From d54b79382f3babe7ae92c8af98364438d5af575f Mon Sep 17 00:00:00 2001 From: Dan Cinnamon Date: Mon, 20 Jun 2016 00:01:34 -0500 Subject: [PATCH] Added a documentation page for the envisalink component. (#573) --- source/_components/envisalink.markdown | 76 ++++++++++++++++++++++ source/images/supported_brands/eyezon.png | Bin 0 -> 2725 bytes 2 files changed, 76 insertions(+) create mode 100644 source/_components/envisalink.markdown create mode 100644 source/images/supported_brands/eyezon.png diff --git a/source/_components/envisalink.markdown b/source/_components/envisalink.markdown new file mode 100644 index 00000000000..340c88c1975 --- /dev/null +++ b/source/_components/envisalink.markdown @@ -0,0 +1,76 @@ +--- +layout: page +title: "Envisalink Alarm Control Panel" +description: "Instructions on how to integrate a DSC/Honeywell alarm panel with Home Assistant using an envisalink evl3/evl4 board." +date: 2016-06-19 22:10 +sidebar: true +comments: false +sharing: true +footer: true +logo: eyezon.png +ha_category: Alarm +ha_release: 0.23 +--- + +This 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. + +Please visit the [eyezon website](http://www.eyezon.com/) for further information about the evl3 and evl4 boards. + +There is currently support for the following device types within Home Assistant: + +- Binary Sensor (Reports on zone status) +- Sensor (Emulates an alpha-numeric keypad attached to the alarm panel) +- Alarm Control Panel (Reports on partition status, and can be used to arm/disarm the system) + +This is a fully event-based component- any event sent by the Envisalink device will be immediately reflected within Home Assistant. + +## Configuration + +An `envisalink` section must be present in the `configuration.yaml` file and contain the following options as required: + +### Required Parameters +- **host**: The ip address of the Envisalink device on your home network. +- **panel_type**: `HONEYWELL` or `DSC`, depending upon which alarm system you have. +- **user_name**: Which username to authenticate with when connecting to the device. On a Honeywell alarm panel, the username/password are the same. +- **password**: Which password to authenticate with when connecting to the device. +- **code**: Your alarm panel's code, for authenticating user input during arm/disarm. + +### Optional Parameters +- **port**: Which network port to connect with. Default: `4025` +- **evl_version**: 3 for evl3, or 4 for evl4. Default: `3` +- **keepalive_interval**: 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: `60` seconds +- **zonedump_interval**: 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: `30` +- **zones**: 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. *Note- if no zones are specified, Home Assistant will not load any binary_sensor components.* +- **partitions**: 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. + +#### Example + +```yaml +envisalink: +#optional + port: 4025 + evl_version: 3 + keepalive_interval: 60 + zonedump_interval: 30 + +#required + host: + panel_type: HONEYWELL or DSC + user_name: + password: + code: '1234' + + zones: + 11: + name: 'Back Door' + type: 'opening' + + 21: + name: 'First Floor Motion' + type: 'motion' + + partitions: + 1: + name: 'Home Alarm' +``` diff --git a/source/images/supported_brands/eyezon.png b/source/images/supported_brands/eyezon.png new file mode 100644 index 0000000000000000000000000000000000000000..1dd698a885411f81e47a0d83962ad3f02b87091b GIT binary patch literal 2725 zcmV;W3R?AvP)E`LJ)+*4BA>d84DF|GIL1{*+e!c`5n1ji-EQ_lF_fZ5iE~U;btQ|H!ickzm23km_*;hH6`Ug@~tKF#d!n z_mxTiyr2G_W&Vmc|INAnibkJ`fd8_T<vSZVVN8JVUZvX%Z2T4RhRA_y}nl^SEPcxlPJDKj8|Nn>H`yOB#i^Mr6KBqm$ zUt+Ypr}y3EyH^XtJmL|L_+Nw)YFrwM%0sfUVOh_wf$Vde55=nhtv+ZMb~ZjluHeV{ z{4``AgxBz8J=xj)DivGX2ZMZ1dkAL3&&PXPAHlAl7r%P|-g3UTv9b|5bysIhzo_n!Ny9Mlw9FM?8QGz>9st~ z>vEM~@;qfYyZpIJd;n+@U9b_A$8P)J0~Exc`E+8@mGfGND5h#l0i=3dN)FoX_BNUo z9{4_oXT$a_4(RVX;>eY6bE_0Jjowv4P1Dd0Wn(%ROgTKq!r&Y*2Z?cEGO6vi+kS|v z0b2oNUhs2K6z;(3_B!IQs=K`<@l+JAqQy=TMyD=8S)u3V=tV$W9khLa4^86U12b`1 zA+ECuM>3ylJ1Hz5W7=_3F8GZT8hL; zLgLE}62t)#A0+R?l{~`fb;M9jt{x+K(1g8MFVBb85QidWkO0KQXb{yLqlmJb%nu;_$_0d6 zqtn4o7uk?_CeAo=jzB~kqr^o*PKHBbrYKg^iO~a*sM62PiOWn8lnzU7xVn6G-MhYy zU0Eg`D?uF;pms^?H7Y zIR!DXAaR-m_!kqca#&q7=s-M~6JNsWN0(&3_@;tEI1y$UG~hy*P1X?STs>dTE_-p< z)7^FyL%~38`OwrBcTCz=P|-PNNqo5=23($@K{t~MT6itYDme63xJ)O`vSm=y#_fqH zfs%#tAvFcW@!}bQQ?k%rN_xp>7R172;Uy9a&rn+@f`Asj5iToe$Eh$`<1sESYAeUk zB70E8Nkqqz)%ylS$Bh^50f{FQjA!@^9VQ+|&xB*#z)%LS{B|udcu3Nh&C+lq8TP~+ z-Pf-cJS=IWq{vr@1r(HWjUFG9rY#6B(3HxhaE1XmL*r73!=5Y;R=p~tplH8V+O((< z7a{56w5(T%Pw@ESe3Ai8f#s)}$_etHUkcx%Tb0Q=V(>zahZNyFobuwXK|-s6+`}Gd z3z~{9?uNx;@hfE+>KEjqn>W`*)m6*eFp~4mC1p~xYS}~+c z$;0PUkdzXYXk|eju*J=Z&u+*}h34rrGofOxTvpzqLFc!y(Gk$O6K_ZtWpu?c2wvtZZo*^s&${YHoWci?)L`e{r;7Z5i%L_x3Uq0)vfUI z$(rZ+Rb;VP-SQ{r5p42}cfuzCyg%9ZiF7oWKkVHHUaRwN?%p~GFaOjH?(;E1b453~ z?<*s#TI26ueuP>O-u>j5_j)hyO-dQ=)6Z6&#aB}H(&p`dp}-<(=_gLzKeNg z^WXpa>p#Cv!$1E1w`g9b~-R=lT2jkhB4|-J;Qox zGUij>8(GXI8N**=+#*wq@z`X%?o%5sB^NavkMTM+cCiRc{%@}F+8fnj4GC0Y+t6Xu znoaASZFRiB8JR}2%LI*D-wvQ`ZQC^V?M9s_RUJ7k#%eSq7A~!+tm$-XfdzxONDFMR zB~vnBthJv?+-%r9%&J?G<)~_-#y6V=As%~n)9D8zp6NGQtxvkN^?9}b%Sh7Zz?R3b* zT7&NfP1|Z3Y`tq3j>UL=tKN{9dY1;zYD(R)1ZEn%WjQv(A40afb%SX(EW6+nW!Xa#KD=}We%9`fLlC7F#{DluK5nd3Q~LM4 fM?B&Y|7Z9Q+hL*>WC<_y00000NkvXXu0mjfME_Cz literal 0 HcmV?d00001