LMixer scripting

Layer keywords

Create layer

A layer hold information for outputting data to a UDP listener. The layer have a length and can be combined with another layer using different mathematical operations.

Operations:

Example: Create a new layer that multiplies master with this. Default value is 1.

dimmer = layer(master, mul, 512, 1)

output

Output controls what data is sent to each controller. An output can only send one layer.

Example: Send the master layer to specified host on port 1234.

output("192.168.1.10", 1234, master)

artnet_output

Create a new output in the ArtNet1 format.

Example: Send the master layer in ArtNet format to specific host with universe set to 123.

artnet_output("192.168.1.10", 123, master)

input

Open a UDP port and bind data messages on that port to an existing layer.

Example: Listen on port 1234 and put the data into an existing layer.

additional_data = layer(nil, add, 512)
input(1234, additional_data)

Fixture keywords

fix

Create a new fixture with specified parameters. Fixtures can also be added into "groups" by adding them to a table in Lua.

Example: Add a new fixture with address 128 and 4 channels.

lamp1 = fix(128, 4)

Add two fixtures and append them to a group called lamps.

lamp1 = fix(128, 4)
lamp2 = fix(132, 4)
lamps = { lamp1, lamp2 }

range

Create several fixtures in a series and add them to a group.

Example: Create 10 fixtures with 3 channels, with an offset of 1.

pixels = range(10, 1, 3)

Effect keywords

<layer>:add

Add an effect to a layer.

Example: Add a new effect on 1 second to set lamp1 to values.

master:add(1000, set(lamp1, 255, 255, 0, 0))

dim

Fade a fixture from previous values to new values over a period of time.

Example: Dim lamp1 to specified values for 100ms.

dim(100, lamp1, 255, 0, 0, 0)

set

Set a fixture to the specified values.

Example: Set lamp1 to specified values.

set(lamp1, 255, 0, 0, 0)

cycle

Add an effect for each fixture in a group with a delay between each.

Example: Set each fixture in lamps to values with a delay of 100ms between each fixture.

cycle(lamps, 100, set, 255, 0, 0, 0)

rev

Reverse a group of fixtures to use them in backwards order. Is usually used inline with cycle command to do effects in reverse order.

Example: Reverse a group of fixtures called lamps.

rev(lamps)

even

Get a subset of fixtures in a group based on their index value. Usually used inline when specifying groups for an effect.

Example: Set all even index lights in lamps to values.

set(even(lamps), 255, 0, 0, 0)

odd

Get a subset of fixtures in a group based on their index value. Usually used inline when specifying groups for an effect.

Example: Set all odd index lights in lamps to values.

set(odd(lamps), 255, 0, 0, 0)

execute

Example: Run the dalicmd command on the server.

execute("dalicmd -g 255 -c 16")

run

Start a script by name. Normally this is used to repeat the current script by starting it again after some time. Can also be used to split common effects into separate script and then combining them.

Example: Execute the script called "rainbow".

run("rainbow")

start

Similar to run except it always executes.

Example: Execute the script called "rainbow".

start("rainbow")

play("blotet/dans_mitt.mp3")

stop_play()

Script keywords

Scripts are accessed from Scripts. in the global scope.

<script>:start

Runs a script, this is synchronous and will be executed instantly.

Example: Start rainbow instantly

Scripts.rainbow:start()

<script>:stop

Stops a script, this only affects run

Example: Stops rainbow

Scripts.rainbow:stop()

<script>:unstop

Unstops a script, this allows run to execute this script again

Example: Unstops rainbow

Scripts.rainbow:unstop()

<script>:is_stopped()

Checks if a script has been stopped, useful for having multiple script

Example: Checks if rainbow is stopped, and stops rainbow_roof if that is the case

if (Scripts.rainbow:is_stopped()) then
    Scripts.rainbow_roof:stop()
end