Merge pull request #179 from jwetzell/fix/in-out-framer

make sure to use a distinct framer for both directions of communication

internal/module/db-sqlite.go

@@ -22,8 +22,10 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"dsn": {
-					Type:      "string",
+					Title:       "Data Source Name",
-					MinLength: new(1),
+					Description: "the data source name (DSN) for the SQLite database",
+					Type:        "string",
+					MinLength:   new(1),
 				},
 			},
 			Required:             []string{"dsn"},

internal/module/http-server.go

@@ -24,10 +24,11 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"port": {
-					Title:   "Port",
+					Title:       "Port",
-					Type:    "integer",
+					Description: "the port for the HTTP server to listen on",
-					Minimum: jsonschema.Ptr[float64](1024),
+					Type:        "integer",
-					Maximum: jsonschema.Ptr[float64](65535),
+					Minimum:     jsonschema.Ptr[float64](1024),
+					Maximum:     jsonschema.Ptr[float64](65535),
 				},
 			},
 			Required:             []string{"port"},

internal/module/midi-input.go

@@ -22,8 +22,9 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"port": {
-					Title: "Port",
+					Title:       "Port",
-					Type:  "string",
+					Description: "the name of the MIDI port to listen to",
+					Type:        "string",
 				},
 			},
 			Required:             []string{"port"},

internal/module/midi-output.go

@@ -24,8 +24,9 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"port": {
-					Title: "Port",
+					Title:       "Port",
-					Type:  "string",
+					Description: "the name of the MIDI port to send messages to",
+					Type:        "string",
 				},
 			},
 			Required:             []string{"port"},

internal/module/mqtt-client.go

@@ -22,28 +22,33 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"broker": {
-					Title: "Broker URL",
+					Title:       "Broker URL",
-					Type:  "string",
+					Description: "the URL of the MQTT broker to connect to",
+					Type:        "string",
 				},
 				"topic": {
-					Title: "Topic",
+					Title:       "Topic",
-					Type:  "string",
+					Description: "an MQTT topic to subscribe to",
+					Type:        "string",
 				},
 				"clientId": {
-					Title: "Client ID",
+					Title:       "Client ID",
-					Type:  "string",
+					Description: "the client ID to use when connecting to the MQTT broker",
+					Type:        "string",
 				},
 				"qos": {
-					Title:   "QoS",
+					Title:       "QoS",
-					Type:    "integer",
+					Description: "the QoS level to use when publishing messages",
-					Minimum: jsonschema.Ptr[float64](0),
+					Type:        "integer",
-					Maximum: jsonschema.Ptr[float64](2),
+					Minimum:     jsonschema.Ptr[float64](0),
-					Default: json.RawMessage(`0`),
+					Maximum:     jsonschema.Ptr[float64](2),
+					Default:     json.RawMessage(`0`),
 				},
 				"retained": {
-					Title:   "Retained",
+					Title:       "Retained",
-					Type:    "boolean",
+					Description: "whether to set the retained flag when publishing messages",
-					Default: json.RawMessage(`false`),
+					Type:        "boolean",
+					Default:     json.RawMessage(`false`),
 				},
 			},
 			Required:             []string{"broker", "topic", "clientId"},

internal/module/nats-client.go

@@ -20,12 +20,14 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"url": {
-					Title: "NATS Server URL",
+					Title:       "NATS Server URL",
-					Type:  "string",
+					Description: "the URL of the NATS server to connect to",
+					Type:        "string",
 				},
 				"subject": {
-					Title: "Subject",
+					Title:       "Subject",
-					Type:  "string",
+					Description: "the subject to subscribe to",
+					Type:        "string",
 				},
 			},
 			Required:             []string{"url", "subject"},

internal/module/nats-server.go

@@ -24,16 +24,18 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"ip": {
-					Title:   "IP",
+					Title:       "IP",
-					Type:    "string",
+					Description: "the IP address to bind the NATS server to",
-					Default: json.RawMessage(`"0.0.0.0"`),
+					Type:        "string",
+					Default:     json.RawMessage(`"0.0.0.0"`),
 				},
 				"port": {
-					Title:   "Port",
+					Title:       "Port",
-					Type:    "integer",
+					Description: "the port for the NATS server to listen on",
-					Minimum: jsonschema.Ptr[float64](1024),
+					Type:        "integer",
-					Maximum: jsonschema.Ptr[float64](65535),
+					Minimum:     jsonschema.Ptr[float64](1024),
-					Default: json.RawMessage(`4222`),
+					Maximum:     jsonschema.Ptr[float64](65535),
+					Default:     json.RawMessage(`4222`),
 				},
 			},
 			Required:             []string{},

internal/module/redis-client.go

@@ -21,12 +21,16 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"host": {
-					Type: "string",
+					Title:       "Host",
+					Description: "the hostname or IP address of the Redis server to connect to",
+					Type:        "string",
 				},
 				"port": {
-					Type:    "integer",
+					Title:       "Port",
-					Minimum: jsonschema.Ptr[float64](1),
+					Description: "the port to use when connecting to the Redis server",
-					Maximum: jsonschema.Ptr[float64](65535),
+					Type:        "integer",
+					Minimum:     jsonschema.Ptr[float64](1),
+					Maximum:     jsonschema.Ptr[float64](65535),
 				},
 			},
 			Required:             []string{"host", "port"},

