327 lines
16 KiB
HTML
327 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>Device Tracker - Home Assistant</title>
|
||
<meta name="author" content="Home Assistant">
|
||
<meta name="description" content="Instructions how to setup device tracking within Home Assistant.">
|
||
<meta name="viewport" content="width=device-width">
|
||
<link rel="canonical" href="https://home-assistant.io/components/device_tracker/">
|
||
<meta property="fb:app_id" content="338291289691179">
|
||
<meta property="og:title" content="Device Tracker">
|
||
<meta property="og:site_name" content="Home Assistant">
|
||
<meta property="og:url" content="https://home-assistant.io/components/device_tracker/">
|
||
<meta property="og:type" content="article">
|
||
<meta property="og:description" content="Instructions how to setup device tracking within 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="Device Tracker">
|
||
<meta name="twitter:description" content="Instructions how to setup device tracking within 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">
|
||
Device Tracker
|
||
</h1>
|
||
</header>
|
||
<hr class="divider">
|
||
<p>Home Assistant can get information from your wireless router or third party services like iCloud or OwnTracks to track which devices are connected and considered “in home”. Please check the sidebar for a list of brands of supported wireless routers and services.</p>
|
||
<p>There are also trackers available which use different technologies like <a href="/components/mqtt/">MQTT</a> or <a href="/components/device_tracker.nmap_tracker/">Nmap</a> to scan the network for devices.</p>
|
||
<p>An <a href="/getting-started/automation-trigger/#event-trigger">event</a> (<code class="highlighter-rouge">device_tracker_new_device</code>) will be fired when a device is discovered for the first time.</p>
|
||
<h2><a class="title-link" name="configuring-a-device_tracker-platform" href="#configuring-a-device_tracker-platform"></a> Configuring a <code class="highlighter-rouge">device_tracker</code> platform</h2>
|
||
<p>To get started add the following lines to your <code class="highlighter-rouge">configuration.yaml</code> (example for Netgear):</p>
|
||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry for Netgear device</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">netgear</span>
|
||
<span class="s">host</span><span class="pi">:</span> <span class="s">192.168.1.1</span>
|
||
<span class="s">username</span><span class="pi">:</span> <span class="s">admin</span>
|
||
<span class="s">password</span><span class="pi">:</span> <span class="s">YOUR_PASSWORD</span>
|
||
</code></pre>
|
||
</div>
|
||
<p>The following optional parameters can be used with any platform. However device tracker will only look for global settings under the configuration of the first configured platform:</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Parameter</th>
|
||
<th>Default</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><code class="highlighter-rouge">track_new_devices</code></td>
|
||
<td>True</td>
|
||
<td>If new discovered devices are tracked by default</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code class="highlighter-rouge">interval_seconds</code></td>
|
||
<td>12</td>
|
||
<td>Seconds between each scan for new devices</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code class="highlighter-rouge">consider_home</code></td>
|
||
<td>180</td>
|
||
<td>Seconds to wait till marking someone as not home after not being seen. This parameter is most useful for households with Apple iOS devices that go into sleep mode while still at home to conserve battery life. iPhones will occasionally drop off the network and then re-appear. <code class="highlighter-rouge">consider_home</code> helps prevent false alarms in presence detection when using IP scanners such as Nmap. <code class="highlighter-rouge">consider_home</code> accepts various time representations, (E.g. the following all represents 3 minutes: <code class="highlighter-rouge">180</code>, <code class="highlighter-rouge">0:03</code>, <code class="highlighter-rouge">0:03:00</code>)</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>The extended example from above would look like the following sample:</p>
|
||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry for Netgear device</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">netgear</span>
|
||
<span class="s">host</span><span class="pi">:</span> <span class="s">192.168.1.1</span>
|
||
<span class="s">username</span><span class="pi">:</span> <span class="s">admin</span>
|
||
<span class="s">interval_seconds</span><span class="pi">:</span> <span class="s">10</span>
|
||
<span class="s">consider_home</span><span class="pi">:</span> <span class="s">180</span>
|
||
<span class="s">track_new_devices</span><span class="pi">:</span> <span class="s">yes</span>
|
||
</code></pre>
|
||
</div>
|
||
<p>Multiple device trackers can be used in parallel, such as <a href="/components/device_tracker.owntracks/#using-owntracks-with-other-device-trackers">Owntracks</a> and <a href="/components/device_tracker.nmap_tracker/">Nmap</a>. The state of the device will be determined by the source that reported last.</p>
|
||
<h2><a class="title-link" name="known_devicesyaml" href="#known_devicesyaml"></a> <code class="highlighter-rouge">known_devices.yaml</code></h2>
|
||
<p>Once <code class="highlighter-rouge">device_tracker</code> is enabled, a file will be created in your config dir named <code class="highlighter-rouge">known_devices.yaml</code>. Edit this file to adjust which devices to be tracked.</p>
|
||
<p>Here’s an example configuration for a single device:</p>
|
||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">devicename</span><span class="pi">:</span>
|
||
<span class="s">name</span><span class="pi">:</span> <span class="s">Friendly Name</span>
|
||
<span class="s">mac</span><span class="pi">:</span> <span class="s">EA:AA:55:E7:C6:94</span>
|
||
<span class="s">picture</span><span class="pi">:</span> <span class="s">https://home-assistant.io/images/favicon-192x192.png</span>
|
||
<span class="s">gravatar</span><span class="pi">:</span> <span class="s">test@example.com</span>
|
||
<span class="s">track</span><span class="pi">:</span> <span class="s">yes</span>
|
||
<span class="s">hide_if_away</span><span class="pi">:</span> <span class="s">no</span>
|
||
</code></pre>
|
||
</div>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Parameter</th>
|
||
<th>Default</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><code class="highlighter-rouge">name</code></td>
|
||
<td>Host name or “Unnamed Device”</td>
|
||
<td>The friendly name of the device</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code class="highlighter-rouge">mac</code></td>
|
||
<td>None</td>
|
||
<td>The MAC address of the device. Add this if you are using a network device tracker like Nmap or SNMP</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code class="highlighter-rouge">picture</code></td>
|
||
<td>None</td>
|
||
<td>A picture that you can use to easily identify the person or device. You can also save the image file in a folder “www” in the same location (can be obtained from developer tools) where you have your configuration.yaml file and just use <code class="highlighter-rouge">picture: /local/favicon-192x192.png</code>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code class="highlighter-rouge">gravatar</code></td>
|
||
<td>None</td>
|
||
<td>An email address for the device’s owner. If provided, it will override <code class="highlighter-rouge">picture</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td><code class="highlighter-rouge">track</code></td>
|
||
<td>False</td>
|
||
<td>If <code class="highlighter-rouge">yes</code>/<code class="highlighter-rouge">on</code>/<code class="highlighter-rouge">true</code> then the device will be tracked. Otherwise its location and state will not update</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code class="highlighter-rouge">hide_if_away</code></td>
|
||
<td>False</td>
|
||
<td>If <code class="highlighter-rouge">yes</code>/<code class="highlighter-rouge">on</code>/<code class="highlighter-rouge">true</code> then the device will be hidden if it is not at home</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code class="highlighter-rouge">consider_home</code></td>
|
||
<td>[uses platform setting]</td>
|
||
<td>Allows you to override the global <code class="highlighter-rouge">consider_home</code> setting from the platform configuration on a per device level</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</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.markdown'>Edit this page on GitHub</a></div>
|
||
<div class='brand-logo-container section'>
|
||
</div>
|
||
<h1 class='title delta'>Platforms</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><a href='/components/device_tracker.gpslogger/'>
|
||
GPSLogger
|
||
</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/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>
|
||
</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>
|
||
<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>
|