tuxuser / abfallapi_regioit_ha

Abfall API (RegioIT) custom component for home assistant - Get an alert when garbage collection is due
Apache License 2.0
10 stars 8 forks source link
collection component garbage homeassistant homeassistant-sensor muell muellabfuhr regioit sensor smart-home waste

hacs_badge

Note
By now there is a more feature-full and actively maintained Home Assistant plugin/addon called Waste Collection Schedule.
Please switch to it! :smile:

Home Assistant sensor for german waste collection schedule (regioIT API)

Functionality

The sensor shows the bin which will be collected the next day. The complete collection schedule is available as attributes of the sensor

Supported services:

alt text

alt text

Credits

Based on AWB Köln Home Assistant sensor by jensweimann

Installation

Manual

Copy all files from custom_components/abfallapi_regioit/ to custom_components/abfallapi_regioit/ inside your config Home Assistant directory.

HACS

Search for Abfall API (RegioIT) in HACS -> Integrations. Install the integration and restart home assistant.

Discussion

Home Assistant Community Forum

Configuration

Setup sensor

- platform: abfallapi_regioit
  name: muellabfuhr
  scan_interval: 3600
  anbieter_id: KRWAF
  ort: 'Ahlen'
  strasse: 'Abtstraße'

Customize

sensor.muellabfuhr:
  friendly_name: Heute Mülltonne rausstellen
  icon: mdi:delete

Automation

- alias: Abfall Notification
  trigger:
    - platform: time
      at: "18:00:00"
    - entity_id: binary_sensor.someone_is_home
      from: 'off'
      platform: state
      to: 'on'
  condition:
    - condition: and
      conditions:
      - condition: time
        after: '09:00:00'
      - condition: time
        before: '23:00:00'
      - condition: template
        value_template: "{{ (states.sensor.muellabfuhr.state != 'Keine') and (states.sensor.muellabfuhr.state != 'unknown') }}"
  action:
    - service: notify.my_telegram
      data_template:
        message: "{{ states.sensor.muellabfuhr.state }}"

Find anbieter_id

BASE_URL can be found in regioit_abfall_api.py -> CITIES

anbieter_id: KRWAF

Verify names for strasse and ort

GET https://<BASE_URL>/rest/orte

Example output:

[
 {"id":3839714,"name":"Ahlen"},
 {"id":3840376,"name":"Beckum"},
 ...
]

GET http://<BASE_URL>/rest/orte/<ort_id>/strassen

Example output:

[
 {"id":3839716,"name":"Abtstraße","hausNrList":[],"ort":{"id":3839714,"name":"Ahlen"}},
 {"id":3839725,"name":"Agnes-Miegel-Straße","hausNrList":[],"ort":{"id":3839714,"name":"Ahlen"}},
 ...
]

DISCLAIMER

This project is in no way endorsed by or affiliated with regioIT, or any associated subsidiaries, logos or trademarks.