internal/module/serial-client.go

@@ -25,17 +25,20 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"port": {
-					Title: "Port",
+					Title:       "Port",
-					Type:  "string",
+					Description: "the name of the serial port to connect to",
+					Type:        "string",
 				},
 				"baudRate": {
-					Title: "Baud Rate",
+					Title:       "Baud Rate",
-					Type:  "integer",
+					Description: "the baud rate to use when connecting to the serial port",
+					Type:        "integer",
 				},
 				"framing": {
-					Title: "Framing Method",
+					Title:       "Framing Method",
-					Type:  "string",
+					Description: "the method to use for framing messages on the serial port",
-					Enum:  []any{"LF", "CR", "CRLF", "SLIP", "RAW"},
+					Type:        "string",
+					Enum:        []any{"LF", "CR", "CRLF", "SLIP", "RAW"},
 				},
 			},
 			Required:             []string{"port", "baudRate", "framing"},
@@ -53,12 +56,14 @@ func init() {
 				return nil, fmt.Errorf("serial.client framing error: %w", err)
 			}
 
-			framer := framer.GetFramer(framingMethodString)
+			inFramer := framer.GetFramer(framingMethodString)
 
-			if framer == nil {
+			if inFramer == nil {
 				return nil, fmt.Errorf("serial.client unknown framing method: %s", framingMethodString)
 			}
 
+			outFramer := framer.GetFramer(framingMethodString)
+
 			baudRateInt, err := params.GetInt("baudRate")
 			if err != nil {
 				return nil, fmt.Errorf("serial.client baudRate error: %w", err)
@@ -68,7 +73,7 @@ func init() {
 				BaudRate: baudRateInt,
 			}
 
-			return &SerialClient{config: config, Port: portString, Framer: framer, Mode: &mode, logger: CreateLogger(config)}, nil
+			return &SerialClient{config: config, Port: portString, inFramer: inFramer, outFramer: outFramer, Mode: &mode, logger: CreateLogger(config)}, nil
 		},
 	})
 }
