State

Get the LED layout

GET/api/layout

Open. Open to everyone who can reach Tempolight.

Where every LED is, in the order the preview frames on the WebSocket use: positions, the shape each LED belongs to and each device's range.

Responses

200OKapplication/json

Ninteger

LEDs in all.

xnumber[]

ynumber[]

shapeinteger[]

Shape index per LED.

chainStartany

Where each device's LEDs start.

rangesobject[]

Show child attributes

devstring

startinteger

endinteger

shapesobject[]

Show child attributes

typestringrequired

One of "line" "pole" "free" "circle" "rect" "hex" "tri" "matrix" "points"

namestring

devstringrequired

The device id it belongs to.

countintegerrequired

LEDs, 1 to 8192.

1 to 8192

frominteger | null

Its first LED on the device; null: after the previous shape.

revboolean

rotnumber

startnumber

zonestring | null

ptsnumber[][]

Points [x, y] for lines; for points, one LED at each.

cxnumber

cynumber

sizenumber

wnumber

hnumber

colsinteger

rowsinteger

Request

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

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

import requests

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

Response

{
  "N": 0,
  "x": [
    0
  ],
  "y": [
    0
  ],
  "shape": [
    0
  ],
  "chainStart": null,
  "ranges": [
    {
      "dev": "string",
      "start": 0,
      "end": 0
    }
  ],
  "shapes": [
    {
      "type": "line",
      "name": "Desk strip",
      "count": 120,
      "dev": "d4k2x9",
      "rot": 0,
      "start": 0,
      "rev": false,
      "from": null,
      "zone": null,
      "pts": [
        [
          1.5,
          6
        ],
        [
          14.5,
          6
        ]
      ]
    }
  ]
}