Echelon OpenLNS Commissioning Tool Manuel d'utilisateur

OpenLNS Commissioning Tool User's Guide 078-0488-01A

x Preface Appendix D Software License Transfer Agreement... 375

84 Designing Networks subsequent functional block with the same name for the same device, the instance number is incremented by one. For example,

OpenLNS CT User’s Guide 85 the Create all Network Variables Shapes check box. 3. Click Finish to add the functional block SmartShape to the OpenLN

86 Designing Networks 1. Right-click the functional block you want to move, point to Move FB, and click Change Assigned Device to reassign the func

OpenLNS CT User’s Guide 87 2. Right-click the functional block you want to update with the configured settings, point to Configuration Properties

88 Designing Networks 4. Select the target subsystems into which you want the configuration properties to be copied. You can expand a subsystem

OpenLNS CT User’s Guide 89 7. You can remove a functional block target from the list by selecting the target’s subsystem name and then clicking R

90 Designing Networks Dynamic functional blocks are typically used by controllers that do not have a static interface. These controllers typically

OpenLNS CT User’s Guide 91 5. If the selected functional profile defines mandatory and/or optional network variables, the corresponding check boxe

92 Designing Networks 2. Under Device, select the device to which you want to assign the virtual functional block from the Name list 3. Under Func

OpenLNS CT User’s Guide 93 setting) encapsulated within functional blocks that a particular device application expects to receive from other physic

OpenLNS CT User’s Guide xi Preface The OpenLNS Commissioning Tool (OpenLNS CT) is a software package for designing, installing, and maintaining mult

94 Designing Networks To automatically add all available network variables to a functional block, select the Create Shapes for all Network Variables

OpenLNS CT User’s Guide 95 3. The Create Network Variable dialog box opens. Enter the name, number, and type of the dynamic network variable(s)

96 Designing Networks d. Select the type of the dynamic network variable based on a defined type, or the type of an existing network variable in yo

OpenLNS CT User’s Guide 97 5. Under Poll Attributes of New NV(s), select whether the dynamic network variable(s) will by default use polled monit

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

OpenLNS CT User’s Guide 99 2. Following steps 3–6 in Creating Dynamic Network Variables Using Network Variable SmartShapes, change the default nam

100 Designing Networks 4. Select one or more network variable SmartShapes to delete. To select multiple network variable SmartShapes, hold down C

OpenLNS CT User’s Guide 101 Deleting Dynamic Network Variables You can delete a dynamic network variable from a functional block. When you delete

102 Designing Networks To add a router to an OpenLNS CT drawing, follow these steps: 1. Drag a Router SmartShape () from the OpenLNS CT stencil to

OpenLNS CT User’s Guide 103 more than 85 characters long. If you are creating one or two new channels, specify the channel type for each channel i

xii Preface Purpose This guide outlines the new features in the OpenLNS Commissioning Tool (OpenLNS CT), and it describes how to use OpenLNS CT to d

104 Designing Networks If you do not specify a value and the Set Location Property to Subsystem ID check box in the Network Properties: Recovery opt

OpenLNS CT User’s Guide 105 because it allows OpenLNS CT to optimize network traffic and determine automatically the channel to which each device i

106 Designing Networks Changing a Router Channel You can change one or both of the channels assigned to a router SmartShape. You can do this to ass

OpenLNS CT User’s Guide 107 2. Enter the following information: Channel Definition Select whether the SmartShape represents a new or an exis

108 Designing Networks selected channel type. Round-Trip Delay Select whether to use the default round-trip delay or to specify a time for the chan

OpenLNS CT User’s Guide 109 2. Enter the following information: Subsystem Enter the name of the subsystem. The name must be unique within the c

110 Designing Networks Copy subsystems. You have three choices: • Do not Copy. Only the subsystem SmartShape will be copied. None of the conten

OpenLNS CT User’s Guide 111 4. Right-click the subsystem and click Expand from the network navigator. All devices, functional blocks, and avail

112 Designing Networks 2. Right-click anywhere in the OpenLNS CT drawing, in the same or in a different subsystem, and click Paste on the shortcut

OpenLNS CT User’s Guide 113 Creating a Connection with the Connector SmartShape You can create a connection with the Connector SmartShape ( ) in th

OpenLNS CT User’s Guide xiii OpenLNS Programmer’s Reference Provides reference information for writing OpenLNS tools, applications, and plug-ins.

114 Designing Networks Creating a Connection with the Network Variable Connection Dialog Box You can create a connection using the Network Variable

OpenLNS CT User’s Guide 115 3. Create the network variable connection by selecting the following options: Hub: (box) Displays the currently sele

116 Designing Networks • NV. Displays available or compatible network variables. • MT. Displays available message tags. This option is only a

OpenLNS CT User’s Guide 117 7. In the New Connections box, select a connection description to assign to all the new connections listed in the Conn

118 Designing Networks eliminates the need to manually move functional block, connector, and connector reference SmartShapes to keep your OpenLNS CT

OpenLNS CT User’s Guide 119 network overhead for large multicast fan-out connections. For example, a repeated message with three retries to 64 dev

120 Designing Networks Repeated with Alias Multicast Repeated Alias Repeated with Broadcast Multicast Repeated Broadcast Repeated with Group

OpenLNS CT User’s Guide 121 To view the properties of a connection description, select the connection description from the Name list. If you do ma

122 Designing Networks StartUnicast?All targets on same subnet?# of targets< Z ?*SCD_UnicastAcknowledged serviceAliases for selector conflictsDoe

OpenLNS CT User’s Guide 123 3. You can change or disable the connection description used for each condition in the automatic connection descripti

xiv Preface the OpenLNS CT DVD or purchase an OpenLNS CT activation key. To receive technical support from Echelon, you must purchase support servi

124 Designing Networks Connection Description, and then click the desired connection description on the shortcut menu. To disable automatic connect

