home-assistant.io/source/_components/sensor.usps.markdown
2017-06-13 19:26:01 +02:00

1.3 KiB

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 Sensor Instructions on how to set up USPS sensors within Home Assistant. 2017-01-06 08:00 true false true true usps.png Sensor 0.36 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 by clicking "Get Started Now" on this page. You must also "Opt-In" to Informed Delivery to see inbound mail.

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

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

You will see two new sensors, one for packages and one for mail.

Configuration options for the USPS Sensor:

  • username (Required): The username to access the MyUSPS service.
  • password (Required): The password for the given username.
  • name (Optional): Prefix for sensor names (defaults to "USPS")

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