353 lines
16 KiB
HTML
353 lines
16 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, 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">
|
||
GPSLogger
|
||
</h1>
|
||
</header>
|
||
<hr class="divider">
|
||
<p>The <code class="highlighter-rouge">gpslogger</code> device tracker 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>
|
||
<span class="s">password</span><span class="pi">:</span> <span class="kt">!secret</span> <span class="s">gpslogger_password</span>
|
||
</code></pre>
|
||
</div>
|
||
<div class="config-vars">
|
||
<h3><a class="title-link" name="configuration-variables" href="#configuration-variables"></a> Configuration Variables</h3>
|
||
<dl class="">
|
||
<dt><a class="title-link" name="password" href="#password"></a> password</dt>
|
||
<dd>
|
||
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Optional)</span><span class="description">Separate password for GPS Logger endpoint. If provided using regular API password to contact endpoint will result in 401 response.</span></p>
|
||
</dd>
|
||
</dl>
|
||
</div>
|
||
<h2><a class="title-link" name="setup-on-your-smartphone" href="#setup-on-your-smartphone"></a> Setup on your smartphone</h2>
|
||
<p>Install <a href="https://play.google.com/store/apps/details?id=com.mendhak.gpslogger">GPSLogger for Android</a> on your device.</p>
|
||
<p>After the launch, go to <strong>General Options</strong>. Enable <strong>Start on bootup</strong> and <strong>Start on app launch</strong>.</p>
|
||
<p class="img">
|
||
<img width="300" src="/images/components/gpslogger/settings.png" />
|
||
GPSLogger Settings
|
||
</p>
|
||
<p>Go to <strong>Logging details</strong> and disable <strong>Log to GPX</strong>. <strong>Log to KML</strong>, and <strong>Log to NMEA</strong>. Enable <strong>Log to custom URL</strong>.</p>
|
||
<p class="img">
|
||
<img width="300" src="/images/components/gpslogger/logging-details.png" />
|
||
Logging Details
|
||
</p>
|
||
<p>Right after enabling, the app will take you to the <strong>Log to custom URL</strong> settings.</p>
|
||
<p class="img">
|
||
<img width="300" src="/images/components/gpslogger/custom-url.png" />
|
||
Log to custom URL details
|
||
</p>
|
||
<p>The relevant endpoint is: <code class="highlighter-rouge">/api/gpslogger</code></p>
|
||
<div class="language-text highlighter-rouge"><pre class="highlight"><code>http://[IP address Home Assistant]:[Port]/api/gpslogger?
|
||
latitude=%LAT&longitude=%LON&device=%SER&accuracy=%ACC
|
||
&battery=%BATT&speed=%SPD&direction=%DIR
|
||
&altitude=%ALT&provider=%PROV&activity=%ACT
|
||
</code></pre>
|
||
</div>
|
||
<p>Add the above URL after you modified it with your settings into the <strong>URL</strong> field. Remove the line breaks as they are only there to make the URL readable here.</p>
|
||
<ul>
|
||
<li>It’s HIGHLY recommended to use SSL/TLS.</li>
|
||
<li>Use the domain that Home Assistant is available on the internet or the public IP address. Can be a local IP address if you are using a VPN setup.</li>
|
||
<li>Only remove <code class="highlighter-rouge">[Port]</code> if your Home Assistant instance is using port 80. Otherwise set it to 8123.</li>
|
||
<li>For Home Assistant only the above URL, as written, will work - do not add or remove any parameters.</li>
|
||
<li>Make sure to include your <a href="/components/http/">API password</a> if you have configured a password. Add <code class="highlighter-rouge">&api_password=[Your password]</code> to the end of the URL.</li>
|
||
<li>You can change the name of your device name by replacing <code class="highlighter-rouge">&device=%SER</code> with <code class="highlighter-rouge">&device=[Devicename]</code>.</li>
|
||
</ul>
|
||
<p>If your battery drains fast then you can tune the performance of GPSLogger under <strong>Performance</strong> -> <strong>Location providers</strong></p>
|
||
<p class="img">
|
||
<img width="300" src="/images/components/gpslogger/performance.png" />
|
||
Performance
|
||
</p>
|
||
<p>A request can be forced from the app to test if everything is working fine. A successful request will update the <code class="highlighter-rouge">known_devices.yaml</code> file with the device’s 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'>
|
||
Source:
|
||
<a href='https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/device_tracker/gpslogger.py'>device_tracker/gpslogger.py</a>
|
||
</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.geofency/'>Geofency</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/device_tracker.hitron_coda/'>Hitron CODA Routers</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/device_tracker.huawei_router/'>Huawei Router</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/device_tracker.mqtt_json/'>JSON MQTT Device Tracker</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/device_tracker.keenetic_ndms2/'>Keenetic NDMS2 Routers</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/device_tracker.linksys_ap/'>Linksys Access Points</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/device_tracker.linksys_smart/'>Linksys Smart Wifi Router</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.meraki/'>Meraki</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_http/'>OwnTracks (via HTTP)</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.tesla/'>Tesla</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/device_tracker.thomson/'>Thomson</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/device_tracker.tile/'>Tile</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.unifi_direct/'>Ubiquiti Unifi direct AP</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>
|
||
<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>
|