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

Site updated at 2016-08-24 11:19:24 UTC

Browse source
This commit is contained in:
Travis CI 2016-08-24 11:19:24 +00:00
parent a3b45e423a
commit b60a53843f
28 changed files with 68 additions and 58 deletions
Download patch file Download diff file Expand all files Collapse all files

6
components/arduino/index.html
View file

@ -123,6 +123,12 @@
A word of caution: The Arduino boards are not storing states. This means that with every initialization the pins are set to off/low.
</p>
<p>Add the user who is used to run Home Assistant to the groups to allow access to the serial port.</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code>sudo usermod -a -G dialout,lock <span class="nv">$USER</span>
</code></pre>
</div>
</article>

7
components/binary_sensor.apcupsd/index.html
View file

@ -95,16 +95,15 @@
<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">platform</span><span class="pi">:</span> <span class="s">apcupsd</span>
<span class="s">name</span><span class="pi">:</span> <span class="s">UPS Online</span>
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">apcupsd</span>
<span class="s">name</span><span class="pi">:</span> <span class="s">UPS Online</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>resource</strong> (<em>Required</em>): The resource or endpoint that contains the value.</li>
<li><strong>method</strong> (<em>Optional</em>): The method of the request. Default is GET.</li>
<li><strong>name</strong> (<em>Optional</em>): Name to use in the front end.</li>
</ul>

5
components/binary_sensor.enocean/index.html
View file

@ -97,6 +97,8 @@
<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">enocean</span>
<span class="s">id</span><span class="pi">:</span> <span class="pi">[</span><span class="nv">0x01</span><span class="pi">,</span><span class="nv">0x90</span><span class="pi">,</span><span class="nv">0x84</span><span class="pi">,</span><span class="nv">0x3C</span><span class="pi">]</span>
<span class="s">name</span><span class="pi">:</span> <span class="s">Door</span>
<span class="s">sensor_class</span><span class="pi">:</span> <span class="s">opening</span>
</code></pre>
</div>
@ -104,7 +106,8 @@
<ul>
<li><strong>id</strong> (<em>Required</em>): The ID of the device. This is the 4 bytes long number written on the dimmer.</li>
<li><strong>platform</strong> (<em>Required</em>): Set to <code class="highlighter-rouge">enocean</code>.</li>
<li><strong>name</strong> (<em>Optional</em>): An identifier for the Ligh in the frontend.</li>
<li><strong>sensor_class</strong> (<em>Optional</em>): The <a href="/components/binary_sensor/">type/class</a> of the sensor to set the icon in the frontend.</li>
</ul>

18
components/enocean/index.html
View file

@ -96,10 +96,10 @@
<p>There is currently support for the following device types within Home Assistant:</p>
<ul>
<li><a href="../binary_sensor.enocean">Binary Sensor</a> (wall switches)</li>
<li><a href="../sensor.enocean">Sensor</a> (power meters)</li>
<li><a href="../light.enocean">Light</a> (dimmers)</li>
<li><a href="../switch.enocean">Switch</a></li>
<li><a href="/components/binary_sensor.enocean/">Binary Sensor</a> (wall switches)</li>
<li><a href="/components/sensor.enocean/">Sensor</a> (power meters)</li>
<li><a href="/components/light.enocean/">Light</a> (dimmers)</li>
<li><a href="/components/switch.enocean/">Switch</a></li>
</ul>
<p>However, only a few devices have been confirmed to work. These are:</p>
@ -110,9 +110,9 @@
<li>Permundo PSC234 (switch and power monitor)</li>
</ul>
<p>Other devices will most likely need some changes in the Home-Assistant code in order to work. Support for teaching of devices is also missing at this time.</p>
<p>Other devices will most likely need some changes in the Home Assistant code in order to work. Support for teaching of devices is also missing at this time.</p>
<h1>Configuration</h1>
<p>To integrate an EnOcean controller with Home Assistant, add the following section 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">enocean</span><span class="pi">:</span>
@ -120,7 +120,11 @@
</code></pre>
</div>
<p>If no device is specified, the default will be <strong>/dev/ttyUSB0</strong></p>
<p>Configuration variables:</p>
<ul>
<li><strong>device</strong> (<em>Required</em>): The port where your device is connected to your Home Assistant host.</li>
</ul>

