Echelon OpenLNS User Manual

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.

Neuron

Chips and other OEM Products were not

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

Chips in such applications.

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

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

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

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

ii Preface

Table of Contents

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

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

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

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

OpenLNS CT Documentation.........................................................................xii

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

Content..........................................................................................................xv

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

Introduction to the OpenLNS Commissioning Tool.........................................2

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

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

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

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

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

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

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

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

New OpenLNS CT Menus ........................................................................3

OpenLNS CT Versions....................................................................................4

OpenLNS CT Network Designs.......................................................................4

OpenLNS Network Database....................................................................4

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

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

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

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

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

Device Templates .....................................................................................5

Channels...................................................................................................5

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

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

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

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

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

Functional Profiles.....................................................................................7

Standard Network Variable and Configuration Property

Types..................................................................................................

User-defined Standard Network Variable and Configuration Property

Types..................................................................................................

Subsystems...............................................................................................8

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

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

8
8

2 Installing and Activating OpenLNS CT.......................................... 11

Ordering OpenLNS CT..................................................................................12

Installing and Activating OpenLNS CT..........................................................12

Manually Activating OpenLNS CT.................................................................19

3 Getting Started ................................................................................ 25

Design Overview ...........................................................................................26

Defining Network Requirements and Organization.................................26

Selecting a Network Installation Scenario ..............................................26

Engineered System Scenario...........................................................26

OpenLNS CT User’s Guide iii

Ad-Hoc System Scenario .................................................................27

Determining User Permissions ...............................................................27

Optimizing OpenLNS CT Network Performance ....................................27

Drawing Files....................................................................................27

Network Changes.............................................................................28

Connections......................................................................................28

Sharing the OpenLNS Interface with the LNS DDE Server .............28

Functional Blocks .............................................................................28

Subsystems......................................................................................29

OpenLNS CT Design Manager Overview .....................................................29

Options....................................................................................................32

New Network Options.............................................................................34

OpenLNS CT Stencils.............................................................................36

OpenLNS CT Default Options.................................................................37

Setting Up a Network Interface......................................................................38

Optimizing Network Interface Performance............................................38

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

Creating and Opening OpenLNS CT Networks.............................................40

Creating an OpenLNS CT Network Design............................................40

Working with Digital Signatures........................................................46

Creating an OpenLNS CT Network from an Existing OpenLNS

Database..................................................................................................

Copying an OpenLNS CT Network Design.............................................51

Opening an OpenLNS CT Network Design............................................53

OpenLNS CT Client Types .....................................................................55

Local Client.......................................................................................55

Remote Full Client............................................................................56

Remote Lightweight Client................................................................60

Using Network Service Device SmartShapes...............................................63

Listing Network Service Devices......................................................64

Upgrading Network Service Devices................................................65

Replacing a Local Network Service Device......................................66

User Profiles..................................................................................................66

Creating a New User Profile ...................................................................67

Changing Passwords..............................................................................69

Modifying and Deleting User Profiles......................................................70

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

Using OpenLNS CT Remotely with User Profiles...................................71

47

4 Designing Networks........................................................................ 73

Creating a LONWORKS Network.....................................................................74

Creating an OpenLNS CT Drawing...............................................................74

Creating Application Devices..................................................................75

Using Automatic Channel Selection for Devices..............................79

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

Creating Functional Blocks.....................................................................81

Using Automatic Device Selection ...................................................85

Reassigning a Functional Block .......................................................85

Configuring a Functional Block.........................................................86

Copying a Functional Block Configuration .......................................86

Creating a New Functional Block from a Configured

Functional Block.........................................................................

Updating a Functional Block from a Configured Functional

Block ..........................................................................................

Creating a Functional Block Master SmartShape ............................89

Creating Dynamic Functional Blocks................................................89

iv Preface

86
86

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 ..........................................................................................

Deleting Message Tag SmartShapes........................................92

Creating Network Variables....................................................................92

Creating a Network Variable SmartShape .......................................93

Creating a Network Variable Master SmartShape...........................93

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

Creating Network Variables Using Generic Network

Variable SmartShapes...............................................................

Creating Dynamic Network Variables Using Network
Variables SmartShapes from the OpenLNS CT NV

SmartShapes Stencil .................................................................

Creating Dynamic Network Variables Using Network

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

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

Changing Network Variable Position................................................99

Deleting a Network Variable SmartShape........................................99

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

Creating a Router........................................................................................101

Using Automatic Channel Selection for Routers............................105

Changing a Router Channel...........................................................106

Creating a Channel......................................................................................106

Creating a Subsystem.................................................................................108

