Basic Message Components

Topic

The topic is published in the format [Namespace]spBv1.0/[Group ID]/[Message Type]/[Edge Node ID]/[Device ID] where:

Namespace
- This always begins with “spBv1.0” to indicate that the topic is using the Sparkplug B version 1.0 specification. This serves as an identifier for the protocol version being used, as well as the encoding used for the associated payload data
Group ID
- This identifies a logical grouping of Edge nodes and devices. For example, you might use a group ID to represent a particular factory or plant location. It ensures data segregation between different groups, aiding in efficient data management and security This can be a region, a facility name, or any meaningful grouping of Edge Nodes within your application.
Message Type
- The message_type component of the topic namespace signals how the MQTT payload should be processed. The following message_type components are defined for the Sparkplug topic namespace:
  CL Modules Sparkplug message types and how they differ: Edge node BIRTH certificate. This is a startup message from an Edge node to announce its presence and share its configurations.
  CL Modules Sparkplug message types and how they differ: Notification of an edge node’s disconnection or failure.
  CL Modules Sparkplug message types and how they differ: Device BIRTH certificate. This is a startup message from a device to announce its presence and share its configurations.
  CL Modules Sparkplug message types and how they differ: Notification of a device’s disconnection or failure.
  CL Modules Sparkplug message types and how they differ: Data messages from an edge node which include edge node metric data.
  CL Modules Sparkplug message types and how they differ: Data messages from a device which include device metrics.
  CL Modules Sparkplug message types and how they differ: Command to an edge node.
  CL Modules Sparkplug message types and how they differ: Command to a device.
  CL Modules Sparkplug message types and how they differ: It represents the state of the primary host application. Edge nodes subscribe to it to get the online status of the host.
Edge Node ID
- This uniquely identifies a specific edge node within in a group. Edge nodes are responsible for reporting data on behalf of devices they control or are connected to. The Edge Node ID helps in directing commands to the correct node and segregating data from various nodesThe ID of the logical Edge Node. This is often the name of the system running Ignition with MQTT Transmission or Injectors.
Device ID (Optional)If the message relates to a specific device controlled by the edge node, the device ID uniquely identifies that device
- The ID of a device attached to the Ignition instance. This can be a PLC or logical grouping of tags that represent a physical or logical device connected to Ignition.

Tip

MQTT Transmission or Tag Agents are designed to dynamically pick up tags in Ignition or Ignition Edge and publish tag change events to an MQTT Server. How the tags are published to the MQTT Server is based on a combination of a 'Transmitter' or 'Tag Agent' configuration as well as the arrangement of tags in the Ignition tag tree. See MQTT Transmission Transmitters and Tag Trees or Cloud Injector Tag Agents and Tag Trees for details.

Payload

The payload contains the following :

timestamp
- The time stamp the payload was created
metrics
- An array containing data specific to the message type being published
- Parameters include:
  - name
    - Set to null in DATA messages if aliasing used
  - timestamp
  - dataType
  - value
  - alias
    - Set to null if aliasing not used
  - isHistorical
    - Flag denoting the metric represents a historical value
    - Set to null for live data and True for historical data
  - isTransient
    - Not used in Cirrus Link modules
    - Set to null
  - isNull
    - Flag denoting the metric has a null value
  - metaData
    - Included in BIRTH messages
    - Includes Tooltip and Documentation if they have been changed from the Ignition default. See the Ignition Tag Properties reference for all available properties.
  - properties
    - The Quality property
      - May be included in BIRTH and DATA messages
      - If the Quality property is not included, the quality of the tag data is considered Good. See the Ignition Tag Quality Code Reference for the Data Quality value reference
    - Additional property values
      - Included only in BIRTH messages
      - Included if they have been changed from the Ignition default or if they are custom properties. See the Ignition Tag Properties reference for all available properties.
seq
- The message sequence number used to ensure that messages are processed in the correct order
uuid
- Set to null
body
- Set to null

Examples

Anchor
NBIRTH
NBIRTH
NBIRTH

Panel

borderColor	black
borderStyle	solid
title	Sparkplug Topic

spBv1.0/TestGroup/NBIRTH/TestEdge

...

Panel

borderColor	black
borderStyle	solid
title	Sparkplug Payload Metrics (Examples)

