Echelon LonMaker User Manual

LonMaker

User’s Guide

Echelon, LON, LONWORKS, LonTalk, Neuron, LONMARK, 3120, 3150, LNS, LonMaker, and the Echelon logo are trademarks of Echelon Corporation registered in the United States and other countries. LonPoint and LonSupport are trademarks of Echelon Corporation.

Other brand and product names are trademarks or registered trademarks of their respective holders.

Neuron

Chips, LonPoint Modules, and other OEM

Products were not designed for use in equipment or systems which involve danger to human health or safety or a risk of property damage and Echelon assumes no responsibility or liability for use of the Neuron

Chips or

LonPoint Modules in such applications.

Parts manufactured by vendors other than Echelon and referenced in this document have been described for illustrative purposes only, and may not have been tested by Echelon. It is the responsibility of the customer to determine the suitability of these parts for each application.

ECHELON MAKES NO REPRESENTATION, WARRANTY, OR CONDITION OF ANY KIND, EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE OR IN ANY COMMUNICATION WITH YOU, INCLUDING, BUT NOT LIMITED TO, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, SATISFACTORY QUALITY, FITNESS FOR ANY PARTICULAR PURPOSE, NONINFRINGEMENT, AND THEIR EQUIVALENTS.

No part of this publication may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means, electronic, mechanical, photocopying, recording, or otherwise, without the prior written permission of Echelon Corporation.

ii Preface

Preface

The LonMaker Integration Tool is a software package for designing, installing, and

maintaining multi-vendor, open, interoperable L

on Echelon's LNS

network operating system, the LonMaker tool combines a

ONWORKS

control networks. Based

powerful, client-server architecture with an easy-to-use Visio user interface. The

result is a tool sophisticated enough to design, commission, operate, and maintain a

control network, yet economical enough to be left behind as an operation and

maintenance tool. The LonMaker tool complies with the LNS plug-in standard,

making it compatible with the wide variety of LNS plug-ins available from Echelon

and many other vendors.

LonMaker User’s Guide iii

Purpose

This guide outlines the new features in the Turbo edition of the LonMaker Integration Tool, and it describes how to use the LonMaker Integration Tool to design, commission, monitor and control, maintain, and manage a network. The LonMaker Integration Tool includes an online help system that provides context-sensitive help that supplements the information in this guide.

Audience

This guide is intended for system designers and integrators with an understanding of control networks.

Content

This guide includes the following content:

• Introduction: Provides an introduction to the LonMaker Integration Tool, new features in the Turbo Editions; and the basics of LonMaker Network Designs, L

• Installing and Activating the LonMaker Tool : Lists hardware requirements for installing the LonMaker Integration Tool; describes how to install the various software and components included in your copy of the LonMaker Integration Tool; and describes how to activate the LonMaker Turbo Integration Tool.

• Getting Started: Provides information on the planning a LonMaker network design; using the LonMaker Design Manager; setting up a network interface; creating and opening a LonMaker network design; LonMaker client types; using the LonMaker tool remotely; using Network Device shapes; and creating and using user profiles.

ONWORKS, and Visio.

• Designing Networks: Describes how to design a network using the LonMaker tool. Covers how to create the following objects in a LonMaker drawing: application devices, functional blocks, network variables, routers, channels, and subsystems. Explains how to connect network variables. Explains working with LonMaker shapes and layers, customizing the LonMaker user interface, and using LonMaker with AutoCAD drawings.

iv Preface

• Installing Networks: Describes how to install devices using the LonMaker tool, including how to load applications into them, set the initial state of their applications, set the source of their configuration properties, and select how they manage device-specific configuration properties. It also explains the different methods for acquiring device Neuron IDs and how to alternatively use the device discovery method to install a network.

• Monitoring and Controlling Netw orks: Describes how you can monitor and control the devices in your network with the LonMaker tool. Describes the three methods you can use to read and/or write network variables and configurat i o n p roperties: using monitored connections, browsing with the LonMaker Browser, and using Data Point shapes. Covers how to bind network variables to the host in order to receive event-driven updates. Describes how to change the types and formats of network variables and configuration properties. Explains how to create simple HMIs in your LonMaker drawing with Data Point and Visi o shapes.

• Maintaining Networks: Provides an overview of network maintenance tasks that you can perform with the LonMaker tool. Describes loading, replacing, and decommissioning devices. Explains how to resynchronize and propagate configuration properties values. Explains how to back up and restore a LonMaker network; create a LonMaker network by recovering information from the physical network; and resynchronize the network database, LonMaker drawing, and physical devices. Explains how to merge two LonMaker networks.

• Managing Networks: Explains how to test and verify application devices, functional blocks, and routers; describes LonMaker styles; and details how to generate device status summary reports, network resource reports, and LNS network reports.

• Exporting and Importing a Network Using XML: Describes how to export a L to a LonMaker network XML file; view a LONWORKS network XML file in a web browser; edit a LonMaker network XML file; and import a LONWORKS network XML file to update a network.

• LonMaker Credits: Provides information on licensing the LonMaker tool; using, viewing, and adding LonMaker credits; licensing remote clients; transferring a LonMaker license; usin g LonMaker demo mode.

• Using LNS Plug-ins: Provides an overview of LNS Plug-ins and then describes how to start a plug-in, get plug-in informati on, and re-register, enable, and disable plug-ins.

• Creating and Using LonMaker Shapes and Stencils: Describes how to create a LonMaker stencil and create and use custom master shapes for devices, functional blocks, subsystems, and connections. Explains how to modify a master shape by changing its user-defined cells.

• Appendices: Includes information on setting LonMaker default options; instructions for installing network interfaces; a quick-start exercise you can use to quickly create a LonMaker network, and control and monitor devices; the LonMaker Credits Order Form; the LonMaker Software License Agreement; the LonMaker License Transfer Agreement; a glossary; and the index.

ONWORKS network

For More Information and Technical Support

• See the LonMaker Turbo Editions Help file for detailed information on using the LonMaker Turbo Integration Tool.

• See the LonPoint Application an d Pl ug-In Guide, the LonPoint Plug-In help file, and the LonPoint plug-in for detailed information on using LonPoint devices.

• Adobe Acrobat versions of the LonMaker User’s Guide and LonPoint Application and Plug-In Guide are also included in LonMaker and LonPoint program folders when you install the

LonMaker Turbo Editions and LonPoint software. You’ll need the Adobe Acrobat reader that is optionally installed by the LonMaker setup application to view these files.

LonMaker User’s Guide v

The LonMaker and LonPoint Plug-In ReadMe files provide descriptions of known problems and their workarounds. To view the LonMaker Turbo Editions ReadMe file, click Start, point to Programs, point to Echelon LonMaker, and then select LonMaker Read Me. To view the LonPoint ReadMe file, click Start, point to Programs, point to Echelon LonPoint Software, and then select LonPoint Read Me First. You can also find additional LonMaker and LonPoint information at the LonMaker Web page at www.echelon.com/lonmaker.

If you have technical questions that are not answered by the documentation, on-line help, or LonMaker Web page, you can get technical support from Echelon. Your LonMaker distributor may also provide customer support. You can also enroll in training classes at Echelon or an Echelon training center to learn more about how to use the LonMaker tool.

To receive technical support from Echelon for the LonMaker tool, you must register your copy with Echelon and you must purchase support services from Echelon or an Echelon support partner. See

www.echelon.com/support for more information on Echelon support and training services.

There is no charge for software installation-related questions during the first 30 days after you receive the LonMaker CD.

You can obtain technical support via phone, fax, or email from your closest Echelon support center. The contact information is as follows:

Region Languages Supported Contact Information

The Americas

English Japanese

Echelon Corporation Attn. Customer Support 550 Meridian Avenue San Jose, CA 95126 Phone (toll-free): 800 258 4LON (258-4566) Phone: 408 938 5200 Fax: 408 790 3801

lonsupport@echelon.com

Europe

Japan

English German French Italian

