Output#
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 |
---|---|---|---|
|
string |
Protocol to disable. Options: |
|
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 |
---|---|---|---|
|
string |
Protocol to enable. Options: |
|
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 |
---|---|---|
|
integer |
Output protocol (see Enumerated Protocols) |
|
integer |
Required unless |
|
integer |
Only required if |
|
integer |
Only required if |
|
integer |
Only required if |
|
integer |
Only required if |
|
integer |
Only required if |
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 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"
Enumerated Protocols#
Constants for protocols are defined in query.js as follows:
Name |
Value |
---|---|
|
1 |
|
2 |
|
4 |
|
8 |
|
16 |
|
32 |
|
64 |
|
128 |
Enumerated Remote Device Types#
Constants for RIO types are defined in query.js as follows:
Name |
Value |
---|---|
|
101 |
|
102 |
|
103 |
Constants for EDN types are defined in query.js as follows:
Name |
Value |
---|---|
|
109 |
|
110 |