home-assistant.github.io/components/device_tracker/index.html
2016-01-16 19:31:32 +00:00

246 lines
No EOL
10 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="Paulus Schoutsen">
<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/home-assistant-logo-2164x2164.png">
<meta name="twitter:card" content="summary">
<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/home-assistant-logo-2164x2164.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='/images/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>
<ul>
<li><a href='/getting-started/'>Installing Home Assistant</a></li>
<li><a href='/getting-started/configuration/'>Configuration basics</a></li>
<li><a href='/getting-started/devices/'>Adding devices</a></li>
<li><a href='/getting-started/presence-detection/'>Presence detection</a></li>
<li><a href='/getting-started/automation/'>Automation</a></li>
<li><a href='/getting-started/templating/'>Templating</a></li>
<li><a href='/cookbook'>Configuration cookbook</a></li>
</ul>
</li>
<li><a href='/components/'>Components</a></li>
<li>
<a href="/developers/">Developers</a>
<ul>
<li><a href="/developers/architecture/">Architecture</a></li>
<li><a href="/developers/frontend/">Frontend development</a></li>
<li><a href="/developers/creating_components/">
Creating components
</a></li>
<li><a href="/developers/add_new_platform/">
Adding platform support
</a></li>
<li><a href="/developers/api/">API</a></li>
<li><a href="/developers/credits/">Credits</a></li>
</ul>
</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>configuration.yaml</code> (example for Netgear):</p>
<div class="highlighter-coderay"><div class="CodeRay">
<div class="code"><pre><span class="comment"># Example configuration.yaml entry for Netgear device</span>
<span class="key">device_tracker</span>:
<span class="key">platform</span>: <span class="string"><span class="content">netgear</span></span>
<span class="key">host</span>: <span class="string"><span class="content">192.168.1.1</span></span>
<span class="key">username</span>: <span class="string"><span class="content">admin</span></span>
<span class="key">password</span>: <span class="string"><span class="content">YOUR_PASSWORD</span></span>
<span class="comment"># Optional configuration</span>
<span class="comment"># If new discovered devices are tracked by default (default: yes)</span>
<span class="key">track_new_devices</span>: <span class="string"><span class="content">yes</span></span>
<span class="comment"># Seconds between each scan for new devices (default: 12)</span>
<span class="key">interval_seconds</span>: <span class="string"><span class="content">12</span></span>
<span class="comment"># Seconds to wait till marking someone as not home after not being seen</span>
<span class="comment"># (default: 180)</span>
<span class="key">consider_home</span>: <span class="string"><span class="content">180</span></span>
</pre></div>
</div>
</div>
<p>Once tracked, a file will be created in your config dir called <code>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 (track_new_devices, consider_home and home_interval) under the configuration of the first platform.</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='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.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.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://github.com/balloob/home-assistant'><i class="icon-github"></i></a>
<div class="credit">
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>
<!--[if lt IE 7]>
<p class="chromeframe">You are using an <strong>outdated</strong> browser. Please <a href="http://browsehappy.com/">upgrade your browser</a> or <a href="http://www.google.com/chromeframe/?redirect=true">activate Google Chrome Frame</a> to improve your experience.</p>
<![endif]-->
<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>