@@ -78,7 +83,8 @@ type SerialClient struct {
 	ctx          context.Context
 	inputHandler common.InputHandler
 	Port         string
-	Framer       framer.Framer
+	inFramer     framer.Framer
+	outFramer    framer.Framer
 	Mode         *serial.Mode
 	port         serial.Port
 	logger       *slog.Logger
@@ -139,13 +145,13 @@ func (sc *SerialClient) Start(ctx context.Context, inputHandler common.InputHand
 					byteCount, err := sc.port.Read(buffer)
 
 					if err != nil {
-						sc.Framer.Clear()
+						sc.inFramer.Clear()
 						break READ
 					}
 
-					if sc.Framer != nil {
+					if sc.inFramer != nil {
 						if byteCount > 0 {
-							messages := sc.Framer.Decode(buffer[0:byteCount])
+							messages := sc.inFramer.Decode(buffer[0:byteCount])
 							for _, message := range messages {
 								if sc.inputHandler != nil {
 									sc.inputHandler(sc.ctx, sc.Id(), message)
@@ -172,7 +178,7 @@ func (sc *SerialClient) Output(ctx context.Context, payload any) error {
 		return errors.New("serial.client can only output bytes")
 	}
 
-	_, err := sc.port.Write(sc.Framer.Encode(payloadBytes))
+	_, err := sc.port.Write(sc.outFramer.Encode(payloadBytes))
 	return err
 }
 
@@ -185,4 +191,12 @@ func (sc *SerialClient) Stop() {
 	if sc.port != nil {
 		sc.port.Close()
 	}
+
+	if sc.inFramer != nil {
+		sc.inFramer.Clear()
+	}
+
+	if sc.outFramer != nil {
+		sc.outFramer.Clear()
+	}
 }

internal/module/sip-call-server.go

@@ -29,27 +29,31 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"ip": {
-					Title:   "IP",
+					Title:       "IP",
-					Type:    "string",
+					Description: "the IP address to bind the SIP server to",
-					Default: json.RawMessage(`"0.0.0.0"`),
+					Type:        "string",
+					Default:     json.RawMessage(`"0.0.0.0"`),
 				},
 				"port": {
-					Title:   "Port",
+					Title:       "Port",
-					Type:    "integer",
+					Description: "the port for the SIP server to listen on",
-					Minimum: jsonschema.Ptr[float64](1024),
+					Type:        "integer",
-					Maximum: jsonschema.Ptr[float64](65535),
+					Minimum:     jsonschema.Ptr[float64](1024),
-					Default: json.RawMessage(`5060`),
+					Maximum:     jsonschema.Ptr[float64](65535),
+					Default:     json.RawMessage(`5060`),
 				},
 				"transport": {
-					Title:   "Transport",
+					Title:       "Transport",
-					Type:    "string",
+					Description: "the transport protocol to use for the SIP server",
-					Enum:    []any{"udp", "tcp", "ws", "udp4", "tcp4"},
+					Type:        "string",
-					Default: json.RawMessage(`"udp"`),
+					Enum:        []any{"udp", "tcp", "ws", "udp4", "tcp4"},
+					Default:     json.RawMessage(`"udp"`),
 				},
 				"userAgent": {
-					Title:   "User Agent",
+					Title:       "User Agent",
-					Type:    "string",
+					Description: "the user agent string to use",
-					Default: json.RawMessage(`"showbridge"`),
+					Type:        "string",
+					Default:     json.RawMessage(`"showbridge"`),
 				},
 			},
 			Required:             []string{},

internal/module/sip-dtmf-server.go

@@ -30,33 +30,38 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"ip": {
-					Title:   "IP",
+					Title:       "IP",
-					Type:    "string",
+					Description: "the IP address to bind the SIP server to",
-					Default: json.RawMessage(`"0.0.0.0"`),
+					Type:        "string",
+					Default:     json.RawMessage(`"0.0.0.0"`),
 				},
 				"port": {
-					Title:   "Port",
+					Title:       "Port",
-					Type:    "integer",
+					Description: "the port for the SIP server to listen on",
-					Minimum: jsonschema.Ptr[float64](1024),
+					Type:        "integer",
-					Maximum: jsonschema.Ptr[float64](65535),
+					Minimum:     jsonschema.Ptr[float64](1024),
-					Default: json.RawMessage(`5060`),
+					Maximum:     jsonschema.Ptr[float64](65535),
+					Default:     json.RawMessage(`5060`),
 				},
 				"transport": {
-					Title:   "Transport",
+					Title:       "Transport",
-					Type:    "string",
+					Description: "the transport protocol to use for the SIP server",
-					Enum:    []any{"udp", "tcp", "ws", "udp4", "tcp4"},
+					Type:        "string",
-					Default: json.RawMessage(`"udp"`),
+					Enum:        []any{"udp", "tcp", "ws", "udp4", "tcp4"},
+					Default:     json.RawMessage(`"udp"`),
 				},
 				"userAgent": {
-					Title:   "User Agent",
+					Title:       "User Agent",
-					Type:    "string",
+					Description: "the user agent string to use",
-					Default: json.RawMessage(`"showbridge"`),
+					Type:        "string",
+					Default:     json.RawMessage(`"showbridge"`),
 				},
 				"separator": {
-					Title:     "DTMF Separator",
+					Title:       "DTMF Separator",
-					Type:      "string",
+					Description: "the DTMF character to use as a separator between DTMF digit groups",
-					MinLength: new(1),
+					Type:        "string",
-					MaxLength: new(1),
+					MinLength:   new(1),
+					MaxLength:   new(1),
 				},
 			},
 			Required:             []string{"separator"},

internal/module/tcp-client.go

@@ -23,19 +23,22 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"host": {
-					Title: "Host",
+					Title:       "Host",
-					Type:  "string",
+					Description: "the hostname or IP address of the TCP server to connect to",
+					Type:        "string",
 				},
 				"port": {
-					Title:   "Port",
+					Title:       "Port",
-					Type:    "integer",
+					Description: "the port of the TCP server to connect to",
-					Minimum: jsonschema.Ptr[float64](1),
+					Type:        "integer",
-					Maximum: jsonschema.Ptr[float64](65535),
+					Minimum:     jsonschema.Ptr[float64](1),
+					Maximum:     jsonschema.Ptr[float64](65535),
 				},
 				"framing": {
-					Title: "Framing Method",
+					Title:       "Framing Method",
-					Type:  "string",
+					Description: "the method used to frame messages over the TCP connection",
-					Enum:  []any{"LF", "CR", "CRLF", "SLIP", "RAW"},
+					Type:        "string",
+					Enum:        []any{"LF", "CR", "CRLF", "SLIP", "RAW"},
 				},
 			},
 			Required:             []string{"host", "port", "framing"},
@@ -63,19 +66,22 @@ func init() {
 				return nil, fmt.Errorf("net.tcp.client framing error: %w", err)
 			}
 
-			framer := framer.GetFramer(framingMethodString)
+			inFramer := framer.GetFramer(framingMethodString)
 
-			if framer == nil {
+			if inFramer == nil {
 				return nil, fmt.Errorf("net.tcp.client unknown framing method: %s", framingMethodString)
 			}
-			return &TCPClient{framer: framer, Addr: addr, config: config, logger: CreateLogger(config)}, nil
+
+			outFramer := framer.GetFramer(framingMethodString)
+			return &TCPClient{inFramer: inFramer, outFramer: outFramer, Addr: addr, config: config, logger: CreateLogger(config)}, nil
 		},
 	})
 }
 
 type TCPClient struct {
 	config       config.ModuleConfig
-	framer       framer.Framer
+	inFramer     framer.Framer
+	outFramer    framer.Framer
 	conn         *net.TCPConn
 	ctx          context.Context
 	inputHandler common.InputHandler
@@ -132,9 +138,9 @@ CONNECT_RETRY:
 				break READ
 			}
 
