OpenLNS Commissioning Tool User's Guide 078-0488-01A
Echelon, LON, LONWORKS, LonTalk, Neuron, LONMARK, 3120, 3150, LNS, LonMaker, and the Echelon logo are trademarks of Echelon Corporation registered in the United States and other countries. LonSupport is a trademark of Echelon Corporation. Other brand and product names are trademarks or registered trademarks of their respective holders.
Table of Contents Preface .................................................................................................... xi Purpose ..........................................................................................................xii Audience.........................................................................................................xii System Requirements ....................................................................................xii OpenLNS CT Documentation...............
Ad-Hoc System Scenario ................................................................. 27 Determining User Permissions ............................................................... 27 Optimizing OpenLNS CT Network Performance .................................... 27 Drawing Files.................................................................................... 27 Network Changes ............................................................................. 28 Connections.................................
Deleting Dynamic FBs ............................................................... 91 Creating Dynamic Functional Block Master SmartShapes........ 91 Creating a Virtual Functional Block .................................................. 91 Adding a Message Tag SmartShape to a Virtual Functional Block .......................................................................................... 92 Deleting Message Tag SmartShapes ........................................ 92 Creating Network Variables ..........
Managing a Network with the Network Explorer ............................ 132 Managing and Editing Device Templates with the Network Explorer .......................................................................................... 132 Managing Device Templates ................................................... 132 Editing Device Template Properties......................................... 133 Working with OpenLNS CT Layers .............................................................
Saving Browser Customization ...................................................... 173 Monitoring Network Variables ............................................................... 173 Enabling Network Variable Monitoring ........................................... 173 Disabling Network Variable Monitoring .......................................... 173 Getting Network Variable Values ................................................... 173 Using Bound Updates .................................................
Creating a Backup from the OpenLNS CT Design Manager ......... 210 Scheduling Drawing Saves and Database Backups............................. 210 Scheduling Backups with OpenLNS CT .................................. 210 Scheduling Backups with the Windows Task Scheduler ......... 212 Restoring an OpenLNS CT Network..................................................... 214 Restoring a Network Database Backup ......................................... 214 Restoring an OpenLNS CT Drawing Backup .................
Upgrading OpenLNS CT Standard Edition to OpenLNS CT Professional Edition..................................................................................... 286 Renewing OpenLNS CT Annual Maintenance ............................................ 289 Transferring OpenLNS CT Licenses ........................................................... 289 11 Using Plug-ins ............................................................................... 293 Using Plug-ins Overview ......................................
Appendix D Software License Transfer Agreement........................
Preface The OpenLNS Commissioning Tool (OpenLNS CT) is a software package for designing, installing, and maintaining multi-vendor, open, interoperable LONWORKS® control networks. Based on Echelon's OpenLNS network operating system, OpenLNS CT combines support for open LONWORKS control networks with a user-friendly Microsoft Visio interface. The result is a software tool that’s robust enough to work with all your devices, yet economical enough to leave behind as an operations and maintenance tool.
Purpose This guide outlines the new features in the OpenLNS Commissioning Tool (OpenLNS CT), and it describes how to use OpenLNS CT to design, commission, monitor and control, maintain, and manage a network. OpenLNS CT includes online help that provides context-sensitive documentation that supplements the information in this guide. Audience This guide is intended for system designers and integrators with an understanding of control networks.
OpenLNS Programmer’s Reference Provides reference information for writing OpenLNS tools, applications, and plug-ins. Describes the objects in the OpenLNS Object hierarchy, and details their properties, methods, and events. LNS®Plug-in Framework Developer’s Guide Describes how to write system and device plug-ins using .NET programming languages such as C# and Visual Basic .NET. The following documents supplement the material provided in this guide.
the OpenLNS CT DVD or purchase an OpenLNS CT activation key. To receive technical support from Echelon, you must purchase support services from Echelon or an Echelon support partner. See www.echelon.com/support for more information on Echelon support. Your OpenLNS CT distributor may also provide customer support. You can also enroll in training classes at Echelon or an Echelon training center to learn more about using OpenLNS CT. You can find additional information about device development training at www.
Content This guide includes the following content: • Introduction: Provides an introduction to the OpenLNS CT, new features; and the basics of OpenLNS CT network designs, LONWORKS, and Visio. • Installing and Activating OpenLNS CT: Describes how to order and install OpenLNS CT and Microsoft Visio 2010, and then how to activate OpenLNS CT.
xvi • Creating and Using OpenLNS CT SmartShapes and Stencils: Describes how to create an OpenLNS CT stencil and create and use custom master SmartShapes for devices, functional blocks, subsystems, and connections. Explains how to modify a master SmartShape by changing its user-defined cells. • Appendices: Includes the OpenLNS CT default options, a glossary, the OpenLNS CT Software License Agreement, and the OpenLNS CT License Transfer Agreement.
1 Introduction This chapter provides an introduction to the OpenLNS Commissioning Tool, describes new features, and explains the basics of OpenLNS CT Network Designs, LONWORKS, and Visio.
Introduction to the OpenLNS Commissioning Tool The OpenLNS Commissioning Tool (OpenLNS CT) is a LONWORKS® network tool that runs on the OpenLNS network operating system and uses Microsoft Visio® 2010 or Visio 2003 (Professional or Standard editions) as a graphical user interface. The OpenLNS network operating system implements a client/server architecture with directory, installation, management, monitoring, and control services provided by an OpenLNS Server that is included with the OpenLNS CT.
3170/3150/3120 Smart Transceiver, and also includes devices based on third-party ISO/IEC 14908-1 protocol processors. This reduces network installation costs, makes installation and maintenance costs more predictable, and simplifies the installation process. Automated Product Activation You can quickly install and activate the OpenLNS CT software.
OpenLNS CT Versions There are five versions of OpenLNS CT: OpenLNS CT Professional, OpenLNS CT Professional Without Visio, OpenLNS CT Standard, OpenLNS CT Standard Without Visio, and OpenLNS CT Trial. OpenLNS CT Professional Without Visio and OpenLNS CT Standard Without Visio require a separate purchase of Visio 2010 or 2003. The advantage of OpenLNS CT Professional is that you can have an unlimited number of OpenLNS networks—OpenLNS CT Standard is limited to five networks.
OpenLNS CT Drawing An OpenLNS CT drawing contains the graphical representation of the LONWORKS network. An OpenLNS CT drawing consists of one or more drawing files, and the drawing files consist of one or more pages that each represent a subsystem. One drawing file is designated as the top-level drawing file; this drawing file is the one created when you create a new OpenLNS CT network design.
(high-speed twisted pair channel), PL-20 (ISO/IEC 14908-3 power line channel), FO-20 (ANSI/CEA-709.4 fiber optics channel), and IP-852 (ISO/IEC 14908-4 IP-communication). Different transceivers may be able to interoperate on the same channel; therefore, each transceiver type specifies the channel type or types that it supports. The choice of channel type affects transmission speed and distance as well as the network topology. Routers Multiple channels can be connected using routers.
The application program in a device does not need to know where input network variable values come from or where output network variable values go. When the application program has a changed value for an output network variable, it simply assigns the new value to the output network variable.
actuator has mandatory SNVT_switch input and output network variables, optional SNVT_elapsed_tm and SNVT_elec_kwh output network variables, and a number of optional configuration properties. The following diagram illustrates the components of the standard light actuator functional profile: When a functional block is created from a functional profile, the application designer can determine which of the optional configuration properties and network variables to implement.
be further divided into subsystems for each floor, and each floor divided into subsystems for each room. Supernodes Using OpenLNS CT, you can also use subsystems to create supernodes. A supernode is a subsystem with its own network variable interface. You can use supernodes to organize groups of devices into logical units and to hide complex subsystem details, exposing only the most important network variables.
10 Introduction
2 Installing and Activating OpenLNS CT This chapter describes how to order OpenLNS CT, install the various software and components included in your copy of OpenLNS CT, and how to activate OpenLNS CT.
Ordering OpenLNS CT You can order OpenLNS CT directly from Echelon, from an Echelon distributor, or from the Echelon store at store.echelon.com. If you order from the Echelon store, make sure you provide a valid e-mail address when you order OpenLNS CT products. Once you complete your order, Echelon will send you an e-mail message to the provided e-mail address with the activation key for your OpenLNS CT products. You can order the following products from the Echelon store: Echelon Part No.
4. Select the components that you wish to install by selecting the appropriate check boxes on the Select Components dialog box. • Microsoft Visio: Installs the 32-bit version of the Visio 2010 drawing tool. To install the 32-bit version of Visio 2010, your computer cannot have the 64-bit version of any Office 2010 application installed on it.
You can use the LONWORKS Interfaces application in the Control Panel to define, configure, and test RNIs, IP-852 network interfaces, USB 10/20 network interfaces, and PCC/PCLTA network interfaces. 14 • SLTA-10 Driver (Serial): Installs the network driver for the SLTA-10 serial network interface. Click this check box if you are using an SLTA-10 serial adapter as your network interface. This option is not available on 64-bit versions of Windows. • Adobe Reader: Installs Adobe Reader 9.
If you selected the Visio component in the Select Components window, the Microsoft Visio setup wizard opens. Follow the instructions in the installation program to complete the Visio setup. 8. Install OpenLNS CT following these steps: a. The OpenLNS CT setup program begins automatically with the Welcome window opening. b. Click Next. The License Agreement window opens.
c. Read the license agreement and click Yes if you agree with the terms. The Customer Information window opens. d. Enter your name, organization, and the OpenLNS CT activation key in the appropriate fields. The name and organization may be entered automatically based on the user currently logged on and whether other Echelon products are installed on your computer.
e. If your computer is connected to the Internet, the OpenLNS CT installer connects to the Echelon License Server, the License Server issues activation licenses for OpenLNS Server and OpenLNS CT, and the installer stores the licenses on your computer. If your computer is not attached to the Internet, you can use the Echelon License Wizard to manually activate OpenLNS CT via e-mail or phone after installing the software (e-mail is recommended).
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 window. j. A confirmation dialog opens stating that the selected components have been installed. Click OK. Note: Do not uninstall any of the following applications and components that are used by OpenLNS CT: OpenLNS Server, OpenLNS XML Utility, OpenLDV, Visio, LonMark Resource Files, Multi-Port Router 50, and the IP-852 Configuration Server.
Manually Activating OpenLNS CT If your computer was not attached to the Internet when you installed OpenLNS CT, you can use the Echelon License Wizard to activate OpenLNS Server and OpenLNS CT after you complete the software installation. You can activate your software via the Internet if your computer is now online, or you can activate your software via e-mail or phone if your computer is still offline. To use the License Wizard to activate your OpenLNS CT software, follow these steps: 1.
3. To activate your OpenLNS CT software using the over the Internet or via e-mail, click Activate Product Licenses and then click Next. To activate over the phone, click Show Advanced Tasks, Upgrade a Product License over the Phone, and then follow the instructions in the License Wizard. If your computer is offline, activate via e-mail if you have e-mail access because activating over the phone requires manually entering many lengthy alpha-numeric strings. 4.
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 license request file (.elwrq extension) is to be saved, or click Browse, specify the directory where the license request file is to be saved, and then enter a name for the file.
10. Click Send Request to Echelon to e-mail the license request file to Echelon at activation@echelon.com. Echelon will send you an e-mail message with a license response (.elwrs extension) file. For faster activation, copy the license request file to an Internet-connected computer with the License Wizard installed on it and importing it into the License Wizard. The License Wizard creates the license response file, which you can then copy to the original computer. 11. Import the license response (.
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 extension), or click Browse and then select the file. Click Next. 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 activate. Click Next. The License Server installs and activates the licenses in the license response file. e.
12. Click Exit to close the License Wizard.
3 Getting Started This chapter describes how to plan and create OpenLNS CT network designs. It describes how to use the OpenLNS CT Design Manager to create, open, and manage OpenLNS CT network designs, and it explains how to set up a network interface that enables OpenLNS CT to communicate with the network. It summarizes the different OpenLNS CT client types, and it explains how to use OpenLNS CT remotely, and how to create and use user profiles.
Design Overview To prepare to design an OpenLNS CT network, follow these steps: 1. 2. 3. 4. Define network requirements and organization. Select a network installation scenario. Determine user permissions for viewing and changing the network. Optimize network performance.
Ad-Hoc System Scenario The ad-hoc system scenario allows you to design and install the network onsite. In this scenario, OpenLNS CT loads the network configuration information into each device as you define devices, configurations, and connections. This is different from the engineered system scenario in that information is incrementally loaded to the physical devices. The advantage of the ad-hoc system scenario is its flexibility, as the installer can make decisions onsite.
When designing multiple drawing files, organize the individual drawing files as subsystems within the top-level drawing file, and limit the top-level drawing to contain only those subsystems. This minimizes the number of drawing files that must be opened as you descend the subsystem hierarchy. Avoid deep subsystem hierarchies with long subsystem names that results in long subsystem paths.
functional block if you need to connect them later. To simplify following this guideline, you can create functional block master SmartShapes with your most commonly used network variables. See Creating a Functional Block Master SmartShape in Chapter 4, Designing Networks for more information. Subsystems Subsystems allow you to divide a large network into more manageable parts. For example, in a building control network, one subsystem could contain lighting controls and another temperature controls.
The OpenLNS CT Design Manager consists of five tabs that let you perform the following functions: • General. Create, open, copy, delete, and backup/restore OpenLNS CT network designs; start the OpenLNS Server application; and import and defragment OpenLNS network databases. • Options. Set a prioritized list of languages for LONMARK resource files. • New Network Options. Configure default properties for the pages in the Network Wizard and options to skip the pages, and set the network components.
cannot create two networks with names that differ only in capitalization. The initial default network name is “Network 1”. OpenLNS CT automatically increments the index in the default network name so that the network names are unique for subsequent networks you create using the default name. After you create a network with a different name than the initial default, the default network name will become the last network created with an incremented index.
defragmentation process. Start OpenLNS Server Starts the OpenLNS Server application so that remote client computers can access the OpenLNS network database. Backup Opens the OpenLNS CT Backup dialog, in which you can back up the network database specified in the Database Name lists and all of associated drawing files. See Manually Backing Up an OpenLNS CT Network in Chapter 7, Maintaining Networks, for more information on how to use the OpenLNS CT Backup dialog.
You can set the resource file language for a specific network while in OpenLNS CT by clicking Add-ins, clicking OpenLNS CT, clicking LonWorks Network, clicking Network Properties, and then clicking the Resource File Language tab. The OpenLNS CT Design Manager’s Options tab contains the following options: Set LONMARK Resource Files Languages Allows available language-specific LONMARK resource files to be added, removed, or reordered in the languages list.
New Network Options You can use the New Network Options tab to set the default network interface, automatically register plug-ins, set the default network management mode, and set the default drawing template. The properties you set are then applied to each new network you create. You can also select options to have OpenLNS CT skip the pages in the Network Wizard when opening a network.
Skip Plug-ins Options Page Skips the plug-in registration page in the Network Wizard when you create a new OpenLNS CT network. User Logon Skip Logon Options Page Management Mode Skips the user logon page in the Network Wizard when you open an OpenLNS CT network. Select when changes made in your OpenLNS CT drawing are transmitted to the physical devices on the network. OnNet Changes to the OpenLNS CT drawing are sent immediately to the physical devices on the network.
Channel names may be up to 85 characters, may include embedded spaces, but may not include the period, backslash, colon, forward slash, or double quote characters. Channel names are case sensitive. The default root channel name is “Channel 1”. OpenLNS CT Stencils The OpenLNS CT Design Manager’s OpenLNS CT Stencils tab lists the OpenLNS CT stencils that are initially available in the LONWORKS template upon opening or creating a network drawing.
the list and then click Delete (the stencil file is not deleted). OpenLNS CT Default Options You can use the OpenLNS CT Default Options tab to set the OpenLNS CT default properties for the new networks you create. This tab contains a list of OpenLNS CT options categories such as options for configuration properties, devices, functional blocks and for backing up and synchronizing the OpenLNS CT network database. The default options you set will be applied to each new OpenLNS CT network you create.
• • Synchronization Warnings Appendix A details the defaults you can set under each network properties options category. Setting Up a Network Interface To attach your OpenLNS CT computer to a LONWORKS network, you must define and configure an OpenLDV 4.0-compatible network interface or an IP-852 network interface before starting OpenLNS CT. Network interfaces include the following: • RNIs: SmartServer, i.LON 100 Internet Server, i.LON 600 IP-852 Router, and i.LON 10 Ethernet Adapter.
For more information on creating IP-852 network interfaces, see the LONWORKS Interfaces online help file. 3. Define the IP-852 channel and devices in the IP-852 Configuration Server. To do this, follow these steps: a. Click Start on the taskbar, point to Programs, point to Echelon IP-852 Configuration Server, and then click Echelon IP-852 Configuration Server. b. Click Channel, and then click New Channel. Enter a name for the new IP-852 channel. c.
The devices on the IP-852 channel will not be fully commissioned until you run OpenLNS applications such as the OpenLNS Server or OpenLNS CT on each of the OpenLNS Server or OpenLNS CT computers. For more information, see the IP-852 Channel User’s Guide. Creating and Opening OpenLNS CT Networks An OpenLNS CT network consists of an OpenLNS CT drawing and an OpenLNS network database.
To create a new OpenLNS CT network, follow these steps: 1. Click Start on the taskbar, point to Programs, point to Echelon OpenLNS CT, and then select OpenLNS CT. The OpenLNS CT Design Manager opens. 2. Under New Network, enter the name of the network in the New Network box, or accept the default network name. 3. Click Create Network to create the new network. Visio starts. 4. • When you initially start Visio 2010, a message opens informing you that Visio must activated.
Tips: 5. 42 • You can click Finish at any point in the Network Wizard. Doing so will skip the subsequent series of pages, and your new OpenLNS CT network design will be created using the current settings in the New Network Options tab of the OpenLNS CT Design Manager. • By default, the subsequent pages in the Network Wizard will appear each time you re-open the OpenLNS CT drawing.
See Recovering an OpenLNS CT Network in Chapter 7, Maintaining Networks, for more information. 4 Network Database Path Specifies the folder that will contain the network database. By default, the database path is C:\Users\Public\Documents\LonWorks\OpenLnsCt\Databases\ . You can specify a different to place the OpenLNS CT network database; however, the network name in the database path must match the one in the Network Name box.
Notes: • The network interface you select must already have been defined and configured, as described in Setting up a Network Interface. • For OpenLNS CT to communicate on an IP-852 channel, the OpenLNS CT computer must be configured as an IP-852 device on the target channel using the IP-852 Configuration Server. If an IP-852 device name has not been defined, create one in the IP-852 Configuration Server as described in Using an IP-852 Network Interface earlier in this chapter. 8. Click Next.
10. Click Next. The Plug-In Registration dialog opens. 11. Use the following commands to register, deregister, enable, and disable plug-ins in your OpenLNS CT network. Register Adds a plug-in to the Pending list, indicating that the plug-in is to be registered. A plug-in must be registered for it to be available within OpenLNS CT. This button is available when a plug-in listed under any category or a category label (except Pending) is selected.
Registered or Not Registered or either of the category labels is selected. If the Already Registered or Not Registered category label is selected, all the plug-ins under the selected category label will be disabled. Remove Removes a plug-in from the Pending list. This button is available when a plug-in listed under Pending or the Pending category label is selected. If the Pending category label is selected, all the plug-ins under it will be removed.
If an OpenLNS CT drawing does not have a digital signature, you will see the macro warning dialog and will have to enable macros every time the network drawing is opened, provided Visio’s macro security is set to medium (the default). In order to change Visio’s macro security, open the Tools menu, point to Macro and then select Security. A dialog opens allowing you to select Low, Medium, or High security. • If you select Low security, you will never see the macro warning.
48 3. Click Create Drawing. Visio starts and the Naming dialog of the Network Wizard opens. 4. Specify the folder that will contain the OpenLNS CT drawing in the Network Drawing Path box. The folder must have the same name that opens in the Network Name box, but it may be contained within another folder. The Network Name and Network Database Path boxes are read-only, as these settings are determined by the OpenLNS network database. Click Next. The Network Interface dialog opens.
5. Following steps 7 through 9 of Creating a New OpenLNS CT Network Design, select whether OpenLNS CT is attached to the network, and if it is attached, select the management mode (OnNet or OffNet). Click Finish. The Synchronization Options dialog box opens. 6. Select the desired synchronization options and subsystem assignments. Create Shapes for all Connected NVs/MTs Adds SmartShapes to functional blocks for all connected network variables or message tags created by the resynchronization.
Missing FB Shapes SmartShape in the OpenLNS CT drawing. Subsystem to Visio Document Assignment Select in which Visio drawing file to place the subsystems in your network. You have four choices: • Single Visio Document for all Subsystems. Places all subsystems in a single Visio document. • Prompt for Subsystem Document Assignment. Prompts you to specify the Visio document for each subsystem. • Separate Document for each Subsystem Hierarchy below Root.
LONWORKS Device SmartShape, for example) will be used. After OpenLNS CT is done scanning stencils, the Synchronization Status dialog box opens. 9. You can monitor the progress of the resynchronization. When the resynchronization is complete, click OK to open your OpenLNS CT network. Copying an OpenLNS CT Network Design You can create a new OpenLNS CT network design by copying an existing one.
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 hexadecimal format in the Domain ID box. Click Finish. 6. If you are copying a network created with OpenLNS CT, your new OpenLNS CT network will open and you can skip the remaining steps. 7.
Any devices you created and commissioned in your original network will have the same Neuron IDs in the copied version. To avoid conflicts, make sure the domain IDs of the original and copied OpenLNS CT network designs are unique, or make sure that the copied OpenLNS CT network design is not attached to the physical network associated with the original version when you are using it. Monitoring will be disabled in the copy of the OpenLNS CT network.
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 want to enable macros. You must enable macros for OpenLNS CT to function. See Working with Digital Signatures for more information. 6. Visio starts, your OpenLNS CT drawing opens, and the Server Location page of the Network Wizard opens (unless you selected the Automatically Determine Server Location check box at the bottom of this page when you previously opened the network).
8. Click Next. The Network Interface page opens, unless the Skip this Prompt check box was previously selected. Follow steps 7–12 in Creating an OpenLNS CT Network Design. By default, the options previously selected for the network will be used; however, you can change any option. Note: You may open multiple OpenLNS CT network designs by repeating the preceding steps. Each OpenLNS CT network design that you open will have its own instance of Visio.
Remote Full Client A remote full client is an OpenLNS CT computer that communicates with the OpenLNS Server (running on a separate computer) over a LONWORKS channel. In this configuration, the OpenLNS CT computer uses a network interface to communicate with the network (for example, a U10/U20 USB network interface or PCC-10, PCLTA-20, or PCLTA-21 network interface card).
The following example demonstrates a scenario in which the OpenLNS CT computers communicate with the OpenLNS Server and the network over an IP-852 channel. The OpenLNS computers directly route management tasks to the network via an IP-852 router. The IP-852 Configuration Server creates virtual channels that direct packet traffic and enable the IP-852 devices (OpenLNS CT computers, the OpenLNS Server, the IP-852 router, and other IP-852 devices) to communicate with each other over the TCP/IP network.
58 c. The Echelon OpenLNS Remote Server application opens with the Network Interfaces dialog. d. Select the OpenLNS network interface or IP-852 network interface to be used to connect to the LONWORKS channel. An OpenLNS Server or remote client can be attached to an IP-852 channel using an IP network interface, such as an Ethernet network interface card (NIC), WiFi interface, or a modem channel with PPP software.
f. To open an additional network, click Start OpenLNS Server on the OpenLNS CT Design Manager. The OpenLNS Server window opens. Highlight the next network to open. Click Open Network. The Network Interface page opens. Select the network interface. Click OK. Repeat this process for each additional network you want to open. 3. Copy the OpenLNS CT backup file that you created in step 1 to the remote client. 4. Start OpenLNS CT on the remote full client.
6. Select Remote Full Client to access the network and then click Next. The Network Interface page opens. 7. Follow steps 7–12 in Creating an OpenLNS CT Network Design. Remote Lightweight Client A remote lightweight client is an OpenLNS CT computer that communicates with the OpenLNS Server (running on a separate computer) via TCP/IP. As a remote lightweight client, the network management, monitoring, and controlling tasks performed by OpenLNS CT are all routed through the OpenLNS Server.
To use OpenLNS CT on a remote lightweight client follow these steps: 1. 2. Prepare for Remote Operations. a. Copy any custom stencils that you will need to the OpenLNS CT drawing folder on the OpenLNS Server computer. b. Back up the OpenLNS CT drawing for the network you will be using and all other files in the drawing directory. See Backing Up an OpenLNS CT Network Design in Chapter 7, Maintaining Networks, for instructions. c. Save the OpenLNS CT backup file to a shared network folder.
62 6. Select Remote Lightweight Client to access the network and then click Next. 7. If the server address is configured correctly, you can skip to step 10, in which the User Logon window opens. If there is a problem with the server address, or you are opening a drawing created using LonMaker, the Selecting a Remote Network Name dialog opens.
8. Select an OpenLNS CT network to open. If a connection to this network has already been established, click Next, and skip to step 10. If you are accessing the selected network over an OpenLNS/IP interface for the first time, click Add/Remove. The Remote Networks Collection dialog box opens. 9.
2. A dialog opens that allows you to select whether the network service device being added represents the local NSD (only available if you are a remote client and you are using a NSD that does not have a SmartShape associated with it) or a remote NSD. 3. If you selected Remote Device in step 2, a dialog opens which allows you to select the local or remote network service device to be associated with this network service device SmartShape.
This dialog box lists all NSDs in this network, regardless of whether a SmartShape has been created for each NSD. For each NSD, the following information is listed: NSD Name Specifies the name of the NSD, which is assigned by the OpenLNS Server. Type Specifies the NSD type. This can either be NSS (the OpenLNS Server) or NSI (a remote full client). Device Name Specifies the NSD name in the format of ..
and decide later to upgrade, select the NSD SmartShape, right-click it, and then click Upgrade NSD on the shortcut menu. When moving from an OpenLNS high performance network interface (LonTalk layer 2) to an OpenLNS network interface (LonTalk layer 5), all connections and monitor sets may not be created on the new network interface. If this happens, a dialog displays the items that will be lost and gives you an opportunity to cancel the upgrade.
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 OpenLNS CT, and then select User Profiles. The User Profiles dialog box opens. 2. Enter the name of the new user name in the Name box, and the password in the Password and Retype Password boxes. Both the user name and password are case sensitive.
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 OpenLNS CT and Visio menus that will be available to the user. This option is not available if you are using Visio 2010. If you are using Visio 2003, you have two choices: • Maximum. This setting provides the user a full set of toolbars, menus, and menu items for advanced use of OpenLNS CT. • Access Control 68 Minimum.
Privileges Select which actions the user can perform on objects in the OpenLNS CT drawing. You can set privileges for reading, modifying, changing the name, adding, deleting, commissioning, and replacing objects, as well as the use of plug-ins for the objects. The objects for which you can set privileges consist of the network, subsystems, channels, application devices, routers, functional blocks, connections, network variables, and configuration properties.
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 password will be changed. Modifying and Deleting User Profiles Only the Administrator can modify or delete a user profile. To modify or delete a user profile, follow these steps: 1. In the OpenLNS CT drawing, click Add-ins, point to OpenLNS CT, and then select User Profiles. The User Profiles dialog box opens. 2.
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 OpenLNS CT Remotely with User Profiles When you open an OpenLNS CT network on a remote client, you will be prompted for your user name and password (provided that the administrator password has been set for the network). After logging on to the network, you will have the same privileges as you do when working on a local client.
72 Getting Started
4 Designing Networks This chapter describes how to design a network using OpenLNS CT. It covers how to create the following objects in an OpenLNS CT drawing: application devices, functional blocks, network variables, routers, channels, and subsystems. It explains how to connect network variables. It explains working with OpenLNS CT SmartShapes and layers, customizing the OpenLNS CT user interface, and using OpenLNS CT with AutoCAD drawings.
Creating a LONWORKS Network You can design a LONWORKS network and then install it using OpenLNS CT. To design a LONWORKS network with OpenLNS CT, you create an OpenLNS CT drawing. This entails adding OpenLNS CT SmartShapes for channels, routers, devices, and functional blocks; making logical connections between devices so they can send and receive data to and from each other; and organizing the network into subsystems.
• If you have licensed OpenLNS CT as part of the NodeBuilder tool, the OpenLNS CT Basic Shapes stencil is replaced with a NodeBuilder Basic Shapes stencil that includes Release Target Device and Development Target Device shapes. Creating Application Devices An application device consists of hardware and software that runs an application and communicates with other devices using the ISO/IEC 14908-1 Control Network Protocol.
2. Enter the following information for the device. Device Name Enter the name of the device. This name must be unique within the currently displayed subsystem. The device name may be up to 85 characters and it may include embedded spaces; however, the name may not include period, backslash, colon, forward slash, or double quote characters. The default device name is the abbreviated device SmartShape name followed by a dash, a space, and the instance number “1”.
Create a New Device Template Select this check box to create a new device template for the device. If you select this check box, the Specify Device Template window opens after you click Next. In this window, you can define a new template by uploading the device interface definition from the device or importing an existing device interface (XIF) file from your computer. This check box is unavailable for device SmartShapes with pre-defined device templates such as the LonPoint device SmartShapes.
4. Enter the following information: Location Specifies a 6-byte location string that documents the device’s location within the network. To store the device’s subsystem ID in this field, follow these steps: 1. Click Add-ins, point to OpenLNS CT, and then click OpenLNS Options. Select Recovery from the options category list and then select the Set Location Property to Subsystem ID check box under Subsystem Recovery Options. 2. Resynchronize the network.
with the network. Set the ping interval based on the expected movement of the device. Select Never to disable pinging. To enable pinging, change the ping interval to 15 minutes if you expect the device will seldom move or if the device is on a power line channel, 2 minutes if you expect it will move somewhat frequently, and 1 minute if you expect it will move frequently. You must set a ping value for OpenLNS CT to display device and functional block errors on their respective SmartShapes.
You can also have automatic channel selection enabled by default in each OpenLNS CT drawing you create or open. In the OpenLNS CT Design Manager, click the OpenLNS CT Default Options tab, select Device from the Options Category list, and then select the Enable Automatic Channel Selection check box.
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 around the channel SmartShape. 5. Release the mouse button. 6.
2. Enter the following information: Source Functional Block Name Type Displays the name of the source functional block (a master SmartShape or an existing functional block) from which the new functional block was created. This box will be empty if the functional block was created by dragging the generic functional block master SmartShape to the OpenLNS CT drawing. Displays the functional profile represented by the source functional block (open loop sensor object, for example).
in the selected subsystem with available functional blocks will be listed. Type Functional Block Type / FPT File Specifies the device template associated with the functional block. Select whether the functional block you are creating is static or dynamic. • Static/Existing. Select a functional block that is defined in the device interface. • Dynamic FB. This option is only available for devices that support dynamic functional blocks (for example, a controller such as the SmartServer).
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 new functional block created from a digital output functional block master SmartShape named “LED” would be “LED” if it was the only one named as such for the assigned device. If a copy of the LED functional block was created and assigned to the same device, the default name would be “LED 1”. A second copy would be named “LED 2”, and so on.
the Create all Network Variables Shapes check box. 3. Click Finish to add the functional block SmartShape to the OpenLNS CT drawing. Using Automatic Device Selection You can use automatic device selection to enable OpenLNS CT to automatically select the appropriate device for a new functional block, skipping the Functional Block Wizard. This feature lets you create a new functional block with a single click and drag. To enable automatic device selection in your OpenLNS CT drawing, follow these steps: 1.
1. Right-click the functional block you want to move, point to Move FB, and click Change Assigned Device to reassign the functional block to a device on the current subsystem. The Functional Block Wizard opens 2. Under Device, select the device to which you want to reassign the functional block. Then, under Functional Block, select the instance of the functional block to associate with the reassigned device. Click Finish.
2. Right-click the functional block you want to update with the configured settings, point to Configuration Properties on the shortcut menu, and then click Paste Config. Tip: You can also paste the configuration properties to a text file to get a summary of the configuration property settings. Right-click the configured functional block, point to Copy Config from the shortcut menu, open a text editor or word processing application, and then paste the configuration properties.
4. Select the target subsystems into which you want the configuration properties to be copied. You can expand a subsystem to view any nested subsystems. 5. Select the criteria used to determine which functional blocks will be updated with the configured settings. You have three choices: • Matching Device/FB name. Both the device and functional block names must match for the functional block to be configured • Matching Device/FB Type.
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 view those functional blocks in which the value of the configuration property in the target functional block differs from the source, click the check box at the bottom. You can sort the entries in a column by clicking the column header. Click the header again to toggle the order (ascending or descending). 8. Click Finish.
Dynamic functional blocks are typically used by controllers that do not have a static interface. These controllers typically require the integrator to run a plug-in or other configuration software that defines the control algorithm and configures the controller. The controller manufacturer can use dynamic functional blocks to enable an OpenLNS CT user to add functional blocks to the controller using OpenLNS CT. Dynamic functional blocks are created in the same manner as static functional blocks.
5. If the selected functional profile defines mandatory and/or optional network variables, the corresponding check boxes under Dynamic FBs for creating those network variables in the dynamic functional block will be enabled. By default, the Create all Mandatory NVs check box will be selected and the Create all Optional NVs check box will be cleared. Select the check boxes for the types of network variables for which you want OpenLNS CT to create.
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 Virtual Functional Block from the Name list. This option only opens in the list if the device supports a virtual functional block 4. Click Finish. Adding a Message Tag SmartShape to a Virtual Functional Block You can add a message tag SmartShape to the virtual functional block of a device that supports message tags.
setting) encapsulated within functional blocks that a particular device application expects to receive from other physical devices (an input network variable) or expects to make available to other physical devices (an output network variable). There are two types of network variables: static and dynamic. A static network variable is defined by the device application and is always available in the device. Most LONWORKS devices have functional blocks that include static network variables.
To automatically add all available network variables to a functional block, select the Create Shapes for all Network Variables check box in the New Functional Block Wizard when you add a functional block SmartShape to your drawing. To selectively add network variables, clear the Create Shapes for all Network Variables check box in the New Functional Block Wizard. This creates a functional block with no network variable SmartShapes.
3. The Create Network Variable dialog box opens. Enter the name, number, and type of the dynamic network variable(s) you are creating. a. Enter the name of the dynamic network variable. This name must be unique within the functional block. It may be up to 85 characters long and may include embedded spaces, but it may not include period, backslash, colon, forward slash, or double quote characters. b. Enter the number of dynamic network variables you are creating. c.
d. 4. 96 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. • To select a defined type, select Specify under the New NV Type box and then click Select. The Select Network Variable Type dialog box opens. This dialog box lists built-in data types and resource files. Expand the items listed to view the available built-in data types, SNVTs, and UNVTs.
5. Under Poll Attributes of New NV(s), select whether the dynamic network variable(s) will by default use polled monitoring. You have four choices: • Select Clear to disable polling. • Select Set to enable polling. • Select Same as Source NV to use the same poll attribute of the source network variable (enabled or disabled). This option is only available if the dynamic network variable you are creating is derived from an existing network variable.
8. Select one or more static and/or dynamic network variables SmartShapes to add to the functional block from the list of network variables available for the selected direction. If you select multiple network variables, additional SmartShapes will automatically added to the functional block. To select all of the listed network variables, click Select All. 9. To remove any “nvo” or “nvi” prefixes, select the Remove Prefix from NV Names check box.
2. Following steps 3–6 in Creating Dynamic Network Variables Using Network Variable SmartShapes, change the default name, if desired, enter the number of new dynamic network variable(s) you are creating, and set the poll attributes and the message service type and options. 3. Click OK to add the dynamic network variable to the functional block. Changing a Network Variable Name You can change the network variable name on a functional block.
4. Select one or more network variable SmartShapes to delete. To select multiple network variable SmartShapes, hold down CTRL and click the SmartShapes you want to delete. To select all of the listed network variables, click Select All. 5. Set the following options: Display Apply Changes to 6. 100 Select which network variable and message tag SmartShapes are displayed.
Deleting Dynamic Network Variables You can delete a dynamic network variable from a functional block. When you delete a dynamic network variable, you can either delete the network variable SmartShape, or you can delete both the network variable SmartShape and the implementation. You can also delete a dynamic network variable by deleting the functional block containing it.
To add a router to an OpenLNS CT drawing, follow these steps: 1. Drag a Router SmartShape ( ) from the OpenLNS CT stencil to the drawing page. The New Router Wizard opens unless you enabled automatic channel selection. 2. Enter the following information: Router Name Enter the name of the router. This name must be unique within the network. The router name may be up to 85 characters and include embedded spaces, but it may not include period, backslash, colon, forward slash, or double quote characters.
more than 85 characters long. If you are creating one or two new channels, specify the channel type for each channel in the Type box. 3. Click Next. The Router Properties window opens. 4. Enter the following information: Location Specifies the 6-byte location string for the router, which documents the router’s location within the network. To store the router’s subsystem ID in this field, follow these steps: 3. Click Add-ins, point to OpenLNS CT, and then click OpenLNS Options.
If you do not specify a value and the Set Location Property to Subsystem ID check box in the Network Properties: Recovery options category is cleared, the current value in the router will be written to this field and stored in the OpenLNS network database when the router is commissioned. Ping Interval Enables the OpenLNS Server to ping the router periodically. Pinging verifies that a router is still operating and communicating with the network.
because it allows OpenLNS CT to optimize network traffic and determine automatically the channel to which each device is attached. You can select Repeater to forward all valid packets received on one channel to the other channel. A Permanent Repeater behaves similarly, but its type cannot be changed in the network after the router is created. You can select Bridge to forward all valid packets that match the network domain.
Changing a Router Channel You can change one or both of the channels assigned to a router SmartShape. You can do this to assign a router to a channel different from the one that was automatically selected by OpenLNS CT, or to physically move a router to a different compatible channel. To move a router to a different channel, you can either right-click the router and then click Move Device on the shortcut menu, or you can use the Connector tool on the Visio Standard toolbar to graphically move the router.
2. Enter the following information: Channel Definition Select whether the SmartShape represents a new or an existing channel. • Select Shape Represents a New Channel if you are adding a new channel to your OpenLNS CT drawing. • Select Shape Represents an Existing Channel to place devices in different subsystems on the same channel. Each subsystem may have only one channel SmartShape for a given channel, but the same channel may be referenced by channel SmartShapes in many subsystems.
selected channel type. Round-Trip Delay Description 3. Select whether to use the default round-trip delay or to specify a time for the channel in milliseconds. • Select Use Default to use the default of two packet cycles based on the average packet size. • Select Specify to set the value to the expected longest round-trip time of a message (for example, message and response).
2. Enter the following information: Subsystem Enter the name of the subsystem. The name must be unique within the current subsystem and may be up to 85 characters long. The name may include embedded spaces, but it may not include periods, backslashes, colons, forward slashes, or double quotes. Subsystem names are case sensitive.
Copy 3. subsystems. You have three choices: • Do not Copy. Only the subsystem SmartShape will be copied. None of the contents of the original subsystem will be copied into the new subsystem. This is the only option available when you create a new subsystem by dragging a Subsystem SmartShape from the OpenLNS CT Basic Shapes stencil to the drawing (all of the options are available when you create a new subsystem by copying an existing one). • Copy only Selected Subsystem.
4. Right-click the subsystem and click Expand from the network navigator. All devices, functional blocks, and available network variables in the network hierarchy will be displayed. Select one or more network variables to be supernodes. To select all the available network variables, click Select All from the network navigator. 5. Click OK. SmartShapes for the selected network variables appear on the subsystem SmartShape.
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 Wizard opens. Instead of performing steps 1 and 2, you can hold down CTRL and drag the subsystem or supernode SmartShape to the desired location. 3. Enter the information for the new subsystem following the instructions in Creating a Subsystem. 4. Click Finish. OpenLNS CT copies the subsystem or supernode.
Creating a Connection with the Connector SmartShape You can create a connection with the Connector SmartShape ( ) in the OpenLNS CT Basic Shapes stencil. You can only use this method to connect functional blocks or supernodes that are in the same subsystem. You can connect network variables or message tags on functional blocks or supernodes whether they have network variable or message tag SmartShapes or not.
Creating a Connection with the Network Variable Connection Dialog Box You can create a connection using the Network Variable Connection dialog box. This dialog box provides a powerful and flexible method for creating connections. It provides a hierarchal view of the devices, functional blocks, and network variables in your OpenLNS CT network. You use this view to select the network variable hub and one or more targets to connect.
3. Create the network variable connection by selecting the following options: Hub: (box) Displays the currently selected hub network variable. This is useful when you are selecting the target network variables. Hub (tab) Displays a hierarchal view of the network, consisting of the subsystems, devices, functional blocks, and all available network variables that can be selected as the hub. Select the hub network variable on this tab before clicking the Target tab.
NV. Displays available or compatible network variables. • MT. Displays available message tags. This option is only available if you are connecting virtual functional blocks. Add Adds a connection with the currently selected network variable target to the Connections pane. Add All Adds connections with all compatible network variable targets to the Connection pane. Add FB/SNs Opens the Select Object dialog box, which you can use to add functional blocks or supernodes to the hub and target tabs.
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 Properties to view and modify the properties of the connection description displayed in the New Connections box. See Using Connection Descriptions in this chapter for more information on using and creating connection descriptions. 8. Click OK. The connections listed in the Connections box will be added to your OpenLNS CT drawing. 9.
eliminates the need to manually move functional block, connector, and connector reference SmartShapes to keep your OpenLNS CT drawing organized. To align all reference connection SmartShapes in a subsystem, right-click an empty space in the subsystem, point to Display Options, and then click Align All Reference Shapes on the shortcut menu.
network overhead for large multicast fan-out connections. For example, a repeated message with three retries to 64 devices generates 4 packets on the network, whereas an acknowledged message requires at least 65 packets • Unacknowledged. The sending device sends out the network variable update only once and does not expect any confirmation from the receiving device. This message service type consumes the least amount of resources, but is the least reliable.
Repeated with Alias Multicast Repeated Alias Repeated with Broadcast Multicast Repeated Broadcast Repeated with Group Multicast Repeated Group Acknowledged Alias Repeated Group (if available); otherwise, domain broadcast SCD_Alias SCD_Default ● ● SCD_SubnetBcast ● Repeated Subnet broadcast SCD_Unicast ● Acknowledged Group Unacknowledged*** Unacknowledged Group Unacknowledged with Alias Multicast Unacknowledged Alias Unacknowledged with Broadcast Multicast Unacknowledged Broadc
To view the properties of a connection description, select the connection description from the Name list. If you do make changes, click OK and OpenLNS CT then updates all network variable members of the connection with the modified connection description To create a new connection description, click New. The New Connection Description dialog box opens. Enter the name of the new connection description and select whether the currently displayed or default attributes are used, and then click OK.
Start Unicast? Yes SCD_Unicast Acknowledged service Aliases for selector conflicts Does not use broadcast No All targets on same subnet? Yes SCD_SubnetBcast Repeated service (3 repeats) Aliases for selector conflicts Subnet broadcast No # of targets < Z ?* Yes SCD_AliasUnicast Acknowledged service Alias multi-unicast Does not use broadcast No Group available? Yes SCD_Default Repeated service (3 repeats) Aliases for selector conflicts Does not use broadcast No SCD_Default Repeated service (3 rep
3. You can change or disable the connection description used for each condition in the automatic connection description selection process. If you disable the connection description for a given condition, OpenLNS CT will select the next defined connection description. You can also change the maximum number of target network variables used to select between the Alias Unicast and Default conditions. The default value of 5 provides a good balance between total transaction time and network resource usage. 4.
Connection Description, and then click the desired connection description on the shortcut menu. To disable automatic connection description selection, select a connection description that does not start with “SCD_”. To enable automatic connection description selection, select .
To hide a connector SmartShape directly attached to two functional block SmartShapes (not attached using a reference SmartShape), select Hide Connectors on both functional blocks. The connector SmartShape will be hidden at both ends. To show the connector SmartShape, you only need to select Show Connectors on one of the attached functional blocks.
If you right click the Switch[0] functional block, point to Display Options, and then click Hide Connectors, the connector and reference SmartShapes attached to this functional block are hidden. There is no change to the connector and reference SmartShapes attached to the Lamp[0] functional block because connector SmartShapes attached via reference are hidden/shown independently on each end.
2. Select the following options for creating and displaying connection SmartShapes for the selected functional block or functional blocks. Create Connection Shapes OpenLNS CT User’s Guide Select whether SmartShapes are created and displayed in the OpenLNS CT drawing for connections with the selected functional block(s). You have three choices: • Yes.
Show Connection Shapes Select whether connection SmartShapes attached to the selected functional block(s) are displayed. This check box is selected by default, but it is cleared and unavailable if No is selected in the Create Connection Shapes list.
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 the current subsystem shown. You can expand an object to view any others further down the network hierarchy such as nested subsystems, devices, and functional blocks. You can also right-click an object and use the Network Navigator to expand an object.
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 Displays all objects below the selected item. Selecting expand on the top-level subsystem will display all objects in the network hierarchy. Select All Expands the item and selects the check boxes of all the objects below it. Click Select All on the top-level subsystem to select the check boxes of all the objects in the network hierarchy.
Network Explorer options category. By default subsystems, devices, and functional blocks are displayed. To expand or reduce the scope of the objects displayed in the Network Explorer, follow these steps: 1. In the OpenLNS CT drawing, click Add-ins, point to OpenLNS CT, and then select OpenLNS CT Options. The Network Properties dialog box opens. 2. Select Network Explorer from the Options Category list. 3. Select the desired scope under the Displayed Objects box.
• 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 drawing are listed below their respective subsystems in a hierarchal structure (in the order of nested subsystems, devices, functional blocks, and then network variables).
The Device Template shortcut menu contains the following options: Delete Deletes the selected device template. This option is unavailable if there are any devices currently using the device template, or if there is a device that has been discovered by the OpenLNS Server but does not yet appear in the OpenLNS CT drawing. Import XIF Updates the device template (and optionally devices) with the data from the XIF that you select.
The Device Template Properties dialog box contains the following options: Name Specifies the name of the device template. You can change the device template name to any other valid, unique name. Program ID Displays the program ID of the device template. You can select one of the following options for displaying the program ID (this selection does not change the program ID): • ASCII. Displays the program ID as an ASCII string.
will validate that the physical device is on the correct assigned Channel and that the device template has the same Program ID and Program Interface (XIF) defined in the network database. Clearing these check boxes may reduce the time required to commission a device. This may be useful when you are commissioning a large number of devices on a slow channel such as power line, or when commissioning time is very expensive such as a remote OpenLNS Server communicating over a dial-up connection.
Data Layer • Shows/hides all monitored connections. Right-click an empty space in your OpenLNS CT drawing, point to Display Options on the shortcut menu, and select View Subsystems Layers from the shortcut menu. The View Subsystem Layers dialog box opens. Select or clear the OpenLNS CT Layers you want displayed or hidden. You can click Apply if you want to see how your OpenLNS CT drawing opens with the current settings. When you are done, click OK.
2. Point to Move Device (for device, router, and subsystem SmartShapes) or Move FB (for functional block SmartShapes) on the shortcut menu. 3. Click Change Subsystem (for device, router, and functional block SmartShapes) or Move (for subsystem SmartShapes). The Select a Subsystem dialog box opens. This dialog lists any subsystems nested within the current subsystem. 4. Click the Up button ( ) to move up one level in the network hierarchy; double-click a subsystem to move down one level.
2. Set the following options: Original Channel Name Specifies the current channel on which the devices or routers are attached. If you are moving devices or routers from a subsystem SmartShape that has devices or router SmartShapes connected on two or more channels, select the channel with the devices or routers you want to move. Only those devices or routers located on the selected channel will be moved.
• 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 the device. A Neuron-hosted device, for example, will run its application after it has been moved. • Select Offline to put the devices or routers in the offline state. This is the default for devices. The behavior in the offline state depends on the device. A Neuron-hosted device, for example, will not run its application after it has been moved.
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 moving an OpenLNS CT computer and you will be using a different network interface, click Add-ins, point to LonWorks Network, and then click Network Properties. Click the Network Interface tab, select the name of the new network interface, and then click OK. 4. Click OK.
Deleted OpenLNS CT Shape Affect on Physical Device Commissioned Application Device Application device is decommissioned and no longer has a network address. Commissioned Router Router is decommissioned and no longer has a network address. OpenLNS Network Interface or NSD OpenLNS CT attempts to decommission the NSD. If the NSD is using a Layer 2 interface, it cannot be decommissioned. Disconnects any remote full clients using the NSD. Functional block (static) No change.
The following figures illustrate the difference of a device SmartShape menu with OpenLNS CT Shape Menus selected and cleared. Using AutoCAD Drawings You can import AutoCAD drawings into your OpenLNS CT drawing and export your OpenLNS CT drawing as an AutoCAD drawing. Importing an AutoCAD Drawing You can import an AutoCAD drawing. You can do this to use a drawing created by a mechanical system designer as a background for your OpenLNS CT drawing.
6. The AutoCAD drawing opens in the OpenLNS CT drawing as a background. Exporting an AutoCAD Drawing You can export an OpenLNS CT drawing as an AutoCAD drawing. This lets you create an as-built report in the same format as your other system blueprints. An OpenLNS CT drawing saved in AutoCAD drawing format can be marked up by AutoCAD tools, but not manipulated as an AutoCAD object. To export an OpenLNS CT drawing as an AutoCAD drawing, follow these steps: 1.
144 Designing Networks
5 Installing Networks This chapter describes how to install devices using OpenLNS CT, including how to load applications into them, set the initial state of their applications, set the source of their configuration properties, and select how they manage device-specific configuration properties. It also explains the different methods for acquiring device Neuron IDs and how to alternatively use the device discovery method to install a network.
Network Installation Overview You can install the devices that you added to your OpenLNS CT network design in Designing Networks. To install devices, you commission the devices and routers in your OpenLNS CT network design. Commissioning associates the device SmartShape created in the OpenLNS CT drawing with a physical device on the network and updates the physical device to match the configuration in your network design.
Selecting Devices for Commissioning To select the device or devices to be commissioned, follow these steps: 1. Right-click the device SmartShape of the device you want to commission, point to Commissioning, and then click Commission on the shortcut menu. To select multiple devices, do one of the following: • To select multiple devices within a subsystem, hold down CTRL and click the device SmartShapes, or click an empty space in the drawing page and drag a selection net around them.
2. The Commission Device Wizard opens. Where you start in the wizard depends on whether you are commissioning an application device or router, and whether OpenLNS CT is attached to the network and OnNet or OffNet. • If OpenLNS CT is unattached to the network or attached but OffNet, the wizard will skip the Device Application Image and Initial State windows and begin with the Device Identification window.
1. Specify the device application by setting the following options: Load Application Image Select this check box to load an application image into a Neuron-hosted application device that has writeable application memory and comes with an application file (.ndl, .nxe or .apb extensions).
default. XIF Name 2. If you are loading an application file with an .nxe extension, select the pathname of the XIF file. OpenLNS CT only requires the binary application file (.apb extension) and the binary device interface file (.xfb extension); however, it automatically creates binary files from existing text files (.nxe and .xif extensions) and saves them in the application file folder that contains the corresponding .nxe file.
Setting the Initial Application Device State and Source of Configuration Property Values When the Device Initial State window opens, follow these steps: 1. Specify the initial state of the device applications, source of the configuration property values, and management of device-specific configuration properties by setting the following options: State Set the state of the device application after it has been commissioned. You have four choices: • Default.
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 Node Object, the device is placed offline. As with offline operation, portions of a disabled device’s application may continue to function. Source of CP Values Specify the source of initial values for the device’s configuration properties. • OpenLNS Database.
Image window. • Upload from New App Image. The current device-specific configuration property values in the selected application image file will be written to the device. This option is only available if you selected the check box to load an application image into the device in the Device Application Image window. • Preserve Device Values.
operation. 2. • Offline. The router will not forward packets. • Online. The router will forward packets between the channels connected to it. This is the default. If the network will have devices installed on the far side of a router (the side furthest away from the OpenLNS Server), you must commission the router before any of the application devices connected on its far side. Click Next to continue. The Device Identification Method window opens.
2. Click Finish. If you selected the Service Pin method, you are prompted to press the service pin as described in Using the Service Pin Method. Once the Neuron ID is specified or acquired, OpenLNS CT commissions the device, and changes the color of the device SmartShape to green to indicate that the device has been commissioned.
To acquire the Neuron IDs and finish installing the devices, follow these steps: 1. Select any of the following service pin options Options Display Data from Service Pin Select this check box to display a dialog that contains the information returned in the service pin message. This check box is cleared by default. Filter on Program ID Select this check box to ignore service pin messages that do not include the same program ID as the device being commissioned. This option is selected by default.
Using the Manual Entry Method If you selected Manual as the device identification method or if OpenLNS CT is not attached to the network, and you are commissioning multiple devices, a prompt opens instructing you to enter the Neuron IDs of the devices you are installing. The device Neuron ID is provided by the manufacturer as a 12-digit hex string or as a bar code label on the device that can be scanned. Entering a Neuron ID Manually To enter a device’s Neuron ID follow these steps: 1. 2. 3.
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 recommended that you use a gun-style laser or LED scanner. One scanner that you can use with OpenLNS CT devices is the Symbol Technologies LS 3000, which is made available by Barcode Logics. See your scanner documentation for instructions on programming the scanner.
2. Select the following options: Device Selection Scope Options Wink Interval Selects which subsystems will be searched for uncommissioned device SmartShapes. You have three choices: • All Subsystems. The entire OpenLNS CT drawing will be searched for uncommissioned device SmartShapes. • The Current Subsystem and Dependent Subsystems. The current subsystem and any subsystems nested in it will be searched for uncommissioned device SmartShapes. • The Current Subsystem only.
Include Devices with Unknown Programs Adds physical devices to the discovered device list that are applicationless or have an unrecognized application. Such physical devices can then be matched to any device SmartShape with a matching channel. However, after matching, you must click Details and specify an application image to load into the device. Discover Configured Devices Discovers devices that have previously been configured.
This dialog box allows you to manually or automatically match the discovered devices on the network with the defined device SmartShapes in the OpenLNS CT drawing. To select a device from any of the lists, click the entry in the leftmost column (the # column in the Discovered Devices list, and the Subsystem column in the Defined Devices and Devices to be Commissioned lists). After selecting a device, its field in the leftmost column will be shaded blue.
appropriate device list. Match Matches the device selected in the Defined Devices list is to the device selected in the Discovered Devices list. The devices are removed from their respective lists and the matched device is added to the Devices to be Commissioned list. This command is only available if one device is selected from each list and the selected devices are compatible.
11. Select an application image and set the options for the initial application state and source of configuration property values. See Loading a Device Application Image and Setting the Initial Application Device State and Source of Configuration Property Values for information on setting these options. Click OK. 12. Click Finish. OpenLNS CT commissions the devices in the Devices to be Commissioned list and sets the state of their applications.
164 Installing Networks
6 Monitoring and Controlling Networks This chapter describes how you can monitor and control the devices in your network with OpenLNS CT. It describes the three methods you can use to read and/or write network variables and configuration properties: using monitored connections, browsing with the OpenLNS CT Browser, and using Data Point SmartShapes. This chapter covers how to bind network variables to the host in order to receive event-driven updates.
Monitoring and Controlling Overview You can monitor and control the physical devices in a network by reading and writing the network variables on the devices. You can also read configuration property values. You can use any of the following three methods to read and/or write network variables and configuration properties: • Monitored connections. Monitored connections provide a simple means to view network variable values within your network.
When you enable monitoring on a connection, the network variable values are continuously polled. The default poll interval is 1 second. To change the default poll interval, click Add-ins, point to LonWorks Network, and then click Network Properties. Click the Timing tab, set the default poll rate, and then click OK. Excessive polling can create heavy network traffic and consequently degrade network performance.
Using the OpenLNS CT Browser You can use the OpenLNS CT Browser to monitor and control the network variables and configuration properties in your network. The OpenLNS CT Browser provides a table view of the selected network variables and configuration properties. You can add all the network variables and configuration properties for a functional block or device to the Browser, and you can delete selected network variables and configuration properties from it.
The OpenLNS CT browser color codes the configuration properties and network variables in the following manner: Blue Input network variables. You can write values to these network variables. See Updating Network Variable and Configuration Property Values. Green Writeable configuration properties. You can write values to these configuration properties. See Updating Network Variable and Configuration Property Values. Grey Output network variables and read-only configuration properties.
The OpenLNS CT Browser Toolbar You can use the OpenLNS CT browser toolbar to perform many browser functions quickly. The toolbar contains the following buttons: Open Opens an existing browser file. See Customizing the Browser. Save Saves changes to a browser file. If the browser file is new, the Save As dialog opens. Name the file and choose a folder in which to save the file. See Customizing the Browser for more information. Print Prints the data in the Browser window.
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 in the browser; therefore, you would hide the rows of all the other network variables that you do not want to monitor and control. Customizing Browser Columns You can hide, change the order, or adjust the width of the columns in the OpenLNS CT Browser.
Under the display box, select which objects you want displayed in the browser. You have three choices: • • • Network Variables. Only network variables are displayed in the browser. Configuration Properties. Only configuration properties are displayed in the browser. Both. Network variables and configuration properties are displayed in the browser. Select the Sort NVs by Name check box to list the network variables in the browser alphabetically.
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 all the objects, and then click OK. The selected objects appear in the browser again. Saving Browser Customization You can save and later restore the rows and columns that you customize in the OpenLNS CT Browser to a browser (.brw extension) file. To save your rows and columns to a browser file, open the File menu and select Save or Save As.
You can update all network variable values by clicking the Refresh All button ( toolbar or opening the Browse menu and selecting Refresh All. ) on the browser Using Bound Updates You can use bound updates with the OpenLNS CT Browser to reduce the network overhead of polling many network variables. Bound updates use a connection between the network variable being monitored and the browser.
d. Enter the name of the Virtual Functional Block in the New FB Name box. 2. Drag an Input Network Variable SmartShape from the OpenLNS CT Basic Stencil to the virtual functional block. The Choose a Network Variable dialog opens. 3. Click Create NV. Create a dynamic network variable, as described in Adding Network Variables to a Functional Block in Chapter 4, Designing Networks. Select a network variable type that is compatible with the network variable you are binding to your compute. 4.
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 then click twice slowly on the value that opens below it. Enter a valid value for the field (the minimum and maximum values appear in the Field Info box to the right). Click OK to apply the changes.
Setting Values for Configuration Property Arrays You can view and set values for a configuration property array using a table instead of using the Value box or the Set Configuration Properties dialog. To view a configuration property array, right-click a configuration property array and then click Table on the shortcut menu. The Edit Configuration Property Table dialog opens. This dialog contains a table listing the values for each element in the configuration property array.
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 then clicking Clear Value on the shortcut menu. To clear all values in the browser display, open the Browse menu and select Clear All Values. Clearing the values in the browser display does not affect the values in the functional block. Getting Values You can get the current value of a network variable or configuration property.
This dialog lists built-in data types, and resource files containing defined network variable types (SNVTs and UNVTs). Expand the items listed to view the available data types. Click the type for the network variable and then click OK. • Select the Show Only Types with Matching Length check box to display only those types with the same size as the current network variable type.
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, localized formatting specifications, or text strings that are to be displayed as part of the value. For example, a temperature sensor may report a temperature value with a type of SNVT_temp_f. The SNVT_temp_f type is defined as a 32-bit signed floating-point value representing a Celsius temperature.
• Select the Show Obsolete Types check box to list those network variable types that are marked obsolete in the current standard resource file set. • The Length box displays the size (in bytes) of the currently selected type. Tip: Many standard network variable types include formats with “#US” and “#SI” format specifiers. You can use these specifiers to identify default formats when the appropriate default is determined by the regional settings on the computer running OpenLNS CT.
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 property, or functional block state (enabled or in override). You can also use a Data Point SmartShape to update the value of an input network variable or configuration property. You can use Data Point SmartShapes to create simple human-machine interface (HMI) applications within your OpenLNS CT drawing.
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, OpenLNS CT will attempt to locate the appropriate data point using the relative subsystem\device\functional block path of the source. In addition, you can create a Data Point SmartShape that you can copy to a different subsystem and have it refer to a data point in that subsystem.
and field name [if defined]). This is the default. Device.FB.NV (the device name, functional block name, network variable name, and field name [if defined]). If the selected data point is a functional block state, the following options are available: • • • • None (no label). Status (the status name [enable/override]). FB.Status (the functional block name and status name). This is the default. • Device.FB.Status (the device name, functional block name, and status name).
a functional block state. Polling Interval Specifies how frequently (in seconds) the data point is polled. The default is 5 seconds for polled network variables and 15 seconds for monitored configuration properties and functional block states. If you change the polling interval, the value you enter becomes the default for new Data Point SmartShapes of that object type until you close the drawing and then re-open it from the OpenLNS CT Design Manager.
• 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 value with multiple states each represented by an enumeration string, such as an occupancy state with occupied and unoccupied values or an HVAC mode. A functional block state is also an enumerated value. Updating a Scalar Data Point To set the value of a scalar data point, follow these steps: 1.
5. • 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 minimum and maximum values appear in the Field Info box to the right). Repeat for any other fields for which you want to set the value. • Enter a valid value in the Data Value box for one or more of the fields in the structured data point.
Creating and Using a Custom Data Point Master SmartShape You can create a custom data point master SmartShape from an existing Data Point SmartShape, and you can include a Data Point SmartShape with other SmartShapes in a custom OpenLNS CT master SmartShape. All the properties of the Data Point SmartShape—including the selected data point, label, fonts, and colors—are saved in the custom master SmartShape.
subsystem levels up the network hierarchy and then down to the “Floor2.Room10” subsystem in the network. A custom Data Point master SmartShape is created by dragging the original SmartShape to an OpenLNS CT stencil. If the custom Data Point master SmartShape is dragged to a “Subsystem 1.Building2.Floor1.Room1” subsystem, it will reference a data point in the “Subsystem 1.Building2.Floor2.Room10” subsystem.
specifically address HMI tasks. In addition, these tools offer components that provide reporting and analysis, history, alarm logging, event handling, and Internet-enabling. To create a simple HMI with Data Point and Visio SmartShapes, you do the following: 1. Add Data Point SmartShapes to your drawing as described in Adding and Monitoring a Data Point SmartShape. You use the Data Point SmartShapes to monitor and control data points. 2.
• Example The following example demonstrates a function that writes an “ON” value to a SNVT_swtich data point: RUNADDONWARGS("LMW Set Value","/SelOverride/ShapeOverride=DataPoint.50 /Value= 100.
2. In the Macros Name: dialog box, enter a name for the Macro. Click Create. The Network Passwords dialog opens if this is the first time you are creating a Macro or entering VBA code in your OpenLNS CT drawing. 3. Enter enumerate in the Password box. 4. The Visio VBA editor opens. The left pane of the editor displays the OpenLNS CT drawing; the right pane displays the VBA code associated with the Macro you are creating. 5.
• 4. If you are monitoring the lamp value, you can change the color of the Visio shape based on the brightness of the lamp. To do this, enter the following function: Sheet.!User.MonValue/10. Click the accept button ( ) in the Formulas box. Using a Macro to Read Values To read from a Data Point SmartShape value using a Macro, follow these steps: 1. Click the Developer tab, and then click Macros. The Macros dialog box opens. 2.
6. In the OpenLNS CT drawing, right-click the Visio shape used to monitor the Data Point SmartShape, and then click Show ShapeSheet on the shortcut menu. The ShapeSheet of the selected Visio shape opens. 7. Enter the following function the FillForegnd cell of the FillFormat section: RUNMACRO(""), where Macro Name is the name of the Macro you entered in step 2. 8. Click the accept button ( ) in the Formulas box.
7 Maintaining Networks This chapter provides an overview of network maintenance tasks that you can perform with OpenLNS CT. It describes loading, replacing, and decommissioning devices. It explains how to resynchronize and propagate configuration properties values. It explains how to back up and restore an OpenLNS CT network; create an OpenLNS CT network by recovering information from the physical network; and resynchronize the network database, OpenLNS CT drawing, and physical devices.
Maintaining Networks Overview You can perform routine maintenance to update, repair, and optimize an installed network. You can maintain the network and its components, the OpenLNS CT drawing, and the OpenLNS network database. For example, if a device or router fails, you can replace it on the physical network and then logically replace it in the OpenLNS CT network, preserving the device’s configuration and all of its connections.
To load a new application into a device, the devices must have writeable application memory, and OpenLNS CT must be attached to the network and OnNet. To load a new application into a device, follow the five steps described in the subsequent sections: 1. Select the device or devices to upgrade. 2. Select or create a device template. 3. Select an application image to load into the device(s). 4.
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 this property, click Add-ins, click OpenLNS CT, click OpenLNS CT Options, and then select Device from the Options Category list). The device template name in the Template Name box is automatically set to the name of the XIF file (without the extension), but you can change it to any name that is unique to the network. • Existing Template.
Load Application Image Select this check box to enable loading a new application image into the device. Update Firmware in Device to Match Application Image Select this check box to load a new Neuron firmware image to make the Neuron firmware on the device compatible with the new application image file. For a device to support Neuron firmware updates, it must be based on a Nueron 5000 or Neuron 3150 core with a nonvolatile memory layout supporting at least 32K starting from address 0.
Selecting Initial Device State and Source of Configuration Property Values To select the initial device state and the source of configuration property values, follow these steps: 1. Specify the initial state of the device applications, and select the source of the configuration property values and management of device-specific configuration properties as follows: State Specify the state of the device application after it has been commissioned. You have four choices: • Default.
after a reset. • Source of CP Values Device Specific CPs OpenLNS CT User’s Guide Disable. Keeps the device application disabled even if the device 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 Node Object, the device is placed offline. As with offline operation, portions of a disabled device’s application may continue to function. Specify the source of the device’s configuration property values.
new device. 2. Click Next. The Device Identification Method window opens. Follow the steps in Installing Devices and Routers in Chapter 5, Installing Networks, to continue loading the devices. Replacing Devices You can replace a device with a new device if the device fails or a newer version of the device becomes available. The replacement device can use the same device template used by the old device or it can use a different device template.
5. Specify the initial state of the replacement device’s application, and select the source of the configuration property values and management of device-specific configuration properties as follows: State Set the state of the device application after the replacement device has been commissioned. You have four choices: • Default. The state of the replacement device’s application is determined by the current setting under the New Device Options box in the Network Properties: Device options category.
and the device does not contain a Node Object functional block, the device is placed offline. As with offline operation, portions of a disabled device’s application may continue to function. This option is not available for routers. Source of CP Values Device Specific CPs 6. 204 Specify the source of the replacement device’s configuration property values. You have three choices: • OpenLNS Database.
case, follow the steps in Installing Devices and Routers in Chapter 5, Installing Networks, to continue installing the devices). Removing the Old Device If the old device still functions, and if physically possible, leave the old device connected to the network until the device replacement has been completed. This allows OpenLNS CT to deconfigure the old device so that you can easily reuse it in a new network. This step is not required if the device has failed.
network tool not based on OpenLNS is used to update the physical devices, or if the devices themselves update their own configuration properties. To resynchronize the configuration properties for a device, follow these steps: 1. Right-click the device, or select multiple devices and right-click one of them, point to Commissioning, and then click Resync CPs on the shortcut menu. The Set Configuration Properties dialog opens. 2.
3. Click OK. OpenLNS CT updates the device and the OpenLNS network database, as required. Using OpenLNS CT as a Passive Configuration Tool You can use OpenLNS CT as a passive configuration tool. A passive configuration tool is a tool that that configures the application in a device without affecting its network configuration. A passive configuration tool is required when a network tool not based on OpenLNS is being used to manage the configuration of a network.
Manually Backing Up an OpenLNS CT Network You can back up an OpenLNS CT network design from an OpenLNS CT drawing or from the OpenLNS CT Design Manager. When you back up the network database, you can close the network database and create a standard backup, or you can create a hot backup, which is a shadow copy of the network database created while it is open. You can use a hot backup to create a backup without disrupting any remote clients or other OpenLNS applications accessing the network database.
• 3. 4. Select the Backup NodeBuilder Project check box to back up the NodeBuilder project associated with the OpenLNS CT network, if there is one. This option is only available if you are using the NodeBuilder Development Tool. If you are backing up the OpenLNS CT drawing, select which drawing files to back up under the Drawing Files to Backup box. • Select Backup Visio (*.vs*) Files only to back up only the Visio files in the drawing directory.
• 6. 7. If the backup file includes only the database, the default backup file is Db[_index].zip. Click OK. • If the OpenLNS network database is not being accessed, OpenLNS CT automatically creates a standard backup of the database. • If the OpenLNS network database is being accessed and hot backups are enabled, OpenLNS CT automatically creates a hot backup of the database.
To set the automatic OpenLNS CT drawing save interval, follow these steps: 1. In the OpenLNS CT drawing, click Add-ins, point to OpenLNS CT, and then select OpenLNS CT Options. The Network Properties dialog box opens. 2. Select Backup/Restore from the Options Category list. 3. In the Drawing Save field under the Auto Save Interval box, enter the desired number of minutes between the automatic saves in the network properties.
backup, the backup will be stored in the LM\Backup\ folder and the backup file will include the date on which it was created and an index (if necessary to make the file unique). 7. To set the periodic backup interval, select the desired number of days between backups in the Interval in Days list under the Periodic Backup Options box. The default value is 7, which means that a standard OpenLNS CT backup of the network drawing(s) and database is created every week by default.
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 manager. Click Start on the taskbar, click Run, and the enter C:\Windows\tasks. The Windows Task dialog opens. 2. Double-click Add Scheduled Task. The Scheduled Task Wizard opens. 3. Click Next. 4. Under the Application column, locate and then click LonMaker. Click Next. 5. Modify the task name, if desired, and select how often you want the backup performed.
Restoring an OpenLNS CT Network You can restore an OpenLNS CT network from a standard OpenLNS CT backup or a hot backup. If you restore an OpenLNS CT network containing only a network database or an OpenLNS CT drawing, OpenLNS CT replaces the current drawing file and/or database with the backup copy (unless the network does not already exist on a local client).
backup file names are in the following format by default: Db[_index].zip), and click Open or double-click the OpenLNS CT backup file. • If you select the Restore from OpenLNS Hot Backup check box, select the OpenLNS hot backup to restore. The OpenLNS hot backups appear in the order they were created. By default, the first OpenLNS hot backup created is selected. To select a different OpenLNS hot backup, click the file name of the OpenLNS hot backup you want to restore. 5.
7. This dialog box displays the paths where the restored network database will be saved. You cannot change the directory if the database already exists on your computer. Click OK. A message will appear prompting you to select whether to delete or overwrite the existing directory. 8. Click Yes to delete the existing drawing folder before restoring the network, or click No to overwrite it. The database restore operation begins. 9. When the network database has been restored, a confirmation dialog opens.
Restoring a Full Network Backup To restore a full network backup containing both the network database and OpenLNS CT drawing files, follow these steps: 1. Open the OpenLNS CT Design Manager. Click Start on the taskbar, point to Programs, point to Echelon OpenLNS CT, and then select OpenLNS CT. 2. Select the network to restore by selecting either the database from the Database Name list or the OpenLNS CT drawing from the Drawing Directory list. 3. Click Restore. The OpenLNS CT Restore dialog box opens.
• Click Yes if you made any changes to the network since it was backed up. This prevents the network from behaving unpredictably if the OpenLNS CT network design is not in sync with the physical devices. • Click No only if changes have not been made to the configuration of the existing physical devices on the network since it was backed up. This happens if OpenLNS CT was OffNet the entire time, or if you added new devices and functional blocks but did not modify any existing devices or functional blocks.
15. Click Next to next to accept the default synchronization operation, which is Synchronize Network to Database (the option for recommissioning devices). The Choose Synchronization Scope dialog opens. 16. Click Next to accept the default synchronization scope (all the subsystems and drawing files in the network). The Commissioning Options dialog box opens.
17. Select the state of the devices after they have been recommissioned. You have four choices: • Preserve Current State. The devices will be restored to the state they were in prior to being recommissioned. This is the default. • Offline. All devices will be left in the offline state. The behavior in the offline state depends on the device. A Neuron-hosted device, for example, will not run its application. You can set all device offline so that you can recommission the system incrementally.
19. This window displays the status of the resynchronization. Resynchronization events will be listed in the order they occur. Click OK when the resynchronization is complete. The resynchronization events, including any errors, are shown in the status pane and recorded in a log file (Resync.log). The resync log is stored in the drawing directory of the current OpenLNS CT network. Notes: • Recommissioning a device may temporarily interrupt its operation.
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 detailed recovery log. A trace log lists the steps, with the times and dates, that the wizard took to recover the database. You can view the logs after the database has been recovered. These logs are useful for tracking any errors that the recovery process encounters, such as connection errors or lost data. 4.
4. Click OK. You can update the recovery data in the physical devices in a network after setting the subsystem recovery options and after recovering a network. To update the recovery data, follow these steps: 1. Click Add-ins, point to Synchronization, and then click Resynchronize. The Synchronize OpenLNS CT Drawing dialog opens. 2.
3. Select the subsystems and drawing files to update. 4. Click Finish. The Synchronization Status dialog opens and OpenLNS CT begins updating the subsystem data in the devices within the specified network scope. 5. When the synchronization operation has been completed, click OK. Using Subsystem Paths If you select the Set SCPT Location Value to Subsystem Path option, OpenLNS CT stores the subsystem path in the SCPTlocation configuration property of application devices when they are commissioned.
OpenLNS CT then assigns the discovered devices the first subsystem ID value discovered. OpenLNS CT resolves any conflict that occurs in this scenario. Using the OpenLNS Database Recovery Wizard To run the OpenLNS Database Recovery Wizard in order to recover a network, follow these steps: 1. Click Start on the taskbar, point to Programs, point to Echelon OpenLNS CT, and then select OpenLNS CT. The General tab of the OpenLNS CT Design opens. 2.
226 5. The Plug-In Registration dialog opens. Register or disable plug-ins as desired and click Next. 6. The Authentication dialog opens. If you use authentication on your network, select the Enable Authentication check box and click Set New Authentication Key. Enter the correct authentication key for your network (OpenLNS CT cannot recover your database without the authentication key). Click Next.
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 Domain ID box. If you do not know the domain ID, select the Recover Domain ID from Network Device check box. To recover a domain ID, you must have access to the service pin of an unauthenticated device that is on the same channel as the network interface. 8. Click Finish.
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 unauthenticated devices that are on the same channel as the network interface, and then click OK. 10. The OpenLNS Database Recovery Wizard opens. Click Next. 11. The What Would You Like To Do Now? dialog box opens. Click Recover a Network and click Next. 12. The Select LonManager Database dialog box opens.
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 Domain ID and Authentication Key boxes are read-only, as these settings are determined by the input from step 7. Click Next. 14. The Device Resource Files dialog box opens. Before proceeding, check if any LONMARK resource files are contained in directories not displayed in this dialog box.
15. The External Interface Files dialog box opens. Add or remove device templates based on device interface (XIF) files. When finished, click Next. 16. The Recovering dialog box opens. Click Next to begin the network recovery. The time of the recovery process depends on the size and complexity of the network. Throughout this process, messages will appear.
17. When the data recovery is complete, the Optimizing Database dialog box opens. Select the Organize Database check box and click Next. 18. Throughout this process numerous messages will appear. When the database organization is complete, a Congratulations dialog box opens. This dialog box displays the number of errors and warnings, and the number of devices, bindings, warnings, routers, and channels found.
19. If there are any errors or warnings, click Details to view the recovery log listing each recovery phase initiated and any problems encountered. Investigate any errors before you set the final network design OnNet. You can also research warnings, but they are not considered as serious as errors. Click Trace to view the trace log listing the steps taken by the OpenLNS Database Recovery Wizard to recover your network.
22. The Select Stencils dialog box opens. Add, remove, or re-order stencils. Click Finish 23. The Synchronization Status dialog box opens as the synchronization process begins. It then displays the progress of the synchronization. Once “Synchronization Complete” opens, click OK to open your OpenLNS CT network. 24. Verify that your OpenLNS CT drawing accurately represents the network. Ensure that all devices on the physical network and all the connections between the devices appear on the drawing.
25. Compare the recovered OpenLNS network database to your expected results. Because network recovery occurs while OpenLNS CT is OffNet, required changes to device configuration properties are stored in the OpenLNS network database instead of being propagated to the network. Once you have checked the recovered OpenLNS network database and validated your OpenLNS CT network design, change the management mode to OnNet.
• Any address table entries that are not associated with a network variable or message tag (source or target) are marked as empty. A lost source or a lost target may create this scenario. Group use counts are updated as necessary, and group IDs are freed as necessary. • When recovering a network, OpenLNS CT cannot determine which network variables are hubs and which ones are targets. These relationships are arbitrarily assigned.
OpenLNS CT object that the other user is trying to modify at the same time. As a result, multiple users will typically be more productive if they are working in different subsystems. OpenLNS Event Tracking OpenLNS CT uses OpenLNS events to detect changes to an OpenLNS CT drawing made by OpenLNS applications other than OpenLNS CT, as well as changes in the status of devices as reported by the OpenLNS server.
You can sort the OpenLNS CT event log by any of the column headers. To sort by a column header, click the header. Click the header again to toggle the order in which the data in that column is listed (ascending or descending). The columns contain the following data: Date/Time The date and time the event occurred. By default, the OpenLNS CT Event Log lists the changes by date/time in ascending order. Document The name of the document in which the change occurred.
The exported XML version of the OpenLNS CT event log contains the following information for each log entry. DocumentName Name of the OpenLNS CT drawing in which the event occurred. SeqNum The unique ID (within the OpenLNS CT drawing) of the event. TimeStamp Date and time at which event occurred in the format year-month-date-time. UserName The user who generated the event. AppInst The instance of the OpenLNS CT application that generated the event.
blocks. NvHandle The index of the network variable in the device. This field only applies to events related to network variables. Mthandle The index of the message tag in the device. This field only applies to events related to message tags.
3. Choose the synchronization operation(s) you want to perform by selecting the following options. OpenLNS Database The network database resynchronization options are only available if OpenLNS CT is running on the same computer as the OpenLNS Server. Validate OpenLNS Database Validates the structure of the OpenLNS network database. Validate and Repair OpenLNS Database Validates the structure of the OpenLNS network database and repairs the database if any errors are detected.
OpenLNS CT Drawing Synchronize Drawing to Database (fix-up Drawing) Updates the OpenLNS CT drawing to be consistent with the OpenLNS database. Synchronize Monitor Sets between Drawing and Database Updates the monitor sets in the OpenLNS CT drawing to be consistent with the OpenLNS database. A monitor set is a group of point definitions that OpenLNS CT uses to monitor and control network variables.
5. Select the scope of the selected synchronization operation(s) by choosing which subsystems and drawing files to resynchronize. If you know that the current subsystem is the only one needing resynchronization, resynchronize just that subsystem. If you aren’t sure which subsystem needs to resynchronized, resynchronize all subsystems. The same logic applies if your OpenLNS CT network contains multiple drawing files.
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 Synchronization Options dialog opens. If you are performing any other synchronization operation, click Finish to begin resynchronization. Skip to step 16 in which the Synchronization Status dialog opens. 7. If you are recommissioning devices, the Commissioning Options dialog box opens. Select the state of the devices after they have been recommissioned.
9. Select the following options and then click Next. Shapes All SmartShapes that have newer versions available than the ones currently in the drawing are listed. Select the SmartShapes to update. Items Select Menu to update the shortcut menus for the selected SmartShapes. Set Appearance to have the appearance of the SmartShapes updated. 10. The Synchronization Options dialog opens. 11. Select the options to be applied during the synchronization of the OpenLNS CT drawing to the network database.
during Resync resynchronization. This speeds up resynchronization, as it reduces the time Visio spends updating the drawings. Check for Connections for Missing FB Shapes Enables OpenLNS CT to check for connections to functional blocks that are in the network database but are not represented by functional block SmartShapes in the OpenLNS CT drawing. Subsystem to Visio Document Assignment Select in which Visio drawing file to place the subsystems in your network.
15. Specify the stencils that will be scanned for master SmartShapes during resynchronization. When objects are found within the OpenLNS network database that are not already represented in the drawing, OpenLNS CT scans the listed stencils and automatically adds the appropriate SmartShape to the drawing. If the object’s particular master SmartShape is not found, an appropriate generic master SmartShape (e.g., a LONWORKS Device SmartShape) will be used. To add additional stencils, click Add Stencil.
events, including any errors, are shown in the status pane and recorded in a log file (Resync.log). The resync log is stored in the drawing directory of the current OpenLNS CT network design. 17. If the OpenLNS CT drawing is being synchronized to match the network database and the Automatically Drop Device, FB, and Subsystem Shapes check box was cleared, the Missing Shape dialog opens for each object in the network database that is not represented in the OpenLNS CT drawing. a. Click OK.
which no permanent server is needed. In most cases, however, it may be easier (if not necessary) to install each floor as a separate network. Once the entire site has connectivity, the individual floor networks can be merged into a single network representing the high rise. To support these scenarios, OpenLNS CT provides the ability to merge OpenLNS CT networks.
• Non OpenLNS CT extension records. Non OpenLNS CT extension records will only be copied if you selected the Enable Configuration Properties check box the Network Properties: Configuration Properties options category, and the extension record is marked for copying Merging OpenLNS CT Networks To merge two OpenLNS CT networks, follow these steps: 1. Identify the source and destination networks.
5. Click Finish to prepare the OpenLNS CT network design for merging. The OpenLNS CT Database Merge Export Status dialog opens. This dialog displays the export status and lists merge export events in the order they occur. 6. Click OK when the merge export is complete. Click Cancel at any time to terminate the merge export. 7. Exit the OpenLNS CT drawing of the source network. 8.
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 have been exported using the Merge Export Utility. 13. Enter a name for the root subsystem of the source network in the Name to Be Assigned box. 14. Click Finish to begin the network merge. The source network and its underlying subsystem hierarchy will be added as a new subsystem.
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 pane, and they are also available in a log file for the network merge. The log file is named Merge_.log. The merge log is stored in the drawing directory of the destination network. 15. During the network merge, OpenLNS CT prompts you to specify whether the channels in the merged network already exist in or are new to the current network.
8 Managing Networks This chapter explains how to test and verify application devices, functional blocks, and routers. It also describes OpenLNS CT styles, and it details how to generate device status summary reports, network resource reports, and OpenLNS network reports.
Using the OpenLNS CT Device Manager You can manage application devices, functional blocks, and routers using the OpenLNS CT Device Manager. You can switch between performing management tasks and making changes in your OpenLNS CT drawing without having to close the OpenLNS CT Device Manager. You can perform the following tasks using the OpenLNS CT Device Manager: • Test application devices, functional blocks, and routers to ensure they are operating and are configured correctly.
Managing Devices To manage a device, right-click a device (or select multiple objects including at least one application device or functional block and right-click one of them), and then select Manage on the shortcut menu. You can also select the Devices tab after you have opened one of the other tabs with one or more application devices or functional blocks selected. The Devices tab of the OpenLNS CT Device Manager opens. You can use this tab to manage the selected application devices.
network variable values or send network variable updates. If the device was previously offline, the device state does not change. If the device is reset while offline, it will be placed in the online state. Enable Activates all functional blocks on a disabled device. The device must be online to be enabled. This command only applies to devices containing a Node Object functional block. Disable Keeps the device application disabled even if the device is reset. The device must be online to be disabled.
The commands in this dialog require that the device application associated with the functional block includes a Node Object functional block and that the device is online. Click one or more functional blocks in the Object List and then click any of the following buttons: Test Tests the functional block to ensure that it is operating correctly. The tests run are determined by the options set in the Device Manager Settings dialog, which you can open by clicking Settings.
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 then and select Manage on the shortcut menu. You can also select the Routers tab after you have opened one of the other tabs with one or more routers selected. The Routers tab of the OpenLNS CT Device Manager opens. You can use this tab to manage the selected routers.
Click Settings to open the Device Manager Settings dialog box. There, you can set options for testing routers and options for the results log. Device Manager Settings You can customize the error reporting, testing, and winking operations performed by the OpenLNS CT Device Manager. To customize these setting, click the Settings button on any of the tabs in the Device Manager. The Device Manager Settings dialog opens. Set the following options and then click OK to apply any changes.
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 these commands are not repeated. If you enter a value greater that 1 in this box, you must enter a non-zero value in the Wait Between Operations box. Wait Between Operations Specifies how many seconds the OpenLNS CT Device Manager waits between repeating a Wink or Test command when the number in the Repeat Number of Times box is greater than 1.
device may not be responding properly, a router or channel between the OpenLNS Server and the device may have failed, or a physical connection may be faulty. If OpenLNS CT is OnNet, the OpenLNS Server periodically tries to update the device. Once the device has been updated to match the network database, the device style changes to Normal. Detached Red crosshatching The OpenLNS Server has detected that the device is not attached or is otherwise unable to communicate with the network.
When multiple functional blocks states are concurrently active, the style displayed is based on the order of the states listed above. For example, a functional block in the normal state that is disabled and placed in override mode will be crosshatched yellow, indicating the disabled state (disabled is the highest-order state of the three). If multiple states are active and the highest-order state is then cleared, the functional block style will be updated to display the next applicable state.
Network Variable and Message Tag SmartShape Styles OpenLNS CT indicates the state of network variable and message tag SmartShapes using the following styles: Connection Point State Default Style Description Connection Point Normal Solid black fill The network variable or message tag SmartShape is normal (not currently exported to a supernode). Connection Point Exported Solid blue fill The network variable or message tag SmartShape has been exported to one or more supernodes.
Monitoring Enabled Text is black. Monitoring Disabled Text is magenta. OpenLNS CT updates the style of the connection SmartShapes, as required, if changes are made to the connections that affect the service type used. Generating a Device Status Summary Report You can generate a status summary report listing the devices and routers that are unconfigured and offline, and selected functional blocks that are in the override, alarm, or disabled states or have reported communication or self-test failures.
3. • Select Subsystem Page to include the application devices, routers, and functional blocks in the current subsystem. This is the default. • Select Subsystem Hierarchy to include the application devices, routers, and functional blocks in the current subsystem and subsystems nested in it. • Select Entire Network to include all the application devices, routers, and functional blocks in the current OpenLNS CT network.
266 4. Select additional functional blocks to include in the status summary based on the type of errors or exceptions they have reported. For more information on the status items themselves, refer to hardware manuals or LONMARK documentation. 5. Click Next. The Device Status Summary Results dialog opens. This dialog displays the status of devices, routers, and specified functional block types within the scope specified in the Device Status Summary Options dialog.
For functional blocks, this dialog displays the following data in the top pane: subsystem, device, functional block name, applicable status (indicated by "YES"), and any comments about the functional block. For application devices and routers, this dialog displays the following data in the bottom pane: subsystem, device name, state, and any comments about the device or router. 7. To save the status summary to a text file (.txt extension), click Save As.
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 displayed in a ToolTip for a device. The device SmartShape ToolTip lists the total number of network variable aliases for the device, and the number of aliases currently available.
OpenLNS CT User’s Guide 269
270 Managing Networks
9 Exporting and Importing Networks with XML This chapter describes how to export a LONWORKS network to a LONWORKS network XML file, view a LONWORKS network XML file in a web browser, edit a LONWORKS network XML file, and import a LONWORKS network XML file to update a network.
Using XML Export/Import Overview You can speed up your network design and ensure your devices are configured correctly by creating an OpenLNS CT network report or by creating a custom OpenLNS CT user interface. OpenLNS CT includes an OpenLNS CT XML plug-in that you can use to export all the devices, connections, network variables, and configuration properties within all or a part of an OpenLNS CT network design to a LONWORKS network XML file.
1. Click Add-ins, point to OpenLNS CT Documents, and then click Export to XML. The XML Export Options dialog box opens. 2. Set the following options to select the data to be included in the XML file: Export Scope Select the portion of the network to be included in the XML file. There are four choices: • Entire Network. All application devices and routers in all subsystems in the network will be exported. This is the default. • Current Subsystem and Dependents.
Specific CP Values Device-specific CPs are CPs that may be changed by the device itself or by another device that is not based on OpenLNS. OpenLNS CT reads device-specific values from the devices in the network—this option is unavailable if the OpenLNS CT computer is not connected to the physical network. This option can add significant processing time to the export if there are many device-specific CPs within the export scope.
4. Either open the OpenLNS CT XML file from Internet Explorer, or open the folder containing the OpenLNS CT XML file and double-click the file (Internet Explorer must be your default Web browser for this method to work). The OpenLNS CT network report opens. 5. If you are using Internet Explorer 9, press F12 to open the Developer Tools, click Browser Mode, and select Internet Explorer 9 Compatibility Mode. This enables Internet Explorer 9 to display the objects in the report.
Click a functional block link to open a page with detailed data on that functional block and a table listing its network variables and configuration properties, with links to view detailed data on each one.
You can continue moving down the network hierarchy until reaching the end, which is at the network variable\configuration property or configuration property paths. Click Up to go back one level in the network hierarchy, or click Root to return to the main network page. Importing a LONWORKS Network XML File You can import a LONWORKS network XML file from another application using the OpenLNS CT XML Plug-in, or you can manually import a LONWORKS network XML file into an existing network using OpenLNS CT.
Input File Name Specifies the name of the XML file to import. Log File Name Specifies the name of the output XML log file that is generated during the XML import. This log lists the objects created, modified, or deleted, and any errors encountered. The default name is C:\Users\Public\Documents\LonWorks\OpenLnsCt\XML\ network\Export[ _version ]Log.xml. If this field is clear, an XML log file is not created. 3. Click OK.
10 Managing OpenLNS CT Licenses This chapter provides an overview of OpenLNS CT licensing. It describes how to upgrade OpenLNS CT, upgrade an OpenLNS CT Standard Edition to the Professional Edition, renew your OpenLNS CT annual maintenance, and transfer an OpenLNS CT license.
Commissioning Devices with OpenLNS CT OpenLNS CT lets you install devices without commissioning fees (known as “credits” in LonMaker Turbo Editions and previous versions of the LonMaker software). OpenLNS CT features no-cost installation for all LONWORKS devices that comply with the ISO/IEC 14908-1 Control Network Protocol.
2. The License Wizard guides you through the process of manually updating or upgrading your OpenLNS CT license. Click Next. 3. The Step 1: What would you like to do? dialog opens. 4. To update or upgrade your OpenLNS CT software using the over the Internet or via e-mail, click Activate Product Licenses and then click Next. To upgrade over the phone, click Show Advanced Tasks, Upgrade a Product License over the Phone, and then follow the instructions in the License Wizard.
282 6. Select Upgrade from the Action list for both OpenLNS Server and OpenLNS CT, and then click Next. 7. If your computer is online, the Step 3: Status dialog opens, and the License Server upgrades OpenLNS Server and OpenLNS CT. If your computer is offline, 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 license request file (.elwrq extension) is to be saved, or click Browse, specify the directory where the license request file is to be saved, and then enter a name for the file. Under Authentication Details, enter the Echelon ID (e-mail address) and Password you created for your Echelon download account. The Activation Key box displays the 25-character alphanumeric string for the Echelon product to be upgraded. Do not modify this property.
10. Click Send Request to Echelon to e-mail the license request file to Echelon at activation@echelon.com. Echelon will send you an e-mail message with a license response (.elwrs extension) file. You can upgrade your license faster by copying the license request file to an Internet-connected computer with the License Wizard installed on it and importing it into the License Wizard. The License Wizard creates the license response file, which you can then copy to the original computer. 11.
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 activate. Click Next. The License Server installs and upgrades the licenses in the license response file. e. The Status dialog opens and confirms that the OpenLNS Server and OpenLNS CT licenses have been successfully upgraded.
12. Click Exit to close the License Wizard. Upgrading OpenLNS CT Standard Edition to OpenLNS CT Professional Edition You can upgrade a copy of OpenLNS CT Standard Edition to OpenLNS CT Professional Edition if you need support for more networks. The Standard Edition supports up to five networks and the Professional Edition supports an unlimited number of networks. Upgrading from OpenLNS CT Standard to OpenLNS CT Professional does not upgrade the Visio edition.
d. If your computer is online, the Step 3: Enter Customer Information dialog opens. Complete the following steps to return your software (if your computer is offline, proceed to step e): • Enter the User ID (e-mail address) and Password you created for your Echelon download account. If you do not have an Echelon download account, click the Sign Up for a New Account link, and create one on the Echelon Web site. If you forgot your password, you can retrieve it by clicking the Forgot your Password link.
• The Step 4: Status dialog opens, and the License Server returns your OpenLNS CT Standard license. • Click Exit to close the License Wizard. e. If your computer is offline, the Step 3: Where Would You Like to Save your License Requests? dialog opens. f. 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 the directory where the license request file is to be saved, and then enter a name for the file.
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 Echelon to e-mail the license request file to Echelon at activation@echelon.com. Echelon will send you an e-mail message with a license response (.elwrs extension) file. You can upgrade your license faster by copying the license request file to an Internet-connected computer with the License Wizard installed on it and importing it into the License Wizard.
losing your license. You cannot use the License Wizard to install one OpenLNS CT license on multiple computers. To transfer your OpenLNS CT license, follow these steps: 1. On the source computer, return the OpenLNS CT license following these steps: a. Open the Echelon License Wizard. Click Start, click Programs, point to Echelon License Wizard, and then click License Wizard. The Echelon License Wizard opens. Click Next. b. The Step 1: What Would You Like to Do? dialog opens.
the target computer by e-mailing the license request file to Echelon at activation@echelon.com, or by copying it to the target computer (if it has an Internet connection) and importing it into the License Wizard. e. 2. Your OpenLNS Server and OpenLNS CT licenses are returned to the Echelon License Server. The Step 4: Status dialog opens and report the results of the license return. Install OpenLNS CT on the target computer following the steps described in Chapter 2, Installing and Activating OpenLNS CT.
292 Managing OpenLNS CT Licenses
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, enable, and disable plug-ins.
Using Plug-ins Overview Plug-ins are applications that you can start from within OpenLNS CT to perform a specialized task, often relating to a specific type of device or functional block. Device manufacturers may provide plug-ins that you can use with OpenLNS CT to configure their devices. Any plug-in conforming to the OpenLNS plug-in guidelines may be used with OpenLNS CT. You can view and download free Echelon and third-party plug-ins at www.echelon.com/plugins.
• 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-in is registered for the selected command and functional block type, the plug-in window opens. You can display information about the plug-in commands that are installed on your computer and registered for the network, and which commands are default commands, as described in Getting Plug-in Information.
Viewing Plug-in Information You can perform the following operations for registered plug-ins: • • • • • View general information about the selected plug-in. Disable the plug-in. Set whether the plug-in is the default for a given command. Select whether the plug-in is pre-launched for commands that invoke it. View whether the plug-in supports multiple objects and single instance use. To perform any of these operations, open the OpenLNS CT Plug-in Info dialog from the drawing page or the Visio menu.
OpenLNS CT does not change the attribute on any other plug-ins. If multiple plug-ins are registered for the same command and object class, the plug-in with this check box selected will be the one invoked. If multiple plug-ins have this check box selected, OpenLNS CT invokes the first plug-in that it finds with this option set. Prelaunch Keeps one instance of the plug-in program active (if registered) so that it is immediately available for commands that invoke it.
Server Name The registered ActiveX name for the plug-in. Multi-Object Whether the plug-in supports multiple objects simultaneously. Single Instance Whether the plug-in supports using a single instance of the plug-in when it is requested for the same object multiple times. Pre-Launch Whether OpenLNS CT has pre-launched an instance of the plug-in. Failures. The number of times in the current session that the plug-in has been pre-launched but has failed to launch or has terminated unexpectedly.
2. Click Register. The plug-in or plug-ins are added to the Pending list (they also remain under their existing lists), and their status, “[Register]”, is indicated. 3. Once you have chosen all the plug-ins to register or re-register, click Apply. The selected plug-ins will be added to the Already Registered category and be removed from the Pending category. 4. After the plug-ins are registered, click OK to return to the OpenLNS CT drawing.
300 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 CT drawing.
12 Creating and Using Custom OpenLNS CT SmartShapes and Stencils This chapter describes OpenLNS CT stencils and the process to create them; creating and using custom master SmartShapes for devices, functional blocks, subsystems, and connections; using additional user cells for devices, functional blocks, and routers; and setting user-defined functional block modes and types.
OpenLNS CT Stencils OpenLNS CT uses Visio stencils to speed your LONWORKS network engineering. A stencil is a collection of master SmartShapes (also called masters) that you can easily reuse in your drawings. To add a master SmartShape to your drawing, you drag the master SmartShape from the stencil to your drawing. OpenLNS CT includes LONWORKS specific master SmartShapes called OpenLNS CT SmartShapes. For more information on Visio stencils and master SmartShapes, see your Visio documentation.
LonWorks\LonMaker\Visio directory (by default, C:\Program Files\LonWorks\LonMaker\Visio [32-bit system] or C:\Program Files (x86)\LonWorks\LonMaker\Visio [64-bit system]) to easily access it with the open stencil ( button, or save the stencil to the drawing folder for simplified backup. ) Creating Custom OpenLNS CT Master SmartShapes You can create a custom OpenLNS CT master SmartShape to reuse any part of a design within the same drawing or in many OpenLNS CT drawings.
Using Custom OpenLNS CT Master SmartShapes You can reuse a custom OpenLNS CT SmartShape that you create (see Creating Custom OpenLNS CT Master SmartShapes). The custom OpenLNS CT master SmartShape may contain any number of the standard OpenLNS CT SmartShapes described in Designing OpenLNS CT Networks. The following sections describe how OpenLNS CT processes each of the standard OpenLNS CT SmartShapes when you include them in a custom OpenLNS CT SmartShape.
SmartShapes that will be used with the newly created device SmartShape. See Additional Functional Block User Cells for more information. 5 Functional Block Master SmartShapes You can include one or more OpenLNS CT Functional Block SmartShapes in a custom master SmartShape. Each of these is called a functional block master SmartShape.
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 is added to your OpenLNS CT drawing. You have four choices: • Prompt User. The Channel Definition dialog box will appear, enabling you to select whether the channel represents a new or an existing channel. This is the default. • Automatic. OpenLNS CT will define the channel based on where you drop the subsystem SmartShape in the OpenLNS CT drawing.
You can use connection master SmartShapes to do the following: • Specify a connection with a connection description other than the default connection description. A connection description is a set of properties that apply to a connection, such as protocol service, retry count, priority, and authentication. • Establish multiple connections in a single operation.
If you drag this master SmartShape to any subsystem in the same network, OpenLNS CT creates two new functional blocks, and adds their outputs to the same Alarm connection for the Central Monitoring Station. If you also include the Central Monitoring Station in the master SmartShape, OpenLNS CT creates three new functional blocks and a new reference connection when you drag the master SmartShape to a drawing.
4. Every OpenLNS CT SmartShape has an OpenLNS CT ShapeType user cell. The value of this cell specifies the OpenLNS CT SmartShape type. You are most likely to use the DEVICE (LonMakerShapeType 4), FUNCTIONAL_BLOCK (type 5), and FB_NAME (type 13) SmartShape types. 5. You can use the FB_NAME value to include a functional block within a group that may include other functional block SmartShapes. Set the ShapeType value to 13 for SmartShapes in the group with text that reflects the functional block name.
• A value of 0 indicates no. • A value of 1 indicates yes. • A value of 2 indicates that the OpenLNS CT user will be prompted. The default value is 2 to prompt the user. ChanTypeList A semicolon-separated list of valid channel type IDs for the device. A value of -1 in the list indicates that the user has the option of selecting from all channels in addition to the channels of the specific types defined. Channel type IDs correspond to the ChannelTypeNumber values contained in the StdXcvr.
The scope selector definitions are: 0 Standard functional profile defined in the standard resource file set. 3 User-defined functional profile, defined in a manufacturer-specific resource file set. 4 User-defined functional profile, defined in a manufacturer and device class specific resource file set. 5 User-defined functional profile, defined in a manufacturer and device class/subclass specific resource file set.
NewAdvPropCap NewPropCap NonGrpRcvTimer NxeName ObjStateStyle 312 Specifies handling of the advanced properties dialog in the new device wizard. • A value of 0 specifies that the advanced properties dialog is not to be displayed. • A value of 1 indicates that the advanced properties dialog is to be displayed, but cannot be modified. • A value of 2 indicates that the advanced properties dialog is displayed and changes can be made.
• A value of 1 indicates that the style applies to the SmartShape’s lines. • A value of 2 indicates that the value applies to the SmartShape’s fill. • A value of 4 indicates that the style applies to the SmartShape’s text. You can add values together to specify combinations. For example, a value of 6 indicates that the style applies to the SmartShape’s fill and text, but not its lines. By default, the style applies to all three SmartShape attributes. PingClass Specifies the ping interval.
and TmplName values. Additional Functional Block User Cells You can include the following additional user cells in a functional block SmartShape. Not every functional block has all of these cells, but you can add any of them by right-clicking an existing user-defined cell and selecting Insert Row. DevProgIDList Specifies a semicolon-separated list of program IDs that are valid for this functional block. If both DevProgIDList and DevTypeList values are specified, the DevTypeList value takes precedence.
Additional Router SmartShape User Cells You can include the following additional user cells in a router SmartShape. Not every router has all of these cells, but you can add them by right-clicking an existing user-defined cell and selecting Insert Row. Class Specifies the type of router. Valid values are as follows: 0 1 2 3 4 5 Configured router Learning router Repeater Bridge Permanent Repeater Permanent Bridge The default and recommended value is 0 for a configured router.
5. Open the Insert menu, point to Picture, and then click From File. Select a bitmap file. Position the bitmap on the device as desired. Close the Group window. 6. Click the bitmap, open the Format menu, and then click Behavior. Clear the three check boxes under the Selection Highlighting box. 7. Open the Windows menu and then click Show ShapeSheet. The ShapeSheet opens. In the Protection section, enter 1 in the LockTextEdit cell. Close the ShapeSheet. 8.
Appendix A Setting OpenLNS CT Default Options This appendix documents the OpenLNS CT Default Options you can set either in the OpenLNS CT Design Manager or in your OpenLNS CT drawing.
Setting OpenLNS CT Default Options You can set OpenLNS CT Default Options either in the OpenLNS CT Design Manager or in your OpenLNS CT drawing. For new networks, you can set the default options in the Default OpenLNS CT Options tab in the OpenLNS CT Design Manger. For an existing network, you can set them in the OpenLNS CT drawing by clicking Add-ins, pointing to OpenLNS CT, and then clicking OpenLNS CT Options.
You can click Restore Defaults to reset all the options and values in the currently displayed options category to their defaults. Every default OpenLNS CT option has one of the following three scopes that determine which networks and OpenLNS CT computers are updated when you change the value of an option: • Current network, current OpenLNS CT computer. Value is updated in the network on the OpenLNS CT computer in which the change was made. • Current network, all OpenLNS CT computers.
(even those files that are not resource files or are not used in the OpenLNS CT drawing) will be copied into that new Import folder prior to creating the OpenLNS CT backup. Files outside the LONWORKS Import folder will not be backed up, even if they have been used in the OpenLNS CT drawing. Scope: All networks, current OpenLNS CT computer Backup Types Folder Include resource files and all other files in the LONWORKS Types folder when creating an OpenLNS CT backup file. This option is selected by default.
Auto Save Intervals Drawing Save Sets how frequently (in minutes) the OpenLNS CT drawing (.VSD) file is automatically saved. The default value is 60 minutes. To disable this feature, set the interval to 0. Scope: All networks, current OpenLNS CT computer Database Backup Sets how frequently (in minutes) OpenLNS CT will automatically create a hot backup of the OpenLNS database. The default value is 0 (never).
settings of the Overwrite Read-only Files and Overwrite More Recent Files check boxes This option is selected by default, and it is unavailable if either the Overwrite Read-only Files or Overwrite More Recent Files check boxes are selected. Scope: All networks, current OpenLNS CT computer Periodic Backup Options Interval in Days Sets the number of days between periodic OpenLNS CT backups. The backup will be automatic or manual depending on the Prompt Before Creating Backup setting.
The Configuration Properties category contains the following options. Enable Configuration Properties Enables access to configuration properties. This option is selected by default. Also enables automatic extension record copying. When this check box is selected, a device’s extension records that are marked for copying will automatically be copied when you create a new device by copying an existing one and when you create a new custom device master SmartShape.
Copy Values on Functional Block Copy Copies CP values when creating a new functional block from a master SmartShape or from another functional block. This check box is only available if the Enable Configuration Properties check box has been selected, and it is selected by default.
Device Options The Device category contains the following options. Device Options XIF Search Path Specifies the path that OpenLNS CT uses to search for device interface (XIF) files. You can enter multiple directories by separating them with semicolons. Scope: All networks, current OpenLNS CT computer NXE/APB Search Path Specifies the path that OpenLNS CT uses to search for device application files (.NXE and .APB extensions). You can enter multiple directories by separating them with semicolons.
Scope: All networks, current OpenLNS CT computer Prompt for Device State During Commissioning Remove Unreferenced Device Templates Includes the window in the Commissioning Device Wizard for setting the initial state of application device/router applications and the source of device configuration property values. This option is selected by default. If this check box is cleared, this window will be skipped. The initial device state will be determined by the current setting in the New Device Options box.
commissioned. You have two choices: • Online. The router will forward packets between the channels connected to it. Use this setting to ensure routers are operational as they are commissioned. This is the default. • Offline. The router will not forward packets between the channels connected to it. Scope: Current network, all OpenLNS CT computers Commission After Creation Selects the check box to commission new devices and routers on the first page of their respective wizards.
Device Selection block SmartShape, thereby skipping the Functional Block wizard. This option is cleared by default. The functional block SmartShape must contain a functional block type specification for this feature to work. This feature will therefore not work for the Functional Block SmartShape in the OpenLNS CT Basic Shapes stencil. To accelerate network design, create custom device master SmartShapes for each of the functional block types that you typically use.
is Deleted You have three choices: • No. The dynamic network variable is not deleted. • Yes. The dynamic network variable is automatically deleted. • Ask. OpenLNS CT will prompt you to decide whether to delete the dynamic network variable. This is the default. Scope: All networks, current OpenLNS CT computer Reference Shape Alignment Horizontal Alignment Select how OpenLNS CT aligns reference connection SmartShapes.
General Options The General category contains the following options. Confirm Deletes Prompts you to confirm the deleting of an OpenLNS CT SmartShape. This option is selected by default. Scope: Current network, current OpenLNS CT computer Force Wizard Prompts Displays all wizards when you create a new OpenLNS CT SmartShape, regardless of the settings of any other options. This option is cleared by default.
selected by default. Scope: Current network, current OpenLNS CT computer Automatically upgrade Visio drawings to current version Automatically upgrades an OpenLNS CT drawing to the current version of Visio you are using, if possible. This option is selected by default. Disable plug-in pre-launch Disables the pre-launching of plug-ins when an OpenLNS CT drawing is opened. This option is cleared by default.
The OpenLNS Event category contains the following options. The changes you make in the OpenLNS Events options category are all applied to the current network on your computer. Device/router Commission and Attachment Events Device Interface Change Events Connection Change Events Device/router Change Events Subsystem Change Events Device Template Change Events 332 Updates the OpenLNS CT drawing when devices or routers are attached to the network, detached, commissioned, or decommissioned.
Channel Change Events Updates the OpenLNS CT drawing when channels are added, removed, or modified. This option is selected by default. Scope: Current network, current OpenLNS CT computer Naming Options The Naming category contains the following options. The changes you make in the Naming options category are applied to the current network on your computer. Naming Options Controls how OpenLNS CT constructs a unique name for new OpenLNS CT SmartShapes.
Name/instance ID Separator Character Selects the character to be inserted between the OpenLNS CT SmartShape name and the instance ID. The choices are Space ( ), Underscore (_), Dash (-), Exclamation Point (!), and Hash (#). The default separator character is Space ( ). For example, the default name of the first analog input (AI-) LonPoint device added to your OpenLNS CT drawing with a space ( ) selected as the separator character is AI- 1.
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 Network Explorer to navigate, view, and modify the subsystems, devices, and device templates in your network design. The Network Explorer category contains the following options. The changes you make in the Network Explorer options category are applied to all networks on your computer.
subsystems, devices, functional blocks, and network variables in the OpenLNS CT network. Scope: All networks, current OpenLNS CT computer NV Browser/Monitoring Options The NV Browser/Monitoring category contains the following options. NV Browser/Monitoring Options Catalog Directory Specifies the directory containing resource files (.TYP, .FMT, .FPT, and language files). The default directory is LONWORKS\Types.
client. To remove the monitor sets, use the Remove Monitor Sets command from the Network Service Devices command on the OpenLNS CT menu. Scope: All networks, current OpenLNS CT computer Disable ActiveX Control Design Mode Warning Disables the warning that opens when you drag an ActiveX control to your OpenLNS CT drawing. Dragging an ActiveX control to your OpenLNS CT drawing puts OpenLNS CT in design mode, which affects the behavior of all ActiveX controls. This check box is cleared by default.
The OpenLNS CT Font category contains the following options. OpenLNS CT Font Name Displays the name of the current OpenLNS CT font. The default value is Arial. Scope: Current network, current OpenLNS CT computer Size Displays the size of the current OpenLNS CT font. The default value is 8 points. Scope: Current network, current OpenLNS CT computer Change Opens a dialog in which you can change the font, size, or style of the OpenLNS CT font.
The Recovery category contains the following options. The changes you make in the Recovery options category are applied to the current network on all OpenLNS CT computers.
will not be stored in the device. Scope: Current network, all OpenLNS CT computers Set Location Property to Subsystem ID Stores the subsystem ID in the location field of an application device and router when the device is commissioned.
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 received by OpenLNS CT when you press the device’s service pin. This option is cleared by default. You can change this option when you commission a device or router in the Commission Device/Router Wizard.
Scope: Current network, all OpenLNS CT computers Shape ToolTips Options You can enable a ToolTip to appear when the mouse pointer is over an OpenLNS CT SmartShape in your OpenLNS CT drawing and select the type of data that opens in the ToolTip. Using a device for example, you can set a ToolTip to display any or all of the following data items when the mouse pointer is over its SmartShape: SmartShape name, template name, network variable alias data, Neuron ID, Subnet/Node ID, and OpenLNS handle.
Synchronization Options The Synchronization category contains the following options. Automatic Update Interval (Seconds) Maximum Log Entries per Drawing File Sets how frequently (in seconds) an OpenLNS CT client checks the OpenLNS CT Event Log and updates its copy of an OpenLNS CT drawing to incorporate any changes made by other clients. The default automatic update interval is 10 seconds. Set the interval to 0 to disable automatic updates.
Warnings Options The Warnings category contains the following options, which are all selected by default. Enable Warning When New Device Requires Commissioning Enable Warning When Functional Block has no Matching Device Displays a message when you create a new device that needs to be commissioned. Scope: Current network, current OpenLNS CT computer Displays a message when you drag a functional block SmartShape onto a drawing but there is no compatible device on the drawing page.
you are only temporarily using a different network interface, you may choose not to upgrade. In this case, communication with physical devices is limited until you reopen the network with the original network interface. If initially you choose not to upgrade the NSD and decide later to upgrade, right-click the NSD SmartShape, and then click Upgrade NSD on the shortcut menu.
Appendix B Glossary This appendix provides definitions for terms commonly used with OpenLNS CT.
Glossary Acknowledged Service A service of the ISO/IEC 14908-1 Control Network Protocol that ensures a message was received by the addressee(s). After a configurable number of retries, failures are logged in a status register in the device, which can be accessed by network management tools. Actuator Any component that affects a physical variable of a system under control or indicates the values of system variables for human operators.
or, for Neuron-hosted devices, you may load it into the device from application files (.nld, .apb, and .nxe extensions) using OpenLNS CT. The application program interfaces with the ISO/IEC 14908-1 protocol stack to communicate over the network. It may reside completely in the Smart Transceiver or Neuron Chip, or it may reside on an attached host processor (in a host-based device). Applicationless A state a device enters when it has determined that it does not have a valid application image.
Channel Segment A portion of a channel. A single segment can be comprised of multiple sections connected by physical layer repeaters. Channel Type Channels are categorized into channel types, which are characterized by the device transceiver. Common channel types include the following: TP/FT-10 (ISO/IEC 14908-3 twisted pair free topology channel), TP/XF-1250 (high-speed twisted pair channel), PL-20 (ISO/IEC 14908-2 power line channel), FO-20 (ANSI/CEA-709.
Control Network Protocol (CNP) A communication protocol standard for control networks defined by the ISO/IEC 14908-1 standard. The CNP provides a standard method for devices on a LONWORKS network to exchange data. The CNP defines the format of the messages being transmitted between devices, and it defines the actions expected when one device sends a message to another. The protocol normally takes the form of embedded software or firmware code in each device on the network.
Device Template A device template contains all the attributes of a given device type, such as its functional blocks, network variables, and configuration properties. You can create a device template by importing a device interface (XIF) file supplied by the device manufacturer, or by uploading the device interface definition from the physical device. A device template is identified by its name and its program ID.
Dynamic Network Variable A network variable that is added to a functional block after the device has been commissioned. Devices that support dynamic network variables include controllers and gateways with dynamic interfaces. Engineered System Scenario A control network installation scenario in which configuration data is collected into the network database when the system is being designed with OpenLNS CT and downloaded into the physical devices when the network is installed.
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-configured group of devices. Each group has an 8-bit group ID. Each domain can have up to 256 groups defined. Host A device implementing layer 7 of the ISO/IEC 14908-1 Control Network Protocol. A host may be based on a Smart Transceiver or Neuron Chip, in which case it is called a Neuron hosted device.
IP-852 Network Interface Software that enables IP-852 devices such as OpenLNS Server computers, OpenLNS CT computers, IP-852 routers, and native IP-852 devices to be attached to an IP-852 channel. An IP-852 network interface requires that the IP-852 Configuration Server be configured before trying to communicate with remote devices or remote computers. IP-852 routers include the SmartServer, i.LON 100 Internet Server, and i.LON 600 IP-852 Router.
devices use network variables to communicate with one another since they are interoperable and produce more efficient code. Message tags are similar to network variables except that they do not have pre-defined types. Monitor Set A group of data points that OpenLNS CT uses to monitor and control network variables or message tags. Monitored Connection A connector SmartShape or reference connection on which network variable values are displayed and updated.
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 Variable/Configuration Property Types A network variable or configuration property type defines the structure and contents of the object. A network variable type can be either a standard network variable type (SNVT) or a user-defined network variable type (UNVT).
Node Object A functional block that monitors the status of all functional blocks in a device and makes the status information available for monitoring by OpenLNS CT. A LONMARK-compliant device that has more than one functional block must have a Node object. NodeBuilder Tool A hardware and software platform used to develop applications for Smart Transceivers and Neuron Chips. Non-Volatile RAM Read/write processor memory that does not lose its contents when electrical power is removed.
OpenLNS Event An action fired by an OpenLNS Server to notify an OpenLNS client application of a change to the OpenLNS network. OpenLNS CT uses OpenLNS events to keep it synchronized with other OpenLNS applications or plug-ins that are making changes to the network database. OpenLNS Network Database A database (also referred to as the network database), which includes the network and device configuration data for the devices in a LONWORKS network.
OpenLNS Commissioning Tool (CT) An OpenLNS network tool that uses Visio as its graphical user interface. OpenLNS CT is used to design, commission, maintain, and document distributed control networks comprised of both LONMARK and other LONWORKS devices. OpenLNS CT Layers Separate views for the physical, logical, and data components in an OpenLNS CT network that can be used to hide and show parts of an OpenLNS CT drawing.
master controller. Because of the enhanced system reliability introduced by eliminating the master (a single point of failure) and the reduced installation and configuration cost inherent in peer-to-peer designs, LONWORKS technology supports but does not require a peer-to-peer control strategy. Physical Medium A communication environment that carries the modulated signals from sources to destinations in a network.
Resource File A file included with a LONWORKS device that defines the components of the device interface to be used by OpenLNS CT. Defined components include functional blocks, network variables, and configuration properties implemented by the device application. Resource files allow for the correct interpretation and formatting of the data, and they are necessary for LONMARK certification of a device.
under software control as long as the device is configured. For example, the device can ground the pin when the device is moved or when a predefined series of I/O occurs. The service pin can also be used to drive an LED that indicates the Smart Transceiver’s or Neuron Chip's state.
Supernode A subsystem with a network variable interface. Supernodes enable a group of devices to be organized into logical units with selected network variables from the devices within the supernodes. This allows complex subsystem details to be hidden, reduces errors, and decreases the time required for network engineering and commissioning. A supernode’s network variable interface may contain any network variable on any device found within the supernode or its nested subsystems.
format, in order to allow the devices to be configured without the need for proprietary configuration tools. User-defined Network Variable Type (UNVT) A non-standard network variable type defined by the manufacturer of a LONWORKS device. UNVTs should be used only when there is no appropriate standard network variable type (SNVT) defined. LONMARK-certified devices must have UNVTs documented in resource files according to a standard format, in order to allow the devices to be interoperable.
366 Appendix C – OpenLNS CT Software License Agreement
Appendix C OpenLNS Software License Agreement This appendix provides a copy of OpenLNS CT Software License Agreement.
OpenLNS CT Software License Agreement Echelon OpenLNS Commissioning Tool (CT) Software License Agreement I. NOTICE This OpenLNS Commissioning Tool (CT) Software License Agreement (the "Agreement") is enterered between you ("You" or "Your") and Echelon Corporation ("Echelon"). YOU MUST READ AND AGREE TO THE TERMS OF THIS AGREEMENT BEFORE DOWNLOADING, INSTALLING, OR USING THE ECHELON OPENLNS COMMISSIONING TOOL SOFTWARE (THE "LICENSED SOFTWARE").
• "Trial Period" is a 60-day period during which the Licensed Software can be used with limited functionality for a maximum of two networks, with a maximum of five devices per network, and a maximum run time of 60 minutes. • "Use Period" means a time period during which you can use the Licensed Software. The Use Period is limited to the Trial Period for Trial Editions of the Licensed Software, and is unlimited for all other editions Licensed Software.
Echelon with a copy of same upon request; this right of transfer is exercisable no more than one (1) time every year. V.
The functionality of the Microsoft Visio product as integrated in specified editions of the Licensed Software may differ from a non-integrated Microsoft Visio product and any issues concerning the functionality or performance of the Echelon OpenLNS Commissioning Tool and the integrated Microsoft Visio product should be directed to Echelon and not to Microsoft Corporation. VII. TERMINATION This License will continue until terminated by either party in writing.
$1000). YOU HEREBY AGREE THAT THE FOREGOING LIMITATIONS REFLECT THIS REASONABLE ALLOCATION OF RISK. XI. SAFE OPERATION YOU ASSUME THE SOLE RESPONSIBILITY FOR, AND HEREBY AGREE TO USE YOUR BEST EFFORTS IN, DESIGNING, MANUFACTURING, COMMISSIONING, ROUTING, MONITORING, AND CONTROLLING DEVICES USING THE ISO/IEC 14908-1 PROTOCOL TO PROVIDE FOR SAFE OPERATION THEREOF, INCLUDING, BUT NOT LIMITED TO, COMPLIANCE OR QUALIFICATION WITH RESPECT TO ALL SAFETY LAWS, REGULATIONS AND AGENCY APPROVALS, AS APPLICABLE.
expense and are deemed to be "commercial computer software" and "commercial computer software documentation", respectively, pursuant to DFAR Section 227.7202 and FAR 12.212(b), as applicable. Any use, modification, reproduction, release, performance, display or disclosure of the Licensed Software and/or the accompanying documentation by the U.S.
374 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. To do this, you and the other party must sign the agreement in this appendix.
Software License Transfer Agreement THIS SOFTWARE LICENSE TRANSFER AGREEMENT is entered into as of : (Date) by and between “Assignor” ______________________________________ (Company name of original purchaser) and "Assignee" _____________________________________ (Name of company purchasing the software) for the transferred “Software” _____________________________________ (Name of software product being transferred) 1. Software License Agreement.
www.echelon.
