MQTT Connections

Name

(Mandatory)

Name for the MQTT Connection.

Description

Descriptive name for the MQTT Connection.

Server

(Mandatory)

IP address of the MQTT server.

Port

(Mandatory)

Port number of the WebSocket protocol in the MQTT server.

The default value is 8080.

Note: The Broker should be enabled with WebSockets.

Secure Connection

Allow or disallow secure WebSocket.

• Select Yes to allow secure WebSocket using TLS.

• Select No to disallow secure WebSocket.

The default value is No.

Note: For secure WebSocket, ensure to install CA Root Certificate on client under Trusted Root Certification Authorities.

If the Enterprise Console Web Application is configured with secured protocol, you need to select Yes for the MQTT Connection to work properly.

When the Enterprise Console Site is configured as Secured (HTTPS protocol), then the MQTT connections would work only with Secured configuration.

WebSocket Endpoint (Mandatory)

Enter the WebSocket Endpoint.

For example, mqtt or ws.

The default value is mqtt.

Client ID Prefix

Client ID prefix for the MQTT Connection, if required.

Anonymous

Allow or disallow all users.

• Select Yes to allow all users. In such cases User Name and Password are not required.

• Select No to disallow all users. In such cases User Name and Password are required.

The default value is No.

User Name

(Mandatory)

User ID for the MQTT Connection.

Note: User Name is not available if Anonymous is set to Yes.

Password

(Mandatory)

Password for the MQTT Connection.

Note: Password is not available if Anonymous is set to Yes.

MQTT Version

Version of the MQTT.

The default value is 3.1.1.

Reconnection Attempts (Mandatory)

Number of times to try connecting when the MQTT Connection fails.

The range is between -1 to 20. If the value is set to -1, then there is no limit to the number of attempts, and if the value is set to 0, then there will be no attempts.

The default value is 3.

Reconnection Period (Mandatory)

Time (in milliseconds) between the connection attempts when the MQTT Connection fails.

The range is between 10000 to 300000.

The default value is 30000.

Quality of Service

Quality of service for the MQTT Connection.

• At Most Once: The message is sent once. The message is also deleted, and no duplicate messages are possible.

• At Least Once: The message is sent multiple times. The message is also stored, and duplicate messages are possible.

• Exactly Once: The message is sent and acknowledgement is awaited. The message is also stored, and no duplicate messages are possible.

  The default value is Exactly Once.

Update Rate (Mandatory)

Time (in milliseconds) at which data is updated.

The range is between 0 to 3600000. If the value is set to 0, then the data is updated immediately.

The default value is 0.