add more processor documentation

This commit is contained in:
Joel Wetzell
2026-02-08 15:16:49 -06:00
parent c94002c1b6
commit ffbd717993
8 changed files with 144 additions and 0 deletions
@@ -0,0 +1,18 @@
---
title: Float Parse
sidebar:
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.
- **type**: `float.parse`
- **params**:
- **bitSize**: (optional) the bit size of the float to parse, defaults to 64
### Example
This would parse the string payload as a 32 bit float and set the payload to that value.
```
- type: float.parse
params:
bitSize: 32
```
+19
View File
@@ -0,0 +1,19 @@
---
title: Int Parse
sidebar:
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.
- **type**: `int.parse`
- **params**:
- **base**: (optional) the base to use for parsing the integer, defaults to 10
- **bitSize**: (optional) the bit size of the integer to parse, defaults to 64
### Example
This would parse the string payload as a 32 bit, base 10 integer and set the payload to that value.
```
- type: int.parse
params:
bitSize: 32
```
+20
View File
@@ -0,0 +1,20 @@
---
title: Int Random
sidebar:
order: 2
---
The `int.random` processor will set the payload to a random integer between the specified `min` and `max` value. The minimum and maximum values are inclusive.
- **type**: `int.random`
- **params**:
- **min**: the minimum value for the random integer.
- **max**: the maximum value for the random integer.
### Example
This would generate a random integer between -127 and 127 and set the payload to that value.
```
- type: int.random
params:
min: -127
max: 127
```
+18
View File
@@ -0,0 +1,18 @@
---
title: Sleep
sidebar:
order: 1
---
The `time.sleep` processor will sleep for the specified `duration` in milliseconds before passing the message to the next processor.
- **type**: `time.sleep`
- **params**:
- **duration**: the duration to sleep in milliseconds
### Example
This would sleep for 5 seconds before passing the message to the next processor.
```
- type: time.sleep
params:
duration: 5000
```
+19
View File
@@ -0,0 +1,19 @@
---
title: Uint Parse
sidebar:
order: 1
---
The `uint.parse` processor takes a string and parses it as an unsigned 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 unsigned integer.
- **type**: `uint.parse`
- **params**:
- **base**: (optional) the base to use for parsing the unsigned integer, defaults to 10
- **bitSize**: (optional) the bit size of the unsigned integer to parse, defaults to 64
### Example
This would parse the string payload as a 32 bit, base 10 unsigned integer and set the payload to that value.
```
- type: uint.parse
params:
bitSize: 32
```
@@ -0,0 +1,20 @@
---
title: Uint Random
sidebar:
order: 2
---
The `uint.random` processor will set the payload to a random unsigned integer between the specified `min` and `max` value. The minimum and maximum values are inclusive.
- **type**: `uint.random`
- **params**:
- **min**: the minimum value for the random unsigned integer.
- **max**: the maximum value for the random unsigned integer.
### Example
This would generate a random unsigned integer between 0 and 127 and set the payload to that value.
```
- type: uint.random
params:
min: 0
max: 127
```