Beschreibung
Logikbaustein für Wasserstand und Abfluss von Pegeln der Wasserstraßen- und Schifffahrtsverwaltung des Bundes (WSV) über die REST-API von PEGELONLINE. Bis zu 5 Pegel werden in einer Anfrage abgefragt. Jeder Pegel hat eine eigene Warnschwelle, die Hysterese gilt für alle Pegel gemeinsam. Geeignet ist das z. B. als Hochwasserwarnung für Keller, Garage oder Bootssteg.
Die API braucht keinen Key und keine Anmeldung.
- Gerät
- Gira X1
- Version
- 1.0.0
- Lizenz
- Ein Schlüssel je X1 (MAC-Adresse), dauerhaft nutzbar
- Thema
- Daten aus dem Netz
Hinweis zur Schnittstelle: Der Baustein nutzt die Schnittstelle von PEGELONLINE (WSV). Ändert der Anbieter sie oder stellt sie ein, kann der Baustein eingeschränkt oder gar nicht mehr funktionieren, bis er angepasst ist. Wir passen ihn nach Möglichkeit an, einen Anspruch darauf gibt es nicht.
Anleitung
Pegel finden
Pegel werden über ihre UUID (eindeutige Kennung aus Ziffern, Buchstaben und Bindestrichen) angegeben, weil Nummern und Namen sich ändern können. Die UUID findet man
- in der Pegeltabelle von PEGELONLINE, oder
- in der Stationsliste einer Wasserstraße im Browser, z. B.
https://www.pegelonline.wsv.de/webservices/rest-api/v2/stations.json?waters=ELBE(uuidundlongnameder Station).
Beispiel: Elbe, Pegel Dresden: 70272185-b2b3-4178-96b8-43bea330dcae.
Abfrageintervall
Abgefragt wird, wenn der Eingang „Trigger“ den Wert 1 bekommt. Die Pegel melden ihre Messwerte im 15-Minuten-Raster, häufiger abzufragen bringt nichts. Der Baustein ignoriert einen Trigger, der weniger als 5 Minuten nach der letzten Abfrage kommt, den Grund zeigt dann „Debug“. Sinnvoll ist ein Trigger alle 15 Minuten.
Parameter
| Parameter | Bedeutung |
|---|---|
| Anzahl Pegel | 1 bis 5, Vorgabe 1. So viele Pegel und Ausgangsgruppen gibt es |
| Pegel-ID i (UUID) | UUID des i-ten Pegels. Fehlende oder ungültige IDs meldet die Projektprüfung im GPA (Gira Projekt Assistent) |
| Bezeichnung Pegel i (ausgeblendet) | Name für den Ausgang „Name i“. Leer = Name des Pegels laut WSV |
| Warnschwelle Pegel i in cm (0 = keine Warnung) | Wasserstand, ab dem „Warnung i“ eingeschaltet wird |
| Hysterese in cm | Vorgabe 5, gilt für alle Pegel. Die Warnung geht erst aus, wenn der Wasserstand unter „Schwelle minus Hysterese“ fällt. Verhindert Flackern um die Schwelle |
| Messwert veraltet nach Minuten (ausgeblendet) | Ist eine Messung älter, gilt sie als veraltet (Vorgabe 60, mindestens 15) |
| Lizenzschlüssel | Schlüssel für diesen X1, siehe „Lizenz“ |
Der Wasserstand (W) wird in cm über dem Nullpunkt des jeweiligen Pegels gemessen, nicht über dem Meeresspiegel. Die Schwelle muss also je Pegel passend gewählt werden, am besten anhand der Kennwerte auf der Seite des Pegels bei PEGELONLINE, z. B. des mittleren Hochwassers (MHW).
Ausgänge
| Ausgang | Bedeutung |
|---|---|
| Name i | Bezeichnung oder Name des Pegels |
| Gewässer i (ausgeblendet) | Name des Gewässers, z. B. ELBE |
| Wasserstand i in cm | Aktueller Wasserstand (W). Fehlt eine Messung, bleibt der letzte Wert stehen und „Veraltet i“ wird 1 |
| Abfluss i in m³/s (ausgeblendet) | Aktueller Abfluss (Q). 0, wenn der Pegel keinen Abfluss misst |
| Messzeit i (ausgeblendet) | Zeit der Messung, TT.MM.JJJJ HH:mm (Ortszeit, 24 Stunden) |
| Warnung i | 1, wenn der Wasserstand die Warnschwelle erreicht hat (bis er unter Schwelle minus Hysterese fällt) |
| Veraltet i (ausgeblendet) | 1, wenn die Messung älter als „Messwert veraltet nach“ ist oder fehlt |
| Zustand i (low/normal/high) (ausgeblendet) | Einordnung laut WSV gegenüber Niedrig- und Hochwasser, so wie PEGELONLINE sie liefert: low (niedrig), normal, high (hoch), unknown (unbekannt) u. a. Leer, wenn keine Messung vorliegt |
| Eine Warnung aktiv | 1, wenn mindestens eine Warnung eingeschaltet ist |
| Höchster Wasserstand in cm (ausgeblendet) | Höchster Wasserstand der Pegel mit aktueller Messung. Pegel ohne Messung oder nicht gefundene Pegel zählen nicht mit |
| Letzte Abfrage (ausgeblendet) | Zeit der letzten erfolgreichen Abfrage, TT.MM.JJJJ hh:mm:ss |
| JSON (ausgeblendet) | Alle gefundenen Pegel als JSON-Liste (id, name, gewaesser, wasserstand_cm, abfluss_m3s, messzeit, warnung, veraltet, zustand). Fehlt eine Messung, steht dort null |
| Lizenzstatus, Debug | Lizenzprüfung, Ergebnis bzw. Fehler der letzten Abfrage |
Ausgeblendete Parameter und Ausgänge lassen sich im GPA am Baustein einblenden.
Fehlerverhalten
- Bei Verbindungsproblemen oder HTTP-Fehlern bleiben die Ausgänge auf dem letzten Stand, der Grund steht unter „Debug“.
- Eine unbekannte Pegel-ID beantwortet PEGELONLINE mit einer leeren Liste. „Debug“ nennt dann die nicht gefundene ID, die Ausgänge dieses Pegels bleiben stehen.
- Bei einer veralteten Messung ändert der Baustein die Warnung nicht: weder ein neuer Alarm noch eine Entwarnung aus alten Daten. „Veraltet i“ zeigt den Ausfall an und lässt sich z. B. auf eine Störungsmeldung legen.
Datenquelle
Die Daten kommen von der Wasserstraßen- und Schifffahrtsverwaltung des Bundes (WSV) und stehen unter der Datenlizenz Deutschland – Zero – Version 2.0. Es sind ungeprüfte Rohdaten ohne Gewähr für Richtigkeit, Aktualität und Vollständigkeit. Der Baustein darf deshalb nur als Zusatzinformation dienen und ersetzt keine amtliche Hochwasserwarnung.
Lizenz
Der Lizenzschlüssel wird im GPA im Parameter „Lizenzschlüssel“ eingetragen. Der Baustein prüft ihn beim Start auf dem X1, offline und gebunden an die MAC-Adresse des X1. Der Ausgang „Lizenzstatus“ zeigt das Ergebnis, bei einem Schlüssel für ein anderes Gerät auch die MAC-Adresse dieses X1. Ohne gültigen Schlüssel fragt der Baustein nichts ab. In der Simulation des GPA am PC läuft er ohne Lizenzprüfung, damit sich Logikblätter testen lassen.
Läuft eine Testlizenz ab, ignoriert der Baustein ab dem nächsten Trigger alle Abfragen, bis ein neuer Schlüssel eingetragen ist. Die Ausgänge bleiben auf dem letzten Stand. Den Schlüssel erhältst du beim Kauf über smolabs.de.
Changelog
Version 1.0.0
- Erste Version.
Rezensionen
Es gibt noch keine Rezensionen.