Echelon IzoT Commissioning Tool User Manual

IzoTTM
Commissioning Tool
User’s Guide

Design, install, operate, and maintain IzoT and LONWORKS
networks with the IzoT Commissioning Tool.

®

078-0509-01A

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

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

Neuron

Chips 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 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 PARTICUL AR PURP OSE,
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.

Printed in the United States of America.
Copyright ©1997–2014 by Echelon
Corporation.
Echelon Corporation
www.echelon.com

ii Preface

Table of Contents

Preface ................................................................................................... xi

Purpose .......................................................................................................... xii

Audience ......................................................................................................... xii

System Requirements .................................................................................... xii

IzoT Commissioning Tool Documentation ...................................................... xii

For More Information and Technical Support ................................................ xiii

Content .......................................................................................................... xiv

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

Introduction to the IzoT Commissioning Tool .................................................. 2

New Features .................................................................................................. 2

No-Cost Device Installation ....................................................................... 2

Automated Product Activation ................................................................... 3

Annual Product Maintenance .................................................................... 3

Increased Device Compatibility ................................................................. 3

Longer Database Directory Paths ............................................................. 3

Improved Windows Compatibility .............................................................. 3

Additional OpenLNS Events ..................................................................... 3

New IzoT Commissioning Tool Menus ..................................................... 3

IzoT Commissioning Tool Versions ................................................................. 4

IzoT Commissioning Tool Network Designs .................................................... 5

OpenLNS Network Database .................................................................... 5

OpenLNS CT Drawing .............................................................................. 5

LONWORKS Basics ........................................................................................... 5

Networks ................................................................................................... 5

Devices ..................................................................................................... 5

Protocol ..................................................................................................... 5

Device Templates ..................................................................................... 6

Channels ................................................................................................... 6

Routers ...................................................................................................... 6

Applications ............................................................................................... 6

Network Variables ..................................................................................... 6

Configuration Properties ........................................................................... 7

Functional Blocks ...................................................................................... 8

Functional Profiles..................................................................................... 8

Standard Network Variable and Conf iguration Property T ypes ......... 8

User-defined Standard Network Variable and Configur ation

Property Types ..................................................................................... 9

Subsystems ............................................................................................... 9

Supernodes ............................................................................................... 9

Visio Basics ..................................................................................................... 9

2 Installing and Activating the IzoT Commissioning Tool .............. 12

Ordering the IzoT Commissioning Tool ......................................................... 13

Installing and Activating the IzoT Commissioning Tool ................................. 13

Manually Activating IzoT Commissioning Tool .............................................. 20

3 Getting Started ................................................................................ 26

Design Overview ........................................................................................... 27

Defining Network Requirements and Organization ................................. 27

Selecting a Network Installation Scenario .............................................. 27

Engineered System Scenario ........................................................... 27

Ad-Hoc System Scenario ................................................................. 28

IzoT Commissioning Tool User’s Guide iii

Determining User Permissions ............................................................... 28

Optimizing IzoT Commissioning Tool Network Performance ................. 28

Drawing Files .................................................................................... 28

Network Changes ............................................................................. 29

Connections ...................................................................................... 29

Sharing the OpenLNS Interface with the L N S DD E Server ............. 29

Functional Blocks ............................................................................. 30

Subsystems ...................................................................................... 30

IzoT Commissioning Tool Design Manager Overview .................................. 30

Options .................................................................................................... 33

New Network Options ............................................................................. 35

IzoT Commissioning Tool Stencils .......................................................... 37

IzoT Commissioning Tool Default Options.............................................. 38

Setting Up a Network Interface...................................................................... 39

Optimizing Network Interface Performance ............................................ 39

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

Creating and Opening IzoT Commissioning Tool Networks ......................... 41

Creating an IzoT Commissioning Tool Network Design ......................... 41

Creating an IzoT Commissioning Tool Network from an Existing

OpenLNS Database .................................................................................. 47

Working with Digital Signatures ........................................................ 51

Copying an IzoT Commissioning Tool Network Design.......................... 52

Opening an IzoT Commissioning Tool Network Design ......................... 55

IzoT Commissioning Tool Client Types .................................................. 57

Local Client ....................................................................................... 57

Remote Full Client ............................................................................ 59

Remote Lightweight Client................................................................ 62

Using Network Service Device SmartShapes ............................................... 66

Listing Network Service Devices ...................................................... 67

Upgrading Network Service Devices ................................................ 68

Replacing a Local Network Service Device ...................................... 68

User Profiles .................................................................................................. 68

Creating a New User Profile ................................................................... 69

Changing Passwords .............................................................................. 71

Modifying and Deleting User Profiles ...................................................... 72

Changing User Profiles in an OpenLNS CT Drawing ............................. 72

Using IzoT Commissioning Tool Remotely with User Profiles ................ 73

4 Designing Networks ....................................................................... 75

Creating a LONWORKS Network ..................................................................... 76

Creating an OpenLNS CT Drawing ............................................................... 76

Creating Application Devices .................................................................. 77

Using Automatic Channel Selection for Devices .............................. 81

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

Creating Functional Blocks ..................................................................... 83

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

Reassigning a Functional Block ....................................................... 87

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

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

Creating a New Functional Block from a Configured

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

Updating a Functional Block from a Configured

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

Creating a Functional Block Master SmartShape ............................ 91

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

Deleting Dynamic FBs ............................................................... 93

iv Preface

Creating Dynamic Functional Block Master SmartShapes ........ 93

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

Adding a Message Tag SmartShape to a Virtual

Functional Block ......................................................................... 94

Deleting Message Tag SmartShapes ........................................ 94

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

Creating a Network Variable SmartShape ....................................... 95

Creating a Network Variable Master SmartShape ........................... 95

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

Creating Network Variables Using Generic Network

Variable SmartShapes ............................................................... 96

Creating Dynamic Network Variables Using Network

Variables SmartShapes from the IzoT Commissioning

Tool NV SmartShapes Stencil ................................................. 100

Creating Dynamic Network Variables Using Network

Variable Master SmartShapes ................................................. 100

Changing a Network Variable Name .............................................. 101

Changing Network Variable Position .............................................. 101

Deleting a Network Variable SmartShape ...................................... 101

Deleting Dynamic Network Variables ............................................. 103

Creating a Router ........................................................................................ 103

Using Automatic Channel Selection for Routers ............................ 108

Changing a Router Channel ........................................................... 108

Creating a Channel ...................................................................................... 108

Creating a Subsystem ................................................................................. 110

Creating a Supernode ........................................................................... 112

Renaming and Deleting a Supernode Network Variable ...................... 113

Copying a Subsystem or Supernode .................................................... 113

Creating Connections .................................................................................. 114

Creating a Connection with the Connector SmartShape ...................... 115

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

Creating a Connection with the Network Variable Connection

Dialog Box ............................................................................................. 116

Using Reference Connection SmartShapes ......................................... 119

Aligning Reference Connection SmartShapes ............................... 119

Using Connection Descriptions ............................................................. 120

Connection Description Properties ................................................. 120

Message Service Type ............................................................ 120

Addressing Mode ..................................................................... 121

Viewing and Creating Connection Descriptions ............................. 121

