5.5.3 api io ctrl
Funkce /api/io/ctrl řídí stav logických výstupu zařízení. Funkce má povinný parametr port, který určuje řízený výstup a povinný parametr action definující akci provedenou nad spínačem (sepnutí, vypnutí).
Funkce je součástí služby I/O a v případě použití autentizace je nutné, aby uživatel měl přiřazené privilegium Vstupy a výstupy – řízení.
Pro tuto funkci lze použít metody GET nebo POST.
Parametry požadavku:
Parametr | Popis |
|---|---|
port | Povinný parametr definující identifikátor vstupu nebo výstupu. Identifikátory dostupných vstupů a výstupů lze získat pomocí funkce /api/io/caps. |
action | Povinný parametr definující akci (on – sepnutí výstupu, log.1, off – vypnutí výstupu, log.0). |
| response | Nepovinný parametr umožňující modifikovat odpověď interkomu tak, aby neobsahovala JSON zprávu, ale obyčejný text odpovídající tomuto parametru. |
Odpověď je ve formátu application/json a neobsahuje žádné parametry.
Příklad:
GET /api/io/ctrl?port=relay1&action=on
{
"success" : true
}
V případě použití parametru response odpověď interkomu neobsahuje zprávy json, server vrací odpověď typu text/plain se zadaným textem (zadaný text může být prázdný).
Příklad:
GET /api/io/ctrl?port=relay1&action=on&response=text text
GET /api/io/ctrl?port=relay1&action=on&response=