Echelon IzoT Commissioning Tool User Manual

078-0509-01ADesign, install, operate, and maintain IzoT and LONWORKS®networks with the IzoT Commissioning Tool. IzoTTM Commissioning Tool User’s Guid

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

2. Enter the following information: Source Functional Block Name Displays the name of the source functional block (a master SmartShape or an exist

in the selected subsystem with available functional blocks will be listed. Type Specifies the device template associated with the functional bloc

subsequent functional block with the same name for the same device, the instance number is incremented by one. For example, the default name of a n

To create the SmartShapes in your OpenLNS CT drawing, select the Create all Network Variables Shapes check box. 3. Click Finish to add the functio

To use the Move FB command to reassign a functional block to a different device, follow these steps: 1. Right-click the functional block you want t

2. Right-click the functional block you want to update with the configured settings, point to Configuration Properties on the shortcut menu, and t

4. Select the target subsystems into which you want the configuration properties to be copied. You can expand a subsystem to view any nested subs

7. You can remove a functional block target from the list by selecting the target’s subsystem name and then clicking Remove. If you only want to

Dynamic functional blocks are typically used by controllers that do not have a static interface. These controllers typically require the integrator

5. If the selected functional profile defines mandatory and/or optional network variables, the corresponding check boxes under Dynamic FBs for cre

Preface The IzoT Commissioning Tool is a software package for designing, installing, and maintaining multi-vendor, open, interoperable LONWORKS® cont

2. Under Device, select the device to which you want to assign the virtual functional block from the Name list 3. Under Functional Block, select Vi

setting) encapsulated within functional blocks that a particular device application expects to receive from other physical devices (an input networ

To automatically add all available network variables to a functional block, select the Create Shapes for all Network Variables check box in the New F

3. The Create Network Variable dialog box opens. Enter the name, number, and type of the dynamic network variable(s) you are creating. a. Ent

d. Select the type of the dynamic network variable based on a defined type, or the type of an existing network variable in your OpenLNS CT drawing.

5. Under Poll Attributes of New NV(s), select whether the dynamic network variable(s) will by default use polled monitoring. You have four choi

8. Select one or more static and/or dynamic network variables SmartShapes to add to the functional block from the list of network variables availab

2. Following steps 3–6 in Creating Dynamic Network Variables Using Network Variable SmartShapes, change the default name, if desired, enter the nu

4. Select one or more network variable SmartShapes to delete. To select multiple network variable SmartShapes, hold down CTRL and click the SmartS

Deleting Dynamic Network Variables You can delete a dynamic network variable from a functional block. When you delete a dynamic network variable,

Purpose This guide outlines the the IzoT Commissioning Tool, and it describes how to use the IzoT Commissioning Tool to design, commission, monitor a

Wizard opens each time you add a router SmartShape to your OpenLNS CT drawing. See Using Automatic Channel Selection for Routers in this section for

Name Select the two channels that you will attach to the router. You can enter a new channel name for one or both of the channels to add new chann

the network recovery process. If the Set Location Property to Subsystem ID check box is cleared, you can enter a location description for the router.

Router Name Displays the name of the router. Router Type Specify one of the following router types: Configured, Repeater, Permanent Repeater, Bridg

If you did not select the Commission Device check box on the first page of the wizard, click Finish to add the router SmartShape to your OpenLNS CT d

2. Enter the following information: Channel Definition Select whether the SmartShape represents a new or an existing channel. • Select Sh

selected channel type. Round-Trip Delay Select whether to use the default round-trip delay or to specify a time for the channel in milliseconds. •

2. Enter the following information: Subsystem Enter the name of the subsystem. The name must be unique within the current subsystem and may be u

Copy subsystems. You have three choices: • Do not Copy. Only the subsystem SmartShape will be copied. None of the contents of the original subsys

4. Right-click the subsystem and click Expand from the network navigator. All devices, functional blocks, and available network variables in th

i.LON 600 LonWorks/IP Server User's Guide (078-0272-01A) Describes how to install, configure, use, and manage the i.LON 600 IP-852 routers, and

2. Right-click anywhere in the OpenLNS CT drawing, in the same or in a different subsystem, and click Paste on the shortcut menu. The New Subsystem

Creating a Connection with the Connector SmartShape You can create a connection with the Connector SmartShape ( ) in the IzoT Commissioning Tool Ba

Creating a Connection with the Network Variable Connection Dialog Box You can create a connection using the Network Variable Connection dialog box.

3. Create the network variable connection by selecting the following options: Hub: (box) Displays the currently selected hub network variable. T

• NV. Displays available or compatible network variables. • MT. Displays available message tags. This option is only available if you are conn

7. In the New Connections box, select a connection description to assign to all the new connections listed in the Connections box. You can click

eliminates the need to manually move functional block, connector, and connector reference SmartShapes to keep your OpenLNS CT drawing organized. To

network overhead for large multicast fan-out connections. For example, a repeated message with three retries to 64 devices generates 4 packets on

Repeated with Alias Multicast Repeated Alias Repeated with Broadcast Multicast Repeated Broadcast Repeated with Group Multicast Repeated

To view the properties of a connection description, select the connection description from the Name list. If you do make changes, click OK and I

Region Languages Supported Contact Information The Americas English Japanese Echelon Corporation Attn. Customer Support 550 Meridian Avenue San J

These automatic SCD selection rules do not apply to message tag connections, fan-in connections (where the hub is an input network variable), or con

3. You can change or disable the connection description used for each condition in the automatic connection description selection process. If yo

Connection Description, and then click the desired connection description on the shortcut menu. To disable automatic connection description selectio

To hide a connector SmartShape directly attached to two functional block SmartShapes (not attached using a reference SmartShape), select Hide Co

If you right click the Switch[0] functional block, point to Display Options, and then click Hide Connectors, the connector and reference SmartShape

2. Select the following options for creating and displaying connection SmartShapes for the selected functional block or functional blocks. Crea

Show Connection Shapes Select whether connection SmartShapes attached to the selected functional block(s) are displayed. This check box is selected

2. The window displays a hierarchal view of the subsystems in your network, with the nested subsystems and devices in the top-level subsystem and

To use the network navigator, right-click an object that can be expanded and then click one of the following commands in the shortcut menu: Expand

Network Explorer options category. By default subsystems, devices, and functional blocks are displayed. To expand or reduce the scope of the o

• Getting Started: Provides information on the planning an IzoT Commissioning Tool network design; using the OpenLNS CT Design Manager; setting up a

• In the subsystem view, the top-level subsystem and all the subsystems it contains are displayed, and all the other objects in your OpenLNS CT draw

The Device Template shortcut menu contains the following options: Delete Deletes the selected device template. This option is unavailable if ther

The Device Template Properties dialog box contains the following options: Name Specifies the name of the device template. You can change the device

When you commission a device, the OpenLNS Server by default will validate that the physical device is on the correct assigned Channel and that the

Data Layer Shows/hides all monitored connections. • Right-click an empty space in your OpenLNS CT drawing, point to Display Options on the shortcut

1. Right-click the SmartShape. You can select multiple SmartShapes by holding down CTRL and clicking the SmartShapes, or clicking an empty space

2. Set the following options: Original Channel Name Specifies the current channel on which the devices or routers are attached. If you are movin

• Select Online to put the devices or routers in the online state. This is the default for routers. The behavior in the online state depends on

2. Change the channel on which the OpenLNS computer is attached following step 2 in Moving a Device or Router to a Different Channel. 3. If you are

Deleted IzoT Commissioning Tool Shape Affect on Physical Device Commissioned Application Device Application device is decommissioned and no longer

Commissioning Tool shortcut menus, click Add-ins, point to IzoT Commissioning Tool, and then select or clear the Use IzoT Commissioning Tool Shape Me

4. Specify the drawing page size and scale for the AutoCAD drawing in the Page Size/Scale dialog. These settings do not affect the size of IzoT C

146 Designing Networks

5 Installing Networks This chapter describes how to install devices using IzoT Commissioning Tool, including how to load applications into them, set

Network Installation Overview You can install the devices that you added to your IzoT Commissioning Tool network design in Designing Networks. To in

Selecting Devices for Commissioning To select the device or devices to be commissioned, follow these steps: 1. Right-click the device SmartShap

2. The Commission Device Wizard opens. Where you start in the wizard depends on whether you are commissioning an application device or router,

1. Specify the device application by setting the following options: Load Application Image Select this check box to load an application image into

directory as the XIF file of the device template, that directory is the default. XIF Name If you are loading an application file with an .nxe extensi

Setting the Initial Application Device State and Source of Configuration Property Values When the Device Initial State window opens, follow these ste

1 Introduction This chapter provides an introduction to the IzoT Commissioning Tool, describes new features, and explains the basics of IzoT Commis

is reset. For a device to be disabled, it must contain a Node Object functional block. If Disable is selected and the device does not contain a Nod

Image window. • Upload from New App Image. The current device-specific configuration property values in the selected application image file will be

operation. • Offline. The router will not forward packets. • Online. The router will forward packets between the channels connected to it. Thi

difficult to access. 2. Click Finish. If you selected the Service Pin method, you are prompted to press the service pin as described in Using the

To acquire the Neuron IDs and finish installing the devices, follow these steps: 1. Select any of the following service pin options Options Display

Using the Manual Entry Method If you selected Manual as the device identification method or if IzoT Commissioning Tool is not attached to the network

scanner vendor for prices on the different scanner types. If you are using a LonPoint device, or a device with a similar bar code label, it is recom

2. Select the following options: Device Selection Scope Selects which subsystems will be searched for uncommissioned device SmartShapes. You have

Include Devices with Unknown Programs Adds physical devices to the discovered device list that are applicationless or have an unrecognized applicatio

This dialog box allows you to manually or automatically match the discovered devices on the network with the defined device SmartShapes in the OpenL

Introduction to the IzoT Commissioning Tool The IzoT Commissioning Tool (OpenLNS CT and LonMaker) is a LONWORKS® network tool that runs on the OpenLN

appropriate device list. Match Matches the device selected in the Defined Devices list is to the device selected in the Discovered Devices list. The

11. Select an application image and set the options for the initial application state and source of configuration property values. See Loading a D

166 Installing Networks

6 Monitoring and Controlling Networks This chapter describes how you can monitor and control the devices in your network with IzoT Commissioning Too

Monitoring and Controlling Overview You can monitor and control the physical devices in a network by reading and writing the network variables on the

When you enable monitoring on a connection, the network variable values are continuously polled. The default poll interval is 1 second. To change

Using the OpenLNS CT Browser You can use the OpenLNS CT Browser to monitor and control the network variables and configuration properties in your net

The OpenLNS CT browser color codes the configuration properties and network variables in the following manner: Blue Input network variables. You can

The OpenLNS CT Browser Toolbar You can use the OpenLNS CT browser toolbar to perform many browser functions quickly. The toolbar contains the follow

therefore, you would hide the subsystem column. In another example, you may want to monitor and control only a few of the network variables listed i

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 T

Under the display box, select which objects you want displayed in the browser. You have three choices: • Network Variables. Only network variable

This dialog lists all the hidden objects in the browser. Select the object or objects you want to show, or select the Select All check box to select

You can update all network variable values by clicking the Refresh All button () on the browser toolbar or opening the Browse menu and selecting Refr

b. Under the Device box, select OpenLNS Network Interface from the Name list. c. Under the Functional Block box, select Virtual Functional Block fr

All the fields for the selected object are listed in structural order in the Field List box. To set the value for a field, expand that field and th

Setting Values for Configuration Property Arrays You can view and set values for a configuration property array using a table instead of using the V

Clearing Values You can clear the displayed value of a network variable or configuration property by right-clicking the object you want to clear and

This dialog lists built-in data types, and resource files containing defined network variable types (SNVTs and UNVTs). Expand the items listed to

The format may include scaling and offset values to convert one type of data to another such as Celsius to Fahrenheit or kilograms to pounds, localiz

• Select the Show Obsolete Types check box to list those network variable types that are marked obsolete in the current standard resource file set.

Echelon, LON, LONWORKS, IzoT, LonTalk, Neuron, LONMARK, 3120, 3150, LNS, LonMaker, LonSupport and the Echelon logo are trademarks of Echelon Corporat

properties, synchronization, and documents [backup/restore, XML export/import]). This manual assumes you are using Visio 2010—if you are using Visio

