Versions Compared

Old Version 3

changes.mady.by.user user-c32a8

Saved on

compared with

New Version Current

changes.mady.by.user Dan Potter

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Basic Message Components

Topic 

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

...

  • 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.

  • Verb
    • This provides an indication on how to handle the payload of the message. This includes whether the message is a birth certificate, death certificate, data message, command message, etc.
    • Options include

      NBIRTH: Edge node BIRTH certificate. This is a

    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:

      NBIRTH: Edge node BIRTH certificate. This is a startup message from an Edge node to announce its presence and , share its configurations and it indicates the beginning of a Sparkplug session.

      NDEATH: Notification of an edge node’s disconnection or failure. This indicates the end of a Sparkplug session.

      DBIRTH: Device BIRTH certificate. This is a startup message from a device to announce its presence and share its configurations.

      DDEATH: Notification of a device’s disconnection or failure.    Note:  MQTT Transmission only sends a DDEATH if a device level tag folder is deleted.

      NDATA: Data NDATA: Data messages from an edge node which include edge node metric data.

      DDATA: Data messages from a device which include device metrics.

      NCMD: Command to an edge node.

      • Also used for REBIRTH requests to an edge node 

      DCMD: Command to a device.

      STATE: 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.

Payload

The payload contains the following :

    • 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.


Note
MQTT Transmission transmitters or the Injector Tag Agents are designed to use the Ignition tag folder hierarchy (Tag Path) in combination with any configured Sparkplug IDs to dynamically build the Group ID, Edge Node Id and Device ID used in the topic.

Payload

The payload contains the following :

  • timestamp
    • The
    timestamp
    • The time stamp the payload was created
  • metrics
    • An array containing data specific to the message type metrics being published.
    • For each metric parameters Each object in the array will include:
    • name
      • timestamp
      • dataType array
      • value
      • Metric name when aliasing not used
      • For Ignition tags this is the tag folder hierarchy not used in the topic namespace
    • alias
      • Numeric value representing the metric when aliasing is used
    • timestamp
      • Timestamp associated with the last metric change event
    • dataType
      • DataType associated with the metric
    • isHistorical
      • Set to True to denote
      Optional parameters included in the object include:
      • alias
        • Included in BIRTH and DATA messages
        • Tied to name on BIRTH and included in all later DATA messages  
      • isHistorical
      • Included in BIRTH and DATA messages
        • Flag denoting the metric represents a historical value
    • isTransient
      • Included in BIRTH and DATA messages
        • Flag denoting the metric is a transient valueCurrently not used by MQTT Modules
      • Set to null 
      • isNull
        • Included in BIRTH and DATA messages
        • Flag denoting the metric has a null value
      • null
    • metaData
      • Used for customisation on top of the Sparkplug B protocol
      • Used by MQTT Modules for file transfers and custom decoding information for the metric
    • properties
      • Used for Ignition tag properties. See the Ignition Tag Properties reference for all available properties.metaData

      • Included in BIRTH messages

        Includes Tooltip and Documentation if they

        if values 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
          • Only included 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
    • bodySet

      • or if they are custom properties. 

        Tip
        Cirrus Link modules often optimise payloads by excluding Good metric qualities from a payload. If the payload is missing the quality property, it should be considered to be Good


    • value
    • isNull
      • Flag denoting the metric has a null value
  • seq
    • The message sequence number used to ensure that messages are processed in the correct order
  • uuid
    • Currently not used by MQTT Modules
    • Set to null
  • body
    • Currently not used by MQTT Modules
    • Set to null
Note
Where a parameter is not specific to the metric being published, it is set to null

Examples

Anchor
NBIRTH
NBIRTH
NBIRTH

Code Blockpanel
languageborderColorbashblack
titleborderStylesolid
titleSparkplug Topic

spBv1.0/TestGroup/NBIRTH/

TestNode

TestEdge


Panel
borderColorblack
borderStylesolid
Code Block
languagebash
titleSparkplug Payload

[timestamp=

1713266689040

1713266473578,

metrics=[ Metric

[name=Node

Control/Next

Server,

 alias

alias=null,

 timestamp

timestamp=

1713266689040

1713266473578,

 dataType

dataType=MetricDataType

[type=Boolean,

intValue=11,

clazz=class

java.lang.Boolean],

isHistorical=null,

 isTransient

isTransient=null,

 metaData

metaData=null,

 properties

properties=null,

 value

value=false,

 isNull

isNull=false],

 

Metric

[

name=

ET1

Motor,

alias=null,

 

timestamp=

1713266689040

1713266473578,

 

dataType=MetricDataType

[type=

Int32

Template,

intValue=

3

19,

clazz=class

java.lang.Integer], 

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

=9, isNull=false], Metric [name=Node Info/Transmission Version,

=Template [version=, templateRef=, isDefinition=true, metrics=[Metric [name=T1, alias=null,

timestamp=

1713266689040

1713266473578,

dataType=MetricDataType

[type=

String

Int32,

intValue=

12

3,

clazz=class

java.lang.

String

Integer],

isHistorical=null,

isTransient=null,

metaData=

null, properties=null, value=4.0.22-SNAPSHOT (b2024041611),

MetaData [isMultiPart=false, contentType=, size=0, seq=0, fileName=, fileType=, md5=, description=], properties=PropertySet [propertyMap={}], value=null, isNull=true]], parameters=[]], isNull=false],

Metric

[name=

bdSeq

E_T1,

alias=null,

timestamp=

1713266689040

1713266473578,

dataType=MetricDataType

[type=

Int64

String,

intValue=

4

12,

clazz=class

java.lang.

Long

String],

isHistorical=null,

isTransient=null,

metaData=null, properties=null, value=41, isNull=false], Metric [name=Node Control/Rebirth, alias=null, timestamp=1713266689040, dataType=MetricDataType [type=Boolean, intValue=11, clazz=class java.lang.Boolean], isHistorical=null, isTransient=null, metaData=null, properties=null, value=false, isNull=false]], seq=0, uuid=null, body=null]

