LN-Builder 3.5 Technical Bulletin

Technical Bulletin Issue Date December 2017

LN-Builder 3.5

LN-Builder 3.5 ...... 5

Introduction ...... 5

Key Concepts ...... 6 LN-Builder 3.5 ...... 6 Messages Window ...... 9 Audit Log ...... 10 User Manager ...... 11 Group Privileges ...... 12 User Database Import and Export ...... 12 Network Connection Modes ...... 13 Network Management Modes ...... 14 Network Database Backup Files ...... 14 Plug-ins and Device Templates ...... 15 Devices ...... 15 Device Configuration ...... 16 Extension Viewer ...... 17 Functional Blocks ...... 17 Network Service Devices ...... 17 Network Variables ...... 18 Dynamic Network Variables ...... 19 Connection Description Templates ...... 19 Message Tags ...... 20 Ping Interval ...... 21 Monitor Set ...... 21 Network Variable Selector ...... 22 Network Communication ...... 22

Communication Settings ...... 23 Binding Service Type ...... 23 Johnson Controls Browser...... 26 Johnson Controls Browser User Interface (UI) ...... 27 Browser Right-Click Menu ...... 34 Watchlist ...... 34

Detailed Procedures ...... 35 Starting LN-Builder 3.5 ...... 35 Adding a New User...... 35 Deleting a User Account ...... 37 Changing a User Password ...... 38 Modifying Group Privileges ...... 39 Creating a New User Group ...... 39 Deleting a User Group ...... 40 Moving a User to a Different Group ...... 40 Exporting a User Database ...... 40 Importing a User Database ...... 41 Creating a Network Database ...... 41 Copying a Network Database ...... 42 Defining Network Connection Settings...... 44 Connecting to a Network Database ...... 46 Changing the Network Management Mode ...... 50 Configuring the Network Interface Conflict Settings ...... 51 Disconnecting from a Network ...... 52 Configuring Network Properties ...... 53 Backing Up a Network Database ...... 62 Restoring a Network Database ...... 62 Importing a Network Database ...... 64 Deleting a Network Database ...... 66 Defragmenting a Network Database ...... 67 Creating a Channel...... 68 Viewing and Modifying Channel Properties ...... 69 Adding a Router ...... 71 Commissioning a Router ...... 75

LN-Builder 3.5 Technical Bulletin 3

Viewing and Modifying Router Properties ...... 77 Adding a Subsystem ...... 84 Viewing or Modifying Subsystem Properties ...... 85 Installing Plug-ins ...... 86 Registering Plug-ins ...... 87 Launching Plug-ins ...... 89 Adding a Device Template ...... 90 Updating a Device Template ...... 92 Adding a Device to a Network ...... 92 Configuring a Device Using a Plug-in ...... 99 Configuring a Device Using Configuration Properties ...... 99 Using the Extension Viewer ...... 105 Commissioning a Device ...... 106 Configuring Program ID Check Settings ...... 112 Using a Bar Code Scanner ...... 113 Viewing or Modifying Device Properties ...... 113 Viewing or Modifying Functional Block Properties ...... 123 Adding a Network Service Device ...... 127 Removing a Network Service Device ...... 129 Creating a New Connection Description Template ...... 130 Renaming a Connection Description Template ...... 134 Deleting a Connection Description Template ...... 134 Replacing a Connection Description Template ...... 135 Connecting Network Variables ...... 136 Removing a Connection between Network Variables ...... 139 Viewing the Network Connections Map ...... 139 Viewing and Modifying Network Variable Properties ...... 141 Viewing Network Variables and Configuration Properties ...... 147 Changing the Network Variable Type ...... 148 Changing Network Variable and Configuration Property Formats ...... 150 Adding Dynamic Network Variables ...... 152 Importing Dynamic Network Variables ...... 154 Connecting Message Tags ...... 154 Removing a Connection between Message Tags ...... 156 Managing a Device, Router, or Functional Block ...... 157

4 LN-Builder 3.5 Technical Bulletin

Configuring the Ping Interval ...... 161 Deleting a Monitor Set ...... 162 Using the Multi-Device Copy and Paste Feature ...... 163 Loading a Device ...... 165 Renaming a Device, Router, or Subsystem ...... 166 Renaming a Channel ...... 166 Moving a Device or Router to a Different Channel ...... 167 Moving a Device or Router to a Different Subsystem ...... 168 Deleting a Device, Router, or Subsystem ...... 170 Replacing a Device...... 170 Replacing a Router ...... 171 Resynchronizing Device Configuration Properties ...... 174 Resynchronizing Device Configuration Property, Network Variable, and LONMARK Object Names ...... 175 Creating and Viewing a Device Status Summary Report ...... 176 Exporting .xml Files ...... 179 Importing .xml Files ...... 180 Viewing Audit Log Settings ...... 180 Launching the Johnson Controls Browser ...... 181 Dragging Network Variables and Configuration Properties from LN-Builder 3.5 to the Johnson Controls Browser...... 184 Browsing Network Variables and Configuration Properties ...... 184 Opening a Watchlist in the Johnson Controls Browser ...... 186 Saving a Watchlist in the Johnson Controls Browser ...... 187 Restoring Items in the Johnson Controls Browser ...... 187 Viewing and Modifying Johnson Controls Browser Options ...... 188 Customizing the Johnson Controls Browser ...... 193 Displaying Error Messages in the Johnson Controls Browser ...... 194 Changing Network Variables or Configuration Properties in the Johnson Controls Browser ...... 194 Changing Network Variable or Configuration Property Format in the Johnson Controls Browser ...... 195 Changing Network Variable Type in the Johnson Controls Browser ...... 195 Viewing and Modifying Network Variable or Configuration Properties in the Johnson Controls Browser...... 195

LN-Builder 3.5 Technical Bulletin 5

LN-Builder 3.5

Introduction LN-Builder 3.5 is an innovative software tool that allows you to quickly set up an LN Series system in a cost efficient manner. LN-Builder can be used to manage multi-vendor open-source control system networks based on interoperable LONWORKS® technology. This intuitive, yet sophisticated, tool provides network integrators with advanced features and all the resources necessary to install, operate, and maintain LONWORKs networks. LN-Builder 3.5 is compatible with Echelon's LNS® Turbo Edition and Echelon's IzoT™ Net Server (see Table 2: Operating System Compatibility Matrix). LNS Turbo is now considered the legacy version of LNS but it can still be installed and licensed with 64 device credits. The latest LNS Server called IzoT Net Server removes the requirement for device credits, but it requires a separate license key purchased directly from Echelon prior to the installation process. The purchased key includes one year of maintenance with every IzoT Network Services Server. During the first year, all updates and upgrades to the server can be downloaded and installed for free. The annual maintenance package can be renewed any time prior to the end of any maintenance period, whether the pre-paid initial maintenance period or any following. Annual maintenance cannot be renewed after expiration of the last pre-paid or paid maintenance period. Once renewed, all updates and upgrades can be downloaded and installed for an additional year. If the annual maintenance subscription lapses, LN Builder still functions but IzoT software updates cannot be applied until a new IzoT Net Server key is purchased from Echelon (www.echelon.com). LN-Builder 3.5 is a tree-view oriented program with a user-friendly interface that is designed to make it easy to navigate through networks with a high device count. Through context-sensitive menus and dynamically enabled toolbars, all device, channel, subsystem, functional object, and Network Variable (NV) operations can be easily set up and maintained. Advanced features allow moving and copying devices or entire subsystems in one simple operation. The program includes multiple modular applications such as the Johnson Controls® Browser. The Johnson Controls Browser monitors Network Variable and Configuration Property (CP) values during operation, allowing for quick and easy troubleshooting.

6 LN-Builder 3.5 Technical Bulletin

Key Concepts LN-Builder 3.5 For information on software installation, registration, and licensing, or LNS device credits, refer to the LN-Builder 3.5 Installation Instructions (LIT- 12011532) or contact your local Johnson Controls® representative.

LN-Builder 3.5 System Requirements LN-Builder 3.5 system requirements include:

Table 1: System Requirements Operating System1, 2, 3 Windows® 7 Professional or Enterprise/Ultimate with SP1 (32-bit or 64-bit) Windows® 8.1 Professional or Enterprise (64-bit) Windows® 10 Professional or Windows 10 Enterprise Editions (64-bit) Note: For additional information see Table 2: Operating System Compatibility Matrix Processor 1.3 GHz or higher Memory 2 GB RAM minimum Hard Drive 40 GB minimum free hard disk space Display Minimum 128 MB video card Accessories CD-ROM drive, mouse, or other Microsoft Windows OS compatible pointing device Network Interface LONWORKS network interface card 1. User Account Control (UAC) settings may need to be changed in order to properly run the software. 2. Use the Run as Administrator option when installing and running applications to prevent issues with licensing and operation. 3. User file rights affect LNS databases that have been copied over from another computer. Set permissions on the folder containing your files to ensure access to the database.

Table 2: Operating System Compatibility Matrix Echelon LNS Software Product LNS Server Turbo Edition IzoT Net Server Version 3.27 4.02.028 Windows Desktop OS Widows 10 64-bit X2 Windows 8 & 8.1 64-bit X Windows 7 64-bit X1 X1 Windows 7 32-bit X X Widows Server OS Server 2012 R2 64-bit X1 Server 2012 64-bit X1 Server 2008 R2 64-bit X1 X1 1. Echelon Lon USB Interface support for U10/U20 requires OpenLDV 4 Network Driver or higher for all 64-bit OS. U10/U20 must be unplugged from the USB port during installation. 2. Echelon Lon USB Interface support for U10/U20 requires OpenLDV 5 Network Driver for a Windows 10 machine. U10/U20 must be unplugged from the USB port during installation.

LN-Builder 3.5 Technical Bulletin 7

The LN-Builder Interface is composed of four major components: Menu/Toolbar, Tree View pane, List View pane, and Status Bar.

Figure 1: LN-Builder 3.5 Interface

Menu/Toolbar Use the toolbar buttons to quickly activate LN-Builder functions. Place your mouse over any of the toolbar buttons to see pop-up tooltips that describe the button’s function. Table 3 describes the Toolbar menu.

8 LN-Builder 3.5 Technical Bulletin

Table 3: Toolbar Menu Button Name Description Channel View Changes the Tree View pane display to the channel view. The network is organized in a hierarchical manner by channel. The channel view is a physical view of the system. Subsystem View Changes the Tree View pane display to the subsystem view. The network is organized in a hierarchical manner by subsystem. The subsystem view is the logical view of the system. OnNet Indicates the network management mode is online (OnNet).

OffNet Indicates the network management mode is offline (OffNet).

Close All Closes all network databases and disconnects your computer from the Networks network. Expand Changes the effect of a double-click action in the List View pane. If you double-click an item in the List View pane, it expands the item by one level. Display Changes the effect of a double-click action in the List View pane. If you Properties double-click this button in the List View pane, the properties box appears (device properties for a device, object properties for an object). Browse Changes the effect of a double-click action in the List View pane. If you double-click an item, the Johnson Controls Browser opens and allows you to view and set network variable values in real time. Configure Changes the effect of a double-click action in the List View pane. If you double-click on an item, the configuration plug-in launches. Monitor Changes the effect of a double-click action in the List View pane. If you double-click on a device, the monitoring plug-in launches. The monitoring plug-in provides a graphical representation of relevant information about the device. Londisplay Launches the Londisplay tool. The icon appears after you purchase and install Londisplay. Log Manager Launches the Log Manager.

Johnson Controls Launches an empty Johnson Controls Browser. You can drag and drop Browser network variables, configuration properties, and functional block objects from the browser into the List View pane. Re-login Allows you to switch users in real time without shutting down and restarting the software. For audit logging purposes, you can track which users made changes to the network. Adjust Columns Resizes the cells in the List View pane and adjusts the contents for optimal viewing. Show Message Launches the message window. The message window is a sequential history Window of all steps you have taken since you began the current LN-Builder 3.5 session. Legend Map Opens the legend map that details all LN-Builder 3.5 buttons and icons.

Show Shortcuts Opens a list of shortcuts that you can use in LN-Builder 3.5.

Help File Opens the LN-Builder 3.5 Help system.

LN-Builder 3.5 Technical Bulletin 9

Tree View Pane The Tree View pane appears on the left side of the LN-Builder interface. The Tree View pane provides a multi-level, hierarchical list of available networks, network subsystems, and network components. You can expand the view to browse the network variables. You can also change the display mode to organize the network variables by channel or subsystem for flexibility in managing the network. Table 4 describes the Tree View pane icons.

Table 4: Tree View Pane Icons Icon Name Network

Subsystem

Channel

Online Router (Green)

Uncommissioned Router (Gray)

Offline Router (Red)

Online Device (Green)

Uncommissioned Device (Gray)

Offline Device (Red)

LONMARK® Object

Network Variable Input (NVI)

Network Variable Output (NVO)

Configuration Property

List View Pane The List View pane is on the right side of the LN-Builder Interface. When you double-click a network object, all objects that are one level lower in the network hierarchy appear in the pane. If you double-click a subsystem, all devices that are part of the subsystem appear in the pane. Similarly, when you double-click a device, the functional blocks for the device (network inputs, outputs, real-time clock) appear in the pane.

Status Bar The Status Bar displays important information about the system, including system name, system mode (online or offline), and network connection mode (Local, Lightweight, or Full client).

Messages Window The Messages window opens in the background when you launch LN-Builder. You can access the Messages window by clicking it in the Windows® taskbar.

10 LN-Builder 3.5 Technical Bulletin

The Messages window is a sequential list of actions you have taken since you launched LN-Builder. The Messages window lists the action number, the name of the user who performed the action, the date and time of the action, and a description of the action. The information automatically saves to the log file.

Audit Log LN-Builder allows you to store an audit log of the actions performed within a log file. The log file is a sequential list of actions you have performed. The Audit log lists the action number, the name of the user who performed the action, the date and time of the action, and a description of the action. The Audit Log is a subset of the information listed in the Messages window. Figure 2 shows an example of the Audit Log file. For information on the Messages window contents, see the Messages Window section. When you access the Audit Log, open it in a Microsoft® Excel spreadsheet to view the stored data properly. The second column value that lists the action number resets to 1 after each closing and reopening of the LN-Builder software.

Figure 2: Audit Log

LN-Builder 3.5 Technical Bulletin 11

User Manager The User Manager provides user management features such as creating new users and modifying user passwords.

Figure 3: User Manager

12 LN-Builder 3.5 Technical Bulletin

Group Privileges Each user in LN-Builder must belong to a user group. The Groups window can be accessed from the User Manager window by clicking the icon. Each user group has different privileges and operations that they can perform. By default the group privileges and operation rights are as illustrated in Figure 4. An in a table cell means that a user group has that specific privilege/right.

Figure 4: Groups Window

User Database Import and Export LN-Builder allows you to set up users on one computer and then set up the same users on another computer. You can export a user database and then import it on a different computer.

LN-Builder 3.5 Technical Bulletin 13

Network Connection Modes Before connecting to a network database, you must select a Connection Mode. The Connection Mode is determined by the LNS server location. Table 5 describes the three connection modes in LN-Builder.

Table 5: Connection Modes Connection Mode Description Local Client A local client situation exists when LN-Builder 3.5 or another LNS management application is running on the same computer as the LNS server. When LN-Builder 3.5 runs on the same computer as the LNS server software, there is a local client situation, even if the computer is remote from the actual network. The client is remote or local relative to the location of the LNS server, not relative to the actual network. For example, network interfaces such as the PCLTA-21 and PCC-10 allow LN-Builder 3.5 to connect the local LNS server to the local network. Network interfaces such as the i.LON® 10 Ethernet Adapter and i.LON 100 Internet Server allow LN-Builder 3.5 to connect the local LNS server to a remote network. Remote Lightweight A remote lightweight client situation exists when Client LN-Builder 3.5 or another LNS management tool communicates with the LNS server through an LNS/IP (LNS over IP) channel. The LNS server computer must be connected to the LNS/IP channel to support lightweight clients and must also be connected to a LONWORKS channel. Remote Full Client A remote full client situation exists when LN-Builder 3.5 or another LNS management tool communicates with the LNS server through any LONWORKS channel including an IP channel. The LNS server computer and the computer running LN-Builder 3.5 may be on different channels. A full client computer can be added to a network database as a Network Service Device.

14 LN-Builder 3.5 Technical Bulletin

Network Management Modes The management mode allows you send changes in the network database to the physical device. You can change the mode status while connected to the network database.

Table 6: Network Management Modes Mode Description OnNet Changes to the network database are immediately sent to the physical devices on the network. Any changes in the network database are immediately reflected on the physical devices. Use LN-Builder 3.5 in the OnNet mode when you are commissioning devices. OffNet Changes to the network database are not sent to the physical devices in real time. You can make changes to the network database while in the OffNet mode, but the changes are only implemented in the physical devices once you put LN-Builder 3.5 into the OnNet mode. However, if you already commissioned devices on the network and are in OffNet mode, changes to network variables take effect on the network in real time. While LN-Builder 3.5 is in OffNet mode, you can read configuration properties for devices on the network. In OffNet mode, you can make changes without having to wait for every change to be sent to the physical devices.

Network Database Backup Files You can use LN-Builder to save a network database to a single backup file with a .zip extension. You can use backup files to protect against accidental file corruption, hardware failure, or to transfer a network database from one computer to another. You also can use backup files to archive a network at sites without an LNS server or to archive multiple network configurations. You can restore a previous configuration from the backup files when necessary. An LN-Builder backup file contains all files that you have placed in the network database directory, providing an easy way to back up and copy files associated with a network. See the Backing Up a Network Database, Restoring a Network Database, and Importing a Network Database sections.

LN-Builder 3.5 Technical Bulletin 15

Plug-ins and Device Templates Before adding a device to the network, you must install and register the device’s plug-ins and create a device template. In general, registering the device plug-in for a device adds the device template to the active network database. The device template is used for device commissioning, and the plug-in is used for device configuration.

Plug-ins To provide interoperability between LNS applications from different vendors, the LNS server defines and supports a standard plug-in architecture where an LNS application can invoke the services of any other LNS application on the same computer. Plug-ins allow you to configure a device’s network variables and configuration properties more easily than through a browser tool. LN-Builder can launch LNS device plug-ins for any device on the network. Plug-ins simplify programming, configuring, and monitoring devices. Plug-ins can exist at multiple levels in an LNS application. The seven levels are: • Global • System • Subsystem • Device • Object • Network Variable • Configuration Properties Plug-in types are generally defined by their purpose and scope. For example, a plug-in that manages multiple devices at one time is normally a system plug-in or a subsystem plug-in.

Device Templates The device template is a template used by LN-Builder that contains all the attributes of a given device type (functional blocks, network variables, configuration properties, and more). Device templates are created using device External Interface (XIF) files or by uploading the interface definition from the physical device. Normally, a device template is automatically created when you register the device’s plug-in.

Devices A device in the network database corresponds to a physical device on the network. Installation of a device in a LONWORKS network is usually a three- step process: creation/definition, configuration, and commissioning. 1. Device creation or definition does not require LN-Builder or the device to be attached to the network. This task includes defining the device name, device template, location, channel, and device description.

16 LN-Builder 3.5 Technical Bulletin

2. Device configuration allows you to configure the device to work with the appropriate equipment and specify the sequence of operation, setpoints, and other device specific parameters. 3. Device commissioning associates the physical device attached to the network with the device in the network database.

Device Configuration Use plug-ins or modify the device’s configuration properties to configure a device.

Plug-ins After adding a device to a network, you must configure it based on the application requirements. Configuration is usually done through a plug-in. Devices are generally composed of several functional blocks also known as LONMARK Objects. Each functional block has its own configuration plug-in that is used to perform specific configuration operations on the functional block. To configure a device you have to launch the appropriate functional block plug-in. Each plug-in is designed for specific configuration parameters such as scheduling, time and date setting, equipment sequence, setpoint configuration, device programming, and more. Use different types of plug-ins such as Global, System, Subsystem, Device, Object, Variable, and ConfigProp plug-ins, depending on the type of device you being used.

Configuration Properties A device's configuration is usually stored in network objects called Standard Configuration Property Types (SCPTs), User Configuration Property Types (UCPTs), or Network Configuration Inputs (NCIs). Some information can also be stored in the database extension. The database extension is used to store extra device information that is not supported by LNS applications (for programmable devices, i.LON servers, and more). When configuring several devices that have the same configuration, use the Copy CPs and Paste CPs function available when you right-click a device. These functions copy the configuration properties as well as the database extensions from one device to another one. Another way to create similar devices would be to copy and paste a previously configured device. Note: Devices that use the database extension to store information may require extra steps for proper configuration. Refer to the device’s user guide for more information.

Import and Export Device Properties Device properties can be imported and exported as an .xml file, which allows you to copy the same properties into other devices (with the same type and program ID). Table 7 outlines the device properties you can export.

Table 7: Exported Device Properties Device Property Parameters Exported Items Network Variable Exports the following: type, format, name, programmatic name,

LN-Builder 3.5 Technical Bulletin 17

description, index, position, toString data, isDynamic, binding variable list including connection template settings, and all configuration properties. Configuration Property Exports the following: name, description, format, typeIndex, mode, precision, position, isWritable, and raw value if the CP is writable. LONMARK Object Exports the following: name, programmatic name, alarmFormat, type index, mode, index, position, and all configuration properties. Extensions Exports the following: description and key and three values. Interfaces (host-based only) Exports the following: name, description, and position. Device Exports the following: name, program ID, Neuron® ID, location, Initial AuthenticationKey, description, priority, PingClass, IsHostBased, and path. Extension Viewer Specific data objects may be defined for an application. Data objects are stored in a structure called the database extension. Use the extension viewer to view data contained in the database extension. See the Using the Extension Viewer section.

Functional Blocks A functional block is a collection of network variables and configuration properties on a device that perform related functions. For example, a device with four schedulers can contain one functional block for each scheduler. A standard functional block is also known as a LONMARK object. A standard or user functional block is also known as an object. A device may include network variables, configuration properties, and message tags that are not part of any functional block. A special type of functional block, known as a virtual functional block, contains these interfaces. A virtual functional block is not actually a functional block, but it is a method provided by LN-Builder to access the parts of the device interface that are not contained within standard functional blocks. The device template defines the functional blocks on a device and the network variables and configuration properties supported by each, as well as the network variables and configuration properties not contained by any functional blocks.

