glance- / dhl

A custom_component for home-assistant to track DHL packages via their api.

DHL custom_component

This is a custom component for home-assistant to track DHL packages.

Its activated by adding the following to your configuration.yaml:

sensor:
  - platform: dhl
    api_key: !secret dhl_api_key

And you get your own api key by registering at https://developer.dhl.com/

After that you can start to track your packages by calling the service dhl.register with a argument looking like {"package_id": "123456789"} to have home-assistant start tracking that package.

And when you loose interest in that package, you just stop tracking it by calling dhl.unregister with a corresponding argument.

To view all your packages in a nice fashion, I use the auto-entities[1] card to view them all as a list in lovelace:

      - card:
          type: entities
        filter:
          include:
            - domain: dhl
        type: 'custom:auto-entities'

This component shares quite a bit of code and architecture with my package tracker for Postnord[2], bring[3] and DbSchenker[4].

1. https://github.com/thomasloven/lovelace-auto-entities
2. https://github.com/glance-/postnord
3. https://github.com/glance-/bring
4. https://github.com/glance-/dbschenker

dhl's Issues

homeassitant warning - deprecation for async_add_job

2024-04-24 11:50:49.821 WARNING (MainThread) [homeassistant.helpers.frame] Detected that custom integration 'dhl' calls async_add_job, which is deprecated and will be removed in Home Assistant 2025.4; Please review https://developers.home-assistant.io/blog/2024/03/13/deprecate_add_run_job for replacement options at custom_components/dhl/sensor.py, line 86: await hass.async_add_job(save_json, json_path, registrations), please report it to the author of the 'dhl' custom integration

I hereby reported this :)

Feature request: live tracking

Would it be possible to get live tracking information as attributes? Like stops before delivery?

Thx in advance

why did my ticket got closed?

https://github.com/glance-/dhl/issues/5

Package Title / Name

this is not really a issue.

Is it somehow possible to add a package title or anything to a specific package?
If you track multiple packages, its hard to know which is which.

device_state_attributes is deprecated

Home Assistant 2022.2 throws the following message:

Entity dhl.xxx (<class 'custom_components.dhl.sensor.DHLSensor'>) implements device_state_attributes. Please report it to the custom component author.

Seems like it needs to be renamed to extra_state_attributes: https://community.home-assistant.io/t/warning-that-custom-component-is-using-device-state-attributes/376020/2

Entities wont update

Thanks for your work here, it works mostly very good.

The problem is refreshing the entities to get their new states. Is there a way to control the polling or just trigger a refresh without doing unregister and register again?

Cant unregister

Ive tested a bit and created some weird tracking ids.

Ive registered IDs like "dhl" "dhl123" "123dhl"

So creating this is not a problem, but i cant unregister them. So now theyre in my entity list and cant get removed or unregistered.

Request some support help get it working

because myne isnt do much atm tbh

C ould you also tell me where to find the exact
{"package_id": "123456789"}