diff --git a/astro.config.mjs b/astro.config.mjs index d8cfa83..1a0a09c 100644 --- a/astro.config.mjs +++ b/astro.config.mjs @@ -1,104 +1,210 @@ -import starlight from '@astrojs/starlight'; -import { defineConfig } from 'astro/config'; +import starlight from "@astrojs/starlight"; +import { defineConfig } from "astro/config"; // https://astro.build/config export default defineConfig({ integrations: [ starlight({ - title: 'showbridge', - favicon: '/favicon.ico', + title: "showbridge", + favicon: "/favicon.ico", social: [ { - icon: 'github', - label: 'GitHub', - href: 'https://github.com/jwetzell/showbridge-go', + icon: "github", + label: "GitHub", + href: "https://github.com/jwetzell/showbridge-go", }, ], sidebar: [ { - label: 'showbridge', - autogenerate: { directory: '/showbridge' }, + label: "showbridge", + autogenerate: { directory: "/showbridge" }, }, { - label: 'Run', - autogenerate: { directory: 'run' }, + label: "Run", + autogenerate: { directory: "run" }, }, { - label: 'Concepts', - autogenerate: { directory: 'concepts' }, + label: "Concepts", + autogenerate: { directory: "concepts" }, }, { - label: 'Modules', + label: "Modules", items: [ - { - label: "Time", - collapsed: true, - autogenerate: { directory: 'modules/time' } - }, { label: "Database", collapsed: true, - autogenerate: { directory: 'modules/db' } - }, - { - label: "Network", - collapsed: true, - autogenerate: { directory: 'modules/network' } + autogenerate: { directory: "modules/db" }, }, { label: "HTTP", collapsed: true, - autogenerate: { directory: 'modules/http' } + autogenerate: { directory: "modules/http" }, }, { label: "MIDI", collapsed: true, - autogenerate: { directory: 'modules/midi' } - }, - { - label: "Serial", - collapsed: true, - autogenerate: { directory: 'modules/serial' } + autogenerate: { directory: "modules/midi" }, }, { label: "MQTT", collapsed: true, - autogenerate: { directory: 'modules/mqtt' } + autogenerate: { directory: "modules/mqtt" }, + }, + { + label: "NATS", + collapsed: true, + autogenerate: { directory: "modules/nats" }, + }, + { + label: "Network", + collapsed: true, + items: [ + { + label: "TCP", + collapsed: true, + autogenerate: { directory: "modules/net/tcp" }, + }, + { + label: "UDP", + collapsed: true, + autogenerate: { directory: "modules/net/udp" }, + }, + ], + }, + { + label: "PosiStageNet", + collapsed: true, + autogenerate: { directory: "modules/psn" }, }, { label: "Redis", collapsed: true, - autogenerate: { directory: 'modules/redis' } + autogenerate: { directory: "modules/redis" }, }, - ] + { + label: "Time", + collapsed: true, + autogenerate: { directory: "modules/time" }, + }, + { + label: "Serial", + collapsed: true, + autogenerate: { directory: "modules/serial" }, + }, + { + label: "SIP", + collapsed: true, + items: [ + { + label: "Call", + collapsed: true, + autogenerate: { directory: "modules/sip/call" }, + }, + { + label: "DTMF", + collapsed: true, + autogenerate: { directory: "modules/sip/dtmf" }, + }, + ], + }, + ], }, { - label: 'Processors', + label: "Processors", items: [ { - label: "Router", + label: "ArtNet", collapsed: true, - autogenerate: { directory: 'processors/router' } + autogenerate: { directory: "processors/artnet" }, }, { label: "Database", collapsed: true, - autogenerate: { directory: 'processors/db' } + autogenerate: { directory: "processors/db" }, + }, + { + label: "Debug", + collapsed: true, + autogenerate: { directory: "processors/debug" }, }, { label: "Filter", collapsed: true, - autogenerate: { directory: 'processors/filter' } - }, - { - label: "Int", - collapsed: true, - autogenerate: { directory: 'processors/int' } + autogenerate: { directory: "processors/filter" }, }, { label: "Float", collapsed: true, - autogenerate: { directory: 'processors/float' } + autogenerate: { directory: "processors/float" }, + }, + { + label: "FreeD", + collapsed: true, + autogenerate: { directory: "processors/free-d" }, + }, + { + label: "HTTP", + collapsed: true, + items: [ + { + label: "Request", + collapsed: true, + autogenerate: { directory: "processors/http/request" }, + }, + { + label: "Response", + collapsed: true, + autogenerate: { directory: "processors/http/response" }, + }, + ], + }, + { + label: "Int", + collapsed: true, + autogenerate: { directory: "processors/int" }, + }, + { + label: "JSON", + collapsed: true, + autogenerate: { directory: "processors/json" }, + }, + { + label: "Key/Value", + collapsed: true, + autogenerate: { directory: "processors/kv" }, + }, + { + label: "MIDI", + collapsed: true, + items: [ + { + label: "Message", + collapsed: true, + autogenerate: { directory: "processors/midi/message" }, + }, + ], + }, + { + label: "MQTT", + collapsed: true, + items: [ + { + label: "Message", + collapsed: true, + autogenerate: { directory: "processors/mqtt/message" }, + }, + ], + }, + { + label: "NATS", + collapsed: true, + items: [ + { + label: "Message", + collapsed: true, + autogenerate: { directory: "processors/nats/message" }, + }, + ], }, { label: "OSC", @@ -107,35 +213,61 @@ export default defineConfig({ { label: "Message", collapsed: true, - autogenerate: { directory: 'processors/osc/message' } - } - ] + autogenerate: { directory: "processors/osc/message" }, + }, + ], }, { - label: "String", + label: "Router", collapsed: true, - autogenerate: { directory: 'processors/string' } + autogenerate: { directory: "processors/router" }, }, { label: "Script", collapsed: true, - autogenerate: { directory: 'processors/script' } + autogenerate: { directory: "processors/script" }, + }, + { + label: "SIP", + collapsed: true, + items: [ + { + label: "Response", + collapsed: true, + items: [ + { + label: "Audio", + collapsed: true, + autogenerate: { + directory: "processors/sip/response/audio", + }, + }, + { + label: "DTMF", + collapsed: true, + autogenerate: { + directory: "processors/sip/response/dtmf", + }, + }, + ], + }, + ], + }, + { + label: "String", + collapsed: true, + autogenerate: { directory: "processors/string" }, }, { label: "Time", collapsed: true, - autogenerate: { directory: 'processors/time' } + autogenerate: { directory: "processors/time" }, }, - { - label: "Key/Value", - collapsed: true, - autogenerate: { directory: 'processors/kv' } - } - ] + ], }, { - label: 'Examples', - autogenerate: { directory: 'examples' }, + label: "Examples", + autogenerate: { directory: "examples" }, }, ], }), diff --git a/src/content/docs/modules/http/http-server.md b/src/content/docs/modules/http/http-server.md index 63f96ba..a12d8ad 100644 --- a/src/content/docs/modules/http/http-server.md +++ b/src/content/docs/modules/http/http-server.md @@ -1,6 +1,7 @@ --- title: HTTP Server sidebar: + label: Server order: 2 --- The `http.server` module emits a message for every HTTP request that is made to the server. diff --git a/src/content/docs/modules/midi/input.mdx b/src/content/docs/modules/midi/input.mdx index 8c47d8a..d53a537 100644 --- a/src/content/docs/modules/midi/input.mdx +++ b/src/content/docs/modules/midi/input.mdx @@ -1,6 +1,7 @@ --- title: MIDI Input sidebar: + label: Input order: 1 --- diff --git a/src/content/docs/modules/midi/output.mdx b/src/content/docs/modules/midi/output.mdx index 018b431..3f6e73c 100644 --- a/src/content/docs/modules/midi/output.mdx +++ b/src/content/docs/modules/midi/output.mdx @@ -1,6 +1,7 @@ --- title: MIDI Output sidebar: + label: Output order: 2 --- import { Aside } from '@astrojs/starlight/components'; diff --git a/src/content/docs/modules/mqtt/client.mdx b/src/content/docs/modules/mqtt/client.mdx index af740a8..2c1a8f2 100644 --- a/src/content/docs/modules/mqtt/client.mdx +++ b/src/content/docs/modules/mqtt/client.mdx @@ -1,6 +1,7 @@ --- title: MQTT Client sidebar: + label: Client order: 1 --- diff --git a/src/content/docs/modules/nats/client.md b/src/content/docs/modules/nats/client.md new file mode 100644 index 0000000..173c544 --- /dev/null +++ b/src/content/docs/modules/nats/client.md @@ -0,0 +1,11 @@ +--- +title: NATS Client +sidebar: + label: Client + order: 1 +--- + +- **type**: `nats.client` +- **params**: + - **url** + - **subject** \ No newline at end of file diff --git a/src/content/docs/modules/nats/server.md b/src/content/docs/modules/nats/server.md new file mode 100644 index 0000000..604bb00 --- /dev/null +++ b/src/content/docs/modules/nats/server.md @@ -0,0 +1,11 @@ +--- +title: NATS Server +sidebar: + label: Server + order: 2 +--- + +- **type**: `nats.server` +- **params**: + - **ip** + - **port** \ No newline at end of file diff --git a/src/content/docs/modules/network/tcp-client.md b/src/content/docs/modules/net/tcp/client.md similarity index 98% rename from src/content/docs/modules/network/tcp-client.md rename to src/content/docs/modules/net/tcp/client.md index 08a0fb6..85e327e 100644 --- a/src/content/docs/modules/network/tcp-client.md +++ b/src/content/docs/modules/net/tcp/client.md @@ -1,6 +1,7 @@ --- title: TCP Client sidebar: + label: Client order: 1 --- The `net.tcp.client` module connects to TCP server and emits messages based on the data it receives from the server that it connects to. Messages are determined by "framing" techniques as TCP is a stream based protocol. The module will attempt to reconnect anytime the connection is closed. diff --git a/src/content/docs/modules/network/tcp-server.md b/src/content/docs/modules/net/tcp/server.md similarity index 98% rename from src/content/docs/modules/network/tcp-server.md rename to src/content/docs/modules/net/tcp/server.md index 9250120..b8bcdf8 100644 --- a/src/content/docs/modules/network/tcp-server.md +++ b/src/content/docs/modules/net/tcp/server.md @@ -1,6 +1,7 @@ --- title: TCP Server sidebar: + label: Server order: 2 --- The `net.tcp.server` module emits a message messages based on the data it receives from clients that connect to it. Messages are determined by "framing" techniques as TCP is a stream based protocol. diff --git a/src/content/docs/modules/network/udp-client.md b/src/content/docs/modules/net/udp/client.md similarity index 94% rename from src/content/docs/modules/network/udp-client.md rename to src/content/docs/modules/net/udp/client.md index 7674e89..50addab 100644 --- a/src/content/docs/modules/network/udp-client.md +++ b/src/content/docs/modules/net/udp/client.md @@ -1,7 +1,8 @@ --- title: UDP Client sidebar: - order: 3 + label: Client + order: 1 --- The `net.udp.client` module sends messages to a the configured `host` and `port`. This module does not produce any messages and so using it as an `input` to a [route](/concepts/routes) would be pointless. diff --git a/src/content/docs/modules/net/udp/multicast.md b/src/content/docs/modules/net/udp/multicast.md new file mode 100644 index 0000000..cfe63e5 --- /dev/null +++ b/src/content/docs/modules/net/udp/multicast.md @@ -0,0 +1,12 @@ +--- +title: UDP Multicast +sidebar: + label: Multicast + order: 3 +--- + +- **type**: `net.udp.multicast` +- **params**: + - **ip** + - **port** + - **bufferSize** \ No newline at end of file diff --git a/src/content/docs/modules/network/udp-server.md b/src/content/docs/modules/net/udp/server.md similarity index 94% rename from src/content/docs/modules/network/udp-server.md rename to src/content/docs/modules/net/udp/server.md index 1c8c22a..a059d88 100644 --- a/src/content/docs/modules/network/udp-server.md +++ b/src/content/docs/modules/net/udp/server.md @@ -1,7 +1,8 @@ --- title: UDP Server sidebar: - order: 4 + label: Server + order: 2 --- The `net.udp.server` module emits a message for every incoming UDP datagram. diff --git a/src/content/docs/modules/psn/client.md b/src/content/docs/modules/psn/client.md new file mode 100644 index 0000000..bc6dc16 --- /dev/null +++ b/src/content/docs/modules/psn/client.md @@ -0,0 +1,8 @@ +--- +title: PSN Client +sidebar: + label: Client + order: 1 +--- + +- **type**: `psn.client` \ No newline at end of file diff --git a/src/content/docs/modules/redis/client.mdx b/src/content/docs/modules/redis/client.mdx index beaf23d..b110eb5 100644 --- a/src/content/docs/modules/redis/client.mdx +++ b/src/content/docs/modules/redis/client.mdx @@ -1,6 +1,7 @@ --- title: Redis Client sidebar: + label: Client order: 1 --- diff --git a/src/content/docs/modules/serial/client.mdx b/src/content/docs/modules/serial/client.mdx index 808f955..8a4a4bd 100644 --- a/src/content/docs/modules/serial/client.mdx +++ b/src/content/docs/modules/serial/client.mdx @@ -1,6 +1,7 @@ --- title: Serial Client sidebar: + label: Client order: 1 --- diff --git a/src/content/docs/modules/sip/call/server.md b/src/content/docs/modules/sip/call/server.md new file mode 100644 index 0000000..3f67d2a --- /dev/null +++ b/src/content/docs/modules/sip/call/server.md @@ -0,0 +1,13 @@ +--- +title: SIP Call Server +sidebar: + label: Server + order: 1 +--- + +- **type**: `sip.call.server` +- **params**: + - **ip** + - **port** + - **transport** + - **userAgent** \ No newline at end of file diff --git a/src/content/docs/modules/sip/dtmf/server.md b/src/content/docs/modules/sip/dtmf/server.md new file mode 100644 index 0000000..cfcc48e --- /dev/null +++ b/src/content/docs/modules/sip/dtmf/server.md @@ -0,0 +1,14 @@ +--- +title: SIP DTMF Server +sidebar: + label: Server + order: 1 +--- + +- **type**: `sip.dtmf.server` +- **params**: + - **ip** + - **port** + - **transport** + - **userAgent** + - **separator** \ No newline at end of file diff --git a/src/content/docs/processors/artnet/decode.md b/src/content/docs/processors/artnet/decode.md new file mode 100644 index 0000000..c514098 --- /dev/null +++ b/src/content/docs/processors/artnet/decode.md @@ -0,0 +1,8 @@ +--- +title: Decode ArtNet Packet +sidebar: + label: Decode + order: 1 +--- + +- **type**: `artnet.packet.decode` \ No newline at end of file diff --git a/src/content/docs/processors/artnet/encode.md b/src/content/docs/processors/artnet/encode.md new file mode 100644 index 0000000..3f0d0b0 --- /dev/null +++ b/src/content/docs/processors/artnet/encode.md @@ -0,0 +1,8 @@ +--- +title: Encode ArtNet Packet +sidebar: + label: Encode + order: 2 +--- + +- **type**: `artnet.packet.encode` \ No newline at end of file diff --git a/src/content/docs/processors/db/query.md b/src/content/docs/processors/db/query.md index 9294d28..0e9e08c 100644 --- a/src/content/docs/processors/db/query.md +++ b/src/content/docs/processors/db/query.md @@ -1,6 +1,7 @@ --- -title: Query +title: Database Query sidebar: + label: Query order: 1 --- The `db.query` processor will issue a query to the specified module and return the result to the next processor in line. diff --git a/src/content/docs/processors/debug/log.md b/src/content/docs/processors/debug/log.md new file mode 100644 index 0000000..14b5d60 --- /dev/null +++ b/src/content/docs/processors/debug/log.md @@ -0,0 +1,8 @@ +--- +title: Debug Log +sidebar: + label: Log + order: 1 +--- + +- **type**: `debug.log` \ No newline at end of file diff --git a/src/content/docs/processors/filter/change.md b/src/content/docs/processors/filter/change.md new file mode 100644 index 0000000..f603230 --- /dev/null +++ b/src/content/docs/processors/filter/change.md @@ -0,0 +1,8 @@ +--- +title: Filter On Change +sidebar: + label: On Change + order: 3 +--- + +- **type**: `filter.change` \ No newline at end of file diff --git a/src/content/docs/processors/filter/expr.md b/src/content/docs/processors/filter/expr.md index 62b0bb0..727a64e 100644 --- a/src/content/docs/processors/filter/expr.md +++ b/src/content/docs/processors/filter/expr.md @@ -1,6 +1,7 @@ --- title: Expr Filter sidebar: + label: Expr order: 2 --- The `filter.expr` processor evaluates an [Expr expression](https://expr-lang.org/playground). If the expression evaluates to true then the payload is sent through. This processor will return an error if the expression fails to evaluate. diff --git a/src/content/docs/processors/filter/regex.md b/src/content/docs/processors/filter/regex.md index 792607e..4b2ce56 100644 --- a/src/content/docs/processors/filter/regex.md +++ b/src/content/docs/processors/filter/regex.md @@ -1,6 +1,7 @@ --- title: Regex Filter sidebar: + label: Regex order: 1 --- The `filter.regex` processor matches incoming string payload against a regular expression. If there is a match then the payload is sent through. This processor will return an error if the message being processed is not a string. diff --git a/src/content/docs/processors/float/parse.md b/src/content/docs/processors/float/parse.md index 33f6ca1..cf3f553 100644 --- a/src/content/docs/processors/float/parse.md +++ b/src/content/docs/processors/float/parse.md @@ -1,6 +1,7 @@ --- -title: Float Parse +title: Parse Float sidebar: + label: Parse order: 1 --- The `float.parse` processor takes a string and parses it as a float with the specified `base` and `bitSize`. This processor will return an error if the message being processed is not a string or if the string cannot be parsed into a float. diff --git a/src/content/docs/processors/float/random.md b/src/content/docs/processors/float/random.md index 18c24af..1e60758 100644 --- a/src/content/docs/processors/float/random.md +++ b/src/content/docs/processors/float/random.md @@ -1,6 +1,7 @@ --- -title: Float Random +title: Create Random Float sidebar: + label: Random order: 2 --- The `float.random` processor will set the payload to a random float between the specified `min` and `max` value. diff --git a/src/content/docs/processors/free-d/create.md b/src/content/docs/processors/free-d/create.md new file mode 100644 index 0000000..6fc3818 --- /dev/null +++ b/src/content/docs/processors/free-d/create.md @@ -0,0 +1,18 @@ +--- +title: Create FreeD +sidebar: + label: Create + order: 1 +--- + +- **type**: `free.d.create` +- **params**: + - **id** + - **pan** + - **tilt** + - **roll** + - **posX** + - **posY** + - **posZ** + - **zoom** + - **focus** \ No newline at end of file diff --git a/src/content/docs/processors/free-d/decode.md b/src/content/docs/processors/free-d/decode.md new file mode 100644 index 0000000..3d5ea90 --- /dev/null +++ b/src/content/docs/processors/free-d/decode.md @@ -0,0 +1,8 @@ +--- +title: Decode FreeD +sidebar: + label: Decode + order: 3 +--- + +- **type**: `free.d.decode` \ No newline at end of file diff --git a/src/content/docs/processors/free-d/encode.md b/src/content/docs/processors/free-d/encode.md new file mode 100644 index 0000000..e3b24fe --- /dev/null +++ b/src/content/docs/processors/free-d/encode.md @@ -0,0 +1,8 @@ +--- +title: Encode FreeD +sidebar: + label: Encode + order: 2 +--- + +- **type**: `free.d.encode` \ No newline at end of file diff --git a/src/content/docs/processors/http/request/do.md b/src/content/docs/processors/http/request/do.md new file mode 100644 index 0000000..dd38a98 --- /dev/null +++ b/src/content/docs/processors/http/request/do.md @@ -0,0 +1,11 @@ +--- +title: Make HTTP Request +sidebar: + label: Make Request + order: 1 +--- + +- **type**: `http.request.do` +- **params**: + - **method** + - **url** \ No newline at end of file diff --git a/src/content/docs/processors/http/response/create.md b/src/content/docs/processors/http/response/create.md new file mode 100644 index 0000000..e60547e --- /dev/null +++ b/src/content/docs/processors/http/response/create.md @@ -0,0 +1,11 @@ +--- +title: Create HTTP Response +sidebar: + label: Create + order: 2 +--- + +- **type**: `http.response.create` +- **params**: + - **status** + - **body** \ No newline at end of file diff --git a/src/content/docs/processors/int/parse.md b/src/content/docs/processors/int/parse.md index 4eeb3fb..171a59a 100644 --- a/src/content/docs/processors/int/parse.md +++ b/src/content/docs/processors/int/parse.md @@ -1,6 +1,7 @@ --- -title: Int Parse +title: Parse Int sidebar: + label: Parse order: 1 --- The `int.parse` processor takes a string and parses it as an integer with the specified `base` and `bitSize`. This processor will return an error if the message being processed is not a string or if the string cannot be parsed into an integer. diff --git a/src/content/docs/processors/int/random.md b/src/content/docs/processors/int/random.md index 7eebfd7..e817ae8 100644 --- a/src/content/docs/processors/int/random.md +++ b/src/content/docs/processors/int/random.md @@ -1,5 +1,5 @@ --- -title: Int Random +title: Create Random Int sidebar: order: 2 --- diff --git a/src/content/docs/processors/int/scale.md b/src/content/docs/processors/int/scale.md new file mode 100644 index 0000000..0c016a4 --- /dev/null +++ b/src/content/docs/processors/int/scale.md @@ -0,0 +1,13 @@ +--- +title: Scale Int +sidebar: + label: Scale + order: 3 +--- + +- **type**: `int.scale` +- **params**: + - **inMin** + - **inMax** + - **outMin** + - **outMax** \ No newline at end of file diff --git a/src/content/docs/processors/json/decode.md b/src/content/docs/processors/json/decode.md new file mode 100644 index 0000000..caf1d21 --- /dev/null +++ b/src/content/docs/processors/json/decode.md @@ -0,0 +1,8 @@ +--- +title: Decode JSON +sidebar: + label: Decode + order: 2 +--- + +- **type**: `json.decode` \ No newline at end of file diff --git a/src/content/docs/processors/json/encode.md b/src/content/docs/processors/json/encode.md new file mode 100644 index 0000000..f3f9363 --- /dev/null +++ b/src/content/docs/processors/json/encode.md @@ -0,0 +1,8 @@ +--- +title: Encode JSON +sidebar: + label: Encode + order: 1 +--- + +- **type**: `json.decode` diff --git a/src/content/docs/processors/kv/get.md b/src/content/docs/processors/kv/get.md index 5a1ad8d..52882ea 100644 --- a/src/content/docs/processors/kv/get.md +++ b/src/content/docs/processors/kv/get.md @@ -1,6 +1,7 @@ --- -title: Get +title: Get Key/Value sidebar: + label: Get order: 1 --- The `kv.get` processor gets the value associated with a key from a compatible module. The output payload is the value if the key is found. diff --git a/src/content/docs/processors/kv/set.md b/src/content/docs/processors/kv/set.md index 3d4d8bd..03c8d54 100644 --- a/src/content/docs/processors/kv/set.md +++ b/src/content/docs/processors/kv/set.md @@ -1,6 +1,7 @@ --- -title: Set +title: Set Key/Value sidebar: + label: Set order: 2 --- The `kv.set` processor sets the value associated with a key from a compatible module. The payload is unchanged so whatever is received by this payload is output unless any errors are encountered. diff --git a/src/content/docs/processors/midi/message/create.md b/src/content/docs/processors/midi/message/create.md new file mode 100644 index 0000000..0b69673 --- /dev/null +++ b/src/content/docs/processors/midi/message/create.md @@ -0,0 +1,16 @@ +--- +title: Create MIDI Message +sidebar: + label: Create + order: 1 +--- + +- **type**: `midi.message.create` +- **params**: + - **type** + - **channel** + - **note** + - **velocity** + - **program** + - **control** + - **value** \ No newline at end of file diff --git a/src/content/docs/processors/midi/message/decode.md b/src/content/docs/processors/midi/message/decode.md new file mode 100644 index 0000000..76bd734 --- /dev/null +++ b/src/content/docs/processors/midi/message/decode.md @@ -0,0 +1,8 @@ +--- +title: Decode MIDI Message +sidebar: + label: Decode + order: 3 +--- + +- **type**: `midi.message.decode` \ No newline at end of file diff --git a/src/content/docs/processors/midi/message/encode.md b/src/content/docs/processors/midi/message/encode.md new file mode 100644 index 0000000..3bf2daa --- /dev/null +++ b/src/content/docs/processors/midi/message/encode.md @@ -0,0 +1,8 @@ +--- +title: Encode MIDI Message +sidebar: + label: Encode + order: 2 +--- + +- **type**: `midi.message.encode` diff --git a/src/content/docs/processors/midi/message/unpack.md b/src/content/docs/processors/midi/message/unpack.md new file mode 100644 index 0000000..1ac6cac --- /dev/null +++ b/src/content/docs/processors/midi/message/unpack.md @@ -0,0 +1,8 @@ +--- +title: Unpack MIDI Message +sidebar: + label: Unpack + order: 4 +--- + +- **type**: `midi.message.unpack` diff --git a/src/content/docs/processors/mqtt/message/create.md b/src/content/docs/processors/mqtt/message/create.md new file mode 100644 index 0000000..443d406 --- /dev/null +++ b/src/content/docs/processors/mqtt/message/create.md @@ -0,0 +1,12 @@ +--- +title: Create MQTT Message +sidebar: + order: 1 +--- + +- **type**: `mqtt.message.create` +- **params**: + - **topic** + - **qos** + - **retained** + - **payload** \ No newline at end of file diff --git a/src/content/docs/processors/nats/message/create.md b/src/content/docs/processors/nats/message/create.md new file mode 100644 index 0000000..e895abf --- /dev/null +++ b/src/content/docs/processors/nats/message/create.md @@ -0,0 +1,11 @@ +--- +title: Create NATS Message +sidebar: + label: Create + order: 1 +--- + +- **type**: `nats.message.create` +- **params**: + - **subject** + - **payload** \ No newline at end of file diff --git a/src/content/docs/processors/osc/message/create.md b/src/content/docs/processors/osc/message/create.md new file mode 100644 index 0000000..a1dbbd6 --- /dev/null +++ b/src/content/docs/processors/osc/message/create.md @@ -0,0 +1,12 @@ +--- +title: Create OSC Message +sidebar: + label: Create + order: 1 +--- + +- **type**: `osc.message.create` +- **params**: + - **address** + - **args** + - **types** \ No newline at end of file diff --git a/src/content/docs/processors/osc/message/decode.md b/src/content/docs/processors/osc/message/decode.md index 94c753d..4f91975 100644 --- a/src/content/docs/processors/osc/message/decode.md +++ b/src/content/docs/processors/osc/message/decode.md @@ -1,7 +1,8 @@ --- -title: OSC Message Decode +title: Decode OSC Message sidebar: - order: 1 + label: Decode + order: 3 --- The `osc.message.decode` processor takes a array of bytes and turn it into OSC message if it can be. This processor will return an error if the bytes cannot be parsed as an OSC message diff --git a/src/content/docs/processors/osc/message/encode.md b/src/content/docs/processors/osc/message/encode.md index d66b0a7..9157cc8 100644 --- a/src/content/docs/processors/osc/message/encode.md +++ b/src/content/docs/processors/osc/message/encode.md @@ -1,6 +1,7 @@ --- -title: OSC Message Encode +title: Encode OSC Message sidebar: + label: Encode order: 2 --- The `osc.message.encode` processor takes an OSC message and turns it into an array of bytes. This processor will return an error if the OSC message cannot be turned into bytes. diff --git a/src/content/docs/processors/router/output.md b/src/content/docs/processors/router/output.md index 5064f71..9e0ef8b 100644 --- a/src/content/docs/processors/router/output.md +++ b/src/content/docs/processors/router/output.md @@ -1,6 +1,7 @@ --- -title: Router Output +title: Output from Router sidebar: + label: Output order: 1 --- The `router.output` processor takes any payload and outputs to the specified module. diff --git a/src/content/docs/processors/script/expr.md b/src/content/docs/processors/script/expr.md new file mode 100644 index 0000000..cf16b2c --- /dev/null +++ b/src/content/docs/processors/script/expr.md @@ -0,0 +1,10 @@ +--- +title: Execute Expr Expression +sidebar: + label: Expr + order: 2 +--- + +- **type**: `script.expr` +- **params**: + - **expression** \ No newline at end of file diff --git a/src/content/docs/processors/script/js.mdx b/src/content/docs/processors/script/js.mdx index 3640bf4..a8c8fa3 100644 --- a/src/content/docs/processors/script/js.mdx +++ b/src/content/docs/processors/script/js.mdx @@ -1,6 +1,7 @@ --- -title: JavaScript +title: Execute JavaScript sidebar: + label: JavaScript order: 1 --- diff --git a/src/content/docs/processors/script/wasm.md b/src/content/docs/processors/script/wasm.md new file mode 100644 index 0000000..79733ba --- /dev/null +++ b/src/content/docs/processors/script/wasm.md @@ -0,0 +1,12 @@ +--- +title: Run WASM (Extism) Plugin +sidebar: + label: WASM + order: 3 +--- + +- **type**: `script.wasm` +- **params**: + - **path** + - **function** + - **enableWasi** \ No newline at end of file diff --git a/src/content/docs/processors/sip/response/audio/create.md b/src/content/docs/processors/sip/response/audio/create.md new file mode 100644 index 0000000..767b0b4 --- /dev/null +++ b/src/content/docs/processors/sip/response/audio/create.md @@ -0,0 +1,12 @@ +--- +title: Create SIP Audio Response +sidebar: + label: Create + order: 1 +--- + +- **type**: `sip.response.audio.create` +- **params**: + - **preWait** + - **audioFile** + - **postWait** \ No newline at end of file diff --git a/src/content/docs/processors/sip/response/dtmf/create.md b/src/content/docs/processors/sip/response/dtmf/create.md new file mode 100644 index 0000000..58f58ef --- /dev/null +++ b/src/content/docs/processors/sip/response/dtmf/create.md @@ -0,0 +1,12 @@ +--- +title: Create SIP DTMF Response +sidebar: + label: Create + order: 1 +--- + +- **type**: `sip.response.dtmf.create` +- **params**: + - **preWait** + - **digits** + - **postWait** \ No newline at end of file diff --git a/src/content/docs/processors/string/create.md b/src/content/docs/processors/string/create.md index 874d831..f79a150 100644 --- a/src/content/docs/processors/string/create.md +++ b/src/content/docs/processors/string/create.md @@ -1,6 +1,7 @@ --- -title: String Create +title: Create String sidebar: + label: Create order: 3 --- The `string.create` processor creates a string based on the provided template. This processor will return an error if there is an issue executing the template. The template property is just a [Go template](https://pkg.go.dev/text/template) that will be evaluated with the incoming message provided as an environment. diff --git a/src/content/docs/processors/string/decode.md b/src/content/docs/processors/string/decode.md index f53747c..c428dab 100644 --- a/src/content/docs/processors/string/decode.md +++ b/src/content/docs/processors/string/decode.md @@ -1,6 +1,7 @@ --- -title: String Decode +title: Decode String sidebar: + label: Decode order: 1 --- The `string.decode` processor takes a array of bytes and turn it into string. This processor will return an error if the message being processed is not an array of bytes. diff --git a/src/content/docs/processors/string/encode.md b/src/content/docs/processors/string/encode.md index 7dbf766..d76053e 100644 --- a/src/content/docs/processors/string/encode.md +++ b/src/content/docs/processors/string/encode.md @@ -1,6 +1,7 @@ --- -title: String Encode +title: Encode String sidebar: + label: Encode order: 2 --- The `string.encode` processor takes a string and turns it into an array of bytes. This processor will return an error if the message being processed is not a string. diff --git a/src/content/docs/processors/string/split.md b/src/content/docs/processors/string/split.md index 41d4e82..67ef818 100644 --- a/src/content/docs/processors/string/split.md +++ b/src/content/docs/processors/string/split.md @@ -1,6 +1,7 @@ --- -title: String Split +title: Split String sidebar: + label: Split order: 5 --- The `string.split` processor takes a string and turns it into an array of strings by splitting on `params.separator`. This processor will return an error if the message being processed is not a string. diff --git a/src/content/docs/processors/time/sleep.md b/src/content/docs/processors/time/sleep.md index 239380e..9df7c47 100644 --- a/src/content/docs/processors/time/sleep.md +++ b/src/content/docs/processors/time/sleep.md @@ -1,6 +1,7 @@ --- title: Sleep sidebar: + label: Sleep order: 1 --- The `time.sleep` processor will sleep for the specified `duration` in milliseconds before passing the message to the next processor.