Creating a Supernode...........................................................................110

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

Copying a Subsystem or Supernode....................................................111

Creating Connections..................................................................................112

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

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

Creating a Connection with the Network Variable Connection

Dialog Box.............................................................................................

Using Reference Connection SmartShapes.........................................117

Aligning Reference Connection SmartShapes...............................117

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

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

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

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

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

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

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

Hiding and Showing Connector SmartShapes .....................................124

Hiding and Showing All Connector SmartShapes in a

Subsystem......................................................................................

Hiding and Showing Selected Connector SmartShapes

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

Hiding and Showing Connector SmartShapes Attached

to a Functional Block......................................................................

Viewing and Navigating OpenLNS CT Network Design..............................128

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

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

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

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

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

92

94

98
98

114

124
124
126

OpenLNS CT User’s Guide v

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

Managing and Editing Device Templates with the Network

Explorer ..........................................................................................

Managing Device Templates ...................................................132

Editing Device Template Properties.........................................133

Working with OpenLNS CT Layers .............................................................135

Working with OpenLNS CT SmartShapes ..................................................136

Viewing and Setting OpenLNS CT SmartShape Properties.................136

Moving an OpenLNS CT SmartShape..................................................136

Repositioning an OpenLNS CT SmartShape.................................136

Changing the Subsystem for an OpenLNS CT SmartShape.........136

Changing the Channel for an OpenLNS CT SmartShape..............137

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

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

Copying an OpenLNS CT SmartShape................................................140

Deleting an OpenLNS CT SmartShape................................................140

Customizing the User Interface...................................................................141

Editing the Title Block ...........................................................................141

Using OpenLNS CT SmartShape Menus .............................................141

Using AutoCAD Drawings ...........................................................................142

Importing an AutoCAD Drawing............................................................142

Exporting an AutoCAD Drawing............................................................143

132

5 Installing Networks ....................................................................... 145

Network Installation Overview.....................................................................146

Commissioning a Device.............................................................................146

Selecting Devices for Commissioning...................................................147

Loading a Device Application Image.....................................................148

Setting the Initial Device State and Source of Configuration

Property Values.....................................................................................

Setting the Initial Application Device State and Source of

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

Setting the Initial Router State........................................................153

Setting the Neuron ID ...........................................................................154

Selecting the Device Identification Method ....................................154

Using the Service Pin Method........................................................155

Using the Manual Entry Method.....................................................157

Entering a Neuron ID Manually................................................157

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

Commissioning an IP-852 Router ...............................................................158

Commissioning Using Device Discovery.....................................................158

150
151

6 Monitoring and Controlling Networks......................................... 165

Monitoring and Controlling Overview ..........................................................166

Using Monitored Connections .....................................................................166

Displaying a Network Variable Value....................................................167

Using the OpenLNS CT Browser ................................................................168

Starting the OpenLNS CT Browser.......................................................168

The OpenLNS CT Browser Toolbar......................................................170

Customizing the Browser......................................................................170

Customizing Browser Columns ......................................................171

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

Adjusting the Width of Browser Columns ................................171

Customizing Browser Rows............................................................171

Selecting Browser Rows to be Displayed................................171

Hiding Browser Rows...............................................................172

vi Preface

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...........................................................................174

Binding Network Variables to the Host .................................................174

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

Setting Values ................................................................................175

Setting Values for Structured Objects......................................175

Setting Values for Configuration Property Arrays....................177

Clearing Values..............................................................................178

Getting Values................................................................................178

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

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

Displaying Error Messages...................................................................181

Managing Functional Blocks.................................................................181

Using Data Point SmartShapes...................................................................182

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

Updating a Data Point...........................................................................185

Updating a Scalar Data Point.........................................................186

Updating a Structured Data Point...................................................186

Updating an Enumerated Data Point..............................................187

Getting a Data Point Value ...................................................................187

Creating and Using a Custom Data Point Master SmartShape............188

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

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

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

Deleting a Data Point SmartShape.......................................................189

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

Writing Data Point SmartShape Values .........................................190

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

Using a Macro to Write Values ................................................191

Reading Data Point SmartShape Values.......................................192

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

Using a Macro to Read Values................................................193

Organizing HMIs.............................................................................194

7 Maintaining Networks................................................................... 195

Maintaining Networks Overview..................................................................196

Loading Devices..........................................................................................196

Selecting the Devices to Load ..............................................................197

Selecting or Creating a Device Template .............................................197

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

Selecting Initial Device State and Source of Configuration

Property Values.....................................................................................

Replacing Devices.......................................................................................202

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

