Om 136: QuickNet MicroTech 2000 Network Mgmt Software · OM 136 6 Introduction Welcome to QuickNet...

Operation Manual OM 136

Group: Controls

Part Number: 629957Y

Date: July 1997

© 1997 McQuay International

QuickNet™

MicroTech 2000™ Network Management Software

Version 3.2

OM 136 2

ContentsIntroduction.................................................................................................................................... 6

Product Overview ....................................................................................................................... 6Installing QuickNet on Your Computer ....................................................................................... 6Technical Support ....................................................................................................................... 6

Getting Started ........................................................................................................................... 7

Network Installation Methods......................................................................................................... 7On-Line Network Installation and Maintenance.......................................................................... 8Off-Line Network Installation ..................................................................................................... 8Graphical Template Binding ....................................................................................................... 8Duplicating an Installation.......................................................................................................... 8

QuickNet’s Main Screen................................................................................................................. 9Project Menu .............................................................................................................................. 9Location Menu.......................................................................................................................... 10Network Interface Menu ........................................................................................................... 11Network Management Menu..................................................................................................... 11NV (Network Variable) Browser Menu ..................................................................................... 13Window Menu .......................................................................................................................... 13

Graphical Representation of Node States ...................................................................................... 15

Uninstalling QuickNet .................................................................................................................. 15

Managing Projects................................................................................................................... 16

Password Management ................................................................................................................. 16Adding a User........................................................................................................................... 16Deleting a User ......................................................................................................................... 17Modifying a User’s Access Privileges........................................................................................ 17

Working with Projects................................................................................................................... 17New Projects............................................................................................................................. 17Opening Existing Projects......................................................................................................... 18Deleting Projects....................................................................................................................... 19

Laying Out a Project ..................................................................................................................... 19Using QuickNet to Lay Out a Project ........................................................................................ 19Using AutoCAD to Create a QuickNet Compatible DXF File.................................................... 23

Network Documentation ............................................................................................................... 25

Managing the Network Interface ........................................................................................... 27

Opening the Network Interface ..................................................................................................... 27

Closing the Network Interface ...................................................................................................... 27

Managing the Network Interface’s Channel .................................................................................. 27

Managing Your Network ......................................................................................................... 29

Adding or Deleting Domains ........................................................................................................ 29

Adding or Deleting Subnets .......................................................................................................... 30

Adding or Deleting Channels ....................................................................................................... 30The CHANNELS.TYP File....................................................................................................... 31

Adding or Deleting Hardware Types ............................................................................................. 31

OM 136 3

Viewing Network Properties......................................................................................................... 32Domain Properties.................................................................................................................... 32Subnet Properties ..................................................................................................................... 33Channel Properties ................................................................................................................... 34Hardware Types........................................................................................................................ 34

Network Topology........................................................................................................................ 34

Managing Nodes and Routers .............................................................................................. 36

Importing XIF Files ..................................................................................................................... 36

Removing XIF Files ..................................................................................................................... 37

Installing or Creating Nodes ........................................................................................................ 38Installing Nodes On-Line Using the Service Pin or Neuron ID ................................................. 38Installing Nodes Using Discover and Wink .............................................................................. 39Creating Nodes Off-Line .......................................................................................................... 40

Installing or Creating Routers ...................................................................................................... 41

Deconfiguring Nodes or Routers .................................................................................................. 41

Determining Node Specifications ................................................................................................. 41About the Network Address...................................................................................................... 42

Downloading Applications........................................................................................................... 43About Downloading ................................................................................................................. 44About Saving and Restoring Network Variable Configuration Data .......................................... 44Download Application Image Only .......................................................................................... 46Save Configuration, Download, Restore Configuration............................................................. 48Save Configuration Network Variables Only............................................................................. 49Restoring Configuration Network Variables Only ..................................................................... 50Windows Multi-select Convention............................................................................................ 51Download Wizard Messages Window....................................................................................... 51

Node Diagnostics ......................................................................................................................... 52Identifying a Node.................................................................................................................... 52Placing Nodes On or Off-line, Resetting................................................................................... 52Winking Nodes ........................................................................................................................ 52Testing Nodes........................................................................................................................... 52Replacing Nodes ...................................................................................................................... 53Updating Configured Router Forwarding Tables....................................................................... 54Querying Nodes ....................................................................................................................... 54

OM 136 4

Managing Individual Connections........................................................................................ 56

Creating a Connection .................................................................................................................. 56Setting Bind Options................................................................................................................. 58

Viewing Connections.................................................................................................................... 58

Adding Members to a Connection................................................................................................. 59

Deleting Members of a Connection ............................................................................................... 59

Advanced Connections: Graphical Template Binding Tools .......................................... 61

Template Design Tool ................................................................................................................... 61Definitions................................................................................................................................ 62Quick Start ............................................................................................................................... 62Creating a Template Database................................................................................................... 63Importing Template XIF Files................................................................................................... 64Removing Template XIF Files................................................................................................... 64Creating a Pattern ..................................................................................................................... 64Creating a Template.................................................................................................................. 65Adding Instances ...................................................................................................................... 66Adding Bindings....................................................................................................................... 66

Template Apply Tool .................................................................................................................... 68Definitions................................................................................................................................ 68Quick Start ............................................................................................................................... 68Adding and Removing Targets.................................................................................................. 69Applying a Template................................................................................................................. 69Undoing a Template.................................................................................................................. 69The Status Window................................................................................................................... 69Optimizing Bindings ................................................................................................................ 69Zero, One, and Multiple Targets................................................................................................ 70Caveats ..................................................................................................................................... 71

Browsing Network Variables ................................................................................................. 72

Creating a New Network Variable Browser File ............................................................................ 73

Opening an Existing Network Variable Browser File .................................................................... 73

Setting the NV Browser Update Interval Time .............................................................................. 73

Using the NV Browser.................................................................................................................. 74Displaying a Network Variable’s Current Value ........................................................................ 75Revising a Network Variable’s Value......................................................................................... 75

Appendix A: Error Message Dictionary ............................................................................... 78

Database Errors ............................................................................................................................ 78

Network Errors............................................................................................................................. 79

OM 136 5

Appendix B: The No Database QuickNet Wizard .............................................................. 82

General ........................................................................................................................................ 82About Downloading ................................................................................................................. 83About Saving and Restoring Network Variable Configuration Data .......................................... 84About Addressing..................................................................................................................... 85

Getting Started with the No Database Wizard............................................................................... 85Wizard Menus.......................................................................................................................... 86Messages Window.................................................................................................................... 86

Wizard Procedures ....................................................................................................................... 87Download Application Image Only .......................................................................................... 87Save Configuration, Download, Restore Configuration............................................................. 87Save Configuration Network Variables Only............................................................................. 88Restore Configuration Network Variables Only ........................................................................ 89Set Target Node’s Network Address ......................................................................................... 89Windows Multi-select Convention............................................................................................ 90Service Pin Messages from Pre-LonMark WSHP Controllers ................................................... 90

Appendix C: McQuay InternationalSoftware License Agreement (Single User Products)...................................................... 91

McQuay and MicroTech are registered trademarks of McQuay International.QuickNet and MicroTech 2000 are trademarks of McQuay International.All other trademarks are the property of their respective owners.

QuickNet was designed for McQuay International by IEC Intelligent Technologies.

©1997 McQuay International. All rights reserved throughout the world.

OM 136 6

IntroductionWelcome to QuickNet

TM, the premier LONWORKS

TM network management tool available. During its

development, QuickNet’s architecture and implementation were focused upon providing the greatestof ease for LONWORKS network installers, developers, and end users by providing a visuallyintuitive product to assist you with your network management requirements. It is implicitly assumedthat by purchasing this product, you are familiar with the LONWORKS nomenclature.

Product OverviewQuickNet was developed to provide intuitive LONWORKS technology network managementcapability. Primarily based on a graphical representation of LONWORKS networks using bit mappedbackground location images to represent your physical locations, icon images that represent yournodes, and the point-and-click approach to graphical user interfaces, QuickNet utilizes a graphicalrepresentation of physical and logical network associations, which provides you with a visual meansto quickly maintain and manage your networks. LONWORKS networks can be comprised of a fewnodes, or a complex system of nodes that interact. QuickNet provides you with a visual tool thatmanages an entire system, from node installation, binding and network variable browsing, toapplication performance optimization, while allowing you to navigate around your system andquickly develop your networks and applications.

Installing QuickNet on Your ComputerThe following hardware is required to install and run QuickNet:

• IBM-compatible machine with a 486 DX, 33 MHz processor minimum

• 5 megabytes free disk space

• A 3-1/2” floppy drive

• A VGA monitor or better

• At least 8 megabytes of RAM (16 megabytes or more recommended)

• Windows version 3.1 or Windows 95 (Windows 95 recommended)

• LONWORKS network interface hardware with its device driver installed

• If Windows 3.x, the Share utility must be installed

To install under Windows 3.x

1. Insert the distribution disk in drive A (or another logical disk drive).

2. From the File menu of the program manager, click Run.

3. Type a:setup.

4. Follow the setup instructions on the screen.

To install under Windows 95

1. Insert the distribution disk in drive A (or another logical disk drive).

2. From the Start menu, click Run.

3. Type a:setup.

4. Follow the setup instructions on the screen.

Technical SupportMcQuay International technical support is available between 8:00 AM and 4:30 PM Central time,Monday through Friday, excluding holidays.

Fax: 612-553-1667Voice: 612-553-5330

When you contact us, please be at your computer and have a detailed description of the problem.

OM 136 7

Getting Started

QuickNet provides you with great latitude in setting up your network management projects. You cancreate bit mapped images using a tool like Microsoft Paint to create icons that represent node types,or you can use our supplied bit maps for this purpose. Background images that represent locationscan be scanned or drawn using Paint or a similar tool, and then can be imported to represent yourphysical scenario. Location background images are not required, thereby allowing you to quicklystart to use QuickNet. Multiple locations are supported so that you can group your nodes logically asthey are physically located, and you can navigate easily amongst these locations. These screens areaccessible through menu commands, and the menus are laid out in a manner that allows you toeasily flow through the network management process.

To invoke QuickNet, double-click its icon from within the Windows 3.x Program Manager, or clickthe QuickNet Network Management Tool item under QuickNet on the Windows 95 Start menu.

To start your first project, you will have to log in. You can customize the password protectionmechanism, but you must first log in using the following default user initials and password:

User initials: MCQ (all upper case)Password: controls (all lower case)

To log in, click Login on the Project menu. Enter the user initials and password in the displayeddialog box and click the OK button.

Figure 1. Login Dialog Box

After you initially log in, you can create other user initials and passwords as described in the“Managing Projects” section.

The Main screen is your access to all of the functionality of QuickNet. QuickNet’s primary databaseentity is called a project. Each network management scenario will require its own project. Thisfeature allows you to maintain configuration control over each network with which you are working.

McQuay International’s software products are copyright protected. You must register the product bytyping in a registration password. On the Project menu, click Registration. McQuay Internationalwill provide you with your registration password.

Network Installation MethodsNetwork installation is comprised of creating a network database that contains a completerepresentation of the participating devices and their associated interactions represented as data pathconnections, and downloading the necessary information to the devices in your network so that theycan perform their required functionality.

QuickNet is capable of creating and/or modifying network database images while it is or is notphysically attached to your network (on-line or off-line network management). This means that youcan either set up a new or modify an existing installation database image without being physicallyattached to the network, and then download the installation parameters to your nodes and routersonce your computer is physically attached to the network. Conversely, you can physically attach yourcomputer to the network and install, bind and operate on your nodes and routers in real time.

OM 136 8

On-Line Network Installation and MaintenanceOn-line installation and maintenance offers the benefit that your installation database is alwaysconsistent with the physical network. To perform on-line installation and maintenance, you mustconnect QuickNet to your network via network interface hardware. You can then perform allnetwork management functions on the nodes and routers attached to the network.

The network interface hardware can be attached to any channel on your network; however, you musttell the network interface to which channel it is attached using the Network I/F menu. Once yournetwork interface has been attached, network management commands are compiled by QuickNetand sent to the destination nodes at the same time that the project database is updated, reflectingyour changes. This assures a consistency between your project and the currently managed network.

Off-Line Network InstallationYou can create a new network image or modify an existing network image without being physicallyconnected to the network with a network interface. When you perform network managementfunctions, the changes are stored in the network database image. To invoke these changes,physically attach a network interface to the computer on which QuickNet is running, and then openthe interface. When you click Manage Nodes and Routers on the Network Management menu, youwill be asked whether you want to update all affected nodes and routers. You can do so at that timeor at a later time.

Note It is highly recommended that after you have made changes to the network off-line, youupdate routers and nodes each time you attach to the affected network so that you maintainconsistency between the database and the network whenever you make off-line changes.

Graphical Template BindingWhen creating larger, more complicated networks, the bindings required in the system become moreand more complex. Creating the connections correctly, when many nodes may be involved, becomesvery difficult. Sometimes you will need to create a binding among a small number of nodes, but youwill need to do it in many different places with different groups of nodes. For example, you mayhave a building in which each room needs its network variables bound in a certain way. Or you maybe producing a pre-installed network for clients, and each network has the same connections. TheTemplate Design tool provides a way to create the bindings as a series of steps, and those steps canbe executed on any group of nodes.

To perform a template application, you must have a created template. You can use the templatedesigner to create the templates. The “Advanced Connections: Graphical Template Binding Tools”section discuss the use of QuickNet’s Graphical Template Design and Application tools.

Duplicating an InstallationYou can easily duplicate installations. This feature is useful if you want to exactly duplicateinstallations without re-entering the entire network management database.

Completely create the installation off-line, then using a file manager, create new project folders andcopy all of the files from the original project folder to the new project folders.

If the duplicate project’s network resides on a closed channel (i.e., there is no communicationleakage as is found on power line or RF channels), open the new project from within QuickNet andproceed with the installation as if the project were created off-line.

If the duplicate project’s network resides on an open channel, you must select a unique domain IDfor the nodes in the new project. When you open a duplicate project for such an installation, clickNetwork Objects on the Network Management menu and then select the Domains tab. Double-clickthe domain name from the Existing Domains list. This will bring up a dialog box showing thedomain’s attributes (see “Viewing Network Properties” in the “Managing Your Network” section).

OM 136 9

Simply change the domain’s ID and click the Modify button. Then proceed with the installation asif the project were created off-line.

QuickNet’s Main ScreenThe Main screen has a number of menu and sub menu selections. Certain menu functions areunavailable until you carry out other pre-related tasks. This feature helps you to “walk through” themanagement scenario, allowing you to only perform tasks which are applicable during the currentphase of the network management process.

Figure 2. Main Screen

Project MenuThe Project menu allows you to create a new project database, access existing project databases,delete existing project databases, create detailed network documentation, or exit QuickNet. It isfrom within this menu that you also log in and set up additional users’ passwords and accesscapabilities. The “Managing Projects” section describes these functions.

OM 136 10

Figure 3. Project Menu

Location MenuThe Location menu accesses the Location screen and the Icon toolbar, which allow you to customizeyour physical installation scenario. You can incorporate bit mapped images as a background for aparticular location, import bit mapped images to represent your nodes, lay out the nodes on yourscreen to represent their physical locations, and encapsulate locations (e.g., a building may be yourfirst location; its many floors can be represented by subsequent locations; a room on a floor can berepresented by still another location). The Icons toolbar is displayed on the left portion of thedisplay. The Icons toolbar supports node image importing, deletion, and selection for use in theLocation screen. The rest of the screen is called the Location screen. It is from within this screenthat you will create locations and assign specific icons to these locations. See “Laying Out a Project”in the “Managing Projects” section for more information.

OM 136 11

Network Interface Menu

Figure 4. Network Interface Menu

A typical example of the line of code in your CONFIG.SYS file may look like this (refer to yournetwork interface’s user’s guide to obtain the specifications and switches that you require):

DEVICE=C:\SLTA\LDVSLTA.SYS /A /P2 /D1

The network interface node is assigned default specifications. The default specifications represent azero length domain, the first subnet on this domain, a twisted pair FTT-10 channel operating at 78kbps, and a 5 MHz Neuron 3150 hardware property type. These defaults are represented inQuickNet’s database as:

• Domain: Zero Length

• Subnet: default_subnet

• Channel: FT-10 1 Reptr

• Hardware: 3150 5 MHz

The network interface must be assigned to the channel to which it is physically attached. The“Managing the Network Interface” section describes this process. New database recordsrepresenting other domains, subnets, channels, and hardware properties can be created and arediscussed further in the “Managing Your Network” section.

Network Management MenuThe Network Management menu is the key item to managing a LONWORKS network. It iscomprised of five distinct groups of functions categorized into sub menus.

OM 136 12

Figure 5. Network Management Menu