Using Automatic Connection Description Selection ....................... 123

Changing the Connection Description for a Connection ................ 125

Hiding and Showing Connector SmartShapes ..................................... 126

Hiding and Showing All Connector SmartShapes in a Subsystem 126
Hiding and Showing Selected Connector SmartShapes

Attached to Functional Blocks or Supernodes ............................... 126

Hiding and Showing Connector SmartShapes Attached to a

Functional Block ............................................................................. 128

Viewing and Navigating IzoT Commissioning Tool Network Design........... 130

Opening any Subsystem ................................................................ 130

Opening a Parent Subsystem......................................................... 131

Using Network Navigators .............................................................. 131

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

Navigating a Network with the Network Explorer ........................... 134

Managing a Network with the Network Explorer ............................ 134

IzoT Commissioning Tool User’s Guide v

Managing and Editing Device T em plates with the

Network Explorer ............................................................................ 134

Managing Device Templates ................................................... 134

Editing Device Template Properties......................................... 135

Working with IzoT Commissioning Tool Layers .......................................... 137

Working with IzoT Commissioning Tool SmartShapes ............................... 138

Viewing and Setting IzoT Commissioning Tool SmartShape Properties138

Moving an IzoT Commissioning Tool SmartShape ............................... 138

Repositioning an IzoT Commissioning Tool SmartShape .............. 138

Changing the Subsystem for an IzoT Commissioning

Tool SmartShape ............................................................................ 138

Changing the Channel for an IzoT Commissioning

Tool SmartShape ............................................................................ 139

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

Moving an OpenLNS Computer to a Different Channel........... 141

Copying an IzoT Commissioning Tool SmartShape ............................. 142

Deleting an IzoT Commissioning Tool SmartShape ............................. 142

Customizing the User Interface ................................................................... 143

Editing the Title Block............................................................................ 143

Using IzoT Commissioning Tool SmartShape Menus .......................... 143

Using AutoCAD Drawings ........................................................................... 144

Importing an AutoCAD Drawing ............................................................ 144

Exporting an AutoCAD Drawing ............................................................ 145

5 Installing Networks ....................................................................... 147

Network Installation Overview ..................................................................... 148

Commissioning a Device ............................................................................. 148

Selecting Devices for Commissioning................................................... 149

Loading a Device Application Image ..................................................... 150

Setting the Initial Device State and Source of Configuration

Property Values ..................................................................................... 152

Setting the Initial Appli cation Devi ce Stat e and Sou rce of

Configuration Property Values ........................................................... 153

Setting the Initial Router State ........................................................ 155

Setting the Neuron ID............................................................................ 156

Selecting the Device Identification Method .................................... 156

Using the Service Pin Method ........................................................ 157

Using the Manual Entry Method ..................................................... 159

Entering a Neuron ID Manually ................................................ 159

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

Commissioning an IP-852 Router................................................................ 160

Commissioning Using Device Discovery ..................................................... 160

6 Monitoring and Controlling Networks ......................................... 167

Monitoring and Controlling O verv iew .......................................................... 168

Using Monitored Connections ..................................................................... 168

Displaying a Network Variable Value .................................................... 169

Using the OpenLNS CT Browser................................................................. 170

Starting the OpenLNS CT Browser ....................................................... 170

The OpenLNS CT Browser Toolbar ...................................................... 172

Customizing the Browser ...................................................................... 172

Customizing Browser Columns ...................................................... 173

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

Adjusting the Width of Browser Columns ................................ 173

Customizing Browser Rows............................................................ 173

Selecting Browser Rows to be Displayed ................................ 173

vi Preface

Hiding Browser Rows ............................................................... 174

Saving Browser Customization....................................................... 175

Monitoring Network Variables ............................................................... 175

Enabling Network Variable Monitoring ........................................... 175

Disabling Network Variable Monitoring .......................................... 175

Getting Network Variable Values ................................................... 175

Using Bound Updates ........................................................................... 176

Binding Network Variables to the Host ................................................. 176

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

Setting Values ................................................................................ 177

Setting Values for Structured Objects ...................................... 177

Setting Values for Configuration Property Arrays .................... 179

Clearing Values .............................................................................. 180

Getting Values ................................................................................ 180

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

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

Displaying Error Messages ................................................................... 183

Managing Functional Blocks ................................................................. 183

Using Data Point SmartShapes ................................................................... 184

Adding and Monitoring a Data Point SmartShape ................................ 184

Updating a Data Point ........................................................................... 187

Updating a Scalar Data Point ......................................................... 188

Updating a Structured Data Point ................................................... 188

Updating an Enumerated Data Point .............................................. 189

Getting a Data Point Value ................................................................... 189

Creating and Using a Custom Data Point Mas ter SmartShape ............ 190

Creating a Custom Data Point Master SmartShape ...................... 190

Using a Custom Data Point Master SmartShape ........................... 190

Copying and Creating a Data Point SmartShape ................................. 191

Deleting a Data Point SmartShape ....................................................... 191

Creating an HMI with Data Point SmartShapes .................................... 191

Writing Data Point SmartShape Values ......................................... 192

Using an Add-On to Write Values ............................................ 192

Using a Macro to Write Values ................................................ 194

Reading Data Point SmartShape Values ....................................... 194

Using an Add-On to Read Values ............................................ 194

Using a Macro to Read Values ................................................ 195

Organizing HMIs ............................................................................. 196

7 Maintaining Networks ................................................................... 197

Maintaining Networks Overview .................................................................. 198

Loading Devices .......................................................................................... 198

Selecting the Devices to Load .............................................................. 199

Selecting or Creating a Device Template ............................................. 199

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

Selecting Initial Device State and Source of Configuration

Property Values ..................................................................................... 202

Replacing Devices ....................................................................................... 204

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

Replacing a Device in the IzoT Commissioning Tool Network ............. 204

Removing the Old Device ..................................................................... 207

Decommissioning Devices .......................................................................... 207

Resynchronizing Configuration Properties .................................................. 207

Using IzoT Commissioning Tool as a Passive Configuration Tool .............. 209

Backing up an IzoT Commissioning Tool Network Design ......................... 209

Manually Backing Up an IzoT Commissioning Tool Network ............... 210

IzoT Commissioning Tool User’s Guide vii

Creating a Backup from an OpenLNS CT Drawing ........................ 210

Creating a Backup from the IzoT Commissioning Tool

Design Manager ............................................................................. 212

Scheduling Drawing Saves and Database Backups ............................. 213

Scheduling Backups with IzoT Commissioning Tool ............... 213

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

Restoring an IzoT Commissioning Tool Network .................................. 216

Restoring a Network Database Backup ......................................... 216

Restoring an IzoT Commissioning Tool Drawing Backup .............. 218

Restoring a Full Network Backup ................................................... 219

Recovering an IzoT Commissioning Tool Network ..................................... 223

Subsystem Recovery Options ............................................................... 224

Using Subsystem Paths ................................................................. 226

Using Subsystem IDs ..................................................................... 226

Using the OpenLNS Database Recovery Wizard ................................. 227

Network Recovery vs. Database Backup............................................. 236

Resynchronizing an IzoT Commissioning Tool Network ............................. 237

