PostNL Integration

ptnijssen · April 21, 2019, 5:30pm

UPDATE June 2024

PostNL is back working thanks to the work by @arjenbos

Check out his Github repository, which contains instructions on how to install the component:

History

This topic started as a Lovelace card for the PostNL integration that was part of the core of HA. Over time PostNL broke the integration and the lovelace card was abandoned. The integration didn’t work for a while till it was brought back to live.

Therefor much of this topic contains information related to the lovelace card back then and the previous integration. For up 2 date discussions, please follow the latest post or raise questions.

Roelofk85 · April 21, 2019, 6:42pm

I think this is already looking very good! Going to use it for sure when realeased for public!

Great job

riemers · April 21, 2019, 10:01pm

Always like new features. Looks nice.

That said, i’ll be ‘frank’. I never open the post nl app to see what envelopes i am getting. It is nice that it could show it but it takes up a lot of screen. Would at least seperate the 2, 1 card for mail and 1 card for packages. That way it doesn’t matter what the preference is of a person since he can choose both if he/she wants too (or 1 card that does it all)

For the packages an option how many delivered packages it would show is a nice bonus.

And i presume to far fetched but what about an option that it counts the number of mail items untill a reset is given? So if you could have a sensor that just adds up the number of mail, that way you can automate your mailbox further (most have a sensor in the mail to trigger it) but now you could even say “you have more then 5 mail items in your box, it really is time to empty it” just thinking out loud here
(I actually have a mailbox outside, doesn’t really matter for the people where the mail drops in the house)

ptnijssen · April 21, 2019, 10:11pm

Thanks for the input! I had the same feeling with the images.

Already changed some stuff. I’m now waiting for the 0.92 release of HA, since I am overwriting the current component to achieve my results and they made some changes in this release. After that, I have a guide on how to achieve the Lovelace card. Depending on input, I can perhaps override the current component with my component, so you only need to install the lovelace card.

Meanwhile, I am also waiting for a package or mail to arrive. Since I currently have to work with delivered packages and an empty mailbox, which makes it hard to test

riemers · April 21, 2019, 10:14pm

Well if you want a mail card, just private message your address. Least i can do ha

ptnijssen · April 24, 2019, 8:57pm

Awaiting the 0.92 release (should be available today) to create instructions to have more people test this.

If you click on the ID of the letter, you get to see the image.
If you click on the name of the package, you are taken to the web interface of PostNL itself.

ramonvanbiljouw · April 24, 2019, 9:31pm

Hi Peter, in case you need more beta testers, I’m gladly to help. Regards, Ramon

ptnijssen · April 24, 2019, 10:01pm

Yeah definetly need testers. Will post instructions tomorrow!

Thanks!

ptnijssen · April 25, 2019, 5:42pm

Topic description has been updated! Hope it contains enough information for you guys to know what to do.

Happy to hear your thoughts and feedback. Also see the list of known issues and upcoming features.

Best to report features and bugs within the Github repository for easy tracking.

Thanks!

riemers · April 25, 2019, 8:27pm

Made an issue, if your on discord could just look into it but don’t know your nick there.

ptnijssen · April 25, 2019, 9:19pm

Solved some issues with help from @riemers.
Custom component as well as the lovelace card have been updated.

Luukxt8 · April 26, 2019, 11:00am

Hi i’m getting the following error:

[homeassistant.components.sensor] Error while setting up platform postnl_custom Traceback (most recent call last): File "/usr/src/app/homeassistant/helpers/entity_platform.py", line 126, in _async_setup_platform SLOW_SETUP_MAX_WAIT, loop=hass.loop) File "/usr/local/lib/python3.7/asyncio/tasks.py", line 416, in wait_for return fut.result() File "/usr/local/lib/python3.7/concurrent/futures/thread.py", line 57, in run result = self.fn(*self.args, **self.kwargs) File "/config/custom_components/postnl_custom/sensor.py", line 34, in setup_platform from postnlpy.postnlapi import PostnlApi ModuleNotFoundError: No module named 'postnlpy'

I’m running version 0.92 in a docker container.

ptnijssen · April 27, 2019, 6:59am

I’ve updated the gist by adding a manifest.json file. This is now a requirement as of HA 0.92.

gist.github.com

https://gist.github.com/peternijssen/155c9060923adbc08d0998bbd8ed44bf

init.py

"""The postnl component."""

manifest.json

