ptServer

PT server

PT server je http server implementující REST API. Jeho účel je

• umožnit vzdálenou správu hJOPserveru,
• poskytnout rozhraní k řízení kolejiště pro studenty MENDELU.

S PT serverem se komunikuje ve formátu JSON. Veškerá dokumentace, jména endpointů, atributů a osttaně všeho jsou v češtině.

PT server je zakompilovaný v základní verzi hJOPserveru, avšak automaticky se nespouští. PT server nevyžaduje žádnou autentizaci, což by mělo být, vzhledem k vypnutému serveru by default, únosně bezpečné.

Funckcionalita

PT server umožňuje toto:

• dotazovat server na data a stav,
  • bloků,
  • hnacích vozidel,
• přestavít výhybku,
• řídit hnací vozidlo na základě adresy.

JSON data

TODO

Endpointy serveru

GET /bloky

• Endpoint vrací bloky.
• Parametry:

• stanice=\id -- vrací jen bloky v dané stanici

• typ=\typ -- vrací jen bloky daného typu

• stav=True/False -- jestli vrátit s bloky i jejich stav

  { "bloky": [ ... ] }

GET /bloky/id

GET /blokStav/id

PUT /blokStav/id

GET /stanice

GET /stanice/id

GET /loko

GET /loko/addr

GET /lokoStav/id

PUT /lokoStav/id