Versions Compared

Key

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

...

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

...

  • 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 tags this is the tag Tag folder hierarchy not used in the topic namespace when aliasing not used
    • alias
      • Numeric value representing the tag rather than a name metric when aliasing is used
    • timestamp
      • Timestamp associated with the last tag metric change event
    • dataType
      • DataType associated with the tagmetric
    • isHistorical
      • Set to True to denote the metric represents a historical value
    • isTransient
      • Set to null
    • metaData
      • Included in BIRTH messages if Used for Ignition tag Meta Data (Tooltip and Documentation) has   
      • Included in BIRTH messages if values have changed from Ignition defaults
    • properties
      • Used for Ignition tag properties. See the Ignition Ignition Tag Properties reference for all available properties.
      • Included in BIRTH messages if they values have been changed from the Ignition default or if they are custom properties. 

        Tip
        If the Quality property is not included, the quality of the tag data metric is considered Good


    • value
      • Value associated with the tagmetic 
    • isNull
      • Boolean 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
    • Set to null
  • body
    • Set to null

...