home-assistant.io/source/_components/usps.markdown

title, description, logo, ha_category, ha_release, ha_iot_class, redirect_from

title	description	logo	ha_category	ha_release	ha_iot_class	redirect_from
USPS	Interface USPS mail and package information to Home Assistant.	usps.png	Postal Service Camera Sensor	0.52	Cloud Polling	/components/camera.usps/ /components/sensor.usps/

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.

There is currently support for the following device types within Home Assistant:

• Camera
• Sensor

Prerequisites

This integration 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. PhantomJS is not available for Alpine Linux. Therefore it is currently not possible to use this integration on Hass.io.

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.

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:

• Ubuntu 16 (Selenium server portion not necessary)
• RHEL/Centos 7

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

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.

Camera

The usps camera integration allows you to view the mail piece images made available through USPS via the Informed Delivery service. You must "Opt-In" to Informed Delivery to see mail images. This works in concert with USPS sensors.

Configuration

To customize the interval that mail images are rotated in the mail camera you can edit your configuration.yaml file with the following settings:

# Example configuration.yaml entry
camera:
  - platform: usps
    scan_interval: 5

To enable this camera in your installation, set up the USPS integration first.

Sensor

The usps sensor integration allows you to view statistics on incoming mail and packages made available through USPS via the Informed Delivery service. You must "Opt-In" to Informed Delivery to see mail images. This works in concert with USPS camera.

To enable this sensor in your installation, set up the USPS integration first.