Network Objects Menu ItemThe Network Objects menu item allows you to create new domains, subnets, channel types, andhardware properties. You can also see a list of each of these data objects and ascertain all of therelevant properties for each of these data types. These functions are discussed in further detail in the“Managing Your Network” section.

Manage Nodes and Routers Menu ItemThe Manage Nodes and Routers menu item is your mechanism for managing the nodes and routerscreated within all of the locations in your project. By selecting this menu item, the Manage Nodesand Routers screen appears with its complement of menus. From this screen, the following functionscan be performed:

• Navigating through all locations

• Managing the network interface

• Creating, installing and deconfiguring nodes and routers

• Viewing node or router specifications and self documentation strings

• Downloading applications which fit in the Neuron chip EEPROM

• Importing and removing XIF files

• Finding nodes on a network

• Setting a node or router mode to on-line or off-line

• Resetting nodes or routers

• Winking nodes

• Testing nodes or routers and obtaining network images

• Replacing nodes or routers

These features are discussed in further detail in the “Managing Nodes and Routers” section.

OM 136 13

Manage Connections Menu ItemThe Manage Connections menu item allows you to bring up the Manage Connections screen, whichprovides an enhanced graphical representation of your connection (i.e., binding) configuration. Itallows you to create, modify, and delete network variable and message tag connections usingQuickNet’s creative graphical approach. This approach provides an intuitive depiction for all ofyour connections. You no longer have to keep a paper trail for your connection scenario, asQuickNet does this for you. Connections are created and then can be logically displayed, allowingyou to establish and maintain these connections quickly and easily. Connections can be viewedgraphically by simply clicking any node. The connection list can then be filtered to show allconnections between two nodes by clicking a second node. From this screen, the following functionscan be performed:

• Navigation through all locations

• Creation of network variable or message tag connections

• Modifications (additions or deletions) of members of connections

• Deletion of connections

• Bind specifications

• Graphical viewing of connections

These features are discussed in further detail in the “Managing Individual Connections” section.

Template Design and Template Apply Menu ItemsThe Template Design and Template Apply menu items allow you to pre-define network variablebinding patterns that will speed your installation process. You can create binding templates thatrepresent the connectivity amongst many node types, instead of performing the connectionsindividually. Then, by simply dragging and dropping the actual nodes onto these templates, theconnection sets are created and bound.

These features are discussed in further detail in the “Advanced Connections: Graphical TemplateBinding Tools” section.

Network Topology Menu ItemThe Network Topology menu item allows you to bring up the Network Topology screen, whichprovides an enhanced graphical representation of your network topology by showing you thechannels created for your installation and the nodes on those channels. From within this screen, youcan isolate any two channels by clicking the router icon connecting the two channels, isolate anyone channel by clicking the button next to the desired channel, or view the specifications for anynode or router by clicking the associated icon.

NV (Network Variable) Browser MenuThe NV Browser menu implements a utility that allows you to investigate values of all networkvariables on nodes, and to change the values for network variables that are inputs to nodes. Thisfunction has proven to be useful in an environment where you need to debug your networkapplications, or to establish application performance and optimization specifications.

You can get the current value of a network variable when you want, or you can use the UpdateInterval capability to display the value of the network variable at pre-defined time intervals. The NVbrowser function are discussed in further detail in the “Browsing Network Variables” section.

Window MenuThe Window menu is present on all major screens. It contains two menu items.

OM 136 14

Figure 6. Window Menu

The Memo Pad menu item invokes a text editor that allows you to store commentary information tofiles in your current project folder.

The System Resource menu item allows you to investigate available system resources (e.g., availablebytes free in memory).

OM 136 15

Graphical Representation of Node StatesBefore continuing, you must familiarize yourself with the appearance of node images. The nodeimages will display a square border that is color coded to represent the current state of the node. Theborder colors used and their meanings are described in Table 1.

Table 1. Graphical Representation of Node States

Border Color Meaning

Green The node has been selected for further operations by pointing and clicking with the left mouse button.

Many QuickNet commands require that you first select one or more nodes on the screen.

White The node has been installed and is thus in the configured state; the application is in the on-line mode.

The words “installed” and “configured” mean essentially the same thing. An installed or configured nodehas been given a subnet/node address in one or two domains. It may also have been given network variableor message tag binding information. This address and binding information is stored in the node’s networkimage. It is also stored in QuickNet’s network database along with the node’s Neuron ID and Program ID.

The application program is enabled in a node that is on-line.

Dark Blue The node is in the unconfigured or applicationless state.

An unconfigured or applicationless node has no network image; i.e., it has no address and no networkvariable or message tag bindings. An unconfigured or applicationless node has no record in QuickNet’snetwork database.

An unconfigured node has an application image (i.e., a program); an applicationless node does not. Before anode can be installed, it must have an application image. You can give it one by using QuickNet’sDownload wizard, identifying the nodes by Neuron ID or service pin.

Cyan Blue The node has been either created or modified while QuickNet was not attached to the network.

Creating a node is similar to installing a node; the difference is that only the database is affected since thenetwork interface is closed. Offline modifications to installed nodes (e.g., adding a network variableconnection) are also recorded only in the database. When the network interface is attached to the network,QuickNet gives you the opportunity to update the network images in the nodes that have been created ormodified.

Red The node is in the configured state, but the application is in the off-line mode.

The application program is disabled in a node that is off-line.

Uninstalling QuickNetQuickNet is distributed for use on a single computer. QuickNet’s distribution disks are speciallydesigned to only allow installation on a single computer. At some point it may be necessary to moveQuickNet to another computer. You can do this by inserting the last distribution disk in the floppydisk drive of the computer on which QuickNet is currently installed, and using a file manager, runthe program UNINSTAL.EXE in the QuickNet folder. Follow the instructions on the screen. Thisaction will not corrupt any existing projects. You can now install QuickNet on another computer.

OM 136 16

Managing Projects

Password ManagementQuickNet offers an extended password protection function that allows you to customize thefunctional access capabilities for different users of this tool. By setting initials and unique passwordsfor individuals or groups, you can selectively allow users to perform tasks.

To add a user, modify a user’s access capabilities, or delete a user from QuickNet, click Passwordson the Project menu. The Passwords dialog box will appear.

Figure 6. Passwords Dialog Box

Once users have been added, or access privileges modified, the changes take effect the next time thatuser logs in to QuickNet.

Note You can inhibit the login requirement by adding a special user password. From within theSetup Passwords dialog box, create a new user using the following parameters:

User initials: USR (all upper case)Password: access (all lower case)

Set the appropriate Access Properties (usually manager default access properties) for this specialcase. Make sure that at least one user has the Setup Passwords property selected.

Adding a UserTo add a user, type in the user’s initials, name, and password. At this point, you can select defaultaccess privileges or customize access capabilities. Either select one of the Defaults access types orselect the appropriate privileges from the Access Properties list. Press the Add User button toinclude this record in the password database.

OM 136 17

Deleting a UserTo delete a user, press the down arrow button under Initials and User Name. A list of current userinitials will be displayed. Click the user’s initials that you want to delete and press the Delete Userbutton. This user record is deleted from the password database.

Modifying a User’s Access PrivilegesTo modify a user’s access privileges, press the down arrow button under Initials and User Name. Alist of current user initials will be displayed. Click the user’s initials that you want to modify. Selector de-select the appropriate privileges from the Access Properties list. Press the Modify User buttonto modify the password database.

Working with ProjectsA new LONWORKS network management scenario requires that you create a project database. Theproject database will contain all of the information pertaining to this specific project. Thisinformation includes the network topology database and all related records, the location databasewhich contains all of the graphical representations of your installation scenario, and any number ofnetwork variable browser display files which contain saved information of nodes and networkvariables that you want to display and/or modify. Previously created projects can be opened, atwhich time all of the applicable information for that project will be imported.

QuickNet supports two methods for describing the geographic layout of your project. You canchoose to design the locations using the Location menu by importing bitmap backgrounds, thencreating and overlaying bitmap representations of nodes on your backgrounds. You can also importfiles that have been saved from AutoCAD into the DXF file format. You won’t have to duplicateinformation that you create in either package. QuickNet imports an AutoCAD DXF file, performsnetwork management, and exports LONWORKS logical layers directly into the AutoCAD file. Formore information, see “Laying Out a Project” below.

New ProjectsThe Project menu allows you to create a new project database, access existing project databases, orexit QuickNet. Clicking New on the Project menu will automatically generate all initial databasefiles required in a subfolder that you name in the New Project dialog box under the folder where youinstalled QuickNet.

When you select the New menu item, a dialog box appears asking you to provide a unique name forthe project. Type in a project name (limited to eight characters, following the DOS directory namingstandards).

It is at this point that you specify the type of project that you want to create. Choose the StandardFile Format option if you will use QuickNet’s location layout system. Choose the DXF File Formatoption if you will be importing a DXF file instead. There are certain prerequisites for using a DXFfile. Laying out a project, as well as the prerequisites for DXF files, are discussed in “Laying Out aProject” below.

Figure 7. New Project Dialog Box

OM 136 18

If you choose the DXF file format and click the OK button, a dialog box will appear requesting youto import the DXF file for this project.

Figure 8. Import DXF Files Dialog Box

In either project type, another dialog box will appear requesting you to import any LONWORKS XIFfiles required for your project.

Figure 9. Import XIF Files Dialog Box

You can import these files now or at a later time; however, if these files exist, it is recommendedthat you import the files at this time.

User-Defined Type FilesIf your project contains nodes that use non-SNVT network variables, you should copy two files intoyour project folder: USER.TYP and USER.ENM. These files define how the network variables arestructured and provide text labels. QuickNet’s NV Browser tool uses this information. If you do nothave the MicroTech 2000 USER.TYP and USER.ENM files, contact technical support.

Opening Existing ProjectsClicking Open on the Project menu brings up a dialog box containing a list of all existing projects.You can select any of these projects by double-clicking the project name and then selecting the Openbutton with the mouse, or by pressing ENTER on the keyboard. This will allow you to access a pre-defined project and perform all network management functions.

Pre-LonMarkMicroTech 2000heat pumps usemany non-SNVTnetwork variables.

OM 136 19

Figure 10. Open Project Dialog Box

Deleting ProjectsSelecting the Delete menu item opens a dialog box containing a list of all existing projects. You canselect any of these projects by double-clicking the project name and then clicking the Delete button,or by clicking the project name and then pressing ENTER on the keyboard. This action will delete allof the database structures associated with the pre-defined project.

Figure 11. Delete Project Dialog Box

Note Use the Delete Project function with care.

Laying Out a ProjectLaying out a project refers to designing the graphical images and locating them in such a way as toprovide an intuitive, geographical representation of your project. Projects can be laid out by eitherusing QuickNet’s internal layout system or by importing DXF files that were exported fromAutoCAD. If you choose to import a DXF file for this project, the Location menu on QuickNet’sMain screen becomes disabled.

Using QuickNet to Lay Out a ProjectThe first time that you click the Location menu on the Main screen for a newly created project, theNew Location dialog box will appear.

OM 136 20

Figure 12. New Location Dialog Box

Since this is a new project, no locations have been defined. You must enter a name for this locationby typing a location name in the text box. If you want to attach a background image that representsthe physical context of the location (e.g., a floor plan), you can select the bit map file by clicking theDrives, Directories, and Files list box items and then clicking the Attach button. If you do not wantto attach a background image, then simply click the No Drawing button. You can add a backgroundimage for this location at a later time by clicking Attach Drawing on the Location menu of theLocation screen. Node images are not required for any given location, thereby allowing you to havelocations that depict an overall perspective.

The Location screen will be subsequently displayed. The toolbar on the left side of the display iscalled the Icons toolbar. Its primary function is to allow you to select node images that representyour physical nodes and place them in a staging area on the Location screen. The Icons toolbar’ssecondary function allows you to import or delete images that represent (“look like”) yourapplication nodes. For more information, see “The Icons Toolbar” below.

OM 136 21

Figure 13. Location Screen, Lighting Example

The location name that you typed in will be displayed as the window title on the Location screen.

You can create another location by clicking New on the Location menu of the Location screen; theNew Location dialog box will then appear again.

Figure 14. Location Screen, Location Menu

OM 136 22

If the project was an existing project, you can navigate amongst the locations by clicking Next,Previous, or Select on the Location menu.

The Select menu item allows you to go to any location that has been previously defined.

You can delete an entire location using the Delete This Location menu item if all of the nodes on thelocation are in the unconfigured state.

The Nodes menu allows you to perform actions on individual nodes.

Figure 15. Location Screen, Nodes Menu

The Rename Node menu item allows you to rename a node or router without losing any networkimage information pertaining to the node. This means the node’s address and connections will notbe lost.

To delete a node image, the image must depict a node in the unconfigured state. This means theborder color of the node must be dark blue. (See “Graphical Representation of Node States” in the“Getting Started” section for more on border colors.) Configured nodes must first be deconfigured inthe Manage Nodes and Routers screen.

To locate a node within QuickNet, use the Locate Node menu item. This action will display a dialogbox showing all of the nodes within QuickNet’s database. Select a node from the list, and QuickNetdisplays the node in its location shown with a green border. QuickNet can also find and display anode when you press the node’s service pin. (See “Node Diagnostics” in the “Managing Nodes andRouters” section for more on identifying nodes.)

Selecting the Change Icon menu item allows you to assign a different bit map image to a node.

The Icons ToolbarOn the left side of the Location screen, you will see the Icons toolbar. This toolbar contains all of thenode type images that you create (using a tool such as Microsoft Paint) and import to the toolbar.You can import any of the “stock” icons supplied with QuickNet. This toolbar is a push-button setthat will allow you to select a certain type of node that you wish to position on your locationbackground image. When you press any of the node images on the toolbar, a copy of its image will

OM 136 23

be placed on the Location screen and a dialog box will appear asking you to type in a unique namefor this particular node. Once placed upon the background, these images will represent the physicalnodes associated with the location in your network application scenario. You can adjust theplacement of the node images by clicking and holding the left mouse button down in the specificnode image and dragging the image to the desired position on the screen. These images do notcontain any specific node properties as of yet; they only suggest the appearance of a type of node.

One type of node icon will be displayed when you create new projects. This node icon represents arouter node, since routers are common to many LONWORKS networks.

You can import bit mapped images that “look like” your application nodes, or you can use any of the“stock” image icons supplied with QuickNet. Node images must be created as bit mapped imagesdimensioned to 25 pixels in height by 25 pixels in width. You can create these images with a toollike Microsoft Paint, and they must be saved as 16-color bit map files.

To import either a “stock” bit mapped image or a bit map that you have created to graphicallyrepresent any of your nodes, simply select the File menu on the Icons toolbar and click the CreateNode Icon menu item. The Create Node Icon dialog box will appear. Select the drive, directory(folder), and file for the bit mapped image that you want to represent a specific node type. There aremany “stock” icons available.

Figure 16. Create Node Icon Dialog Box

If you want to delete a node type from the toolbar, select the Delete Node Icon menu item on the Filemenu of the Icons toolbar. Then click the node image on the toolbar to remove the item from thetoolbar. This action will not delete nodes from the network; it will only remove the node image fromallowed selections on the toolbar.

The Location ScreenThe Location screen’s primary function is to allow you to encapsulate information. You can createlocations that depict the physical representation of your network, from a broad to a focused scale.You can import background images and position nodes so that they appear in the positions wherethey actually exist. You can easily navigate amongst locations by using the Location menu.

Using AutoCAD to Create a QuickNet Compatible DXF FileQuickNet supports the visual representation of network management projects created usingAutoCAD generated DXF files in almost exactly the same way that it does for its internal layoutsystem.

When QuickNet imports a DXF file for the first time, it adds two layers to the drawing. These layersare called LONObject and LONLogical. QuickNet will not modify any information on any other

OM 136 24

layer. The LONObject layer is used to store text that describes properties for each individual node.The text is placed to the right of each of the nodes or routers as it is either installed or created. Theproperties contained on this layer include:

• Device Name

• Neuron ID

• Program ID

• Channel Name

• Hardware Type

• Location

• Domain Name, Subnet Name

• Subnet/Node IDs

Also contained on this layer at the upper left corner of the drawing is a list of all the channelsproperties created for this project. The properties listed include:

• Channel Name

• Bit Rate

• Minimum Clock

• Number of Nodes

The second layer that QuickNet creates, the LONLogical layer, is used to store text that describesconnections between nodes. This text is placed below each of the nodes that participate inconnections. The information that is listed includes:

• Connection Name

• Variable Name

• Direction

These two layers are stored back in the original DXF file. The original DXF file was copied prior toany changes using the suffix “000.” For example, if the original file was called OFFICE.DXF, theunmodified copy is called OFFICE.000.

When creating projects using QuickNet in the AutoCAD mode, there are a few prerequisites thatmust be established when creating the DXF file that QuickNet expects. AutoCAD terminology willbe used:

