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

Site updated at 2016-10-08 18:28:01 UTC

Browse source
This commit is contained in:
Travis CI 2016-10-08 18:28:02 +00:00
parent c33649c7ed
commit 85df6d11f5
522 changed files with 7493 additions and 3477 deletions
Download patch file Download diff file Expand all files Collapse all files

2
getting-started/installation-vagrant/index.html
View file

@ -126,7 +126,7 @@ When using Vagrant on Windows, change git’s <code class="highlighter-rouge">au
</code></pre>
</div>
<p>This will download and start a virtual machine using Virtualbox, which will internally setup the development environment necessary to start Home Assistant process and run test suite as well. After the VM has started succesfully, the Home Assistant frontend will be accessible locally from your browser at <a href="http://localhost:8123">http://localhost:8123</a></p>
<p>This will download and start a virtual machine using Virtualbox, which will internally setup the development environment necessary to start Home Assistant process and run test suite as well. After the VM has started successfully, the Home Assistant frontend will be accessible locally from your browser at <a href="http://localhost:8123">http://localhost:8123</a></p>
<h2><a class="title-link" name="stopping-vagrant" href="#stopping-vagrant"></a> Stopping Vagrant</h2>

25
getting-started/z-wave-device-specific/index.html
View file

@ -91,14 +91,35 @@
<h5><a class="title-link" name="motion-or-alarm-sensors" href="#motion-or-alarm-sensors"></a> Motion or alarm sensors</h5>
<p>In order for Home Assistant to recognize well the sensor, you will need to change its configuration from <code class="highlighter-rouge">Basic Set (default)</code> to <code class="highlighter-rouge">Binary Sensor report</code> or <code class="highlighter-rouge">Alarm report</code>. Currently there’s no way to do this in Home Assistant but you can use ozwcp (OpenZWave control panel), Domoticz or similar to do it.
<p>In order for Home Assistant to recognize well the sensor, you will need to change its configuration from <code class="highlighter-rouge">Basic Set (default)</code> to <code class="highlighter-rouge">Binary Sensor report</code> or <code class="highlighter-rouge">Alarm report</code>.
These devices will either show as a binary sensor or a sensor called <code class="highlighter-rouge">Alarm xxxx</code> and will report a numeric value. Test to see what value is what. Sometimes this is noted in the device manual.</p>
<p>As of version 0.30 you can set the settings of a Z-Wave device through the dev_service page of Home Assistant with the service: <code class="highlighter-rouge">zwave/set_config_parameter</code>.</p>
<p>The following parameters can be entered:</p>
<ul>
<li><strong>entity_id</strong> (<em>Required</em>): The entity_id of the device that you are going to set a parameter to. Any entity_id of the node can be used.</li>
<li><strong>parameter</strong> (<em>Required</em>): The index number of the parameter to be set. Refer to device manual or zwcfg_[home_id].xml</li>
<li><strong>value</strong> (<em>Required</em>): The value to set the parameter to. Refer to device manual or zwcfg_[home_id].xml</li>
<li><strong>size</strong> (<em>Optional</em>): The size of the value. It is normally not needed to specify this parameter, but in some cases it’s needed. Check OZW.log for details on this.
You should check OZW.log to see if setting has been set
Example entry in dev-service, setting binary report for Aeotec multisensor 6:
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example entry in dev-service</span>
<span class="pi">{</span><span class="s2">"</span><span class="s">entity_id"</span><span class="pi">:</span> <span class="s2">"</span><span class="s">sensor.aetoec_multisensor_6_luminance_5"</span><span class="pi">,</span>
<span class="s2">"</span><span class="s">parameter"</span><span class="pi">:</span> <span class="s2">"</span><span class="s">5"</span><span class="pi">,</span>
<span class="s2">"</span><span class="s">value"</span><span class="pi">:</span> <span class="s2">"</span><span class="s">2"</span>
<span class="pi">}</span>
</code></pre>
</div>
</li>
</ul>
<h5><a class="title-link" name="locks-and-other-secure-devices" href="#locks-and-other-secure-devices"></a> Locks and other secure devices</h5>
<p>These devices require a network key to be set for the Z-Wave network before they are paired. This key is set in OpenZwave’s <code class="highlighter-rouge">options.xml</code> which is located in OpenZWave’s directory. This should also be the same directory as <code class="highlighter-rouge">config_path:</code> in your <code class="highlighter-rouge">configuration.yaml</code>. If it’s not, make sure you have the same values in all the files you are using.
The option is commented out by default in <code class="highlighter-rouge">options.xml</code> and is a default key. Make your own unique key. The key is in Hexadecimals.
It is best to pair these devices in OpenZWave Control Panel or other Z-wave tool that can show you logs while pairing. Test the device before you save the configuration.
It is best to pair these devices in OpenZWave Control Panel or other Z-wave tool that can show you logs while pairing. Home Assistant show logs from zwave too and it is <code class="highlighter-rouge">OZW.log</code> in the Home Assistant config directory.
You should see communication from the node with lines starting with <code class="highlighter-rouge">info: NONCES</code> in <code class="highlighter-rouge">OZW.log</code> when the device is paired secure successfully. If you use Open Zwave Control Panel to pair, test the device before you save the configuration.
Make sure you copy the newly saved <code class="highlighter-rouge">zwcfg_[home_id].xml</code>into your Home Assistant configuration directory.</p>
<h5><a class="title-link" name="aeon-minimote" href="#aeon-minimote"></a> Aeon Minimote</h5>

21
getting-started/z-wave/index.html
View file

