home-assistant.github.io/components/sensor.torque/index.html
2017-11-18 20:42:08 +00:00

231 lines
11 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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>Torque (OBD2) - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions how to integrate Torque sensors into Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/sensor.torque/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Torque (OBD2)">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/sensor.torque/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions how to integrate Torque sensors 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="Torque (OBD2)">
<meta name="twitter:description" content="Instructions how to integrate Torque sensors into 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">
Torque (OBD2)
</h1>
</header>
<hr class="divider">
<p>The <code class="highlighter-rouge">torque</code> platform will allow you to monitor <a href="http://torque-bhp.com/">Torque</a> data relayed from a Bluetooth OBD2 stick via the Torque mobile application.</p>
<h2><a class="title-link" name="configuration" href="#configuration"></a> Configuration</h2>
<p>To use Torque sensors with your installation, you must configure both the Torque mobile application and Home Assistant.</p>
<h3><a class="title-link" name="torque-application" href="#torque-application"></a> Torque application</h3>
<p>In <strong>Settings</strong> -&gt; <strong>Data Logging &amp; Upload</strong>:</p>
<p>Under the <strong>Logging Preferences</strong> header:</p>
<ul>
<li>Touch <strong>Select what to log</strong>, activate the menu in the upper right, and select <strong>Add PID to log</strong>.</li>
<li>Select items of interest.</li>
</ul>
<p>Under the <strong>Realtime Web Upload</strong> header:</p>
<ul>
<li>Check <strong>Upload to web-server</strong>.</li>
<li>Enter <code class="highlighter-rouge">http://HOST:PORT/api/torque?api_password=YOUR_PASSWORD</code> as the <strong>Web-server URL</strong>, where <code class="highlighter-rouge">HOST</code> and <code class="highlighter-rouge">PORT</code> are your externally accessible Home Assistant HTTP host and port and YOUR_PASSWORD is your Home Assistants <a href="/components/http/">API password</a>. It highly recommended that you protect your Home Assistant instance with <a href="/docs/ecosystem/certificates/">SSL/TSL</a>.</li>
<li>Enter an email address in <strong>User Email Address</strong>.</li>
<li>Optionally set the <strong>Web Logging Interval</strong>. The 2-second default may quickly fill up the Home Assistant history database.</li>
</ul>
<h3><a class="title-link" name="home-assistant" href="#home-assistant"></a> Home Assistant</h3>
<p>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">sensor</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">torque</span>
<span class="s">email</span><span class="pi">:</span> <span class="s">your_configured@email.com</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>name</strong> (<em>Optional</em>): Vehicle name (your choice).</li>
<li><strong>email</strong> (<em>Required</em>): Email address configured in Torque application.</li>
</ul>
</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.torque.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
<img src='/images/supported_brands/torque.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.10
</div>
<div class='section'>
Source:
<a href='https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/sensor/torque.py'>sensor/torque.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>
Torque (OBD2)
</li>
<li>
<a href='/components/sensor.uk_transport/'>UK transport</a>
</li>
<li>
<a href='/components/sensor.uber/'>Uber</a>
</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>