From 1325606f3009fa49aec755f1ee5b8f32ef0f92dc Mon Sep 17 00:00:00 2001 From: Glenn Waters Date: Sun, 7 Oct 2018 16:55:54 -0400 Subject: [PATCH] Add Elk-M1 (#6587) * Add Elk-M1. * Fix PR comments. --- .../alarm_control_panel.elkm1.markdown | 22 ++ source/_components/elkm1.markdown | 253 ++++++++++++++++++ .../images/supported_brands/elkproducts.png | Bin 0 -> 3634 bytes 3 files changed, 275 insertions(+) create mode 100644 source/_components/alarm_control_panel.elkm1.markdown create mode 100644 source/_components/elkm1.markdown create mode 100644 source/images/supported_brands/elkproducts.png diff --git a/source/_components/alarm_control_panel.elkm1.markdown b/source/_components/alarm_control_panel.elkm1.markdown new file mode 100644 index 00000000000..89a57e26fe4 --- /dev/null +++ b/source/_components/alarm_control_panel.elkm1.markdown @@ -0,0 +1,22 @@ +--- +layout: page +title: "Elk-M1 Alarm Control Panel" +description: "Instructions how to integrate Elk M1 alarm control panel." +date: 2018-10-07 00:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: elkproducts.png +ha_release: 0.81 +ha_category: Alarm +ha_iot_class: "Local Push" +--- + +The `elkm1` platform allows you to control your [Elk-M1](https://www.elkproducts.com/m1_controls.html). + +An Elk-M1 area (also known as partition) is represented as an `alarm_control_panel`. + +

+Full configuration details can be found on the main [Elk-M1 component](/components/elkm1/) page. +

diff --git a/source/_components/elkm1.markdown b/source/_components/elkm1.markdown new file mode 100644 index 00000000000..7e6bdb540ed --- /dev/null +++ b/source/_components/elkm1.markdown @@ -0,0 +1,253 @@ +--- +layout: page +title: "Elk-M1 Controller" +description: "Instructions to setup the Elk-M1 controller." +date: 2018-10-07 00:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: elkproducts.png +ha_release: 0.81 +ha_category: Hub +ha_iot_class: "Local Push" +--- + +The Elk-M1 is a home security and automation controller that is capable of alarm control panel functions and automation. + +The Elk-M1 controller is manufactured by [Elk Products](https://www.elkproducts.com). + +## {% linkable_title Configuration %} + +To integrate Elk-M1 controller with Home Assistant, add the following +section to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +elkm1: + host: elk://IP_ADDRESS +``` + +{% configuration %} +host: + description: Connection string to Elk of the form `://
[:port]`. `` is `elk` for non-secure connection, `elks` for secure connection, and `serial` for serial port connection. `
` is IP address or domain or for `serial` the serial port that the Elk is connected to. Optional `` is the port to connect to on the Elk, defaulting to 2101 for `elk` and 2601 for `elks`. + required: true + type: string +username: + description: Username to login to Elk. Only required if using `elks` connection method. + required: false + type: string +password: + description: Password to login to Elk. Only required if using `elks` connection method. + required: false + type: string +temperature_unit: + description: The temperature unit that the Elk panel uses. Valid values are `C` and `F`. + required: false + type: string + default: F +area: + description: Elk areas to include in Home Assistant. + required: false + default: All included. + type: map + keys: + enabled: + description: Enable this configuration section. + type: boolean + required: false + default: true + include: + description: List to include in the form of either `` or `-` where `` is a postive integer or a X10 housecode. See configuration below for examples of ranges. + type: list + required: false + default: All included. + exclude: + description: List to exclude in the form of either `` or `-` where `` is a number or a X10 housecode. See configuration below for examples of ranges. + type: list + required: false + default: None excluded. +counter: + description: Elk counters to include in Home Assistant. + required: false + default: All included. + type: map + keys: + enabled: + description: Enable this configuration section. + type: boolean + required: false + default: true + include: + description: List to include in the form of either `` or `-` where `` is a postive integer or a X10 housecode. See configuration below for examples of ranges. + type: list + required: false + default: All included. + exclude: + description: List to exclude in the form of either `` or `-` where `` is a number or a X10 housecode. See configuration below for examples of ranges. + type: list + required: false + default: None excluded. +keypad: + description: Elk keypads to include in Home Assistant. + required: false + default: All included. + type: map + keys: + enabled: + description: Enable this configuration section. + type: boolean + required: false + default: true + include: + description: List to include in the form of either `` or `-` where `` is a postive integer or a X10 housecode. See configuration below for examples of ranges. + type: list + required: false + default: All included. + exclude: + description: List to exclude in the form of either `` or `-` where `` is a number or a X10 housecode. See configuration below for examples of ranges. + type: list + required: false + default: None excluded. +output: + description: Elk outputs to include in Home Assistant. + required: false + default: All included. + type: map + keys: + enabled: + description: Enable this configuration section. + type: boolean + required: false + default: true + include: + description: List to include in the form of either `` or `-` where `` is a postive integer or a X10 housecode. See configuration below for examples of ranges. + type: list + required: false + default: All included. + exclude: + description: List to exclude in the form of either `` or `-` where `` is a number or a X10 housecode. See configuration below for examples of ranges. + type: list + required: false + default: None excluded. +setting: + description: Elk settings to include in Home Assistant. + required: false + default: All included. + type: map + keys: + enabled: + description: Enable this configuration section. + type: boolean + required: false + default: true + include: + description: List to include in the form of either `` or `-` where `` is a postive integer or a X10 housecode. See configuration below for examples of ranges. + type: list + required: false + default: All included. + exclude: + description: List to exclude in the form of either `` or `-` where `` is a number or a X10 housecode. See configuration below for examples of ranges. + type: list + required: false + default: None excluded. +task: + description: Elk tasks to include in Home Assistant. + required: false + default: All included. + type: map + keys: + enabled: + description: Enable this configuration section. + type: boolean + required: false + default: true + include: + description: List to include in the form of either `` or `-` where `` is a postive integer or a X10 housecode. See configuration below for examples of ranges. + type: list + required: false + default: All included. + exclude: + description: List to exclude in the form of either `` or `-` where `` is a number or a X10 housecode. See configuration below for examples of ranges. + type: list + required: false + default: None excluded. +thermostat: + description: Elk thermostats to include in Home Assistant. + required: false + default: All included. + type: map + keys: + enabled: + description: Enable this configuration section. + type: boolean + required: false + default: true + include: + description: List to include in the form of either `` or `-` where `` is a postive integer or a X10 housecode. See configuration below for examples of ranges. + type: list + required: false + default: All included. + exclude: + description: List to exclude in the form of either `` or `-` where `` is a number or a X10 housecode. See configuration below for examples of ranges. + type: list + required: false + default: None excluded. +plc: + description: Elk PLC lights to include in Home Assistant. + required: false + default: All included. + type: map + keys: + enabled: + description: Enable this configuration section. + type: boolean + required: false + default: true + include: + description: List to include in the form of either `` or `-` where `` is a postive integer or a X10 housecode. See configuration below for examples of ranges. + type: list + required: false + default: All included. + exclude: + description: List to exclude in the form of either `` or `-` where `` is a number or a X10 housecode. See configuration below for examples of ranges. + type: list + required: false + default: None excluded. +zone: + description: Elk zones to include in Home Assistant. + required: false + default: All included. + type: map + keys: + enabled: + description: Enable this configuration section. + type: boolean + required: false + default: true + include: + description: List to include in the form of either `` or `-` where `` is a postive integer or a X10 housecode. See configuration below for examples of ranges. + type: list + required: false + default: All included. + exclude: + description: List to exclude in the form of either `` or `-` where `` is a number or a X10 housecode. See configuration below for examples of ranges. + type: list + required: false + default: None excluded. +{% endconfiguration %} + +Example configuration of the above: +```yaml +elkm1: + host: elks://IP_ADDRESS + username: USERNAME + password: PASSWORD + area: + exclude: [5-8] + zone: + exclude: [11-16, 19-192, 199-208] + plc: + include: [a1-d16, 192] + exclude: [b12-d5] +``` diff --git a/source/images/supported_brands/elkproducts.png b/source/images/supported_brands/elkproducts.png new file mode 100644 index 0000000000000000000000000000000000000000..3f026c21b0e466259c48dab44b775ea9a0189692 GIT binary patch literal 3634 zcmZ8jXE+;N8&2%KM@T|QY!ai5Sg$BCst8)U_MVNsXNg_2yfsQRrKr(r%__Bdl^RuA zqe4|n(OPd?eEF_k-=FVX*LlwU+|N4a{&h0&rUvXR!Ylv)fZfPY&w_e3Q@0HhE!DQY zxBdhG(463}UB^+~KWlpK1458XQW_=9#|`G?l!S?Mva$>h3{s;UtjwHjtdgQIgn~NN z-90#DW@O~$&j+Sv149~^I>#ZT zm8=Q5|DA%6M#!oWQpzMHl_VvRTx{%(tvzEC)7(gFglQy9-(OtUOH9wlJGxj*%buDK zN9pzsy}21)V9w8b3 z=)7+SN7+@K@i{fqGw;sMFLrhh&?*>eD_SYMymc~IMwd}Y4Fr`=$RX3S!LFIvN{B#x z!m@I*bAtT+1TH&JZ!2OF1;RK(41$Gq{6K0hf~t=Em+V0rZXit$QR8s1ULg32zldox z^jd_Fwm0-@I2acs^p_{pD1-}TO(%X0W)>ra^%1j36g7_r>)+y6_XI$%@oBh$jiUiF zcAVM)5G^mDiYE|ZE^ZP5!Q7;kx&bjy;n(m52pfu6XMqeN00Mfnsy-0QG|?MG9*mm+ z#ubQi0mwNq$y?K?2k_%U_;d+^*jxNsUJ$c*L99O;+KpA+o9nV8_*xtYM_^KM1+Zyw z;=+UtLPhNIgv^row1c49zAPx)v*3gu)E7PpwJ@~=M2Ds$@6+*wF)=Q3vZH&Sdc(mh zR!G4zyeuE3t`xn!Jl|fOuB~CJd%ptGT#xB$)mrkAxL>+a;s;@s3^Z>PVM_BV#x z^5T5)GGgZ^-v@e|8Xl4E7Y5i{qvg+k{d>4D^PEhs%u9+2A=qe1ai8vfTKzCN++KdS zFzWl-?Bw`Rf6wE_XlFA6Rq*NQ{sx7z{C0j~thFvLA&fxq@p7@%m)_pmSRL*z4-E}c z<2BJ*t^)vAFh+Vh*S%MEO2+&w&H09>uE;UuU>FD=Nm(!^->fjE8+dy@;`27}7cuNt^`hVBH=r=^u2S8Adnv`lc|W-V7qp&(Y*CJL#fNyiFLYVdLk4IILlSu;Teg==EsTMJd0J=;fkJ!yp89_#S#ra34x=`;Y znw7pDKPZmFx0FnarhIp4jLp32aoRMGORxV1ZB!|L`v~iha2u6k%l9}$Za7qA=eH2C z<7!9;(UzyoCD&eW#Kka`7)#OODt2^c(xMaxv(u^;bG?gAlW6!E-Cvcaloeq{^`cbp z^0GqH--;sc3NP@g@?Sy9dUXG7RPW(r1@rehawio0K;2jiU0ppzIL~+7sELcwOuytbMv|B4PE$N!LP-*LLf4oQ z)6^^2)y=^n(pH>o0(wyY+lB-yNct0f$aATdP-%{`6b|4K;i_>Gt{2hL8dKynZK*6< zX8&w`4Q~w9B}iw!qrVNeW0q$b=b7&n+vs*e*U`aX zzGlaRK_K`8@G%BqhhHq502?{}Ipu~A4MA&)Z7yC1T%irAn zfwyi|X+M6>@h}rxwrS3~zQqkw8Y>Eooi!5`R)yNLXwFgiPvwRa(P8hLjRJs~0p_B2 zktwr-9RjZj{fO$j7d)Pz!W@^GcRLtZ%2QVbynK$!BhF*G*hohu(L@x7(S6~qH%rWL z+ebZ+dJ^*4%6u(9F&=Sd+qehTgMJ_}pW2B3bntCVi97fI`N}q`DcePNRUqf4&HPm- zoVgoQMOTeUYM+5yb5=&e+w5#dYs<7R)tOPD5Iw{ZbV(;Ch6FgR%Uo)__A`@zfaXo= z*RsS1ZHy7mTPG}5WT@>k0Zr%8aAE0$9xvJL#w)lvsYnl2+9btG6gAzAg zRTx)3E3MT&BrYpG`0d3&zuHZR6FBp;Sxk*c+Fk`*3WfCS(BJlyOPjAiYX&Ld<;5eC zmcO$1O*SD>g`Qv2F>77Ml#g#0cQ#>XE*$$LxxJ_%L_R+;W%WJbCY&Rz!thJL-f{g@ z@7W3~-yusLv=B;+epSWIxa{gGNWOgP-y#sXIDPcxa#qmGqf8fKI-BEr-l}&?8RX58 z=C~_@h(K^8WxtcLv#fhbU%b+s?dy3PTsOFOSfiKK=w;<%_z`EIqSF+ZsEV3zD-o?! zE&!vRT&VZx=UzIyWq-2CTM+-^npH5z(v--jRX1aF3N$(wBsLXJ- zqvyJR?Zz)JqvxuBoye|{5^Z#T{^cE#xU^_GolaYDe(yeGgm&+sf>kc9$a#U^tXGFmbuO%+cCjns_#J@2fgT+s9Q&-7B3#Te!3x)!dsUo|qW47u9d{yZFD^yUD>* zzuf(54)n10kzm|dR@1JVRms|FNY>~!;1RR-D}RGz_J@>`;TEn4x;>efSf3vmFuv=& zAKn-*>kU=ECC(A!n~#s5!tPNp>RqavY=5ocqVifeIj-t5qj_F^UY;dCVI)4i^D?z3 z{Z7|QH(r=91%wz4^*+*ZSr9@ruhi{lt^`-vxB}ggti!2^&`65VsJjUk>{oID>c=8gXm*-^>2vL3Q0OtD@ zDMrFhVd_bUZH34wc+whn=a$G5MP3N8ARP-2uN(rJHz^eM*YbVLcz-gnAWOWP#ju?d zrWpLU!j(u`-RT+L9&c1ShR>zTd{?ZcDj}7=s}P>v?K@d`nPKaZ+c&!)3*6t$3*`Sq+Q4B z>Gbxm_o=1UkE%|A4zEbY@$R(ymTztRRviu@35u;LXVHF|efPi-OKUO`iH2c-$E%=_ zXQuSD0u2pcxXc5)2-4AORO`6WC0JilpeEi~rxYGyuNDDDaF*_5-$zJUkn6eZ%Q0F%N^9zraf>wv!V<&=d zJ5?~RB~{#83yk~OE4>#QTTg27hOfH`33tR0tlAZV-w|8x7ajJZ1rEn|#?I4HdBtN3 zW-df7mJ~|(4U(kU?z`vfk0(m=Tp9+;lIkvXgjRDgF+H6?noT!2ZgrjuLd+`is=b~o zbB(rRDzhHN7I~zrOqN+YR}QxKW#M}tHqQn+rQBWV0hw;BX#V=U>pWyV=U+t1a%V?p zg|3C(jOKmvaT#Iuz<9GOkh_!hlf|O(f{IUEFrrx2^87nn=4^WD^Bt6Ka$)O+B%W*} zYNm;ChCQSkak@NHo%_+eRGMC1XVLvOzNCw2)=)Sg_MJACr=kV^B&M`6>sow9fy6iS zANpw>$P)Os!9g;zZ8k8xL|Sf?1dRwnKQ_&!@U%-uCUlw)xa&$#z;;c@u2RKT5;?2N z=~bU9>w0&B{8IYq&+Pr*dkz}6z3uiIdK7$a+YXC%WHvLDyo}ACHgo#dKIk@9(ZAEC zOeo{(+}*Z4G6P5X&(ng|l$|@x{q>CHgYE9Cr=m_D2PPN~xv4Wp=cY_w>+&JcTS^a3 zQiG16BI@}N&xbol9q`F-#O9Wf3M;9>bt#+JqDesE%G!#C@D~1Mxa4}sTmVg5uziT) z&b3UInjrPSd9IKV^Pc9R{zJ2U@34D^+hw&6k29jCc48dnjjG7UVRq!J9`_#zQQE8s zazl^?S#}1e%CttTCD-+03z5fWt!gv0L2mnGR@S&N`LD9j8lk81<#9Ya(@z=+sMJCy r1-YF{Im4%F3Zj9ZC(BeXN>-)3otuWoPWY%lV1N