Network Service Devices You can use a Network Service Device (NSD) to represent the LNS server and LNS client in the network database. The NSD is a remote client of the LNS server that you can use to monitor and control the network. In full client mode, you can add an NSD as part of the network to make the remote client a permanent server. After adding an NSD to the network, you can add network variables and create connections.

18 LN-Builder 3.5 Technical Bulletin

Network Variables In a LONWORKS network, devices share information by using network variables. Each network variable has a type that defines the data type, range, and resolution.

LONWORKS devices communicate across the network by exchanging data via network variables. Network variables allow for interoperability and compatibility between different LONWORKS application programs and LONWORKS devices. A network variable holds information (data) about a specific device attribute such as air temperature, air pressure, the device status, and more. A Network Variable Input (NVI) gets its value from another device. The device that outputs the value does so using a Network Variable Output (NVO).

LN-Builder 3.5 Technical Bulletin 19

You can use LN-Builder to connect compatible network variables (that is, the network variables are of the same type). The network variable type specifies the data structure of the network variable as well as the resolution/precision and nature of the network variable. By checking the NV type, LN-Builder ensures that incompatible inputs and outputs are not connected (for example, a pressure type output being connected to a temperature type input). All connections have one hub network variable (an originating/source network variable) and each connection can have single or multiple target network variables. When you create a connection with a single input and a single output, either end of the connection can act as the hub or as the target. When you create large fan-in connections (multiple outputs feeding a single input) or fan-out connections (a single output feeding multiple inputs), the common network variable should be set up as the hub variable to reduce the time required to make the connection. In a fan-out connection, the single output should be the hub and in a fan-in connection, the single input should be the hub. When the source network variable changes value, the change propagates through the network, and LN-Builder updates all connected inputs to reflect the same value as the source NVO.

LONWORKS has a large number of Standard Network Variable Types (SNVTs) that cover many of the most frequently used Heating, Ventilating, and Air Conditioning (HVAC) and automation applications. Many devices have their own User Network Variable Types (UNVTs). SNVTs and UNVTs can be of scalar or structure types: • A scalar type variable is used to represent a single value. The value may be an enumeration, a floating-point number, or a fixed-point number. You can use scalar types to set minimum and maximum value ranges (valid range). • A structure is a set of single or multiple scalar values, unions, arrays, or embedded structures.

Dynamic Network Variables Some devices, such as LNS network interface and the Echelon® i.LON 100, support the creation of dynamic network variables. A dynamic network variable is a variable that you can add to a device after adding the device to the network. In the i.LON 100 plug-in, a dynamic network variable is named Local Network Variable (NVL).

Connection Description Templates All network variable connections have associated connection descriptions. Connection descriptions establish how data is delivered from NVOs to NVIs and how the connection is constructed. ConnectDescTemplate_0 is LN-Builder’s default connection description. ConnectDescTemplate_0 is a base description that cannot be deleted or modified. You can create a new connection description if you want a connection to have different connection description properties.

20 LN-Builder 3.5 Technical Bulletin

Message Tags Message tags are used to send and receive explicit messages by devices. Messages contain an identifier code indicating the type of message. The receiving device uses the identifier code to determine how to handle the message content. Individual devices are responsible for building, sending, and responding to explicit messages. When using a device that supports message tags, refer to the device documentation for information on the device’s specific message tag usage. You can connect message tags in LN-Builder in a process similar to connecting network variables. All connections have one hub message port (an originating/source message tag) and each connection can have single or multiple target message ports. When you create a connection with a single input and a single output, either end of the connection can act as the hub or as the target. When you create large fan-in connections (multiple outputs feeding a single input) or fan-out connections (a single output feeding multiple inputs), the common message port should be set up as the hub variable to reduce the time required to make the connection. In a fan-out connection, the single output should be the hub and in a fan-in connection, the single input should be the hub.

LN-Builder 3.5 Technical Bulletin 21

Ping Interval The ping interval determines the frequency with which a device is tested (pinged) to determine whether it is still attached to the network. LN-Builder assumes a device is detached if it cannot communicate with that device three consecutive times. Set the ping interval based on how often you wish to ping the device. If the ping interval option is disabled, the server stops sending communication requests to the devices that belong to the disabled group (Longest, Long, Short, and Shortest). Typically, a device controlling critical HVAC equipment like a boiler should be pinged more often than a Variable Air Volume (VAV) controller. If the ping interval option is disabled, the server stops sending communication requests to the devices that belong to the disabled group (Longest, Long, Short, and Shortest). When commissioning a device or a router, you can specify a ping interval that defines how often LN-Builder pings the device to make sure it is still communicating with the network. See Configuring the Ping Interval.

Monitor Set A monitor set is a set of network variables and message tag monitor points that are automatically created when monitoring a point. Applications such as the Johnson Controls Browser plug-in use the monitor set. There are two types of monitor sets: temporary and permanent. Temporary monitor sets are normally used for single client sessions. When the client session ends, the temporary monitor set and all the monitor points that it contains are deleted. Permanent monitor sets are normally used for multiple client sessions. When the client session ends, the permanent monitor set and all the monitor points that it contains remain, unless otherwise specified. A monitor set contains default settings that are applied to all monitor points as they are added to the set (such as network variable type). When a monitor set is created, you can no longer change the network variable type. To change a network variable type, delete the monitor set.

22 LN-Builder 3.5 Technical Bulletin

Network Variable Selector A network variable selector is the number used by the Neuron® firmware to resolve network variable update messages. Each network variable has only one network variable selector. When you connect network variables, the variables must share one selector. For example, to connect one network variable on a controller (NVO) to two network variables residing on another controller (two NVIs), create the first connection between the NVO and the first NVI. These two variables share the same selector. A conflict situation occurs when you create the second connection between the NVO and the second NVI. The second connection you create usually shares the same selector as the initial connection. However, because the receiving device cannot have the same selector twice, an alias network variable is created to resolve the conflict. The alias network variable has the same value, service type, and other properties as the original network variable, but has a different selector. The alias allows you to create the correct type of connection.

Figure 5: Alias Network Variable

NVO NVI Alias NVI alias FIG : alias : FIG Network Communication Devices share information by sending and receiving network variables. LN-Builder and the LNS server also communicate with devices and further increase the number of messages sent and received on the network. On medium to large-sized networks, the network design is critical to ensure optimal network communications. Use high-speed channels such as TP/XF- 1250 and LONWORKS IP as the backbone for medium to large-sized networks to prevent network congestion. Configure communication settings in every network to minimize the network traffic. You can modify Device Network Variable Configuration Properties such as heartbeat, minimum send time, maximum send time, and send on delta to reduce the amount of messages sent on the network.

LN-Builder 3.5 Technical Bulletin 23

Communication Settings Modifying communication settings increases or decreases the rate of propagation of network variables on the network. Set communication settings initially at a value that is considered acceptable for the device application. For example, you can update a network schedule every minute and update a space temperature value every 5 seconds if it is used to control critical equipment. Setting up correct communication parameters improves communication on a LONWORKS network by reducing network traffic. You can access network variable transmission parameters using device configuration tools or a browser. See Table 8.

Table 8: Network Variable Transmission Parameters Parameter Description Heartbeat Indicates the maximum period of time between transmissions of the network variable. Send on Delta Transmits the network variable on Delta. Delta is the magnitude of change of the network variable that must occur before transmitting the variable. Throttle Indicates the minimum period of time that must pass before transmitting a network variable. Minimum send time Indicates the minimum time between transmissions of the network variables. Maximum send time Indicates the maximum time between transmissions of the network variables.

In addition, LN-Builder communicates with devices on the network to get device information. You can use LN-Builder to modify these settings to optimize the network communication using the Timing/Retries tab of the Network Properties dialog box. See Configuring Network Properties. After configuring the communication settings, check to see whether there are any communication errors. You can verify communication errors using a protocol analyzer or by looking in the Device Manager.

Binding Service Type Selecting the proper binding service type decreases network traffic by reducing the number of message transmissions. There are three service types: Acknowledged, Unacknowledged Repeated, and Unacknowledged. These service types allow you to set timing and retry properties. Use the following guidelines when connecting network variables without modifying the associated timing and retry settings. For a one-to-one connection, use the Acknowledged service type.

The Acknowledged service type creates two messages for each message transmission. The sender transmits a message on the network and the receiver replies with an acknowledgment message to the sender. In a one-to- one connection, two messages are normally sent on the network, and the receiver and the sender receive the message on the first try. For a many-to-one (fan-in) connection, use the Unacknowledged service type. Each sender transmits a message once to the receiver. The

24 LN-Builder 3.5 Technical Bulletin

Unacknowledged service prevents the receiving devices from becoming overloaded. For example, if you have a 100 network variable outputs bound to a network variable input on a device and are using Acknowledged service type, the receiving device sends out 100 acknowledge messages. For a one-to-many (fan-out) connection, use the Unacknowledged Repeated connection service type. The sender transmits the same message a specified number of times without expecting an acknowledgment. By default (Auto option), the message is transmitted four times. You can change the repeat number as desired. For example, if you have a fan-out (one-to-many) connection that consists of one sender and 20 receivers, then 21 messages are transmitted (that is, all messages are acknowledged). If you use the Unacknowledged Repeated service with the same one-to-many connection, only four messages are transmitted because there are four repetitions by default (unless specified otherwise). There are 17 more messages transmitted when using the Acknowledged service type for this one-to-many example. When using the Unacknowledged Repeated service, the sender transmits the data to other devices multiple times. Each additional repeat increases the probability that the receiver receives the message. If a receiver does not receive a message, even after multiple retries, check if there is a network communication problem or if the device is in fault. In general, use the Unacknowledged Repeated service type for fan-out connections and Unacknowledged messaging for fan-in connections.

LN-Builder 3.5 Technical Bulletin 25

Table 9: Connection Service Types Connection Type Representation Service Type One-to-one Acknowledged NVO NVI onetoone FIG : onetoone : FIG

Many-to-one Unacknowledged Repeated (Fan-in) NVO NVI

NVO

NVO manytoone : manytoone FIG : FIG One-to-many Unacknowledged (Fan-out) NVO NVI

NVI

NVI FIG : onetomany

FIG : onetomany

26 LN-Builder 3.5 Technical Bulletin

Johnson Controls Browser The Johnson Controls Browser is a plug-in for LN-Builder that allows you to read and write network variables and configuration properties for devices and functional blocks. The Browser provides you with a quick method of viewing and changing specific network variables and configuration properties for multiple devices without having to open multiple plug-ins. The Johnson Controls Browser is a multifunctional tool designed to provide powerful network monitoring and management capabilities. Using a simple yet detailed interface, the browser gives you access to any Network Variables (NVs) and Configuration Properties (CPs) available on the network. The browser's many customization features allow you to easily select the type and quantity of data to display. You can select network variables and configuration properties for display in different ways. You may choose to browse a specific functional block on a node in the network and thus see all the NVs and CPs associated with it. Alternatively, you may choose to browse an entire device (including all the functional blocks it contains) or browse NVs or CPs from multiple devices (or functional blocks) on the network simultaneously. Using the browser to directly read and write NVs and CPs decreases troubleshooting and configuration time when compared to using multiple plug-ins for multiple device NVs and CPs.

LN-Builder 3.5 Technical Bulletin 27

Johnson Controls Browser User Interface (UI) The Johnson Controls Browser uses a row/column layout to display network variables and configuration properties according to a color code.

Figure 6: Johnson Controls Browser

28 LN-Builder 3.5 Technical Bulletin

Columns Each column in the Johnson Controls Browser UI has a header/title that details the type of information it contains.

Table 10: Johnson Controls Browser Columns Column Description # Displays an automated number given to the elements appearing in the browser. You can use this number for referencing purposes because deleting elements in the browser does not change the numbering. Device Displays the name of the device in which the functional block of the network variable or configuration property resides. Functional Block Displays the name of the functional block/LONMARK object in which the network variable or configuration property resides. A functional block is a collection of network variables and configuration properties that are used together to perform a specific task. Programmatic Name Displays the name of the network variable or configuration property being displayed in that row as defined by the functional block. Format Type Displays the format of the network variable or configuration property being displayed in that row. If the item being displayed does not have a format, then this field displays the name of the item. Value Displays the last value obtained by the browser for the network variable or configuration property being displayed in that row. This field is empty if you launch the browser and the device containing the browsed item is offline or not communicating.

LN-Builder 3.5 Technical Bulletin 29

The Johnson Controls Browser allows you to customize the columns and has other custom column types available. You can add a column or remove an existing column from the browser by selecting Browser > Customize in the main menu. Table 11 describes the optional column types available.

Table 11: Custom Johnson Controls Browser Columns Column Description URL Displays the complete network/database path of the item being displayed and includes the Subsystem, Device Name, Object, and Programmatic Name. Network Variable Displays the name of the network variable that the row describes. If the row describes a configuration property associated with a specific network variable, this field shows that network variable. Otherwise, this field is blank. Configuration Property Displays the standard or user-defined type of the configuration property that the row describes. If the row describes a network variable, this field is blank. Subsystem Displays the name of the subsystem to which the item being displayed belongs. Direction Displays the direction of the network variable displayed in that row. If the row describes a network variable input, the field shows Input. If the row describes a network variable output, the field shows Output. If the row describes a configuration property, this field is blank. Monitoring Indicates whether the network variable displayed in the row is being monitored (On or Off). If the row describes a configuration property, this field is blank. Object Type Displays the type of item being displayed in the row (Network Variable or Config Property). Note: Network Configuration Inputs (NCIs) appear as Network Variable. SNVT/SCPT ID Displays the SNVT ID or the SCPT ID number.

30 LN-Builder 3.5 Technical Bulletin

Color Legend The Johnson Controls Browser uses a color scheme to enable you to easily differentiate between the items being displayed in the browser.

Table 12: Johnson Controls Browser Legend Icon Color Description Green Indicates that the row displays a Network Variable Input (NVI). Blue Indicates that the row displays a Network Variable Output (NVO). Maroon Indicates that the row displays a normal configuration property. Gray Indicates that the row displays a read-only configuration property. Bright Red Indicates that the row displays a network variable or configuration property with a modified Value field that has not been downloaded to the device. Aqua Indicates that the row displays a network variable that is being polled by the browser. This icon appears at the beginning of the row. White Indicates that the row displays a network variable that is not being polled by the browser. This icon appears at the beginning of the row. Orange Indicates that the row displays a network variable that is being polled by the browser, but the browser is not receiving a response. This icon appears at the beginning of the row. Beige with Indicates that the row displays a configuration maroon frame property. This icon appears at the beginning of the row.

LN-Builder 3.5 Technical Bulletin 31

Johnson Controls Browser Toolbar The browser toolbar provides quick access to the most common functions and commands of the Johnson Controls Browser.

Table 13: Johnson Controls Browser Toolbar Icon Description Opens a watchlist file.

Saves a watchlist file.

Prints the contents of the browser.

Copies one or more selected items.

Pastes the contents of the clipboard into one or more selected items. Toggles the configuration properties display in the

browser. Toggles the network variables display in the browser.

Turns on monitoring.

Pauses monitoring.

Turns off monitoring.

Refreshes all fields in the browser.

Opens the properties dialog box of a highlighted item.

Resizes the columns in the browser.

Gets values from the device.

Sets values to a device.

Sends all modified values to all devices.

Cancels all modifications made in the browser.

Opens the error log and turns red when an error occurs. Opens the browser color legend.

32 LN-Builder 3.5 Technical Bulletin

Browser Main Menus Table 14 describes the main menu items of the Johnson Controls Browser.

Table 14: Johnson Controls Browser Main Menu Items Main Menu Menu Item Description File Open Opens a previously saved browser watchlist. Close Closes the current watchlist that is open. Save Saves changes made to an open watchlist. Save As Saves the current browser configuration along with a list of all the items being displayed into a watchlist file for later retrieval. Save List To File Saves the current browser configuration and a list of all the data points to a .csv file. You can view the .csv file contents in a spreadsheet. Print Prints the current browser contents along with the date and time of printing using the default printer and settings. Print Setup Opens the print setup dialog box. Exit Closes the browser. Edit Cut Cuts the contents of the Value field of a highlighted item and holds the contents in the clipboard for later pasting. Copy Copies the contents of the Value field of a highlighted item and holds the contents in the clipboard for later pasting. Paste Pastes the contents of the clipboard into the Value field of a highlighted item. You can paste the values into multiple, selected items. Delete All Rows Deletes all rows of items being displayed in the browser. Undelete Rows Opens the Undo Delete dialog box to restore items. Select All Selects all network variables and configuration properties in the browser. Select None Removes any selections of network variables and configuration properties in the browser. Continued on next page . . .

LN-Builder 3.5 Technical Bulletin 33

Main Menu Menu Item Description (Cont.) Browser Options Opens the Browser Options dialog box to select display, messaging, network variable, configuration property, and monitor set options. Customize Opens the Customize dialog box to select the columns to display in the browser. Adjust Columns Resizes the columns of the browser to make the contents of the cells fully visible. Display Error Opens the built-in error log of the Messages browser. The error messages include the date and time of the error as well as a description of the error. Monitor On Provides continuous updating of the values of the items being displayed in the browser. Note: By default, monitoring is disabled when you open the browser. Turning on monitoring creates a temporary monitor set in the LNS database. This monitor set is deleted when you close the browser, even if the Remove all monitor sets on closing option is not selected. Automatically deleting this file when you exit reduces network traffic. Monitor Pause Temporarily pauses the monitoring of all items in the browser. Select the Monitor On option or select Monitor Pause a second time to resume monitoring. Monitor Off Turns off the monitoring of all items in the browser. Refresh All Updates all fields in the browser one time. Clear All Values Clears the contents of all Value fields in the browser. Resynchronize Updates the data in the browser MonitorSets associated with a changed monitor set. Use this option if you created a monitor set and the properties of the items being monitored by the set change (for example, through another LNS application such as a plug-in). This option synchronizes the monitor set and displays the proper data in the browser. Stop monitoring any Stops the browser from polling any offline device device in an offline state. This option lessens network traffic when many devices are offline.

34 LN-Builder 3.5 Technical Bulletin

Browser Right-Click Menu Table 15 describes the menu items available when you right-click a network variable or configuration property in the List View of the Johnson Controls Browser.

Table 15: Browser Right-Click Menu Items Menu Item Description Monitor Creates a monitor set and turns it on for the selected items in the browser. Use this command a second time to turn off and delete the monitor set. Get Value Obtains the values of the selected items in the browser directly from the controller. Set Value Sends the current values of the selected items in the browser to the controller. Clear Value Clears the contents of the Value fields of the selected items in the browser. Refresh Updates the contents of all selected fields in the browser. Details Expands the selected items to show their contents. Change Format Changes the format of the selected items. Change Type Changes the type of the selected network variable. Delete Hides the selected rows from view within the browser. Use the Undelete Rows option to undo a delete command. Resynchronize Provides the following update options for the selected configuration property: • Write database value to device: Downloads the current database value for the configuration property into the device. • Write device value to database: Uploads the value from the device into the database. Properties Opens the Network Variable Properties dialog box or the Configuration Properties dialog box.

Watchlist A watchlist is a file containing all the network variables and configuration properties along with all the customization options applied to the browser at the time you created the watchlist. A watchlist file has a .wlt extension. You can run a watchlist directly from a Windows environment without using a network management tool to open the browser. You do not need to open LN-Builder or use multiple plug-ins to read and write network variables and configuration properties.

LN-Builder 3.5 Technical Bulletin 35

Detailed Procedures Starting LN-Builder 3.5 To start LN-Builder 3.5: In the Start menu, click Programs > Johnson Controls > LN-Builder 3.5 > LN-Builder 3. (In Windows 8.1 or Windows 10, click the Start icon and begin to type LN-Builder 3 while at the Start screen, then click LN-Builder 3 in the Apps results.) The LN-Builder 3.5 network management tool appears.

Adding a New User To add a new user: 1. In the Settings menu, click User Manager. The User Accounts window appears (Figure 7).

2. In the File menu, click Add New User or click the icon. The New User dialog box appears.

Figure 7: New User Dialog Box

3. Fill in the fields. See Table 16.

36 LN-Builder 3.5 Technical Bulletin

Table 16: New User Dialog Box Field Description User Name Enter the desired user name. The user name is case sensitive and can be up to 25 characters long and include embedded spaces. This is a required field. Full Name Enter the user’s real or full name. This field is used only for record keeping purposes. This is an optional field. Description Enter a description for the user (for example, Systems Manager or Field Technician). This field is used only for record keeping purposes. This is an optional field. Password Enter a password with a minimum length of 5 characters. The password is case sensitive. This is a required field. Confirm Password Re-type the password you chose to ensure accuracy. Group Select the User Group to which this new user is added. See the Group Privileges section for details about the different user groups available.

4. Click OK to finish adding the user.

LN-Builder 3.5 Technical Bulletin 37

Deleting a User Account To delete a user account: 1. In the Settings menu, click User Manager. The User Accounts window appears (Figure 8). 2. Right-click the name of the user to delete and click Remove. A dialog box appears asking you to confirm that you want to remove the user from the database.

Figure 8: User Accounts – Deleting a User Account

3. Click OK. The user is deleted from the database.

38 LN-Builder 3.5 Technical Bulletin

Changing a User Password To change a user password: 1. In the Settings menu, click User Manager. The User Accounts window appears (Figure 8). 2. Right-click the name of the user whose password you want to change and select Properties. The User Properties dialog box appears.

Figure 9: User Properties Dialog Box – Change Password 3. Click Change Password. 4. Enter the new password in the pop-up window and click OK to finish resetting the password. Note: When launching a new session of LN-Builder, the Login dialog box appears. To configure LN-Builder for use without password protection, perform the following tasks: • Delete all users except one administrator. • Click Change Password. The Reset Password dialog box appears. Do not type any user name and password. Click OK. Another prompt window appears. • Follow the instructions to set LN-Builder in the no-protection mode.

LN-Builder 3.5 Technical Bulletin 39

Modifying Group Privileges Adding Privileges to a User Group To add rights/privileges to a user group:

1. Click the icon in the User Manager window. The Groups window appears. 2. Click an empty cell that corresponds to the desired. An appears in the table cell to show that the user group now has the specified privilege.

3. Once you have configured the user privileges as required, click the icon in the toolbar to save your changes.

Removing Privileges from a User Group To remove rights/privileges from a user group:

1. Click the icon in the User Manager window. The Groups window appears. 2. Click the cell that corresponds to the privilege that you want to remove from the user. The disappears from the table cell to show that the user group no longer has the specified privilege.

