5.5.2 api io status

Funkce /api/io/status vrací aktuální stav logických vstupů a výstupů zařízení (portů). Funkce má volitelný parametr port, který určuje vstup/výstup, jehož stav se má vrátit. Pokud parametr port není uveden, funkce vrací stav všech vstupů a výstupů.

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 – sledování. 

Pro tuto funkci lze použít metody GET nebo POST.

Parametry požadavku:

Parametr

Popis

port

Volitelný 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.

Odpověď je ve formátu application/json a obsahuje seznam portů (pole ports) a jejich aktuální stav (položka state). V případě použití parametru port obsahuje pole ports právě jednu položku.

Příklad:

 GET /api/io/status
{
  "success" : true,
  "result" : {
    "ports" : [
      {
        "port" : "relay1",
        "state" : 0
      },
      {
        "port" : "relay2",
        "state" : 0
      }
    ]
  }
}