• The AutoCAD drawing must be saved as a “DXF” file. QuickNet will import this file, and onceQuickNet has modified the file, you can then re-import it into AutoCAD for further editing.

• When you create objects within AutoCAD that are to be designated as LONWORKS Objects, youmust create and assign two new attributes: LONTYPE and LONNAME. The LONTYPEattribute must be assigned either “LONDevice” for a node on the network or “LONRouter,”which indicates a router, for each individual LONWORKS object. You must also assign aLONNAME attribute for each individual LONWORKS object. The value assigned to theLONNAME attribute can be any alphanumeric text string limited to sixteen characters. You canhave as many attributes as you require.

When using AutoCAD DXF files, it is not necessary to create locations within QuickNet. All of thegraphical information is contained within the AutoCAD DXF file; therefore, the Location menu onQuickNet’s Main screen is disabled.

When QuickNet imports a DXF file, it assigns a colored border to each of the LONWORKS objectsthat it finds. It does this by checking each object for the LONTYPE attribute. The border colorindicates the current state of the object as it normally does in QuickNet.

Once you select the Manage Nodes and Routers or the Manage Connections menu items, a toolbarwill be displayed. The toolbar allows you to navigate around the imported DXF file. On the toolbar

OM 136 25

(from left to right) you can select nodes, zoom to the full extent of the drawing, zoom in or out, pan,or select the drawing layers that are displayed.

Figure 17. Manage Nodes Screen, DXF Project

When you view the DXF file from within QuickNet, most of the functionality is performed by usingthe mouse to select objects or perform viewing functions. If you click an object in the Selectionmode, the object’s border color turns green. (See “Graphical Representation of Node States” in the“Getting Started” section for more on border colors.) All network management tasks are performedexactly as they would be if you used QuickNet’s layout system. If you right-click an object, a dialogscreen appears that displays the attributes assigned to the object. You can also see the LONNAMEthat you assigned to the object here.

If you select the Zoom function, left-click the mouse to zoom in or right-click to zoom out. Allzooming is performed with respect to the mouse cursor position. For example, if you left-click themouse and the mouse cursor is at the lower right of the screen, this point will then be centered inthe screen, and the zoom action will be performed.

Panning is performed by selecting the Pan function. To pan, simply press the left mouse button anddrag the mouse cursor to a different location on the screen.

Note All network management functions are performed when you select objects, so remember toreturn to the selection mode before performing these activities.

Network DocumentationIf you click Document Network on the Project menu, a screen will appear that allows you greatlatitude in viewing or printing the network database. The network database is partitioned intosixteen different categories. Some categories—such as Nodes, Domains, Subnets—showfundamental building blocks for your network. Other categories—such as Connections: Nodes In,Group: Nodes In, Node: Connections To—represent the many-to-many relationship amongst thefundamental blocks. For example, if you select the tab marked “Connections: Nodes In,” a drop

OM 136 26

down list will appear. By selecting a specific connection by name, you will see all of the nodesparticipating in that connection, as well as other pertinent information.

Figure 18. Document Network Screen

You can use Project Documentation when debugging a network. For instance, you can verify thatyour network variable or message tag connections produce the desired results in the database,which, of course, represents the actual network.

You can obtain hard copies of the information displayed by clicking Print on the File menu whilethe Project Documentation screen is active. The Print Options dialog box will appear. It is fromwithin this dialog box that you can selectively choose the information that you want to print. TheApply button allows you to save the selected configuration, and the Print button formats and sendsthe selected items to the printer.

Note A small project can provide a great deal of information when it is cross-referenced in the waythat is shown in the Document Network screen. Do not print the documentation for an entire projectunless you want to tie up your printer for a long time. Try printing one item in each category to get afeel for the quantity of information and to discern the information that is relevant to your needs.

OM 136 27

Managing the Network Interface

In order to communicate with your LONWORKS network, you must connect to the network a nodethat serves as the interface between your PC and the network. This node is referred to as the networkinterface. This node must be an Echelon SLTA or an equivalent device. A device driver thatrecognizes network message traffic must be incorporated in your CONFIG.SYS file. Following is anexample of what the line of code in your CONFIG.SYS file may look like (refer to your networkinterface’s user’s guide to obtain the specifications and switches that you require):

DEVICE=C:\SLTA\LDVSLTA.SYS /A /P2 /D1

A message bar is displayed at the bottom of all of QuickNet’s main screens. One of the elementswithin the message bar is a rectangular box that is colored either red or green. The box displays thestatus of the network interface. When the network interface rectangle is red, the network interface isclosed. A green state indicates that the network interface is open. The colored state of this rectangleshould be monitored so that you know whether you are performing network management tasks on-line or off-line.

Opening the Network InterfaceThe network interface can be opened by using its logical device name. QuickNet has eightpredefined logical device names to choose from, or you can type in the logical name yourself. Thisallows you the latitude of selecting PCMCIA, PCLTA, or third party network interfaces. Theparticular logical network interface name is defined by the command line that you incorporatedwithin your CONFIG.SYS file for the network interface device driver as described above.

To open the network interface, click Open on the Network I/F menu of the Main or Manage Nodesand Routers screen. Select either one of the predefined logical names from the drop down list, ortype the name into the Interface Name text box. Then press the OK button. Once the networkinterface has been successfully opened, the network interface rectangle in the message bar willchange to green.

Figure 19. Open Network Interface Dialog Box

Closing the Network InterfaceBy selecting the Close menu item on the Network I/F menu, you will disconnect the networkinterface from QuickNet. All subsequent network management functions that are performed will bein the off-line mode of operation. Once the network interface has been successfully closed, thenetwork interface rectangle in the message bar will change to red.

Managing the Network Interface’s ChannelThe network interface must be attached to the channel from which you want to send networkmanagement commands.

To attach the network interface to a different channel, click Manage on the Network I/F menu of theMain or Manage Nodes and Routers screen and select the channel that you want to connect to thenetwork interface.

OM 136 28

Figure 20. Manage Network Interface Dialog Box

OM 136 29

Managing Your Network

Once your network architecture has been conceptually designed, you can create database recordsrepresentative of this architecture. Domains and subnets logically group nodes within your network.On a multi-channel network, channel types specify communication parameters used by every nodeto allow successful communication between nodes existing on channels near and far from the sourcenode. A node’s hardware properties must also be established. These operations are performed byusing the Network Objects menu item on the Network Management menu of the Main screen.

The Network Objects menu item allows you to create or list network parameters. When you clickthis item, a property sheet will appear containing four new tabs. There is a tab for each of thefollowing objects:

• Domains

• Subnets

• Channels

• Hardware Types

They allow you to add or delete an object, or see a list of the existing objects and their properties.Clicking the Add button in each of these screens will automatically create a new record in thedatabase reflecting the desired properties. Once you have defined a new record, you can either createanother new record or exit by pressing the Close button.

Adding or Deleting DomainsTo add a new domain, select the Domain tab, type in a unique domain name, select a domainidentifier length to either one, three or six bytes, and then set the domain ID. The ID can be anyhexadecimal number of the selected length. Press the Add button to add the new domain record.

Figure 21. Network Objects Dialog Box, Domains Tab

To delete a domain, click the domain in the Domains list box and then press the Delete button.

OM 136 30

Adding or Deleting SubnetsSubnet records must be associated with a specific domain. To add a new subnet, select the Subnettab, type in a unique subnet name, and then associate this subnet with a domain by clicking thedown arrow for the Domain to Add To list box and selecting the desired domain. Press the Addbutton to create a new subnet record.

Figure 22. Network Objects Dialog Box, Subnets Tab

To delete a subnet, click the subnet in the Subnets list box and then press the Delete button.

Adding or Deleting ChannelsChannel records associate communication parameters with a channel and are used in computingthese parameters, which are downloaded to nodes at binding time so that they can communicate toall other nodes in the network effectively. To add a new channel, select the Channel tab, type in aunique channel name, and select the channel type. Press the Add button to create a new channelrecord.

OM 136 31

Figure 23. Network Objects Dialog Box, Channels Tab

To delete a channel, click the channel in the Channels list box and then press the Delete button.

About FTT-10 Channel TypesMicroTech 2000 products use FTT-10 transceivers, which means that the channel type must alwaysbe an FTT-10 type. You’ll notice that the available types range from “FTT-10 1 Reptr” to “FTT-105 Reptrs.” The “Reptr” abbreviation refers to a physical layer repeater. A physical layer repeatercontains back-to-back transceivers, but no Neurons. It is not a router. The channel type shouldreflect the number of physical layer repeaters on the channel, with the exception that the “FTT-10 1Reptr” type should be used when there are no repeaters as well as when there is one repeater.

Note The default channel name, “FTT-10 1 Reptr,” is identical to the channel type. If anadditional type FTT-10 1 Reptr channel must be defined, just give it any name; e.g., “FT2.”

The CHANNELS.TYP FileIncluded within the QuickNet installation folder is a file called CHANNELS.TYP. This file containsa list of parameters that define LonTalk communication media (e.g., twisted pair, power line). If youare using a communication medium not listed in the Channels list box when creating channels, youmust contact the vendor of the transceiver to obtain the appropriate parameters. If you print a copyof the CHANNELS.TYP file, you will see blocks of lists of parameters required for each channeltype. Edit the CHANNELS.TYP file carefully, following the syntax used for previously definedchannels.

Adding or Deleting Hardware TypesHardware type records simply specify the type of Neuron chip and at what clock rate the particularnode is running. They are also used in the calculation of communication parameters that aredownloaded to nodes at installation time. To add a new hardware type, select the Hardware Typestab, enter a unique hardware type name, and then select the Neuron chip model and its clock rate.Press the Add button to create a new hardware type record.

The MicroTech 2000 heat pump controller uses a Neuron 3150 with a 5 MHz clock rate.

OM 136 32

Figure 24. Network Objects Dialog Box, Hardware Types Tab

To delete a hardware type, click the hardware type in the Hardware Types list box and then press theDelete button.

Viewing Network PropertiesAll of these records can be viewed by selecting the Domains, Subnets, Channels, or Hardware Typestab from the Network Object property sheet. When the appropriate tab is selected, a list box displaysall of the currently established network entities. If you double-click an entry in the list, a new screenappears containing pertinent information for that entity type (domain, subnet, etc.).

Domain PropertiesIf you double-click an entry on the Domains tab, you will see the following items:

• Domain name

• Domain ID

• Number of groups assigned to this domain

• Number of subnets assigned to this domain

• Number of network variable connections assigned to this domain

• Number of message tag connections assigned to this domain

OM 136 33

Figure 25. Domain Specifications Dialog Box

You can use this screen to easily duplicate installations. To do so, completely create the installationoff-line, then using a file manager, create new project folders and copy all the files from the originalproject folder to the new project folders.

It is always safest to select a unique domain ID for which nodes existing within the new project willcommunicate. This way, you are guaranteed that nodes in different projects will not interfere withone another. Simply change the domain’s ID and press the Modify button. Then proceed with theinstallation as if the project were created off-line.

Subnet PropertiesIf you double-click an entry on the Subnets tab, you will see the following items:

• Subnet name

• On domain

• Subnet ID

• Number of nodes on this subnet

Figure 26. Subnet Specifications Dialog Box

OM 136 34

Channel PropertiesIf you double-click an entry on the Channels tab, you will see the following items:

• Channel name

• Channel ID

• Channel bit rate

• Minimum clock rate

• Average packet size

• Number of nodes on this channel

Figure 27. Channel Specifications Dialog Box

Hardware TypesIf you double-click an entry on the Hardware Types tab, you will see the following items:

• Hardware type name

• Neuron model

• Clock rate

Figure 28. Hardware Property Specifications Dialog Box

Network TopologyThe Network Topology screen gives you an enhanced graphical representation of your networktopology by showing you the channels created for your installation and the nodes on those channels.Notice that the uppermost channel is always the channel to which the network interface is attached.

OM 136 35

Figure 29. Network Topology Screen 1

From within this screen, you can isolate any two channels by clicking the router icon connecting thetwo channels, isolate any one channel by clicking the button next to the desired channel, or view thespecifications for any node or router by clicking the associated icon. This view is extremely usefulwhen debugging communications failures by showing the actual signal paths.

Figure 30. Network Topology Screen 2

OM 136 36

Managing Nodes and Routers

Note All routers should be installed prior to node installation to assure correct communicationparameter calculations will be downloaded to the nodes.

To enter the node management screen, click Manage Nodes and Routers on the NetworkManagement menu of the Main screen. If nodes or routers have been created or modified off-lineand QuickNet has subsequently been attached to a network, you will be notified that some node orrouter configurations have changed and you will be queried as to whether you want to update thosechanges. It is highly recommended that you do so that the database accurately reflects the network.

If you created this project using QuickNet’s location layout system, the Manage Nodes and Routersscreen is automatically set to the last location in which you were working. To navigate amongst theother locations that you previously defined, use the Location menu. If you imported a DXF file whenyou created this project, the DXF drawing is set to its full extent, and you can navigate around thedrawing by using the zoom and pan toolbar.

Nodes and routers are managed by using the graphical context of QuickNet. By simply pointing andclicking a node image, many functions can be performed. You can select single nodes or multiplenodes by pointing and clicking, or you can select all nodes that are unconfigured, created, orconfigured from a sub menu under the Location menu. QuickNet knows whether the node that youselected is a router or an application node.

Clicking a node image selects the node for further activities. The border for the node image willchange to green. Double-clicking any node image will display the Node Specifications dialog box,which provides you information pertaining to the particular node such as:

• Node name

• Neuron ID

• Program name

• Neuron type

• Subnet 1 name

• Subnet 1 node number

• Subnet 2 name

• Subnet 2 node number

• Channel name

• Hardware properties

• Location string

At this point, you may notice that each of the nodes is surrounded by a thin dark blue border. Thisindicates that the nodes have yet to be installed or created. When you perform the installationprocedure, this border will disappear (i.e., turn white), providing you with a visual indication thatthe node has been installed.

Note It is important that you import all LONWORKS external interface files prior to installing newtypes of nodes. QuickNet will upload the required information from the node if necessary.

Importing XIF FilesTo import XIF files that are not already included in the database, click Import XIF File on theManage Nodes menu. Select the drive, directory (folder), and file path for the XIF file that you wantto import. Either double-click the file name or press the Import button to complete the action. Pressthe Close button after you have imported all desired XIF files.

OM 136 37


Removing XIF FilesWhen you remove an XIF file, you are actually deleting a number of records from the database. Anindividual XIF file represents the program name associated with a given node type, so you willactually be removing this program name and all of the records associated with this program type,including network variable and message tag definition records. Therefore, it is imperative that nonodes using this program exist on your network when you perform this function. QuickNet willnotify you if nodes using this program exist.

To remove program records, click Remove XIF File on the Manage Nodes menu. Select the programthat you want to remove from the database. If any nodes with this program name exist on yournetwork, you will be informed and the request will be aborted.

Figure 32. Remove XIF File Dialog Box

OM 136 38

Installing or Creating NodesQuickNet allows you to perform either on-line or off-line installations. The process is similar foreither method. QuickNet provides three choices for installing nodes:

• Service pin installation

• Neuron ID installation

• Discover and wink installation

To install or create a node or router using either the service pin or Neuron ID method, click one ormore node or router icons and select the Install or Create Nodes or Routers menu item on theManage Nodes menu. This action will bring up either the node or router installation or creationscreen. For more information, see “Installing Nodes On-Line Using the Service Pin or Neuron ID”and “Creating Nodes Off-Line” below.

To use the discover and wink method, click Discover Nodes on the Manage Nodes menu. For moreinformation, see “Installing Nodes Using Discover and Wink” below.

Installing Nodes On-Line Using the Service Pin or Neuron IDThe Install Node screen allows you to select a method of installation. You can install nodes either bypressing the service pin on the node or by manually entering the node’s Neuron ID. Click theappropriate button for the installation method you desire. If you select the Neuron ID method, a textbox will appear. You must enter the Neuron ID of the node to be installed within the displayed textbox.

The image of the node or router that you are installing will be displayed at the top of the screen. TheInstall Node screen requires you to select a channel and hardware type to associate with this node.This is done by clicking the down arrow next to each of these list boxes, and selecting theappropriate type name. All nodes must be assigned to at least one subnet, and can be assigned to twosubnets (in different domains). You must select one or both of these subnets by clicking theappropriate arrow for these list boxes and selecting subnets for association with this node. You canalso add an optional six character location string in the Location text box if you desire. This stringis only used for your reference and is downloaded to the node, but performs no functionality withregard to the network.

Figure 33. Install Node Dialog Box

The Install Node screen allows you to download the communication parameters for the selectedchannel to the node. This function is used if you have a node that can be reconfigured with differenttransceivers and the default communication parameters loaded into the node do not match those of

OM 136 39

