Page History

The following API modules calls are available for the MQTT Distributor Module and can be executed within any of the available Ignition Designer Script Console scopes.

• createConfig
• readConfig
• updateConfig
• deleteConfig

...

• Anchor
  createConfig createConfig

  system.cirruslink.distributor.createConfig(type, props) → void
  
  • Parameters
    • String type

      • The type of configuration to create with valid options:

        • Users
    • Map props
      • Dictionary of properties making up the configuration with the following keys and datatypes:
        • Users
          • Id (long)
          • Username (str)
          • Password (str)
          • ACLs (str)
  • Return Value
    • NoneA map representing the newly created configuration after it has been written to the database. (added 4.0.16)

• Anchor
  readConfig readConfig

  system.cirruslink.distributor.readConfig(type) → List
  
  • Parameters
    • String type

      • The type of configuration to read with valid options:

        • General
        • Users
  • Return Value
    • A List of Dictionaries of properties making up the configurations with the following keys and datatypes: 
      
      • General
        
        • Id (long)
        • Enabled (bool)
        • EnableTCP (bool)
        • Port (int)
        • EnableWebsocket (bool)
        • WebsocketPort (int)
        • EnableTLS (bool)
        • SecurePort (int)
        • EnableSecureWebsocket (bool)
        • SecureWebsocketPort (int)
        • AllowAnonymousConnections (bool)
      • Users
        
        • Id (long)
        • Username (str)
        • Password (str)
        • ACLs (str)

• Anchor
  updateConfig updateConfig

  system.cirruslink.distributor.updateConfig(type, id, collisionPolicy, props) → void
  • Parameters
    • String type

      • The type of configuration to update with valid options:

        • General
        • Users
    • Long id
      • The ID of the record to update
    • String collisionPolicy
      • Either "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)
          • EnableTCP (bool)
          • Port (int)
          • EnableWebsocket (bool)
          • WebsocketPort (int)
          • EnableTLS (bool)
          • SecurePort (int)
          • EnableSecureWebsocket (bool)
          • SecureWebsocketPort (int)
          • AllowAnonymousConnections (bool)
        • Users
          
          • Id (long)
          • Username (str)
          • Password (str)
          • ACLs (str)
  • Return Value
    • NoneA map representing the updated configuration after it has been written to the database. (added 4.0.16)

• Anchor
  deleteConfig deleteConfig

  system.cirruslink.distributor.deleteConfig(type, id) → void
  
  • Parameters
    • String type

      • The type of configuration to delete with valid options:

        • Users
    • Long id
      • The ID of the record to delete
  • Return Value
    • NoneTrue if the record was successfully deleted otherwise False is returned (added 4.0.16)