369 lines
No EOL
14 KiB
HTML
369 lines
No EOL
14 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>ZigBee Sensor - Home Assistant</title>
|
||
<meta name="author" content="Paulus Schoutsen">
|
||
<meta name="description" content="Instructions on how to set up ZigBee sensors within Home Assistant.">
|
||
|
||
<meta name="viewport" content="width=device-width">
|
||
<link rel="canonical" href="https://home-assistant.io/components/sensor.zigbee/">
|
||
|
||
<meta property="fb:app_id" content="338291289691179">
|
||
<meta property="og:title" content="ZigBee Sensor">
|
||
<meta property="og:site_name" content="Home Assistant">
|
||
<meta property="og:url" content="https://home-assistant.io/components/sensor.zigbee/">
|
||
<meta property="og:type" content="article">
|
||
<meta property="og:description" content="Instructions on how to set up ZigBee sensors within 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="ZigBee Sensor">
|
||
<meta name="twitter:description" content="Instructions on how to set up ZigBee sensors within 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>Getting started <i class="icon icon-caret-down"></i></a>
|
||
<ul>
|
||
<li><a href='/getting-started/'>Installing Home Assistant</a></li>
|
||
<li><a href='/getting-started/configuration/'>Configuration basics</a></li>
|
||
<li><a href='/getting-started/devices/'>Adding devices</a></li>
|
||
<li><a href='/getting-started/presence-detection/'>Presence detection</a></li>
|
||
<li><a href='/getting-started/automation/'>Automation</a></li>
|
||
<li><a href='/getting-started/templating/'>Templating</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a href='/components/'>Components</a></li>
|
||
<li><a href='/cookbook'>Examples</a></li>
|
||
<li>
|
||
<a>Developers <i class="icon icon-caret-down"></i></a>
|
||
<ul>
|
||
<li><a href="/developers/">Setup Development</a></li>
|
||
<li><a href="/developers/architecture/">Architecture</a></li>
|
||
<li><a href="/developers/frontend/">Frontend development</a></li>
|
||
<li><a href="/developers/creating_components/">
|
||
Creating components
|
||
</a></li>
|
||
<li><a href="/developers/add_new_platform/">
|
||
Adding platform support
|
||
</a></li>
|
||
<li><a href="/developers/api/">API</a></li>
|
||
<li><a href="/developers/credits/">Credits</a></li>
|
||
</ul>
|
||
</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">
|
||
ZigBee Sensor
|
||
</h1>
|
||
</header>
|
||
<hr class="divider">
|
||
|
||
|
||
<p>There are two types of ZigBee sensor available to Home Assistant:</p>
|
||
|
||
<ul>
|
||
<li><a href="#analog-input-pin">Analog input pin</a></li>
|
||
<li><a href="#temperature-sensor">Temperature sensor</a> (XBee Pro)</li>
|
||
</ul>
|
||
|
||
<h2><a class="title-link" name="analog-input-pin" href="#analog-input-pin"></a> Analog Input Pin</h2>
|
||
|
||
<p>The analog input pins on an XBee (non-Pro) will read 0V to 1.2V. This is translated by the <a href="https://github.com/flyte/xbee-helper">xbee-helper</a> library into a percentage. The maximum voltage your ZigBee device will read is configurable using the <code>max_volts</code> configuration variable.</p>
|
||
|
||
<p>To configure an analog input pin sensor, use the following variables:</p>
|
||
|
||
<ul>
|
||
<li><strong>name</strong> (<em>Required</em>): The name you’d like to give the sensor in Home Assistant.</li>
|
||
<li><strong>platform</strong> (<em>Required</em>): Set to <code>zigbee</code>.</li>
|
||
<li><strong>type</strong> (<em>Required</em>): Set to <code>analog</code>.</li>
|
||
<li><strong>pin</strong> (<em>Required</em>): The number identifying which pin to sample.</li>
|
||
<li><strong>address</strong>: The long 64bit address of the remote ZigBee device whose analog input pin you’d like to sample. Do not include this variable if you want to sample the local ZigBee device’s pins.</li>
|
||
<li><strong>max_volts</strong>: The maximum voltage which the analog input pin is able to read. Default: <code>1.2</code></li>
|
||
</ul>
|
||
|
||
<h4>Example</h4>
|
||
|
||
<div class="highlighter-coderay"><div class="CodeRay">
|
||
<div class="code"><pre><span class="key">sensor</span>:
|
||
- <span class="string"><span class="content">name: My Analog Input</span></span>
|
||
<span class="key">platform</span>: <span class="string"><span class="content">zigbee</span></span>
|
||
<span class="key">type</span>: <span class="string"><span class="content">analog</span></span>
|
||
<span class="key">pin</span>: <span class="string"><span class="content">0</span></span>
|
||
<span class="key">address</span>: <span class="string"><span class="content">0013A2004233D138</span></span>
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
|
||
<p>See the <a href="http://knowledge.digi.com/articles/Knowledge_Base_Article/Digital-and-analog-sampling-using-XBee-radios">Digi knowledge base</a> for more XBee sampling details.</p>
|
||
|
||
<h2><a class="title-link" name="temperature-sensor" href="#temperature-sensor"></a> Temperature Sensor</h2>
|
||
|
||
<p>The XBee Pro (and perhaps other third party modules) contains a thermometer device which can be read by using the <code>TP</code> AT command. To set this up as a temperature sensor device in Home Assistant use the following config variables:</p>
|
||
|
||
<ul>
|
||
<li><strong>name</strong> (<em>Required</em>): The name you’d like to give the temperature sensor in Home Assistant</li>
|
||
<li><strong>platform</strong> (<em>Required</em>): Set to <code>zigbee</code></li>
|
||
<li><strong>type</strong> (<em>Required</em>): Set to <code>temperature</code></li>
|
||
<li><strong>address</strong>: The long 64bit address of the remote ZigBee device whose temperature sensor you’d like to sample. Do not include this variable if you want to sample the local ZigBee device’s temperature.</li>
|
||
</ul>
|
||
|
||
<h4>Example</h4>
|
||
|
||
<div class="highlighter-coderay"><div class="CodeRay">
|
||
<div class="code"><pre><span class="key">sensor</span>:
|
||
- <span class="string"><span class="content">name: Living Room Temperature</span></span>
|
||
<span class="key">platform</span>: <span class="string"><span class="content">zigbee</span></span>
|
||
<span class="key">type</span>: <span class="string"><span class="content">temperature</span></span>
|
||
<span class="key">address</span>: <span class="string"><span class="content">0013A20050E752C5</span></span>
|
||
</pre></div>
|
||
</div>
|
||
</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/balloob/home-assistant.io/tree/master/source/_components/sensor.zigbee.markdown'>Edit this page on GitHub</a></div>
|
||
<div class='brand-logo-container section'>
|
||
<img src='/images/supported_brands/zigbee.png' />
|
||
</div>
|
||
<div class='section'>
|
||
<h1 class='title delta'>Related components</h1>
|
||
<ul class='divided'>
|
||
<li><a href='/components/zigbee/'>
|
||
ZigBee
|
||
</a></li>
|
||
<li><a href='/components/binary_sensor.zigbee/'>
|
||
ZigBee Binary Sensor
|
||
</a></li>
|
||
<li><a href='/components/light.zigbee/'>
|
||
ZigBee Light
|
||
</a></li>
|
||
<li><a href='/components/switch.zigbee/'>
|
||
ZigBee Switch
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
<div class='section'>
|
||
<h1 class="title delta">Category Sensor</h1>
|
||
<ul class='divided'>
|
||
<li>
|
||
<a href='/components/sensor.apcupsd/'>APCUPSd Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.bitcoin/'>Bitcoin</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.bloomsky/'>BloomSky Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.cpuspeed/'>CPU speed</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.command_sensor/'>Command line Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.dweet/'>Dweet.io</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.ecobee/'>Ecobee Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.efergy/'>Efergy</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.eliqonline/'>Eliqonline</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.glances/'>Glances</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.http/'>HTTP Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.mqtt/'>MQTT Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.modbus/'>Modbus Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.mysensors/'>MySensors Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.nest/'>Nest Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.netatmo/'>Netatmo Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.onewire/'>One wire Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.rest/'>RESTful Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.rfxtrx/'>RFXtrx Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/binary_sensor.rpi_gpio/'>Raspberry PI GPIO Binary Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.sabnzbd/'>SABnzbd</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.speedtest/'>Speedtest.net</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.swiss_public_transport/'>Swiss Public Transport</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.systemmonitor/'>System Monitor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.temper/'>TEMPer Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.tellstick/'>TellStick Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.tellduslive/'>Telldus Live sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.template/'>Template Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.time_date/'>Time & Date</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.torque/'>Torque (OBD2)</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.transmission/'>Transmission Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.twitch/'>Twitch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.vera/'>Vera Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.wink/'>Wink Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.worldclock/'>Worldclock</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.zwave/'>Z-Wave Sensor</a>
|
||
</li>
|
||
<li>
|
||
ZigBee Sensor
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.arest/'>aREST Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.mfi/'>mFi 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://github.com/balloob/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>
|
||
|
||
<!--[if lt IE 7]>
|
||
<p class="chromeframe">You are using an <strong>outdated</strong> browser. Please <a href="http://browsehappy.com/">upgrade your browser</a> or <a href="http://www.google.com/chromeframe/?redirect=true">activate Google Chrome Frame</a> to improve your experience.</p>
|
||
<![endif]-->
|
||
|
||
<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> |