sACN

This is the sACN plugin documentation.

Supported data types

• int

Data type	BOOL	INT	FLOAT	STRING
sACN::int	•	•	•	⤴

NOTE

INPUTS Boolean inputs are translated to sACN value 0 (when false) and 255 (when true) when the output type is int8, or sACN value 0 (when false) and 65536 (when true) when the output type is int16. Float values are converted to int values (int8 or int16) int16 values will take 2 sACN addresses: The mapping address as the MSB (most significant byte, or the coarse value) and the one address above that as the LSB (the least significant byte, or the fine value).

OUTPUTS An 8-bit sACN input address (int8) will send a boolean true if the value is greater than or equal to 138 (55%), and a boolean false when the value is less than or equal to 114 (45%).

Configuration options

The minimal device config when using the default options would be:

settings.yml

devices:
  - type: sACN
    name: sacn1
    options:
      ip: 10.0.0.9

This assumes that the universe to be used is 1. The ip address field can be omitted in which case the plugin will fall back to the loopback interface. When specified, the interface bound to the ip address will be used.

A complete / alternative config would look like this:

settings.yml

devices:
  - type: sACN
    name: sacn1
    options:
      interface: eth0
      universe: 1
      transmit: true
      ttl: 1
      name: dcontrol
      hold: false
      priority: 100

where

type

is always “sACN” as this is the name of this plugin.

name

unique arbitrary name.

options/ip

the ip address of the interface to be used (is overruled by the interface option if set)

options/interface

the interface to be used (overrules the ip address set)

options/universe

the universe to be used (defaults to 1)

options/transmit

transmit sACN (defaults to true). When set to false, no sACN will be transmitted (useful when only receiving data, not to pollute the network)

options/ttl

TTL value set on the outgoing sACN data (defaults to 1)

options/name

the name to be used as the visible source name when transmitting (defaults to dcontrol)

options/hold

hold the last known values in case the source disappears (defaults to true). When set to false, all channels will fall back to 0 when there are no sources left.

options/priority

set the transmit priority of the sACN universe (defaults to 100).

Metrics

The following metrics are exported by the sACN plugin. They are prefixed / namespaced with sacn_, and all of them have the label {instance:"plugin_name"} where plugin_name is the name specified in the settings.yml file with the name attribute.

NOTE

16bit channels have a single 16bit value with the address of the MSB (the lowest address, as they are defined in there mapping in settings.yml).

Filter Metrics Reset

More	Metric Name	Metric Type	Notes
	General
	connection_state	Gauge	The connection state of the powersoftX server.
	Values: -1 initial / undefined 0 connected 1 disconnected 2 connection error 3 error received 4 error sending
	sACN channel values
	rx_channel_value	Gauge	The current value for the input (rx) channel.
	Labels: {address="mapping_address"}
	tx_channel_value	Gauge	The current value for the input (tx) channel.
	Labels: {address="mapping_address"}