Echelon UK 16, The Courtyards Hatters Lane Watford Herts. WD18 8YH United Kingdom Phone: 44 0 1923 430200 Fax: 44 0 1923 430300

lonsupport@echelon.co.uk

Japanese Echelon Japan

Holland Hills Mori Tower, 18F 5-11-2 Toranomon, Minato-ku Tokyo 105-0001 Japan Phone: 81 3 5733 3320 Fax: 81 3 5733 3321

lonsupport@echelon.co.jp

vi Preface

China

Region Languages Supported Contact Information

Chinese English

Echelon Greater China Rm. 1007-1008, IBM Tower Pacific Century Place 2A Gong Ti Bei Lu Chaoyang District Beijing 100027, China Phone: 86 10 6539 3750 Fax: 86 106539 3754

lonsupport@echelon.com.cn

Other Regions

English Phone: 408 938 5200

Fax: 408 328 3801

lonsupport@echelon.com

Echelon will provide Visio support only for those Visio features that are required for use of the LonMaker tool. To receive support for Visio from Microsoft, you must purchase separately a retail version of the Microsoft Visio Professional or Standard 2003 drawing application. Echelon will not support use of the LonMaker Integration Tool with versions of Visio other than the version included on the LonMaker CD.

You can submit a feedback form with suggestions on how to improve the product’s functionality and documentation at http://www.echelon.com/company/feedback. This feedback form is not forwarded to technical support and should not be used to submit technical or product support related issues—send technical support questions to your Echelon support center.

LonMaker User’s Guide vii

Preface .................................................................................................... iii

Purpose .......................................................................................................... iv

Audience......................................................................................................... iv

Related Reading............................................................................................. iv

Content...........................................................................................................iv

For More Information and Technical Support.................................................. v

Table of Contents..........................................................................................viii

1 Introduction ....................................................................................... 1

Introduction to the LonMaker Tool...................................................................2

What’s New for LonMaker Turbo Editions.......................................................2

LonMaker Design Manager.......................................................................3

One-Click Network Creation............................................................... 4

New Network and LonMaker Default Options Tabs...........................4

Network Wizard Accelerator...............................................................4

LonMaker Shape Tooltips.........................................................................4

Application Devices and Routers..............................................................4

Simplified Wizards..............................................................................4

Automatic Channel Selection .............................................................5

Channel Reassignment with the Connector Tool...............................5

Simplified Shape Menus..................................................................... 5

Firmware Upgrade..............................................................................5

Device-Specific Configuration Property Support................................5

Passive Configuration Mode ..............................................................6

Enhanced Subsystem Recovery........................................................6

Active Device Template and Resource File Updates.........................6

Accelerated Device Interface Verification...........................................7

Functional Blocks......................................................................................7

One-Page Functional Block Wizard ...................................................7

Automatic Device Selection................................................................7

Device Re-assignment with the Connector Tool................................7

Simplified Shortcut Menu....................................................................7

Creating Dynamic Functional Blocks..................................................8

Connections..............................................................................................8

Creating a Connection with the Connector Tool ................................8

Automatic Connection Description Selection .....................................8

Fast Connection Property Modification ..............................................8

New Connection Descriptions............................................................8

Hiding and Showing Connector Shapes.............................................8

Automatic Reference Connection Shape Alignment..........................9

Monitoring—Data Point Shape .................................................................9

Network Explorer.......................................................................................9

Network Variable Access....................................................................9

New Channel and Device Template Views........................................9

Device Template Menu.......................................................................9

Multi-User Modification............................................................................10

Automatic Drawing Synchronization.................................................10

LNS Event Tracking..........................................................................10

LonMaker Event Log ........................................................................10

Resource Usage Reports........................................................................10

Network Resource Report................................................................10

Alias Table Summary .......................................................................11

Application Integration and XML Export/Import......................................11

viii Introduction

Exporting a L

Importing a LONWORKS Network XML File.......................................11

Automatic Extension Record Copying..............................................11

Plug-in Enable/Disable.....................................................................11

LNS Network Database ..........................................................................12

LNS Hot Backup...............................................................................12

Scheduled Backups..........................................................................12

Automatic Resynchronization...........................................................12

Database Validation and Repair.......................................................12

Visio 2003 Integration .............................................................................13

Tablet PC Support............................................................................13

LonMaker Drawing Markup with Digital Ink......................................13

Windows Compatibility............................................................................13

Professional, Standard, and Trial Editions....................................................13

Professional Edition..........................................................................13

Standard Edition...............................................................................14

Trial Edition.......................................................................................14

LonMaker Network Designs ..........................................................................14

LNS Network Database ..........................................................................14

LonMaker Drawing..................................................................................14

LONWORKS Basics .........................................................................................14

LONWORKS Networks ..............................................................................15

Devices.............................................................................................15

Protocol.............................................................................................15

Device Templates.............................................................................15

Channels...........................................................................................15

Routers.............................................................................................15

Applications......................................................................................15

Network Variables ............................................................................16

Configuration Properties...................................................................16

Standard Network Variable and Configuration Property Types.......16

User-defined Standard Network Variable and Configuration Property

Types ................................................................................................16

Network Variable Connections.........................................................16

Subsystems......................................................................................17

Supernodes......................................................................................17

LonMaker Client Types...........................................................................17

Visio Basics ...................................................................................................17

ONWORKS Network XML File.......................................11

2 Installing and Activating the LonMaker Tool................................ 19

Hardware Requirements................................................................................20

Minimum Hardware Requirements .........................................................20

Enhancements for Engineering Large Networks....................................20

Installing the LonMaker Tool .........................................................................20

Installing Visio.........................................................................................23

Installing the LonMaker Integration Tool.................................................25

Installing the LonPoint Applications, Plug-in, and Utilities......................27

Installing and Configuring Network Drivers.............................................28

Installing Adobe Acrobat Reader............................................................28

Activating the LonMaker Tool........................................................................28

Creating and Sending an Activation Request.........................................29

Entering an Activation Key......................................................................31

3 Getting Started ................................................................................ 33

Design Overview ...........................................................................................34

Defining Network Requirements and Organization.................................34

LonMaker User’s Guide ix

Selecting a Network Installation Scenario ..............................................34

Engineered System Scenario...........................................................34

Ad-Hoc System Scenario .................................................................35

Determining User Permissions ...............................................................35

Optimizing LonMaker Network Performance..........................................35

Drawing Files....................................................................................35

Network Changes.............................................................................36

Connections......................................................................................36

Sharing the LNS Interface with the LNS DDE Server......................36

Functional Blocks .............................................................................36

Subsystems......................................................................................37

LonMaker Design Manager Overview...........................................................37

General ...................................................................................................38

Options....................................................................................................40

New Network Options.............................................................................42

LonMaker Stencils...................................................................................44

LonMaker Default Options......................................................................45

Setting Up a Network Interface......................................................................46

Optimizing Network Interface Performance............................................46

Using an IP-852 Network Interface.........................................................46

Creating and Opening a LonMaker Network.................................................47

Creating a New LonMaker Network Design............................................47

Working with Digital Signatures........................................................52

Creating a New LonMaker Network from an Existing LNS Database...........53

Copying an Existing LonMaker Network Design.....................................56

Opening an Existing LonMaker Network Design....................................57

LonMaker Client Types..................................................................................61

Local Client .............................................................................................61

Remote Full Client...................................................................................62

Remote Lightweight Client......................................................................63

Using the LonMaker Tool on a Remote Client ..............................................64

Using the LonMaker Tool on a Remote Full Client.................................64

Using the LonMaker Tool on a Remote Lightweight Client ....................67

Using Network Service Device Shapes.........................................................69

Listing Network Service Devices......................................................71

Upgrading Network Service Devices................................................71

Replacing a Local Network Service Device......................................72

User Profiles..................................................................................................72

Creating a New User Profile ...................................................................72

Changing Passwords..............................................................................74

Modifying and Deleting User Profiles......................................................74

Changing User Profiles in a LonMaker Drawing.....................................74

Using the LonMaker Tool Remotely with User Profiles ..........................75

4 Designing Networks........................................................................ 77