Replacing a Device in the OpenLNS CT Network................................202

Removing the Old Device.....................................................................205

Decommissioning Devices ..........................................................................205

Resynchronizing Configuration Properties..................................................205

Using OpenLNS CT as a Passive Configuration Tool.................................207

Backing up an OpenLNS CT Network Design.............................................207

Manually Backing Up an OpenLNS CT Network..................................208

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

OpenLNS CT User’s Guide vii

200

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.................................216

Restoring a Full Network Backup...................................................217

Recovering an OpenLNS CT Network ........................................................221

Subsystem Recovery Options...............................................................222

Using Subsystem Paths .................................................................224

Using Subsystem IDs.....................................................................224

Using the OpenLNS Database Recovery Wizard.................................225

Network Recovery vs. Database Backup ............................................234

Resynchronizing an OpenLNS CT Network................................................235

Automatic OpenLNS CT Drawing Synchronization ..............................235

OpenLNS Event Tracking...............................................................236

OpenLNS CT Event Log.................................................................236

Viewing the OpenLNS CT Event Log ......................................236

Exporting the OpenLNS CT Event Log....................................237

Manual Network Resynchronization .....................................................239

Refreshing the OpenLNS CT Network..................................................247

Merging OpenLNS CT Networks.................................................................247

Network Merge Considerations.............................................................248

Limitations ......................................................................................248

Information Loss.............................................................................248

Merging OpenLNS CT Networks ..........................................................249

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

Using the OpenLNS CT Device Manager ...................................................254

Opening the OpenLNS CT Device Manager ........................................254

Managing Devices.................................................................................255

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

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

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

Using OpenLNS CT Styles Overview..........................................................260

OpenLNS CT Device Styles..................................................................260

OpenLNS CT Functional Block Styles..................................................261

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

OpenLNS CT Connector SmartShape Styles.......................................263

Generating a Device Status Summary Report............................................264

Using Resource Usage Reports..................................................................267

Network Resource Report.....................................................................267

Alias Table Summary............................................................................268

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

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

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

Viewing an OpenLNS CT Network Report............................................274

Importing a LONWORKS Network XML File............................................277

10 Managing OpenLNS CT Licenses................................................ 279

Commissioning Devices with OpenLNS CT................................................280

Overview of OpenLNS CT Licensing...........................................................280

Maintaining OpenLNS CT............................................................................280

viii Preface

Upgrading OpenLNS CT Standard Edition to OpenLNS CT

Professional Edition.....................................................................................

Renewing OpenLNS CT Annual Maintenance............................................289

Transferring OpenLNS CT Licenses ...........................................................289

286

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

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

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

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

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

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

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

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

Enabling a Plug-in.................................................................................299

12 Creating and Using Custom OpenLNS CT SmartShapes

and Stencils...................................................................................

OpenLNS CT Stencils .................................................................................302

Creating a Custom OpenLNS CT Stencil....................................................302

Creating Custom OpenLNS CT Master SmartShapes................................303

Using Custom OpenLNS CT Master SmartShapes....................................304

Device Master SmartShapes................................................................304

Functional Block Master SmartShapes.................................................305

Subsystem or Supernode Master SmartShapes ..................................305

Connection Master SmartShapes.........................................................306

Creating Additional Channels ...............................................................308

Editing Master SmartShape User Defined Cells .........................................308

Additional Device User Cells.................................................................309

Additional Functional Block User Cells.................................................314

Additional Router SmartShape User Cells............................................315

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

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

Viewing and Editing VBA Code Associated with an OpenLNS CT

Network Drawing.........................................................................................

301

316

Appendix A Setting OpenLNS CT Default Options.......................... 317

Setting OpenLNS CT Default Options.........................................................318

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

Configuration Properties Options..........................................................322

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

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

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

OpenLNS Event Options.......................................................................331

Naming Options ....................................................................................333

Network Explorer Options.....................................................................335

NV Browser/Monitoring Options............................................................336

OpenLNS CT Font Options...................................................................337

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

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

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

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

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

Appendix B Glossary......................................................................... 347

Appendix C OpenLNS Software License Agreement...................... 367

OpenLNS CT User’s Guide ix

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

x Preface

Preface

The OpenLNS Commissioning Tool (OpenLNS CT) is a software package for

designing, installing, and maintaining multi-vendor, open, interoperable L

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. OpenLNS CT, OpenLNS Server, and the OpenLNS

SDK are the three primary components of OpenLNS. OpenLNS CT complies with
the OpenLNS plug-in standard, and it is compatible with the LNS plug-in standard,

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

many other vendors.

ONWORKS

®

