Versions Compared

Key

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

...

  • 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.
    • The default namespaces are Elecsys, Xirgo, Sparkplug A and Sparkplug B.

Anchor
ServerSettingsAdvancedLegacy
ServerSettingsAdvancedLegacy
Server Settings - Advanced Legacy State

...

  • Name
    • A friendly name of the namespace to easily identify it.
  • Enabled
    • Whether or not the namespace is enabled. This is true by default. 
    • If enabled, MQTT Engine will subscribe to the topics necessary to provide support for devices and data associated with that namespace.  If disabled, MQTT Engine will unsubscribe from those topics and no longer support the devices and data associated with that namespace.

Anchor
NamespacesDefaultFilters
NamespacesDefaultFilters
Namespaces Default - Filters

  • Group ID
    • The Group ID to be filtered included in the MQTT Engine subscriptions for this specific namespace.
  • Edge Node ID
    • Edge Node ID to be filteredincluded in the MQTT Engine subscriptions for this specific namspace.

Additional detail on the default namespaces is available here.

Anchor
NamespacesDefaultFiles
NamespacesDefaultFiles
Namespaces Default - Files

...