mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-14 04:46:49 +00:00
Update rova documentation with config flow (#31941)
* Update rova documentation with config flow * Tiny tweak --------- Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
This commit is contained in:
parent
95e541f85e
commit
cae50c8abf
@ -5,105 +5,15 @@ ha_category:
|
|||||||
- Sensor
|
- Sensor
|
||||||
ha_release: 0.87
|
ha_release: 0.87
|
||||||
ha_iot_class: Cloud Polling
|
ha_iot_class: Cloud Polling
|
||||||
|
ha_config_flow: true
|
||||||
ha_domain: rova
|
ha_domain: rova
|
||||||
ha_platforms:
|
ha_platforms:
|
||||||
- sensor
|
- sensor
|
||||||
ha_integration_type: integration
|
ha_integration_type: integration
|
||||||
---
|
---
|
||||||
|
|
||||||
[ROVA](https://rova.nl) is a waste collection company that operates in the center and east of the Netherlands. The `rova` platform uses an unofficial [ROVA](https://rova.nl) API to allow you to get your waste collection schedule and integrate this in your Home Assistant installation.
|
[ROVA](https://rova.nl) is a waste collection company that operates in the center and east of the Netherlands. This **ROVA** integration uses an unofficial [ROVA](https://rova.nl) API to allow you to get your waste collection schedule and integrate this into your Home Assistant installation.
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
To use the ROVA sensor in your installation, add the following to your `configuration.yaml` file:
|
{% include integrations/config_flow.md %}
|
||||||
|
|
||||||
```yaml
|
|
||||||
# Example configuration.yaml entry
|
|
||||||
sensor:
|
|
||||||
- platform: rova
|
|
||||||
zip_code: ZIP_CODE
|
|
||||||
house_number: HOUSE_NUMBER
|
|
||||||
```
|
|
||||||
|
|
||||||
{% configuration %}
|
|
||||||
zip_code:
|
|
||||||
description: Your zip code.
|
|
||||||
required: true
|
|
||||||
type: string
|
|
||||||
house_number:
|
|
||||||
description: Your house number.
|
|
||||||
required: true
|
|
||||||
type: string
|
|
||||||
house_number_suffix:
|
|
||||||
description: A suffix for your house number.
|
|
||||||
required: false
|
|
||||||
type: string
|
|
||||||
name:
|
|
||||||
description: Let you overwrite the name of the device in the frontend.
|
|
||||||
required: false
|
|
||||||
default: Rova
|
|
||||||
type: string
|
|
||||||
monitored_conditions:
|
|
||||||
description: ROVA information to be monitored. The following collection dates can be monitored.
|
|
||||||
required: false
|
|
||||||
type: list
|
|
||||||
keys:
|
|
||||||
bio:
|
|
||||||
description: Upcoming collection date of your biodegradable waste
|
|
||||||
paper:
|
|
||||||
description: Upcoming collection date of your paper waste
|
|
||||||
plastic:
|
|
||||||
description: upcoming collection date of your plastic waste
|
|
||||||
residual:
|
|
||||||
description: Upcoming collection date of your general waste
|
|
||||||
{% endconfiguration %}
|
|
||||||
|
|
||||||
If no **monitored_conditions** are specified, only **bio** will be enabled.
|
|
||||||
|
|
||||||
### Full configuration sample
|
|
||||||
|
|
||||||
A full configuration entry would look like the sample below.
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
# Example configuration.yaml entry
|
|
||||||
sensor:
|
|
||||||
- platform: rova
|
|
||||||
zip_code: ZIP_CODE
|
|
||||||
house_number: HOUSE_NUMBER
|
|
||||||
house_number_suffix: HOUSE_NUMBER_SUFFIX
|
|
||||||
name: Rova
|
|
||||||
monitored_conditions:
|
|
||||||
- bio
|
|
||||||
- paper
|
|
||||||
- plastic
|
|
||||||
- residual
|
|
||||||
```
|
|
||||||
|
|
||||||
To have your Home Assistant installation remind you of upcoming waste collections, combine the `rova` platform with some [Automations](/docs/automation/) and a [notification platform](/integrations/notify/).
|
|
||||||
|
|
||||||
{% raw %}
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
# Example configuration.yaml entry for Rova waste collection reminder
|
|
||||||
automation:
|
|
||||||
- id: rova-garbage-bio-reminder
|
|
||||||
alias: "Send Rova Bio waste collection reminder"
|
|
||||||
trigger:
|
|
||||||
- platform: time
|
|
||||||
at: "19:00:00"
|
|
||||||
condition:
|
|
||||||
- condition: template
|
|
||||||
value_template: "{% if (as_timestamp(states('sensor.rova_garbage_gft')) - as_timestamp(now())) < 43200 %}true{% endif %}"
|
|
||||||
- condition: template
|
|
||||||
value_template: "{% if (as_timestamp(states('sensor.rova_garbage_gft')) - as_timestamp(now())) > 0 %}true{% endif %}"
|
|
||||||
action:
|
|
||||||
- service: NOTIFICATION_SERVICE
|
|
||||||
data:
|
|
||||||
message: "Reminder: put out biowaste bin"
|
|
||||||
```
|
|
||||||
|
|
||||||
{% endraw %}
|
|
||||||
|
|
||||||
<div class='note warning'>
|
|
||||||
This integration is not affiliated with Rova and retrieves data from the endpoints of their website. Use at your own risk.
|
|
||||||
</div>
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user