-			if tc.framer != nil {
+			if tc.inFramer != nil {
 				if byteCount > 0 {
-					messages := tc.framer.Decode(buffer[0:byteCount])
+					messages := tc.inFramer.Decode(buffer[0:byteCount])
 					for _, message := range messages {
 						if tc.inputHandler != nil {
 							tc.inputHandler(tc.ctx, tc.Id(), message)
@@ -169,7 +175,7 @@ func (tc *TCPClient) Output(ctx context.Context, payload any) error {
 	if !ok {
 		return errors.New("net.tcp.client is only able to output bytes")
 	}
-	_, err := tc.conn.Write(tc.framer.Encode(payloadBytes))
+	_, err := tc.conn.Write(tc.inFramer.Encode(payloadBytes))
 	return err
 }
 
@@ -182,4 +188,12 @@ func (tc *TCPClient) Stop() {
 	if tc.conn != nil {
 		tc.conn.Close()
 	}
+
+	if tc.inFramer != nil {
+		tc.inFramer.Clear()
+	}
+
+	if tc.outFramer != nil {
+		tc.outFramer.Clear()
+	}
 }

internal/module/tcp-server.go

@@ -26,20 +26,23 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"ip": {
-					Title:   "IP",
+					Title:       "IP",
-					Type:    "string",
+					Description: "the IP address to bind the TCP server to",
-					Default: json.RawMessage(`"0.0.0.0"`),
+					Type:        "string",
+					Default:     json.RawMessage(`"0.0.0.0"`),
 				},
 				"port": {
-					Title:   "Port",
+					Title:       "Port",
-					Type:    "integer",
+					Description: "the port for the TCP server to listen on",
-					Minimum: jsonschema.Ptr[float64](1024),
+					Type:        "integer",
-					Maximum: jsonschema.Ptr[float64](65535),
+					Minimum:     jsonschema.Ptr[float64](1024),
+					Maximum:     jsonschema.Ptr[float64](65535),
 				},
 				"framing": {
-					Title: "Framing Method",
+					Title:       "Framing Method",
-					Type:  "string",
+					Description: "the method used to frame messages over the TCP connection",
-					Enum:  []any{"LF", "CR", "CRLF", "SLIP", "RAW"},
+					Type:        "string",
+					Enum:        []any{"LF", "CR", "CRLF", "SLIP", "RAW"},
 				},
 			},
 			Required:             []string{"port", "framing"},
@@ -78,7 +81,7 @@ func init() {
 			if err != nil {
 				return nil, err
 			}
-			return &TCPServer{InFramer: inFramer, OutFramer: outFramer, framerType: framingMethodString, Addr: addr, config: moduleConfig, logger: CreateLogger(moduleConfig)}, nil
+			return &TCPServer{inFramer: inFramer, outFramer: outFramer, framerType: framingMethodString, Addr: addr, config: moduleConfig, logger: CreateLogger(moduleConfig)}, nil
 		},
 	})
 }
@@ -91,8 +94,8 @@ type tcpConnection struct {
 type TCPServer struct {
 	config                config.ModuleConfig
 	Addr                  *net.TCPAddr
-	InFramer              framer.Framer
+	inFramer              framer.Framer
-	OutFramer             framer.Framer
+	outFramer             framer.Framer
 	framerType            string
 	ctx                   context.Context
 	inputHandler          common.InputHandler
@@ -146,9 +149,9 @@ func (ts *TCPServer) handleClient(client *net.TCPConn) {
 			}
 			break
 		}
-		if ts.InFramer != nil {
+		if ts.inFramer != nil {
 			if byteCount > 0 {
-				messages := ts.InFramer.Decode(buffer[0:byteCount])
+				messages := ts.inFramer.Decode(buffer[0:byteCount])
 				for _, message := range messages {
 					if ts.inputHandler != nil {
 						ts.inputHandler(ts.ctx, ts.Id(), message)
@@ -216,11 +219,11 @@ func (ts *TCPServer) Output(ctx context.Context, payload any) error {
 	defer ts.connectionsMu.Unlock()
 	var errorString strings.Builder
 
-	if ts.OutFramer == nil {
+	if ts.outFramer == nil {
 		return errors.New("no output framer configured")
 	}
 
-	outputBytes := ts.OutFramer.Encode(payloadBytes)
+	outputBytes := ts.outFramer.Encode(payloadBytes)
 
 	for _, connection := range ts.connections {
 		_, err := connection.conn.Write(outputBytes)

internal/module/time-interval.go

@@ -20,8 +20,8 @@ func init() {
 			Properties: map[string]*jsonschema.Schema{
 				"duration": {
 					Title:       "Duration",
+					Description: "time in milliseconds between emitted events",
 					Type:        "integer",
-					Description: "Interval duration in milliseconds",
 				},
 			},
 			Required:             []string{"duration"},

internal/module/time-timer.go

@@ -20,8 +20,8 @@ func init() {
 			Properties: map[string]*jsonschema.Schema{
 				"duration": {
 					Title:       "Duration",
+					Description: "time in milliseconds before the timer fires",
 					Type:        "integer",
-					Description: "Interval duration in milliseconds",
 				},
 			},
 			Required:             []string{"duration"},

internal/module/udp-client.go

@@ -21,14 +21,16 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"host": {
-					Title: "Host",
+					Title:       "Host",
-					Type:  "string",
+					Description: "the hostname or IP address of the UDP server to connect to",
+					Type:        "string",
 				},
 				"port": {
-					Title:   "Port",
+					Title:       "Port",
-					Type:    "integer",
+					Description: "the port of the UDP server to connect to",
-					Minimum: jsonschema.Ptr[float64](1),
+					Type:        "integer",
-					Maximum: jsonschema.Ptr[float64](65535),
+					Minimum:     jsonschema.Ptr[float64](1),
+					Maximum:     jsonschema.Ptr[float64](65535),
 				},
 			},
 			Required:             []string{"host", "port"},

internal/module/udp-multicast.go

@@ -22,14 +22,16 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"ip": {
-					Title: "IP",
+					Title:       "IP",
-					Type:  "string",
+					Description: "the multicast address to listen on",
+					Type:        "string",
 				},
 				"port": {
-					Title:   "Port",
+					Title:       "Port",
-					Type:    "integer",
+					Description: "the port to listen on",
-					Minimum: jsonschema.Ptr[float64](1024),
+					Type:        "integer",
-					Maximum: jsonschema.Ptr[float64](65535),
+					Minimum:     jsonschema.Ptr[float64](1024),
+					Maximum:     jsonschema.Ptr[float64](65535),
 				},
 			},
 			Required:             []string{"ip", "port"},

internal/module/udp-server.go

@@ -23,22 +23,25 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"ip": {
-					Title:   "IP",
+					Title:       "IP",
-					Type:    "string",
+					Description: "the IP address to bind the UDP server to",
-					Default: json.RawMessage(`"0.0.0.0"`),
+					Type:        "string",
+					Default:     json.RawMessage(`"0.0.0.0"`),
 				},
 				"port": {
-					Title:   "Port",
+					Title:       "Port",
-					Type:    "integer",
+					Description: "the port for the UDP server to listen on",
-					Minimum: jsonschema.Ptr[float64](1024),
+					Type:        "integer",
-					Maximum: jsonschema.Ptr[float64](65535),
+					Minimum:     jsonschema.Ptr[float64](1024),
+					Maximum:     jsonschema.Ptr[float64](65535),
 				},
 				"bufferSize": {
-					Title:   "Buffer Size",
+					Title:       "Buffer Size",
-					Type:    "integer",
+					Description: "the size of the buffer for incoming UDP messages",
-					Minimum: jsonschema.Ptr[float64](1),
+					Type:        "integer",
-					Maximum: jsonschema.Ptr[float64](65535),
+					Minimum:     jsonschema.Ptr[float64](1),
-					Default: json.RawMessage("2048"),
+					Maximum:     jsonschema.Ptr[float64](65535),
+					Default:     json.RawMessage("2048"),
 				},
 			},
 			Required:             []string{"port"},

internal/module/websocket-client.go

@@ -23,8 +23,9 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"url": {
-					Title: "URL",
+					Title:       "URL",
-					Type:  "string",
+					Description: "the URL of the WebSocket server to connect",
+					Type:        "string",
 				},
 			},
 			Required:             []string{"url"},

internal/processor/db-query.go

@@ -22,13 +22,13 @@ func init() {
 			Properties: map[string]*jsonschema.Schema{
 				"module": {
 					Title:       "Module ID",
-					Type:        "string",
 					Description: "ID of the database module to query",
+					Type:        "string",
 				},
 				"query": {
 					Title:       "Query",
-					Type:        "string",
 					Description: "SQL query to execute",
+					Type:        "string",
 				},
 			},
 			Required:             []string{"module", "query"},

internal/processor/filter-expr.go

@@ -19,8 +19,9 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"expression": {
-					Title: "Expression",
+					Title:       "Expression",
-					Type:  "string",
+					Description: "Expr expression to evaluate, must return a boolean",
+					Type:        "string",
 				},
 			},
 			Required:             []string{"expression"},

internal/processor/filter-rate.go

@@ -18,9 +18,9 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"rate": {
-					Type:        "integer",
 					Title:       "Rate",
-					Description: "The number of events to allow per second.",
+					Description: "number of events to allow per second",
+					Type:        "integer",
 				},
 			},
 			Required: []string{"rate"},

internal/processor/filter-regex.go

@@ -19,8 +19,9 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"pattern": {
-					Title: "Pattern",
+					Title:       "Pattern",
-					Type:  "string",
+					Description: "regex pattern to match against",
+					Type:        "string",
 				},
 			},
 			Required:             []string{"pattern"},

internal/processor/float-parse.go

@@ -20,10 +20,11 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"bitSize": {
-					Title:   "Bit Size",
+					Title:       "Bit Size",
-					Type:    "integer",
+					Description: "bit size of the resulting float",
-					Enum:    []any{32, 64},
+					Type:        "integer",
-					Default: json.RawMessage("64"),
+					Enum:        []any{32, 64},
+					Default:     json.RawMessage("64"),
 				},
 			},
 			AdditionalProperties: &jsonschema.Schema{Not: &jsonschema.Schema{}},

internal/processor/float-random.go

@@ -20,18 +20,21 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"bitSize": {
-					Title:   "Bit Size",
+					Title:       "Bit Size",
-					Type:    "integer",
+					Description: "bit size of the resulting float",
-					Enum:    []any{32, 64},
+					Type:        "integer",
-					Default: json.RawMessage("32"),
+					Enum:        []any{32, 64},
+					Default:     json.RawMessage("32"),
 				},
 				"min": {
-					Title: "Minimum",
+					Title:       "Minimum",
-					Type:  "number",
+					Description: "inclusive minimum value of the random float",
+					Type:        "number",
 				},
 				"max": {
-					Title: "Maximum",
+					Title:       "Maximum",
-					Type:  "number",
+					Description: "exclusive maximum value of the random float",
+					Type:        "number",
 				},
 			},
 			Required:             []string{"min", "max"},

internal/processor/free-d-create.go

@@ -21,40 +21,49 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"id": {
-					Title: "Camera ID",
+					Title:       "Camera ID",
-					Type:  "string",
+					Description: "ID of the camera this FreeD position corresponds to",
+					Type:        "string",
 				},
 				"pan": {
-					Title: "Pan",
+					Title:       "Pan",
-					Type:  "string",
+					Description: "pan angle of the camera",
+					Type:        "string",
 				},
 				"tilt": {
-					Title: "Tilt",
+					Title:       "Tilt",
-					Type:  "string",
+					Description: "tilt angle of the camera",
+					Type:        "string",
 				},
 				"roll": {
-					Title: "Roll",
+					Title:       "Roll",
-					Type:  "string",
+					Description: "roll angle of the camera",
+					Type:        "string",
 				},
 				"posX": {
-					Title: "Position X",
+					Title:       "Position X",
-					Type:  "string",
+					Description: "X coordinate of the camera's position",
+					Type:        "string",
 				},
 				"posY": {
-					Title: "Position Y",
+					Title:       "Position Y",
-					Type:  "string",
+					Description: "Y coordinate of the camera's position",
+					Type:        "string",
 				},
 				"posZ": {
-					Title: "Position Z",
+					Title:       "Position Z",
-					Type:  "string",
+					Description: "Z coordinate of the camera's position",
+					Type:        "string",
 				},
 				"zoom": {
-					Title: "Zoom",
+					Title:       "Zoom",
-					Type:  "string",
+					Description: "zoom level of the camera",
+					Type:        "string",
 				},
 				"focus": {
-					Title: "Focus",
+					Title:       "Focus",
-					Type:  "string",
+					Description: "focus level of the camera",
+					Type:        "string",
 				},
 			},
 			Required: []string{

internal/processor/http-request-do.go

@@ -22,13 +22,15 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"method": {
-					Title: "HTTP Method",
+					Title:       "HTTP Method",
-					Type:  "string",
+					Description: "method to use for the HTTP request",
-					Enum:  []any{"GET", "POST", "PUT", "PATCH", "DELETE"},
+					Type:        "string",
+					Enum:        []any{"GET", "POST", "PUT", "PATCH", "DELETE"},
 				},
 				"url": {
-					Title: "URL",
+					Title:       "URL",
-					Type:  "string",
+					Description: "URL to send the HTTP request to",
+					Type:        "string",
 				},
 			},
 			Required:             []string{"method", "url"},

internal/processor/http-response-create.go

@@ -19,12 +19,14 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"status": {
-					Title: "Status Code",
+					Title:       "Status Code",
-					Type:  "integer",
+					Description: "status code to set on the response",
+					Type:        "integer",
 				},
 				"bodyTemplate": {
-					Title: "Body Template",
+					Title:       "Body Template",
-					Type:  "string",
+					Description: "template for the response body",
+					Type:        "string",
 				},
 			},
 			Required:             []string{"status", "bodyTemplate"},

internal/processor/int-parse.go

@@ -20,16 +20,18 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"base": {
-					Title:   "Base",
+					Title:       "Base",
-					Type:    "integer",
+					Description: "numerical base to use for parsing the integer",
-					Enum:    []any{0, 2, 8, 10, 16},
+					Type:        "integer",
-					Default: json.RawMessage("10"),
+					Enum:        []any{0, 2, 8, 10, 16},
+					Default:     json.RawMessage("10"),
 				},
 				"bitSize": {
-					Title:   "Bit Size",
+					Title:       "Bit Size",
-					Type:    "integer",
+					Description: "bit size of the resulting integer",
-					Enum:    []any{0, 8, 16, 32, 64},
+					Type:        "integer",
-					Default: json.RawMessage("64"),
+					Enum:        []any{0, 8, 16, 32, 64},
+					Default:     json.RawMessage("64"),
 				},
 			},
 			AdditionalProperties: &jsonschema.Schema{Not: &jsonschema.Schema{}},

internal/processor/int-random.go

@@ -19,12 +19,14 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"min": {
-					Title: "Minimum",
+					Title:       "Minimum",
-					Type:  "integer",
+					Description: "inclusive minimum value of the random integer",
+					Type:        "integer",
 				},
 				"max": {
-					Title: "Maximum",
+					Title:       "Maximum",
-					Type:  "integer",
+					Description: "inclusive maximum value of the random integer",
+					Type:        "integer",
 				},
 			},
 			Required:             []string{"min", "max"},