the transceiver. To perform this action, select the Load Comm Parameters checkbox. In mostsituations with McQuay International nodes, this check box should remain unchecked.

Caution If you choose to load the communications parameters into a node, you will change theparameters that are currently loaded in the node. This can result in the loss of communications tothis node. Please double check the channel type and hardware properties that you have selected. Useextreme caution if you wish to proceed.

Once all of the node’s properties have been selected, press the Install button. If the installationmethod that you selected was the service pin method, you will be asked to press the service pin onthe node to be installed (or generate a service pin message in some other way; see note below).When you have pressed the service pin, the node will be automatically installed and placed in theconfigured, on-line state. If you use the Neuron ID of the node, QuickNet will perform theinstallation immediately. The border surrounding the node image will disappear, indicating that thenode has been installed.

Note For pre-LonMark MicroTech 2000 water source heat pump controllers, it is possible togenerate a service pin message—which contains the node’s Neuron ID—using the tenant overrideswitch on the wall sensor instead of the service pin button on the controller board, which is oftendifficult to access. However, to use this method, the node must be configured.

Installing Nodes Using Discover and WinkInstalling nodes using the discover and wink method requires that the network interface be attachedto the network. QuickNet will search the network and discover all nodes on the selected domain thatare in the unconfigured state. You can filter the search so that only nodes containing the selectedprogram respond. When you click Discover Nodes on the Manage Nodes menu, the dialog boxshown in Figure 34 will appear.

Figure 34. Discover Nodes Dialog Box

The Filter option allows you to select either Program ID or None. By selecting a Program ID fromthe combo box, only unconfigured nodes on the selected domain containing the selected Program IDwill be discovered. By selecting None, all unconfigured nodes on the selected domain will bediscovered.

OM 136 40

QuickNet can only discover nodes on the selected domain. The From Domain combo box allows youto select the domain on which you want to discover nodes. (This box does not appear when only onedomain is defined.)

Once you have selected a Program ID (or None) and a domain, press the Discover Nodes button.This action will send a discover command to the network. The result is displayed in the list on thelower right of the dialog box.

Below the From Domain combo box is a list that contains all of QuickNet’s node icons that are inthe unconfigured state and the location that contains these icons. When you select an item from thislist, it is the target for the assignment of a discovered node.

Discovered nodes are presented in the list to the right. This list shows all of the discovered nodes onthe selected domain, according to the filter option, by Program ID and Neuron ID. Select one of thediscovered nodes and then press the Wink button. This will issue a wink command to the selectednode. If the node responds correctly, press the Configure button to complete the installation. Youcan select and wink any discovered node in the list until the correct node is found. You don’t have towink the node if you know its Neuron ID. Just select it from the list and press Configure.Press the Refresh button to begin a new search for unconfigured nodes.

Note For pre-LonMark MicroTech 2000 water source heat pump controllers (WHPE10 –WHPE1C), it is not possible to install nodes using the discover and wink method because theprogrammed wink effects (fan cycling, LED flashing) will not execute when the node isunconfigured.

Creating Nodes Off-LineThe procedure for creating nodes off-line is similar to installing nodes on-line with the exceptionsthat you have to associate an application program for the node and you are not required to provide aNeuron ID or press a service pin. You are not yet associating the node with a physical piece ofhardware; however, you must tell the database what the functionality of the node is by selecting theprogram name. After you press the Create button, the node is surrounded with a cyan (light blue)border. This indicates that the database has been updated to reflect that the node exists and theconfiguration is ready to be downloaded to the actual node on the network.

Figure 35. Create Node Dialog Box

OM 136 41

Installing or Creating RoutersThe Install Router and Create Router screens are similar to the Install Node and Create Nodescreens; however, because routers connect two different channels, more parameters must bespecified. You select the router’s parameters in much the same way that you defined the propertiesfor the install node scenario. First select the router type, which defaults to Repeater, then select theother parameters to reflect the network architecture.

Figure 36. Install Router Dialog Box

You will notice that you can select two subnets for each side of the router. Only the first subnet fieldfor each side of the router must be selected; however, if the network architecture has two domains,the second set of subnet fields can also be specified.

Deconfiguring Nodes or RoutersTo deconfigure nodes or routers, click one or more node or router icons and then click DeconfigureNodes Or Routers on the Manage Nodes menu. You will be asked to confirm each node or routerdeconfiguration. The node icon will be surrounded by a dark blue border, indicating that the nodehas been placed in the unconfigured state.

Note This action will remove the node or router from any existing connections and update thenetwork image on all other affected nodes. Also, if you deconfigure a node while the networkinterface is not attached, the node will be removed from the database, but the node on the networkwill still retain its network image.

Determining Node SpecificationsYou can see certain node properties by double-clicking an individual node or router or by selecting anode or router and clicking Node Specs on the Manage Nodes menu. This will display a screen thatshows subnet/node information pertaining to each node selected.

OM 136 42

Figure 37. Node Specifications Dialog Box

If you select the Self Docs button on this screen, a subsequent screen shows the node’s selfdocumentation information.

Figure 38. Node Self Documentation Screen

About the Network AddressIn the LONWORKS world, the network address is intentionally kept “behind the scenes.” Nodes andsubnets (and domains) are intended to be identified by a user-specified name. As a result, the useror installer is given no control over the exact address assignment; it is all handled automatically bythe database program (e.g., QuickNet). The program assigns a logical address to each subnet whenit is created and to each node when it is either created or installed. The program always assignsaddresses in sequential, consecutive order. If a node is installed (or created) and then subsequentlydeconfigured, the program will go back and reuse that address when the next node is installed (notnecessarily the deconfigured node).

OM 136 43

Note that this behavior can cause problems for monitoring and control programs or nodes (e.g.,keypad/displays) that rely on addresses instead of the node names in the database. The node namesalways stay the same (unless you choose to rename them), but the addresses can shift. This shiftingcan only occur as a result of two or more previously installed nodes being deconfigured at the sametime.

Using the Node Specifications dialog box is the fastest and easiest way to find out what a node’snetwork address is. (The subnet address is labeled “Subnet x ID” and the node address is labeled“Node Number.”) See Figure 37.

Downloading Applications

Note To perform a download operation, QuickNet must be attached to a network via a networkinterface.

QuickNet’s Download wizard guides you through the steps required to download applications tonodes, save network variable configuration data, or restore network variable configuration data. Tostart the wizard, click Download Application on the Manage Nodes menu of the Manage Nodes andRouters screen.

When you invoke the wizard, you will be given the choice to perform one of the following sequenceof actions for one or more nodes:

1. Download a new application only

2. Save configuration (input) network variables prior to, and restore their values afterdownloading a new application

3. Save configuration (input) network variables only

4. Restore configuration network variables only

Figure 39. Download Wizard

The following table summarizes the available options in light of pre- and post-download node statesand network image retention.

OM 136 44

Table 2. Download Wizard Option Summary

DownloadWizard Option

Pre-actionnode state

Use this nodeidentificationmethod

Do you want toretain networkimage?

Must target nodeand new ProgramIDs match?

Post-actionnode state

Download only Applicationless Neuron ID orService pin

N/a (deselectcheckbox)

N/a Unconfigured

Unconfigured Neuron ID orService pin

N/a (deselectcheckbox)

No Unconfigured

Configured Node name,Neuron ID, orService pin

No No Unconfigured

Yes Yes Configured

Save, download,restore

Configured Node name Yes (required) Yes Configured

Save only Configured Node name N/a Yes Configured

Restore only Configured Node address N/a No (see note) Configured

Note: When restoring network variable configuration data, the saved network variable structures must match the external interfacesof the programs in the target nodes. In other words, for a given configuration file, the external interface that existed in the node whenthe file was created must be identical to the one in the node when the restore is performed. You can be assured of this if the node’sProgram ID has not changed since the save, but this is not a requirement; i.e., the external interfaces might be identical even whenthe Program IDs are different. If you’re not sure, check with the node software supplier.

About DownloadingThe Download wizard can download applications to nodes that are in the applicationless,unconfigured, or configured state. This wizard is unique in that you can download the sameapplication to many nodes in one simple process. This eases the network management scenariowhen you need to update multiple nodes. After selecting the nodes to be updated, you can let theDownload wizard perform all of the download operations automatically while you perform othertasks.

For nodes that are either applicationless or unconfigured, the application is downloaded and thenode is placed in the unconfigured state. For nodes that are configured (i.e., installed), theapplication is downloaded and the node either remains configured or is placed in the unconfiguredstate, depending on what you want. Configured nodes have a network address and may or may nothave network variable bindings. (Address and binding information is set and stored in a node’snetwork image.)

During a download the Download wizard is able to retain the network image, but to do this the oldand new Program IDs must be identical. You can specify whether or not you want the wizard toretain the network image with the “Retain Net Image” checkbox. If you choose to retain the networkimage, the nodes remain configured after the download. If you choose not to retain the networkimage, the nodes are deconfigured after the download and all other nodes that are affected by thisaction are updated.

About Saving and Restoring Network Variable Configuration DataThe Download wizard can be used to save and restore node application configuration data that isstored in input network variables. This data, which is usually different than the factory defaultvalues, might include user-adjusted temperature setpoints or factory-adjusted parameters that areunique for each unit (e.g., brownout trip point settings). Saving and restoring can be done inconjunction with a download or separately, e.g., for backup purposes.

How Saving WorksWhen you select an option that saves configuration data, the wizard polls the first node in the targetlist for all of its input network variable names. It then presents this list to you so that you can chooseonly those whose values you want to save. If you have more than one node in your list of targetnodes, the wizard assumes that the variables in the first node are the same in all specified targetnodes. It is up to you to assure that all target nodes are of the same type (identical external

OM 136 45

interfaces). The easiest way to do this is to assure that all target node have the same Program ID.Common network variable selection is done to make the process faster—you don’t have to reselectthe same variables over and over for a group of identical nodes. If you have two or more types ofnodes, you will need to perform separate save operations for each group of similar nodes.

Even though you select the variables once for a group of nodes, the program automatically stores thedata in those variables for each individual node. The data for each node is stored in a separate STOfile on the hard disk. The files are named according to each node’s subnet/node address; e.g.,S001N002.STO is the file for the node at address 001/002.

The save operation only works on configured nodes. Since configured nodes have node names, thewizard requires that you select the targets with the node name identification method. See the saveprocedures below for more information.

How Restoring WorksWhen you select an option that restores configuration data, the wizard finds the target node bydeciphering the subnet/node address from the STO file name. This means that the target node mustbe configured. It is up to you to assure that the external interface in the target node matches theexternal interface that existed in the node when the STO file was created. (An external interfacedescribes the number, type, and structure of the node’s network variables.) See “RestoringConfiguration Network Variables Only” below for more information.

Saving and Restoring Data for Pre-LonMark MicroTech 2000 Heat Pump ControllersWhen upgrading code for pre-LonMark MicroTech 2000 heat pump controllers, we recommendsaving and restoring the following 10 network variables:

• nciOccRmHtgSpt• nciOccRmClgSpt• nciUnitTimeSched• nciRmSptAdjSpan• neiOptionalOuts• nciUnitType• nciRoomTDiffSpt• nciBrownoutSpt• nviRunHours• nviCompStarts

You can save more than these if you’d like, but do not save the nviAddrAssign variable. If you do,the node’s subnet/node address will be set to 000/000 when the variable is restored.

Even though one network variable was added at version WHPE1B (changing the external interface),testing has confirmed that it is safe to save variables and then restore them to any of the followingupgraded code versions: WHPE1A, WHPE1B, or WHPE1C (see note below).

Note As stated above, the save, download, and restore option will not allow you to change a targetnode’s Program ID during its operation. This is an inherent constraint of LONWORKS. To upgradethe code and save/restore the configuration data, you can use this procedure (node reinstallation isrequired):

1. Assure that there are no gaps in the node address sequence for the subnets you will be workingwith.

2. Perform save-only operations for all nodes you want to upgrade. You can specify in groups ifthe target nodes have the same Program ID.

3. Perform a download-only operation for each target node individually; i.e., do not specify agroup of target nodes. Deselect the “Save Net Image” checkbox. After each download, reinstallthe node before going on to the next node.

4. Perform a restore-only operation for all target nodes. You can specify all target nodes at once bymulti-selecting the STO files.

OM 136 46

Download Application Image OnlyThis operation downloads an application program (NXE file) stored on your PC’s hard disk or afloppy disk into one or more specified nodes. The nodes can be in the applicationless, unconfigured,or configured state.

To download

1. Select the Download Application Image Only option button.

2. Click the Next button.

3. Using the three tabs, specify the target nodes using one of the following methods:

• Node Name: Select one or more configured nodes by clicking the node image inQuickNet’s Manage Nodes and Routers screen. Once you have added nodes to the NodeName tab list, select one or more nodes from the Node Name tab list and click the Addbutton to add them to the Target Nodes list. The items that are placed within the TargetNodes list are those on which operations will ultimately be performed. You can traversemultiple location screens to perform the selection. Note that this method of selection canonly be used on configured nodes. (Configured nodes have been installed, and thus theyhave a network image and database records.)

• Neuron ID: Type a Neuron ID and click the Add button to add it to the Target Nodes list.Note that the Neuron ID method can be used in conjunction with the service pin method.

• Service Pin: Press the service pin button on each node you want in the Target Nodes list.The Neuron ID received from the node will automatically be added to the list. Note that theservice pin method can be used in conjunction with the Neuron ID method.

Figure 40. Download Wizard, Node Name Screen


5. Specify the location of the external interface file for the application program you want todownload.

Select the drive, folder (directory), and XIF file from the list boxes.

Note If the nodes are configured and you’re planning to retain the network image, the name ofthe new XIF file can be different from the one for the XIF file that was originally imported.(The original file name appears in the Node Specifications dialog box.) That’s okay, as long asthe Program IDs—which are contained in the XIF files—are identical.

OM 136 47

Figure 41. Download Wizard, Select External Interface File Screen


7. Specify the location of the application program you want to download.

Select the drive, folder (directory), and NXE file from the list boxes.

Figure 42. Download Wizard, Select Application Image Screen

8. Select the Retain Net Image checkbox if you want the nodes to retain their network images afterthe download. Deselect it if you want the nodes to be unconfigured after the download. (Thisoption only applies to configured nodes. For applicationless or unconfigured nodes, thischeckbox should be deselected.)

OM 136 48

Note If you want to retain the node network images, all target nodes must have the sameProgram ID, and that Program ID must match the one for the new program to be downloaded.Conversely, if the new program has a different Program ID than the configured nodes in theTarget Nodes list, the network images cannot be retained, and thus the nodes must bereinstalled after the download. In this case, you must deselect the Retain Net Image checkbox.

9. Click the Finish button.

The Status box displays a status message that identifies the current task and node as each downloadoccurs. When the download is complete, the wizard’s opening screen returns.

Save Configuration, Download, Restore ConfigurationThis operation saves the current values of the input network variables you select, loads anapplication program (NXE file) into the specified node, and restores the network variable values yousaved. You can specify more than one node for this operation. Note that the target nodes must beconfigured, and you must know their names (as defined in the database and shown below the nodeicon). The Neuron ID and service pin methods of node identification are not available.

To save, download, and restore

1. Select the Save Configuration, Download, Restore Configuration option button.


3. Specify the target nodes.

Select one or more configured nodes by clicking the node image in QuickNet’s Manage Nodesand Routers screen. Once you have added nodes to the Node Name tab list, select one or morenodes from this list and click the Add button to add them to the Target Nodes list. The itemsthat are placed within the Target Nodes list are those on which operations will ultimately beperformed. You can traverse multiple location screens to perform the selection.

Caution If you specify more than one node, all nodes must have the same Program ID. Thisassures that the network variable structure is the same for all nodes. In addition, the ProgramID in the target nodes must match the one for the new program to be downloaded so that thenetwork images can be retained.


5. Specify the complete list of network variables that you want to save.

Select the variables from the Available Network Variables list. (See “Windows Multi-selectConvention” below for information on how to select a complete list in one operation.)

Caution For pre-LonMark water-source heat pumps, do not save and restore thenviAddrAssign variable. If you do, the network address will be set to zero (000/000).

OM 136 49

Figure 43. Download Wizard, Save Network Variables Screen

6. Click the Save button.

Those variables selected will move to the list on the right.

Note If you select more variables and click the Save button a second time, the new variablesreplace the existing variables. You cannot add to an existing list.





10. Specify the location of the program you want to download.

Select the drive, folder (directory), and NXE file from the list boxes. The network images areretained so that the variables in the STO files can be restored after the download.



Save Configuration Network Variables OnlyThis operation saves the network variables you specify to a file on your hard disk. You can specifymore than one target node. A separate file is created for each node. Note that the target nodes mustbe configured, and you must know their names (as defined in the database and shown below thenode icon). The Neuron ID and service pin methods of node identification are not available.