OpenLNS CT User’s Guide xi

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.

System Requirements

System requirements for computers running the OpenLNS CT are as follows:

• Microsoft Windows

with Service Pack (SP) 1, or Windows XP with SP3 (32-bit).

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

• 2 GB or more of free disk space.

• 512 MB RAM. 2 GB RAM recommended.

®

7 (64-bit and 32-bit), Windows Server 2008 SR2 64-bit, Windows Vista®

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

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

• Mouse or compatible pointing device

• DVD-ROM drive.

• OpenLDV 4.0-compatible local, remote, or IP-852 network interface.

o Compatible local network interfaces include the U10/U20 USB network interface; PCC-10,

PCLTA-20, or PCLTA-21 network interface cards; and the SLTA-10 Serial LonTalk Adapter.
The PCC/PCLTA and SLTA-10 network interfaces are compatible with 32-bit versions of
Windows only.

o Compatible remote network interfaces include the SmartServer, i.LON 100 Internet Server,

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

o Compatible IP-852 network interfaces include the SmartServer (with IP-852 routing option),

i.LON 100 Internet Server (with IP-852 routing option), and i.LON 600 IP-852 Router.

OpenLNS CT Documentation

The documentation for OpenLNS CT is provi de d as Adobe Acrobat PDF files and online help files.
The PDF file for this document is installed in the Echelon OpenLNS CT program folder when you
install the Echelon OpenLNS CT software. You can also download the latest OpenLNS
documentation, including the latest version of this guide, by going to the Echelon OpenLNS Web site

www.echelon.com/openlns.

at

OpenLNS CT XML Programmer’s
Guide

OpenLNS Programmer’s Guide

xii Preface

Describes how to create and modify an OpenLNS network using
the OpenLNS XML Plug-in.

Describes how to use the OpenLNS Object Server ActiveX
Control to develop OpenLNS apps.

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.

®

Plug-in Framework Developer’s

LNS
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. You can download th ese
documents from Echelon’s Web site at

www.echelon.com/docs.

i.LON 600 LonWorks/IP Server User's
Guide

Introduction to the L

ONWORKS

®

Platform

Describes how to install, configure, use, and manage the i.LON
600 IP-852 routers, and how to use the Echelon IP-852
Configuration Server.

Provides a high-level introduction to L

ONWORKS networks and

the tools and components that are used for developing, installing,
operating, and maintaining them.

IP-852 Channel User’s Guide Describes how to configure an IP-852 channel with the Echelon

IP-852 Configuration Server. You will need this information if

you plan on attaching your OpenLNS CT computer to an IP-852
channel.

ONMARK

L

®

SNVT and SCPT Guide

Documents the standard network variable types (SNVTs) and
standard configuration property types (SCPTs) used by

ONWORKS device applications. For more information, go the

L

ONMARK International Web site at

L
www.lonmark.org/technical_resources/resource_files.

L

ONWORKS

®

User’s Guide

USB Network Interface

Describes how to install and use the U10 and U20 USB Network
Interfaces to connect an OpenLNS or OpenLDV application to a

ONWORKS network.

L

Mini FX User’s Guide Describes how to use the Mini kit to develop a prototype or

production control system that requires networking, particularly
in the rapidly growing, price-sensitive mass markets of smart
light switches, thermostats, and other simple devices and sensors.

NodeBuilder

®

FX User’s Guide

Describes how to use the NodeBuilder tool to develop

ONWORKS device applications and build and test prototype and

L
production L

ONWORKS devices

PCC/PCLTA Network Interface User's
Guide

Describes how to install, configure, and test the PCC-10,
PCLTA-20, and PCLTA-21 network interface cards that you can
use to connect an OpenLNS or OpenLDV application to a

ONWORKS network.

L

SmartServer 2.0 User’s Guide Describes how to configure the SmartServer and use its

applications to manage control networks.

For More Information and Technical Support

The Echelon OpenLNS CT ReadMe document provides descriptions of known problems, if any, and
their workarounds. To view the Echelon OpenLNS CT ReadMe document, clic k Start, point to
Programs, point to Echelon OpenLNS CT, and then select Echelon OpenLNS CT ReadMe.

If you have technical questions that are not answered by this document, the OpenLNS CT online help
files, or the Echelon OpenLNS CT ReadMe document, you can contact Echelon technical support.
There is no charge for software installation-related questions during the first 30 days after you receive

OpenLNS CT User’s Guide xiii

the OpenLNS CT DVD or purchase an OpenLNS CT activation key. To receive technical support
from Echelon, you must purchase support services from Echelon or an Echelon support partner. See

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

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

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

