Skip to content

Commit c05021e

Browse files
happyleavesaocfabaff
authored andcommitted
update usps doc (home-assistant#1880)
1 parent 10248cd commit c05021e

File tree

1 file changed

+19
-4
lines changed

1 file changed

+19
-4
lines changed

source/_components/sensor.usps.markdown

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ ha_category: Sensor
1212
ha_release: 0.36
1313
---
1414

15-
The `usps` platform allows one to track deliveries by the [US Postal Service (USPS)](https://www.usps.com/).
15+
The `usps` platform allows one to track deliveries by the [US Postal Service (USPS)](https://www.usps.com/). You must opt-in to [MyUSPS](https://my.usps.com/mobileWeb/pages/intro/start.action) prior to using this sensor. Doing so will confirm your address.
1616

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

@@ -24,9 +24,24 @@ sensor:
2424
password: YOUR_PASSWORD
2525
```
2626
27-
Configuration options for the a TCP Sensor:
27+
Configuration options for the USPS Sensor:
2828
29-
- **username** (*Required*): The username to access the USPS service.
29+
- **username** (*Required*): The username to access the MyUSPS service.
3030
- **password** (*Required*): The password for the given username.
31-
- **update_interval** (*Optional*): Interval in minutes for the updates.
31+
- **name** (*Optional*): Name the sensor (default: your mailing address).
32+
- **update_inverval** (*Optional*): Minimum time interval between updates. Default is 1 hour. Supported formats:
33+
- `update_interval: 'HH:MM:SS'`
34+
- `update_interval: 'HH:MM'`
35+
- Time period dictionary, e.g.:
36+
<pre>update_interval:
37+
# At least one of these must be specified:
38+
days: 0
39+
hours: 0
40+
minutes: 3
41+
seconds: 30
42+
milliseconds: 0
43+
</pre>
3244
45+
<p class='note warning'>
46+
The USPS sensor logs into the MyUSPS website to scrape package data. It does not use an API.
47+
</p>

0 commit comments

Comments
 (0)