Versions Compared

Old Version 121

changes.mady.by.user Gill Houghton

Saved on

compared with

New Version Current

changes.mady.by.user Gill Houghton

Saved on

Key

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

...

  • Client ID

    • Optional MQTT client ID to use.  If specified this will be used in the MQTT Transmission connect packet when connecting to the server.  If left blank, a random client ID will be create of the form 'MT-xxxxxxxx-xxxx-xxxx'.

      Warning
      Caution: MQTT Clients IDs must be unique and if two clients attempt to connect with the same client ID, one will be forcefully disconnected from the server to allow the other client to connect. 


  • Anchor
    Keep Alive
    Keep Alive
    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
    • A clients variable reconnect delay in milliseconds - not configured by default
    • Entered in the format of 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'. 
    • Used to minimise "NBIRTH message storms" on reconnect from Edge nodes with many clients 
  • Reconnect Delay
    • The A clients fixed reconnect delay in millisecond.milliseconds with a default of 1000
  • 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.

...

Note

If both the Random Startup Delay and the Reconnect Delay are configured, the startup delay for any one client will be the aggregate of the two configured values. For example, with the Random Startup Delay = 10-1000ms and the Reconnect Delay = 1000ms, the startup delay for any one client will be between 1010 and 2000ms


Anchor
ServerSettingsRPCClient
ServerSettingsRPCClient
Server Settings - RPC Client Connection

This section was added in release 4.0.18

...

Anchor
TransmittersAlarmSettings
TransmittersAlarmSettings
Transmitters - Alarm Settings

Tip
Available in

MQTT Transmission 4.0.16

and newer

Image Removed

...

through 4.0.22 support the propagation of alarm events from the Edge to MQTT Engine on the Central Gateway to be inserted in the Ignition Alarm Journal but do not support the remote acknowledgment of those alarms

MQTT Transmission 4.0.23 and newer support the propagation of alarm events from the Edge to MQTT Engine on the Central Gateway to be inserted in the Ignition Alarm Journal along with acknowledgements from the Central Gateway back to the Edge

Review the Alarm Event Propagation document for system configuration details including the changes needed

When enabled and alarms are enabled on tags, the contents of the triggered alarms will be transmitted via Sparkplug to MQTT Engine and will be inserted into the Ignition Alarm Journal on the server where MQTT Engine is installed.

Note

This is not full alarm support as the ability to clear or ack an alarm from MQTT Engine is not currently supported

...

to the data/ignition.conf file and MQTT Engine

Image Added

  • Alarm Event Enable

    • When enabled and alarms are enabled on tags, the contents of the triggered alarms will be transmitted via Sparkplug to MQTT Engine and will be inserted into the Ignition Alarm Journal on the server where MQTT Engine is installed.

      but replace the 'XX' with the proper index per the wrapper.java.additional statements:
      wrapper.java.additional.XX=--add-opens=java.base/java.util.concurrent.atomic=ALL-UNNAMED

Anchor
TransmittersSparkplugSettings
TransmittersSparkplugSettings
Transmitters - Sparkplug Settings

...

Note
From release 4.0.19, major improvements have been made to the disk-backed History Store. Details on configuring pre 4.0.19 modules can be found here. be found here. 


Tip

Prior to release 4.0.22, Disk-Backed History stores are located here ~yourIgnitionInstance\user-lib\cls\data\h2

From release 4.0.22, Disk-Backed History store are located here ~yourIgnitionInstance\data\modules\com.cirrus-link\com.cirruslink.mqtt.transmission.gateway\h2

The History tab contains a Main section and an Advanced section.

...

  • H2 Database Port
    • TCP Port to connect to H2 Database for Disk-Backed History Store
Warning

If using multiple Disk-Back History Stores, the TCP Database Port must be unique for each one.

This requirement applies to all Disk-Backed History Stores (MQTT Transmission and all Injectors), MQTT Engine Alarm Stores and Chariot MQTT Server (uses TCP Port 9092) if co-located on the same platform