276 lines
14 KiB
HTML
276 lines
14 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>Automatic - Home Assistant</title>
|
||
<meta name="author" content="Home Assistant">
|
||
<meta name="description" content="Instructions for how to integrate Automatic ODB readers into Home Assistant.">
|
||
<meta name="viewport" content="width=device-width">
|
||
<link rel="canonical" href="https://home-assistant.io/components/device_tracker.automatic/">
|
||
<meta property="fb:app_id" content="338291289691179">
|
||
<meta property="og:title" content="Automatic">
|
||
<meta property="og:site_name" content="Home Assistant">
|
||
<meta property="og:url" content="https://home-assistant.io/components/device_tracker.automatic/">
|
||
<meta property="og:type" content="article">
|
||
<meta property="og:description" content="Instructions for how to integrate Automatic ODB readers into 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="Automatic">
|
||
<meta name="twitter:description" content="Instructions for how to integrate Automatic ODB readers into Home Assistant.">
|
||
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
|
||
<link href="/stylesheets/screen.css" media="screen, projection" 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>
|
||
<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>
|
||
</ul>
|
||
</nav>
|
||
</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">
|
||
Automatic
|
||
</h1>
|
||
</header>
|
||
<hr class="divider">
|
||
<p>The <code class="highlighter-rouge">automatic</code> platform offers presence detection by retrieving your car’s information from the <a href="http://automatic.com/">Automatic</a> cloud service.</p>
|
||
<p>To use Automatic with Home Assistant, first you must <a href="https://developer.automatic.com/">create a free development account</a>. Automatic will generate a Client ID and Secret for you to use in your Home Assistant configuration. You will also need to update your Event Delivery preferences to ensure Home Assistant can receive updates. On the developer page, under App Settings / Event Delivery, select “Websocket” for Event Delivery Preference.</p>
|
||
<p>Home Assistant will also take advantage of <code class="highlighter-rouge">scope:current_location</code> if available. This will allow Home Assistant to receive periodic location updates during a trip. In order to use this functionality, you must request the scope for your application from Automatic. Once <code class="highlighter-rouge">scope:current_location</code> is available, Home Assistant will automatically make use of it after the next restart.</p>
|
||
<p>Once your developer account is created, add the following 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">device_tracker</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">automatic</span>
|
||
<span class="s">client_id</span><span class="pi">:</span> <span class="s">1234567</span>
|
||
<span class="s">secret</span><span class="pi">:</span> <span class="s">0987654321</span>
|
||
<span class="s">username</span><span class="pi">:</span> <span class="s">your@email.com</span>
|
||
<span class="s">password</span><span class="pi">:</span> <span class="s">your_password</span>
|
||
<span class="s">devices</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">2007 Honda Element</span>
|
||
<span class="pi">-</span> <span class="s">2004 Subaru Impreza</span>
|
||
</code></pre>
|
||
</div>
|
||
<p>Configuration variables:</p>
|
||
<ul>
|
||
<li><strong>client_id</strong> (<em>Required</em>): The OAuth client id (get from https://developer.automatic.com/).</li>
|
||
<li><strong>secret</strong> (<em>Required</em>): The OAuth client secret (get from https://developer.automatic.com/).</li>
|
||
<li><strong>username</strong> (<em>Required</em>): The username associated with your ODB reader.</li>
|
||
<li><strong>password</strong> (<em>Required</em>): The password for your given ODB reader account.</li>
|
||
<li><strong>devices</strong> (<em>Optional</em>): The list of vehicle display names you wish to track. If not provided, all vehicles will be tracked.</li>
|
||
</ul>
|
||
<p>Home Assistant will also fire events when an update is received from Automatic. These can be used to trigger automations, as shown in the example below. A list of available event types can be found in the <a href="https://developer.automatic.com/api-reference/#real-time-events">Automatic Real-Time Events documentation</a>.</p>
|
||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example automatic event automation</span>
|
||
<span class="s">automation</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">trigger</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">event</span>
|
||
<span class="s">event_type</span><span class="pi">:</span> <span class="s">automatic_update</span>
|
||
<span class="s">event_data</span><span class="pi">:</span>
|
||
<span class="s">type</span><span class="pi">:</span> <span class="s2">"</span><span class="s">ignition:on"</span>
|
||
<span class="s">action</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">service</span><span class="pi">:</span> <span class="s">light.turn_off</span>
|
||
</code></pre>
|
||
</div>
|
||
<p>See the <a href="/components/device_tracker/">device tracker component page</a> for instructions how to configure the cars to be tracked.</p>
|
||
</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/device_tracker.automatic.markdown'>Edit this page on GitHub</a></div>
|
||
<div class='brand-logo-container section'>
|
||
<img src='/images/supported_brands/automatic.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 Push
|
||
</div>
|
||
<div class='section'>
|
||
Introduced in release: 0.28
|
||
</div>
|
||
<div class='section'>
|
||
This is a platform for
|
||
<a href='/components/device_tracker/'>the Device Tracker component</a>.
|
||
</div>
|
||
<div class='section'>
|
||
<h1 class="title delta">Category Presence Detection</h1>
|
||
<ul class='divided'>
|
||
<li>
|
||
<a href='/components/device_tracker.asuswrt/'>ASUSWRT</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/device_tracker.actiontec/'>Actiontec</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/device_tracker.aruba/'>Aruba</a>
|
||
</li>
|
||
<li>
|
||
Automatic
|
||
</li>
|
||
<li>
|
||
<a href='/components/device_tracker.bt_home_hub_5/'>BT Home Hub 5</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/device_tracker.bbox/'>Bbox</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/device_tracker.bluetooth_le_tracker/'>Bluetooth LE Tracker</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/device_tracker.bluetooth_tracker/'>Bluetooth Tracker</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/device_tracker.cisco_ios/'>Cisco IOS</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/device_tracker.ddwrt/'>DD-WRT</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/device_tracker.fritz/'>FRITZ!Box</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/device_tracker.gpslogger/'>GPSLogger</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/device_tracker.mqtt_json/'>JSON MQTT Device Tracker</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/device_tracker.linksys_ap/'>Linksys Access Points</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/device_tracker.locative/'>Locative</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/device_tracker.mqtt/'>MQTT Device Tracker</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.mqtt_room/'>MQTT Room Presence</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/device_tracker.mikrotik/'>Mikrotik</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/device_tracker.mysensors/'>MySensors Device Tracker</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/device_tracker.netgear/'>Netgear</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/device_tracker.nmap_tracker/'>Nmap</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/device_tracker.luci/'>OpenWRT (luci)</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/device_tracker.ubus/'>OpenWRT (ubus)</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/device_tracker.owntracks/'>Owntracks</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/device_tracker.ping/'>Ping (ICMP)</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/device_tracker.snmp/'>SNMP</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/device_tracker.sky_hub/'>Sky Hub</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/device_tracker.swisscom/'>Swisscom Internet-Box</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/device_tracker.tplink/'>TP-Link</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/device_tracker.tado/'>Tado</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/device_tracker.thomson/'>Thomson</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/device_tracker.tomato/'>Tomato</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/device_tracker.trackr/'>TrackR</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/device_tracker.upc_connect/'>UPC ConnectBox</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/device_tracker.unifi/'>Ubiquiti Unifi WAP</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/device_tracker.volvooncall/'>Volvo On Call</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/device_tracker.xiaomi/'>Xiaomi Router</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/device_tracker.icloud/'>iCloud</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>
|
||
</body>
|
||
</html>
|