Contents
Cirrus Link Resources
Cirrus Link Website
Contact Us (Sales/Support)
Forum
Cirrus Link Modules Docs for Ignition 7.9.x
Inductive Resources
Ignition User Manual
Knowledge Base Articles
Inductive University
Forum
Page History
...
The tags below are general information tags with respect to Sparkplug Edge Nodes. These are created, managed and updated by MQTT Engine based on messages arriving from each given Edge Node.
| Name | Data Type | Description |
|---|---|---|
| bdSeq | Long | The last bdSeq number sent by the Edge Node in an NBIRTH message |
Birth Count | Long | The number of NBIRTH messages since the last time the info metrics were reset via the Node Info/Reset Info tag |
| Current Server | String | The current MQTT Server the Edge Node is connected to |
| Data Latency (ms) | Long | The time in milliseconds between MQTT Engine receiving of the last message and the payload's reported time. Note: For this to be very accurate the edge node's clock and the system clock running MQTT Engine should be synced |
| Death Count | Long | The number of NDEATH messages since the last time the info metrics were reset via the Node Info/Reset Info tag |
| Message Schema | String | The schema associated with the Edge Node (e.g. Sparkplug B) |
| Offline DateTime | DateTime | The time at which the last NDEATH message was received by MQTT Engine |
| Online | Boolean | Whether or not the Edge Node is online. This is determined by whether the last lifecycle message was an NBIRTH or NDEATH |
| Online DateTime | DateTime | The time at which the last NBIRTH message was received by MQTT Engine |
| Rebirth (Last) Cause | String | The reason for the last rebirth request to be issued for this Edge Node by MQTT Engine (added 4.0.22) |
| Rebirth (Last) DateTime | DateTime | The time at which the last rebirth was issued for this Edge Node by MQTT Engine (added 4.0.22) |
| Rebirth Count | Integer | The count of rebirth requests issued for this Edge Node by MQTT Engine (added 4.0.22) |
| Reset Info | Boolean | Writable tag to 'reset' the Node Info metrics |
| seq | Long | The last Sparkplug seq number received from the Edge Node |
| Total Bytes Recvd (bytes) | Long | The number of bytes received from the Edge Node since the last time the info metrics were reset via the Node Info/Reset Info tag |
| Total Bytes Xmit (bytes) | Long | The number of bytes sent to the Edge Node since the last time the info metrics were reset via the Node Info/Reset Info tag |
| Transmission Version | String | The version of MQTT Transmission installed at the Edge Node |
Device Control
The tags in each Device Control folder are created based on a supplied metric within the DBIRTH message from the Edge Node. These will only appear if the Edge Node implementation supports them. It is up to the Edge Node implementation (MQTT Transmission for example) to support any functionality it supplies via the DBIRTH. If the Edge Node does not support the specific control, it should not include it in the DBIRTH payload.
| Name | Data Type | Description |
|---|---|---|
| Rebirth | Boolean | Writeable tag to request the Edge Node to resend its cached DBIRTH message for the specific Device without disconnecting or sending DEATH messages first |
Device Info
The tags below are general information tags with respect to Sparkplug Devices. These are created, managed and updated by MQTT Engine based on messages arriving from each given Device.
...
The tags below provide information regarding the MQTT Engine Devices, Edge Nodes, Latches, MQTT Client as well as information on MQTT Engine.
| Name | Data Type | Description |
|---|---|---|
| Enable Tag Tracking | Boolean | Writable tag to control whether or not to update Tags Per Seconds (added 4.0.17) |
| Rebirth (Last) Cause | String | The reason for the last rebirth request to be issued by MQTT Engine (added 4.0.22) |
| Rebirth (Last) DateTime | DateTime | The time at which the last rebirth was issued by MQTT Engine (added 4.0.22) |
| Rebirth (Last) Node | String | The Sparkplug EdgeNode ID for which the last rebirth was issued by MQTT Engine (added 4.0.22) |
| Rebirth Count | Integer | The count of rebirth requests issued by MQTT Engine (added 4.0.22) |
| Redundancy Role | String | The redundancy configuration of the Ignition system that MQTT engine is installed on. Options are Independent, Master and Backup |
| Redundancy State | String | The redundancy status of the Ignition system that MQTT engine is installed on. Options are Active or Cold |
| Reordered Mesg Count | Integer | The number of messages that have been reordered by MQTT Engine (added 4.0.22) |
| Reordered Mesg Reset | Boolean | Writable tag to reset the Reordered Mesg Count metric (added 4.0.22) |
| System-Wide Reset Info | Boolean | Writeable tag to 'reset' all Engine metrics |
| Tag Count | Long | The sum of tags included in the last NBIRTH and DBIRTH messages received from each Edge Node. When an LWT is received form the Edge Node, the tag count for that Edge Node is set to 0 and repopulated on connect when the next BIRTH messages are received (added 4.0.17) |
| Tags Per Second | Long | The number of tags changes received per second with the value updated every two seconds (added 4.0.17) |
| Total Bytes Recvd (bytes) | Integer | The number of bytes received by Engine since the last time the info metrics were reset via the System-Wide Reset Info tag |
| Total Bytes Xmit (bytes) | Integer | The number of bytes sent from Engine since the last time the info metrics were reset via the System-Wide Reset Info tag |
| Total Data Mesg Count | Integer | The number of messages received by Engine since the last time the info metrics were reset via the System-Wide Reset Info tag |
| Version | String | The version MQTT Engine currently installed |
Devices
The Devices folder tags provide information on the connected devices.
...
Overview
Content Tools