MQTT Upload
MQTT is a publish/subscribe network protocol. The MQTT plugin subscribes to and publishes topic messages through the protocol.
After loading configuration, the plugin connects to the configured MQTT server and receives upstream data. On receiving data, it checks selected data, upload interval, and aggregation settings. When all are configured, it aggregates data and uploads to uploadTopic. Without aggregation, buffered items and current data are uploaded to uploadTopic individually in sequence.
Note:
- An upstream acquisition plugin is required, or acquisition configuration contains no data.
- Once selected, a scheme’s state and contents cannot be changed in its acquisition node.
1. Create nodes
Section titled “1. Create nodes”(1) Open CommBridge Digital Twin and switch to Device Connectivity.
(2) Drag Serial Communication, Data Processing, and MQTT Upload into the workspace to create three nodes.
(3) Connect Serial Communication → Data Processing → MQTT Upload.
2. Create a scheme
Section titled “2. Create a scheme”(1) Double-click MQTT Upload and select Add scheme.
(2) Enter connection settings and select Next.
(3) Select Add group, enter group information, and confirm.
(4) Select data to upload and confirm.
(5) Select Finish to add the upload scheme.
(6) Enable the scheme and select Save.
3. View results
Section titled “3. View results”(1) Select Deploy under Device Connectivity and wait for success.
(2) Switch to Digital Twin and hover over MQTT Upload to show node information.
(3) Open MQTTX and start a connection.
4. Configuration reference
Section titled “4. Configuration reference”Connection settings
Section titled “Connection settings”| Parameter | Description | Format | Example |
|---|---|---|---|
| Scheme name | User-defined scheme name | Nonempty | MQTT upload |
| Type | MQTT service protocol | mqtt:// or mqtts:// | mqtt:// |
| Host | MQTT server address, running an MQTT broker | Nonempty | 172.21.78.153 |
| Port | MQTT server port | 0-65535 | 1883 |
| Qos | MQTT quality of service | 0, 1, or 2 | 0 |
| Client ID | MQTT client identifier | Unrestricted | |
| Username | MQTT connection username | Unrestricted | |
| Password | MQTT authentication password | Unrestricted |
Add groups
Section titled “Add groups”| Parameter | Description | Format | Example |
|---|---|---|---|
| Group name | User-defined group name | Nonempty | MQTT group 1 |
| Upload (publish) Topic | MQTT subscription topic | Nonempty | 1 |
| Upload interval (ms) | Server upload interval | 0-4294967295 | 1000 |
| Aggregate upload | Whether to upload data together | Yes or No | No |
If the upload interval is 0, the acquisition interval of the upload scheme determines it.
Select data
Section titled “Select data”Select schemes configured in upstream acquisition data. Only selected schemes can upload to the MQTT server.