...
- Client ID
- Keep Alive
- The maximum interval in seconds (5-65,535) between any two MQTT protocol control packets sent by the client to the server.
- The minimum Keep Alive for MQTT Transmission is 5.
- If the client is idle and has no control packets to send, it will send PINGREQ protocol packet and the server is required to respond with a PINGRESP packet. If no response is received from the server within 1.5 times the Keep Alive, the client will close the connection.
If the server does not receive, at minimum, a PINGREQ message from a client within 1.5 times the Keep Alive, it will terminate the connection and send the client's LWT if it has been defined.
For MQTT Transmission, this is an DEATH message.
- Random Startup Delay
- The Random Startup Delay in milliseconds of the form 'min-max' where min is the low end and max is the high end of the random range. e.g. '10-1000'.
- Reconnect Delay
- The clients reconnect delay in millisecond.
- Subscribe to Legacy STATE Topic
- Data Format Type
- The format of the data to send. Default is Sparkplug_B_v1_0_Protobuf with JSON as an option.
Anchor |
---|
| ServerSettingsRPCClient |
---|
| ServerSettingsRPCClient |
---|
|
Server Settings - RPC Client Connection
...
Anchor |
---|
| TransmittersAlarmSettings |
---|
| TransmittersAlarmSettings |
---|
|
Transmitters - Alarm Settings
Tip |
---|
Available in MQTT Transmission 4.0.16 and newer |
![](/download/attachments/33490947/image%20%2828%29.png?version=1&modificationDate=1687451466042&api=v2)
Anchor |
---|
| TransmittersSparkplugSettings |
---|
| TransmittersSparkplugSettings |
---|
|
Transmitters - Sparkplug Settings
...
Anchor |
---|
| TransmittersAdvancedSettings |
---|
| TransmittersAdvancedSettings |
---|
|
Transmitters - Advanced Settings
Image Removed
Image Added- Filtered Properties
- Rebirth Debounce Delay
- The amount of time, in milliseconds, to delay before processing Rebirth NCMD requests after one has been processed. Default of 5000 milliseconds.
- Include Sparkplug DataTypes
- Whether or not to include Sparkplug DataTypes for Metrics in Sparkplug DATA payloads
- Enabled by default
Records
...
Anchor |
---|
| RecordsRecordsSignature |
---|
| RecordsRecordsSignature |
---|
|
Records - Records Signature
Note |
---|
From version 4.0.19 added support for digital signatures/hashing of Records that are generated by MQTT Transmission so that they can be verified in the MQTT Recorder database. |
Note |
---|
From version 4.0.19, digital signature support has been added |
![](/download/attachments/33490947/history-4.png?version=1&modificationDate=1699369432207&api=v2)
- Enable Signature
- Checkbox to enable a digital signature field on all Records. Default is de-selected
- Algorithm
- The hashing algorithm to use when generating the digital signature
- Options are SHA_1,SHA_224,SHA_256,SHA_384 and SHA_512
- Password
- The password used to generate the PBE secret key for encrypting the digital signature
...
Note |
---|
From release 4.0.19, major improvements have been made to the disk-backed History Store. Details on configurating configuring pre 4.0.19 modules can be found here. |
Image Removed
Image Added
The History tab contains a Main section and an Advanced section.
History - Main
Image Removed
Image Added
- Name
- The name of the History Store.
- Enabled
- Checkbox to enable/disable the History Store. Not selected by default.
- Type
- The type of History Store.
- Data stored in an In-Memory History Store will not be persisted across a module configuration change, module disable/enable, module restart or power loss.
- Data stored in a Disk-Backed History Store will persist across a module configuration change, module disable/enable, module restart or power loss.History Store will persist across a module configuration change, module disable/enable, module restart or power loss.
- History Max Size
- Maximum number of megabytes history can use before dropping the data
- An In-Memory History store will use the Ignition Java Heap memory
- History Max Age
- Maximum number of minutes to store history before dropping the data.
- Flush Quantity
- The maximum number of tags to publish in a single message upon reestablishing communication.
- Flush Period
- The period to wait in milliseconds between publishes when flushing messages upon reestablishing re-establishing communication
Anchor |
---|
| HistoryAdvanced |
---|
| HistoryAdvanced |
---|
|
History - Advanced
...
Image Added
Rolling History Settings
- Enable Rolling History Buffer
- Enable/disable storing data in a rolling buffer to cover data loss in Keep Alive timeout scenario
- Rolling History Prune Interval
- The interval, in seconds at which to attempt to prune the rolling history buffer
- Rolling History Max Age
- The maximum age allowed of data, in seconds, in the rolling history buffer
- This should be at least 2 x the Keep Alive timeout
- Rolling History Prune Quantity
- The number of metrics to prune in a single block
Advanced Settings
- H2 Database Port
- TCP Port to connect to H2 Database for Disk-Backed History Store