You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: source/_components/sensor.usps.markdown
+19-4Lines changed: 19 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ ha_category: Sensor
12
12
ha_release: 0.36
13
13
---
14
14
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.
16
16
17
17
To enable this sensor, add the following lines to your `configuration.yaml`:
18
18
@@ -24,9 +24,24 @@ sensor:
24
24
password: YOUR_PASSWORD
25
25
```
26
26
27
-
Configuration options for the a TCP Sensor:
27
+
Configuration options for the USPS Sensor:
28
28
29
-
- **username** (*Required*): The username to access the USPS service.
29
+
- **username** (*Required*): The username to access the MyUSPS service.
30
30
- **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>
32
44
45
+
<p class='note warning'>
46
+
The USPS sensor logs into the MyUSPS website to scrape package data. It does not use an API.
0 commit comments