Site updated at 2016-08-22 08:21:42 UTC

This commit is contained in:
Travis CI 2016-08-22 08:21:43 +00:00
parent f9d65cbe57
commit 4acb07bf8e
559 changed files with 18878 additions and 21688 deletions

View file

@ -89,48 +89,44 @@
<hr class="divider">
<p>The <code>nx584</code> platform provides integration with GE, Caddx, Interlogix (and other brands) alarm panels that support the NX584 interface module (or have it built in). Supported panels include NX4/6/8/8E. Actual integration is done through <a href="http://github.com/kk7ds/pynx584">pynx584</a> which is required for this to work.</p>
<p>The <code class="highlighter-rouge">nx584</code> platform provides integration with GE, Caddx, Interlogix (and other brands) alarm panels that support the NX584 interface module (or have it built in). Supported panels include NX4/6/8/8E. Actual integration is done through <a href="http://github.com/kk7ds/pynx584">pynx584</a> which is required for this to work.</p>
<p>Enabling this sensor platform exposes all of your zones as binary sensors, which provides visibility through the UI as well as the ability to trigger automation actions instantly when something happens like a door opening, or a motion sensor trigger.</p>
<p>To enable this, add the following lines to your <code>configuration.yaml</code>:</p>
<p>To enable this, add the following lines to your <code class="highlighter-rouge">configuration.yaml</code>:</p>
<div class="highlighter-coderay"><div class="CodeRay">
<div class="code"><pre><span class="key">binary_sensor</span>:
<span class="key">platform</span>: <span class="string"><span class="content">nx584</span></span>
<span class="key">host</span>: <span class="string"><span class="content">ADDRESS</span></span>
<span class="key">exclude_zones</span>:
- <span class="string"><span class="content">ZONE ...</span></span>
<span class="key">zone_types</span>:
<span class="key">ZONE</span>: <span class="string"><span class="content">TYPE</span></span>
</pre></div>
</div>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">binary_sensor</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">nx584</span>
<span class="s">host</span><span class="pi">:</span> <span class="s">ADDRESS</span>
<span class="s">exclude_zones</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">ZONE ...</span>
<span class="s">zone_types</span><span class="pi">:</span>
<span class="s">ZONE</span><span class="pi">:</span> <span class="s">TYPE</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>host</strong> (<em>Optional</em>): This is the host connection string (host:port) for the nx584 server process. If unset, it is assumed to be <code>localhost:5007</code>, which will work if the server process is running on the same system as home-assistant.</li>
<li><strong>host</strong> (<em>Optional</em>): This is the host connection string (host:port) for the nx584 server process. If unset, it is assumed to be <code class="highlighter-rouge">localhost:5007</code>, which will work if the server process is running on the same system as home-assistant.</li>
<li><strong>exclude_zones</strong> (<em>Optional</em>): This is a list of zone numbers that should be excluded. Use this to avoid exposing a zone that is of no interest, unconnected, etc.</li>
<li><strong>zone_types</strong> (<em>Optional</em>): This is a list of zone numbers mapped to zone types. Use this to designate zones as doors, motion sensors, smoke detectors, etc. The list of available zone types relevant to alarm zones are: <code>opening</code>, <code>motion</code>, <code>gas</code>, <code>smoke</code>, <code>moisture</code>, <code>safety</code>.</li>
<li><strong>zone_types</strong> (<em>Optional</em>): This is a list of zone numbers mapped to zone types. Use this to designate zones as doors, motion sensors, smoke detectors, etc. The list of available zone types relevant to alarm zones are: <code class="highlighter-rouge">opening</code>, <code class="highlighter-rouge">motion</code>, <code class="highlighter-rouge">gas</code>, <code class="highlighter-rouge">smoke</code>, <code class="highlighter-rouge">moisture</code>, <code class="highlighter-rouge">safety</code>.</li>
</ul>
<p>Example configuration:</p>
<div class="highlighter-coderay"><div class="CodeRay">
<div class="code"><pre><span class="key">binary_sensor</span>:
<span class="key">platform</span>: <span class="string"><span class="content">nx584</span></span>
<span class="key">host</span>: <span class="string"><span class="content">192.168.1.10:5007</span></span>
<span class="key">exclude_zones</span>:
- <span class="string"><span class="content">3</span></span>
- <span class="string"><span class="content">5</span></span>
<span class="key">zone_types</span>:
<span class="key">1</span>: <span class="string"><span class="content">opening</span></span>
<span class="key">2</span>: <span class="string"><span class="content">opening</span></span>
<span class="key">4</span>: <span class="string"><span class="content">motion</span></span>
<span class="key">6</span>: <span class="string"><span class="content">moisture</span></span>
</pre></div>
</div>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">binary_sensor</span><span class="pi">:</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">nx584</span>
<span class="s">host</span><span class="pi">:</span> <span class="s">192.168.1.10:5007</span>
<span class="s">exclude_zones</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">3</span>
<span class="pi">-</span> <span class="s">5</span>
<span class="s">zone_types</span><span class="pi">:</span>
<span class="s">1</span><span class="pi">:</span> <span class="s">opening</span>
<span class="s">2</span><span class="pi">:</span> <span class="s">opening</span>
<span class="s">4</span><span class="pi">:</span> <span class="s">motion</span>
<span class="s">6</span><span class="pi">:</span> <span class="s">moisture</span>
</code></pre>
</div>