NodeUtil (Echelon®
Node Utility) ReadMe File
Release 1.82, March 2004
Copyright
© 1994–2004 Echelon Corporation
All Rights Reserved
NodeUtil is a simple Win32 console application that can be used with Echelon’s family of network interfaces (including the i.LON® 10 Ethernet Adapter and the i.LON 100 Internet Server) to diagnose and configure LonWorks® network interfaces, routers, and devices.
NodeUtil is not a network management tool; it will not assign destination addresses or bind network variables. Nor will it format LonMark® interoperable device information. A large number of LNS® based network management, diagnostic, monitoring and control tools are available; a directory of LNS based tools is available at http://www.echelon.com/lns. A popular LNS based network engineering tool is the LonMaker™ Integration Tool; more information about the LonMaker tool can be found at http://www.echelon.com/lonmaker. NodeUtil runs on top of LNS 3.07 or higher, or on top of OpenLDV™. The OpenLDV Installer is available for royalty-free download from http://www.echelon.com/OpenLDV.
Additional information and updates, including critical updates, may be available in Echelon’s Downloads web page at http://www.echelon.com/downloads.
4.3 Network Interface Hardware Requirements
5.5.1 (A)dd device to list (Main menu)
5.5.2 Node (A)ddress table (Device menu)
5.5.3 (B)uffer configuration (Device menu)
5.5.4 Application (C)onfiguration structures (Device menu)
5.5.5 Set the (D)omain of the network interface (Main menu)
5.5.6 Device (D)omain table (Device menu)
5.5.7 (E)xit this application and return to command prompt (Main menu)
5.5.8 (E)xit this menu and return to main menu (Device menu)
5.5.9 (F)ind devices in the current domain (Main menu)
5.5.10 Find devices in all (1)-byte domains.
5.5.11 Configuration (F)iles (Device menu)
5.5.12 (G)o to device menu (Main menu)
5.5.13 (G)o to another device (Device menu)
5.5.14 (H)elp with commands (Main menu)
5.5.15 (H)elp with device commands (Device menu)
5.5.16 Network variable al(I)as table (Device menu)
5.5.17 (J)am network variable type (Device menu)
5.5.18 Display device (L)ist (Main menu)
5.5.19 (L)ist network variables (Device menu)
5.5.20 Change device (M)ode and state. (Main and Device menus)
5.5.21 (N)etwork Variable configuration table (Device menu)
5.5.22 Redirect (O)utput to a file (Main and Device menus)
5.5.23 Send a service (P)in message (Main menu)
5.5.24 (P)oll network variable (Device menu)
5.5.25 (R)eboot 3150 device (Main menu)
5.5.26 (R)ead device memory (Device menu)
5.5.27 Report device (S)tatus and statistics (Main and Device menus)
5.5.28 (T)ransceiver parameters (Main menu)
5.5.29 (T)ransceiver parameters (Device menu)
5.5.30 (U)pdate input network variable (Device menu)
5.5.31 Control (V)erbose modes (Main and Device menus)
5.5.32 (W)ink a device (Main menu)
5.5.33 (W)rite device memory (Device menu)
5.5.34 Create e(X)ternal interface file (Device menu)
5.5.35 Download Neuron executable (Y command, Device menu)
5.5.36 Shell out to command prompt (Z command, Main menu)
NodeUtil Software License Agreement
NOTICE
This is a legal agreement between You and Echelon Corporation ("Echelon"). YOU MUST READ AND AGREE TO THE TERMS OF THIS SOFTWARE LICENSE AGREEMENT BEFORE ANY LICENSED SOFTWARE CAN BE DOWNLOADED OR INSTALLED OR USED. BY DOWNLOADING LICENSED SOFTWARE, OR INSTALLING LICENSED SOFTWARE, OR USING LICENSED SOFTWARE, YOU ARE AGREEING TO BE BOUND BY THE TERMS AND CONDITIONS OF THIS SOFTWARE LICENSE AGREEMENT. IF YOU DO NOT AGREE WITH THE TERMS AND CONDITIONS OF THIS SOFTWARE LICENSE AGREEMENT, THEN YOU SHOULD NOT DOWNLOAD OR INSTALL OR USE ANY LICENSED SOFTWARE. BY DOING SO YOU FOREGO ANY IMPLIED OR STATED RIGHTS TO DOWNLOAD OR INSTALL OR USE LICENSED SOFTWARE.
Software License Agreement
Echelon Corporation ("Echelon") grants You a non-exclusive, non-transferable license to use the copy of the Licensed Software and any updates or upgrades thereto provided by Echelon according to the terms set forth below. If the Licensed Software is being provided to you as an update or upgrade to software which You have previously licensed, then You agree to destroy all copies of the prior release of this software within thirty (30) days after this download; provided, however, that You may retain one (1) copy of the prior release for backup, archival and support purposes. As used herein,
"Licensed Software" means the NodeUtil.exe Windows executable file and this Readme.htm file.
"Network Adapter" means any product in the following product families: the i.LON(r) 10 Ethernet Adapter, i.LON 100 Internet Server, LTS-20 SLTA Core Module, PCC-10 PC Card Network Adapter, PCLTA-10/20 Network Adapter, PL-SLTA Power Line Serial LonTalk(r) Adapter, SLTA/10 Serial LonTalk Adapter, and any updates thereof and replacements thereto.
"You(r)" means the company, entity or individual who downloads the Licensed Software from a web site on which Echelon has made it available, or who has otherwise rightfully acquired the Licensed Software.
LICENSE
You may:
(a) download the Licensed Software onto Your computer,
(b) make a limited number of copies of the Licensed Software solely for backup purposes, provided that You reproduce, unaltered, all proprietary notices on or in the copies, and
(c) use, reproduce and distribute the Licensed Software, in binary form only, solely for use with a Network Adapter, provided that you reproduce, unaltered, all proprietary notices on or in the copies. You may not modify any of the Licensed Software files.
You remain solely responsible for support, services, upgrades or other technical assistance for Your customers ("Support") with respect to the Licensed Software, and will indemnify and hold Echelon harmless from all loss, cost liability and expense arising from Your use or distribution of the Licensed Software ("Indemnification"). You agree that the foregoing Support and Indemnification obligations are provided by you in partial consideration for the rights granted to You hereunder.
You may not and shall not permit others to:
(a) copy the Licensed Software (except as expressly permitted above),
(b) modify or translate any Licensed Software,
(c) modify, translate, reverse engineer, decompile, disassemble or otherwise attempt (i) to defeat, avoid, bypass, remove, deactivate, or otherwise circumvent any software protection mechanisms in the Licensed Software, including without limitation any such mechanism used to restrict or control the functionality of the Licensed Software, or (ii) to derive the source code or the underlying ideas, algorithms, structure or organization from the Licensed Software,
(d) distribute, rent, transfer or grant any rights in the Licensed Software (except as expressly permitted above) in any form to any person without the prior written consent of Echelon,
(e) use the Licensed Software with LonWorks network adapters not manufactured by Echelon, or
(f) without limiting the foregoing, use the Licensed Software to build a LonTalk Protocol analyzer or otherwise to gain access to messages on a LonTalk channel that are not addressed at LonTalk Layer 5 or higher to the Network Adapter.
This license is not a sale. Title and copyrights to the Licensed Software and any copies made by you remain with Echelon and its suppliers. Unauthorized copying of the Licensed Software, or failure to comply with the above restrictions, will result in automatic termination of this license and will make available to Echelon other legal remedies.
TERMINATION
This license will continue until terminated. Unauthorized copying of the Licensed Software or failure to comply with the above restrictions will result in automatic termination of this Agreement and will make available to Echelon other legal remedies. This license will also automatically terminate if You go into liquidation, suffer or make any winding up petition, make an arrangement with Your creditors, or suffer or file any similar action in any jurisdiction in consequence of debt. Upon termination of this license for any reason, You will destroy all copies of the Licensed Software. Any use of the Licensed Software after termination is unlawful.
TRADEMARKS
You may not use Echelon's name, logo or trademarks, except that You may make appropriate and truthful reference to Echelon and Echelon products and technology in Your company and product literature, in accordance with Echelon's guidelines for use of its trademarks and provided that you properly attribute Echelon's trademark. No license is granted, express or implied, under any Echelon trademarks, trade names or service marks.
LIMITED WARRANTY AND DISCLAIMER
THIS LICENSED SOFTWARE IS PROVIDED "AS IS" WITHOUT REPRESENTATION, WARRANTY OR CONDITION OF ANY KIND, EXPRESS, IMPLIED OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR ANY PARTICULAR PURPOSE AND NONINFRINGEMENT. The entire risk as to the quality and performance of the Licensed Software is borne by Recipient. Should the Licensed Software prove defective, Recipient and not Echelon assumes the entire cost of any service and repair.
SOME STATES OR OTHER JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO THE ABOVE EXCLUSIONS MAY NOT APPLY TO YOU. YOU MAY ALSO HAVE OTHER RIGHTS THAT VARY FROM STATE TO STATE AND JURISDICTION TO JURISDICTION.
LIMITATION OF LIABILITY
IN NO EVENT WILL ECHELON OR ITS SUPPLIERS BE LIABLE FOR LOSS OF OR CORRUPTION TO DATA, LOST PROFITS OR LOSS OF CONTRACTS, COST OF PROCUREMENT OF SUBSTITUTE PRODUCTS OR OTHER SPECIAL, INCIDENTAL, PUNITIVE, CONSEQUENTIAL OR INDIRECT DAMAGES ARISING FROM THE SUPPLY OR USE OF THE LICENSED SOFTWARE, HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY (INCLUDING NEGLIGENCE). THIS LIMITATION WILL APPLY EVEN IF ECHELON OR AN AUTHORIZED DISTRIBUTOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES, EXCEPT TO THE EXTENT THAT LIABILITY MAY NOT BY LAW BE LIMITED OR EXCLUDED, AND NOTWITHSTANDING THE FAILURE OF ESSENTIAL PURPOSE OF ANY LIMITED REMEDY. IN NO EVENT SHALL ECHELON'S LIABILITY EXCEED ONE THOUSAND DOLLARS ($1,000). YOU AGREE THAT THE FOREGOING LIMITATIONS REFLECT A REASONABLE ALLOCATION OF RISK.
SOME STATES OR OTHER JURISDICTIONS DO NOT ALLOW THE EXCLUSION OR LIMITATION OF LIABILITY FOR INCIDENTAL OR CONSEQUENTIAL DAMAGES, SO THE ABOVE LIMITATIONS AND EXCLUSIONS MAY NOT APPLY TO YOU.
SAFE OPERATION
YOU ASSUME RESPONSIBILITY FOR, AND HEREBY AGREE TO USE YOUR BEST EFFORTS IN, DESIGNING YOUR PRODUCTS TO PROVIDE FOR SAFE OPERATION THEREOF, INCLUDING, BUT NOT LIMITED TO, COMPLIANCE OR QUALIFICATION WITH RESPECT TO ALL SAFETY LAWS, REGULATIONS AND AGENCY APPROVALS, AS APPLICABLE. THE NEURON® CHIP, LONTALK PROTOCOL, NEURON CHIP FIRMWARE, NETWORK ADAPTERS, AND THE LICENSED SOFTWARE ARE NOT DESIGNED OR INTENDED FOR USE AS COMPONENTS IN EQUIPMENT INTENDED FOR SURGICAL IMPLANT INTO THE BODY, OR OTHER APPLICATIONS INTENDED TO SUPPORT OR SUSTAIN LIFE, FOR USE IN FLIGHT CONTROL OR ENGINE CONTROL EQUIPMENT WITHIN AN AIRCRAFT, OR FOR ANY OTHER APPLICATION IN WHICH THE FAILURE OF THE NEURON CHIP, LONTALK PROTOCOL, NEURON CHIP FIRMWARE, NETWORK ADAPTERS, OR THE LICENSED SOFTWARE COULD CREATE A SITUATION IN WHICH PERSONAL INJURY OR DEATH MAY OCCUR, AND YOU SHALL HAVE NO RIGHTS HEREUNDER FOR ANY SUCH APPLICATIONS.
COMPLIANCE WITH EXPORT CONTROL LAWS
You agree to comply with all applicable export and reexport control laws and regulations, including the Export Administration Regulations ("EAR") maintained by the United States Department of Commerce. Specifically, You covenant that You shall not -- directly or indirectly -- sell, export, reexport, transfer, divert, or otherwise dispose of any software, source code, or technology (including products derived from or based on such technology) received from Echelon under this Agreement to any country (or national thereof) subject to antiterrorism controls or U.S. embargo, or to any other person, entity, or destination prohibited by the laws or regulations of the United States, without obtaining prior authorization from the competent government authorities as required by those laws and regulations. You agree to indemnify, to the fullest extent permitted by law, Echelon from and against any fines or penalties that may arise as a result of Your breach of this provision. This export control clause shall survive termination or cancellation of this Agreement.
LANGUAGE
The parties hereto confirm that it is their wish that this Agreement, as well as other documents relating hereto, have been and shall be written in the English language only.
Les parties aux présentes confirment leur volonté que cette convention de même que tous les documents y compris tout avis qui s'y rattache, soient rédigés en langue anglaise.
GENERAL
This Agreement shall not be governed by the 1980 U.N. Convention on Contracts for the International Sale of Goods; rather, this Agreement shall be governed by the laws of the State of California, including its Uniform Commercial Code, without reference to conflicts of laws principles. This Agreement is the entire agreement between us with respect to the Licensed Software. This Agreement supersedes any other communications or advertising with respect to the Licensed Software. If any provision of this Agreement is held invalid or unenforceable, such provision shall be revised to the extent necessary to cure the invalidity or unenforceability, and the remainder of the Agreement shall continue in full force and effect. If You are acquiring the Licensed Software on behalf of any part of the U.S. Government, the following provisions apply. The Licensed Software and documentation thereto are deemed to be "commercial computer software" and "commercial computer software documentation", respectively, pursuant to DFAR Section 227.7202 and DFAR Section 12.212, as applicable. Any use, modification, reproduction, release, performing, displaying, or disclosing of the software or documentation by the U.S. Government shall be governed solely by the terms of this Agreement and shall be prohibited except to the extent expressly permitted by the terms of this Agreement. Any technical data provided that is not covered by the above provisions is deemed to be "technical data-commercial items" pursuant to DFAR Section 227.7015(a). Any use, modification, reproduction, release, performance, display or disclosure of such technical data shall be governed by the terms of DFAR Section 227.7015(b).
Echelon, LonMark, LonTalk, LonWorks, LNS, i.LON and Neuron are registered trademarks of Echelon Corporation in the U.S. and other countries. LonMaker, LonSupport and OpenLDV are trademarks of Echelon Corporation in the U.S. and other countries.
The following are minimum requirements:
The following are minimum requirements:
* Although NodeUtil will work just fine on LNS 3.07 or LNS 3.08 Update 1 without OpenLDV 1.0, it is recommended to install OpenLDV 1.0 anyway. The reason is that OpenLDV 1.0 enforces exclusivity of the OpenLDV interface, so that for instance if an end-user tries to run an LNS application (such as LonMaker Integration Tool) and NodeUtil (or any other OpenLDV application) at the same time, only the first accessor will succeed. When using LNS 3.0x without OpenLDV 1.0, an end-user can start any number of LNS applications (which is allowed) and a single copy of NodeUtil. As soon as NodeUtil is started on the same network interface along with LNS applications, both NodeUtil and all LNS applications will start failing to receive all network messages. So if you don’t install OpenLDV 1.0 any any single time either run any number of LNS applications, or NodeUtil by itself.
NodeUtil is licensed for use with the network interface products from Echelon listed below:
Before invoking NodeUtil, make sure that the network interface driver for the selected network interface is installed, and is appropriately configured for your hardware. See the documentation for your selected network interface for details. Also, you will need either OpenLDV 1.0 or LNS 3.07 or higher, installed. It’s OK to have both OpenLDV 1.0 and LNS 3.07 or higher installed, if you wish.
Open a command prompt by clicking Start, pointing to All Programs, pointing to Accessories, and then clicking Command Prompt. Set the path to the folder where the NodeUtil executable resides.
NodeUtil accepts command line arguments, with the following form:
NodeUtil [-D<interface name>] [-V] [-A] [-S] [-I<infile>] [-O<outfile>]
If an invalid option is specified, NodeUtil will display a help message.
The -D switch specifies the network interface name to use (the default is -DLON1). To specify an i.LON(r) 10 or i.LON 100, use the form x.<Profile>.<i.LON name>. For instance, -Dx.Default.iLONatHQ would specify using the Default xDriver profile, with the iLONatHQ i.LON. See the OpenLDV Programmer’s Guide, and OpenLDV Programmer’s Guide, xDriver Supplement for details.
The -V option causes NodeUtil to start up in verbose mode. In this mode, the software displays all network interface messages in detail.
The -A option causes NodeUtil to start up in application mode. In this mode, NodeUtil does not configure the network interface, and does not accept service pin messages. By default, NodeUtil assigns the network interface to a random subnet address in the zero length domain with a node ID of 126, and sets the network interface to the configured state.
The -S option causes NodeUtil to use slower transaction timers, suitable for use with PL-20 power line channels. By default, NodeUtil uses transaction timers that are suitable for FT-10 channels.
The –I option allows input from a properly formatted text file instead of from the keyboard. The –I option is for advanced users only, and there is no additional documentation available on this option at this time. If you wish to write scripts for NodeUtil to execute, it is suggested that you use the –O option to record the sequence that you want to duplicate, and then edit the output file into an input file.
The –O option writes all of the output from NodeUtil not just to the command prompt window but to the filename specified.
NodeUtil will display a sign-on message, and a menu of commands. If there is any problem in opening the network interface driver, error messages will be displayed and NodeUtil will exit back to the command prompt. If this happens, check that the network interface driver is loaded correctly, that you have OpenLDV 1.0 or LNS 3.07 or higher installed, and that your network interface hardware is correctly configured.
If NodeUtil succeeds in opening the network interface driver, it will display the message:
Echelon Node Utility Release 1.82
Successfully installed TP/FT-10 network interface.
Welcome to the Echelon Node Utility application.
Activate the service pin on remote device to access it.
Enter one of the following commands by typing the indicated letter:
This is followed by the NodeUtil Main menu.
Note that any of the commands listed below may be aborted by pressing the Escape key on the keyboard.
The Main menu for NodeUtil is as follows:
A -- (A)dd device to list.
D -- Set the (D)omain of the network interface.
E -- (E)xit this application.
F -- (F)ind devices in the current domain.
1 -- Find devices in all (1)-byte domains.
G -- (G)o to device menu....
H -- (H)elp with commands.
I -- Redirect (I)nput from a file.
L -- Display device (L)ist.
M -- Change device (M)ode or state.
O -- Redirect (O)utput to a file.
P -- Send a service (P)in message.
R -- (R)eboot 3150 device.
S -- Report device (S)tatus and statistics.
T -- (T)ransceiver parameters.
V -- Control (V)erbose modes.
W -- (W)ink a device.
Z -- Shell out to command prompt.
NodeUtil>
Type the indicated letter to invoke the corresponding command.
The G, M, R, S, and W commands will prompt you to enter an ID for the device you wish to address with the command. NodeUtil maintains a directory of devices that it knows about, indexed by ID number. This directory initially contains only the network interface itself, which has an ID of 0. For most of these commands, the default device is the last device in the directory.
One way to add a device to the device directory is to attach the device to the network and activate its service pin. When NodeUtil receives the service pin message, it will display the program ID of the device. Subsequent service pin messages from the same device will be ignored. If the service pin message is received from a router, two entries will be made in the device directory; the first entry will be for the router near side (the side attached to the network interface), and the second entry for the router far side.
A second way to add devices to the device directory is to execute either the Find devices in all (1)-byte domains or the (F)ind devices in the current domain command. All unconfigured devices, and devices configured in all 1-byte domains, or in the configured domain of the network interface, as appropriate to the command selected, will be added to the device directory.
A third way to add devices to the device directory is to execute the (A)dd device to list command. You will be prompted to enter the 6-byte Neuron ID of the device you wish to add to the directory.
The G command will display a secondary menu of commands to display various data structures within the Neuron. This menu is modal—the G command will prompt you to enter an ID for the device you wish to address, and the prompt will change to DEVICE:x> , where x is the ID of the device for the device menu. For descriptions of the information displayed by the Device menu commands see the FT 3120® / FT 3150® Smart Transceiver Data Book available from http://www.echelon.com/products.
The device command menu for NodeUtil is as follows:
A -- Device (A)ddress table.
B -- (B)uffer configuration.
C -- Application (C)onfiguration structures.
D -- Device (D)omain table.
E -- (E)xit this menu and return to main menu.
F -- Configuration (F)iles. **
G -- (G)o to another device.
H -- (H)elp with device commands.
I -- Network variable al(I)as table. **
J -- (J)am network variable type. **
K -- Chec(K) Neuron executable. **
L -- (L)ist network variables. **
M -- Change device (M)ode or state.
N -- (N)etwork Variable configuration table. **
O -- Redirect (O)utput to a file.
P -- (P)oll network variable. **
Q -- (Q)uickly send a message.
R -- (R)ead device memory.
S -- Report device (S)tatus and statistics.
T -- (T)ransceiver parameters.
U -- (U)pdate input network variable. **
V -- Control (V)erbose modes.
W -- (W)rite device memory.
X -- Create device interface ((X)IF) file. **
Y -- Download Neuron executable. **
** These commands are not available for the network interface, or for routers.
Allows you to manually enter the Neuron ID of a device that you wish to add to the device directory. Enter the Neuron ID as six hex values, separated by spaces. If NodeUtil can communicate with the device, it will be added to the directory.
Displays a selected address table entry, or the whole address table of the indicated device. For a description of the address table entry fields, see the FT 3120® / FT 3150® Smart Transceiver Data Book available from http://www.echelon.com/products.
Displays the buffer configuration of the indicated device. For buffer configuration information, see the FT 3120® / FT 3150® Smart Transceiver Data Book available from http://www.echelon.com/products. After displaying the current buffer configuration, you will then be given the opportunity to change the configuration, one value at a time. For each value, the default value is the current setting. If the value you enter is not a valid value, you will either be prompted again, or the next larger valid value will be substituted. At the end of this process, the new configuration will be displayed, and you will be given an opportunity to cancel the command before the new values are written to the device. Note that if you configure the device to use more RAM than is actually available, the device will most likely crash. If the device is Neuron 3120 based, it may not be recoverable. If it is based on the Neuron 3150, you may be able to recover it with the (R)eboot command of NodeUtil. If the device is not recoverable with the reboot command of NodeUtil, you can use the EEBLANK program available from http://www.echelon.com/downloads.
Displays data from the Read-only and Configuration data structures of the indicated device. For a description of the Read-only and Configuration data structures, see the FT 3120® / FT 3150® Smart Transceiver Data Book available from http://www.echelon.com/products.
Displays the first domain table entry of the network interface. You will then be given the opportunity to change this data. Enter the desired domain ID length (0, 1, 3 or 6 bytes), followed by the ID values in hex, separated by spaces. The default domain ID is all zeroes.
Following this, you will be asked to enter the subnet ID that you wish to assign to the network interface. The node ID in that subnet is fixed at 126 decimal, or 7E hex. You will then be asked to enter the authentication key to use for that domain table entry. Enter the key as hex bytes separated by spaces. The default key is 0xFF for all bytes.
The second domain table entry of the network interface is always set to the zero length domain for the purpose of receiving service pin messages.
The (F)ind Devices command broadcasts on the domain you assign to the network interface. Changing the domain and subnet to the configured domain for the network is especially useful if your network contains routers. Normally, routers are set to the Configured mode, as that mode is the most bandwidth efficient. In the Configured mode, routers will only pass messages for the configured domains. If the routers are set to the Repeater mode, though, it may not be necessary to modify the domain and subnet node address of the network interface in order to find devices on domains, because the routers will pass valid messages sent on any domain.
Changing the authentication key is useful if you wish to update network variables that have been configured as authenticated. An update to an authenticated network variable must be sent using a domain in which the target device is configured, using the correct authentication key.
At the end of this process, you will be given an opportunity to cancel the command before the new domain entry is written into the device.
Displays a selected domain table entry, or the whole domain table of the indicated device.
Exits from NodeUtil. The device directory is not saved, and will need to be rebuilt when NodeUtil is invoked again.
Exits from the Device menu, and returns to the Main menu. The prompt becomes NodeUtil> again.
Issues a domain-wide broadcast to all devices to respond to the query message, and then queries all devices for their identification. Each new device is added to the device directory. This command is useful when the service pins of the remote devices are not accessible. It will discover unconfigured and application-less devices, as well as devices that are configured in the domain of the network interface. To query for devices configured in a specific domain, use the Set (D)omain command before the (F)ind Devices command.
Issues a domain-wide broadcast in each of the 1-byte domains asking that all devices to respond to the query message, and then queries all devices found for their identification. Each new device is added to the device directory. This command is useful when you do not know the domain of the devices in the network, and you are not able to physically access the devices in order to invoke the service pin function. It will discover unconfigured and applicationless devices, as well as devices that are configured in the domain of the network interface. This command remembers the domain information in the network interface before the command was started, and rewrites the domain information back into the network interface when the command completes. Since this command takes a long time to complete, you may interrupt the command by pressing any key on the keyboard. To query for devices configured in a specific domain, use the Set (D)omain command before the (F)ind Devices command.
Reads the configuration parameter template file from the indicated device, and interprets the contents. This command is supported only for Neuron based devices that have a LonMark compliant device object which allows for direct memory read access to the configuration files. Enter the index of the network variable of type SNVT_address which points to the file directory. The SCPT template file is checked for syntax errors.
Displays the device list, and switches to the Device menu. Enter the ID of the device you wish to address. The prompt changes to DEVICE:x>, where x is the ID of the device for the Device menu. To return to the Main menu, use the (E)xit command.
Displays the device list, and allows you to select another device for Device menu operations. The prompt changes to DEVICE:x>, where x is the ID of the selected device.
This command (or any other unrecognized command character) displays the Main menu again.
This command (or any other unrecognized command character) displays the Device menu again.
Displays a selected network variable alias table entry, or the whole network variable alias table of the indicated device.
Reads the network variable self-documentation information from the indicated device. Enter the index of the network variable whose type you wish to change, and the SNVT index of the new type. This command can only be used on Neuron based devices which have specified one of the Neuron C pragmas snvt_si_eecode or snvt_si_ramcode.
Displays a list of the devices in the directory. The list includes the network interface, devices, and routers. For each device (and for each side of a router), the Device ID (used only within NodeUtil), Neuron ID, Program ID and plain text interpretation of the Program ID (if it is a plain text Program ID), is displayed.
Displays the self-documentation and other network variable information available on the selected device, in Neuron C source format. The information may be saved in a file with the extension .HC. If the device is LonMark certified or LonMark compliant, the device and network variable self-documentation strings will be interpreted and checked for errors.
Allows you to change the device's mode or state. If you invoke this command from the main menu, you are prompted to enter a device ID. The default is [all] devices, meaning that the change mode or state message is sent as a broadcast to all devices configured in the current domain.
The choices for device mode are (R)eset, o(N)line, o(F)fline, and (S)tate change. Type the indicated letter to invoke the corresponding command. For a description of these modes, see the FT 3120 / FT 3150 Smart Transceiver Data Book available from http://www.echelon.com/products. If you select (R)eset, o(N)line, or o(F)fline, the corresponding message will be sent to the device. If you select (S)tate change, you will be prompted to select the new state for the device. The choices are (A)ppl-less, (U)ncfg, (C)nfg, and (H)ard offline. Type the indicated letter to invoke the corresponding command. For a description of these states, see the FT 3120 / FT 3150 Smart Transceiver Data Book available from http://www.echelon.com/products.
If the device is a router, the device mode choices are (R)eset, o(N)line, o(F)fline, (S)tate change, and Routing (M)ode. If you invoke the Routing (M)ode command, you will be prompted for the algorithm. The choices are (C)onfigured, (L)earning, (B)ridge, and (R)epeater. Type the indicated letter to invoke the corresponding command. For a description of these choices, see the LonWorks Router User's Guide available from http://www.echelon.com/products.
Displays a selected network variable configuration table entry, or the whole network variable configuration table of the indicated device. For a description of the network variable configuration table structure and its elements, see the FT 3120 / FT 3150 Smart Transceiver Data Book available from http://www.echelon.com/products.
Redirects all screen output from NodeUtil to a file. You will be prompted for the name of a file. The default file extension is .LOG. If the file already exists, you will be asked if you wish to (O)verwrite the file from the beginning, or (A)ppend output to the end of the file. To stop redirection, enter a null file name. This command is useful for saving the output of any of the other NodeUtil commands.
This command will cause the network interface to send out a service pin message.
Fetches the value of a selected network variable, or every network variable on the indicated device. Enter the index of the network variable on the device, or <Enter> for all variables. The data fetched from the network variable will be displayed in hexadecimal bytes, and may be further interpreted depending on its length.
Restores the contents of the on-chip EEPROM memory of the indicated device to the state it had when the off-chip EPROM was first installed.
Use this command with caution.
This command will restore the communications parameters, device state, buffer configuration and on-chip EEPROM variables, and re-initialize the domain, address, and network variable configuration tables.
This command does not operate on a Neuron 3120 based device.
If the (R)eboot command is executed on the network interface used to run NodeUtil, it will be reconfigured so that it can continue to be used.
Enter the starting address for the read operation in hexadecimal, and then enter the number of bytes you wish to read in hexadecimal. The memory will be read from the device and displayed in hexadecimal bytes. If you wish to save the output to a file, invoke the Redirect (O)utput command before the (R)ead Memory command.
Sends a message to query the status of the indicated device, and displays the results. For a description of the meanings of the returned values, see the FT 3120 / FT 3150 Smart Transceiver Data Book available from http://www.echelon.com/products. If the status and statistics of a router are being requested there will be additional information displayed, such as the router algorithm and mode. For a description of the meanings of these router-specific values, see the LonWorks Router User’s Guide available from http://www.echelon.com/products.
You will then be given an opportunity to clear the status of the device, which clears the error counters, the reset cause and the last error logged.
Displays the transceiver ID of the network interface, and allows you to set the transceiver ID for network interfaces with software-configurable transceiver IDs.
For all network interfaces, this command then allows you to change the transceiver parameters for the network interface. See the description for the (T)ransceiver parameters command in the Device menu.
Displays the transceiver (communications) parameters of the indicated device. The information displayed will depend on the transceiver type. For a description of the meanings of these values, see the FT 3120® / FT 3150® Smart Transceiver Data Book available from http://www.echelon.com/products.
If the network interface supports it, you will then be given an opportunity to change the input clock rate by selecting from a menu. The choices are 5, 10 and 20 MHz. You will then be given an opportunity to change the transceiver parameters by selecting from a menu. The choices depend on the Neuron input clock rate.
NodeUtil does not support changing the transceiver parameters for devices with input clocks less than 5 MHz.
If the device implements the Transceiver ID (XID) pins, then you will normally not be able to change the interface bit rate or the transceiver type (differential, single-ended or special-purpose). To change types of devices, you you must physically set the value read from the XID pins to 30 decimal, or 1E hex first.
Selecting incorrect communications parameters may make it impossible to communicate with the device over the network. If the device contains one of Neuron 3120s or the FT 3120, it may not be recoverable. If it is based on the Neuron 3150 or the FT 3150, you will be able to recover it using the EEBLANK program available from http://www.echelon.com/downloads.
Allows you to update an input network variable on the indicated device. Enter the index of the network variable on the device. The current data in the network variable is displayed. At the prompt, enter the data to be sent to the network variable in hexadecimal bytes. Separate each pair of hex digits with a space, and enter all the required data on one line. The data values default to zero.
If the network variable has been configured as authenticated, you should use the Set (D)omain command to configure the network interface with a domain and authentication key to match those of the destination device.
Enables or disables two verbose modes in the NodeUtil application. These are useful for debugging network problems.
Display network interface messages - this mode displays the contents of all application buffers going to and coming from the network interface. By default, it is off.
Display traffic summary - this mode reports any incoming message addressed to the application processor on the network interface. By default, it is on.
Sends the wink message to a device. If the device has been programmed to respond to this message, it will activate the wink task. When you are prompted to enter a device ID for this command, the default is [all] devices, meaning that the wink message is sent as a broadcast to all devices configured in the current domain.
You will be prompted to enter the starting address for the write operation in hexadecimal. The contents of each memory address will be first read and displayed in hexadecimal. If you do not wish to change the data, press <Enter>, and the next byte will be displayed. If you wish to change the data for that address, enter the new data byte in hexadecimal, followed by <Enter>. To terminate the process, enter some non-hexadecimal character, for example a period (.) before pressing <Enter>.
If you have changed any of the data in memory, you will be given the opportunity to update both the application and configuration checksums, or just the configuration checksum. For a description of which data structures are part of each of these checksums, see the FT 3120 / FT 3150 Smart Transceiver Data Book available from http://www.echelon.com/products.
The device should be in the applicationless state before you change any of the application image memory, otherwise the device will report an application checksum error. Similarly, the device should be in the applicationless or unconfigured state before you change any of the network image memory, otherwise the device will report a configuration checksum error.
Creates a version 3 external interface file (.XIF extension) for the indicated device. You will be prompted to enter a name for the external interface file to be created. If the device has an alphanumeric program ID, this ID becomes the default filename. The default extension is .XIF. If output redirection is in effect, the current output file is closed before creating the external interface file. The generated external interface file can be used as input to any Echelon or third-party LNS based tool, including the LonMaker Integration Tool.
Download a Neuron application to a device. This command takes as input the Neuron Executable File (.NXE) that is generated by the NodeBuilder or LonBuilder development tools. If the device already contains an alphanumeric application ID, this name is the default for the .NXE file name. Enter the name of your .NXE file. The filename extension defaults to .NXE, and both Intel and Motorola file formats are acceptable. The Neuron application is then downloaded to the device.
If the download was successful, you will then be asked if you want to set the device configured, on-line. Answer Yes to this question only if the device already contains a valid network configuration for this application. By default, the device will be set to the unconfigured state. This command will then read the state of the device and display any errors that may have occurred.
This command does NOT check that the .NXE file that you are loading iscompatible with the device hardware configuration. Before loading an application to a device, you should make sure that the .NXE file was linked using the correct Neuron model and firmware version for your target device. And for Neuron 3150 based devices, that the .NXE file was linked using the correct memory map for the device.
If an incompatible .NXE file is loaded to the device, the device will most probably start watchdog resetting. You may be able to recover it by downloading a compatible .NXE file. If not, you can recover Neuron 3150 based devices using the EEBLANK program available from http://www.echelon.com/downloads. However, Neuron 3120 based devices may be totally unrecoverable.
If you attempt to set the device to the configured state after loading, but the device does not contain a valid network configuration for this application, then the Neuron System Image will detect a configuration checksum error and set the device to be unconfigured.
Allows you to temporarily return to a command prompt without losing the device directory. Type EXIT at the command prompt to return to NodeUtil.
Echelon welcomes your comments on the NodeUtil software. Please direct any non-technical support comments to OpenLDV@echelon.com.