Automatic OpenLNS CT Drawing Synchronization .............................. 237

OpenLNS Event Tracking ............................................................... 238

IzoT Commissioning Tool Event Log .............................................. 238

Viewing the IzoT Commissioning Tool Event Log ................... 238

Exporting the IzoT Commissioning Tool Event Log ................. 239

Manual Network Resynchronization ..................................................... 241

Refreshing the IzoT Commissioning Tool Network ............................... 249

Merging IzoT Commissioning Tool Networks .............................................. 249

Network Merge Considerations ............................................................. 250

Limitations....................................................................................... 250

Information Loss ............................................................................. 250

Merging IzoT Commissioning Tool Networks ....................................... 251

8 Managing Networks ...................................................................... 255

Using the IzoT Commissioning Tool Device Manager ................................ 256

Opening the IzoT Commissioning Tool Device Manager ..................... 256

Managing Devices................................................................................. 257

Managing Functional Blocks ................................................................. 258

Managing Routers ................................................................................. 260

Device Manager Settings ...................................................................... 261

Using IzoT Commissioning Tool Styles Overview ....................................... 262

IzoT Commissioning Tool Device Styles............................................... 262

IzoT Commissioning Tool Functional Block Styles ............................... 263

Network Variable and Message Tag SmartShape Styles ..................... 265

IzoT Commissioning Tool Connector SmartShape Styles .................... 265

Generating a Device Status Summary Report ............................................ 266

Using Resource Usage Reports .................................................................. 269

Network Resource Report ..................................................................... 269

Alias Table Summary ............................................................................ 270

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

Using XML Export/Import Overview ............................................................ 274

Exporting a LONWORKS Network XML File ........................................... 274

Viewing an IzoT Commissioning Tool Network Report ......................... 276

Importing a LONWORKS Network XML File ............................................ 279

10 Managing IzoT Commissioning Tool Licenses ........................... 281

Commissioning Devices with IzoT Commissioning Tool ............................. 282

Overview of IzoT Commissioning Tool Licensing ........................................ 282

viii Preface

Maintaining IzoT Commissioning Tool ........................................................ 282

Upgrading IzoT Commissioning Tool Standard Edit ion to

IzoT Commissioning Tool Professional Edition .......................................... 288

Renewing IzoT Commissioning Tool Annual Maintenance ......................... 291

Transferring IzoT Commissioning Tool Licenses ........................................ 291

11 Using Plug-ins .............................................................................. 294

Using Plug-ins Overview ............................................................................. 295

Starting a Plug-in ......................................................................................... 295

Viewing Plug-in Information ......................................................................... 297

Viewing Plug-in Status ................................................................................. 298

Re-Registerin g Plu g -ins ............................................................................... 299

Disabling and Enabling Plug-ins .................................................................. 300

Disabling a Plug-in ................................................................................ 300

Enabling a Plug-in ................................................................................. 301

12 Creating and Using Custom IzoT Commissioning Tool SmartShapes and

Stencils ............................................................................................... 302

IzoT Commissioning Tool Stencils .............................................................. 303

Creating a Custom IzoT Commissioning Tool Stencil ................................. 303

Creating Custom IzoT Commissioning Tool Master SmartShapes ............. 304

Using Custom IzoT Commissioning Tool Master SmartShapes ................. 305

Device Master SmartShapes ................................................................ 305

Functional Block Master SmartShapes ................................................. 306

Subsystem or Supernode Master SmartShapes .................................. 306

Connection Master SmartShapes ......................................................... 307

Creating Additional Channe ls ............................................................... 309

Editing Master SmartShape User Defined Cells ......................................... 309

Additional Device User Cells ................................................................. 310

Additional Functional Block User Cells ................................................. 315

Additional Router SmartShape User Cells ............................................ 316

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

Adding a Bitmap to a Device Master SmartShape ...................................... 316

Viewing and Editing VBA Code Assoc iated w ith an IzoT

Commissioning Tool Network Drawing ....................................................... 317

Appendix A Setting IzoT Commissioning Tool Default Options ..... 318

Setting IzoT Commissioning Tool Default Options ...................................... 319

Backup/Restore Options ....................................................................... 320

Configuration Properties Options .......................................................... 324

Device Options ...................................................................................... 326

Functional Block Options ...................................................................... 328

General Options .................................................................................... 331

OpenLNS Event Options ....................................................................... 332

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

Network Explorer Options ..................................................................... 337

NV Browser/Monitoring Options ............................................................ 338

IzoT Commissioning Tool Font Options ................................................ 339

Recovery Options .................................................................................. 341

Service Pin Options............................................................................... 343

Shape ToolTips Options ....................................................................... 344

Synchronization Options ....................................................................... 345

Warnings Options .................................................................................. 346

Appendix B Glossary ........................................................................ 349

Glossary ....................................................................................................... 350

IzoT Commissioning Tool User’s Guide ix

Appendix C OpenLNS Software License Agreement ...................... 369

OpenLNS CT Software License Agreement ................................................ 370

Appendix D Software License Transfer Agreement ........................ 377

Software License Transfer Agreement ........................................................ 378

x Preface

Preface

The IzoT Commissioning Tool is a software package for designing, installing, and
maintaining multi-vendor, open, interoperable LONWORKS® control networks and
IzoT networks. Installing the IzoT Network Services Server on the same computer
with the OpenLNS Commissioning Tool converts the OpenLNS Commissioning Tool
to an IzoT Commissioning Tool. The product names referenced by the OpenLNS
Server and the OpenLNS Commissioning Tool are not all updated to the new IzoT
names by the IzoT Network Services Server. You will see references to both sets of
names in the software and documentation.

Based on Echelon's OpenLNS network operating system, the Izot Commissioning

Tool combines support for open LONWORKS control networks and IzoT networks
with a user-friendly Microsoft Visio interface. The result is a software tool that’s

robust enough to work with all your devices, yet economical enough to leave behind

as an operations and maintenance tool. The IzoT Commissioning Tool complies with

the OpenLNS plug-in standard, and it is compatible with the LNS plug-in standard,

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

many other vendors.

IzoT Commissioning Tool User’s Guide xi

OpenLNS CT XML Programmer’s

Describes how to create and modify an OpenLNS network using

OpenLNS Programmer’s Guide (078-

Describes how to use the OpenLNS Object Server ActiveX

OpenLNS Programmer’s Reference

Provides reference information for writing OpenLNS tools,

LNSPlug-in Framework Develop er’s

Describes how to write system and device plug-ins using .NE T

Purpose

This guide outlines the the IzoT Commissioning Tool, and it describes ho w to use the IzoT
Commissioning Tool to design, commission, monitor and control, maint ai n, a nd ma nage a network.
The IzoT C ommissioning Tool includes online help that provides context-sensitive documentation that
supplements the information in this guide.

Audience

This guide is intended for system designers a nd integrators with an understand ing of control networks.

System Requirements

System requirements for computers runnin g t he the IzoT Commissioning tool are as follows:

• Microsoft

XP 32-bit.Echelon recommends that you install the latest service pack available from Microsoft
for your version of Windows.

• 500 MHz processor or faster. 2 GHz processor recommended.

• 2 GB or more of free disk space.

• 512 MB RAM. 2 GB RAM recommended.

®

Windows. Windows 8 64-bit and 32-bit or Windows 7 54-bit and 32-bit or Windows

• 1,024 MB page file minimum. 2,048 page file recommended.

• 1,024 x 768 or higher-resolution display with at least 256 colors.

• Mouse or compatible pointing device

• DVD-ROM drive.

• IP-852 network interface.

IzoT Commissioning Tool Documentation

The docume ntation for the IzoT Commissioning tool is provided as Adobe Acrobat PDF files and
online help files. The PDF file for this do c ument is installed in the Echelon OpenLNS CT program
folder when you install the IzoT Commissioning Tool software. You can also download the latest
OpenLNS documentation, including the late s t version of this guide, by going to the Echelon OpenLNS
Web site at www.echelon.com/openlns.

Guide

0437-01A)

