hacs_waste_collection_schedule/doc/source/ics.md

ICS / iCal

Add support for generic ICS / iCal files which are downloaded from a fix location. The waste type will be taken from the summary attribute.

This source has been successfully tested with the following service providers:

• Abfall Landkreis Stade
• AVL Ludwigsburg
• AWB Esslingen
• Awista Starnberg
• AWM München
• EDG Entsorgung Dortmund
• Stadtreinigung Leipzig
• Entsorgungsgesellschaft Görlitz-Löbau-Zittau (Remove the year from the generated URL to always get the current year.)
• Abfallwirtschaft Kreis Böblingen (API from AbfallPlus / Abfall.IO)
• ASR Chemnitz (Service von https://asc.hausmuell.info/ics/ics.php)

Configuration via configuration.yaml

waste_collection_schedule:
  sources:
    - name: ics
      args:
        url: URL
        file: FILE
        offset: OFFSET
        method: METHOD
        params: PARAMS
        year_field: YEAR_FIELD

Configuration Variables

url
(string) (optional)

URL to ICS / iCal file. File will be downloaded using a HTTP GET request.

If the original url contains the current year (4 digits including century), this can be replaced by the wildcard {%Y} (see example below).

You have to specify either url or file!

file
(string) (optional)

Local ICS / iCal file name. Can be used instead of url for local files.

You have to specify either url or file!

offset
(int) (optional, default: 0)

Offset in days which will be added to every start time. Can be used if the start time of the events in the ICS file are ahead of the actual date.

method
(string) (optional, default: GET)

Method to send the URL params.

Need to be GET or POST

params
(dict) (optional, default: None)

Dictionary, list of tuples or bytes to send in the query string for the HTTP GET request. Only used if url is specified, not used for file.

year_field
(string) (optional, default: None)

Field in params dictionary to be replaced with current year (4 digits including century).

Examples

waste_collection_schedule:
  sources:
    - name: ics
      args:
        url: "https://www.avl-ludwigsburg.de/fileadmin/Files/Abfallkalender/ICS/Privat/Privat_{%Y}_Ossweil.ics"
        offset: 1

waste_collection_schedule:
  sources:
    - name: ics
      args:
        file: "test.ics"

waste_collection_schedule:
  sources:
    - name: ics
      args:
        url: "https://www.abfallkalender-zak.de",
        params:
            city: 2,3,4
            street: 3
            types[]:
              - restmuell
                gelbersack
                papiertonne
                biomuell
                gruenabfall
                schadstoffsammlung
                altpapiersammlung
                schrottsammlung
                weihnachtsbaeume
                elektrosammlung
            go_ics: Download
        },
        year_field: year