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
...
| Name | Data Type | Description |
|---|---|---|
| Delete UNS Tags | Boolean | Writeable tag to delete all UNS namespace tags associated with this Sparkplug Edge Node. Tag is set to read-only by default |
| Next Server | Boolean | Writeable tag to request the Edge Node to walk to the next MQTT server |
| Rebirth | Boolean | Writeable tag to request the Edge Node to resend its cached NBIRTH and DBIRTH messages without disconnecting or sending DEATH messages first. This means a that the new BIRTH will only contain the same metrics/tags that were in the original BIRTH message. |
Node Info
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 |
|---|---|---|
| Delete UNS Tags | Boolean | Writeable tag to delete all UNS namespace tags associated with this Sparkplug Device. Tag is set to read-only by default |
| 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. This means a that the new BIRTH will only contain the same metrics/tags that were in the original BIRTH message. Note: Block Device Commands must be disabled in order the DCMD to be published by Engine |
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.
...
| Name | Data Type | Description |
|---|---|---|
| Enable Tag Tracking | Boolean | Writable tag to control whether or not to update Tags Per Seconds (added 4.0.17) |
| Queued Messages | Dataset | A dataset showing the current message count for each message queue |
| Queued Messages Total | Integer | The count of all current queued messages |
| 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 |
...
The Edge Nodes folder tags provide information on the connected Edge Nodes
| Name | Data Type | Description |
|---|---|---|
| Last Node to Connect | String | The Sparkplug ID of the last node to connect |
| Last Node To Disconnect | String | The Sparkplug ID of the last node to disconnect |
| NodesOffline | Integer | The number of Sparkplug Edge Nodes offline. This is determined by whether the last lifecycle message was an NBIRTH or NDEATH |
| NodesOnline | Integer | The number of Sparkplug Edge Nodes online. This is determined by whether the last lifecycle message was an NBIRTH or NDEATH |
| NodeUnitCount | Integer | The total number of Sparkplug Edge Nodes as determined by the received NBIRTH messages |
| Offline Nodes | Dataset | A dataset containing the Sparkplug ID and timestamp for all offline Sparkplug edge nodes |
| Online Nodes | Dataset | A dataset containing the Sparkplug ID and timestamp for all online Sparkplug edge nodes |
Latches
The Latches folder tags provide a tag path to any configured tag latches in the MQTT Engine configuration
| Name | Data Type | Description |
|---|---|---|
| TagName as defined in the MQTT Engine configuration | Boolean | Writeable tag to 'reset' the tag latch |
MQTT Clients
The MQTT Clients folder tags provide information on the connected MQTT Clients.
| Name | Data Type | Description |
|---|---|---|
| Latency Check Period (ms) | Integer | Frequency in milliseconds that the message latency for each MQTT Client is checked if the Enable Latency Check is checked |
For each configured MQTT Engine Set, the following tags are available for each identified MQTT Client:
| Name | Data Type | Description |
|---|---|---|
| Connected Nodes | Integer | Number of currently connected Sparkplug Edge Nodes to this MQTT Client |
| Enable Latency Check | Integer | Writable tag to enabled message latency checking for each MQTT Client |
| Message Processing Latency (ms) | Integer | The amount of time to process the last Sparkplug message |
| Messages Per Second | Integer | The number of MQTT messages received by Engine per second |
| MQTT Client ID | String | The Client ID for the MQTT Client |
| Offline DateTime | DateTime | The last time at which the MQTT Client successfully disconnected from the MQTT Server |
| Online | Boolean | A read-only tag showing the connection status of the MQTT Client |
| Online DateTime | DateTime | The last time at which the MQTT Client successfully connected to the MQTT Server |
| Server Latency (ms) | Integer | The amount of time that it takes for a test MQTT message to be sent and received back by MQTT Engine |
| Target Server URL | String | The URL of the target MQTT Server to connect to |
For each identified MQTT Client, the following folders and tags are available:
| Name | Name | Data Type | Description |
|---|---|---|---|
| Primary Host State/PrimaryHostName | Folder | Folder named as the Primary Host ID configured in MQTT Engine | |
| Payload | String | Status of the Primary Host. Options are {"online":true,"timestamp":1681780081657} or {"online":true,"timestamp":1681780081657} where the timestamp is the time of the last status change | |
| Retain | Boolean | Retain status of the LWT message for the Primary Host | |
| Legacy Primary Host State/PrimaryHostName | Folder | Folder named as the Primary Host ID configured in MQTT Engine if Enable Legacy State messages is True under the Severs > Legacy State configuration | |
| Payload | String | Status of the Legacy Primary Host. Options are OFFLINE or ONLINE | |
| Retain | Boolean | Retain status of the LWT message for the Primary Host |
Overview
Content Tools