Output

Note

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

Functions

disable_output

Disable the output of a specified protocol from the controller. Propagates to all controllers in a project.

disable_output(params, callback)

params is expected to be an 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.	"parthport"

enable_output

Enable the output of a specified protocol from the controller. Propagates to all controllers in a project.

enable_output(params, callback)

params is expected to be an object with the following attributes:

Attribute	Value Type	Description	Value Example
protocol	string	Protocol to enable. Options: dmx, pathport, sacn, art-net, kinet, rio-dmx, edn, edn-spi.	"parthport"

get_output

Returns the lighting levels being output by the queried controller.

get_output(universeKey, callback)

Returns an object with the same attributes as in the HTTP GET response.

universeKey can be a string (see Universe Key String Format) or it can be an object with the following attributes:

Attribute	Value Type	Description
protocol	integer	Output protocol (see Enumerated Protocols)
index	integer	Required unless protocol is KINET, RIO_DMX or EDN
kinet_power_supply_num	integer	Only required if protocol is KINET
kinet_port	integer	Only required if protocol is KINET
remote_device_type	integer	Only required if protocol is RIO_DMX or EDN (see Enumerated Remote Device Types)
remote_device_num	integer	Only required if protocol is RIO_DMX or EDN
port	integer	Only required if protocol is EDN

For example:

Query.get_output({
    protocol: KINET,
    kinet_port: 1,
    kinet_power_supply_num: 1
  }, u => {
  console.log(u)
  }
)

Query.get_output({
    protocol: DMX,
    index: 1
  }, u => {
    console.log(u)
  }
)

Query.get_output("dmx:1", u => {
  console.log(u)
})

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"

Enumerated Protocols

Constants for protocols are defined in query.js as follows:

Name	Value
DMX	1
PATHPORT	2
ARTNET	4
KINET	8
SACN	16
DVI	32
RIO_DMX	64
EDN	128

Enumerated Remote Device Types

Constants for RIO types are defined in query.js as follows:

Name	Value
RIO80	101
RIO44	102
RIO08	103

Constants for EDN types are defined in query.js as follows:

Name	Value
EDN20	109
EDN10	110