Skip to content

Commit 857e50f

Browse files
committed
Document the new node options in the readme
List the value scale for all three nodes, the blank-on-stop option for the sender, and note that recorded scenes are now persisted to disk.
1 parent 89794bd commit 857e50f

1 file changed

Lines changed: 8 additions & 1 deletion

File tree

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ This node can be used to read one or multiple universes sent by sACN.
3838
| trigger | Controls when a message is emitted: only on change, on every received packet, or on change plus a cyclic keepalive re-emit. | `changes`, `always`, `interval` | `changes` | yes |
3939
| interval | Keepalive interval in milliseconds for the `interval` trigger; the full universe is re-emitted when no change arrives in time. | `\d+` | `1000` | no |
4040
| clearOnUniverseChange | When the observed universe is switched at runtime, emit a full universe of zeros until real data for the new universe arrives. | `true`, `false` | `false` | no |
41+
| values | Emit channel values as a percentage (0–100) or as raw DMX values (0–255). | `percent`, `absolute` | `percent` | yes |
4142
| IP-address | IP-Address of the network-interface that should be used for reading from sACN. | `\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}\` (_any valid ip-address_) | _empty_ | no |
4243
| port | The network port which should be used for reading sACN. | `\d+` | _empty_ (defaults to `5568`) | no |
4344

@@ -74,6 +75,8 @@ This node can be used to send one universe using sACN.
7475
| source-name | The name for the sACN-sender that should be displayed within the network. | _any string below 50 characters_ | `Node-RED` | yes |
7576
| speed | Defines the frequency for sending sACN-packages | `once (0Hz)`, `24Hz`, `27Hz`, `30Hz`, `40Hz`, `44Hz` | `0Hz` | yes |
7677
| priority | The priority that should be used for the sACN-sender. | `\d+` (`1` to `200`) | `100` | yes |
78+
| values | Interpret the payload as a percentage (0–100) or as raw DMX values (0–255). | `percent`, `absolute` | `percent` | yes |
79+
| blank-on-stop | Send an all-zero frame before closing so receivers go dark on stop. | `true`, `false` | `false` | no |
7780
| IP-address | IP-Address of the network-interface that should be used for sending sACN. | `\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}\` (_any valid ip-address_) | _empty_ | no |
7881
| port | The network port which should be used for reading sACN. | `\d+` | _empty_ (defaults to `5568`) | no |
7982

@@ -89,7 +92,11 @@ This node can be used to record scenes and play them afterwards.
8992

9093
#### Parameters:
9194

92-
This node has no configuration parameters; its behaviour is controlled entirely through the incoming message.
95+
| Parameter | Description | Possible Values | Default Value | Mandatory |
96+
| --------- | ------------------------------------------------------------------------------ | --------------------- | ------------- | --------- |
97+
| values | Interpret channel values as a percentage (0–100) or as raw DMX values (0–255). | `percent`, `absolute` | `percent` | yes |
98+
99+
Recorded scenes are stored on disk (in a `sacn-scenes` directory inside the Node-RED user directory) and survive a restart.
93100

94101
#### Expected input:
95102

0 commit comments

Comments
 (0)