MQTT - Instance & item setup
How to setup a MQTT instance and item in SIA
The MQTT connector allows for connecting with an MQTT broker which can be in the local network or the internet (as long as SIA is properly configured to access it).
Info
The Connector is currently only compatible with the MQTT protocol v3.1.
Parameters
When using the MQTT Connector both the instance and item have specific parameters. These parameters are required as they are needed to establish connection with the MQTT broker and to use a specific topic to read from and write to.
Instance
The instance needs the following parameters to establish a connection to the MQTT Broker:
| Parameter | Description |
|---|---|
| Address (instance default) | The IP address of the MQTT Broker. |
| Port |
The port used by the specific MQTT Broker. |
| Username |
The username used by the MQTT broker to connect to, if required. Leave empty in case no such authentication is required. Default: empty |
| Password |
The password used by the MQTT broker to connect to, if required. Leave empty in case no such authentication is required. Default: empty |
| Device Id |
The Device Id (or ClientId) to use when connecting to a Broker and be identified as such. Leave empty to auto-generate one. Default: empty |
| Ssl Version Certificate Key Server Certificate |
Depending on the MQTT Broker's certificate configuration, related certificates and keys can be selected. Please upload such certificates and keys on the Connector Setup View, to make them available to all the MQTT instances. If none of them are selected, then no such security will be used. Default: none |
Upload certifications
Upload public/private certificates and keys by adding them as files to the MQTT Connector.
Device & Client ID
The Device Id reflects the MQTT Client ID. Every Instance needs a unique Client ID, otherwise the Broker will refuse the connection.
The auto-generated Client ID has the following _ separated format:
SIA_aaaaaa_bbbb-bbbb-bbb-bbb
where the first part is SIA, the second is aaaaaa which is a 6 characters randomly generated string and the last part bbbb-bbbb-bbb-bbb is the specific SIA unit UUID.
Item
The item parameter that is needed to read from/write to the different topics:
| Parameter | Description |
|---|---|
| Read write (instance default) |
Select the type of topic to use. Depending on the design, it is suggested to use only Read or only Write per topic, keeping the different topics independent for subscribing and publishing. |
| Topic |
The name of the topic that will be used for reading from (subscribing) or writing to (publishing). |