Skip to content

Latest commit

 

History

History
87 lines (57 loc) · 4.46 KB

README.md

File metadata and controls

87 lines (57 loc) · 4.46 KB
Raw

hacs_badge

ParcelsApp Integration for Home Assistant

A Home Assistant integration for ParcelsApp.com, a universal parcel tracking service.

Features

Binary Sensor

Sensor Description
Parcels App Status Monitors the availability of the ParcelsApp.com website

Button

Button Description
Update Parcels App Tracking Updates all parcels not marked as delivered or archived

Services

The integration provides the following services:

parcelsapp.track_package

  • Arguments:
    • tracking_id (Required): The parcel's tracking ID provided by your parcel/delivery company.
    • name (Optional): An optional name for your parcel (used as the sensor name).

parcelsapp.remove_package

  • Arguments:
    • tracking_id (Required): The tracking ID of the package you wish to stop tracking.

Use the parcelsapp.remove_package service to remove a package from tracking. This will delete the associated sensor and stop any further updates for that package.

Tracking Sensor

The track_package service creates a sensor for each tracked package with the following attributes:

Attribute Description
status Current state (archived, delivered, transit, arrived, pickup)
uuid UUID used by the ParcelsApp API
uuid_timestamp Timestamp when the UUID was obtained
message Latest update message from the delivery company
location Latest known location of the parcel
origin Country of departure
destination Destination country or address
carrier Delivery company name
days_in_transit Number of days the parcel has been in transit
last_updated Timestamp of the latest check by the integration
name Name given to the parcel (from the name parameter)
tracking_id The tracking ID of the parcel

Installation

Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.

  1. Add this GitHub repository to HACS as a custom repository, or click the badge above.
  2. Install the "Parcels App" integration via HACS.
  3. Restart Home Assistant.
  4. Add the integration via the Home Assistant UI (Configuration > Integrations > Add Integration > Parcels App).

Configuration

During setup, you'll need to provide:

  1. Your ParcelsApp API key (obtainable from parcelsapp.com/dashboard)
  2. Your destination country (the name of your country in your native language)

Usage

After configuration, you can use the parcelsapp.track_package service to add new packages for tracking. Each tracked package will create a new sensor entity in Home Assistant.

To remove a tracked package, use the parcelsapp.remove_package service with the tracking_id of the package you wish to remove.

Contributing

Contributions to this integration are welcome! Please follow these guidelines:

  1. Use descriptive commit messages and add context to your changes.
  2. Test your changes thoroughly before submitting a pull request.
  3. Update documentation (including this README) if your changes affect user-facing features or setup.

If you find this integration valuable and want to support it in other ways, you can buy me a coffee.