Versions Compared

Key

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

...

Anchor
ServerSettingsAdvanced
ServerSettingsAdvanced
Server Settings - Advanced

...

Image Added


  • 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 'IgnitionTarget-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 (0-65,535) between any two MQTT protocol control packets sent by the client to the server.
    • Setting the Keep Alive to 0 will disable the Keep Alive functionality.
    • 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.
  • Auto-reconnect RPC Client
    • Allow the RPC Client to auto connect and reconnect when publishing from Ignition Python scripts.
  • 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

To publish files, MQTT Transmission uses a configured Transmitter. The properties entered into the Sparkplug settings for Group ID, Edge ID and Device ID (optional) must match an existing Sparkplug Edge Node based on a Transmitter and tag tree configuration.

Image Modified

  • Group ID
    • The Group ID that matches an existing Sparkplug Edge Node. Cannot be NULL
  • Edge Node ID
    • The Edge Node ID that matches an existing Sparkplug Edge Node. Cannot be NULL
  • Device ID
    • The Device ID that matches an existing Sparkplug Edge Node. (Optional).

...