3. Once you have configured the user privileges as required, click the icon in the toolbar to save your changes.

Creating a New User Group To create a new user group:

1. Click the icon in the Groups window toolbar. LN-Builder creates a new user group labeled New Group.

Figure 10: Groups Window – New Group

2. Click the table cell labeled New Group. The label becomes highlighted and you can enter a group name of your choice. 3. To add rights/privileges to this user group, click any empty cell that corresponds to the privilege you want to give to the group. An appears in the table cell meaning that the user group now has the specified privilege.

40 LN-Builder 3.5 Technical Bulletin

4. Once you have configured the user privileges as required, click the icon in the toolbar to save your changes.

Deleting a User Group To delete a user group: 1. In the Groups window, click the user group name to delete. The name becomes highlighted.

2. Click the icon to remove the group. A confirmation dialog box appears. 3. Click OK to complete the deletion.

Moving a User to a Different Group To move an existing user to a different user group: 1. Click the name of the user to move to another group in the User Manager window and select Properties. The User Properties dialog box appears.

Figure 11: User Properties Dialog Box – Change Group

2. Select the Edit check box. 3. In the Group drop-down menu, click the user group. 4. Click OK to complete the move.

Exporting a User Database To export a user database: 1. In the User Manager’s File menu, click Export Database. The Save As dialog box appears. 2. Specify the location and file name for the database and click Save. The database is saved in a flat text file with a .txt extension.

LN-Builder 3.5 Technical Bulletin 41

Importing a User Database To import a user database: 1. In the User Manager’s File menu, click Import Database. The Open dialog box appears. 2. Select the database to import and click Open. LN-Builder imports the user database. Note: The database has a .txt extension.

Creating a Network Database To create a LNS network database: 1. In the File menu, click Create Network Database. The Creating Network Database dialog box appears.

Figure 12: Creating Network Database Dialog Box

2. Fill in the necessary fields. See Table 17.

42 LN-Builder 3.5 Technical Bulletin

Table 17: Creating Network Database Dialog Box Field Description Network Name Enter the name of the network database to create. The network name must be unique. The network name is not case sensitive (that is, you cannot create two networks with names that differ only in capitalization). If the database is located in C:\LNS, names cannot exceed 16 characters including spaces. Database Path Select the directory to store the LNS network database. You can modify this field to place the LNS network database in another directory; however, the directory name must match the network name. The network database path and file name together cannot exceed 23 characters. Initial Subsystem Enter the name of the initial subsystem (where the network is located). Subsystem names cannot exceed 85 characters, may include spaces, and are case sensitive. Names may not include the period, backslash, colon, forward slash, or double-quote characters. Domain ID Select the Domain ID by clicking the selection button located next to the field. The Current Domain ID dialog box allows you to determine the domain length and Domain ID. Description Enter an optional description of the network database. This field is used for record keeping purposes and has no effect on network operation.

3. Click OK. The newly created network appears in the Tree View pane.

Copying a Network Database You can copy and paste a network database. For example, create a typical network database and use this database to start any new projects. To copy a network database: 1. Right-click the database and select Copy. 2. In the File menu, click Paste Network Database. The Copy Network Database dialog box appears.

LN-Builder 3.5 Technical Bulletin 43

Figure 13: Copy Network Database Dialog Box

3. Edit the fields as required. See Table 18.

Table 18: Copy Network Database Dialog Box Field Description Name Enter the name of the network database to create. The network name must be unique. The network name is not case sensitive. If the database is located in C:\LNS, names cannot exceed 16 characters including spaces. Domain ID Select the Domain ID by clicking the selection button located next to the field. The Current Domain ID dialog box allows you to determine the domain length and Domain ID. Description Enter an optional description of the network database. This field is used for record keeping purposes and has no effect on network operation.

4. Click OK.

44 LN-Builder 3.5 Technical Bulletin

Defining Network Connection Settings In LN-Builder, each database can have its own connection settings saved in memory. You can configure the Network Connection Settings for one or more network databases in the Network Connection Settings dialog box. To define network connection settings: 1. In the Settings menu, click Network Interface, or double-click a specific network database in the Tree View pane. The Network Connection Settings dialog box appears.

Figure 14: Network Connection Settings Dialog Box

2. Select the desired network connection settings. See Table 19.

Table 19: Network Connection Settings Dialog Box Field Description Network Name Displays the available network databases stored on the computer. The current network connection appears first. This field is associated with the Network Access settings for the current database. You can click another network in the drop-down menu to update its Network Access settings. Network Interface Displays the type of network interface to use to connect to the database. If you are using a PCC-10 card or PCLTA-21, the network interface appears as LON1. This option becomes inactive when Network Attached is set to No. Continued on next page. . .

LN-Builder 3.5 Technical Bulletin 45

Field (Cont.) Description Management Mode Indicates if the devices in the database to which you are connecting are online. The management mode allows you to choose if the changes in the network database are sent to the physical device. See Network Management Mode. • OnNet: Opens a network database with online devices. Network Attached must be set to Yes. Changes to the network database are immediately sent to the physical devices on the network. • OffNet: Opens a network database that does not have devices physically connected to the network. Changes to the network database are not sent to the physical devices in real time. This option becomes inactive when Network Attached is set to No. Network Attached Indicates if the database is attached to the network. • Yes: Opens a network database with online devices. Management Mode must be set to OnNet. • No: Opens a network database that is not physically connected to the network. The Network Interface and Management Mode selections become inactive. If you are setting up your network database for the first time, we recommend setting Network Attached to No. This setting prevents LN-Builder from attempting to read device states, which takes time. Save as global default settings Saves the selected Network Access settings as default settings. The default settings are applied when you open a network database that has not had its Network Access settings configured. Skip this window on next Opens the network database using the default connection network connection settings without opening the Network Connection Settings dialog box.

3. Click OK. The selected network database (Network Name field) opens.

46 LN-Builder 3.5 Technical Bulletin

Connecting to a Network Database Before you connect to a network database, you must select a Connection Mode (Local Client, Remote Lightweight Client, or Remote Full Client). See the Network Connection Modes section for information on the Connection Modes. For the Local Client mode, see Selecting the Connection Mode and Connecting to a Network Database Using a Local Client. For remote clients, you must start the LNS server before connecting to the database. See Selecting the Connection Mode, Starting the LNS Server for Remote Clients, and Connecting to a Network Database Using a Remote Lightweight Client or Connecting to a Network Database Using a Remote Full Client. Note: When using LN-Builder as a remote full or remote lightweight client, you can open and modify an existing network database, but you cannot create or copy the database because it remains on the LNS server computer.

Selecting the Connection Mode To select the Connection Mode, in the Settings menu, click Connection Mode and then select one of the three connection modes. LN-Builder updates the Tree View pane with a list of available network databases that support the selected connection mode. Note: The current connection mode and Network Management Mode appear at the bottom right side of the LN-Builder interface.

LN-Builder 3.5 Technical Bulletin 47

Figure 15: LN-Builder 3.5 – Network: Library

Connecting to a Network Database Using a Local Client In the Local Client mode, all databases residing on the computer running LN-Builder appear in the Tree View pane. To connect to a network database using a local client: 1. In the Local Client mode, double-click the network database name in the Tree View pane. The Network Connection Settings dialog box appears. 2. Follow the instructions in the Defining Network Connection Settings section to configure the Network Access settings and open the database. Note: If the Skip this window on next connection option was previously selected in the Network Connection Settings dialog box, LN-Builder connects directly to the database using the default network connection settings without opening the dialog box. To change the existing connection settings, click Network Interface in the Settings menu and make the desired changes.

48 LN-Builder 3.5 Technical Bulletin

Starting the LNS Server for Remote Clients Using the Remote Client mode, you can use LN-Builder on a computer that is not hosting the LNS server. However, the LNS server must run on another computer attached to the control system network (that is, the LNS server software must be running on the computer that is hosting the network database). Skip this procedure if the LNS server is already running as required. To start the LNS server for remote clients: 1. In the Windows Start menu, click Programs > Echelon LNS Utilities > LNS Server. (In Windows 8.1 or Windows 10, click the Start icon and begin to type LNS Server while at the Start screen, then click LNS Server in the Apps results.) 2. Select a network to open. 3. Click OK. 4. Select the network interface you want to use to connect to the local network. 5. Click OK. The LNS Server dialog box appears.

Figure 16: LNS Server Dialog Box

The LNS Server dialog box displays status information for the open network. You can minimize this window for convenience. For more information on using the LNS server, open the LNS server Help file by selecting LNS Server Help from the Help menu.

LN-Builder 3.5 Technical Bulletin 49

Connecting to a Network Database Using a Remote Lightweight Client Make sure the LNS server is running on the computer that is hosting the network database before proceeding. To connect to a network database using a remote lightweight client: 1. In the Windows Start menu, click Programs > Johnson Controls > LNS Utilities > LNS Remote Client Configuration Utility. (In Windows 8.1 or Windows 10, click the Start icon and begin to type LNS Remote Client Configuration while at the Start screen, then click LNS Remote Client Configuration in the Apps results.) The LNS Remote Client Configuration Utility dialog box appears.

Figure 17: LNS Remote Client Configuration Utility Dialog Box

2. Set the Default Remote Transfer to TCP and click Add. The Add LNS Network dialog box appears. 3. If you are on the same domain as the computer running the LNS server, click the button to open a dialog box that lists all of the LNS servers on the domain. Select the LNS server hosting the network database and click OK. OR If you are not on the same domain as the computer running the LNS server, manually enter the name of the network database and the IP address of the LNS server computer. 4. Click OK. The Add LNS Network dialog box closes and the LNS Remote Client Configuration Utility dialog box reappears with the name of the selected network in the Remote Networks list. 5. Click Done. 6. Open LN-Builder and verify that LN-Builder is running in Lightweight Client mode (see Selecting the Connection Mode). LN-Builder lists the networks you selected in the LNS Remote Client Configuration Utility dialog box in the Tree View pane.

50 LN-Builder 3.5 Technical Bulletin

7. Double-click the network database to open. The Network Connection Settings dialog box appears with the default Network Interface set to Internet (you cannot change this setting). However, you can select the Network Management Mode as OnNet or OffNet. See Defining Network Connection Settings. 8. Click OK. LN-Builder connects as a remote lightweight client to the database. You can now work with the network database as desired.

Connecting to a Network Database Using a Remote Full Client Make sure the LNS server is running on the computer that is hosting the network database before proceeding. In Remote Full Client mode, LN-Builder automatically detects available networks that are shared over communication media such as TP/FT-10, LONWORKS /IP, and more. The network interface must be configured so that LN-Builder can detect the remote network. To connect to a network database using a remote full client: 1. Verify that LN-Builder is running in Full Client mode. See Selecting the Connection Mode. 2. In the Settings menu, click Network Interface. The Network Interface dialog box appears. 3. Select the desired network interface. 4. Click OK. LN-Builder detects the available networks connected to the selected media and lists them under Networks. 5. Click Close. LN-Builder lists the previously detected databases in the Tree View pane. 6. Double-click the network database to open. The network database opens in OnNet management mode.

Changing the Network Management Mode To change the Network Management mode, in the Settings menu, click Network Management Mode and OnNet or OffNet as desired. For information on these modes, see the Network Management Mode section.

LN-Builder 3.5 Technical Bulletin 51

Configuring the Network Interface Conflict Settings When opening multiple databases simultaneously, LN-Builder 3.5 must use a separate network interface to connect to each individual network. You must select one of LN-Builder’s three options to use in a conflict situation. To configure the Network Interface Conflict settings: 1. In the Settings menu, click Interface Conflict. The Network Interface Conflict dialog box appears.

Figure 18: Network Interface Conflict Dialog Box

2. Select the desired options to define how LN-Builder handles a conflict. See Table 20.

Table 20: Network Interface Conflict Dialog Box Field Description Closing the network that use Closes the network database that is using the the interface network interface and opens the selected network database with that network interface. Opening the network without Opens the selected network database attaching network interface unattached from the network. Doing nothing Does not open the selected network database. Don’t ask me this question Sets your choice as the default, and prevents again, set my choice as default the dialog box from appearing for future conflicts.

3. Click Close.

52 LN-Builder 3.5 Technical Bulletin

Disconnecting from a Network To disconnect from a network, right-click the network database in the Tree View pane and select Close. LN-Builder disconnects from the network database.

Figure 19: LN-Builder 3.5 – Disconnect Network

LN-Builder 3.5 Technical Bulletin 53

Configuring Network Properties After creating a network database, you can configure the network and display network properties. To configure network properties: 1. Right-click an open network database and select Properties. The Network Properties dialog box appears with the Attributes tab active.

Figure 20: Network Properties Dialog Box – Attributes Tab

2. Modify the fields of the Attributes tab. See Table 21.

54 LN-Builder 3.5 Technical Bulletin

Table 21: Network Properties Dialog Box – Attributes Tab Field Description Network Name This field is read-only in this dialog box. During network creation, use this field to enter the name of the network database. Network Database Path This field is read-only in this dialog box. During network creation, use this field to select the directory to store the LNS network database. Domain ID (in hex) Selects the Domain ID number in hexadecimal format by clicking the selection button located next to the field. The Current Domain ID dialog box appears allowing you to define the domain length and Domain ID. Click OK. See Figure 21 and Table 22. Network Description Allows you to enter an optional description of the network database. This field is used for record keeping purposes and has no effect on network operation.

Figure 21: Current Domain ID Dialog Box

Table 22: Current Domain ID Dialog Box Field Description Length (bytes) Allows you to select the length of the Domain ID from the drop-down menu (1, 3, or 6 bytes). Generate Automatically generates a new Domain ID. The Use randomly generated Domain ID option must be selected to use this feature. Domain ID (in hex) Allows you to enter the Domain ID in hexadecimal format. If you enter a Domain ID with fewer bytes than defined in the Length field, LN-Builder pads the ID with leading zeroes. Another option is to leave this field blank and have LN-Builder automatically generate a new Domain ID. First, select the Use randomly generated Domain ID option and click the Generate button. Use randomly generated Allows LN-Builder to generate a random Domain ID Domain ID for the network.

LN-Builder 3.5 Technical Bulletin 55

3. Select the Connections tab and modify the fields. See Table 23.

Figure 22: Network Properties Dialog Box – Connections Tab

Table 23: Network Properties Dialog Box – Connections Tab Field Description Local Network Access This field is read-only in this dialog box and (Interface) displays the network interface name. To change the network interface, close and re-open the network database. Management Mode Indicates if the devices in the database to which you are connecting are online. The management mode allows you to choose if the changes in the network database are sent to the physical device. See Network Management Mode. • OnNet: Changes to the network database are immediately sent to the physical devices on the network. • OffNet: Changes to the network database are not sent to the physical devices in real time. If LN-Builder 3.5 is not connected to the network, these options appear dimmed. Continued on next page. . .

56 LN-Builder 3.5 Technical Bulletin

Field (Cont.) Description Server Location Mode This field is read-only in this dialog box and indicates if LN-Builder is running on a computer that is acting as a local client, remote full client, or remote lightweight client in relation to the server. See Network Connection Modes. Attachment of Network This field is read-only in this dialog box and Interface indicates if LN-Builder is connected to the physical network. This field indicates the attachment state selected when you first created or opened the network (the attached value does not update in real time). To change the attachment state, close and re-open the network database.

4. Select the Credit Info tab and monitor the fields. See Table 24.

Figure 23: Network Properties Dialog Box – Credit Info Tab

Note: LNS credits only apply to the LNS Server Turbo Edition. IzoT Net Server does not use credits.

LN-Builder 3.5 Technical Bulletin 57

Table 24: Network Properties Dialog Box – Credit Info Tab Field Description Days remaining Indicates the number of days remaining if you are using deficit credits. If you are using more credits than the number you have already purchased, LN-Builder allows you to continue adding devices and work with deficit (unpurchased) credits for up to 2 weeks. After 2 weeks, LN-Builder enters a locked state until you add new credits. Deficit credits Indicates the number of deficit credits you are using. If you have used up the credits that you have purchased, LN-Builder gives you a 2-week grace period in which you can use up to 500 deficit credits. License credits Indicates the total number of credits that you are licensed to use. Max deficit credits Indicates the maximum number of credits that can be in deficit. Used credits Indicates the number of credits that are currently in use. Each node on the network corresponds to one used credit.

5. Select the Timing/Retries tab and modify the fields. See Table 25.

Figure 24: Network Properties Dialog Box – Timing/Retries Tab

Note: We recommend leaving the default values for the Timing/Retries properties. Improperly changing these values may result in poor network performance or communication errors.

58 LN-Builder 3.5 Technical Bulletin

Table 25: Network Properties Dialog Box – Timing/Retries Tab Field Description Update Interval Indicates the interval, in seconds, between attempts by LN-Builder to resynchronize information within the network database with the device image. If LN-Builder is not able to immediately update the device in real time once you have made a modification, LN-Builder tries to update the device again after this interval. The update process does not run if LN-Builder is in the OffNet network management mode. The default interval is 120 seconds. The update process runs in the background. An update interval of 0 seconds indicates that the update process is turned off. Poll Interval Indicates the interval, in seconds, between polling cycles of network variables. The default polling interval is 1 second. Repeat Timer Indicates the rate, in milliseconds, at which unacknowledged repeated messages are transmitted over the network. If you click the Reset to Default button, the value is calculated based on the network topology. Transmit Timer Indicates the interval, in milliseconds, between retries for unacknowledged and request/response network messages. If you click the Reset to Default button, the value is computed by LN-Builder based on the network topology. Retry Count Indicates the number of times an unacknowledged repeated or acknowledged message is re-sent on the network. If you click the Reset to Default button, the value is calculated based on the network topology. The retry count range is 0 to 15.

LN-Builder 3.5 Technical Bulletin 59

6. Select the Authentication tab and modify the fields. See Table 26.

Figure 25: Network Properties Dialog Box – Authentication Tab

Table 26: Network Properties Dialog Box – Authentication Tab Field Description Enable Authentication Enables authentication on the network. All routers and devices must have authentication enabled in their respective properties menus to communicate on the network. Key Modification These options are only available when Enable Authentication is selected. If you have not set up an authentication key for the network, you can set up a key using the Set new authentication key or Generate random authentication key options. • Keep current authentication key: Maintains the authentication key at its current value. • Generate random authentication key: Creates a random hexadecimal number for the authentication key. • Set new authentication key: Allows you to enter a new authentication key (see the Authentication Key description). Continued on next page. . .

60 LN-Builder 3.5 Technical Bulletin

Field (Cont.) Description Authentication Key This option is only available when Enable Authentication is selected and Key Modification is set to Set new authentication key. If you enable authentication, you must enter a key in this field. The authentication key must be 12 hexadecimal digits in length. If you enter a key with less than 12 digits, LN-Builder 3.5 adds leading zeroes to create a 12-digit key.

7. Select the Resources tab and monitor the fields. This tab provides information about your network resource usage and is only available if you are using LNS TURBO Edition. See Table 27.

Figure 26: Network Properties Dialog Box – Resources Tab

LN-Builder 3.5 Technical Bulletin 61

Table 27: Network Properties Dialog Box – Resources Tab Field Description AppDevice Count Indicates the number of AppDevices in the network database. This number includes all devices (excluding routers) that are in the network database and managed by LN-Builder. Router Count Indicates the number of routers in the network database. This number includes all routers that are in the network database and managed by LN-Builder. Exclusive Selector Pool Size Indicates the total number of exclusive selectors in the system, including the exclusive selectors that are already in use by network connections. Network variable selectors are 14-bit numbers used to identify connected network variables. Individual connections in the system are assigned a selector value and all network variables within a given connection must use the same selector. Exclusive Selector Available Indicates how many exclusive selectors are currently available for use in the system. Sharable Selector Pool Size Indicates the number of sharable selectors that exist in the system. Group IDs Allocated Indicates the how many LonTalk® Group IDs have been allocated for the system. Subnets Allocated Indicates the how many subnets have been allocated within the system. Subnets are at the second level of the three-level LonTalk addressing hierarchy (domain/subnet/device) within a LONWORKS network. Subnet addresses are at the level where routers decide whether or not to forward a packet. The same subnet cannot appear on both sides of a configured or learning router. Subnets are automatically added to a system when routers or devices are added within LN-Builder.

8. Click OK after modifying and monitoring the network properties.

62 LN-Builder 3.5 Technical Bulletin

Backing Up a Network Database To back up a network database: 1. In the File menu, click Backup Network Database. The Backup dialog box appears.

Figure 27: Backup Dialog Box

2. Select the check box next to one or more network database names, or select the All check box to select all databases. Note: You can change the backup path and backup file name by clicking in the Backup Path cell of the desired network. Click the button that appears in the cell and specify the new path and .zip file name. Use this feature to make multiple backup files of the same database with different names/locations or to differentiate backup files by date. LN-Builder replaces the previous backup file with the new backup file by default. 3. Click Backup. LN-Builder creates a folder named Backup at the same level as the directory name. You can view the backup path location in the Backup dialog box. LN-Builder places the backup file in that folder. The backup file has the same name as the network database, followed by the date and time that the backup was made and a .zip extension. The default path is C:\LNS\ Backup\.zip. Note: The LNS TURBO Edition allows you to back up a network database without closing it. To back up a network based on a previous version of the LNS server, close any plug-ins or other applications that opened the LNS network database and follow the steps in this procedure. LN-Builder automatically detects the LNS server version and closes the database if required.

Restoring a Network Database To restore an existing network database that you previously backed up: 1. In the File menu, click Restore Network Database. The Restore dialog box appears.

LN-Builder 3.5 Technical Bulletin 63

Figure 28: Restore Dialog Box

2. Select the check box next to one or more network database names, or select the All check box to select all databases. Note: You can change the file from which the database is restored by clicking within the Backup Path cell of the desired network. Click the button that appears in the cell and specify the .zip file to restore. By default, LN-Builder lists the latest .zip file that has the same name as the network in the Backup File. This option allows you to restore the database from an alternate file. 3. Click Restore. LN-Builder restores the selected database.

64 LN-Builder 3.5 Technical Bulletin

Importing a Network Database You can import network databases created from any LNS server-based network management tool. LN-Builder allows you to import a .zip file or a network folder containing the database. To import a network database: 1. In the File menu, click Import Network Database. The Importing Network dialog box appears.

Figure 29: Importing Network Database

2. To import a network database from a file folder, click the button next to Database Path. The Browse for Folder dialog box appears. Select the folder that contains the network database and click OK.

