update fedex doc (#2059)

This commit is contained in:
happyleavesaoc 2017-02-16 12:17:30 -05:00 committed by Fabian Affolter
parent 2894153a04
commit 584ef519f0

View File

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