internal/processor/int-scale.go

@@ -18,20 +18,24 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"inMin": {
-					Title: "Input Minimum",
+					Title:       "Input Minimum",
-					Type:  "integer",
+					Description: "minimum value of the input integer",
+					Type:        "integer",
 				},
 				"inMax": {
-					Title: "Input Maximum",
+					Title:       "Input Maximum",
-					Type:  "integer",
+					Description: "maximum value of the input integer",
+					Type:        "integer",
 				},
 				"outMin": {
-					Title: "Output Minimum",
+					Title:       "Output Minimum",
-					Type:  "integer",
+					Description: "minimum value of the output integer",
+					Type:        "integer",
 				},
 				"outMax": {
-					Title: "Output Maximum",
+					Title:       "Output Maximum",
-					Type:  "integer",
+					Description: "maximum value of the output integer",
+					Type:        "integer",
 				},
 			},
 			Required:             []string{"inMin", "inMax", "outMin", "outMax"},

internal/processor/kv-get.go

@@ -19,12 +19,14 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"module": {
-					Title: "Module ID",
+					Title:       "Module ID",
-					Type:  "string",
+					Description: "ID of the key-value module to get the value from",
+					Type:        "string",
 				},
 				"key": {
-					Title: "Key",
+					Title:       "Key",
-					Type:  "string",
+					Description: "key to retrieve from the key-value module",
+					Type:        "string",
 				},
 			},
 			Required:             []string{"module", "key"},

