home-assistant.github.io/components/binary_sensor/index.html
2016-05-07 20:05:09 +00:00

222 lines
No EOL
8.2 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>Binary Sensor - Home Assistant</title>
<meta name="author" content="Paulus Schoutsen">
<meta name="description" content="Instructions how to setup your binary sensors with Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/binary_sensor/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Binary Sensor">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/binary_sensor/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions how to setup your binary sensors with 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="Binary Sensor">
<meta name="twitter:description" content="Instructions how to setup your binary sensors with 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='/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='/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">
Binary Sensor
</h1>
</header>
<hr class="divider">
<p>Binary sensors are gathering information about state of switches, contacts, pins, and alike. The return value of those sensors is usually digital (1/0). This means that those sensors knows only two states: <strong>off/low/open</strong> and <strong>on/high/closed</strong>.</p>
<p>Knowing that there are only two states allows Home Assistant to represent the sensor better in the frontend.</p>
<p>Most binary sensors support the <code>SENSOR_CLASSES</code> which let you specify the type of your sensor. The following types are supported:</p>
<ul>
<li><strong>None</strong>: Generic on/off</li>
<li><strong>opening</strong>: Door, window, etc</li>
<li><strong>motion</strong>: Motion sensor</li>
<li><strong>gas</strong>: CO, CO2, etc</li>
<li><strong>smoke</strong>: Smoke detector</li>
<li><strong>moisture</strong>: Specifically a wetness sensor</li>
<li><strong>light</strong>: Lightness threshold</li>
<li><strong>power</strong>: Power, over-current, etc</li>
<li><strong>safety</strong>: Generic on=unsafe, off=safe</li>
<li><strong>heat</strong>: On means hot (or too hot)</li>
<li><strong>cold</strong>: On means cold (or too cold)</li>
<li><strong>moving</strong>: On means moving, Off means stopped</li>
<li><strong>sound</strong>: On means sound detected, Off means no sound</li>
<li><strong>vibration</strong>: On means vibration detected, Off means no vibration</li>
</ul>
<p>For analog sensors please check the <a href="https://home-assistant.io/components/#sensor">component overview</a>.</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.io/tree/master/source/_components/binary_sensor.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
</div>
<h1 class='title delta'>Platforms</h1>
<ul class='divided'>
<li><a href='/components/binary_sensor.apcupsd/'>
APCUPSd 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.http/'>
HTTP Binary Sensor
</a></li>
<li><a href='/components/binary_sensor.mqtt/'>
MQTT 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.octoprint/'>
OctoPrint Binary Sensor
</a></li>
<li><a href='/components/binary_sensor.rest/'>
RESTful 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.tcp/'>
TCP Binary Sensor
</a></li>
<li><a href='/components/binary_sensor.template/'>
Template Binary Sensor
</a></li>
<li><a href='/components/binary_sensor.vera/'>
Vera Binary Sensor
</a></li>
<li><a href='/components/binary_sensor.wink/'>
Wink 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.arest/'>
aREST Binary Sensor
</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/home-assistant/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>
<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>