home-assistant.github.io/getting-started/z-wave-device-specific/index.html
2017-02-05 04:50:40 +00:00

321 lines
No EOL
18 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>Z-Wave Device Specific Settings - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Extended instructions how to setup Z-Wave.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/getting-started/z-wave-device-specific/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Z-Wave Device Specific Settings">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/getting-started/z-wave-device-specific/">
<meta property="og:type" content="website">
<meta property="og:description" content="Extended instructions how to setup Z-Wave.">
<meta property="og:image" content="https://home-assistant.io/images/default-social.png">
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:site" content="@home_assistant">
<meta name="twitter:title" content="Z-Wave Device Specific Settings">
<meta name="twitter:description" content="Extended instructions how to setup Z-Wave.">
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.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="/ecosystem/">Ecosystem</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">
Z-Wave Device Specific Settings
</h1>
</header>
<hr class="divider">
<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 the sensor properly, 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>node_id</strong> (<em>Required</em>): The node_id of the device that you are going to set a parameter to.</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 its needed. Check OZW.log for details on this.
You should check OZW.log to see if your new setting has been set
Example entry in dev-service, setting binary reports for an 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">node_id"</span><span class="pi">:</span> <span class="nv">42</span><span class="pi">,</span>
<span class="s2">"</span><span class="s">parameter"</span><span class="pi">:</span> <span class="nv">5</span><span class="pi">,</span>
<span class="s2">"</span><span class="s">value"</span><span class="pi">:</span> <span class="nv">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 OpenZWaves <code class="highlighter-rouge">options.xml</code> which is located in OpenZWaves 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 its 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 another Z-Wave tool that can show you logs while pairing. Home Assistant stores logs from Z-Wave in <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 successfully with a secure connection. If you use OpenZWave 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>
<p>Heres a handy configuration for the Aeon Labs Minimote that defines all possible button presses. Put it into <code class="highlighter-rouge">automation.yaml</code>.</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">Minimote Button 1 Pressed</span>
<span class="s">trigger</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">event</span>
<span class="s">event_type</span><span class="pi">:</span> <span class="s">zwave.scene_activated</span>
<span class="s">event_data</span><span class="pi">:</span>
<span class="s">object_id</span><span class="pi">:</span> <span class="s">aeon_labs_minimote_1</span>
<span class="s">scene_id</span><span class="pi">:</span> <span class="s">1</span>
<span class="pi">-</span> <span class="s">alias</span><span class="pi">:</span> <span class="s">Minimote Button 1 Held</span>
<span class="s">trigger</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">event</span>
<span class="s">event_type</span><span class="pi">:</span> <span class="s">zwave.scene_activated</span>
<span class="s">event_data</span><span class="pi">:</span>
<span class="s">object_id</span><span class="pi">:</span> <span class="s">aeon_labs_minimote_1</span>
<span class="s">scene_id</span><span class="pi">:</span> <span class="s">2</span>
<span class="pi">-</span> <span class="s">alias</span><span class="pi">:</span> <span class="s">Minimote Button 2 Pressed</span>
<span class="s">trigger</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">event</span>
<span class="s">event_type</span><span class="pi">:</span> <span class="s">zwave.scene_activated</span>
<span class="s">event_data</span><span class="pi">:</span>
<span class="s">object_id</span><span class="pi">:</span> <span class="s">aeon_labs_minimote_1</span>
<span class="s">scene_id</span><span class="pi">:</span> <span class="s">3</span>
<span class="pi">-</span> <span class="s">alias</span><span class="pi">:</span> <span class="s">Minimote Button 2 Held</span>
<span class="s">trigger</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">event</span>
<span class="s">event_type</span><span class="pi">:</span> <span class="s">zwave.scene_activated</span>
<span class="s">event_data</span><span class="pi">:</span>
<span class="s">object_id</span><span class="pi">:</span> <span class="s">aeon_labs_minimote_1</span>
<span class="s">scene_id</span><span class="pi">:</span> <span class="s">4</span>
<span class="pi">-</span> <span class="s">alias</span><span class="pi">:</span> <span class="s">Minimote Button 3 Pressed</span>
<span class="s">trigger</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">event</span>
<span class="s">event_type</span><span class="pi">:</span> <span class="s">zwave.scene_activated</span>
<span class="s">event_data</span><span class="pi">:</span>
<span class="s">object_id</span><span class="pi">:</span> <span class="s">aeon_labs_minimote_1</span>
<span class="s">scene_id</span><span class="pi">:</span> <span class="s">5</span>
<span class="pi">-</span> <span class="s">alias</span><span class="pi">:</span> <span class="s">Minimote Button 3 Held</span>
<span class="s">trigger</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">event</span>
<span class="s">event_type</span><span class="pi">:</span> <span class="s">zwave.scene_activated</span>
<span class="s">event_data</span><span class="pi">:</span>
<span class="s">object_id</span><span class="pi">:</span> <span class="s">aeon_labs_minimote_1</span>
<span class="s">scene_id</span><span class="pi">:</span> <span class="s">6</span>
<span class="pi">-</span> <span class="s">alias</span><span class="pi">:</span> <span class="s">Minimote Button 4 Pressed</span>
<span class="s">trigger</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">event</span>
<span class="s">event_type</span><span class="pi">:</span> <span class="s">zwave.scene_activated</span>
<span class="s">event_data</span><span class="pi">:</span>
<span class="s">object_id</span><span class="pi">:</span> <span class="s">aeon_labs_minimote_1</span>
<span class="s">scene_id</span><span class="pi">:</span> <span class="s">7</span>
<span class="pi">-</span> <span class="s">alias</span><span class="pi">:</span> <span class="s">Minimote Button 4 Held</span>
<span class="s">trigger</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">event</span>
<span class="s">event_type</span><span class="pi">:</span> <span class="s">zwave.scene_activated</span>
<span class="s">event_data</span><span class="pi">:</span>
<span class="s">object_id</span><span class="pi">:</span> <span class="s">aeon_labs_minimote_1</span>
<span class="s">scene_id</span><span class="pi">:</span> <span class="s">8</span>
</code></pre>
</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/home-assistant/home-assistant.github.io/tree/current/source/getting-started/z-wave-device-specific.markdown'>Edit this page on GitHub</a></div>
<div class='section'>
<h1 class="title delta">Getting Started Guide</h1>
<ul class='divided sidebar-menu'>
<li>
<a href='/getting-started/'>Installation </a>
<ul>
<li><a href='/getting-started/installation-python/'>Python </a></li>
<li><a href='/getting-started/updating/'>Updating </a></li>
<li><a href='/getting-started/troubleshooting/'>Troubleshooting </a></li>
</ul>
</li>
<li>
<a href='/getting-started/hassbian/'>Hassbian </a>
<ul>
<li><a href='/getting-started/hassbian-installation/'>Installation </a></li>
<li><a href='/getting-started/hassbian-customization/'>Customization </a></li>
<li><a href='/getting-started/hassbian-common-tasks/'>Common tasks </a></li>
<li><a href='/getting-started/hassbian-integrations/'>Integrations </a></li>
<li><a href='/getting-started/hassbian-upgrading/'>Upgrading </a></li>
</ul>
</li>
<li>
<a href='/getting-started/configuration/'>Configuration </a>
<ul>
<li><a href='/getting-started/yaml/'>YAML </a></li>
<li><a href='/getting-started/basic/'>Basic information </a></li>
<li><a href='/getting-started/devices/'>Setting up devices </a></li>
<li><a href='/getting-started/customizing-devices/'>Customizing devices and services </a></li>
<li><a href='/getting-started/presence-detection/'>Presence Detection </a></li>
<li><a href='/getting-started/troubleshooting-configuration/'>Troubleshooting </a></li>
<li><a href='/getting-started/securing/'>Security Check Points </a></li>
</ul>
</li>
<li>
<a href='/getting-started/automation/'>Automation </a>
<ul>
<li><a href='/getting-started/automation-create-first/'>Tutorial </a></li>
<li><a href='/getting-started/automation-trigger/'>Triggers </a></li>
<li><a href='/getting-started/automation-condition/'>Conditions </a></li>
<li><a href='/getting-started/automation-action/'>Actions </a></li>
<li><a href='/getting-started/automation-templating/'>Templates </a></li>
</ul>
</li>
<li>
<a href='/getting-started/scripts/'>Scripts </a>
<ul>
<li><a href='/getting-started/scripts-service-calls/'>Service Calls </a></li>
<li><a href='/getting-started/scripts-conditions/'>Conditions </a></li>
</ul>
</li>
<li>
<a href='/getting-started/z-wave/'>Z-Wave </a>
<ul>
<li><a href='/getting-started/z-wave-controllers/'>Controllers </a></li>
<li><a href='/getting-started/z-wave-settings/'>Modifying Settings </a></li>
<li><a class='active' href='/getting-started/z-wave-device-specific/'>Device Specific </a></li>
</ul>
</li>
<li>
<a href='/getting-started/autostart/'>Autostart </a>
<ul>
<li><a href='/getting-started/autostart-systemd/'>Linux - systemd </a></li>
<li><a href='/getting-started/autostart-upstart/'>Linux - Upstart </a></li>
<li><a href='/getting-started/autostart-init.d/'>Linux - init.d </a></li>
<li><a href='/getting-started/autostart-macos/'>macOS </a></li>
<li><a href='/getting-started/autostart-synology/'>Synology NAS </a></li>
</ul>
</li>
<li><a href='/topics/'>Advanced Topics </a></li>
<li><a href='/details/'>Details </a></li>
<li><a href='/getting-started/mobile/'>Add to Android/iOS Homescreen </a></li>
<li><a href='/getting-started/browsers/'>Browser Compatibility List </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://facebook.com/homeassistantio'><i class="icon-facebook"></i></a>
<a rel="me" href='https://plus.google.com/110560654828510104551'><i class="icon-google-plus"></i></a>
<a rel="me" href='https://github.com/home-assistant/home-assistant'><i class="icon-github"></i></a>
<div class="credit">
Contact us at <a href='mailto:hello@home-assistant.io'>hello@home-assistant.io</a>.<br>
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>
<a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png" /></a><br /><span xmlns:dct="http://purl.org/dc/terms/" property="dct:title">home-assistant.io</span> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.
</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>