add MQTT client docs

This commit is contained in:
Joel Wetzell
2025-12-20 10:54:05 -06:00
parent 25f6c83c3e
commit 3faeb6c9bf
2 changed files with 29 additions and 0 deletions
+5
View File
@@ -55,6 +55,11 @@ export default defineConfig({
collapsed: true,
autogenerate: { directory: 'modules/serial' }
},
{
label: "MQTT",
collapsed: true,
autogenerate: { directory: 'modules/mqtt' }
},
]
},
{
+24
View File
@@ -0,0 +1,24 @@
---
title: MQTT Client
sidebar:
order: 1
---
The `mqtt.client` module connects to a MQTT broker and emits a message messages based on the subscribed topic it receives from the port. This module is also capable of publishing MQTT messages to the connected broker.
- **type**: `mqtt.client`
- **params**:
- **broker**: connection string for the mqtt broker (`mqtt://test.mosquitto.org:1833`)
- **topic** mqtt topic to subscribe to
- **clientId** client ID for this connection to the broker
### Example
Open a mqtt connection to `test.mosquitto.org` subscribing to the `showbridge` topic.
```
- id: mqttClient
type: mqtt.client
params:
broker: "mqtt://test.mosquitto.org:1833"
topic: showbridge
clientId: showbridge
```