To save configuration data

1. Select the Save Configuration Network Variables Only option button.



Select one or more nodes by clicking the node image in QuickNet’s Manage Nodes and Routersscreen. Once you have added nodes to the Node Name tab list, select one or more nodes fromthis list and click the Add button to add the selected nodes to the Target Nodes list. The items

OM 136 50

that are placed within the Target Nodes list are those on which operations will ultimately beperformed. You can traverse locations to perform the selection.

Caution If you specify more than one node, all nodes must have the same Program ID. Thisassures that the network variable structure is the same for all nodes.




Caution For pre-LonMark water-source heat pumps, do not save and restore thenviAddrAssign variable. If you do, the network address will be set to zero (000/000).





The variables are saved and the wizard’s opening screen returns. The variable files have an STOextension and are located in the project’s LOG folder.

Restoring Configuration Network Variables OnlyThis operation restores the network variable values you saved previously. The wizard determines theaddress of the node from the name of the saved configuration file. Therefore, you must know thesubnet/node addresses of the nodes you want to restore data to. Note that the nodes must beconfigured.

To restore configuration data

1. Select the Restore Configuration Network Variables Only option button.


3. Specify the location where you stored the configuration files.

The default location is the LOG folder, which is in the project folder.

4. Select one or more data files that you want to restore.

The name of the file is of the form SxxxNyyy.STO, where the subnet address is “xxx” and thenode address is “yyy.”

OM 136 51

Figure 44. Download Wizard, Restore Configuration Files Screen

5. Click the Restore button to restore the configuration files.

If you want to restore more files, go back to step 3; otherwise, go on to step 6.


The configuration data is restored to the nodes and the wizard’s opening screen returns.

Windows Multi-select ConventionTo select a set of contiguous elements (node names, variables, files, etc.), click the first element youwant, press and hold down the SHIFT key, and then click the last element you want. The elementsyou clicked and all those in between are selected.

To select noncontiguous elements or to add to a list of contiguous elements, press and hold down theCTRL key and click each element you want. You can also use this technique to deselect previouslyselected elements.

Download Wizard Messages WindowThe wizard displays error messages in the Messages window. The messages include the date andtime. The Messages window has two menus: Options and Close. The Options menu contains onecommand, Clear Messages. This command clears the messages from the window. The windowremains open. The Close command minimizes the Messages window. The messages remain in thewindow.

Figure 45. Download Wizard, Messages Screen

OM 136 52

Any errors that occur are logged in the Messages window and in a LOG file, which can be found inthe project’s LOG folder. The LOG file is named with the current date, and a separate file is createdfor each date on which errors occur. Each error message has a reference to the target node (asapplicable) and an error code. The Messages window also displays an expanded message for the lastmessage received.

Node DiagnosticsThe Diagnostics menu of the Manage Nodes screen allows you to perform a number of functions.You can identify nodes, place nodes on-line or off-line, reset, test, replace, or query nodes. Each ofthese functions can be performed on routers as well.

Identifying a NodeThe Identify Node menu item allows you to find physical nodes on your network within QuickNet.When selected, a dialog box will appear requesting you to press the service pin on the node that youwant to identify. If the node exists in QuickNet’s database, the node will be shown with a greenborder on the location screen in which it resides. If the node does not exist in the database, thenode’s Neuron ID and Program ID are displayed.

Placing Nodes On or Off-line, ResettingThe Place Nodes Online and Place Nodes Offline menu items will set the mode of selected nodes inthe configured state. On-line is the normal condition for an operational node. When off-line, anode’s application program is disabled. A node in a configured, off-line condition is also known asbeing soft off-line. This is because the off-line mode is not preserved across a reset. When you placea node’s application off-line, the node is surrounded by a red border.

The Reset Nodes menu item will reset selected nodes. Note that resetting a soft off-line node willalso cause it to go on-line.

As always, you must first select one or more nodes by pointing to and clicking node images toperform these functions.

Winking NodesThe Wink Nodes menu item sends a wink message to the selected node or nodes.

Testing NodesBy selecting the Test Nodes menu item, you will see a screen that supplies a list of diagnosticparameters for the nodes selected.

OM 136 53

Figure 46. Node Test Results Screen

If you press the Net Image button on this screen, the selected node is queried to return its networkimage. Displayed are the contents of the node’s Domain, Address, and Network VariableConfiguration tables. If multiple nodes were selected, you can use the Next button to cycle throughall selected nodes.

Figure 47. Network Image Tables

Replacing NodesIf you suspect that a node has failed for any reason, you can replace the particular node by firstselecting the node image, and then clicking Replace Node on the Diagnostics menu. The new nodemust be an identical node type (same Program ID and external interface) for the node that you arereplacing, and it must be attached to the same channel. The faulty node does not need to exist on thephysical network. You will have the option of pressing the service pin or entering the Neuron ID onthe replacement node. The network image for the faulty node will be automatically downloaded tothe replacement node, and the node will be reset.

OM 136 54

Figure 48. Replace Node Dialog Box

Updating Configured Router Forwarding TablesThere might be occasions that will require you to manually update a configured router’s forwardingtables. For example, this will occur after you install a configured or learning router when otherconfigured routers are either not powered or not attached to the network. When you install aconfigured router, all other configured routers might require that their forwarding tables be updated.If this is indeed the case, you will get the following error:

X67 - Error occurred while updating configured routers during node install, download, or replacement. Please

check that all configured routers are attached to the network and powered, then select Diagnostics|Update

Routers in the Manage Nodes and Routers screen to update.

An Update Routers menu item will become visible on the Diagnostics menu. When you click UpdateRouters, the following dialog box will appear. Just select each router in the list and then press theUpdate button.

Figure 49. Update Router Forwarding Tables Dialog Box

Querying NodesQuickNet offers a feature that lets you monitor the health and status of all the nodes and routers inyour network. This feature automatically sends a diagnostic request/response message that queriesthe nodes status at a user selectable interval. The Messages window is displayed, indicating thestatus of the query and any faulty, non-communicating, or restored nodes.

To initiate the query process, you must be attached to a network. From the Manage Nodes andRouters screen, click Query Nodes on the Diagnostics menu. This brings up a dialog box that allowsyou to select the destination for the messages: file, printer, or both. The files are stored within theproject folder, and are named using the standard DOS 8x3 naming convention. The first threecharacters indicate the month; the next four characters indicate the date and year. The file extensionis LOG.

OM 136 55

Figure 50. Query Node Properties Dialog Box

You can select the update interval. The update interval represents the time between a query to thenodes in your network. At each update interval, the next node in the network is queried. Forexample, if you have ten nodes in your network and the update interval is set to 2 seconds, QuickNetwill sequence through each of the nodes in the network over 20 seconds.

When you exit this dialog box, a check is placed next to the Query Nodes menu item. To disable thisfunction, either re-select the menu item (the check will then be removed) or press the ESC key whilethe Manage Nodes and Routers screen is active.

OM 136 56

Managing Individual Connections

QuickNet provides a unique graphical representation by which you can view your connectionscenario. Once connections have been established, you can see at a glance which nodes areconnected to others, and you can also isolate connections between any two nodes.

If you created this project using QuickNet’s location layout system, the Manage Connections screenis automatically set to the last location in which you were working. To navigate amongst the otherlocations that you previously defined, use the Location menu. If you imported a DXF file when youcreated this project, the DXF drawing is set to its full extent. You can navigate around the drawingby using the Zoom and Pan toolbar functions. (See “Laying Out a Project” in the “ManagingProjects” section for more on using QuickNet with DXF files.)

Connections are comprised of a set of either network variables or message tags. To create, modify, ordelete connections or members of connections, the procedure is similar for both network variableconnections and message tag connections. The only difference is in the menu item selection for eachof these types of connections. Network variable connections will be addressed here; if you want tomanage a message tag connection, simply perform the applicable steps and replace network variablemenu items with message tag menu items.

Connections can be made either on-line or off-line. The procedure is exactly the same for bothcases; however, when an off-line change is made, the node image will be surrounded by a cyan(light blue) border indicating that an off-line binding change has been made.

Creating a ConnectionTo create a connection, you must have first created a network layout or modified a previously savedlayout. Nodes targeted for connections must have been logically installed on your network. At leasttwo nodes must be involved in a connection; one of these nodes must provide an output networkvariable, and the other must provide an input network variable. These nodes do not have to reside inthe same location, thus allowing you to bind nodes that are physically separated.

From the Create menu, select either Network Variable Connection or Message Tag Connection. Aradio button control designating Output Nodes or Input Nodes will appear on the right side of thescreen. By selecting either of these buttons, you will be setting QuickNet to designate nodes as thesource or destination of network variable messages. Once you have selected either button, click anode image. If you selected the Output Nodes radio button and you are creating a network variableconnection, an arrow pointing out of the node that you selected will be displayed on its right side.This indicates that the node is a source for a network variable connection (i.e., you want to connectan output network variable from this node). If you selected the Input Nodes radio button and you arecreating a network variable connection, an arrow pointing into the node that you selected will bedisplayed on its left side. This indicates that the node is a destination for a network variableconnection (i.e., you want to connect an output network variable from another node to this node).You can select as many output and input nodes as required for this connection as long as you don’tviolate the LONWORKS connection constraints. Similar visual effects are portrayed for message tagconnections except that the arrows are replaced with half circles on the right or left side of theparticipating nodes.

OM 136 57

Figure 51. Selecting Input Network Variable Nodes

After selecting all the nodes that will participate in a given connection, select the Assemble menu.The Create Network Variable Connection dialog box will then appear, showing the first output nodefor the connection and a list of output network variables for this node.

Figure 52. Create Network Variable Connection Dialog Box

You must name the connection by entering a unique name in the Connection Name text box. Whenyou click a network variable in the Network Variable list box and press the Add button, the networkvariable is automatically displayed in the lower list box, indicating that it is staged for thisconnection. When you press the Add button, you are shown the next node that you selected toparticipate in this connection. The network variable list is filtered based upon the type of the first

OM 136 58

network variable selected. When you have traversed through all the nodes that you selected, theConnect button is enabled and the Add button is disabled. To complete the connection, press theConnect button. The connection will be processed. Repeat this procedure for all of the connectionsthat you want to create for your current project.

Setting Bind OptionsConnection bind options include service type, retry count, and authentication. By default, aconnection is bound using the bind parameters specified in the device application code running onthe node. These defaults can be overridden by selecting the Bind Options button in the CreateNetwork Variable Connection dialog box.

Figure 53. Bind Options Dialog Box

The following table shows the possible combinations of service type and retry counts:

Table 3. Binding Options

Service Type Retry Count Authentication

Application configured Application configured Application configured

Unacknowledged 0 Off or On

Unacknowledged Repeated 0–15 Off or On

Acknowledged 0–15 Off or On

Viewing ConnectionsOnce you have created connections, there are different methods to view the connections. You canselect the View menu for either network variable or message tag connections. This action willdisplay two lists on the right side of the screen. The upper list contains all connections created andis named Connection. The lower list contains a list of all other locations that include nodes inconnections and is named Locations.

By clicking a connection name in the upper list, you will see lines appear on the ManageConnections screen between all of the nodes included in this connection. If you want to findinformation regarding any specific connection, just double-click the connection name in theConnections list, and the information pertaining to that connection will be displayed.

To simplify this process, you can click any node in the current location. A green circle will surroundthat node, and lines will be drawn between all of the nodes that the selected node is connected to.The Connections and Locations lists are revised to indicate only the connections associated with theselected node. To further filter the lists of information, clicking a second node in the connectionscreen connects lines between only the two nodes that were selected. This action again revises theConnections and Locations lists to reflect only these connections. If the first node that was selectedis connected to nodes at other locations, the selected node presents a symbol that looks like a center-of-gravity symbol, and the Locations list is updated. By selecting a member of the Locations list, you

OM 136 59

will immediately be taken to that location, and the connection screen will be updated to reflect theconnections at that location.

Figure 54. Manage Connections Screen

Adding Members to a ConnectionNetwork variables and message tags on nodes can be added to connections. From the ManageConnections screen, select the Modify menu. Then select the Add To submenu item for networkvariables or message tags. A list that shows existing connections will appear on the upper right sideof the screen. Click the connection name to which you want to add a network variable or messagetag. The output/input radio button control box will then appear. Continue in the same manner as youdid when you created this connection, remembering that you should only select output or inputnodes that contain network variables or message tags that you want to add to an existingconnection.

Once you have selected the required nodes, select the Assemble menu. A dialog box will appearindicating the connection you are about to modify, and showing you the image of the first outputnode that you selected. A list of existing node/network variables or node/message tag participantswill also be displayed. Add the new participants by pressing the Add button. The dialog box will beupdated to indicate the next node that you selected and its available network variables. Press theConnect button when you are done to establish the modification to the connection.

Deleting Members of a ConnectionNetwork variables and message tags on nodes can be deleted from connections. In addition, you caneasily delete an entire connection. From the Manage Connections screen, select the Modify menu.Then select the Delete From submenu item for network variables or message tags. A list that showsexisting connections will appear on the upper right side of the screen. Click the connection namethat you want to modify.

OM 136 60

When you click the connection name, a dialog box will appear. This dialog box will show theconnection name and all of its participants. You can delete the entire connection by pressing theDelete All button and then the Modify button. If you want to remove one or more participants fromthis connection, select each participant individually from the Connection Members list and thenpress the Remove button. This action queues existing participants in the connection modificationlist. Press the Modify button to complete the modification to this connection.

OM 136 61

Advanced Connections: Graphical Template Binding Tools

QuickNet’s graphical Template Design and Template Apply tools allow you to pre-define networkvariable binding patterns that will speed your installation process. You can create binding templatesthat represent the connectivity amongst many node types, instead of performing the connectionsindividually. Then, by simply dragging and dropping the actual nodes onto these templates, theconnection sets are created and bound.

The connections that the graphical template binding tools create are normal LONWORKS

connections. They can be viewed, modified, or deleted from the Connections screen. See the“Managing Individual Connections” section for more details.

Template Design ToolWhen creating larger, more complex networks, the bindings required in the system become morenumerous. Creating the connections correctly, when many nodes may be involved, becomes verydifficult. Sometimes you will need to create a binding among a small number of nodes, but you willneed to do it in many different places with different groups of nodes. For example, you may have abuilding, where each room needs its network variables bound in a certain way. Or you may beproducing a pre-installed network for clients, and each network has the same connections. TheTemplate Design tool provides a way to create the bindings as a series of steps, and those steps canbe executed on any group of nodes.

Before going any further, let’s go over the basic terminology. In order to create a template, you mustfirst define patterns (much like an XIF file identifies nodes) that match the different nodes on yournetwork. Once the patterns are defined, you can create templates, which contain instances of thepatterns. These instances represent a real node, but have not been told which one yet. Finally, acollection of bindings can be created, which refer to any or all of the instances defined in thetemplate. Once the template has been created, you can apply the template. This is where the realhardware is associated with the instances.

Let’s go through an example to show how this works. It is important to understand the differencesbetween patterns and instances.

Let’s create a template for all the lights and switches in a single room in a building. We have aLIGHT.XIF and SWITCH.XIF file, which define the nodes that are used in the room. Here are thesteps:

1. Import the XIF files, so we can use them as a reference for the patterns.

2. Create a light pattern, based on the LIGHT.XIF file. We will call the pattern “LIGHT.” Thepattern is a list of network variables and message tags, by name, that are in the node.

3. Create a switch pattern, based on the SWITCH.XIF file. We will call the pattern “SWITCH.”Now that we know what a LIGHT and SWITCH are, we can create the template:

4. Add an instance of a LIGHT, called Light1.

5. Add an instance of a LIGHT, called Light2.

6. Add an instance of a SWITCH, called Switch1.

7. Add an instance of a SWITCH, called Switch2.

8. Create a new binding, and in that binding make the connections between Light1 and Switch1.

9. Create a new binding, and in that binding make the connections between Light2 and Switch2.

10. Save the template.

That is all it takes to create the template. From now on, you can apply the bindings for two lightsand two switches in the template any time you need them.

OM 136 62

The main thing to remember here is that the LIGHT pattern that we created only tells us what a lightlooks like; it hasn’t actually been used yet. It is very similar to programming, where you can definea variable type, but you don’t have an actual variable of that type until you declare an instance of it.

DefinitionsPattern: A pattern is used to identify a node (or some object, in general) to be used. A patternconsists of a list of network variable and message tag names that must match the node exactly. Thepattern also stores type information, etc., but that is not used for the pattern matching. To create apattern, an XIF file must be imported as a reference. The XIF file provides the network variable andmessage tag names for the pattern.

Instance: Once a pattern has been created, an instance must be created to use the pattern. Thepattern is a node type, but an instance is a node of that type. For example, if you have a SWITCH

pattern, you might have several instances of switches that are of type SWITCH.

