Versions Compared

Key

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

...

The agent's configuration dialogs contain three different tabs; General, Subscribe and Advanced.

General Tab

 The General tab contains configurations related to the MQTT Connection Details.


MQTT Agent Configuration, General tab


SettingDescription

Username

Enter the user name to be used for the connection to the MQTT server.

Password

Enter the password to be used for the connection to the MQTT server.

Use TLS

Select this check box to have the MQTT agent use TLS. The fields beneath will then be activated.

Note
titleSetting up TLS

For more information on setting up TLS, refer to 4. Network Security.


Keystore PathEnter the location of the keystore used by the TLS.
Keystore Password

Enter the password for the keystore indicated in the Keystore Path field.

Broker ConnectionEnter the IP address or hostname of the target broker.
Broker PortEnter the port value of the target broker.


Subscribe Tab

The Subscribe tab contains configurations related to topic subscription, where the MQTT agent will subscribe to 1 or many topics in the subscriber/publisher.

MQTT Agent Configuration, Subscribe tab


SettingDescription
TopicEnter the value for the MQTT topic in this field.
QoSSelect the value for the Quality of Service out of 3 choices, At Most once (0), At Least one (1) and Exactly once (2)


Advanced Tab

The Advanced tab contains additional properties for the MQTT agent.

...

SettingDescription
Keep AliveEnter a Keep Alive (in seconds) value for the MQTT agent. The Keep Alive is set to 60 seconds by default.
Use Clean Session

Select this check box to have the MQTT agent set to use clean session. MQTT agent is set to use persistent session by default.

Client IDEnter the value for the Client ID of the MQTT agent.
Use Will Message

Select this check box to have the MQTT agent use Will Message. The fields beneath will then be activated.

Info
titleWill Message

The following parameters are used to set up a Will Message as specified in the OASIS Standard MQTT Version 3.1.1 Specification


Enable Will Message RetainSelect this check box to have the MQTT agent to set retain Will Message to true in the MQTT server.
Will Message TopicEnter the value for the topic to be used in the Will Message.
Will MessageEnter the message to be included in the Will Message.
Will Message Quality of ServiceSelect the value for the Quality of Service to be used by Will Message. As indicated above, there will be 3 choices, At Most once (0), At Least one (1) and Exactly once (2)


Scroll ignore
scroll-viewportfalse
scroll-pdftrue
scroll-officefalse
scroll-chmtrue
scroll-docbooktrue
scroll-eclipsehelptrue
scroll-epubtrue
scroll-htmlfalse


Next: