Site updated at 2016-08-13 15:06:42 UTC
This commit is contained in:
Travis CI
parent
c35d2d31f0
commit
f7ee881911
91 changed files with 313 additions and 299 deletions
|
|
@ -89,34 +89,50 @@
|
|||
<hr class="divider">
|
||||
|
||||
|
||||
<p>There are two types of ZigBee sensor available to Home Assistant:</p>
|
||||
<p>There are two types of <a href="http://www.zigbee.org/">ZigBee</a> 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>
|
||||
<p>To configure an analog input pin sensor, add the following to your <code>configuration.yaml</code> file:</p>
|
||||
|
||||
<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>
|
||||
<div class="code"><pre><span class="comment"># Example configuration.yaml entry</span>
|
||||
<span class="key">sensor</span>:
|
||||
- <span class="string"><span class="content">platform: zigbee</span></span>
|
||||
<span class="key">name</span>: <span class="string"><span class="content">My Analog ZigBee Input</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>Configuration variables:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>name</strong> (<em>Required</em>): The name you would like to give the sensor in Home Assistant.</li>
|
||||
<li><strong>type</strong> (<em>Required</em>): Set to <code>analog</code> or <code>temperature</code>.</li>
|
||||
<li><strong>pin</strong> (<em>Required</em>): The number identifying which pin to sample</li>
|
||||
<li><strong>address</strong> (<em>Optional</em>): The long 64 bit address of the remote ZigBee device whose pin you would 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> (<em>Optional</em>): The maximum voltage which the input pin is able to read. Defaults to <code>1.2</code></li>
|
||||
</ul>
|
||||
|
||||
<h2><a class="title-link" name="examples" href="#examples"></a> Examples</h2>
|
||||
|
||||
<h3><a class="title-link" name="analog-input-pin" href="#analog-input-pin"></a> Analog Input Pin</h3>
|
||||
|
||||
<p>The analog input pins on an XBee (non-Pro) will read 0V to 1.2 V. 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, add the following to your <code>configuration.yaml</code> file:</p>
|
||||
|
||||
<div class="highlighter-coderay"><div class="CodeRay">
|
||||
<div class="code"><pre><span class="comment">## Example configuration.yaml entry</span>
|
||||
<span class="key">sensor</span>:
|
||||
- <span class="string"><span class="content">platform: zigbee</span></span>
|
||||
<span class="key">name</span>: <span class="string"><span class="content">My Analog ZigBee Input</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>
|
||||
|
|
@ -128,21 +144,15 @@
|
|||
|
||||
<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>
|
||||
<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.</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>
|
||||
<p>To configure a temperature sensor device, add the following to your <code>configuration.yaml</code> file:</p>
|
||||
|
||||
<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>
|
||||
<div class="code"><pre><span class="comment"># Example configuration.yaml entry</span>
|
||||
<span class="key">sensor</span>:
|
||||
- <span class="string"><span class="content">platform: zigbee</span></span>
|
||||
<span class="key">name</span>: <span class="string"><span class="content">Living Room Temperature 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>
|
||||
|
|
@ -150,6 +160,7 @@
|
|||
</div>
|
||||
|
||||
|
||||
|
||||
</article>
|
||||
|
||||
|
||||
|
|
@ -221,6 +232,9 @@
|
|||
<li>
|
||||
<a href='/components/sensor.enocean/'>EnOcean Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/sensor.envisalink/'>Envisalink Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/sensor.fitbit/'>Fitbit</a>
|
||||
</li>
|
||||
|
|
@ -350,9 +364,6 @@
|
|||
<li>
|
||||
<a href='/components/sensor.vera/'>Vera Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/sensor.envisalink/'>Vera Sensor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/sensor.verisure/'>Verisure Sensor</a>
|
||||
</li>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue