Page History

...

• Enabled

  • Whether or not the MQTT Engine module is enabled and connecting to configured MQTT Servers.
    

• Anchor
  PrimaryHostEnabled PrimaryHostEnabled

  Primary Host Enabled
  • Whether or not primary host STATE message will be published. If true, the Primary Host ID must also be set.
  • When enabled, the MQTT Engine will publish it's connection state on a topic that contains the Primary Host ID.  In the event that MQTT Engine becomes disconnected from the server, a death certificate will be published on the same topic, setting the state to 'offline'.  Any connecting client that subscribes on the state topic will then be notified of the MQTT Engine state.

• Anchor
  PrimaryHost PrimaryHost

  Primary Host ID
  • The primary host ID to allow connecting clients to ensure they remain connected. 
  • This must contain only letters, numbers, or any of the following special characters: . $ % @ ! - _ ^ *

...

• 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 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
  KeepAlive KeepAlive

  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 message if defined. For MQTT engine, with Primary Host enabled, this is a STATE message of OFFLINE.

• Filtered Namespaces
  • A comma separated list of namespaces that will be filtered/disabled for connections to this MQTT Server.

...