(078-0437-01A)

the OpenLNS XML Plug-in.

Control to develop OpenLNS apps.

applications, and plug-ins. Describes the objects in the
OpenLNS Object hierarchy, and details their properties,
methods, a nd events.

Guide (078-0393-01A)

The following docume nt s supplement the material provided in this guide. Y ou can download these
documents from Echelon’s Web site at www.echelon.com/docs.

xii Preface

programming languages such as C# and Visual Basic .NET.

i.LON 600 Lon Works/IP Server U ser's

Describes how to install, configure, use, and manage the i.LON

Introduction to the LONW



Provides a high-level introduction to LONW

networks a nd

IP-852 Channel User’s Guide (078-

Describes how to configure an IP-852 channel with the Echelon

LONM



SNVT and SCPT Guide

Documents the standard network variable types (SNVTs) and

LONW



USB Network Interface

Describes how to install and use the U10 and U20 USB Network

IzoT NodeBuilder FX User’s Guide

Describes how to use the IzoT NodeBuilder tool to develop

PCC/PCLTA Network Interface User's

Describes how to install, configure, a nd te st the PCC-10,

SmartServer 2.0 User’s Guide (078-

Describes how to configure the SmartServer and use its

Guide (078-0272-01A)

ORKS

Platform (078-0183-01B)

0312-01A)

ARK

ORKS

User’s Guide (078-0296-01B )

(078-0516-01)

Guide (078-0450-01A)

600 IP-852 routers, and how to use the Echelon I P-852
Configurati on Server.

ORKS

the tools and component s that are used for deve loping, installing,
operating, and maintaining them.

IP-852 Configuration Server. You will need this information if
you plan on a ttaching your OpenLNS CT computer to an IP-852
channel.

standard configuration property types (SCPTs) used by

ONWORKS device applications. For more information, go the

L

ONMARK International Web site at

L
www.lonmark.org/technical_resources/resource_files.

Interfaces to connect an OpenLNS or OpenLDV application to a

ONWORKS network.

L

LONWORKS device applications and build and test prototype and
production L

ONWORKS devices

PCLTA-20, and PCLTA-21 network interface cards that you can
use to connect an OpenLNS or OpenLDV application to a

ONWORKS network.

L

0345-01F)

applications to manage control networks.

For More Information and Technical Support

The Echelon OpenL N S CT ReadMe document provides descriptions of known problems, if any, and
their workarounds. To vi ew the Echelon OpenLNS CT ReadMe document, click Start, point to
Programs, point to Echelon OpenLNS CT, and the n s elect Echelon Ope nLNS CT ReadMe.

If you have technical questions that are not answered by this document, the OpenLNS CT o nl ine he lp
files, or the Echelon OpenLNS CT ReadMe document, you can contact Echelon technical support.
There is no charge for software installation-related questions during the first 30 days after you receive
the OpenLNS CT DVD or purchase an OpenLNS CT activation key. To receive technical support
from Echelon, you must purchase support services from Echelon or an Echelon support partner. See

www.echelon.com/support for more information on Echelon support. Your OpenLNS CT distributor

may also provide customer support.
You can also enroll in training classes at Echelon or an Echelon training center to learn more about

using OpenLNS CT. You can find additional information about device development training at

www.echelon.com/training.

You can obtain technical support via phone, fax, or e-mail from your closest Echelon support center.
The contact information is as fo llows:

IzoT Commissioning Tool User’s Guide xiii

The Americas

English

Echelon Corporation

Europe

English

Echelon Europe Ltd.

Japan

Japanese

Echelon Japan

China

Chinese

Echelon Greater China

Other Regio ns

English

Phone: [phone]

Region Languages Supported Contact Information

Japanese

German
French
Italian

Attn. Customer Support
550 Meri dian Avenue
San Jose, CA 95126
Phone (tol l-free):

1.800-258-4LON (258-4566)
Phone: [phone]
Fax: [phone]

[e-mail]

Suite 12
Building 6
Croxley Green Busine s s Park
Hatters Lane
Watford
Hertfordshire WD18 8YH
United Kingdom
Phone: [phone]
Fax: [phone]

[e-mail]

Holland Hills Mori Tower, 18F
5-11.2 Toranomon, Minato-ku
Tokyo 105-0001
Japan
Phone: [phone]
Fax: [phone]

[e-mail]

Content

This guide includes the following c ontent:

• Introduction: Provides an introduction to the IzoT Commissioning tool, new features; a nd the

basics of IzoT commissioning tool network designs, L

• Installing and Activating the IzoT Commissioning Tool – describes how to order and install the

IzoT Commissioning Tool and Microsoft Vision 2010, and then how to activate the IzoT
Commissioning Tool.

English

Japanese

ONWORKS, and Visio.

Rm. 1007-1008, IBM Tower
Pacific Century Place
2A Gong Ti Bei Lu
Chaoyang District
Beijing 100027, China
Phone: [phone]
Fax: [phone]

[e-mail]

Fax: [phone]

[e-mail]

xiv Preface

• Getting Started: Provides information on the planning an IzoT Commissioning Tool network

design; using the OpenLNS CT Design Manager; setting up a network interface; creating and
opening an OpenLNS CT network design; OpenLNS CT client types; using OpenLNS CT
remotely; and creating and using user profiles.

• Designing Networks: Describes how to design a network using the IzoT Commissioning Tool.

Covers how to create the following objects in an OpenLNS CT drawing: application devices,
functional blocks, network variables, rout ers, channels, and sub systems. Explains how to connect
network variables. Explains working with OpenLNS CT SmartShapes



and layers , customizing

the OpenLNS CT user interface, and using OpenLNS CT with AutoCAD drawings.

• Installing Networks: Describes how to install devices using t he IzoT Commissioning Tool,

including how to load applications into them, set the initial state of their ap plications, set the
source of their configuration properties, and select how they manage device-specific configuration
properties. It also explains the diffe rent metho ds for acquiring device Neuron IDs and how to
alternatively use the device discovery method to install a network.

• Monitoring and Controlling Networks: Describes how you can monitor and control the devices in

your network with the Iz oT Commissi oning To ol. Describes the three methods you can use to
read and/or write network variables and configuration properties: using monitored connections,
browsing with the OpenLNS CT Browser, and using Data Po int SmartShapes. 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 OpenLNS CT drawing with D ata Point and Visio SmartShapes.

• Maintaining Networks: Provides an overview of network maintenance tasks that you can perfor m