Figure 30: Browse for Folder Dialog Box

LN-Builder 3.5 Technical Bulletin 65

OR To import a network database from a backup file, click the button next to Zip File. The Open dialog box appears. Select the .zip file that corresponds to the network database and click Open. If the backup file name includes the date and time of the backup, LN-Builder removes the date and time from the name when importing the database and creating the database folder. Note: LN-Builder supports importing .zip files from any network management tool or other software that can compress a network in .zip format. 3. If you do not want to change the Domain ID, leave the Domain ID field empty. LN-Builder restores the original Domain ID. If you want to change the Domain ID, click the button next to Domain ID and change the Domain ID as required. See Table 21 and Table 22 for information on changing the Domain ID. 4. Enter a short description for the project in the Description field. Because the network description is not restored when importing a network database, this description is available in the Network Properties dialog box for future reference. 5. Click OK. LN-Builder imports the selected database, which appears in the Tree View pane. Note: When importing a database created with an older LNS server version to LN-Builder, the database is updated to the newer LNS server version. The updated database is no longer compatible with the older LNS server version. Back up the database before updating the LNS server version of the database.

66 LN-Builder 3.5 Technical Bulletin

Deleting a Network Database IMPORTANT: When you delete a Network Database, LN-Builder 3.5 deletes the network database and all files and subfolders. To delete a network database: 1. In the File menu, click Delete Network Database. The Delete Databases dialog box appears.

Figure 31: Delete Databases Dialog Box

2. Select the network database from the Database drop-down menu and click Delete. Note: To delete all network databases listed in the Database drop-down menu, click Delete All.

LN-Builder 3.5 Technical Bulletin 67

Defragmenting a Network Database You can defragment a network database to reduce its size and optimize access time. Use this procedure with databases that have undergone many changes and have increased in both size and inefficiency. To defragment a network database: 1. Close all LNS applications, except LN-Builder. 2. In the File menu, click Defragment Network Database. The Defragment dialog box appears.

Figure 32: Defragment Dialog Box

3. Select the database to defragment from the Database drop-down menu and click Defragment. LN-Builder defragments the selected database after backing up the database. Note: To defragment all network databases listed in the Database drop- down menu after backing up the databases, click Defragment All.

68 LN-Builder 3.5 Technical Bulletin

Creating a Channel To add a channel: 1. In the Network menu, click Channel Manager. The Channel Manager appears with the Add New Channel tab active.

Figure 33: Channel Manager – Add New Channel Tab

2. Select the desired channel settings. See Table 28.

Table 28: Channel Manager – Add New Channel Tab Field Description Channel Name Allows you to enter a channel name. Transceiver Type Allows you to select the correct type of transceiver to use. Number Maximum of Priority Keep the default setting. Slots Delay Keep the default setting. Description Allows you to enter a description for the channel.

3. Click Add. The Channel Manager creates a new channel. 4. Repeat the previous steps if necessary, depending on the total number of channels you need for your system. 5. Click the List of Channels tab to see the list of channels.

LN-Builder 3.5 Technical Bulletin 69

Figure 34: Channel Manager – List of Channels Tab

Note: The list of channels allows you to see existing channel names and their transceiver type. You can select channels and delete them by clicking the Remove button. For more information about a channel name, see Viewing and Modifying Channel Properties.

Viewing and Modifying Channel Properties To view or modify channel properties: 1. Change the display mode to Display on Channels by clicking the channel view button ( ) in the toolbar. 2. In the Network menu, click Channel Manager. The Channel Manager appears with the Add New Channel tab active. 3. Click the List of Channels tab. 4. Right-click the desired channel and click Properties. The Channel Properties dialog box for the selected channel appears. 5. View and modify the channel properties as desired. See Table 29.

70 LN-Builder 3.5 Technical Bulletin

Figure 35: Channel Properties Dialog Box

Table 29: Channel Properties Dialog Box Field Description Name Displays the name of the channel. You can modify this field. The name must be fewer than 85 characters. Handle Displays the handle of the channel assigned by the LNS server. Maximum Priority Slots Displays the maximum number of priority slots available for the channel type. You can modify this field if a custom transceiver type is selected. Refer to your custom transceiver documentation for information. Transceiver Type Displays the type of transceiver used on the channel. You can modify this field. Delay Displays the average expected time for a queued packet to be sent to the network. You can modify this field. Click the Default button to use the channel’s default value or enter the desired delay value in milliseconds. Refer to your transceiver documentation for more information. Device Count Displays the number of devices installed on the channel. Router Count Displays the number of routers installed on the channel. Description Displays the description of the channel.

6. Click OK.

LN-Builder 3.5 Technical Bulletin 71

Adding a Router You can add a router after creating the necessary channels. To add a router: 1. In the Tree View pane, right-click the subsystem to which you want to add a router and select Add > Router. The Adding Router wizard appears with the Commission screen active.

Figure 36: Adding Router Wizard – Commission

2. Modify the fields. See Table 30.

Table 30: Adding Router Wizard – Commission Field Description Name Enter the name of the router. The name must be less than 85 characters. Commission Device Select this box if LN-Builder and the router are physically attached to the network. Leave the box empty if you plan to commission the device later. This option is normally used during network database engineering.

72 LN-Builder 3.5 Technical Bulletin

3. Click Next. The Near Side and Far Side Channels screen appears.

Figure 37: Adding Router Wizard – Near Side and Far Side Channels

Figure 38: Near Side and Far Side Channels

4. Modify the fields. See Table 31.

Table 31: Adding Router Wizard – Near Side and Far Side Channels Field Description Near Side Channel Set the near side channel by using the drop- down menu. The near side is the half of a router that has a direct path to the network interface. Far Side Channel Set the far side channel by using the drop- down menu. The far side is the half of a router that does not have a direct path to the network interface. The network interface communicates with the far side of a router indirectly through the near side. Location Click Ascii or Hex and enter the router’s location string. For the Ascii option, enter a six-digit American Standard Code for Information Interchange (ASCII) text string. For the Hex option, enter a twelve-digit hex string.

LN-Builder 3.5 Technical Bulletin 73

5. Click Next. The Router Type screen appears.

Figure 39: Adding Router Wizard – Router Type

6. Modify the fields. See Table 32.

Table 32: Adding Router Wizard – Router Type Field Description Router Type (Name) Set the type of router by using the drop-down menu. You can configure routers to act as configured routers, learning routers, repeaters, permanent repeaters, bridges, or permanent bridges. The default type is Configured Router, which is the recommended setting for optimal performance and reliability. Description Enter a description for the router. This field is used for record keeping purposes and has no effect on network operation.

74 LN-Builder 3.5 Technical Bulletin

7. Click Next. The Device Identification Method screen appears.

Figure 40: Adding Router Wizard – Device Identification Method

8. Modify the fields. See Table 33.

Table 33: Adding Router Wizard – Device Identification Method Field Description Device Identification Method Select Service Pin if the router is already connected to the network and can be easily accessed. This option is not active if you left the Commission Device box empty in the Commission screen of the Adding Router wizard. Select Manual Entry if the router is not connected to the network and you know the router’s Neuron ID (typically found on a sticker on the router) or if you are using a bar code scanner. You can commission the router at a later time. If you select Manual Entry, enter the Neuron ID in the Neuron ID field. If you do not know the router’s Neuron ID, you can enter it when you commission the device at a later time. Ping Interval Set the desired ping interval. See Ping Interval and Configuring the Ping Interval. Initial State Set the router’s initial state. Select Online to put the router in the online state. The device’s application binary file executes when online. Select Offline to put the router in the offline state. The device’s application binary file stops running when offline.

LN-Builder 3.5 Technical Bulletin 75

9. Set the Ping Interval to Short. 10. In Configuration Properties, click Default Values. 11. Set the Initial State to Online. Click Finish. The router is added to the network. Note: If you select the Service Pin device identification method, LN-Builder 3.5 prompts you to press the service pin. The device’s Neuron ID is broadcast over the network.

Commissioning a Router To commission a router: 1. Right-click the router that you want to commission and then click Commission. The Commission Router dialog box appears.

Figure 41: Commission Router Dialog Box

2. Modify the fields. See Table 34.

76 LN-Builder 3.5 Technical Bulletin

Table 34: Commission Router Dialog Box Field Description Name Displays the name of the router. This field is read-only. Device Identification Method Select Service Pin if the router is already connected to the network and can be easily accessed. This option is not active if you left the Commission Device box empty in the Commission screen of the Adding Router wizard. Select Manual Entry if the router is not connected to the network and you know the router’s Neuron ID (typically found on a sticker on the router) or if you are using a bar code scanner. If you select Manual Entry, enter the Neuron ID in the Neuron ID field. Ping Interval Select the desired ping interval. See Ping Interval and Configuring the Ping Interval. Initial State Select the router’s initial state. Select Online to put the router in the online state. The device’s application binary file executes when online. Select Offline to put the router in the offline state. The device’s application binary file stops running when offline.

3. Click Finish. Note: If you select the Service Pin device identification method, LN-Builder prompts you to press the service pin. The device’s Neuron ID is broadcast over the network.

LN-Builder 3.5 Technical Bulletin 77

Viewing and Modifying Router Properties The properties in the Router Properties dialog box are mostly read-only properties that were set when you added and commissioned the router. To view or modify Router Properties: 1. Right-click a router and click Properties. The Router Properties dialog box appears with the Attributes tab active.

Figure 42: Router Properties Dialog Box – Attributes Tab

2. View and modify the fields of the Attributes tab. See Table 35.

78 LN-Builder 3.5 Technical Bulletin

Table 35: Router Properties Dialog Box – Attributes Tab Field Description Name Displays the name of the router. This field is read-only. The name is limited to 85 characters. Commission Status Displays the current commissioning status of the router. • Commission Updates Pending: Indicates that the commissioning updates are in progress or pending. If you make database changes that affect a device’s configuration, this value denotes the commission status of the device. The commission status changes from Commission Updates Pending to Commission Updates Current or Commission Updates Failed depending on whether the updates succeeded or failed. • Commission Updates Current: Indicates that there are no commissioning updates pending. • Commission Updates Failed: Indicates that the commissioning updates are currently in progress or pending and that the most recent update attempt failed. Application State Displays the state of the application binary in the router. • Online: Indicates that the device’s application binary file is executing. • Offline: Indicates that the device’s application binary file is not running. • Not Available: Indicates the reason why the router is not available, such as Not Attached if the network is not attached. Near Side Displays the name of the channel connected to the near side of the router. The Handle field displays the handle number of the near side channel. Far Side Displays the name of the channel connected to the far side of the router. The Handle field displays the handle number of the far side channel. Subsystems Displays a list of subsystems in which this router appears. If the router is part of a nested subsystem, it displays with all parent and child subsystems in the hierarchy.

LN-Builder 3.5 Technical Bulletin 79

3. Click the Identifiers tab and view or modify the fields. See Table 36.

Figure 43: Router Properties Dialog Box – Identifiers Tab

Table 36: Router Properties Dialog Box – Identifiers Tab Field Description Subnet/Node ID Indicates the subnet and node for the router. Each router and network device has its own Subnet/Node ID (address). LN-Builder 3.5 assigns an ID when the router is created. The ID is used to address messages to the correct recipient. Firmware Version Indicates the firmware version running on the Neuron chip within the router. Model Number Indicates the device’s Neuron chip model. Current Neuron ID Indicates the current Neuron IDs for each physical router side. Pending Neuron ID Indicates the pending Neuron IDs for each side of the router. The current and pending Neuron IDs may be different when a router is being commissioned for the first time, or if you are replacing the physical router and the update is pending.

80 LN-Builder 3.5 Technical Bulletin

4. Click the Basic tab and view/modify the fields. See Table 37.

Figure 44: Router Properties Dialog Box – Basic Tab

Table 37: Router Properties Dialog Box – Basic Tab Field Description Location Indicates the router’s location string and type. For the Ascii option, the location is a six-digit ASCII text string. For the Hex option, the location is a twelve-digit hex string. This field provides documentation of the router’s location within the network and has no effect on network operation. Ping Interval Indicates the ping interval for the router. Pinging tests if a particular router is operating properly and is reachable on the network. The ping interval determines how often a router is pinged to make sure the router is communicating with the network. See Ping Interval and Configuring the Ping Interval. Description Displays the description of the router you entered in the Adding Router wizard. This field provides additional documentation and does not impact the network’s operation.

5. Click the Advanced tab and view or modify the fields. See Table 38.

LN-Builder 3.5 Technical Bulletin 81

Figure 45: Router Properties Dialog Box – Advanced Tab

82 LN-Builder 3.5 Technical Bulletin

Table 38: Router Properties Dialog Box – Advanced Tab Field Description Router Type Indicates the type of router. Options include configured routers, learning routers, repeaters, permanent repeaters, bridges, or permanent bridges. The default type is Configured Router, which is the recommended setting for optimal performance and reliability. Configured Router: Decides which packets to forward to their far side channel based on internal routing tables. The routing tables are stored in non-volatile memory and the data within them is not lost after a reset. The routing tables manage the forwarding of subnet and group addressed data packets. If no group members are on the far side of the router, then the messages meant for that group are not transmitted on the far side channel. LN-Builder automatically sets up the routing tables based on network topology. The recommended router type for your network is Configured Router. Configured routers allow LN-Builder to optimize network traffic and to automatically detect the channel to which each device is connected. Configured routers can act as redundant routers between channels. Redundant routers provide fault tolerance because if one of the routers connecting two channels fails, the other router maintains the connection. Learning Router: Decides which packets to forward to their far side channel based on internal routing tables. Learning routers store routing tables in volatile memory and the data within them is lost after a device reset. After a reset, the learning router broadcasts packets addressed to all subnets in the application domain. Each time the learning router receives a packet, it uses the source subnet ID to determine the network topology. The routing tables have one entry for each subnet in the application domain. When the router receives a packet, it sets the corresponding routing table entry to indicate the direction of the subnet. A learning router always broadcasts all group- addresses messages. Repeater: Extends the length of a channel. Repeaters do not make use of routing tables and simply forward all packets along the extended physical channel. Use a repeater to double the physical length of the channel and to double the number of devices that can be connected to the channel. Permanent Repeater: A repeater whose type cannot be changed after creation. Bridge: Connects two network domains. The bridge forwards valid packets from one domain to another. In a single domain network, a bridge acts as a repeater. Permanent Bridge: A bridge whose type cannot be changed after creation. Authentication Indicates if you enabled authentication in LN-Builder. You can only set routers to use authentication if authentication was already enabled in LN-Builder. Priority Indicates whether priority is being used by the router on its near side and far side channels. These options also indicate if priority slots are determined automatically or manually.

LN-Builder 3.5 Technical Bulletin 83

6. Click the Buffers tab and view or modify the fields. See Table 39.

Figure 46: Router Properties Dialog Box – Buffers Tab

Table 39: Router Properties Dialog Box – Buffers Tab Field Description Buffer Type Provides buffer data. The router can have three types of buffers on each side (near side and far side): • Input: Receives LonTalk messages. • Output: Sends LonTalk messages. • Priority Output: Sends LonTalk messages that have the priority attribute set. Buffer Size Indicates the memory, in bytes, allocated to the buffer. Buffer Count Indicates the number of buffers for that buffer type. Memory Indicates the total amount of memory, in bytes, available for the buffers on the particular side of the router. Note: Refer to your router’s documentation for more information on these properties and to check if the router supports changing the buffer properties using an LNS server-based management tool. Buffer values are automatically set during installation and generally do not need to be changed.

Note: Changing buffer values can adversely impact your network. 7. Click OK.

84 LN-Builder 3.5 Technical Bulletin

Adding a Subsystem To add a subsystem: 1. Right-click the network to which to add the subsystem and click Add > Subsystem. The Add Subsystem dialog box appears. Note: To create a nested subsystem, right-click the subsystem name in the Tree View pane and click Add > Subsystem.

Figure 47: Add Subsystem Dialog Box

2. Modify the fields. See Table 40.

Table 40: Add Subsystem Dialog Box Field Description Name Enter a name for the subsystem. The name must be unique within the subsystem and is limited to 85 characters. Number of subsystem to Enter or select the number of subsystems to create create. When creating more than one subsystem, LN-Builder creates new subsystems and enumerates them. The maximum number of subsystems you can create in one operation is 100. For nested subsystems, you can create up to 5 subsystems at a time. Nested Select this option to nest subsystems. A nested subsystem is a subsystem inside another subsystem.

Note: When you copy a subsystem, all devices in the subsystem are also copied. You can create a new subsystem by copying an existing subsystem, creating the network bindings for the new subsystem, and then commissioning the devices 3. Click OK.

LN-Builder 3.5 Technical Bulletin 85

Viewing or Modifying Subsystem Properties To view or modify subsystem properties: 1. Right-click a subsystem and click Properties. The Subsystem Properties dialog box appears with the Attributes tab active.

Figure 48: Subsystem Properties Dialog Box – Attributes Tab

2. View or modify the fields. See Table 41.

Table 41: Subsystem Properties Dialog Box – Attributes Tab Field Description Name Indicates the name of the subsystem. The name must be unique within the subsystem and is limited to 85 characters. Parent Indicates the parent subsystem for nested subsystems. The parent is the root subsystem, which is the network name. Description Enter a description for the subsystem. This field is used for record keeping purposes and has no effect on network operation.

86 LN-Builder 3.5 Technical Bulletin

3. Click the Devices tab and view the fields for information about the devices in the subsystem.

Figure 49: Subsystem Properties Dialog Box – Devices Tab

4. Click OK.

Installing Plug-ins Plug-ins may be supplied with the device but may also be available on the device’s website. Before you install a plug-in, verify that you have the latest version available. To install a plug-in, follow the plug-in’s instructions.

LN-Builder 3.5 Technical Bulletin 87

Registering Plug-ins You only need to install device plug-ins once; however, you need to register the plug-ins for each network database. For most devices, plug-in registration automatically creates the device template. The Register Plug-Ins dialog box opens when a database is opened unless the Skip this window at next startup option has been checked. To register plug-ins: 1. Open the Register Plug-Ins dialog box, if necessary. • Click any of the following main menu items: File, Network, Subsystem, Device, or LonMarkObject and click Plug-Ins () > Register.

• Right-click a network, subsystem, device, or LONMARK object in the Tree View or List View pane and click Plug-Ins () > Register.

Figure 50: Register Plug-Ins Dialog Box

88 LN-Builder 3.5 Technical Bulletin

2. In the Register Plug-Ins dialog box, click the plug-ins to add in the Not Registered list and then click Add. The plug-ins appear in the To Register list. See Table 42. Note: You also can double-click a plug-in to add it to the To Register list. Select multiple plug-ins by holding down the Ctrl key while clicking items. Click Add All to register all unregistered plug-ins at once.

Table 42: Register Plug-Ins Dialog Box Field Description Already Registered Lists the registered plug-ins for the network being configured. If any plug-ins have changed in such a way that they need to be registered again, you can select them and click the Register Again button. To remove the registration of a plug-in, select it and click the Deregister button. Click Deregister All to remove the registration of all registered plug-ins at once. Once you use the Deregister or Deregister All button, the plug-ins are no longer available in the network database. You can register them at a later time, if needed. Not Registered Lists the unregistered plug-ins installed on the computer. Select the desired plug-ins and click the Add or Add All button as necessary. To Register Lists all the plug-ins to register when the network properties are updated (that is, when you click OK in this dialog box). To remove plug-ins from this list, select the desired plug-ins and click the Remove or Remove All button as necessary. Skip this window on next Determines if the Register Plug-Ins dialog box startup appears each time the network database is opened. If you do not expect to need additional plug-ins, select this option to skip this dialog box.

3. Click OK. LN-Builder registers the specified plug-ins. The registration process may take several minutes, depending on the number of plug-ins being registered and the speed of the computer.

LN-Builder 3.5 Technical Bulletin 89

Launching Plug-ins You can only launch a plug-in after you register it for the selected network database. There are different ways to launch a plug-in, depending on plug-in type (network, subsystem, device, or LONMARK object) and purpose (Monitor, Configure, or Browse). To launch a plug-in, do one of the following: • Click any of the following main menu items: File, Network, Subsystem, Device, or LonMarkObject, and then select Plug-Ins (). Then click the desired plug-in in the list.

• Right-click a network, subsystem, device, or LONMARK object from the Tree View or List View pane, and then select Plug-Ins (). Then click the desired plug-in in the list.

• Right-click a device or LONMARK object and click Browse > Configure or Monitor.

• Double-click one of the action icons from the main menu toolbar: (Browse), (Configure), or (Monitor). Then double-click the desired device or LONMARK object.

90 LN-Builder 3.5 Technical Bulletin

Adding a Device Template To add a device template: 1. In the Network menu, click Device Templates. The Device Template Manager dialog box appears.

Figure 51: Device Template Manager Dialog Box

2. To create a new device template, enter a name for the new template and select an XIF file. OR To use an existing device template, click it in the Device Templates (Exist) list. See Table 43.

LN-Builder 3.5 Technical Bulletin 91

Table 43: Device Template Manager Dialog Box Field Description Name Enter a name for the new device template. The name must be unique within the subsystem and is limited to 85 characters. XIF File Enter the file name and path or browse to the external interface (XIF) file from which the device template is imported. Device Template (Exist) Lists all existing device templates available for your network. • Name: Indicates the device template name. To rename the template, right- click the name and select Rename. Change the name as required. • Program ID: Indicates the program ID associated with the device template. To delete a device template, select the plug-in to remove and click the Delete button. To successfully delete a device template, no devices can be associated with the selected template. To select all plug-ins, select the All check box. Resynchronize checked Allows you to update the names of the templates to device resource configuration properties, LONMARK objects, files and network variables on the device during resynchronization. Use this option to update an existing device template. For example, a device template originally uploaded from a device can later be updated when the XIF file becomes available. The XIF file contains additional information from a device upload, such as network variable names and default configuration property values. Select Do not propagate the change to device to modify only the device template object name.

3. Click Add.

92 LN-Builder 3.5 Technical Bulletin

Updating a Device Template You can update an existing device template to include newly updated templates using LNS Server Turbo. You can also update the device template to use older versions of a specific template. When you update the device template, it updates the NVs associated with the template and LONMARK object names only. To update a device template: 1. In the Network menu, click Device Template. The Device Templates dialog box appears. 2. Click Browse and select the XIF file. Note: If the XIF file is already created, the Add button automatically changes to an Update button. 3. Click Update to complete the process.