Creating a LONWORKS Network.....................................................................78

Creating a LonMaker Drawing.......................................................................78

Creating Application Devices..................................................................79

Using Automatic Channel Selection.................................................83

Changing the Channel of an Application Device..............................83

Creating Functional Blocks.....................................................................84

Using Automatic Device Selection ...................................................87

Re-assigning a Functional Block......................................................88

Configuring a Functional Block.........................................................88

Copying a Functional Block Configuration .......................................88

x Introduction

Creating a New Functional Block from a Configured

Functional Block.........................................................................88

Updating a Functional Block from a Configured Functional

Block ..........................................................................................89

Creating a Functional Block Master Shape......................................91

Creating Dynamic Functional Blocks................................................91

Deleting Dynamic FBs ...............................................................92

Creating Dynamic Functional Block Master Shapes..................93

Creating a Virtual Functional Block..................................................93

Adding a Message Tag Shape to a Virtual Functional Block.....93

Deleting Message Tag Shapes..................................................94

Creating Network Variables....................................................................94

Creating a Network Variable Shape.................................................94

Creating a Network Variable Master Shape.....................................95

Adding Network Variable Shapes to a Functional Block..................95

Creating Network Variables Using Generic Network Variable

Shapes.......................................................................................96

Creating Dynamic Network Variables Using Network

Variables Shapes from the LonMaker NV Shapes Stencil........99

Creating Dynamic Network Variables Using Network

Variable Master Shapes.............................................................99

Changing Network Variable Name...................................................99

Changing Network Variable Position..............................................100

Deleting a Network Variable Shape ...............................................100

Deleting Dynamic Network Variables.............................................101

Creating a Router........................................................................................102

Using Automatic Channel Selection...............................................106

Changing a Router Channel...........................................................107

Creating a Channel......................................................................................107

Creating a Subsystem.................................................................................109

Creating a Supernode...........................................................................111

Re-Naming and Deleting a Supernode Network Variable ....................112

Copying a Subsystem or Supernode....................................................112

Creating Connections..................................................................................113

Creating a Connection with the Connector Shape................................114

Creating a Connection with the Connector Tool...................................114

Creating a Connection with the Network Variable Connection

Dialog Box.............................................................................................114

Using Reference Connection Shapes...................................................117

Aligning Reference Connection Shapes.........................................118

Using Connection Descriptions.............................................................118

Connection Description Properties.................................................118

Message Service Type ............................................................118

Addressing Mode.....................................................................119

Viewing and Creating Connection Descriptions.............................119

Using Automatic Connection Description Selection.......................121

Changing the Connection Description for a Connection................123

Hiding and Showing Connector Shapes...............................................124

Hiding and Showing All Connector Shapes in a Subsystem..........124

Hiding and Showing Selected Connector Shapes Attached to

Functional Blocks or Supernodes...................................................124

Hiding and Showing Connector Shapes Attached to a

Functional Block.............................................................................126

Viewing and Navigating LonMaker Network Design ...................................128

Navigating the Network within the Drawing Page.................................128

Opening any Subsystem ................................................................128

LonMaker User’s Guide xi

Opening a Parent Subsystem ........................................................129

Using Network Navigators..............................................................129

Navigating and Managing a Network with the Network Explorer..........130

Navigating a Network with the Network Explorer...........................131

Managing a Network with the Network Explorer............................131

Managing and Editing Device Templates with the Network

Explorer ..........................................................................................131

Managing Device Templates ...................................................131

Editing Device Template Properties.........................................132

Working with LonMaker Layers...................................................................134

Working with LonMaker Shapes..................................................................135

Viewing and Setting LonMaker Shape Properties................................135

Moving a LonMaker Shape...................................................................135

Repositioning a LonMaker Shape..................................................135

Changing the Subsystem for a LonMaker Shape ..........................135

Changing the Channel for a LonMaker Shape...............................136

Moving a Device or Router to a Different Channel..................136

Moving an LNS Computer to a Different Channel ...................139

Copying a LonMaker Shape .................................................................139

Deleting a LonMaker Shape .................................................................139

Customizing the User Interface Overview...................................................140

Editing the Title Block ...........................................................................140

Changing the Commands on the LonMaker Menus.............................140

Using LonMaker Shape Menus.............................................................141

Using AutoCAD Drawings ...........................................................................141

Importing an AutoCAD Drawing............................................................141

Exporting an AutoCAD Drawing............................................................142

5 Installing Networks ....................................................................... 143

Network Installation Overview.....................................................................144

Commissioning a Device.............................................................................144

Selecting Devices for Commissioning...................................................145

Loading a Device Application Image.....................................................146

Setting the Initial Device State and Source of Configuration

Property Values.....................................................................................148

Setting the Initial Application Device State and Source of

Con f i g u ra t i o n P r op e r t y V a lu e s...........................................................149

Setting the Initial Router State........................................................151

Setting the Neuron ID ...........................................................................152

Selecting the Device Identification Method ....................................152

Using the Service Pin Method........................................................153

Using the Manual Entry Method.....................................................155

Entering a Neuron ID Manually................................................155

Entering a Neuron ID Using a Bar Code Scanner...................155

Commissioning an i.LON IP-852 Router.....................................................156

Commissioning Using Device Discovery.....................................................156

6 Monitoring and Controlling Networks......................................... 163

Monitoring and Controlling Overview ..........................................................164

Using Monitored Connections .....................................................................164

Displaying a Network Variable Value....................................................165

Using the LonMaker Browser......................................................................166

Starting the LonMaker Browser ............................................................166

The LonMaker Browser Toolbar ...........................................................168

Customizing the Browser......................................................................169

Customizing Browser Columns ......................................................169

xii Introduction

Hiding or Changing the Order of Browser Columns ................169

Adjusting the Width of Browser Columns ................................169

Customizing Browser Rows............................................................170

Selecting Browser Rows to be Displayed................................170

Hiding Browser Rows...............................................................170

Saving Browser Customization ......................................................171

Monitoring Network Variables...............................................................171

Enabling Network Variable Monitoring...........................................171

Disabling Network Variable Monitoring ..........................................172

Getting Network Variable Values ...................................................172

Using Bound Updates...........................................................................172

Binding Network Variables to the Host .................................................172

Updating Network Variable and Configuration Property Values...........173

Setting Values ................................................................................173

Setting Values for Structured Objects......................................173

Setting Values for Configuration Property Arrays....................175

Clearing Values..............................................................................176

Getting Values................................................................................176

Changing a Network Variable or Configuration Property Type.............176

Changing a Network Variable or Configuration Property Format.........177

Displaying Error Messages...................................................................179

Managing Functional Blocks.................................................................180

Using Data Point Shapes ............................................................................180

Adding and Monitoring a Data Point Shape..........................................180

Updating a Data Point...........................................................................183

Updating a Scalar Data Point.........................................................184

Updating a Structured Data Point...................................................184

Updating an Enumerated Data Point..............................................185

Getting a Data Point Value ...................................................................185

Creating and Using a Custom Data Point Master Shape .....................186

Creating a Custom Data Point Master Shape................................186

Using a Custom Data Point Master Shape.....................................186

Copying and Creating a Data Point Shape...........................................187

Deleting a Data Point Shape.................................................................187

Creating an HMI with Data Point Shapes.............................................187

Writing to a Data Point Shape Value..............................................189

Using an Add-On .....................................................................189

Using a Macro..........................................................................190

Reading from a Data Point Shape Value .......................................191

Using an Add-On .....................................................................191

Using a Macro..........................................................................191

Organizing HMIs.............................................................................192

7 Maintaining Networks................................................................... 193

Maintaining Networks Overview..................................................................194

Loading Devices..........................................................................................194

Selecting the Devices to Load ..............................................................195

Selecting or Creating a Device Template .............................................195

Selecting an Application Image and a Neuron Firmware Image ..........196

Selecting Initial Device State and Source of Configuration Property

Values...................................................................................................198

Replacing Devices.......................................................................................200

Attaching a New Device to the Network................................................200

