|
1 | | -# node-red-sacn |
2 | | -Implementation of sACN for Node-RED |
| 1 | +# sACN for Node-RED |
| 2 | +Simple Implementation of [sACN](https://artisticlicenceintegration.com/technology-brief/technology-resource/sacn-and-art-net/) (Streaming ACN) for [Node-RED](https://nodered.org). |
| 3 | + |
| 4 | +## Requirements |
| 5 | +Required version of Node-RED: v3.1.6 |
| 6 | + |
| 7 | +This package uses [`sacn`](https://www.npmjs.com/package/sacn) as library to interact by sACN. |
| 8 | + |
| 9 | +## Installation |
| 10 | +See the list below for the |
| 11 | +npm package names, or [search npm](https://www.npmjs.org/search?q=node-red-sacn). |
| 12 | +To install - either use the manage palette option in the editor, or change to your Node-RED user directory. |
| 13 | + |
| 14 | + cd ~/.node-red |
| 15 | + npm install @mysterycode/node-red-sacn |
| 16 | + |
| 17 | +Copyright MysteryCode and other contributors under [GNU GENERAL PUBLIC LICENSE Version 3](LICENSE). |
| 18 | + |
| 19 | +## Node Usage |
| 20 | +### sACN in |
| 21 | +This node can be used to read one or multiple universes send by sACN. |
| 22 | + |
| 23 | +#### Parameters: |
| 24 | +| Paremeter | Description | Possible Values | Default Value | |
| 25 | +|-------------|-------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------|---------------| |
| 26 | +| 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_ | |
| 27 | +| 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` | |
| 28 | +| universe | The universe that is meant to be observed. | `\d+` (`1` to `63999`) | `1` | |
| 29 | +| port | The network port which should be used for reading sACN. | `\d+` | `5568` | |
| 30 | + |
| 31 | +#### Output for direct-mode: |
| 32 | +| Property | Description | |
| 33 | +|------------|------------------------------------------------------------------------------------------------------------------------------------------| |
| 34 | +| `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`) | |
| 35 | +| `source` | IP-Address of the sender. | |
| 36 | +| `priority` | Priority of the sender. (`1` to `200`) | |
| 37 | +| `universe` | Id of the universe the package is addressed to. | |
| 38 | +| `payload` | array containing the dmx values as **percentage** by dmx channel. DMX-Channel `1` starts at key `1`, not `0`. (`Array<number, number>`) | |
| 39 | + |
| 40 | +#### Output for merging-modes (HTP or LTP): |
| 41 | +| Property | Description | |
| 42 | +|------------|------------------------------------------------------------------------------------------------------------------------------------------| |
| 43 | +| `universe` | Id of the universe the package is addressed to. | |
| 44 | +| `payload` | array containing the dmx values as **percentage** by dmx channel. DMX-Channel `1` starts at key `1`, not `0`. (`Array<number, number>`) | |
| 45 | + |
| 46 | +### sACN out |
| 47 | +This node can be used to send one universe using sACN. |
| 48 | + |
| 49 | +#### Parameters: |
| 50 | +| Paremeter | Description | Possible Values | Default Value | |
| 51 | +|------------|---------------------------------------------------------------------------|----------------------------------------------------------------|---------------| |
| 52 | +| 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_ | |
| 53 | +| speed | Defines the frequency for sending sACN-packages | `once (0Hz)`, `24Hz`, `27Hz`, `30Hz`, `40Hz`, `44Hz` | `0Hz` | |
| 54 | +| universe | The universe that is meant to be observed. | `\d+` (`1` to `63999`) | `1` | |
| 55 | +| port | The network port which should be used for reading sACN. | `\d+` | `5568` | |
| 56 | +| priority | The priority that should be used for the sACN-sender. | `\d+` (`1` to `200`) | `100` | |
| 57 | +| priority | The name for the sACN-sender that should be displayed within the network. | _any string below 50 characters_ | `Node-RED` | |
| 58 | + |
| 59 | +#### Expected input: |
| 60 | +| Property | Description | |
| 61 | +|------------|------------------------------------------------------------------------------------------------------------------------------------------| |
| 62 | +| `payload` | array containing the dmx values as **percentage** by dmx channel. DMX-Channel `1` starts at key `1`, not `0`. (`Array<number, number>`) | |
0 commit comments