{
  "domain": "postnl",
  "name": "Postnl",
  "documentation": "https://www.home-assistant.io/components/postnl",
  "requirements": [
    "postnlpy==0.4.1"
  ],
  "dependencies": [],
  "codeowners": []
}

sensor.py

"""Sensor for PostNL packages."""
import datetime
import logging

import voluptuous as vol

from homeassistant.components.sensor import PLATFORM_SCHEMA
from homeassistant.const import (
    ATTR_ATTRIBUTION, CONF_NAME, CONF_PASSWORD, CONF_SCAN_INTERVAL, CONF_USERNAME)
import homeassistant.helpers.config_validation as cv

This file has been truncated. show original

After restart, It should work.

Luukxt8 · April 27, 2019, 7:10am

Thanks alot @ptnijssen! Wish I could tell you that it fixed the issue. But I get a different error now…

Traceback (most recent call last):
File “/usr/src/app/homeassistant/helpers/entity_platform.py”, line 261, in _async_add_entity
await entity.async_device_update(warning=False)
File “/usr/src/app/homeassistant/helpers/entity.py”, line 377, in async_device_update
await self.hass.async_add_executor_job(self.update)
File “/usr/local/lib/python3.7/concurrent/futures/thread.py”, line 57, in run
result = self.fn(*self.args, **self.kwargs)
File “/usr/src/app/homeassistant/util/init.py”, line 224, in wrapper
result = method(*args, **kwargs)
File “/config/custom_components/postnl/sensor.py”, line 92, in update
shipments = self._api.get_package_deliveries(True)
File “/config/deps/lib/python3.7/site-packages/postnlpy/postnlapi.py”, line 114, in get_package_deliveries
self.update()
File “/config/deps/lib/python3.7/site-packages/postnlpy/postnlapi.py”, line 79, in update
self.update_letters()
File “/config/deps/lib/python3.7/site-packages/postnlpy/postnlapi.py”, line 105, in update_letters
document_id = documents.get(‘documents’)[0].get(‘documentId’)
IndexError: list index out of range
2019-04-27 07:07:15 ERROR (MainThread) [homeassistant.components.sensor] postnl: Error on device update!
Traceback (most recent call last):
File “/usr/src/app/homeassistant/helpers/entity_platform.py”, line 261, in _async_add_entity
await entity.async_device_update(warning=False)
File “/usr/src/app/homeassistant/helpers/entity.py”, line 377, in async_device_update
await self.hass.async_add_executor_job(self.update)
File “/usr/local/lib/python3.7/concurrent/futures/thread.py”, line 57, in run
result = self.fn(*self.args, **self.kwargs)
File “/usr/src/app/homeassistant/util/init.py”, line 224, in wrapper
result = method(*args, **kwargs)
File “/config/custom_components/postnl/sensor.py”, line 140, in update
letters = self._api.get_letters()
File “/config/deps/lib/python3.7/site-packages/postnlpy/postnlapi.py”, line 132, in get_letters
self.update()
File “/config/deps/lib/python3.7/site-packages/postnlpy/postnlapi.py”, line 79, in update
self.update_letters()
File “/config/deps/lib/python3.7/site-packages/postnlpy/postnlapi.py”, line 105, in update_letters
document_id = documents.get(‘documents’)[0].get(‘documentId’)
IndexError: list index out of range

Could this be an user error on my side? Running version 92.1 now.

ptnijssen · April 27, 2019, 7:16am

Seems like something I need to fix. I suppose not every letter has an image or the API is not giving a good response.

Let me try to fix something over here. Will report back in half an hour.

Luukxt8 · April 27, 2019, 7:16am

Thanks. Take your time.

ptnijssen · April 27, 2019, 7:28am

I’ve updated the custom component. Please see the change in the gist. (Basically change the dependency to 0.2.4).

Either it’s solved, or you will have a very similar error. I aim for the first case

Luukxt8 · April 27, 2019, 7:45am

Thank you for the quick fixes! It works now

Remco_van_Geel · April 27, 2019, 9:08am

very nice!! maybe it’s an idea to add it into the custom updater? so we can update the component and the card very easy. and never miss some work of you

ptnijssen · April 27, 2019, 9:10am

Thanks Remco!
I’ve already marked it as an thing to do: https://github.com/peternijssen/lovelace-postnl/issues/5

In the end, I also want to update the component in HA. Just making sure it’s now feature complete and it’s working for everyone, before breaking stuff