Adding a Device to a Network There are two different ways to add a device to the network. The first method is to add a device using this procedure. The second method is to copy an existing device. The copy operation also copies the configuration properties of the device. Use the copy technique when you need to use multiple devices that have the same configuration. To add a device to a network: 1. In the Tree View pane, right-click the subsystem to which you want to add a device and click Add > Device. The Add Device wizard appears with the Device Name and Description screen active.

Figure 52: Add Device Wizard – Device Name and Description

2. Modify the fields. See Table 44.

LN-Builder 3.5 Technical Bulletin 93

Table 44: Add Device Wizard – Device Name and Description Field Description Device Enter a name for the device. The name must be unique within the subsystem and is limited to 85 characters. The device name cannot include colon, forward slash, period, backslash, or double-quote characters. Commission Device Select this option to execute the definition and commissioning steps simultaneously. Use this option only if the device is physically attached to the network. This option is inactive when creating multiple devices. New Device Number Select the number of devices to create. When creating more than one device, LN-Builder automatically modifies the names of the devices by appending underscores and numbers to the end of the device names (for example, RTU becomes RTU_1 and RTU_2). If the device name in the Device field ends with an underscore followed by a number, LN-Builder automatically increments the number for the subsequent devices. Description Enter a description for the device. This field is used for record keeping purposes and has no effect on network operation.

3. Click Next. The Channel and Location screen appears.

Figure 53: Add Device Wizard – Channel and Location

4. Modify the fields. See Table 45.

94 LN-Builder 3.5 Technical Bulletin

Table 45: Add Device Wizard – Channel and Location Field Description Device Channel Select Auto-Detect or Specify: • Auto-Detect: LN-Builder automatically detects the channel to which the device is attached. This option only works if LN-Builder is attached to the network and all routers are defined, installed, commissioned, and online. Otherwise, LN-Builder displays an error during commissioning. You cannot use the Auto-Detect option with routers that are configured as repeaters or bridges. • Specify: Allows you to select the channel to which you want to attach the device. Click the Create button to create a channel as required. Location Enter the device’s location string and type. For the Ascii option, the location is a six-digit ASCII text string. For the Hex option, the location is a twelve-digit hex string. This field provides documentation of the device’s location within the network and has no effect on network operation.

5. Click Next. The Define XIF and APB screen appears.

Figure 54: Add Device Wizard – Define XIF and APB

6. Modify the fields. See Table 46.

LN-Builder 3.5 Technical Bulletin 95

Table 46: Add Device Wizard - Define XIF and APB Field Description External Interface Definition Select the method to load the XIF definition: • Load from template: Uses an existing device template from the Template Name drop-down menu to define the device. If the required device template does not exist, register the device plug-in or click the Create button to create a new template. See Registering Plug-ins or Adding a Device Template. • Load from XIF: Uses a XIF file to create the new device template. Enter a path name or click Browse to locate the file. Enter the Template Name when using this option. Otherwise, the XIF file name is the default name of the template. • Ad hoc (Upload from Device): Creates a new device template from the device interface definition stored in the device. The definition is uploaded directly from the device. This option is available when LN-Builder is attached to the network (even when set to OffNet) and the device is attached to the network. Enter the Template Name when using this option. Otherwise, the XIF file name is the default name of the template. Application Image Select whether to load an application image. All devices contain an application image file (.apb file) that governs the behavior of the device. The desired .apb file may be preloaded in the device when purchased or may come as a stand-alone file to load into the device upon commissioning. If the device you are commissioning is based on a Neuron chip with writable application memory, you can load an .apb or .nxe file onto the Neuron chip using the Load Image option and specifying the location of the file to load. If you select Load from XIF option in the External Interface Definition box, LN-Builder automatically selects the compatible .apb file from the template. Make sure that the desired .apb file is installed on your computer. This option is inactive if you did not select the Commission Device option in the Device Name and Description screen of the Add Device wizard.

96 LN-Builder 3.5 Technical Bulletin

7. Click Next. The Configuration Properties screen appears.

Figure 55: Add Device Wizard – Configuration Properties

8. Modify the fields. See Table 47.

LN-Builder 3.5 Technical Bulletin 97

Table 47: Add Device Wizard – Configuration Properties Field Description Ping Interval Set the ping interval for the device. Pinging tests if a particular device is operating properly and is reachable on the network. The ping interval determines how often a device is pinged to make sure the device is communicating with the network. Select the desired ping interval. See Ping Interval and Configuring the Ping Interval. Configuration Properties Select one of the following options: • Default Values: Reverts the configuration properties of the device to the default values stored in the device template. • Values in device: Obtains the current configuration properties from the physical device and saves them to the LNS network database. • Values in image file: Reverts the configuration properties of the device to the values included in the application image file (.apb file) and overwrites any configuration changes you may have made to the device. This option is only available in if you select Load Image. These options overwrite any configuration changes made to the device. Initial State Set the device’s initial state. Select Online to put the device in the online state. The device’s application binary file executes when online. Select Offline to put the device in the offline state. The device’s application binary file stops running when offline.

9. Click Next. The Device Identification Method screen appears.

98 LN-Builder 3.5 Technical Bulletin

Figure 56: Add Device Wizard – Device Identification Method

10. Modify the fields. See Table 48.

Table 48: Add Device Wizard – Device Identification Method Field Description Devices Lists all the devices to add to the network database, including their device name, template, Neuron ID, and status properties. To change the device name, click the name in the Name column. To enter the Neuron ID manually or using a bar code scanner, click the ID in the Neuron ID column (when Device Identification Method is set to Manual Entry). The Neuron ID appears as red text if the ID is not valid because it is too short or long (wrong number of digits) or it is already in use. Device Identification Method Select Service Pin if the device is already connected to the network and can be easily accessed. This option is not active if you left the Commission Device box empty in the Commission screen of the Add Device wizard. Select Manual Entry if the device is not connected to the network and you know the device’s Neuron ID (typically found on a sticker on the device) or if you are using a bar code scanner. If you select Manual Entry, enter the Neuron ID in the Neuron ID column in the Devices box.

11. Click Finish.

LN-Builder 3.5 Technical Bulletin 99

Note: If you select the Service Pin device identification method, LN-Builder 3.5 prompts you to press the service pin. The device’s Neuron ID is broadcast over the network. An error message appears in LN-Builder if you try to load an incompatible .apb file into a device. However, this message does not appear if the Program ID Check option in the LN-Builder Settings menu is disabled.

Configuring a Device Using a Plug-in To configure a device using a plug-in: 1. Identify the plug-in type. 2. In the Tree View pane, right-click the object that corresponds to the type of plug-in and then click Plug-Ins (). 3. Select the appropriate configuration plug-in from the list. 4. Once the plug-in starts, configure the group of devices, device, or object as desired. Refer to the plug-in’s user guide or help for more information.

Configuring a Device Using Configuration Properties To configure a device using configuration properties: 1. Right-click the desired configuration property in the List View pane and then click Properties. The Config Property Properties dialog box appears with the Description tab active.

100 LN-Builder 3.5 Technical Bulletin

Figure 57: Config Property Properties Dialog Box – Description Tab

2. View or modify the fields of the Description tab. See Table 49.

LN-Builder 3.5 Technical Bulletin 101

Table 49: Config Property Properties Dialog Box – Description Tab Field Description Name Indicates the name of the configuration property. Network Indicates the name of the network database in which the device is located. Subsystem Indicates the name of the subsystem in which the device is located. Device Indicates the name of the device in which the configuration property is located. Functional Block Indicates the name of the functional block in which the configuration property is located. NV Name Indicates the name of the network variable in which the configuration property is located. This field is often blank, because the configuration property is not necessarily part of a network variable and may reside in functional block at the same level as a network variable. Format Name Indicates the display format of the configuration property. The display format defines the resolution for a configuration property as well as the format. For example, if a configuration property deals with temperature, the display format may define if the configuration property is displayed in °C or °F. The display format allows LN-Builder 3.5 to display an ASCII representation of the meaning of a binary value (that is, if you have a 64-bit network variable output VAV state, instead of displaying the actual 64-bit binary value, you can map the value to meaningful ASCII text such as Hot Air or Economizer). Description Allows you to enter a description for the configuration property. This field is used for record keeping purposes and has no effect on network operation. Url Indicates the path for the configuration property within the network database hierarchy in the following format: // //

102 LN-Builder 3.5 Technical Bulletin

3. Select the LONMARK tab and view or modify the fields. See Table 50.

Figure 58: Config Property Properties Dialog Box – LONMARK Tab

Table 50: Config Property Properties Dialog Box – LONMARK Tab Field Description Functional profile name Indicates the name of the configuration property as externally represented to the network installer. Functional profile Indicates the name of the configuration programmatic name property as internally represented to the Neuron C application. Functional profile description Describes the configuration property type. Type Index Indicates the type index of the configuration property. If the configuration property is a Standard Configuration Property Type (SCPT), this value is the standard file type index. If the configuration property is a User Configuration Property Type (UCPT), this value is the user file type index. Dimension Indicates the number of elements within the configuration property. A value of 1 indicates a single element, whereas a value of 2 or higher signifies multiple elements (that is, an array).

LN-Builder 3.5 Technical Bulletin 103

4. Select the Attributes tab and view or modify the fields. See Table 51.

Figure 59: Config Property Properties Dialog Box – Attributes Tab

104 LN-Builder 3.5 Technical Bulletin

