Skip to content

Commit 1ced43e

Browse files
mutecmutec
committed
update readme documentation
1 parent 00c861f commit 1ced43e

File tree

1 file changed

+41
-20
lines changed

1 file changed

+41
-20
lines changed

‎README.md‎

Lines changed: 41 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
# sACN for Node-RED
22

3-
Simple Implementation of [sACN](https://artisticlicenceintegration.com/technology-brief/technology-resource/sacn-and-art-net/) (Streaming ACN) for [Node-RED](https://nodered.org).
3+
Simple Implementation
4+
of [sACN](https://artisticlicenceintegration.com/technology-brief/technology-resource/sacn-and-art-net/) (Streaming ACN)
5+
for [Node-RED](https://nodered.org).
46

57
## Requirements
68

7-
Required version of Node-RED: v3.1.6
9+
Required version of Node-RED: v4.0.5
810

9-
This package uses [`sacn`](https://www.npmjs.com/package/sacn) as library to interact by sACN.
11+
This package requires [`sacn`](https://www.npmjs.com/package/sacn) as library to interact by sACN.
1012

1113
## Installation
1214

@@ -27,17 +29,18 @@ This node can be used to read one or multiple universes send by sACN.
2729

2830
#### Parameters:
2931

30-
| Paremeter | Description | Possible Values | Default Value |
31-
| ---------- | ------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------- | ------------- |
32-
| 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_ |
33-
| mode | Defines whether the node returns the values of every read sACN package (direct mode), or merged values using HTP or LTP. | `direct`, `htp`, `ltp` | `htp` |
34-
| universe | The universe that is meant to be observed. | `\d+` (`1` to `63999`) | `1` |
35-
| port | The network port which should be used for reading sACN. | `\d+` | `5568` |
32+
| Paremeter | Description | Possible Values | Default Value | Mandatory |
33+
|------------|-------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------|------------------------------|-----------|
34+
| universe | The universe that is meant to be observed. | `\d+` (`1` to `63999`) | `1` | yes |
35+
| 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 |
36+
| output | Defines wether the node sends only changed values or the whole universe. | `full`, `changes` | `full` | yes |
37+
| 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 |
38+
| port | The network port which should be used for reading sACN. | `\d+` | _empty_ (defaults to `5568`) | no |
3639

3740
#### Output for direct-mode:
3841

3942
| Property | Description |
40-
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
43+
|------------|-------------------------------------------------------------------------------------------------------------------------------------------|
4144
| `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`) |
4245
| `source` | IP-Address of the sender. |
4346
| `priority` | Priority of the sender. (`1` to `200`) |
@@ -47,7 +50,7 @@ This node can be used to read one or multiple universes send by sACN.
4750
#### Output for merging-modes (HTP or LTP):
4851

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

@@ -57,17 +60,35 @@ This node can be used to send one universe using sACN.
5760

5861
#### Parameters:
5962

60-
| Paremeter | Description | Possible Values | Default Value |
61-
| ---------- | ------------------------------------------------------------------------- | -------------------------------------------------------------- | ------------- |
62-
| 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_ |
63-
| speed | Defines the frequency for sending sACN-packages | `once (0Hz)`, `24Hz`, `27Hz`, `30Hz`, `40Hz`, `44Hz` | `0Hz` |
64-
| universe | The universe that is meant to be observed. | `\d+` (`1` to `63999`) | `1` |
65-
| port | The network port which should be used for reading sACN. | `\d+` | `5568` |
66-
| priority | The priority that should be used for the sACN-sender. | `\d+` (`1` to `200`) | `100` |
67-
| priority | The name for the sACN-sender that should be displayed within the network. | _any string below 50 characters_ | `Node-RED` |
63+
| Paremeter | Description | Possible Values | Default Value | Mandatory |
64+
|-------------|---------------------------------------------------------------------------|----------------------------------------------------------------|------------------------------|-----------|
65+
| universe | The universe that is meant to be observed. | `\d+` (`1` to `63999`) | `1` | yes |
66+
| source-name | The name for the sACN-sender that should be displayed within the network. | _any string below 50 characters_ | `Node-RED` | yes |
67+
| speed | Defines the frequency for sending sACN-packages | `once (0Hz)`, `24Hz`, `27Hz`, `30Hz`, `40Hz`, `44Hz` | `0Hz` | yes |
68+
| priority | The priority that should be used for the sACN-sender. | `\d+` (`1` to `200`) | `100` | yes |
69+
| 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 |
70+
| port | The network port which should be used for reading sACN. | `\d+` | _empty_ (defaults to `5568`) | no |
6871

6972
#### Expected input:
7073

7174
| Property | Description |
72-
| --------- | --------------------------------------------------------------------------------------------------------------------------------------- |
75+
|-----------|-----------------------------------------------------------------------------------------------------------------------------------------|
7376
| `payload` | array containing the dmx values as **percentage** by dmx channel. DMX-Channel `1` starts at key `1`, not `0`. (`Array<number, number>`) |
77+
78+
### Scene-Controller
79+
80+
This node can be used to record scenes and play them afterwards.
81+
82+
#### Parameters:
83+
84+
| Paremeter | Description | Possible Values | Default Value | Mandatory |
85+
|-------------|---------------------------------------------------------------------------|----------------------------------------------------------------|---------------|-----------|
86+
87+
#### Expected input:
88+
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 |
94+
| `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` |

0 commit comments

Comments
 (0)