Update Swiss Hydrological Data documentation (#6535)

* Update Swiss Hydrological Data documentation

* Update

* Fix typo and style

* Fix my copy-&-paste mistake:
This commit is contained in:
bouni 2018-11-11 17:39:40 +01:00 committed by Fabian Affolter
parent 618132c67c
commit 01f8ca6e24

View File

@ -13,15 +13,11 @@ ha_iot_class: "Cloud Polling"
ha_release: 0.22
---
<p class='note warning'>
This sensor doesn't work at the moment due to changed by the [Swiss Federal Office for the Environment (Bundesamt für Umwelt - Abt. Hydrologie)](http://www.hydrodaten.admin.ch) to access the data.
</p>
The `swiss_hydrological_data` sensor will show you details (temperature, level, and discharge) of rivers and lakes in Switzerland.
## {% linkable_title Setup %}
The [station overview](http://www.hydrodaten.admin.ch/en/danger-levels-table.html) contains a list of all available measuring points and will help to determine the ID of station which is needed for the configuration.
The [station overview](https://www.hydrodaten.admin.ch/en/stations-and-data.html) contains a list of all available measuring points and will help to determine the ID of station which is needed for the configuration.
## {% linkable_title Configuration %}
@ -32,6 +28,10 @@ To enable this sensor, add the following lines to your `configuration.yaml` file
sensor:
- platform: swiss_hydrological_data
station: STATION_ID
monitored_conditions:
- temperature
- level
- discharge
```
{% configuration %}
@ -39,29 +39,27 @@ station:
description: The ID of the measurement point.
required: true
type: string
name:
description: Name to use in the frontend.
monitored_conditions:
description: The list of measurements you want to use. Available is `temperature`, `level` or `discharge`.
required: false
type: string
default:
type: list
default: temperature
{% endconfiguration %}
The hydrological measurings are coming from the [Swiss Federal Office for the Environment (Bundesamt für Umwelt - Abt. Hydrologie)](http://www.hydrodaten.admin.ch) and are updated almost in real-time.
Sensors are exposing additional values through their attributes for all available conditions:
## {% linkable_title Example %}
This sensor contains additional information which an easily accessed by a [template sensor](/components/sensor.template/).
{% raw %}
```yaml
# Example configuration.yaml entry
sensor:
platform: template
sensors:
discharge:
value_template: '{{ states.sensor.aare.attributes.Discharge }}'
friendly_name: 'Discharge'
```
{% endraw %}
- `delta-24h`: The delta measurement for the last 24 hours.
- `max-1h`: The maximum measurement for the last hour.
- `max-24h`: The maximum measurement for the last 24 hours.
- `mean-1h`: The mean measurement for the last hour.
- `mean-24h`: The mean measurement for the last 24 hours.
- `min-1h`: The minimum measurement for the last hour.
- `min-24h`: The minimum measurement for the last 24 hours.
- `previous-24h`: The previous measurement for the last 24 hours.
- `station_update`: There is a time span between the sensor update in Home Assistant and the updates from the stations. Include those information if you are building automations based on the discharge of a water body.
<p class='note info'>
The sensors don't show the latest measurement, but those from the last hour due to the source of data. Some stations also don't provide data for certain measurements.
</p>
The hydrological measurements are coming from the [Swiss Federal Office for the Environment (Bundesamt für Umwelt - Abt. Hydrologie)](http://www.hydrodaten.admin.ch) and are updated every 10 minutes.