Using Data Point SmartShapes You can use a Data Point SmartShape in an OpenLNS CT drawing to monitor the value of any network variable configuration

default. If this check box is selected, the same data point will be monitored in a new Data Point SmartShape. If this check box is cleared, IzoT Co

and field name [if defined]). This is the default. • Device.FB.NV (the device name, functional block name, network variable name, and field name

a functional block state. Polling Interval Specifies how frequently (in seconds) the data point is polled. The default is 5 seconds for polled netwo

• A structured value is a value that contains multiple fields such as a switch value with state and level fields. • An enumerated value is a valu

• Expand a field in the Field List box and then click twice slowly on the value that opens below the field. Enter a valid value for the field (the

Creating and Using a Custom Data Point Master SmartShape You can create a custom data point master SmartShape from an existing Data Point SmartShape

1.Building1.Floor2.Room10” subsystem. The subsystem path stored in the Data Point SmartShape is therefore “^.^.Floor2.Room10”. This indicates that

You can use high-end HMI tools, such as Wonderware’s InTouch or Intellution FIX, to represent more complex types of network interactions. These too

o To get the ID of a Data Point SmartShape, click the Data Point SmartShape, click the Developer tab, and then click Shape Name. An index is append

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

In the X cell of the Scratch section, enter a formula. For example, to create a formula that brightens a lamp when you double-click the Visio shape,

Data Point SmartShape ID index refers to the numeric digits at the end of the Data Point SmartShape name. For example, if the name of Data Point Sma

If myShape2.Cells("User.MonValue") = 1 Then myShape.Cells("FillForegnd") = 5 myShape.Text = "ON" Else my

7 Maintaining Networks This chapter provides an overview of network maintenance tasks that you can perform with IzoT Commissioning Tool. It describ

Maintaining Networks Overview You can perform routine maintenance to update, repair, and optimize an installed network. You can maintain the network

To load a new application into a device, the devices must have writeable application memory, and IzoT Commissioning Tool must be attached to the netw

name without a path only if the XIF file is in the folder specified in the XIF Search Path box Network Properties: Device options category (to access

Load Application Image Select this check box to enable loading a new application image into the device. Update Firmware in Device to Match Applicatio

Selecting Initial Device State and Source of Configuration Property Values To select the initial device state and the source of configuration propert

after a reset. • Disable. Keeps the device application disabled even if the device is reset. For a device to be disabled, it must contain a Node O

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

new device. 2. Click Next. The Device Identification Method window opens. Follow the steps in Installing Devices and Routers in Chapter 5, Insta

5. Specify the initial state of the replacement device’s application, and select the source of the configuration property values and management of

and the device does not contain a Node Object functional block, the device is placed offline. As with offline operation, portions of a disabled dev

case, follow the steps in Installing Devices and Routers in Chapter 5, Installing Networks, to continue installing the devices). Removing the Old Dev

network tool not based on OpenLNS is used to update the physical devices, or if the devices themselves update their own configuration properties. T

3. Click OK. IzoT Commissioning Tool updates the device and the OpenLNS network database, as required. Using IzoT Commissioning Tool as a Passive C

You can manually back up an IzoT Commissioning Tool network design, or you can have IzoT Commissioning Tool schedule periodic backups. Manually Backi

• Select the Backup Database check box to back up the OpenLNS network database only. Use this option to move the network database to an OpenLNS Ser

• If the backup file includes the drawing and database, the default backup file is <IzoT Commissioning Tool network>[_index].zip. • If the ba

Scheduling Drawing Saves and Database Backups You can schedule regular backups of an IzoT Commissioning Tool network using IzoT Commissioning Tool or

Network variables of identical type and length but opposite directions can be connected to allow the devices to share information. For example, an a

5. You can set the maximum number of hot backups that are saved for all IzoT Commissioning Tool networks (includes hot backups created automatically

7. Click Next. 8. Click Finish. Windows XP SP3 To create a scheduled task in Windows XP3, follow these steps: 1. Open the Windows Task manage

Restoring an IzoT Commissioning Tool Network You can restore an IzoT Commissioning Tool network from a standard IzoT Commissioning Tool backup or a h

IzoT Commissioning Tool backup file (.zip extension) of the desired database backup (the database backup file names are in the following format by de

7. This dialog box displays the paths where the restored network database will be saved. You cannot change the directory if the database already e

6. Select the IzoT Commissioning Tool backup file (.zip extension) of the desired OpenLNS CT drawing to restore (the drawing backup files are in the

Click Yes to restore the files; click No to skip restoring the files; or clear the Only Restore New Files check box, select one or both of the Overwr

the drawing has been opened, click Add-ins, point to Synchronization, click Resynchronize, and follow steps 14–18. 14. The Synchronize OpenLNS CT

17. Select the state of the devices after they have been recommissioned. You have four choices: • Preserve Current State. The devices will be re

19. This window displays the status of the resynchronization. Resynchronization events will be listed in the order they occur. Click OK when th

to be performed on the values stored in the network variables. For example, a configuration property may specify a minimum change that must occur on

3. Verify that the recovered network opens to be correct. The recovery wizard logs the recovery tasks as well as any errors that occurred in the de

4. Click OK. You can update the recovery data in the physical devices in a network after setting the subsystem recovery options and after recover

3. Select the subsystems and drawing files to update. 4. Click Finish. The Synchronization Status dialog opens and IzoT Commissioning Tool begin

configuration property but different subsystem IDs, IzoT Commissioning Tool places the discovered devices in the subsystem path specified by the firs

5. The Plug-In Registration dialog opens. Register or disable plug-ins as desired and click Next. 6. The Authentication dialog opens. If you u

7. The Domain Definition dialog opens. If you know the domain ID of the network that you want to recover, enter it in hexadecimal format into the

9. If you selected the Recover Domain ID from Network Device check box, the Service Pin dialog box opens. Press the service pin on one of the unaut

13. The Recovery Options dialog box opens. If you expect your network to have more than 200 devices, select the Large Network check box. The Doma

15. The External Interface Files dialog box opens. Add or remove device templates based on device interface (XIF) files. When finished, click Nex

17. When the data recovery is complete, the Optimizing Database dialog box opens. Select the Organize Database check box and click Next. 18. T

• Standard Configuration Property Types (SCPTs, pronounced skipits). SCPTs contain many common configuration data types. For example, SCPT_locatio

19. If there are any errors or warnings, click Details to view the recovery log listing each recovery phase initiated and any problems encountered.

22. The Select Stencils dialog box opens. Add, remove, or re-order stencils. Click Finish 23. The Synchronization Status dialog box opens as t

25. Compare the recovered OpenLNS network database to your expected results. Because network recovery occurs while IzoT Commissioning Tool is OffNe

• If a bound dedicated message tag does not have any targets, its address table entry is marked as empty and removed from the associated connection.

While it is possible for multiple users to be modifying the same page of an OpenLNS CT drawing at the same time, if the users are working in the same

You can sort the IzoT Commissioning Tool event log by any of the column headers. To sort by a column header, click the header. Click the header ag

To view the exported IzoT Commissioning Tool event log, find the XML file in C:\Users\Public\Documents\LonWorks\OpenLnsCt\XML\network name and double

ObjectId The handle of the object that was modified. For events related to network variables and message tags, the object ID will be the index of th

3. Choose the synchronization operation(s) you want to perform by selecting the following options. OpenLNS Database The network database resynchro

OpenLNS CT Drawing Synchronize Drawing to Database (fix-up Drawing) Updates the OpenLNS CT drawing to be consistent with the OpenLNS database. Synch

you create a new drawing. The IzoT Commissioning Tool includes a LONWORKS template that is used automatically when you create an OpenLNS CT drawing.

5. Select the scope of the selected synchronization operation(s) by choosing which subsystems and drawing files to resynchronize. If you know that

Otherwise, if you are synchronizing the network or the OpenLNS CT drawing to the network database, click Next and skip to step 10 in which the Synchr

9. Select the following options and then click Next. Shapes All SmartShapes that have newer versions available than the ones currently in the drawin

during Resync network during resynchronization. This speeds up resynchronization, as it reduces the time Visio spends updating the drawings. Check f

15. Specify the stencils that will be scanned for master SmartShapes during resynchronization. When objects are found within the OpenLNS network d

The resync log is stored in the drawing directory of the current IzoT Commissioning Tool network design. 17. If the OpenLNS CT drawing is being sync

single network using a portable network server under a sequential network installation scenario, in which no permanent server is needed. In most cas

• Unreferenced connection descriptions. Connection descriptions that have been created but do not have any corresponding connections are not create

The merge export utility also automatically decommissions all configured devices in the network that use authenticated message service so that they c

12. Select the source network you exported in steps 4 – 6 from the Select Network to be Merged list. This list contains only those networks that h

IzoT Commissioning Tool User’s Guide 11

This dialog displays the status of the network merge and lists the events in the order they occur. Any errors encountered are shown in the status pa

8 Managing Networks This chapter explains how to test and verify application devices, functional blocks, and routers. It also describes IzoT Commis

Using the IzoT Commissioning Tool Device Manager You can manage application devices, functional blocks, and routers using the IzoT Commissioning Tool

Managing Devices To manage a device, right-click a device (or select multiple objects including at least one application device or functional block a

network variable values or send network variable updates. If the device was previously offline, the device state does not change. If the device is r

The commands in this dialog require that the device application associated with the functional block includes a Node Object functional block and tha

Managing Routers To manage a router, right-click a router (or select multiple objects including at least one router and right-click one of them), and

Click Settings to open the Device Manager Settings dialog box. There, you can set options for testing routers and options for the results log. Devic

Repetition Control Repeat Number of Times Specifies how many times a Wink or Test command will be repeated. The default is 1, which means that thes

Error Red diagonal Changes have been made in the network database, but an error has occurred while updating the device. The device may not be resp

2 Installing and Activating the IzoT Commissioning Tool This chapter describes how to order the IzoT Commissioning Tool, install the various softwa

Normal Solid cyan. The functional block is in a normal state and none of the states listed above are active. When multiple functional blocks sta

Network Variable and Message Tag SmartShape Styles IzoT Commissioning Tool indicates the state of network variable and message tag SmartShapes using

Monitoring Enabled Text is black. Monitoring Disabled Text is magenta. IzoT Commissioning Tool updates the style of the connection SmartShapes, as

• Select Subsystem Page to include the application devices, routers, and functional blocks in the current subsystem. This is the default. • Select

4. Select additional functional blocks to include in the status summary based on the type of errors or exceptions they have reported. For more inf

For functional blocks, this dialog displays the following data in the top pane: subsystem, device, functional block name, applicable status (indicate

Alias Table Summary You can display a summary of the usage and availability of alias table entries for a device. The usage and availability is dis

IzoT Commissioning Tool User’s Guide 271

9 Exporting and Importing Networks with XML This chapter describes how to export a LONWORKS network to a LONWORKS network XML file, view a LONWORK

Ordering the IzoT Commissioning Tool You can order the IzoT Commissioning Tool directly from Echelon, from an Echelon distributor, or from the Echelo

Using XML Export/Import Overview You can speed up your network design and ensure your devices are configured correctly by creating an IzoT Commission

Programmer’s Guide for details on how applications can use the plug-in and the schema used for the XML file. To manually export your OpenLNS CT drawi

Report Self-Documentation Includes the self-documentation data for all exported devices and their network variables. This option is unavailable if t

1. Generate a LONWORKS network XML file. 2. Clear the Exclude XSLT Stylesheet check box in the XML Export Options dialog box. 3. Optionally mo

Click a device link to open a page with detailed data on that device and a table listing its functional blocks, with links to view detailed data on

You can continue moving down the network hierarchy until reaching the end, which is at the network variable\configuration property or configuration

2. Set the following options: Import to Subsystem Select the root subsystem for the XML file. There are two choices: • As Defined in XML File.

10 Managing IzoT Commissioning Tool Licenses This chapter provides an overview of IzoT Commissioning Tool licensing. It describes how to upgrade Iz

Commissioning Devices with IzoT Commissioning Tool IzoT Commissioning Tool lets you install devices without commissioning fees (known as “credits” in

2. The License Wizard guides you through the process of manually updating or upgrading your IzoT Commissioning Tool license. Click Next. 3. The

Table of Contents Preface ... xi Purpose ...

4. Select the components that you wish to install by selecting the appropriate check boxes on the Select Components dialog box. • Microsoft

6. Select Upgrade from the Action list for both OpenLNS Server and IzoT Commissioning Tool, and then click Next. 7. If your computer is online,

8. In the Request File Name property, enter a full path where a license request file (.elwrq extension) is to be saved, or click Browse, specify th

10. Click Send Request to Echelon to e-mail the license request file to Echelon at [email protected]. Echelon will send you an e-mail message

d. The Check License Response File dialog opens. Confirm that the Echelon product licenses in the license response file are the ones you want to a

12. Click Exit to close the License Wizard. Upgrading IzoT Commissioning Tool Standard Edition to IzoT Commissioning Tool Professional Edition Yo

d. If your computer is online, the Step 3: Enter Customer Information dialog opens. Complete the following steps to return your software (if your

• The Step 4: Status dialog opens, and the License Server returns your IzoT Commissioning Tool Standard license. • Click Exit to close the L

Click Next. g. The Step 4: Status dialog opens. The License Wizard confirms the creation of the license request file. h. Click Send Request to E

Commissioning Tool computer without losing your license. You cannot use the License Wizard to install one IzoT Commissioning Tool license on multipl

the target computer by e-mailing the license request file to Echelon at [email protected], or by copying it to the target computer (if it has an

You can use the LONWORKS Interfaces application in the Control Panel to define, configure, and test RNIs, IP-852 network interfaces, USB 10/20 networ

11 Using Plug-ins This chapter provides an overview of plug-ins and then describes how to start a plug-in, get plug-in information, and re-register,

Using Plug-ins Overview Plug-ins are applications that you can start from within IzoT Commissioning Tool to perform a specialized task, often relatin

• To start a plug-in using a default command, right click a device or functional block SmartShape, and then select Configure or Browse. If a plug-

Viewing Plug-in Information You can perform the following operations for registered plug-ins: • View general information about the selected plug-in.

Commissioning Tool does not change the attribute on any other plug-ins. If multiple plug-ins are registered for the same command and object class,

The columns contain the following data. You can sort the data by clicking a column header. Click a header again to toggle the order (ascending or d

Follow these steps to register or re-register a plug-in: 1. Choose the plug-in to register from the Already Registered or the Not Registered list.

Enabling a Plug-in To enable a plug-in, follow these steps: 1. Select the plug-in under the Disabled list. You can enable all of the disabled plug-

12 Creating and Using Custom Commissioning Tool SmartShapes and Stencils This chapter describes IzoT Commissioning Tool stencils and the process t

IzoT Commissioning Tool Stencils IzoT Commissioning Tool uses Visio stencils to speed your LONWORKS network engineering. A stencil is a collection o

If you selected the Visio component in the Select Components window, the Microsoft Visio setup wizard opens. Follow the instructions in the install

4. Right-click the title bar of the new stencil and then click Save on the shortcut menu. Select a folder, assign a name for the stencil file, and

section. Do not hold down CTRL and drag or use copy/paste between drawings from different networks. Using Custom IzoT Commissioning Tool Master Smar

Commissioning Tool gives the new device template the name specified in the device SmartShape, and associates it with the device SmartShape. 4. If Iz

For each channel listed, click anywhere in the Method field and then select how the channel is to be defined when the subsystem or supernode master

SmartShape can represent several connections in your OpenLNS CT drawing, allowing you to quickly and easily establish multiple network connections wi

If you drag this master SmartShape to any subsystem in the same network, IzoT Commissioning Tool creates two new functional blocks, and adds their

4. Every IzoT Commissioning Tool SmartShape has an IzoT Commissioning Tool ShapeType user cell. The value of this cell specifies the IzoT Commissi

• A value of 0 indicates no. • A value of 1 indicates yes. • A value of 2 indicates that the IzoT Commissioning Tool user will be prompted. Th

The scope selector definitions are: 0 Standard functional profile defined in the standard resource file set. 3 User-defined functional profile,

Property to Subsystem ID check box in the Network Properties: Recovery options category. NewAdvPropCap Specifies handling of the advanced propertie

c. Read the license agreement and click Yes if you agree with the terms. The Customer Information window opens. d. Enter your name, organiza

ObjStateStyle Specifies whether the coloring style is applied to the SmartShape’s fill, line, text, or a combination of the three. • A value of 1

not specified here, the IzoT Commissioning Tool user may be prompted for a device interface when the device master SmartShape is dragged to the to th

information. Additional Router SmartShape User Cells You can include the following additional user cells in a router SmartShape. Not every router ha

3. Drag the generic Device SmartShape () to the drawing. 4. Open the Edit menu and then click Open Device. The Group window opens for the device.

Appendix A Setting IzoT Commissioning Tool Default Options This appendix documents the IzoT Commissioning Tool Default Options you can set either i

Setting IzoT Commissioning Tool Default Options You can set IzoT Commissioning Tool Default Options either in the IzoT Commissioning Tool Design Mana

You can click Restore Defaults to reset all the options and values in the currently displayed options category to their defaults. Every default IzoT

files in the LONWORKS Import folder when creating an IzoT Commissioning Tool backup file. This option is selected by default. If selected, a new Imp

OpenLNS backup file is created. If the Delete OpenLNS Hot Backup after LM Backup check box is cleared, the OpenLNS hot backup copies are preserved.

Restore New Files check box is selected. Scope: All networks, current IzoT Commissioning Tool computer Only Restore New Files Automatically restores

e. If your computer is connected to the Internet, the IzoT Commissioning Tool installer connects to the Echelon License Server, the License Server i

Configuration Properties Options The Configuration Properties category contains the following options. Enable Configuration Properties Enables acces

Copy Values on Functional Block Copy Copies CP values when creating a new functional block from a master SmartShape or from another functional block

Device Options The Device category contains the following options. Device Options XIF Search Path Specifies the path that IzoT Commissioning Too

selected using the preceding criteria, the Device Wizard will appear. Scope: All networks, current IzoT Commissioning Tool computer Prompt for Devic

application may continue to function. Scope: Current network, all IzoT Commissioning Tool computers Routers Specifies the initial state of a new rou

The Functional Block category contains the following options. Functional Block Options Enable Automatic Device Selection Automatically assigns the

whether to delete the dynamic network variable. Scope: All networks, current IzoT Commissioning Tool computer Delete Dynamic NV when NV SmartShape i

variable SmartShapes to which they are connected. The default reference SmartShape spacing value is 1.1. Scope: Current network, current IzoT Commis

The IzoT Commissioning Tool tracing output is saved in a file called trace.log, which is stored in the C:\Users\Public\Documents\LonWorks\OpenLnsCt\

The OpenLNS Event category contains the following options. The changes you make in the OpenLNS Events options category are all applied to the curre

i. Click Finish. The ReadMe file opens if the Show the Readme File check box was selected. When you finish reading the ReadMe file, close the win

Channel Change Events Updates the OpenLNS CT drawing when channels are added, removed, or modified. This option is selected by default. Scope: Curr

Name/instance ID Separator Character Selects the character to be inserted between the IzoT Commissioning Tool SmartShape name and the instance ID.

Network Explorer Options The Network Explorer is an auto-hide window that displays a hierarchal view of the OpenLNS CT drawing. You can use the Netw

• Subsystems, Devices, FBs, and NVs. Lists the subsystems, devices, functional blocks, and network variables in the IzoT Commissioning Tool network

to correlate a lightweight client to its monitor sets. By default, this tag is the computer’s Windows network name. If you have existing monitor s

The IzoT Commissioning Tool Font category contains the following options. IzoT Commissioning Tool Font Name Displays the name of the current IzoT C

Recovery Options The Recovery options category lets you store and automatically update subsystem data in application devices and routers. This is us

OpenLNS CT Drawing dialog. This check box is cleared by default. If an application device and its functional blocks span multiple subsystems, IzoT C

Service Pin Options You can set options for using the service pin when commissioning a device. Show Service Pin Data Displays the service pin data r

Manually Activating IzoT Commissioning Tool If your computer was not attached to the Internet when you installed IzoT Commissioning Tool, you can use

Clear this check box if the network includes any logical repeaters. Scope: Current network, all IzoT Commissioning Tool computers Shape ToolTips Opt

Synchronization Options The Synchronization category contains the following options. Automatic Update Interval (Seconds) Sets how frequently (in sec

Warnings Options The Warnings category contains the following options, which are all selected by default. Enable Warning When New Device Requires Co

LonMaker Release 3, or if you are switching between a fast OpenLNS network interface (layer 2) and an OpenLNS network interface (layer 5). If you at

Appendix B Glossary This appendix provides definitions for terms commonly used with IzoT Commissioning Tool. IzoT Commissioning Tool User’s Guide 3

Glossary Acknowledged Service A service of the ISO/IEC 14908-1 Control Network Protocol that ensures a message was received by the addressee(s). Af

or, for Neuron-hosted devices, you may load it into the device from application files (.nld, .apb, and .nxe extensions) using IzoT Commissioning Tool

Channel Segment A portion of a channel. A single segment can be comprised of multiple sections connected by physical layer repeaters. Channel Type C

Control Network Protocol (CNP) A communication protocol standard for control networks defined by the ISO/IEC 14908-1 standard. The CNP provides a st

3. To activate your IzoT Commissioning Tool software using the over the Internet or via e-mail, click Activate Product Licenses and then click Next.

Device Template A device template contains all the attributes of a given device type, such as its functional blocks, network variables, and configura

Dynamic Network Variable A network variable that is added to a functional block after the device has been commissioned. Devices that support dynamic

Group Addressing A logical addressing mode in the ISO/IEC 14908-1 Control Network Protocol that allows a message to be sent simultaneously to a pre-c

IP-852 Network Interface Software that enables IP-852 devices such as OpenLNS Server computers, IzoT Commissioning Tool computers, IP-852 routers, an

Local Client An IzoT Commissioning Tool computer that is also running the OpenLNS Server. LonMark International A global membership organization crea

• Configuring the various Control Network Protocol parameters in each device for the desired features and performance, including channel bit rate, a

format also specifies how data entered by a user or application is translated to the raw data to be transmitted on a LONWORKS network. Network Variab

OffNet A network management mode in which network configuration changes are stored in the OpenLNS network database, but not propagated to the devices

OpenLNS Event An action fired by an OpenLNS Server to notify an OpenLNS client application of a change to the OpenLNS network. IzoT Commissioning To

Priority An ISO/IEC 14908-1 Control Network Protocol service for messages sent from LONWORKS devices that allow a message priority access to a channe

7. The Step 3: Where Would You Like to Save Your License Requests? dialog opens. 8. In the Request File Name property, enter a full path where a

Replacement Process in which a failed or obsolete device is replaced on a network and in an OpenLNS CT drawing with a new or upgraded device. IzoT C

Smart Connection Description (SCD) A pre-defined connection description that IzoT Commissioning Tool automatically assigns to a connection being crea

Synchronized The state of an IzoT Commissioning Tool network design when an OpenLNS CT drawing and the physical devices on the network match the Open

Virtual Functional Block A static functional block that that contains the network inputs and outputs for a device that are not part of other function

368 Appendix C – OpenLNS CT Software License Agreement

Appendix C OpenLNS Software License Agreement This appendix provides a copy of the OpenLNS Software License Agreement. IzoT Commissioning Tool Use

OpenLNS CT Software License Agreement Echelon OpenLNS Commissioning Tool (CT) Software License Agreement I. NOTICE This OpenLNS Commissioning Tool (

• "Trial Period" is a 60-day period during which the Licensed Software can be used with limited functionality for a maximum of two network

Echelon with a copy of same upon request; this right of transfer is exercisable no more than one (1) time every year. V. RESTRICTIONS The License gr

The functionality of the Microsoft Visio product as integrated in specified editions of the Licensed Software may differ from a non-integrated Micros

10. Click Send Request to Echelon to e-mail the license request file to Echelon at [email protected]. Echelon will send you an e-mail messag

$1000). YOU HEREBY AGREE THAT THE FOREGOING LIMITATIONS REFLECT THIS REASONABLE ALLOCATION OF RISK. XI. SAFE OPERATION YOU ASSUME THE SOLE RESPON

expense and are deemed to be "commercial computer software" and "commercial computer software documentation", respectively, pursu

376 Appendix C – OpenLNS CT Software License Agreement

Appendix D Software License Transfer Agreement If you purchased a license for the OpenLNS CT software, you can transfer the license to another party

Software License Transfer Agreement THIS SOFTWARE LICENSE TRANSFER AGREEMENT is entered into as of : (Da

Determining User Permissions ... 28 Optimizing IzoT Commissioning Tool Network Performanc

c. The Import License Request or Response File dialog opens. In the File Name property, enter the full path of the license response file (.elwrs ex

12. Click Exit to close the License Wizard. IzoT Commissioning Tool User’s Guide 25

3 Getting Started This chapter describes how to plan and create IzoT Commissioning Tool network designs. It describes how to use the IzoT Commissi

Design Overview To prepare to design an IzoT Commissioning Tool network, follow these steps: 1. Define network requirements and organization. 2. Se

Ad-Hoc System Scenario The ad-hoc system scenario allows you to design and install the network onsite. In this scenario, IzoT Commissioning Tool loa

When designing multiple drawing files, organize the individual drawing files as subsystems within the top-level drawing file, and limit the top-level

Functional Blocks If you have a large network with many unconnected network variables on the functional blocks, delete the unused network variable S

The IzoT Commissioning Tool Design Manager consists of five tabs that let you perform the following functions: • General. Create, open, copy, dele

Network Name Specifies the name of the new IzoT Commissioning Tool network design to be created. The name must be unique to all the IzoT Commissioni

Defragment Database Defragments and recreates the index for the IzoT Commissioning Tool database specified in the Database Name list. This can reduc

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

When IzoT Commissioning Tool displays documentation for selected devices, functional blocks, and network variables, it uses the definitions contained

Remove Removes the selected language from the list. Add Adds a language to the end of the list. Exit Design Manager after Launching Visio Sel

network. This option is only available if you selected the Network Attached check box. Skip Network Interface Options Page Skips the network interfa

Custom IzoT Commissioning Tool templates installed in the template directory are also listed. Root Subsystem Name Specifies the top-level subsystem n

stencil file associated with the IzoT Commissioning Tool version or description of a stencil file. Add Click Add to open the Add New Stencil dialog

• Backup/Restore • Configuration Properties • Device • Functional Blocks • General • Naming Options • Network Explorer • NV Browser/Monitorin

or have dynamic IP addresses that do not change. A static IP address is an address that is not dynamically assigned by a DHCP server. 2. Create an

The devices on the IP-852 channel will not be fully commissioned until you run OpenLNS applications such as the OpenLNS Server or IzoT Commissioning

Commissioning Tool as a local client (IzoT Commissioning Tool is running on the same computer as the OpenLNS server). To create a new IzoT Commissio

Tips: • You can click Finish at any point in the Network Wizard. Doing so will skip the subsequent series of pages, and your new IzoT Commis

Managing and Editing Device Templates with the Network Explorer ... 134 Man

operational network. See Recovering an IzoT Commissioning Tool Network in Chapter 7, Maintaining Networks, for more information. Network Database P

Notes: • The network interface you select must already have been defined and configured, as described in Setting up a Network Interface. • For I

Show all Options check box under Existing Networks in the IzoT Commissioning Tool Design Manager General tab is selected, the prompt will appear rega

You can disable a plug-in to prevent IzoT Commissioning Tool from prompting you to register the plug-in. This button is available when a plug-in li

1. Click Start on the taskbar, point to Programs, point to Echelon IzoT Commissioning Tool, and then select IzoT Commissioning Tool. The IzoT Commi

5. Following steps 7 through 9 of Creating a New IzoT Commissioning Tool Network Design, select whether IzoT Commissioning Tool is attached to the

6. Select the desired synchronization options and subsystem assignments. Create Shapes for all Connected NVs/MTs Adds SmartShapes to functional

8. Select the stencils that you want to be scanned for master SmartShapes. • To add a stencil, click Add Stencil, select the desired Visio st

automatically. If you have lost Echelon’s signature on a network drawing, you have three options: (1) ignore the macro warnings as described in the

3. Click Yes. The Network Wizard opens and the Naming page opens 4. Follow steps 5–11 in Creating an IzoT Commissioning Tool Network Design. By

Hiding Browser Rows ... 174 Saving Browser Customization...

5. A new random domain ID is generated. To use a specific domain ID, clear the Use Randomly Generated Domain ID check box and enter your ID in hex

and routers will be updated to match the new network database. Verify that IzoT Commissioning Tool is not attached to the original network and then

5. If you are opening an IzoT Commissioning Tool network after starting IzoT Commissioning Tool for the first time, a message may appear asking you

Select the Automatically Determine Server Location check box to have IzoT Commissioning Tool automatically determine the location of the OpenLNS Se

OpenLNS ServerDevice1Device2Device3Device4Device5Device6LonWorks ChannelOpenLNS ServerOpenLNS CT(Local Client) A local client can also be configured

Remote Full Client A remote full client is an IzoT Commissioning Tool computer that communicates with the OpenLNS Server (running on a separate comp

To use IzoT Commissioning Tool on a remote full client follow these steps: 1. Prepare for remote operations. a. Copy any custom stencils that you w

d. Select the OpenLNS network interface or IP-852 network interface to be used to connect to the LONWORKS channel. An OpenLNS Server or remot

f. To open an additional network, click Start OpenLNS Server on the IzoT Commissioning Tool Design Manager. The OpenLNS Server window opens. Highl

LonWorks ChannelOpenLNS ServerDevice1Device2Device3Device4Device5Device6OpenLNS CT(Remote Lightweight Client)TCP/IP To use IzoT Commissioning Tool on

Creating a Backup from an OpenLNS CT Drawing ... 210 Creating a Backup from the IzoT Commissioning Tool Design Manager ...

Click Yes to open the network drawing. The Network Wizard opens with the Server Location dialog. 6. Select Remote Lightweight Client to access the

8. Select an IzoT Commissioning Tool network to open. If a connection to this network has already been established, click Next, and skip to step 1

Using Network Service Device SmartShapes A network service device (NSD) is a local or remote client capable of monitoring and controlling the network

Note: If you need to remove a NSD from the physical network, first remove the network service device SmartShape from the drawing by right-clicking it

Upgrading Network Service Devices When you upgrade IzoT Commissioning Tool or switch between an OpenLNS high performance network interface (LonTalk l

Creating a New User Profile To create a new user profile, follow these steps: 1. In the OpenLNS CT drawing, click Add-ins, point to IzoT Commission

3. Set the user interface, access, and privileges of the new user. UI Setting If you are using Visio 2003, you can select the set of IzoT Commi

Privileges Select which actions the user can perform on objects in the OpenLNS CT drawing. You can set privileges for reading, modifying, changing

3. Type the old password in the Old Password box, enter the new password in the New Password and Retype Password boxes, and then click OK. The pass

4. Enter the user name and password of the user you want to logon as. 5. Click OK. You will be logged on as the selected user. Using IzoT Commiss

Maintaining IzoT Commissioning Tool ... 282 Upgrading IzoT Commissioning Tool Standard Edition t

74 Getting Started

4 Designing Networks This chapter describes how to design a network using IzoT Commissioning Tool. It covers how to create the following objects

Creating a LONWORKS Network You can design a LONWORKS network and then install it using IzoT Commissioning Tool. To design a LONWORKS network with I

• If you have licensed IzoT Commissioning Tool as part of the NodeBuilder tool, the IzoT Commissioning Tool Basic Shapes stencil is replaced with

2. Enter the following information for the device. Device Name Enter the name of the device. This name must be unique within the currently display

Device Template Create a New Device Template Select this check box to create a new device template for the device. If you select this check box,

4. Enter the following information: Location Specifies a 6-byte location string that documents the device’s location within the network. To st

with the network. Set the ping interval based on the expected movement of the device. Select Never to disable pinging. To enable pinging, chang

You can also have automatic channel selection enabled by default in each OpenLNS CT drawing you create or open. In the IzoT Commissioning Tool Desi

3. Click and hold the mouse button. 4. Drag the Connector tool to the center of the SmartShape of the desired channel so that a red box opens a