Metric [name=Node Control/Next Server, alias=null, timestamp=1713266473578, dataType=MetricDataType [type=Boolean, intValue=11, clazz=class java.lang.Boolean], isHistorical=null, isTransient=null, metaData=null, properties=null, value=false, isNull=false]

Metric [name=Node Info/Transmission Version, alias=null, timestamp=1713266473578, dataType=MetricDataType [type=String, intValue=12, clazz=class java.lang.String], isHistorical=null, isTransient=null, metaData=null, properties=null, value=4.0.22-SNAPSHOT (b2024041611), isNull=false]

Metric [name=bdSeq, alias=null, timestamp=1713266473578, dataType=MetricDataType [type=Int64, intValue=4, clazz=class java.lang.Long], isHistorical=null, isTransient=null, metaData=null, properties=null, value=2, isNull=false]

Metric [ name=Motor, alias=null, timestamp=1713266473578, dataType=MetricDataType [type=Template, intValue=19, clazz=class org.eclipse.tahu.message.model.Template], isHistorical=null, isTransient=null, metaData=MetaData [isMultiPart=false, contentType=, size=0, seq=0, fileName=, fileType=, md5=03081691ee14510415e1036a4d1f416d, description=], properties=PropertySet [propertyMap={}], value=Template [version=, templateRef=, isDefinition=true, metrics=[Metric [name=T1, alias=null, timestamp=1713266473578, dataType=MetricDataType [type=Int32, intValue=3, clazz=class java.lang.Integer], isHistorical=null, isTransient=null, metaData=MetaData [isMultiPart=false, contentType=, size=0, seq=0, fileName=, fileType=, md5=, description=], properties=PropertySet [propertyMap={}], value=null, isNull=true]], parameters=[]], isNull=false]

Metric [name=E_T1, alias=null, timestamp=1713266473578, dataType=MetricDataType [type=String, intValue=12, clazz=class java.lang.String], isHistorical=null, isTransient=null, metaData=MetaData [isMultiPart=false, contentType=application/json, size=0, seq=0, fileName=, fileType=, md5=, description=], properties=PropertySet [propertyMap={engLow=PropertyValue [type=PropertyDataType [type=Double, intValue=10, clazz=class java.lang.Double], value=1.0, isNull=false], Quality=PropertyValue [type=PropertyDataType [type=Int32, intValue=3, clazz=class java.lang.Integer], value=-2147483133, isNull=false], enabled=PropertyValue [type=PropertyDataType [type=Boolean, intValue=11, clazz=class java.lang.Boolean], value=false, isNull=false]}], value=null, isNull=true]

Metric [name=T1, alias=null, timestamp=1713266473578, dataType=MetricDataType [type=Int32, intValue=3, clazz=class java.lang.Integer], isHistorical=false, isTransient=false, metaData=MetaData [isMultiPart=false, contentType=, size=0, seq=0, fileName=, fileType=, md5=, description=], properties=PropertySet [propertyMap={engUnit=PropertyValue [type=PropertyDataType [type=String, intValue=12, clazz=class java.lang.String], value=RPM, isNull=false], Quality=PropertyValue [type=PropertyDataType [type=Int32, intValue=3, clazz=class java.lang.Integer], value=-2147483133, isNull=false]}], value=null, isNull=true]], parameters=[]], isNull=false]

Anchor
DBIRTH
DBIRTH
DBIRTH

Panel

borderColor	black
borderStyle	solid
title	Sparkplug Topic

spBv1.0/TestGroup/NBIRTH/TestEdge/TestDevice

...

Panel

borderColor	black
borderStyle	solid
title	Sparkplug Payload Metrics (Examples)

Metric [name=Device Control/Rebirth, alias=null, timestamp=1713266459127, dataType=MetricDataType [type=Boolean, intValue=11, clazz=class java.lang.Boolean], isHistorical=null, isTransient=null, metaData=null, properties=null, value=false, isNull=false]

Metric [name=D_T1, alias=null, timestamp=1713266459127, dataType=MetricDataType [type=String, intValue=12, clazz=class java.lang.String], isHistorical=null, isTransient=null, metaData=MetaData [isMultiPart=false, contentType=application/json, size=0, seq=0, fileName=, fileType=, md5=, description=], properties=PropertySet [propertyMap={Quality=PropertyValue [type=PropertyDataType [type=Int32, intValue=3, clazz=class java.lang.Integer], value=192, isNull=false], enabled=PropertyValue [type=PropertyDataType [type=Boolean, intValue=11, clazz=class java.lang.Boolean], value=true, isNull=false], documentation=PropertyValue [type=PropertyDataType [type=String, intValue=12, clazz=class java.lang.String], value=Some helpful docs, isNull=false]}], value={ "Key1": "Value3" }, isNull=false]

