mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-18 17:08:58 +00:00
1.5 KiB
1.5 KiB
layout, title, description, date, sidebar, comments, sharing, footer, logo, ha_category, ha_release
layout | title | description | date | sidebar | comments | sharing | footer | logo | ha_category | ha_release |
---|---|---|---|---|---|---|---|---|---|---|
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 |
The usps
platform allows one to track deliveries by the US Postal Service (USPS). You must opt-in to MyUSPS prior to using this sensor. Doing so will confirm your address.
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
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): Name the sensor (default: your mailing address).
- update_inverval (Optional): Minimum time interval between updates. Default is 1 hour. Supported formats:
update_interval: 'HH:MM:SS'
update_interval: 'HH:MM'
- Time period dictionary, e.g.:
update_interval: # At least one of these must be specified: days: 0 hours: 0 minutes: 3 seconds: 30 milliseconds: 0
The USPS sensor logs into the MyUSPS website to scrape package data. It does not use an API.