https://github.com/thejeffreystone/usps2mqtt

A simple way to integrate USPS Informed Delivery to Home Assistant
https://github.com/thejeffreystone/usps2mqtt

Last synced: 28 days ago
JSON representation

A simple way to integrate USPS Informed Delivery to Home Assistant

• Host: GitHub
• URL: https://github.com/thejeffreystone/usps2mqtt
• Owner: thejeffreystone
• Created: 2019-11-09T15:46:52.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2021-07-26T12:58:35.000Z (over 3 years ago)
• Last Synced: 2024-08-02T16:01:13.924Z (3 months ago)
• Language: Python
• Size: 25.4 KB
• Stars: 12
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# usps2mqtt

usps2mqtt is a simple way to integrate USPS Informaed Delivery with Home Assistant. 

I did a video on this setup over on [youtube](https://www.youtube.com/watch?v=TjVeoAKn-r0)

This is a repackaged version of [USPS Mail Integration with Home Assistant](https://blog.kalavala.net/usps/homeassistant/mqtt/2018/01/12/usps.html) that can be deployed on any host with python 3 and access to your Home Assistant MQTT server. 

The script logs into your email, finds the email from USPS Informed Delivery, gets the count of mail and packages along with photos and then published the results to your MQTT Server.  

## Requirements

This script was written in python3 and requires the installation of some python libraires, and imagemagik 

## Installation

* Clone this repo: `git clone https://github.com/thejeffreystone/usps2mqtt.git`

* cd to dir `usps2mqtt`

* install required python libraries: `pip install -r requirements.txt`

* install imagemagick `sudo apt-get install imagemagick`

* cp env-sample to .env: `cp env-sample .env`

* Edit .env to match your environmnt:

```

# MQTT Hosts details

MQTT_SERVER = 127.0.0.1 

MQTT_SERVER_PORT = 1883

# MQTT User name and Password

MQTT_USERNAME = mqtt

MQTT_PASSWORD = pass

# MQTT Topic

MQTT_USPS_MAIL_TOPIC = house/usps/mails

MQTT_USPS_PACKAGE_TOPIC = house/usps/packages

# Email Host Details

# For Email Hosts:

# GMail	- imap.gmail.com / 993

# Yahoo	- imap.mail.yahoo.com / 993

# Outlook	- imap-mail.outlook.com / 993

 

# Update host and port based on your provider

HOST = imap.gmail.com

PORT = 993

# Your email login creds

USERNAME = [email protected]

PASSWORD = pass

# Image Output location

IMAGE_OUTPUT_PATH = /var/www/html/images/

# Update Interval - default 5 mins

SLEEP_TIME_IN_SECONDS = 300

```

 

## Running usps2mqtt

Simple execute `usps2matt.py` 

You will want to automate the execution via cron, pm2, supervisor, or the like. 

## Integrating into Home Assistant

Next you just have to setup some sensors. 

For an example see my [usps package](https://github.com/thejeffreystone/home-assistant-configuration/blob/master/config/packages/usps.yaml).