Output

Note

The endpoints listed on this page require a project to be loaded on the controller.

Methods

POST

Enable/disable the output of a selected protocol from the controller.

POST /api/output

Payload is a JSON object with the following attributes:

Attribute	Value Type	Description	Value Example
protocol	string	Protocol to disable. Options: dmx, sacn, art-net.	"art-net"
action	string	Whether to enable or disable output via the protocol.	"disable"

GET

Returns the lighting levels being output by the queried controller.

GET /api/output?universe=universeKey

universeKey is a string; see Universe Key String Format.

For example:

• GET /api/output?universe=dmx:1

Attribute	Value Type	Description	Value Example
channels	array	Array of string channel levels	["0","0"," "," ","253","255",...,"!0","+255"]
disabled	bool	Whether the output has been disabled	false

Channel Level Strings

A channel level string is formatted as follows:

Format	Description	Value Example
" "	Unpatched	"{val}"
"0"	Patched	"0"
"+{val}"	Parked	"+255"
"!{val}"	Overridden	"!255"

Universe Key String Format

A universe key string takes the form:

• protocol:index where:

  • protocol is dmx, sacn, or art-net;

  • index is the index of the output port, 1 or 2, matching the port on the Express controller.

For example:

• "dmx:1" refers to port 1 on the Express Controller