Skip to content

Commit 68bfa01

Browse files
committed
Merge pull request home-assistant#324 from robbiet480/uber
Add Uber component documentation
2 parents 458c969 + 21d0332 commit 68bfa01

File tree

2 files changed

+43
-0
lines changed

2 files changed

+43
-0
lines changed
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
layout: page
3+
title: "Uber"
4+
description: "How to integrate Uber in Home Assistant"
5+
date: 2016-03-24 23:04
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: uber.png
11+
ha_category: Sensor
12+
ha_iot_class: "Local Polling"
13+
---
14+
15+
16+
The `uber` sensor will give you time and price estimates for all available [Uber](https://uber.com) products at the given `start_latitude` and `start_longitude`.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/).
17+
18+
19+
You must create an application [here](https://developer.uber.com/dashboard/create) to obtain a `server_token`.
20+
21+
To enable this sensor, add the following lines to your `configuration.yaml` file:
22+
23+
```yaml
24+
# Example configuration.yaml entry
25+
sensor:
26+
platform: uber
27+
start_latitude: 37.8116380
28+
start_longitude: -122.2648050
29+
end_latitude: 37.7768520
30+
end_longitude: -122.4155500
31+
server_token: 'BeAPPTDsWZSHLf7fd9OWjZkIezweRw18Q8NltY27'
32+
product_ids:
33+
- '04a497f5-380d-47f2-bf1b-ad4cfdcb51f2'
34+
```
35+
36+
Configuration variables:
37+
38+
- **start_latitude** (*Required*): The starting latitude for a trip.
39+
- **start_longitude** (*Required*): The starting longitude for a trip.
40+
- **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.
41+
- **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.
42+
- **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).
43+
- **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.
5.64 KB
Loading

0 commit comments

Comments
 (0)