with the IzoT Commissioning Tool. Describes loading, replacing, and decommissioning devices.
Explains how to resynchronize and propagate configuration properties values. Explains how to
back up and restore an OpenLNS CT network; create an OpenLNS CT network by recovering
information from the physical network; and resynchronize the network database, OpenLNS CT
drawing, and physical devices. Explains how to merge two Op e nLN S CT net wor k s.

• Managing Networks: Explain s how to test and verify applicatio n d e vices, functional blocks, and

routers; describes the IzoT Commissioning Tool styles; and details how to generate device status
summary reports, network resource reports, and OpenLNS network reports.

• Managing OpenLNS CT Licenses: Provides an overview of IzoT Commissioning Tool licensing.

Describes how to upgrade the IzoT Commissioning Tool, upgrade an IzoT Commissioning Tool
Standard Edition to the Professional Edition, renew your IzoT Commissioning Tool annual
maintenance contract, and transfer an IzoT Commissioning Tool license.

• Exporting and Importing a Network Using XML: Describes how to export a L

ONWORKS network

to an IzoT Commissioning Tool network XML file; view a LONWORKS network XML file in a
Web browser; edit an IzoT Commissioning tool network XML file; and import a LONWORKS
network XML file to update a network.

• Using Plug-ins: Provides an overview of plug-ins and then describes how to start a plug-in, get

plug-in information, and re-re gister, e nable, and disable plug-ins.

• Creating and Using IzoT Commissiong Tool SmartShapes and Stencils: Describes how to create

an IzoT Commissioning Tool stencil and create and use custom master SmartShapes for devices,
functional blocks, subsystems, and connections. Explains how to modify a master SmartShape by
changing it s user-defined cells.

• Appendices: Includes the IzoT Commissioning Tool default options, a glossary, the OpenLNS C T

Software License Agreement, and the OpenLNS CT License Transfer Agreement.

IzoT Commissioning Tool User’s Guide xv

1

Introduction

This chapter provides an introduction to the IzoT Commissioning Tool, describes new

features, and explains the basics of IzoT Commissioning Tool Network Designs,

LONWORKS, and Visio.

IzoT Commissioning Tool User’s Guide 1

Introduction to the IzoT Commissioning Tool

The IzoT Commissioning Tool (OpenLNS CT and LonMaker) is a LONWORKS® network tool that runs
on the OpenLNS network operating system and uses Microso ft Visio
(Professional or Standard editions) as a graphical user interface. The OpenLNS network operating
system implements a client/server architecture with directory, installatio n, mana gement, monitor i ng,
and control services provided by an OpenLNS Server that is included with the IzoT Commissioning
Tool. The OpenLNS Server all o ws mult ip le user s r un ni ng IzoT Commissioning Tool and other
OpenLNS tools, applications, and plug-ins on separate computers to access the OpenLNS Server
simultaneously. This means that ma nagers, syst em integr ators, installers, and maintenance perso nnel
can all work on the same L
compatible with Windows 7 (64-bit and 32-bit), Windows Server 2008 R2 (64-bit), Windows Vista
with SP1 (32-bit), and Windows XP with SP3 (32-bit). The OpenLNS Server and IzoT
Commissioning Tool are backwards compatible with all existing LNS Turbo Edition databases and
LonMaker T urbo Edition drawings providing simple migration for existing LNS and LonMaker
networks.

The IzoT C ommissioning Tool can be used to manage all phases of a network’s life cycle—from the
initial des ign and commissioning t o the ongoing operation. 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.

• 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 OpenLNS CT Browser provides
complete access to all network variables and configuration properties.

ONWORKS network at the same time. The IzoT Commissioning Tool is

®

2010 or Visio 2003

• Network Documentation Tool. You can create an OpenLNS CT drawing during the ne twork

design and installation process. This OpenLNS CT drawing is an accurate, logical representation
of the installed physical network. The OpenLNS CT drawing is therefore an essential component
of as-built reports.

• Network Operation Tool. You can operate the network using the operator interface pages

contained wit hi n the OpenLNS CT drawing.

• Network Maintenance Tool. You can easily add, test, remove, modify, or replace devices, routers,

channels, subsystems, and connections to maintain the network.

New Features

This section describes the major features included with the OpenLNS Server and the IzoT
Commissioning Tool.

• No-cost device installation.

• Automated product activation (Internet connection required).

• Annual product maintenance.

• Increased device compatibility.

• Longer database directory paths.

• Improved Microsoft Windows

• Additional OpenLNS events.

• New OpenLNS CT Menus.

No-Cost Device Installation



Compatibility.

You can install devices without commissioning fees (known as “credits” in LNS Turbo and LonMaker
Turbo software). The IzoT Commissioning Tool features no-cost installation for all L

2 Introduction

ONWORKS

devices that comply with the ISO/IEC 14908-1 Control Network Protocol. This includes devices
based on the FT 6000 Smart Transceiver, FT 5000 Smart Transceiver, Neuron

®

Neuron
Transceiver, and also includes devices based on third-party ISO/IEC 14908-1 protocol processors.
This reduces network installation costs, makes installation and maintenance costs more predictable,
and simplifies the installation process.

5000 Processor, FT 3150/3120 Smart Transceiver, or PL 3170/3150/3120 Smart

®

6000 Processor,

Automated Product Activation

You can quickly install and activate the IzoT Commissioning Tool software. When you install the
IzoT Commissioning Tool software on an Internet-connected computer, the installer automatically
connects to the Echelon License Server, the License Server issues activation licenses for OpenLNS
Server and IzoT Commissioning Tool, and the licenses are installed on your computer. If your
computer does not have access to the Internet, you can manually activate your software via e-mail or
phone using the Echelon License Wizard, which provides easy-to-follow instructions for activating
Echelon software products. See Chapter 2, Installing and Activating IzoT Commissioning Tool, for
more information on installing a nd a c tivating IzoT Commissioning Tool.

Annual Product Maintenance

The IzoT Commissioning Tool software products each include one-year maintenance during which
you can download and install IzoT Commissioning Tool software updates and upgrades for free. You
can renew your annual maintenance anytime before it expires. Renewing your maintenance enables
you to continue installing software updates. If you do not renew the product's mai nt enance, you can
still use the product; however, you will not be able to install any updates or upgrades released after the
expiration of your maintenance period.

Increased Device Compatibility

OpenLNS supports network variables with up to 225 bytes. This expands OpenLNS compatibility to
include devices with network variables longer than 31 bytes.

Longer Database Directory Path s

IzoT Commissioning Tool supports network database paths up to 230 characters (the previous limit in
the LNS Turbo Server was 23 characters). This means that OpenLNS data can now be stored in any
user data directory on your computer.

Improved Windows Compatibility

The OpenLNS Server and IzoT Commissioning Tool are now installed in the C:\Program
Files\LonWorks dire c tory by default, which is a more compatible location with Windows conventions

for program file installation. Windows has become increasingly more restrictive about default access
permissio ns on the computer’s root directory. These restrictions caused compatibility issues with LNS
Turbo and LonMaker Turbo Editions, which were installed in the C:\LonWorks directory by default.
If you have previously installed the LonMaker tool or other LNS application on your computer and
you already have a L
directory.

