5.4.1 api switch caps
Funkce /api/switch/caps vrací aktuální nastavení a možnosti řízení spínačů. Funkce má volitelný parametr switch, který určuje spínač, jehož vlastnosti a nastavení se mají vrátit. Pokud parametr switch není uveden, funkce vrací stav všech spínačů.
Funkce je součástí služby Switch a v případě použití autentizace je nutné, aby uživatel měl přiřazené privilegium Spínače (sledování).
Pro tuto funkci lze použít metody GET nebo POST.
Parametry požadavku:
Parametr | Popis |
---|---|
switch | Volitelný parametr definující číslo spínače (obvykle 1 až 4). |
Odpověď je ve formátu application/json a obsahuje seznam spínačů (pole switches) a jejich aktuální nastavení. V případě použití parametru switch obsahuje pole switches právě jednu položku.
Parametr | Popis |
---|---|
switch | ID spínače (1 až 4) |
enabled | Řízení spínače je povoleno v konfiguračním webovém rozhraní. |
mode | Nastavený režim spínače (monostable, bistable) |
switchOnDuration | Doba sepnutí spínače v sekundách (jen pro monostabilní režim) |
type | Typ spínače (normal, security) |
Příklad:
GET /api/switch/caps { "success" : true, "result" : { "switches" : [ { "switch" : 1, "enabled" : true, "mode" : "monostable", "switchOnDuration" : 5, "type" : "normal" }, { "switch" : 2, "enabled" : true, "mode" : "monostable", "switchOnDuration" : 5, "type" : "normal" }, { "switch" : 3, "enabled" : false }, { "switch" : 4, "enabled" : false } ] } }