Versions Compared

Key

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

...

  • 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
      • Set to null
    • metaData
      • Used for Ignition tag Meta Data (Tooltip and Documentation)  
      • Included in BIRTH messages if values have changed from Ignition defaults
    • 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
        If the Quality property is not included, the quality of the metric is considered Good


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

...