Metric [name=D_M1, alias=null, timestamp=1713266459127, dataType=MetricDataType [type=Template, intValue=19, clazz=class org.eclipse.tahu.message.model.Template], isHistorical=null, isTransient=null, metaData=MetaData [isMultiPart=false, contentType=, size=0, seq=0, fileName=, fileType=, md5=, description=], properties=PropertySet [propertyMap={enabled=PropertyValue [type=PropertyDataType [type=Boolean, intValue=11, clazz=class java.lang.Boolean], value=true, isNull=false]}], value=Template [version=, templateRef=Motor, isDefinition=false, metrics=[Metric [name=T1, alias=null, timestamp=1713266459127, dataType=MetricDataType [type=Int32, intValue=3, clazz=class java.lang.Integer], isHistorical=false, isTransient=false, metaData=MetaData [isMultiPart=false, contentType=, size=0, seq=0, fileName=, fileType=, md5=, description=], properties=PropertySet [propertyMap={engHigh=PropertyValue [type=PropertyDataType [type=Double, intValue=10, clazz=class java.lang.Double], value=60.0, isNull=false]}], value=12, isNull=false]], parameters=[]], isNull=false]]

Anchor
NDATA
NDATA
NDATA

Panel

borderColor	black
borderStyle	solid
title	Sparkplug Topic

spBv1.0/TestGroup/NDATA/TestEdge

...

Panel

borderColor	black
borderStyle	solid
title	Sparkplug Payload Metrics (Examples)

Metric [name=E_M1, alias=null, timestamp=1713266452937, dataType=MetricDataType [type=Template, intValue=19, clazz=class org.eclipse.tahu.message.model.Template], isHistorical=null, isTransient=null, metaData=null, properties=null, value=Template [version=, templateRef=Motor, isDefinition=false, metrics=[Metric [name=T1, alias=null, timestamp=1713266445706, dataType=MetricDataType [type=Int32, intValue=3, clazz=class java.lang.Integer], isHistorical=null, isTransient=null, metaData=null, properties=null, value=12, isNull=false]], parameters=[]], isNull=false]

Metric [name=E_T1, alias=null, timestamp=1713266452939, dataType=MetricDataType [type=String, intValue=12, clazz=class java.lang.String], isHistorical=null, isTransient=null, metaData=MetaData [isMultiPart=false, contentType=application/json, size=0, seq=0, fileName=, fileType=, md5=, description=], properties=PropertySet [propertyMap={}], value={ "Key1": "Value3" }, isNull=false]]

Anchor
DDATA
DDATA
DDATA

Panel

borderColor	black
borderStyle	solid
title	Sparkplug Topic

spBv1.0/TestGroup/DDATA/TestEdge/TestDevice

...

Panel

borderColor	black
borderStyle	solid
title	Sparkplug Payload 2 Metrics (Examples)

Metric [name=D_M1, alias=null, timestamp=1713266452942, dataType=MetricDataType [type=Template, intValue=19, clazz=class org.eclipse.tahu.message.model.Template], isHistorical=null, isTransient=null, metaData=null, properties=null, value=Template [version=, templateRef=Motor, isDefinition=false, metrics=[Metric [name=T1, alias=null, timestamp=1713266445725, dataType=MetricDataType [type=Int32, intValue=3, clazz=class java.lang.Integer], isHistorical=null, isTransient=null, metaData=null, properties=null, value=12, isNull=false]], parameters=[]], isNull=false]

Metric [name=D_T1, alias=null, timestamp=1713266452947, dataType=MetricDataType [type=String, intValue=12, clazz=class java.lang.String], isHistorical=null, isTransient=null, metaData=MetaData [isMultiPart=false, contentType=application/json, size=0, seq=0, fileName=, fileType=, md5=, description=], properties=PropertySet [propertyMap={}], value={ "Key1": "Value3" }, isNull=false]]

Anchor
NDEATH
NDEATH
NDEATH

Panel