Replacing a Device in the LonMaker Network......................................200

Removing the Old Device.....................................................................203

Decommissioning Devices ..........................................................................203

LonMaker User’s Guide xiii

Resynchronizing Configuration Properties..................................................204

Using the LonMaker Tool as a Passive Configuration Tool........................205

Backing up a LonMaker Network Design....................................................206

Manually Backing Up a LonMaker Network..........................................206

Creating a Backup from a LonMaker Drawing ...............................206

Creating a Backup from the LonMaker Design Manager...............209

Scheduling Drawing Saves and Database Backups.............................209

Scheduling Backups with the LonMaker Tool..........................209

Scheduling Backups with the Windows Task Scheduler.........210

Restoring a LonMaker Network ............................................................211

Restoring a Network Database Backup .........................................211

Restoring a LonMaker Drawing Backup.........................................214

Restoring a Full Network Backup...................................................214

Recovering a LonMaker Network................................................................219

Subsystem Recovery Options...............................................................220

Using Subsystem Paths .................................................................221

Using Subsystem IDs.....................................................................222

Using the LNS Database Recovery Wizard..........................................222

Network Recovery vs. Database Backup .............................................232

Resynchronizing a LonMaker Network........................................................233

Automatic LonMaker Drawing Synchronization....................................234

LNS Event Tracking........................................................................234

LonMaker Event Log ......................................................................234

Viewing the LonMaker Event Log............................................235

Exporting the LonMaker Event Log..........................................236

Manual Network Resynchronization .....................................................237

Refreshing the LonMaker Network .......................................................246

Merging LonMaker Networks.......................................................................247

Network Merge Considerations.............................................................247

Limitations ......................................................................................247

Information Loss.............................................................................247

Merging LonMaker Networks................................................................248

8 Managing Networks ...................................................................... 253

Using the LonMaker Device Manager.........................................................254

Opening the LonMaker Device Manager..............................................254

Managing Devices.................................................................................254

Managing Functional Blocks.................................................................256

Managing Routers.................................................................................258

Device Manager Settings......................................................................259

Using LonMaker Styles Overview ...............................................................260

LonMaker Device Styles .......................................................................260

LonMaker Functional Block Styles........................................................261

Network Variable and Message Tag Shape Styles ..............................262

LonMaker Connector Shape Styles......................................................262

Generating a Device Status Summary Report............................................263

Using Resource Usage Reports..................................................................266

Network Resource Report.....................................................................266

Alias Table Summary............................................................................267

Generating LNS Reports.............................................................................268

9 Exporting and Importing Networks with XML............................. 271

Using XML Export/Import Overview ............................................................272

Exporting a LONWORKS Network XML File ...........................................272

Viewing a LonMaker Network Report ...................................................274

Importing a LONWORKS Network XML File............................................276

xiv Introduction

10 LonMaker Credits.......................................................................... 279

Licensing with the LonMaker Tool...............................................................280

Defragmenting the LonMaker Disk..............................................................280

Using LonMaker Credits..............................................................................280

Viewing LonMaker Credits....................................................................281

Using Deficit Credits..............................................................................281

Viewing Deficit Credits..........................................................................282

Adding LonMaker Credits .....................................................................283

Licensing Remote Clients............................................................................286

Transferring a LonMaker License................................................................286

Creating LonMaker Demonstration Networks .............................................291

11 Using LNS Plug-ins....................................................................... 293

Using LNS Plug-ins Overview .....................................................................294

Starting a Plug-in.........................................................................................294

Viewing Plug-in Information.........................................................................296

Viewing Plug-in Status.................................................................................297

Re-Registering Plug-ins...............................................................................298

Disabling and Enabling Plug-ins..................................................................299

Disabling a Plug-in................................................................................299

Enabling a Plug-in.................................................................................300

12 Creating and Using Custom LonMaker Shapes and Stencils... 301

LonMaker Stencils.......................................................................................302

Creating a Custom LonMaker Stencil..........................................................302

Creating Custom LonMaker Master Shapes...............................................302

Using Custom LonMaker Master Shapes....................................................303

Device Master Shapes..........................................................................303

Functional Block Master Shapes ..........................................................304

Subsystem or Supernode Master Shapes............................................305

Connection Master Shapes...................................................................306

Creating Additional Channels ...............................................................307

Editing Master Shape User Defined Cells...................................................308

Additional Device User Cells.................................................................308

Additional Functional Block User Cells.................................................313

Additional Router Shape User Cells .....................................................314

Setting User Functional Block Scopes and Types ......................................314

Adding a Bitmap to a Device Master Shape................................................314

Viewing and Editing VBA Code Associated with a LonMaker Network

Drawing........................................................................................................315

Appendix A - Setting LonMaker Default Options............................. 317

Setting LonMaker Default Options ..............................................................318

Backup/Restore Options.......................................................................319

Configuration Properties Options..........................................................323

Device Options......................................................................................325

Functional Block Options ......................................................................327

General Options....................................................................................330

LNS Event Options................................................................................331

LonMaker Font Options ........................................................................332

Naming Options ....................................................................................334

Network Explorer Options.....................................................................336

NV Browser/Monitoring Options............................................................337

Recovery Options..................................................................................338

Service Pin Options...............................................................................341

LonMaker User’s Guide xv

Shape ToolTips Options .......................................................................342

Synchronization Options.......................................................................343

Warnings Options..................................................................................344

Appendix B - Installing Network Interfaces...................................... 347

Installing the PCLTA-10 Network Interface.................................................348

Installing the PCLTA-10 Hardware .......................................................348

Configuring the PCLTA-10 Network Interface ......................................348

Installing and Configuring the PCLTA-20 Network Interface.......................350

Installing the PCLTA-20 Hardware .......................................................351

Configuring the PCLTA-20 Network interface.......................................351

Installing and Configuring the PCC-10 Network Interface...........................351

Installing the PCC-10 Card Hardware...................................................351

Configuring the PCC-10 Network interface...........................................352

Appendix C- LonMaker QuickStart Exercise.................................... 355

Appendix D - LonMaker Credits Order Form.................................... 363

Appendix E - LonMaker Software License Agreement.................... 367

Appendix F - Software License Transfer Agreement....................... 375

Appendix G - Glossary ....................................................................... 377

Index..................................................................................................... 397

xvi Introduction

Introduction

This chapter provides an introduction to the LonMaker Integration Tool, new features in

the Turbo Editions; and the basics of LonMaker Network Designs, LONWORKS, and

Visio.

LonMaker User’s Guide 1

Introduction to the LonMaker Tool

The LonMaker® Integration Tool is a LONWORKS ® network tool that runs on the LNS® client/server network operating system and uses Microsoft Visio user interface. LNS provides the set of directory, installation, management, monitoring, and control services used by the LonMaker tool. In addition, the client/server architecture of LNS allows multiple users running the LonMaker tool on separate computers to access the LNS server simultaneously. This means that managers, system integrators, installers, and maintenance personnel can all work on the same L

ONWORKS network at the same time. The LonMaker tool is compatible with Windows XP

Professional and Home editions, Windows 2003 Server, and Windows 2000. The LonMaker tool can be used to manage all phases of a network’s life cycle, from the initial design

and commissioning to the ongoing operation, because it provides the functionality of several network tools in one single solution:

• Network Design Tool. You can design a network offsite (without actually being connected to the network) and/or onsite, and modify it anytime. The LonMaker tool can also learn an existing network’s design through a process called network recovery.

• Network Installation Tool. You can rapidly install a network designed offsite once it is brought onsite. The device definitions can be quickly and easily associated with their corresponding physical devices to reduce on-site commissioning time. The LonMaker Browser provides complete access to all network variables and configuration properties.

• Network Documentation Tool. You can create a LonMaker drawing during the network design and installation process. This LonMaker drawing is an accurate, logical representation of the installed physical network. The LonMaker drawing is therefore an essential component of as-built reports.

• Network Operation Tool. You can operate the net w or k using the operator interface pages contained within the LonMaker drawing.

(Professional or Standard 2003) as a graphical

