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,7 +89,7 @@
<hr class="divider">
<p>This component will allow Home Assistant users who own either a DSC or Honeywell alarm panel to leverage their alarm system and its sensors to provide Home Assistant with rich information about their homes.<br />
<p>This component will allow Home Assistant users who own either a DSC or Honeywell alarm panel to leverage their alarm system and its sensors to provide Home Assistant with rich information about their homes.
Connectivity between Home Assistant and the alarm panel is accomplished through a device produced by Eyez On, known as the Envisalink. The Envisalink evl3 and evl4 boards provide a TCP/IP interface to the alarm panel, where it emulates an alarm keypad. This board also exposes a raw TCP/IP based API, upon which this component is built. Currently, the Envisalink version 4 is the latest model. This component supports both the evl3 and the evl4.</p>
<p>Please visit the <a href="http://www.eyezon.com/">eyezon website</a> for further information about the evl3 and evl4 boards.</p>
@ -106,12 +106,12 @@ Connectivity between Home Assistant and the alarm panel is accomplished through
<h2>Configuration</h2>
<p>An <code>envisalink</code> section must be present in the <code>configuration.yaml</code> file and contain the following options as required:</p>
<p>An <code class="highlighter-rouge">envisalink</code> section must be present in the <code class="highlighter-rouge">configuration.yaml</code> file and contain the following options as required:</p>
<h3>Required Parameters</h3>
<ul>
<li><strong>host</strong>: The IP address of the Envisalink device on your home network.</li>
<li><strong>panel_type</strong>: <code>HONEYWELL</code> or <code>DSC</code>, depending upon which alarm system you have.</li>
<li><strong>panel_type</strong>: <code class="highlighter-rouge">HONEYWELL</code> or <code class="highlighter-rouge">DSC</code>, depending upon which alarm system you have.</li>
<li><strong>user_name</strong>: Which username to authenticate with when connecting to the device. On a Honeywell alarm panel, the username/password are the same.</li>
<li><strong>password</strong>: Which password to authenticate with when connecting to the device.</li>
<li><strong>code</strong>: Your alarm panels code, for authenticating user input during arm/disarm.</li>
@ -119,45 +119,43 @@ Connectivity between Home Assistant and the alarm panel is accomplished through
<h3>Optional Parameters</h3>
<ul>
<li><strong>port</strong>: Which network port to connect with. Default: <code>4025</code></li>
<li><strong>evl_version</strong>: 3 for evl3, or 4 for evl4. Default: <code>3</code></li>
<li><strong>keepalive_interval</strong>: This is a periodic heartbeat signal (measured in seconds) sent to your Envisalink board to keep it from restarting. This is required for DSC and Honeywell systems. Default: <code>60</code> seconds</li>
<li><strong>zonedump_interval</strong>: This is an interval (measured in seconds) where the evl will dump out all zone statuses. This is required for Honeywell systems, which do not properly send zone closure events. DSC boards do not technically need this. Default: <code>30</code></li>
<li><strong>port</strong>: Which network port to connect with. Default: <code class="highlighter-rouge">4025</code></li>
<li><strong>evl_version</strong>: 3 for evl3, or 4 for evl4. Default: <code class="highlighter-rouge">3</code></li>
<li><strong>keepalive_interval</strong>: This is a periodic heartbeat signal (measured in seconds) sent to your Envisalink board to keep it from restarting. This is required for DSC and Honeywell systems. Default: <code class="highlighter-rouge">60</code> seconds</li>
<li><strong>zonedump_interval</strong>: This is an interval (measured in seconds) where the evl will dump out all zone statuses. This is required for Honeywell systems, which do not properly send zone closure events. DSC boards do not technically need this. Default: <code class="highlighter-rouge">30</code></li>
<li><strong>zones</strong>: Envisalink boards have no way to tell us which zones are actually in use, so each zone must be configured in Home Assistant. For each zone, at least a name must be given. <em>Note- if no zones are specified, Home Assistant will not load any binary_sensor components.</em></li>
<li><strong>partitions</strong>: Again, Envisalink boards do not tell us what is in use, and what is not, so each partition must be configured with a partition name. If no partition parameter is specified, then no alarm_panel or sensor components are loaded.</li>
</ul>
<h4>Example</h4>
<div class="highlighter-coderay"><div class="CodeRay">
<div class="code"><pre><span class="key">envisalink</span>:
<span class="comment">#optional</span>
<span class="key">port</span>: <span class="string"><span class="content">4025</span></span>
<span class="key">evl_version</span>: <span class="string"><span class="content">3</span></span>
<span class="key">keepalive_interval</span>: <span class="string"><span class="content">60</span></span>
<span class="key">zonedump_interval</span>: <span class="string"><span class="content">30</span></span>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">envisalink</span><span class="pi">:</span>
<span class="c1">#optional</span>
<span class="s">port</span><span class="pi">:</span> <span class="s">4025</span>
<span class="s">evl_version</span><span class="pi">:</span> <span class="s">3</span>
<span class="s">keepalive_interval</span><span class="pi">:</span> <span class="s">60</span>
<span class="s">zonedump_interval</span><span class="pi">:</span> <span class="s">30</span>
<span class="comment">#required</span>
<span class="key">host</span>: <span class="string"><span class="content">&lt;envisalink IP address&gt;</span></span>
<span class="key">panel_type</span>: <span class="string"><span class="content">HONEYWELL or DSC</span></span>
<span class="key">user_name</span>: <span class="string"><span class="content">&lt;pass&gt;</span></span>
<span class="key">password</span>: <span class="string"><span class="content">&lt;pass&gt;</span></span>
<span class="key">code</span>: <span class="string"><span class="content">'1234'</span></span>
<span class="c1">#required</span>
<span class="s">host</span><span class="pi">:</span> <span class="s">&lt;envisalink IP address&gt;</span>
<span class="s">panel_type</span><span class="pi">:</span> <span class="s">HONEYWELL or DSC</span>
<span class="s">user_name</span><span class="pi">:</span> <span class="s">&lt;pass&gt;</span>
<span class="s">password</span><span class="pi">:</span> <span class="s">&lt;pass&gt;</span>
<span class="s">code</span><span class="pi">:</span> <span class="s1">'</span><span class="s">1234'</span>
<span class="key">zones</span>:
<span class="key">11</span>:
<span class="key">name</span>: <span class="string"><span class="content">'Back Door'</span></span>
<span class="key">type</span>: <span class="string"><span class="content">'opening'</span></span>
<span class="s">zones</span><span class="pi">:</span>
<span class="s">11</span><span class="pi">:</span>
<span class="s">name</span><span class="pi">:</span> <span class="s1">'</span><span class="s">Back</span><span class="nv"> </span><span class="s">Door'</span>
<span class="s">type</span><span class="pi">:</span> <span class="s1">'</span><span class="s">opening'</span>
<span class="key">21</span>:
<span class="key">name</span>: <span class="string"><span class="content">'First Floor Motion'</span></span>
<span class="key">type</span>: <span class="string"><span class="content">'motion'</span></span>
<span class="s">21</span><span class="pi">:</span>
<span class="s">name</span><span class="pi">:</span> <span class="s1">'</span><span class="s">First</span><span class="nv"> </span><span class="s">Floor</span><span class="nv"> </span><span class="s">Motion'</span>
<span class="s">type</span><span class="pi">:</span> <span class="s1">'</span><span class="s">motion'</span>
<span class="key">partitions</span>:
<span class="key">1</span>:
<span class="key">name</span>: <span class="string"><span class="content">'Home Alarm'</span></span>
</pre></div>
</div>
<span class="s">partitions</span><span class="pi">:</span>
<span class="s">1</span><span class="pi">:</span>
<span class="s">name</span><span class="pi">:</span> <span class="s1">'</span><span class="s">Home</span><span class="nv"> </span><span class="s">Alarm'</span>
</code></pre>
</div>