borderColor	black
borderStyle	solid
title	Sparkplug Topic

spBv1.0/TestGroup/NDEATH/TestEdge

...

Panel

borderColor	black
borderStyle	solid
title	Sparkplug Payload

[timestamp=1713266459127, metrics=[Metric [name=bdSeq, alias=null, timestamp=1713266473578, dataType=MetricDataType [type=Int64, intValue=4, clazz=class java.lang.Long], isHistorical=null, isTransient=null, metaData=null, properties=null, value=2, isNull=false]], seq=7, uuid=null, body=null]

Anchor
DDEATH
DDEATH
DDEATH

Panel

borderColor	black
borderStyle	solid
title	Sparkplug Topic

spBv1.0/TestGroup/DDEATH/TestEdge/TestDevice

...

Panel

borderColor	black
borderStyle	solid
title	Sparkplug Payload

[timestamp=1713266459127, metrics=[Metric [name=bdSeq, alias=null, timestamp=1713266442358, dataType=MetricDataType [type=Int64, intValue=4, clazz=class java.lang.Long], isHistorical=null, isTransient=null, metaData=null, properties=null, value=5, isNull=false]], seq=7, uuid=null, body=null]

Anchor
NCMD
NCMD
NCMD

Panel

borderColor	black
borderStyle	solid
title	Sparkplug Topic

spBv1.0/TestGroup/NCMD/TestEdge

...

Panel

borderColor	black
borderStyle	solid
title	Sparkplug Payload

[timestamp=1713266761298, metrics=[Metric [name=ET1, alias=null, timestamp=1713266730315, dataType=MetricDataType [type=Int32, intValue=3, clazz=class java.lang.Integer], isHistorical=true, isTransient=null, metaData=null, properties=null, value=5, isNull=false]], seq=15, uuid=null, body=null]

Anchor
DCMD
DCMD
DCMD

Panel

borderColor	black
borderStyle	solid
title	Sparkplug Topic

spBv1.0/TestGroup/DCMD/TestEdge/TestDevice

...

Panel

borderColor	black
borderStyle	solid
title	Sparkplug Payload

[timestamp=1713266761298, metrics=[Metric [name=DT1, alias=null, timestamp=1713266785263, dataType=MetricDataType [type=Int32, intValue=3, clazz=class java.lang.Integer], isHistorical=true, isTransient=null, metaData=null, properties=null, value=25, isNull=false]], seq=12, uuid=null, body=null]

Anchor
STATE
STATE
STATE

Panel

borderColor	black
borderStyle	solid
title	Sparkplug Topic

spBv1.0/STATE/primary_host_id

...

Contents

Cirrus Link Resources

Inductive Resources

Versions Compared

Old Version 27

New Version 28

Key

Basic Message Components

Topic

Payload

Examples

Anchor
NBIRTH
NBIRTH
NBIRTH

Anchor
DBIRTH
DBIRTH
DBIRTH

Anchor
NDATA
NDATA
NDATA

Anchor
DDATA
DDATA
DDATA

Anchor
NDEATH
NDEATH
NDEATH

Anchor
DDEATH
DDEATH
DDEATH

Anchor
NCMD
NCMD
NCMD

Anchor
DCMD
DCMD
DCMD

Anchor
STATE
STATE
STATE

Contents

Cirrus Link Resources

Inductive Resources

Page History

Versions Compared

Old Version 27

New Version 28

Key

Basic Message Components

Topic

Payload

Examples

AnchorNBIRTHNBIRTHNBIRTH

AnchorDBIRTHDBIRTHDBIRTH

AnchorNDATANDATANDATA

AnchorDDATADDATADDATA

AnchorNDEATHNDEATHNDEATH

AnchorDDEATHDDEATHDDEATH

AnchorNCMDNCMDNCMD

AnchorDCMDDCMDDCMD

AnchorSTATESTATESTATE

Anchor
NBIRTH
NBIRTH
NBIRTH

Anchor
DBIRTH
DBIRTH
DBIRTH

Anchor
NDATA
NDATA
NDATA

Anchor
DDATA
DDATA
DDATA

Anchor
NDEATH
NDEATH
NDEATH

Anchor
DDEATH
DDEATH
DDEATH

Anchor
NCMD
NCMD
NCMD

Anchor
DCMD
DCMD
DCMD

Anchor
STATE
STATE
STATE