• Network Maintenance Tool. You can easily add, test, remove, modify, or replace devices, routers, channels, subsystems, and connections to maintain the network.

What’s New for LonMaker Turbo Editions

This section lists and then describes the new features that have been added to the LonMaker tool for the Turbo Editions.

LonMaker Design Manager

LonMaker Shapes Application Devices and

Routers

• One-click network creation

• New tabs for setting new network and LonMaker

default options

• Network Wizard accelerator

• ToolTips for displaying shape data

• Simplified wizards

• Automatic channel selection

• Channel re-assignment with the Connector tool

• Simplified shape menus

• Firmware upgrade

• Device-specific configuration property support

• Passive configuration mode

• Enhanced subsystem recovery

• Active device template and resource file updates

• Accelerated device interface verification

2 Introduction

Functional Blocks

Connections

Monitoring Network Explorer

Multi-User Modification

• One-page wizard

• Automatic device selection

• Device re-assignment with the Connector tool

• Simplified shape menu

• Dynamic functional blocks

• Dynamic network variables on application functional

blocks

• Simplified Connector tool

• Automatic connection type selection

• Fast connection property modification

• New connection descriptions

• More default connection descriptions

• New connection property modification

• Connection hiding

• Connection reference shape alignment

• New Data Point shape

• Network variable access

• Channel and device template views

• Device template menu

• Automatic drawing synchronization

• LNS event tracking

• LonMaker event log

Resource Usage Reports

Application Integration

LNS network database

Visio 2003 Integration

Windows Compatibly

Performance

LonMaker Design Manager

• Network resource report

• Alias table summary

• XML export to other applications and reports

• XML import from other applications

• LonMaker network report

• Automatic extension record copying

• Plug-in disable/enable

• Hot backup while the LNS Server is running

• Scheduled backup

• Automatic resynchronization

• LNS network database validation and repair

• Tablet PC support

• LonMaker drawing markup with digital ink

• Compatible with Windows XP Professional and

Home Editions, Windows 2003 server, and Windows 2000

• Faster device, router, functional block, channel, and connection creation

• Faster commissioning

• Faster resynchronization

The LonMaker Design Manager has been enhanced to provide greater flexibility in customizing your networks, and to speed up creating and opening networks.

LonMaker User’s Guide 3

One-Click Network Creation

You can now create new networks with only one mouse click from the LonMaker Design Manager. To use the one-click network creation feature, clear the Show All Options check box in the New Network box on the General tab, and select the options in the New Network Options tab to skip the pages for setting the management mode, network interface, registered plug-ins, and default LonMaker stencils.

New Network and LonMaker Default Options Tabs

The LonMaker Design Manager includes New Network Options and LonMaker Default Options tabs that let you select the default settings for new networks.

The New Network Options tab lets you set the default properties for the network interface, plug-ins, user logon, management mode, and network components pages that appear in the Network Wizard when you create a new network. The properties you set for these pages are then applied to each new network you create. You can also set options to skip these pages in order to create a new network with one click. See New Network Options in Chapter 3, Getting Started, for more information on the options you can set in the New Network Options tab.

The LonMaker Default Options tab lets you set the default options for LonMaker objects such as devices, functional blocks, and configuration properties and processes such as backup/restore, commissioning, network variable browser/monitoring, and synchronization. Each new network you create will use these default settings. You can change any of these settings after creating the network by opening the LonMaker menu and clicking LonMaker Options. See LonMaker Default Options in Chapter 3, Getting Started, for more information on the options you can set in the LonMaker Default Options tab.

Network Wizard Accelerator

When creating or opening a network with the Network Wizard, you can click the new Finish button to skip any remaining pages in the wizard. New networks will be created using the current settings in the New Network Options tab of the LonMaker Design Manager for those pages that you skip. Existing networks will be opened using the settings in the Network Properties dialog in the LonMaker drawing, which you can access by opening the LonMaker menu and clicking Network Properties.

LonMaker Shape Tooltips

You can enable a ToolTip to display selected data items when the mouse pointer is over application device, functional block, connection, channel, and network variable shapes. Using an application device for example, you can set a ToolTip to display any or all of the following data items when the mouse pointer is over the device shape: shape name, template name, network variable alias data, Neuron ID, Subnet/Node ID, and LNS handle. See Shape ToolTips Options in Appendix A for more information.

Application Devices and Routers

The new features in the LonMaker Turbo Editions for application devices and routers are described in the following sections.

Simplified Wizards

The New Device Wizard and New Router Wizard have been short ened. The channel selection page in both wizards and the device template page in the New Device Wizard have been eliminated, and the options from these pages have been added to the first page of the respective wizards. In addition, each page of the wizard now has a Finish button, which you can use to skip any remaining pages. Clicking Finish is the same as clicking through the remaining pages in the wizard without making any changes. These simplified wizards let you define and commission an application device or router with only one click.

4 Introduction

See Creating Application Devices and Creating Routers in Chapter 4, Designing Networks, for more detailed information on using these simplified wizards.

Automatic Channel Selection

You can use automatic channel selection to enable the LonMaker tool to automatically select the appropriate channel or channels for a new application device or router, skipping their respective wizards. This feature lets you create a new device or router with a single click and drag. To enable automatic channel selection for all new LonMaker networks or for an existing LonMaker networ k, set the Enable Automatic Channel Selection check box in the network properties: Device options category.

See Creating Application Devices and Creating Routers in Chapter 4, Designing Networks, for information on using the automatic channel selection feature.

Channel Reassignment with the Connector Tool

You can move an application device to a different channel, preserving the device’s configuration and all of its connections. You can do this to assign a device to a channel different from the one automatically selected by the LonMaker tool, or to physically move a device to a different compatible channel. To move a device to a different channel, you can either right-click the device and then click Move Device on the shortcut menu, or you can use the Connector tool on the Visio Standard toolbar to graphically move the device.

See Creating Application Devices and Creating Routers in Chapter 4, Designing Networks, for more information on moving application devices and routers.

Simplified Shape Menus

You can right-click an application device or router to display a shortcut menu for the device. The shortcut menus have been simplified to display hierarchical menus for commissioning and moving devices, and for starting plug-ins (application devices only). Visio-specific commands—such as cut, view, format, shape, and help—no longer appear in the device shortcut menus. You can disable the new LonMaker menus to display all Visio commands. To disable or enable the LonMaker shape menus, open the LonMaker menu and then click Use LonMaker Shape Menus.

See Using LonMaker Shape Menus in Chapter 4, Designing Networks, for information on enabling and using LonMaker shape menus.

Firmware Upgrade

When you load a new application image into a compatible device, you can upgrade (or downgrade) the device firmware to make the device compatible with the application image being loaded into it. The device and the existing device firmware must support firmware updates to use this option. This option is available when you commission, replace, or load an application file into a de vice. See Chapter 5, Installing Networks, for information on the firmware upgrade feature.

Device-Specific Configuration Property Support

The LonMaker tool now provides improved support for device-specific configuration properties. Unlike other configuration properties, device-specific configuration properties have values that can be modified independent of the LNS network database. For example, a thermostat may include a user interface to allow the user to locally change a setpoint configuration property. This change may occur independently of the LNS network database and therefore not be reflected in it. The setpoint configuration property should be defined as device-specific in the device to communicate to the LNS server that it may be changed independently of the LNS network database.

If the manufacturer does not specify that a particular configuration property is device-specific, but you know that it should be, you can now change the device-specific flag for that configuration property in a device template.

LonMaker User’s Guide 5

You can also set the initial values of device-specific configuration properties when commissioning or replacing a device, loading a new application image into the device, or resynchronizing configuration properties. For example, when commissioning or replacing the thermostat in the previous example, you may load the configuration property value from the LNS network database to assign the initial setpoint.

See Chapter 5, Installing Networks, for more information on managing device-specific configuration properties.

Passive Configuration Mode

