Contents
Cirrus Link Resources
Cirrus Link Website
Contact Us (Sales/Support)
Forum
Cirrus Link Modules Docs for Ignition 7.9.x
Inductive Resources
Ignition User Manual
Knowledge Base Articles
Inductive University
Forum
The following API modules are available for the MQTT Distributor Module and can be executed within the Ignition Designer Script Console.
APIs
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
None
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"
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
None
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
None
...