Page History

...

• 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 create created of the form 'IgnitionTargetME-xxxxxxxxxxxxxxxxx-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.

...

• Enable Legacy STATE messages
  • Whether or not connections to enable legacy STATE messages (e.g. STATE/[host_id]). This is false by default unless upgrading from a previous module version.

• Enable Primary Host Subscriptions

  • Whether or not to enable MQTT Engine subscriptions on legacy STATE/# and State/# topics.
  • Requires that Enable Legacy STATE messages is TRUE and Primary Host Enabled is FALSE and/or Primary Host ID is null.
  • This setting is for debugging purposes only.
• Username
  • Optional MQTT username to use in the MQTT connect packet.  This is required if the MQTT Server to connect to requires it.
• Password
  • Optional MQTT password to use in the MQTT connect packet.  This is required if the MQTT Server to connect to requires it.
• Client ID
  • The MQTT Client ID for connections to the MQTT Server. If left blank one will be auto-generated .of the form ME-LS-xxxxxxxx-xxxx-xxxx
• CA Certification File
  • CA Certification file currently in use.
• Client Certification File
  • Client Certification file currently in use.
• Client Private Key File
  • Client Private Key file currently in use
• Password
  • Optional password associated with the certificate's private key.
• Hostname Verification
  • Enable TLS Hostname Verification. This is true by default.
• TLS ALPN Extensions
  
  • Optional TLS ALPN Extensions to use with this connection

...