internal/processor/kv-set.go

@@ -19,12 +19,14 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"module": {
-					Title: "Module ID",
+					Title:       "Module ID",
-					Type:  "string",
+					Description: "ID of the key-value module to set the value in",
+					Type:        "string",
 				},
 				"key": {
-					Title: "Key",
+					Title:       "Key",
-					Type:  "string",
+					Description: "key to set in the key-value module",
+					Type:        "string",
 				},
 			},
 			Required:             []string{"module", "key"},

internal/processor/midi-control_change-create.go

@@ -23,16 +23,19 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"channel": {
-					Title: "Channel",
+					Title:       "Channel",
-					Type:  "string",
+					Description: "channel number for the control change message",
+					Type:        "string",
 				},
 				"control": {
-					Title: "Control",
+					Title:       "Control",
-					Type:  "string",
+					Description: "control number for the control change message",
+					Type:        "string",
 				},
 				"value": {
-					Title: "Value",
+					Title:       "Value",
-					Type:  "string",
+					Description: "value for the control change message",
+					Type:        "string",
 				},
 			},
 			Required:             []string{"channel", "control", "value"},

internal/processor/midi-note_off-create.go

@@ -23,16 +23,19 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"channel": {
-					Title: "Channel",
+					Title:       "Channel",
-					Type:  "string",
+					Description: "channel number for the note off message",
+					Type:        "string",
 				},
 				"note": {
-					Title: "Note",
+					Title:       "Note",
-					Type:  "string",
+					Description: "note number for the note off message",
+					Type:        "string",
 				},
 				"velocity": {
-					Title: "Velocity",
+					Title:       "Velocity",
-					Type:  "string",
+					Description: "velocity for the note off message",
+					Type:        "string",
 				},
 			},
 			Required:             []string{"channel", "note", "velocity"},