9
components/light.enocean/index.html
View file

@ -91,12 +91,12 @@
<p>An EnOcean light can take many formes. Currently only one type has been tested: Eltako FUD61 dimmer.</p>
<p>To use your EnOcean device, you first have to set up your <a href="../enocean">EnOcean hub</a> and then add the following to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
<p>To use your EnOcean device, you first have to set up your <a href="/components/enocean/">EnOcean hub</a> and then 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">light</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">name</span><span class="pi">:</span> <span class="s">Living_room</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">enocean</span>
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">enocean</span>
<span class="s">name</span><span class="pi">:</span> <span class="s">Living_room</span>
<span class="s">id</span><span class="pi">:</span> <span class="pi">[</span><span class="nv">0x01</span><span class="pi">,</span><span class="nv">0x90</span><span class="pi">,</span><span class="nv">0x84</span><span class="pi">,</span><span class="nv">0x3C</span><span class="pi">]</span>
<span class="s">sender_id</span><span class="pi">:</span> <span class="pi">[</span><span class="nv">0xFF</span><span class="pi">,</span><span class="nv">0xC6</span><span class="pi">,</span><span class="nv">0xEA</span><span class="pi">,</span><span class="nv">0x04</span><span class="pi">]</span>
</code></pre>
@ -107,8 +107,7 @@
<ul>
<li><strong>id</strong> (<em>Required</em>): The ID of the device. This is the 4 bytes long number written on the dimmer.</li>
<li><strong>sender_id</strong> (<em>Required</em>): The Sender ID of the device. This is a 4 bytes long number.</li>
<li><strong>platform</strong> (<em>Required</em>): Set to <code class="highlighter-rouge">enocean</code>.</li>
<li><strong>name</strong> (<em>Required</em>): An identifier for the switch</li>
<li><strong>name</strong> (<em>Optional</em>): An identifier for the Ligh in the frontend.</li>
</ul>

2
components/sensor.arduino/index.html
View file

@ -89,7 +89,7 @@
<hr class="divider">
<p>The <code class="highlighter-rouge">arduino</code> sensor platform allows allow you to get an numerical values from an analog input pin of an <a href="https://www.arduino.cc/">Arduino</a> board. Usually the value is between 0 and 1024.</p>
<p>The <code class="highlighter-rouge">arduino</code> sensor platform allows you to get an numerical values from an analog input pin of an <a href="https://www.arduino.cc/">Arduino</a> board. Usually the value is between 0 and 1024.</p>
<p>To enable an Arduino sensor with Home Assistant, add the following section to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>

9
components/switch.enocean/index.html
View file

@ -91,12 +91,12 @@
<p>An EnOcean switch can take many forms. Currently only one type has been tested: Permundo PSC234</p>
<p>To use your EnOcean device, you first have to set up your <a href="../enocean">EnOcean hub</a> and then add the following to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
<p>To use your EnOcean device, you first have to set up your <a href="/components/enocean/">EnOcean hub</a> and then 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">switch</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">name</span><span class="pi">:</span> <span class="s">Television</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">enocean</span>
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">enocean</span>
<span class="s">name</span><span class="pi">:</span> <span class="s">Front door</span>
<span class="s">id</span><span class="pi">:</span> <span class="pi">[</span><span class="nv">0x01</span><span class="pi">,</span><span class="nv">0x90</span><span class="pi">,</span><span class="nv">0x84</span><span class="pi">,</span><span class="nv">0x3C</span><span class="pi">]</span>
</code></pre>
</div>
@ -105,8 +105,7 @@
<ul>
<li><strong>id</strong> (<em>Required</em>): The ID of the device. This is a 4 bytes long number.</li>
<li><strong>platform</strong> (<em>Required</em>): Set to <code class="highlighter-rouge">enocean</code>.</li>
<li><strong>name</strong> (<em>Required</em>): An identifier for the switch</li>
<li><strong>name</strong> (<em>Optional</em>): An identifier for the switch. Default to <code class="highlighter-rouge">EnOcean Switch</code>.</li>
</ul>