homeassistant-afvalwijzer - GitLite

KO | EN

gitlite — search

#javascript #react #ai #typescript #golang #android #linux #macos #windows #awesome #cli #kubernetes #vue #openai

homeassistant-afvalwijzer

(★ 250)

Provides sensors for some Dutch waste collectors

파일 탐색기

최종 버전 다운로드 (.zip)

- devcontainer.json
- - config.yml
  - feature.yml
  - issue.yml
- - ci.yml
  - daily_test.yml
  - monthly_test.yml
  - release.yml
- dependabot.yaml
- SUPPORT.md
- launch.json
- tasks.json
- configuration.yaml
- - __init__.py
  - calendar.py
  - config_flow.py
  - coordinator.py
  - manifest.json
  - sensor.py
  - sensor_custom.py
  - sensor_provider.py
  - strings.json
- afvalwijzer-lovelace_1.png
- afvalwijzer-lovelace_2.png
- check-municipality-coverage
- convert-zst-to-pkl
- coverage
- dev-branch
- develop
- download-addresses-Nederland
- lint
- setup
- specific-version
- test
- test-module
- test_tls.py
- update-version
- upgrade
- verify-version
- version_scheme.py
- __init__.py
- check_municipality_coverage.py
- conftest.py
- test_calendar.py
- test_config_flow.py
- test_config_flow_options.py
- test_config_flow_reconfigure.py
- test_const_usage.py
- test_coordinator.py
- test_data.py
- test_day_sensor_data.py
- test_happy_flow.py
- test_init_midnight.py
- test_main_collector.py
- test_module.py
- test_postal_code_mappings.py
- test_sensor_custom.py
- test_sensor_provider.py
- test_sensor_setup.py
- test_sensor_utils.py
- test_setup.py
- test_translation_loading.py
- test_translations.py
- test_version_scheme.py
.gitattributes
.gitignore
.pre-commit-config.yaml
.prettierrc
.ruff.toml
.strings.json
CONTRIBUTING.md
docker-compose.yml
hacs.json
LICENSE
pyproject.toml
README.md
requirements.txt
requirements_test.txt
setup.cfg
venv.sh

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Afvalwijzer

