Configuration - MQTT Binding Settings
The CSE supports MQTT communication via the MQTT binding. The MQTT binding is disabled by default and must be enabled in the configuration file under [client.mqtt].enable .
General Settings
Section: [mqtt]
These are the general MQTT client settings.
| Setting | Description | Default | Configuration Name |
|---|---|---|---|
| enable | Enable the MQTT binding. | False | mqtt.enable |
| address | The hostname of the MQTT broker. | 127.0.0.1 | mqtt.address |
| port | Set the port for the MQTT broker. | 1883, or 8883 for TLS | mqtt.port |
| listenIF | Interface to listen to. Use 0.0.0.0 for "all" interfaces. | 0.0.0.0 | mqtt.listenIF |
| keepalive | Value for the MQTT connection's keep-alive parameter in seconds. | 60 seconds | mqtt.keepalive |
| topicPrefix | Optional prefix for topics. | empty string | mqtt.topicPrefix |
| timeout | Timeout when sending MQTT requests and waiting for responses. | 10.0 seconds | mqtt.timeout |
Security
Section: [mqtt.security]
These are the security settings for the MQTT binding.
| Setting | Description | Default | Configuration Name |
|---|---|---|---|
| username | The username for MQTT broker authentication if required by the broker. | empty string | mqtt.security.username |
| password | The password for MQTT broker authentication. | empty string | mqtt.security.password |
| useTLS | Enable TLS for communications with the MQTT broker. | False | mqtt.security.useTLS |
| verifyCertificate | Verify certificates in requests. Set to False when using self-signed certificates. | False | mqtt.security.verifyCertificate |
| caCertificateFile | Path and filename of the certificate file. | empty string | mqtt.security.caCertificateFile |
| allowedCredentialIDs | List of credential-IDs that can be used to register an AE via MQTT. If this list is empty then all credential IDs are allowed. This is a comma-separated list. Wildcards (* and ?) are supported. |
empty list | mqtt.security.allowedCredentialIDs |