jlsjonas / homeassistant-bpost-integration

Integration of the my bpost app for Home Assistant

My bpost integration for Home Assistant

This is a custom component for Home Assistant that allows you to see the mail you are going to receive.

This integration requires you to create and configure an account in the my bpost app. You need to have My Mail correctly setup within the app to use this integration.

Features

Only features with a ☑️ are available at the moment. Other features are planned for the future.

Entities

Sensor

• The amount of mail you will receive today: sensor.mail_today (extra attribute containing unique IDs of the mail)
• Information about parcels you're tracking

Binary sensor

• If mail has been processed today: binary_sensor.mail_processed_today
• If you've configured the mail service correctly: binary_sensor.mail_service_available
• If you're expecting a parcel

Camera

• Pictures of the mail you will receive. The image will be available with a unique ID in the form bpost_camera_id. The list of IDs can be found in the mail_today extra attribute. This entity has an extra attribute expected_delivery_date with a timestamp indicating when the mail should arrive.

Services

• Start tracking a new parcel

Installation

Installing the integration as a custom component

This repository is included in the HACS repositories.

Configure the integration in Home Assistant

1. Go to your Home Assistant settings > Integrations and add a new integration.
2. Search for bpost and select it.
3. Enter the email address you've used in the mobile app.
4. You will receive a verification code through email.
5. Enter the verification code you received.
6. All entities and services mentioned above are now available.

License

MIT license

Contributing

1. Install poetry
2. Clone the repository
3. Install dependencies poetry install
4. Activate venv: poetry shell
5. Configure pre-commit: pre-commit install
6. Configure your IDE to use the poetry venv (poetry env info)