jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions
home-assistant.github.io/components/binary_sensor.bayesian/index.html
Travis CI ac7487404f Site updated at 2018-02-26 01:02:56 UTC
2018-02-26 01:02:57 +00:00

438 lines
23 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>Bayesian Binary Sensor - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions how to integrate threshold Bayesian sensors into Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/binary_sensor.bayesian/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Bayesian Binary Sensor">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/binary_sensor.bayesian/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions how to integrate threshold Bayesian sensors into 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="Bayesian Binary Sensor">
<meta name="twitter:description" content="Instructions how to integrate threshold Bayesian sensors into 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">
Bayesian Binary Sensor
</h1>
</header>
<hr class="divider">
<p>The <code class="highlighter-rouge">bayesian</code> binary sensor platform observes the state from multiple sensors and uses <a href="https://en.wikipedia.org/wiki/Bayes%27_theorem">Bayes’ rule</a> to estimate the probability that an event has occurred given the state of the observed sensors. If the estimated posterior probability is above the <code class="highlighter-rouge">probability_threshold</code>, the sensor is <code class="highlighter-rouge">on</code> otherwise it is <code class="highlighter-rouge">off</code>.</p>
<p>This allows for the detection of complex events that may not be readily observable, e.g., cooking, showering, in bed, the start of a morning routine, etc. It can also be used to gain greater confidence about events that <em>are</em> directly observable, but for which the sensors can be unreliable, e.g., presence.</p>
<p>To enable the Bayesian sensor, add the following lines to your <code class="highlighter-rouge">configuration.yaml</code>:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
<span class="s">binary_sensor</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">bayesian</span>
<span class="s">prior</span><span class="pi">:</span> <span class="s">0.1</span>
<span class="s">observations</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">entity_id</span><span class="pi">:</span> <span class="s1">'</span><span class="s">switch.kitchen_lights'</span>
<span class="s">prob_given_true</span><span class="pi">:</span> <span class="s">0.6</span>
<span class="s">prob_given_false</span><span class="pi">:</span> <span class="s">0.2</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s1">'</span><span class="s">state'</span>
<span class="s">to_state</span><span class="pi">:</span> <span class="s1">'</span><span class="s">on'</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>prior</strong> (<em>Required</em>): The prior probability of the event. At any point in time (ignoring all external influences) how likely is this event to occur?</li>
<li><strong>probability_threshold</strong> (<em>Optional</em>): The probability at which the sensor should trigger to <code class="highlighter-rouge">on</code>.</li>
<li><strong>name</strong> (<em>Optional</em>): Name of the sensor to use in the frontend. Defaults to <code class="highlighter-rouge">Bayesian Binary sensor</code>.</li>
<li><strong>observations</strong> array (<em>Required</em>): The observations which should influence the likelihood that the given event has occurred.
<ul>
<li><strong>entity_id</strong> (<em>Required</em>): Name of the entity to monitor.</li>
<li><strong>prob_given_true</strong> (<em>Required</em>): The probability of the observation occurring, given the event is <code class="highlighter-rouge">true</code>.</li>
<li><strong>prob_given_false</strong> (<em>Optional</em>): The probability of the observation occurring, given the event is <code class="highlighter-rouge">false</code> can be set as well. If <code class="highlighter-rouge">prob_given_false</code> is not set, it will default to <code class="highlighter-rouge">1 - prob_given_true</code>.</li>
<li><strong>platform</strong> (<em>Required</em>): The only supported observation platforms are <code class="highlighter-rouge">state</code> and <code class="highlighter-rouge">numeric_state</code>, which are modeled after their corresponding triggers for automations, requiring <code class="highlighter-rouge">below</code> and/or <code class="highlighter-rouge">above</code> instead of <code class="highlighter-rouge">to_state</code>.</li>
<li><strong>to_state</strong> (<em>Required</em>): The target state.</li>
</ul>
</li>
</ul>
<h2><a class="title-link" name="full-examples" href="#full-examples"></a> Full examples</h2>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
<span class="s">binary_sensor</span><span class="pi">:</span>
<span class="s">name</span><span class="pi">:</span> <span class="s1">'</span><span class="s">in_bed'</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s1">'</span><span class="s">bayesian'</span>
<span class="s">prior</span><span class="pi">:</span> <span class="s">0.25</span>
<span class="s">probability_threshold</span><span class="pi">:</span> <span class="s">0.95</span>
<span class="s">observations</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">entity_id</span><span class="pi">:</span> <span class="s1">'</span><span class="s">sensor.living_room_motion'</span>
<span class="s">prob_given_true</span><span class="pi">:</span> <span class="s">0.4</span>
<span class="s">prob_given_false</span><span class="pi">:</span> <span class="s">0.2</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s1">'</span><span class="s">state'</span>
<span class="s">to_state</span><span class="pi">:</span> <span class="s1">'</span><span class="s">off'</span>
<span class="pi">-</span> <span class="s">entity_id</span><span class="pi">:</span> <span class="s1">'</span><span class="s">sensor.basement_motion'</span>
<span class="s">prob_given_true</span><span class="pi">:</span> <span class="s">0.5</span>
<span class="s">prob_given_false</span><span class="pi">:</span> <span class="s">0.4</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s1">'</span><span class="s">state'</span>
<span class="s">to_state</span><span class="pi">:</span> <span class="s1">'</span><span class="s">off'</span>
<span class="pi">-</span> <span class="s">entity_id</span><span class="pi">:</span> <span class="s1">'</span><span class="s">sensor.bedroom_motion'</span>
<span class="s">prob_given_true</span><span class="pi">:</span> <span class="s">0.5</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s1">'</span><span class="s">state'</span>
<span class="s">to_state</span><span class="pi">:</span> <span class="s1">'</span><span class="s">on'</span>
<span class="pi">-</span> <span class="s">entity_id</span><span class="pi">:</span> <span class="s1">'</span><span class="s">sun.sun'</span>
<span class="s">prob_given_true</span><span class="pi">:</span> <span class="s">0.7</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s1">'</span><span class="s">state'</span>
<span class="s">to_state</span><span class="pi">:</span> <span class="s1">'</span><span class="s">below_horizon'</span>
</code></pre>
</div>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
<span class="s">binary_sensor</span><span class="pi">:</span>
<span class="s">name</span><span class="pi">:</span> <span class="s1">'</span><span class="s">Heat</span><span class="nv"> </span><span class="s">On'</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s1">'</span><span class="s">bayesian'</span>
<span class="s">prior</span><span class="pi">:</span> <span class="s">0.2</span>
<span class="s">probability_threshold</span><span class="pi">:</span> <span class="s">0.9</span>
<span class="s">observations</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">entity_id</span><span class="pi">:</span> <span class="s1">'</span><span class="s">sensor.outside_air_temperature_fahrenheit'</span>
<span class="s">prob_given_true</span><span class="pi">:</span> <span class="s">0.95</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s1">'</span><span class="s">numeric_state'</span>
<span class="s">below</span><span class="pi">:</span> <span class="s">50</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/binary_sensor.bayesian.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
<img src='/images/supported_brands/home-assistant.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>: Local Polling
</div>
<div class='section'>
Introduced in release: 0.53
</div>
<div class='section'>
Source:
<a href='https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/binary_sensor/bayesian.py'>binary_sensor/bayesian.py</a>
</div>
<div class='section'>
This is a platform for
<a href='/components/binary_sensor/'>the Binary Sensor component</a>.
</div>
<div class='section'>
<h1 class="title delta">Category Binary Sensor</h1>
<ul class='divided'>
<li>
<a href='/components/binary_sensor.ads/'>ADS Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.abode/'>Abode Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.alarmdecoder/'>AlarmDecoder Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.android_ip_webcam/'>Android IP Webcam Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.august/'>August Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.aurora/'>Aurora sensor</a>
</li>
<li>
<a href='/components/binary_sensor.axis/'>Axis Binary Sensor</a>
</li>
<li>
Bayesian Binary Sensor
</li>
<li>
<a href='/components/binary_sensor.bbb_gpio/'>BeagleBone Black GPIO Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.blink/'>Blink Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.bloomsky/'>BloomSky Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.command_line/'>Command line Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.concord232/'>Concord232 Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.ecobee/'>Ecobee Binary Sensor</a>
</li>
<li>
<a href='/components/sensor.ecobee/'>Ecobee Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.eight_sleep/'>Eight Sleep Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.enocean/'>EnOcean Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.envisalink/'>Envisalink Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.ffmpeg_motion/'>FFmpeg Motion Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.ffmpeg_noise/'>FFmpeg Noise Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.flic/'>Flic Smart Button</a>
</li>
<li>
<a href='/components/binary_sensor.http/'>HTTP Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.hikvision/'>Hikvision Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.hive/'>Hive Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.homematic/'>Homematic Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.ihc/'>IHC Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.isy994/'>ISY994 Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.insteon_plm/'>Insteon PLM Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.iss/'>International Space Station</a>
</li>
<li>
<a href='/components/binary_sensor.knx/'>KNX Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.mercedesme/'>Mercedes me Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.mysensors/'>MySensors Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.nx584/'>NX584 zones</a>
</li>
<li>
<a href='/components/binary_sensor.nest/'>Nest Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.netatmo/'>Netatmo Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.octoprint/'>OctoPrint Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.rpi_pfio/'>PiFace Digital I/O Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.pilight/'>Pilight Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.ping/'>Ping (ICMP) Binary sensor</a>
</li>
<li>
<a href='/components/binary_sensor.rest/'>RESTful Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.rfxtrx/'>RFXtrx Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.rpi_gpio/'>Raspberry Pi GPIO Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raspihats/'>Raspihats Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.ring/'>Ring Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.spc/'>SPC Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.satel_integra/'>Satel Integra Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.skybell/'>Skybell Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.sleepiq/'>SleepIQ Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.tcp/'>TCP Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.tellduslive/'>Telldus Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.template/'>Template Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.tesla/'>Tesla Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.threshold/'>Threshold Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.trend/'>Trend Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.velbus/'>Velbus sensors</a>
</li>
<li>
<a href='/components/binary_sensor.vera/'>Vera Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.verisure/'>Verisure Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.wink/'>Wink Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.workday/'>Workday Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.xiaomi_aqara/'>Xiaomi Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.zwave/'>Z-Wave Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.zigbee/'>ZigBee Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.zha/'>ZigBee Home Automation Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.arest/'>aREST Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.deconz/'>deCONZ Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.gc100/'>gc100 Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.mystrom/'>myStrom Binary Sensor</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>
Reference in a new issue View git blame Copy permalink