The garbage_collection component is a Home Assistant custom sensor for monitoring regular garbage collection schedule. The sensor can be configured for weekly schedule (including multiple collection days), bi-weekly in even or odd weeks, monthly schedule (nth day each month), or annualy (e.g. birthdays). You can also configure seasonal calendars (e.g. for bio-waste collection), by configuring the first and last month. And you can also group entities, which will merge multile schedules into one sensor.
- Download the latest release.
- Unpack the release and copy the
custom_components/garbage_collectiondirectory into thecustom_componentsdirectory of your Home Assistant installation. - Configure the
garbage_collectionsensor. - Restart Home Assistant.
- Ensure that HACS is installed.
- Search for and install the "Garbage Collection" integration.
- Configure the
garbage_collectionsensor. - Restart Home Assistant.
There are 2 ways to configure the integration:
- Using Config Flow: in
Configuration/Integrationsclick on the+button, selectGarbage Collectionand configure the sensor (prefered). If you configure Garbage Collection using Config Flow, you can change the entity_name, name and change the sensor parameters from the Integrations configuration. The changes are instant and do not require HA restart. - Using YAML: add
garbage_collectionintegration in yourconfiguration.yamland add individual sensors. Example:
# Example configuration.yaml entry
garbage_collection:
sensors:
- name: waste # Each week on Monday and Wednesday. No collection on Christmas, added extra collection on the 27th
frequency: "weekly"
collection_days:
- mon
- wed
exclude_dates:
- '2019-12-25'
include_dates:
- '2019-12-27'
- name: "Bio-waste" # Bi-weekly (odd weeks) on Thursday. Between March and November
frequency: "odd-weeks"
first_month: "mar"
last_month: "nov"
collection_days: "thu"
- name: "Large waste summer" # First and third Saturday each month
frequency: "monthly"
collection_days: "sat"
weekday_order_number:
- 1
- 3
first_month: "may"
last_month: "oct"
- name: "Large waste winter" # First Saturday each month only
frequency: "monthly"
collection_days: "sat"
weekday_order_number:
- 1
first_month: "nov"
last_month: "apr"
- name: "Large waste" # Combination of winter and summer sensors
frequency: "group"
entities:
- sensor.large_waste_summer
- sensor.large_waste_winter
- name: Paper # Every 4 weeks on Tuesday, starting on 4th week each year
frequency: "every-n-weeks"
collection_days: "tue"
period: 4
first_week: 4
- name: "Someone's Birthday"
frequency: "annual"
date: '11/24'Entity_id change is not possible using the YAML configuration. Changing other paratemers require restarting Home Assistant.
| Attribute | Optional | Description |
|---|---|---|
name |
No | Sensor friendly name |
frequency |
Yes | "weekly", "even-weeks", "odd-weeks", "every-n-weeks", "monthly", "annual" or "group" |
icon_normal |
Yes | Default icon Default: mdi:trash-can |
icon_today |
Yes | Icon if the collection is today Default: mdi:delete-restore |
icon_tomorrow |
Yes | Icon if the collection is tomorrow Default: mdi:delete-circle |
verbose_state |
Yes | The sensor state will show collection date and remaining days, instead of number Default: False |
verbose_format |
Yes | (relevant when verbose_state is True). Verbose status formatting string. Can use placeholders {date} and {days} to show the date of next collection and remaining days. Default: 'on {date}, in {days} days'When the collection is today or tomorrow, it will show Today or Tomorrow(currently in English, French and Czech). |
date_format |
Yes | In the verbose_format, you can configure the format of date (using strftime format) Default: '%d-%b-%Y' |
| Attribute | Optional | Description |
|---|---|---|
collection_days |
No | Day three letter abbreviation, list of "mon", "tue", "wed", "thu", "fri", "sat", "sun". |
first_month |
Yes | Month three letter abbreviation, e.g. "jan", "feb"...Default: "jan" |
last_month |
Yes | Month three letter abbreviation. Default: "dec" |
exclude_dates |
Yes | List of dates with no collection (using international date format 'yyyy-mm-dd'. |
include_dates |
Yes | List of extra collection (using international date format 'yyyy-mm-dd'. |
| Attribute | Optional | Description |
|---|---|---|
period |
Yes | Collection every "period" weeks (integer 1-53)Default: 1 |
first_week |
Yes | First collection on the "first_week" week (integer 1-53)Default: 1 (The week number is using ISO-8601 numeric representatio of the week) |
| Attribute | Optional | Description |
|---|---|---|
weekday_order_number |
Yes | List of week numbers of collection_day each month. E.g., if collection_day is "sat", 1 will mean 1st Saturday each month (integer 1-4)Default: 1 |
| Attribute | Optional | Description |
|---|---|---|
date |
No | Date of the collection using format 'mm/dd' (e.g. '11/24' for November 24 each year) |
| Attribute | Optional | Description |
|---|---|---|
entities |
No | List of entity_ids to merge |
IMPORTANT - put include/exclude dates within quotes. Dates without quotes might cause Home Assistant not loading configuration when starting - in case the date is invalid. Validation for dates within quotes works fine. I think this is general bug, I am addressing that. (See the example above)
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 date and remaining days, for example "Today" or "Tomorrow" or "on 10-Sep-2019, in 2 days" (configurable)
| Attribute | Description |
|---|---|
next_date |
The date of next collection |
days |
Days till the next collection |