MysteryCode / node-red-sacn

Implementation of sACN for Node-RED

sACN for Node-RED

Simple Implementation of sACN (Streaming ACN) for Node-RED.

Requirements

Required version of Node-RED: v3.1.6

This package uses sacn as library to interact by sACN.

Installation

See the list below for the npm package names, or search npm. To install - either use the manage palette option in the editor, or change to your Node-RED user directory.

cd ~/.node-red
npm install @mysterycode/node-red-sacn

Copyright MysteryCode and other contributors under GNU GENERAL PUBLIC LICENSE Version 3.

Node Usage

sACN in

This node can be used to read one or multiple universes send by sACN.

Parameters:

Paremeter	Description	Possible Values	Default Value
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
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
universe	The universe that is meant to be observed.	\d+ (1 to 63999)	1
port	The network port which should be used for reading sACN.	\d+	5568

Output for direct-mode:

Property	Description
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)
source	IP-Address of the sender.
priority	Priority of the sender. (1 to 200)
universe	Id of the universe the package is addressed to.
payload	array containing the dmx values as percentage by dmx channel. DMX-Channel 1 starts at key 1, not 0. (Array<number, number>)

Output for merging-modes (HTP or LTP):

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

sACN out

This node can be used to send one universe using sACN.

Parameters:

Paremeter	Description	Possible Values	Default Value
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
speed	Defines the frequency for sending sACN-packages	once (0Hz), 24Hz, 27Hz, 30Hz, 40Hz, 44Hz	0Hz
universe	The universe that is meant to be observed.	\d+ (1 to 63999)	1
port	The network port which should be used for reading sACN.	\d+	5568
priority	The priority that should be used for the sACN-sender.	\d+ (1 to 200)	100
priority	The name for the sACN-sender that should be displayed within the network.	any string below 50 characters	Node-RED

Expected input:

Property	Description
payload	array containing the dmx values as percentage by dmx channel. DMX-Channel 1 starts at key 1, not 0. (Array<number, number>)