Improve Twente Milieu documentation (#38838)

This commit is contained in:
Franck Nijhof 2025-05-01 12:19:35 +02:00 committed by GitHub
parent 80c068cdc9
commit 15ee451e3c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -19,70 +19,57 @@ ha_integration_type: service
ha_quality_scale: silver ha_quality_scale: silver
--- ---
The Twente Milieu {% term integration %} enables you to monitor the upcoming The **Twente Milieu** {% term integration %} enables you to monitor the upcoming waste collection schedules provided by [Twente Milieu](https://www.twentemilieu.nl/), a waste collection company serving municipalities in the Twente region of the Netherlands, including Enschede, Hengelo, Almelo, Borne, Hof van Twente, Oldenzaal, and Losser. This integration helps you stay informed about the next pickup dates for different types of waste (like organic, paper, plastic, and non-recyclable), ensuring you never miss a collection day.
waste collection schedules provided by
[Twente Milieu](https://www.twentemilieu.nl/) for various waste categories.
This integration helps you stay informed about the next pickup dates for
different types of waste, ensuring you never miss a collection day.
{% include integrations/config_flow.md %} {% include integrations/config_flow.md %}
### Configuration parameters
{% configuration_basic %} {% configuration_basic %}
Postal code: Postal code:
description: The postal code of the address, for example "7500AA". description: The postal code of the address, for example "7500AA".
House number: House number:
description: The house number of the address. description: The house number of the address.
House letter/additional: House letter/additional:
description: The house letter or additional information of the address. description: The house letter or additional information of the address, if applicable.
{% endconfiguration_basic %} {% endconfiguration_basic %}
## Use cases ## Use cases
The integration provides sensors for the next waste pickup dates. You can use With the Twente Milieu integration, you can:
this information to create automations, for example, to remind you to put out
the waste bins the night before the pickup.
Besides the sensors, the integration also provides a calendar to Home Assistant. - Monitor upcoming waste collection dates for different waste types
Meaning you can view all upcoming waste pickups in the calendar dashboard. - Create automations to remind you to put out your waste bins before collection day
- View all your upcoming waste pickups in the calendar dashboard
- See at a glance when your next waste collection is due
## Supported functionality ## Supported functionality
### Calendar ### Calendar
The integration provides a calendar to Home Assistant. You can view The integration provides a calendar entity that displays all upcoming waste collection dates from Twente Milieu. You can view this calendar in your {% my calendar title="Calendar dashboard" %}.
all upcoming waste pickups in the calender dashboard.
### Sensors ### Sensors
This integration provides sensors for the following waste pickup dates from This integration creates the following sensors for upcoming waste collection dates:
Twente Milieu:
- Next plastic waste pickup date. - Next plastic waste pickup date
- Next organic waste pickup date. - Next organic waste pickup date
- Next paper waste pickup date. - Next paper waste pickup date
- Next non-recyclable waste pickup date. - Next non-recyclable waste pickup date
- Next Christmas Tree pickup date. - Next Christmas tree pickup date (seasonal)
Each sensor provides the next scheduled date for its respective waste type, allowing you to track when to put out specific bins.
## Data updates ## Data updates
The integration will update its information by polling Twente Milieu every The integration updates its information by {% term polling %} the Twente Milieu service every hour. This ensures your waste collection schedule in Home Assistant stays current.
hour. This ensures the data in Home Assistant is up to date.
## Actions
This integration does not provide additional actions.
## Examples ## Examples
The following examples show how to use the Twente Milieu integration in Home Below are practical examples of how you can use the Twente Milieu integration in your automations.
Assistant automations.
### Send notification the evening before the garbage pickup day ### Send notification the evening before the garbage pickup day
The following example sends a notification to your mobile device the evening This example sends a notification to your mobile device the evening before collection day, ensuring you remember to put out the correct bin.
before the garbage pickup day. This ensures your bins are out on time.
```yaml ```yaml
automation: automation:
@ -92,6 +79,7 @@ automation:
event: start event: start
entity_id: calendar.twente_milieu entity_id: calendar.twente_milieu
offset: "-6:00:00" offset: "-6:00:00"
# This triggers 6 hours before the calendar event starts
actions: actions:
- action: notify.mobile_app_your_device - action: notify.mobile_app_your_device
@ -102,32 +90,32 @@ automation:
day. Don't forget to put out the bin! day. Don't forget to put out the bin!
``` ```
### Send notification at the end of day to haul in the empty bin again ### Send notification at the end of day to bring in the empty bin
The following example sends a notification to your mobile device at the end of This example sends a notification to remind you to bring the empty bin back in after collection.
the day to remind you to haul in the empty bin again.
```yaml ```yaml
automation: automation:
- alias: "Reminder to haul in the bin" - alias: "Reminder to bring in the bin"
triggers: triggers:
- trigger: calendar - trigger: calendar
event: end event: end
entity_id: calendar.twente_milieu entity_id: calendar.twente_milieu
offset: "-4:00:00" offset: "-4:00:00"
# This triggers 4 hours before the calendar event ends
actions: actions:
- action: notify.mobile_app_your_device - action: notify.mobile_app_your_device
data: data:
title: "Haul in the bin!" title: "Bring in the bin!"
message: > message: >
Reminder Garbage has been picked up today. Don't forget to haul in Reminder: The waste has been collected today. Don't forget to
the bin! bring in your empty bin!
``` ```
## Known limitations ## Known limitations
There are no known limitations for this integration. - Home Assistant currently doesn't support translating calendar items. Therefore, waste collection events in the calendar will always be displayed in English, regardless of your language settings.
## Troubleshooting ## Troubleshooting
@ -135,7 +123,6 @@ There are no commonly known issues with this integration.
## Removing the integration ## Removing the integration
This integration follows standard integration removal. No extra steps are This integration follows standard integration removal. No additional steps are required.
required.
{% include integrations/remove_device_service.md %} {% include integrations/remove_device_service.md %}