Skip to content

Commit 6248e45

Browse files
mutecmutec
committed
add reset message and update documentation
1 parent 665bd1b commit 6248e45

File tree

4 files changed

+101
-15
lines changed

4 files changed

+101
-15
lines changed

‎README.md‎

Lines changed: 30 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ This node can be used to read one or multiple universes send by sACN.
3030
#### Parameters:
3131

3232
| Paremeter | Description | Possible Values | Default Value | Mandatory |
33-
|------------|-------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------|------------------------------|-----------|
33+
| ---------- | ----------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- | ---------------------------- | --------- |
3434
| universe | The universe that is meant to be observed. | `\d+` (`1` to `63999`) | `1` | yes |
3535
| mode | Defines whether the node returns the values of every read sACN package (passthrough mode), or merged values using HTP or LTP. | `passthrough`, `htp`, `ltp` | `htp` | yes |
3636
| output | Defines wether the node sends only changed values or the whole universe. | `full`, `changes` | `full` | yes |
@@ -40,7 +40,7 @@ This node can be used to read one or multiple universes send by sACN.
4040
#### Output for direct-mode:
4141

4242
| Property | Description |
43-
|------------|-------------------------------------------------------------------------------------------------------------------------------------------|
43+
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
4444
| `sequence` | sACN packets are given a packet sequence number so that the receiver can keep the sequence of packets from a given sender. (`1` to `255`) |
4545
| `source` | IP-Address of the sender. |
4646
| `priority` | Priority of the sender. (`1` to `200`) |
@@ -50,7 +50,7 @@ This node can be used to read one or multiple universes send by sACN.
5050
#### Output for merging-modes (HTP or LTP):
5151

5252
| Property | Description |
53-
|------------|-----------------------------------------------------------------------------------------------------------------------------------------|
53+
| ---------- | --------------------------------------------------------------------------------------------------------------------------------------- |
5454
| `universe` | Id of the universe the package is addressed to. |
5555
| `payload` | array containing the dmx values as **percentage** by dmx channel. DMX-Channel `1` starts at key `1`, not `0`. (`Array<number, number>`) |
5656

@@ -61,7 +61,7 @@ This node can be used to send one universe using sACN.
6161
#### Parameters:
6262

6363
| Paremeter | Description | Possible Values | Default Value | Mandatory |
64-
|-------------|---------------------------------------------------------------------------|----------------------------------------------------------------|------------------------------|-----------|
64+
| ----------- | ------------------------------------------------------------------------- | -------------------------------------------------------------- | ---------------------------- | --------- |
6565
| universe | The universe that is meant to be observed. | `\d+` (`1` to `63999`) | `1` | yes |
6666
| source-name | The name for the sACN-sender that should be displayed within the network. | _any string below 50 characters_ | `Node-RED` | yes |
6767
| speed | Defines the frequency for sending sACN-packages | `once (0Hz)`, `24Hz`, `27Hz`, `30Hz`, `40Hz`, `44Hz` | `0Hz` | yes |
@@ -72,7 +72,7 @@ This node can be used to send one universe using sACN.
7272
#### Expected input:
7373

7474
| Property | Description |
75-
|-----------|-----------------------------------------------------------------------------------------------------------------------------------------|
75+
| --------- | --------------------------------------------------------------------------------------------------------------------------------------- |
7676
| `payload` | array containing the dmx values as **percentage** by dmx channel. DMX-Channel `1` starts at key `1`, not `0`. (`Array<number, number>`) |
7777

7878
### Scene-Controller
@@ -81,14 +81,32 @@ This node can be used to record scenes and play them afterwards.
8181

8282
#### Parameters:
8383

84-
| Paremeter | Description | Possible Values | Default Value | Mandatory |
85-
|-------------|---------------------------------------------------------------------------|----------------------------------------------------------------|---------------|-----------|
84+
| Paremeter | Description | Possible Values | Default Value | Mandatory |
85+
| --------- | ----------- | --------------- | ------------- | --------- |
8686

8787
#### Expected input:
8888

89-
| Property | Description | Mandatory |
90-
|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------|
91-
| `action` | the action to be executed - `save` to save a preset, `play` to play a saved preset, `reset` to reset | yes |
92-
| `scene` | for action | yes, for actions `save`, `play` |
93-
| `universe` | if only one universe is handled, this parameter is mandatory and contains the used universe | yes |
89+
| Property | Description | Mandatory |
90+
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------- |
91+
| `action` | the action to be executed - `save` to save a preset, `play` to play a saved preset, `reset` to reset | yes |
92+
| `scene` | for action | yes, for actions `save`, `play` |
93+
| `universe` | if only one universe is handled, this parameter is mandatory and contains the used universe | yes |
9494
| `payload` | contains the values to record. it might be an array (key 0-511) containing the values for a single universe,<br/>an object (keys 1-512) containing the values for a single universe or<br/>an object (any numeric keys) containing objects (keys 1-512) containing an universe each. | yes, for action `save` |
95+
96+
#### Output for single universe:
97+
98+
| Property | Description |
99+
| ---------- | --------------------------------------------------------------------------------------------------------------------------------------- |
100+
| `universe` | ID of the universe the package is addressed to when a single universe is used. (`number`) |
101+
| `payload` | Array containing the dmx values as **percentage** by dmx channel. DMX-Channel `1` starts at key `1`, not `0`. (`Array<number, number>`) |
102+
| `scene` | The scene that is played (`number`) |
103+
| `reset` | Identifies a reset message for action `reset`, otherwise it does not exist. (`true`) |
104+
105+
#### Output for multiple universes:
106+
107+
| Property | Description |
108+
| ---------- | --------------------------------------------------------------------------------------------------------------------------------- |
109+
| `universe` | (`undefined`) |
110+
| `payload` | Object containing one object per universe. DMX-Channel `1` starts at key `1`, not `0`. (`object<number, object<number, number>>`) |
111+
| `scene` | The scene that is played (`number`) |
112+
| `reset` | Identifies a reset message for action `reset`, otherwise it does not exist. (`true`) |

‎src/sacn/scene-controller.js‎

Lines changed: 31 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)