From a33c05373f024c2490c00929f741f25dd9caf52d Mon Sep 17 00:00:00 2001 From: Joel Wetzell Date: Wed, 19 Aug 2026 10:12:58 -0500 Subject: [PATCH] add new ID property for processors and routes --- src/content/docs/concepts/processors.mdx | 1 + src/content/docs/concepts/routes.mdx | 1 + src/content/docs/examples/dial-a-cue.mdx | 12 ++++++++---- src/content/docs/examples/http-to-osc.mdx | 12 ++++++++---- src/content/docs/processors/artnet/decode.mdx | 3 ++- src/content/docs/processors/artnet/encode.mdx | 3 ++- src/content/docs/processors/db/query.mdx | 3 ++- src/content/docs/processors/debug/log.mdx | 3 ++- src/content/docs/processors/filter/change.mdx | 3 ++- src/content/docs/processors/filter/expr.mdx | 3 ++- src/content/docs/processors/filter/regex.mdx | 3 ++- src/content/docs/processors/float/parse.mdx | 3 ++- src/content/docs/processors/float/random.mdx | 3 ++- src/content/docs/processors/free-d/create.mdx | 3 ++- src/content/docs/processors/free-d/decode.mdx | 3 ++- src/content/docs/processors/free-d/encode.mdx | 3 ++- src/content/docs/processors/http/request/do.mdx | 3 ++- src/content/docs/processors/http/response/create.mdx | 3 ++- src/content/docs/processors/int/parse.mdx | 3 ++- src/content/docs/processors/int/random.mdx | 3 ++- src/content/docs/processors/int/scale.mdx | 3 ++- src/content/docs/processors/json/decode.mdx | 3 ++- src/content/docs/processors/json/encode.mdx | 3 ++- src/content/docs/processors/kv/get.mdx | 3 ++- src/content/docs/processors/kv/set.mdx | 3 ++- .../docs/processors/midi/control_change/create.mdx | 3 ++- src/content/docs/processors/midi/message/decode.mdx | 3 ++- src/content/docs/processors/midi/message/encode.mdx | 3 ++- src/content/docs/processors/midi/message/unpack.mdx | 3 ++- src/content/docs/processors/midi/note_off/create.mdx | 3 ++- src/content/docs/processors/midi/note_on/create.mdx | 3 ++- .../docs/processors/midi/program_change/create.mdx | 3 ++- src/content/docs/processors/module/output.mdx | 3 ++- src/content/docs/processors/osc/message/create.mdx | 3 ++- src/content/docs/processors/osc/message/decode.mdx | 3 ++- src/content/docs/processors/osc/message/encode.mdx | 3 ++- src/content/docs/processors/pubsub/publish.mdx | 3 ++- src/content/docs/processors/script/expr.mdx | 3 ++- src/content/docs/processors/script/js.mdx | 3 ++- src/content/docs/processors/script/wasm.mdx | 3 ++- .../docs/processors/sip/response/audio/create.mdx | 3 ++- .../docs/processors/sip/response/dtmf/create.mdx | 3 ++- src/content/docs/processors/string/create.mdx | 3 ++- src/content/docs/processors/string/decode.mdx | 3 ++- src/content/docs/processors/string/encode.mdx | 3 ++- src/content/docs/processors/string/split.mdx | 3 ++- src/content/docs/processors/time/sleep.mdx | 3 ++- 47 files changed, 104 insertions(+), 51 deletions(-) diff --git a/src/content/docs/concepts/processors.mdx b/src/content/docs/concepts/processors.mdx index 63687a4..410a378 100644 --- a/src/content/docs/concepts/processors.mdx +++ b/src/content/docs/concepts/processors.mdx @@ -10,5 +10,6 @@ Processors are anything that create or manipulate messages. They are configured A processor YAML block has the following properties +- **id**: a unique identifier for the processor (auto generated when using the web interface) - **type**: the processor type - **params**: optional map for processor configuration values. The valid values will depend on the processor type diff --git a/src/content/docs/concepts/routes.mdx b/src/content/docs/concepts/routes.mdx index 5f719cf..4f16acf 100644 --- a/src/content/docs/concepts/routes.mdx +++ b/src/content/docs/concepts/routes.mdx @@ -8,6 +8,7 @@ Routes take the messages coming from a module and push them through a list of [p ## YAML Definition +- **id**: a unique identifier for the route (auto generated when using the web interface) - **input**: the id of the [module](/concepts/modules) that will provide messages to this route - **processors**: (optional) array of [processors](/concepts/processors) that will be called in order and the result of the previous will be fed to the next processor. - an error in a processor step will result in the individual route being terminated diff --git a/src/content/docs/examples/dial-a-cue.mdx b/src/content/docs/examples/dial-a-cue.mdx index 7870e5b..9b952aa 100644 --- a/src/content/docs/examples/dial-a-cue.mdx +++ b/src/content/docs/examples/dial-a-cue.mdx @@ -23,13 +23,17 @@ modules: host: 127.0.0.1 port: 53000 routes: - - input: sip + - id: sip-to-osc + input: sip processors: - - type: osc.message.create + - id: create-osc-message + type: osc.message.create params: address: "/cue/{{.Payload.To}}/go" - - type: osc.message.encode - - type: module.output + - id: encode-osc-message + type: osc.message.encode + - id: send-osc + 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 1a6b173..90dade8 100644 --- a/src/content/docs/examples/http-to-osc.mdx +++ b/src/content/docs/examples/http-to-osc.mdx @@ -23,13 +23,17 @@ modules: host: 127.0.0.1 port: 8000 routes: - - input: http + - id: http-to-osc + input: http processors: - - type: osc.message.create # create OSC message + - id: create-osc-message + type: osc.message.create # create OSC message params: address: "{{.Payload.URL.Path}}" # template the address from the incoming message - - type: osc.message.encode # turn OSC message into bytes - - type: module.output # output to the udp module + - id: encode-osc-message + type: osc.message.encode # turn OSC message into bytes + - id: send-osc + type: module.output # output to the udp module params: module: udp `; diff --git a/src/content/docs/processors/artnet/decode.mdx b/src/content/docs/processors/artnet/decode.mdx index e671e86..ca73a00 100644 --- a/src/content/docs/processors/artnet/decode.mdx +++ b/src/content/docs/processors/artnet/decode.mdx @@ -14,5 +14,6 @@ This processor will decode incoming bytes into an ArtNet packet. This processor ### Example ```yaml -- type: artnet.packet.decode +- id: decode + type: artnet.packet.decode ``` diff --git a/src/content/docs/processors/artnet/encode.mdx b/src/content/docs/processors/artnet/encode.mdx index 2546b81..337386a 100644 --- a/src/content/docs/processors/artnet/encode.mdx +++ b/src/content/docs/processors/artnet/encode.mdx @@ -14,5 +14,6 @@ This processor will encode an ArtNet packet into an array of bytes. This process ### Example ```yaml -- type: artnet.packet.encode +- id: encode + type: artnet.packet.encode ``` diff --git a/src/content/docs/processors/db/query.mdx b/src/content/docs/processors/db/query.mdx index 2b18bbe..2c7cc67 100644 --- a/src/content/docs/processors/db/query.mdx +++ b/src/content/docs/processors/db/query.mdx @@ -17,7 +17,8 @@ This processor will return an error if any of the required parameters are missin Issue a `SELECT` statement to a module with id `sqlite`. ```yaml -- type: db.query +- id: query + type: db.query params: module: sqlite query: "SELECT * from users;" diff --git a/src/content/docs/processors/debug/log.mdx b/src/content/docs/processors/debug/log.mdx index b2156db..e50304b 100644 --- a/src/content/docs/processors/debug/log.mdx +++ b/src/content/docs/processors/debug/log.mdx @@ -13,5 +13,6 @@ This processor will log information about the message being processed to the con ### Example ```yaml -- type: debug.log +- id: log + type: debug.log ``` diff --git a/src/content/docs/processors/filter/change.mdx b/src/content/docs/processors/filter/change.mdx index b823a86..de420f9 100644 --- a/src/content/docs/processors/filter/change.mdx +++ b/src/content/docs/processors/filter/change.mdx @@ -13,5 +13,6 @@ This processor will only pass messages through if the value of the message has c ### Example ```yaml -- type: filter.change +- id: filter + type: filter.change ``` diff --git a/src/content/docs/processors/filter/expr.mdx b/src/content/docs/processors/filter/expr.mdx index c9514d9..1113af2 100644 --- a/src/content/docs/processors/filter/expr.mdx +++ b/src/content/docs/processors/filter/expr.mdx @@ -15,7 +15,8 @@ The `filter.expr` processor evaluates an [Expr expression](https://expr-lang.org Match a payload great than or equal to 0 ```yaml -- type: filter.expr +- id: filter + type: filter.expr params: expression: "Payload >= 0" ``` diff --git a/src/content/docs/processors/filter/regex.mdx b/src/content/docs/processors/filter/regex.mdx index dadcf33..646c4e7 100644 --- a/src/content/docs/processors/filter/regex.mdx +++ b/src/content/docs/processors/filter/regex.mdx @@ -15,7 +15,8 @@ The `filter.regex` processor matches incoming string payload against a regular e Match strings starting with `hello` ```yaml -- type: filter.regex +- id: filter + type: filter.regex params: pattern: "^hello.*" ``` diff --git a/src/content/docs/processors/float/parse.mdx b/src/content/docs/processors/float/parse.mdx index 6b7837a..3309db9 100644 --- a/src/content/docs/processors/float/parse.mdx +++ b/src/content/docs/processors/float/parse.mdx @@ -15,7 +15,8 @@ The `float.parse` processor takes a string and parses it as a float with the spe This would parse the string payload as a 32 bit float and set the payload to that value. ```yaml -- type: float.parse +- id: parse + type: float.parse params: bitSize: 32 ``` diff --git a/src/content/docs/processors/float/random.mdx b/src/content/docs/processors/float/random.mdx index 873e27d..36009c4 100644 --- a/src/content/docs/processors/float/random.mdx +++ b/src/content/docs/processors/float/random.mdx @@ -15,7 +15,8 @@ The `float.random` processor will set the payload to a random float between the This would generate a random 64-bit float between 1.1 and 1.5 and set the payload to that value. ```yaml -- type: float.random +- id: random + type: float.random params: bitSize: 64 min: 1.0 diff --git a/src/content/docs/processors/free-d/create.mdx b/src/content/docs/processors/free-d/create.mdx index 8260152..2d829f8 100644 --- a/src/content/docs/processors/free-d/create.mdx +++ b/src/content/docs/processors/free-d/create.mdx @@ -13,7 +13,8 @@ This processor will create a new FreeD message with the specified parameters. ### Example ```yaml -- type: freed.create +- id: freed-message + type: freed.create params: id: "1" pan: "45" diff --git a/src/content/docs/processors/free-d/decode.mdx b/src/content/docs/processors/free-d/decode.mdx index 4086034..1f6201e 100644 --- a/src/content/docs/processors/free-d/decode.mdx +++ b/src/content/docs/processors/free-d/decode.mdx @@ -13,5 +13,6 @@ This processor will decode incoming bytes into a FreeD message. This processor w ### Example ```yaml -- type: freed.decode +- id: decode + type: freed.decode ``` diff --git a/src/content/docs/processors/free-d/encode.mdx b/src/content/docs/processors/free-d/encode.mdx index 5dc425c..8e9a4bd 100644 --- a/src/content/docs/processors/free-d/encode.mdx +++ b/src/content/docs/processors/free-d/encode.mdx @@ -13,5 +13,6 @@ This processor will encode a FreeD message into an array of bytes. This processo ### Example ```yaml -- type: freed.encode +- id: encode + type: freed.encode ``` diff --git a/src/content/docs/processors/http/request/do.mdx b/src/content/docs/processors/http/request/do.mdx index 6d02771..a10b08b 100644 --- a/src/content/docs/processors/http/request/do.mdx +++ b/src/content/docs/processors/http/request/do.mdx @@ -15,7 +15,8 @@ This process will make an HTTP request to the specified URL using the specified Make a GET request to `https://example.com` ```yaml -- type: http.request.do +- id: make-request + type: http.request.do params: method: GET url: https://example.com diff --git a/src/content/docs/processors/http/response/create.mdx b/src/content/docs/processors/http/response/create.mdx index 8ba6194..3e0cd77 100644 --- a/src/content/docs/processors/http/response/create.mdx +++ b/src/content/docs/processors/http/response/create.mdx @@ -15,7 +15,8 @@ This processor will create a new HTTP response with the specified status code an This would create an HTTP response with a status code of `200` and a body of `OK` ```yaml -- type: http.response.create +- id: create-response + type: http.response.create params: status: 200 bodyTemplate: "OK" diff --git a/src/content/docs/processors/int/parse.mdx b/src/content/docs/processors/int/parse.mdx index a1356b4..f455f1e 100644 --- a/src/content/docs/processors/int/parse.mdx +++ b/src/content/docs/processors/int/parse.mdx @@ -15,7 +15,8 @@ The `int.parse` processor takes a string and parses it as an integer with the sp This would parse the string payload as a 32 bit, base 10 integer and set the payload to that value. ```yaml -- type: int.parse +- id: parse + type: int.parse params: bitSize: 32 ``` diff --git a/src/content/docs/processors/int/random.mdx b/src/content/docs/processors/int/random.mdx index 034fc76..67fe9c1 100644 --- a/src/content/docs/processors/int/random.mdx +++ b/src/content/docs/processors/int/random.mdx @@ -14,7 +14,8 @@ The `int.random` processor will set the payload to a random integer between the This would generate a random integer between -127 and 127 and set the payload to that value. ```yaml -- type: int.random +- id: random + type: int.random params: min: -127 max: 127 diff --git a/src/content/docs/processors/int/scale.mdx b/src/content/docs/processors/int/scale.mdx index d9dddcd..d1969f1 100644 --- a/src/content/docs/processors/int/scale.mdx +++ b/src/content/docs/processors/int/scale.mdx @@ -15,7 +15,8 @@ This processor will scale an integer value from one range to another. This proce Scale an integer value from the range 0-255 to the range 0-100 ```yaml -- type: int.scale +- id: scale + type: int.scale params: inMin: 0 inMax: 255 diff --git a/src/content/docs/processors/json/decode.mdx b/src/content/docs/processors/json/decode.mdx index 918fb1f..bd42e93 100644 --- a/src/content/docs/processors/json/decode.mdx +++ b/src/content/docs/processors/json/decode.mdx @@ -13,5 +13,6 @@ Convert an incoming byte array or raw string into a JSON object. This processor ### Example ```yaml -- type: json.decode +- id: decode + type: json.decode ``` diff --git a/src/content/docs/processors/json/encode.mdx b/src/content/docs/processors/json/encode.mdx index 82c54de..f07b5c2 100644 --- a/src/content/docs/processors/json/encode.mdx +++ b/src/content/docs/processors/json/encode.mdx @@ -13,5 +13,6 @@ This processor will encode an incoming object into a JSON byte array. This proce ### Example ```yaml -- type: json.encode +- id: encode + type: json.encode ``` diff --git a/src/content/docs/processors/kv/get.mdx b/src/content/docs/processors/kv/get.mdx index 8624217..46983b8 100644 --- a/src/content/docs/processors/kv/get.mdx +++ b/src/content/docs/processors/kv/get.mdx @@ -16,7 +16,8 @@ The output payload is the value if the key is found. This will attempt to get the value for the `counter` key from the module with an id of `redis` ```yaml -- type: kv.get +- id: get + type: kv.get params: module: redis key: counter diff --git a/src/content/docs/processors/kv/set.mdx b/src/content/docs/processors/kv/set.mdx index fac4a4f..fc5bb66 100644 --- a/src/content/docs/processors/kv/set.mdx +++ b/src/content/docs/processors/kv/set.mdx @@ -15,7 +15,8 @@ The `kv.set` processor sets the value of the configured key to the incoming payl This will attempt to set the key `hello` using the module with an id of `redis` ```yaml -- type: kv.set +- id: set + type: kv.set params: module: redis key: hello diff --git a/src/content/docs/processors/midi/control_change/create.mdx b/src/content/docs/processors/midi/control_change/create.mdx index 00a7b3d..519a693 100644 --- a/src/content/docs/processors/midi/control_change/create.mdx +++ b/src/content/docs/processors/midi/control_change/create.mdx @@ -13,7 +13,8 @@ This processor will create a MIDI Control Change message with the specified chan ### Example ```yaml -- type: midi.control_change.create +- id: create + type: midi.control_change.create params: channel: "1" control: "64" diff --git a/src/content/docs/processors/midi/message/decode.mdx b/src/content/docs/processors/midi/message/decode.mdx index 471c369..1fc4d0a 100644 --- a/src/content/docs/processors/midi/message/decode.mdx +++ b/src/content/docs/processors/midi/message/decode.mdx @@ -13,5 +13,6 @@ This processor will decode incoming bytes into a MIDI message. This processor wi ### Example ```yaml -- type: midi.message.decode +- id: decode + type: midi.message.decode ``` diff --git a/src/content/docs/processors/midi/message/encode.mdx b/src/content/docs/processors/midi/message/encode.mdx index 48432fd..8202902 100644 --- a/src/content/docs/processors/midi/message/encode.mdx +++ b/src/content/docs/processors/midi/message/encode.mdx @@ -13,5 +13,6 @@ This processor will encode a MIDI message into an array of bytes. This processor ### Example ```yaml -- type: midi.message.encode +- id: encode + type: midi.message.encode ``` diff --git a/src/content/docs/processors/midi/message/unpack.mdx b/src/content/docs/processors/midi/message/unpack.mdx index 3cbfad4..12db604 100644 --- a/src/content/docs/processors/midi/message/unpack.mdx +++ b/src/content/docs/processors/midi/message/unpack.mdx @@ -13,5 +13,6 @@ This processor will unpack a MIDI message into its individual components. This p ### Example ```yaml -- type: midi.message.unpack +- id: unpack + type: midi.message.unpack ``` diff --git a/src/content/docs/processors/midi/note_off/create.mdx b/src/content/docs/processors/midi/note_off/create.mdx index 7d98b4a..9477ea9 100644 --- a/src/content/docs/processors/midi/note_off/create.mdx +++ b/src/content/docs/processors/midi/note_off/create.mdx @@ -13,7 +13,8 @@ This processor will create a MIDI Note Off message with the specified channel, n ### Example ```yaml -- type: midi.note_off.create +- id: create + type: midi.note_off.create params: channel: "1" note: "60" diff --git a/src/content/docs/processors/midi/note_on/create.mdx b/src/content/docs/processors/midi/note_on/create.mdx index 6320217..f968fdb 100644 --- a/src/content/docs/processors/midi/note_on/create.mdx +++ b/src/content/docs/processors/midi/note_on/create.mdx @@ -13,7 +13,8 @@ This processor will create a MIDI Note On message with the specified channel, no ### Example ```yaml -- type: midi.note_on.create +- id: create + type: midi.note_on.create params: channel: "1" note: "60" diff --git a/src/content/docs/processors/midi/program_change/create.mdx b/src/content/docs/processors/midi/program_change/create.mdx index 62c4a4b..95613ef 100644 --- a/src/content/docs/processors/midi/program_change/create.mdx +++ b/src/content/docs/processors/midi/program_change/create.mdx @@ -13,7 +13,8 @@ This processor will create a MIDI Program Change message with the specified chan ### Example ```yaml -- type: midi.program_change.create +- id: create + type: midi.program_change.create params: channel: "1" program: "10" diff --git a/src/content/docs/processors/module/output.mdx b/src/content/docs/processors/module/output.mdx index d34e8bf..6aad463 100644 --- a/src/content/docs/processors/module/output.mdx +++ b/src/content/docs/processors/module/output.mdx @@ -15,7 +15,8 @@ The `module.output` processor takes any payload and outputs to the specified mod Output whatever payload comes through this processor to the `osc-out` module. ```yaml -- type: module.output +- id: output + type: module.output params: module: osc-out ``` diff --git a/src/content/docs/processors/osc/message/create.mdx b/src/content/docs/processors/osc/message/create.mdx index f95e06c..ff03ff3 100644 --- a/src/content/docs/processors/osc/message/create.mdx +++ b/src/content/docs/processors/osc/message/create.mdx @@ -15,7 +15,8 @@ This processor will create an OSC message from the provided parameters. This pro Create an OSC message with the address `/test/message` and two integer arguments from the payload of the message being processed. ```yaml -- type: osc.message.create +- id: create + type: osc.message.create params: address: "/test/message" args: ["{{.Payload[0]}}", "{{.Payload[1]}}"] diff --git a/src/content/docs/processors/osc/message/decode.mdx b/src/content/docs/processors/osc/message/decode.mdx index 6cadc1f..39da40f 100644 --- a/src/content/docs/processors/osc/message/decode.mdx +++ b/src/content/docs/processors/osc/message/decode.mdx @@ -13,5 +13,6 @@ The `osc.message.decode` processor takes a array of bytes and turn it into OSC m ### Example ```yaml -- type: osc.message.encode +- id: decode + type: osc.message.decode ``` diff --git a/src/content/docs/processors/osc/message/encode.mdx b/src/content/docs/processors/osc/message/encode.mdx index 512827a..7083271 100644 --- a/src/content/docs/processors/osc/message/encode.mdx +++ b/src/content/docs/processors/osc/message/encode.mdx @@ -13,5 +13,6 @@ The `osc.message.encode` processor takes an OSC message and turns it into an arr ### Example ```yaml -- type: osc.message.encode +- id: encode + type: osc.message.encode ``` diff --git a/src/content/docs/processors/pubsub/publish.mdx b/src/content/docs/processors/pubsub/publish.mdx index 0bfb924..645d3c6 100644 --- a/src/content/docs/processors/pubsub/publish.mdx +++ b/src/content/docs/processors/pubsub/publish.mdx @@ -15,7 +15,8 @@ The payload is unchanged so whatever is received by this payload is output unles ### Example ```yaml -- type: pubsub.publish +- id: publish + type: pubsub.publish params: module: mqtt-out topic: "test" diff --git a/src/content/docs/processors/script/expr.mdx b/src/content/docs/processors/script/expr.mdx index d42c308..f996c0c 100644 --- a/src/content/docs/processors/script/expr.mdx +++ b/src/content/docs/processors/script/expr.mdx @@ -15,7 +15,8 @@ The processor will execute the provided Expr expression and return the result as This example will add 1 to the wrapped payload. ```yaml -- type: script.expr +- id: expr + type: script.expr params: expression: "Payload + 1" ``` diff --git a/src/content/docs/processors/script/js.mdx b/src/content/docs/processors/script/js.mdx index 03827c4..5e0e08c 100644 --- a/src/content/docs/processors/script/js.mdx +++ b/src/content/docs/processors/script/js.mdx @@ -19,7 +19,8 @@ This run your JavaScript program in a [sandboxed environment](https://gitlab.com Replace all occurrences of `|` with `,` in the payload ```yaml -- type: script.js +- id: javascript + type: script.js params: program: | payload = payload.replaceAll('|',','); diff --git a/src/content/docs/processors/script/wasm.mdx b/src/content/docs/processors/script/wasm.mdx index 1c791b8..0ec98fe 100644 --- a/src/content/docs/processors/script/wasm.mdx +++ b/src/content/docs/processors/script/wasm.mdx @@ -15,7 +15,8 @@ This processor will load and execute a WASM plugin using the [Extism](https://ex This example will load the plugin at `./test.wasm` and execute the `test` function ```yaml -- type: script.wasm +- id: wasm + type: script.wasm params: path: "./test.wasm" function: "test" diff --git a/src/content/docs/processors/sip/response/audio/create.mdx b/src/content/docs/processors/sip/response/audio/create.mdx index 2383cce..1036df7 100644 --- a/src/content/docs/processors/sip/response/audio/create.mdx +++ b/src/content/docs/processors/sip/response/audio/create.mdx @@ -15,7 +15,8 @@ This processor will create a SIP response message with an audio file as the payl This example will create a SIP response that will wait 1 second then play `response.wav` then wait another second before completing the response. ```yaml -- type: sip.response.audio.create +- id: create-audio-response + type: sip.response.audio.create params: preWait: 1000 audioFile: "response.wav" diff --git a/src/content/docs/processors/sip/response/dtmf/create.mdx b/src/content/docs/processors/sip/response/dtmf/create.mdx index 90fc747..2038e48 100644 --- a/src/content/docs/processors/sip/response/dtmf/create.mdx +++ b/src/content/docs/processors/sip/response/dtmf/create.mdx @@ -15,7 +15,8 @@ This processor will create a SIP DTMF response from the provided parameters. If This example will create a SIP response that will wait 1 second then play the DTMF digits "1234" then wait another second before completing the response. ```yaml -- type: sip.response.dtmf.create +- id: create-dtmf-response + type: sip.response.dtmf.create params: preWait: 1000 digits: "1234" diff --git a/src/content/docs/processors/string/create.mdx b/src/content/docs/processors/string/create.mdx index 89cf60c..b5d9239 100644 --- a/src/content/docs/processors/string/create.mdx +++ b/src/content/docs/processors/string/create.mdx @@ -15,7 +15,8 @@ The `string.create` processor creates a string based on the provided template. T This would create a string using the `Address` property of the incoming message like and OSC message ```yaml -- type: string.create +- id: create + type: string.create params: template: "{{.Address}} ``` diff --git a/src/content/docs/processors/string/decode.mdx b/src/content/docs/processors/string/decode.mdx index 82ab331..7e13a0f 100644 --- a/src/content/docs/processors/string/decode.mdx +++ b/src/content/docs/processors/string/decode.mdx @@ -13,5 +13,6 @@ The `string.decode` processor takes a array of bytes and turn it into string. Th ### Example ```yaml -- type: string.decode +- id: decode + type: string.decode ``` diff --git a/src/content/docs/processors/string/encode.mdx b/src/content/docs/processors/string/encode.mdx index 38ffc22..2292f88 100644 --- a/src/content/docs/processors/string/encode.mdx +++ b/src/content/docs/processors/string/encode.mdx @@ -13,5 +13,6 @@ The `string.encode` processor takes a string and turns it into an array of bytes ### Example ```yaml -- type: string.encode +- id: encode + type: string.encode ``` diff --git a/src/content/docs/processors/string/split.mdx b/src/content/docs/processors/string/split.mdx index e0ba393..5e58485 100644 --- a/src/content/docs/processors/string/split.mdx +++ b/src/content/docs/processors/string/split.mdx @@ -15,7 +15,8 @@ The `string.split` processor takes a string and turns it into an array of string Split incoming string on `,` i.e `"one,two,three"` -> `["one","two","three"]` ```yaml -- type: string.split +- id: split + type: string.split params: separator: "," ``` diff --git a/src/content/docs/processors/time/sleep.mdx b/src/content/docs/processors/time/sleep.mdx index 0c10166..730f14a 100644 --- a/src/content/docs/processors/time/sleep.mdx +++ b/src/content/docs/processors/time/sleep.mdx @@ -15,7 +15,8 @@ The `time.sleep` processor will sleep for the specified `duration` in millisecon This would sleep for 5 seconds before passing the message to the next processor. ```yaml -- type: time.sleep +- id: sleep + type: time.sleep params: duration: 5000 ```