fkf-garbage-collection icon indicating copy to clipboard operation
fkf-garbage-collection copied to clipboard

FKF Budapest Garbage Collection custom component for Home Assistant

hacs_badge

Buy me a coffee

FKF Budapest Garbage Collection custom component for Home Assistant

This custom component provides garbage collection schedule from FKF Budapest Department of Public for a configurable address. It also supports green garbage collection schedule (FKF Budapest treats it differently)

The state of the sensor will be the number of days to the first upcoming garbage collection date.

The sensor will also report in an attribute the status of the latest data fetch.

The FKF Garbage Collection sensors can also be added to appear in HASS calendar. Calendar entries will be prefixed with the friendly name of the sensor to support and distinguish schedule for multiple such sensors/addresses. Translation of the calendar entries is also available through the calendar_lang option; so far only Hungarian and English are supported. Language tags should follow IANA subtag registry.

Installation

The easiest way to install it is through HACS (Home Assistant Community Store), search for FKF Budapest Garbage in the Integrations.

Sensors of this platform should be configured as per below information.

Configuration:

Define sensors with the following configuration parameters according to FKF Hulladéknaptár for Budapest or FKF Hulladéknaptár for Budaörs.


Name Optional Default Description
name Y - sensor of fkf_garbage_collection type
city Y Budapest City to look for. Only Budapest and Budaörs are supported. Deprecated by zipcode. It will be removed in the next version.
zipcode N - ZIP code
publicplace N - Name of public place
housenr Y 1 House number (only for Budapest)
offsetdays Y 0 Optional offset for the number of days left (usually 1)
calendar Y false Show FKF schedule in calendar
calendar_lang Y en Language to display garbage type in calendar
green Y false Include green garbage schedule as well
greencolor Y `` Use map color for districts that have different green garbage collecting days per region (see below)

For green garbage collection, greencolor, if defined, takes precedence over publicplace-housenr. Color name can be fetched from the source of the webpage www.fkf.hu/kerti-zoldhulladek-korzetek-<districts_roman_number>-kerulet and is one of these: kek, lila, narancs, rozsaszin, sarga. greencolor is not necessary if the whole district has green garbage collection on one specific day. greencolor has to be defined for Budapest districts.

Green garbage collection related attribute will not be included when the green garbage collection service is suspended during winter time (FKF Zöldhulladék).

Example

sensor:
- platform: fkf_garbage_collection
  name: 'fkf_my_schedule'
  zipcode: '1013'
  publicplace: 'Attila út'
  housenr: '69'

Lovelace UI

There is a Lovelace custom card related to this component at https://github.com/amaximus/fkf-garbage-collection-card.

Custom Lovelace card example:

Garbage Collection card example

Home Assistant Companion App notification example

You can set up an automation to get a notification on your phone so you don't forget to pull out the trash bins:

- alias: 'Tedd ki a szemetet'
  trigger:
    - platform: time
      at: '18:00:00'
  condition:
    condition: and
    conditions:
    - condition: state
      entity_id: 'person.me'
      state: 'home'
    - condition: state
      entity_id: sensor.fkf_hulladek
      state: '0'
  action:
    - choose:
        - conditions:
            - condition: template
              value_template: "{{ is_state_attr('sensor.fkf_hulladek', 'garbage0', 'communal') }}"
          sequence:
            - service: notify.mobile_app_me
              data:
                title: 'Tedd ki a szemetet!'
                message: 'A kommunális :wastebasket: -át ma ki kell tolni.'
                data:
                  channel: Kuka
                  clickAction: /lovelace/default_view
        - conditions:
            - condition: template
              value_template: "{{ is_state_attr('sensor.fkf_hulladek', 'garbage0', 'selective') }}"
          sequence:
            - service: notify.mobile_app_me
              data:
                title: 'Tedd ki a szemetet!'
                message: 'A szelektív :wastebasket: -át ma ki kell tolni.'
                data:
                  channel: Kuka
                  clickAction: /lovelace/default_view
      default:
        - service: notify.mobile_app_me
          data:
            title: 'Tedd ki a szemetet!'
            message: 'A :wastebasket: -át ma ki kell tolni.'
            data:
              channel: Kuka
              clickAction: /lovelace/default_view

Thanks

Thanks to all the people who have contributed!

contributors