internal/processor/midi-note_on-create.go

@@ -23,16 +23,19 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"channel": {
-					Title: "Channel",
+					Title:       "Channel",
-					Type:  "string",
+					Description: "channel number for the note on message",
+					Type:        "string",
 				},
 				"note": {
-					Title: "Note",
+					Title:       "Note",
-					Type:  "string",
+					Description: "note number for the note on message",
+					Type:        "string",
 				},
 				"velocity": {
-					Title: "Velocity",
+					Title:       "Velocity",
-					Type:  "string",
+					Description: "velocity for the note on message",
+					Type:        "string",
 				},
 			},
 			Required:             []string{"channel", "note", "velocity"},

internal/processor/midi-program_change-create.go

@@ -23,12 +23,14 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"channel": {
-					Title: "Channel",
+					Title:       "Channel",
-					Type:  "string",
+					Description: "channel number for the program change message",
+					Type:        "string",
 				},
 				"program": {
-					Title: "Program",
+					Title:       "Program",
-					Type:  "string",
+					Description: "program number for the program change message",
+					Type:        "string",
 				},
 			},
 			Required:             []string{"type", "channel", "program"},

internal/processor/module-output.go

@@ -20,8 +20,8 @@ func init() {
 			Properties: map[string]*jsonschema.Schema{
 				"module": {
 					Title:       "Module ID",
-					Type:        "string",
 					Description: "ID of module to send output to",
+					Type:        "string",
 				},
 			},
 			Required:             []string{"module"},

internal/processor/osc-message-create.go

@@ -23,19 +23,22 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"address": {
-					Title: "Address",
+					Title:       "Address",
-					Type:  "string",
+					Description: "OSC address for the message",
+					Type:        "string",
 				},
 				"args": {
-					Title: "Arguments",
+					Title:       "Arguments",
-					Type:  "array",
+					Description: "arguments for the OSC message",
+					Type:        "array",
 					Items: &jsonschema.Schema{
 						Type: "string",
 					},
 				},
 				"types": {
-					Title: "Argument Types",
+					Title:       "Argument Types",
-					Type:  "string",
+					Description: "string of OSC types corresponding to the arguments in args",
+					Type:        "string",
 				},
 			},
 			Required:             []string{"address"},

internal/processor/pubsub-publish.go

