MQTT broker definitions
- Wolfgang Granzer
The MQTT interface is used to send and receive data and information from MQTT broker. Within this definition file, the used MQTT brokers have to be specified.
File location
<WorkspaceDirectory>\DataFiles\xio.Mqtt.Broker.dat
Col# | Parameter | Description | Scope | Unit | Mandatory / default value |
|---|---|---|---|---|---|
1 | Name | Mandatory name identifying the MQTT broker within the NETx Server. In combination with Path, it must be unique. | string | None | mandatory |
2 | Path | The structure that is used to represent the data point. In combination with the Name, it must be unique. | string | None | empty |
3 | IP address | IP address of MQTT broker. | string | None | mandatory |
4 | Auto-Reconnect | Timeout in milliseconds between connection attempts. | 100 – 65535 | milliseconds | 1000 |
5 | Port | TCP port used for the communication with MQTT broker. | 0 – 65535 | TCP port | 1883 |
6 | Client Username | If the MQTT broker requires authentication of connecting MQTT client, the username must specified here. | string | None | empty |
7 | Client Password | If the MQTT broker requires authentication of connecting MQTT client, the password must specified here. | string | None | empty |
8 | TLS | Defines whether TLS shall be enabled for the communication with the MQTT broker. | boolean | true/false | false |
9 | TLS Version | If TLS is enabled, the used TLS version must be specified here. | None, SSLv3, TLSv1_0, TLSv1_1, TLSv1_2 | none | None |
10 | CA certificate file | Certificate file of the CA that issued the broker's TLS certificate. This certificate is used to verify the TLS server certificate. Normally, this file has the extension .crt. The file must be located in the DataFiles folder of the workspace. | string | none | empty |
11 | CA certificate password | If the CA certificate is password protected, the password must be entered here. | string | none | empty |
12 | Culture info | Defines the culture info that is used to transfer values from and to MQTT brokers. If left empty, the culture info from the driver configuration is used. | string | none | Culture from driver configuration |
13 | Client certificate file | If the broker requires a client certificate for connecting to it, the certificate file has to be defined here. It must also contain the private key. Normally, this file has the extension .pfx. The file must be located in the DataFiles folder of the workspace. | string | none | empty |
14 | Client certificate password | If the client certificate is password protected, the password must be entered here. | string | none | empty |
15 | Keep alive timeout | Timeout in seconds between sending keep alive packets to MQTT broker. | 1 – 65535 | seconds | 60 |