Template: A template contains instances and bindings combined together to perform a specific setof bindings with those instances. To use the template binder, you must have a template. Templatesdo not reference any real nodes, only instances to be matched with real nodes. During templateapplication, you will select the actual node(s) to be associated with each instance.

Binding: A binding is a list of network variables or message tags that are to be joined together in asingle connection. Bindings reference the instance names that you have selected, not actual nodenames. During template application, you will select actual node names to perform the bindings.

Database: A database for template design and application refers to the template database. Itcontains all the patterns and templates that you have defined. You can create as many of these asyou wish, but it is wise to group related project templates and patterns together in a single database.A database has a description that goes with it, and that description can be used to select thedatabase, so please choose a good description.

Reference Database: You must import XIF files in order to create patterns. Those XIF files arekept in the reference database. Note that the reference database is not required to use (apply orview) a template, only to change it.

Items: Items refer to the network variable or message tag names in a pattern or a binding. They arethe smallest object used in the template binder.

Quick StartThis section shows you all the steps to create a regular template. To follow these steps while runningthe design tool, invoke and resize the Help window so you can see most or all of the template designwindow, then select the Help menu item Always On Top. This will keep the Help window on top ofthe design window while you’re going through it.

To create a template for application from scratch, follow these steps:

1. Create a Database: If this is the first time you have run the design tool, you will need to createa template database. If you created one when you started, great. If not, click New on theDatabase menu to create one. Enter the filename to use for the database and a description. Youcan have multiple databases of templates in use at once, and the description (not the name) isused to select the database to use. See “Creating a Template Database” below for moreinformation.

2. Import XIF Files: In order to create patterns, the design tool uses XIF files as a reference. (It ismuch easier than entering all the information yourself.) To add the XIF files, click Import XIFFile on the Ref Database menu. Add XIF files for all the node types you want to use. See“Importing Template XIF Files” below for more information.

3. Create Patterns: For the specific template that you wish to create, you will need patterns foreach of the node types. To create a pattern, click New Pattern on the Template menu. Keep thename specific to the XIF file; for example, enter LIGHT or THERMOSTAT. You may want it to be

OM 136 63

specific as to the manufacturer and model, such as ACME THERMOSTAT, so that you candistinguish similar types. Put your name or company in the author section, and provide adescription of the pattern if you wish. The only required fields are the name and the ProgramID. Use the Program ID to look up an XIF file that you have loaded. Note that the Program IDis not used in the pattern, only to retrieve the information about the pattern. When you select aProgram ID, a node view will appear in the window below. See “Creating a Pattern” below formore information.

4. Create Template: Once you have the necessary patterns, you will need to use them. Click NewTemplate on the Template menu. The name for the template should reflect the actions it willperform. Fill out the Author and Description fields as you wish. In the bottom part of thewindow is the list of steps in the template. A template consists of instances and actions on thoseinstances. The next two sections define these types. See “Creating a Template” below for moreinformation.

5. Create Instances: In the template window, click the Instance button. This will create aninstance for use. A pattern, such as LIGHT, tells us what a light looks like, but an instance tellsthe computer that we are going to use one. For example, if we want a template with two lightsand one switch, we can create an instance for “Light A” and one for “Light B,” both from thepattern LIGHT. You will need an instance for each object (node) that you need to use in thistemplate. See “Adding Instances” below for more information.

6. Create Actions: In the template window, click the Bind button. A window will appear lettingyou select from any instance you created in the last step. Click the object to look at the items(network variables and message tags) in the object. To add an item to the binding (connection),click the network variable or message tag you wish. Selected items will be highlighted with agreen border, and only the items that can be bound together will be shown. To remove an itemfrom the binding, click it again. Experiment with this for a while to get comfortable with it.Create as many bindings as you wish in the template. See “Adding Bindings” below for moreinformation.

7. Edit the Template: If you need to make changes to the template, you can double-click any stepin the template and edit it. If you need to delete a step, select the step (by clicking it), and thenpress the DELETE key.

Note Be careful deleting instances because it will change any binding that used that instance.

8. Save the Template: When you are finished, save the template. You can then apply the newlybuilt template from QuickNet.

Creating a Template DatabaseTo create a database, click New on the Database menu. The following dialog box will appear.

Figure 55. Create Template Database Dialog Box

You will need to enter a filename and description for the database. Whenever you are using thetemplates, the databases will be displayed by their descriptions first. So, the description should beshort (under about 40 characters) and easy to identify. The filename is not as important because youwill not need to know the name unless you are trying to move a single database to another machine.

OM 136 64

Clicking OK will create the database with the specified name and place the description in it. In thisexample, when you try to open a template or a pattern, “Project X templates” will appear as thedatabase.

Importing Template XIF FilesTo import XIF files that are not in the database, click Import XIF File on the Ref Database menu. Adialog box will appear.


Select the drive, directory (folder), and file path for the XIF file that you want to import. Eitherdouble-click the file name or press the Import button to complete the action. Press the Close buttononce you have imported all desired XIF files.

Removing Template XIF FilesTo remove program records, click Remove XIF File on the Ref Database menu. The followingdialog box will appear:

Figure 57. Remove XIF File Dialog Box

Select the XIF files that you want to remove from the database.

OM 136 65

Creating a PatternFor the specific template that you wish to create, you will need patterns for each of the node types.To create a pattern, click New Pattern on the Template menu. The following window will appear.

Figure 58. New Pattern Dialog Box

Keep the name specific to the XIF file, for example LIGHT or THERMOSTAT. You may want it to bespecific as to the manufacturer and model, such as ACME THERMOSTAT, so that you can distinguishsimilar types. Put your name or company in the author section, and provide a description of thepattern if you wish. The only required fields are the name and the Program ID. Use the Program IDto look up an XIF file that you have loaded. Note that the Program ID is not used in the pattern,only to retrieve the information about the pattern.

When you select a Program ID, a node view will appear in the window below.

When you are done, you can close the window. It will prompt you to save the pattern if necessary.Remember to select the proper database to put the pattern in.

If the XIF file you need isn’t there, see Importing XIF Files. Once you have created the pattern(s)you need, see Creating a Template.

Creating a TemplateAfter you have created the patterns, you need to create a template to use them. To create a newtemplate, click New Template on the Template menu. The following window will appear.

OM 136 66

Figure 59. New Template Window

Use a name that describes what the whole template will do; for example, “First Floor” or “SecuritySystem.” You want it to be as specific as the template is. That is, if the template is a general roombinding for the lighting and HVAC systems, you may want to call it “Room.” But if it is specific toRoom 502, call it that. The only required fields are the name and any steps. To add steps to yourtemplate, you can click Instance or Bind to perform those operations.

Adding InstancesIn the Template window, click the Instance button. This will create an instance of a pattern for use.The following window will appear.

Figure 60. Add an Instance Window

A pattern, such as a LIGHT, tells us what a light looks like, but an instance tells the computer that weare going to use one. For example, if we want a template with two lights and one switch, we cancreate an instance for “Light A” and one for “Light B,” both from the pattern LIGHT. You will needan instance for each object (node) that you need to use in this template.

This window is the display of a step in the template. You won’t need to save it independently.

Adding BindingsIn the Template window, click the Bind button. A window will appear, showing all availableinstances declared in the template.

OM 136 67

Figure 61. Add a Bind Window

The window above is what is displayed for the template shown in Creating a Template. To create thebinding, you will need to select a connection prefix and the items to be bound.

The connection prefix is used to name the connection in the project during application. The prefixwill be used as entered, unless a connection of that name already exists. If it does exist, “001” willbe added, and it will be checked again, then “002,” etc. This field defaults to “TPL,” and you canleave it that way if you don’t care about the names assigned to the connections.

Click any object to look at the specific pattern (network variables and message tags) in the object.Below is an example of an unfiltered list. It is showing all available network variables and messagetags that can be bound.

Figure 62. Network Variables Example

To add an item to the binding (connection), click the network variable or message tag you want.Selected items will be highlighted with a green border, and only the items that can be boundtogether will be shown. This automatic filtering makes it easy to locate the network variables thatyou want. For example, after selecting ntiCount[0] in the window above, the display changed tothis:

Figure 63. Filtering Example

OM 136 68

To remove an item from the binding, click it again. Experiment with this for a while to getcomfortable with it. Create as many bindings as you wish in the template.

Template Apply Tool

DefinitionsApplication: An application is a template with associations to be applied to real nodes. It iseverything needed for a single application of the template.

Target: A target is simply a node used for a template application.

Object: An object is an instance defined in the template.

Association: Each template consists of several objects. The association is the list of targets tied to asingle object. For simple templates, the association will consist of one object and one target (onenode per object). More complicated associations may use zero, or more than one target. For moreinformation, see Zero, One, and Multiple Targets.

Instance: Once a pattern has been created, an instance must be created to use the pattern. Thepattern is a node type, but an instance is a node of that type. For example, if you have a SWITCH

pattern, you might have several instances of switches that are of type SWITCH.

Template: A template contains instances and bindings, combined together to perform a specific setof bindings with those instances. To use the template binder, you must have a template. Templatesdo not reference any real nodes, only instances to be matched with real nodes.

Quick StartThis section shows you all the steps to apply a template. To follow these steps while running theapply tool, invoke and resize the Help window so you can see most or all of the apply windows, thenclick Always On Top on the Help menu. This will keep the Help window on top of the applywindows while you’re going through it.

If you have not created a template to apply, you will need to do so first.

To apply a template, follow these steps:

1. Open a Template: Select Open from the Template menu and select the desired template toapply. Once it has loaded, a second window will appear, showing all the objects (instances) thatyou have defined.

2. Associate Nodes with Objects: You must now tell the program which nodes are to beassociated with each of the objects shown. To do this, find the node on the location window,drag the node onto the desired object, and release it. The program will attempt to match theobject with the specified node. If it cannot, it will tell you why. To see what node has beenassociated with the object, click and hold the mouse down on the object. A pop-up list of targets(nodes) will be shown. If an object has no nodes associated, the border will be black. With onenode, the border turns green, and with two or more, the border turns yellow. If you need toremove targets, select Remove Targets from the Template menu. This will remove all targetsfrom all objects.

3. Select Options: Before applying a template, verify that the options are set the way you wantthem. Most importantly, study Optimizing Bindings.

4. Apply the Template: Once all of the associations have been made, click Apply on the Templatemenu. A status window will appear, and it will build a set of commands to execute. You will seethe current action being taken, and a percentage complete. If an error occurs during theoperation, it will stop and show you the message. You can then retry, abort, or undo at thattime.

OM 136 69

Adding and Removing TargetsAdding Targets: To add a target to a specific object, first find it on the Location screen (you mayneed to change locations to do this). Take the node, and drag it over the desired object and drop it.To see the targets associated to an object, just click the object (and keep the button down). A windowwill pop up, showing all targets for that object.

Removing Targets: If you need to remove targets from an object, you must remove them all. To dothis, click Remove Targets on the Template menu.

Applying a TemplateOnce you have added all the nodes you wish, you need to apply the template to the nodes. First,check to see that the options are set the way you wish (see Section 14.2.7, “Optimizing Bindings”).To apply the template, click Apply on the Template menu. The Status window will appear, showingthe template application in progress.

Undoing a TemplateUndoing a template that has been applied is much the same as applying it. To undo the template,assign the same targets to the objects (they will already be there if you just finished applying thetemplate). Then click Undo on the Template menu. The Status window will appear, and the stepswill be executed from last to first. Remember that in order to undo a template, you must merge withexisting connections from the Options menu (see Optimizing Bindings). If not, the undo will donothing.

The Status WindowThe Status window is displayed whenever a template is being applied or undone.

Figure 64. Status Window

In the example above, the application is halted, because an error occurred. The main text area showsa synopsis of the command that was last executed, in this case a binding called Trio. Because thesecommands can be very long, only the first few binding items are shown. At the bottom is theprogress bar, indicating that there are three steps to perform and this is the second. At this point, theuser could retry the operation (maybe a node was turned off or communications were down for somereason); they could reverse, which would undo what has been done so far in this application; or theycould abort, leaving the previous steps of the application as is.

When undoing a template application, the progress bar in this case would go from 3/3 down to 1/3,performing the steps in reverse.

Optimizing BindingsMerge With Existing Connections in the Options menu lets you choose how to optimize thebindings for template application. Depending on how you plan to use a template, this option mayneed to be changed.

When you apply a template, it will automatically optimize its own bindings. For example, thefollowing connections would be merged as follows:

OM 136 70

X→Y and X→Z becomes X→(Y,Z)

If you choose to merge with existing connections, it will look at all the connections that havealready been made on the network and optimize with those too. So if you have a bind command toconnect X and Y, and the network already has a connection C1 with X and Z, then Y will be addedto connection C1:

Template: X→Y, Connection C1: X→Z becomes: Connection C1: X→(Y,Z)

Intersecting ConnectionsAt certain times, you may choose to not optimize with existing connections. Most commonly, it isnot necessary if there are no connections related to the template application. Sometimes though, youwill want to create intersecting connections. Take the following example:

In the template, we have: B→(C,D). (This is a normal 3-way connection; B is a writer, and C and Dare readers).

In the network, we have: Connection C2: A→C

We have two choices: We could merge with existing connections, and create a two-writer, two-reader connection:

Connection C2: (A,B) →(C,D)

Or, we could keep them separate, resulting in:

Connection C2: A→C, and Connection C3: B→(C,D)

The second case is very important if you do not want A to write to D.

Zero, One, and Multiple TargetsTemplate applications are very flexible, and target selection lets you control much of that.Conceptually, there are three types of target associations that can be made, and they are describedbelow.

One Target On an ObjectThis is the simplest case for template application. The template is built, substituting the node inevery place that you defined in the template.

No Targets On an ObjectThis can be very useful for optional configurations. Let’s say you have a system with 10 nodes andmany connections. Some of these nodes are optional (the customer may choose one configuration oranother). You can create a template that shows a complete configuration, and drop only the targetsthat you have in their configuration. When this is done, the unused objects are ignored for all steps,so the connections are built without them (or not built at all). This lets you create one template thatcan be used with optional nodes.

Multiple Targets On an ObjectThis is another very useful choice to handle variations in real-world situations. Think of a simpletemplate: It has two objects, Switch and Light, and one binding that connects the output of theSwitch to the Light. Now you are setting up a room that has 3 switches controlling 15 lights total. Ifyou want each switch to control five of the lights, this can be accommodated by dropping one switchon the Switch object, and 5 lights on the Light object. The program will create a single groupconnection from the switch to the 5 lights. You will need to apply the same template (with the otherswitches and lights) three times to accomplish your goal.

Now you could have dropped all three switches on the Switch, and all 15 lights on the Light. Theresult of that would be a group connection with three switches and 15 lights. All lights would worktogether, and each switch would control all 15 lights.

OM 136 71

Understanding the differences between these cases will let you make the most of templates and yourtime. The best way to understand how all of these work is to experiment. Try a template application,and then return to the connection screen and see what it did.

CaveatsThis section is here to discuss some of the side effects that template applications can give. Some ofthem can be very useful, and some of them can change more than you expected.

Undoing Template ApplicationsThis ability is very useful, but it can lead to unexpected results. Take the simple Switch and Lightexample (see Zero, One, and Multiple Targets for more information). You have a template thatconnects one Switch to one Light. If you have an existing connection that connects a switch toseveral lights, you can tell the program to merge with existing connections, select the same switchand a new light, and it will just add the new light to the existing connection. Now let’s say wewanted to undo that. You would think that it would remove just the light, but what it really does isremove everything in the template from the connection, which includes the switch. If there is onlyone switch (or output) in the connection, the entire connection will be removed because there areonly inputs left. It is not clear how the program should handle this situation because in certain caseswe want it to remove the switch and not in others. As a general rule, it is safest not to undo atemplate if it is merged with existing connections.

OM 136 72

Browsing Network Variables

QuickNet’s network variable browser can aid in debugging networks and applications. It can also beuseful in optimization of control strategies. By setting and viewing parameters and then observingsystem performance, you can adjust your control system until optimum application performance isachieved. You can also save the network variable browser configuration so that you can view thevariables you previously saved at any time.

Note If the selected node/network variable combination is a member of one or more connections,this function will only modify the network variable value on the node selected, and will not updatethe values for the other output or input nodes in the connections.

Network variable types are grouped into five categories:

• Atomic network variable types

• Complex network variable types

• Standard Network Variable types (SNVTs)

• User defined types

• Other network variable types

QuickNet recognizes all of these types.

Atomic network variable types are those declared within a node as follows:

• Unsigned or signed int

• Unsigned or signed long

• Unsigned or signed char

Complex network variable types are those declared (typedef) within a node as structures.

SNVTs are network variable types that have a pre-defined interpretation. SNVTs can be atomic orcomplex types. See Echelon Corporation’s Master SNVT list for their descriptions.

