Skip to content

This Home Assistant custom_card allows you to monitor and control your iParcelBox smart parcel delivery box directly within Home Assistant.

License

Notifications You must be signed in to change notification settings

gadget-man/iparcelbox-card

Repository files navigation

iParcelBox Card by @gadget-man

GH-release GH-downloads GH-last-commit GH-code-size hacs_badge

Screenshot

Home-Assistant custom-integration

This Lovelace custom card requires the iParcelBox custom integration, available at https://github.com/gadget-man/iparcelboxHA.

Install

iParcelBox Card is available from HACS as a custom repository. In your HA HACS dashboard, select 'Frontend', then select the 3 dots in the top right corner of the screen and choose 'Custom Repositories'. Enter https://github.com/gadget-man/iparcelbox-card and select Lovelace as the category. If you don't have HACS installed, follow the manual installation instructions.

Configuration is done in the UI

You can configure this custom-card using the UI. Simply select the device from the list and update any of the optional settings.

Configuration

Alternatively you can manually add the integration and provide the relevant Device name (note it should be an underscore, not dash), Device ID and other settings:

type: custom:iparcelbox-card
device_name: iParcelBox_XXXXXXXX
device_id: XXXXXXXX
name: Front Driveway
show_header: true
show_status: true
show_attributes: true
show_buttons: true
image: /hacsfiles/iparcelbox-card/iparcelbox-card.png

By default, the custom-card will display a generic background. Select your own background by providing the file path, or enter 'none' in the image field to remove the background image.

Options

Name Type Requirement Description Default
type string Required custom:iparcelbox-card
device_name string Required iParcelBox Integration device name none
device_id string Required iParcelBox Integration device ID. none
name string Optional Card name - will appear at the top none
image string Optional Path to image file - set 'none' for blank iParcelBox image
show_header boolean Optional Show boxStatus in header true
show_status boolean Optional Show status icons on left true
show_attributes boolean Optional Show attributes on rigt side true
show_buttons boolean Optional Show allowDelivery, emptyBox, lockBox true

iParcelBox Premium Subscription

An iParcelBox Premium subscription is required to connect your iParcelBox device to Home Assistant. More details can be found at https://www.iparcelbox.com/faqs/#premium

Manual installation

  1. Download iparcelbox-card.js and iparcelbox-card.png from the [latest release][releases] and move these files to a new config/www/community/iparcelbox-card folder.
  2. Ensure you have advanced mode enabled (accessible via your username in the bottom left corner)
  3. Go to Configuration -> Lovelace Dashboards -> Resources.
  4. Add /local/community/iparcelbox-card/iparcelbox-card.js with type JS module.
  5. Refresh the page? Or restart Home Assistant? The card should eventually be there.

Contributions are welcome!

If you want to contribute to this please read the Contribution guidelines

About

This Home Assistant custom_card allows you to monitor and control your iParcelBox smart parcel delivery box directly within Home Assistant.

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project

 

Packages