API v4

Lua

The system namespace A collection of Lua variables and functions collected together into a group (e.g. system contains system.hardware_type and system.channel_capacity etc.) has the following properties:

capacity = system.channel_capacity

boot_time = system.last_boot_time.time_string

HTTP

GET /api/system

Returns an object with the following properties:

JavaScript

get_system_info(callback)

Returns an object with the same properties as in the HTTP call

Query.get_system_info( function(system){

   var capacity = system.channel_capacity

}

Lua

get_current_project()

Returns an object with the following properties:

project_name = get_current_project().name

HTTP

GET /api/project

Returns an object with the following properties:

JavaScript

get_project_info(callback)

Returns an object with the same properties as in the HTTP call

Query.get_project_info( function(project){

 var author = project.author

}

Lua

get_current_replication()

Returns an object with the following properties:

rep_name = get_current_replication().name

HTTP

GET /api/replication

Returns an object with the following properties:

JavaScript

get_replication(callback)

Returns an object with the same properties as in the HTTP call

Lua

get_location()

Returns an object with the following properties:

lat = get_location().lat

HTTP

Not currently available.

JavaScript

Not currently available.

Lua

The protocol_interface namespace has the following properties:

if protocol_interface.has_interface == true then

end

HTTP

Not currently available.

JavaScript

Not currently available.

Lua

The time namespace A collection of Lua variables and functions collected together into a group (e.g. system contains system.hardware_type and system.channel_capacity etc.) has the following functions which return a DateTime object

• get_current_time()
• get_sunrise()
• get_sunset()
• get_civil_dawn()
• get_civil_dusk()
• get_nautical_dawn()
• get_nautical_dusk()
• get_new_moon()
• get_first_quarter()
• get_full_moon()
• get_third_quarter()

and the following properties

Each function returns a DateTime object, with the following properties:

current_hour = time.get_current_time().hour

HTTP

GET /api/time

Returns an object with the following properties:

JavaScript

get_current_time(callback)

Returns an object with the same properties as in the HTTP call

Query.get_current_time( function(time){

 var uptime = time.uptime

}

Lua

get_timeline(timelineNum)

Returns a single Timeline object for the timeline with user number timelineNum.

The returned object has the following properties

tl = get_timeline(1)

name = tl.name

state = tl.state

if (tl.source_bus == TCODE_1) then

    -- do something

end

HTTP

GET /api/timeline[?num=timelineNumbers]

• num can be used to filter which timelines are returned and can be a single number or a string representing the required timelines (e.g. "1,2,5-9")

Returns an object with the following properties:

Each timeline object contains the following properties:

JavaScript

get_timeline_info(callback[, num])

• num can be used to filter which timelines are returned and is defined as a JSON object which can contain a single number or a string representing the required timelines (e.g. "1,2,5-9")

Returns an array of timelines in the same way as the HTTP call

Query.get_timeline_info( function(t){

 var name = t.timelines[0].name //name of the first timeline

}, {"num":"1-4"})

Lua

get_scene(sceneNum)

Returns a single Scene object for the Scene with user number SceneNum.

The returned object has the following properties

scn = get_scene(1)

name = scn.name

state = scn.state

HTTP

GET /api/scene[?num=sceneNumbers]

num can be used to filter which scenes are returned and can be a single number or array

Returns an object with the following properties:

Each scene object contains the following properties:

JavaScript

get_scene_info(callback[, num])

filter may contain a num property which is used to filter which scenes are returned

Returns an array of scenes in the same way as the HTTP call

Query.get_scene_info( function(s){

 var name = s.scenes[0].name //name of the first timeline

}, {"num":"1-4"})

Lua

get_group(groupNum)

Returns a Group object for the group with user number groupNum.

The returned object has the following properties:

grp = get_group(1)

name = grp.name

HTTP

GET /api/group[?num=groupNumbers]

num can be used to filter which groups are returned and can be a single number or array

Returns an object with the following properties:

Each group object contains the following properties:

JavaScript

get_group_info(callback[, num])

filter may contain a num property which is used to filter which groups are returned

Returns an array of groups in the same way as the HTTP call

Query.get_group_info( function(g){

 var name = g.groups[0].name //name of the first timeline

}, {"num":"1-4"})

Lua

get_current_controller()

Returns either the controller, the script, or module it is being run on.

get_network_primary()

Returns the controller which is currently the network primary.

Both return an object containing the following properties:

cont = get_current_controller()

name = cont.name

is_controller_online(controllerNumber)

Returns true if the controller with user number controllerNum has been discovered, and false otherwise

if (is_controller_online(2)) then

  log("Controller 2 is online")

else

   log("Controller 2 is offline")

end

HTTP

GET /api/controller

Returns an object with the following properties:

Each controller object contains the following properties:

JavaScript

get_controller_info(callback)

Returns an array of controllers in the same way as the HTTP call

Query.get_controller_info( function(controller){

 var name = controller[0].name // name of the first controller

}

Lua

get_temperature()

Returns an object with the following properties

temp = get_temperature()

log(temp.ambient_temp)

HTTP

GET /api/temperature

Returns an object with the following properties:

JavaScript

get_temperature(callback)

Returns an object with the same properties as in the HTTP call

Query.get_temperature( function(temp){

 var ambient = temp.ambient_temp // ambient temperature of the controller

}

Lua

get_rio(type, num):get_input(inputNum)

• type can be RIO80, RIO44 or RIO08
• num is the remote device number
• inputNum is the number of the input

Returns a boolean if the input is set to Digital or Contact Closure, or an integer if the input is set to Analog.

rio = get_rio(RIO44, 1)

input = rio:get_input(1)

get_rio(type, num):get_output(outputNum)

• type can be RIO80, RIO44 or RIO08
• num is the remote device number
• outputNum is the number of the output

Returns a boolean showing the current state of the output.

rio = get_rio(RIO44, 1)

output_state = rio:get_output(1)

get_bps(num):get_state(buttonNum)

• num is the BPS number
• buttonNum is the number of the button

Returns the state of the button, which can be RELEASED, PRESSED, HELD or REPEAT

bps = get_bps(1)

btn = bps:get_state(1)

HTTP

GET /api/remote_device

Returns an array of all remote devices in the project.

The returned object has the following structure

Each Remote Device object contains the following properties:

The Output object has the following properties:

The Input object has the following properties:

JavaScript

get_remote_device_info(callback)

Returns an array of all remote devices in the project with the same properties as in the HTTP call.

Query.get_remote_device_info( function(remote){

 var type = remote[0].type // type of the first remote device

}

Lua

get_text_slot(slotName)

• slotName is the name of the text slot

Returns the value of slotName

log(get_text_slot("test_slot"))

HTTP

GET /api/text_slot[?names=slotNames]

slotNames can be used to filter which text slots are returned and can be a single name or array

The returned object has the following structure

Each Text Slot object contains the following properties:

JavaScript

get_text_slot(callback[, filter])

filter may contain a names property which is used to filter which text slot values are returned

Returns an array of all text slots in the project with the same properties as in the HTTP call.

Query.get_text_slot( function(text){

 var value = text[0].value // value of the first text slot

}, {names: "test_slot1", "test_slot2"})

Lua

Not currently available.

HTTP

GET /api/log

The returned object has the following structure

JavaScript

Not currently available.

Lua

Not currently available.

HTTP

GET /api/protocol

Returns all the universes on the queried controller

The returned object has the following structure

Each Protocol object has the following properties:

Each Universe object has the following properties:

Each DMX Proxy object has the following properties:

The properties of the Universe Key object depends upon the type:

For DMX, Pathport, sACN and Art-Net:

For KiNET:

JavaScript

get_protocols(callback)

Lua

get_dmx_universe(idx)

get_artnet_universe(idx)

get_pathport_universe(idx)

get_sacn_universe(idx)

• idx is the required universe number

get_kinet_universe(power_supply_num, port_num)

• power_supply_num is the power supply to return the output from
• port_num is the port to return the output from

These all return a Universe object, which has the following function

get_channel_value(chnl)

• chnl is the channel to get the value from

uni = get_dmx_universe(1) -- get DMX Universe 1

level = uni:get_channel_value(1) -- get channel 1 from the returned universe

HTTP

GET /api/output?universe=universeKey

• universeKey is a string in the form protocol:index for DMX, Pathport, sACN and Art-Net, protocol:kinetPowerSupplyNum:kinetPort for KiNET, protocol:remoteDeviceType:remoteDeviceNum for RIO DMX and protocol:remoteDeviceNum:port for EDN.
• protocol can be dmx, pathport, sacn, art-net, kinet, rio-dmx or edn
• remoteDeviceType can be rio08, rio44 or rio80

The returned object has the following structure

JavaScript

get_output(universeKey, callback)

• universeKey can be either a string, or an object containing protocol and either index, kinet_power_supply_num and kinet_port or remote_device_type and remote_device_num as received from get_protocols

Query.get_output({protocol:KINET, kinet_port:1, kinet_power_supply_num:1}, function(u){

})

Query.get_output({protocol:DMX, num:1}, function(u){

})

Query.get_output("dmx:1", function(u){

})

Returns an object with the same structure as in the HTTP call

Lua

get_input(idx)

Returns the value of the controllers input as a boolean or integer

in1 = get_input(1)

if in1 == true then

  log("Input 1 is digital and high")

elseif in1 == false then

  log("Input 1 is digital and low")

else

   log("Input 1 is analog at " .. in1)

get_dmx_input(chnl)

• chnl is the required channel number

Returns the value of the DMX input at channel chnl as an integer. If no DMX Input is detected, it will return nil.

HTTP

GET /api/input

The returned object has the following structure

The Input object has the following properties:

The DMX Input object has the following properties:

JavaScript

Not currently available.

Lua

Not currently available.

HTTP

GET /api/trigger?[type=[triggerType]]

• triggerType is a string defining the trigger types to be returned.

The returned object has the following structure

The Trigger object has the following properties:

The Condition and Action objects have the following properties:

JavaScript

Not currently available.

Lua

Not currently available.

HTTP

GET /api/lua?variables=luaVariables

Returns an object containing all the Lua variables requested and their values.

JavaScript

get_lua_variables(luaVariables, callback)

Returns an object containing all the Lua variables requested and their values.

Query.get_lua_variables("myVar", function(lua){

 var value = lua.myVar

}

Lua

get_trigger_variable(idx)

Returns the trigger variable at idx as a Variant object.

-- Use with a TPC Colour Move Trigger 

red = get_trigger_variable(1).integer

green = get_trigger_variable(2).integer

blue = get_trigger_variable(3).integer

-- Use with Serial Input "<s>\r\n"

input = get_trigger_variable(1).string

HTTP

Not currently available.

JavaScript

Not currently available.

Lua

get_resource_path(filename)

Returns a path to the resource filename.

dofile(get_resource_path("my_lua_file.lua"))

HTTP

Not currently available.

JavaScript

Not currently available.

Lua

On a Atlas

get_content_target(compositionNum)

On a Atlas Pro

get_content_target(compositionNum, type)

• compositionNum is the usernumber of the composition to return
• type is the type of target within the composition to return (PRIMARY, SECONDARY, OVERLAY_1, OVERLAY_2)

Returns a Content Target object with the following properties:

target = get_content_target(1)

current_level = target.master_intensity_level

target = get_content_target(1,PRIMARY)

current_angle = target.rotation_offset

HTTP

Not currently available.

JavaScript

Not currently available.

Lua

get_log_level()

Returns the current log level of the controller

get_syslog_enabled()

Returns true if Syslog is enabled, false otherwise

get_syslog_ip_address()

Returns the IP address of the Syslog server

get_ntp_enabled()

Returns true if NTP is enabled

get_ntp_ip_address()

Returns the IP address of the NTP server

HTTP

GET /api/config

Returns an object with the following properties:

JavaScript

get_config(callback)

Returns the controller's configuration

The returned object has the same structure as in the HTTP call

Lua

get_timeline(timelineNum):start()

HTTP

POST /api/timeline

{

  "action": "start",

  "num": timelineNum

}

JavaScript

Query.start_timeline({ "num": timelineNum}, callback)

Lua

get_scene(sceneNum):start()

HTTP

POST /api/scene

{

   "action": "start",

   "num": sceneNum

}

JavaScript

Query.start_scene({ "num": sceneNum}, callback)

Lua

get_timeline(timelineNum):release([fade])

HTTP

POST /api/timeline

{

  "action": "release",

  "num": timelineNum[,

  "fade": fade]

}

JavaScript

Query.release_timeline({ "num": timelineNum[, "fade": fade]}, callback)

Lua

get_scene(sceneNum):release([fade])

HTTP

POST /api/scene

{

  "action": "release",

  "num": sceneNum[,

  "fade": fade]

}

JavaScript

Query.release_scene({ "num": sceneNum[, "fade": fade]}, callback)

Lua

get_timeline(timelineNum):toggle([fade])

HTTP

POST /api/timeline

{

  "action": "toggle",

  "num": timelineNum[,

  "fade": fade]

}

JavaScript

Query.toggle_timeline({ "num": timelineNum[, "fade": fade]}, callback)

Lua

get_scene(sceneNum):toggle([fade])

HTTP

POST /api/scene

{

  "action": "toggle",

  "num": sceneNum[,

  "fade": fade]

}

JavaScript

Query.toggle_scene({ "num": sceneNum[, "fade": fade]}, callback)

Lua

get_timeline(timelineNum):pause()

HTTP

POST /api/timeline

{

  "action": "pause",

  "num": timelineNum

}

JavaScript

Query.pause_timeline({ "num": timelineNum}, callback)

Lua

get_timeline(timelineNum):resume()

HTTP

POST /api/timeline

{

  "action": "resume",

  "num": timelineNum

}

JavaScript

Query.resume_timeline({ "num": timelineNum}, callback)

Lua

pause_all()

HTTP

POST /api/timeline

{

 "action": "pause"

}

JavaScript

Query.pause_all(callback)

Lua

resume_all()

HTTP

POST /api/timeline

{

 "action": "resume"

}

JavaScript

Query.resume_all(callback)

Lua

release_all([fade,] [group])

release_all_timelines([fade,] [group])

release_all_scenes([fade,] [group])

HTTP

POST /api/release_all

POST /api/timeline

POST /api/scene

{

  "action": "release"[, (not required for release all)

  "group": group][,

  "fade": fade]

}

JavaScript

release_all_timelines({["fade": fade]}, callback)

release_all_scenes({["fade": fade]}, callback)

release_all({ ["fade": fade,] ["group": group] }, callback)

Lua

get_timeline(timelineNum):set_rate(rate)

HTTP

POST /api/timeline

{

  "action": "set_rate",

  "num": timelineNum,

  "rate": rate

}

JavaScript

Query.set_timeline_rate({"num": timelineNum, "rate": rate }, callback)

Lua

get_timeline(timelineNum):set_position(position)

HTTP

POST /api/timeline

{

 "action": "set_position",

  "num": timelineNum,

  "position": position

}

JavaScript

Query.set_timeline_position({"num": timelineNum, "position": position }, callback)

Lua

enqueue_trigger(num[,var...])

enqueue_trigger(1,1,2,"string")

force_trigger(num[, var...])

Enqueues a trigger without testing its conditions first (it will always be fired).

HTTP

POST /api/trigger

{

  "num": num[,

  "var": var...][,

  "conditions": test_conditions]

}

• num - the trigger number to enqueue
• var... - 0 or more variables to pass to the trigger
• test_conditions - Should the conditions on the trigger be tested?

JavaScript

Query.fire_trigger({"num": num[, "var": var...][, "conditions": test_conditions] }, callback)

• var... - 0 or more variables to pass to the trigger. If passing multiple variables, they must be a single string surrounded by single quotes ( ' ), string variables should be surrounded by double quotes ( " ).

Lua

Not currently available.

HTTP

POST /api/cmdline

{

  "input": chunk,

}

NOTE: returns "Executed" if successful, or an error string if not

JavaScript

Query.run_command({ "input": chunk }, callback)

NOTE: returns "Executed" if successful, or an error string if not

Lua

Not currently available.

HTTP

POST /api/reset

JavaScript

Not currently available.

Lua

Non-Atlas

get_group(groupNum):set_master_intensity(level[, fade[, delay]])

Atlas

get_content_target():set_master_intensity(level, [fade, [delay]])

Atlas Pro

get_content_target(compositionNum, type):set_master_intensity(level, [fade, [delay]])

get_group(1):set_master_intensity(128,3) -- master group 1 to 50% (128/255 = 0.5) in 3 seconds)

HTTP

Non-Atlas

POST /api/group

{

 "action": "master_intensity",

    "num": groupNum,

    "level": level,

   ["fade": fade,]

   ["delay": delay]

}

Atlas /Atlas Pro

POST /api/content_target

{

"action": "master_intensity",

"level": level,

["fade": fade,]

["delay": delay,]

"type": type

}

JavaScript

Non-Atlas

master_intensity({ "num": groupNum, "level": level, ["fade": fade,] ["delay": delay] }, callback)

Atlas /Atlas Pro

master_content_target_intensity({ "type":type, "level": level, ["fade": fade,] ["delay": delay] }, callback)

Query.master_intensity({"num":1,"level":"50:100","fade":3) -- master group 1 to 50% (50/100 = 0.5) in 3 seconds)

Lua

get_fixture_override(num)

get_group_override(num)

    :set_irgb(intensity, red, green, blue, [fade, [path]])

    :set_intensity(intensity, [fade, [path]])

    :set_red(red, [fade, [path]])

    :set_green(green, [fade, [path]])

    :set_blue(blue, [fade, [path]])

    :set_temperature(temperature, [fade, [path]])

ov = get_fixture_override(1) -- Get fixture 1

ov:set_irgb(255, 255, 0, 0) -- Set the fixture to Red

HTTP

PUT /api/override

{

   "target": target,

   "num": num,

   ["intensity": intensity,]

   ["red": red,]

   ["green": green,]

   ["blue": blue,]

   ["temperature": temperature,]

   ["fade": fade,]

   ["path": path]

}

Javascript

set_group_override({ "num": num, ["intensity": intensity,] ["red": red,] ["green": green,] ["blue": blue,] ["temperature": temperature,] ["fade": fade,] ["path": path] }, callback)

set_fixture_override({ "num": num, ["intensity": intensity,] ["red": red,] ["green": green,] ["blue": blue,] ["temperature": temperature,] ["fade": fade,] ["path": path] }, callback)

Query.set_fixture_override({ "num": 1, "intensity": 255, "red": 255, "green": 0, "blue": 0});

Lua

get_fixture_override(num)

get_group_override(num)

   :clear([fade])

clear_all_overrides([fade])

ov = get_fixture_override(1) -- Get fixture 1

ov:clear() -- Clear the override on fixture 1

HTTP

DELETE /api/override

{

   ["target": target,]

   ["num": objectNum,]

   ["fade": fade]

}

If num is not included, target is ignored and all overrides are cleared.

JavaScript

clear_group_overrides({ ["num" :num,] ["fade": fade] }, callback)

clear_fixture_overrides({ ["num" :num,] ["fade": fade] }, callback)

clear_overrides({ ["fade": fade] }, callback)

Query.clear_overrides({"fade":3})

Lua

set_text_slot(name, value)

set_text_slot("myTextSlot", "Hello World!")

HTTP

PUT /api/text_slot

{

   "name": name,

   "value": value

}

JavaScript

set_text_slot({"name": name, "value": value}, callback)

Query.set_text_slot("name:"myTextSlot", "value":"Hello World!")

Lua

get_bps(num):set_led(button, effect, [intensity], [fade])

get_bps(1):set_led(1,FAST_FLASH,255) -- Set button 1 on BPS 1 to Fast Flash at full intensity

HTTP

Not currently available.

Use Run Script or Enqueue Trigger

JavaScript

Not currently available.

Use Run Script or Enqueue Trigger

Lua

set_control_value(name, [index,] value[, emitChange])

set_control_value("slider001", 1, 128) -- set slider001 to half and don't fire associated triggers

HTTP

Not currently available.

Use Run Script or Enqueue Trigger

JavaScript

Not currently available.

Use Run Script or Enqueue Trigger

Lua

set_control_state(name, state)

set_control_state("slider001", "Green") -- set slider001 to a state called "Green"

HTTP

Not currently available.

Use Run Script or Enqueue Trigger

JavaScript

Not currently available.

Use Run Script or Enqueue Trigger

Lua

set_control_caption(name, caption)

set_control_caption("button001", "On") -- set button001's caption to "On"

HTTP

Not currently available.

Use Run Script or Enqueue Trigger

JavaScript

Not currently available.

Use Run Script or Enqueue Trigger

Lua

set_interface_page(number[, transition])

set_interface_page(4) -- change the page on the TPC's interface to page 4

HTTP

Not currently available.

Use Run Script or Enqueue Trigger

JavaScript

Not currently available.

Use Run Script or Enqueue Trigger

Lua

set_interface_enabled([enable])

set_interface_enabled(false) -- disable the TPC's touch screen

set_interface_enabled() -- enable the TPC's touch screen

HTTP

Not currently available.

Use Run Script or Enqueue Trigger

JavaScript

Not currently available.

Use Run Script or Enqueue Trigger

Lua

set_interface_locked([lock])

set_interface_enabled(false) -- disable the TPC's touch screen

set_interface_enabled() -- enable the TPC's touch screen

HTTP

Not currently available.

Use Run Script or Enqueue Trigger

JavaScript

Not currently available.

Use Run Script or Enqueue Trigger

Lua

get_content_target(compositionNum, type)

  :transition_rotation([offset], [count], [period], [delay], [useShortestPath])

  :transition_x_position([offset], [count], [period], [delay])

  :transition_y_position([offset], [count], [period], [delay])

tar = get_composition_target(1,PRIMARY)

tar:transition_x_position(10,1,5) -- Move 10 pixels right in 5 seconds

tar:transition_y_position(10,1,5) -- Move 10 pixels down in 5 seconds

tar:transition_rotation(90,1,5) -- Rotate by 90 degrees in 5 seconds

HTTP

Not currently available.

Use Run Script or Enqueue Trigger

JavaScript

Not currently available.

Use Run Script or Enqueue Trigger

Lua

get_adjustment(num)

  :transition_rotation([offset], [count], [period], [delay], [useShortestPath])

  :transition_x_position([offset], [count], [period], [delay])

  :transition_y_position([offset], [count], [period], [delay])

tar = get_adjustment(1)

tar:transition_x_position(10,1,5) -- Move 10 pixels right in 5 seconds

tar:transition_y_position(10,1,5) -- Move 10 pixels down in 5 seconds

tar:transition_rotation(90,1,5) -- Rotate by 90 degrees in 5 seconds

HTTP

Not currently available.

Use Run Script or Enqueue Trigger

JavaScript

Not currently available.

Use Run Script or Enqueue Trigger

Lua

Not currently available.

HTTP

POST /api/beacon

JavaScript

toggle_beacon(callback)

Query.toggle_beacon()

Lua

log([level, ]message)

HTTP

Not currently available.

Use Run Script or Enqueue Trigger

JavaScript

Not currently available.

Use Run Script or Enqueue Trigger

Lua

push_to_web(name, value)

myVar = 15

push_to_web("myVar", myVar) -- will push the object {"myVar": 15}

HTTP

Not currently available.

Use Run Script or Enqueue Trigger

JavaScript

Not currently available.

Use Run Script or Enqueue Trigger

Lua

Universe:park(channel, value)

get_dmx_universe(1):park(1,128) -- Park channel 1 of DMX Universe 1 at 128 (50%)

HTTP

POST /api/channel

{

    "universe": universeKey,

    "channels": channelList,

    "level": level

}

JavaScript

park_channel({ "universe": universeKey, "channels": channelList, "level": level }, callback)

park_channel({ "universe": "dmx:1","channels": 1, "level":128}); // Park channel 1 of DMX Universe 1 at 128 (50%)

Lua

Universe:unpark(channel)

get_dmx_universe(1):unpark(1) -- Unpark channel 1 of DMX Universe 1 (it will go back to normal output levels)

HTTP

DELETE /api/channel

{

    "universe": universeKey,

    "channels": channelList

}

JavaScript

park_channel({ "universe": universeKey, "channels": channelList }, callback)

park_channel({ "universe": "dmx:1","channels": 1}); //Unpark channel 1 of DMX Universe 1 (it will go back to normal output levels)

Lua

disable_output(protocol)

enable_output(protocol)

HTTP

POST /api/output

{

    "protocol": protocol,

    "action": action

}

JavaScript

disable_output({ "protocol": protocol }, callback)

enable_output({ "protocol": protocol }, callback)

disbale_output({ "protocol": "dmx"}); // Disable the DMX output

enable_output({ "protocol": "art-net"}); // Enable the Art-Net Output

Lua

Timeline:set_default_source()

Timeline:set_timecode_source(timecodeBus[, offset])

Timeline:set_audio_source(audioBus, band, channel[,peak])

HTTP

Not currently available.

Use Run Script or Enqueue Trigger

JavaScript

Not currently available.

Use Run Script or Enqueue Trigger

Lua

set_timecode_bus_enabled(bus[, enable])

• bus is the timecode bus to enable or disable (TCODE_1 ... TCODE_6)
• enable determines whether the bus should be enabled or disabled (boolean, default true)

HTTP

Not currently available.

Use Run Script or Enqueue Trigger

JavaScript

Not currently available.

Use Run Script or Enqueue Trigger

Lua

get_rio(type, num):set_output(outputNum, state)

• type can be RIO44 or RIO08 (RIO80 has no outputs)
• num is the remote device number
• outputNum is the number of the output
• state is the state to set the output to and can be any of: 0, 1, true, false, ON, OFF

HTTP

Not currently available.

Use Run Script or Enqueue Trigger

JavaScript

Not currently available.

Use Run Script or Enqueue Trigger

Lua

set_log_level(log_level)

Sets the log level of the controller to log_level

• log_level can be LOG_DEBUG, LOG_TERSE, LOG_NORMAL, LOG_EXTENDED, LOG_VERBOSE, LOG_CRITICAL or 0-5.

HTTP

Not currently available.

Use Edit Config

JavaScript

Not currently available.

Use Edit Config

Lua

Not currently available.

HTTP

POST /api/config

{

"ip": ipAddress,

"subnet_mask": subnetMask,

"gateway": gateway,

"dhcp_enabled": dhcpEnabled,

"name_server_1": dnsServer1IPAddress,

"name_server_2": dnsServer2IPAddress,

"http_port": httpPort,

"https_port": httpsPort,

"year": year,

"month": month,

"day": day,

"hour": hour,

"minute": minute,

"second": second,

"watchdog_enabled": watchdogEnabled,

"log_level": logLevel,

"syslog_enabled": syslogEnabled,

"syslog_ip": syslogIpAddress,

"ntp_enabled": ntpEnabled,

"ntp_ip": ntpIpAddress,

"password": password

}

If the response is 200 OK, the response body will be

{

"restart": restart

}

restart is a boolean. If true, the controller will reset imminently in order to apply the changes

JavaScript

edit_config(params, callback)

Sends a request to change the controller's configuration

params is an object of the same format as in the HTTP request

The callback parameter will contain the same object as a response to the HTTP request

Lua

Not currently available.

HTTP

Not currently available.

JavaScript

subscribe_timeline_status(callback)

Returns an object with the following properties:

Callback is used to define a function that should be called whenever the data is received

subscribe_timeline_status(function(t){

	alert(t.num + ": " + t.state)

})

Lua

Not currently available.

HTTP

Not currently available.

JavaScript

subscribe_scene_status(callback)

Returns an object with the following properties:

Callback is used to define a function that should be called whenever the data is received

subscribe_scene_status(function(s){

	alert(s.num + ": " + s.state)

})

Lua

Not currently available.

HTTP

Not currently available.

JavaScript

subscribe_group_status(callback)

Returns an object with the following properties:

Callback is used to define a function that should be called whenever the data is received

subscribe_group_status(function(g){

	alert(g.num + ": " + g.level)

})

Lua

Not currently available.

HTTP

Not currently available.

JavaScript

subscribe_remote_device_status(callback)

Returns an object with the following properties:

Callback is used to define a function that should be called whenever the data is received

subscribe_remote_device_status(function(r){

	alert(r.num + ": " + r.level)

})

Lua

Not currently available.

HTTP

Not currently available.

JavaScript

subscribe_beacon(callback)

Returns an object with the following properties:

Callback is used to define a function that should be called whenever the data is received

subscribe_beacon(function(b){

	if (b.on){

		alert("Beacon Turned On")

	else {

		alert("Beacon Turned Off")

	}	

})

Lua

Not currently available.

HTTP

Not currently available.

JavaScript

subscribe_lua(callback)

Returns an object with the following properties:

Callback is used to define a function that should be called whenever the data is received

subscribe_lua(function(l){

	key = Object.keys(l)[0]

	value = l.key

	alert(key + ": " + value)

})

Lua

See here.

HTTP

Not currently available.

JavaScript

Not currently available.

Lua

The DateTime object contains the following properties:

HTTP

Not currently available.

JavaScript

Not currently available.

Lua

digital_input_to_string()

button_state_to_string()

log(digital_input_to_string(get_input(1)))

str = button_state_to_string(get_bps(1):get_state(1))

HTTP

Not currently available.

JavaScript

Not currently available.