MQTT settings

Access MQTT The degree to which the result of a measurement, calculation, or specification conforms to the correct value or a standard. settings using Device Configuration Utility Software tool used to set up data loggers and peripherals, and to configure PakBus settings before those devices are deployed in the field and/or added to networks. Also called DevConfig.. Clicking on a setting in Device Configuration Utility also provides information about that setting.

Where to find:

• All settings: Settings Editor tab in Device Configuration Utility: MQTT tab, unless noted.

See also MQTT.

MQTTBaseTopic (MQTT base topic)

This is the base topic which will automatically be used. Use this setting to override the default format: CS/{CAMPBELL CLOUD Account ID}/{MQTT Client Id}/.

• String data type

MQTTCleanSession (MQTT connection)

Assigns the MQTT broker connection type. Persistent sessions save all relevant client information on the broker. The client gets messages that it misses offline.

If the connection between the client and broker is interrupted during a Clean session, topics may be lost and the client needs to subscribe again. The client does not get messages that it misses offline.

• Long data type, allowed values:

  • 0 = Clean

  • 1 = Persistent (default)

MQTTClientID (MQTT client identifier)

Unique identifier the data logger uses to connect to MQTT broker. The default is the hardware type_serial number. Example: CR6_123.

• String data type, maximum number of characters is 64

MQTTEnable (Enable or disable MQTT)

By default, MQTT is disabled.

• Long data type, allowed values:

  • 0 = Disable (default)

  • 1 = Enable with TLS-Mutual Authentication

  • 2 = Enable with TLS

  • 3 = Enable MQTT

MQTTEndpoint (MQTT broker URL)

Server URL for MQTT broker.

• String data type

MQTTKeepAlive (MQTT keep alive)

When there has been no network activity for this amount of time, in seconds, a ping will be sent to the MQTTBrokerURL. Default = 0 which disables keep alive pings. Valid values are in the range 0 to 65535.

• Long data type

MQTTPassword (MQTT password)

Password, in association with MQTTUserName, required to connect to the MQTT broker.

• String data type

MQTTPortNumber (MQTT port number)

Port number to connect to the MQTT broker.

• Long data type, maximum number of characters is 256

MQTTStatusInterval (Status information publish interval)

Time (in minutes) between publishing MQTT status information. This interval determines how often the data logger publishes to the topic: {System Base Topic/}statuslnfo. Valid values are in the range 0 to 1440.

• Long data type

MQTTState (MQTT state)

This is a read-only field indicating the current state of the data logger connection to the MQTT broker.

• Long data type, possible results:

  • 0 = Disabled / Off

  • 8 = Disconnected. Sleeping

  • 10 = Waiting for an IP network interface

  • 11 = Connection retry wait

  • 20 = Opening TCP connection

  • 11 = TCP Open failed

  • 22 = TCP connection opened

  • 24 = Closing TCP connection

  • 26 = TCP connection closed

  • 30 = TLS handshake started

  • 31 = TLS handshake failed

  • 32 = TLS handshake success

  • 50 = MQTT session established

  • 51 = Waiting for session start response

  • 52 = Publishing

  • 100 = Onboard started

  • 101 = Onboard retry

  • 102 = Onboard processing

  • 200 = Waiting for modem startup

  • 201 = Configuring SSL

  • 202 = Configuring MQTT

  • 203 = Opening network

  • 204 = Connecting to MQTT broker

MQTTStateInterval (State publish interval)

Time (in minutes) between publishing MQTT state information. This interval determines how often the data logger publishes to the topic: {System Base Topic/}State. Valid values are in the range 0 to 1440. Setting the value to 0 will not disable normal state publishing activity, only interval publishing.

• Long data type

MQTTUserName (MQTT user name)

User name, in association with MQTTPassword, used to connect to MQTT broker.

• String data type, maximum number of characters is 256

MQTTWillMessage (MQTT last will message)

Message published on last will topic by broker if disconnected without a disconnect command.

• String data type, maximum number of characters is 256

MQTTWillQoS (Quality of service)

This is an agreement that defines the guarantee of delivery for a specific message. Higher QoS levels are more reliable, but take more time and bandwidth.

• Long data type, allowed values:

  • 0 = At most once (default), no confirmation

  • 1 = At least once, confirmation required

  • 2 = Exactly once using a multi-step handshake

MQTTWillRetain (MQTT last will message retained by broker)

Enables or disables the broker to retain MQTTWillMessage.

• Long data type, allowed values:

  • 0 = Do not retain (default)

  • 1 = Retain

MQTTWillTopic (MQTT last will topic)

Broker will publish the MQTTWillMessage to this topic if disconnected without a disconnect command.

• String data type, maximum number of characters is 64