OpenLNS CT User’s Guide 125 To hide a connector SmartShape directly attached to two functional block SmartShapes (not attached using a reference

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

OpenLNS CT User’s Guide 127 2. Select the following options for creating and displaying connection SmartShapes for the selected functional block

128 Designing Networks Show Connection Shapes Select whether connection SmartShapes attached to the selected functional block(s) are displayed. Thi

OpenLNS CT User’s Guide 129 2. The window displays a hierarchal view of the subsystems in your network, with the nested subsystems and devices in

130 Designing Networks To use the network navigator, right-click an object that can be expanded and then click one of the following commands in th

OpenLNS CT User’s Guide 131 Network Explorer options category. By default subsystems, devices, and functional blocks are displayed. To expand

132 Designing Networks • In the subsystem view, the top-level subsystem and all the subsystems it contains are displayed, and all the other objects

OpenLNS CT User’s Guide 133 The Device Template shortcut menu contains the following options: Delete Deletes the selected device template. This

OpenLNS CT User’s Guide xv Content This guide includes the following content: • Introduction: Provides an introduction to the OpenLNS CT, new featur

134 Designing Networks The Device Template Properties dialog box contains the following options: Name Specifies the name of the device template.

OpenLNS CT User’s Guide 135 will validate that the physical device is on the correct assigned Channel and that the device template has the same Pro

136 Designing Networks Data Layer Shows/hides all monitored connections. • Right-click an empty space in your OpenLNS CT drawing, point to Display

OpenLNS CT User’s Guide 137 2. Point to Move Device (for device, router, and subsystem SmartShapes) or Move FB (for functional block SmartShapes)

138 Designing Networks 2. Set the following options: Original Channel Name Specifies the current channel on which the devices or routers are atta

OpenLNS CT User’s Guide 139 • Select Online to put the devices or routers in the online state. This is the default for routers. The behavior in

140 Designing Networks 2. Change the channel on which the OpenLNS computer is attached following step 2 in Moving a Device or Router to a Different

OpenLNS CT User’s Guide 141 Deleted OpenLNS CT Shape Affect on Physical Device Commissioned Application Device Application device is decommissione

142 Designing Networks The following figures illustrate the difference of a device SmartShape menu with OpenLNS CT Shape Menus selected and cleared.

OpenLNS CT User’s Guide 143 6. The AutoCAD drawing opens in the OpenLNS CT drawing as a background. Exporting an AutoCAD Drawing You can export an

xvi Preface • Creating and Using OpenLNS CT SmartShapes and Stencils: Describes how to create an OpenLNS CT stencil and create and use custom master

144 Designing Networks

OpenLNS CT User’s Guide 145 5 Installing Networks This chapter describes how to install devices using OpenLNS CT, including how to load application

146 Installing Networks Network Installation Overview You can install the devices that you added to your OpenLNS CT network design in Designing Netw

OpenLNS CT User’s Guide 147 Selecting Devices for Commissioning To select the device or devices to be commissioned, follow these steps: 1. Rig

148 Installing Networks 2. The Commission Device Wizard opens. Where you start in the wizard depends on whether you are commissioning an applic

OpenLNS CT User’s Guide 149 1. Specify the device application by setting the following options: Load Application Image Select this check box to lo

150 Installing Networks default. XIF Name If you are loading an application file with an .nxe extension, select the pathname of the XIF file. OpenL

OpenLNS CT User’s Guide 151 Setting the Initial Application Device State and Source of Configuration Property Values When the Device Initial State w

152 Installing Networks is reset. For a device to be disabled, it must contain a Node Object functional block. If Disable is selected and the devi

OpenLNS CT User’s Guide 153 Image window. • Upload from New App Image. The current device-specific configuration property values in the selected a

OpenLNS CT User’s Guide 1 1 Introduction This chapter provides an introduction to the OpenLNS Commissioning Tool, describes new features, and expl

154 Installing Networks operation. • Offline. The router will not forward packets. • Online. The router will forward packets between the chann

OpenLNS CT User’s Guide 155 2. Click Finish. If you selected the Service Pin method, you are prompted to press the service pin as described in Usi

156 Installing Networks To acquire the Neuron IDs and finish installing the devices, follow these steps: 1. Select any of the following service pin

OpenLNS CT User’s Guide 157 Using the Manual Entry Method If you selected Manual as the device identification method or if OpenLNS CT is not attache

158 Installing Networks scanner vendor for prices on the different scanner types. If you are using a LonPoint device, or a device with a similar ba

OpenLNS CT User’s Guide 159 2. Select the following options: Device Selection Scope Selects which subsystems will be searched for uncommissioned d

160 Installing Networks Include Devices with Unknown Programs Adds physical devices to the discovered device list that are applicationless or have a

OpenLNS CT User’s Guide 161 This dialog box allows you to manually or automatically match the discovered devices on the network with the defined de

162 Installing Networks appropriate device list. Match Matches the device selected in the Defined Devices list is to the device selected in the Dis

OpenLNS CT User’s Guide 163 11. Select an application image and set the options for the initial application state and source of configuration prop

2 Introduction Introduction to the OpenLNS Commissioning Tool The OpenLNS Commissioning Tool (OpenLNS CT) is a LONWORKS® network tool that runs on t

164 Installing Networks

OpenLNS CT User’s Guide 165 6 Monitoring and Controlling Networks This chapter describes how you can monitor and control the devices in your networ

166 Monitoring and Controlling Networks Monitoring and Controlling Overview You can monitor and control the physical devices in a network by reading

OpenLNS CT User’s Guide 167 When you enable monitoring on a connection, the network variable values are continuously polled. The default poll inte

168 Monitoring and Controlling Networks Using the OpenLNS CT Browser You can use the OpenLNS CT Browser to monitor and control the network variables

OpenLNS CT User’s Guide 169 The OpenLNS CT browser color codes the configuration properties and network variables in the following manner: Blue Inpu

170 Monitoring and Controlling Networks The OpenLNS CT Browser Toolbar You can use the OpenLNS CT browser toolbar to perform many browser functions

OpenLNS CT User’s Guide 171 therefore, you would hide the subsystem column. In another example, you may want to monitor and control only a few of t

172 Monitoring and Controlling Networks Under the display box, select which objects you want displayed in the browser. You have three choices: •

OpenLNS CT User’s Guide 173 This dialog lists all the hidden objects in the browser. Select the object or objects you want to show, or select the S

OpenLNS CT User’s Guide 3 3170/3150/3120 Smart Transceiver, and also includes devices based on third-party ISO/IEC 14908-1 protocol processors. Thi

174 Monitoring and Controlling Networks You can update all network variable values by clicking the Refresh All button () on the browser toolbar or o

OpenLNS CT User’s Guide 175 d. Enter the name of the Virtual Functional Block in the New FB Name box. 2. Drag an Input Network Variable SmartShape

176 Monitoring and Controlling Networks All the fields for the selected object are listed in structural order in the Field List box. To set the va

OpenLNS CT User’s Guide 177 Setting Values for Configuration Property Arrays You can view and set values for a configuration property array using a

178 Monitoring and Controlling Networks Clearing Values You can clear the displayed value of a network variable or configuration property by right-c

OpenLNS CT User’s Guide 179 This dialog lists built-in data types, and resource files containing defined network variable types (SNVTs and UNVTs).

180 Monitoring and Controlling Networks The format may include scaling and offset values to convert one type of data to another such as Celsius to F

OpenLNS CT User’s Guide 181 • Select the Show Obsolete Types check box to list those network variable types that are marked obsolete in the current

182 Monitoring and Controlling Networks Using Data Point SmartShapes You can use a Data Point SmartShape in an OpenLNS CT drawing to monitor the val

OpenLNS CT User’s Guide 183 default. If this check box is selected, the same data point will be monitored in a new Data Point SmartShape. If this

ii Preface Echelon, LON, LONWORKS, LonTalk, Neuron, LONMARK, 3120, 3150, LNS, LonMaker, and the Echelon logo are trademarks of Echelon Corporation

4 Introduction OpenLNS CT Versions There are five versions of OpenLNS CT: OpenLNS CT Professional, OpenLNS CT Professional Without Visio, OpenLNS CT

184 Monitoring and Controlling Networks and field name [if defined]). This is the default. • Device.FB.NV (the device name, functional block nam

OpenLNS CT User’s Guide 185 a functional block state. Polling Interval Specifies how frequently (in seconds) the data point is polled. The default

186 Monitoring and Controlling Networks • A structured value is a value that contains multiple fields such as a switch value with state and level f

OpenLNS CT User’s Guide 187 • Expand a field in the Field List box and then click twice slowly on the value that opens below the field. Enter a va

188 Monitoring and Controlling Networks Creating and Using a Custom Data Point Master SmartShape You can create a custom data point master SmartSha

OpenLNS CT User’s Guide 189 subsystem levels up the network hierarchy and then down to the “Floor2.Room10” subsystem in the network. A custom Data

190 Monitoring and Controlling Networks specifically address HMI tasks. In addition, these tools offer components that provide reporting and analys

OpenLNS CT User’s Guide 191 • Example The following example demonstrates a function that writes an “ON” value to a SNVT_swtich data point: RUNADD

192 Monitoring and Controlling Networks 2. In the Macros Name: dialog box, enter a name for the Macro. Click Create. The Network Passwords dialog

OpenLNS CT User’s Guide 193 • If you are monitoring the lamp value, you can change the color of the Visio shape based on the brightness of the lam

OpenLNS CT User’s Guide 5 OpenLNS CT Drawing An OpenLNS CT drawing contains the graphical representation of the LONWORKS network. An OpenLNS CT dra

194 Monitoring and Controlling Networks 6. In the OpenLNS CT drawing, right-click the Visio shape used to monitor the Data Point SmartShape, and th

OpenLNS CT User’s Guide 195 7 Maintaining Networks This chapter provides an overview of network maintenance tasks that you can perform with OpenLNS

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

OpenLNS CT User’s Guide 197 To load a new application into a device, the devices must have writeable application memory, and OpenLNS CT must be atta

198 Maintaining Networks name without a path only if the XIF file is in the folder specified in the XIF Search Path box Network Properties: Device op

OpenLNS CT User’s Guide 199 Load Application Image Select this check box to enable loading a new application image into the device. Update Firmware

200 Maintaining Networks Selecting Initial Device State and Source of Configuration Property Values To select the initial device state and the source

OpenLNS CT User’s Guide 201 after a reset. • Disable. Keeps the device application disabled even if the device is reset. For a device to be disab

202 Maintaining Networks new device. 2. Click Next. The Device Identification Method window opens. Follow the steps in Installing Devices and Ro

OpenLNS CT User’s Guide 203 5. Specify the initial state of the replacement device’s application, and select the source of the configuration prope

6 Introduction (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-85

204 Maintaining Networks and the device does not contain a Node Object functional block, the device is placed offline. As with offline operation, p

OpenLNS CT User’s Guide 205 case, follow the steps in Installing Devices and Routers in Chapter 5, Installing Networks, to continue installing the d

206 Maintaining Networks network tool not based on OpenLNS is used to update the physical devices, or if the devices themselves update their own conf

OpenLNS CT User’s Guide 207 3. Click OK. OpenLNS CT updates the device and the OpenLNS network database, as required. Using OpenLNS CT as a Passiv

208 Maintaining Networks Manually Backing Up an OpenLNS CT Network You can back up an OpenLNS CT network design from an OpenLNS CT drawing or from t

OpenLNS CT User’s Guide 209 • Select the Backup NodeBuilder Project check box to back up the NodeBuilder project associated with the OpenLNS CT net

210 Maintaining Networks • If the backup file includes only the database, the default backup file is <OpenLNS CT network>Db[_index].zip. 6. C

OpenLNS CT User’s Guide 211 To set the automatic OpenLNS CT drawing save interval, follow these steps: 1. In the OpenLNS CT drawing, click Add-ins,

212 Maintaining Networks backup, the backup will be stored in the LM\Backup\<network name> folder and the backup file will include the date on

OpenLNS CT User’s Guide 213 7. Click Next. 8. Click Finish. Windows XP SP3 To create a scheduled task in Windows XP3, follow these steps: 1.

OpenLNS CT User’s Guide 7 The application program in a device does not need to know where input network variable values come from or where output

214 Maintaining Networks Restoring an OpenLNS CT Network You can restore an OpenLNS CT network from a standard OpenLNS CT backup or a hot backup. If

OpenLNS CT User’s Guide 215 backup file names are in the following format by default: <network name>Db[_index].zip), and click Open or double-

216 Maintaining Networks 7. This dialog box displays the paths where the restored network database will be saved. You cannot change the directory i

OpenLNS CT User’s Guide 217 Restoring a Full Network Backup To restore a full network backup containing both the network database and OpenLNS CT dra

218 Maintaining Networks • Click Yes if you made any changes to the network since it was backed up. This prevents the network from behaving unpredi

OpenLNS CT User’s Guide 219 15. Click Next to next to accept the default synchronization operation, which is Synchronize Network to Database (the

220 Maintaining Networks 17. Select the state of the devices after they have been recommissioned. You have four choices: • Preserve Current State

OpenLNS CT User’s Guide 221 19. This window displays the status of the resynchronization. Resynchronization events will be listed in the order

222 Maintaining Networks 3. Verify that the recovered network opens to be correct. The recovery wizard logs the recovery tasks as well as any error

OpenLNS CT User’s Guide 223 4. Click OK. You can update the recovery data in the physical devices in a network after setting the subsystem recov

8 Introduction actuator has mandatory SNVT_switch input and output network variables, optional SNVT_elapsed_tm and SNVT_elec_kwh output network vari

224 Maintaining Networks 3. Select the subsystems and drawing files to update. 4. Click Finish. The Synchronization Status dialog opens and Open

OpenLNS CT User’s Guide 225 OpenLNS CT then assigns the discovered devices the first subsystem ID value discovered. OpenLNS CT resolves any conflic

226 Maintaining Networks 5. The Plug-In Registration dialog opens. Register or disable plug-ins as desired and click Next. 6. The Authenticatio

OpenLNS CT User’s Guide 227 7. The Domain Definition dialog opens. If you know the domain ID of the network that you want to recover, enter it in

228 Maintaining Networks 9. If you selected the Recover Domain ID from Network Device check box, the Service Pin dialog box opens. Press the servic

OpenLNS CT User’s Guide 229 13. The Recovery Options dialog box opens. If you expect your network to have more than 200 devices, select the Large

230 Maintaining Networks 15. The External Interface Files dialog box opens. Add or remove device templates based on device interface (XIF) files.

OpenLNS CT User’s Guide 231 17. When the data recovery is complete, the Optimizing Database dialog box opens. Select the Organize Database check

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

OpenLNS CT User’s Guide 233 22. The Select Stencils dialog box opens. Add, remove, or re-order stencils. Click Finish 23. The Synchronization

OpenLNS CT User’s Guide 9 be further divided into subsystems for each floor, and each floor divided into subsystems for each room. Supernodes Usin

234 Maintaining Networks 25. Compare the recovered OpenLNS network database to your expected results. Because network recovery occurs while OpenLNS

OpenLNS CT User’s Guide 235 • Any address table entries that are not associated with a network variable or message tag (source or target) are marke

236 Maintaining Networks OpenLNS CT object that the other user is trying to modify at the same time. As a result, multiple users will typically be m

OpenLNS CT User’s Guide 237 You can sort the OpenLNS CT event log by any of the column headers. To sort by a column header, click the header. Clic

238 Maintaining Networks The exported XML version of the OpenLNS CT event log contains the following information for each log entry. DocumentName N

OpenLNS CT User’s Guide 239 blocks. NvHandle The index of the network variable in the device. This field only applies to events related to network

240 Maintaining Networks 3. Choose the synchronization operation(s) you want to perform by selecting the following options. OpenLNS Database The n

OpenLNS CT User’s Guide 241 OpenLNS CT Drawing Synchronize Drawing to Database (fix-up Drawing) Updates the OpenLNS CT drawing to be consistent wit

242 Maintaining Networks 5. Select the scope of the selected synchronization operation(s) by choosing which subsystems and drawing files to resynch

OpenLNS CT User’s Guide 243 Otherwise, if you are synchronizing the network or the OpenLNS CT drawing to the network database, click Next and skip t

10 Introduction

244 Maintaining Networks 9. Select the following options and then click Next. Shapes All SmartShapes that have newer versions available than the on

OpenLNS CT User’s Guide 245 during Resync resynchronization. This speeds up resynchronization, as it reduces the time Visio spends updating the dr

246 Maintaining Networks 15. Specify the stencils that will be scanned for master SmartShapes during resynchronization. When objects are found wit

OpenLNS CT User’s Guide 247 events, including any errors, are shown in the status pane and recorded in a log file (Resync.log). The resync log is s

248 Maintaining Networks which no permanent server is needed. In most cases, however, it may be easier (if not necessary) to install each floor as a

OpenLNS CT User’s Guide 249 • Non OpenLNS CT extension records. Non OpenLNS CT extension records will only be copied if you selected the Enable Co

250 Maintaining Networks 5. Click Finish to prepare the OpenLNS CT network design for merging. The OpenLNS CT Database Merge Export Status dialog o

OpenLNS CT User’s Guide 251 12. Select the source network you exported in steps 4 – 6 from the Select Network to be Merged list. This list contai

252 Maintaining Networks This dialog displays the status of the network merge and lists the events in the order they occur. Any errors encountered a

OpenLNS CT User’s Guide 253 8 Managing Networks This chapter explains how to test and verify application devices, functional blocks, and routers.

OpenLNS CT User’s Guide 11 2 Installing and Activating OpenLNS CT This chapter describes how to order OpenLNS CT, install the various software and

254 Managing Networks Using the OpenLNS CT Device Manager You can manage application devices, functional blocks, and routers using the OpenLNS CT De

OpenLNS CT User’s Guide 255 Managing Devices To manage a device, right-click a device (or select multiple objects including at least one application

256 Managing Networks network variable values or send network variable updates. If the device was previously offline, the device state does not chan

OpenLNS CT User’s Guide 257 The commands in this dialog require that the device application associated with the functional block includes a Node Ob

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

OpenLNS CT User’s Guide 259 Click Settings to open the Device Manager Settings dialog box. There, you can set options for testing routers and optio

260 Managing Networks Repetition Control Repeat Number of Times Specifies how many times a Wink or Test command will be repeated. The default is 1

OpenLNS CT User’s Guide 261 device may not be responding properly, a router or channel between the OpenLNS Server and the device may have failed, o

262 Managing Networks When multiple functional blocks states are concurrently active, the style displayed is based on the order of the states listed

OpenLNS CT User’s Guide 263 Network Variable and Message Tag SmartShape Styles OpenLNS CT indicates the state of network variable and message tag Sm

12 Installing and Activating OpenLNS CT Ordering OpenLNS CT You can order OpenLNS CT directly from Echelon, from an Echelon distributor, or from the

264 Managing Networks Monitoring Enabled Text is black. Monitoring Disabled Text is magenta. OpenLNS CT updates the style of the connection Sma

OpenLNS CT User’s Guide 265 • Select Subsystem Page to include the application devices, routers, and functional blocks in the current subsystem. T

266 Managing Networks 4. Select additional functional blocks to include in the status summary based on the type of errors or exceptions they have

OpenLNS CT User’s Guide 267 For functional blocks, this dialog displays the following data in the top pane: subsystem, device, functional block name

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

OpenLNS CT User’s Guide 269

270 Managing Networks

OpenLNS CT User’s Guide 271 9 Exporting and Importing Networks with XML This chapter describes how to export a LONWORKS network to a LONWORKS net

272 Exporting and Importing Networks with XML Using XML Export/Import Overview You can speed up your network design and ensure your devices are conf

OpenLNS CT User’s Guide 273 1. Click Add-ins, point to OpenLNS CT Documents, and then click Export to XML. The XML Export Options dialog box opens

OpenLNS CT User’s Guide 13 4. Select the components that you wish to install by selecting the appropriate check boxes on the Select Components

274 Exporting and Importing Networks with XML Specific CP Values Device-specific CPs are CPs that may be changed by the device itself or by another

OpenLNS CT User’s Guide 275 4. Either open the OpenLNS CT XML file from Internet Explorer, or open the folder containing the OpenLNS CT XML file an

276 Exporting and Importing Networks with XML Click a functional block link to open a page with detailed data on that functional block and a table

OpenLNS CT User’s Guide 277 You can continue moving down the network hierarchy until reaching the end, which is at the network variable\configuratio

278 Exporting and Importing Networks with XML Input File Name Specifies the name of the XML file to import. Log File Name Specifies the name of th

OpenLNS CT User’s Guide 279 10 Managing OpenLNS CT Licenses This chapter provides an overview of OpenLNS CT licensing. It describes how to upgrade

280 Managing OpenLNS CT Licenses Commissioning Devices with OpenLNS CT OpenLNS CT lets you install devices without commissioning fees (known as “cre

OpenLNS CT User’s Guide 281 2. The License Wizard guides you through the process of manually updating or upgrading your OpenLNS CT license. Click

282 Managing OpenLNS CT Licenses 6. Select Upgrade from the Action list for both OpenLNS Server and OpenLNS CT, and then click Next. 7. If you

OpenLNS CT User’s Guide 283 8. In the Request File Name property, enter a full path where a license request file (.elwrq extension) is to be saved

OpenLNS CT User’s Guide iii Table of Contents Preface ...

14 Installing and Activating OpenLNS CT You can use the LONWORKS Interfaces application in the Control Panel to define, configure, and test RNIs, IP

284 Managing OpenLNS CT Licenses 10. Click Send Request to Echelon to e-mail the license request file to Echelon at [email protected]. Echelo

OpenLNS CT User’s Guide 285 d. The Check License Response File dialog opens. Confirm that the Echelon product licenses in the license response fi

286 Managing OpenLNS CT Licenses 12. Click Exit to close the License Wizard. Upgrading OpenLNS CT Standard Edition to OpenLNS CT Professional Ed

OpenLNS CT User’s Guide 287 d. If your computer is online, the Step 3: Enter Customer Information dialog opens. Complete the following steps to r

288 Managing OpenLNS CT Licenses • The Step 4: Status dialog opens, and the License Server returns your OpenLNS CT Standard license. • Clic

OpenLNS CT User’s Guide 289 Click Next. g. The Step 4: Status dialog opens. The License Wizard confirms the creation of the license request file

290 Managing OpenLNS CT Licenses losing your license. You cannot use the License Wizard to install one OpenLNS CT license on multiple computers.

OpenLNS CT User’s Guide 291 the target computer by e-mailing the license request file to Echelon at [email protected], or by copying it to the

292 Managing OpenLNS CT Licenses

OpenLNS CT User’s Guide 293 11 Using Plug-ins This chapter provides an overview of plug-ins and then describes how to start a plug-in, get plug-in

OpenLNS CT User’s Guide 15 If you selected the Visio component in the Select Components window, the Microsoft Visio setup wizard opens. Follow the

294 Using Plug-ins Using Plug-ins Overview Plug-ins are applications that you can start from within OpenLNS CT to perform a specialized task, often

OpenLNS CT User’s Guide 295 • To start a plug-in using a default command, right click a device or functional block SmartShape, and then select Con

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

OpenLNS CT User’s Guide 297 OpenLNS CT does not change the attribute on any other plug-ins. If multiple plug-ins are registered for the same comma

298 Using Plug-ins Server Name The registered ActiveX name for the plug-in. Multi-Object Whether the plug-in supports multiple objects simultaneou

OpenLNS CT User’s Guide 299 2. Click Register. The plug-in or plug-ins are added to the Pending list (they also remain under their existing lists)

300 Using Plug-ins 3. Click Apply to enable the selected plug-in or plug-ins. 4. After the plug-ins are enabled, click OK to return to the OpenLNS

OpenLNS CT User’s Guide 301 12 Creating and Using Custom OpenLNS CT SmartShapes and Stencils This chapter describes OpenLNS CT stencils and the pr

302 Creating and Using Custom OpenLNS CT Shapes and Stencils OpenLNS CT Stencils OpenLNS CT uses Visio stencils to speed your LONWORKS network engin

OpenLNS CT User’s Guide 303 LonWorks\LonMaker\Visio directory (by default, C:\Program Files\LonWorks\LonMaker\Visio [32-bit system] or C:\Program Fi

16 Installing and Activating OpenLNS CT c. Read the license agreement and click Yes if you agree with the terms. The Customer Information window

304 Creating and Using Custom OpenLNS CT Shapes and Stencils Using Custom OpenLNS CT Master SmartShapes You can reuse a custom OpenLNS CT SmartShape

OpenLNS CT User’s Guide 305 SmartShapes that will be used with the newly created device SmartShape. See 5Additional Functional Block User Cells for

306 Creating and Using Custom OpenLNS CT Shapes and Stencils For each channel listed, click anywhere in the Method field and then select how the ch

OpenLNS CT User’s Guide 307 You can use connection master SmartShapes to do the following: • Specify a connection with a connection description oth

308 Creating and Using Custom OpenLNS CT Shapes and Stencils If you drag this master SmartShape to any subsystem in the same network, OpenLNS CT cre

OpenLNS CT User’s Guide 309 4. Every OpenLNS CT SmartShape has an OpenLNS CT ShapeType user cell. The value of this cell specifies the OpenLNS CT

310 Creating and Using Custom OpenLNS CT Shapes and Stencils • A value of 0 indicates no. • A value of 1 indicates yes. • A value of 2 indicate

OpenLNS CT User’s Guide 311 The scope selector definitions are: 0 Standard functional profile defined in the standard resource file set. 3 Use

312 Creating and Using Custom OpenLNS CT Shapes and Stencils NewAdvPropCap Specifies handling of the advanced properties dialog in the new device wi

OpenLNS CT User’s Guide 313 • A value of 1 indicates that the style applies to the SmartShape’s lines. • A value of 2 indicates that the value app

OpenLNS CT User’s Guide 17 e. If your computer is connected to the Internet, the OpenLNS CT installer connects to the Echelon License Server, the L

314 Creating and Using Custom OpenLNS CT Shapes and Stencils and TmplName values. Additional Functional Block User Cells You can include the follow

OpenLNS CT User’s Guide 315 Additional Router SmartShape User Cells You can include the following additional user cells in a router SmartShape. Not

316 Creating and Using Custom OpenLNS CT Shapes and Stencils 5. Open the Insert menu, point to Picture, and then click From File. Select a bitmap

OpenLNS CT User’s Guide OpenLNS CT 317 Appendix A Setting OpenLNS CT Default Options This appendix documents the OpenLNS CT Default Options you ca

318 Appendix A - Setting OpenLNS CT Default Options Setting OpenLNS CT Default Options You can set OpenLNS CT Default Options either in the OpenLNS

OpenLNS CT User’s Guide 319 You can click Restore Defaults to reset all the options and values in the currently displayed options category to their

320 Appendix A - Setting OpenLNS CT Default Options (even those files that are not resource files or are not used in the OpenLNS CT drawing) will be

OpenLNS CT User’s Guide 321 Auto Save Intervals Drawing Save Sets how frequently (in minutes) the OpenLNS CT drawing (.VSD) file is automatically

322 Appendix A - Setting OpenLNS CT Default Options settings of the Overwrite Read-only Files and Overwrite More Recent Files check boxes This optio

OpenLNS CT User’s Guide 323 The Configuration Properties category contains the following options. Enable Configuration Properties Enables access to

18 Installing and Activating OpenLNS CT i. Click Finish. The ReadMe file opens if the Show the Readme File check box was selected. When you fini

324 Appendix A - Setting OpenLNS CT Default Options Copy Values on Functional Block Copy Copies CP values when creating a new functional block from

OpenLNS CT User’s Guide 325 Device Options The Device category contains the following options. Device Options XIF Search Path Specifies the pat

326 Appendix A - Setting OpenLNS CT Default Options Scope: All networks, current OpenLNS CT computer Prompt for Device State During Commissioning I

OpenLNS CT User’s Guide 327 commissioned. You have two choices: • Online. The router will forward packets between the channels connected to it.

328 Appendix A - Setting OpenLNS CT Default Options Device Selection block SmartShape, thereby skipping the Functional Block wizard. This option i

OpenLNS CT User’s Guide 329 is Deleted You have three choices: • No. The dynamic network variable is not deleted. • Yes. The dynamic network va

330 Appendix A - Setting OpenLNS CT Default Options General Options The General category contains the following options. Confirm Deletes Prompts y

OpenLNS CT User’s Guide 331 selected by default. Scope: Current network, current OpenLNS CT computer Automatically upgrade Visio drawings to curren

332 Appendix A - Setting OpenLNS CT Default Options The OpenLNS Event category contains the following options. The changes you make in the OpenLNS

OpenLNS CT User’s Guide 333 Channel Change Events Updates the OpenLNS CT drawing when channels are added, removed, or modified. This option is sele

OpenLNS CT User’s Guide 19 Manually Activating OpenLNS CT If your computer was not attached to the Internet when you installed OpenLNS CT, you can u

334 Appendix A - Setting OpenLNS CT Default Options Name/instance ID Separator Character Selects the character to be inserted between the OpenLNS C

OpenLNS CT User’s Guide 335 Network Explorer Options The Network Explorer is an auto-hide window that displays a hierarchal view of the OpenLNS CT d

336 Appendix A - Setting OpenLNS CT Default Options subsystems, devices, functional blocks, and network variables in the OpenLNS CT network. Scope:

OpenLNS CT User’s Guide 337 client. To remove the monitor sets, use the Remove Monitor Sets command from the Network Service Devices command on the

338 Appendix A - Setting OpenLNS CT Default Options The OpenLNS CT Font category contains the following options. OpenLNS CT Font Name Displays the

OpenLNS CT User’s Guide 339 The Recovery category contains the following options. The changes you make in the Recovery options category are appli

340 Appendix A - Setting OpenLNS CT Default Options will not be stored in the device. Scope: Current network, all OpenLNS CT computers Set Location

OpenLNS CT User’s Guide 341 Service Pin Options You can set options for using the service pin when commissioning a device. Show Service Pin Data Di

342 Appendix A - Setting OpenLNS CT Default Options Scope: Current network, all OpenLNS CT computers Shape ToolTips Options You can enable a ToolTi

OpenLNS CT User’s Guide 343 Synchronization Options The Synchronization category contains the following options. Automatic Update Interval (Seconds

20 Installing and Activating OpenLNS CT 3. To activate your OpenLNS CT software using the over the Internet or via e-mail, click Activate Product L

344 Appendix A - Setting OpenLNS CT Default Options Warnings Options The Warnings category contains the following options, which are all selected b

OpenLNS CT User’s Guide 345 you are only temporarily using a different network interface, you may choose not to upgrade. In this case, communicatio

OpenLNS CT User’s Guide 347 Appendix B Glossary This appendix provides definitions for terms commonly used with OpenLNS CT.

348 Appendix B – Glossary Glossary Acknowledged Service A service of the ISO/IEC 14908-1 Control Network Protocol that ensures a message was receiv

OpenLNS CT User’s Guide 349 or, for Neuron-hosted devices, you may load it into the device from application files (.nld, .apb, and .nxe extensions)

350 Appendix B – Glossary Channel Segment A portion of a channel. A single segment can be comprised of multiple sections connected by physical laye

OpenLNS CT User’s Guide 351 Control Network Protocol (CNP) A communication protocol standard for control networks defined by the ISO/IEC 14908-1 sta

352 Appendix B – Glossary Device Template A device template contains all the attributes of a given device type, such as its functional blocks, netwo

OpenLNS CT User’s Guide 353 Dynamic Network Variable A network variable that is added to a functional block after the device has been commissioned.

OpenLNS CT User’s Guide 21 7. The Step 3: Where Would You Like to Save Your License Requests? dialog opens. 8. In the Request File Name property

354 Appendix B – Glossary Group Addressing A logical addressing mode in the ISO/IEC 14908-1 Control Network Protocol that allows a message to be sen

OpenLNS CT User’s Guide 355 IP-852 Network Interface Software that enables IP-852 devices such as OpenLNS Server computers, OpenLNS CT computers, IP

356 Appendix B – Glossary devices use network variables to communicate with one another since they are interoperable and produce more efficient code

OpenLNS CT User’s Guide 357 format also specifies how data entered by a user or application is translated to the raw data to be transmitted on a LON

358 Appendix B – Glossary Node Object A functional block that monitors the status of all functional blocks in a device and makes the status informat

OpenLNS CT User’s Guide 359 OpenLNS Event An action fired by an OpenLNS Server to notify an OpenLNS client application of a change to the OpenLNS n

360 Appendix B – Glossary OpenLNS Commissioning Tool (CT) An OpenLNS network tool that uses Visio as its graphical user interface. OpenLNS CT is us

OpenLNS CT User’s Guide 361 master controller. Because of the enhanced system reliability introduced by eliminating the master (a single point of f

362 Appendix B – Glossary Resource File A file included with a LONWORKS device that defines the components of the device interface to be used by Ope

OpenLNS CT User’s Guide 363 under software control as long as the device is configured. For example, the device can ground the pin when the device

22 Installing and Activating OpenLNS CT 10. Click Send Request to Echelon to e-mail the license request file to Echelon at [email protected]

364 Appendix B – Glossary Supernode A subsystem with a network variable interface. Supernodes enable a group of devices to be organized into logica

OpenLNS CT User’s Guide 365 format, in order to allow the devices to be configured without the need for proprietary configuration tools. User-define

366 Appendix C – OpenLNS CT Software License Agreement

OpenLNS CT User’s Guide 367 Appendix C OpenLNS Software License Agreement This appendix provides a copy of OpenLNS CT Software License Agreement.

368 Appendix C – OpenLNS CT Software License Agreement OpenLNS CT Software License Agreement Echelon OpenLNS Commissioning Tool (CT) Software Licen

OpenLNS CT User’s Guide 369 • "Trial Period" is a 60-day period during which the Licensed Software can be used with limited functionality

370 Appendix C – OpenLNS CT Software License Agreement Echelon with a copy of same upon request; this right of transfer is exercisable no more than

OpenLNS CT User’s Guide 371 The functionality of the Microsoft Visio product as integrated in specified editions of the Licensed Software may differ

372 Appendix C – OpenLNS CT Software License Agreement $1000). YOU HEREBY AGREE THAT THE FOREGOING LIMITATIONS REFLECT THIS REASONABLE ALLOCATION

OpenLNS CT User’s Guide 373 expense and are deemed to be "commercial computer software" and "commercial computer software documentati

OpenLNS CT User’s Guide 23 c. The Import License Request or Response File dialog opens. In the File Name property, enter the full path of the lice

374 Appendix C – OpenLNS CT Software License Agreement

OpenLNS CT User’s Guide 375 Appendix D Software License Transfer Agreement If you purchased a license for the OpenLNS CT software, you can transfer

376 Appendix D – Software License Transfer Agreement Software License Transfer Agreement THIS SOFTWARE LICENSE TRANSFER AGREEMENT is entered into a

www.echelon.com

iv Preface Ad-Hoc System Scenario ...27 Determining User Permissions ...

24 Installing and Activating OpenLNS CT 12. Click Exit to close the License Wizard.

OpenLNS CT User’s Guide 25 3 Getting Started This chapter describes how to plan and create OpenLNS CT network designs. It describes how to use th

26 Getting Started Design Overview To prepare to design an OpenLNS CT network, follow these steps: 1. Define network requirements and organization.

OpenLNS CT User’s Guide 27 Ad-Hoc System Scenario The ad-hoc system scenario allows you to design and install the network onsite. In this scenario,

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

OpenLNS CT User’s Guide 29 functional block if you need to connect them later. To simplify following this guideline, you can create functional bloc

30 Getting Started The OpenLNS CT Design Manager consists of five tabs that let you perform the following functions: • General. Create, open, cop

OpenLNS CT User’s Guide 31 cannot create two networks with names that differ only in capitalization. The initial default network name is “Network

32 Getting Started defragmentation process. Start OpenLNS Server Starts the OpenLNS Server application so that remote client computers can access t

OpenLNS CT User’s Guide 33 You can set the resource file language for a specific network while in OpenLNS CT by clicking Add-ins, clicking OpenLNS C

OpenLNS CT User’s Guide v Deleting Dynamic FBs ...91 Creating Dynamic Functional Block M

34 Getting Started New Network Options You can use the New Network Options tab to set the default network interface, automatically register plug-ins

OpenLNS CT User’s Guide 35 Skip Plug-ins Options Page Skips the plug-in registration page in the Network Wizard when you create a new OpenLNS CT net

36 Getting Started Channel names may be up to 85 characters, may include embedded spaces, but may not include the period, backslash, colon, forward

OpenLNS CT User’s Guide 37 the list and then click Delete (the stencil file is not deleted). OpenLNS CT Default Options You can use the OpenLNS CT

38 Getting Started • Synchronization • Warnings Appendix A details the defaults you can set under each network properties options category. Sett

OpenLNS CT User’s Guide 39 For more information on creating IP-852 network interfaces, see the LONWORKS Interfaces online help file. 3. Define the

40 Getting Started The devices on the IP-852 channel will not be fully commissioned until you run OpenLNS applications such as the OpenLNS Server o

OpenLNS CT User’s Guide 41 To create a new OpenLNS CT network, follow these steps: 1. Click Start on the taskbar, point to Programs, point to Echel

42 Getting Started Tips: • You can click Finish at any point in the Network Wizard. Doing so will skip the subsequent series of pages, and

OpenLNS CT User’s Guide 43 See 4Recovering an OpenLNS CT Network in Chapter 7, Maintaining Networks, for more information. Network Database Path S

vi Preface Managing a Network with the Network Explorer ...132 Managing and Editing Device Templates with the Network Expl

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

OpenLNS CT User’s Guide 45 10. Click Next. The Plug-In Registration dialog opens. 11. Use the following commands to register, deregister, enable

46 Getting Started Registered or Not Registered or either of the category labels is selected. If the Already Registered or Not Registered category

OpenLNS CT User’s Guide 47 If an OpenLNS CT drawing does not have a digital signature, you will see the macro warning dialog and will have to enable

48 Getting Started 3. Click Create Drawing. Visio starts and the Naming dialog of the Network Wizard opens. 4. Specify the folder that will cont

OpenLNS CT User’s Guide 49 5. Following steps 7 through 9 of Creating a New OpenLNS CT Network Design, select whether OpenLNS CT is attached to the

50 Getting Started Missing FB Shapes SmartShape in the OpenLNS CT drawing. Subsystem to Visio Document Assignment Select in which Visio drawing fil

OpenLNS CT User’s Guide 51 LONWORKS Device SmartShape, for example) will be used. After OpenLNS CT is done scanning stencils, the Synchronization S

52 Getting Started 5. A new random domain ID is generated. To use a specific domain ID, clear the Use Randomly Generated Domain ID check box and

OpenLNS CT User’s Guide 53 Any devices you created and commissioned in your original network will have the same Neuron IDs in the copied version. T

OpenLNS CT User’s Guide vii Saving Browser Customization ...173 Monitoring Network Variables...

54 Getting Started 5. If you are opening an OpenLNS CT network after starting OpenLNS CT for the first time, a message may appear asking you if you

OpenLNS CT User’s Guide 55 8. Click Next. The Network Interface page opens, unless the Skip this Prompt check box was previously selected. Follow

56 Getting Started Remote Full Client A remote full client is an OpenLNS CT computer that communicates with the OpenLNS Server (running on a separ

OpenLNS CT User’s Guide 57 The following example demonstrates a scenario in which the OpenLNS CT computers communicate with the OpenLNS Server and t

58 Getting Started c. The Echelon OpenLNS Remote Server application opens with the Network Interfaces dialog. d. Select the OpenLNS network

OpenLNS CT User’s Guide 59 f. To open an additional network, click Start OpenLNS Server on the OpenLNS CT Design Manager. The OpenLNS Server wi

60 Getting Started 6. Select Remote Full Client to access the network and then click Next. The Network Interface page opens. 7. Follow steps 7–1

OpenLNS CT User’s Guide 61 To use OpenLNS CT on a remote lightweight client follow these steps: 1. Prepare for Remote Operations. a. Copy any cus

62 Getting Started 6. Select Remote Lightweight Client to access the network and then click Next. 7. If the server address is configured correc

OpenLNS CT User’s Guide 63 8. Select an OpenLNS CT network to open. If a connection to this network has already been established, click Next, and

viii Preface Creating a Backup from the OpenLNS CT Design Manager ...210 Scheduling Drawing Saves and Database Backups...

64 Getting Started 2. A dialog opens that allows you to select whether the network service device being added represents the local NSD (only availa

OpenLNS CT User’s Guide 65 This dialog box lists all NSDs in this network, regardless of whether a SmartShape has been created for each NSD. For

66 Getting Started and decide later to upgrade, select the NSD SmartShape, right-click it, and then click Upgrade NSD on the shortcut menu. When mov

OpenLNS CT User’s Guide 67 Creating a New User Profile To create a new user profile, follow these steps: 1. In the OpenLNS CT drawing, click Add-i

68 Getting Started 3. Set the user interface, access, and privileges of the new user. UI Setting If you are using Visio 2003, you can select

OpenLNS CT User’s Guide 69 Privileges Select which actions the user can perform on objects in the OpenLNS CT drawing. You can set privileges for

70 Getting Started 3. Type the old password in the Old Password box, enter the new password in the New Password and Retype Password boxes, and then

OpenLNS CT User’s Guide 71 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 selec

72 Getting Started

OpenLNS CT User’s Guide 73 4 Designing Networks This chapter describes how to design a network using OpenLNS CT. It covers how to create the fol

OpenLNS CT User’s Guide ix Upgrading OpenLNS CT Standard Edition to OpenLNS CT Professional Edition...

74 Designing Networks Creating a LONWORKS Network You can design a LONWORKS network and then install it using OpenLNS CT. To design a LONWORKS netw

OpenLNS CT User’s Guide 75 • If you have licensed OpenLNS CT as part of the NodeBuilder tool, the OpenLNS CT Basic Shapes stencil is replaced with

76 Designing Networks 2. Enter the following information for the device. Device Name Enter the name of the device. This name must be unique with

OpenLNS CT User’s Guide 77 Create a New Device Template Select this check box to create a new device template for the device. If you select this c

78 Designing Networks 4. Enter the following information: Location Specifies a 6-byte location string that documents the device’s location with

OpenLNS CT User’s Guide 79 with the network. Set the ping interval based on the expected movement of the device. Select Never to disable pinging

80 Designing Networks You can also have automatic channel selection enabled by default in each OpenLNS CT drawing you create or open. In the OpenL

OpenLNS CT User’s Guide 81 3. Click and hold the mouse button. 4. Drag the Connector tool to the center of the SmartShape of the desired channe

82 Designing Networks 2. Enter the following information: Source Functional Block Name Displays the name of the source functional block (a maste

OpenLNS CT User’s Guide 83 in the selected subsystem with available functional blocks will be listed. Type Specifies the device template associa