diff --git a/README.md b/README.md index 549df56546b7325c908bc9ca4644a65a81748e7c..1f7f0aba8a92035e829907329c345a59d83ce1e2 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,33 @@ # Schrankenwärter - -> Arduino Yun +Python basierter http-Server zur Steuerung der Festo-Ventilinsel (SE3). +## Ventilinsel +Die Ventilinsel der Firma Festo kann über eine einfache http-Schnittstelle (und +über das Modbus-TCP-Protokoll, das hier aber nicht verwendet wird) angesprochen +werden. Der "Schrankenwärter"-http-Server bietet nun als Mittelsmann eine REST-Schnittstelle +an, über die die Steuerventile der Insel gesteuert werden können. Außerdem ist die +Auswertung der Lagemelder der gesteuerten Ventile möglich, die ihrerseits von der Ventilinsel ausgewertet werden. + +## Installation + +## Kommunikation +Mit dem Server wird über eine REST-Schnittstelle an Port 9000 kommuniziert. + + +### Beispiele zur Kommunikation mit dem Server (Port 9000) + +```bash + curl -X PUT http://localhost:9000/valve/2/close -> Antwort: XXXXXX +``` + + +```bash + curl -X PUT http://localhost:9000/valve/17/open + + curl -X GET http://localhost:9000/valve/3/state + curl -X GET http://localhost:9000/valve/all/state +``` + + +> Arduino Yun \ No newline at end of file