Skip to end of metadata
Go to start of metadata

APIs

  • system.cirruslink.engine.publish(mqttServerName, topic, payload, qos, retained) → void
    • Parameters
      • String mqttServerName
        • The name of the server connection to use in the MQTT Engine Server configuration. This must match an existing server name in the configuration.
      • String topic
        • The MQTT topic to publish on. This must be a valid MQTT topic
      • byte[] payload
        • An array of bytes representing the MQTT payload
      • int qos
        • The MQTT 'Quality of Service' to use. This must be either 0, 1, or 2
      • boolean retained
        • Whether or not to publish this message with the retained flag set
    • Return Value
      • None
  • system.cirruslink.engine.createConfig(type, props) → void
    • Parameters
      • String type
        • The type of configuration to create with valid options:

          • Cert Files
          • Servers
          • Def Namespace Filters
          • Def Namespace
          • Cust Namespace
      • Map props
        • Dictionary of properties making up the configuration with the following keys and datatypes:
          • Cert Files
            • Id (long)

            • Name (str)

            • FileContents (str)

            • Description (str)

          • Servers
            • Id (long)

            • Name (str)

            • Enabled (bool)

            • Url (str)

            • Username (str)

            • Password (str)

            • CaCertFileId (long)

            • ClientCertFileId (long)

            • ClientPrivateKeyFileId (long)

            • ClientKeyPassword (str)

            • HostnameVerification (bool)

            • ClientId (str)

            • CleanSession (bool)

            • KeepAlive (int)

            • FilteredNamespaces (str)

          • Def Namespace Filters
            • Id (long)

            • NamespaceId (long)

            • GroupId (str)

            • EdgeNodeId (str)

          • Def Namespace
            • Id (long)

            • Name (str) "Elecsys", "Sparkplug A", Sparkplug B", or "Xirgo"

            • Enabled (bool)

          • Cust Namespace
            • Id (long) 

            • Name (str) 

            • Subscription (str)

            • QoS1 (bool)

            • RootFolder (str)

            • TagName (str)

            • JsonPayload (bool)

            • Charset (str)

            • WritableTags (bool)

    • Return Value
      • None
  • system.cirruslink.engine.readConfig(type) → List
    • Parameters
      • String type
        • The type of configuration to read with valid options:

          • General
          • Cert Files
          • Servers
          • Def Namespace Files
          • Def Namespace Filters
          • Def Namespace
          • Cust Namespace
    • Return Value
      • A List of Dictionaries of properties making up the configurations with the following keys and datatypes:
        • General
          • Id (long)

          • Enabled (bool)

          • PrimaryHostEnabled (bool)

          • PrimaryHostId (str)

          • BlockNodeCommands (bool)

          • BlockDeviceCommands (bool)

          • BlockTagPropertyChanges (bool)

          • StoreHistoricalEvents (bool)

          • EnableLatching (bool)

          • LatchTimeout (long)

          • LatchTagList (str)

          • FilteredProperties (str)

          • EnableBdSeqChecking (bool)

          • CustomProperties (str)

          • EnablePrimaryHostSubscriptions (bool)

        • Cert Files
          • Id (long)

          • Name (str)

          • FileContents (str)

          • Description (str)

        • Servers
          • Id (long)

          • Name (str)

          • Enabled (bool)

          • Url (str)

          • Username (str)

          • Password (str)

          • CaCertFileId (long)

          • ClientCertFileId (long)

          • ClientPrivateKeyFileId (long)

          • ClientKeyPassword (str)

          • HostnameVerification (bool)

          • ClientId (str)

          • CleanSession (bool)

          • KeepAlive (int)

          • FilteredNamespaces (str)

        • Def Namespace Files
          • Id (long)

          • IgnoreFiles (bool)

          • FileHostType (str) "ACTIVE" or "PASSIVE"

          • BaseFileDirectory (str)

          • AddTopicTokens (bool)

          • FileStoringPolicy (str)

        • Def Namespace Filters
          • Id (long)

          • NamespaceId (long)

          • GroupId (str)

          • EdgeNodeId (str)

        • Def Namespace
          • Id (long)

          • Name (str) "Elecsys", "Sparkplug A", Sparkplug B", or "Xirgo"

          • Enabled (bool)

        • Cust Namespace
          • Id (long) 

          • Name (str) 

          • Subscription (str)

          • QoS1 (bool)

          • RootFolder (str)

          • TagName (str)

          • JsonPayload (bool)

          • Charset (str)

          • WritableTags (bool)

  • system.cirruslink.engine.updateConfig(type, id, collisionPolicy, props) → void
    • Parameters
      • String type
        • The type of configuration to update with valid options:

          • General
          • Cert Files
          • Servers
          • Def Namespace Files
          • Def Namespace Filters
          • Def Namespace
          • Cust Namespace
      • Long id
        • The ID of the record to update
      • String collisionPolicy
        • Either "MergeOverwrite" or "Overwrite"
      • Map props
        • Dictionary of properties making up the configuration with the following keys and datatypes: 
          • General
            • Id (long)

            • Enabled (bool)

            • PrimaryHostEnabled (bool)

            • PrimaryHostId (str)

            • BlockNodeCommands (bool)

            • BlockDeviceCommands (bool)

            • BlockTagPropertyChanges (bool)

            • StoreHistoricalEvents (bool)

            • EnableLatching (bool)

            • LatchTimeout (long)

            • LatchTagList (str)

            • FilteredProperties (str)

            • EnableBdSeqChecking (bool)

            • CustomProperties (str)

            • EnablePrimaryHostSubscriptions (bool)

          • Cert Files
            • Id (long)

            • Name (str)

            • FileContents (str)

            • Description (str)

          • Servers
            • Id (long)

            • Name (str)

            • Enabled (bool)

            • Url (str)

            • Username (str)

            • Password (str)

            • CaCertFileId (long)

            • ClientCertFileId (long)

            • ClientPrivateKeyFileId (long)

            • ClientKeyPassword (str)

            • HostnameVerification (bool)

            • ClientId (str)

            • CleanSession (bool)

            • KeepAlive (int)

            • FilteredNamespaces (str)

          • Def Namespace Files
            • Id (long)

            • IgnoreFiles (bool)

            • FileHostType (str) "ACTIVE" or "PASSIVE"

            • BaseFileDirectory (str)

            • AddTopicTokens (bool)

            • FileStoringPolicy (str)

          • Def Namespace Filters
            • Id (long)

            • NamespaceId (long)

            • GroupId (str)

            • EdgeNodeId (str)

          • Def Namespace
            • Id (long)

            • Name (str) "Elecsys", "Sparkplug A", Sparkplug B", or "Xirgo"

            • Enabled (bool)

          • Cust Namespace
            • Id (long) 

            • Name (str) 

            • Subscription (str)

            • QoS1 (bool)

            • RootFolder (str)

            • TagName (str)

            • JsonPayload (bool)

            • Charset (str)

            • WritableTags (bool)

    • Return Value
      • None
  • system.cirruslink.engine.deleteConfig(type, id) → void
    • Parameters
      • String type
        • The type of configuration to delete with valid options:

          • Cert Files
          • Servers
          • Def Namespace Filters
          • Def Namespace
          • Cust Namespace
      • Long id
        • The ID of the record to delete
    • Return Value
      • None


  • No labels