Script Conversion
The PharosProject Migration Tool can be used to convert a v1.x file into a v2.x file, and this should convert any scripting within projects to the updated Lua API, however the conversion table below can be used when writing new scripting from scratch:
| V1.X.X | V2.X.X | Notes |
|---|---|---|
| realtime.XXX | time.get_current_time().XXX |
|
| sunrise.XXX | time.get_sunrise().XXX |
|
| sunset.XXX | time.get_sunset().XXX |
|
| civil_dawn.XXX | time.get_civil_dawn().XXX |
|
| civil_dusk.XXX | time.get_civil_dusk().XXX |
|
| nautical_dawn.XXX | time.get_nautical_dawn().XXX |
|
| nautical_dusk.XXX | time.get_nautical_dusk().XXX |
|
| digital[index] | get_input(index) | Returns digital and analogue values |
| DMXIN[channel] | get_dmx_input(channel) |
|
| get_controller_number() | get_current_controller().number |
|
| set_timecode_source_enabled(source,enabled) | set_timecode_bus_enabled(source,enabled) |
|
| start_timeline(num) | get_timeline(num):start() |
|
| stop_timeline(num,time) | get_timeline(num):stop(time) |
|
| halt_timeline(num) | get_timeline(num):pause() |
|
| resume_timeline(num) | get_timeilne(num):resume() |
|
| set_timecode_source(num,source, offset) | get_timeline(num):set_timecode_source(source,offset) |
|
| set_timecode_source(num,source, band, channel, peak) | get_timeline(num):set_audio_source(source, band, channel, peak) |
|
| is_timeline_running(num) | get_timeline(num).is_running |
|
| is_timeline_onstage(num) | get_timeline(num).is_onstage |
|
| stop_all() | stop_all_timelines(fade) | fade is optional |
| set_intensity(fixture,value, time) | get_fixture_override(fixture):set_intensity(value,time) |
|
| set_red(fixture, value, time) | get_fixture_override(fixture):set_red(value, time) |
|
| set_green(fixture, value, time) | get_fixture_override(fixture):set_green(value, time) |
|
| set_blue(fixture, value, time) | get_fixture_override(fixture):get_blue(value, time) |
|
| clear_fixture(fixture, time) | get_fixture_override(fixture):clear() |
|
| clear_all(time) | clear_all_overrides(time) |
|
| get_dmxout(universe) | get_dmx_universe(universe) | if universe is 1 or 2 |
| get_dmxout(ARTNET + universe) | get_artnet_universe(universe) |
|
| get_dmxout(PATHPORT + universe) | get_pathport_universe(universe) |
|
| get_dmxout(SACN + universe) | get_sacn_universe(universe) |
|
| get_dmxout(get_kinet_universe(powerSupplyNum, portNum)) | get_kinet_universe(powerSupplyNum, portNum) |
|
| DMXOUT[channel] | get_XXX_universe(universe):get_channel_value(channel) | DMXOUT is object returned from get_dmxout(universe) |
| park(universe, channel, value) | get_XXX_universe(universe):park(channel, value) |
|
| unpark(universe, channel) | get_XXX_universe(universe):unpark(channel) |
|
| rio[input] | rio:get_input(input) | rio is object returned by get_rio |
| bps:set_LED(button,effect, intensity, fade) | bps:set_led(button,effect, intensity, fade) |
|
| variable[index] | get_trigger_variable(index) |
|
Please Note: These are only the functions that have changed between V1.x and V2.x. There are also newly added functions which can be used to provide additional functionality which wasn't previously available. These can be found here.