Page History

...

• 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 set configured by default
  • Entered in the format of '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
  • A clients fixed reconnect delay in milliseconds with a default of 1000
• Subscribe to Legacy STATE Topic
  
  • Allow the Transmission Client to subscribe to a legacy state topic (eg. STATE/IamHost) for primary host ID notifications (available from release 4.0.16)
  • Review Changes to the STATE messages in the Sparkplug v3.0.0 Specification
• Data Format Type
  • The format of the data to send. Default is Sparkplug_B_v1_0_Protobuf with JSON as an option.

...

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