jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-05-30 06:46:49 +00:00
Code Issues Packages Projects Releases Wiki Activity
home-assistant.io/source/_components/usps.markdown
Jorim Tielemans c466e7b556 Update USPS configuration (#7023) 
Using new config vars
Add linkable titles
Remove trailing spaces
2018-10-25 05:20:25 +03:00

3.3 KiB
Raw Blame History

layout, title, description, date, sidebar, comments, sharing, footer, logo, ha_category, ha_release, ha_iot_class
layout title description date sidebar comments sharing footer logo ha_category ha_release ha_iot_class
page USPS Interface USPS mail and package information to Home Assistant. 2017-07-28 20:00 true false true true usps.png Postal Service 0.52 Cloud Polling

The usps platform allows one to track deliveries and inbound mail from the US Postal Service (USPS). In addition to having a USPS account, you will need to complete the "Opt-In" process for packages by clicking "Get Started Now" on this page. You must also "Opt-In" to Informed Delivery to see inbound mail.

{% linkable_title Prerequisites %}

This component requires that a headless-capable web browser is installed on your system - either PhantomJS or Google Chrome. Preferably use Chrome if your operating system supports it, since PhantomJS is deprecated.

If you are using a Raspberry Pi, you must use PhantomJS.

Hass.io containers are based on Alpine Linux. PhanthomJS is not available for Alpine Linux. Therefore it is currently not possible to use this component on Hass.io.

{% linkable_title PhantomJS %}

Install the latest version of PhantomJS. Ensure the executable is on your PATH. phantomjs --version should work and report the correct version. This is the default option and requires no further configuration.

Don't use apt-get to install PhantomJS. This version is not compatible.

If you use the PhantomJS option, specify driver: phantomjs in your usps configuration.

{% linkable_title Chrome %}

Install Chrome 59 or greater (preferably the most recent). Install the latest Chromedriver. Ensure both executables are on your PATH. google-chrome --version and chromedriver --version should work and report the correct version.

OS-specific instructions:

If you use the Chrome option, specify driver: chrome in your usps configuration.

{% linkable_title Configuration %}

To enable this component, add the following lines to your configuration.yaml:

# Example configuration.yaml entry
usps:
    username: YOUR_USERNAME
    password: YOUR_PASSWORD

You will see two new sensors, one for packages and one for mail and a camera to rotate through images of incoming mail for the current day.

{% configuration %} username: description: The username to access the MyUSPS service. required: true type: string password: description: The password for the given username. required: true type: string driver: description: Specify if you're using phantomjs or chrome. required: false type: string default: phantomjs name: description: The prefix for sensor names. required: false type: string default: usps {% endconfiguration %}

The USPS sensor logs into the MyUSPS website to scrape package data. It does not use an API.