Status

Get the live status

GET/api/status

Open. Open to everyone who can reach Tempolight.

What is happening now: the music source, tempo, song part, beat, the effect, loudness, key and mood, the song, the pads, home, MQTT, and per device what is sent and the sound-to-light latency. The WebSocket sends the same object 4 times a second.

Responses

200OKapplication/json

type"status"

sourcestring

One of "song" "nowplaying" "browser" "capture" "djlink" "midiclock" "link" "metronome" "idle"

sourceLabelstring

fpsinteger

ledsinteger

uptimeinteger

Seconds since start.

effectstring

effectNamestring

stylestring

styleNamestring

bpmnumber | null

partstring

One of "calm" "build" "drop" "silent" "idle"

beatinteger | null

Beat in the bar, 0 to 3.

levelnumber

Loudness.

0 to 1

bandsarray | null

24 spectrum bands, with live audio.

keyobject | null

Show child attributes

keystring

modestring

namestring

confidencenumber

moodobject | null

Show child attributes

valencenumber

energynumber

namestring

hearsstring | null

vocalnumber | null

songobject | null

Show child attributes

memIdstring | null

namestring

playingboolean

posnumber

durnumber

bpmnumber

stylestring

dropsany

The drops the analysis found.

recognisedobject | null

Show child attributes

idstring

namestring

posnumber

durnumber

nowPlayingobject | null

See Now playing.

spotifyobject | null

See Spotify.

captureobject | null

Show child attributes

labelstring

runningboolean

errorstring | null

hearingobject

{via, sound, level, capture, output, problem, method}.

offsetMsnumber

The light timing in use.

timingobject

Light timing (see docs/internals/runtime-and-outputs.md).

Show child attributes

modestring

ahead: frames are drawn ahead and fast lights held back; reactive: live without beat prediction, nothing held back.

One of "ahead" "reactive"

lookaheadMsnumber

How far ahead frames are drawn for the lights: the slowest light's delay, at most capMs.

audioMsnumber

The sound's way in, made up for too (live).

leadMsnumber

All of it: lookahead, the sound's way in, half a frame and the render time.

capMsnumber

sloweststring | null

The slowest light's device id.

frameobject

Show child attributes

intervalMsnumber

jitterMsnumber

Standard deviation of the frame interval.

worstMsnumber

djlinkobject | null

Show child attributes

namestring

bpmnumber

beatInBarinteger

midiClockobject | null

MIDI clock being followed.

linkobject | null

Ableton Link session.

powerboolean

brightnessnumber

0 to 1

nightboolean

overlayobject

The live pads' state.

Show child attributes

strobeboolean

blackoutboolean

freezeboolean

holdboolean

A colour is held.

boostnumber

Brightness gain, 0 to 2.

forcedstring | null

One of "build" "drop" null

homeobject | null

Show child attributes

wakeobject | null

Show child attributes

phasestring

One of "pending" "rising" "snoozed" "holding" "ending"

startstring <date-time>

An ISO date and time.

endstring <date-time>

An ISO date and time.

progressnumber

0 to 1

snoozeUntilstring | null <date-time>

An ISO date and time.

nextWakestring | null <date-time>

An ISO date and time.

sleepobject | null

Show child attributes

startstring <date-time>

An ISO date and time.

endstring <date-time>

An ISO date and time.

progressnumber

0 to 1

leftinteger

Seconds left.

planobject | null

Show child attributes

namestring

indexinteger

nightboolean

fadingboolean

mqttobject | null

Show child attributes

statestring

One of "connected" "connecting" "reconnecting" "error" "off"

errorstring | null

phonesinteger

screenstring | null

mappingobject | null

Show child attributes

devicestring

ledinteger

perfobject

Show child attributes

modestring

settingstring

whystring | null

fpsnumber

frameMsnumber

cpunumber

dmxobject | null

{lasers: {on, why}, fog: {...}}.

devicesobject[]

Show child attributes

idstring

onlineboolean

sentinteger

usedinteger

ampsnumber

limitedboolean

latencyMsnumber | null

Sound to light.

latencyobject

Show child attributes

audioMsnumber

analysisMsnumber

networkMsnumber

frameMsnumber

offsetMsnumber

lightMsnumber

The light's own delay used (network + frame, or set by hand).

lightAutoboolean

latencyLevelstring

One of "good" "ok" "slow" "none"

timingobject

Show child attributes

modestring

One of "ahead" "reactive"

lightMsnumber

autoboolean

holdMsnumber

How long its frames are held back.

shownMsnumber | null

The delay left after light timing.

levelstring

One of "good" "ok" "slow" "none"

warningsobject[]

Show child attributes

kindstring

One of "offline" "wifi" "frames" "notlive" "power" "slow"

textstring

Request

curl 'http://localhost:8080/api/status'

const res = await fetch("http://localhost:8080/api/status");
const data = await res.json();
console.log(data);

import requests

res = requests.get(
    "http://localhost:8080/api/status",
)
print(res.json())

Response

{
  "type": "status",
  "source": "browser",
  "sourceLabel": "Browser audio",
  "fps": 60,
  "leds": 240,
  "uptime": 3600,
  "effect": "laser",
  "effectName": "Laser",
  "style": "party",
  "styleName": "Party",
  "bpm": 124,
  "part": "drop",
  "beat": 2,
  "level": 0.71,
  "power": true,
  "brightness": 0.8,
  "night": false,
  "overlay": {
    "strobe": false,
    "blackout": false,
    "freeze": false,
    "hold": false,
    "boost": 1,
    "forced": null
  },
  "devices": []
}