update ups doc (#2058)

This commit is contained in:
happyleavesaoc 2017-02-16 12:16:53 -05:00 committed by Fabian Affolter
parent 5df5b69aa8
commit 2894153a04

View File

@ -12,7 +12,7 @@ ha_category: Sensor
ha_release: 0.39
---
The `ups` platform allows one to track deliveries by the [UPS](https://www.ups.com/). To use this sensor, you need a [My UPS Account](https://www.ups.com/one-to-one/login).
The `ups` platform allows one to track deliveries by the [UPS](https://www.ups.com/). To use this sensor, you need a [My UPS Account](https://www.ups.com/mychoice).
To enable this sensor, add the following lines to your `configuration.yaml`:
@ -24,8 +24,24 @@ sensor:
password: YOUR_PASSWORD
```
Configuration options for the USPS Sensor:
Configuration options for the UPS Sensor:
- **username** (*Required*): The username to access the UPS service.
- **username** (*Required*): The username to access the UPS My Choice service.
- **password** (*Required*): The password for the given username.
- **name** (*Optional*): Name the sensor.
- **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'>
The UPS sensor logs into the UPS My Choice website to scrape package data. It does not use an API. Use at your own risk.
</p>