Add Suez Water config flow (#30295)

This commit is contained in:
Joost Lekkerkerker 2023-12-13 08:12:00 +01:00 committed by GitHub
parent b5199b17b9
commit 8a24226cc0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -5,6 +5,7 @@ ha_release: 0.97
ha_category: ha_category:
- Sensor - Sensor
ha_iot_class: Cloud Polling ha_iot_class: Cloud Polling
ha_config_flow: true
ha_codeowners: ha_codeowners:
- '@ooii' - '@ooii'
ha_domain: suez_water ha_domain: suez_water
@ -13,7 +14,7 @@ ha_platforms:
ha_integration_type: integration ha_integration_type: integration
--- ---
The `suez_water` sensor platform fetches your last day consumption of water from the French water provider [Tout Sur Mon Eau](https://www.toutsurmoneau.fr) website. The Suez Water integration fetches your last day consumption of water from the French water provider [Tout Sur Mon Eau](https://www.toutsurmoneau.fr) website.
It also gets the following data: It also gets the following data:
@ -24,32 +25,6 @@ It also gets the following data:
- Last year total consumption - Last year total consumption
- Current year total consumption - Current year total consumption
## Configuration {% include integrations/config_flow.md %}
To add the Suez Water sensor to your installation, add your _Tout Sur Mon Eau_ account credentials and your `counter_id` to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
sensor:
- platform: suez_water
username: YOUR_SUEZ_USERNAME
password: YOUR_SUEZ_PASSWORD
counter_id: YOUR_SUEZ_COUNTER_ID
```
{% configuration %}
username:
description: The Tout Sur Mon Eau account username.
required: true
type: string
password:
description: The Tout Sur Mon Eau account password.
required: true
type: string
counter_id:
description: The Tout Sur Mon Eau counter id.
required: true
type: integer
{% endconfiguration %}
`counter_id` is the water counter id. It can be found on your _Tout Sur Mon Eau_ [user account](https://www.toutsurmoneau.fr/mon-compte-en-ligne/historique-de-consommation-tr). Look in the source code of the page for something similar to `url: '/mon-compte-en-ligne/statMData' + '/123456789'`. The `counter_id` in this case is `123456789`. `counter_id` is the water counter id. It can be found on your _Tout Sur Mon Eau_ [user account](https://www.toutsurmoneau.fr/mon-compte-en-ligne/historique-de-consommation-tr). Look in the source code of the page for something similar to `url: '/mon-compte-en-ligne/statMData' + '/123456789'`. The `counter_id` in this case is `123456789`.