5.4.3 api switch ctrl

Funkce /api/switch/ctrl se používá k ovládání spínačů.

Skupiny služeb a privilegií

Skupina služeb je Switch.
Skupina privilegií je Spínače (řízení).

Metody

GET
POST

Požadavek

Požadavek obsahuje parametry ve formátu URL (nebo application/x-www-form-urlencoded při použití POST).

Tabulka 1. Parametry požadavku

Název parametru	Povinný	Očekávané hodnoty	Výchozí hodnota	Popis
switch	Ano	Celé číslo definující spínač (obvykle 1 až 4)	–	Definuje, který spínač má být ovládán. Funkce api/switch/caps může sloužit ke zjištění počtu spínačů určitého zařízení.
action	Ano	Řetězec definující příkaz	–	Definuje, který příkaz bude pro spínač použit. Lze použít tyto příkazy: `on` – sepnutí spínače `off` – vypnutí spínače `trigger` – sepnutí monostabilního spínače, překlopení stavu bistabilního spínače `lock` – uzamčení spínače (uzamčený spínač je vypnutý a nedá se ovládat) `unlock` – odemknutí spínače (povolení normálního provozu) `hold` – přidržení sepnutého spínače (přidržený spínač je sepnutý, ale nedá se ovládat), jestliže je spínač uzamčen a zároveň přidržen, je vypnutý `release` – uvolnění spínače z přidržení (povolení normálního provozu)
response	Ne	Řetězec definující text, který má být vrácen místo standardní odpovědi JSON	–	Zařízení vrátí text uvedený v tomto parametru místo standardní odpovědi JSON.
timeout	Ne (zadává se při použití parametru `action=hold`)	Rozsah v sekundách 1–86 400.	–	Definuje dobu v sekundách, po které se spínač po přijetí příkazu `hold` automaticky opět uvolní.

Příklad požadavku

URL: https://192.168.1.1/api/switch/ctrl?switch=4&action=trigger&response=TEST

Odpověď

Úspěšná odpověď je ve formátu application/json (pokud není v parametru response uveden jiný text odpovědi).

Tabulka 2. Klíče odpovědi JSON

Klíč	Typické vrácené hodnoty	Popis
success	`true` nebo `false`	Jestliže byl příkaz proveden správně, je vrácená hodnota `true`, a jestliže nebylo možno dosáhnout požadovaného stavu, je `false` (např. když je spínač uzamčen a požadovaným stavem byl sepnutý spínač).

Příklad odpovědi

{ "success": true }

Když je vrácena hodnota false, odpověď obsahuje další informace. Chybový kód 14, "akce se nezdařila", znamená, že nebylo možno dosáhnout požadovaného výsledku (např. když je spínač uzamčen a byla požadována akce action=on). Příkaz ke změně typu operace (tj. přidržení, uzamčení) bude vždy úspěšný, protože typ operace se dá změnit kdykoli s výjimkou případu, kdy je spínač zakázán (zařízení v takovém případě vrátí na všechny příkazy chybu 14).