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 data specific to the message type being published
    • Parameters include:
      • name
        • Tag folder hierarchy not used in the topic namespace Set to null in DATA messages if aliasing when aliasing not used
      • timestamp
        • Timestamp associated with the last tag change event
      • dataType
        • DataType associated with the tag
      • value
        • Value associated with the tag
      • alias
        • Numeric value representing the tag rather than a name Set to null if aliasing not when aliasing is used
      • isHistorical
        • Flag denoting Set to True to denote the metric represents a historical value
        • Set to null if metric has no historic data 
      • isTransient
        • Not used in Cirrus Link modulesSet to null 
      • isNull
        • Flag Boolean denoting the metric has a null value
      • metaDataSet to null
        • Included in BIRTH messages if tag Meta Data (Tooltip and Documentation) has changed from Ignition defaults
      • propertiesSet to null if no changes from Ignition defaults.
        • See the Ignition Tag Properties reference for all available properties.
        • Included only 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


  • seq
    • The message sequence number used to ensure that messages are processed in the correct order
  • uuid
    • Set to null
  • body
    • Set to null
Note
Where a parameter is not specific to the message type being published, it is set to null

Examples

Anchor
NBIRTH
NBIRTH
NBIRTH

...