232 lines
13 KiB
HTML
232 lines
13 KiB
HTML
<!doctype html>
|
|
<!--[if lt IE 7]> <html class="no-js lt-ie9 lt-ie8 lt-ie7"> <![endif]-->
|
|
<!--[if IE 7]> <html class="no-js lt-ie9 lt-ie8"> <![endif]-->
|
|
<!--[if IE 8]> <html class="no-js lt-ie9"> <![endif]-->
|
|
<!--[if gt IE 8]><!--> <html> <!--<![endif]-->
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
|
<title>Uber - Home Assistant</title>
|
|
<meta name="author" content="Home Assistant">
|
|
<meta name="description" content="How to integrate Uber in Home Assistant">
|
|
<meta name="viewport" content="width=device-width">
|
|
<link rel="canonical" href="https://home-assistant.io/components/sensor.uber/">
|
|
<meta property="fb:app_id" content="338291289691179">
|
|
<meta property="og:title" content="Uber">
|
|
<meta property="og:site_name" content="Home Assistant">
|
|
<meta property="og:url" content="https://home-assistant.io/components/sensor.uber/">
|
|
<meta property="og:type" content="article">
|
|
<meta property="og:description" content="How to integrate Uber in Home Assistant">
|
|
<meta property="og:image" content="https://home-assistant.io/images/default-social.png">
|
|
<meta name="twitter:card" content="summary_large_image">
|
|
<meta name="twitter:site" content="@home_assistant">
|
|
<meta name="twitter:title" content="Uber">
|
|
<meta name="twitter:description" content="How to integrate Uber in Home Assistant">
|
|
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
|
|
<link href="/stylesheets/screen.css" media="screen, projection, print" rel="stylesheet">
|
|
<link href="/atom.xml" rel="alternate" title="Home Assistant" type="application/atom+xml">
|
|
<link rel='shortcut icon' href='/images/favicon.ico' />
|
|
<link rel='icon' type='image/png' href='/images/favicon-192x192.png' sizes='192x192' />
|
|
</head>
|
|
<body >
|
|
<header class='site-header'>
|
|
<div class="grid-wrapper">
|
|
<div class="grid">
|
|
<div class="grid__item three-tenths lap-two-sixths palm-one-whole ha-title">
|
|
<a href="/" class="site-title">
|
|
<img width='40' src='/demo/favicon-192x192.png'>
|
|
<span>Home Assistant</span>
|
|
</a>
|
|
</div>
|
|
<div class="grid__item seven-tenths lap-four-sixths palm-one-whole">
|
|
<nav>
|
|
<input type="checkbox" id="toggle">
|
|
<label for="toggle" class="toggle" data-open="Main Menu" data-close="Close Menu"></label>
|
|
<ul class="menu pull-right">
|
|
<li><a href="/getting-started/">Getting started</a></li>
|
|
<li><a href="/components/">Components</a></li>
|
|
<li><a href="/docs/">Docs</a></li>
|
|
<li><a href="/cookbook/">Examples</a></li>
|
|
<li><a href="/developers/">Developers</a></li>
|
|
<li><a href="/blog/">Blog</a></li>
|
|
<li><a href="/help/">Need help?</a></li>
|
|
<li><a href='#' class='show-search'><i class="icon-search"></i></a></li>
|
|
</ul>
|
|
</nav>
|
|
<div class='search-container' style='display: none'>
|
|
<div class='search'>
|
|
<i class="icon-search"></i>
|
|
<input id='search' placeholder='Search the docs…'>
|
|
<a href='#' class='close'><i class="icon-remove-sign"></i></a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div class="grid-wrapper">
|
|
<div class="grid grid-center">
|
|
<div class="grid__item two-thirds lap-one-whole palm-one-whole">
|
|
<article class="page">
|
|
<header>
|
|
<h1 class="title indent">
|
|
Uber
|
|
</h1>
|
|
</header>
|
|
<hr class="divider">
|
|
<p>The <code class="highlighter-rouge">uber</code> sensor will give you time and price estimates for all available <a href="https://uber.com">Uber</a> products at the given location. The <code class="highlighter-rouge">ATTRIBUTES</code> 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 <code class="highlighter-rouge">start</code> location, one for pickup time and one for current price. The sensor is powered by the official Uber <a href="https://developer.uber.com/">API</a>.</p>
|
|
<p>You must create an application <a href="https://developer.uber.com/dashboard/create">here</a> to obtain a <code class="highlighter-rouge">server_token</code>.</p>
|
|
<p>To enable this sensor, add the following lines to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
|
|
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
|
|
<span class="s">sensor</span><span class="pi">:</span>
|
|
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">uber</span>
|
|
<span class="s">server_token</span><span class="pi">:</span> <span class="s1">'</span><span class="s">BeAPPTDsWZSHLf7fd9OWjZkIezweRw18Q8NltY27'</span>
|
|
</code></pre>
|
|
</div>
|
|
<p>Configuration variables:</p>
|
|
<ul>
|
|
<li><strong>server_token</strong> (<em>Required</em>): A server token obtained from <a href="https://developer.uber.com">developer.uber.com</a> after <a href="https://developer.uber.com/dashboard/create">creating an app</a>.</li>
|
|
<li><strong>start_latitude</strong> (<em>Optional</em>): The starting latitude for a trip. Defaults to the latitude in your <code class="highlighter-rouge">configuration.yaml</code> file.</li>
|
|
<li><strong>start_longitude</strong> (<em>Optional</em>): The starting longitude for a trip. Defaults to the longitude in your <code class="highlighter-rouge">configuration.yaml</code> file.</li>
|
|
<li><strong>end_latitude</strong> (<em>Optional</em>): The ending latitude for a trip. While <code class="highlighter-rouge">end_latitude</code> is optional, it is strongly recommended to provide an <code class="highlighter-rouge">end_latitude</code>/<code class="highlighter-rouge">end_longitude</code> when possible as you will get more accurate price and time estimates.</li>
|
|
<li><strong>end_longitude</strong> (<em>Optional</em>): The ending longitude for a trip. While <code class="highlighter-rouge">end_longitude</code> is optional, it is strongly recommended to provide an <code class="highlighter-rouge">end_latitude</code>/<code class="highlighter-rouge">end_longitude</code> when possible as you will get more accurate price and time estimates.</li>
|
|
<li><strong>product_ids</strong> (<em>Options</em>): 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.</li>
|
|
</ul>
|
|
<p>A full configuration entry could look like the sample below:</p>
|
|
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
|
|
<span class="s">sensor</span><span class="pi">:</span>
|
|
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">uber</span>
|
|
<span class="s">start_latitude</span><span class="pi">:</span> <span class="s">37.8116380</span>
|
|
<span class="s">start_longitude</span><span class="pi">:</span> <span class="s">-122.2648050</span>
|
|
<span class="s">end_latitude</span><span class="pi">:</span> <span class="s">37.7768520</span>
|
|
<span class="s">end_longitude</span><span class="pi">:</span> <span class="s">-122.4155500</span>
|
|
<span class="s">server_token</span><span class="pi">:</span> <span class="s1">'</span><span class="s">BeAPPTDsWZSHLf7fd9OWjZkIezweRw18Q8NltY27'</span>
|
|
<span class="s">product_ids</span><span class="pi">:</span>
|
|
<span class="pi">-</span> <span class="s1">'</span><span class="s">04a497f5-380d-47f2-bf1b-ad4cfdcb51f2'</span>
|
|
</code></pre>
|
|
</div>
|
|
</article>
|
|
</div>
|
|
<aside id="sidebar" class="grid__item one-third lap-one-whole palm-one-whole">
|
|
<div class="grid">
|
|
<section class="aside-module grid__item one-whole lap-one-half">
|
|
<div class='edit-github'><a href='https://github.com/home-assistant/home-assistant.github.io/tree/current/source/_components/sensor.uber.markdown'>Edit this page on GitHub</a></div>
|
|
<div class='brand-logo-container section'>
|
|
<img src='/images/supported_brands/uber.png' />
|
|
</div>
|
|
<div class='section'>
|
|
IoT class<sup><a href='/blog/2016/02/12/classifying-the-internet-of-things/#classifiers'><i class="icon-info-sign"></i></a></sup>: Cloud Polling
|
|
</div>
|
|
<div class='section'>
|
|
Introduced in release: 0.16
|
|
</div>
|
|
<div class='section'>
|
|
Source:
|
|
<a href='https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/sensor/uber.py'>sensor/uber.py</a>
|
|
</div>
|
|
<div class='section'>
|
|
<h1 class="title delta">Category Transport</h1>
|
|
<ul class='divided'>
|
|
<li>
|
|
<a href='/components/sensor.deutsche_bahn/'>Deutsche Bahn</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.dublin_bus_transport/'>Dublin Bus Transport</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.google_travel_time/'>Google Maps Travel Time</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.irish_rail_transport/'>Irish Rail Transport</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.london_underground/'>London Underground</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.lyft/'>Lyft Sensor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.mvglive/'>MVG</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.nederlandse_spoorwegen/'>Nederlandse Spoorwegen</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.gtfs/'>Public Transit (GTFS)</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.swiss_public_transport/'>Swiss Public Transport</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.torque/'>Torque (OBD2)</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.uk_transport/'>UK transport</a>
|
|
</li>
|
|
<li>
|
|
Uber
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.viaggiatreno/'>ViaggiaTreno Italian Railroads</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.vasttrafik/'>Västtrafik Public Transport</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.wsdot/'>Washington State DOT</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</aside>
|
|
</div>
|
|
</div>
|
|
<footer>
|
|
<div class="grid-wrapper">
|
|
<div class="grid">
|
|
<div class="grid__item">
|
|
<div class="copyright">
|
|
<a rel="me" href='https://twitter.com/home_assistant'><i class="icon-twitter"></i></a>
|
|
<a rel="me" href='https://facebook.com/homeassistantio'><i class="icon-facebook"></i></a>
|
|
<a rel="me" href='https://plus.google.com/110560654828510104551'><i class="icon-google-plus"></i></a>
|
|
<a rel="me" href='https://github.com/home-assistant/home-assistant'><i class="icon-github"></i></a>
|
|
<div class="credit">
|
|
Contact us at <a href='mailto:hello@home-assistant.io'>hello@home-assistant.io</a> (no support!).<br>
|
|
Website powered by <a href='http://jekyllrb.com/'>Jekyll</a> and the <a href='https://github.com/coogie/oscailte'>Oscalite theme</a>.<br />
|
|
Hosted by <a href='https://pages.github.com/'>GitHub</a> and served by <a href='https://cloudflare.com'>CloudFlare</a>.
|
|
</div>
|
|
<a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png" /></a><br /><span xmlns:dct="http://purl.org/dc/terms/" property="dct:title">home-assistant.io</span> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
<script>
|
|
var _gaq=[['_setAccount','UA-57927901-1'],['_trackPageview']];
|
|
(function(d,t){var g=d.createElement(t),s=d.getElementsByTagName(t)[0];
|
|
g.src=('https:'==location.protocol?'//ssl':'//www')+'.google-analytics.com/ga.js';
|
|
s.parentNode.insertBefore(g,s)}(document,'script'));
|
|
</script>
|
|
<link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.css" />
|
|
<script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.js"></script>
|
|
<script type="text/javascript">
|
|
docsearch({
|
|
apiKey: 'ae96d94b201c5444c8a443093edf3efb',
|
|
indexName: 'home-assistant',
|
|
inputSelector: '#search',
|
|
debug: false // Set debug to true if you want to inspect the dropdown
|
|
});
|
|
document.querySelector('.search .close').addEventListener('click', function(ev) {
|
|
ev.preventDefault();
|
|
document.querySelector('.search-container').style.display = 'none';
|
|
});
|
|
document.querySelector('.show-search').addEventListener('click', function(ev) {
|
|
ev.preventDefault();
|
|
document.querySelector('.search-container').style.display = 'block';
|
|
document.getElementById('toggle').checked = false;
|
|
document.querySelector('.search-container input').focus();
|
|
});
|
|
</script>
|
|
</body>
|
|
</html>
|