add pubsub.publish docs and cleanout nats/mqtt specific

This commit is contained in:
Joel Wetzell
2026-05-19 22:13:05 -05:00
parent e76a6f1d06
commit d49fa50eb7
4 changed files with 27 additions and 73 deletions
+5 -26
View File
@@ -241,32 +241,6 @@ export default defineConfig({
collapsed: true, collapsed: true,
items: [{ autogenerate: { directory: "processors/module" } }], items: [{ autogenerate: { directory: "processors/module" } }],
}, },
{
label: "MQTT",
collapsed: true,
items: [
{
label: "Message",
collapsed: true,
items: [
{ autogenerate: { directory: "processors/mqtt/message" } },
],
},
],
},
{
label: "NATS",
collapsed: true,
items: [
{
label: "Message",
collapsed: true,
items: [
{ autogenerate: { directory: "processors/nats/message" } },
],
},
],
},
{ {
label: "OSC", label: "OSC",
collapsed: true, collapsed: true,
@@ -280,6 +254,11 @@ export default defineConfig({
}, },
], ],
}, },
{
label: "Pub/Sub",
collapsed: true,
items: [{ autogenerate: { directory: "processors/pubsub" } }],
},
{ {
label: "Script", label: "Script",
collapsed: true, collapsed: true,
@@ -1,25 +0,0 @@
---
title: Create MQTT Message
sidebar:
order: 1
---
This processor will create an MQTT message from the provided parameters. This processor will return an error if any of the required parameters are missing or if the parameters are of the wrong type.
- **type**: `mqtt.message.create`
- **params**:
- **topic**: the topic to publish the message to.
- **qos**: the QoS level of the message.
- **retained**: whether the message should be retained by the broker.
- **payload**: the payload of the message. This can be a string or a byte array.
### Example
```yaml
- type: mqtt.message.create
params:
topic: "test/topic"
qos: 1
retained: false
payload: "Hello, World!"
```
@@ -1,22 +0,0 @@
---
title: Create NATS Message
sidebar:
label: Create
order: 1
---
This processor will create a NATS message from the provided parameters. This processor will return an error if any of the required parameters are missing or if the parameters are of the wrong type.
- **type**: `nats.message.create`
- **params**:
- **subject**: the subject to publish the message to.
- **payload**: the payload of the message.
### Example
```yaml
- type: nats.message.create
params:
subject: "events"
payload: "Hello, World!"
```
@@ -0,0 +1,22 @@
---
title: Publish to Pub/Sub
sidebar:
label: Publish
order: 1
---
This processor will publish the incoming payload to a Pub/Sub capable module. This processor will return an error if any of the required parameters are missing or if the parameters are of the wrong type.
- **type**: `pubsub.publish`
- **params**:
- **module**: the module to publish with.
- **topic**: the subject to publish to.
### Example
```yaml
- type: pubsub.publish
params:
module: mqtt-out
topic: "test"
```