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-07-16 13:56:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update sensor.usps.markdown (#2662)

Browse Source
This commit is contained in:
happyleavesaoc 2017-05-19 13:09:01 -05:00 committed by Fredrik Lindqvist
parent d5e7847682
commit 8661c807d5
1 changed files with 5 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
source/_components/sensor.usps.markdown
View File

@ -12,8 +12,8 @@ ha_category: Sensor
ha_release: 0.36 ha_release: 0.36
--- ---
The `usps` platform allows one to track deliveries by the [US Postal Service (USPS)](https://www.usps.com/). The `usps` platform allows one to track deliveries and inbound mail from the [US Postal Service (USPS)](https://www.usps.com/).
In addition to having a USPS account, you will need to complete the "Opt-In" process by clicking "Get Started Now" on [this page](https://my.usps.com/mobileWeb/pages/intro/start.action). Currently, you also will need to have a package listed in the "Package Dashboard" in order for the component to complete set-up. In addition to having a USPS account, you will need to complete the "Opt-In" process by clicking "Get Started Now" on [this page](https://my.usps.com/mobileWeb/pages/intro/start.action). You must also "Opt-In" to [Informed Delivery](https://informeddelivery.usps.com/box/pages/intro/start.action) to see inbound mail.
To enable this sensor, add the following lines to your `configuration.yaml`: To enable this sensor, add the following lines to your `configuration.yaml`:
@ -25,23 +25,13 @@ sensor:
password: YOUR_PASSWORD password: YOUR_PASSWORD
``` ```
You will see two new sensors, one for packages and one for mail.
Configuration options for the USPS Sensor: Configuration options for the USPS Sensor:
- **username** (*Required*): The username to access the MyUSPS service. - **username** (*Required*): The username to access the MyUSPS service.
- **password** (*Required*): The password for the given username. - **password** (*Required*): The password for the given username.
- **name** (*Optional*): Name the sensor (default: your mailing address). - **name** (*Optional*): Prefix for sensor names (defaults to "USPS")
- **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.:
<pre>update_interval:
# At least one of these must be specified:
days: 0
hours: 0
minutes: 3
seconds: 30
milliseconds: 0
</pre>
<p class='note warning'> <p class='note warning'>
The USPS sensor logs into the MyUSPS website to scrape package data. It does not use an API. The USPS sensor logs into the MyUSPS website to scrape package data. It does not use an API.