342 lines
16 KiB
HTML
342 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>MQTT Room Presence - Home Assistant</title>
|
|
<meta name="author" content="Home Assistant">
|
|
<meta name="description" content="Instructions on how to track room presence within Home Assistant.">
|
|
<meta name="viewport" content="width=device-width">
|
|
<link rel="canonical" href="https://home-assistant.io/components/sensor.mqtt_room/">
|
|
<meta property="fb:app_id" content="338291289691179">
|
|
<meta property="og:title" content="MQTT Room Presence">
|
|
<meta property="og:site_name" content="Home Assistant">
|
|
<meta property="og:url" content="https://home-assistant.io/components/sensor.mqtt_room/">
|
|
<meta property="og:type" content="article">
|
|
<meta property="og:description" content="Instructions on how to track room presence 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="MQTT Room Presence">
|
|
<meta name="twitter:description" content="Instructions on how to track room presence within 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">
|
|
MQTT Room Presence
|
|
</h1>
|
|
</header>
|
|
<hr class="divider">
|
|
<p>The <code class="highlighter-rouge">mqtt_room</code> sensor platform allows you to detect the indoor location of devices using MQTT clients.</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">sensor</span><span class="pi">:</span>
|
|
<span class="s">platform</span><span class="pi">:</span> <span class="s">mqtt_room</span>
|
|
<span class="s">device_id</span><span class="pi">:</span> <span class="s">123testid</span>
|
|
<span class="s">name</span><span class="pi">:</span> <span class="s1">'</span><span class="s">Cool</span><span class="nv"> </span><span class="s">device'</span>
|
|
<span class="s">state_topic</span><span class="pi">:</span> <span class="s1">'</span><span class="s">room_presence'</span>
|
|
<span class="s">timeout</span><span class="pi">:</span> <span class="s">5</span>
|
|
<span class="s">away_timeout</span><span class="pi">:</span> <span class="s">60</span>
|
|
</code></pre>
|
|
</div>
|
|
<p>Configuration variables:</p>
|
|
<ul>
|
|
<li><strong>device_id</strong> (<em>Required</em>): The device id to track for this sensor.</li>
|
|
<li><strong>name</strong> (<em>Optional</em>): The name of the sensor.</li>
|
|
<li><strong>state_topic</strong> (<em>Optional</em>): The topic that contains all subtopics for the rooms.</li>
|
|
<li><strong>timeout</strong> (<em>Optional</em>): The time in seconds after which a room presence state is considered old. An example: device1 is reported at scanner1 with a distance of 1. No further updates are sent from scanner1. After 5 seconds scanner2 reports device1 with a distance of 2. The old location info is discarded in favor of the new scanner2 information as the timeout has passed.</li>
|
|
<li><strong>away_timeout</strong> (<em>Optional</em>): The time in seconds after which the state should be set to <code class="highlighter-rouge">not_home</code> if there were no updates. <code class="highlighter-rouge">0</code> disables the check and is the default.</li>
|
|
</ul>
|
|
<p>Example JSON that should be published to the room topics:</p>
|
|
<div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"123testid"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Test Device"</span><span class="p">,</span><span class="w">
|
|
</span><span class="nt">"distance"</span><span class="p">:</span><span class="w"> </span><span class="mf">5.678</span><span class="w">
|
|
</span><span class="p">}</span><span class="w">
|
|
</span></code></pre>
|
|
</div>
|
|
<h3><a class="title-link" name="setting-up-clients" href="#setting-up-clients"></a> Setting up clients</h3>
|
|
<p>This component works with any software that is sending data in the given format.
|
|
Each client should post the discovered devices in its own subtopic of the configured topic.
|
|
Instead of developing your own application, you can also use any of these already existing clients:</p>
|
|
<ul>
|
|
<li><a href="https://github.com/mKeRix/room-assistant"><strong>room-assistant</strong></a>: looks for Bluetooth LE beacons, based on Node.js</li>
|
|
<li><a href="https://github.com/happy-bubbles/presence"><strong>Happy Bubbles Presence Server</strong></a>: presence detection server for Happy Bubbles BLE-scanning devices, based on Go</li>
|
|
</ul>
|
|
</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/sensor.mqtt_room.markdown'>Edit this page on GitHub</a></div>
|
|
<div class='brand-logo-container section'>
|
|
<img src='/images/supported_brands/mqtt.png' />
|
|
</div>
|
|
<div class='section'>
|
|
IoT class<sup><a href='/blog/2016/02/12/classifying-the-internet-of-things/#classifiers'><i class="icon-info-sign"></i></a></sup>: depends
|
|
</div>
|
|
<div class='section'>
|
|
Introduced in release: 0.27
|
|
</div>
|
|
<div class='section'>
|
|
Source:
|
|
<a href='https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/sensor/mqtt_room.py'>sensor/mqtt_room.py</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.bmw_connected_drive/'>BMW connected drive</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.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>
|
|
MQTT Room Presence
|
|
</li>
|
|
<li>
|
|
<a href='/components/device_tracker.meraki/'>Meraki</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/device_tracker.mercedesme/'>Mercedes me</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/switch.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>
|