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 |
---|---|---|---|
|
string |
Protocol to disable. Options: |
|
|
string |
Whether to |
|
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 |
---|---|---|
|
string |
|
Otherwise a JSON object with the following attributes is returned:
Attribute |
Value Type |
Description |
Value Example |
---|---|---|---|
|
array |
Array of integer (0-255) channel levels |
|
|
bool |
Whether the output has been disabled by a Trigger Action |
|
Universe Key String Format#
A universe key string takes the form:
protocol:index
for protocolsdmx
,pathport
,sacn
,art-net
;protocol:kinetPowerSupplyNum:kinetPort
for protocolkinet
;protocol:remoteDeviceType:remoteDeviceNum
for protocolrio-dmx
;protocol:remoteDeviceType:remoteDeviceNum:port
for protocolsedn
,edn-spi
.
Where:
kinetPowerSupplyNum
is an integer;kinetPort
is an integer;remoteDeviceType
can berio08
,rio44
orrio80
,edn10
oredn20
;remoteDeviceNum
is an integer;port
is an integer.
For example:
"dmx:1"
"rio-dmx:rio44:1"