Lights & show

Trigger a live pad

POST/api/action

Guest area “pads”. Open unless a PIN lock is set and guests aren't allowed this area (settings.guest.pads); then it needs an unlock token.

A live pad: flash, strobe, blackout, freeze, hold a colour, boost, next effect, a drop now, a build-up, cancel, tap tempo, identify a device or shape, or the DMX fog pad. Also over the WebSocket, OSC and MQTT. Answers the pads' state.

Request body application/json

typestringrequired

One of "flash" "strobe" "blackout" "freeze" "hold" "boost" "next" "drop" "build" "cancel" "tap" "identify" "fog"

colorstring

flash, hold: the colour (none: white, or release the hold).

Pattern ^#[0-9a-fA-F]{6}$

onboolean

strobe, blackout, freeze, fog: on or off (left out: toggle).

valuenumber

boost: brightness gain 0 to 2.

0 to 2

secondsnumber

build: how long the build-up lasts (default 8).

devicestring

identify: a device id.

shapeinteger

identify: a shape index.

Responses

200OKapplication/json

strobeboolean

blackoutboolean

freezeboolean

holdboolean

A colour is held.

boostnumber

Brightness gain, 0 to 2.

forcedstring | null

One of "build" "drop" null

400The body isn't valid JSON, or a value is wrong.application/json

errorstringrequired

What went wrong, in a sentence for people.

403Locked, or not allowed.application/json

errorstringrequired

What went wrong, in a sentence for people.

Request

curl -X POST 'http://localhost:8080/api/action' \
  -H 'content-type: application/json' \
  -d '{
  "type": "flash",
  "color": "#ff0066"
}'

const res = await fetch("http://localhost:8080/api/action", {
  method: "POST",
  headers: { "content-type": "application/json" },
  body: JSON.stringify({
    "type": "flash",
    "color": "#ff0066"
  }),
});
const data = await res.json();
console.log(data);

import requests

res = requests.post(
    "http://localhost:8080/api/action",
    json={
        "type": "flash",
        "color": "#ff0066"
    },
)
print(res.json())

Response

{
  "strobe": false,
  "blackout": false,
  "freeze": false,
  "hold": false,
  "boost": 1,
  "forced": null
}

{
  "error": "Unknown action \"x\""
}

{
  "error": "Settings are locked. Unlock with the PIN in Settings."
}