You can now manually propagate configuration property value changes to one or more devices without affecting the network configuration of the devices. You can use this feature to enable a plug-in to operate as a passive configuration tool, which allows you to use plug-ins on devices installed by network tools not based on LNS. To use this passive configuration mode, attach the LonMaker tool to the network, keep it OffNet, and then recover the network. You can then configure any device in the network using plug-ins, and apply confi g uration property value changes to these devices by rightclicking a device (or selecting multiple devices and right-clicking one of the devices), pointing to Commissioning, and clicking Propagate CP Values to Device on the shortcut menu.

Enhanced Subsystem Recovery

You can now store subsystem data in application devices and routers. This improves the network recovery process (see Recovering a LonMaker Network in Chapter 7, Maintaining Networks), as the LonMaker tool can use the saved subsystem data to place application devices and routers in their correct subsystems.

To enable subsystem data to be stored in devices, select one or both of the options in the network properties: Recovery options category (see Appendix A). The options consist of storing the subsystem ID in the location property of application devices and routers and storing the subsystem path in the SCPTlocation configuration property of application devices.

• If you select the Set Location Property to Subsystem ID option, the LonMaker tool stores the

subsystem ID in application devices or routers when they are commissioned. This subsystem ID appears as a 6-character ASCII or 12-digit hex string in the Location field of the Basic Properties dialog box. The LonMaker tool automatically updates the subsystem ID when you move the device, and when you move or rename its subsystem and the Update all Devices when Subsystem Name is Modified option in the network properties: Recovery options category is set to Yes.

If you select the Set SCPT Location Value to Subsystem Path option, the LonMaker tool stores

•

the subsystem ID in the SCPTlocation configuration property of application devices when they are commissioned. The LonMaker tool automatically updates the subsystem path stored in the SCPTlocation configuration property when you move the application device, and when you move or rename its subsystem and the Update all Devices when Subsystem Name is Modified option in the network properties: Recovery options category is set to Yes.

Active Device Template and Resource File Updates

You can now update the device interface (XIF) file or the resource files for a device template currently being used by devices in the network. To update the XIF file or resource files of a device template, open the Network Explorer, click the new Device Templates tab, right-click a device template, point to Import XIF or Resync to Resource Files, and then select whether to update the device template and all the devices using that template, or just the device template.

See Network Explorer in Chapter 4, Designing Networks, for more information on updating device templates and resource files.

6 Introduction

Accelerated Device Interface Verification

The LonMaker Turbo Editions let you disable any or all of the validation steps performed on the device interface when a device is commissioned. This may reduce the time required to install a network, especially for power line devices. To set the validation options, right-click a device template in the Device Templates tab in the Network Explorer, and then select Properties from the shortcut menu. Under the Device Validation box, clear the check boxes for those validation steps the LNS Server is to skip when you commission devices using that device template.

See Network Explorer in Chapter 4, Designing Networks, for more information on setting device interface validation options.

Functional Blocks

The new features in the LonMaker Turbo Editions for functional blocks are described in the following sections.

One-Page Functional Block Wizard

The functional block wizard has been reduced from two pages to one. The functional block name page has been eliminated, and the options have been added to the first page of the wizard. This one-page wizard lets you create a functional block with only one click. See Creating Functional Blocks in Chapter 4, Designing Networks, for more detailed information on using the simplified Functional Block wizard.

Automatic Device Selection

You can use automatic device selection to enable the LonMaker tool to automatically select the appropriate device for a new functional block, skipping the functional block wizard. This feature lets you create a new functional block with a single click and drag. To enable automatic device selection for all new LonMaker networks or for an existing LonMaker network, set the Enable Automatic Device Selection check box in the network properties: Functional Block options category. This option is cleared by default.

See Creating Functional Blocks in Chapter 4, Designing Networks, for more formation on using automatic device selection.

Device Re-assignment with the Connector Tool

You can move a functional block to a different device, preserving all of the functional block’s configuration and connections. You can do this to assign a functional block to a different device than the one automatically selected by the LonMaker tool, or to re-assign any functional block to a different compatible device. To move a functional block to a different device, you can either right-click the functional block and use the Move FB command, or you can use the Connector tool on the Visio Standard toolbar to graphically re-assign the functional block.

See Creating Functional Blocks in Chapter 4, Designing Networks, for more formation on re-assigning functional blocks to different devices.

Simplified Shortcut Menu

You can right-click a functional block to display a shortcut menu for the functional block. The shortcut menu has been simplified to display a hierarchical menu for configuration properties, display options, moving the functional block, and for starting plug-ins. Visio-specific commands—such as cut, view, format, shape, and help—no longer appear in the functional block shortcut menu. You can disable the new LonMaker menus to display all Visio commands. To disable or enable the LonMaker menus, open the LonMaker menu and then click Use LonMaker Shape Menus.

See Using LonMaker Shape Menus in Chapter 4, Designing Networks, for information on enabling and using LonMaker shape menus.

LonMaker User’s Guide 7

Creating Dynamic Functional Blocks

You can create dynamic functional blocks on devices that support them. Device manufacturers can implement dynamic functional blocks on devices that support customized interfaces, such as programmable controllers. Within the LonMaker tool, dynamic functional blocks are similar to the more common static functional blocks except that they can only be added to a compatible device and they do not contain configuration properties. When you create a dynamic functional block, you can select whether to create shapes all for mandatory and optional network variables defined in that dynamic functional block.

See Creating Functional Blocks in Chapter 4, Designing Networks, for more formation on creating dynamic functional blocks.

Connections

The new features in the LonMaker Turbo Editions for connections are described in the following sections. See Creating Connections in Chapter 4, Designing Networks, for more detailed information on using these new features.

Creating a Connection with the Connector Tool

You can use the Connector tool on the Visio Standard toolbar to connect network variables and message tags on functional blocks and supernodes that are located in the same subsystem.

Automatic Connection Description Selection

You can use the LonMaker tool to automatically select the connection services for network variab le connections. The LonMaker tool will select the connection service that optimizes network performance, while providing reliable message delivery and minimizing network resource usage. For example, you can use this feature to minimize the use of ANSI/CEA-709.1 (EN14908) groups in large networks.

Fast Connection Property Modification

You can manually change a connection type quickly by right-clicking the connection, pointing to Set Connection Description, and then selecting the new connection description. Selecting a connection

description that does not start with “SCD_” disables automatic connection description selection. To automatically select the appropriate smart connection description (SCD), select <Recompute>.

New Connection Descriptions

To provide more flexibility when manually selecting a connection type, five new default connection descriptions have been added:

1. Acknowledged with Alias Multicast

2. Repeated with Alias Multicast

3. Repeated with Broadcast Multicast

4. Unacknowledged with Alias Multicast

5. Unacknowledged with Broadcast Multicast

Hiding and Showing Connector Shapes

You can hide connector shapes to simplify a LonMaker drawing, or you can selectively show the connector shapes attached to specific functional blocks or superno des t o examine their connections. You can also set an option on a functional block to not create connection shapes. See Hiding and Showing Connector Shapes in Chapter 4, Designing Networks, for more detailed information on the different ways you can hide and show connector shapes.

8 Introduction

Automatic Reference Connection Shape Alignment

You can automatically align and keep aligned all the reference connection shapes in a subsystem or the reference connection shapes attached to a specific functional block. This feature eliminates the need to manually move functional block, connector, and connector reference shapes to keep your LonMaker drawing organized. See Aligning Reference Connection Shapes in Chapter 4, Designing Networks, for more detailed information on using this feature.

Monitoring—Data Point Shape

The LonMaker tool includes a new Data Point shape that you can use to monitor and control a network. You can use the Data Point shape to monitor and control the value of any network variable, configuration property, or functional block state (enabled or in override) in your network. In addition, you can use the Data Point shape to create simple human-machine interfaces (HMIs) in your LonMaker drawing.

The Data Point shape serves as a replacement for the LNS Text Box shape, which was introduced in LonMaker 3. The Data Point shape functions similarly to the LNS Text Box shape and has all the same functions, but it performs significantly better. The Data Point shape keeps Visio in design mode, does not crash Visio when a page is deleted, makes saving a LonMaker drawing easier, and improves security because it does not remove the digital signature associated with a LonMaker drawing. The LNS Text Box shape is still available for legacy drawings, but new drawings should use the Data Point shape because of its improved performance.

