Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/jampez77/evri

An integration that adds Evri tracking data into Home Assistant
https://github.com/jampez77/evri

hacs hacs-custom hacs-integration homeassistant homeassistant-custom-component homeassistant-integration homeautomation

Last synced: 27 days ago
JSON representation

An integration that adds Evri tracking data into Home Assistant

Awesome Lists containing this project

README 

        
# ![Logo](https://github.com/jampez77/Evri/blob/main/logo.png "Evri Logo") Evri parcel tracking for Home Assistant



This integration allows you to track Evri parcels in [Home Assistant](https://www.home-assistant.io/) which can be used in your own automations.



---



[![GitHub Release][releases-shield]][releases]

[![License][license-shield]](LICENSE.md)

[![hacs_badge](https://img.shields.io/badge/HACS-Default-orange.svg?style=for-the-badge)](https://github.com/custom-components/hacs)

![Project Maintenance][maintenance-shield]



Enjoying this? Help me out with a :beers: or :coffee:!



[![coffee](https://www.buymeacoffee.com/assets/img/custom_images/black_img.png)](https://www.buymeacoffee.com/whenitworks)



## Installation through [HACS](https://hacs.xyz/)



There is an active [PR](https://github.com/hacs/default/pull/2711) to get this into [HACS](https://hacs.xyz/), once that is merged then you can install the **Evri** integration by searching for it there in HA instance.



Until then you will have to add this repository manually:



Go to HACS -> 3 dot menu -> Custom Repositories:- 



Paste `https://github.com/jampez77/Evri` into Repository field and select `Integration`



Now you should be able to find it in HACS as normal.



You can install the **Evri** integration by searching for it there in HA instance.



## Manual Installation

Use this route only if you do not want to use [HACS](https://hacs.xyz/) and love the pain of manually installing regular updates.

* Add the `evri` folder in your `custom_components` folder



---

## Data 

The integration will automatically create a `Tracked Parcels` sensor. This will show the total number of tracked parcels and the attrributes will list them by tracking number. Additionally it will also has an attribute list for parcel that are currently out for delivery.



Tracking parcels is done entirely via the `track_a_parcel` service call / action. An entity will be create for each parcel and it will automatically be deleted 24 hours after the registered delivery date. There is an optional `post code` paramameter for tracking a parcel, using the delivery post code will retreive more details. 



## Contributing



Contirbutions are welcome from everyone! By contributing to this project, you help improve it and make it more useful for the community. Here's how you can get involved:



### How to Contribute



1. **Report Bugs**: If you encounter a bug, please open an issue with details about the problem and how to reproduce it.

2. **Suggest Features**: Have an idea for a new feature? I'd love to hear about it! Please open an issue to discuss it.

3. **Submit Pull Requests**: If you'd like to contribute code:

   - Fork the repository and create your branch from `main`.

   - Make your changes in the new branch.

   - Open a pull request with a clear description of what you’ve done.



---



[commits-shield]: https://img.shields.io/github/commit-activity/y/jampez77/Evri.svg?style=for-the-badge

[commits]: https://github.com/jampez77/Evri/commits/main

[license-shield]: https://img.shields.io/github/license/jampez77/Evri.svg?style=for-the-badge

[maintenance-shield]: https://img.shields.io/badge/Maintainer-Jamie%20Nandhra--Pezone-blue

[releases-shield]: https://img.shields.io/github/v/release/jampez77/Evri.svg?style=for-the-badge

[releases]: https://github.com/jampez77/Evri/releases