Lokální API

Lokální HTTP API

Hodiny poskytují přes Wi-Fi v lokální síti REST API. To Vám umožňuje číst a zapisovat všechna nastavení hodin bez použití cloudu.

Lokální API používá stejné názvy parametrů, rozsahy hodnot a konvence jako Cloud API – tento dokument popisuje pouze to, co je u lokálního rozhraní odlišné nebo specifické. Úplný přehled parametrů (názvy, povolené hodnoty, popisy) najdete v dokumentaci Cloud API.


Připojení

Hodiny spustí HTTP server na portu 88, jakmile mají Wi-Fi připojení. Není vyžadováno žádné ověření.

http://CLOCK_IP:88/

IP adresu hodin zjistíte v seznamu DHCP klientů Vašeho routeru nebo ji najdete v mobilní aplikaci.


REST endpointy

Všechna nastavení jsou dostupná přes jeden společný vzor URL:

http://CLOCK_IP:88/v1/parameter
Metoda Akce
GET Čtení aktuální hodnoty
POST Zápis nové hodnoty

Čtení nastavení

GET http://CLOCK_IP:88/v1/parameter

Příklad:

curl http://192.168.1.100:88/v1/transition

Odpověď:

{"ok": true, "status": 200, "value": 2}

Zápis nastavení

Novou hodnotu pošlete jako tělo požadavku. Přijímána jsou jak prostá celá čísla, tak JSON.

Prostá hodnota:

curl -X POST http://192.168.1.100:88/v1/transition -d '3'

JSON:

curl -X POST http://192.168.1.100:88/v1/transition \
  -H "Content-Type: application/json" \
  -d '{"value": 3}'

Odpověď:

{"ok": true, "status": 200, "value": 3}

Formát odpovědi

Všechny odpovědi jsou ve formátu JSON.

Pole Typ Popis
ok boolean true při úspěchu, false při chybě
status integer Stavový kód HTTP
value integer nebo string Aktuální hodnota (při úspěchu)
message string Popis chyby (při neúspěchu)

Chybové odpovědi

Stav Význam
404 Parametr nenalezen
405 Nesprávná metoda (čtení parametru určeného pouze pro zápis nebo zápis parametru určeného pouze pro čtení)
400 Hodnotu se nepodařilo nastavit

Parametry

Úplný seznam parametrů je zdokumentován v referenci Cloud API. Lokální API podporuje stejné parametry se stejnými úrovněmi přístupu (pouze pro čtení, pouze pro zápis, čtení i zápis).


Hodnoty jasu

Parametry jasu používají nelineární stupnici. API přijímá a vrací následující diskrétní hodnoty:

Hodnota API Popisek
1 Off
6 Very Low
71 Low
126 Medium
201 High
256 Full

To platí pro brightnessday i brightnessnight.