About the Lon Utilities Manager

The Lon Utilities Manager view of a LonNetwork (Figure 30) provides the means to perform a variety of queries to both devices in the LonNetwork and discovered nodes.

Figure 30. Lon Utilities Manager view of a LonNetwork


Lon Utilities Manager view of a LonNetwork


See the following additional Lon Utilities Manager sections for more details:

Building a utility command

Build a command in the Lon Utilities Manager by using drop-down controls at the bottom of the view.

Figure 31. Building a command in Lon Utilities Manager


Building a command in Lon Utilities Manager

As shown in Figure 31, to build a command you:

  • Select Device—list includes both devices in the database, as well as discovered nodes.

  • Select main Command—list includes Status, Data Structs, File, Identify, Reports, Find.

  • Select SubCommand—list differs according to the selected command (“Data Structs” sub-commands are shown in Figure 31).

After you build the command, click Execute to see results in the utilities manager view.

NoteStarting in AX-3.5 and build 3.4.55 and later, text labels appear beside the selection fields for Device, Command, and SubCommand, as shown in Figure 31.

Types of Lon utility commands

Main commands available in the Lon Utilities Manager include the following:

Status, Data Structs, File, Identify, Reports, Read Mem, and Find.

Status

Use this command to display real-time status for a node, or to perform some other network management operation that affects its status. The following sub-commands are available:

  • Display

    Issues a query status message to the node. This retrieves the network error statistic accumulators, cause of the last reset, current state of node, and the last runtime error logged.

  • Clear

    This sends a message to the node to clear its error flag and error counts. After this is processed, the status display for the node updates. Following a clear, you can use the display sub-command to gauge the effects of network traffic on the node.

  • Set Unconfigured

    This sets the node’s internal and database state to unconfigured, and displays new node status. In an unconfigured state, a node’s application is loaded, but configuration data is either not loaded or deemed to be corrupted due to a configuration checksum error.

    When unconfigured, a node responds to status query messages with its Neuron ID rather than subnet/node addressing. Network variables do not update, and its service LED blinks at a once-per-second rate.

  • Set Online

    This sets a node to an online state, and is provided as a convenience for a device not represented in the station database. From a Lon device’s property sheet, under the Device Data slot, you can directly access and write to a device’s Node State. See DeviceData.

  • Reset

    Issues a software reset to the node, and displays new status.

Data Structs

Use this command to display various internal device tables and structures. The following sub-commands are available:

  • Address Table

    Defines the network addresses to which the node can send implicit messages and nv updates, and also the groups to which the node belongs. Up to 15 address entries are possible.

  • Domain Table

    Defines the domain(s) to which the node belongs. Up to two domains can be assigned.

  • Read Only Structure

    Defines the node’s identification as well as some of the application image properties of the node.

  • Config Structure

    Defines the hardware and transceiver properties of the node, and resides in its EEPROM. Some portions are written by the manufacturer, while other fields are written when the node is installed.

  • Nv Alias Table

    Defines configuration attributes of the alias network variables in the node. Aliases allow an nv in one controller to be linked to multiple nvs in another (single) controller.

  • Nv Config

    Defines the configurable attributes of the network variables in the node. Up to 62 entries are possible.

  • Nv Value

    Displays raw (hex data) values for nvs in the node, without any conversion (as provided for the nv LonComponents or nv proxy points). Can be used to verify against values seen in Niagara.

  • Self Documentation

    Displays the self-documentation available in the node. This capability must be provided for a device to have the LonMark logo.

File

This command lets you display internal files of any selected Lonworks device, providing that it supports files. The following sub-commands are available:

  • File Directory

    Shows list of available files, including type and size.

  • Config Template File

    Shows template file entries.

  • Config Value File

    Shows config value file entries, and bytes.

  • Other

    Shows files other than template and value files.

Identify

Use these commands to identify a node in the field. Basically, commands are either “wink” (send to node) or “service pin” (send from node). The following sub-commands are available:

  • Wink

    Use this to send a wink message to a selected node, whereby, depending on the device, it typically visually (or audibly) indicates receiving the message—for example, flashing an LED in a pattern.

    NoteBefore executing this command, select the specific device from the drop-down list.

  • Service Pin

    (Device selection is not used for this command.) This command causes the Lon Utilities Manager to listen on the network for a node to identify itself. In this mode, the utilities manager displays “Waiting on a service pin.”

    When the service pin of a Lonworks device is pushed, that node sends its domain table to the utilities manager, where it displays in the view. For more details, see Service pin notes.

  • Clear Service Pin

    Use this command to cancel a pending Service Pin command.

Reports

Use these commands to display various reports for networked nodes, including network management data, transmit errors data, and to discover (verify) inconsistencies in the station database (against what is actually stored inside nodes that are online).

The following sub-commands are available:

  • Netmgmt Summary

    Provides a summary of network links, address table entries, and group assignments.

  • Program Ids

    Lists the current program IDs with associated module and lnml file or class.

  • Transmit Errors

    Creates and displays a table of various transmission error counts for all nodes on the network. This command results in a “status clear” sent to all nodes, such that error counts are reset—the next report shows counts since this report was created.

  • Transmit Errors No Clear

    Creates and displays a table of various transmission error counts for all nodes on the network. Does not clear device status in nodes (unlike Transmit Errors command).

  • Verify

    Compares the networked devices’ nv configuration and address table entries against the station’s database (Lon device’s properties) and reports discrepancies.

    Depending on the selected device, the verify report scope varies:

    • If LocalLonDevice is selected device, the report verifies all networked Lon devices.

    • If any other device is selected device, the report verifies only that device.

  • Network Summary

    Creates a table of devices showing channel, subnet/node address, and Neuron ID. Also shown are routers (if any).

Read Mem

This command provides a (starting) address field and len(gth) field in which you can enter values, using hexadecimal notation, to read “raw” memory contents of the selected device. Results display in hex bytes as well as ASCII characters, using 16 byte rows listed by address location.

For example, if you enter address of 01FC and len of FF, you see 16 rows of data from 01FC through 02EC.

Find

This command discovers nodes on the network (that are not already represented in the station by a Lon device). It is equivalent to the Discover command in the Lon Device Manager.

NoteThere are no Find sub-commands, and selected device is not important.

Common usages of Lon Utilities Manager

The following notes list commands that are commonly run from the Lon Utilities Manager.

  • To identify a device from a service pin message:

    Main command: Identify, sub-command: Service Pin.

    For a procedure, see To identify a device using its service pin message.

  • To determine the working domain of an existing managed network:

    Select <a Lon device>, main command: Reports, sub-command: Domain Table.

    For a procedure, see To see a node’s current domain table.

  • To verify that binds issued from the Lon Link Manager executed correctly, meaning that the actual devices and the station database are both synchronized:

    • If selective binds made to just one Lon device:

      Select <that device>, main command: Reports, sub-command: Verify.

    • If binds were made to multiple Lon devices:

      Select localLonDevice, main command: Reports, sub-command: Verify.

    If the report shows discrepancies, take the appropriate actions from the Lon Device Manager:

    Following either action, you typically perform another Bind from the Lon Link Manager, then re-run the verify report from the Lon Utilities Manager.