diff --git a/astro.config.mjs b/astro.config.mjs index 3d9d119..e21b5e2 100644 --- a/astro.config.mjs +++ b/astro.config.mjs @@ -236,6 +236,11 @@ export default defineConfig({ }, ], }, + { + label: "Module", + collapsed: true, + items: [{ autogenerate: { directory: "processors/module" } }], + }, { label: "MQTT", collapsed: true, @@ -275,11 +280,6 @@ export default defineConfig({ }, ], }, - { - label: "Router", - collapsed: true, - items: [{ autogenerate: { directory: "processors/router" } }], - }, { label: "Script", collapsed: true, diff --git a/src/content/docs/examples/dial-a-cue.mdx b/src/content/docs/examples/dial-a-cue.mdx index 9c05217..7870e5b 100644 --- a/src/content/docs/examples/dial-a-cue.mdx +++ b/src/content/docs/examples/dial-a-cue.mdx @@ -29,7 +29,7 @@ routes: params: address: "/cue/{{.Payload.To}}/go" - type: osc.message.encode - - type: router.output + - type: module.output params: module: udp `; diff --git a/src/content/docs/examples/http-to-osc.mdx b/src/content/docs/examples/http-to-osc.mdx index 018c441..1a6b173 100644 --- a/src/content/docs/examples/http-to-osc.mdx +++ b/src/content/docs/examples/http-to-osc.mdx @@ -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 `; diff --git a/src/content/docs/processors/http/response/create.mdx b/src/content/docs/processors/http/response/create.mdx index 82cef23..02d4f07 100644 --- a/src/content/docs/processors/http/response/create.mdx +++ b/src/content/docs/processors/http/response/create.mdx @@ -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**: diff --git a/src/content/docs/processors/module/output.mdx b/src/content/docs/processors/module/output.mdx new file mode 100644 index 0000000..e100074 --- /dev/null +++ b/src/content/docs/processors/module/output.mdx @@ -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 +``` diff --git a/src/content/docs/processors/router/output.mdx b/src/content/docs/processors/router/output.mdx deleted file mode 100644 index b5a2fb6..0000000 --- a/src/content/docs/processors/router/output.mdx +++ /dev/null @@ -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 -``` diff --git a/src/content/docs/processors/sip/response/audio/create.mdx b/src/content/docs/processors/sip/response/audio/create.mdx index 22f7a7f..0d5f7fc 100644 --- a/src/content/docs/processors/sip/response/audio/create.mdx +++ b/src/content/docs/processors/sip/response/audio/create.mdx @@ -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**: diff --git a/src/content/docs/processors/sip/response/dtmf/create.mdx b/src/content/docs/processors/sip/response/dtmf/create.mdx index e788fc4..a6424d1 100644 --- a/src/content/docs/processors/sip/response/dtmf/create.mdx +++ b/src/content/docs/processors/sip/response/dtmf/create.mdx @@ -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**: