Page History

...

Anchor
ServerSettingsAdvanced ServerSettingsAdvanced

Server Settings - AdvancedImage RemovedImage Added

• Client ID
  • Optional MQTT client ID to use.  If specified this will be used in the MQTT Engine connect packet when connecting to the server.  If left blank, a random client ID will be created of the form 'ME-xxxxxxxxx-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
  KeepAlive KeepAlive

  Keep Alive
  • The maximum interval in seconds (5-65,535) between any two MQTT protocol control packets sent by the client to the server.
  • Minimum Keep Alive for MQTT Engine 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 message if defined.

  • For MQTT Engine with Primary Host enabled, this is a message of format spBv1.0/STATE/primary_host_id with a payload {"online" : false, "timestamp" : 1668114759262}

  • For MQTT Engine with Legacy Primary Host enabled, this is a message of format STATE/primary_host_id with a payload of OFFLINE
• Filtered Namespaces
  • A comma separated list of namespaces that will be filtered/disabled for connections to this MQTT Server.
  • The default namespaces are Elecsys, Xirgo, Sparkplug A and Sparkplug B.
• Include Sparkplug DataTypes
  • Whether or not to include Sparkplug DataTypes for Metrics in Sparkplug CMD payloads
  • Enabled by default

Anchor
ServerSettingsAdvancedLegacy ServerSettingsAdvancedLegacy

Server Settings - Advanced Legacy State

...