mirror of
https://github.com/jwetzell/showbridge-docs.git
synced 2026-05-14 05:24:21 +00:00
add layout for remaining processors/modules and order everything
This commit is contained in:
@@ -0,0 +1,8 @@
|
||||
---
|
||||
title: Decode ArtNet Packet
|
||||
sidebar:
|
||||
label: Decode
|
||||
order: 1
|
||||
---
|
||||
|
||||
- **type**: `artnet.packet.decode`
|
||||
@@ -0,0 +1,8 @@
|
||||
---
|
||||
title: Encode ArtNet Packet
|
||||
sidebar:
|
||||
label: Encode
|
||||
order: 2
|
||||
---
|
||||
|
||||
- **type**: `artnet.packet.encode`
|
||||
@@ -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.
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
---
|
||||
title: Debug Log
|
||||
sidebar:
|
||||
label: Log
|
||||
order: 1
|
||||
---
|
||||
|
||||
- **type**: `debug.log`
|
||||
@@ -0,0 +1,8 @@
|
||||
---
|
||||
title: Filter On Change
|
||||
sidebar:
|
||||
label: On Change
|
||||
order: 3
|
||||
---
|
||||
|
||||
- **type**: `filter.change`
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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**
|
||||
@@ -0,0 +1,8 @@
|
||||
---
|
||||
title: Decode FreeD
|
||||
sidebar:
|
||||
label: Decode
|
||||
order: 3
|
||||
---
|
||||
|
||||
- **type**: `free.d.decode`
|
||||
@@ -0,0 +1,8 @@
|
||||
---
|
||||
title: Encode FreeD
|
||||
sidebar:
|
||||
label: Encode
|
||||
order: 2
|
||||
---
|
||||
|
||||
- **type**: `free.d.encode`
|
||||
@@ -0,0 +1,11 @@
|
||||
---
|
||||
title: Make HTTP Request
|
||||
sidebar:
|
||||
label: Make Request
|
||||
order: 1
|
||||
---
|
||||
|
||||
- **type**: `http.request.do`
|
||||
- **params**:
|
||||
- **method**
|
||||
- **url**
|
||||
@@ -0,0 +1,11 @@
|
||||
---
|
||||
title: Create HTTP Response
|
||||
sidebar:
|
||||
label: Create
|
||||
order: 2
|
||||
---
|
||||
|
||||
- **type**: `http.response.create`
|
||||
- **params**:
|
||||
- **status**
|
||||
- **body**
|
||||
@@ -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.
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
title: Int Random
|
||||
title: Create Random Int
|
||||
sidebar:
|
||||
order: 2
|
||||
---
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
---
|
||||
title: Scale Int
|
||||
sidebar:
|
||||
label: Scale
|
||||
order: 3
|
||||
---
|
||||
|
||||
- **type**: `int.scale`
|
||||
- **params**:
|
||||
- **inMin**
|
||||
- **inMax**
|
||||
- **outMin**
|
||||
- **outMax**
|
||||
@@ -0,0 +1,8 @@
|
||||
---
|
||||
title: Decode JSON
|
||||
sidebar:
|
||||
label: Decode
|
||||
order: 2
|
||||
---
|
||||
|
||||
- **type**: `json.decode`
|
||||
@@ -0,0 +1,8 @@
|
||||
---
|
||||
title: Encode JSON
|
||||
sidebar:
|
||||
label: Encode
|
||||
order: 1
|
||||
---
|
||||
|
||||
- **type**: `json.decode`
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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**
|
||||
@@ -0,0 +1,8 @@
|
||||
---
|
||||
title: Decode MIDI Message
|
||||
sidebar:
|
||||
label: Decode
|
||||
order: 3
|
||||
---
|
||||
|
||||
- **type**: `midi.message.decode`
|
||||
@@ -0,0 +1,8 @@
|
||||
---
|
||||
title: Encode MIDI Message
|
||||
sidebar:
|
||||
label: Encode
|
||||
order: 2
|
||||
---
|
||||
|
||||
- **type**: `midi.message.encode`
|
||||
@@ -0,0 +1,8 @@
|
||||
---
|
||||
title: Unpack MIDI Message
|
||||
sidebar:
|
||||
label: Unpack
|
||||
order: 4
|
||||
---
|
||||
|
||||
- **type**: `midi.message.unpack`
|
||||
@@ -0,0 +1,12 @@
|
||||
---
|
||||
title: Create MQTT Message
|
||||
sidebar:
|
||||
order: 1
|
||||
---
|
||||
|
||||
- **type**: `mqtt.message.create`
|
||||
- **params**:
|
||||
- **topic**
|
||||
- **qos**
|
||||
- **retained**
|
||||
- **payload**
|
||||
@@ -0,0 +1,11 @@
|
||||
---
|
||||
title: Create NATS Message
|
||||
sidebar:
|
||||
label: Create
|
||||
order: 1
|
||||
---
|
||||
|
||||
- **type**: `nats.message.create`
|
||||
- **params**:
|
||||
- **subject**
|
||||
- **payload**
|
||||
@@ -0,0 +1,12 @@
|
||||
---
|
||||
title: Create OSC Message
|
||||
sidebar:
|
||||
label: Create
|
||||
order: 1
|
||||
---
|
||||
|
||||
- **type**: `osc.message.create`
|
||||
- **params**:
|
||||
- **address**
|
||||
- **args**
|
||||
- **types**
|
||||
@@ -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
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -0,0 +1,10 @@
|
||||
---
|
||||
title: Execute Expr Expression
|
||||
sidebar:
|
||||
label: Expr
|
||||
order: 2
|
||||
---
|
||||
|
||||
- **type**: `script.expr`
|
||||
- **params**:
|
||||
- **expression**
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
title: JavaScript
|
||||
title: Execute JavaScript
|
||||
sidebar:
|
||||
label: JavaScript
|
||||
order: 1
|
||||
---
|
||||
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
---
|
||||
title: Run WASM (Extism) Plugin
|
||||
sidebar:
|
||||
label: WASM
|
||||
order: 3
|
||||
---
|
||||
|
||||
- **type**: `script.wasm`
|
||||
- **params**:
|
||||
- **path**
|
||||
- **function**
|
||||
- **enableWasi**
|
||||
@@ -0,0 +1,12 @@
|
||||
---
|
||||
title: Create SIP Audio Response
|
||||
sidebar:
|
||||
label: Create
|
||||
order: 1
|
||||
---
|
||||
|
||||
- **type**: `sip.response.audio.create`
|
||||
- **params**:
|
||||
- **preWait**
|
||||
- **audioFile**
|
||||
- **postWait**
|
||||
@@ -0,0 +1,12 @@
|
||||
---
|
||||
title: Create SIP DTMF Response
|
||||
sidebar:
|
||||
label: Create
|
||||
order: 1
|
||||
---
|
||||
|
||||
- **type**: `sip.response.dtmf.create`
|
||||
- **params**:
|
||||
- **preWait**
|
||||
- **digits**
|
||||
- **postWait**
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
Reference in New Issue
Block a user