Device Online Tracker

Last modified by Alexander Mott on 2024/06/12 23:17

ShowRunnerCLC™ deployments as of version 3.013 come standard with a Device Manager Online Tracker feature that is capable of tracking the online/offline status of any device defined in the ShowRunnerCLC™ configuration. As of version 3.021, the online status of devices being tracked can be exposed over BACnet on deployments which have been licensed and configured for it. 

Enabling Device Online Tracker

The Device Online Tracker is not enabled by default and must be manually enabled during startup. The Device Online Tracker is only able to track online status for the current boot: if the program is restarted or the processor is rebooted, any currently tracked stats (e.g. last online/offline, offline count, etc.) will be reset, though the general configuration (i.e. whether or not the tracker is enabled, any ignored devices, etc.) will remain unchanged.

If the offline device count is to be exported over BACnet, it is strongly recommended to configure the Device Online Tracker to ignore any devices that are not expected to be continuously online (such as XPanel or iPad user interfaces which are defined by default in the configuration) or which have not been installed yet (such as devices defined in the configuration in preparation for future phases of the project). It is best practice to remove from the ShowRunnerCLC™ configuration any devices that have been permanently deleted from the design, but if these devices are to remain defined in the configuration then they should at least be excluded from the Device Online Tracker to prevent false alarms. 

To enable and configure the Device Online Tracker, run the following commands:

  • Enable the Device Online Tracker with the command: sr devmgr onlinetracker enable true
  • Save the configuration with command: sr save
  • Restart the ShowRunnerCLC™ program with command: progreset
  • Verify the tracker is running by using one of the show commands:
    • List all devices: sr devmgr onlinetracker show all
      (In this example, the system is not live so most devices are reporting as offline without having ever been online)
      1718232381405-280.png
    • List only offline devices: sr devmgr onlinetracker show offline
      (In this example, the system is not live so most devices are reporting as offline without having ever been online)
      1718232442971-433.png
  • Optionally, configure the tracker to ignore specific devices by one of the two methods below:
    • Using the following commands to add or remove devices from the ignore list:
      • sr devmgr onlinetracker ignore add [record]
      • sr devmgr onlinetracker ignore remove [record]
      • In the above commands, [record] is the connection for the device being tracked and follows the form (section in parentheses only required for: ConnectionType(|:HostConnectionProperties)|:DeviceId
      • Note that HostIpId and DeviceId should be written in hexadecimal, e.g. IP-ID 20 should be written as "20" for these commands
      • Note that ZUMNET-JBOXs have two devices being tracked: one device corresponds to the load controller at CID 3 and the other device corresponds to the Cresnet/Ethernet bridge at the IP-ID of the JBOX
      • Examples:
        • Cresnet device at CID 3 landed directly on a processor: sr devmgr on ig add Cresnet|:03
        • Cresnet device at CID 8 on Net 2 of a DIN-CENCN-2 at IP-ID D0: sr devmgr on ig add Cresnet|:D0,2|:08
        • Cresnet/Zūm Link device at CID 5 on a ZUMNET-JBOX at IP-ID 33: sr devmgr on ig add Cresnet|:33,1|:05
        • Zūm Net Cresnet/Ethernet bridge device at IP-ID 33: sr devmgr on ig add Ethernet|:33
        • XPanel/iPad UI at IP-ID 13: sr devmgr on ig add Ethernet|:13
          1718233010707-194.png
    • Pulling the configuration and editing the "RecordsToIgnore" section within the "OnlineTrackerSettings" section of the configuration
      • Each record to be ignored has a "HostDevice" section for the device host (e.g. DIN-CENCN-2, ZUMNET-JBOX, etc.) and a "Device" section for the device itself.
        • The HostDevice "ConnectionId" corresponds to the IP-ID of the host and must be converted to decimal (e.g. IP-ID 20 should be written as ConnectionId: 32)
        • The Device "ConnectionId" corresponds to the IP-ID for Ethernet type devices or the Cresnet ID for Cresnet/Zūm Link devices and must be converted to decimal (e.g. CID 3D should be written as ConnectionId: 61)
      • Example for an Ethernet device at IP-ID 13, equivalent to the command: sr devmgr on ig add Ethernet|:13
        :1718233294814-417.png
    • Verify the correct devices are ignored with the command: sr devmgr onlinetracker show ignore
      1718233043262-396.png

Exposing Over BACnet

Once the Device Online Tracker has been enabled and configured, the online status of devices can be exposed over BACnet by taking the following steps:

  • Enable Device Tracker BACnet points with the command: sr bacnet feature DeviceOfflineCount
    1718234163881-573.png
    • If BACnet is not already enabled, then it must be enabled by editing the "BacnetEnabled" property of the configuration or by running the command: sr bacnet enable true and then restarting the program
  • Save the configuration with the command: sr save
  • Restart the ShowRunnerCLC™ program with command: progreset

Once the program starts up, you can verify the feature was enabled by looking for it in the processor's response to the command: sr bacnet features
1718234259038-857.png