LM-UG1 6/19/06 9:30 AM Page 1 LonMaker User’s Guide ® LonMaker® User’s Guide www.echelon.
Echelon, LON, LONWORKS, LonTalk, Neuron, LONMARK, 3120, 3150, LNS, LonMaker, and the Echelon logo are trademarks of Echelon Corporation registered in the United States and other countries. LonPoint and LonSupport are trademarks of Echelon Corporation. Other brand and product names are trademarks or registered trademarks of their respective holders.
Preface The LonMaker Integration Tool is a software package for designing, installing, and maintaining multi-vendor, open, interoperable LONWORKS® control networks. Based on Echelon's LNS® network operating system, the LonMaker tool combines a powerful, client-server architecture with an easy-to-use Visio user interface. The result is a tool sophisticated enough to design, commission, operate, and maintain a control network, yet economical enough to be left behind as an operation and maintenance tool.
Purpose This guide outlines the new features in the Turbo edition of the LonMaker Integration Tool, and it describes how to use the LonMaker Integration Tool to design, commission, monitor and control, maintain, and manage a network. The LonMaker Integration Tool includes an online help system that provides context-sensitive help that supplements the information in this guide. Audience This guide is intended for system designers and integrators with an understanding of control networks.
• Installing Networks: Describes how to install devices using the LonMaker tool, including how to load applications into them, set the initial state of their applications, set the source of their configuration properties, and select how they manage device-specific configuration properties. It also explains the different methods for acquiring device Neuron IDs and how to alternatively use the device discovery method to install a network.
The LonMaker and LonPoint Plug-In ReadMe files provide descriptions of known problems and their workarounds. To view the LonMaker Turbo Editions ReadMe file, click Start, point to Programs, point to Echelon LonMaker, and then select LonMaker Read Me. To view the LonPoint ReadMe file, click Start, point to Programs, point to Echelon LonPoint Software, and then select LonPoint Read Me First. You can also find additional LonMaker and LonPoint information at the LonMaker Web page at www.echelon.com/lonmaker.
Region China Languages Supported Chinese English Contact Information Echelon Greater China Rm. 1007-1008, IBM Tower Pacific Century Place 2A Gong Ti Bei Lu Chaoyang District Beijing 100027, China Phone: 86 10 6539 3750 Fax: 86 106539 3754 lonsupport@echelon.com.cn Other Regions English Phone: 408 938 5200 Fax: 408 328 3801 lonsupport@echelon.com Echelon will provide Visio support only for those Visio features that are required for use of the LonMaker tool.
Table of Contents Preface .................................................................................................... iii Purpose .......................................................................................................... iv Audience......................................................................................................... iv Related Reading............................................................................................. iv Content ..........................
Exporting a LONWORKS Network XML File ....................................... 11 Importing a LONWORKS Network XML File ....................................... 11 Automatic Extension Record Copying.............................................. 11 Plug-in Enable/Disable ..................................................................... 11 LNS Network Database .......................................................................... 12 LNS Hot Backup ........................................................
Selecting a Network Installation Scenario .............................................. 34 Engineered System Scenario ........................................................... 34 Ad-Hoc System Scenario ................................................................. 35 Determining User Permissions ............................................................... 35 Optimizing LonMaker Network Performance .......................................... 35 Drawing Files...........................................
Creating a New Functional Block from a Configured Functional Block......................................................................... 88 Updating a Functional Block from a Configured Functional Block .......................................................................................... 89 Creating a Functional Block Master Shape ...................................... 91 Creating Dynamic Functional Blocks................................................ 91 Deleting Dynamic FBs ......................
Opening a Parent Subsystem ........................................................ 129 Using Network Navigators .............................................................. 129 Navigating and Managing a Network with the Network Explorer.......... 130 Navigating a Network with the Network Explorer ........................... 131 Managing a Network with the Network Explorer ............................ 131 Managing and Editing Device Templates with the Network Explorer .....................................
Hiding or Changing the Order of Browser Columns ................ 169 Adjusting the Width of Browser Columns ................................ 169 Customizing Browser Rows............................................................ 170 Selecting Browser Rows to be Displayed ................................ 170 Hiding Browser Rows............................................................... 170 Saving Browser Customization ......................................................
Resynchronizing Configuration Properties .................................................. 204 Using the LonMaker Tool as a Passive Configuration Tool ........................ 205 Backing up a LonMaker Network Design .................................................... 206 Manually Backing Up a LonMaker Network.......................................... 206 Creating a Backup from a LonMaker Drawing ............................... 206 Creating a Backup from the LonMaker Design Manager ...............
10 LonMaker Credits .......................................................................... 279 Licensing with the LonMaker Tool............................................................... 280 Defragmenting the LonMaker Disk.............................................................. 280 Using LonMaker Credits .............................................................................. 280 Viewing LonMaker Credits ....................................................................
Shape ToolTips Options ....................................................................... 342 Synchronization Options ....................................................................... 343 Warnings Options.................................................................................. 344 Appendix B - Installing Network Interfaces ...................................... 347 Installing the PCLTA-10 Network Interface .................................................
1 Introduction This chapter provides an introduction to the LonMaker Integration Tool, new features in the Turbo Editions; and the basics of LonMaker Network Designs, LONWORKS, and Visio.
Introduction to the LonMaker Tool The LonMaker® Integration Tool is a LONWORKS ® network tool that runs on the LNS® client/server network operating system and uses Microsoft Visio® (Professional or Standard 2003) as a graphical user interface. LNS provides the set of directory, installation, management, monitoring, and control services used by the LonMaker tool.
Functional Blocks • • • • • • One-page wizard Automatic device selection Device re-assignment with the Connector tool Simplified shape menu Dynamic functional blocks Dynamic network variables on application functional blocks Connections • • • • • • • • Simplified Connector tool Automatic connection type selection Fast connection property modification New connection descriptions More default connection descriptions New connection property modification Connection hiding Connection reference shape alignme
One-Click Network Creation You can now create new networks with only one mouse click from the LonMaker Design Manager. To use the one-click network creation feature, clear the Show All Options check box in the New Network box on the General tab, and select the options in the New Network Options tab to skip the pages for setting the management mode, network interface, registered plug-ins, and default LonMaker stencils.
See Creating Application Devices and Creating Routers in Chapter 4, Designing Networks, for more detailed information on using these simplified wizards. Automatic Channel Selection You can use automatic channel selection to enable the LonMaker tool to automatically select the appropriate channel or channels for a new application device or router, skipping their respective wizards. This feature lets you create a new device or router with a single click and drag.
You can also set the initial values of device-specific configuration properties when commissioning or replacing a device, loading a new application image into the device, or resynchronizing configuration properties. For example, when commissioning or replacing the thermostat in the previous example, you may load the configuration property value from the LNS network database to assign the initial setpoint.
Accelerated Device Interface Verification The LonMaker Turbo Editions let you disable any or all of the validation steps performed on the device interface when a device is commissioned. This may reduce the time required to install a network, especially for power line devices. To set the validation options, right-click a device template in the Device Templates tab in the Network Explorer, and then select Properties from the shortcut menu.
Creating Dynamic Functional Blocks You can create dynamic functional blocks on devices that support them. Device manufacturers can implement dynamic functional blocks on devices that support customized interfaces, such as programmable controllers. Within the LonMaker tool, dynamic functional blocks are similar to the more common static functional blocks except that they can only be added to a compatible device and they do not contain configuration properties.
Automatic Reference Connection Shape Alignment You can automatically align and keep aligned all the reference connection shapes in a subsystem or the reference connection shapes attached to a specific functional block. This feature eliminates the need to manually move functional block, connector, and connector reference shapes to keep your LonMaker drawing organized. See Aligning Reference Connection Shapes in Chapter 4, Designing Networks, for more detailed information on using this feature.
Multi-User Modification The new features in the LonMaker Turbo Editions for multi-user modification are described in the following sections. See Resynchronizing a Network in Chapter 7, Maintaining Networks, for more detailed information on using these new features. Automatic Drawing Synchronization You can make changes to a LonMaker drawing at the same time other users are modifying the network, even if the other users are modifying the same subsystem as you.
• Red. Resource is critically low (over 90 percent used). To view the network resources report, open the LonMaker menu and then click LonTalk Network Resources. Alias Table Summary You can display a summary of the usage and availability of alias table entries for a device in a ToolTip. The device shape ToolTip lists the total number of network variable aliases for the device, and the number of aliases currently available.
LNS Network Database The LonMaker Turbo Editions includes new features to help you backup, validate, repair, and synchronize your network database. These features are described in the following sections. LNS Hot Backup You can make a hot backup of the network database while you or another user is working in the same network—without disrupting the other LNS applications. A hot backup is a backup that is created while one or more LNS applications are accessing the LNS network database.
Visio 2003 Integration Tablet PC Support You can run the LonMaker tool on a Tablet PC. The ease of portability of a Tablet PC makes it ideal for installing a network under the ad-hoc system scenario, in which you both design and commission the network onsite. You can wirelessly connect the Tablet PC to an i.Lon IP-852 router that is attached to the physical network, and then carry the Tablet PC around the site, designing the LonMaker drawing and commissioning devices at the same time.
Standard Edition The standard edition ships with Visio 2003 Standard, comes with 5 LonMaker credits, and does not expire. You can purchase additional LonMaker credits for the standard edition (see Adding LonMaker Credits). Trial Edition The trial edition ships with a 30-day evaluation copy of Visio 2003 Professional, does not come with any LonMaker credits, and requires licensing the professional or standard edition to continue using the LonMaker tool after the 30-day trial period ends.
The Glossary in Appendix G provides a quick reference for specific terms. LONWORKS Networks A LONWORKS network consists of intelligent devices (such as sensors, actuators, and controllers) that communicate with each other using a common protocol over one or more channels. Network devices are sometimes called nodes. Devices Each device includes one or more processors and a transceiver. The processor(s) provide the device’s intelligence and implement a communications protocol.
Applications in devices are divided into one or more functional blocks. A functional block is a collection of network variables and configuration properties that are used together to perform one task. For example, a four-port digital input module may have four digital input functional blocks that contain the configuration properties and output network variable for each of the four hardware digital inputs on the device.
Subsystems Devices, routers, and functional blocks are contained in subsystems. With the LonMaker tool, each subsystem corresponds to one page within a LonMaker drawing. Subsystems allow you to place devices, routers, and functional blocks onto separate pages for organizational purposes. You may also nest subsystems in other subsystems, allowing you to create a subsystem hierarchy for large networks. For example, a network may consist of HVAC, lighting, security, and operator subsystems.
To simplify access to your most commonly used stencils and drawing options, Visio defines another type of drawing called a template. Templates are drawings that may be used as the starting point when you create a new drawing. The LonMaker tool includes a LONWORKS template that is used automatically when you create a LonMaker drawing. If you wish, you can create your own custom LonMaker template and select it as the default template in the LonMaker Design Manager.
2 Installing and Activating the LonMaker Tool This chapter lists the hardware requirements for using the LonMaker tool; describes how to install the various software and components included in your copy of the LonMaker tool; and describes how to activate the LonMaker tool.
Hardware Requirements This section describes the hardware requirements and recommendations for your computer when using the LonMaker tool. If you are engineering a network with more than 200 devices, see the additional recommendations for the LNS Server and the LonMaker computer in Enhancements for Engineering Large Networks.
commission or recover LONWORKS devices. See the LonMaker Software License Agreement in Appendix E for additional restrictions. To begin your installation, follow these steps: 1. If you previously installed a LonMaker Trial Edition and you are now installing one of the full editions, you must first uninstall the Visio Trial software. If you do not uninstall the Visio Trial software first, the LonMaker software will be installed, but the full version of Visio will not.
Most network interfaces include an application that handles network interface configuration. You must perform this configuration before you can use the LonMaker tool attached to a network. The application handles host details such as IRQ assignment and also manages network parameters such as buffer counts and transceiver types. To open the network interface application, click Start on the taskbar, point to Programs (Windows 2000), and click Control Panel.
11. When all of the selected components have been installed, a dialog appears informing you that the setup has been completed and prompting you whether to reboot your computer now or later. You must reboot your computer before beginning to use the LonMaker tool. Installing Visio 1. If you selected the Visio component in the Select Components window, The Microsoft Visio setup wizard appears when you click Install. 2. Follow the instructions in the installation program to complete the Visio setup.
The Visio installation may suggest that you exit LonMaker setup. You can safely disregard this message by clicking Ignore. To keep an existing Visio installation, install the Visio program on the LonMaker CD into a new directory. 3. When the Visio installation has finished, the following dialog appears, informing you that the setup has been completed. 4. Click Finish. Notes: • Before you do any further required reboots, you should install the Visio 2003 Service Pack 2 on the LonMaker CD.
Installing the LonMaker Integration Tool 1. The LonMaker setup program begins automatically with the Welcome window opening. 2. Read the information on the Welcome window and click Next. The License Agreement window appears. 3. Read the license agreement and click Yes if you agree with the terms. The User Information window appears.
4. 26 Enter your name, company name, and the LonMaker serial number in the appropriate fields. The name and company may be entered automatically based on the user currently logged on and whether other Echelon products are installed on your computer. If you did not license an upgrade version, the serial number is located on the back of your LonMaker CD case. If there are two serial numbers on the back of your CD case, the second number is the LonMaker serial number. Save this number.
5. If the Destination Location window appears, choose a LONWORKS folder in which you want the LonMaker software installed. The LonMaker software will be installed in a LonMaker folder below the LONWORKS folder that you specify. If you installed other Echelon software on this computer, use the same LONWORKS folder. The default LONWORKS folder is C:\LonWorks.
4. Choose a LONWORKS folder for the plug-in. You must use the same LONWORKS folder in which you installed the LonMaker tool. The default is C:\LonWorks. Click Next. The Select Echelon Application Image Version window appears. 5. If this is a new installation, use LonPoint firmware version 3 instead of version 2. This window allows you to install a copy of version 2 firmware if you need the capability to install devices with this older firmware.
Click Run Activation Wizard in the LonMaker Product Activation dialog to begin the activation process or click Continue to keep running the LonMaker tool in demo mode. The LonMaker license status box in the bottom left-hand corner of the LonMaker Design Manager also indicates that your copy of the LonMaker tool has not been activated and the number of days your LonMaker tool will continue to function.
1. Start the LonMaker Design Manager or open a LonMaker drawing. The LonMaker Product Activation dialog appears. 2. Click Run Activation Wizard. The LonMaker Activation wizard appears. If you click Continue, you can still access this dialog and begin the activation process by completing the following steps: 3.
4. The wizard displays the PC Key (also called the activation code), which uniquely identifies your copy of the LonMaker tool and the computer running the LonMaker tool, and the Serial number of your LonMaker tool. Click Copy to Clipboard. 5. An activation request form is created that includes your request to activate your copy of the LonMaker software, the PC key (activation code), and the serial number. 6. Send the activation request form to your license administrator via e-mail, fax, or mail.
32 6. Click OK. 7. Exit and then re-open the LonMaker Design Manager to begin using your activated LonMaker tool. Any additional credits purchased will be applied.
3 Getting Started This chapter provides information on the planning a LonMaker network design; using the LonMaker Design Manager; setting up a network interface; creating and opening a LonMaker network design; LonMaker client types; using the LonMaker tool remotely; using Network Device shapes; and creating and using user profiles.
Design Overview To prepare to design a LonMaker network, follow these steps: 1. 2. 3. 4. Define network requirements and organization. Select a network installation scenario. Determine user permissions for viewing and changing the network. Optimize network performance.
Ad-Hoc System Scenario The ad-hoc system scenario allows you to design and install the network onsite. In this scenario, the LonMaker tool loads the network configuration information into each device as you define devices, configurations, and connections. This is different from the engineered system scenario in that information is incrementally loaded to the physical devices. The advantage of the ad-hoc system scenario is its flexibility, as the installer can make decisions onsite.
When designing multiple drawing files, organize the individual drawing files as subsystems within the top-level drawing file, and limit the top-level drawing to contain only those subsystems. This minimizes the number of drawing files that must be opened as you descend the subsystem hierarchy. Avoid deep subsystem hierarchies with long subsystem names that results in long subsystem paths.
master shapes with your most commonly used network variables. See Creating a Functional Block Master Shape in Chapter 4, Designing Networks for more information. Subsystems Subsystems allow you to divide a large network into more manageable parts. For example, in a building control network, one subsystem could contain lighting controls and another temperature controls. Each subsystem is represented by a page of a LonMaker drawing and by a subsystem shape on the drawing page of its parent subsystem.
The following sections describe the functions and available options in each tab of the LonMaker Design Manager. General You can use the General tab in the LonMaker Design Manager to create, open, copy, delete, backup, restore LonMaker network designs; start the LNS Server application so remote clients can access the LNS network database; import a database and then create a new LonMaker drawing from it; and defragment LNS network databases.
new LNS network database and a new LonMaker drawing. Show all options Displays all the pages in the Network Wizard as the network is opened, regardless if the Skip this Prompt option is selected for a page in the New Network Options tab. To create networks with one-click, clear this check box and select the options in the New Network Options tab to skip the pages in the Network Wizard. Existing Network Drawing Directory Selects a file from the folder indicated in the Drawing Base Path list.
Prompt option had been previously selected. Restore Restores a LonMaker drawing and LNS network database from a LonMaker backup file. See Restoring a LonMaker Network in Chapter 7, Maintaining Networks, for more information. See Using LonMaker Backup Files for more information on how to use the LonMaker Restore dialog. See Backup/Restore Options in Appendix A for the default restore options you can set. Import Imports an LNS network database (objects.
The LonMaker Design Manager’s Options tab contains the following options: Set LONMARK Resource Files Languages Allows available language-specific LONMARK resource files to be added, removed, or reordered in the languages list. When searching for a resource definition such as an NV field name, the LonMaker tool searches the first language file in the list for the device information, then the second language file in the list, and so on until it finds the information for the specified device.
New Network Options You can use the New Network Options tab to set the default properties for the network interface, plug-ins, user logon, and management mode pages in the Network Wizard, and set the default network components. The properties you set are then applied to each new network you create. You can also select options to have the LonMaker tool skip the pages in the Network Wizard when opening a network.
Skip Plug-ins Options Page Skips the plug-in registration page in the Network Wizard when you create a new LonMaker network. User Logon Skip Logon Options Page Management Mode Skips the user logon page in the Network Wizard when you open a LonMaker network. Select when changes made in your LonMaker drawing are transmitted to the physical devices on the network. OnNet Changes to the LonMaker drawing are sent immediately to the physical devices on the network.
may be up to 85 characters, may include embedded spaces, but may not include the period, backslash, colon, forward slash, or double quote characters. Channel names are case sensitive. The default root channel name is “Channel 1”. LonMaker Stencils The LonMaker Design Manager’s LonMaker Stencils tab lists the LonMaker stencils that are initially available in the LonWorks template upon opening or creating a network drawing. It allows you to add, remove, or modify the properties of LonMaker stencils.
LonMaker Default Options You can use the LonMaker Default Options tab to set the LonMaker default properties for the new networks you create. This tab contains a list of LonMaker options categories such as options for devices, functional blocks, and configuration properties. The default options you set will be applied to each new LonMaker network you create.
Setting Up a Network Interface You can directly attach your LonMaker computer to a LONWORKS network. To attach the LonMaker tool to the network, you must define and configure your network interface before starting the LonMaker tool. LNS network interfaces include the following: IP-852 interfaces (i.LON 10 Ethernet Adapters, i.LON 100 Internet Servers, and i.
e. Repeat steps c and d for each LNS Server computer, LonMaker computer, and IP-852 router on the IP-852 channel The devices on the IP-852 channel will not be fully commissioned until you run LNS applications such as the LNS Server or LonMaker tool on each of the LNS Server or LonMaker computers. For more information, see the LonWorks-IP Configuration Server Help file. Creating and Opening a LonMaker Network A LonMaker network consists of a LonMaker drawing and an LNS network database.
Tips: 5. • You can click Finish at any point in the Network Wizard. Doing so will skip the subsequent series of pages, and your new LonMaker network design will be created using the current settings in the New Network Options tab of the LonMaker Design Manager. • By default, the subsequent pages in the Network Wizard will appear each time you re-open the LonMaker drawing. Select the Skip This Prompt when Re-opening this Drawing check box on any of the pages you want to skip when re-opening the drawing.
Network Database Path Specifies the folder that will contain the network database. By default, the database path is C:\LM\DB\. You can specify a different to place the LonMaker network database; however, the network name in the database path must match the one in the Network Name box. Network Drawing Path Specifies the folder that will contain the LonMaker drawing. By default, the drawing path is C:\LM\Drawings\.
LONWORKS/IP Configuration Server, which you can access by clicking Start on the taskbar, pointing to Programs, and then clicking Echelon LonWorks-IP Configuration Server. Your computer must have a static IP address, or it must have a dynamic IP address that does not change (you cannot use an IP address that may be changed by a DHCP server). For more information on using the LonWorks-IP Configuration Server, see the IP-852 Channel User’s Guide and the LonWorks-IP Configuration Server Help file. 8.
11. Use the following commands to register, deregister, enable, and disable plug-ins in your LonMaker network. Register Adds a plug-in to the Pending list, indicating that the plug-in is to be registered. A plug-in must be registered for it to be available within the LonMaker tool. This button is available when a plug-in listed under any category or a category label (except Pending) is selected. If a category label is selected, all the plug-ins under it will be registered.
selected. If the Already Registered or Not Registered category label is selected, all the plug-ins under the selected category label will be disabled. Remove Removes a plug-in from the Pending list. This button is available when a plug-in listed under Pending or the Pending category label is selected. If the Pending category label is selected, all the plug-ins under it will be removed.
is set to medium (the default). In order to change Visio’s macro security, open the Tools menu, point to Macro and then select Security. A dialog opens allowing you to select Low, Medium, or High security. • If you select Low security, you will never see the macro warning. • If you select Medium security, you will be prompted to enable macros for unsigned network drawings or network drawings signed by companies that have not been added to the trusted signatures list.
7. Select the desired synchronization options and subsystem assignments. Create Shapes for all Connected NVs/MTs Adds shapes to functional blocks for all connected network variables or message tags created by the resynchronization. If this check box is cleared, the LonMaker tool will use generic connections when possible. It will still create network variable or message tag shapes for connections to supernodes and for those functional blocks that already contain network variable or message tag shapes.
Subsystem to Visio Document Assignment Select in which Visio drawing file to place the subsystems in your network. You have four choices: • Single Visio Document for all Subsystems. Places all subsystems in a single Visio document. • Prompt for Subsystem Document Assignment. Prompts you to specify the Visio document for each subsystem. • Separate Document for each Subsystem Hierarchy below Root. Places each subsystem hierarchy below the top-level subsystem in a separate, new Visio document.
10. You can monitor the progress of the resynchronization. When the resynchronization is complete, click OK to open your LonMaker network. Copying an Existing LonMaker Network Design You can create a new LonMaker network design by copying an existing one. You can use this procedure to reuse the drawings, options, plug-ins, master shapes, and device templates of an existing network design. You can also use this procedure to reduce the time required to create a new network.
6. If you are copying a network created with a Turbo edition of the LonMaker Tool, your new LonMaker network will open and you can skip the remaining steps. 7. If the existing LonMaker network design you are copying was created in a previous version of the LonMaker tool, the Synchronize LonMaker for Windows Drawing dialog box appears. This is because the LonMaker shapes in the drawing need to be updated to reflect the current LonMaker Turbo edition. 8.
4. Click Open Network. 5. If you are opening a LonMaker network after starting the LonMaker tool for the first time, a message may appear asking you if you want to enable macros. You must enable macros for the LonMaker tool to function. See Working with Digital Signatures for more information. 6.
location each time you open the drawing. Click Next. The Network Interface page appears, unless the Skip this Prompt check box was previously selected. 8. Select the Network Attached check box if the LonMaker computer is attached to the physical network and you want the LonMaker tool to communicate with the physical devices. If you select this check box and you have more than one network interface in your computer, select the name of the LNS network interface in the Network Interface Name list.
9. If user profiles have been defined for this network, enter the User Name and Password in their respective boxes. This page displays the version of the drawing, and the most current version of the network database; both are incremented each time you save your LonMaker network design. If the number in the Version # of this Drawing box does not match that in the Most Current Version # box, you should resynchronize the LonMaker network drawing with the LNS network database.
11. Register, deregister, enable, and disable any plug-ins in your LonMaker network. If you are working on a remote client, plug-ins that are registered on the LNS Server computer but not installed on the remote client will be listed under the Not Installed Locally category. Click Finish. Note: You may open multiple LonMaker network designs by repeating the preceding steps. Each LonMaker network design that you open will have its own instance of Visio.
LonMaker Computer LNS LONWORKS Channel A local client can also be configured as a local IP client. In this configuration, the LonMaker computer is attached to a LonWorks channel such as an IP-852 channel and communicates remotely with the network using an i.LON IP-852 router. The LonMaker computer is still a local client because the LNS Server is running on the same computer. LonMaker Computer LNS LONWORKS Channel (IP-852) i.
One or more LonMaker computers and the LNS Server may also be connected to the network using separate LonWorks channels. The LonMaker computers communicate over an IP network with the LNS Server, which routes management tasks to the network via an i.LON IP-852 router. The LonMaker computers communicate directly with the network via the i.LON IP-852 router to perform monitoring and controlling tasks. The i.
LonMaker Computer LonMaker Computer LNS/IP Interface LNS/IP Interface LNS Server LNS LNS/IP Interface IP Network LONWORKS Channel Using the LonMaker Tool on a Remote Client The following sections describe how to use the LonMaker tool on a remote full client and on a remote lightweight client, and it provides tips on managing multiple remote clients.
c. Select the LNS Network Interface or an IP-852 Network Interface you want to use to connect to the LONWORKS channel. The LNS Server or remote client is attached to an IP-852 channel using an IP network interface, such as an Ethernet network interface card (NIC) or a modem channel with PPP software. The network interface to the LONWORKS channel must be defined and configured before opening an existing LonMaker network on a remote full client. Click OK. The LNS Server dialog appears. d.
4. Start the LonMaker tool on the remote full client. Click Start on the taskbar, point to Programs, point to Echelon LonMaker, and then select LonMaker. The LonMaker Design Manager opens. 5. Restore the LonMaker drawings from the backup you created in step 1. See Restoring a LonMaker Network in Chapter 7, Maintaining Networks, for instructions. After restoring the drawing files, a prompt appears asking whether you want to open the network drawing. Click Yes to open the network drawing.
registered on the LNS Server computer but not installed on the remote client will be listed under the Not Installed Locally category. Click Finish. Using the LonMaker Tool on a Remote Lightweight Client A remote lightweight client is a LonMaker computer that communicates with the LNS Server (running on a separate computer) over an IP network (such as the Internet) or local intranet using an LNS/IP interface.
68 6. Select Remote Lightweight Client to access the network and then click Next. 7. If the server address is configured correctly, you can skip to step 10, in which the User Logon window appears. If there is a problem with the server address, or you are opening a drawing created using LonMaker 1, the Selecting a Remote Network Name page appears.
8. Select a LonMaker network to open. If a connection to this network has already been established, click Next, and skip to Step 10. If you are accessing the selected network over an LNS/IP interface for the first time, click Add/Remove. The Remote Networks Collection dialog box appears. 9.
LonMaker drawing with an NSD shape. When a LonMaker network is created, it initially contains one NSD shape that represents the LNS Server—the LNS Network Interface. If a remote full client is connected to a network, you can add an NSD shape to the LonMaker drawing to represent it. Creating an NSD shape makes that remote full client permanent in the drawing; otherwise, LNS automatically creates and deletes it each time you open and close the network.
Listing Network Service Devices If you are using the LonMaker tool with remote clients, you can view a list of all LNS clients connected to the network. Each client is represented by a network service device. To obtain a list of all NSDs in a network, open the LonMaker menu and select Network Service Devices. The LONWORKS Network Service Devices dialog box opens. This dialog box lists all NSDs in this network, regardless of whether a shape has been created for each NSD.
device. When you open the network and either of these conditions is detected, the LonMaker tool will ask whether you want to upgrade. You should typically perform the upgrade. However, if you are only using a different network interface temporarily, you may choose not to upgrade. In this case, communication with physical devices is limited until the network is reopened with the original network interface.
2. Enter the name of the new user name in the Name box, and the password in the Password and Retype Password boxes. Note that both the user name and password are case sensitive. 3. Set the user interface, access, and privileges of the new user. UI Setting Select the set of LonMaker and Visio menu that will be available to the user. You have two choices: • Maximum. This setting provides the user a full set of toolbars, menus, and menu items for advanced use of the LonMaker tool. • Minimum.
privileges consist of the network, subsystems, channels, application devices, routers, functional blocks, connections, network variables, and configuration properties. While All Objects is selected, the privileges you set apply to all objects. For example, to prevent this user from modifying any object, click All Objects and then clear the Modify check box. While Selection is selected, the privileges you set apply only to the object specified in the Selection list.
2. Click Change User. The Enter User Name and Password dialog box appears. 3. Enter the user name and password of the user you want to logon as. 4. Click OK. You will be logged on as the selected user. Using the LonMaker Tool Remotely with User Profiles When you open a LonMaker network on a remote client, you will be prompted for your user name and password (provided that the administrator password has been set for the network).
76 Getting Started
4 Designing Networks This chapter describes how to design a network using the LonMaker tool. It covers how to create the following objects in a LonMaker drawing: application devices, functional blocks, network variables, routers, channels, subsystems, and i.LON servers. It explains how to connect network variables. It explains working with LonMaker shapes and layers, customizing the LonMaker user interface, and using LonMaker with AutoCAD drawings.
Creating a LONWORKS Network You can create a LONWORKS network by designing the network and then commissioning application devices and routers using the LonMaker tool. To design a LONWORKS network with the LonMaker tool, you create a LonMaker drawing. This involves adding LonMaker shapes for channels, routers, devices, and functional blocks; making logical connections between devices so they can send and receive data to and from each other; and organizing the network into subsystems.
Creating Application Devices An application device consists of hardware and software that runs an application and communicates with other devices using the ANSI/CEA-709.1 (EN14908-1) protocol. An application device in a LonMaker drawing corresponds to a physical device on the network. To add an application device to your LonMaker drawing, you define and then commission it.
2. Enter the following information for the device. Device Name Enter the name of the device. This name must be unique within the currently displayed subsystem. The device name may be up to 85 characters and include embedded spaces, but it may not include period, backslash, colon, forward slash, or double quote characters. The default device name is the abbreviated device shape name followed by a dash, a space, and the instance number “1”.
Device Template Create a New Device Template Select this check box to create a new device template for the device. If you select this check box, the Specify Device Template window appears after you click Next. In this window, you can define a new template by uploading the device interface definition from the device or importing an existing device interface (XIF) file from your computer. This check box is unavailable for device shapes with pre-defined device templates such as the LonPoint device shapes.
4. Enter the following information: Location Specifies a 6-byte location string that documents the device’s location within the network. Select the Set Location Property to Subsystem ID check box in the network properties: Recovery options category to store the device’s subsystem ID in this field, which will be read-only.
if the device is on a power line channel, 2 minutes if you expect it will move somewhat frequently, and 1 minute if you expect it will move frequently. Any errors detected by pinging a device are displayed on the device shape in the LonMaker drawing. See Using LonMaker Styles for more information. Description 5. Provides an optional description of the device. This description has no effect on network operation, but you can use it to provide additional documentation for as-built reports.
2. Position the Connector tool over the “x” connection point of the device so that a red box appears over the “x”. 3. Click and hold the mouse button. 4. Drag the Connector tool to the center of the shape of the desired channel so that a red box appears around the channel shape. 5. Release the mouse button. 6.
2. Enter the following information: Source Functional Block Name Type Displays the name of the source functional block (a master shape or an existing functional block) from which the new functional block was created. This box will be empty if the functional block was created by dragging the generic functional block master shape to the LonMaker drawing. Displays the functional profile represented by the source functional block (open loop sensor object, for example).
selected subsystem with available functional blocks will be listed. Type Specifies the device template associated with the functional block. Functional Block Type Select the functional profile for the functional block. The default is the functional profile for the functional block currently listed in the Functional Block Name box. Name Select the functional block.
actually be “DO- 1.LED”. The second functional block named “LED” assigned to that same device would be “DO- 1.LED- 1”, and so on. To enable or disable this feature for all new LonMaker network designs or for an existing LonMaker network design, set or clear the Include Device Name in Default FB Name check box in the network properties: Functional Block options category as described in Appendix A.
the width of the functional block shape, and then (2) most recently created or assigned device. If no device can be selected using the preceding criteria, the Functional Block Wizard will appear. Re-assigning a Functional Block You can move a functional block to a different device, preserving all of the functional block’s configurations and connections.
re-use the configured functional block by dragging it from the LonMaker stencil on which it is saved to the same or any other LonMaker drawing. Note: Functional blocks created using either of these methods will initially have the same configuration property settings as the source functional block. Any changes you make to a functional block afterwards will not affect other functional blocks of the same type.
4. Select the target subsystems into which you want the configuration properties to be copied. You can expand a subsystem to view any nested subsystems. 5. Select the criteria used to determine which functional blocks will be updated with the configured settings. You have three choices: • Matching Device/FB name. Both the device and functional block names must match for the functional block to be configured • Matching Device/FB Type.
7. You can remove a functional block target from the list by selecting the target’s subsystem name and then clicking Remove. If you only want to view those functional blocks in which the value of the configuration property in the target functional block differs from the source, click the check box at the bottom. You can sort the entries in a column by clicking the column header. Click the header again to toggle the order (ascending or descending). 8. Click Finish.
the control algorithm and configures the controller. The controller manufacturer can use dynamic functional blocks to enable a LonMaker user to add functional blocks to the controller using the LonMaker tool. Dynamic functional blocks are created in the same manner as static functional blocks. To create a dynamic functional block, follow these steps: 1. Drag a functional block shape from a stencil to the LonMaker drawing, or copy an existing functional block shape.
Creating Dynamic Functional Block Master Shapes You can create master shapes for dynamic functional blocks in the same manner as static functional blocks.
2. Select one or more message tag shapes to add to the virtual functional block from the list of available message tags. If you select multiple message tags, additional shapes will automatically be added to the virtual functional block. To select all of the listed message tags, click Select All. 3. Click OK. The selected message tag shapes appear on the virtual functional block shape in the appropriate position.
1. Select a functional block that contains a network variable with the desired network variable type that you want to use for the new network variable shape, and then select the network variable. 2. Right-click the network variable that you selected in step 1 and then select Create Input NV Template or Create Output NV Template on the shortcut menu to create an input or output network variable shape, respectively. The LonMaker tool creates a new network variable shape on the current drawing page.
Creating Network Variables Using Generic Network Variable Shapes Using generic network variable shapes, you can add an existing static network variable or create and add a dynamic variable to a functional block following these steps: 1. Drag an input or output network variable shape from the LonMaker Basic Shapes stencil onto the functional block. The Choose a Network Variable dialog box appears. If the device supports dynamic network variables, this dialog will also have a Create NV button.
2. To add a static network variable to the functional block, skip to step 8. To create and add a dynamic network variable, click Create NV. The Create Network Variable dialog box appears. 3. Enter the name, number, and type of the dynamic network variable(s) you are creating. a. Enter the name of the dynamic network variable. This name must be unique within the functional block.
• 4. Click More if you want to set the polling attributes for the dynamic network variable(s) you are creating. 5. Under Poll Attributes of New NV(s), select whether the dynamic network variable(s) will by default use polled monitoring. You have four choices: 6. 98 To create a dynamic variable from the template of an existing network variable in your LonMaker drawing, select Derive from Existing NV under the New NV Type box and then click Browse. The Select Object window opens.
7. Click OK. The new dynamic network variable appears in the Choose a Network Variable dialog box. 8. Select one or more static and/or dynamic network variables shapes to add to the functional block from the list of network variables available for the selected direction. If you select multiple network variables, additional shapes will automatically added to the functional block. To select all of the listed network variables, click Select All. 9.
The LonMaker tool only requires that network variable names be unique within a functional block; therefore, if you list all the network variables in a device, some may have duplicate names. Changing Network Variable Position Once a functional block has a network variable shape placed on it, the network variable shape becomes part of the functional block shape.
4. Select one or more network variable shapes to delete. To select multiple network variable shapes, hold down CTRL and click the shapes you want to delete. To select all of the listed network variables, click Select All. 5. Set the following options: Display Apply Changes to 6. Select which network variable and message tag shapes are displayed. • Select Unconnected NV and MT Shapes to view all the unconnected network variable and message tag shapes on the functional block.
Creating a Router A router enables application devices on separate channels to communicate. The router may be a LonPoint router, an MPR-50 Multi-Port Router, an i.LON 100 Internet Server with IP-852 routing, an i.LON 600 LonWorks/IP Server, an i.LON 1000 Internet Server, or other ANSI/CEA-709.1 (EN14908) or ANSI/CEA-852 compatible router. This section describes how to create a router in a LonMaker network design. See the i.LON 100 User's Guide and the i.
2. Enter the following information: Router Name Enter the name of the router. This name must be unique within the network. The router name may be up to 85 characters and include embedded spaces, but it may not include period, backslash, colon, forward slash, or double quote characters. The default router name is “RTR- 1”. The instance number in the default router name is incremented for each subsequent router you create.
3. Click Next. The Router Properties window appears. 4. Enter the following information: Location Specifies the 6-byte location string for the router, which documents the router’s location within the network. Select the Set Location Property to Subsystem ID check box in the network properties: Recovery options category to store the router’s subsystem ID in this field, which will be read-only.
change the ping interval to 15 minutes if you expect the router will seldom move or if the router is on a power line channel, 2 minutes if you expect it will move somewhat frequently, and 1 minute if you expect it will move frequently. Any errors detected by pinging a router are displayed on the router shape in the LonMaker drawing. See LonMaker Device Styles in Chapter 8, Managing Networks, for more information. Description Provides an optional description of the router.
You can select Bridge to forward all valid packets that match the network domain. A Permanent Bridge behaves similarly, but its type cannot be changed in the network after the router is created. The LonMaker tool allows subnets to span permanent repeaters and bridges, but not non-permanent types. You can use permanent repeaters and bridges to preserve subnet IDs, and non-permanent types to maintain flexibility in order to change the router type later. 7.
Changing a Router Channel You can change one or both of the channels assigned to a router shape. You can do this to assign a router to a channel different from the one that was automatically selected by the LonMaker tool, or to physically move a router to a different compatible channel. To move a router to a different channel, you can either right-click the router and then click Move Device on the shortcut menu, or you can use the Connector tool on the Visio Standard toolbar to graphically move the router.
2. Enter the following information: Channel Definition Select whether the shape represents a new or an existing channel. • Select Shape Represents a New Channel if you are adding a new channel to your LonMaker drawing. • Select Shape Represents an Existing Channel to place devices in different subsystems on the same channel. Each subsystem may have only one channel shape for a given channel, but the same channel shape may appear in many subsystems.
selected channel type. Round-Trip Delay Description 3. Select whether to use the default round-trip delay or to specify a time for the channel in milliseconds. • Select Use Default to use the default of two packet cycles based on the average packet size. • Select Specify to set the value to the expected longest round-trip time of a message (for example, message and response).
2. Enter the following information: Subsystem Enter the name of the subsystem. The name must be unique within the current subsystem and may be up to 85 characters long. The name may include embedded spaces, but it may not include periods, backslashes, colons, forward slashes, or double quotes. Subsystem names are case sensitive.
Subsystem Contents Copy 3. Select which objects to copy in the subsystem and any nested subsystems. You have three choices: • Do not copy. Only the subsystem shape will be copied. None of the contents of the original subsystem will be copied into the new subsystem.
4. Right-click the subsystem and click Expand from the network navigator. All devices, functional blocks, and available network variables in the network hierarchy will be displayed. Select one or more network variables to be supernodes. To select all the available network variables, click Select All from the network navigator. 5. Click OK. Shapes for the selected network variables appear on the subsystem shape.
Instead of performing steps 1 and 2, you can hold down CTRL and drag the subsystem or supernode shape to the desired location. 3. Enter the information for the new subsystem following the instructions in Creating a Subsystem. 4. Click Finish. The LonMaker tool copies the subsystem or supernode. If only a single end of a reference connection is in a copied subsystem, the network variable will be connected to the existing connection specified by the reference.
Creating a Connection with the Connector Shape You can create a connection with the Connector shape in the LonMaker Basic Shapes stencil. You can only use this method to connect functional blocks or supernodes that are in the same subsystem. You can connect network variables or message tags on functional blocks or supernodes whether they have network variable or message tag shapes or not.
connect to a hub network variable with a few mouse clicks. You can change the properties of the connection while you are creating it (you can also change the properties after you create the connection). You must use this dialog if you want to connect network variables or message tags that are located in different subsystems, or if you are connecting a functional block without network variable or message tag shapes.
Target Displays a hierarchal view of the network, consisting of the subsystems, devices, functional blocks, and all compatible network variables that can be selected as targets. Select a target and then click Add. Connections Lists the connections that are scheduled to be created. Connection Attributes New Connections Displays the connection description that will be assigned to all new connections created.
of the selected functional blocks and supernodes and displays connection between any pairs. • From or To Selected FB/SNs. Displays all connections from or to all selected functional blocks and supernodes. 3. Under the Hub tab, select the hub network variable for the connection. The icon for the selected NV will be highlighted yellow.
Reference connections are automatically used for connections between functional blocks or supernodes in different subsystems. You can also use reference connections to simplify your LonMaker drawing by reducing the number of crisscrossing connector shapes that can clutter a LonMaker drawing.
notified when an update fails, but it is up to the developer of the sending device to handle the notification in the device application. While acknowledged service is very reliable, it can create excessive message traffic, especially for large fan-out or polled fan-in connections. When acknowledged messaging is used, every receiving device has to return an acknowledgment.
Connection Description New SCD Acknowledged Acknowledged with Alias Multicast ● ConnectDescTemplate_0* Multicast Addressing Mode Messaging Service Acknowledged Group Acknowledged Alias N/A N/A Repeated with Alias Multicast ● Repeated Alias Repeated with Broadcast Multicast ● Repeated Broadcast Repeated Group Acknowledged Alias Repeated Group (if available); otherwise, domain broadcast Repeated with Group Multicast Repeated** SCD_Alias ● ● SCD_Default ● ● SCD_SubnetBcast ●
To view the properties of a connection description, select the connection description from the Name list. If you do make changes, click OK and the LonMaker tool then updates all network variable members of the connection with the modified connection description To create a new connection description, click New. The New Connection Description dialog box opens. Enter the name of the new connection description and select whether the currently displayed or default attributes are used, and then click OK.
The following flow chart demonstrates the process the LonMaker tool uses to select the appropriate SCD.
You can change or disable the connection description used for each condition in the automatic connection description selection process. If you disable the connection description for a given condition, the LonMaker tool will select the next defined connection description. You can also change the maximum number of target network variables used to select between the Alias Unicast and Default conditions. The default value of 5 provides a good balance between total transaction time and network resource usage.
Hiding and Showing Connector Shapes You can hide connector shapes to simplify a LonMaker drawing, or you can selectively show connector shapes attached to specific functional blocks or supernodes to examine their connections. You can hide or show all of the connector shapes in a subsystem; hide/show connector shapes attached to specific functional blocks or supernodes; or control the creation and hide/show connector shapes attached to a functional block using the functional block properties Options tab.
The connector shape and its reference shape will both be hidden on that end. Repeat this step on the other attached functional block to hide the corresponding shapes on the other end of the connection. The following series of figures demonstrates how you can hide and show connections. This example uses two analog input functional blocks connected to an analog functional block. One connector shape is attached directly to both functional blocks; the other is attached via a reference shape.
Connectors Hidden Connectors Hidden Connectors Hidden Right click A1-1.AFB-1, point to Display Options, and then click Hide Connectors. The connector shape between functional blocks A1-1.A1-1 and A1-1.AFB-1 is now hidden because Hide Connectors is selected on both attached functional blocks. The reference shape attached to functional block A1-1.AFB-1 is now also hidden. Connectors Hidden Connectors Hidden Right click AI- 1.AI- 1, point to Display Options, and then click Show Connectors.
2. Select the following options for creating and displaying connection shapes for the selected functional block or functional blocks. Create Connection Shapes Show Connection Shapes LonMaker User’s Guide Select whether shapes are created and displayed in the LonMaker drawing for connections with the selected functional block(s). You have three choices: • Yes.
Connection Shapes is selected in the functional block on the other end of the connection. If these conditions are true, a connection shape will be shown regardless if this option is cleared for the functional block on the other end of the connection. If this check box is cleared, a connection shape will be hidden if this check box is cleared in the functional block on the other end of the connection.
2. The window displays a hierarchal view of the subsystems in your network, with the nested subsystems and devices in the top-level subsystem and the current subsystem shown. You can expand an object to view any others further down the network hierarchy such as nested subsystems, devices, and functional blocks. You can also right-click an object and use the Network Navigator to expand an object.
hierarchy. Select All Expands the item and selects the check boxes of all the objects below it. Click Select All on the top-level subsystem to select the check boxes of all the objects in the network hierarchy. This option is only available in scenarios in which multiple objects can be selected. Deselect All Expands the item and clears the check boxes of all the objects below it. Click Deselect All on the top-level subsystem to clear the check boxes of all the objects in the network hierarchy.
The Network Explorer provides separate subsystem, channel, and device template views, each on its own tab. To change views, click the appropriate tab. • In the subsystem view, the top-level subsystem and all the subsystems it contains are displayed, and all the other objects in your LonMaker drawing are listed below their respective subsystems in a hierarchal structure (in the order of nested subsystems, devices, functional blocks, and then network variables).
The Device Template shortcut menu contains the following options: Delete Deletes the selected device template. This option is unavailable if there are any devices currently using the device template, or if there is a device that has been discovered by the LNS Server but does not yet appear in the LonMaker drawing. Import XIF Updates the device template (and optionally devices) with the data from the XIF that you select.
The Device Template Properties dialog box contains the following options: Name Specifies the name of the device template. You can change the device template name to any other valid, unique name. Program ID Displays the program ID of the device template. You can select one of the following options for displaying the program ID (this selection does not change the program ID): • ASCII. Displays the program ID as an ASCII string.
and are installed on the correct channel before commissioning them. Doing so will help prevent the devices from being improperly configured or having communication problems. Self-doc Consistency Selects the required level of consistency for the self-documentation data (strings and format) of the devices using the selected device template.
Working with LonMaker Shapes You can view, edit, move, copy, and delete LonMaker shapes. A LonMaker shape is a shape within a LonMaker drawing that represents a physical component in a LONWORKS network such as device, channel, network variable, or connection. This section describes how to work with LonMaker shapes. Viewing and Setting LonMaker Shape Properties You can view and set the properties of a LonMaker shape.
4. Click the Up button to move up one level in the network hierarchy; double-click a subsystem to move down one level. Select the new subsystem. 5. Click OK. 6. If you move a functional block with any connector shapes, you will be prompted to have the LonMaker tool convert the connector shapes to reference connection shapes. Click OK. Changing the Channel for a LonMaker Shape You can move a device, router, or LNS computer onto a different channel.
2. Set the following options: Original Channel Name Specifies the current channel on which the devices or routers are attached. If you are moving devices or routers from a subsystem shape that has devices or router shapes connected on two or more channels, select the channel with the devices or routers you want to move. Only those devices or routers located on the selected channel will be moved.
device on it. • State After Move 138 Select Specify to manually choose an existing subnet from the Name list. Specifies the desired state of the devices or routers after they have been moved. • Select Online to put the devices or routers in the online state. This is the default for routers. The behavior in the online state depends on the device. A Neuron-hosted device, for example, will run its application after it has been moved. • Select Offline to put the devices or routers in the offline state.
Moving an LNS Computer to a Different Channel You can move an LNS computer (LonMaker computer, LNS Server, or other LNS client) to a different channel following these steps: 1. Right-click the LNS Network Interface shape for the LonMaker computer, or the NSD shape for another LNS computer, and then click Change Channel from the shortcut menu. 2. Change the channel on which the LNS computer is attached following step 2 in Moving a Device or Router to a Different Channel. 3.
Deleted LonMaker Shape Affect on Physical Device Commissioned Application Device Application device is decommissioned and no longer has a network address. Commissioned Router Router is decommissioned and no longer has a network address. LNS Network Interface or NSD LNS attempts to decommission the NSD. If the NSD is using a Layer 2 interface, it cannot be decommissioned. Disconnects any remote full clients using the NSD. Functional block (static) No change.
Using LonMaker Shape Menus You can change the appearance of the LonMaker shortcut menus. You can select either a hierarchical menu that removes Visio commands not typically used with LonMaker shapes, or you can select a flat menu that includes all Visio shape commands. The hierarchical menus provide a compact top-level shortcut menu for each LonMaker shape with hierarchical sub-menus.
1. Open the Edit menu, point to Go To, and select Background. 2. Open the Insert menu and select CAD Drawing. 3. Select the AutoCAD drawing (.dwg or .dxf extension). 4. In the AutoCAD Drawing Layer Status dialog, specify which layers to convert from the AutoCAD file. Because the LonMaker tool only supports importing an AutoCAD drawing as a background, you can choose to convert layers as Displayed Layers only. Layer 0 indicates unlayered data. 5.
5 Installing Networks This chapter describes how to install devices using the LonMaker tool, including how to load applications into them, set the initial state of their applications, set the source of their configuration properties, and select how they manage device-specific configuration properties. It also explains the different methods for acquiring device Neuron IDs and how to alternatively use the device discovery method to install a network.
Network Installation Overview You can install the devices that you added to your LonMaker network design in Designing Networks. To install devices, you commission the devices and routers in your LonMaker network design. Commissioning associates the device shape created in the LonMaker drawing with a physical device on the network and updates the physical device to match the configuration in your network design.
Selecting Devices for Commissioning To select the device or devices to be commissioned, follow these steps: 1. Right-click the device shape of the device you want to commission, point to Commissioning, and then click Commission on the shortcut menu. To select multiple devices, do one of the following: • To select multiple devices within a subsystem, hold down CTRL and click the device shapes, or click an empty space in the drawing page and drag a selection net around them.
2. The Commission Device Wizard opens. Where you start in the wizard depends on whether you are commissioning an application device or router, and whether the LonMaker tool is attached to the network and OnNet or OffNet. • If the LonMaker tool is unattached to the network or attached but OffNet, the wizard will skip the Device Application Image and Initial State windows and begin with the Device Identification window.
1. Specify the device application by setting the following options: Load Application Image Select this check box to load an application image into a Neuronhosted application device that has writeable application memory and comes with an application file (.ndl, .nxe or .apb extensions).
different XIF file. If an application image file is found in the same directory as the XIF file of the device template, that directory is the default. XIF Name 2. If you are loading an application file with an .nxe extension, select the pathname of the XIF file. The LonMaker tool only requires the binary application file (.apb extension) and the binary device interface file (.xfb extension); however, it automatically creates binary files from existing text files (.nxe and .
Setting the Initial Application Device State and Source of Configuration Property Values When the Device Initial State window appears, follow these steps: 1. Specify the initial state of the device applications, source of the configuration property values, and management of device-specific configuration properties by setting the following options: State Set the state of the device application after it has been commissioned. You have four choices: • Default.
in the hard offline state, in which case it will remain offline after a reset. • Source of CP Values Disable. Keeps the device application disabled even if the device is reset. For a device to be disabled, it must contain a Node Object functional block. If Disable is selected and the device does not contain a Node Object, the device is placed offline. As with offline operation, portions of a disabled device’s application may continue to function.
an application image into the device in the Device Application Image window. • Upload from New App Image. The current device-specific configuration property values in the selected application image file will be written to the device. This option is only available if you selected the check box to load an application image into the device in the Device Application Image window. • Preserve Device Values.
previously commissioned and is able to communicate, the default state is the state of the router before the current operation. 2. • Offline. The router will not forward packets. • Online. The router will forward packets between the channels connected to it. This is the default. If the network will have devices installed on the far side of a router (the side furthest away from the LNS Server), you must commission the router before any of the application devices connected on its far side.
Neuron IDs in the subsequent dialog box. See Using the Manual Entry Method. Manual entry is recommended if the device or its service pin are difficult to access. 2. Click Finish. If you selected the Service Pin method, you are prompted to press the service pin as described in Using the Service Pin Method.
To acquire the Neuron IDs and finish installing the devices, follow these steps: 1. Select any of the following service pin options Options Display Data from Service Pin Select this check box to display a dialog that contains the information returned in the service pin message. This check box is cleared by default. Filter on Program ID Select this check box to ignore service pin messages that do not include the same program ID as the device being commissioned. This option is selected by default.
Using the Manual Entry Method If you selected Manual as the device identification method or if the LonMaker tool is not attached to the network, and you are commissioning multiple devices, a prompt appears instructing you to enter the Neuron IDs of the devices you are installing. The device Neuron ID is provided by the manufacturer as a 12-digit hex string or as a bar code label on the device that can be scanned. Entering a Neuron ID Manually To enter a device’s Neuron ID follow these steps: 1. 2. 3.
scanner vendor for prices on the different scanner types. If you are using a LonPoint device, or a device with a similar bar code label, it is recommended that you use a gun-style laser or LED scanner. One scanner that you can use with the LonMaker tool and LonPoint devices is the Symbol Technologies LS 3000, which is made available by Barcode Logics. The Neuron IDs for LonPoint devices are printed on their labels in Code 39 format. See your scanner documentation for instructions on programming the scanner.
2. Select the following options: Device Selection Scope Options Wink Interval Selects which subsystems will be searched for uncommissioned device shapes. You have three choices: • All Subsystems. The entire LonMaker drawing will be searched for uncommissioned device shapes. • The Current Subsystem and Dependent Subsystems. The current subsystem and any subsystems nested in it will be searched for uncommissioned device shapes. • The Current Subsystem only.
device in the Defined Devices list when you press the service pin. Include Devices with Unknown Programs Adds physical devices to the discovered device list that are applicationless or have an unrecognized application. Such physical devices can then be matched to any device shape with a matching channel. However, after matching, you must click Details and specify an application image to load into the device. Discover Configured Devices Discovers devices that have previously been configured.
This dialog box allows you to manually or automatically match the discovered devices on the network with the defined device shapes in the LonMaker drawing. To select a device from any of the lists, click the entry in the leftmost column (the # column in the Discovered Devices list, and the Subsystem column in the Defined Devices and Devices to be Commissioned lists). After selecting a device, its field in the leftmost column will be shaded blue.
This command is only available if a device is selected in the appropriate device list. Match Matches the device selected in the Defined Devices list is to the device selected in the Discovered Devices list. The devices are removed from their respective lists and the matched device is added to the Devices to be Commissioned list. This command is only available if one device is selected from each list and the selected devices are compatible.
11. Select an application image and set the options for the initial application state and source of configuration property values. See Loading a Device Application Image and Setting the Initial Application Device State and Source of Configuration Property Values for information on setting these options. Click OK. 12. Click Finish. The LonMaker tool commissions the devices in the Devices to be Commissioned list and sets the state of their applications.
162 Installing Networks
6 Monitoring and Controlling Networks This chapter describes how you can monitor and control the devices in your network with the LonMaker tool. It describes the three methods you can use to read and/or write network variables and configuration properties: using monitored connections, browsing with the LonMaker Browser, and using Data Point shapes. This chapter covers how to bind network variables to the host in order to receive event-driven updates.
Monitoring and Controlling Overview You can monitor and control the physical devices in a network by reading and writing the network variables on the devices. You can also read configuration property values. You can use any of the following three methods to read and/or write network variables and configuration properties: • Monitored connections. Monitored connections provide a simple means to view network variable values within your network.
When you enable monitoring on a connection, the network variable values are continuously polled. The default poll interval is 1 second. You can change the default poll interval in the network properties: Timing dialog, which you can access by opening the LonMaker menu, selecting Network Properties, and clicking the Timing tab. Excessive polling can create heavy network traffic and consequently degrade network performance.
dialog by opening the LonMaker menu, clicking LonMaker Options, and selecting NV Browser/ Monitoring from the Options Category list. Using the LonMaker Browser You can use the LonMaker Browser to monitor and control the network variables and configuration properties in your network. The LonMaker Browser provides a table view of the selected network variables and configuration properties.
The LonMaker browser color codes the configuration properties and network variables in the following manner: Blue Input network variables. You can write values to these network variables. See Updating Network Variable and Configuration Property Values. Green Writeable configuration properties. You can write values to these configuration properties. See Updating Network Variable and Configuration Property Values. Grey Output network variables and read-only configuration properties.
property if the row describes a configuration property. (see types.lonmark.org) If a row describes a network variable, this column is blank. Mon Indicates whether the network variable is monitored. A “Y” indicates that monitoring is on; a status indicator follows the “Y”, indicating when a new value is received by the browser. Configuration properties cannot be monitored. Value Contains the value of the network variable or configuration property.
Configuration Property Values for more information. Details Displays the details of the selected network variable or configuration property. See Updating Network Variable and Configuration Property Values for more information. Display Messages Displays a log of error messages received while the browser is active. The Display Messages button is located at the bottom left corner of the browser. See Displaying Error Messages for more information.
in the browser toolbar. The browser automatically resizes the columns to display Columns button the longest text string in each column. Customizing Browser Rows You can customize the LonMaker Browser so that it only displays rows containing network variables or configuration properties, or you can hide specific network variables or configuration properties by deleting the rows on which they appear.
This dialog lists all the hidden objects in the browser. Select the object or objects you want to show, or select the Select All check box to select all the objects, and then click OK. The selected objects appear in the browser again. Saving Browser Customization: You can save and later restore the rows and columns that you customize in the LonMaker Browser to a browser (.brw extension) file. To save your rows and columns to a browser file, open the File menu and select Save or Save As.
and enter the desired poll interval in the Poll Interval box. The browser does not poll monitored output network variables if they are connected to the browser computer as described in Using Bound Updates. Disabling Network Variable Monitoring To stop the LonMaker Browser from monitoring a network variable, right-click the network variable row and then clear the Monitor option on the shortcut menu.
connections between each of these network variables and the host would consume a significant amount of system resources. It is more efficient to create just one network variable on the host and bind all of the output network variables to it. Network variables bound to the host may be monitored by an LNS application such as the LNS DDE Server. LNS allows the individual network variables to be monitored, even though they are received on the same network variable input on the host.
see that this configuration property has day, hour, minute, second, and milliseconds fields and view the minimum and maximum values for each of these fields. To open the Set Network Variable/Set Configuration Property dialog, right-click the object and click Details on the shortcut menu. All the fields for the selected object are listed in structural order in the Field List box. To set the value for a field, expand that field and then click twice slowly on the value that appears below it.
Setting Values for Configuration Property Arrays You can view and set values for a configuration property array using a table instead of using the Value box or the Set Configuration Properties dialog. To view a configuration property array, right-click a configuration property array and then click Table on the shortcut menu. The Edit Configuration Property Table dialog appears. This dialog contains a table listing the values for each element in the configuration property array.
Clearing Values You can clear the displayed value of a network variable or configuration property by right-clicking the object you want to clear and then clicking Clear Value on the shortcut menu. To clear all values in the browser display, open the Browse menu and select Clear All Values. Clearing the values in the browser display does not affect the values in the functional block. Getting Values You can get the current value of a network variable or configuration property.
This dialog lists built-in data types, and resource files containing defined network variable types (SNVTs and UNVTs). Expand the items listed to view the available data types. Click the type for the network variable and then click OK. • Select the Show Only Types with Matching Length check box to display only those types with the same size as the current network variable type.
The format may include scaling and offset values to convert one type of data to another such as Celsius to Fahrenheit or kilograms to pounds, localized formatting specifications, or text strings that are to be displayed as part of the value. For example, a temperature sensor may report a temperature value with a type of SNVT_temp_f. The SNVT_temp_f type is defined as a 32-bit signed floating-point value representing a Celsius temperature.
• Select the Show Obsolete Types check box to list those network variable types that are marked obsolete in the current standard resource file set. • The Length box displays the size (in bytes) of the currently selected type. Tip: Many standard network variable types include formats with “#US” and “#SI” format specifiers. You can use these specifiers to identify default formats when the appropriate default is determined by the regional settings on the computer running the LonMaker tool.
Managing Functional Blocks You can disable, override, and test a functional block from the LonMaker Browser. To do this, open the Browse menu and then click Manage. See Managing Functional Blocks in Chapter 8, Managing Networks, for more information. Using Data Point Shapes You can use a Data Point shape in a LonMaker drawing to monitor the value of any network variable configuration property, or functional block state (enabled or in override).
Enable Monitoring Enables monitoring for the selected data point. Creates a monitor set and monitor point for a network variable data point if one is selected. All network variable Data Point shapes and monitored network variable connections in the same subsystem are placed in one LNS monitor set. This check box is cleared by default. Use Absolute Subsystem Path Controls how the LonMaker tool interprets a new Data Point shape created from a copy (an existing Data Point shape or a master shape).
own label and later create an instance of the Data Point shape (a master shape or a copy), that label will be selected by default in this list. If the selected data point is a network variable, the following options are available: • • • None (no label). NV (the network variable name). FB.NV (the functional block name, network variable name, and field name [if defined]). This is the default. • Device.FB.NV (the device name, functional block name, network variable name, and field name [if defined]).
select an input network variable with a SNVT_switch type as the data point, the switch is off, and you select (the default) from the field name list, the Data Point shape displays the entire structure, which would be “0.0 0”. If you select value, the value displayed in the Data Point shape will be “0.0”, and if you select state, the value displayed will be “0”.
• A scalar value is a single number such as a temperature or a pressure. • A structured value is a value that contains multiple fields such as a switch value with state and level fields. • An enumerated value is a value with multiple states each represented by an enumeration string, such as an occupancy state with occupied and unoccupied values or an HVAC mode. A functional block state is also an enumerated value.
4. 5. All the fields for the selected data point are listed in structural order in the Field List box. You can set the value for a structured data point in two ways: • Expand a field in the Field List box and then click twice slowly on the value that appears below the field. Enter a valid value for the field (the minimum and maximum values appear in the Field Info box to the right). Repeat for any other fields for which you want to set the value.
with the current value of the data point. The LonMaker tool must be attached to the network to use this option. If monitoring on the Data Point shape is disabled, the value displayed in the Data Point shape will be cleared in n seconds, where n is the value set in the ‘Get Value’ Display Duration box in the network properties: NV Browser/Monitoring options category. By default, the value is 15 seconds. You can disable the clearing of the Data Point shape by setting this value to 0.
Example: A subsystem named “Subsystem 1,Building1.Floor1.Room1” contains a Data Point shape, and the Use Subsystem Absolute Path check box for the Data Point shape is cleared. The Data Point shape references a data point on a functional block in the “Subsystem 1.Building1.Floor2.Room10” subsystem. The subsystem path stored in the Data Point shape is therefore “^.^.Floor2.Room10”.
You can use high-end HMI tools, such as Wonderware’s InTouch or Intellution FIX, to represent more complex types of network interactions. These tools are developed with a scripting language tuned to specifically address HMI tasks. In addition, these tools offer components that provide reporting and analysis, history, alarm logging, event handling, and Internet-enabling. To create a simple HMI with Data Point and Visio shapes, you do the following: 1.
Writing to a Data Point Shape Value You can use a Visio shape to write a value to a Data Point shape. You can write to a Data Point shape using an Add-On or a Macro. Using the lighting HMI example, when you double-click one of the Visio shapes, the following occurs: 1. The switch value and/or state is updated in the Data Point shape that controls the D1 input network variable on the Digital Encoder functional block. 2.
5. To have some logic performed on the data point value instead of specifying a value, replace n with &Scratch.X. The function is as follows: RUNADDONWARGS(“LMW Set [Field] Value”, “/SelOverride /ShapeOverride= /Value=” &Scratch.X). You can use this type of formula to incrementally change the value of a data point when you double-click the Visio shape. 6. Press ENTER. 7. In the X cell of the Scratch section, enter a formula.
9. Open the Windows menu and click Show ShapeSheet. The ShapeSheet of the selected Visio shape opens. 10. In the EventDblClick cell of the Events section, enter the following function: RUNMACRO(""), where Macro Name is the name of the Macro you entered in step 2. Reading from a Data Point Shape Value You can use a Visio shape to read a value in a Data Point shape. You can read a Data Point shape using an Add-On or a Macro.
Dim myshape2 As Shape Set myshape = ActivePage.Shapes("Circle") Set myshape2 = ActivePage.Shapes("Data Point.50") If myshape2.Text = 1 Then myshape.Text = "ON" Else myshape.Text = "OFF" End If If myshape2.Cells("User.MonValue") = 1 Then myshape.Cells("FillForegnd") = 5 Else myshape.Cells("FillForegnd") = 0 End If End Sub 6. In the LonMaker drawing, click the Data Point shape that is monitoring the value that the Visio shape is to read. 7. Open the Windows menu and click Show ShapeSheet.
7 Maintaining Networks This chapter provides an overview of network maintenance tasks that you can perform with the LonMaker tool. It describes loading, replacing, and decommissioning devices. It explains how to resynchronize and propagate configuration properties values. It explains how to back up and restore a LonMaker network; create a LonMaker network by recovering information from the physical network; and resynchronize the network database, LonMaker drawing, and physical devices.
Maintaining Networks Overview You can perform routine maintenance to update, repair, and optimize an installed network. You can maintain the network and its components, the LonMaker drawing, and the LNS network database. For example, if a device or router fails, you can replace it on the physical network and then logically replace it in the LonMaker network, preserving the device’s configuration and all of its connections.
To load a new application into a device, the devices must have writeable application memory and the LonMaker tool must be attached to the network and OnNet. To load a new application into a device, follow the five steps described in the subsequent sections: 1. Select the device or devices to upgrade. 2. Select or create a device template. 3. Select an application image to load into the device(s). 4.
• Load XIF. Creates a device template by reading an XIF file on the LNS Server. You can either enter the path or click Browse to locate the desired XIF file. You can enter the file name without a path only if the XIF file is in the folder specified in the XIF Search Path box network properties: Device options category. The device template name in the Template Name box is automatically set to the name of the XIF file (without the extension), but you can change it to any name that is unique to the network.
Load Application Image Select this check box to enable loading a new application image into the device. Update Firmware in Device to Match Application Image Select this check box to load a new Neuron firmware image to make the Neuron firmware on the device compatible with the new application image file. For a device to support Neuron firmware updates, it must be based on a Neuron 3150 core with a nonvolatile memory layout supporting at least 32K starting from address 0.
Selecting Initial Device State and Source of Configuration Property Values To select the initial device state and the source of configuration property values, follow these steps: 1. Specify the initial state of the device applications, and select the source of the configuration property values and management of device-specific configuration properties as follows: State Specify the state of the device application after it has been commissioned. You have four choices: • Default.
Resetting an offline device makes it go online, unless the device is in the hard offline state, in which case it will remain offline after a reset. • Source of CP Values Device Specific CPs LonMaker User’s Guide Disable. Keeps the device application disabled even if the device is reset. For a device to be disabled, it must contain a Node Object functional block. If Disable is selected and the device does not contain a Node Object, the device is placed offline.
installed, the device-specific configuration property values in the LNS network database are written into the new device. 2. Click Next. The Device Identification Method window opens. Follow the steps in Installing Devices and Routers in Chapter 5, Installing Networks, to continue loading the devices. Replacing Devices You can replace a device with a new device if the device fails or a newer version of the device becomes available.
5. Specify the initial state of the replacement device’s application, and select the source of the configuration property values and management of device-specific configuration properties as follows: State Set the state of the device application after the replacement device has been commissioned. You have four choices: • Default. The state of the replacement device’s application is determined by the current setting under the New Device Options box in the network properties: Device options category.
even if the device is reset. For a device to be disabled, it must contain a Node Object functional block. If Disable is selected and the device does not contain a Node Object functional block, the device is placed offline. As with offline operation, portions of a disabled device’s application may continue to function. This option is not available for routers. Source of CP Values Device Specific CPs 202 Specify the source of the replacement device’s configuration property values.
6. Click Next. If you are replacing application devices and routers at the same time, the Initial Router State window appears. Otherwise, the Device Identification Method window opens. In this case, follow the steps in Installing Devices and Routers in Chapter 5, Installing Networks, to continue installing the devices). Removing the Old Device If the old device still functions, and if physically possible, leave the old device connected to the network until the device replacement has been completed.
4. Select the Preserve Neuron ID check box to recommission the same device or router later without re-entering the configuration data. 5. Click OK. The color of the device shape changes to crosshatched yellow, indicating that the device is unconfigured. Resynchronizing Configuration Properties You can resynchronize the configuration property values in the LNS network database with those in the physical devices.
Operation Included CPs 3. Select a synchronization operation. You have four choices: • Download Current Values to Device. Writes the configuration property values stored in the LNS network database to the physical device. This is the default. • Upload Values from Device. Writes the current configuration property values in the physical device to the LNS network database. • Reset Device to Default Values.
3. To configure a device with a manufacturer’s plug-in that supports passive configuration, right-click the device or a functional block on the device and then click Configure on the shortcut menu. The plug-in starts. 4. Configure the device using the manufacturer’s plug-in. 5. Right-click the device, point to Commissioning, and then click Propagate CP Values to Device on the shortcut menu.
2. 3. 4. Select which components of the LonMaker network design to back up. • Select both the Backup Drawing and Backup Database check boxes to back up the entire LonMaker network design. Use this option to move a LonMaker network design from one computer to another, replicate the LonMaker network design for another installation, or to store a backup of the LonMaker network design to protect against accidental file corruption or hardware failure.
a. To enable hot backups, select the Use LNSHot Backups check box under Backup Options. If you select this check box, the LonMaker tool creates a hot backup of the network database if an application is accessing the LNS network database when you attempt to back up the network. Creating a hot backup prevents remote clients or other LNS applications accessing the network database from being disrupted. If you clear this check box, you can still create a hot backup (see step 6 for more information) b.
• 7. If the database is being accessed and hot backups are disabled, a prompt will open giving you the option to create a hot backup of the LNS network database, or to create a standard backup after closing all applications accessing the database, including the LNS Server. o Click Yes to make a hot backup of the network database. o Click No to create a standard backup of the network database after you have closed all other LNS applications accessing the network database, including the LNS Server.
backups are disabled by default. Once you set a database backup interval, the LonMaker tool will make the automatic hot backups on the specified interval as long as changes have been made to the network database since the previous backup, the changes were made using the LonMaker tool or reported by an LNS event, and you are using the LonMaker tool on a local client.
• /DB. Specifies that only the LNS network database is to be backed up (the default is to backup both the LNS network database and the drawing). • /Drawing. Specifies that only the LonMaker drawing is to be backed up. Restoring a LonMaker Network You can restore a LonMaker network from a standard LonMaker backup or a hot backup.
4. 212 Select whether to restore a standard LonMaker backup or an LNS hot backup (backup made while the LNS Server is running). • If you select the Restore from LonMaker Backup checkbox, specify the backup you want to restore. By default, the last file containing both a network database and LonMaker drawing backup is selected (unless one does not exist). To select a network database backup, click Browse. The Select Backup File dialog opens.
LNS hot backup created is selected. To select a different LNS hot backup, click the file name of the LNS hot backup you want to restore. 5. Click OK in the LonMaker Restore dialog box. 6. The LonMaker tool checks for user privileges. If this LonMaker network is password protected (see User Profiles in Chapter 3, Getting Started), enter your user name and password. Your user profile must have the Modify privilege selected for the network object to restore a network. The Confirm Restore dialog box appears.
Note: When you open a network restored from a hot backup of the network database, a message may appear prompting you to resynchronize the LonMaker drawing to match the database. This occurs if changes were made to the drawing after the hot backup of the network database was created. Restoring a LonMaker Drawing Backup To restore a LonMaker drawing backup, follow these steps: 1. Open the LonMaker Design Manager.
4. Select the Restore from LonMaker Backup checkbox. 5. By default, the last file containing both a network database and LonMaker drawing backup for the selected network appears in the Restore from LonMaker Backup box. To select a different LonMaker backup file (.zip extension), click Browse. The Select Backup File dialog opens. Select the LonMaker backup file to restore (the full network backup files are in the following format by default: [_index].
10. By default, the LonMaker tool will prompt you to select whether to install any new files in the Import folder (includes LONMARK resource files) and then any new files in the Types folder (includes XIF and .APB files) . Click Yes to restore the files; click No to skip restoring the files; or clear the Only Restore New Files checkbox, select one or both of the Overwrite Read-only Files and Overwrite more Recent Files check boxes, and click Yes.
14. Click Next to next to accept the default synchronization operation, which is Synchronize Network to Database (the option for recommissioning devices). The Choose Synchronization Scope dialog opens.
15. Click Next to accept the default synchronization scope (all the subsystems and drawing files in the network). The Commissioning Options dialog box opens. 16. Select the state of the devices after they have been recommissioned. You have four choices: • Preserve Current State. The devices will be restored to the state they were in prior to being recommissioned. This is the default. • Offline. All devices will be left in the offline state. The behavior in the offline state depends on the device.
18. This window displays the status of the resynchronization. Resynchronization events will be listed in the order they occur. Click OK when the resynchronization is complete. The resynchronization events, including any errors, are shown in the status pane and recorded in a log file (Resync.log). The resync log is stored in the drawing directory of the current LonMaker network. Notes: • Recommissioning a device may temporarily interrupt its operation.
2. Ensure that all components of the network are present and functioning properly before starting recovery. Any missing devices or routers will cause portions of the network design to be missing. For example, if a router is not recovered, all devices on the router’s far side will not be included in the recovered network design. 3. Run the LNS Network Database Recovery Wizard. The recovery wizard includes an option to automatically generate the LonMaker drawing. 4.
2. Under LonWorks Network, select the Update Location Path and ID in Devices check box (this option is only available if at least one of the subsystem recovery options is selected). Click Next. The Choose Synchronization Scope dialog appears. 3. Select the subsystems and drawing files to update. 4. Click Finish. The Synchronization Status dialog opens and the LonMaker tool begins updating the subsystem data in the devices within the specified network scope. 5.
Using Subsystem IDs If you select the Set Location Property to Subsystem ID option, the LonMaker tool stores the subsystem ID in application devices or routers when they are commissioned. The subsystem ID is equal to the lower 15 bits of a device’s subsystem handle, and it appears as a 6-character ASCII or 12digit hex string in the Location field of the Basic Properties dialog box. The LonMaker tool automatically updates the subsystem ID when you move the device.
3. Enter a unique network name, and select the Recover Database from Network check box. Click Next. The Network Interface page appears. 4. Select the Network Interface and click Next. The Plug-In Registration page appears.
224 5. Register or disable plug-ins as desired and click Next. The Authentication window appears. 6. If you use authentication on your network, select the Enable Authentication check box and click Set New Authentication Key.
LonMaker tool cannot recover your database without the authentication key). Click Next. The Domain Definition window appears. 7. If you know the Domain ID of the network that you want to recover, enter it in hexadecimal format into the Domain ID box. If you do not know the Domain ID, select the Recover Domain ID from Network Device check box. To recover a domain ID, you must have access to the service pin of an unauthenticated device that is on the same channel as the network interface. 8. Click Finish.
11. Click Next to continue. The Device Credit Note dialog box appears. 12. Select whether LonMaker credits are to be deducted for application devices that are recovered. Select Deduct LonMaker Credits if the devices on the network that you are recovering were not commissioned previously with the LonMaker tool. Select Do Not Deduct LonMaker Credits if the devices on the network were commissioned previously with the LonMaker tool. Click Next. The What Would You Like To Do Now? dialog box appears.
13. Click Recover a Network and click Next. The Select LonManager Database dialog box appears. 14. If you have a LonManager database or CSV file, select the corresponding option; otherwise, click No Such Input Available. Click Next. The Recovery Options dialog box appears.
15. If you expect your network to have more than 200 devices, select the Large Network check box. The Domain ID and Authentication Key boxes are read-only, as these settings are determined by the input from step 6. Click Next. The Device Resource Files dialog box appears. 16. Before proceeding, check if any LONMARK resource files are contained in directories not displayed in this dialog box.
17. Add or remove device templates based on device interface (XIF) files. When finished, click Next. The Recovering dialog box appears. 18. Click Next to begin the network recovery. The time of the recovery process depends on the size and complexity of the network. Throughout this process, messages will appear. When the data recovery is complete, the Optimizing Database dialog box appears.
19. Select the Organize Database check box and click Next. Throughout this process numerous messages will appear. When the database organization is complete, a Congratulations dialog box appears. 20. The Congratulations dialog box displays the number of errors and warnings, and the number of devices, bindings, warnings, routers, and channels found. This window provides valuable information to help you validate your LonMaker network design after it has been synchronized.
22. Click Finish to continue. The Synchronization Options dialog box appears. 23. Select the Automatically Drop Device, FB, and Subsystem Shapes check box to automatically add the appropriate shapes from the stencils to the drawing. You can clear the Create Shapes for all Connected NVs/MTs check box to simplify the drawing (alternatively, you can add the connection shapes and then hide them temporarily as described in Hiding and Showing Connector Shapes in Chapter 4, Designing Networks.
24. Add, remove, or re-order stencils. Click Finish. 25. The Synchronization Status dialog box appears as the synchronization process begins. It then displays the progress of the synchronization. Once “Synchronization Complete” appears, click OK to open your LonMaker network. 26. Verify that your LonMaker drawing accurately represents the network. Ensure that all devices on the physical network and all the connections between the devices appear on the drawing.
• Speed. Creating and restoring a LonMaker backup file is much faster than recovering a network. To recover the network, the LNS Server must scan the network to discover all the devices, upload a small portion of the overall network configuration stored in each device, and then create a drawing and network database based on the data collected from the physical devices.
resynchronize the LonMaker drawing to the network database. This resynchronization will be transparent, except that you may notice a slightly lower response time during the resynchronization. However, the automatic resynchronization may fail or other scenarios may occur in which you need to manually resynchronize the network.
You can change the defaults for how frequently your LonMaker tool checks the LonMaker event log, and the maximum number of entries it stores in the log. To change the default synchronization settings, select the network properties: Synchronization options category.
Exporting the LonMaker Event Log You can export the LonMaker event log to an XML file to work with the log information in another application. To export the LonMaker event log to an XML file, open the LonMaker menu, point to Synchronization, and then click Export Event Log. A message appears stating that the LonMaker event log has been successfully exported, and displaying the full path of the XML file. The XML file will be exported to C:\XML\\EventLog_year_month_date_[version].
• AppInst. The instance of the LonMaker application that generated the event. • EventType ID. The type of event that occurred (for example, created, deleted, renamed, shape moved, connection added). • Object Type ID. The type of object modified by the event (for example, AppDevice, Channel, Router, Subnet, NSI, Subsystem, Device template, LonMark Object). • SubsystemName. The name of the subsystem in which the object is defined.
3. Choose the synchronization operation(s) you want to perform by selecting the following options. LNS Database The network database resynchronization options are only available if the LonMaker tool is running on the same computer as the LNS Server. Validate LNS Database Validates the structure of the LNS network database. Validate and Repair LNS Database Validates the structure of the LNS network database and repairs the database if any errors are detected.
32,767 subsystems have been created and deleted, this could result in multiple unique subsystems having the same ID; however, this is very unlikely). LonMaker Drawing Synchronize Drawing to Database (fix-up Drawing) Updates the LonMaker drawing to be consistent with the LNS database. Synchronize Monitor Sets between Drawing and Database Updates the monitor sets in the LonMaker drawing to be consistent with the LNS database.
5. Select the scope of the selected synchronization operation(s) by choosing which subsystems and drawing files to resynchronize. If you know that the current subsystem is the only one needing resynchronization, resynchronize just that subsystem. If you aren’t sure which subsystem needs to resynchronized, resynchronize all subsystems. The same logic applies if your LonMaker network contains multiple drawing files.
Otherwise, if you are synchronizing the network or the LonMaker drawing to the network database, click Next and skip to step 10 in which the Synchronization Options dialog appears. If you are performing any other synchronization operation, click Finish to begin resynchronization. Skip to step 16 in which the Synchronization Status dialog appears. 7. If you are recommissioning devices, the Commissioning Options dialog box appears. Select the state of the devices after they have been recommissioned.
Otherwise, the Synchronization Options dialog appears. Skip to step 10. If you are not resynchronizing the LonMaker drawing, click Finish to begin resynchronization. Skip to step 16 in which the Synchronization Status dialog appears. 9. Select the following options and then click Next. Shapes All shapes that have newer versions available than the ones currently in the drawing are listed. Select the shapes to update. Items Select Menu to update the shortcut menus for the selected shapes.
11. Select the options to be applied during the synchronization of the LonMaker drawing to the network database. Create Shapes for all Connected NVs/MTs Adds shapes to functional blocks for all connected network variables or message tags created during resynchronization. If this check box is cleared, the LonMaker tool uses generic connections when possible.
subsystems in a single Visio document. • Prompt for Subsystem Document Assignment. Prompts you to specify the Visio document for each subsystem. • Separate Document for each Subsystem Hierarchy below Root. Places each subsystem hierarchy below the top-level subsystem in a separate, new Visio document. • Custom. Opens the Subsystem Document Assignment dialog. In this dialog, you specify the Visio document for each subsystem. 12. Click Next.
15. Specify the stencils that will be scanned for master shapes during resynchronization. When objects are found within the LNS network database that are not already represented in the drawing, the LonMaker tool scans the listed stencils and automatically adds the appropriate shape to the drawing. If the object’s particular master shape is not found, an appropriate generic master shape (e.g., a LonWorks device shape) will be used. To add additional stencils, click Add Stencil.
17. If the LonMaker drawing is being synchronized to match the network database and the Automatically Drop Device, FB, and Subsystem Shapes check box was cleared, the Missing Shape dialog appears for each object in the network database that is not represented in the LonMaker drawing. a. Click OK. The Missing Shape dialog closes and you are returned to the LonMaker drawing. b. Drag a single shape from a LonMaker stencil to the LonMaker drawing to represent the missing shape.
Merging LonMaker Networks You can initially install a large LonWorks network as a number of smaller independent networks— each with their own network database—and then later merge the networks into one network. Examples of installations that may use this technique include the following scenarios: • Multiple systems. When multiple systems are being installed, the installers for each system want to install and debug their installation without interference from other systems.
will likely change. In addition, all previously commissioned devices in the source network must be recommissioned. • Commission Status. Devices in the source network are unconfigured in the destination network upon the completion of the network merge. However, the Neuron IDs of the devices are preserved in the destination network and the LonMaker credits needed to commission them are added. • Network service devices.
The merge export utility prepares the network to be merged into another network. The utility adds data from the source LNS network database to the source LonMaker drawing. The merge export utility also automatically decommissions all configured devices in the network that use authenticated message service so that they can be recommissioned in the new network. Select the Decommission Unauthenticated Devices check box to decommission all the configured devices in the network. 5.
7. Exit the LonMaker drawing of the source network. 8. Back up the destination LonMaker network design following the steps in Manually Backing Up a LonMaker Network Design in this chapter. You can use the backup to restore the network if the merge process fails for any reason. If a failure occurs during the merge process, the destination network will be left in a partially merged state and the LonMaker tool will not let you access the network.
This dialog displays the status of the network merge and lists the events in the order they occur. Any errors encountered are shown in the status pane, and they are also available in a log file for the network merge. The log file is named Merge_.log. The merge log is stored in the drawing directory of the destination network. 15. During the network merge, the LonMaker tool prompts you to specify whether the channels in the merged network already exist in or are new to the current network.
252 Maintaining Networks
8 Managing Networks This chapter explains how to test and verify application devices, functional blocks, and routers; describes LonMaker styles; and details how to generate device status summary reports, network resource reports, and LNS network reports.
Using the LonMaker Device Manager You can manage application devices, functional blocks, and routers using the LonMaker Device Manager. You can switch between performing management tasks and making changes in your LonMaker drawing without having to close the LonMaker Device Manager. You can perform the following tasks using the LonMaker Device Manager: • Test application devices, functional blocks, and routers to ensure they are operating and are configured correctly.
You can also select the Devices tab after you have opened one of the other tabs with one or more application devices or functional blocks selected. The Devices tab of the LonMaker Device Manager appears. You can use this tab to manage the selected application devices. The tab contains an Object List that displays the selected devices, and a Results Log that lists the results of any commands or tests.
must be online to be enabled. This command only applies to devices containing a Node Object functional block. Disable Keeps the device application disabled even if the device is reset. The device must be online to be disabled. This command only applies to devices containing a Node Object functional block. If Disable is selected and the device does not contain a Node Object functional block, the device is placed offline.
The commands in this dialog require that the device application associated with the functional block includes a Node Object functional block and that the device is online. Click one or more functional blocks in the Object List and then click any of the following buttons: Test Tests the functional block to ensure that it is operating correctly. The tests run are determined by the options set in the Device Manager Settings dialog, which you can open by clicking Settings.
Managing Routers To manage a router, right-click a router (or select multiple objects including at least one router and right-click one of them), and then and select Manage on the shortcut menu. You can also select the Routers tab after you have opened one of the other tabs with one or more routers selected. The Routers tab of the LonMaker Device Manager appears. You can use this tab to manage the selected routers.
Device Manager Settings You can customize the error reporting, testing, and winking operations performed by the LonMaker Device Manager. To customize these setting, click the Settings button on any of the tabs in the Device Manager. The Device Manager Settings dialog appears. Set the following options and then click OK to apply any changes. Options Stop Test on Error Stops tests immediately when an error is reported. This option is cleared by default.
Operations repeating a Wink or Test command when the number in the Repeat Number of Times box is greater than 1. Using LonMaker Styles Overview You can use Visio styles to view the state of each device, functional block, connection, and network variable/message tag. The LonMaker tool automatically updates shape styles as events are received that indicate changes in shape status. You can change how states are depicted in a LonMaker drawing.
Note: Devices that have a Ping Interval of Never are not monitored; therefore, the device shapes may not indicate the correct detached or failure states. LonMaker Functional Block Styles The LonMaker tool reflects the last known state of functional blocks. You may update that information in two ways: • From the LonMaker menu, select Status Summary (see Status Summary in this chapter for more information about this feature).
Network Variable and Message Tag Shape Styles The LonMaker tool indicates the state of network variable and message tag shapes using the following styles: Connection Point State Default Style Description Connection Point Normal Solid black fill The network variable or message tag shape is normal (not currently exported to a supernode). Connection Point Exported Solid blue fill The network variable or message tag shape has been exported to one or more supernodes.
Monitoring Enabled Text is black. Monitoring Disabled Text is magenta. The LonMaker tool updates the style of the connection shapes, as required, if changes are made to the connections that affect the service type used. Generating a Device Status Summary Report You can generate a status summary report listing the devices and routers that are unconfigured and offline, and selected functional blocks that are in the override, alarm, or disabled states or have reported communication or self-test failures.
choices: 3. 264 • Select Subsystem Page to include the application devices, routers, and functional blocks in the current subsystem. This is the default. • Select Subsystem Hierarchy to include the application devices, routers, and functional blocks in the current subsystem and subsystems nested in it. • Select Entire Network to include all the application devices, routers, and functional blocks in the current LonMaker network.
4. Select additional functional blocks to include in the status summary based on the type of errors or exceptions they have reported. For more information on the status items themselves, refer to hardware manuals or LONMARK documentation. 5. Click Next. The Device Status Summary Results dialog appears. This dialog displays the status of devices, routers, and specified functional block types within the scope specified in the Device Status Summary Options dialog.
For functional blocks, this dialog displays the following data in the top pane: subsystem, device, functional block name, applicable status (indicated by "YES"), and any comments about the functional block. For application devices and routers, this dialog displays the following data in the bottom pane: subsystem, device name, state, and any comments about the device or router. 7. To save the status summary to a text file (.txt extension), click Save As.
Alias Table Summary You can display a summary of the usage and availability of alias table entries for a device. The usage and availability is displayed in a ToolTip for a device. The device shape ToolTip lists the total number of network variable aliases for the device, and the number of aliases currently available.
Generating LNS Reports You can create a report detailing selected objects in your LonMaker network using the LNS Report Generator or by generating a LonMaker network report as described in Chapter 9, Exporting and Importing Networks with XML. The LonMaker network report is typically faster and more flexible. The LNS Report Generator is an LNS plug-in that generates customized reports for a LONWORKS network.
3. Under the Report Type box, select the format of the report: CSV (comma delimited values) or TSV (tab delimited values). 4. Enter the name of the report file in the Report Filename box. 5. Under Report Options, select the following report options: Headers Raw Data Outputs a header record before each new block of property data. This option is selected by default. The header record will contain the name of each property along with the units of that property.
6. Under LNS Objects, select which objects to include in the report by moving them from the left to the right pane. You can get information about any object by choosing the object and then selecting Object Help from the Objects menu, or by clicking the help icon. 7. To reorder the selected LNS objects in the right pane, select the object to move and then click the Up or Down button, or select Move Up or Move Down from the Objects menu.
9 Exporting and Importing Networks with XML This chapter describes how to export a LONWORKS network to a LonWorks network XML file, view a LonWorks network XML file in a web browser, edit a LonWorks network XML file, and import a LonWorks network XML file to update a network.
Using XML Export/Import Overview You can export your LONWORKS network to a LONWORKS network XML file that contains all the devices, connections, network variables, and configuration properties within a specified network scope (from selected devices to the entire network). You can also include device templates, connection description templates, and channels in the XML file.
2. Set the following options to select the data to be included in the XML file: Export Scope Select the portion of the network to be included in the XML file. There are four choices: • Entire Network. All application devices and routers in all subsystems in the network will be exported. This is the default. • Current Subsystem and Dependents. Application devices and routers in the currently displayed subsystem and those in any nested subsystems will be exported. • Current Subsystem Only.
Specific CP Values specific CPs are CPs that may be changed by the device itself or by another device that is not based on LNS. The LonMaker tool reads device-specific values from the devices in the network—this option is unavailable if the LonMaker computer is not connected to the physical network. This option can add significant processing time to the export if there are many device-specific CPs within the export scope.
This report consists of a main network page with the network name, export date and time, and tables with hyperlinks to view the exported data for subsystems, channels, device templates, and connection descriptions. You can view the exported data following the network hierarchy—starting from the root subsystem through the contained subsystems, devices, functional blocks, and network variables down to the configuration properties associated with a network variable.
Click a functional block link to open a page with detailed data on that functional block and a table listing its network variables and configuration properties, with links to view detailed data on each one. You can continue moving down the network hierarchy until reaching the end, which is at the network variable\configuration property or configuration property paths. Click Up to go back one level in the network hierarchy, or click Root to return to the main network page.
When the LonMaker tool imports a LONWORKS network XML file, it attempts to match each object in the XML file with an object in the LNS database and LonMaker drawing. The LonMaker tool matches objects based on Neuron ID, name, or handle (in that order). For each matching object, the LonMaker tool updates the attributes of the object based on any changes in the XML file.
Tips: 278 • If you are making changes that affect the LonMaker drawing, set the LonMaker event log limit high enough to hold all of the events that may be generated by the XML file import. You can set the maximum number of log entries in the network properties: Synchronization options category (see Appendix A for more information on this option).
10 LonMaker Credits This chapter provides information on licensing the LonMaker tool; using, viewing, and adding LonMaker credits; licensing remote clients; transferring a LonMaker license; and using LonMaker demo mode.
Licensing with the LonMaker Tool Your licensed copy of the LonMaker software includes 64 (for LonMaker Professional Edition) or 5 (for LonMaker Standard Edition) free LonMaker credits. A LonMaker credit is a token representing a prepaid fee to commission a device. You can use LonMaker credits to commission devices in one network or in multiple networks. LonMaker credits are associated with the LonMaker application and the computer running it and are stored in a file called the LonMaker license file.
Viewing LonMaker Credits You can view the number of LonMaker credits you have available to commission devices from the LonMaker Design Manager or in a LonMaker drawing. The LonMaker Design Manager includes a LonMaker license status box in the bottom left-hand corner that indicates the number of LonMaker credits available (if you have more than 10 credits, the status bar is green; if you have 10 credits or less, it is yellow).
During the two-week deficit credit period, the Low Credits Warning dialog appears each time you open or create a network, switch to a different drawing page, or commission a new device. In addition, this dialog appears after every hour of use. This dialog displays the number of days and deficit credits remaining before your license expires. The LonMaker tool updates the days remaining and number of deficit credits to accurately reflect the current state of your license.
credits. To add credits, double-click anywhere in the LonMaker license status box, or right-click the Echelon LonMaker Design Manager title bar or taskbar button, and then click View Credits on the shortcut menu (see Adding LonMaker Credits in this chapter for how to purchase additional LonMaker credits). In a LonMaker drawing, you can view the status of your license by opening the LonMaker menu and selecting LonMaker Credits. The LonMaker Credits dialog opens.
1. Click Add Credits. 2. The LonMaker License Wizard opens. The first page of the LonMaker License Wizard displays the maximum and available number of LonMaker credits, provides deficit credit information (if you are commissioning devices without having any LonMaker credits—see Using Deficit Credits in this chapter for more information on using deficit credits), and lets you submit an order for additional LonMaker credits. 284 3.
The second page of the LonMaker License Wizard displays the PC Key (also called the activation code), which uniquely identifies your copy of the LonMaker tool and the computer running it, and it shows the Serial Number of your LonMaker tool. 6. Click Copy to Clipboard to create a LonMaker Credits Order Form. This form includes your request to order LonMaker credits, the PC key, and the Serial number. 7.
This dialog includes a License Authorization Report that shows the current and previous number of maximum, available, and maximum deficit credits; the current and previous edition of the LonMaker tool licensed (Professional, Standard, or Trial); and the PC and application keys. Click Copy to Clipboard to paste the report into another Windows application. 10. Click Exit. You are returned to the LonMaker credits dialog. 11. Click Close.
You can also use the LonMaker License Transfer Utility to add LonMaker credits to your license from another computer. You must transfer all credits plus the LonMaker license. You cannot transfer a portion of the LonMaker credits. When you transfer a LonMaker license, the source computer can no longer run the LonMaker software except in Trial mode, and any LonMaker credits that were previously on the target computer will be lost. A license must contain LonMaker credits in order to transfer it.
c. Make sure you are currently on the target computer. If you proceed with the following steps on the source computer, you will lose your LonMaker license. d. Click Step 1. Prepare New Computer to Receive License and then click Next. If the License Transfer Utility detects a LonMaker license on the target computer, the License Already Exists dialog box opens: e.
f. Perform any actions specified by the License Transfer Utility. The following window appears. g. Specify the drive to which you want to transfer your LonMaker license. You can use a USB drive, floppy disk, other removable media, or a shared network drive with read/write permissions. Click Next. A window appears telling you to go to the source computer and run the wizard again. h. Click Finish and go to the source computer. 2. Transfer the LonMaker license out of the source computer.
a. On the source computer, if you are using a USB drive, floppy disk or other removable media to transfer the license, insert it into the source computer. b. Click Start, point to Programs, point to Echelon LonMaker, and then click LonMaker License Transfer Utility. The LonMaker License Transfer wizard opens. Click Next. c. Click Step 2. Transfer License Out of Old Computer. The following window appears. d. Specify the temporary drive you specified in step 1 and then click Next.
3. Transfer the LonMaker license into the target computer. a. On the target computer, if you are using a USB drive, floppy disk or other removable media to transfer the license, insert it into the target computer. b. Click Start, point to Programs, point to Echelon LonMaker, and then click LonMaker License Transfer Utility. The LonMaker License Transfer wizard opens. Click Next. c.
If you are using the LonMaker Trial Edition or an unactivated copy of the LonMaker tool, you can only run the LonMaker tool will in demo mode and create demo networks. To create a LonMaker demo network with an activated copy of the LonMaker tool, click the New Network Options tab in the LonMaker Design Manager, and then under the Network Components box, select LonDemo from the Drawing Template box.
11 Using LNS Plug-ins This chapter provides an overview of LNS Plug-ins and then describes how to start a plug-in, get plug-in information, and re-register, enable, and disable plug-ins.
Using LNS Plug-ins Overview LNS plug-ins are applications that you can start from within the LonMaker tool to perform a specialized task, often relating to a specific type of device or functional block. For example, the LonPoint Plug-in that is included with the LonMaker tool provides LonPoint-specific user interfaces for reading and setting the configuration properties on LonPoint devices.
• For the network, open the LonMaker menu, point to Plug-Ins, and click Network Plug-Ins. The LonMaker Plug-ins dialog appears. This dialog lists the plug-ins that have been registered for the network. Select the desired plug-in and then click OK. To start a plug-in using a default command, right click a device or functional block shape, and then select Configure or Browse. If a plug-in is registered for the selected command and functional block type, the plug-in window opens.
Viewing Plug-in Information You can perform the following operations for registered plug-ins: • • • • • View general information about the selected plug-in. Disable the plug-in. Set whether the plug-in is the default for a given command. Select whether the plug-in is pre-launched for commands that invoke it. View whether the plug-in supports multiple objects and single instance use. To perform any of these operations, open the LonMaker Plug-in Information dialog from the drawing page or the LonMaker menu.
Default Plug-In Registers the plug-in as the default application for the specified command and object class. The LonMaker tool removes the default attribute, if set, from all other plug-ins registered for that command and object class. If this check box is cleared, the LonMaker tool does not change the attribute on any other plugins. If multiple plug-ins are registered for the same command and object class, the plug-in with this check box selected will be the one invoked.
The columns contain the following data. You can sort the data by clicking a column header. Click a header again to toggle the order (ascending or descending) in which the data in that column appears. Server Name The registered ActiveX name for the plug-in. Multi-Object Whether the plug-in supports multiple objects simultaneously. Single Instance Whether the plug-in supports using a single instance of the plugin when it is requested for the same object multiple times.
Follow these steps to register or re-register a plug-in: 1. Choose the plug-in to register from the Already Registered or the Not Registered list. You can register all the plug-ins listed under these lists by clicking the category label. 2. Click Register. The plug-in or plug-ins are added to the Pending list (they also remain under their existing lists), and their status, “[Register]”, is indicated. 3. Once you have chosen all the plug-ins to register or re-register, click Apply.
2. Click Disable. The plug-in or plug-ins are added to the Pending list (they also remain under their existing lists), and their status, “[Disable]”, is indicated. 3. Click Apply to disable the selected plug-in or plug-ins. 4. After the plug-ins are disabled, click OK to return to the LonMaker drawing. When a registered plug-in is disabled, it will not open when you select a default command that would otherwise invoke it.
12 Creating and Using Custom LonMaker Shapes and Stencils This chapter describes LonMaker stencils and the process to create them; creating and using custom master shapes for devices, functional blocks, subsystems, and connections; using additional user cells for devices, functional blocks, and routers; and setting user-defined functional block modes and types.
LonMaker Stencils The LonMaker tool uses Visio stencils to speed your network engineering. A stencil is a collection of master shapes (also called masters) that you can easily reuse in your drawings. To add a master shape to your drawing, you drag the master shape from the stencil to your drawing. The LonMaker tool includes LONWORKS specific master shapes called LonMaker shapes. For more information on Visio stencils and master shapes, see your Visio documentation.
4. Select the object or objects to be included in the master shape. You can create a master shape that contains routers, channels, devices, functional blocks, connections, subsystems, and Data Point shapes. To select multiple objects you can either drag a selection net around the objects or hold down CTRL and click the objects. 5. Drag the selected object or objects to the stencil you opened. A new master shape representing the selected object or objects appears in the stencil. 6.
only on each channel. The LonMaker tool places all subsequent devices that are on the same channel in the master shape on the channel that you select for the first device on the channel, and have their properties set as specified in the master shape. To manually set the channels and properties for each device, select the Force Wizard Prompts check box in the network properties: General options category as described in Appendix A.
• If a custom master shape contains several functional blocks associated with the same device, but not the device itself, the functional block wizard appears for the first functional block only. You must associate the functional block with its device. The remaining functional blocks are assigned to the same device, unless no more functional blocks of the correct type are available on the device.
• Create New. The channel is created as a new channel. The channel name will be modified if there is a naming conflict (if the channel name ends with a number, the channel number will be incremented; if the channel name does not end with a number, an index, starting at 1, will be appended to the channel name). Notes: • When creating a subsystem or supernode master shape, the LonMaker tool requires that the stencil has a name.
To create a master shape that allows you to fan-in additional inputs to the Central Monitoring Station functional block, copy the following shapes to a new master shape: If you drag this master shape to any subsystem in the same network, the LonMaker tool creates two new functional blocks, and adds their outputs to the same Alarm connection for the Central Monitoring Station.
Editing Master Shape User Defined Cells This section is for advanced LonMaker and Visio users who want to create custom LonMaker shapes for use in their networks. This is an advanced feature for advanced LonMaker and Visio users. You can change the properties of a master shape by changing its user-defined cells. For example, you can extend the list of device types to which a functional block can be applied, as described in Functional Block Master Shapes.
the device when the device is commissioned or replaced. • A value of 0 indicates no. • A value of 1 indicates yes. • A value of 2 indicates that the LonMaker user will be prompted. The default value is 2 to prompt the user. ChanTypeList A semicolon-separated list of valid channel type IDs for the device. A value of -1 in the list indicates that the user has the option of selecting from all channels in addition to the channels of the specific types defined.
or must include a plug-in that sets the appropriate value. The scope selector definitions are: 0 Standard functional profile defined in the standard type file set. 3 User-defined functional profile, defined in a manufacturerspecific resource file set. 4 User-defined functional profile, defined in a manufacturer and device class specific resource file set. 5 User-defined functional profile, defined in a manufacturer and device class/subclass specific resource file set.
device’s location string. By default, the location string is initialized to all zeroes unless you enable the Set Location Property to Subsystem ID check box in the network properties: Recovery options category. NewAdvPropCap NewPropCap NonGrpRcvTimer • Specifies handling of the advanced properties dialog in the new device wizard. • A value of 0 specifies that the advanced properties dialog is not to be displayed.
NxeName Specifies the file name or full path of the application file. If it is not specified here, the LonMaker user will be prompted for an application file when a request is made to load the application image. ObjStateStyle Specifies whether the coloring style is applied to the shape’s fill, line, text, or a combination of the three. PingClass Priority • A value of 1 indicates that the style applies to the shape’s lines. • A value of 2 indicates that the value applies to the shape’s fill.
XifName value and the XIF search path. If found, the XIF file is loaded and used. If it is not found, the LonMaker user is prompted to enter a device interface file when the device master shape is dragged to the LonMaker drawing. XifName File name or full path of the device interface (XIF) file. If it is not specified here, the LonMaker user may be prompted for a device interface when the device master shape is dragged to the to the LonMaker drawing, depending on the ProgramId and TmplName values.
and device class/subclass specific resource file set. 6 User-defined functional profile, defined in manufacturer, and device class/subclass/model number specific resource file set. See Setting User Functional Block Scopes and Types for more information. Additional Router Shape User Cells You can include the following additional user cells in a router shape. Not every router has all of these cells, but you can add them by right-clicking an existing user-defined cell and selecting Insert Row.
To add a bitmap to a master device shape, follow these steps: 1. Open a new (non-LonMaker) drawing in Visio. 2. Open the LonBasic stencil. Open the File menu, point to Shapes, and then click the LonBasic stencil. 3. Drag the generic Device shape 4. Open the Edit menu and then click Open Device. The Group window opens for the device. 5. Open the Insert menu, point to Picture, and then click From File. Select a bitmap file. Position the bitmap on the device as desired. Close the Group window. 6.
316 Creating and Using Custom LonMaker Shapes and Stencils
Appendix A - Setting LonMaker Default Options This appendix documents the LonMaker Default Options you can set either in the LonMaker Design Manager or in your LonMaker drawing.
Setting LonMaker Default Options You can set LonMaker Default Options either in the LonMaker Design Manager or in your LonMaker drawing. For new networks, you can set the default options in the Default LonMaker Options tab in the LonMaker Design Manger. For an existing network, you can set them by opening the LonMaker menu and clicking LonMaker Options in the LonMaker drawing.
You can click Restore Defaults to reset all the options and values in the currently displayed options category to their defaults. Note: Every default LonMaker option has one of the following three scopes that determine which networks and LonMaker computers are updated when you change the value of an option: • Current network, current LonMaker computer. Value is updated in the network on the LonMaker computer in which the change was made. • Current network, all LonMaker computers.
If selected, a new Import folder will be inserted in the network database directory, and all the files in the LONWORKS Import folder (even those files that are not resource files or are not used in the LonMaker drawing) will be copied into that new Import folder prior to creating the LonMaker backup. Files outside the LONWORKS Import folder will not be backed up, even if they have been used in the LonMaker drawing.
Auto Save Intervals Drawing Save Sets how frequently (in minutes) the LonMaker drawing (.VSD) file is automatically saved. The default value is 60 minutes. To disable this feature, set the interval to 0. Scope: All networks, current LonMaker computer Database Backup Sets how frequently (in minutes) the LonMaker tool will automatically create a hot backup of the LNS database. The default value is 0 (never).
backup device application, device interface, and resource files based on the settings of the Overwrite Read-only Files and Overwrite More Recent Files check boxes This option is selected by default, and it is unavailable if either the Overwrite Read-only Files or Overwrite More Recent Files check boxes are selected. Scope: All networks, current LonMaker computer Periodic Backup Options Interval in Days Sets the number of days between periodic LonMaker backups.
Configuration Properties Options The Configuration Properties category contains the following options. Enable Configuration Properties Enables access to configuration properties. This option is selected by default. Also enables automatic extension record copying. When this check box is selected, a device’s extension records that are marked for copying will automatically be copied when you create a new device by copying an existing one and when you create a new custom device master shape.
Copy Values on Functional Block Copy Copies CP values when creating a new functional block from a master shape or from another functional block. This check box is only available if the Enable Configuration Properties check box has been selected, and it is selected by default.
Device Options The Device category contains the following options. Device Options XIF Search Path Specifies the path that the LonMaker tool uses to search for device interface (XIF) files. You can enter multiple directories by separating them with semicolons. Scope: All networks, current LonMaker computer NXE/APB Search Path Specifies the path that the LonMaker tool uses to search for device application files (.NXE and .APB extensions).
the preceding criteria, the Device Wizard will appear. Scope: All networks, current LonMaker computer Prompt for Device State During Commissioning Remove Unreferenced Device Templates Includes the window in the Commissioning Device Wizard for setting the initial state of application device/router applications and the source of device configuration property values. This option is selected by default. If this check box is cleared, this window will be skipped.
Routers Specifies the initial state of a new router after it has been commissioned. You have two choices: • Online. The router will forward packets between the channels connected to it. Use this setting to ensure routers are operational as they are commissioned. This is the default. • Offline. The router will not forward packets between the channels connected to it.
Functional Block Options Enable Automatic Device Selection Automatically assigns the appropriate device to a new functional block shape, thereby skipping the Functional Block wizard. This option is cleared by default. The functional block shape must contain a functional block type specification for this feature to work. This feature will therefore not work for the Functional Block shape in the LonMaker Basic Shapes stencil.
Scope: All networks, current LonMaker computer Delete Dynamic NV when NV Shape is Deleted Deletes a dynamic network variable from a device when its network variable shape is deleted from a functional block shape. You have three choices: • No. The dynamic network variable is not deleted. • Yes. The dynamic network variable is automatically deleted. • Ask. The LonMaker tool will prompt you to decide whether to delete the dynamic network variable. This is the default.
General Options The General category contains the following options. Confirm Deletes Prompts you to confirm the deleting of a LonMaker shape. This option is selected by default. Scope: Current network, current LonMaker computer Force Wizard Prompts Displays all wizards when you create a new LonMaker shape, regardless of the settings of any other options. This option is cleared by default.
LonMaker Browser. This option is selected by default. Scope: Current network, current LonMaker computer Automatically upgrade Visio drawings to current version Automatically upgrades a LonMaker drawing to the current version of Visio you are using, if possible. This option is selected by default. Disable plug-in prelaunch Disables the pre-launching of plug-ins when a LonMaker drawing is opened. This option is cleared by default.
The LNS Event category contains the following options. The changes you make in the LNS Events options category are all applied to the current network on your computer. Device/router Commission and Attachment Events Device Interface Change Events Connection Change Events Device/router Change Events Subsystem Change Events Device Template Change Events Channel Change Events Updates the LonMaker drawing when devices or routers are attached to the network, detached, commissioned, or decommissioned.
The LonMaker Font category contains the following options. LonMaker Font Name Displays the name of the current LonMaker font. The default value is Arial. Scope: Current network, current LonMaker computer Size Displays the size of the current LonMaker font. The default value is 8 points. Scope: Current network, current LonMaker computer Change Opens a dialog in which you can change the font, size, or style of the LonMaker font.
Naming Options The Naming category contains the following options. The changes you make in the Naming options category are applied to the current network on your computer. Naming Options Controls how the LonMaker tool constructs a unique name for new LonMaker shapes. If there is a naming conflict, the LonMaker tool will append to a new LonMaker shape name a space, dash, or other selected separator character followed by an instance ID.
Name/instance ID Separator Character Selects the character to be inserted between the LonMaker shape name and the instance ID. The choices are Space ( ), Underscore (_), Dash (-), Exclamation Point (!), and Hash (#). The default separator character is Space ( ). For example, the default name of the first analog input (AI-) LonPoint device added to your LonMaker drawing with a space ( ) selected as the separator character is AI- 1. If you select a dash as the separator character, the default name is AI--1.
Network Explorer Options The Network Explorer is an auto-hide window that displays a hierarchal view of the LonMaker drawing. You can use the Network Explorer to navigate, view, and modify the subsystems, devices, and device templates in your network design. The Network Explorer category contains the following options. The changes you make in the Network Explorer options category are applied to all networks on your computer.
• Subsystems, Devices, FBs, and NVs. Lists the subsystems, devices, functional blocks, and network variables in the LonMaker network. Scope: All networks, current LonMaker computer NV Browser/Monitoring Options The NV Browser/Monitoring category contains the following options. NV Browser/Monitoring Options Catalog Directory Specifies the directory containing resource files (.TYP, .FMT, .FPT, and language files). The default directory is LonWorks\Types.
monitor and control network variables. The tag is used to correlate a lightweight client to its monitor sets. By default, this tag is the computer’s Windows network name. If you have existing monitor sets and you change this tag, the existing monitor sets can no longer connect to the lightweight client. To remove the monitor sets, use the Remove Monitor Sets command from the Network Service Devices command on the LonMaker menu.
The Recovery category contains the following options. The changes you make in the Recovery options category are applied to the current network on all LonMaker computers. Subsystem Recovery Options If you select either of the following subsystem recovery options in the LonMaker drawing, you need to resynchronize your drawing and select the Update Location Path and ID in Devices check box in the Synchronize LonMaker Drawings dialog box in order to update the devices with the current subsystem location data.
will not be stored in the device. Scope: Current network, all LonMaker computers Set Location Property to Subsystem ID Stores the subsystem ID in the location field of an application device and router when the device is commissioned.
Service Pin Options You can set options for using the service pin when commissioning a device. Show Service Pin Data Displays the service pin data received by the LonMaker tool when you press the device’s service pin. This option is cleared by default. You can change this option when you commission a device or router in the Commission Device/Router Wizard.
Select this check box if the network does not contain any logical repeaters. Clear this check box if the network includes any logical repeaters. Scope: Current network, all LonMaker computers Shape ToolTips Options You can enable a ToolTip to appear when the mouse pointer is over a LonMaker shape in your LonMaker drawing and select the type of data that appears in the ToolTip.
Synchronization Options The Synchronization category contains the following options. Automatic Update Interval (Seconds) Maximum Log Entries per Drawing File Sets how frequently (in seconds) a LonMaker client checks the LonMaker Event Log and updates its copy of a LonMaker drawing to incorporate any changes made by other clients. The default automatic update interval is 10 seconds. Set the interval to 0 to disable automatic updates.
Warnings Options The Warnings category contains the following options, which are all selected by default. Enable Warning When New Device Requires Commissioning Enable Warning When Functional Block has no Matching Device Displays a message when you create a new device that needs to be commissioned. Scope: Current network, current LonMaker computer Displays a message when you drag a functional block shape onto a drawing but there is no compatible device on the drawing page.
the NSD. In most cases, you should perform the upgrade. However, if you are only temporarily using a different network interface, you may choose not to upgrade. In this case, communication with physical devices is limited until you reopen the network with the original network interface. If initially you choose not to upgrade the NSD and decide later to upgrade, rightclick the NSD shape, and then click Upgrade NSD on the shortcut menu.
346 Appendix B - Installing Network Interfaces
Appendix B - Installing Network Interfaces You can use any compatible IP or LNS network interface with the LonMaker tool. Compatible network interfaces include the i.LON 10 and i.LON 100 IP interfaces, U10 and U20 USB interfaces, PCC-10 PC Card, PCLTA-20 and 21 PCI Cards, SLTA-10 Serial LonTalk Adapter, and an Ethernet card used with an i.LON 100 with IP-852 routing or an i.LON 600 router.
Installing the PCLTA-10 Network Interface The following section describes how to install and configure the hardware for the PCLTA-10 network interface. The driver software is installed automatically when you install the LonMaker tool. Make sure the driver software is installed before installing the hardware and configuring the network interface. Installing the PCLTA-10 Hardware 1. Turn off the computer and remove the power cord. 2.
3. Ensure that the System Image Path matches the one used during software installation. 4. Select PCC10VNI from the NI Application list and then click Apply. 5. Click Diagnostics. If the PCLTA-10 software and hardware installation has proceeded correctly, the following dialog appears (refer to the PCLTA-10 online help if it does not appear): 6. Click Test. The following statistics should appear.
If the test passes, the computer can communicate with the PCLTA-10 network interface. If you receive an error message or your system hangs after clicking the Test button, uninstall the driver, reboot your computer, reinstall the software, and try running this diagnostic again. 7. Click COMM to make sure that the interface network interface can communicate with a test device. 8. Click OK.
Installing the PCLTA-20 Hardware 1. Turn off the computer and remove the power cord. 2. Open the computer case and locate an empty 32-bit PCI slot. Remove the corresponding blank panel from the rear of the computer. Set aside the screw. 3. Insert the PCLTA-20 card into the slot, ensuring that the edge connectors are fully mated and the slot in the rear panel-mounting lug of the PCLTA-20 card is aligned with the threaded hole in the computer chassis.
Windows does not load the device driver for the PCC-10 card until it discovers the first PCC-10 card. Likewise, when you remove the last PCC-10 card, Windows unloads the device driver, thus freeing any system resources it was using. Each PCC-10 card requires a single, dedicated interrupt request (IRQ) and four contiguous bytes of I/O address space starting on a modulo-4-based address.
If the test passes, the computer can communicate with the PCC-10 network interface. If you receive an error message or your system hangs after clicking the Test button, uninstall the driver, reboot your computer, reinstall the software, and try running this diagnostic again. 7. Click COMM to make sure that the interface network interface can communicate with a test device. 8. Click OK.
354 Appendix B - Installing Network Interfaces
Appendix C- LonMaker QuickStart Exercise This appendix contains a quick exercise in which you create a simple network that monitors and controls the temperature in a system using two devices and three functional blocks.
LonMaker QuickStart Exercise This section shows you how to quickly create a basic, fully functioning control network using the LonMaker tool and the LonPoint Plug-in. The LonPoint Plug-in, which is included with the LonMaker tool, provides LonPoint-specific user interfaces for configuring properties on LonPoint devices. The LonPoint Plug-in must be installed on your computer for this quick-start exercise, but you do not need any physical devices.
name, right-click the channel shape, click Properties on the shortcut menu, enter the new channel name in the Name box, and then click OK. 5. Define and commission (optional) the analog input and digital output LonPoint devices. a. Enable one-click device creation. Open the LonMaker menu and then click LonMaker Options. Select Device from the Options Category list. Select the Enable Automatic Channel Selection check box. b.
shape. Hold down the mouse button and then point to the A1 network variable on the thermostat (AFB) functional block. b. Connect the thermostat (AFB) functional block to the exhaust fan (DO) switch functional block. Connect the Digital_Out network variable on the Thermostat (AFB) functional block to the Digital input network variable on the Exhaust Fan Switch (DO) functional block. Select a different tool on the Visio toolbar 8. Configure the temperature sensor (A1) functional block.
c. In the Device Offset box, enter 32 if the temperature is displayed in Fahrenheit (degrees F), or enter 0 if the temperature is displayed in Celsius (degrees C). The temperature displayed depends on the Regional Settings in Windows. d. Click the Translation tab. A translation table appears. The translation table maps a set of input values for a thermistor to a set of temperature output values.
f. If you do not have a thermistor, you can send a value onto the network by entering an override value and then enabling the override. To enter the override value, click the Output Parameters tab, and then in the Override box, enter the value that you wish to send onto the network. To enable the override, click the Status tab, and then under Object Status, click Override On. g. Click OK. 9. Configure the thermostat (AFB) functional block.
c. For the Analog Input 2 network variable, click Use Constant and then enter the setpoint, which for this example, is 72.5 for Fahrenheit or 22.5 for Celsius. d. Click the Function tab.
e. Under Logic Function, click Greater Than. Now, if the value from Analog Input 1 (the temperature) is greater than or equal to the value from Analog Input 2 (the setpoint), the Digital_Out output network variable on the thermostat (AFB) functional block will transmit a value of On. After the Digital input network variable on the fan exhaust switch (DO) functional block receives and processes the On value, the exhaust fan turns on.
Appendix D - LonMaker Credits Order Form This appendix provides a printed copy of the order form for LonMaker credits. See Chapter 10, LonMaker Credits for information on using and adding LonMaker credits and instructions for using this order form. The order form in this appendix is only for use when you cannot automatically generate an e-mail or printed form as described in Chapter 10.
LonMaker Credits Order Form TO ORDER LONMAKER(R) CREDITS, PLEASE FILL IN ALL THE BLANK FIELDS IN THE TOP PART OF THE FOLLOWING FORM, SELECT ONE OF THE BILLING OPTIONS BY FILLING IN A CHECKBOX IN THE BOTTOM PART OF THE FORM, AND FILL IN THE BLANK FIELDS IN THE SELECTED BILLING OPTION. IF YOU ARE ORDERING NO CHARGE CREDITS, YOU MUST FILL IN ONE OF THE CHECKBOXES EXPLAINING THE REASON FOR THE ORDER. IF YOU ARE REQUESTING NO CHARGE REPLACEMENT CREDITS, YOU MUST FILL IN A REASON AT THE BOTTOM OF THIS FORM.
(or fax if e-mail is not available) to ensure that there are no errors in transcribing the serial number and key values.
[ ] Evaluation use. LonMaker Credits used for evaluating the LonMaker Integration Tool. Limited to 500 free credits per company per year. [ ] Internal development and test use. LonMaker Credits used for the development and testing of devices that will solely will be used for development, or that will be shipped in the unconfigured state. Limited to 500 free credits per device type per year. [ ] Support use. LonMaker Credits used by a support engineer to provide support to a customer using the LonMaker tool.
Appendix E - LonMaker Software License Agreement This appendix provides a printed copy of the LonMaker Turbo Integration Tool Software License Agreement.
LonMaker Software License Agreement LonMaker® Integration Tool NOTICE This is a legal agreement between you and Echelon Corporation (“Echelon”). YOU MUST READ AND AGREE TO THE TERMS OF THIS SOFTWARE LICENSE AGREEMENT BEFORE ANY LICENSED SOFTWARE CAN BE DOWNLOADED OR INSTALLED OR USED.
• “Multi-Port Router” means any of Echelon’s family of products that contain multiple Routers, including but not limited to the MPR-50 Multi-Port Router. • “Network Service Device” means a LONWORKS Device that is executing the Echelon LNS software as described in the Echelon LNS documentation. • “Recover” means to read the LONWORKS Network Configuration from a LONWORKS Device and to use such information to create an entry or entries in an LNS Server’s database.
Routers; and (i) transfer Your rights under this Agreement (including all unused LonMaker Credits) to an end user of the Licensed Software; provided that (i) You require the transferee to execute both copies of the Software License Transfer Agreement included with the Licensed Software and (ii) You retain one (1) signed original thereof and furnish Echelon with a copy of same upon request.
OR FROM AN ECHELON-APPROVED LONMAKER CREDIT RESELLER. IF YOU ATTEMPT TO COMMISSION MORE THAN SUCH APPLICABLE NUMBER OF LONWORKS DEVICES WITHOUT PURCHASING LONMAKER CREDITS, OR ATTEMPT TO INSTALL LONWORKS DEVICES IN EXCESS OF THE NUMBER OF LONMAKER CREDITS WHICH YOU HAVE PURCHASED, THE LICENSED SOFTWARE WILL CEASE TO OPERATE TO COMMISSION LONWORKS DEVICES.
SAFE OPERATION YOU ASSUME RESPONSIBILITY FOR, AND HEREBY AGREE TO USE YOUR BEST EFFORTS IN, DESIGNING, MANUFACTURING, COMMISSIONING, ROUTING, MONITORING, CONTROLLING, AND RECOVERING LONWORKS DEVICES HEREUNDER TO PROVIDE FOR SAFE OPERATION THEREOF, INCLUDING, BUT NOT LIMITED TO, COMPLIANCE OR QUALIFICATION WITH RESPECT TO ALL SAFETY LAWS, REGULATIONS AND AGENCY APPROVALS, AS APPLICABLE. THE LICENSED SOFTWARE, NEURON® CHIP, LONTALK® PROTOCOL, NEURON CHIP FIRMWARE, i.
Any use, modification, reproduction, release, performance, display or disclosure of the Licensed Software and/or the accompanying documentation by the U.S. Government or any of its agencies shall be governed solely by the terms of this Agreement and shall be prohibited except to the extent expressly permitted by the terms of this Agreement. Any technical data provided that is not covered by the above provisions is deemed to be "technical data/commercial items” pursuant to DFAR Section 227.7015(a).
374 Appendix E – LonMaker Software License Agreement
Appendix F - Software License Transfer Agreement If you purchased a license for the LonMaker software, you can transfer the license to another party. To do this, you and the other party must sign the agreement in this appendix.
Software License Transfer Agreement THIS SOFTWARE LICENSE TRANSFER AGREEMENT is entered into as of [insert date], by and between [insert company name of original purchaser] ("Assignor") and [insert name of company purchasing the software] ("Assignee") for the [insert name of software product being transferred] (“Software”). 1. Software License Agreement.
Appendix G - Glossary This appendix provides definitions for many terms commonly used with the LonMaker tool.
Glossary Acknowledged Service A service of the LonTalk protocol that ensures a message was received by the addressee(s). After a configurable number of retries, failures are logged in a status register in the device, which can be accessed by network management tools. Actuator Any component that affects a physical variable of the system under control or indicates the values of system variables for human operators. Some examples are pumps, fans, heaters, alarm annunciators, and operator displays.
or you may load it into the device from application files (.nld, .apb, and .nxe extensions) using the LonMaker tool. The application program interfaces with the LonTalk firmware to communicate over the network. It may reside completely in the Neuron Chip, or it may reside on an attached host processor (in a host-based device). Applicationless A state a device enters when it has determined that it does not have a valid application image.
Channel Type Channels are categorized into channel types, which are characterized by the device transceiver. Common channel types include the following: TP/FT-10 (ANSI/CEA-709.3 twisted pair free topology channel), TP/XF-1250 (high-speed twisted pair channel), PL-20 (ANSI/CEA-709.2 power line channel), FO-20 (ANSI/CEA-709.4 fiber optics channel), and IP-852 (ANSI/CEA-852 IP channel).
Data Point A network variable, configuration property, or functional block state (enabled or in override) that the LonMaker tool can monitor and/or control. Decommissioning Process in which devices are temporarily uninstalled. Decommissioning devices is useful when optimizing, troubleshooting, or repairing a network. All the configuration data of a decommissioned device, including configuration properties and connections, are preserved in the LNS network database.
Disable For a device, disabled is a device state in which the device application does not run even if the device is reset. For a functional block, disable is a management command that causes output network variables to send their configured default values. Domain A logical collection of devices on one or more channels. Communications can only take place among devices configured in the same domain. Domain ID The top level of the LonTalk addressing hierarchy of domain/subnet/node.
Fan-in Connection A multicast connection in which multiple output network variables (or message tags) are connected to a single input network variable (or message tag). Fan-Out Connection A multicast connection in which multiple input network variables (or message tags) are connected to a single output network variable (or message tag). Firmware Firmware required to implement the LonTalk protocol.
which case it is called a host-based device. A host-based device uses the Neuron Chip as a network interface to talk to the LONWORKS network. Host Processor The application processor for a host-based device. The host processor is typically a micro-controller, microprocessor, or computer. Host-Based Device A device in which the device application program runs on a processor other than the Neuron Chip.
the LAN, individual workstations or computers can send messages and files to each other and to shared devices, such as printers, disk storage, and other computer systems. LAN performance is measured in the amount of data that can be transmitted and received, usually expressed as megabits transmitted per second, so its critical factor is speed. LNS A network operating system that provides services for interoperable LONWORKS installation, maintenance, monitoring, and control tools such as the LonMaker tool.
Local Client A LonMaker computer that is also running the LNS Server. LonMaker Browser An LNS plug-in that provides a table view of the network variables and configuration properties of selected devices and/or functional blocks. The LonMaker Brower can be used to monitor and control the network variables and configuration properties in a network. LonMaker Credit A pre-paid fee for commissioning an application device.
type of medium. The LonManager Protocol Analyzer includes three tools for network analysis and monitoring: • • • Packet monitor tool Network traffic statistics tool Network diagnostics tool LonMark A distinctive logo applied to LONWORKS devices that have been certified to the interoperability standards of the LONMARK Interoperability Association. LonTalk File Transfer Protocol An interoperable way for devices to share data files.
• Binding network variables to create logical connections between devices. • Configuring the various LonTalk protocol parameters in each device for the desired features and performance, including channel bit rate, acknowledgement, authentication, priority service, etc. Network Image A device's network address and connection information. For Neuron Chip hosted devices, the device's network image is stored in EEPROM on the Neuron Chip.
Neuron ID A 48-bit number assigned to each Neuron Chip at manufacture time. Each Neuron Chip has a unique Neuron ID, making it like a serial number. Network Explorer An auto-hide window that displays a hierarchical view of your LonMaker network and supports all of the commands available within the drawing pages. The Network Explorer can be used in a LonMaker drawing as a navigational tool or as a network management tool.
LonMaker tool OnNet. If the LonMaker tool is OffNet and attached to the network, you can still perform read operations on the network. OnNet A management mode in which network configuration changes are propagated immediately to the devices on the network. Override A management command used on a functional block that causes output network variables to send their configured override values. The override values are set using the configuration properties in the functional block.
Priority A LonTalk protocol service for messages sent from LONWORKS devices that allow a message priority access to a channel. Priority traffic is delivered before other traffic. Priority is a resource of the channel. Protocol Analyzer A tool that can read every packet on a LONWORKS channel. A protocol analyzer is different from a device containing the complete LonTalk protocol stack in that it can receive every packet on the network, not just packets that are addressed to it.
Replacement Process in which a failed or obsolete device is replaced on the network and in a LonMaker drawing with a new or upgraded device. The LonMaker tool preserves the device’s functional blocks, network variables, configuration properties, and connections and transfers them into the new device. Router Routers manage network message traffic, extend the physical size of a channel (both length and number of devices attached), and connect different channel types.
and is unconfigured, is off when the Neuron Chip has an application and is configured, and blinks once quickly each time the Neuron Chip is reset. Smart Connection Description (SCD) A pre-defined connection description that the LonMaker tool automatically assigns to a connection being created or changed based on the number of target network variables, whether the target network variables are located on the same or different subnet, and the availability of network variable aliases.
Synchronized The state of a LonMaker network design when a LonMaker drawing and the physical devices on the network match the LNS network database. Target The destination of a connection specified by a device handle and network variable (or message tag) index. Each connection is defined in terms of a hub and a one or more targets connected to the hub. For network variable connections, the hub may only be a single input or output network variable in the connection.
devices must have UNVTs documented in resource files according to a standard format, in order to allow the devices to be interoperable. Virtual Functional Block A static functional block that that contains the network inputs and outputs for a device that are not part of other functional blocks on the device. Wink A management command used to identify a device on the network and verify that is communicating.
396 Appendix G – Glossary
Index LonMaker User’s Guide 397
A Access control, 35, 73 acknowledged connection, 118 using authentication, 119 Activation, 28 creating key request, 29 entering activation key, 31 requesting activation key, 31 adding LonMaker credits, 283 addressing modes, 119 alias, 119 broadcast, 119 group, 119 subnet/node ID, 119 ad-hoc system scenario, 35 administrators, 35 Adobe Acrobat Reader Installation, 28 add-ons uisng with data point shape, 189, 191 alias addressing, 119 alias table summary, 267 application devices, 81 adding, 79 automatic chan
creating with the connector tool, 114 defined, 113 fan-in, 117, 172, 306 fan-out, 117, 306 implicit, 172 master shape, 306 monitoring, 164 multicast, 113 network navigators, 129 priority, 119 reference, 117 unicast, 113 moving the computer to a different channel, 139 selecting, 81 channel types, 308 router, 314 clients, 17, 61 application devices, 144 commissioning, 80 configuration property source, 150 device state, 149 device-specific configuration property management, 150 loaing devices, 146 manual entr
creating, 99 deleting, 101 device discovery, 156 device identification method, 152 device interface files, 131, 148, 381 user cell, 313 device shape, 79 device templates creating, 81 defined, 15, 131 editing, 132 managing, 131 selecting or creatng, 195 devices attaching replacement to a network, 200 bitmap, 314 commissioning multiple, 155 controlling, 164 decommissioing, 203 description, 15 discovering, 156 listing devices in a subsystem, 200 listing devices in a subsystem, 200 loading an application into,
minimum, 20 using, 225 HMI applications, 187 organizing, 192 LNS DDE Server sharing LNS interface, 36 hot backup, 206 creating, 207 restoring, 212 LNS events, 234 hubs, 113 I i.LON 1000, 46, 47 i.LON IP-852 router commissioning, 156 identification method service pin, 153 import folder backing up, 207 restoring, 216 importing a network with XML, 276 Installation, 144 Adobe Acrobat Reader, 28 LonMaker tool, 25 LonPoint, 27 LonPoint Plug-in, 22 network drivers, 28 Visio, 23 LNS hot backup.
LonMaker Design Manager, 37 General tab, 38 LonMaker Default Options tab, 45 LonMaker Stencils tab, 44 Network Wizard Accelerator, 4 New Network Options tab, 42 One-Click Network Creation, 4 Options tab, 40 LonMaker Device Manager, 254 opening, 254 settings, 259 LonMaker drawing creating, 78 defined, 14 restoring, 214 synchronization, 239 LonMaker event log, 234 exporting, 236 viewing, 235 LonMaker layers, 134 LonMaker license status box, 37 LonMaker License Wizard, 284 LonMaker Network Design copying, 56 c
connection, 306 connector, 114 creating, 302 data point shape, 186 defined, 302 device, 303 device user cells, 308 functional block, 304 functional block user cells, 313 including subsystems and supernodes in, 303 router user cells, 314 subsystem and supernode, 305 user defined cells, 308 using, 303 using with referenced connections, 306 merge export utility, 249 merging networks, 247–52 message service types, 118 acknowledged, 118 repeated, 119 unacknowledged, 119 message tags creating, 93 defined, 93 dele
fan-in, 172 format, 178 format specifiers, 179 LonMaker styles for, 262 mandatory, 87 monitoring with the LonMaker Browser, 171 monitoring, 164 optional, 87 selectors, 266 static, 94 types, 16, 176 updating with a data point shape, 183 updating with the LonMaker Browser, 173 networks backing up, 206 creating, 78 installing, 144 maintaining, 194 managing, 254 merging, 247–52 monitoring overview, 164 optimizing performance, e 35 refreshing, 246 restoring, 211 resynchronizing, 237 neuron firmware updating, 147
moving between subsystems, 135 one-step creation, 102 pinging, 104 priority, 106, 314 repeater, 105 setting initial state, 151 subsystem ID, 104 types, 105 licensing, 286 loading applications, 148 LonMaker credits, 286 remote full clients, 17, 61 defined, 62 using, 64 remote lightweight client 17, 61 defined, 63 using, 67 S remote networks collection, 69 scopes, 309 remote use, 17, 61 licensing, 286 using user profiles with, 75 SCPT, 16 repeated, 119 selector, 266 replacing devices, 200 configurati
copying, 112, 139 creating, 109 defined, 17 hierarchy of, 128 in large networks, 37 including in master shapes, 303 master shape, 305 names, 36 opening, 128 parent, 129 supernodes, 37, 111 adding to a connection, 129 changing name, 112 copying, 112, 139 creating, 111 defined, 17, 111 deleting, 112 including in master shapes, 303 master shape, 305 synchronization, 231, 233 automatic, 234 LNS events, 234 LonMaker event log, 234 manual, 237 options, 243 recommissioing devices, 241 scope, 240 T Tablet PC Suppo
LM-UG1 6/19/06 9:30 AM Page 1 LonMaker User’s Guide ® LonMaker® User’s Guide www.echelon.
