home-assistant.github.io/components/device_tracker.unifi/index.html
2017-05-14 07:56:45 +00:00

255 lines
12 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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>Ubiquiti Unifi WAP - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions how to use a Unifi WAP controller as a device tracker module.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/device_tracker.unifi/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Ubiquiti Unifi WAP">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/device_tracker.unifi/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions how to use a Unifi WAP controller as a device tracker module.">
<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="Ubiquiti Unifi WAP">
<meta name="twitter:description" content="Instructions how to use a Unifi WAP controller as a device tracker module.">
<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">
Ubiquiti Unifi WAP
</h1>
</header>
<hr class="divider">
<p>This platform allows you to detect presence by looking at devices connected to a <a href="http://ubnt.com/">Ubiquiti</a> <a href="https://www.ubnt.com/enterprise/#unifi">Unifi</a> controller.</p>
<p>To use this device tracker in your installation, add the following 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">unifi</span>
<span class="s">username</span><span class="pi">:</span> <span class="s">YOUR_ADMIN_USERNAME</span>
<span class="s">password</span><span class="pi">:</span> <span class="s">YOUR_ADMIN_PASSWORD</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>host</strong> (<em>Optional</em>): The hostname or IP address of your controller. Defaults to <code class="highlighter-rouge">localhost</code>.</li>
<li><strong>port</strong> (<em>Optional</em>): The port of your controllers web interface. Defaults to <code class="highlighter-rouge">8443</code>.</li>
<li><strong>username</strong> (<em>Required</em>: The username of an user with administrative privileges, usually <code class="highlighter-rouge">admin</code>.</li>
<li><strong>password</strong> (<em>Required</em>): The password for your given admin account.</li>
<li><strong>site_id</strong> (<em>Optional</em>): Allows you to specify a <code class="highlighter-rouge">site_id</code> for device tracking. Defaults to <code class="highlighter-rouge">default</code>. Found in the URL of the controller (i.e. https://CONTROLLER:PORT/manage/site/SITE_ID/dashboard).</li>
<li><strong>verify_ssl</strong> (<em>Optional</em>): Controls if the SSL certificate running on your Unifi webserver must be trusted by a known Certificate Authority on the server running Home Assistant. Defaults to True but can also be a value that points to your custom cert “path/to/custom_cert.pem”.</li>
</ul>
<p>See the <a href="/components/device_tracker/">device tracker component page</a> for instructions how to configure the people to be tracked.</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.unifi.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
<img src='/images/supported_brands/ubiquiti.png' />
</div>
<div class='section'>
Introduced in release: 0.14
</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>
<a href='/components/device_tracker.gpslogger/'>GPSLogger</a>
</li>
<li>
<a href='/components/device_tracker.mqtt_json/'>JSON MQTT Device Tracker</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/sensor.mqtt_room/'>MQTT Room Presence</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/'>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>
Ubiquiti Unifi WAP
</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>
</body>
</html>