Skip to content

Latest commit

 

History

History
1799 lines (1711 loc) · 120 KB

README.md

File metadata and controls

1799 lines (1711 loc) · 120 KB
Raw

Waste Collection Schedule logo

Waste Collection Schedule

A custom component for Home Assistant that retrieves waste collection schedules from a wide range of service providers.

Waste Collection Schedule animation

Waste collection schedules from service provider web sites are updated daily, derived from local ICS/iCal files, or generated from user-specified dates or regularly repeating date patterns. The Home Assistant built-in Calendar is automatically populated with schedules, and there is a high degree of flexibility in how information can be format and displayed in entity cards or pop-ups. The framework can easily be extended to support additional waste collection service providers, or other services which provide schedules.

Supported Service Providers

Waste collection schedules in the following formats and countries are supported. Click on the section heading to view details of individual service providers.

If your service provider is not listed, feel free to open a source request issue (please first check the Issues section if there already is an open issue for your service provider.).

ICS/iCal and User-Specified
Australia
Austria
Belgium
Canada
Czech Republic
Denmark
Finland
France
Germany
Hungary
Italy
Lithuania
Luxembourg
Netherlands
New Zealand
Norway
Poland
Slovenia
Sweden
Switzerland
United Kingdom
United States of America

Installation

hacs badge hacs installs

Waste Collection Schedule can be installed via HACS, or by manually copying the waste_collection_schedule directory to Home Assistant's config/custom_components/ directory.

Configuration

This integration can be configured through the Home Assistant UI. From the Devices & Services page click 'Add Integration' and search for 'Waste Collection Schedule'.

Alternatively, Waste Collection Schedule can be configured manually in the yaml configuration files. This is required for certain advanced options. For further details see the installation and configuration page, or the FAQ.

Contributing To The Project

python badge github contributors last commit Community Discussion

There are several ways of contributing to this project, they include:

  • Adding new service providers
  • Updating or improving the documentation
  • Helping answer/fix any issues raised
  • Join in with the Home Assistant Community discussion

For further details see contributing guidelines, or take a look at our online mentions.

Known Issues

The following waste service providers return errors when running the test_source script:

  • banyule_vic_gov_au: JSONDecodeError, caused by not supported Captcha wall
  • awn_de: all tests return 0 entries

If you can fix any of these, please raise a Pull Request with the updates.

Home Assistant Hangs

Problem: Home Assistant hangs during restart or configuration check. This occurs typically after Waste Collection Schedule has been added to the configuration.

Root Cause: Home Assistant tries to install the required Python packages and fails somehow. This is not an issue of Waste Collection Schedule.

Solution: Try to reinstall Waste Collection Schedule (if you are using HACS) or install the required Python packages manually. This list of required packages can be found in manifest.json.

The actual procedure depends on your Home Assistant installation type.

Example:

sudo docker exec -it homeassistant /bin/bash
pip list
pip install recurring_ical_events  # in case recurring_ical_events is missing

Licence

github licence

This project uses the MIT Licence, for more details see the licence document.

Showing Your Appreciation

If you like this project, please give it a star on GitHub or consider becoming a Sponsor.