www.echelon.com/training.

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

Region Languages Supported Contact Information

The Americas

English
Japanese

Echelon Corporation
Attn. Customer Support
550 Meridian Avenue
San Jose, CA 95126
Phone (toll-free):

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

[e-mail]

Europe

Japan

China

English
German
French
Italian

Echelon Europe Ltd.
Suite 12
Building 6
Croxley Green Business Park
Hatters Lane
Watford
Hertfordshire WD18 8YH
United Kingdom
Phone: [phone]
Fax: [phone]

[e-mail]

Japanese Echelon Japan

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

[e-mail]

Chinese
English

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

[e-mail]

Other Regions

English
Japanese

Phone: [phone]
Fax: [phone]

[e-mail]

xiv Preface

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, L

•

Installing and Activating OpenLNS CT: Describes how to order and install OpenLNS CT and
Microsoft Visio 2010, and then how to activate OpenLNS CT.

•

Getting Started: Provides information on the planning an OpenLNS CT network design; using the
OpenLNS CT Design Manager; setting up a network interface; creating and opening an OpenLNS
CT network design; OpenLNS CT client types; using OpenLNS CT remotely; and creating and
using user profiles.

Designing Networks: Describes how to design a netwo r k usi n g OpenLNS CT. Covers how to

•

create the following objects in an OpenLNS CT drawing: application devices, functional blocks,
network variables, routers, channels, and subsystems. Explains how to connect network variables.
Explains working with OpenLNS CT SmartShapes
user interface, and using OpenLNS CT with AutoCAD drawings.

•

Installing Networks: 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.

ONWORKS, and Visio.

®

and layers, customizing the OpenLNS CT

Monitoring and Controlling Netw orks: Describes how you can monitor and control the devices in

•

your network with OpenLNS CT. 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. Covers how to bind network variables
to the host in order to receive event-driven updates. Describes how to change the types and
formats of network variables and configuration properties. Explains how to create simple HMIs in
your OpenLNS CT drawing with Data Point and Visio SmartShapes.

Maintaining Networks: Provides an overview of network maintenance tasks that you can perform

•

with OpenLNS CT. Describes loading, repla ci ng, and decommissioning devices. Explains how to
resynchronize and propagate configuration properties values. Explains how to back up and restore
an OpenLNS CT network; create an OpenLNS CT network by recovering information from the
physical network; and resynchronize the network database, OpenLNS CT drawing, and physical
devices. Explains how to merge two OpenLNS CT networks.

Managing Networks: Explains how to test and verify application devices, functional blocks, and

•

routers; describes OpenLNS CT styles; and details how to generate device status summary reports,
network resource reports, and OpenLNS network reports.

Managing OpenLNS CT Licenses: Provides an overview of OpenLNS CT licensing. Describes

•

how to upgrade OpenLNS CT, upgrade an OpenLNS CT Standard Edition to the Professional
Edition, renew your OpenLNS CT annual maintenance contract, and transfer an OpenLNS CT
license.

Exporting and Importing a Network Using XML: Describes how to export a LONWORKS network

•

to an OpenLNS CT network XML file; view a LONWORKS network XML file in a Web
browser; edit an OpenLNS CT network XML file; and import a LONWORKS network XML file
to update a network.

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

•

plug-in information, and re-register, enable, and disable plug-ins.

OpenLNS CT User’s Guide xv

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.

xvi Preface

1

Introduction

This chapter provides an introduction to the OpenLNS Commissioning Tool, describes

new features, and explains the basics of OpenLNS CT Network Designs, L

ONWORKS,

and Visio.

OpenLNS CT User’s Guide 1

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
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. The OpenLNS Server
allows multiple users running OpenLNS CT and other OpenLNS tools, applications, and plug-ins on
separate computers to access the OpenLNS Server simultaneously. This means that managers, system
integrators, installers, and maintenance personnel can all work on the same L
same time. OpenLNS CT is compatible with Windows 7 (64-bit and 32-bit), Windows Server 2008 R2
(64-bit), Windows Vista with SP1 (32-bit), and Windows XP with SP3 (32-bit). The OpenLNS Server
and OpenLNS CT are backwards compatible with all existing LNS Turbo Edition databases and
LonMaker Turbo Edition drawings providing simple migration for existing LNS and LonMaker
networks.

OpenLNS CT can be used to manage all phases of a network’s life cycle—from the initial design and
commissioning to the ongoing operation. It provides the functionality of several network tools in one
single solution:

• Network Design Tool. You can design a network offsite (without actually being connected to the

network) and/or onsite, and modify it anytime.

