jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-22 16:56:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update Uber sensor component configuration (#7046)

Browse Source 
* Update Uber sensor component configuration

* Minor changes
This commit is contained in:
Klaas Schoute 2018-10-24 16:08:51 +02:00 committed by Fabian Affolter
parent f4261d446c
commit e7b3d3ebf5
1 changed files with 35 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
source/_components/sensor.uber.markdown
View File

@ -16,7 +16,11 @@ ha_release: 0.16
The `uber` sensor will give you time and price estimates for all available [Uber](https://uber.com) products at the given location. The `ATTRIBUTES` are used to provide extra information about products, such as estimated trip duration, distance and vehicle capacity. By default, 2 sensors will be created for each product at the given `start` location, one for pickup time and one for current price. The sensor is powered by the official Uber [API](https://developer.uber.com/).
You must create an application [here](https://developer.uber.com/dashboard/create) to obtain a `server_token`.
## {% linkable_title Setup %}
You must [create an application](https://developer.uber.com/dashboard/create) in the [Uber developer Dashboard](https://developer.uber.com) to obtain a `server_token`.
## {% linkable_title Configuration %}
To enable this sensor, add the following lines to your `configuration.yaml` file:
@ -24,19 +28,39 @@ To enable this sensor, add the following lines to your `configuration.yaml` file
# Example configuration.yaml entry
sensor:
- platform: uber
server_token: 'BeAPPTDsWZSHLf7fd9OWjZkIezweRw18Q8NltY27'
server_token: YOUR_UBER_SERVER_TOKEN
```
Configuration variables:
{% configuration %}
server_token:
description: The Server API token.
required: true
type: string
start_latitude:
description: The starting latitude for a trip.
required: false
default: to the latitude in your `configuration.yaml` file.
type: float
start_longitude:
description: The starting longitude for a trip.
required: false
default: to the longitude in your `configuration.yaml` file.
type: float
end_latitude:
description: The ending latitude for a trip. While `end_latitude` is optional, it is strongly recommended to provide an `end_latitude`/`end_longitude` when possible as you will get more accurate price and time estimates.
required: false
type: float
end_longitude:
description: The ending longitude for a trip. While `end_longitude` is optional, it is strongly recommended to provide an `end_latitude`/`end_longitude` when possible as you will get more accurate price and time estimates.
required: false
type: float
product_ids:
description: A list of Uber product UUIDs. If provided, sensors will only be created for the given product IDs. Please note that product IDs are region and some times even more specific geographies based. The easiest way to find a UUID is to click on a sensor in the Home Assistant frontend and look for "Product ID" in the attributes.
required: false
type: list
{% endconfiguration %}
- **server_token** (*Required*): A server token obtained from [developer.uber.com](https://developer.uber.com) after [creating an app](https://developer.uber.com/dashboard/create).
- **start_latitude** (*Optional*): The starting latitude for a trip. Defaults to the latitude in your `configuration.yaml` file.
- **start_longitude** (*Optional*): The starting longitude for a trip. Defaults to the longitude in your `configuration.yaml` file.
- **end_latitude** (*Optional*): The ending latitude for a trip. While `end_latitude` is optional, it is strongly recommended to provide an `end_latitude`/`end_longitude` when possible as you will get more accurate price and time estimates.
- **end_longitude** (*Optional*): The ending longitude for a trip. While `end_longitude` is optional, it is strongly recommended to provide an `end_latitude`/`end_longitude` when possible as you will get more accurate price and time estimates.
- **product_ids** (*Options*): A list of Uber product UUIDs. If provided, sensors will only be created for the given product IDs. Please note that product IDs are region and some times even more specific geographies based. The easiest way to find a UUID is to click on a sensor in the Home Assistant frontend and look for "Product ID" in the attributes.
A full configuration entry could look like the sample below:
A full configuration entry could look like the sample below:
```yaml
# Example configuration.yaml entry