Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Warning

Configuration changes made through scripting do not have the same validation as when made through the UI. 

For example, deleting attempting to delete a Sets configuring that is being referenced by a Servers configuration will result in the UI showing an Internal Errorno action being performed.

The logs will show an error

Image Added

Extended Operations

...

Code Block
languagepy
# 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("Transmittertransmitter", "CustomOne", transmitterProps, True, "My First Custom Transmitter")

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

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