Settings

Change settings

PATCH/api/settings
Admin. Needs an unlock token (x-tempolight-token) while a PIN lock is set; without a lock, anyone can call it.

Takes any part of the settings and answers them all: brightness, frame rate, light timing, low-power mode, ambient effect, sound capture, metronome, OSC, guest areas, location, night mode, text, MQTT (Home Assistant), Pro DJ Link, Ableton Link and DMX. The MQTT password is never sent back.

Request body application/json

brightnessnumber
0 to 1
fpsinteger
10 to 120
syncOffsetMsinteger

Light timing for the sound output playing now (or output), -500 to 500 ms.

outputstring

A sound output's key, for syncOffsetMs.

syncOffsetsmap of number | null

{key: ms}, or {key: null} to forget one.

performancestring
One of "auto" "full" "lite"
ambientstring
idleBrightnessnumber
0 to 1
idleAfterSecnumber
safeboolean
predictboolean
dropFlashboolean
variationsboolean

Drops change look every 2 bars (colour flip, mirror) between effect changes.

punchnumber

How hard the kick pumps the room in drops.

0 to 1
dynamicsnumber

How much brightness follows the song part.

0 to 1
audioSyncboolean
autoDiscoverboolean
setupDoneboolean
songMemoryboolean
moodColoursboolean
requestsboolean
showsboolean
hearingobject
captureobject
metronomeobject
oscobject
guestobject
locationobject | null
nightobject
textobject
mqttobject
djlinkobject
linkobject
dmxobject

Responses

200OKapplication/json
brightnessnumber
0 to 1
fpsinteger
10 to 120
syncOffsetMsinteger
-500 to 500
syncOffsetsobject

Light timing per sound output: {key: {ms, name, bt}}.

performancestring
One of "auto" "full" "lite"
ambientstring

An effect id or off.

idleBrightnessnumber
0 to 1
idleAfterSecnumber
1 to 600
safeboolean

Photosensitive-safe mode.

predictboolean
dropFlashboolean
variationsboolean

Drops change look every 2 bars (colour flip, mirror) between effect changes.

punchnumber

How hard the kick pumps the room in drops.

0 to 1
dynamicsnumber

How much brightness follows the song part.

0 to 1
audioSyncboolean
autoDiscoverboolean
setupDoneboolean
songMemoryboolean
moodColoursboolean
requestsboolean
showsboolean
hearingobject
captureobject
metronomeobject
oscobject
guestobject

What guests may do while a PIN lock is set.

locationobject | null
nightobject
textobject
mqttobject
djlinkobject
linkobject
dmxobject
effectPrefsmap of integer

Effect id: 1 liked, -1 banned.

homekitobject
nowPlayingobject
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 PATCH 'http://localhost:8080/api/settings' \
  -H 'content-type: application/json' \
  -d '{
  "fps": 50,
  "night": {
    "enabled": true,
    "from": "23:00",
    "to": "07:00"
  }
}'
Response
{
  "brightness": 0.8,
  "fps": 60,
  "performance": "auto",
  "ambient": "northern",
  "safe": false,
  "guest": {
    "effects": true,
    "scenes": true,
    "pads": true,
    "brightness": true
  },
  "location": null,
  "requests": true
}
Edit on GitHub