Skip to content

Commit

Permalink
Typo's and lay-out
Browse files Browse the repository at this point in the history
  • Loading branch information
physje committed Dec 1, 2023
1 parent d31799d commit 867d353
Show file tree
Hide file tree
Showing 37 changed files with 2,856 additions and 2,746 deletions.
16 changes: 6 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,24 +20,20 @@ This component can be installed in your Home Assistant with HACS.
4. Download _all_ the files from the `custom_components/waterinfo/` directory (folder) in this repository.
5. Place the files you downloaded in the new directory (folder) you created.
6. Restart Home Assistant
7. In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "waterinfo"
7. In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "Rijkswaterstaat Waterinfo"

## Configuration is done in the UI

You can configure and setup the Waterinfo integration in your integrations page, look for Waterinfo in the add integrations dialog.
You can configure and setup the Waterinfo integration in your integrations page, look for "Rijkswaterstaat Waterinfo" in the add integrations dialog.

To configure a sensor, you need to know the code for the location and the code for the measurement. An overview of which measurement is available for which location is given in the `docs`-folder. There are pages with the overview based on location (eg [Locations with a A](docs/location_A.md)) and pages with the overview based on measurement (eg [Measuements with a C](docs/measurement_C.md)).
To configure a sensor, you need to know the code for the location and the code for the measurement. Not all measurements are available at all locations. An overview of which measurement is available for which location is given in the `docs`-folder. There are pages with the overview based on location (eg [Locations with a A](docs/location_A.md)) and pages with the overview based on measurement (eg [Measuements with a C](docs/measurement_C.md)).

