MQTT

Driver Plugin ID:

com.tibbo.linkserver.plugin.device.mqtt

Setting

Description

Connection Method

Dictates how the device establishes a connection with the MQTT broker. Options include:

• TCP: A standard, unencrypted connection method using TCP, suitable for local networks where security isn't critical.

• SSL/TLS: A secure, encrypted connection using SSL/TLS, protecting data transmitted between client and broker and essential for sensitive data over untrusted networks.

• WebSocket: Uses the WebSocket protocol for persistent, bidirectional communication, often employed in web browsers but lacking inherent encryption.

• Secure WebSocket: Combines WebSockets with SSL/TLS encryption, providing secure and persistent connections for web-based MQTT applications handling sensitive data.

Broker Address

The hostname or domain name of the MQTT broker.

Port

Indicate the port where the MQTT broker is listening. If no port is specified, the device will attempt to connect to the broker using the default port appropriate for the selected Connection Method.

Topics

Table of subscribed topics and QoS (Quality of Service) parameters. Topics support wildcards. QoS parameter can be set to 0, 1 or 2.

• QoS 0 indicates that a message should be delivered at most once (zero or one times).

• QoS 1 indicates that a message should be delivered at least once (one or more times).

• QoS 2 indicates that a message should be delivered once.

Message Data Format

Data type of the Message Data field of Message events. Possible types are:

• Text Message Data field of Message events will contain received message text.

• Binary Message Data field of Message events will contain the raw data of received messages in the Data Block format.

Client ID

This is an identifier of each client connecting to a server. Client ID must be unique across all clients. It is used by the server to store data related to the client, hence it is important that this parameter remains the same when connecting to a server if durable subscriptions or reliable messaging are required. By default, Client ID is generated automatically.

Clean Session

Sets whether the client and server should remember state across restarts and reconnects. If set to false both the client and server will maintain state across restarts of the client, the server and the connection. Message delivery will be reliable meeting the specified QoS even if the client, server or connection are restarted. If set to true the client and server will not maintain state across restarts of the client, the server or the connection.

Keep Alive Interval

This value, measured in seconds, defines the maximum time interval between messages sent or received. It enables the client to detect if the server is no longer available, without having to wait for the TCP/IP timeout. The client will ensure that at least one message travels across the network within each keep alive period. In the absence of a data-related message during the time period, the client sends a very small "ping" message, which the server will acknowledge. A value of 0 disables parameter processing in the client.
The default value is 60 seconds.

Connection Timeout

Sets the connection timeout value. This value, measured in seconds, defines the maximum time interval the client will wait for the network connection to the MQTT server to be established. The default timeout is 30 seconds. A value of 0 disables timeout processing meaning the client will wait until the network connection is made successfully or fails.

Certificate Trust Policy

Defines how to verify certificates provided via an SSL/TLS connection.

Certificate

Alias of an SSL/TLS certificate to use for authentication. The certificate with that alias must exist in the server's client certificate storage.

User Name

The user name to use for the connection to the MQTT broker.

Password

The password to use for the connection to the MQTT broker.

Enable Offline Buffering

Enables the use of an offline message buffer for unconfirmed messages.

Buffer Size

Maximum number of messages that can be stored in the buffer.

Delete Oldest Messages

Whether older messages must be deleted when the number of messages in the buffer reaches its maximum. If this value is false, extra messages are ignored.

Event Name

message

Records:

1