Skip to content

Latest commit

 

History

History
110 lines (88 loc) · 4.42 KB

README.md

File metadata and controls

110 lines (88 loc) · 4.42 KB
Raw

Lovelace PostNL

hacs_badge

Home Assistant Lovelace card for PostNL.

WARNING: This card is not compatible with the current Home Assistant component. Please read this topic: https://community.home-assistant.io/t/lovelace-postnl/112433

Example

Features

  • Display of letters
  • Carousel of images of letters
  • List of packages enroute to you
  • List of packages submitted by you
  • Contains direct links to the web interface of PostNL

Installation

  1. Download the lovelace-postnl.js from the latest release and store it in your configuration/www folder.
  2. Configure Lovelace to load the card:
resources:
  - url: /local/postnl-card.js
    type: module

Installation and tracking with HACS (Recommended)

  1. Make sure you've the HACS component installed and working
  2. Search for the PostNL card in the store
  3. Configure Lovelace to load the card:
resources:
  - url: /community_plugin/lovelace-postnl-card/postnl-card.js
    type: module

Installation and tracking with custom updater (Deprecated)

  1. Make sure you've the custom_updater component installed and working.
  2. Add a new reference under card_urls in your custom_updater configuration in configuration.yaml.
custom_updater:
  card_urls:
    - https://raw.githubusercontent.com/peternijssen/lovelace-postnl/master/tracker.json
  1. Configure Lovelace to load the card:
resources:
  - url: /customcards/postnl-card.js
    type: module
  1. Run the service custom_updater.check_all or click the "CHECK" button if you use the tracker-card.
  2. Refresh the website.

Example usage

cards:
  - type: "custom:postnl-card"
    delivery: sensor.postnl_delivery
    distribution: sensor.postnl_distribution
    letters: sensor.postnl_letters
    hide:
      delivered: false
      first_letter: false
      header: false
    date_format: "DD MMM YYYY"
    time_format: "HH:mm"
    past_days: 1

Available configuration options

Name Type Default Since Description
delivery string - v0.8 The delivery sensor. Don't add this if you are not interested in package deliveries
distribution string - v0.8 The distribution sensor. Don't add this if you are not interested in package distribution
letters string - v0.8 The letters sensor. Don't add this if you are not interested in letters
name string PostNL v0.8 Override the card name
icon string mdi:mailbox v0.8 Icon next to the card name
hide object object v0.8 Control specifically information fields to show.
date_format string DD MMM YYYY v0.9 Overrides the default date format.
time_format string HH:mm v0.9 Overrides the default time format.
past_days integer 1 v0.9 Defines how many days you want to see from the past.

Hide object

Name Type Default Since Description
delivered bool false v0.8 Controls if you want to show packages that are delivered already
first_letter bool false v0.8 Controls if you want to show the image of the very first letter
header bool false v0.9 Controls if it displays the top most header

Inspired by

Contributors