Skip to end of metadata
Go to start of metadata

The following API calls are available for the MQTT Recorder Module and can be executed within any of the available Ignition scopes.

APIs

  • system.cirruslink.recorder.createConfig(type, props) → void
    • Parameters
      • Type (str)
        • The type of configuration to create with valid options:

          • "General"
          • "Tables"
      • Map props
        • Dictionary of properties making up the configuration with the following keys and datatypes:
          • General
            • Id (Long)

            • Enabled (bool)
            • Datasource (str)
            • PartitionPeriod (str)
          • Tables
            • Id (long)
            • TableName (str)

            • Enabled (bool)

            • RecordType (str)

            • GroupId (str)

            • EdgeNodeId (str)

            • DeviceId (str)

            • FilteredProperties (str)

    • Return Value
      • A map representing the newly created configuration after it has been written to the database. (added 4.0.16)

  • system.cirruslink.recorder.readConfig(type) → List
    • Parameters
      • Type(str)
        • The type of configuration to read with valid options:

          • "General"
          • "Tables"
    • Return Value
      • A List of the Dictionaries of properties making up the configurations with the following keys and datatypes:
        • General
          • Id (Long)

          • Enabled (bool)
          • Datasource (str)
          • PartitionPeriod (str)
        • Tables
          • Id (long)
          • TableName (str)
          • Enabled (bool)
          • RecordType (str)
          • GroupId (str)
          • EdgeNodeId (str)
          • DeviceId (str)
          • FilteredProperties (str)
  • system.cirruslink.recorder.updateConfig(type, id, collisionPolicy, props) → void
    • Parameters
      • Type(str)
        • The type of configuration to update with valid options:
          • "General"
          • "Tables"
      • Id (long)
        • The ID of the record to update
      • collisionPolicy(str)
        • "MergeOverwrite" or "Overwrite"
          • "MergeOverwrite" will replace the existing properties in the record ID with only those included in the call
          • "Overwrite" will replace all properties in the record ID with those in the call
      • Map props
        • Dictionary of properties making up the configuration with the following keys and datatypes:
          • General
            • Id (Long)

            • Enabled (bool)
            • Datasource (str)
            • PartitionPeriod (str)
          • Tables
            • Id (long)
            • TableName (str)
            • Enabled (bool)
            • RecordType (str)
            • GroupId (str)
            • EdgeNodeId (str)
            • DeviceId (str)
            • FilteredProperties (str)
    • Return value
      • A map representing the updated configuration after it has been written to the database. (added 4.0.16)
  • system.cirruslink.recorder.deleteConfig(type, id) → void
    • Parameters
      • Type(str)
        • The type of configuration to delete with valid options:
          • "General"
          • "Tables"
      • Id (long)
        • The ID of the record to delete
    • Return value
      • True if the record was successfully deleted otherwise False is returned. (added 4.0.16)
  • No labels