ONWORKS directory, IzoT Commissioning Tool will continue to use your existing

Additional OpenLNS Events

To improve synchronization between IzoT Commissioning Tool and other OpenLNS apps, the
OpenLNS Server includes new events for when device templates and extensions are updated.

New IzoT Commissioning Tool Menus

If you are using IzoT Commissioning Tool with Visio 2010, you now click Add-ins to access the
options previously available in the LonMaker menu (for example, network options, network

IzoT Commissioning Tool User’s Guide 3

properties, synchronization, and documents [backup/restore, XML export/import]). This manual
assumes you are using Visio 2010—if you are using Visio 2003, open the LonMaker menu when this
document instructs you to clic k Add-ins and then select the desired option.

IzoT Commissioning Tool Versions

There are five versions of IzoT Commissioning Tool: IzoT Commissioning Tool Professional, IzoT
Commissioning Tool Professional Without Visio, IzoT Commissioning Tool Standard, IzoT
Commissioning Tool Standard Without Visio, and IzoT Commissioning Tool Trial. IzoT
Commissioning Tool Professional Without Visio and IzoT Commissioning Tool Standard Without
Visio require a separate purchase of Visio 2010 or 2003.

The advantage of IzoT Commissioning Tool Professional is that you can have an unlimited number of
OpenLNS ne tworks—IzoT Commissioning Tool Standard is limited to five networks. In addition,
IzoT Commissioning Tool Professional includes Visio 2010 Professional, which contains all of the
business diagramming tools of the Visio 2010 Standard edition, as well as additional comprehensive
technical and drawing solutio ns. You can purchase IzoT Commissioning Tool Standard and then
upgrade it later to IzoT Commissioning Tool Professional by purchasi ng the IzoT Commissioning Tool
Standard to Professional Upgrade Key (Echelon model number 38070-400). The upgrade key does not
include and upgrade to Visio 2010 Professional—it only upgrades the number of networks that you can
access with IzoT Commissioning Tool. See Upgrading IzoT Commissioning Tool Standard Edition to
IzoT Commissioning Tool Professional Ed ition in Chapter 10 for more information.

IzoT Commissioning Tool Professional and IzoT Commissioning Tool Standard each include one-year
maintenance during which you can d ownload and install IzoT Commissioning Tool software updates
and upgrades for free. You can renew your annual maintenance anytime before it expires by
purchasin g an IzoT Commissioning Tool Professional One-Year Maintenance Renewal (Echelon
model number 93800) or an IzoT Commissioning Tool Standard One-Year Maintenance Renewal
(Echelon model number 93810). Renewing your license enables you to continue installing software
updates and upgrad es. If you do not renew the p roduct's maintenance, you can still use the product;
however, you will not be able to install updates or upgrades released after your annual maintenance
expired.

You can download a free trial edition of the IzoT Commi s sioning Tool from the Echelon Web site at

www.echelon.com/openlns. The trial edition is limited to 2 five-device networks, runs for a maximum

of 60 minutes at a time, and expires after 60 days. Visio 2010 is required to use the trial edition, but it
is not included with the trial edition. The DVD version of the trial edition does incl ud e a trial version
of Visio 2010. You can convert the trial edition to IzoT Commissioning Tool Professional or IzoT
Commissioning Tool Standard by purchasing the OpenLNS Commissioning Tool Professional Edition
Without Visio Activation Key (Echelon model number 38060-400), OpenLNS Commissioning Tool
Professional Activation Key (E c helon model number 38050-400), OpenLNS Commissioning Tool
Standard Edition Without Visio Activation Key (Echelon model number 38160-400), or the OpenLNS
Commissioning Tool Standard Activation Key (Echelon model number 38150-400).

4 Introduction

IzoT Commissioning Tool Network Designs

An IzoT Commissioning Tool Network Design consists of an OpenLNS network database and an
OpenLNS CT drawing.

OpenLNS Network Database

An OpenLNS network database contains definitions of the devices contained within a LONWORKS
network and an OpenLNS CT drawing, including information such as the name, address, application
configuration, and ne twork connections for each device. Whenever you change an OpenLNS CT
drawing, IzoT Commissioning Tool automatically uses OpenLNS services to update the information in
the OpenLNS network database associated with the OpenLNS CT drawing.

Every OpenLNS CT drawing is associated with an OpenLNS network database, and the OpenLNS
network database is always located on the computer with the OpenLNS Server. The OpenLNS Server
may be located on the same computer as IzoT Commissioning Tool, or it may be located on a different
computer. You can maintain backup copies of the Izot Commisioning Tool network database, and you
can move the OpenLNS Server and OpenLNS network database to a backup computer. See Backing
Up an OpenLNS CT Network Design in Chap t er 7, Maintaining Networks, for more information.

OpenLNS CT Drawing

An OpenLNS CT drawing contains the graphical representation of the LONWORKS network. An
OpenLNS CT 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 OpenLNS CT 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 OpenLNS CT
network design.

An OpenLNS CT drawing is always located on the computer running OpenLNS CT or on a remote file
share. When multiple OpenLNS CT users are accessing the same OpenLNS CT drawing, OpenLNS
CT automatically keeps the drawing synchronized. Multiple-user operation is described in Automatic
OpenLNS CT Drawing Synchronization in Chapter 7.

LONWORKS Basics

This sectio n provides an overview of LONWORKS networks and defines related terms. The Glossary in
Appendix B provides a quick reference for specific terms.

Networks

A LONWORKS network consists o f intelligent devices (such as sensors, actuators, and controllers) that
communicate with each other usi ng a common protocol over one or more channels. Network devices
are sometimes called nodes.

Devices

Each device includes one or more processors and a transceiver. The processor(s) provide the device’s
intelligence and implement the ISO/IEC
serves as the device’s electrical interface to the communications channel.

14908-1 Control Network Protocol (CNP). The transceiver

Protocol

A device publishes and consumes information as instructed by the application that it is running. The
applications on different devices are not synchronized, and it is possible that multiple devices may all

IzoT Commissioning Tool User’s Guide 5

try to talk at the same time. Meaningful transfer of information between devices on a network,
therefore, requires organization in the form of a set of rules and procedures. These rules and
procedures are the communication protocol, which may be referred to simply as the protocol. The
protocol defines the format of the messages being transmitted between devices and defines the actions
expected when one device sends a message to another. The protocol normally takes the form of
embedded software or firmware code in each device on the network. The CNP
defined by the ISO/IEC 14908-1 standard (de fi ned nationally in the U nited State s , Europe, and China
by the ANSI/EIA 709.1, EN 14908, and GB/Z 20177 standards, respectively).

is an open protocol

Device Templates

A device template contains all the attributes of a given device type, such as its functiona l blocks,
network variables, and configuration properties.

Channels

A channel is the physical media between devices upon which the devices communicate. The Control
Network Protocol is media independent; therefore, numerous types of media can be used for channels
such as twisted pair, power line, fiber optics, IP, and radio frequency (RF). Channels are categorized
into channel types, and the channel types are characterized by the device transceiver. Common
channel types include TP/FT-10 (ISO/IEC 14908-2 twisted pair free topology channel), TP/XF-1250
(high-speed twisted pair channel), PL-20 (ISO/IEC 14908-3 power line channel), FO-20
(ANSI/CEA-709.4 fiber optics channel), and IP-852 (ISO/IEC 14908-4 IP-communication).

