home-assistant.github.io/components/device_tracker.gpslogger/index.html
2016-12-06 08:23:42 +00:00

284 lines
No EOL
11 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>GPSLogger - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions how to use GPSLogger to track devices in Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/device_tracker.gpslogger/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="GPSLogger">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/device_tracker.gpslogger/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions how to use GPSLogger to track devices 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="GPSLogger">
<meta name="twitter:description" content="Instructions how to use GPSLogger to track devices in 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="/ecosystem/">Ecosystem</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">
GPSLogger
</h1>
</header>
<hr class="divider">
<p>This platform allows you to detect presence using <a href="http://code.mendhak.com/gpslogger/">GPSLogger</a>. GPSLogger is an open source app for <a href="https://play.google.com/store/apps/details?id=com.mendhak.gpslogger">Android</a> that allows users to set up a <code class="highlighter-rouge">GET</code> request to update GPS coordinates. This can be configured with Home Assistant to update your location.</p>
<p>To integrate GPSLogger in Home Assistant, add the following section 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">gpslogger</span>
</code></pre>
</div>
<h2><a class="title-link" name="setup-on-your-smartphone" href="#setup-on-your-smartphone"></a> Setup on your smartphone</h2>
<ul>
<li><a href="https://play.google.com/store/apps/details?id=com.mendhak.gpslogger">GPSLogger for Android</a></li>
</ul>
<p>To configure GPSLogger, you must set up the app to send a <code class="highlighter-rouge">GET</code> request to your Home Assistant server at <code class="highlighter-rouge">http://&lt;ha_server&gt;/api/gpslogger?latitude=%LAT&amp;longitude=%LON&amp;battery=%BATT&amp;device=%SER&amp;accuracy=%ACC</code>. Make sure to include the API password if you have configured a password in Home Assistant (add <code class="highlighter-rouge">&amp;api_password=&lt;password&gt;</code> to the end of the URL). Configure that options under “General Options”:</p>
<ul>
<li>Start on boot: yes</li>
<li>Start on app launch: yes</li>
</ul>
<p>Set the URL under “General Options -&gt; Logging details”:</p>
<ul>
<li>Log to GPX: no</li>
<li>Log to KML: no</li>
<li>Log to custom URL: yes and set <code class="highlighter-rouge">http://&lt;ha_server&gt;/api/gpslogger?latitude=%LAT&amp;longitude=%LON&amp;battery=%BATT&amp;device=%SER&amp;accuracy=%ACC</code> (be sure you include API password (<code class="highlighter-rouge">&amp;api_password=&lt;password&gt;</code>) if needed, or you can also use HTTP Basic authentication <code class="highlighter-rouge">http://&lt;username&gt;:&lt;password&gt;@&lt;ha_server&gt;/api/gpslogger...</code>)</li>
<li>Log to OpenGTS Server: no</li>
<li>Log to Plain Text: no</li>
<li>Log to NMEA: no</li>
</ul>
<p>You should also tune GPSLogger performance to save your battery under “General Options -&gt; Logging details -&gt; Performance -&gt; Location providers”:</p>
<ul>
<li>GPS: no</li>
<li>Network: no</li>
<li>Passive: yes</li>
</ul>
<p>A request can be forced from the app to test if everything is working fine. A succesfull request will update <code class="highlighter-rouge">known_devices.yaml</code> with device serial number.</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.gpslogger.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
</div>
<div class='section'>
Introduced in release: 0.34
</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>
<a href='/components/device_tracker.automatic/'>Automatic</a>
</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>
GPSLogger
</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.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.snmp/'>SNMP</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.thomson/'>Thomson</a>
</li>
<li>
<a href='/components/device_tracker.tomato/'>Tomato</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.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>.<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>
</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>