Page History

...

• timestamp
  • The time stamp the payload was created
• metrics
  • An array containing the metrics being published.
  • For each metric parameters include:
  • name
    • 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 the metric represents a historical value
  • isTransient
    • Currently not used by MQTT Modules
    • Set to null
  • metaData
    
    • Used for customisation on top of the Sparkplug B protocol
    • Used by MQTT Modules for file transfers and custom decoding information for example: UDTsthe metric
  • properties
    
    • Used for Ignition tag properties. See the Ignition Tag Properties reference for all available properties.

    • Included in BIRTH messages if values have been changed from the Ignition default 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
    • Value associated with the metric
    • If Ignition User Defined Types (UDTs) are being used, definitions are included in NBIRTH messages 
  • 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

...