[![hacs_badge](https://img.shields.io/badge/HACS-Default-orange.svg)](https://github.com/hacs/integration) [![hacs_badge](https://img.shields.io/badge/HACS-Custom-orange.svg)](https://github.com/hacs/integration) [![made-with-python](https://img.shields.io/badge/Made%20with-Python-1f425f.svg)](https://www.python.org/) [![Open Source Love png1](https://badges.frapsoft.com/os/v1/open-source.png?v=103)](https://github.com/ellerbrock/open-source-badges/) [![Validation And Formatting](https://github.com/xirixiz/homeassistant-afvalwijzer/actions/workflows/ci.yml/badge.svg)](https://github.com/xirixiz/homeassistant-afvalwijzer/actions/workflows/ci.yml)

![Version](https://img.shields.io/github/v/release/xirixiz/homeassistant-afvalwijzer)
![GitHub Downloads](https://img.shields.io/github/downloads/xirixiz/homeassistant-afvalwijzer/latest/total)

[![hacs_badge](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=xirixiz&repository=homeassistant-afvalwijzer)
[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/xirixiz)

_Component to integrate with the following providers/communities._

## Known unsupported municipalities

This custom component tries to support as much as possible, but there are some municipalities which we can't support at this time.

- Bergen (Limburg)
- Gennep
- Haaksbergen
- Landsmeer
- Schiermonnikoog
- Texel
- Vlieland
- Weert

## Supported waste collectors

| Provider                       | Remark / source                  |
| -------------------------------| -------------------------------- |
| ACV                            | ximmio                           |
| Afval3xBeter                   | opzet                            |
| Afvalstoffendienst             | opzet                            |
| Almere                         | ximmio                           |
| Alphen aan den Rijn            | opzet                            |
| Amsterdam                      |                                  |
| AreaReiniging                  | ximmio                           |
| Assen                          | burgerportaal                    |
| Avalex                         | ximmio                           |
| Avri                           | ximmio                           |
| BAR                            | burgerportaal                    |
| Blink                          | ximmio                           |
| Borsele                        | icalendar                        |
| Circulus                       |                                  |
| Cranendonck                    | opzet                            |
| Cure                           | mijnafvalwijzer                  |
| Cyclus NV                      | opzet                            |
| DAR                            | opzet                            |
| DeAfvalApp                     |                                  |
| De Fryske Marren               | opzet                            |
| DenHaag                        | opzet                            |
| Drimmelen                      |                                  |
| Edam-Volemdam                  | icalendar                        |
| Eemsdelta                      | omrin                            |
| GAD                            | opzet                            |
| Geertruidenberg                | opzet                            |
| Goes                           | icalendar                        |
| Groningen                      | burgerportaal                    |
| Harderwijk                     | omrin                            |
| Hellendoorn                    | ximmio                           |
| HVC                            | opzet                            |
| Irado                          |                                  |
| Land van Cuijk                 | deafvalapp                       |
| Lingewaard                     | opzet                            |
| Maassluis                      | klikogroep                       |
| Meerlanden                     | ximmio                           |
| Meppel                         |                                  |
| Middelburg-Vlissingen          | opzet                            |
| Mijn Afvalwijzer               |                                  |
| Mijnafvalzaken                 | opzet                            |
| Montferland                    |                                  |
| Montfoort                      | opzet                            |
| Nijkerk                        |                                  |
| Ôffalkalinder                  | opzet                            |
| Omrin                          |                                  |
| Oostzaan                       | ximmio                           |
| Oude IJsselstreek              | klikogroep                       |
| Peel en Maas                   | opzet                            |
| PreZero                        | opzet                            |
| Purmerend                      | opzet                            |
| RAD                            | ximmio                           |
| RD4                            |                                  |
| RecycleApp                     |                                  |
| Reinis                         | ximmio                           |
| RMN                            |                                  |
| ROVA                           |                                  |
| RWM                            | opzet                            |
| RWN                            | burgerportaal                    |
| Saver                          | opzet                            |
| Schouwen-Duiveland             | opzet                            |
| Sliedrecht                     | opzet                            |
| Spaarnelanden                  | opzet                            |
| Súdwest-Fryslân                | opzet                            |
| Tilburg                        | burgerportaal                    |
| Twente Milieu                  | ximmio                           |
| Uithoorn                       | opzet                            |
| Venlo                          | ximmio                           |
| Venray                         |                                  |
| Voorschoten                    | opzet                            |
| Waalre                         |                                  |
| Waardlanden                    |                                  |
| Woerden                        | ximmio                           |
| ZRD                            | opzet                            |

This custom component dynamically creates sensor.afvalwijzer\_\* items. For me personally the items created are gft, restafval, papier, pmd and kerstbomen. Look in the states overview in the developer tools in Home Assistant what the sensor names for your region are and modify where necessary.

If you are searching for a component with the focus on container cleaning services, you can us the following component. [ha-afvalcontainer-cleaning by @PatrickSt1991](https://github.com/PatrickSt1991/ha-afvalcontainer-cleaning).

**This component will set up the following platform(s).**

| Platform | Description             |
|----------|-------------------------|
| `sensor` | Show waste pickup dates |

<img width="603" height="634" alt="image" src="https://github.com/user-attachments/assets/25c98b66-ed2a-4bb8-b729-9deb333ff526" />

The second row sorts the waste items by date using the following lovelace code

**The example yaml is to be used directly in the main ```cards: ``` node on the dashboard not inside a card yaml. <br/>
This yaml uses a custom card being [auto-entities](https://github.com/thomasloven/lovelace-auto-entities), make sure its installed***

Keep in mind your sensor might differ from the example due to different waste naming or different types of waste in your area.

**Example yaml (same look as shown in the screenshot). This yaml uses a custom card being [stack-in-card](https://github.com/custom-cards/stack-in-card), make sure its installed**

Keep in mind your sensor might differ from the example due to different waste naming or different types of waste in your area.

```yaml
type: custom:stack-in-card
cards:
  - type: horizontal-stack
    cards:
      - type: picture-entity
        entity: sensor.afvalwijzer_today_formatted
        show_name: false
        show_state: false
        state_image:
          GFT: /local/afvalwijzer/GFT.png
          Geen: /local/afvalwijzer/Geen.png
          PMD: /local/afvalwijzer/PMD.png
          Papier: /local/afvalwijzer/Papier.png
          Restafval: /local/afvalwijzer/Restafval.png
      - type: picture-entity
        entity: sensor.afvalwijzer_tomorrow_formatted
        show_name: false
        show_state: false
        state_image:
          GFT: /local/afvalwijzer/GFT.png
          Geen: /local/afvalwijzer/Geen.png
          PMD: /local/afvalwijzer/PMD.png
          Papier: /local/afvalwijzer/Papier.png
          Restafval: /local/afvalwijzer/Restafval.png
      - type: picture-entity
        entity: sensor.afvalwijzer_day_after_tomorrow_formatted
        show_name: false
        show_state: false
        state_image:
          GFT: /local/afvalwijzer/GFT.png
          Geen: /local/afvalwijzer/Geen.png
          PMD: /local/afvalwijzer/PMD.png
          Papier: /local/afvalwijzer/Papier.png
          Restafval: /local/afvalwijzer/Restafval.png
  - type: custom:auto-entities
    card:
      type: glance
    filter:
      exclude:
        - entity_id: sensor.afvalwijzer_*next*
        - entity_id: sensor.afvalwijzer_day_after_tomorrow*
        - entity_id: sensor.afvalwijzer_today*
        - entity_id: sensor.afvalwijzer_tomorrow*
        - entity_id: sensor.afvalwijzer_kerstbomen*
        - entity_id: sensor.afvalwijzer_*orgen
        - entity_id: sensor.afvalwijzer_van*
        - entity_id: sensor.afvalwijzer_*_formatted
        - entity_id: sensor.afvalwijzer_notif*
      include:
        - entity_id: sensor.afvalwijzer_*
          options:
            format: date
    sort:
      method: state
      reverse: false
  - type: markdown
    content: >-
      <center>De volgende leging is {{ states('sensor.afvalwijzer_next_type')
      }}. Dat is over {{ states('sensor.afvalwijzer_next_in_days') }} {% if
      is_state('sensor.afvalwijzer_next_in_days', '1') %}dag{% else %}dagen{%
      endif %}.</center>
  - type: entities
    show_header_toggle: false
    state_color: false
    entities:
      - entity: input_boolean.waste_moved
      - entity: input_boolean.waste_reminder
```

Example waste.yaml packages you could use for formatted template sensors.
Keep in mind your sensor might differ from the example due to different waste naming or different types of waste in your area.

```yaml
################################################
## Packages
################################################
homeassistant:
  customize:
    sensor.afvalwijzer_today:
      friendly_name: Vandaag
    sensor.afvalwijzer_tomorrow:
      friendly_name: Morgen
    sensor.afvalwijzer_day_after_tomorrow:
      friendly_name: Overmorgen

sensor.afvalwijzer_next_item:
      friendly_name: Next pickup item
    sensor.afvalwijzer_next_in_days:
      friendly_name: Next pickup in days

sensor.afvalwijzer_gft:
      friendly_name: GFT
      entity_picture: /local/afvalwijzer/GFT.png
    sensor.afvalwijzer_papier:
      friendly_name: Papier
      entity_picture: /local/afvalwijzer/Papier.png
    sensor.afvalwijzer_pmd:
      friendly_name: PMD
      entity_picture: /local/afvalwijzer/PMD.png
    sensor.afvalwijzer_restafval:
      friendly_name: Restafval
      entity_picture: /local/afvalwijzer/Restafval.png

sensor.afvalwijzer_gft_formatted:
      friendly_name: GFT
      entity_picture: /local/afvalwijzer/GFT.png
    sensor.afvalwijzer_papier_formatted:
      friendly_name: Papier
      entity_picture: /local/afvalwijzer/Papier.png
    sensor.afvalwijzer_pmd_formatted:
      friendly_name: PMD
      entity_picture: /local/afvalwijzer/PMD.png
    sensor.afvalwijzer_restafval_formatted:
      friendly_name: Restafval
      entity_picture: /local/afvalwijzer/Restafval.png

################################################
## Template sensors
################################################
template:
  - sensor:
      - name: Afvalwijzer GFT formatted
        unique_id: afvalwijzer_gft_formatted
        state: >-
          {% set ts = states('sensor.afvalwijzer_gft') | as_timestamp(default=none) %}
          {{ ts | timestamp_custom('%d-%m-%Y') if ts is not none else 'Geen' }}

- name: Afvalwijzer Papier formatted
        unique_id: afvalwijzer_papier_formatted
        state: >-
          {% set ts = states('sensor.afvalwijzer_papier') | as_timestamp(default=none) %}
          {{ ts | timestamp_custom('%d-%m-%Y') if ts is not none else 'Geen' }}

- name: Afvalwijzer PMD formatted
        unique_id: afvalwijzer_pmd_formatted
        state: >-
          {% set ts = states('sensor.afvalwijzer_pmd') | as_timestamp(default=none) %}
          {{ ts | timestamp_custom('%d-%m-%Y') if ts is not none else 'Geen' }}

- name: Afvalwijzer Restafval formatted
        unique_id: afvalwijzer_restafval_formatted
        state: >-
          {% set ts = states('sensor.afvalwijzer_restafval') | as_timestamp(default=none) %}
          {{ ts | timestamp_custom('%d-%m-%Y') if ts is not none else 'Geen' }}

- name: Afvalwijzer next item formatted
        unique_id: afvalwijzer_next_item_formatted
        state: >-
          {{ {
            'gft': 'GFT',
            'papier': 'Papier',
            'pmd': 'PMD',
            'restafval': 'Restafval'
          }.get(states('sensor.afvalwijzer_next_item'), 'Geen') }}

- name: Afvalwijzer today formatted
        unique_id: afvalwijzer_today_formatted
        state: >-
          {{ {
            'gft': 'GFT',
            'papier': 'Papier',
            'pmd': 'PMD',
            'restafval': 'Restafval'
          }.get(states('sensor.afvalwijzer_today'), 'Geen') }}

- name: Afvalwijzer tomorrow formatted
        unique_id: afvalwijzer_tomorrow_formatted
        state: >-
          {{ {
            'gft': 'GFT',
            'papier': 'Papier',
            'pmd': 'PMD',
            'restafval': 'Restafval'
          }.get(states('sensor.afvalwijzer_tomorrow'), 'Geen') }}

- name: Afvalwijzer day after tomorrow formatted
        unique_id: afvalwijzer_day_after_tomorrow_formatted
        state: >-
          {{ {
            'gft': 'GFT',
            'papier': 'Papier',
            'pmd': 'PMD',
            'restafval': 'Restafval'
          }.get(states('sensor.afvalwijzer_day_after_tomorrow'), 'Geen') }}
```

When using the formatted entities, on the frontend you need to use one of these to sort properly by date:
```yaml
sort:
  method: template
  template: "{{ strptime(states(entity), '%d-%m-%Y') }}"
  reverse: false
```
Or
```yaml
sort:
  method: last_updated
  reverse: false
```

## Contributing

Bug reports and feature requests: please read [SUPPORT.md](.github/SUPPORT.md) first.

For local development, the helper scripts, and the release process, see
[CONTRIBUTING.md](CONTRIBUTING.md).

---

## Installation

### Manual Installation

1. Navigate to your Home Assistant configuration directory (where your `configuration.yaml` is located).
2. Create a folder named `custom_components` if it doesn't exist.
3. Inside the `custom_components` folder, create another folder named `afvalwijzer`.
4. Clone this repository or download the source code and copy all files from the `custom_components/afvalwijzer/`
   directory to the newly created `afvalwijzer` folder.
5. Restart Home Assistant to load the custom component.

After following these steps, your directory structure should look like this:

```markdown
custom_components/
afvalwijzer/
**init**.py
manifest.json
sensor.py
config_flow.py
...
```

### Installation via HACS

1. Ensure HACS is installed in your Home Assistant setup. If not, follow
   the [HACS installation guide](https://hacs.xyz/docs/setup/download).
2. Open the HACS panel in Home Assistant.
3. Click on the `Frontend` or `Integrations` tab.
4. Click the `+` button and search for `Afvalwijzer`.
5. Click `Install` to add the component to your Home Assistant setup.
6. Restart Home Assistant after the installation completes.

---

## Configuration

### Add Integration

1. Go to the **Settings** → **Devices & Services** page in Home Assistant.
2. Click **Add Integration** and search for `Afvalwijzer`.
3. Follow the on-screen instructions to complete the setup.
    - Provide your postal code, street number, and any other required details.

After completing the config flow, the integration will dynamically create sensors for waste collection dates based on
your chosen provider.

---

##### CUSTOM COMPONENT USAGE

https://github.com/home-assistant/example-custom-config/tree/master/custom_components/example_sensor

##### LOGLEVEL

To enable debug logging for troubleshooting, add the following lines to your `configuration.yaml`:

```yaml
logger:
  default: info
  logs:
    custom_components.afvalwijzer: debug
```

## EXAMPLE CONFIGURATION

###### INPUT BOOLEAN (FOR AUTOMATION)

```yaml
input_boolean:
  waste_moved:
    name: Waste has been moved
    initial: 'off'
    icon: mdi:delete-empty
  waste_reminder:
    name: Waste reminder enabled
    initial: 'on'
```

###### AUTOMATION

```yaml
automation:
  - alias: Reset waste notification
    trigger:
      platform: state
      entity_id: input_boolean.waste_moved
      to: 'on'
      for:
        hours: 12
    action:
      - service: input_boolean.turn_off
        entity_id: input_boolean.waste_moved
      - service: input_boolean.turn_on
        entity_id: input_boolean.waste_reminder

- alias: Mark waste as moved from notification
    trigger:
      platform: event
      event_type: mobile_app_notification_action
      event_data:
        action: "MARK_WASTE_MOVED"
    action:
      - service: input_boolean.turn_on
        entity_id: input_boolean.waste_moved

- alias: Waste has not been moved
    trigger:
      platform: time_pattern
      hours: '/1'
    condition:
      condition: and
      conditions:
        - condition: state
          entity_id: input_boolean.waste_moved
          state: 'off'
        - condition: state
          entity_id: input_boolean.waste_reminder
          state: 'on'
        - condition: time
          after: '18:00:00'
          before: '23:00:00'
        - condition: template
          value_template: "{{ states('sensor.afvalwijzer_tomorrow') != 'geen' }}"
    action:
      - service: notify.family
        data:
          title: 'Afval'
          message: 'Het is vandaag - {{ now().strftime("%d-%m-%Y") }}. Afvaltype(n): {{ states("sensor.afvalwijzer_tomorrow") }} wordt opgehaald op: {{ (now() + timedelta(days=1)).strftime("%d-%m-%Y") }}!'
          data:
            actions:
              - action: 'MARK_WASTE_MOVED' # The key you are sending for the event
                title: 'Afval buiten gezet' # The button title
```

---

###### WASTE COLLECTOR MESSAGES - MARKDOWN CARD

```yaml
type: markdown
content: >
  {% for notif in state_attr('sensor.afvalwijzer_notifications', 'notifications') | sort(attribute='id', reverse=true) %}

### {{ notif.title }}

{{ notif.content }}

{% endfor %}
visibility:
  - condition: numeric_state
    entity: sensor.afvalwijzer_notifications
    above: 0
```

<details>
<summary> Image preview</summary>

![example][exampleimg2]

</details>

###### WASTE COLLECTOR MESSAGES - AUTOMATION

```yaml
alias: Notify waste collection messages
description: "Notify the latest waste collector message to mobile app"
triggers:
  - trigger: state
    entity_id: sensor.afvalwijzer_notifications
    not_from:
      - unknown
      - unavailable
conditions:
  - condition: numeric_state
    entity_id: sensor.afvalwijzer_notifications
    above: 0
actions:
  - action: notify.mobile_app
    data:
      title: Afvalwijzer notification
      message: >-
        {% set notifs = state_attr('sensor.afvalwijzer_notifications',
        'notifications') %} {{ notifs[-1].content }}
```

> The `not_from` guard matters: reloading the integration briefly sets the sensor to
> `unavailable`, so a trigger without it fires again when the sensor comes back and
> re-sends a message you have already seen.

---

[exampleimg1]: <img width="603" height="634" alt="image" src="https://github.com/user-attachments/assets/bd7b01e5-18f7-4047-9cfb-c94dd4a215b8" />
[exampleimg2]: images/afvalwijzer-lovelace_2.png