jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions

Site updated at 2017-03-18 17:12:07 UTC

Browse source
This commit is contained in:
Travis CI 2017-03-18 17:12:07 +00:00
parent 7573fcba68
commit 67179bf8fe
994 changed files with 1768 additions and 68252 deletions
Download patch file Download diff file Expand all files Collapse all files

48
components/sensor.mqtt_room/index.html
View file

@ -3,17 +3,14 @@
<!--[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">
@ -21,39 +18,31 @@
<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" 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>
@ -64,36 +53,21 @@
</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">
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>
@ -104,9 +78,7 @@
<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>
@ -114,9 +86,7 @@
<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">away</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">
@ -124,29 +94,18 @@
</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'>
@ -272,13 +231,10 @@ Instead of developing your own application, you can also use any of these alread
</ul>
</div>
</section>
</div>
</aside>
</div>
</div>
<footer>
<div class="grid-wrapper">
<div class="grid">
@ -288,7 +244,6 @@ Instead of developing your own application, you can also use any of these alread
<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 />
@ -300,7 +255,6 @@ Instead of developing your own application, you can also use any of these alread
</div>
</div>
</footer>
<script>
var _gaq=[['_setAccount','UA-57927901-1'],['_trackPageview']];
(function(d,t){var g=d.createElement(t),s=d.getElementsByTagName(t)[0];
@ -308,4 +262,4 @@ Instead of developing your own application, you can also use any of these alread
s.parentNode.insertBefore(g,s)}(document,'script'));
</script>
</body>
</html>
</html>