Different transceivers may be able to interoperate on the same channel; therefore, each transceiver type
specifies the channel type or types that it supports. The choice of channel type affects transmission
speed and distance as well as the network topology.

Routers

Multiple channels can be connected using routers. Routers are us ed to manage network message
traffic, extend the physical size of a channel (both length and number of devices attached), and connect
channels that use diffe rent media (channel types) together. Unlike other devices, routers are always
attached to at least two channels.

Applications

Every LONWORKS device contains an application that defines the device’s behavior. The application
defines the inputs and o utputs of the device. The inputs to a d evice can inc l ude information sent on

ONWORKS channels from other devices, as well as information from the device hardware (for

L
example, the temperature from a temperature sensing device). The outputs from a device can include
information sent on L
hardware (for example, a fan, light, heater, or actuator).

The appl ication may be i n the devic e when you purchase it, or you may load it into the device from
application files (.nld, .apb, and .nxe extensions) using the IzoT Commissioning Tool.

Applications in devices are divided into one or more functional blocks. A functional block is a
collection of network variables and configuration properties that are used together to perform one task.
For example, a four-port digital input module may have fo ur digital input functional blocks that
contain the configuration properties and output network variable for each of the four hard ware digital
inputs on the device.

ONWORKS channels to other devices, as well as commands sent to the device

Network Variables

Applications exchange information with other LONWORKS devices using network variables. Every
network variable has a direction, type, and length. The network variable direction can be either input
or output, depending on whether the network variable is used to receive or send data. The network
variable type determines the format of the data.

6 Introduction

Network variables of identical type and length but opposite directions can be connected to allow the
devices to share information. For example, an application on a lighting device could have an input
network variable based on the SNVT_switch type, while an application on a dimmer-switch device
could have an output network variable of the same SNVT_switch type. A network management tool
such as the IzoT Commissioning Tool could be used to connect these two devices, allowing the switch
to control the lighting device, as shown in the following figure:

A single network variable may be connected to multiple network variables of the same type but
opposite direction. The following example shows the same s witch being used to control three lights:

The application program in a device does not need to know where input network variable values come
from or where output network variable values go. When the applic ation program has a cha nge d val ue
for an output network va riable, i t simply assi gns the ne w va lue to the out put network variabl e.

Through a process called binding that takes place during network design and installation, the device is
configured to know the logical address of the other device or group of devices in the network
expecting that network variable’s values. The device’s embedded firmware assembles and sends the
appropriate packet(s) to these destinations. Similarly, when the device receives an updated value for
an input network variable required by its application program, its firmware passes the data to the
application program. The binding process thus creates logical connections between an output network
variable in one device and an input network variable in another device or group of devices.

Connections may be thought of as virtual wires. For example, the dimmer-switch device in the
dimmer-switch-light example could be replaced with an occ upancy sensor, without making any
changes to the lightin g device.

Configuration Properties

Configuration properties define how an application device behaves by determining the manner in
which data is manipulated and when it is transmitted. Configuration properties determine the functions

IzoT Commissioning Tool User’s Guide 7

Lamp Actuator

Mandatory network variables

Configuration properties

Optional network variables

nviLampValue

SNVT_switch

nv1

SFPTLampActuator

nvoLampValueFb

SNVT_switch

nv2

nvoEnergyCnt

SNVT_elec_kwh

nv4

nvoRunHours

SNVT_elapsed_tm

nv3

Mandatory

Optional

SCPT_location
SCPTinFbDly
SCPT_def_output

SCPTrunHrInit
SCPTrunHrAlarm
SCPTenrgyCntInit

to be performed on the values stored in the network var i ables. For example, a configuration property
may specify a minimum change that must occur on a physical input to a device before the
corresponding output network variable is updated. Like network variables, configuration properties
have types that determine the type and format of the data they contain.

Functional Blocks

Applications in devices are divided into one or more functional blocks. A functional block is a
collection of network variables and configuration properties that work together to perform a single
task. These network variables and configuration properties are called the functional block members.
For example, a digital input device could have four digital input functional blocks that contain the
configuration properties and output network variable members for each of the four hardware digital
inputs on the device. A functi onal block is an implementation of a f unct ional profile.

Functional Profiles

A functional profile defines mandatory and optional network variable and configuration property
members for a type of functional block. For example, the standard functional profile for a light
actuator has mandatory SNVT_switch input and output network variabl es, optiona l
SNVT_elapsed_tm and SNVT_elec_kwh output network variables, and a number of optional
configuration properties. The following diagram illustrates the components of the standard light
actuator functional profile:

When a functional block is created from a functional profile, the application designer can determine
which of the optional configuration properties and network variables to implement.

Standard Network Variable and Configurati on P rope r ty Types

Every network variable and configuration pr operty has a type, which determines the content and
structure of the data. To enable devices from different manufacturers to interoperate, the following
standard types are defined:

• Standard Network Variable Types (SNVTs, pronounced snivits). SNVTs cont ain many common

operational data types. For example, SNVT_temp_p is a network variable type for network
variables containing temperature as a fixed-point number.

8 Introduction

• Standard Configuration Property Types (SCPTs, pronounced skipits). SCPTs contain many

common configuration data types. For example, SCPT_location is a configuration property type for
configuration properties containing the device location as a text string.

See types.lonmark.org for a list and description of all SNVTs and SCPTs.

User-defined Standard Network Variable and Configuration Property Types

Applications may use manufacturer-defined non-standard types—user network variable types
(UNVTs) and user configuration property types (UCPTs)—which are defined in user resource files.
Device manufacturers may provide additional resource files that define these types. See the
NodeBuilder Resource Editor User’s Guide for additional information on creating or using these files.

Subsystems

Devices, routers, and functional blocks are contained in subsystems. With the IzoT Commissioning
Tool, each subsystem corresponds to one page within an OpenLNS CT drawing. S ub systems allow
you to place devices, routers, and functional blocks onto separate pages for organizational purposes.
You may also nest subsys tems in ot her subsystems, allo wing you to create a subsystem hierarchy for
large networks. For example, a network may consist of HVAC, lighting, security, and operator
subsystems. These may be further divided into subsystems for each floor, and each floor divided into
subsystems for each room.

Supernodes

Using the IzoT Commissioning Tool, you can also use subsystems to create supernodes. A supernode
is a subsystem with its own net work varia ble interface. You can use supernodes to organize groups of
devices into logical units a nd to hide complex subsystem details, expo sing only the most import ant
network variables. This structure reduces errors and decreases the time required for network
engineeri ng and commissioning. A network variable interface for a supernode may contain any
network variable on any device fu nctional bl ock found within the supernode or in any of its nested
subsystems.

Visio Basics

The IzoT C ommissioning Tool is built on the Visio drawing tool to provide a r ob ust technical drawing
environment for network design. An OpenLNS CT drawing consists of one or more drawing files, and
each drawing file contains multiple subsystems that are each displayed on individual Visio pages. The
Visio documentation provides detailed descriptions of Visio commands and capabilities.