• Network Installation Tool. You can rapidly install a network designed offsite once it is brought

onsite. The device definitions can be quickly and easily associated with their corresponding
physical devices to reduce on-site commissioning time. The OpenLNS CT Browser provides
complete access to all network variables and configuration properties.

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

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

®

2010 or Visio 2003 (Professional or

ONWORKS network at the

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

contained within the OpenLNS CT drawing.

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

New Features

This section describes the major features included with the OpenLNS Server and OpenLNS CT.

•

No-cost device installation.
Automated product activation (Internet connection required).

•

Annual product maintenance.

•

Increased device compatibility.

•

Longer database directory paths.

•

Improved Microsoft Windows® Compatibility.

•

Additional OpenLNS events.

•

New OpenLNS CT Menus.

•

No-Cost Device Installation

You can install devices without commissioning fees (known as “credits” in LNS Turbo and LonMaker
Turbo software). OpenLNS CT features no-cost installation for all L
with the ISO/IEC 14908-1 Control Network Protocol. This includes devices based on the FT 5000
Smart Transceiver, Neuron

®

5000 Processor, FT 3150®/3120® Smart Transceiver, or PL

ONWORKS devices that comply

2 Introduction

3170/3150/3120 Smart Transceiver, and also includes devices ba sed 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. When you install the OpenLNS CT
software on an Internet-connected computer, the installer automatically connects to the Echelon
License Server, the License Server issues activation licenses for OpenLNS Server and OpenLNS CT,
and the licenses are installed on your computer. If your computer does not have access to the Internet,
you can manually activate your software via e-mail or phone using the Echelon License Wizard, which
provides easy-to-follow instructions for activating Echelon software products. See Chapter 2,
Installing and Activating OpenLNS CT, for more information on installing and activating OpenLNS
CT.

Annual Product Maintenance

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

Increased Device Compatibility

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

Longer Database Directory Paths

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

Improved Windows Compatibility

The OpenLNS Server and OpenLNS CT are now installed in the C:\Program Files\LonWorks
directory by default, which is a more compatible location with Windows conventions for program file
installation. Windows has become increasingly more restrictive about default access permissions on
the computer’s root directory. These restrictions caused compatibility issues with LNS Turbo and
LonMaker Turbo Editions, which were installed in the C:\LonWorks directory by default. If you
have previously installed the LonMaker tool or other LNS application on your computer and you
already have a L

ONWORKS directory, OpenLNS CT will continue to use your existing director y.

Additional OpenLNS Events

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

New OpenLNS CT Menus

If you are using OpenLNS CT with Visio 2010, you now click Add-ins to access the options
previously available in the LonMaker menu (for example, network options, network properties,
synchronization, and documents [backup/restore, XML export/import]). This manual assumes you are
using Visio 2010—if you are using Visio 2003 , open the LonMaker menu when this document
instructs you to click Add-ins and then select the desired option.

OpenLNS CT User’s Guide 3

OpenLNS CT Versions

There are five versions of OpenLNS CT: OpenLNS CT Professional, OpenLNS CT Professional
Without Visio, OpenLNS CT Standard, OpenLNS CT Stan dar d Wit h out Vi si o, and O pe nL NS CT
Trial. OpenLNS CT Professional Without Visi o an d 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. In addition, OpenLNS CT Professional
includes Visio 2010 Professional, which contains all of the business diagramming tools of the Visio
2010 Standard edition, as well as additional comprehensive technical and drawing solutions. You can
purchase OpenLNS CT Standard and then upgrade it later to OpenLNS CT Prof essional by purchasing
the OpenLNS CT Standard to Professional Upgrade Key (Echelon model number 38070-400). The
upgrade key does not include and upgrade to Visio 2010 Professional—it only upgrades the number of
networks that you can access with OpenLNS CT. See
OpenLNS CT Professional Edition in Chapter 10 for more information.

OpenLNS CT Professional and OpenLNS CT Standard each include one-year maintenance during
which you can download and install OpenLNS CT software updates and upgrades for free. You can
renew your annual maintenance anytime before it expires by purchasing an OpenLNS CT Professional
One-Year Maintenance Renewal (Echelon model number 93800
One-Year Maintenance Renewal (Echelon model number 93810
you to continue installing software updates and upgrades. If you do not renew the product's
maintenance, you can still use the product; however, you will not be able to install updates or upg rades
released after your annual maintenance expired.

Upgrading OpenLNS CT Standard Edition to

) or an OpenLNS CT Standard
). Renewing your license enables

You can download a free trial edition of OpenLNS CT from the Echelon Web site at

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

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

OpenLNS CT Network Designs

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

OpenLNS Network Database

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

Every OpenLNS CT drawing is associated with an OpenLNS network database, and the OpenLNS
network database is always located on the computer with the OpenLNS Server. The OpenLNS Server
may be located on the same computer as OpenLNS CT, or it may be located on a different computer.
You can maintain backup copies of the OpenLNS network database, and you can move the OpenLNS
Server and OpenLNS network database to a backup computer. See

Network Design in Chapter 7, Maintaining Networks, for more information.

Backing Up an OpenLNS CT

4 Introduction

OpenLNS CT Drawing

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

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

OpenLNS CT Drawing Synchronization in Chapter 7.

Automatic

LONWORKS Basics

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

Networks

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

Devices

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

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

Protocol

A device publishes and consumes information as instructed by the application that it is running. The
applications on different devices are not synchronized, and it is possible that multiple devices may all
try to talk at the same time. Meaningful transfer of information between devices on a network,
therefore, requires organization in the form of a set of rules and procedures. These rules and
procedures are the communication protocol, which may be referred to simply as the protocol. The
protocol defines the format of the messages being transmitted between devices and defines the actions
expected when one device sends a message to another. The protocol normally takes the form of
embedded software or firmware code in each device on the network. The CNP
defined by the ISO/IEC 14908-1 standard (defined nationally in the United States, Europe, and China
by the ANSI/EIA 709.1, EN 14908, and GB/Z 20177 standards, respectively).

is an open protocol

Device Templates

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

Channels

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

OpenLNS CT User’s Guide 5

(high-speed twisted pair channel), PL-20 (ISO/IEC 14908-3 power line channel), FO-20
(ANSI/CEA-709.4 fiber optics channel), and IP-852 (ISO/IEC 14908 -4 IP-communication).

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

Routers

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

Applications

Every LONWORKS device contains an application that defines the device’s behavior. The application
defines the inputs and outputs of the device. The inputs to a device can include information sent on

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

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

The application may be in the device when you purchase it, or you may load it into the device from
application files (.nld, .apb, and .nxe extensions) using OpenLNS CT.

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

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

Network Variables

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

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

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

6 Introduction

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.

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

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

Configuration Properties

Configuration properties define how an application device behaves by determining the manner in
which data is manipulated and when it is transmitted. Configuration properties determine the functions
to be performed on the values stored in the network variables. For example, a configuration property
may specify a minimum change that must occur on a physical input to a device before the
corresponding output network vari abl e is u pd a te d. Like network variables, configuration propertie s
have types that determine the type and format of the data they contain.

Functional Blocks

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

Functional Profiles

A functional profile defines mandatory and optional network variable and configuration property
members for a type of functional block. For example, the standard functional profile for a light

OpenLNS CT User’s Guide 7

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.

Standard Network Variable and Configuration Property Types

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

• Standard Network Variable Types (SNVTs, pronounced snivits). SNVTs contain many common
operational data types. For example, SNVT_temp_p is a network variable type for network
variables containing temperature as a fixed-point number.

• Standard Configuration Property Types (SCPTs, pronounced skipits). SCPTs contain many
common configuration data types. For example, SCPT_location is a configuration proper ty type for
configuration properties containing the device location as a text string.

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

See

User-defined Standard Network Variable and Configuration Property Types

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

Subsystems

Devices, routers, and functional blocks are contained in subsystems. With OpenLNS CT, each
subsystem corresponds to one page within an OpenLNS CT drawing. Subsystems allow you to place
devices, routers, and functional blocks onto separate pages for organizati onal pu rp oses . You m a y also
nest subsystems in other subsystems, allowing you to create a subsystem hierarchy for large networks.
For example, a network may consist of HVAC, lighting, security, and operator subsystems. These may

8 Introduction

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. This structure reduces errors and decreases the time required for network engineering and
commissioning. A network variable interface for a supernode may contain any network variable on
any device functional block found within the supernode or in any of its nested subsystems.

Visio Basics

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

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

®

. OpenLNS includes

To simplify finding and reusing shapes, Visio defines a special type of drawing called a stencil. A
shape contained on a stencil is called a master shape. When you drag a master shape from a stencil to
one of your drawing pages, Visio automatically makes a copy of the master shap e on your drawing and
leaves the master shape unchanged on the s tencil.

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

To simplify access to your most commonly used stencils and drawing options, Visio defines another
type of drawing called a template. Templates are drawings that may be used as the starting point when
you create a new drawing. OpenLNS CT includes a L
when you create an OpenLNS CT drawing. If you wish, you can create your own custom OpenLNS
CT template and select it as the default template in the OpenLNS CT Design Manager. See

Network Options in Chapter 3 for more information on selecting the default drawing template.

Creating and Using Custom Ope nL N S CT

ONWORKS template that is used automatically

New

OpenLNS CT User’s Guide 9

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.

OpenLNS CT User’s Guide 11

Ordering OpenLNS CT

You can order OpenLNS CT directly from Echelon, from an Echelon distributor, or from the Echelon
store at
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:

store.echelon.com. If you order from the Echelon store, make sure you provide a valid e-mail

Echelon
Part No.

38000-400 OpenLNS Commissioning Tool Professional Edition (DVD)
38010-400 OpenLNS Commissioning Tool Professional Edition Without Visio (DVD)
38050-400 OpenLNS Commissioning Tool Professional Edition Activation Key
38060-400 OpenLNS Commissioning Tool Professional Edition Without Visio Acti vation Key
38100-400 OpenLNS Commissioning Tool Standard Edition (DVD)
38150-400 OpenLNS Commissioning Tool Standard Edition Activation Key
38160-400 OpenLNS Com missioning Tool Standard Edition Without Vi si o Act i vat i o n Key
38300-400 OpenLNS Commissioning Tool Trial Edition Without Visio Activation Key

You can download your OpenLNS CT products from the Echelon Web site at

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

OpenLNS CT Product

Installing and Activating OpenLNS CT

You can install a licensed copy of OpenLNS CT on up to two computers, a primary and a secondary
computer, provided that the following requirements are met: only the OpenLNS CT user on the
primary computer can use the copy of OpenLNS CT on the secondary computer and the OpenLNS CT
software may only be used on one computer at a time. See the

Agreement in Appendix C for more information. To begin your installation, follow these steps:

OpenLNS CT Software License

1. If you are installing a version of OpenLNS CT that does not include Visio, you must separately
purchase and install the 32-bit version of Visio 2010 or Visio 2003 before installing the OpenLNS
CT software.

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

www.echelon.com/support/downloads/accounts. Your account will enab le you to download

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

3. Download OpenLNS CT from the Echelon Web site and run the OpenLNSCTSetup.exe file, or
insert the OpenLNS CT DVD into your DVD-ROM drive.

If you are installing OpenLNS CT from a DVD and the OpenLNS CT setup application does not
launch immediately, click Start on the taskbar and then and click Run. Browse to the

OpenLNSCTSetup application on the OpenLNS CT DVD and click Open. The Select
Components dialog box opens.

12 Installing and Activating OpenLNS CT

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.

OpenLNS CT is not compatible with the 64-bit version of Visio 2010 (even if your computer
is using a 64-bit operating system), and it is not compatible with any version of Visio prior to
Visio 2003. If you already have a 64-bit version of any Office 2010 application, you must
uninstall it before installing the 32-bit version of Visio. You can reinstall the 32-bit version of
any 64-bit Office software that you have installed.

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

CT. Installing OpenLNS CT automatically installs OpenLNS Server, the OpenLNS CT XML

, and the drivers for the following OpenLDV 4.0-compatible network interfaces:

Utility
o Remote Network Interfaces (RN Is): SmartServer , i.LON 100 Internet Server, i.LON 600

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

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

interfaces. The PCC/PCLTA and SLTA-10 network drivers are compatible with 32-bit
versions of Windows only and are not instal le d on 6 4-bi t versi o ns of Wi n do ws.

If you are using OpenLNS CT on an IP-852 channel, you will need an IP network interface
card (such as Ethernet or WiFi) or modem with PPP software. An IP network interface is also
required if you are using an IP-852 interface such as a SmartServer (with IP-852 routing
option), i.LON 100 Internet Server (with IP-852 routing option), or i.LON 600 IP-852 Router.
If you are using another OpenLNS interface, install the network interface hardware and driver
following the instructions provided with the hardware.

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

OpenLNS CT User’s Guide 13

You can use the L

ONWORKS 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.

• 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.2, which is a free program that allows you to read

Adobe Acrobat portable document files (.pdf extension). Many of the L

ONMARK reference

documents are exclusively in PDF format. You can clear this check box if you already have a
PDF reader application.

5. Click Install. If you are upgrading from the LonMaker Integration Tool, a message opens
informing you that installing OpenLNS CT will remove any version of the LonMaker tool on your
computer.

6. Click Yes to continue installing OpenLNS CT. The installation program installs the selected
components sequentially, prompting you for required reboots.

7. During the installation, the following dialog opens, displaying the current progress of the
OpenLNS CT setup:

14 Installing and Activating OpenLNS CT