Output

Methods

POST

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

Action will propagate to all controllers in a project.

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, pathport, sacn, art-net, kinet, rio-dmx, edn, edn-spi.	"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

• GET /api/output?universe=rio-dmx:rio44:1

If the queried controller is an MSC 1, the universe is DMX 2, DMX Proxy has been enabled for a MTPC in the project and the MTPC is offline then this request will return a JSON object with the following attributes:

Attribute	Value Type	Value Example
proxied_tpc_name	string	"Controller 2""

Otherwise a JSON object with the following attributes is returned:

Attribute	Value Type	Description	Value Example
channels	array	Array of integer (0-255) channel levels	[0,0,0,0,0,0,0,0,0,255,255,255...255,0,255]
disabled	bool	Whether the output has been disabled	false

Universe Key String Format

A universe key string takes the form:

• protocol:index for protocols dmx, pathport, sacn, art-net;

• protocol:kinetPowerSupplyNum:kinetPort for protocol kinet;

• protocol:remoteDeviceType:remoteDeviceNum for protocol rio-dmx;

• protocol:remoteDeviceType:remoteDeviceNum:port for protocols edn, edn-spi.

Where:

• kinetPowerSupplyNum is an integer;

• kinetPort is an integer;

• remoteDeviceType can be rio08, rio44 or rio80, edn10 or edn20;

• remoteDeviceNum is an integer;

• port is an integer.

For example:

• "dmx:1"

• "rio-dmx:rio44:1"