QuickStart Guide
...
Ignition Module
Ignition Module Driver
6 min
review the following information for setting up and configuring the ignition module driver set up the ignition module see docid\ sd1vldcr7jcngzmqzhos to review how to set up and configure the ignition module driver ignition module driver settings in litmus edge when reviewing or modifying ignition module device settings, refer to the following parameters parameter value type ignition driver ignition module network port the port for communication between litmus edge and ignition the default value is 4778 interface optionally, select the interface for accepting client connections the default value is 0 0 0 0 , which means using all network interfaces for accepting connections from clients user the username for authentication with the ignition module (configured in ignition gateway) the default value is admin password the password for authentication with the ignition module enable tls disable or enable when enabled, data is encrypted using tls v1 3 when being sent between the module and driver nats connection name the nats connection name for the ignition agent (default is ignitionagent ) nats request timeout (ms) timeout for nats requests in milliseconds the default value is 5000 browse request timeout (ms) timeout for browse requests in milliseconds the default value is 5000 browse request items count maximum number of items per browse request the default value is 500 write request items count maximum number of items per write request the default value is 50 ensure that the network port is open for both the litmus edge and ignition instances if you use the default value of 4778 , you do not need to reconfigure the firewall in litmus edge browse tags once connected, ignition tags can be added to the device using hierarchical browse this can be done in either of the following ways navigate to devicehub > tags > add tag > browse tags and select the ignition device navigate to devicehub > browse select the ignition device and create a new browse session once a tag is added, it can be read through the tag alias topic see docid 8oruw1cmtao49bwbbhwrn for more details see docid\ qm0urcltmysimhm2 5kmx for more additional configuration of added tags when you docid\ tuy hh0gi8djvot70wroh to the connected device, refer to the following register table and tag parameters refer to the following additional resources organize device and tag data by using metadata tag formula variables important tags must preserve the name that is auto assigned to them during browsing which matches their tag path exactly (for example, \[system]/time/timestamp) changing this tag name will cause the litmus and ignition tags to be dissociated register table name value types atomic tag boolean, byte, short, integer, long, float, double, string, datetime, text, booleanarray, bytearray, shortarray, integerarray, longarray, floatarray, doublearray, stringarray, datetimearray, binarydata, document, dataset property boolean, byte, short, integer, long, float, double, string, datetime, text alarm dataset (json payload containing alarm information) note see https //docs litmus io/solutions/ignition integration#aqxd9 for detailed type conversions between ignition and litmus edge tag parameters name enter the ignition tag path (for example, \[default]folder/tagname or \[system]/time/timestamp) this name must match the exact tag path in ignition value type select a value type that corresponds to the ignition tag type see the register table for supported types tag name the tag name auto assigned during browsing this must match the tag path and should not be changed description (optional) enter a description for the tag publishing interval enter the publishing interval in seconds this determines how frequently tag values are published tag formula enter a formula for the tag to process the generated data two variables are permitted value (current tag value) and timestamp (current tag unix time in milliseconds) the following math functions are available sin cos sqrt tan power power( x ) performs the operation 10^x log log( x ) is the natural logarithm (the logarithm is in base e ) exp exp( x ) performs the operation e^x only publish on change of value select the checkbox to customize nats messages to be published only when the value parameter changes to a new one change of value only applies to boolean, numeric (such as int or float), and simple string data types it does not apply to complex types, such as json or array poll once topics will not be affected by change of value settings these topics will still only see a single message meta data metadata summarizes basic information about data this feature allows you to define key value pair data for the device output payload later on it can then be used to find, use, and reuse particular instances of data note if you use special characters in meta data key names, the special characters are replaced with underscore characters in the payload this can cause two key names to be combined into one for example, configuring the key names a b and a&\&b will cause only one key name to be created (a b)