Topic = spBv1.0/G1_UDT_Non_Optimized/NBIRTH/E1

SparkplugBPayload = [

timestamp=1713266473578,

metrics=[

...

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=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=E_M1, 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=

...

, description=],

...

properties=PropertySet [propertyMap={

...

enabled=PropertyValue [type=PropertyDataType [type=Boolean, intValue=11, clazz=class java.lang.Boolean], value=false, isNull=false]}], value=Template [version=, templateRef=Motor, isDefinition=false, metrics=[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],

...

Metric [name=

...

Node Control/Rebirth, 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]], seq=0,

...

uuid=

...

null,

...

body=null]


Panel
borderColorblack
borderStylesolid
titleSparkplug 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

...

isNull=false],

...

, 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,

...

uuid=null,

body=null]

...

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
borderColorblack
borderStylesolid
titleSparkplug Topic

spBv1.0/TestGroup/DBIRTH/TestEdge/TestDevice


Panel
borderColorblack
borderStylesolid
titleSparkplug Payload

[timestamp=1713266459127, metrics=[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=

...

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_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]], seq=1, uuid=null, body=null]


Panel
borderColorblack
borderStylesolid
titleSparkplug 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
borderColorblack
borderStylesolid
titleSparkplug Topic

spBv1.0/TestGroup/NDATA/TestEdge


Panel
borderColorblack
borderStylesolid
titleSparkplug Payload

[timestamp=1713266453938, metrics=[ 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]], seq=

...

6, uuid=null, body=null]

...


Panel
borderColorblack
borderStylesolid
titleSparkplug 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
borderColorblack
borderStylesolid
titleSparkplug Topic

spBv1.0/TestGroup/DDATA/TestEdge/TestDevice


Panel
borderColorblack
borderStylesolid
titleSparkplug Payload 1

[timestamp=1713266761298, metrics=[Metric [name=DT1, 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], Metric [name=

...

DT1, alias=null, timestamp=

...

1713266730416, dataType=MetricDataType [type=Int32, intValue=3, clazz=class java.lang.Integer], isHistorical=

...

true, isTransient=

...

null, metaData=

...

null, properties=null, value=6, isNull=false], Metric [name=DT1, alias=null, timestamp=1713266730516, dataType=MetricDataType [type=Int32, intValue=3, clazz=class java.lang.

...

Integer], isHistorical=true, isTransient=null, metaData=null, properties=null, value=

...

7, isNull=false]

...

, Metric [name=DT1, alias=null, timestamp=1713266730617, dataType=MetricDataType [type=Int32, intValue=3, clazz=class java.lang.Integer], isHistorical=true, isTransient=null, metaData=null, properties=null, value=8, isNull=false], Metric [name=DT1, alias=null, timestamp=

...

1713266730718, dataType=MetricDataType [type=

...

Int32, intValue=

...

3, clazz=class

...

java.

...

lang.Integer], isHistorical=

...

true, isTransient=null, metaData=null, properties=null, value

...

=9, isNull=false]], seq=15, uuid=null, body=null]


Panel
borderColorblack
borderStylesolid
titleSparkplug Payload 1 Metrics (Examples)

Metric [name=

...

DT1, 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]

...

Metric [name=

...

DT1, alias=null, timestamp=

...

1713266730416, dataType=MetricDataType [type=

...

Int32, intValue=

...

3, clazz=class java.lang.

...

Integer], isHistorical=

...

true, isTransient=null, metaData=

...

null, properties=null, value=6, isNull=false]

Metric [name=DT1, alias=null, timestamp=1713266730516, dataType=MetricDataType [type=Int32, intValue=3, clazz=class java.lang.Integer], isHistorical=true, isTransient=null, metaData=null, properties=null, value=7, isNull=false]


Panel
borderColorblack
borderStylesolid
titleSparkplug Payload 2

[timestamp=1713266453943

...

, metrics=[ 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]],

...

 seq=7, uuid=null, body=null]


...

Panel
borderColorblack
borderStylesolid
titleSparkplug 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
borderColorblack
borderStylesolid
titleSparkplug Topic

spBv1.0/TestGroup/NDEATH/TestEdge


Panel
borderColorblack
borderStylesolid
titleSparkplug 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
borderColorblack
borderStylesolid
titleSparkplug Topic

spBv1.0/TestGroup/DDEATH/TestEdge/TestDevice


Panel
borderColorblack
borderStylesolid
titleSparkplug 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
borderColorblack
borderStylesolid
titleSparkplug Topic

spBv1.0/TestGroup/NCMD/TestEdge


Panel
borderColorblack
borderStylesolid
titleSparkplug 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
borderColorblack
borderStylesolid
titleSparkplug Topic

spBv1.0/TestGroup/DCMD/TestEdge/TestDevice


Panel
borderColorblack
borderStylesolid
titleSparkplug 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

Note

Sparkplug™ B payloads are not used for encoding in this payload and this allows Host/backend application(s) to work across Sparkplug™ payload types.


Panel
borderColorblack
borderStylesolid
titleSparkplug Topic

spBv1.0/STATE/primary_host_id


Panel
borderColorblack
borderStylesolid
titleSparkplug Payload

{ "online" : true,  "timestamp" : 1668114759262}  or { "offline" : true,  "timestamp" : 1668114759452}

...