MT: Python Scripting

Basic Operations

The following basic operations are available for the MQTT Transmission Module and can be executed within any of the available Ignition scopes using the format system.cirruslink.transmision.operation

• createConfig(type, name, config, enabled, description)
  
  • enabled (boolean) and description (string) are optional calls
  • returns a dictionary that represents the config.json of the specified resource
• deleteConfig(type, name)
  • returns a boolean
• getConfigNames(type, enabled)
  • enabled is an optional call
  • returns a list strings
• isConfigEnabled(type, name)
  • returns a boolean
• readConfig(type, name)
  • returns a dictionary that represents the config.json of the specified resource
• setConfigEnabled(type, name, enabled)
  • returns a boolean 
• updateConfig(type, name, collisionPolicy, config)
  • returns a dictionary that represents the config.json of the specified resource

where:

• type
  • string denoting the type of configuration to operate on
• name
  • string denoting the unique name for the configuration resource to operate on
• config
  • dictionary of properties making up the configuration resource to operate on
    • general
    • file
    • history_store
    • record
    • cert-file
    • server
    • server-set
    • transmitter
    • uns-transmitter
• enabled
  • boolean
• collisionPolicy
  • string with options "MergeOverwrite" or "Overwrite"
    • "MergeOverwrite" will replace the existing properties in the resource name with only those included in the call
    • "Overwrite" will replace all properties in the resource name with those in the call

Extended Operations

The following extended operations are available for the MQTT Transmission Module and can be executed within any of the available Ignition scopes using the format system.cirruslink.transmision.operation

• publish(mqttServerName, topic, payload, qos, retained)

where:

• mqttServerName
  • string
  • name of the server or server set to use from the MQTT Transmission Server configuration.
  • this must match an existing server or server set name in the configuration
• topic
  • string
  • valid MQTT topic to publish on
• payload
  • array
  • bytes representing the MQTT payload
• qos
  • integer
  • the MQTT 'Quality of Service' to use
  • must be either 0,1 or 2
• retained
  • boolean 
  • whether or not to publish this message with the retain flag set

Transmission 'type' keys

• general
• file
• history_store
• record
• cert-file
• server
• server-set
• transmitter
• uns-transmitter

Transmission 'general' keys

Transmission 'file' keys

Transmission 'history-store' keys

Transmission 'record' keys

Transmission 'cert-file' keys

Transmission 'server' keys

Transmission 'server-set' keys

Transmission 'transmitter' keys

Transmission 'uns_transmitter' keys

Sample Scripts

# Cirrus Link provides these scripts as examples only, they are not supported or guaranteed to meet any particular functionality. Cirrus Link cannot provide any assistance to modify these scripts to meet a particular need.

# Create Transmitter One
transmitterProps = {}
transmitterProps["tagProvider"] = "default"
transmitterProps["tagPath"] = ""
transmitterProps["tagPacingPeriod"] = 1000
transmitterProps["serverSet"] = "Default"
transmitterProps["discoveryDelay"] = 0
transmitterProps["aliasedTags"] = False
transmitterProps["compressionTypeWrapper"] = "NONE"
transmitterProps["blockCommands"] = False
transmitterProps["convertUdts"] = True
transmitterProps["publishUdtDefinitions"] = True
transmitterProps["optimizeUdts"] = True
transmitterProps["cacheBirthsEnabled"] = False
#transmitterProps["historyStore"] = None
transmitterProps["enableStoreForwardByDefault"] = True
transmitterProps["inOrderHistory"] = False
transmitterProps["groupId"] = "Test1G"
transmitterProps["edgeNodeId"] = "Test1E"
transmitterProps["deviceId"] = None
transmitterProps["filteredProperties"] = "accessRights;clampMode;deadband;deadbandMode;formatString;historicalDeadband;historicalDeadbandMode;historicalDeadbandStyle;historyEnabled;historyMaxAge;historyMaxAgeUnits;historyProvider;historySampleRate;historySampleRateUnits;historyTagGroup;historyTimeDeadband;historyTimeDeadbandUnits;opcItemPath;opcServer;permissionModel;rawHigh;rawLow;sampleMode;scaleFactor;scaleMode;scaledHigh;scaledLow;tagGroup;valueSource;expression;expressionType;ConfiguredTagPath;eventScripts;readPermissions;writePermissions;eventScripts"
transmitterProps["rebirthDebounceDelay"] = 5000
system.cirruslink.transmission.createConfig("Transmitter", "CustomOne", transmitterProps, True, "My First Custom Transmitter")

# MQTT Transmission Update Existing Transmitter using MergeOverwrite
transmitterProps = {}
transmitterProps["GroupId"] = "Test2G"
transmitterProps["EdgeNodeId"] = "Test2E"
system.cirruslink.transmission.updateConfig(“Transmitter”, "CustomOne", “MergeOverwrite”, transmitterProps)

# Delete Config
system.cirruslink.transmission.deleteConfig("Transmitter", "CustomOne")