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
...
Anchorpublish publish
system.cirruslink.transmission.publish(mqttServerName, topic, payload, qos, retained) → void
Parameters
String mqttServerName
The name of the server connection to use in the MQTT Transmission 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
AnchorcreateConfig createConfig
system.cirruslink.transmission.createConfig(type, props) → void
Parameters
String type
The type of configuration to create with valid options:
History Stores
Cert Files
Servers
Sets
Transmitters
Records
Files
Map props
Dictionary of properties making up the configuration with the following keys and datatypes:
History Stores
Id (long)
Name (str)
Enabled (bool)
TransmissionHistoryStoreType (str) "IN_MEMORY" or "DISK_BACKED"
EdgeNodeTagCapacity (int)(deprecated 4.0.19)
DeviceTagCapacity (int)
FlushQuantity (int(deprecated 4.0.19)
FlushPeriod
HistoryMaxSize (
longint)
Cert Files
(added 4.0.22)
Name HistoryMaxAge (
strint)
FileContents (str(added 4.0.19)
Description FlushQuantity (strint)
Servers
Id FlushPeriod (long)
Name
RollingHistoryBufferEnabled (
strboo)
Url (str(added 4.0.17)
ServerSetId RollingHistoryMaxAge (
strint) (
must be includedadded 4.0.17)
Username RollingHistoryPruneInterval (
strint)
Password (str(added 4.0.17)
H2dbPort (
longint)
ClientCertFileId (long)
(added 4.0.22)
Cert Files
Id ClientPrivateKeyFileId (long)
ClientKeyPassword Name (str)
HostnameVerification FileContents (bool)
str)
ClientId Description (str)
Servers
Id KeepAlive (intlong)
RandomStartupDelay Name (str)
ReconnectDelay Url (longstr)
DataFormatTypeWrapper ServerSetId (str) "Sparkplug_B_v1_0_Protobuf" or "Sparkplug_B_v1_0_JSON"
AutoReconnectRpcClient (bool)
(must be included)
Username
(str)
Password (str)
CaCertFileId (
long)
ClientCertFileId (long)
ClientPrivateKeyFileId (long
)
ClientKeyPassword (str)
HostnameVerification
(bool)
TlsAlpnExtensions (str (added 4.0.18)
RpcUsername ClientId (str)
KeepAlive (int)
RandomStartupDelay (str)
ReconnectDelay (long)
DataFormatTypeWrapper (str) "Sparkplug_B_v1_0_Protobuf" or "Sparkplug_B_v1_0_JSON"
AutoReconnectRpcClient (bool)
RpcClientKeyPassword (str) (added 4.0.18)
RpcPassword RpcClientEnabled (strbool) (added 4.0.18)
RpcCaCertFileId RpcClientPrivateKeyFileId (long) (added 4.0.18)
Sets
RpcTlsAlpnExtensions (
longstr)
Name (str(added 4.0.18)
Description (strRpcHostnameVerification (bool) (added 4.0.18)
RpcUsername (str)
Transmitters
(added 4.0.18)
RpcClientId (str)
Enabled (bool)
TagProvider (str)
(added 4.0.18)
RpcClientCertFileId (long) (added 4.0.18)
RpcPassword
TagPath (str)
TagPacingPeriod (long(added 4.0.18)
RpcCaCertFileId (long) (added 4.0.18)
Sets
Id
must be included)DiscoveryDelay (long)
AliasedTags Name (boolstr)
CompressionTypeWrapper Description (long) "NONE" "DEFLATE" or "GZIP"
str)
PrimaryHostId (str)
Transmitters
Id (long)
Name (str)
Enabled
BlockCommands (bool)
ConvertUdts (bool)
PublishUdtDefinitions (bool)
OptimizeUdts (bool)
CacheBirthsEnabled TagProvider (boolstr)
HistoryStoreId TagPath (longstr)
EnableStoreForwardByDefault TagPacingPeriod (boollong)
InOrderHistory ServerSetId (boollong)
GroupId (strmust be included)
EdgeNodeId DiscoveryDelay (strlong)
DeviceId AliasedTags (strbool)
FilteredProperties CompressionTypeWrapper (str)
RebirthDebounceDelay (long)
Records
long) "NONE" "DEFLATE" or "GZIP"
BlockCommands (bool)
ConvertUdts (bool)
PublishUdtDefinitions (bool)
OptimizeUdts (bool)
CacheBirthsEnabled (bool)
HistoryStoreId (long)
EnableStoreForwardByDefault (bool)
InOrderHistory (bool)
Id (long)
TagProvider (str)
TagFolderPath (str)
RecordType (long)
GroupId (str)
EdgeNodeId (str)
DeviceId (str)
OverridePublishTag FilteredProperties (boolstr)
PublishTagPath RebirthDebounceDelay (strlong)
Records
Files
Id (long)
TagProvider (str)
TagFolderPath (str)
EnableAutoPublishing RecordType (boollong)
FileScanRate (int)
GroupId (str)
EdgeNodeId (str)
DeviceId (str)
MessageSize OverridePublishTag (intbool)
MessagePacingPeriod PublishTagPath (intstr)
MessageAckTimeout
EnableSignature (
int)Return Value
bool)(added 4.0.
20)
SignaturePassword (str)(added 4.0.20)
HashingAlgorithm (str)(added 4.0.20)"SHA_1","SHA_224","SHA_256","SHA_384" or "SHA_512"
Files
Id (long)
TagProvider (str)
TagFolderPath (str)
EnableAutoPublishing (bool)
FileScanRate (int)
GroupId (str)
EdgeNodeId (str)
DeviceId (str)
MessageSize (int)
MessagePacingPeriod (int)
MessageAckTimeout (int)
Return Value
A map representing the newly created configuration after it has been written to the database. (added 4.0.16)
Anchor readConfig readConfig
system.cirruslink.transmission.readConfig(type) → List
Parameters
String type
The type of configuration to read with valid options:
History Stores
General
Cert Files
Servers
Sets
Transmitters
Records
Files
Return Value
A List of Dictionaries of properties making up the configurations with the following keys and datatypes:
History Stores
Parameters
String type
The type of configuration to read with valid options:
History Stores
General
Cert Files
Servers
Sets
Transmitters
Records
Files
Return Value
A List of Dictionaries of properties making up the configurations with the following keys and datatypes:
History Stores
Id (long)
Name (str)
Enabled (bool)
TransmissionHistoryStoreType (str) "In-Memory" or "Disk-Backed"
EdgeNodeTagCapacity (int)
DeviceTagCapacity (int)
FlushQuantity (int)
FlushPeriod (long)
General
Id (long)
Enabled (bool)
Cert Files
Id (long)
Name (str)
FileContents Enabled (strbool)
Description TransmissionHistoryStoreType (str)
Servers
"In-Memory" or "Disk-Backed"
EdgeNodeTagCapacity (int)(deprecated 4.0.19)
DeviceTagCapacity (int)(deprecated 4.0.19)
HistoryMaxSize (int)(added 4.0.22)
HistoryMaxAge (int)(added 4.0.19)
FlushQuantity (int)
FlushPeriod (long)
RollingHistoryBufferEnabled (bool)(added 4.0.17)
RollingHistoryMaxAge (int)(added 4.0.17)
RollingHistoryPruneInterval (int
Id (long)
Name (str)
Url (str)
ServerSetId (str)
Username (str)
Password (str)
CaCertFileId (long)
ClientCertFileId (long)
ClientPrivateKeyFileId (long)
ClientKeyPassword (str)
HostnameVerification (bool)
ClientId (str)
KeepAlive (int)
RandomStartupDelay (str)
ReconnectDelay (long)
DataFormatTypeWrapper (str) "Sparkplug_B_v1_0_Protobuf" or "Sparkplug_B_v1_0_JSON"
AutoReconnectRpcClient (bool)
RpcClientKeyPassword (str)(added 4.0.1817)
RpcClientEnabled H2dbPort (boolint)(added 4.0.1822)
General
Id (long)
Enabled (bool)
RpcTlsAlpnExtensions AuditProfileRecordId (strlong)(added 4.0.1816)
Cert Files
Id (
long)
Name (str)
FileContents (str
)
Description (str)
Servers
Id
(long)
Name (str)
Url (str)
ServerSetId (str)
Username (
str)
Sets
Password (str)
CaCertFileId
Id (long)
Name ClientCertFileId (strlong)
Description ClientPrivateKeyFileId (strlong)
PrimaryHostId ClientKeyPassword (str)
Transmitters
Id HostnameVerification (longbool)
Name ClientId (str)
Enabled KeepAlive (boolint)
TagProvider RandomStartupDelay (str)
TagPath (str)
TagPacingPeriod ReconnectDelay (long)
ServerSetId (long)
DiscoveryDelay (long)
AliasedTags (bool)
CompressionTypeWrapper (long) "NONE" "DEFLATE" or "GZIP"
DataFormatTypeWrapper (str) "Sparkplug_B_v1_0_Protobuf" or "Sparkplug_B_v1_0_JSON"
AutoReconnectRpcClient
BlockCommands (bool)
ConvertUdts RpcClientKeyPassword (
boolstr)
PublishUdtDefinitions (bool(added 4.0.18)
RpcClientEnabled (bool)
CacheBirthsEnabled (bool(added 4.0.18)
RpcClientPrivateKeyFileId (long)
EnableStoreForwardByDefault (bool)
(added 4.0.18)
RpcTlsAlpnExtensions (str) (added 4.0.18)
RpcHostnameVerification
InOrderHistory (bool)
GroupId (str(added 4.0.18)
RpcUsername (str)
DeviceId (str(added 4.0.18)
RpcClientId (str)
RebirthDebounceDelay (long)
Records
(added 4.0.18)
RpcClientCertFileId
(long)
(added 4.0.18)
RpcPassword
TagProvider (str)
TagFolderPath (str(added 4.0.18)
RpcCaCertFileId (long)
(added 4.0.18)
Sets
Id (long)
Name
GroupId (str)
EdgeNodeId (str)
DeviceId (str)
OverridePublishTag Description (boolstr)
PublishTagPath PrimaryHostId (str)
Files
Transmitters
Id (long)
TagProvider Name (str)
TagFolderPath Enabled (bool)
TagProvider (str)
EnableAutoPublishing TagPath (boolstr)
FileScanRate TagPacingPeriod (intlong)
GroupId ServerSetId (strlong)
EdgeNodeId DiscoveryDelay (strlong)
DeviceId AliasedTags (strbool)
MessageSize CompressionTypeWrapper (int)
MessagePacingPeriod (int)
MessageAckTimeout (int)
long) "NONE" "DEFLATE" or "GZIP"
BlockCommands (bool)
ConvertUdts (bool)
PublishUdtDefinitions (bool)
OptimizeUdts (bool)
CacheBirthsEnabled (bool)
HistoryStoreId (long)
EnableStoreForwardByDefault (bool)
InOrderHistory (bool)
GroupId (str)
EdgeNodeId (str)
DeviceId (str)
FilteredProperties (str)
RebirthDebounceDelay (long)
Records
Id (long)
TagProvider (str)
TagFolderPath (str)
RecordType (long)
GroupId (str)
EdgeNodeId (str)
DeviceId (str)
OverridePublishTag (bool)
PublishTagPath (str)
EnableSignature (bool)(added 4.0.20)
SignaturePassword (str)(added 4.0.20)
HashingAlgorithm (str)(added 4.0.20)"SHA_1",SHA_224","SHA_256","SHA_384" or "SHA_512"
Files
Id (long)
TagProvider (str)
TagFolderPath (str)
EnableAutoPublishing (bool)
FileScanRate (int)
GroupId (str)
EdgeNodeId (str)
DeviceId (str)
MessageSize (int)
MessagePacingPeriod (int)
MessageAckTimeout (int)
Anchor updateConfig updateConfig
system.cirruslink.transmission.updateConfig(type, id, collisionPolicy, props) → void
Parameters
String type
The type of configuration to update with valid options:
History Stores
General
Cert Files
Servers
Sets
Transmitters
Records
Files
Long id
The ID of the record to update
String collisionPolicy
"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:
History Stores
Id (long)
Name (str)
Enabled (bool)
TransmissionHistoryStoreType (str) "IN-MEMORY" or "DISK_BACKED"
EdgeNodeTagCapacity (int)(deprecated 4.0.19)
DeviceTagCapacity (int)(deprecated 4.0.19)
HistoryMaxSize (int)(added 4.0.22)
HistoryMaxAge (int)(added 4.0.19)
FlushQuantity (int)
FlushPeriod (long)
RollingHistoryBufferEnabled (bool)(added 4.0.17)
RollingHistoryMaxAge (int)(added 4.0.17)
RollingHistoryPruneInterval (int)(added 4.0.17)
H2dbPort (int)(added 4.0.22
Parameters
String type
The type of configuration to update with valid options:
History Stores
General
Cert Files
Servers
Sets
Transmitters
Records
Files
Long id
The ID of the record to update
String collisionPolicy
"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:
History Stores
Id (long)
Name (str)
Enabled (bool)
TransmissionHistoryStoreType (str) "IN-MEMORY" or "DISK_BACKED"
EdgeNodeTagCapacity (int)
DeviceTagCapacity (int)
FlushQuantity (int)
)
General
Id (long)
Enabled (bool)
AuditProfileRecordId (long)(added 4.0.16)
Cert Files
Id (long)
Name (str)
FileContents (str)
Description (str)
Servers
Id (long)
Name (str)
Url (str)
ServerSetId (str)
Username (str)
Password (str)
CaCertFileId (long)
ClientCertFileId (long)
ClientPrivateKeyFileId (long)
ClientKeyPassword (str)
HostnameVerification (bool)
ClientId (str)
KeepAlive (int)
RandomStartupDelay (str)
ReconnectDelay (long)
DataFormatTypeWrapper (str) "Sparkplug_B_v1_0_Protobuf" or "Sparkplug_B_v1_0_JSON"
AutoReconnectRpcClient (bool)
RpcClientKeyPassword (str) (added 4.0.18)
RpcClientEnabled (bool) (added 4.0.18)
RpcClientPrivateKeyFileId (long) (added 4.0.18)
RpcTlsAlpnExtensions (str) (added 4.0.18)
RpcHostnameVerification (bool) (added 4.0.18)
RpcUsername (str) (added 4.0.18)
RpcClientId (str) (added 4.0.18)
RpcClientCertFileId (long) (added 4.0.18)
RpcPassword (str) (added 4.0.18)
RpcCaCertFileId (long) (added 4.0.18)
Sets
Id (long)
Name (str)
Description (str)
PrimaryHostId (str)
Transmitters
Id (long)
Name (str)
Enabled (bool)
TagProvider (str)
TagPath (str)
TagPacingPeriod (long)
ServerSetId (long)
DiscoveryDelay (long)
AliasedTags (bool)
CompressionTypeWrapper (long) "NONE" "DEFLATE" or "GZIP"
BlockCommands (bool)
ConvertUdts (bool)
PublishUdtDefinitions (bool)
OptimizeUdts (bool)
CacheBirthsEnabled (bool)
HistoryStoreId (long)
EnableStoreForwardByDefault (bool)
InOrderHistory (bool)
GroupId (str)
EdgeNodeId (str)
DeviceId (str)
FilteredProperties (str)
RebirthDebounceDelay (long)
Records
Id (long)
TagProvider (str)
TagFolderPath (str)
RecordType (long)
GroupId (str)
EdgeNodeId (str)
DeviceId (str)
OverridePublishTag (bool)
PublishTagPath (str)
EnableSignature (bool)(added 4.0.20)
SignaturePassword (str)(added 4.0.20)
Files
Id (long)
TagProvider (str)
TagFolderPath (str)
EnableAutoPublishing (bool)
FileScanRate (int)
GroupId (str)
EdgeNodeId (str)
DeviceId (str)
MessageSize (int)
MessagePacingPeriod (int)
MessageAckTimeout (int)
Return Value
A map representing the updated configuration after it has been written to the database. (added 4.0.16)
AnchordeleteConfig deleteConfig
system.cirruslink.transmission.deleteConfig(type, id) → void
Parameters
String type
The type of configuration to delete with valid options:
History Stores
General
Cert Files
Servers
Sets
Transmitters
Records
Files
Long id
The ID of the record to delete
Return Value
True if the record is successfully deleted otherwise False is returned (added 4.0.16)
...