From 41f6365e212553756bfdf1e0ba24a9c37de10892 Mon Sep 17 00:00:00 2001 From: rubund Date: Wed, 1 Jun 2016 13:18:46 +0200 Subject: [PATCH] Added documentation for EnOcean component (#515) * Added documentation for enocean components * More clearly state the limitations of the EnOcean support --- .../binary_sensor.enocean.markdown | 29 ++++++++++++ source/_components/enocean.markdown | 42 ++++++++++++++++++ source/_components/light.enocean.markdown | 33 ++++++++++++++ source/_components/sensor.enocean.markdown | 32 +++++++++++++ source/_components/switch.enocean.markdown | 31 +++++++++++++ source/images/supported_brands/enocean.png | Bin 0 -> 9137 bytes 6 files changed, 167 insertions(+) create mode 100644 source/_components/binary_sensor.enocean.markdown create mode 100644 source/_components/enocean.markdown create mode 100644 source/_components/light.enocean.markdown create mode 100644 source/_components/sensor.enocean.markdown create mode 100644 source/_components/switch.enocean.markdown create mode 100644 source/images/supported_brands/enocean.png diff --git a/source/_components/binary_sensor.enocean.markdown b/source/_components/binary_sensor.enocean.markdown new file mode 100644 index 00000000000..24cdbf89023 --- /dev/null +++ b/source/_components/binary_sensor.enocean.markdown @@ -0,0 +1,29 @@ +--- +layout: page +title: "EnOcean Binary Sensor" +description: "Instructions on how to set up EnOcean binary sensors within Home Assistant." +date: 2016-05-25 23:49 +sidebar: true +comments: false +sharing: true +footer: true +logo: enocean.png +ha_category: Binary Sensor +--- + +This can typically be one of those batteryless wall switches. Currently only one type has been tested: Eltako FT55. Other devices will most likely not work without changing the Home-Asisstant code. + + +To use your EnOcean device, you first have to set up your [EnOcean hub](../enocean) and then add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +binary_sensor: + - platform: enocean + id: [0x01,0x90,0x84,0x3C] +``` + +Configuration variables: + +- **id** (*Required*): The ID of the device. This is the 4 bytes long number written on the dimmer. +- **platform** (*Required*): Set to `enocean`. diff --git a/source/_components/enocean.markdown b/source/_components/enocean.markdown new file mode 100644 index 00000000000..ea9fa21df69 --- /dev/null +++ b/source/_components/enocean.markdown @@ -0,0 +1,42 @@ +--- +layout: page +title: "EnOcean" +description: "Connect EnOcean devices to home-assistant" +date: 2016-05-25 23:39 +sidebar: true +comments: false +sharing: true +footer: true +logo: enocean.png +ha_category: Hub +--- + +The [EnOcean](https://en.wikipedia.org/wiki/EnOcean) standard is supported by many different vendors. There are switches and sensors of many different kinds, and typically they employ energy harvesting to get power such that no batteries are unnecessary. + +The `enocean` component adds support for some of these devices. You will need a controller like the [USB300](https://www.enocean.com/en/enocean_modules/usb-300-oem/) in order for it to work. + +There is currently support for the following device types within Home Assistant: + +- [Binary Sensor](../binary_sensor.enocean) (wall switches) +- [Sensor](../sensor.enocean) (power meters) +- [Light](../light.enocean) (dimmers) +- [Switch](../switch.enocean) + +However, only a few devices have been confirmed to work. These are: + +- Eltako FUD61 dimmer +- Eltako FT55 battery-less wall switch +- Permundo PSC234 (switch and power monitor) + +Other devices will most likely need some changes in the Home-Assistant code in order to work. Support for teaching of devices is also missing at this time. + +# Configuration + +```yaml +# Example configuration.yaml entry +enocean: + device: /dev/ttyUSB0 +``` + +If no device is specified, the default will be **/dev/ttyUSB0** + diff --git a/source/_components/light.enocean.markdown b/source/_components/light.enocean.markdown new file mode 100644 index 00000000000..560500de3e1 --- /dev/null +++ b/source/_components/light.enocean.markdown @@ -0,0 +1,33 @@ +--- +layout: page +title: "EnOcean Light" +description: "Instructions on how to set up EnOcean lights within Home Assistant." +date: 2016-05-25 23:49 +sidebar: true +comments: false +sharing: true +footer: true +logo: enocean.png +ha_category: Light +--- + +An EnOcean light can take many formes. Currently only one type has been tested: Eltako FUD61 dimmer. + + +To use your EnOcean device, you first have to set up your [EnOcean hub](../enocean) and then add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +light: + - name: Living_room + platform: enocean + id: [0x01,0x90,0x84,0x3C] + sender_id: [0xFF,0xC6,0xEA,0x04] +``` + +Configuration variables: + +- **id** (*Required*): The ID of the device. This is the 4 bytes long number written on the dimmer. +- **sender_id** (*Required*): The Sender ID of the device. This is a 4 bytes long number. +- **platform** (*Required*): Set to `enocean`. +- **name** (*Required*): An identifier for the switch diff --git a/source/_components/sensor.enocean.markdown b/source/_components/sensor.enocean.markdown new file mode 100644 index 00000000000..f635a8d2e33 --- /dev/null +++ b/source/_components/sensor.enocean.markdown @@ -0,0 +1,32 @@ +--- +layout: page +title: "EnOcean Sensor" +description: "Instructions how to integrate TellStick sensors into Home Assistant." +date: 2016-05-26 01:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: enocean.png +ha_category: Sensor +--- + + +The `enocean` sensor platform currently only allows reading out the power measured in a Permundo PSC234 switch. + +To use your EnOcean device, you first have to set up your [EnOcean hub](../enocean) and then add the following to your `configuration.yaml` file: + + +```yaml +# Example configuration.yaml entry +sensor: + - name: Television + platform: enocean + id: [0x01,0x90,0x84,0x3C] +``` + +Configuration variables: + +- **id** (*Required*): The ID of the device. This is a 4 bytes long number. +- **platform** (*Required*): Set to `enocean`. +- **name** (*Required*): An identifier for the switch diff --git a/source/_components/switch.enocean.markdown b/source/_components/switch.enocean.markdown new file mode 100644 index 00000000000..3c6fc5e3467 --- /dev/null +++ b/source/_components/switch.enocean.markdown @@ -0,0 +1,31 @@ +--- +layout: page +title: "EnOcean Switch" +description: "Instructions on how to set up EnOcean switches within Home Assistant." +date: 2016-05-25 23:49 +sidebar: true +comments: false +sharing: true +footer: true +logo: enocean.png +ha_category: Switch +--- + +An EnOcean switch can take many forms. Currently only one type has been tested: Permundo PSC234 + + +To use your EnOcean device, you first have to set up your [EnOcean hub](../enocean) and then add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +switch: + - name: Television + platform: enocean + id: [0x01,0x90,0x84,0x3C] +``` + +Configuration variables: + +- **id** (*Required*): The ID of the device. This is a 4 bytes long number. +- **platform** (*Required*): Set to `enocean`. +- **name** (*Required*): An identifier for the switch diff --git a/source/images/supported_brands/enocean.png b/source/images/supported_brands/enocean.png new file mode 100644 index 0000000000000000000000000000000000000000..61aba3285026905bf0906db0a8342990e661feb7 GIT binary patch literal 9137 zcmXX~bwHEt*B&rnq@zctbfbU>2qTql1f&~A$E1;zMoDR;yE`Wh3L-rOq&uZSe&hYV zf1Wt^ea^W~-MgNBR996Xz@@?k000E96=gL60CW)Qc@%_&y5iA0sH1K`8)+430AOZr zN=;u7^-k#_r|+TVZ0+G~=4J(uwsbbPVt5TRv$4{&GP8W|I&38l05HqEmX+3qFYITv zf1*}M3IEJPwMOJdy5~8Z!bJ6VfO$KXZOBkf&Uu!2y;9*A2P7Fhp~leAY*A_(_k25& z(xQUHr=8J4%6TSjWoAcGPB&y*-dfjs26LGr*w&beef|9I{ptF!0+#$Z#q#>rbiCtH zPV>Xf-i<^f1^^HNmnDlarZI|yv}|>I-vr8?FKB=G^Mwkv1Vq?@LTxw!j&nOlGavrY zJ_iAUq)<{xD;aJhjSK()1cby(!Sl0&n}%#0!Fc~CP`qlrNyNSz((Fe>!BF`DqT}l^ zL{j9H82!B)F8Yv(O5!|9gK@%a?1$WB01yoLMufXus;=nD?WXF84v_NsQG)IwSMB@5 zBblCrh(YeDVnFT;8esARHkyG3Vw7}&>QH1;nAME>MBx83 z_vd4%0~yX<4?T|nNbdZL)+hjA*9*gw{s~7Lwppp)sL_#Ts3kB|FjH6cbZD*8vzLaw=DPMn|->L4ihy4$c zDZiI;ys1pk9&5i{JCU}_C1h9kVrF0aSyJOrVh;S(V~7d5_?hK^wCA$YCLG%0i$HxQ zsz)(cmsHWzVhM~XQz-f6ZHcLAH2R~v?0l(H8cSv#YaWO&)|1Do01nA8)wIFfSce?P zR^{eqA>L@HjY0e^v0VCPqG{^PB1xR&x^VJGqs6TF>wl%I_*!zrMEbtqe|ju*Egr@R zWUPe1#y;;jrR={5H1Qk`%PU3`10gZ9|2W&H4bgsC(PSe(=*$Br6cv~X6! zg~b&R2ooU1&@&X;8-^P~*_dd=&dr(UBB%4XP=tBy!2BPxk!HeJL zP$OKNzFtzT$Qy>)O8SWG-Nz96@0GJb`XK>KuzIF=bW~&v$@~cAR2;=c1VIYL)mg=*y@O&j=HI+%D!V+9g*y>? z!M`5Q5h)s3BCJuZC3)L<`EhObF&_rvq6TJE0>IcHj8KH6+t^=@N;FjW_60u)YyDj> z59uSp{q!}zyaTtu3JXV00>tMS54qRnHXRrjOvlMDlQ+< zn{qk5NHUdwabBZ*XKQyB<4cXg6eQXbkEqF-h-gYS!gcs8EGaGcPO|s{P1Uh04_Cf* zGKqBHZ4cRcpbpmRt5yDytNmZ~~v-ORFl1uFDt-^k}LvLS?4fp)v4Oi)b|g(7oI$dfDvd=0$eIyY)ep zhCnm`9S|~Sf7;keV2)R-xsJQ?r?I<_)lvD5IZ;Tp8n7ZA^am0_kNz>Fk_yn*d)$F@ z^sH86Uq{jy7^GFpqusmGADpRwbp)W-(XM_~Q^@ZqdDnEmHm~<Ly6|Q^ITp!k*N! z-^;)Yrm<2T)PVgBX|(emL|+9Yy4X2c=s_)wGc~@V=6@R!`_i`FT!u!9hq!9GrI`$e zvX~N8#)(SNgx4)9>Z|0g0Bl)kq(uUp=uw;~YD?{1V?`X{D+~3*ZGj$Y>3~ znY1ud@ZEp>0;GOS@2l_036z)kSr18U z&f#d>sS_Yw4ca@o;owCghB6C~X8e8F}`9(95Rt*vwUHY>$9 zzfoUxw|8+lxOW_1vDwsW8na-^B`~k?_BGF+nhi0}zxlB>AW8Q}@&tiHjfzIJir9a0 zaYQyJk)t*hb|XvR54&>s`ii<|map-ZlTJ_6)0RYF%YE7NdQsccxZ>RGbjASSgU9nt!EA;O6Jm!4|PMxL9IWIXEGON9XZ~ zY#*@Q5K7lw4GOCISK+4x5jo+HohOKA$3PwTA&te-Oot4_ZgkzmPUev|2D2MW)k*#% z=x~Pi)vkmgMjC+SkRwW?vV&D&1sb4Md_dfYXBR>z}3wz7|S^KIxOudS*HB&=AqL%)Rpq6-Y~# zr3rO6X=8zAxa8%Y43d0cG1ixT3}zH@w=S=MD$6rgjpa(rDiJh>&q>G|vz&!v`0X8vDD$fi zg&fz2CbWd)`>04PN#4(z%%TPn0Kg{_2R*4jCB??;Ljhy}%Rf5hi(THqcrkeuP6b4z z198>Y`(%JGAom%K9S{&iB!!PKbFI1Xd+CbGAwMpi7G`fB+T-(t-Ysh?{)p?nwNVz! zDKZUNc`|-_z9N04{hrvp=C9vvTiGJTqtn0YkbUgMQGvTLzc>Hbpwg!o9Z-hF$__Sz z_pMtBigM#aDJUW@QSYo$eKoNE^r-ybgAr^Q+7C6Onh&JUf^TFw6skzPf@-Js(RO_0 zLUCNR{@_JcKRY`-tM)&)pUFW!LTd|GzpK?{)F0isp0w-SdNC7vQ2RGsmK&aPc4#^K zbe_AMWe>9HyPj9ZoTbnwKhdGN+pux3%F2}&Q_*92D)L@VJ6(7CHh%;+f)9RRwP94A5gDmL8>I-iQE@>Uw+zcv@ z(taINy5Cp%=FX3#=1c!4QQf7*x>j_PzV|SC%cnLHlAFrQW9UQR#2NT1%>ocEF#FNd z`nsvIOE~$YgQ|o9p1+a(78gnhq2@Vjr@L5o=TVTDU?YTaSaFpF_&%=@@cn7qU22s+ z+Qt*1X?$)wb0FsFIC~C`vHSYa)?k&lVe~|Y|Jg{EVbj5YxJzBnY5GHnoL(oU@jbG7 zQ`q=WL&lNfCQH&uTKnOj&3*IrYfz~C>R0ZbL4wu34^)F;UL#E#ywiJiW%ygSL(8{? zD%9eZJ<~FE&kjE6zJ58Pbc<^CPi(v-bphJubQJaUitG@^Q+O_P7{%T_i<7a zfxeZn`Vt|)9@Jo9%&h@kT92-ku#0o_ph+15AlHaS<2nT{4h9`WLF@m04VmpE&aNonz&7iP?{zb z)Zqsz{iSlAxl~cboO-`Gr*=O7UT0=B^#0mtR51Fkgc|LgM78_3QVTfkkdm8;VO81I zm`9!evc?MwoLs8X?#iZ}^0<+-{D&oOpyhan8d5QFL2scUp=*!*Zp621E#h8oLLxeJ zm;nf7=C`Z66pC(Xv)5h8kFRQ%z_=D$8JQobQ7*Un(MFC#)PaTFZ+4z37{(?&eao7U zwv+WoTWy$ABYjJ3{)d*2Dms>eA+W zGrOKs{eFgLSW0iuIC>NLm{bJcMTPilWXiI5un>MqX_RqwDPA5B&enO+o*nTa`PWmd zJZ6m~`ZHU-<-H^O&s*o@V-nI)-MfBb!y#}1T#6_`Qfc?mQ{|nn{2kxBLj4elRYVKK$hQl_GDbgEmJ7F^)u~o z)u7Q_)83oEPP$~4{SWnZOD~Un*$HdsjWi_S`!X!X( zXNNye#hi5J;6%HASRxj0^H!OnfjZ|-(F(eoH_-G0IFr8whz?G;~(PUW^j z$n5?uT5XgMCkqpnlW7e8YV!RX4E!+l9r3h8J%kpf>-)*`WHg9mznbv#vMO6RSNzr$ z(EW#uLgZ1Qd!v)mEY9*tcJj)A76Ed=mCm3A4iiU5k1lcrtz#OzO!+zba!+4(xahh; zt`&+C8r!tS&T=y;GzG_fH*j`L$8~@fAA{?L3W0#6YV~=kj8EXqj7^ar4Yr} z)y`E<{x9^u4W{dj8@UasgKK^r9S@w%Z*69Ol@{oD8h4v2eKAU_hOg*v&DcyuqnG(Z z{wxSmd(ho0&U&*r+3T{^br^^pLTu@Iu!C6^KiLVpR;KtlTcnD_4b{9oNZvYw^;>z3 z1=ziu#_N3dO-bF^b>G=}v9!6q4LU_zOIIt(?s3k-6;|C}D5~yyEQ9OHP$FV#ZTBoJ zEGmk3t_*ukCHl0h-iWA?jyaahU(l6dd!_mQ9|_6vl`XS$g3dBo$nT=D8)M|Z3=y~W z=6)+*W@i%W-0bo6*7oB2+{h|V_wv8KxBa@&X|M5vOX=i!{XYFK z`F6gsV$nz_1>UcL%dTG(<5ajF$|sm|oi`KESH!blqCVuA0L)+Zh%jD^=&;OT1*nKo zr7?wOW8u;ng+bELVik`SeQ7aTVS!rTvg?kVWGXismo^DupEQ9yGC)Fm--Uq7w*bZ@ z>UN&|wxce*MQ_-yH&xBDLA>3t5yZ9v%dlkVGO_3T?s;LCO`d1VRIR|zqx*E2-}-jb z4oTrPDQ3G+j+@$(A6zTj5;Z%bB2|A9Y%b2@fEmFYIAL8*Cp5D>;VW+mVO=uk%16wI zINohry{MPKpN*=rU(b~7=DpkTi$)j3+Y^!hwwYKh#e*boDU<{}*f6WN>f>PXauU!5 z(J1dR)9#ZiN0ccBLw4WgUTZuyIQ_zwGFAxIOUs3om%k*!u03Mh9+FEHRvgZ8?+SLe z57PRjWm=I`-*YjvEbtszuatk$v6aRvawNp766#PQD-e!+TW{qr;5^)ezE$}}2lbA6 z(*gr0BXtixzC;air#%)gJa^bHWEZ$1#HBQ>rPi-Q{aBgvrJ%NZh1*$hGSA62@0JvJ~5!_BR)}B z1EYhyUk2CA9_#J4ZBLdnjHiV1R9omFq-ua{q?pQBW{jVbCw56=4LdM|Dryg^EdtNKA({}{B2SS-1!Q1R-SjqjQCdx$e&HwGL;pu?B~vm zQ?QW^B@f1hF4vS7DyqbOrH09{IPHZbcUpJP%A9v|kmdwDzVkavebv;Lh&XlY}$btZUr2)aHu62j;j5cCX))9E=ne77lURe4(t`Pn)k z_>R?nR(oULGUmeL)_ecszcvbxZ`Mj3bDoR)i+FkF9I7Ua7dPu?2YBwV`9o0XxAHMN z`h}C8J~}HyIX#!pT}f|8zt{zx>8uL0;bo*34-aIo2Z%BGxY)nvb*2>OV0$xdDe(P1bN5u*u%t$ z6CVZMyck}PuDW)^EH~fMLbxb zjr!PI?I~#2(#8FL7$;QVJ(v&_#^rv=TB^^j;0K(1!xN!eNdrQC_zcu31*-#{evP?h zLwvlZ-i{+1o9RNsQ*)Pu^{H=TlK5qxAeL4rzMYrt0;tbf`vj@VcPWutipH*yLmxjf z#9sEWjAW=d~pH-8~=(F{fCV?r%fNxt11IinfMt4E%`&)7XH zrd6wZSBb!DJ6oA2T)E~AAGAJQj?MjDl+x`!X`$WO(b`)t3i+Y=s>T&hKc<(7WHQP+ zEEuoP1h!c#3IEqr)LT0 z5oxxo%h`SU0h~VgE)Xp}sf_R`$!j9@@2U;%ad{*}-+jfBn7N*y{|UXx&zR8MXlSC|MG2w$j{$w~7 zmrOO@zXPKZ8`k2w_H@|35LfDy)4bD zyE!N{FB(B{>iwia*@&RZ1@7pOz1e9(5hmU&r@tMvY|TF-Fnrj z!R8nhvVMcb+L~j-j(iMYpJ~RYVvFY4_*N@Nw@Hzve-W}YRFZL`0F!t(?T-3T#B zZ;AbOK^x0W;g!~;@=Ze@@>}kIV{@Uyb7AD@jQf3DY}7M^&gq1uA^x|BNKU?6v1`TO zdQ5-xLZSRJf@+Je&U&EJTmJ9M5ca=$3B>~q@0Y9HFdSuxa*7XK42+4Ss}(Hu@i0KZ zL9$>az%-;2^m#;)O@-r~#F0X!(tFtX(Q#0k+xECWF$hV%<5qd&gz(tbZ2pYB85RrC z8kCEw^tPSpbscO>@y=snU+_|ms$@F3fT+S4!QxmY${tN8AelYWrf{otbsD362{qO{ zvZYY$+tQXrC2Hmr^TuNN7xh=uI?;kAZ{tR-KAdJ7N)8Sh*6ku8(-$xw^1{mK$fZ!b z_0v1Yq52>xTY>9^st&9T>8p#d)+VDoOAg(WX`$@2TW61N852th%I3aAQ&Mw~@+`YR zzwev(9K1U9L<@%F8Q3BzPr5-zu?s0$O zH1t5F=d;V4;@ip+X8PfG20l-O(VW)m-#xE3f3LdU_hAFkGisRc*|5`=NpPZ<79mt& z9p_#+jovR5{;h~R64k$8w`d%=a03)o4Qmvik@!CnHNP>qpY;$+im)`v+tPkZ z*k*BRUogaCKYKYkeajNwqc-U?zTlA_6qUdvEm`h!KcDABfnSTwwwY!166-n3ZnD1NzZwral&(SgX@_IY{@{Z?tuLX83mD`$ z)iL)!jXug=O6C`F)uqO9)yV~+EOPyw?1lfEXCssuy^Ri$MuzX!)6pqk|IU{~W;?tU zA%wO6luL4$UlQY1uNW<~N~lPA;J?IvbsKb0R$Vr~Oft~AY#Fmdn*FsQ{ zCH+%$P)cKFJ1uo)KuCvIxxq^m*LZJ(3&FTP4m_8mlK}X&Rl?I zRppOw{Yww8b28s^&+H0k8;Czd*|(PaK^~6)?ae#fCXe!nmBOF8+NVa7P1$ zeyteW>ebkQ$U@J37XHZkT4*2B0LgILs}=-4mEWf+D$-UOQ)i6IT6G-ivkZClJo7*b zkC3%@lds~49^b<@oq_1+y#^*#K)n$~+l!ldh1 z)pZV_Z{ENuY*nx;RZQ4U?Q)Sut1|o6zoH2i87gSL>=!V8+3aJzJr)NFJyGp){$5-e z?&i3mMG=_NlfjUaqciT?4~`PrDHCvgp|(7r-?b}~uEWC3oZKp$GTx5*aC@hwa<>?NQA94T3Bo$+Of@;KE& z%G-unc{wg*G8~+1(W`DFoN@S`;*I}7Bo`#+By$^>Ny|?o!sM*@Ay+Paugj27qDc`` zh9}$_J7y<$q?GH_(YdSiOgzaV3X_`pfv*R^P(#8tFYnfh`tu#|T258A3Tpb{e-fhL AYXATM literal 0 HcmV?d00001