@@ -22,13 +22,13 @@ func init() {
 			Properties: map[string]*jsonschema.Schema{
 				"module": {
 					Title:       "Module ID",
-					Type:        "string",
 					Description: "ID of the module to publish to",
+					Type:        "string",
 				},
 				"topic": {
 					Title:       "Topic",
+					Description: "topic to publish to",
 					Type:        "string",
-					Description: "Topic to publish to",
 				},
 			},
 			Required:             []string{"module", "topic"},

internal/processor/router-input.go

@@ -20,8 +20,8 @@ func init() {
 			Properties: map[string]*jsonschema.Schema{
 				"source": {
 					Title:       "Source",
-					Type:        "string",
 					Description: "source to report as to the router",
+					Type:        "string",
 				},
 			},
 			Required:             []string{"source"},

internal/processor/script-expr.go

@@ -25,8 +25,9 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"expression": {
-					Title: "Expression",
+					Title:       "Expression",
-					Type:  "string",
+					Description: "Expr expression to evaluate",
+					Type:        "string",
 				},
 			},
 			Required:             []string{"expression"},

internal/processor/script-js.go

@@ -18,8 +18,9 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"program": {
-					Title: "Program",
+					Title:       "Program",
-					Type:  "string",
+					Description: "JavaScript program to run",
+					Type:        "string",
 				},
 			},
 			Required:             []string{"program"},

internal/processor/script-wasm.go

@@ -20,18 +20,21 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"path": {
-					Title: "Path",
+					Title:       "Path",
-					Type:  "string",
+					Description: "path to the WASM plugin to load",
+					Type:        "string",
 				},
 				"function": {
-					Title:   "Function",
+					Title:       "Function",
-					Type:    "string",
+					Description: "exported function to call on the WASM plugin",
-					Default: json.RawMessage(`"process"`),
+					Type:        "string",
+					Default:     json.RawMessage(`"process"`),
 				},
 				"enableWasi": {
-					Title:   "Enable WASI",
+					Title:       "Enable WASI",
-					Type:    "boolean",
+					Description: "whether to enable WASI when running the WASM plugin",
-					Default: json.RawMessage("false"),
+					Type:        "boolean",
+					Default:     json.RawMessage("false"),
 				},
 			},
 			Required:             []string{"path"},

internal/processor/sip-response-audio-create.go

@@ -19,15 +19,19 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"preWait": {
-					Title: "Pre Wait (ms)",
+					Title:       "Pre Wait (ms)",
-					Type:  "integer",
+					Description: "number of milliseconds to wait before playing the audio",
-				},
+					Type:        "integer",
-				"postWait": {
-					Title: "Post Wait (ms)",
-					Type:  "integer",
 				},
 				"audioFile": {
-					Type: "string",
+					Title:       "Audio File",
+					Description: "path to the audio file to play",
+					Type:        "string",
+				},
+				"postWait": {
+					Title:       "Post Wait (ms)",
+					Description: "number of milliseconds to wait after playing the audio",
+					Type:        "integer",
 				},
 			},
 			Required:             []string{"preWait", "postWait", "audioFile"},

internal/processor/sip-response-dtmf-create.go

@@ -21,15 +21,19 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"preWait": {
-					Title: "Pre Wait (ms)",
+					Title:       "Pre Wait (ms)",
-					Type:  "integer",
+					Description: "number of milliseconds to wait before sending the DTMF tones",
-				},
+					Type:        "integer",
-				"postWait": {
-					Title: "Post Wait (ms)",
-					Type:  "integer",
 				},
 				"digits": {
-					Type: "string",
+					Title:       "Digits",
+					Description: "DTMF digits to send",
+					Type:        "string",
+				},
+				"postWait": {
+					Title:       "Post Wait (ms)",
+					Description: "number of milliseconds to wait after sending the DTMF tones",
+					Type:        "integer",
 				},
 			},
 			Required:             []string{"preWait", "postWait", "digits"},

internal/processor/string-create.go

@@ -19,8 +19,9 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"template": {
-					Title: "Template",
+					Title:       "Template",
-					Type:  "string",
+					Description: "template to evaluate",
+					Type:        "string",
 				},
 			},
 			Required:             []string{"template"},

internal/processor/string-split.go

@@ -19,8 +19,9 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"separator": {
-					Title: "Separator",
+					Title:       "Separator",
-					Type:  "string",
+					Description: "separator to split the string on",
+					Type:        "string",
 				},
 			},
 			Required:             []string{"separator"},

internal/processor/struct-field-get.go

@@ -19,8 +19,9 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"name": {
-					Title: "Field Name",
+					Title:       "Field Name",
-					Type:  "string",
+					Description: "name of the struct field to extract",
+					Type:        "string",
 				},
 			},
 			Required:             []string{"name"},

internal/processor/struct-method-get.go

@@ -19,8 +19,9 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"name": {
-					Title: "Method Name",
+					Title:       "Method Name",
-					Type:  "string",
+					Description: "name of the struct method to extract and call (with no arguments)",
+					Type:        "string",
 				},
 			},
 			Required:             []string{"name"},

internal/processor/time-sleep.go

@@ -19,8 +19,8 @@ func init() {
 			Properties: map[string]*jsonschema.Schema{
 				"duration": {
 					Title:       "Duration",
+					Description: "time to sleep in milliseconds",
 					Type:        "integer",
-					Description: "Duration to sleep in milliseconds",
 				},
 			},
 			Required:             []string{"duration"},