If you are for example are a windsurf-fan and you wants to make a sensor for the windspeed in the middle of the Lake IJssel, you need to know the waterinfo-code for that location and the waterinfo-code for the measurement.
On [Measuements with a W](docs/measurement_W.md) or [Locations with a F](docs/location_F.md) you can see that the measurement-code for **Windsnelheid Lucht t.o.v. Mean Sea Level in m/s** is _WINDSHD_ and the location-code for **Markermeer Midden -o** is _FL42o_ (both codes are case-sensitive).
In the same way on [Measuements with a T](docs/measurement_T.md) or [Locations with a T](docs/location_T.md) the codes for air-temperatur on the Terschelling can be found to be (measurement-code : _T_; location-code : _TERS_).
On [Measuements with a W](docs/measurement_W.md#windsnelheid-lucht-tov-mean-sea-level-in-ms) or [Locations with a F](docs/location_F.md#markermeer-midden--o) you can see that the measurement-code for **Windsnelheid Lucht t.o.v. Mean Sea Level in m/s** is _WINDSHD_ and the location-code for **Markermeer Midden -o** is _FL42o_ (both codes are case-sensitive). If you also want a sensor for the wave-heights at the same location, the location-code is the same (_FL42o_) and [Locations with a F](docs/location_F.md#markermeer-midden--o) tells you that the measurement-code for **Significante golfhoogte in het spectrale domein Oppervlaktewater golffrequentie tussen 30 en 500 mHz in cm** is _Hm0_.

In the same way on [Measuements with a T](docs/measurement_T.md) or [Locations with a T](docs/location_T.md) the codes for water-temperature on the Terschelling can be found to be _TERS_ (location-code) and _T_ (measurement-code).

## Known limitations

- This integration is translated into English and Dutch, the entity names and the data (from the API) are only available in Dutch.
- Sometimes the Rijkswaterstaat site is down for inexplicable reasons. At that moment, creating new sensors is impossible and sensors that have already exist will not be updated.

## Examples

t
- Sometimes the Rijkswaterstaat site is down for inexplicable reasons. At that moment, creating new sensors is impossible and sensors that have already exist will not be updated.
35 changes: 18 additions & 17 deletions docs/location_A.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
A | [B](location_B.md) | [C](location_C.md) | [D](location_D.md) | [E](location_E.md) | [F](location_F.md) | [G](location_G.md) | [H](location_H.md) | [I](location_I.md) | [J](location_J.md) | [K](location_K.md) | [L](location_L.md) | [M](location_M.md) | [N](location_N.md) | [O](location_O.md) | [P](location_P.md) | [Q](location_Q.md) | [R](location_R.md) | [S](location_S.md) | [T](location_T.md) | [U](location_U.md) | [V](location_V.md) | [W](location_W.md) | [X](location_X.md) | [Y](location_Y.md) | [Z](location_Z.md)
Locations : A | [B](location_B.md) | [C](location_C.md) | [D](location_D.md) | [E](location_E.md) | [F](location_F.md) | [G](location_G.md) | [H](location_H.md) | [I](location_I.md) | [J](location_J.md) | [K](location_K.md) | [L](location_L.md) | [M](location_M.md) | [N](location_N.md) | [O](location_O.md) | [P](location_P.md) | [Q](location_Q.md) | [R](location_R.md) | [S](location_S.md) | [T](location_T.md) | [U](location_U.md) | [V](location_V.md) | [W](location_W.md) | [X](location_X.md) | [Y](location_Y.md) | [Z](location_Z.md)
Measurements : [C](measurement_C.md) | [F](measurement_F.md) | [G](measurement_G.md) | [H](measurement_H.md) | [L](measurement_L.md) | [Q](measurement_Q.md) | [S](measurement_S.md) | [T](measurement_T.md) | [W](measurement_W.md) | [Z](measurement_Z.md)

# Locations with the letter A #


### A12 platform ###
## A12 platform ##
location-code : A12

Possible measurements :
Expand All @@ -13,57 +14,57 @@ Possible measurements :
* Waterhoogte berekend Oppervlaktewater t.o.v. Mean Sea Level in cm (measurement-code : WATHTBRKD)
* Windrichting Lucht t.o.v. ware Noorden in graad (measurement-code : WINDRTG)

### Schijndelse loop ###
## Schijndelse loop ##
location-code : AA03

Possible measurements :
* Debiet Oppervlaktewater m3/s (measurement-code : Q)

### Alblasserdam ###
## Alblasserdam ##
location-code : ALBL

Possible measurements :
* Stroomsnelheid Oppervlaktewater m/s (measurement-code : STROOMSHD)

### Almen ###
## Almen ##
location-code : ALME

Possible measurements :
* Waterhoogte Oppervlaktewater t.o.v. Normaal Amsterdams Peil in cm (measurement-code : WATHTE)
* Debiet Oppervlaktewater m3/s (measurement-code : Q)

### Amaliahaven ###
## Amaliahaven ##
location-code : AMHV

Possible measurements :
* Waterhoogte Oppervlaktewater t.o.v. Normaal Amsterdams Peil in cm (measurement-code : WATHTE)

### Amaliahaven ###
## Amaliahaven ##
location-code : AMLAHVN

Possible measurements :
* Waterhoogte berekend Oppervlaktewater t.o.v. Normaal Amsterdams Peil in cm (measurement-code : WATHTBRKD)

### Amerongen boven ###
## Amerongen boven ##
location-code : AMRB

Possible measurements :
* Waterhoogte Oppervlaktewater t.o.v. Normaal Amsterdams Peil in cm (measurement-code : WATHTE)
* Temperatuur Oppervlaktewater oC (measurement-code : T)

### Amerongen beneden ###
## Amerongen beneden ##
location-code : AMRO

Possible measurements :
* Waterhoogte Oppervlaktewater t.o.v. Normaal Amsterdams Peil in cm (measurement-code : WATHTE)

### Antwerps kanaalpand ###
## Antwerps kanaalpand ##
location-code : ANKA

Possible measurements :
* Waterhoogte Oppervlaktewater t.o.v. Normaal Amsterdams Peil in cm (measurement-code : WATHTE)

### Antwerps kanaalpand (b) ###
## Antwerps kanaalpand (b) ##
location-code : ANKAb

Possible measurements :
Expand All @@ -72,7 +73,7 @@ Possible measurements :
* Temperatuur Oppervlaktewater oC (measurement-code : T)
* Saliniteit Oppervlaktewater (measurement-code : SALNTT)

### Antwerps kanaalpand (o) ###
## Antwerps kanaalpand (o) ##
location-code : ANKAo

Possible measurements :
Expand All @@ -81,20 +82,20 @@ Possible measurements :
* (massa)Concentratie chloride in Oppervlaktewater mg/l (measurement-code : CONCTTE)
* Temperatuur Oppervlaktewater oC (measurement-code : T)

### Antwerpen ###
## Antwerpen ##
location-code : ANTW

Possible measurements :
* Waterhoogte Oppervlaktewater t.o.v. Normaal Amsterdams Peil in cm (measurement-code : WATHTE)

### Arnhem ###
## Arnhem ##
location-code : ARNH

Possible measurements :
* Waterhoogte Oppervlaktewater t.o.v. Normaal Amsterdams Peil in cm (measurement-code : WATHTE)
* Debiet Oppervlaktewater m3/s (measurement-code : Q)

### AWG platform ###
## AWG platform ##
location-code : AWG

Possible measurements :
Expand All @@ -112,11 +113,11 @@ Possible measurements :
* Deiningsenergie in het spectrale domein Oppervlaktewater golffrequentie tussen 30 en 100 mHz in cm2 (measurement-code : TE3)
* Significante deiningshoogte in het spectrale domein Oppervlaktewater golffrequentie tussen 30 en 100 mHz in cm (measurement-code : HTE3)

### Amelander Westgat platform ###
## Amelander Westgat platform ##
location-code : AWGPFM

Possible measurements :
* Waterhoogte berekend Oppervlaktewater t.o.v. Mean Sea Level in cm (measurement-code : WATHTBRKD)


_generated on 30-11-2023_
_generated on 01-12-2023_
Loading

0 comments on commit 867d353

Please sign in to comment.