panelServer ac

Automatic Control

Tento protokol slouží k připojení ovládacích systémů druhých stran. API umožňuje rozšiřovat funkce hJOP libovolným způsobem. Klient udržuje se serverem spojení přes Panel Server a získává data ze serveru pomocí REST API PT serveru. Klient může měnit stav serveru pouze v případě, kdy dispečer povolí jeho funkci.

Každý klient se hlásí ke konkrétnímu bloku AC na serveru identifikátorem tohoto bloku a autorizačním tokenem. Stejný token používá pro přístup k PT serveru.

Server → klient

-;AC;id;CONTROL;[START,STOP,PAUSE,RESUME]

• Dispečer spustil/zastavit AC

-;AC;id;AUTH;[ok,nok,logout];/err_code/,/err_msg/

• Odpověď na požadavek o autorizaci klienta
• id je ID AC.

-;AC;-;BLOCKS;CHANGE;id

• Blok s id id změnil svůj stav.
• Klient může zjistit nový stav pomocí PT serveru.

-;AC;-;BLOCKS;[REGISTER,UNREGISTER];id;[OK,ERR];/err_msg/

• Odpověd na požadavek o registraci/uvolnění bloku

-;AC;-;BLOCKS;LIST;{id1,id2,...}

• Odpověď na požadavek o zasílání seznamu registrovaných bloků

Klient → server

-;AC;id;LOGIN;access-token

• Požadavek na přihlášení k AC s id id.
• -;AC;AUTH vždy přijde jako odpověď na tento požadavek.

-;AC;id;LOGOUT

• Informace o odhlášení klienta z AC s id id.
• -;AC;AUTH vždy přijde jako odpověď na tento požadavek.
• Zprávu není nutné zasílat při odpojení klienta.

-;AC;id;CONTROL;DONE

• AC id je hotov.
• Klient chce zůstat připojený a chce dát dispečerovi najevo, že už skončil svou práci a je připraven na další.
• AC se tímto dostává do režimu STOP.
• Jako odpověď vždy přijde -;AC;CONTROL;STOP

-;AC;id;CONTROL;ERROR;DISPBOTTOM;msg

• Zobrazit v panelu chybovou hlášku msg.

-;AC;id;CONTROL;STATE;{line1,line2,...}

• Klient informuje dispečera o změně stavu AC.
• Toto je stav, který může zobrazit dispečer při vyvolání volby STAV?.
• Tuto zprávu lze zasílat, i když je AC neaktivní.
• Server si pamatuje poslední obdržený stav a ten posílá na vyžádání dispečerovi.

-;AC;id;CONTROL;FG-COLOR;color

• Klient žádá o změnu barvy symbolu AC na reliéfu na color.
• Viz specifikaci posílání barvy.
• Povolené barvy: red, green, blue, white, aqua (#00FFFF), yellow (#FFFF00), olive (#808000), teal (#008080).
• Zakázané barvy: fuchsia, #A0A0A0, black.
• Barvu je možné měnit, jen pokud je AC aktivní.
• Výchozí barva je žlutá a je nastavena vždy při aktivaci AC.

-;AC;-;BLOCKS;[REGISTER,UNREGISTER];{id1,id2,...}

• Požadavek na zasílání/zrušení zasílání změn stavů blok s vyjmenovanými id

-;AC;-;BLOCKS;LIST

• Požadavek na zasílání seznamu registrovaných bloků