jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions
home-assistant.github.io/components/device_tracker/index.html
Travis CI 4acb07bf8e Site updated at 2016-08-22 08:21:42 UTC
2016-08-22 08:21:43 +00:00

248 lines
No EOL
11 KiB
HTML
Raw Blame History

<!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='/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 to track which devices are connected. Please check the sidebar for a list of brands of supported wireless routers.</p>
<p>There are also trackers available which uses different technologies like <a href="/components/mqtt/">MQTT</a> or <a href="/components/device_tracker.nmap_scanner/">Nmap</a> to scan the network for devices.</p>
<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="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>
<span class="c1"># Optional configuration</span>
<span class="c1"># If new discovered devices are tracked by default (default: yes)</span>
<span class="s">track_new_devices</span><span class="pi">:</span> <span class="s">yes</span>
<span class="c1"># Seconds between each scan for new devices (default: 12)</span>
<span class="s">interval_seconds</span><span class="pi">:</span> <span class="s">12</span>
<span class="c1"># Seconds to wait till marking someone as not home after not being seen</span>
<span class="c1"># (default: 180)</span>
<span class="s">consider_home</span><span class="pi">:</span> <span class="s">180</span>
</code></pre>
</div>
<p>Once tracked, a file will be created in your config dir called <code class="highlighter-rouge">known_devices.yaml</code>. Edit this file to adjust which devices to be tracked. Here you can also setup a URL for each device to be used as the entity picture and set whether the device will be show in the UI when in the away state.</p>
<p>Multiple device trackers can be used in parallel, such as <a href="/components/device_tracker.owntracks/">Owntracks</a> and <a href="/components/device_tracker.nmap_scanner/">Nmap</a>. The state of the device will be determined by the source that reported last. Device tracker will look for global settings (<code class="highlighter-rouge">track_new_devices</code>, <code class="highlighter-rouge">consider_home</code>, and <code class="highlighter-rouge">home_interval</code>) under the configuration of the first platform.</p>
<p>The optional <code class="highlighter-rouge">consider_home</code> entry is 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.</p>
<p>To add Nmap tracking just add the MAC address to the OwnTracks or iCloud device <code class="highlighter-rouge">mac:</code> configuration. To use both OwnTracks and Nmap you could use the following example:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">owntracksdevicename</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">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>
</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.bt_home_hub_5/'>
BT Home Hub 5
</a></li>
<li><a href='/components/device_tracker.bluetooth_tracker/'>
Bluetooth Tracker
</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.locative/'>
Locative
</a></li>
<li><a href='/components/device_tracker.mqtt/'>
MQTT Device Tracker
</a></li>
<li><a href='/components/device_tracker.netgear/'>
Netgear
</a></li>
<li><a href='/components/device_tracker.nmap_scanner/'>
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.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.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>
</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>
Reference in a new issue View git blame Copy permalink