diff --git a/source/_components/sensor.ups.markdown b/source/_components/sensor.ups.markdown index a610337f619..e20dba0d69a 100644 --- a/source/_components/sensor.ups.markdown +++ b/source/_components/sensor.ups.markdown @@ -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.: +
update_interval: + # At least one of these must be specified: + days: 0 + hours: 0 + minutes: 3 + seconds: 30 + milliseconds: 0 ++
+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. +