See Using Data Point Shapes in Chapter 6, Monitoring and Contr ol l i ng N et w orks, fo r more detailed information on using the Data Point shape.

Network Explorer

The new features in the LonMaker Turbo Editions for the Network Explorer are described in the following sections. See Network Explorer in Chapter 4, Designing Networks, for more information on using these new features.

Network Variable Access

You can access network variables and view their properties from the Network Explorer. To show network variables in the Network Explorer for all new LonMaker networks or for an existing LonMaker network, select Subsystems, Devices, FBs and NVs in the network properties: Network Explorer options category. To access network variables from the Network Explorer, expand a device and then expand one of its functional blocks. The network variables appear listed alphabetically below their respective functional blocks, and they are marked with black arrows within a grey icon.

New Channel and Device Template Views

You can view the devices in a LonMaker drawing organized by subsystem, channel, or device template. You can click the new Channels and Device Templates tabs to find all the devices on a particular channel, or to find all the devices using a specific device template. In the Channel and Device Template tabs, the channels and device templates in your LonMaker drawing are listed alphabetically, and the objects that you selected to be displayed in the Network Explorer are listed in a hierarchal manner (in the order of devices, functional blocks, and then network variables) under their respective channel or device template.

Device Template Menu

To work with a device template, open the Network Explorer, click the Device Templates tab, and then right-click a device template to open the Device Template menu. This menu, previously located under the LonMaker menu, has been enhanced with several new options and features. It includes access to a new Device Properties dialog box where you can set new device validation options, and it contains new options for updating a device template .

LonMaker User’s Guide 9

Multi-User Modification

The new features in the LonMaker Turbo Editions for multi-user modification are described in the following sections. See Resynchronizing a Ne t work in Chapter 7, Maintaining Networks, for more detailed information on using these new features .

Automatic Drawing Synchronization

You can make changes to a LonMaker drawing at the same time other users are modifying the network, even if the other users are modifying the same subsystem as you. The LonMaker tool uses LNS events and a new LonMaker event log described in the following subsections to keep the LonMaker drawings synchronized with the LNS network database and with each other. The LonMaker drawings will remain synchronized even as multiple users and applications access and modify the drawings and the LNS network database.

LNS Event Tracking

The LonMaker tool uses LNS events to detect changes to a LonMaker drawing made by LNS applications other than the LonMaker tool, as well as changes in the status of devices as reported by the LNS server. Actions tracked exclusively by LNS events consist of detecting and commissioning application devices and routers. LNS events track other actions that are also tracked in the LonMaker Event Log described in the next section. These actions include upgrading application devices; creating application devices, routers, subsystem s, and connect io ns; d e l et i ng appl i cat i on de vi ces, ro ut ers, and connections; and renaming application devices, routers, functional blocks, and subsystems.

LonMaker Event Log

The LonMaker tool stores every change made to a LonMaker drawing in a shared log called the LonMaker event log. The LonMaker event log is kept in the LNS network database so that all LonMaker tools on a network can view the events logged by all other LonMaker tools on the same network—including tools that are not active at the same time. All LonMaker tools check the log when they open a LonMaker drawing and periodically thereafter (every 10 seconds by default), and update their copies of the LonMaker drawing based on the log entries.

Additional benefits of the LonMaker event log are that it can be used by the LonMaker tool to restore your work if you computer fails while you are updating a drawing, and it reduces the number of times that you need to resynchronize a LonMaker drawing. You may still need to resynchronize if applications other than the LonMaker tool make changes to the LNS network database that affect a LonMaker drawing, or if log entries are deleted.

You can view the LonMaker event log, and you can export it to an XML file. See LonMaker Event Log in Chapter 7, Maintaining Networks, for how to do this.

Resource Usage Reports

The LonMaker Turbo Editions include the following new features to help you determine usage of critical network resources such as group IDs, subnet IDs, selectors, and network variable alias table space. See Using Resource Usage Reports in Chapter 8, Managing Networks, for more information on using these new features.

Network Resource Report

You can display a summary of the usage of group IDs, subnet IDs, and selectors in your network. The usage of these resources is displayed in a network resource report. This report displays the number of group IDs, subnet IDs, and selectors that have been allocated out of those available in your LonMaker drawing. Individual color status bars indicate the percentage consumed and availability of each resource. As more network resources are consumed, the status bar fills up and changes color.

• Green. Resource is readily available (up to 75 percent used).

• Yellow. Resource is available, but beginning to run low (between 75 and 90 percent used).

10 Introduction

• Red. Resource is critically low (over 90 percent used).

To view the network resources report, open the LonMaker menu and then click LonTalk Network Resources.

Alias Table Summary

You can display a summary of the usage and availability of alias table entries for a device in a ToolTip. The device shape ToolTip lists the total number of network variable aliases for the device, and the number of aliases currently available.

To view the alias table summary, move the pointer over the desired device shape and keep it there for the ToolTip delay (the default ToolTip delay is 2 seconds). The device shape ToolTip will then appear. The total and available network available alias counts are by default the last two items listed in the ToolTip.

Application Integration and XML Export/Import

The LonMaker Turbo Editions include the following new features to support integration with other applications and provide enhanced network reports.

Exporting a LONWORKS Network XML File

You can export your LonMaker network to a LONWORKS network XML file using the new LonMaker XML Plug-in. The export can be fully automated, or you can manually export your LonMaker network. You can export selected items, subsystems, or your entire network to an XML file. The XML file will consist of a report of all the devices, connections, network variables, configuration properties, and other data within the specified network scope. In addition, the exported XML file by default will include a reference to an XSLT style sheet that you can use to transform the file into a LonMaker Network Report. You can then view the LonMaker Network Report in your Web browser.

See Exporting a L

XML, for more information on using the XML export feature.

ONWORKS Network XML File in Chapter 9, Exporting and Importing Networks with

Importing a LONWORKS Network XML File

You can import a LONWORKS network XML file from another application using the LonMaker XML Plug-in. The import can be fully automated, or you can manually import a LONWORKS network XML file using the LonMaker tool. Importing a LONWORKS network XML file will update or create a LonMaker drawing by creating, modifying, and dele ti n g ob ject s i n the LNS network database.

See Importing a L

XML, for more information on using the XML import feature.

ONWORKS Network XML File in Chapter 9, Exporting and Importing Networks with

Automatic Extension Record Copying

You can enable automatic extension record copying so that extension records will automatically be copied when you create a new subsystem, device, or functional block from a copy (a custom master shape or an existing shape). This is useful for integrating with other LNS applications that store device-specific data in extension records. When enabled, the LonMaker tool copies extension records that are identified in the LNS network database as records that should be copied. To enable automatic extension record copying, select the Enable Configuration Properties check box in the network properties: Configuration Properties options category.

Plug-in Enable/Disable

You can enable or disable plug-ins. This is useful for disabling plug-ins that you have installed but are no longer using. See Enabling and Disabl i n g Pl ug -i ns in Chapter 11, Using LNS Plug-Ins, for more information on enabling and disabling plug-ins.

LonMaker User’s Guide 11

LNS Network Database

The LonMaker Turbo Editions includes new features to help you backup, validate, repair, and synchronize your network database. These features are described in the following sections.

LNS Hot Backup

You can make a hot backup of the network database while you or another user is working in the same network—without disrupting the other LNS applications. A hot backup is a backup that is created while one or more LNS applications are accessing the LNS network database. The LonMaker tool creates the hot backup as a shadow copy of the LNS network database.

To use hot backups, select the Use LNS Hot Backup check box in the network properties: Backup/Restore options category. This check box is selected by default. When you attempt to back up your network in the LonMaker drawing and another application is accessing the LNS network database, the LonMaker tool automatically creates a hot backup of that database.

If this check box is cleared, you can still use the hot backup feature. When you attempt to back up your network in the LonMaker drawing, a prompt will open giving you the option to close all applications accessing the network database or make a hot backup. Click Yes to make a hot backup.