Table 51: Config Property Properties Dialog Box – Attributes Tab Field Description Length Indicates the length, in bytes, of the configuration property. The length of a configuration property is determined by its type. Mode Indicates if the configuration property is a Standard Configuration Property Type (SCPT) or User Configuration Property Type (UCPT). For a UCPT, this field indicates how to reference the corresponding resource file. Type Indicates the type of the configuration property. Flags Indicates the parameters for the configuration object and the circumstances under which the configuration can be modified. Flags include: • Normal • Modify only when disabled • Modify only when Offline • Read only • Reset after modification • Modify only during manufacture Must read from device: The value of the configuration property can only be obtained from the device. To read a value, verify that LN-Builder is set to OnNet and the device is configured. If LN-Builder is set to OffNet, the following error appears: Could not find value for the specified configuration property (Subsystem: NS, #113) If LN-Builder is set to OnNet and the device is not configured, the following error appears: The device must be assigned a Neuron Id for this operation to complete. (Subsystem: NS, #37) Default Value Indicates the default value of the configuration property. Current Value Indicates the current value of the configuration property. Inherits Type Indicates if the configuration property inherits its type from its associated network variable.

5. Click OK.

LN-Builder 3.5 Technical Bulletin 105

Using the Extension Viewer Use this procedure to view the data objects stored in the database extension. To use the extension viewer: 1. In the Network menu, click Extension Viewer. The Extension View dialog box appears.

Figure 60: Extension View Dialog Box

2. Browse to the network database in the Tree View and click the desired object. The Extensions list displays the extensions of the selected object. 3. Click Close when done.

106 LN-Builder 3.5 Technical Bulletin

Commissioning a Device Once you have defined a device in the network database, you can commission the device. To commission a device: 1. Right-click the device that you want to commission and click Commission. The Commission Device wizard appears with the Define XIF and APB screen active.

Figure 61: Commission Device Wizard – Define XIF and APB

2. Modify the fields. See Table 52.

LN-Builder 3.5 Technical Bulletin 107

Table 52: Commission Device Wizard – Define XIF and APB Field Description Device Select one or more devices to commission. You can commission multiple devices in one operation. Use the Ctrl and Shift keys to select multiple devices. External Interface Definition Indicates the selected device’s method of loading the XIF definition. • Load from template: Uses an existing device template from the Template Name drop-down menu to define the device. • Load from XIF: Uses an XIF file to create the new device template. • Ad hoc (Upload from Device): Creates a new device template from the device interface definition stored in the device. Application Image Set whether to load an application image into the selected devices. When using the Load Image option, specify the location of the file to load. The most recent .apb file that is compatible with the previously selected device template is automatically detected. You can simultaneously load the same application image into multiple devices only when the selected devices are of the same type. This functionality is not allowed if the selected devices are not all of the same type.

3. Click Next. The Configuration Properties screen appears.

Figure 62: Commission Device Wizard – Configuration Properties

4. Modify the fields. See Table 53.

108 LN-Builder 3.5 Technical Bulletin

Table 53: Commission Device Wizard – Configuration Properties Field Description Ping Interval Set the ping interval for the device. Pinging tests if a particular device is operating properly and is reachable on the network. The ping interval determines how often a device is pinged to make sure the device is communicating with the network. See Ping Interval and Configuring the Ping Interval. Configuration Properties Select one of the following options: • Default Values: Reverts the configuration properties of the device to the default values stored in the device template. This option overwrites any configuration changes made to the device. • Values In Database: Takes the current configuration properties from the database and loads them in the device. This option overwrites the configuration in the device. • Values In Device: Obtains the current configuration properties from the physical device and saves them to the LNS network database. This option overwrites the configuration in the database. • Values In Image File: Reverts the configuration properties of the device to the values in the application image file (.apb file). This option is only available if Load Image is selected and overwrites any configuration changes made to the device. Initial State Set the device’s initial state. Select Online to put the device in the online state. The device’s application binary file executes when online. Select Offline to put the device in the offline state. The device’s application binary file stops running when offline. Note: If you select multiple devices, the settings are applied to all of the selected devices.

5. Click Next. The Device Identification Method screen appears.

LN-Builder 3.5 Technical Bulletin 109

Figure 63: Commission Device Wizard – Device Identification Method

6. Modify the fields. See Table 54.

Table 54: Commission Device Wizard – Device Identification Method Field Description Devices Lists all the devices to commission, displaying their device name, template, Neuron ID, and status properties. To change the device name, click the name in the Name column. To enter the Neuron ID manually, click the ID in the Neuron ID column (when Device Identification Method is set to Manual Entry), or use a bar code scanner. The Neuron ID appears as red text if the ID is not valid because it is too short or long (wrong number of digits) or it is already in use. Device Identification Method Select Service Pin if the device is already connected to the network and can be easily accessed. Select Manual Entry if the device is not connected to the network and you know the device’s Neuron ID (typically found on a sticker on the device) or if you are using a bar code scanner. If you select Manual Entry, enter the Neuron ID in the Neuron ID column in the Devices box for each device.

110 LN-Builder 3.5 Technical Bulletin

7. Click Finish. An error message appears in LN-Builder if you try to load an incompatible .apb file into a device. However, this message does not appear if the Program ID Check option in the LN-Builder Settings menu is disabled.

IMPORTANT: If the Program ID Check menu option has been disabled, make sure that you are loading a compatible .apb file before you begin. Loading an incompatible .apb file with the Program ID Check menu option disabled prevents the error message from appearing and may damage the Neuron chip in the device and the device itself. Note: If you select the Service Pin device identification method, LN-Builder prompts you to press the service pin for each selected device. The device’s Neuron ID is broadcast over the network.

Figure 64: Service Pin Dialog Box

LN-Builder compares the Program ID of the device template in the network database with the Program ID of the application in the device. If the Program IDs do not match, an error message appears in the Status field.

Figure 65: Service Pin Dialog Box – Status Information

Table 55 describes the fields of the Service Pin dialog box.

LN-Builder 3.5 Technical Bulletin 111

Table 55: Service Pin Dialog Box Field Description Press the service pin on the Indicates the name of the device for which the device service pin must be pressed. Status Displays an error message if LN-Builder cannot commission the device. Neuron ID Displays the last Neuron ID received from the service pin identification method. Received PID Displays the Program ID of the device application being commissioned. Template PID Displays the Program ID of the selected device template. Check Program ID When selected, LN-Builder only compares the Program ID of the device template in the network database with the Program ID of the application in the device. LN-Builder does not commission the device. Leave this box empty to load the application image into the device. Check Channel Compares the channel selected in the network database with the physical channel of the device. When selected, LN-Builder does not commission the device when both channels are different. To complete the commissioning, change the device channel in the database or the device physical location Number of Service Pin Indicates the total number of service pin Received messages received by LN-Builder.

112 LN-Builder 3.5 Technical Bulletin

Configuring Program ID Check Settings Downloading an improper application image (such as an .apb file) into a device may damage the Neuron chip in a controller, and the controller may become unusable. To prevent you from downloading incompatible application images into a controller, LN-Builder verifies the compatibility of the Program ID. This feature has priority over the Check Program ID feature of the Service Pin identification method. To configure the Program ID Check settings: 1. In the Settings menu, click Program ID Check. The Program ID Check Setting dialog box appears.

Figure 66: Program ID Check Setting Dialog Box

2. Select to enable or remove the selection to disable the options as desired. See Table 56.

Table 56: Program ID Check Setting Dialog Box Field Description Check if application image file Prevents loading an incompatible application (.apb file) is compatible with image into the controller. The recommended controller before loading setting is to always use (enable) this feature. Check if application image file Prevents loading an incompatible application (.apb file) is compatible with image into the controller if the image does not external interface file (.xif file) correspond to the selected XIF file. The before loading recommended setting is to always use (enable) this feature.

3. Click OK.

LN-Builder 3.5 Technical Bulletin 113

Using a Bar Code Scanner Some devices have a label with a printed bar code representing the device’s Neuron ID. You can use several methods to scan the bar code and save the information to your computer. A wedge interface scanner provides the easiest method of transmitting bar code information from the bar code label to LN-Builder. Connect this type of scanner to your computer using a wedge inserted between the computer keyboard and the system unit. When you scan the Neuron ID, it automatically enters the Neuron ID on the computer at the cursor location.

Viewing or Modifying Device Properties Most of the properties in the Device Properties dialog box are read-only properties that were set when you added and commissioned the device. To view or modify Device Properties: 1. Right-click a device and select Properties. The Device Properties dialog box appears with the Attributes tab active.

Figure 67: Device Properties Dialog Box – Attributes Tab

114 LN-Builder 3.5 Technical Bulletin

2. View and modify the fields of the Attributes tab. See Table 57.

Table 57: Device Properties Dialog Box – Attributes Tab Field Description Name Displays the name of the device. Commission Status Displays the current commissioning status of the device. • Commission Updates Pending: Indicates that the commissioning updates are in progress or pending. If you make database changes that affect a device’s configuration, this value denotes the commission status of the device. The commission status changes from Commission Updates Pending to Commission Updates Current or Commission Updates Failed depending on whether the updates succeeded or failed. • Commission Updates Current: Indicates that there are no commissioning updates pending. • Commission Updates Failed: Indicates that the commissioning updates are currently in progress or pending and that the most recent update attempt failed. Template Name Displays the name of the device template from which this device was created. Status Indicates whether the device state is Configured Online, Software Offline, Unconfigured, or Not Available. Not Available is followed by the reason why the status is not available (for example, Not Attached if the network is unattached). Channel Name Displays the name of the channel on which the device resides. Channel Handle Displays the handle of the channel on which the device resides. Subsystems Displays a list of subsystems in which this device appears. If the device is part of a nested subsystem, it displays with all parent and child subsystems in the hierarchy. A device is considered part of a subsystem if the device or any functional block associated with the device appears in that subsystem. This is a read-only field.

3. Click the Identifiers tab and view or modify the fields. See Table 58.

LN-Builder 3.5 Technical Bulletin 115

Figure 68: Device Properties Dialog Box – Identifiers Tab

Table 58: Device Properties Dialog Box – Identifiers Tab Field Description Device Name Indicates the name of the device. Handle Indicates the handle LN-Builder uses internally to refer to the device. LN-Builder assigns a handle when the device is created. Subnet/Node ID Indicates the subnet and node for the device. LN-Builder assigns an ID when the device is created. The ID is used to address messages to the correct recipient. Subnet Name Indicates the name of the subnet on which the device resides. The subnet name automatically changes when you move a device to a new channel. Firmware Version Indicates the firmware version running on the Neuron chip within the device. Model Number Indicates the device’s Neuron chip model. Neuron ID • Current: Indicates the current Neuron ID for the device. • Pending: Indicates the pending Neuron ID for the device. The current and pending Neuron IDs may be different when a device is being commissioned for the first time, or if you are replacing the physical device and the update is pending.

4. Click the Description tab and view or modify the fields. See Table 59.

116 LN-Builder 3.5 Technical Bulletin

Figure 69: Device Properties Dialog Box – Description Tab

Table 59: Device Properties Dialog Box – Description Tab Field Description Location Indicates the device’s location string and type. For the Ascii option, the location is a six-digit ASCII text string. For the Hex option, the location is a twelve-digit hex string. Ping Interval Indicates the ping interval for the device. Pinging tests if a particular device is operating properly and is reachable on the network. The ping interval determines how often a device is pinged to make sure the device is communicating with the network. Set the desired ping interval. See Ping Interval and Configuring the Ping Interval. Continued on next page. . .

LN-Builder 3.5 Technical Bulletin 117

Field (Cont.) Description Priority Slot Indicates whether the device uses priority to transmit messages. Set the priority slot value to 0 to disable priority slot usage for the device. Set the priority slot value to a non-zero integer to assign a priority slot for the device. Non-Group Receive Timer Indicates the time interval during which the subnet/node and broadcast messages from the same source with the same transaction ID and priority are treated as duplicate messages. Authentication Enables authentication for the device. This option is available only when the network has authentication enabled. Description Describes the device you entered in the Add Device wizard. This field is used for record keeping purposes and has no effect on network operation.

5. Click the Self-Documentation tab and view or modify the fields. See Table 60.

Figure 70: Device Properties Dialog Box – Self-Documentation Tab

118 LN-Builder 3.5 Technical Bulletin

Table 60: Device Properties Dialog Box – Self-Documentation Tab Field Description Device Name Indicates the name of the device. Program ID Indicates the program ID of the device template. You can select to view the ID in ASCII, Hex, or Standard format. Self-Documentation Indicates the self-documentation of the device. You can select to view the self-documentation from the network variables on the device or functional block. This field is read-only.

6. Click the Functional Blocks tab and view or modify the fields. See Table 61.

Figure 71: Device Properties Dialog Box – Functional Blocks Tab

LN-Builder 3.5 Technical Bulletin 119

Table 61: Device Properties Dialog Box – Functional Blocks Tab Field Description Device Name Indicates the name of the device. Index Indicates the index number of the functional block within the device. Name Indicates the name of the functional block. Mode Indicates the scope of the functional block definition: • (0) Standard: LONMARK defined object • (1) Class: Applies to all devices of the same class • (2) Class/Subclass: Applies to all devices of the same class and subclass • (3) Manufacturer: Applies to all devices from the same manufacturer • (4) Manufacturer/Class: Applies to all devices from the same manufacturer of the same class • (5) Manufacturer/Class/Subclass: Applies to all devices from the same manufacturer of the same class and subclass • (6) Manufacturer/Class/Subclass/Model: Applies to all devices from the same manufacturer of the same class, subclass, and model (that is, a specific device type) Type Name Indicates the type of LONMARK object that this functional block represents.

7. Click the Address Table tab and view or modify the fields. See Table 62.

120 LN-Builder 3.5 Technical Bulletin

Figure 72: Device Properties Dialog Box – Address Table Tab

Table 62: Device Properties Dialog Box – Address Table Tab Field Description Index Indicates the index number corresponding to the entry in the Address Table. Type Displays one of the following address modes: • Subnet node • Subnet broadcast • Domain broadcast • Group • Unused • Turnaround ID Indicates the type ID. Retries Indicates the number of times to retransmit a message when the Acknowledge service is being used and the device does not receive an acknowledgement. Repeat Timer Indicates the time interval between message repetitions when the Unacknowledged Repeated service is being used. Receive Timer Indicates the time interval during which the receiving end of the connection discards messages from the same source with the same message ID (because the messages are recognized as duplicates). Continued on next page. . .

LN-Builder 3.5 Technical Bulletin 121

Field (Cont.) Description RX Timer Indicates the time interval between retries. Additional Displays additional information related to the group addressing type. This field lists the size of the group, the member number of the node, and whether the group is an Output only group (Yes/No) or an Input No Ack group (Yes/No).

8. Click the NV Config tab and view or modify the fields. See Table 63.

Figure 73: Device Properties Dialog Box – NV Config Tab

122 LN-Builder 3.5 Technical Bulletin

Table 63: Device Properties Dialog Box – NV Config Tab Field Description Index Indicates the index number of the network variable. If the network variable has an alias, the symbol in the index column is a yellow box with a plus sign. Click this button to expand the network variable and see the network variable aliases. Name Indicates the name of the network variable. Selector Indicates the number used by the Neuron firmware to resolve network variable update messages. Address Indicates the index of the address table entry used to send network variable updates. Service Type Displays whether the object is acknowledged, unacknowledged repeated, or repeated. This field is used to determine how LN-Builder sends network variable updates. Authenticated Indicates whether authentication is required for the network variable updates. Priority Indicates whether updates are sent using priority messaging. Turnaround Indicates whether updates are also sent to another network variable on the device. Direction Indicates the direction of the network variable (Input or Output). Functional Block Indicates the name of the functional block.

9. Click OK.

LN-Builder 3.5 Technical Bulletin 123

Viewing or Modifying Functional Block Properties Most of the properties in the LONMARKObject Properties dialog box are read-only properties. To view or modify Device Properties: 1. Right-click a functional block and click Properties. The LONMARKObject Properties dialog box appears with the Attributes tab active.

Figure 74: LONMARKObject Properties Dialog Box – Attributes Tab

2. View and modify the fields of the Attributes tab. See Table 64.

124 LN-Builder 3.5 Technical Bulletin

Table 64: LONMARKObject Properties Dialog Box – Attributes Tab Field Description Name Displays the name of the functional block. You can modify this field. The name must be unique within the device and less than 85 characters. Programmatic Name Displays the original programmatic name of the functional block and indicates the association between the functional block and its device object. ID Displays the ID of the functional block. Subsystem Displays a list of subsystems in which this device appears. If the device is part of a nested subsystem, it displays with all parent and child subsystems in the hierarchy. A device is considered part of a subsystem if the device or any functional block associated with the device appears in that subsystem. This is a read-only field. Description Allows you to enter a description of the functional block. This field is used for record keeping purposes and has no effect on network operation.

3. Click the Self-Documentation tab and view or modify the fields. See Table 65.

LN-Builder 3.5 Technical Bulletin 125

Figure 75: LONMARKObject Properties Dialog Box – Self-Documentation Tab

Table 65: LONMARKObject Properties Dialog Box – Self-Documentation Tab Field Description Device Name Indicates the name of the device. Type Indicates the type of the device. The type corresponds to the device template name. Program ID Indicates the program ID of the device template. You can select to view the ID in ASCII, Hex, or Standard format. Self-Documentation Indicates the self-documentation of the device. You can select to view the self-documentation from the network variables on the device or functional block. This field is read-only.

4. Click the LONMARK Properties tab and view or modify the fields. See Table 66.

126 LN-Builder 3.5 Technical Bulletin

Figure 76: LONMARKObject Properties Dialog Box – LONMARK Properties Tab

LN-Builder 3.5 Technical Bulletin 127

Table 66: LONMARKObject Properties Dialog Box – LONMARK Properties Tab Field Description Functional Block Name Indicates the name of the functional block. You can edit this name under the Attributes tab. Functional Profile Name Indicates the functional profile name of the functional block. Functional Profile Indicates the programmatic name provided by Programmatic Name the functional profile’s LONMARK definition. Functional Profile Description Indicates the functional profile description.

5. Click OK.

Adding a Network Service Device After adding an NSD to the network, you can add network variables and create connections. To add a network service device: 1. Connect to the network remotely as a full client. See the full client instructions in Connecting to a Network Database. 2. In the Network menu, click Networks Service Devices. The Networks Service Devices dialog box appears and displays the permanent and temporary network service device information.

Figure 77: Networks Service Devices Dialog Box

128 LN-Builder 3.5 Technical Bulletin

Table 67: Networks Service Devices Dialog Box Field Description NSD Name Indicates the name of the network service device. The LNS server assigns this name and it cannot be changed. Type Indicates the type of network service device: NSS (LNS server) or NSI (remote client). Note: An NSS is a Network Services Server and an NSI is a Network Services Interface. Device Name Indicates the name of the network service device in the network. State Indicates the state of the network service device: Temporary or Permanent.

3. Click the temporary NSD and click Save. The NSD becomes permanent. 4. Click the permanent NSD and click Add to add it to the network database. The Add Network Service Device dialog box appears.

Figure 78: Add Network Service Device Dialog Box

5. Modify the fields. See Table 68.

Table 68: Add Network Service Device Dialog Box Field Description Name Indicates the name of the network service device. Subsystem Indicates the subsystem to which to add the network service device. Commission Device Executes the definition and commissioning steps of the device creation simultaneously.

6. Click OK. LN-Builder 3.5 adds the NSD to the network database.

LN-Builder 3.5 Technical Bulletin 129

Removing a Network Service Device Note: We recommend removing NSDs that are no longer in use to improve network performance. To remove a network service device: 1. In the Network menu, click Networks Service Devices. The Networks Service Devices dialog box appears.

Figure 79: Networks Service Devices Dialog Box – Delete

2. Right-click the NSD to remove and click Delete from System. The NSD is deleted from the network database, but remains in the Network Service Device list as a permanent device. 3. Right-click the NSD to remove and click Remove. The NSD state changes from permanent to temporary.

130 LN-Builder 3.5 Technical Bulletin

Creating a New Connection Description Template You can use LN-Builder’s default connection description, ConnectDescTemplate_0, or create a new connection description with different connection description properties. To create a new connection description template: 1. In the Network menu, click ConnDesc Template. The Connection Description Template Manager appears with the Essential tab active.

Figure 80: Connection Description Template Manager – Essential Tab

2. Click New. The Creating New Template dialog box appears. 3. Enter the desired name for the Connection Description Template and click OK. 4. Modify the fields of the Essential tab. See Table 69.

LN-Builder 3.5 Technical Bulletin 131

Table 69: Connection Description Template Manager – Essential Tab Field Description Connection Description Indicates the name of the connection Templates description template. This field allows you to select an existing connection description template for the connection. Note: You cannot change the Connection Description Template from the drop-down menu until you click Apply. Service Type Indicates the service type used to transmit messages over this connection. The Auto option allows LN-Builder 3.5 to automatically determine the service type. Types include: • Acknowledged: The transmitting device is sent a confirmation of receipt from the target device once the target device receives the NV. • Unacknowledged Repeated: The transmitting device transmits each message multiple times at predetermined intervals. This redundant transmittal of messages is used to increase the probability that the message gets to the receiving device. Use the Advanced option to specify the number of repeats. • Unacknowledged: The device only transmits the network variable once and does not require any confirmation of receipt from the receiving device. This service type results in the least amount of network traffic. By default, this field is set to Auto. Priority Indicates whether priority is being used for the connections. Options include: • Yes: The connection uses priority messaging. You must enable priority in both the transmitting and receiving devices. • No: The connection has priority messaging disabled. • Auto: LN-Builder enables priority messaging if both the transmitting and receiving devices have priority enabled. By default, this field is set to Auto. Authentication Indicates whether authentication is enabled for the connection. When this field is set to Auto, LN-Builder 3.5 enables authentication messaging if both the transmitting and receiving devices have authentication enabled. By default, this field is set to Auto. Description Allows you to enter a description of the connection description template. This field is used for record keeping purposes and has no effect on network operation.

5. Click Advanced and modify the fields. See Table 70.

132 LN-Builder 3.5 Technical Bulletin

Figure 81: Connection Description Template Manager – Advanced Tab

Table 70: Connection Description Template Manager – Advanced Tab Field Description Connection Description Indicates the name of the connection Templates description template. This field allows you to select an existing connection description template for the connection. Note: You cannot change the Connection Description Template from the drop-down menu until you click Apply. Use Broadcast Indicates whether broadcast advertising is used for the connection. • Yes: The connection uses broadcasting if a group address is required, but all groups are unavailable. To conserve network bandwidth, LN-Builder uses a subnet broadcast if all devices are on the same subnet. Otherwise, LN-Builder uses a domain broadcast. • No: The connection has broadcasting disabled. By default, this field is set to No. Multicast Method Indicates the behavior of connections that involve more than two members: • Group: LN-Builder uses multicast addressing. • Alias: LN-Builder creates the connection using aliases and Unicast (subnet/node) addressing. By default, this field is set to Group. Continued on next page. . .

LN-Builder 3.5 Technical Bulletin 133

Field (Cont.) Description Timers (Milliseconds) LN-Builder has three connection timers: Transmit, Repeat, and Receive. These determine the interval between repeating or resending of network messages. • Transmit: The transmit timer applies to connections using Acknowledge messaging. The timer specifies how long the transmitting device waits for an acknowledgement from the receiving device before it retransmits the message. • Repeat: The repeat timer applies to connections using Unacknowledged Repeat messaging. The timer specifies how long the transmitting device waits before it repeats the message on the network. • Receive: The receive timer specifies the time interval during which the receiving device treats messages originating from the same source and having the same message ID as being duplicate messages. The default value is Automatic, which calculates an appropriate waiting interval based on network topology. Counts Indicates the Retry and Repeat counts: • Retry: Indicates the number of times a device using Acknowledged messaging retransmits a message if it does not get a confirmation receipt from the receiving device. • Repeat: Indicates the number of times a device using Unacknowledged Repeat messaging resends a message on the network. The default value is Automatic, which calculates an appropriate count based on network topology. Suppress Source Address Indicates whether LN-Builder suppresses the address table and network variable configuration table updates. This option forces the source device to become responsible for managing destination addresses. This option allows the device to use explicit addressing to overcome address table limitations.

6. Click OK.

134 LN-Builder 3.5 Technical Bulletin

Renaming a Connection Description Template To rename a connection description template: 1. In the Network menu, click ConnDesc Template. The Connection Description Template Manager appears. 2. Click the connection description template in the Connection Description Template drop-down menu. 3. Click Rename. 4. Enter the new name in the rename dialog box. 5. Click OK.

Deleting a Connection Description Template You cannot delete the default template, ConnectDescTemplate_0. To delete a connection description template: 1. In the Network menu, click ConnDesc Template. The Connection Description Template Manager appears. 2. Click the connection description template in the Connection Description Template drop-down menu. 3. Click Remove.

LN-Builder 3.5 Technical Bulletin 135

Replacing a Connection Description Template To replace a connection description template: 1. In the Network menu, click NV Connection Manager. The Connection Manager appears. 2. Click the Connection View tab.

Figure 82: Connection Manager – Binding List Tab: Replacing Connection Description Template

3. Select the desired connection description template by clicking the connection column beside the hub name and using the drop-down selection menu. 4. Click Apply. The connection description template is updated.

136 LN-Builder 3.5 Technical Bulletin

Connecting Network Variables You can use LN-Builder to connect compatible network variables. To connect network variables: 1. In the Network menu, click NV Connection Manager. The Connection Manager appears with the Pending Connection tab active.

Figure 83: Connection Manager – Pending Connection Tab

Table 71: Connection Manager – Pending Connection Tab Field Description Hub and Target Network Lists the hub and target network variables. Variables Add Hub Allows you to select a hub variable when setting up a connection between variables. Hub variables are the originating/source network variables. Add Targets Allows you to select target variables when setting up a connection between variables. Target variables are the receiving end of a connection and are fed data from a hub variable. Connect Connects the selected hub and target variables together. Import Allows you to import previously generated bindings lists (.dcb or .lst format). Template Opens the Connection Description Template Manager. Continued on next page. . .

LN-Builder 3.5 Technical Bulletin 137

Field (Cont.) Description Map Opens the Connections Map window, which displays the devices on the network and the bindings between device variables. Connection Description Allows you to select a connection description Templates template for the connection. Edit Opens the Connection Description Template Manager.

2. Click Add Hub. The Browse Hub Network Variable dialog box appears. 3. Browse to and click the name of the desired hub, which can be a NVI or NVO. 4. Click OK. The hub network variable is added to the Hub and Target Network Variables list. 5. Repeat Steps 2-4 to create additional hubs. 6. Click the desired hub in the Hub and Target Network Variables list. 7. Click Add Targets. The Browse Target Network Variable dialog box appears. LN-Builder filters all available network variables and only displays the compatible variables. Devices that do not have compatible network variables appear dimmed.

Figure 84: Browse Target Network Variable Dialog Box

138 LN-Builder 3.5 Technical Bulletin

8. In the Tree View, click to select the target network variables to connect to the hub. Note: You can select multiple network variables in one operation by right-clicking the desired network variables and then clicking one of the following options: • Select all NVs with the same name • Select all NVs with the same name by device template • Select all NVs with the same name by subsystem • Select all NVs with the same name by device template and subsystem • Unselect all 9. Click OK. The target network variable is added to the Hub and Target Network Variables list. 10. Repeat Steps 6-9 to add targets to different hubs. 11. Click the desired Connection Description Template in the drop-down menu. 12. Click Connect. LN-Builder creates the bindings between the specified network variables. 13. To see the binding information, click the Connection View tab.

Figure 85: Connection Manager – Connection View Tab

LN-Builder 3.5 Technical Bulletin 139

Table 72: Connection Manager – Connection View Tab Field Description Reload Refreshes the Bindings List. Add As Hub Displays the selected network variable in the Connections tab to modify its bindings. Add Targets Allows you to select target variables when setting up a connection between variables. Target variables are the receiving end of a connection and are fed data from a hub variable. Disconnect Removes the bindings for the selected network variable. Export Allows you to save the bindings list (.dcb or .lst format). Template Opens the Connection Description Template Manager. Map Opens the Connections Map window, which displays the devices on the network and the bindings between device variables. Show All Displays all the bindings in the network database. Show Selected Displays only the bindings of the selected object where you launched the Connection Manager. If the Connection manager is launched through the subsystem, all the bindings of the nested subsystem appear. Display on Hub Organizes the list by hub network variables. Display on Targets Organizes the list by target network variables.

14. Click OK.

Removing a Connection between Network Variables To remove a connection between network variables: 1. In the Network menu, click NV Connection Manager. The Connection Manager appears. 2. Click the Bindings List tab. 3. Select the variable to disconnect. 4. Click Disconnect.

Viewing the Network Connections Map The network connections map provides a graphical representation of the devices on the network and the network connections between devices. To view the network connections map: 1. In the Network menu, click NV Connection Manager. The Connection Manager appears. 2. Click Map. LN-Builder generates the connection map and opens it in the Connection Map window.

140 LN-Builder 3.5 Technical Bulletin

Figure 86: Connection Map Window

3. Right-click a network variable in the map and click an option to view information on that variable.

Table 73: Connection Map Field Description Show Connection Displays the name of both senders and receivers attached to the selected network variable. A large turquoise line connects these variables. Show Sender(s) Displays the senders of the selected network variable. This option applies only to network variable inputs. Show Receiver(s) Displays the receivers of the selected network variable. This option applies only to network variable outputs. Show Hub(s) Displays the hub network variables. This option applies only to network variable targets. Show Target(s) Displays the target network variables. This option applies only to network variable hubs.

4. Click the X in the upper-right corner to close the map.

LN-Builder 3.5 Technical Bulletin 141

Viewing and Modifying Network Variable Properties To view and modify network variable properties: 1. Right-click the desired network variable in the List View pane and then click Properties. The Network Variable Properties dialog box appears with the Description tab active.

Figure 87: Network Variable Properties Dialog Box – Description Tab

2. View and modify the fields of the Description tab. See Table 74.

142 LN-Builder 3.5 Technical Bulletin

Table 74: Network Variable Properties Dialog Box – Description Tab Field Description Name Displays the name or label of the network variable. Programmatic Name Displays the name the device application used for the network variable. This name is the same as the name defined in the XIF file. This field is read-only. Type Name Displays the type of network variable: Standard Network Variable Type (SNVT) or User Network Variable Type (UNVT). Self Documentation Displays any self-documentation information that the device contains for this network variable. This string is also included in the XIF file. This field is read-only. Description Displays a description for this network variable. You can enter comments or reminders in this field for later reference. Url Displays the path for the network variable within the network database hierarchy in the following format: // /

3. Click the NV Attributes tab and view or modify the fields. See Table 75.

Figure 88: Network Variable Properties Dialog Box – NV Attributes Tab

LN-Builder 3.5 Technical Bulletin 143

Table 75: Network Variable Properties Dialog Box – NV Attributes Tab Field Description SNVT ID Displays the SNVT ID of the network variable type (when the network variable is a SNVT). Configurable Indicates whether you can change the SNVT type of this network variable. If so, you can change the type using the Changing the Network Variable Type. NV Index Displays the index of this network variable within the device. Length Displays the length of this network variable, in bytes. Direction Indicates whether the direction of this network variable is input or output. Selector Displays the value assigned by the LNS Object Server that uniquely associates this network variable with all the connections in which it participates. If this network variable is not a member of a connection, the selector is set to a value representing an unbound network variable. Synchronous Network Indicates whether this network variable is Variable synchronous. A synchronous network variable delivers all network variable updates to the application, not just the most recent update. For example, if multiple network variable messages are received faster than they can be processed, they are queued and processed in the order in which they were received. Config Class Network Indicates whether the value is stored in non-volatile Variable memory and retained for a restart. Polled Network Declares the network variable as polled. If polled and Variable the network variable is silent, the input sends a request to the output. A network variable output can only be bound to a polling network variable input. However, an NVI declared as polled can be bound to either a polling NVO or a non-polling NVO. Configuration Property Indicates that this network variable defines the behavior of the device. Value Displays the current value of this network variable. This property updates each time you open the NV Attributes tab.

4. Click the Connection Attributes tab and view or modify the fields. See Table 76.

144 LN-Builder 3.5 Technical Bulletin

Figure 89: Network Variable Properties Dialog Box – Connection Attributes Tab

Table 76: Network Variable Properties Dialog Box – Connection Attributes Tab Field Description Authentication Enabled: Indicates whether this network variable uses authentication and is determined by the connection description. Configurable: Indicates whether you can change authentication for this network variable using the connection description. These fields are read-only. Priority Enabled: Indicates whether the network variable uses priority messaging. Configurable: Indicates if you can configure the network variable to use priority using the connection description. Service Type Displays whether the messaging service is Acknowledged (most reliable), Unacknowledged Repeated, or Unacknowledged. Configurable: Indicates whether you can configure the messaging service of the network variable using the connection description. Message Rate Sustained: Displays the expected number of messages per (Messages per second transmitted by this network variable. A value of 0 Second) indicates that this value is undetermined. Maximum: Displays the maximum number of messages per second that can be sent by this network variable. A value of 0 indicates that there is no maximum rate. Update data Takes the node offline while configuration changes are offline being made. 5. Click the LONMARK tab and view or modify the fields. See Table 77.

LN-Builder 3.5 Technical Bulletin 145

Figure 90: Network Variable Properties Dialog Box – LONMARK Tab

Table 77: Network Variable Properties Dialog Box – LONMARK Tab Field Description Functional Profile Indicates the name of the network variable as Name externally represented to the network installer. Functional Profile Indicates the name of the network variable as Programmatic Name internally represented to the Neuron C application. Functional Profile Provides a description of the network variable type. Description Member Index Displays the original index of the network variable within its LONMARK object. Each LONMARK object has some number of network variables. Each network variable is given a member index based on its position within the object. Indexes are numbered from 0 to n-1, where n is the number of network variables in the object. Continued on next page. . .

146 LN-Builder 3.5 Technical Bulletin

Field (Cont.) Description Member Number Displays the member number specified for this network variable within an object. Each network variable in an object is given a unique member number within the object. Member numbers are assigned by the LONMARK Application Layer Interoperability Guidelines, a LONMARK approved functional profile, or by a user (for example, if the network variable is not specified in the guidelines). Object Number Displays the number of the object associated with this network variable. Objects on a device are numbered from 0 to n-1, where n is the number of objects in the device. Manufacturer Assigned Indicates whether the Member Number property was assigned by the device manufacturer, or by the LONMARK Application Layer Interoperability Guidelines or a LONMARK approved functional profile. The Member Number property for each network variable in a LONMARK object can be defined by the LONMARK organization or by the manufacturer (for example, for a non-standard object).

6. Click the Monitor Option tab and view or modify the fields. See Table 78.

Figure 91: Network Variable Properties Dialog Box – Monitor Option Tab

LN-Builder 3.5 Technical Bulletin 147

Table 78: Network Variable Properties Dialog Box – Monitor Option Tab Field Description Use priority messaging Uses priority messaging for polling or updating when reading/writing network variables. the variable Bind this variable to Sends updates directly to the software, rather than the the browser for software polling the network variable periodically. receiving network variable update Only report changes in Displays the monitored network variable only when the the variable’s data value changes. Monitor the variable Monitors the network variable. This option is similar to turning on monitoring. Poll interval Indicates how often the network variable is polled when monitoring is turned on. Number of retries Indicates how many times to try to send a poll or update message before reporting a failure. Service type Indicates which message service is used to update the network variable (Acknowledged, Unacknowledged Repeat, or Unacknowledged). When set to Unacknowledged Repeat or Unacknowledged, the network variable uses an authenticated connection and any attempts to send network variable updates fail silently. Format Type Displays the display format of the network variable. This field is read-only. Precision Displays the number of digits to appear to the right of the decimal point of the network variable value. Six is the maximum number of digits.

7. Click OK.

Viewing Network Variables and Configuration Properties Use the Johnson Controls Browser plug-in to view network variables and configuration properties. See Browsing Network Variables and Configuration Properties.

148 LN-Builder 3.5 Technical Bulletin

Changing the Network Variable Type If you make changes to a network variable type, the following changes occur within the network: • updates the LNS network database to reflect the new type definition • updates the type within the physical device • chooses an appropriate format to display the network variable data (if one is available) For example, a controller is connected to a variety of input devices, such as pressure and temperature sensors. When the input device measures the air pressure level, the SNVT_press_p network variable type is used. If the input device measures air temperature, the SNVT_temp_p type is used. Not all network variables have types you can change. Refer to the device or functional block documentation to verify if you can change the variable's type. To change the network variable type: 1. Right-click a network variable and click Change Type. The Change Network Variable Type dialog box appears.

Figure 92: Change Network Variable Type Dialog Box

LN-Builder 3.5 Technical Bulletin 149

Table 79: Change Network Variable Type Dialog Box Field Description Network Variable Name Displays the name of the network variable. This field is read-only. Actual Type Displays the actual type of network variable. Preferred Type List Displays the preferred type list. Length Allows you to select how to display network variables in the type list. Select All to display all network variables. Select Equal length only to display network variables that have the same length. Type Files Allows you to select the catalog that describes the network variable type. The catalog that describes SNVT is named STANDARD.TYP. All other catalogs describe UNVTs. Type List Displays a list of available SNVTs and UNVTs in the selected catalog according to the length preferences.

2. Browse the Type List and click the name of the SNVT or UNVT. 3. Click OK. Note: SI Data Save: By default, when changing the network variable type using LNS TURBO Edition, the network variable number is not written in the device. Use this option to change the network variable type in the database and in the device. If the network variable type is not selected, only the network variable number is written in the database.

150 LN-Builder 3.5 Technical Bulletin

Changing Network Variable and Configuration Property Formats You can change the format of all network variable and configuration property values. The selected format establishes how data is formatted and how input data is interpreted. The updated format saves to the LNS network database. The format does not impact the network variable, configuration property type, or the data on the physical network. To change network variable and configuration property formats: 1. Right-click a network variable or configuration property and click Change Format. The Change Format dialog box appears.

Figure 93: Change Format Dialog Box

Table 80: Change Format Dialog Box Field Description Data Point Displays the path and name of the network variable or configuration property. This field is read-only. Current Type Displays the current type of network variable or configuration property. Current Format Displays the current format of network variable or configuration property. Continued on next page. . .

LN-Builder 3.5 Technical Bulletin 151

Field (Cont.) Description Equal length only Allows you to select how to display network variables or configuration properties in the format list. Leave this box empty to display all network variables or configuration properties in the format list regardless of length. Select this box to only display network variables or configuration properties that have the same length. Include Network Variable Allows you to view configuration property Formats formats as well as network variable formats in the formats list. This option is only available when changing the format of a configuration property. Include ConfigProperty Allows you to view network variable formats as Formats well as configuration property formats in the formats list. This option is only available when changing the format of a network variable. Select Format File Allows you to select the catalog that describes the network variable or configuration property type. The catalog that describes SNVTs and SCPTs is named STANDARD.TYP. All other catalogs describe UNVTs and UCPTs. Format List Displays a list of available SNVTs, UNVTs, SCPTs, and UCPTs in the selected catalog according to the length preferences. Formats Allows you to select one of the following options: • Selected File Types: Displays all formats available in the selected catalog in the format list according to the length preferences. • Alternate Types: Displays all formats that are compatible with the selected SNVT type in the format list. • Built-In Types: Displays five built-in data types in the format list: Integer, Real, Raw (Decimal), Raw (Hex), or String. Precision Allows you to set the precision for configuration properties and network variable types that use floating-point numbers. This value defines the number of digits displayed after the decimal point. If the selected format does not contain a floating-point number, the software ignores the precision setting. Length Displays the length of the current network variable or configuration property type.

2. Click the name of the SNVT, UNVT, SCPT, or UCPT for which to change the format in the format list. 3. Click OK.

152 LN-Builder 3.5 Technical Bulletin

Adding Dynamic Network Variables To add a dynamic network variable: 1. Right-click the device or functional block that supports dynamic network variables and click Add Network Variable. The Dynamic Network Variable Manager appears with the Edit tab active. Note: We recommend adding the dynamic network variable in a functional block that has a logical link with the functional block.

Figure 94: Dynamic Network Variable Manager – Edit Tab

LN-Builder 3.5 Technical Bulletin 153

Table 81: Dynamic Network Variable Manager – Edit Tab Field Description Functional Block Allows you to select one or more functional blocks in which to add the network variable. Leave this field empty to create a dynamic network variable under the device level. Direction Allows you to select the direction of the network variable. • Complementary: LN-Builder 3.5 creates a network variable in the opposite direction of the source network variable. For example, if the source is an NVI, LN-Builder creates an NVO. • Compatible: LN-Builder creates a network variable in the same direction as the source network variable. Option Allows you to enable or disable polling for this network variable. Number of network variable to Allows you to select the number of network create variables to create. When creating more than one device, LN-Builder automatically modifies the names of the network variables by appending underscores and numbers to the end of the names (for example, nviSpaceTemp becomes nviSpaceTemp _01 and nviSpaceTemp _02). If the network variable name ends with an underscore followed by a number, LN-Builder automatically increments the number for the subsequent network variables.

2. Click Browse. The Browse Source Network Variable dialog box appears. 3. Browse to and click the name of the desired network variable. 4. Click OK. The network variable is added to the Dynamic variable to create table in the Edit tab. Note: The network variable source is required to create a dynamic network variable of the same SNVT or UNVT type. You can change the type of dynamic network variable later by right-clicking the dynamic network variable and clicking Change Type. Note: To change the name of the variable, click the variable in the Name field. 5. Click Create. LN-Builder creates the new network variables. Note: You can view all dynamic network variables on a device by clicking the Variables tab.

154 LN-Builder 3.5 Technical Bulletin

Importing Dynamic Network Variables You can import Dynamic NVs from exported configuration files from other devices. Use this feature if you have multiple devices that require the same dynamic NVs. Note: When you import dynamic NVs, it overwrites all existing dynamic NVs in the device. 1. Right-click the device and click Import from File. 2. Click the device file (*.xml). 3. Click Open The Device Import dialog box appears. 4. Check Dynamic Network Variables. 5. Click Finish.

Connecting Message Tags To connect message tags: 1. In the Network menu, click MT Connection Manager. The Message Tag Connection Manager appears with the New Connection tab active.

Figure 95: Message Tag Connection Manager – Edit Tab

LN-Builder 3.5 Technical Bulletin 155

Table 82: Message Tag Connection Manager – Edit Tab Field Description Hub and Target message tags Lists the hub and target message tags. Add Hub Allows you to select a hub message tag when setting up a connection between messages. Hubs are the originating/source message tags. Add Targets Allows you to select target message tags when setting up a connection between message tags. Target message tags are the receiving end of a connection and are fed data from a hub message tag. Connect Connects the selected hub and target message tags together. Connection Description Allows you to select a connection description Templates template for the connection. Edit Opens the Connection Description Template Manager.

2. Click Add Hub. The Browsing Hub Message Tags dialog box appears.

Figure 96: Browsing Hub Message Tags Dialog Box

3. Browse to and click the name of the desired hub. The hub must be a declared message tag (that is, the hub cannot be the predefined msg_in tag). 4. Click OK. The hub message tag is added to the Hub and Target message tags list.

156 LN-Builder 3.5 Technical Bulletin

5. Repeat Steps 2-4 to create additional hubs. 6. Select the desired hub from the Hub and Target message tags list. 7. Click Add Targets. The Browse Target Message Tags dialog box appears. LN-Builder filters all available message tags and only displays the compatible tags. Devices that do not have compatible message tags appear dimmed. 8. Browse the Tree View and select (check) next to the target message tags to connect to the hub. 9. Click OK. The target message tag is added to the Hub and Target message tags list. 10. Repeat Steps 6-9 to add targets to different hubs. 11. Click the desired Connection Description Template in the drop-down menu. 12. Click Connect. LN-Builder creates the bindings between the specified message tags.

Removing a Connection between Message Tags To remove a connection between message tags: 1. In the Network menu, click MT Connection Manager. The Message Tag Connection Manager appears. 2. Click the Bindings List tab. 3. Click the message tag to disconnect. 4. Click Disconnect.

LN-Builder 3.5 Technical Bulletin 157

Managing a Device, Router, or Functional Block Use this procedure to perform management actions on a device, router, or a functional block. To manage a device, router, or a functional block: 1. Right-click a device, router, or functional block and then click Manage. The Device Manager appears with the Devices and Routers tab active. Note: To manage multiple items, use the Ctrl key while clicking devices, routers, or functional blocks in the List View pane. Then right-click an item and click Manage.

Figure 97: Device Manager – Devices and Routers Tab

2. View and manage devices and routers. See Table 83. Note: Use the Devices and Routers tab to test a device and router, change states, reset devices and routers, and to view status.

158 LN-Builder 3.5 Technical Bulletin

Table 83: Device Manager – Devices and Routers Tab Field Description Devices Lists all devices and routers you selected to manage. The device and router names are preceded by the subsystem name. Select one or more items in the list and click the desired action button in the right side of the Device Manager. Properties and Values Lists the selected device/router properties and associated values. Use these (Status Pane) columns to verify the status of the network communication for the selected device/router. The Status pane includes the following information: Transmission Error: Displays the number of Cyclical Redundancy Check (CRC) errors detected during packet reception. These errors may be due to collisions or noise on the transceiver input. Transaction Timeout: Displays the number of times the node failed to receive the expected acknowledgements or responses after retransmitting data the specified number of times. Receive Transaction Full Errors: Displays the number of times an incoming packet was discarded because there was no room in the transaction database. These errors may be due to excessively long receive timers or an inadequate size for the transaction database. Lost Messages: Displays the number of times an incoming packet was discarded because there was no application buffer available. These errors may be due to an application program being too slow to process incoming packets, insufficient application buffers, or excess traffic on the channel. Missed Messages: Displays the number of times an incoming packet was discarded because there was no network buffer available. These errors may be due to excess traffic on the channel, insufficient network buffers, or the network buffers being too small to accept all packets on the channel (whether or not addressed to this specific node). Reset Cause: Displays the cause of the last reset of the device. Options include: • Power-up: Indicates an external power-cycle/reset. • Hardware: Indicates that the hardware circuitry internally reset the Neuron chip. • Watchdog: Indicates that the application or system software failed to reset the watchdog timers periodically causing the entire Neuron chip to reset automatically. The three watchdog timers protect against malfunctioning software or memory faults (one per processor). • Software: Indicates that the reset was caused by an application program, or by using the Reset button in the Device Manager. Node State: Displays whether the state is Configured Online, Software Offline, Unconfigured, or Not Available. Not Available is followed by the reason why the status is not available (for example, Not Attached if the network is unattached). Version Number: Displays the firmware version of the Neuron chip. Error Log: Displays the most recent errors encountered by the Neuron chip. The log displays as an error code that you can use for troubleshooting purposes. Model Number: Displays the model number of the Neuron chip. Log Lists the results of the management commands. If you click Test, the log also indicates the meaning of a failed test. Test Executes a series of tests to verify if the device is operating and configured correctly. The Log field displays the results of the tests. Clear Status Clears the device’s network error statistics and the error log. Online Puts the device’s application binary file in the online state. The device’s application binary file executes when online. Continued on next page. . .

LN-Builder 3.5 Technical Bulletin 159

Field (Cont.) Description Offline Puts the device’s application binary file in the offline state. The device’s application binary file stops running when offline. Reset Resets the device by sending the Reset network management command to the device to stop the application binary file execution, terminating all incoming and outgoing messages, resetting all temporary settings to their initial values, and starting the application binary file again using the original conditions. If the device is offline, this option puts the device online. Wink Causes the device to generate an audible or visible response such as a beep or flashing service LED. The device must support the wink function for this option to work. Use winking for identification and testing purposes. List Objects Lists all functional blocks/LONMARK objects in a device. Clear Log Clears the content of the Log list.

3. Click the LONMARK Objects tab and view or manage functional blocks. See Table 84. Note: Use the LONMARK Objects tab to acquire a functional block’s status, change states, or to enable or disable the block.

Table 84: Device Manager – LONMARK Objects Tab Field Description LONMARK Objects Lists all the functional blocks you selected to manage. Object Status Lists the status of the functional block objects, Use the Display Active Only option to only view active objects. Log Lists the results of the management commands. The log also indicates the meaning of a failed test. Get Status Updates the status information in the Object Status list. Clear Status Clears the functional block test flags without changing the state of the block. The device containing the functional block must be Online to use this command. Override On Puts the functional block into override. The NVOs output their configured override value, even if part of the network is not yet operating and there is no input to the functional block. The override values are set using the functional block’s configuration properties. This command requires LONMARK compatibility for execution in the device’s application binary file. The device containing the functional block must be Online to use this command. Override Off Takes the functional block out of override. The functional block operates normally when the override is off. This command requires LONMARK compatibility for execution in the device’s application binary file. The device containing the functional block must be Online to use this command. Enable Activates the functional block. This command requires LONMARK compatibility for execution in the device’s application binary file. The device containing the functional block must be Online to use this command. Disable Disables the functional block. The block sends its configured NVO defaults. This command requires LONMARK compatibility for execution in the device’s application binary file. The device containing the functional block must be Online to use this command. Continued on next page. . .

160 LN-Builder 3.5 Technical Bulletin

Field (Cont.) Description Request Queries the functional block. The query is performed through a network variable of the SNVT_obj_requests type. Select a command from the drop-down list and click Request. This command requires LONMARK compatibility for execution in the device’s application binary file. The device containing the functional block must be Online to use this command. Request commands include: 0. RQ_NORMAL: Enables the object and removes the override. 1. RQ_DISABLED: Disables the object. 2. RQ_UPDATE_STATUS: Reports the object status. 3. RQ_SELF_TEST: Performs an object self test. 4. RQ_UPDATE_ALARM: Updates the alarm status. 5. RQ_REPORT_MASK: Reports the status bit mask. 6. RQ_OVERRIDE: Overrides the object. 7. RQ_ENABLE: Enables the object. 8. RQ_RMV_OVERRIDE: Removes the object override. 9. RQ_CLEAR_STATUS: Clears the object status. 10. RQ_CLEAR_ALARM: Clears the object alarm. 11. RQ_ALARM_NOTIFY_ENABLED: Enables alarm notification. 12. RQ_ALARM_NOTIFY_DISABLED: Disables alarm notification. 13. RQ_MANUAL_CTRL: Enables the object for manual control. 14. RQ_REMOTE_CTRL: Enables the object for remote control Clear Log Clears the content of the Log list.

4. Click Close.

LN-Builder 3.5 Technical Bulletin 161

Configuring the Ping Interval For information on the ping interval, see the Ping Interval section. To configure the ping interval: 1. In the Network menu, click Ping Interval Configure. The Ping Interval Configuration dialog box appears.

Figure 98: Ping Interval Configuration Dialog Box

2. Click the Enabled check boxes next to the desired intervals and enter the desired number of seconds for the enabled intervals. See Table 85.

Table 85: Ping Interval Configuration Dialog Box Field Description Shortest Defines the shortest of all four ping intervals. The value must be between 30 and 65534 seconds. Set the time to 0 or click to clear the selection from the check box to disable the Shortest ping interval. Short Defines the interval that is less than the Long interval but greater than the Shortest interval. The value must be between 60 and 65534 seconds. Set the time to 0 or click to clear the selection from the check box to disable the Short ping interval. Long Defines the interval that is less than the Longest interval but greater than the Short interval. The value must be between 300 and 65534 seconds. Set the time to 0 or click to clear the selection from the check box to disable the Long ping interval. Longest Defines the interval that is the longest of all four ping intervals. The value must be between 900 and 65534 seconds. Set the time to 0 or click to clear the selection from the check box to disable the Longest ping interval.

Note: To reset the configuration to the default ping intervals, click Default. 3. Click OK.

162 LN-Builder 3.5 Technical Bulletin

Deleting a Monitor Set Use this procedure if you need to change the network variable type setting in the monitor set. To delete a monitor set: 1. Close all applications using monitor sets such as the Johnson Controls Browser or the LN-Monitor plug-ins. 2. In the Network menu, click Monitor Sets. The Monitor Set Manager appears.

Figure 99: Monitor Set Manager

3. Click a monitor set name in the Monitor Set list. 4. Click Remove. LN-Builder deletes the monitor set. Note: To remove all monitor sets, click Remove All. 5. Click Exit.

LN-Builder 3.5 Technical Bulletin 163

Using the Multi-Device Copy and Paste Feature LN-Builder is built with advanced Copy and Paste functionality. You can copy multiple devices and subsystems at the same time and paste them in the same network database, or to a different network database. To use the advanced copy and paste feature: 1. Hold down the Ctrl key while selecting the devices and subsystems to copy. The selected objects appear blue. 2. Right-click one of the selected and then click Copy. 3. In the Tree View pane, browse to the location to paste the selected objects. 4. Right-click and then click Paste. The Copy and Paste Devices dialog box appears.

Figure 100: Copy and Paste Devices Dialog Box

5. Specify the number of copies to make in the selected destination, and then click Next.

164 LN-Builder 3.5 Technical Bulletin

6. Click the selected items you want to copy. Table 86 describes the check boxes.

Figure 101: Copy and Paste Devices Dialog Box – Copy Options

Table 86: Copy and Paste Devices Dialog Box – Copy Options Check Box Description Configuration Properties Copies all configuration properties, including both values and (Value and Format) formats. Network Variable (Format and Type) Copies all network variables, including both formats and types. Network Variable Connections (Bindings) Copies all bindings between the selected devices. Note: When a network variable that belongs to one of the selected devices is bound to a device that is not being copied, the bindings are not copied. Dynamic Network Variables Copies the dynamic variable list with all the saved properties, including the position and index values. Extensions Copies all LNS database extensions for device configurations. LNS database extensions are used to store device specific information that was configured within a device plug-in. Information stored in extensions cannot be stored within a configuration property or network variable. The extensions are client-server enabled. Note: When options appear dimmed, there is nothing to copy because the object is not in use (for example, there are no bindings to the object). Neuron ID Copies the Neuron IDs of all the devices in the copied subsystem and databases to the destination database. The Neuron ID option is available only when you copy from one database to another. Location Copies the location data of the device’s SCPT location (configuration property value) configuration property. Location Copies the location data of the device found in its Device (device property value) properties.

7. Select the parameters you want to copy.

LN-Builder 3.5 Technical Bulletin 165

8. If the device you copied has no network variable connections (bindings), click Finish.

If the device has network variable connections to other devices and the Network Variable Connections (Bindings) option was selected, click Next. 9. All the devices bound to the original device appear (Figure 102). Click the device with the bindings you wish to copy, and then click Finish.

Figure 102: Copying Options – Selecting Devices to Copy

If the subsystem that you are pasting objects into does not display the pasted devices, double-click the subsystem name in the Tree View pane to refresh the view.

Loading a Device Use the load option to update a device to the latest .apb and .xif files. To load a device: 1. Right-click the device to load in the Tree View pane, and then click Load. OR To load multiple devices that have the same device template, use the Shift key to select the device names in the List View pane. Right-click a selected device, and then click Load. The Reload Device Image dialog box appears.

2. Load the External Interface Definition from a device template by clicking the Load from template option and clicking the Template Name corresponding to an existing device template in the drop-down menu. Note: If the required device template does not exist, register the device plug-in or click the Create button to create a new template. See Registering Plug-ins or Adding a Device Template.

166 LN-Builder 3.5 Technical Bulletin

3. Load the Application Image into the device by clicking the Load Image option and specifying the location of the file to load. Note: Make sure that the latest .apb file available is installed on your computer. 4. Click Next. 5. Select Short for the Ping Interval. 6. Select Default values in Configuration Properties. 7. Select Online for the Initial State. 8. Click Next. 9. Configure the device identification method: • Select Service Pin if the device is already connected to the network and can be easily accessed. • Select Manual Entry if the device is not connected to the network and you know the device’s Neuron ID (typically found on a sticker on the device). Enter the Neuron ID. If you do not know the router’s Neuron ID, you can enter it when you commission the device at a later time. 10. Click Finish. An error message appears in LN-Builder if you try to load an incompatible .apb file into a device. However, this message does not appear if the Program ID Check option in the LN-Builder Settings menu is disabled.

Note: If you select the Service Pin device identification method, LN-Builder prompts you to press the service pin. The device’s Neuron ID is broadcast over the network.

Renaming a Device, Router, or Subsystem Use this procedure to change the name of a device, router, or subsystem (for example, when you move a device or router to a new building area or due to building and network design changes). To rename a device, router, or subsystem: 1. Right-click the device, router, or subsystem to rename in the Tree View pane, and click Rename. 2. Enter the new name, and then press Enter.

Renaming a Channel To rename a channel: 1. Change the display mode to Display on Channels by clicking the channel view button ( ) in the toolbar.

LN-Builder 3.5 Technical Bulletin 167

2. Right-click the channel to rename in the Tree View pane, and then click Properties. The Channel Properties dialog box appears. 3. Enter the new channel name in the Name field, and then click OK.

Moving a Device or Router to a Different Channel To move a device or router to a different network channel, you must specify the move in the network database. When you specify the move in LN-Builder, the application prompts you to physically detach the device or router from the old network channel and attach it to the new channel. Move a device or router to a different channel when, for example, the physical configuration of your building changes. When you attach an LN-Builder laptop to a different channel during network configuration and maintenance, you must move the LNS network interface to the corresponding channel in LN-Builder. This procedure describes how to move a device. The steps to move a router are the same, except that you can change two original channels using the drop-down menu because each side of a router is connected to a different channel. To move a device or router to a different channel: 1. Right-click the device or router to move and select Change Channel. The Change Channel dialog box appears. Note: To move multiple devices or routers, use the Shift key to select their names in the List View pane. Right-click a selected device or router and then click Change Channel.

Figure 103: Change Channel Dialog Box UPDATE

Table 87: Change Channel Dialog Box Field Description Choice of Destination Allows you to change the channel in which the Channel device/router resides. • Original channel: Indicates the channel in which the device/router previously resided. • Destination channel: Indicates the new channel to which to attach the device/router.

168 LN-Builder 3.5 Technical Bulletin

State of Devices after Allows you to select a state in which to put the Move device/router after the move. • Default: Puts the device/router in the default state defined. • Online: Puts the device/router in the online state where the application binary file executes. • Offline: Puts the device/router in the offline state where the application binary file stops running.

2. Click the destination channel in the drop-down menu, and then click OK. Note: If you are moving commissioned devices or routers on the network, LN-Builder prompts you to physically move the devices.

Figure 104: Physically Move Devices Dialog Box

Select the devices or routers to physically move and click OK. If you do not want to move the devices or routers, leave the check boxes empty and click OK. LN-Builder displays them as not being configured. You can use Device Manager to put them in the online state once you have physically moved them.

Moving a Device or Router to a Different Subsystem Use this procedure to logically move a device or router to a different subsystem. You do not need to physically move or reattach the device or router as you do when you move it to a new channel. To move a device or router to a different subsystem: 1. Right-click the device or router to move and then click Change Subsystem. The Selecting Subsystem dialog box appears. Note: To move multiple devices or routers, use the Shift key to select their names in the List View pane. Right-click a selected device or router and click Change Subsystem.

LN-Builder 3.5 Technical Bulletin 169

Figure 105: Selecting Subsystem

2. Expand the tree list to view the list of all subsystems in the network database. 3. Double-click the target subsystem. A dialog box appears to confirm the move. 4. Click OK.

170 LN-Builder 3.5 Technical Bulletin

Deleting a Device, Router, or Subsystem To delete a device, router, or subsystem: 1. Right-click the device, router, or subsystem to delete in the Tree View pane and select Delete. A dialog box appears to confirm the deletion. Note: To delete multiple devices, routers, or subsystems, use the Shift key to select their names in the List View pane. Right-click a selected device, router, or subsystem and then click Delete. 2. Click OK.

Replacing a Device LN-Builder allows you to replace a physical device without reconfiguring the new device. The original device and the replacement device must have the same hardware characteristics and support the same .apb and .xif files. To replace a device: 1. Right-click the device to replace and then click Replace. The Replace Devices dialog box appears.

Figure 106: Replace Devices Dialog Box

LN-Builder 3.5 Technical Bulletin 171

2. Load the External Interface Definition from a device template by selecting the Load from template option and clicking the Template Name corresponding to an existing device template in the drop-down menu. Note: If the required device template does not exist, register the device plug-in or click the Create button to create a new template. See Registering Plug-ins or Adding a Device Template. 3. Load the Application Image into the device by clicking the Load Image option and specifying the location of the file to load. Note: Make sure that the latest .apb file available is installed on your computer. 4. Click Next. 5. Select the required ping interval. 6. In Configuration Properties, select Values in Old Device. 7. Select Online for the initial state, and then click Next. 8. Configure the Device Identification Method: • Select Service Pin if the device is already connected to the network and can be easily accessed. • Select Manual Entry if the device is not connected to the network and you know the device’s Neuron ID (typically found on a sticker on the device). Enter the Neuron ID. If you do not know the router’s Neuron ID, you can enter it when you commission the device at a later time. 9. Click Finish. An error message appears in LN-Builder if you try to load an incompatible .apb file into a device. However, this message does not appear if the Program ID Check option in the LN-Builder Settings menu is disabled.

Note: If you select the Service Pin device identification method, LN-Builder prompts you to press the service pin. The device’s Neuron ID is broadcast over the network.

Replacing a Router LN-Builder allows you to replace a physical router without reconfiguring the new router. The original router and the replacement router must have the same hardware characteristics and support the same .apb and .xif files. 1. Right-click the router to replace and then click Replace. The Replace Router wizard appears.

172 LN-Builder 3.5 Technical Bulletin

Figure 107: Replace Router Wizard

2. Modify the fields. See Table 88.

LN-Builder 3.5 Technical Bulletin 173

Table 88: Replace Router Wizard Field Description Device Identification Method Select Service Pin if the router is already connected to the network and can be easily accessed. Select Manual Entry if the router is not connected to the network and you know the router’s Neuron ID (typically found on a sticker on the router) or if you are using a bar code scanner. You can commission the router at a later time. If you select Manual Entry, enter the Neuron ID in the Neuron ID field. If you do not know the router’s Neuron ID, you can enter it when you commission the device at a later time. Ping Interval Set the desired ping interval. Initial State Set the router’s initial state. Select Online to put the router in the online state. The device’s application binary file executes when online. Select Offline to put the router in the offline state. The device’s application binary file stops running when offline. 3. Click Finish. Note: If you select the Service Pin device identification method, LN-Builder prompts you to press the service pin. The router’s Neuron ID is broadcast over the network.

174 LN-Builder 3.5 Technical Bulletin

Resynchronizing Device Configuration Properties Use this procedure if you set the configuration properties of your device using a network management tool instead of LN-Builder. You must resynchronize the device configuration properties to match the properties in the device and the LNS database. To resynchronize device configuration properties: 1. Verify that the LN-Builder computer is attached to the network and is in OnNet mode. 2. Right-click the device to resynchronize and select Resynchronize CPs. The Resynchronize Configuration Properties wizard appears. Note: To resynchronize multiple devices, use the Shift key to select the device names in the List View pane. Right-click a selected device and then click Resynchronize CPs.

Figure 108: Resynchronize Configuration Properties Wizard

3. Select the desired resynchronizing operation. See Table 89.

Table 89: Resynchronize Configuration Properties Wizard Field Description Reset default values Downloads the default CP values stored in the device template to the device and stores the CP values in the LNS network database. Download current values to Downloads the CP values currently stored in device the LNS network database to the device. Upload values from device Uploads the CP values currently stored in the device to LN-Builder and uses the values to update the LNS database. Set device template default Uploads the CP values currently stored in the values from device device to LN-Builder and sets the default device CPs in the device template. 4. Click OK. An error message appears in LN-Builder if you try to load an incompatible .apb file into a device. However, this message does not appear if the Program ID Check option in the LN-Builder Settings menu is disabled.

LN-Builder 3.5 Technical Bulletin 175

Resynchronizing Device Configuration Property, Network Variable, and LONMARK Object Names If the LNS TURBO Edition runs on your network, use LN-Builder to revert any changes made to a device’s configuration property names, network variable names, or internal LONMARK object names. To resynchronize these names: 1. Right-click the desired device and then click Resynchronize to Template. The Resynchronize to Template dialog box appears. Note: To resynchronize the names in multiple devices, hold down the Shift key while you select multiple device names in the List View pane. Right-click a selected device and then click Resynchronize to Template.

Figure 109: Resynchronize to Template Dialog Box

2. Select the desired resynchronizing options. See Table 90.

Table 90: Resynchronize to Template Dialog Box Field Description Update Configuration Property Resets the names of the device’s configuration Names properties to the template defaults. Update LONMARK Object Updates the names of the device’s LONMARK Names objects to the template defaults. Update Network Variable Updates the names of the device’s network Names variables to the template defaults.

176 LN-Builder 3.5 Technical Bulletin

3. Click OK.

Creating and Viewing a Device Status Summary Report The device status summary creates reports showing the status of items on the network. For example, you can generate a report that displays items In Override or In Alarm status, or items that meet other criteria. A report can also give a numbered count of the objects in a network or subsystem. To create and view a device status summary report: 1. In the Network menu, click Device Status Summary. The Device Summary Options dialog box appears with the Function Block tab active. Note: You can also open the Device Summary Options dialog box by right- clicking a subsystem and then clicking Device Status Summary.

Figure 110: Device Summary Options Dialog Box – Function Block Tab

2. Select the desired functional block properties to include in the report. See Table 91.

LN-Builder 3.5 Technical Bulletin 177

Table 91: Device Summary Options Dialog Box – Function Block Tab Field Description Essential Allows you to configure the device status summary to display information about which blocks are in the override condition, disabled, in alarm, and have had communication and self-test failures. More Others Allows you to configure the device status summary to display electrical faults, mechanical faults, open circuits, feedback failures, devices which are locked out, devices which are under manual control, devices with their alarm notification disabled, and functional blocks returning out of limits, out of service, over range, under range, unable to measure, programming mode, or programming failure exceptions. List only the function Lists only the functional blocks that support at least blocks that support at one of the properties selected. least one of the checked Note: Some functional blocks do not support all of the properties above. status attributes contained in the Essential and More Others tabs. Set As Default Options Saves the current property selection to the hard disk as the default values. The default settings are applied whenever you open the Device Status Summary.

3. Click the Device tab and select the desired device properties to include in the report. See Table 92.

Figure 111: Device Summary Options Dialog Box – Device Tab

178 LN-Builder 3.5 Technical Bulletin

Table 92: Device Summary Options Dialog Box – Device Tab Field Description Scope Allows you to determine which objects (devices, routers, and functional blocks) to include in the device status summary. • Subsystem: Summarizes the objects in the current subsystem. This option is inactive in the Device Status Summary if it has not been launched from a subsystem. • Subsystem (Nested): Summarizes the objects in the current subsystem and all subsystems included in it (Nested Subsystems). This option is inactive in the Device Status Summary has not been launched from a subsystem. • Entire Network: Summarizes all the objects in the network. General Informations Allows you to configure the device status summary to display device information such as: the device state, subnet/Node ID, subsystem, template, neuron ID, type, channel, program ID and name. Set As Default Options Saves the current property selection to the hard disk as the default values. The default settings are applied whenever you open the Device Status Summary.

4. Click OK. The Status Summary Results (Device Summary Report) dialog box appears with the Network/Subsystem tab active.

Figure 112: Status Summary Results (Device Summary Report) Dialog Box

5. Click the tabs to view summary information and use the Options and Save As features as desired. See Table 93.

LN-Builder 3.5 Technical Bulletin 179

Table 93: Status Summary Results (Device Summary Report) Tab or Button Description Network/Subsystem Lists information about the network and the subsystems. Devices/Routers Lists information about devices and routers. Function Blocks Lists information about functional blocks. Some functional blocks do not support all of the status attributes. The unsupported attribute is indicated by the value NA in the associated field. Options Open the Device Summary Options dialog box to change the report configuration. Save As Saves the information to a comma separated value file (.csv file).

6. Click Close.

Exporting .xml Files To export .xml files: 1. Right-click the device. A right-click menu appears (Figure 113).

Figure 113: Export to File Menu

2. Select Export to File > From Device or From Database. The Save As dialog box appears. 3. Select where to save the file, and then click Save.

180 LN-Builder 3.5 Technical Bulletin

Importing .xml Files To import .xml files: 1. Right-click the device and select Import From File. The Open dialog box appears. 2. Select the .xml file and click Open. The Importing Device Configuration window appears. 3. Select what options you want to import, and then click Finish. Note: When you import .xml files into the database, the database attempts to synchronize with the device. If the device is offline, you must manually synchronize when the device is online. The Network Variable Connections (Bindings) and Neuron ID: Applicable only to the Non-Commissioned Device options are unavailable.

Viewing Audit Log Settings To view the Audit Log Settings dialog box: 1. In the Settings menu, click Log File. The Log Settings dialog box appears.

Figure 114: Log Settings Dialog Box

2. Fill in the fields. See Table 94.

LN-Builder 3.5 Technical Bulletin 181

Table 94: Log Settings Dialog Box Field Description Log File Max Length Allows you to specify the size limit for the log file (in MB). When the file reaches the limit, LN-Builder removes the oldest log entry to make room for the current log entry. The default size limit is 1 MB. Auto Saving Time Allows you to specify the time interval between automatic saving of the log file. The default save time is 10 minutes. Saving Path Indicates the path and name of the Log file. The default path is C:\LB3.5.log

3. Click OK.

Launching the Johnson Controls Browser You can launch the Johnson Controls Browser in several ways: • To launch an empty instance of the Johnson Controls Browser from LN-Builder, click the icon in the toolbar. The Johnson Controls Browser opens, and you can drag network variables and configuration properties from the List View pane of LN-Builder into the empty session of the browser. See Dragging Network Variables and Configuration Properties from LN-Builder 3.5 to the Johnson Controls Browser.

• In LN-Builder, right-click a device, functional block/LONMARK object, or network variable and select Browse. The Johnson Controls Browser opens, displaying all network variables associated with the selected item. Configuration properties do not display by default, but you can click the icon in the browser toolbar to display the properties. You can browse all network variables with the same name and type in the network or in a single subsystem, as shown in Figure 115.

182 LN-Builder 3.5 Technical Bulletin

Figure 115: Launching the Johnson Controls Browser – Browse Right-Click Menu

• In LN-Builder, right-click a device, functional block/LONMARK object, or network variable and select Plug-Ins () > Johnson Controls AppDevice Browse. The Johnson Controls Browser opens, displaying all network variables associated with the selected item.

LN-Builder 3.5 Technical Bulletin 183

Figure 116: Launching the Johnson Controls Browser – Plug-Ins Right-Click Menu

184 LN-Builder 3.5 Technical Bulletin

Dragging Network Variables and Configuration Properties from LN-Builder 3.5 to the Johnson Controls Browser Use this procedure to drag network variable and configuration property selections from LN-Builder into the Johnson Controls Browser: 1. Open LN-Builder and the Johnson Controls Browser. 2. Click the network variable or configuration property to add to the Johnson Controls Browser. Note: Select multiple network variables or configuration properties using the Ctrl and Shift keys. 3. Click the network variable or configuration property, drag it into the Johnson Controls Browser, and release the mouse button.

Figure 117: Drag and Drop Functionality

4. If required, save the list of network variables and configuration properties to a watch list (.wlt) file by selecting Save from the File menu and specifying a file name.

Browsing Network Variables and Configuration Properties LN-Builder allows you to browse all network variables or configuration properties with the same name and type at once, in the network or in a single subsystem.

LN-Builder 3.5 Technical Bulletin 185

As an example, this procedure shows how to browse for the network variable nviManOverride for all VAVs in a subsystem, as well as to browse to the SCPTlocation configuration property for these controllers. To browse network variables and configuration properties: 1. Open or create a network database with a subsystem containing multiple VAVs. 2. Expand the subsystem with the VAVs in the Tree View pane.

3. Expand the view of one of the VAVs to view the associated LONMARK node objects ( ) and all the network variable and configuration properties.

Figure 118: Browsing Network Variables and Configuration Properties

4. Double-click the Node Object. 5. In the Tree View pane or the List View pane, right-click nviManOverride and select Browse > NVs With Same Names and Same Type Of Devices In The Subsystem. The Johnson Controls Browser appears with a list of all the VAVs in the subsystem and the relevant nviManOverride data. 6. Go to the LN-Builder interface without closing the Johnson Controls Browser. 7. Right-click SCPTlocation in the List View pane and then click Browse > CPs with same name and type of device in the subsystem. A list of all SCPTlocation values for all VAVs in the subsystem appears in the Johnson Controls Browser. 8. Click the Device column heading to rearrange the screen by device.

186 LN-Builder 3.5 Technical Bulletin

Figure 119: Johnson Controls Browser

9. If required, save the list of network variables and configuration properties to a watch list (.wlt) file by selecting Save from the File menu and specifying a file name.

Opening a Watchlist in the Johnson Controls Browser To open a watchlist in the Johnson Controls Browser: 1. In the File menu of the Johnson Controls Browser, select Open. The Open dialog box appears. 2. Browse to and select the desired watchlist file (.wlt file), and then click Open. Note: You can also double-click a watchlist in Windows Explorer to open the browser and display the saved list of points in real time.

LN-Builder 3.5 Technical Bulletin 187

Saving a Watchlist in the Johnson Controls Browser To save a watchlist in the Johnson Controls Browser: 1. In the File menu of the Johnson Controls Browser, click Save As. The Save As dialog box appears. 2. Enter a name for the watchlist file. 3. Browse to and select the desired location to save the watchlist file, and then click Save.

Restoring Items in the Johnson Controls Browser To restore items (network variables and configuration properties) in the Johnson Controls Browser: 1. In the Edit menu of the Johnson Controls Browser, select Undelete Rows. The Undo Delete dialog box appears.

Figure 120: Undo Delete Dialog Box

2. Select one or more rows to restore. 3. Click Restore to continue looking for other items to restore after restoring the selected items, or click OK to restore the selected items and exit the dialog box.

188 LN-Builder 3.5 Technical Bulletin

Viewing and Modifying Johnson Controls Browser Options To view and modify Johnson Controls Browser options: 1. In the Browser menu of the Johnson Controls Browser, click Options. The Browser Options dialog box appears with the Display tab active.

Figure 121: Browser Options Dialog Box – Display Tab

2. Select the type of items to display in the browser. See Table 95.

Table 95: Browser Options Dialog Box – Display Tab Field Description Network Variables Displays only network variables in the browser. Config Properties Displays only configuration properties in the browser. Both Displays both network variables and configuration properties in the browser.

LN-Builder 3.5 Technical Bulletin 189

3. Click the Messaging tab and configure how the browser communicates with physical devices. See Table 96.

Figure 122: Browser Options Dialog Box – Messaging Tab

Table 96: Browser Options Dialog Box – Messaging Tab Field Description Number of retries Sets the number of times the browser sends a message using acknowledged or repeated messaging. Service Type Determines the type of messaging to use to update network variables: Acknowledged, Unacknowledged, or Repeated. You can change this option to Unacknowledged or Repeated messaging even if the object requires authentication based on the network configuration. However, if you try to update a network variable in an authenticated connection, the network variable does not update. Priority Determines if the browser uses priority messaging to poll and update network variables.

190 LN-Builder 3.5 Technical Bulletin

4. Click the Network Variables tab and configure how the browser updates the values of the network variables being displayed. See Table 97.

Figure 123: Browser Options Dialog Box – Network Variables Tab

Table 97: Browser Options Dialog Box – Network Variables Tab Field Description Polling Interval Determines the time interval at which the browser polls network variables to update the variable values. Use report by exception Configures the LNS server to update the value of the items being displayed only if there is a change in the values. Suppress Polling If Disables the polling of network variables that are in a Bound bound state. Most network bindings have a heartbeat or an update rate that the browser uses to detect and read the updated values being sent over the network. Because the browser polls the network variables in addition to the updates detected at every heartbeat period, use this option to lessen network traffic. Set default state to Turns the default monitoring state of the browser to Monitor On On. Restore Default Restores the settings of this tab to the default values.

LN-Builder 3.5 Technical Bulletin 191

5. Click the Configuration Properties tab and set the source from which the browser reads values. See Table 98.

Figure 124 Browser Options Dialog Box – Configuration Properties Tab

Table 98: Browser Options Dialog Box – Configuration Properties Tab Field Description Read value from Reads the configuration properties from the network database database. Read value from device Reads the configuration properties from the device.

192 LN-Builder 3.5 Technical Bulletin

6. Click the Monitor Sets tab and set how the browser handles monitor sets when closed. See Table 99.

Figure 125: Browser Options Dialog Box – Monitor Sets Tab

Table 99: Browser Options Dialog Box – Monitor Sets Tab Field Description Remove all monitor sets Deletes all monitor sets that are in use when you close on closing the browser. Because monitor sets remain in the LNS database for future use after closing the browser, the monitor set locks the item so that you cannot change the network variable or configuration property type. Use this option to avoid this conflict.

7. Click OK.

LN-Builder 3.5 Technical Bulletin 193

Customizing the Johnson Controls Browser To customize the Johnson Controls Browser: 1. In the Browser menu of the Johnson Controls Browser, click Customize. The Customize dialog box appears.

Figure 126: Customize Dialog Box

Table 100: Customize Dialog Box Field Description Available Columns Lists hidden columns available to display in the browser. Current Columns Lists the columns currently displayed in the browser. >> Moves a selected column from the Available Columns list to the Current Columns list. << Moves a selected column from the Current Columns list to the Available Columns list. Move Up Moves the selected column up one place in the list. Move Down Moves the selected column down one place in the list.

2. Use the >> and << buttons to show and hide columns. 3. Use the Move Up and Move Down buttons to rearrange the order of the columns in the browser. 4. Click OK.

194 LN-Builder 3.5 Technical Bulletin

Displaying Error Messages in the Johnson Controls Browser To display error messages, click Display Error Message in the Browser menu of the Johnson Controls Browser. The Error Messages dialog box appears. To clear one or more errors from the log, click the errors (using the Ctrl or Shift keys as necessary). Then right-click a selected error and click Clear Selected Items. To clear all errors from the log, right-click an error and then click Clear All. To save the log list, right-click any error and click Save to file. A Save dialog box appears prompting you to enter a name and select a location for the log file. The log file has a .log extension. You can later open the log file using a standard text editing software such as Notepad.

Changing Network Variables or Configuration Properties in the Johnson Controls Browser You can change the values of network variables or configuration properties in the List View portion of the browser and then download these changes to the devices. To change a network variable or configuration property in the Johnson Controls Browser: 1. In the Johnson Controls Browser List View, expand the network variable or configuration property to view its details. 2. Click the value field of the newly expanded line and enter the new value for the item. Note: If the value is an enumerated value (text), clicking the value field displays a drop-down list of value options from which to choose. However, you also can type the enumerated value. 3. Click the red downward arrow in the toolbar to download all values to the device.

LN-Builder 3.5 Technical Bulletin 195

Changing Network Variable or Configuration Property Format in the Johnson Controls Browser The procedure to change network variable or configuration property format is the same in the Johnson Controls Browser as it is in the LN-Builder. See Changing Network Variable and Configuration Property Formats.

Changing Network Variable Type in the Johnson Controls Browser The procedure to change the network variable type is the same in the Johnson Controls Browser as it is in the LN-Builder. See Changing the Network Variable Type.

Viewing and Modifying Network Variable or Configuration Properties in the Johnson Controls Browser The procedures to view or modify network variable and configuration properties are the same in the Johnson Controls Browser as they are in the LN-Builder. See Viewing and Modifying Network Variable Properties and Configuring a Device Using Configuration Properties.

Building Technologies & Solutions 507 E. Michigan Street, Milwaukee, WI 53202

Metasys® and Johnson Controls® are registered trademarks of Johnson Controls.