{% if prerelease %}
{% endif %}
The garbage_collection component is a Home Assistant custom helper for scheduling/monitoring regular garbage collection. The helper can be configured for weekly schedule (including multiple collection days), bi-weekly (in even or odd weeks), monthly schedule (nth day each month), or annual (e.g. birthdays). You can also configure seasonal calendars (e.g. for bio-waste collection) by configuring the first and last month. You can also group entities, which will merge multiple schedules into one sensor.
Look to the repository for examples of Lovelace configuration.
Go to Settings/Devices & Services/Helpers, click on the + CREATE HELPER button, select Garbage Collection and configure the helper.
If you would like to add more than one collection schedule, click on the + CREATE HELPER button again and add another Garbage Collection helper instance.
The configuration via configuration.yaml has been deprecated. If you have previously configured the integration there, it will be imported to ConfigFlow, and you should remove it.
For the configuration documentation check the repository file
The state can be one of
| Value | Meaning |
|---|---|
| 0 | Collection is today |
| 1 | Collection is tomorrow |
| 2 | Collection is later |
If the verbose_state parameter is set, it will show the date, and remaining days. For example "Today" or "Tomorrow" or "on 2019-09-10, in 2 days"
| Attribute | Description |
|---|---|
next_date |
The date of next collection |
days |
Days till the next collection |
last_collection |
The date and time of the last collection |
If the collection is scheduled for today, mark it completed and look for the next collection.
It will set the last_collection attribute to the current date and time.
| Attribute | Description |
|---|---|
entity_id |
The garbage collection entity id (e.g. sensor.general_waste) |
For more details see the repository.