From 8661c807d5f5fe3bffefe4eb767770da2e9c81a5 Mon Sep 17 00:00:00 2001 From: happyleavesaoc Date: Fri, 19 May 2017 13:09:01 -0500 Subject: [PATCH] Update sensor.usps.markdown (#2662) --- source/_components/sensor.usps.markdown | 20 +++++--------------- 1 file changed, 5 insertions(+), 15 deletions(-) diff --git a/source/_components/sensor.usps.markdown b/source/_components/sensor.usps.markdown index 4f07f171e31..062ef7c7f6b 100644 --- a/source/_components/sensor.usps.markdown +++ b/source/_components/sensor.usps.markdown @@ -12,8 +12,8 @@ ha_category: Sensor ha_release: 0.36 --- -The `usps` platform allows one to track deliveries by 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. +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). 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`: @@ -25,23 +25,13 @@ sensor: 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*): 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
-    
+- **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.