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


      • value
        • Value associated with the tag
      • isNull
        • Boolean denoting the metric has a null value
  • seq
    • The message sequence number used to ensure that messages are processed in the correct order
  • uuid
    • Not used by Cirrus Link modulesSet to null
  • body
    • Not used by Cirrus Link modulesSet to null
Note
Where a parameter is not specific to the metric being published, it is set to null

...