mirror of
https://github.com/jwetzell/showbridge-docs.git
synced 2026-07-28 09:58:39 +00:00
Compare commits
3 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 79892d1372 | |||
| d49fa50eb7 | |||
| e76a6f1d06 |
+4
-25
@@ -237,30 +237,9 @@ export default defineConfig({
|
||||
],
|
||||
},
|
||||
{
|
||||
label: "MQTT",
|
||||
label: "Module",
|
||||
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" } },
|
||||
],
|
||||
},
|
||||
],
|
||||
items: [{ autogenerate: { directory: "processors/module" } }],
|
||||
},
|
||||
{
|
||||
label: "OSC",
|
||||
@@ -276,9 +255,9 @@ export default defineConfig({
|
||||
],
|
||||
},
|
||||
{
|
||||
label: "Router",
|
||||
label: "Pub/Sub",
|
||||
collapsed: true,
|
||||
items: [{ autogenerate: { directory: "processors/router" } }],
|
||||
items: [{ autogenerate: { directory: "processors/pubsub" } }],
|
||||
},
|
||||
{
|
||||
label: "Script",
|
||||
|
||||
@@ -29,7 +29,7 @@ routes:
|
||||
params:
|
||||
address: "/cue/{{.Payload.To}}/go"
|
||||
- type: osc.message.encode
|
||||
- type: router.output
|
||||
- type: module.output
|
||||
params:
|
||||
module: udp
|
||||
`;
|
||||
|
||||
@@ -29,7 +29,7 @@ routes:
|
||||
params:
|
||||
address: "{{.Payload.URL.Path}}" # template the address from the incoming message
|
||||
- type: osc.message.encode # turn OSC message into bytes
|
||||
- type: router.output # output to the udp module
|
||||
- type: module.output # output to the udp module
|
||||
params:
|
||||
module: udp
|
||||
`;
|
||||
|
||||
@@ -5,7 +5,7 @@ sidebar:
|
||||
order: 2
|
||||
---
|
||||
|
||||
This processor will create a new HTTP response with the specified status code and body template. The created response will be passed through to the next processor in the chain. If the response is subsequently sent to an HTTP server module using the [router.output](../router/output.md) processor, the status code and body template set by this processor will be used for the response sent to the client. This processor will return an error if there is an issue executing the body template.
|
||||
This processor will create a new HTTP response with the specified status code and body template. The created response will be passed through to the next processor in the chain. If the response is subsequently sent to an HTTP server module using the [module.output](../module/output.md) processor, the status code and body template set by this processor will be used for the response sent to the client. This processor will return an error if there is an issue executing the body template.
|
||||
|
||||
- **type**: `http.response.create`
|
||||
- **params**:
|
||||
|
||||
@@ -0,0 +1,22 @@
|
||||
---
|
||||
title: Output to module
|
||||
sidebar:
|
||||
label: Output
|
||||
order: 1
|
||||
---
|
||||
|
||||
The `module.output` processor takes any payload and outputs to the specified module.
|
||||
|
||||
- **type**: `module.output`
|
||||
- **params**:
|
||||
- **module**: the id of the [module](/concepts/modules) to output to.
|
||||
|
||||
### Example
|
||||
|
||||
Output whatever payload comes through this processor to the `osc-out` module.
|
||||
|
||||
```yaml
|
||||
- type: module.output
|
||||
params:
|
||||
module: osc-out
|
||||
```
|
||||
@@ -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"
|
||||
```
|
||||
@@ -1,22 +0,0 @@
|
||||
---
|
||||
title: Output from Router
|
||||
sidebar:
|
||||
label: Output
|
||||
order: 1
|
||||
---
|
||||
|
||||
The `router.output` processor takes any payload and outputs to the specified module.
|
||||
|
||||
- **type**: `router.output`
|
||||
- **params**:
|
||||
- **module**: the id of the [module](/concepts/modules) to output to.
|
||||
|
||||
### Example
|
||||
|
||||
Output to the `osc-out` module.
|
||||
|
||||
```yaml
|
||||
- type: router.output
|
||||
params:
|
||||
module: osc-out
|
||||
```
|
||||
@@ -5,7 +5,7 @@ sidebar:
|
||||
order: 1
|
||||
---
|
||||
|
||||
This processor will create a SIP response message with an audio file as the payload. If this message is output to a SIP module using the [router.output](/processors/router/output) processor, then the SIP module will send the response to the caller and play the audio file included in the response.
|
||||
This processor will create a SIP response message with an audio file as the payload. If this message is output to a SIP module using the [module.output](/processors/module/output) processor, then the SIP module will send the response to the caller and play the audio file included in the response.
|
||||
|
||||
- **type**: `sip.response.audio.create`
|
||||
- **params**:
|
||||
|
||||
@@ -5,7 +5,7 @@ sidebar:
|
||||
order: 1
|
||||
---
|
||||
|
||||
This processor will create a SIP DTMF response from the provided parameters. If this message is output to a SIP module using the [router.output](/processors/router/output) processor, then the SIP module will send the response to the caller and play the DTMF tones specified.
|
||||
This processor will create a SIP DTMF response from the provided parameters. If this message is output to a SIP module using the [module.output](/processors/module/output) processor, then the SIP module will send the response to the caller and play the DTMF tones specified.
|
||||
|
||||
- **type**: `sip.response.dtmf.create`
|
||||
- **params**:
|
||||
|
||||
@@ -40,7 +40,6 @@ GLOBAL OPTIONS:
|
||||
--config string path to config file (default: "./config.yaml") [$SHOWBRIDGE_CONFIG]
|
||||
--log-level string set log level (default: "info") [$SHOWBRIDGE_LOG_LEVEL]
|
||||
--log-format string log format to use (default: "text") [$SHOWBRIDGE_LOG_FORMAT]
|
||||
--trace enable OpenTelemetry tracing [$SHOWBRIDGE_TRACE]
|
||||
--help, -h show help
|
||||
--version, -v print the version
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user