User defined types are network variable types that are declared (typedef) within a node as atomic,structure, or enumeration types, and have been pre-processed by the supplied utility programs intofiles that QuickNet recognizes. These files, once created, must be placed into one of QuickNet’sproject folders. These files will either be provided by the node manufacturer or will have to becreated.

Other network variable types include network variable types for which no knowledge of typedefinitions has been supplied to QuickNet.

The NV Browser screen is partitioned into upper and lower areas for output and input networkvariables, respectively. QuickNet displays the value of network variables in a panel on the right sideof the NV Browser screen. Simple data types are displayed as their actual value. Complex data typesare shown as the first few bytes of data, each byte formatted by its data type.

To invoke the network variable browser, click the NV Browser menu on the Main screen. Thebrowser screen will be displayed. Menu items are available to perform the following functions:

• Create a new network variable browser information file

• Open an existing network variable browser information file

• Save the current network variable browser information to a file

• Set automatic update (refresh) intervals for the network variable browser

• Display a message log window

• Return to the Main screen

OM 136 73

You don’t have to create network variable browser information files to observe or update values ofnetwork variables. However, this feature is useful if you set up a specific network variable browserscreen and must leave the screen for any reason. The setup can be easily restored if it has beenpreviously saved, thus eliminating the requirement to subsequently set up the screen again.

Figure 65. Network Variable Browser Screen

Creating a New Network Variable Browser FileClick New on the Files menu of the NV Browser screen. This feature only clears the NV Browserscreen and allows you to add new network variables to the display list. If you try to exit the NVBrowser screen, you will be asked whether you want to save the current configuration. If you want tosave the information, you will be asked to enter a unique file name for the information file.

Opening an Existing Network Variable Browser FileTo open an existing NV browser information file, click Open on the Files menu of the NV Browserscreen. This action will display a dialog box from which you can select a filename. Press the Openbutton to import the information contained in the file.

Note If your node applications have changed so that the information in a given NV browserinformation file does not reflect the nodes (i.e., node names and application image programs) andnetwork variables on the network, an error message will be displayed. You will have to create a newNV browser information file to accommodate the new or changed nodes and their networkvariables.

Setting the NV Browser Update Interval TimeQuickNet allows you to either obtain the value of output and input network variables when youdesire or allows you to update values at pre-defined intervals. This feature is useful when you wantto monitor your application automatically. Conversely, this feature will add some network traffic;

OM 136 74

therefore, in an environment that is heavily burdened with network traffic, it may be better to obtaindata only when required. This assumes a worst case traffic scenario, and in most applications youwon’t run into this constraint.

To set the update interval, select the update time that you want from the Update Interval menu of theNV Browser screen. If at any time you want to stop updating network variables automatically, eitherclick None on the Update Interval menu or press the ESC key.

Using the NV BrowserThere are four control buttons located at the bottom of the NV Browser screen:

• Add NV

• Delete NV

• Get Value

• Update Value

To add network variables to the display list, press the Add NV button. The following dialog box willappear. A Node list and Network Variable list will initially be shown. Network variables are filteredbased on direction. To view output or input network variables, select the appropriate option button.Click the node and then on a network variable that you want to display. When you select a networkvariable, a Type or Field list will appear depending on the type of the selected network variable.

Figure 66. Enter Node and Network Variable Dialog Box

The Type drop down box is shown when a non-SNVT network variable has been selected. The Typedrop down box is filtered to show only those types that match the length in bytes of the networkvariable selected. The Field drop down box displays fields within a structure. This list is shownwhen a SNVT or a complex network variable type has been selected. You can select the top mostelement (e.g., 0 - SNVT_time_stamp) to view or set the entire structure, or select from any of theother elements to view or set a particular field within the structure. Simple data types such asSNVT_count will have only one element. SNVT_time_stamp has elements for year, month, day,hour, minute, and second.

SNVTs and user defined types are formatted and displayed to reflect their types. All other networkvariables display as many bytes as fit into the display aperture. You can gain access to the value ofthese network variables by clicking the associated network variable’s Value panel. Upon doing so, adialog box will appear showing you the values, byte-by-byte, contained in the selected networkvariable. An option box, which allows you to view the data using a number of formats, appears in

OM 136 75

the upper left side of this window. Individual bytes in these data types can be displayed as eithersigned or unsigned integers, characters, hexadecimal values, or raw binary data.

Network variables are added to the display list by means of a checkbox column. Subsequentoperations are only performed on network variables whose checkboxes have been selected.

Note If you add a structure that contains a SNVT type “SNVT_state,” the “1s” and “0s” displayedfor each byte will be in reverse order. The following example shows you how the values will bedisplayed, and how they correspond to the “SNVT_state” type (bit 0 through bit 15).

First Byte:

Bit 0 Bit 7

MSB LSB

Second Byte:

Bit 8 Bit 15

MSB LSB

When you press the Delete NV button, all node/network variable line items that are selected will bedeleted from the display list.

Displaying a Network Variable’s Current ValueYou can display the current value of any or all network variables by checking the appropriate lineitem and then pressing the Get Value button. Alternately, you can get the current value of any outputnetwork variable by simply clicking its Value panel. Of course, if you have set the Update Interval,the values of the selected network variables will be automatically updated. This does not prevent youfrom updating the values when you wish by pressing the Get Value button or clicking the networkvariable’s Value panel.

Revising a Network Variable’s ValueTo revise the value of the selected input network variables, press the Update Value button or clickthe network variable’s Value panel. A dialog box will appear for each node/network variable lineitem that is selected.

Revising an Atomic Network Variable’s ValueIf the network variable is an atomic SNVT or user defined type, the dialog box will display the nodeand network variable that you wish to modify and the expected format for the input value. Type inthe new value and press the Update Value button. The revised value will be sent to the indicatednode and network variable.

Figure 67. Enter Network Variable Value Dialog Box

OM 136 76

Revising a Complex Network Variable’s ValueIf the network variable is a complex SNVT or user defined type, the dialog box will display thenetwork variable’s fields in a tabular format. Type in the new value per the indicated format, orselect the desired enumeration from the field’s drop down list and then press the Update Valuebutton. The revised value will be sent to the indicated node and network variable.

Figure 68. Revising a Complex Network Variable Value

Revising Other Type Network Variable ValuesIf the network variable is an “other” type, a different dialog box will appear. This dialog box willcontain the network variable’s data in a raw format.

Figure 69. Network Variable, User Type Dialog Box

By using the button controls in the upper left of this dialog box, you can select the format of thedisplayed data. To change the value of any particular byte in this network variable, simply click thedesired byte. This action will enable the controls in the lower portion of the dialog box, and you cantype in the new value per the format that you selected. For instance, if the displayed format is

OM 136 77

“unsigned integer,” you can enter a value ranging from 0 through 255. If the format is “signedinteger,” you can enter a value between –128 and 127. Any letter, digit, space, or underscore can beentered using the “character” format. Hexadecimal values can be entered as “0x” followed by ahexadecimal number between “00” and “FF.” If the selected format is binary, “1”s and “0”s areaccepted.

OM 136 78

Appendix A: Error Message Dictionary

Database ErrorsD1 Attempt to reopen database or database not open on access attempt

D2 Specified database does not exist

D3 Unable to allocate memory

D4 Specified object does not exist

D5 Unexpected internal error

D6 End/beginning of list reached

D7 Specified list/next direction invalid

D8 Invalid identifier specified

D9 Invalid Key ID specified

D10 Invalid List ID specified

D11 Invalid Record ID specified

D12 Change of owner key on list access, or intermediate database activity disrupted access

D13 Key specified not valid for requested action

D14 Invalid data specified

D15 Invalid or in-use value specified for member index

D16 Specified key already exists

D17 Creation of specified record type not valid

D18 Deletion of specified record type not valid

D19 Attempt to delete record which still has associated list records

D20 Attempt to delete Program NetVar or Mtag which still has associated connections

D21 Error occurred when opening database

D22 Error occurred when creating database

D23 Database revision # not consistent with API revision #

D24 Database path name not valid or does not exist

D25 Unable to start database transaction; sufficient disk space?

D26 Unable to store records to disk due to lack of disk space

D27 Attempt to start transaction when one is already active

D28 Attempt to commit or abort transaction when none is active

D29 Transaction aborted due to earlier detected database error

D30 Configurable limit exceeded

D31 Conflict with existing data

D32 No path between specified channels

D33 Two or more routers join a given pair of channels, but do not have identical configuration

OM 136 79

D34 Channel ID exceeds topology channel limit

D35 Router ID exceeds topology router ID limit

D36 Attempt to configure forwarding tables on unconfigured router

D37 Conflict in node’s specified subnet/channel

D38 Connection binding attempt failed

D39 ldb_open() or ldb_create(): londb.dbd file does not exist in specified database directory

D40 ldb_open() or ldb_create(): database files invalid or corrupted

D41 .XIF file has invalid format

D42 Error accessing data base file; may be due to insufficient disk space or corrupted data file

D43 Key file inconsistency detected

D44 Unable to open database file; required database file missing or insufficient file handlesallocated (CONFIG.SYS FILES= command)

D45 Insufficient disk space

D46 Attempt to open more databases than current maximum allowed (4)

D47 Invalid SNVT.TYP file

D48 Attempted binding of NVs with incompatible definitions

D49 Task ID passed via an interface function not valid

D50 Called ldb_unlock from within a transaction

D51 Attempt to lock a previously locked record

D52 Lock request contained invalid entries

D53 Invalid item_id in lock request

D54 Invalid lock_type in lock request

D55 Invalid lock_type in unlock request

D56 One or more of the requested locks unavailable

D57 User level locks outstanding

D58 User requested an invalid lock mode

D59 Limit of length of user ID exceeded

D60 Database function aborted by user-called idle function

D61 Either duplicate or invalid user ID specified in database open

D62 Share not loaded

D63 .XIF import of program with same ID, but different external interface

D64 Routers defined connecting channels in a loop

D65 Requested operation not supported

Network ErrorsX1 Network Interface invalid or not open

X2 Internal API error occurred

X3 Internal API data structure limit exceeded

OM 136 80

X4 Unable to determine LonManager domain compatible with destination

X5 Node system type not defined as LonManager

X6 Name not defined as specified object type

X7 Address type specified not defined

X8 Message class specified not defined

X9 Message command specified not defined within specified message class

X10 Destination specified not valid for specified command

X11 Error in message data contents

X12 Reference ID specified out of range or in use

X13 Unable to allocate memory

X14 Specified object not defined in database

X15 Specified command not valid for lxt_send_msg()

X16 Error occurred accessing/updating database

X17 Replacement node/router already defined in database

X18 Specified object already defined in database

X19 Specified object not found in database

X20 Error occurred accessing network

X21 Node is member of both source domain and destination domain, or source and destinationsubnets are not members of same domain

X22 Node’s program ID not defined

X23 No error information to report

X24 Function not currently supported for specified object

X25 Buffer length specified too short

X26 No buffers available on micro interface Neuron for outgoing message

X27 Could not verify delivery of message to destination

X28 Request failed at destination

X29 Message not received within specified time-out period

X30 Invalid message type specified

X31 Invalid service type specified

X32 lxt_lock_domain() called for domain already locked

X33 lxt_unlock_domain() called for domain already unlocked

X34 Invalid ROM version specified

X35 Invalid LON_PATH... specified

X36 Authentication not allowed with specified addressing mode

X37 Invalid command for specified destination

X38 Unexpected EOF encountered in application image

X39 Unable to open application image file

X40 EE image file does not exist

OM 136 81

X41 Unable to download, Neuron has write-protection flag set

X42 API does not support SI-SNVT/SD version present on Neuron

X43 Invalid NV value length

X44 Invalid NV value specified

X45 Invalid CritMode specified

X46 Invalid LONOpt specified

X47 Invalid application mode specified

X48 Invalid ACTION specified

X49 NULL function pointer specified

X50 Insufficient internal resources

X51 EEPROM refresh for specified node not yet due

X52 No path between specified objects

X53 Two or more routers join a given pair of channels, but do not have identical configuration

X54 Attempt to configure nonconfigurable router

X55 Conflict in node’s specified subnet/channel

X56 Domain merge requires all routers to have both source and destination domains when anynodes have network management authentication set, and LXT_MERGE_NO_AUTH notspecified

X57 Invalid binding specification

X58 In multi-node operation, at least one node failed to be updated; nodes which failed haveNODE_STATUS_ERR flag set

X59 Transaction timer/retry count exceeds node’s receive timer

X60 Application image and firmware not compatible

X61 Attempted binding of NVs with incompatible definitions

X62 Operation not consistent with state of destination node

X63 Command was aborted by user

X64 Called function locked out from using requested LNI

X65 Specified LonManager node name already in use on another LNI

X66 Clock setting obtained from node does not match clock setting defined in database

X67 Error occurred while updating configured routers during node install, download, or replace

X68 Routers defined connecting channels in a loop

X69 Database locked by another user

X70 .XIF missing or corrupted

OM 136 82

Appendix B: The No Database QuickNet Wizard

Included in the QuickNet software package is a wizard that allows you to download software, saveand restore network variable configuration data, and set subnet/node addresses (on the zero-lengthdomain)—all without setting up a database. It’s called the No Database QuickNet wizard.

The No Database QuickNet wizard offers you the advantage of being able to walk into an existingjob site and perform the above functions without taking the time to set up a dummy database—aswould be required if a standard tool such LonMaker or the main QuickNet application were used.The disadvantage of the No Database wizard is that it cannot be used on more complex networksthat have network variable or message tag bindings between nodes. On these networks a moreadvanced database tool such as the main QuickNet program must be used.

The No Database wizard normally should not be used on a network for which a PC-based databaseis available. If it is used on such a network, the database and nodes can get out of sync.

A MicroTech 2000 network that includes a MicroTech Communications Gateway (MCG) is asimple network that is in the zero length domain, has no bindings, and does not have a PC-baseddatabase; therefore, it is an ideal environment in which to use the No Database QuickNet wizard. (Asimple, custom database is maintained in the MCG controller. This database contains only networkaddresses and Neuron IDs.)

Caution If a LONWORKS PC-based database is available or if network variables are bound, do notuse the No Database QuickNet wizard to perform downloads or set addresses.

GeneralThe No Database QuickNet wizard is a series of dialog boxes that guides you through the stepsrequired to do the following:

• Download a new application program to a node

• Save configuration network variables, download a new application program to a node, andrestore configuration network variables

• Save configuration network variables only

• Restore configuration network variables only

• Set the network address of a node

Except for the set address function, all of these can be set up to work on groups of nodes. Forexample, you can easily set up a download process that will load new software into each of 100 heatpumps. Since a typical download takes about one minute, this process would likely require over1-1/2 hours. During this time, you could leave the PC or work on another PC application while thedownload takes place in the background.

OM 136 83

Figure 70. No Database Wizard, Opening Screen

The following table summarizes the available options in light of pre- and post-action node statesand network address retention.

Table 4. No Database Wizard Option Summary

No DatabaseWizard Option

Pre-actionnode state

Use this nodeidentificationmethod

Do you want toretain networkaddress?

Must target nodeand new ProgramIDs match?

Post-actionnode state

Download only Applicationless Neuron ID orService pin

N/a N/a Unconfigured

Unconfigured Neuron ID orService pin

N/a No Unconfigured

Configured Node address,Neuron ID, orService pin

No No Unconfigured

Yes No Configured

Save, download,restore

Configured Node address Yes (required) No (see note) Configured

Save only Configured Node address N/a No (see note) Configured

Restore only Configured Node address N/a No (see note) Configured

Set address Unconfigured orConfigured

Neuron ID orService pin

N/a N/a Configured

Note: When saving network variable configuration data for a group of nodes, the network variable structures (external interface)must be identical in all nodes. You can be assured of this if the Program IDs in all target nodes are the same, but this is not arequirement; i.e., the network variable structures might be identical even when the Program IDs are different. When restoringnetwork variable configuration data, the saved network variable structures must match the external interfaces of the programs in thetarget nodes. If you’re not sure, check with the node software supplier.

About DownloadingThe No Database wizard can download applications to nodes that are in the applicationless,unconfigured, or configured state. This wizard is unique in that you can download the sameapplication to many nodes in one simple process. This eases the network management scenariowhen you need to update multiple nodes. After selecting the nodes to be updated, you can let the NoDatabase wizard perform all of the download operations automatically while you perform othertasks.

OM 136 84

For nodes that are either applicationless or unconfigured, the application is downloaded and thenode is placed in the unconfigured state. For nodes that are configured (i.e., installed), theapplication is downloaded and the node either remains configured or is placed in the unconfiguredstate, depending on what you want. Configured nodes have a network address and may or may nothave network variable bindings. (Address and binding information is set and stored in a node’snetwork image.)