Two key Visio concepts are shapes and stencils. Shapes are reusable drawing objects. A shape may
represent a simple drawing object such as a line, arc, circle, or square, or it may represent a complex
drawing object with special behavior such as OpenLNS CT SmartShapes
SmartShapes for subsys tems, application devices, functional blocks, network variables, message tags,
connections, routers, and channel s .

To simplify finding and reusing shapes, Visio defines a special type of drawing called a stencil. A
shape contained on a stencil is called a master shape. When you drag a maste r shape fro m a stencil to
one of your drawing pages, Visio automatically makes a copy of the master shape on your drawing a nd
leaves the master shape unchanged on the stencil.

You can create custom master shapes and stencils for any set of OpenLNS CT SmartShapes. For
example, the IzoT Commissioning Tool includes custom master SmartShapes and a custom stencil for
SmartServer devices and functional blocks. Yo u may wish to create your own custom master
SmartShapes and stencils to speed up network design. See Chapter 12, Creating and Using Custom
OpenLNS CT Master SmartShapes, for more information.



. OpenLNS includes

To simplify access to your most commonly used stencils and drawing options, Visio defines another
type of drawing called a template. Templates are drawings that may be used as the starting point when

IzoT Commissioning Tool User’s Guide 9

you create a new drawing. The IzoT Commissioning Tool includes a L

ONWORKS template that is used

automatically when you create an OpenLNS CT drawing. If you wish, you can create your own
custom OpenLNS CT template and select it as the default template in the OpenLNS CT Design
Manager. See New Network Options in C hapter 3 for more information on selecting the default
drawing template.

10 Introduction

IzoT Commissioning Tool User’s Guide 11

2

Installing and Activating

the IzoT Commissioning Tool

This chapter describes how to order the IzoT Commissioning Tool, install the various

software and components included in your copy of the IzoT Commissioning Tool, and

how to activate the IzoT Commissioning Tool.

12 Installing and Activating the IzoT Commissioning Tool

Echelon

IzoT Commissioning Tool Product

38000-400

OpenLNS Commissioning Tool Professional Edition (DVD)

38010-400

OpenLNS Commissioning Tool P rofessional Edition Without Visio (DVD)

38050-400

OpenLNS Commissioning Tool P rofessional Edition Activation Key

38060-400

OpenLNS Commissioning Tool Profe ssi ona l Edition Without Visio Activation Key

38100-400

OpenLNS Commissioning Tool Sta ndard Edition (DVD)

38150-400

OpenLNS Commissioning Tool Standard Edition Activation Key

38160-400

OpenLNS Commissioning Tool Standard Edition Without Visio Activation Key

38300-400

OpenLNS Commissioning T ool Trial Edition Without Visio Activation Key

Ordering the IzoT Commissioning Tool

You can order the IzoT Commissioning Tool directly from Echelon, from an Echelon distributor, or
from the Echelon store at store.echelon.com. If you order from the Echelon store, make sure you
provide a valid e-mail address when you order the IzoT Commissioning Tool products. Once you
complete your order, Echelon will send you an e-mail message to the provide d e-mail address with the
activation key for your IzoT Commissioning Tool products. You can order the following p roducts
from the Echelon store:

Part No.

You can download your IzoT Commissioning Tool products from the Echelon Web site at

www.echelon.com/openlns, and then install and activate them as described in the next section.

Installing and Activating the IzoT Commissioning Tool

You can install a licensed copy of the IzoT Commissioning Tool on up to two computers, a primary
and a secondary computer, provided that the following requirements are met: only the IzoT
Commissioning Tool user on the primary computer can use the copy of the IzoT Commissioning Tool
on the secondary computer and the IzoT Commissioning Tool soft wa re may only be used on one
computer at a time. See the OpenLNS CT Software License Agreement in Appendix C for more
information. To begin your installation, follow these steps:

1. If you are installing a version of the IzoT Commissioning Tool that does not include Visio, you

must separately purchase and install the 32-bit version of Visio 2010 or Visio 2003 before
installing the IzoT Commissioning Tool software.

2. If you do not have an Echelon download account, create one on the Echelon Web site at

www.echelon.com/support/downloads/accounts. Your account will enable you to d ownload

OpenLNS software from the Echelon Web site; make activating and managing li censes for
multiple Echelon products easier; enable you to return, transfer, and recover licenses; and help you
receive technical support from Echelon faster.

3. Download the IzoT Commissioning Tool from the Echelon Web site and run the

OpenLNSCTSetup.exe file, or insert the OpenLNS CT DVD into your DVD-ROM drive.
If you are installing the IzoT Commissioning Tool from a DVD and the IzoT Commissioning Tool

setup application does not launch immediately, click Start on the taskbar and then and click Run.
Browse to the OpenLNSCTSetup application on the OpenLNS CT DVD and click Open. The
Select Components dialog box opens.

IzoT Commissioning Tool User’s Guide 13

4. Select the components that you wish to install by selecting the appropriate check boxes on the

Select Components dialog box.

• Microsoft Visio: Installs the 32-bit version of the Visio 2010 drawing tool. To install the

32-bit version of Visio 2010, your computer cannot have the 64-bit version of any Office
2010 application installed on it.

The IzoT C ommissioning Tool is not co mpatible with the 64-bit version of Visio 2010 (even
if your co mputer is usin g a 64-bit operating s ystem), and it is not compatible with any version
of Visio prior to Visio 2003. If you already have a 64-bit version of any Office 2010
application, you must uninstall it before installing the 32-bit version of Visio. You can
reinstall the 32-bit version of any 64-bit Office software that you have installed.

• Echelon OpenLNS Commissioning Tool: Installs the required components of the IzoT

Commissioning Tool. Installing the IzoT Commissioning Tool automatically installs the IzoT
Network Services Server, the OpenLNS CT XML Utility

, and the dr ivers for the following

OpenLDV 4.0-compatible network interfaces:
o Remote Network Interfaces (RNIs): SmartServer , i.LON 100 Internet Server, i.LON 600

IP-852 Router, and i.LON 10 Ethernet Adapter

o Local USB network interfaces: U10/U20 USB network interfaces.
o Local PC card network interfaces: PCC-10 and PCLTA-10, 20, and 21 PCI network

interfaces. The PCC/PCLTA a nd SLTA-10 network drivers are compatible with 32-bit
versions of Windows only and are not installed on 64-bit versions of Windows.

If you are using the IzoT Commissioning Tool on an IP-852 channel, yo u will ne ed an IP
network interface card (such as Ether net or WiFi) or modem with PPP software. An IP
network interface is also required if you are using an IP-852 interface such as a SmartServer
(with IP-852 routing option), i.LON 100 Internet Server (with IP-852 routing option), or
i.LON 600 IP-852 Router. If you are using another OpenLNS interface, install the network
interface hardware and dr i ver following the instructions provided with the hardwar e.

Most network interfaces include an application that handles network interface co nfiguration.
You must perform this configuration before you can use the IzoT Commissioning Tool while
attached to a network. The application may handle host details such as IRQ assignment, and
it may also manage network parameters such as buffer counts and transceiver types.

14 Installing and Activating the IzoT Commissioning Tool