@ -110,7 +110,9 @@
</div>
<p>Then get the OpenZWave files and switch to the <code class="highlighter-rouge">python3</code> branch:</p>
<p class="note warning">Do not use root to build python-openzwave as it will surely fail.</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>git clone https://github.com/OpenZWave/python-openzwave.git
<span class="gp">$ </span><span class="nb">cd </span>python-openzwave
<span class="gp">$ </span>git checkout python3
@ -118,6 +120,7 @@
<span class="gp">$ </span>sudo <span class="nv">PYTHON_EXEC</span><span class="o">=</span><span class="k">$(</span>which python3<span class="k">)</span> make install
</code></pre>
</div>
<p class="note">
Instead of <code class="highlighter-rouge">make install</code>, you can alternatively build your own python-openzwave package which can be easily uninstalled:
@ -141,19 +144,14 @@ Instead of <code class="highlighter-rouge">make install</code>, you can alternat
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
<span class="s">zwave</span><span class="pi">:</span>
<span class="s">usb_path</span><span class="pi">:</span> <span class="s">/dev/ttyUSB0</span>
<span class="s">config_path</span><span class="pi">:</span> <span class="s">/usr/local/share/python-openzwave/config</span>
<span class="s">polling_interval</span><span class="pi">:</span> <span class="s">60000</span>
<span class="s">customize</span><span class="pi">:</span>
<span class="s">sensor.greenwave_powernode_6_port_energy_10</span><span class="pi">:</span>
<span class="s">polling_intensity</span><span class="pi">:</span> <span class="s">1</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>usb_path</strong> (<em>Required</em>): The port where your device is connected to your Home Assistant host.</li>
<li><strong>config_path</strong> (<em>Optional</em>): The path to the Python OpenZWave configuration files.</li>
<li><strong>usb_path</strong> (<em>Optional</em>): The port where your device is connected to your Home Assistant host.</li>
<li><strong>config_path</strong> (<em>Optional</em>): The path to the Python OpenZWave configuration files. Defaults to the folder <code class="highlighter-rouge">config</code> in your Python OpenZWave install directory.</li>
<li><strong>autoheal</strong> (<em>Optional</em>): Allows disabling auto Z-Wave heal at midnight. Defaults to True.</li>
<li><strong>polling_interval</strong> (<em>Optional</em>): The time period in milliseconds between polls of a nodes value. Be careful about using polling values below 30000 (30 seconds) as polling can flood the zwave network and cause problems.</li>
<li><strong>customize</strong> (<em>Optional</em>): This attribute contains node-specific override values:
@ -215,6 +213,7 @@ Depending on what’s plugged into your USB ports, the name found above may chan
<h3><a class="title-link" name="events" href="#events"></a> Events</h3>
<h4><a class="title-link" name="zwavenetwork_complete" href="#zwavenetwork_complete"></a> zwave.network_complete</h4>
<p>Home Assistant will trigger a event when the Z-Wave network is complete. Meaning all of the nodes on the network have been queried. This can take quite som time, depending on wakeup intervals on the battery powered devices on the network.</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code> <span class="pi">-</span> <span class="s">alias</span><span class="pi">:</span> <span class="s">Z-Wave network is complete</span>
@ -225,6 +224,7 @@ Depending on what’s plugged into your USB ports, the name found above may chan
</div>
<h4><a class="title-link" name="zwavenetwork_ready" href="#zwavenetwork_ready"></a> zwave.network_ready</h4>
<p>Home Assistant will trigger a event when the Z-Wave network is ready for use. Between <code class="highlighter-rouge">zwave.network_start</code> and <code class="highlighter-rouge">zwave.network_ready</code> Home Assistant will feel sluggish when trying to send commands to Z-Wave nodes. This is because the controller is requesting information from all of the nodes on the network. When this is triggered all awake nodes have been queried and sleeping nodes will be queried when they awake.</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code> <span class="pi">-</span> <span class="s">alias</span><span class="pi">:</span> <span class="s">Z-Wave network is ready</span>
@ -235,6 +235,7 @@ Depending on what’s plugged into your USB ports, the name found above may chan
</div>
<h4><a class="title-link" name="zwavenetwork_start" href="#zwavenetwork_start"></a> zwave.network_start</h4>
<p>Home Assistant will trigger a event when the Z-Wave network is set up to be started.</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code> <span class="pi">-</span> <span class="s">alias</span><span class="pi">:</span> <span class="s">Z-Wave network is starting</span>
@ -245,6 +246,7 @@ Depending on what’s plugged into your USB ports, the name found above may chan
</div>
<h4><a class="title-link" name="zwavenetwork_stop" href="#zwavenetwork_stop"></a> zwave.network_stop</h4>
<p>Home Assistant will trigger a event when the Z-Wave network stopping.</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code> <span class="pi">-</span> <span class="s">alias</span><span class="pi">:</span> <span class="s">Z-Wave network is stopping</span>
@ -274,6 +276,7 @@ You can use this for automations.</p>
<p>The <em>object_id</em> and <em>basic_level</em> of all triggered events can be seen in the console output.</p>
<h4><a class="title-link" name="zwavescene_activated" href="#zwavescene_activated"></a> zwave.scene_activated</h4>
<p>Some devices can also trigger scene activation events, which can be used in automation scripts (for example the press of a button on a wall switch):</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml automation entry</span>
@ -322,6 +325,10 @@ You can use this for automations.</p>
<td>remove_node</td>
<td>Put the Z-Wave controller in exclusion mode. Allows one to remove a device from the Z-Wave network.</td>
</tr>
<tr>
<td>set_config_parameter</td>
<td>Let’s the user set a config parameter to a node.</td>
</tr>
<tr>
<td>soft_reset</td>
<td>Tells the controller to do a “soft reset”. This is not supposed to lose any data, but different controllers can behave differently to a “soft reset” command.</td>