During a download the No Database wizard is able to retain the network address, but it is not able toretain any binding information. You can specify whether or not you want the wizard to retainaddresses with the “Retain address” checkbox. If you choose to retain network addresses, the nodesremain configured after the download. If you choose not to retain network addresses, the nodes aredeconfigured after the download.

Comparing the No Database Wizard with the Main Program’s Download WizardThe No Database wizard is similar to the Download wizard in the main QuickNet program. Themain differences are as follows:

1. In the No Database wizard, nodes can be selected by specifying their subnet/node addresses. Forthe corresponding method in the main QuickNet program’s Download wizard, nodes areselected by specifying node names (the node names are linked to subnet/node addresses in thedatabase).

2. The Download wizard in the main QuickNet program is able to retain the entire network image(including binding information) after a download. The No Database wizard is able to retainonly the address portion of the network image (this is called the domain table).

3. In order to retain the network image after a download, the Download wizard in the mainQuickNet program requires that the old and new Program IDs match. In the No Databasewizard, the old and new Program IDs do not have to match in order to retain the networkaddress portion of the network image.

About Saving and Restoring Network Variable Configuration DataThe No Database wizard can be used to save and restore node application configuration data that isstored in input network variables. This data, which is usually different than the factory defaultvalues, might include user-adjusted temperature setpoints or factory-adjusted parameters that areunique for each unit (e.g., brownout trip point settings). Saving and restoring can be done inconjunction with a download or separately, e.g., for backup purposes.

How Saving WorksWhen you select an option that saves configuration data, the wizard polls the first node in the targetlist for all of its input network variable names. It then presents this list to you so that you can chooseonly those whose values you want to save. If you have more than one node in your list of targetnodes, the wizard assumes that the variables in the first node are the same in all specified targetnodes. It is up to you to assure that all target nodes are of the same type (identical externalinterfaces). Common network variable selection is done to make the process faster—you don’t haveto reselect the same variables over and over for a group of identical nodes. If you have two or moretypes of nodes, you will need to perform separate save operations for each group of similar nodes.

Even though you select the variables once for a group of nodes, the program automatically stores thedata in those variables for each individual node. The data for each node is stored in a separate STOfile on the hard disk. The files are named according to each node’s subnet/node address; e.g.,S001N002.STO is the file for the node at address 001/002.

The save operation only works on configured nodes. Since configured nodes have subnet/nodeaddresses, the wizard requires that you select the targets with the subnet/node address identificationmethod. See “Wizard Procedures” below for more information.

OM 136 85

How Restoring WorksWhen you select an option that restores configuration data, the wizard finds the target node bydeciphering the subnet/node address from the STO file name. This means that the target node mustbe configured. It is up to you to assure that the external interface in the target node matches theexternal interface that existed in the node when the STO file was created. (An external interfacedescribes the number, type, and structure of the node’s network variables.) See “Wizard Procedures”below for more information.

Saving and Restoring Data for Pre-LonMark MicroTech 2000 Heat Pump ControllersWhen upgrading code for pre-LonMark MicroTech 2000 heat pump controllers, we recommendsaving and restoring the following 10 network variables:

• nciOccRmHtgSpt• nciOccRmClgSpt• nciUnitTimeSched• nciRmSptAdjSpan• neiOptionalOuts• nciUnitType• nciRoomTDiffSpt• nciBrownoutSpt• nviRunHours• nviCompStarts

You can save more than these if you’d like, but do not save the nviAddrAssign variable. If you do,the node’s subnet/node address will be set to 000/000 when the variable is restored.

Even though one network variable was added at version WHPE1B (changing the external interface),testing has confirmed that it is safe to save variables and then restore them to any of the followingupgraded code versions: WHPE1A, WHPE1B, or WHPE1C.

About AddressingThe No Database wizard can be used to manually set network addresses. In a LonManager API-based tool—such as the main QuickNet program—all addresses are automatically assigned by theprogram “behind the scenes” as the nodes are installed. The No Database wizard puts you in controlof addressing. This can be valuable, for example, in an MCG network when an Open Protocolsystem or Monitor software package has been set up to look for a node at a certain address and thatnode has become unconfigured. Note that when the wizard assigns an address to a node, it alsoconfigures the node.

Caution With the freedom to choose and assign addresses comes the responsibility to assure thatthere are no duplicate addresses on the network. Be careful when setting addresses with the NoDatabase wizard.

A LONWORKS network address has three components: domain ID (0, 1, 3, or 6 bytes), subnetaddress, and node address. Since the No Database wizard is intended for simple networks that are inthe zero-length domain (domain ID is 0 bytes; i.e., non-existent), only subnet and node addressescan be assigned with it. Valid subnet addresses range from 1 to 255 (decimal); valid node addressesrange from 1 to 127 (decimal).

Getting Started with the No Database WizardTo use the No Database wizard you will need the following:

• Network Interface hardware and driver (e.g., an SLTA)

• XIF and NXE files for the node application program you want to download

• A schedule of the nodes and their subnet/node addresses

OM 136 86

• A schedule of the nodes and their Neuron IDs or access to their service pin buttons (requiredonly if working with unconfigured nodes)

To use the No Database wizard

1. Click QuickNet Wizard under QuickNet on the Windows 95 Start menu.

The No Database wizard will not run at the same time as the main QuickNet program. If themain program is running on the PC, shut it down before starting the wizard.

2. Open the network interface by clicking Open on the wizard’s Network Interface menu.

The network interface hardware must be connected to the PC and the network, and its drivermust be loaded. There are several possible hardware options available. One commonly usednetwork interface is the Echelon SLTA/2, which connects to the PC’s serial port. The driver forthe SLTA/2 (LDVSLTA.SYS) is loaded via the CONFIG.SYS file; here is an example of whatthe load line might look like:

DEVICEHIGH=C:\SLTA\LDVSLTA.SYS /P1 /A

In this example, the “P1” switch refers to COM1. For COM2 you would use a “P2” switch.Refer to the user’s guide for your network interface hardware to obtain instructions on loadingits driver.

3. Select the option button you want and then click the Next button. Follow the instructions on thescreens. (See “Wizard Procedures” below for detailed instructions.)

Note To perform any operation, the No Database QuickNet wizard must be attached to a networkvia a network interface. The wizard will not let you advance past the first screen without openingthe interface.

Wizard MenusThe wizard has four menus: File, Network Interface, Preferences, and Help.

FileThe File menu contains one command: Exit. The Exit command terminates the wizard.

Network InterfaceThe Network Interface menu contains two commands: Open and Close. The Open command makesthe network accessible to the wizard. The Close command makes the network inaccessible to thewizard.

PreferencesThe Preferences menu opens the Preferences dialog box. You can specify whether you want thenetwork interface to open automatically when you start the wizard or to open when you choose theOpen command on the Network Interface menu. You can also specify the network interface name asspecified in the driver setup. (This typically defaults to LON1.)

Messages WindowThe wizard displays error messages in the Messages window. The messages include the date andtime. The Messages window has two menus: Options and Close.

The Options menu contains one command: Clear Messages. This command clears the messagesfrom the window. The window remains open.

The Close menu minimizes the Messages window. The messages remain in the window.

Error MessagesAny errors that occur are logged in the Messages window and in a LOG file, which can be found inthe Log folder, which is under the QuickNet folder. The LOG file is named with the current date,and a separate file is created for each date on which errors occur.

OM 136 87

Each error message has a reference to the target node (as applicable) and an error code. The mostcommon error code is “262,” which means that the wizard could not establish communications withthe node at the address or Neuron ID that you specified. In this case, check to make sure that thenode is connected to the network and has power. If other error codes occur, contact technicalsupport.

Wizard ProceduresThe following sections provide detailed instructions for each of the wizard option paths. Note thatthe network interface must be open to use any of these wizard options.

Download Application Image OnlyThis operation downloads an application program (NXE file) stored on your PC’s hard disk or afloppy disk into one or more specified nodes. The nodes can be in the applicationless, unconfigured,or configured state.

To download

1. Select the Download Application Image Only option button.


3. Using the three tabs, specify the target nodes.

You can use one or a combination of three methods to construct a list of targets:

• Select one or more subnet/node addresses and click the Add button

• Type a Neuron ID and click the Add button

• Press the service pin button on each node you want in the list





7. Specify the location of the application program you want to download.

Select the drive, folder (directory), and NXE file from the list boxes.

8. Select the Retain Address checkbox if you want the nodes to retain their network addresses afterthe download (this is the default). Deselect it if you want the nodes to be unconfigured after thedownload.



Save Configuration, Download, Restore ConfigurationThis operation saves the current values of the input network variables you select, loads anapplication program (NXE file) into the specified node, and restores the network variable values yousaved. You can specify more than one node for this operation. Note that the target nodes must beconfigured, and you must know their subnet/node addresses. The Neuron ID and service pinmethods of node identification are not available.

To save, download, and restore

1. Select the Save Configuration, Download, Restore Configuration option button.



Select one or more subnet/node addresses and click the Add button.

OM 136 88

Caution If you specify more than one node, all nodes must be of the same type; e.g., pre-LonMark MicroTech 2000 WSHP controller. They must have the same network variables (thevalues can be different), in the same index order, and both of these must match the networkvariables of the program being downloaded. If you’re not sure, contact the node softwaresupplier.




Caution For pre-LonMark water-source heat pumps, do not save and restore thenviAddrAssign variable (the second from the top of the list of Available Network Variables). Ifyou do, the network address will be set to zero (000/000).








10. Specify the location of the program you want to download.

Select the drive, folder (directory), and NXE file from the list boxes. The network addresses areretained so that the variables in the STO files can be restored after the download.



Save Configuration Network Variables OnlyThis operation saves the network variables you specify to a file on your hard disk. You can specifymore than one target node. A separate file is created for each node. Note that the target nodes mustbe configured, and you must know their subnet/node addresses. The Neuron ID and service pinmethods of node identification are not available.

To save configuration data

1. Select the Save Configuration Network Variables Only option button.



Select one or more subnet/node addresses and click the Add button.

Caution If you specify more than one node, all nodes must be of the same type; e.g., pre-LonMark MicroTech 2000 WSHP controller. They must have the same network variables (thevalues can be different) in the same index order. If you’re not sure, contact the node softwaresupplier.



OM 136 89


Caution For pre-LonMark water-source heat pumps, do not save and restore thenviAddrAssign variable (the second from the top of the list of Available Network Variables). Ifyou do, the network address will be set to zero (000/000).





The variables are saved and the wizard’s opening window returns. The variable files have an STOextension and are located in the LOG folder directly below the QUICKNET folder.

Restore Configuration Network Variables OnlyThis operation restores the network variable values you saved previously. The wizard determines theaddress of the node from the name of the saved configuration file. Therefore, you must know thesubnet/node addresses of the nodes you want to restore data to. Note that the nodes must beconfigured.

To restore configuration data

1. Select the Restore Configuration Network Variables Only option button.


3. Specify the location where you stored the configuration files.

The default location is the LOG folder, which is in the QUICKNET folder.

4. Select one or more data files that you want to restore.

The name of the file is of the form SxxxNyyy.STO, where the subnet address is “xxx” and thenode address is “yyy.”

5. Click the Restore button to restore the configuration files.

If you want to restore more files, go back to step 3; otherwise, go on to step 6.


The configuration data is restored to the nodes and the wizard’s opening screen returns.

Set Target Node’s Network AddressThis operation sets the network address of a node you identify with the Neuron ID.

To set an address

1. Select the Set Target Node’s Network Address option button.


3. Identify the target node by doing one of the following:

• Select the Enter Neuron ID option button and then type the Neuron ID of the target node inthe text box below.

• Select the Receive Service Pin Message option button and then press the service pin buttonon the target node. The Neuron ID will fill in the text box below when the service pinmessage is received. (Pressing the service pin button causes a node to announce its NeuronID on the network.)

4. Specify the network address using the Subnet and Node list boxes.

OM 136 90

Caution You must ensure that the network address is unique. If you specify the networkaddress of an existing node, communications will become unreliable.


The network address is assigned and the wizard’s opening window returns.

Windows Multi-select ConventionTo select a set of contiguous elements (addresses, variables, files, etc.), click the first element youwant, press and hold down the SHIFT key, and then click the last element you want. The elementsyou clicked and all those in between are selected.

To select noncontiguous elements or to add to a list of contiguous elements, press and hold down theCTRL key and click each element you want. You can also use this technique to deselect previouslyselected elements.

Service Pin Messages from Pre-LonMark WSHP ControllersFor pre-LonMark MicroTech 2000 water source heat pump controllers, it is possible to generate aservice pin message—which contains the node’s Neuron ID—using the tenant override switch onthe wall sensor instead of the service pin button on the controller board, which is often difficult toaccess. However, to use this method, the node must be configured.

To generate a service pin message

• Press and hold the tenant override switch on the wall sensor for approximately 20 seconds.

The LED will start flashing, then go to medium brightness, and then high brightness. Releasethe button any time after the LED reaches high brightness. After a few seconds, the service pinmessage will be broadcast on the network.

Note If the LED state does not change when you press and hold the tenant override switch, itis likely that the node is unconfigured.

OM 136 91

Appendix C: McQuay InternationalSoftware License Agreement (Single User Products)

Important Read carefully before opening software packet.

This is a legal agreement between you (either an individual or an entity) and McQuay International.By opening the sealed software packet, you are agreeing to be bound by the terms of this agreement.If you do not agree to the terms of this agreement, promptly return the unopened software packetand the accompanying items (including written materials and binders or other containers) to theplace of purchase.

1. Grant Of License: This license agreement permits you to use one copy of the enclosed QuickNet™ software program (the“Software”) on a single computer. The Software is in “use” on a computer when it is loaded into temporary memory (i.e.,RAM) or installed into permanent memory (e.g., hard disk, CD-ROM, or other storage device) of that computer.

2. Copyright: The Software is owned by McQuay International and is protected by United States copyright laws andinternational treaty provisions. Therefore, you must treat the Software like any other copyrighted material except you mayeither (a) make one copy of the Software solely for backup purposes or (b) transfer the Software to a single hard diskprovided you keep the original solely for backup purposes. You may not copy the written materials accompanying theSoftware.

3. Other Restrictions: You may not rent or lease the Software, but you may transfer the Software and accompanying writtenmaterials on a permanent basis provided you retain no copies and the recipient agrees to the terms of this agreement. Youmay not reverse engineer, decompile, or disassemble the Software. If the Software is an update or has been updated, anytransfer must include the most recent update and all prior versions.

Limited WarrantyMcQuay International warrants that the Software will perform substantially in accordance with the accompanying written materialsfor a period of thirty (30) days from the date of receipt. Any implied warranties on the Software are limited to thirty (30) days.Some states/jurisdictions do not allow limitations on duration of an implied warranty, so the above limitations may not apply toyou.

Customer Remedies: McQuay International’s and its distributors’ entire liability and your exclusive remedy shall be, at McQuayInternational’s option, either (a) return of the price paid or (b) replacement of the Software that does not meet McQuayInternational’s Limited Warranty and which is returned to McQuay International with a copy of your sales receipt. The LimitedWarranty is void if failure of the Software has resulted from accident, abuse, or misapplication. Any replacement Software will bewarranted an additional thirty (30) days. Neither these remedies nor any product support services are available outside the UnitedStates without proof of purchase from an authorized non-U.S. source.

No Other Warranties: To the maximum extent permitted by applicable law, McQuay International and its distributors disclaimall other warranties, either expressed or implied, including but not limited to implied warranties of merchantability and fitness for aparticular purpose, with respect to the Software and the accompanying written materials. This limited warranty gives you specificlegal rights. You may have others which vary from state/jurisdiction to state/jurisdiction.

No Liability For Consequential Damages: To the maximum extent permitted by law, in no event shall McQuay International orits distributors be liable for any damage whatsoever (including without limitation, damages for loss of business profits, businessinterruption, loss of business information, or any other pecuniary loss) arising out of the use or inability to use this McQuayInternational product, even if McQuay International has been advised of the possibility of such damages. Because somestates/jurisdictions do not allow the exclusion or limitation of liability for consequential or incidental damages, the above limitationmay not apply to you.

U.S. Government Restricted RightsThe Software and documentation are provided with restricted rights. Use, duplication, or disclosure by the Government is subject torestrictions set forth in DOD FARS 252.227-7013 or FAR 52.227, as applicable.

If you acquired this product in the United States, this agreement is governed by the laws of the State of Minnesota.

13600 Industrial Park Boulevard, P.O. Box 1551, Minneapolis, MN 55440 USA (612) 553-5330

Om 136: QuickNet MicroTech 2000 Network Mgmt Software · OM 136 6 Introduction Welcome to QuickNet...

Documents

Transcript of Om 136: QuickNet MicroTech 2000 Network Mgmt Software · OM 136 6 Introduction Welcome to QuickNet...