269 lines
No EOL
15 KiB
HTML
269 lines
No EOL
15 KiB
HTML
<!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>Envisalink Alarm Control Panel - Home Assistant</title>
|
||
<meta name="author" content="Home Assistant">
|
||
<meta name="description" content="Instructions on how to integrate a DSC/Honeywell alarm panel with Home Assistant using an envisalink evl3/evl4 board.">
|
||
|
||
<meta name="viewport" content="width=device-width">
|
||
<link rel="canonical" href="https://home-assistant.io/components/envisalink/">
|
||
|
||
<meta property="fb:app_id" content="338291289691179">
|
||
<meta property="og:title" content="Envisalink Alarm Control Panel">
|
||
<meta property="og:site_name" content="Home Assistant">
|
||
<meta property="og:url" content="https://home-assistant.io/components/envisalink/">
|
||
<meta property="og:type" content="article">
|
||
<meta property="og:description" content="Instructions on how to integrate a DSC/Honeywell alarm panel with Home Assistant using an envisalink evl3/evl4 board.">
|
||
<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="Envisalink Alarm Control Panel">
|
||
<meta name="twitter:description" content="Instructions on how to integrate a DSC/Honeywell alarm panel with Home Assistant using an envisalink evl3/evl4 board.">
|
||
<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">
|
||
Envisalink Alarm Control Panel
|
||
</h1>
|
||
</header>
|
||
<hr class="divider">
|
||
|
||
|
||
<p>The <code class="highlighter-rouge">envisalink</code> component will allow Home Assistant users who own either a DSC or Honeywell alarm panel to leverage their alarm system and it’s 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>
|
||
|
||
<p>There is currently support for the following device types within Home Assistant:</p>
|
||
|
||
<ul>
|
||
<li><a href="/components/binary_sensor.envisalink/">Binary Sensor</a>: Reports on zone status</li>
|
||
<li><a href="/components/sensor.envisalink/">Sensor</a>: Emulates an alpha-numeric keypad attached to the alarm panel</li>
|
||
<li><a href="/components/alarm_control_panel.envisalink/">Alarm Control Panel</a>: Reports on partition status, and can be used to arm/disarm the system</li>
|
||
</ul>
|
||
|
||
<p>This is a fully event-based component. Any event sent by the Envisalink device will be immediately reflected within Home Assistant.</p>
|
||
|
||
<p>As of 0.29, the alarm_trigger service is supported. It is possible to fire off an envisalink-based alarm directly from Home Assistant. For example, a newer zwave/zigbee sensor can now be integrated into a legacy alarm system using a Home Assistant automation.</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>
|
||
|
||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
|
||
<span class="s">envisalink</span><span class="pi">:</span>
|
||
<span class="s">host</span><span class="pi">:</span> <span class="s"><envisalink IP address></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">YOUR_USERNAME</span>
|
||
<span class="s">password</span><span class="pi">:</span> <span class="s">YOUR_PASSWORD</span>
|
||
<span class="s">code</span><span class="pi">:</span> <span class="s1">'</span><span class="s">1234'</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="s">panic_type</span><span class="pi">:</span> <span class="s">Police</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="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="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>
|
||
|
||
<p>Configuration variables:</p>
|
||
|
||
<ul>
|
||
<li><strong>host</strong> (<em>Required</em>): The IP address of the Envisalink device on your home network.</li>
|
||
<li><strong>panel_type</strong> (<em>Required</em>): <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> (<em>Required</em>): 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> (<em>Required</em>): Which password to authenticate with when connecting to the device. EVL3 only works with max. 6 characters.</li>
|
||
<li><strong>code</strong> (<em>Required</em>): Your alarm panel’s code, for authenticating user input during arm/disarm.</li>
|
||
<li><strong>port</strong> (<em>Optional</em>): Which network port to connect with. Default: <code class="highlighter-rouge">4025</code></li>
|
||
<li><strong>evl_version</strong> (<em>Optional</em>): 3 for evl3, or 4 for evl4. Default: <code class="highlighter-rouge">3</code></li>
|
||
<li><strong>keepalive_interval</strong> (<em>Optional</em>): 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. Defaults to <code class="highlighter-rouge">60</code> seconds.</li>
|
||
<li><strong>zonedump_interval</strong> (<em>Optional</em>): 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>panic_type</strong> (<em>Optional</em>): Both DSC and Honeywell boards support a “panic” alarm. This is used when the alarm_trigger service is called in home assistant. This determines which type of panic alarm to raise. Default = Police. Valid values are: Police, Fire, Ambulance</li>
|
||
<li><strong>zones</strong> (<em>Optional</em>): 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. For more information on the available zone types, take a look at the <a href="/components/binary_sensor.envisalink/">Binary Sensor</a> docs. <em>Note: If no zones are specified, Home Assistant will not load any binary_sensor components.</em></li>
|
||
<li><strong>partitions</strong> (<em>Optional</em>): 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>
|
||
|
||
<p>Supported services:</p>
|
||
|
||
<p>The following services are supported by Envisalink and can be used to script or automate the alarm.</p>
|
||
|
||
<ul>
|
||
<li><strong>alarm_disarm</strong>: Disarms the alarm with the user code provided, or the code specified in the configuration.</li>
|
||
<li><strong>alarm_arm_home</strong>: Arms the alarm in home mode.</li>
|
||
<li><strong>alarm_arm_away</strong>: Arms the alarm in standard away mode.</li>
|
||
<li><strong>alarm_trigger</strong>: Trigger an alarm on the Envisalink connected alarm system. For example, a newer zwave/zigbee sensor can now be integrated into a legacy alarm system using a Home Assistant automation.</li>
|
||
<li><strong>envisalink_alarm_keypress</strong>: Sends a string of up to 6 characters to the alarm. <em>DSC alarms only</em></li>
|
||
</ul>
|
||
|
||
|
||
</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/_components/envisalink.markdown'>Edit this page on GitHub</a></div>
|
||
<div class='brand-logo-container section'>
|
||
<img src='/images/supported_brands/eyezon.png' />
|
||
</div>
|
||
<div class='section'>
|
||
IoT class<sup><a href='/blog/2016/02/12/classifying-the-internet-of-things/#classifiers'><i class="icon-info-sign"></i></a></sup>: Local Push
|
||
</div>
|
||
<div class='section'>
|
||
Introduced in release: 0.23
|
||
</div>
|
||
<div class='section'>
|
||
<h1 class='title delta'>Related components</h1>
|
||
<ul class='divided'>
|
||
<li><a href='/components/alarm_control_panel.envisalink/'>
|
||
Envisalink Alarm
|
||
</a></li>
|
||
<li><a href='/components/binary_sensor.envisalink/'>
|
||
Envisalink Binary Sensor
|
||
</a></li>
|
||
<li><a href='/components/sensor.envisalink/'>
|
||
Envisalink Sensor
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
<div class='section'>
|
||
<h1 class="title delta">Category Alarm</h1>
|
||
<ul class='divided'>
|
||
<li>
|
||
<a href='/components/alarm_control_panel.alarmdotcom/'>Alarm.com Alarm Control Panel</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/alarm_control_panel.concord232/'>Concord232 Alarm Control Panel</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/alarm_control_panel.envisalink/'>Envisalink Alarm</a>
|
||
</li>
|
||
<li>
|
||
Envisalink Alarm Control Panel
|
||
</li>
|
||
<li>
|
||
<a href='/components/alarm_control_panel.mqtt/'>MQTT Alarm Control Panel</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/alarm_control_panel.manual/'>Manual Alarm Control Panel</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/alarm_control_panel.nx584/'>NX584 Alarm Control Panel</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/alarm_control_panel.simplisafe/'>SimpliSafe Alarm Control Panel</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/alarm_control_panel.verisure/'>Verisure Alarm</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>
|
||
</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> |