See Manually Backing Up a LonMaker Network in Chapter 7, Maintaining Networks, for more information on using hot backups.

Scheduled Backups

You can use the LonMaker tool (and the Windows Task Scheduler) to automatically backup the network database periodically. To use the LonMaker tool to schedule automatic backups, open the network properties: Backup/Restore options category and enter the desired database backup interval in the Database Backup field under the Auto Save Interval box. The LonMaker tool will then create a hot backup of the network every n minutes, where n is the specified backup interval.

See Scheduling Drawing Saves and Database Backups in Chapter 7, Maintaining Networks, for more information on scheduling automatic database backups.

Automatic Resynchronization

The LonMaker tool will attempt to automatically resynchronize a LonMaker drawing to its network database when it detects an inconsistency internally or between the drawing and the database. This resynchronization will be transparent, except that you may notice a slightly lower response time during the resynchronization. The LonMaker tool will perform an automatic resynchronization when a Visio shape in the LonMaker drawing or a LonMaker object in the LNS database is missing or cannot be found, or when there is missing or incorrect information in the LonMaker drawing. If the automatic resynchronization fails for any reason, you will be prompted to manually resynchronize the LonMaker drawing to the network database.

See Automatic LonMaker Drawing Synchronization in Chapter 7, Maintaining Networks, for more information on this feature.

Database Validation and Repair

You can validate the structure of and repair the LNS network database and optionally resynchronize the LonMaker drawing to the repaired database. You must be using the LonMaker tool on a local client to use the database validation and repair features.

See Manual Network Synchronization in Chapter 7, Maintaining Networks, for more information on this feature.

12 Introduction

Visio 2003 Integration

Tablet PC Support

You can run the LonMaker tool on a Tablet PC. The ease of portability of a Tablet PC makes it ideal for installing a network under the ad-hoc system scenario, in which you both design and commission the network onsite. You can wirelessly connect the Tablet PC to an i.Lon IP-852 router that is attached to the physical network, and then carry the Tablet PC around the site, designing the LonMaker drawing and commissioning devices at the same time. Using the LonMaker tool on a Tablet PC also makes it easy to make last-minute changes or additions to an engineered design (a LonMaker network designed offsite and then installed), and upgrade and replace devices.

LonMaker Drawing Markup with Digital Ink

Using the digital ink feature in Visio 2003 on a Tablet PC, you can easily markup a LonMaker drawing with a special tablet pen, and save the markup as part of the drawing. The markups can be included in a LonMaker backup and then later restored. Digital ink provides an effective means for designers and integrators to communicate with each other as demonstrated in the following figure.

Windows Compatibility

You can use the LonMaker tool on a computer running Windows XP (Professional, Home, and Tablet PC 2005 Editions), Windows 2003 Server, or Windows 2000.

Professional, Standard, and Trial Editions

Three editions of the LonMaker Turbo Integration Tool are available: Profession al, Standard, and Trial. These editions differ in the edition of Visio 2003 included (Professional or Standard), number of LonMaker credits included, and the expiration of the LonMaker tool software license. The advantage of Visio 2003 Professional is that it includes all of the business diagramming tools of the Standard edition, as well as additional comprehensive technical and drawing solutions.

Professional Edition

The professional edition ships with Visio 2003 Professional, comes with 64 LonMaker credits, and does not expire. You can purchase additional LonMaker credits for the professional edition (see Adding LonMaker Credits).

LonMaker User’s Guide 13

Standard Edition

The standard edition ships with Visio 2003 Standard, comes with 5 LonMaker cr edits, and does not expire. You can purchase additional LonMaker credits for the standard edition (see Adding LonMaker Credits).

Trial Edition

The trial edition ships with a 30-day evaluation copy of Visio 2003 Professional, does not come with any LonMaker credits, and requires licensing the professional or standard edition to continue using th e LonMaker tool after the 30-day trial period ends. The trial edition also has the following restrictions:

• All drawings created with the trial edition include a “LonMaker Demonstration Network” banner in the background.

• Networks are limited to a maximum of six devices.

• You cannot add LonMaker credits using the trial edition.

LonMaker Network Designs

A LonMaker Network Design consists of an LNS network database and a LonMaker drawing.

LNS Network Database

An LNS network database contains definitions of the devices contained within a LonMaker drawing, including information such as the name, address, application configuration, and network connections for each device. Whenever you change a LonMaker drawing, the LonMaker tool automatically uses LNS services to update the information in the LNS network database associated with the LonMaker drawing.

Every LonMaker drawing is associated with an LNS network database, and the LNS network database is always located on the computer with the LNS Server. The LNS Server may be located on the same computer as the LonMaker tool, or it may be located on a different computer. You can maintain backup copies of the LNS network database, and you can move the LNS Server and LNS network database to a backup computer. See Backing Up a LonMaker Network Design in Chapter 7, Maintaining Networks, for more information.

LonMaker Drawing

A LonMaker drawing contains the graphi cal rep resentation of the LONWORKS network. A LonMaker drawing consists of one or more drawing files, and the drawing files consist of one or more pages that each represent a subsystem. One drawing file is designated as the top-level drawing file; this drawing file is the one created when you create a new LonMaker network design. A subsystem within the top-level drawing file is designated as the top-level subsystem; this subsystem is represented by the first page of the drawing that you create when you create a new LonMaker network design.

A LonMaker drawing is always located on the computer running the LonMaker tool. If you are running multiple LonMaker tools on the same LonMaker drawing, each computer running a LonMaker tool must have a copy of the LonMaker drawing. The LonMaker tool automatically keeps these multiple copied synchronized. Multiple-user operation is described in Managing Multiple Remote Clients in Chapter 3, Getting Started.

LONWORKS Basics

This section provides an overview of the following topics and defines related terms:

ONWORKS networks

• L

• LonMaker client types

14 Introduction

+ 393 hidden pages

Echelon LonMaker User Manual

Specifications and Main Features

Frequently Asked Questions

User Manual

Preface

Purpose

Audience

Related Reading

Content

For More Information and Technical Support

Table of Contents

Introduction to the LonMaker Tool

What’s New for LonMaker Turbo Editions

LonMaker Design Manager

One-Click Network Creation

New Network and LonMaker Default Options Tabs

Network Wizard Accelerator

LonMaker Shape Tooltips

Application Devices and Routers

Simplified Wizards

Automatic Channel Selection

Channel Reassignment with the Connector Tool

Simplified Shape Menus

Firmware Upgrade

Device-Specific Configuration Property Support

Passive Configuration Mode

Enhanced Subsystem Recovery

Active Device Template and Resource File Updates

Accelerated Device Interface Verification

Functional Blocks

One-Page Functional Block Wizard

Automatic Device Selection

Device Re-assignment with the Connector Tool

Simplified Shortcut Menu

Creating Dynamic Functional Blocks

Connections

Creating a Connection with the Connector Tool

Automatic Connection Description Selection

Fast Connection Property Modification

New Connection Descriptions

Hiding and Showing Connector Shapes

Automatic Reference Connection Shape Alignment

Monitoring—Data Point Shape

Network Explorer

Network Variable Access

New Channel and Device Template Views

Device Template Menu

Multi-User Modification

Automatic Drawing Synchronization

LNS Event Tracking

LonMaker Event Log

Resource Usage Reports

Network Resource Report

Alias Table Summary

Application Integration and XML Export/Import

Exporting a LONWORKS Network XML File

Importing a LONWORKS Network XML File

Automatic Extension Record Copying

Plug-in Enable/Disable

LNS Network Database

LNS Hot Backup

Scheduled Backups

Automatic Resynchronization

Database Validation and Repair

Visio 2003 Integration

Tablet PC Support

LonMaker Drawing Markup with Digital Ink

Windows Compatibility

Professional, Standard, and Trial Editions

Professional Edition

Standard Edition

Trial Edition

LonMaker Network Designs

LNS Network Database

LonMaker Drawing

LONWORKS Basics