Skip to content

stephan192/hochwasserportal

Repository files navigation

hochwasserportal

hacs_badge Validate with hassfest HACS Action

Actively Maintained Code style: black Imports: isort

This Home Assistant integration started as integration for the Länderübergreifendes Hochwasser Portal (LHP), but due to the fact that the LHP locked their formerly open API in July 2023 this integration was rewritten to query the 16 state portals to get all information. The positive side effect, now more pegel are available, because the different state portals didn't report all their pegel to the LHP. The negativ side effect, some of the state portals need to be queried by web scraping and therefore need to be adjusted if the portal's design changes.

List of supported values

  • ✔️ Value mostly available. Check individual state portal because not all stream gauges report all values.
  • ❌ Value generally yet not available.
Prefix State Level Stage Flow Portal
BB Brandenburg ✔️ ✔️ ✔️ Pegelportal Brandenburg
BE Berlin ✔️ ✔️ Wasserportal Berlin
BW Baden-Württemberg ✔️ ✔️ ✔️ Hochwasservorhersagezentrale Baden-Württemberg
BY Bayern ✔️ ✔️ ✔️ Hochwassernachrichtendienst Bayern
HB Bremen ✔️ ✔️ Pegelstände Bremen
HE Hessen ✔️ ✔️ ✔️ Hochwasserportal Hessen
HH Hamburg ✔️ ✔️ Warndienst Binnenhochwasser Hamburg
MV Mecklenburg-Vorpommern ✔️ ✔️ ✔️ Pegelportal Mecklenburg-Vorpommern
NI Niedersachsen ✔️ ✔️ ✔️ NLWKN Pegelonline
NW Nordrhein-Westfalen ✔️ ✔️ Hochwassermeldedienst NRW
RP Rheinland-Pfalz ✔️ ✔️ ✔️ Hochwasservorhersagedienst - Landesamt für Umwelt Rheinland-Pfalz
SH Schleswig-Holstein ✔️ ✔️ ✔️ Hochwasser-Sturmflut-Information Schleswig-Holstein
SL Saarland ✔️ ✔️ Pegel Saarland
SN Sachsen ✔️ ✔️ ✔️ Landeshochwasserzentrum Sachsen
ST Sachsen-Anhalt ✔️ ✔️ ✔️ Landesportal Sachsen-Anhalt
TH Thüringen ✔️ ✔️ ✔️ Hochwassernachrichtenzentrale Thüringen

Notes

  • Not all stream gauges report all three values. If one or more values are not added check official site if stream gauge is down or if not which values are reported. Since v0.0.23 entities for unavailable values are by default not created to reduce the number of unnecessary entities in Home Assistant. To add the unavailable entities in anyway a checkbox during setup is available.
  • Some stream gauges are listed twice or even more often in pegel.md, because they are listed on more than one state portal. Select the one of your choice.
  • Level reports the actual water level (in German Pegelstand or colloquially Wasserstand). A value in centimetres, starting from 0 cm = Pegelnullpunktshöhe.
  • Stage reports the actual warning stage (in German depending on ferderal state e.g. Meldestufe in Bavaria, Alarmstufe in Brandenburg). A number between 0 (=no flood) and 4 (= very large flood).
  • Flow reports the actual flow rate (in German Abfluss or Durchfluss). A value in m³/s.

Setup

Installation via HACS

  • Ensure that HACS is installed
  • Search for and install the "hochwasserportal" integration
  • Restart Home Assistant

Manual installation

  • Copy the sources from ROOT_OF_THIS_REPO/custom_components/hochwasserportal to YOUR_HA_INSTALLATION/config/custom_components/hochwasserportal
  • Restart Home Assistant

Configuration

  • The integration can only be configured by using config flow.
  • Add the integration by pressing the "+ADD INTEGRATION" on the Settings - Integrations page and select "Länderübergreifendes Hochwasser Portal" from the drop-down menu.
  • Enter a valid pegel-ID. A full list of valid pegels can be found here.
  • For multiple locations, just repeat with each pegel-ID.

Result

Example 1