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
MQTT Engine automatically creates a known set of tags for MQTT Engine control, MQTT Engine telemetry, for Sparkplug edge nodes and devices, for its MQTT client connections, etc. The tables below describes these tags.
Node Control Tags
The tags below are created based on a supplied metric within the NBIRTH 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 NBIRTH. If the Edge Node does not support the specific control, it should not include it in the NBIRTH payload.
| Name | Description |
|---|---|
| Node Control/Next Server | Requests the Edge Node to walk to the next MQTT server |
| Node Control/Rebirth | Requests the Edge Node to resend its NBIRTH and DBIRTH messages without disconnecting or sending DEATH messages first |
| Node Control/Reboot | Requests the Edge Node to reboot resulting in DEATH messages and a full BIRTH sequence |
| Node Control/* | These can be any custom functionality the Edge Node may support |
Node Info Tags
The tags below are general information tags with respect to Sparkplug Edge Nodes. These are created, managed and updated by MQTT Engine. They are created and updated based on messages arriving from each given Edge Node.
| Name | Description |
|---|---|
| Node Info/bdSeq | The last bdSeq number sent by the Edge Node in an NBIRTH message |
Node Info/Birth Count | The number of NBIRTH messages since the last time the info metrics were reset via the Node Info/Reset Info tag |
| Node Info/Current Server | The current MQTT Server the Edge Node is connected to |
| Node Info/Data Latency | 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 |
| Node Info/Death Count | The number of NDEATH messages since the last time the info metrics were reset via the Node Info/Reset Info tag |
| Node Info/Message Schema | The schema associated with the Edge Node (e.g. Sparkplug B) |
| Node Info/Offline DateTime | The time at which the last NDEATH message was received by MQTT Engine |
| Node Info/Online | Whether or not the Edge Node is online. This is determined by whether the last lifecycle message was an NBIRTH or NDEATH |
| Node Info/Online DateTime | The time at which the last NBIRTH message was received by MQTT Engine |
| Node Info/Reset Info | Writable tag to 'reset' the Node Info metrics |
| Node Info/seq | The last Sparkplug seq number received from the Edge Node |
| Node Info/Total Bytes Recvd | 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 |
| Node Info/Total Bytes Xmit | 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 |
Device Info Tags
The tags below are general information tags with respect to Sparkplug Devices. These are created, managed and updated by MQTT Engine. They are created and updated based on messages arriving from each given Device.
| Name | Description |
|---|---|
| Device Info/Birth Count | The number of DBIRTH messages since the last time the info metrics were reset via the Device Info/Reset Info tag |
| Device Info/Data Message Count | The number of DDATA messages since the last time the info metrics were reset via the Device Info/Reset Info tag |
| Device Info/Death Count | The number of DDEATH messages since the last time the info metrics were reset via the Device Info/Reset Info tag |
| Device Info/Last Command Size | The size in bytes of the last DCMD that was sent from MQTT Engine |
| Device Info/Last Data Message Size | The size in bytes of the last DDATA that was received from the Device |
| Device Info/Offline DateTime | The time at which the last DDEATH message was received by MQTT Engine |
| Device Info/Online | Whether or not the Device is online. This is determined by whether the last lifecycle message was an DBIRTH or NBIRTH |
| Device Info/Online DateTime | The time at which the last DBIRTH message was received by MQTT Engine |
| Device Info/Reset Info | Writable tag to 'reset' the Device Info metrics |
Overview
Content Tools