From e382dad5ecdc54987a72ed80126c20597a255286 Mon Sep 17 00:00:00 2001 From: majuss Date: Thu, 20 Jun 2019 14:42:34 +0200 Subject: [PATCH 001/116] Added documentation for the ELV PCA 301 smart emeter switch (#8717) * added PCA 301 docu * added reference to hexfile for jeelink clone * cosmetics * typo * cosmetics; version bump * added name conf; deleted linebreak * :pencil2: Tweaks --- source/_components/switch.pca.markdown | 40 +++++++++++++++++++++++++ source/images/supported_brands/elv.png | Bin 0 -> 46260 bytes 2 files changed, 40 insertions(+) create mode 100644 source/_components/switch.pca.markdown create mode 100644 source/images/supported_brands/elv.png diff --git a/source/_components/switch.pca.markdown b/source/_components/switch.pca.markdown new file mode 100644 index 00000000000..55c53006303 --- /dev/null +++ b/source/_components/switch.pca.markdown @@ -0,0 +1,40 @@ +--- +layout: page +title: "ELV PCA 301 Switch" +description: "Instructions on how to integrate ELV PCA 301 switches into Home Assistant." +date: 2019-02-24 18:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: elv.png +ha_category: Switch +ha_iot_class: Local Polling +ha_release: 0.95 +--- + +The `pca` switch platform allows you to control the state of your [ELV PCA 301 smart switch](https://www.elv.de/funkschaltsteckdose-fuer-energiekostenmonitor-pca-301.html). You need an 868 MHz interface like the [JeeLink](https://www.digitalsmarties.net/products/jeelink) flashed with the [pca-hex firmware](https://github.com/mhop/fhem-mirror/blob/master/fhem/FHEM/firmware/JeeLink_PCA301.hex). + +## {% linkable_title Configuration %} + +To use your PCA 301 switch or socket in your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +switch: + - platform: pca + device: SERIAL_PORT +``` + +This platform will add all PCA 301 switches which are in range. You can read the total used energy in KWh and the current power in Watt. + +{% configuration %} +device: + description: "The path to you serial console. Get it via: `ls /dev/tty*`." + required: true + type: string +name: + description: Default name for the plugs. + required: false + type: string +{% endconfiguration %} diff --git a/source/images/supported_brands/elv.png b/source/images/supported_brands/elv.png new file mode 100644 index 0000000000000000000000000000000000000000..139d727b3f129f427371fabb6bb0402331322131 GIT binary patch literal 46260 zcmeGEWmuG5)CLR>ji7`QN=Sn+gmg&?!jJ;eF*MR8T_cEy^dJHPqJSXXog$sm9g@=0 z4h-<_xu54bj_>>X{(kj`hv4Sg*NStU>s)J$e6FE%hlqv<0)gCtDJy70Ah=}^2zD#}T6~@W9_0t(3LZArOCd2n6v40=WQRLi~Y1ydFa!+vX66 zL<$5#?Uvr4^#pta-%?dc0dj-+{iQiC5qyQ<6--@`;5RW1>HP;)9};`PVF*k??uGB{ z?t)*SiBHhM&H3hla*dO!V0Ndse0t9<*q16N8;)BR5!wxnwY1I$&BguNALl!e=^y%E zF(rJEmEZd47V`W{m8{V$@yY1NH*bQLe$s^E+={drRA%u@;ISXtJddDP=I$*V5?>NL z_LqM6Zfz@&Bnl!tKc|XaIOFE*Z&&}D5sOlIi}TlT;yoeV4XHhl9Ub3!s+N_jj+`+k^vJRp(_r1|)n`qmVCzrgpZCRfp52 zza~31cyI8IVnJ9f9O|^+FJx|Q%nhE3iOzk=l^A&O0qW6<{_Fco{m7OgK&Vy>PRqsM zVJ{)jyu=f%zhqhoUrFXoe?4);9>H}Wa(wgbF2rs0tQVbpsbuE@TZx)_+h42VKbdfI zPCQ0HL!EJBOV8}hC|>>hNE)`oaH3S{apivFyPA=M12MSc)1vKoF?o(Q+6|vlkuW~0 zmdKcm3eZW|i!-T(oy{(mZ&$dC5e}k zDf^qSs?(h+NeMJ(iAf} zLXMBY{2xQ|rL`AzTboYiy$4dT_4<$H1R#h+kB}E-b|-Mb%bA>(ANx>|;^dREZ1&00 zl9&%6ssCQ%Dk+W<@mc$AFioDB4>i44Tr=NUIjSkpxH|c62C(j zmmDMmKAX_;nton8Pnp%KuL~{h6er!RShfoM|}FbFTh*3x<h73))^YZ|s{b z>iM)*!N)DsHOx_oI`jEM1nZbHfmS&&9e+1^i1p7~1kb#wcza1Nu{EaX0Tqw$n47f?$2oS59FRyOs zjT-mynytnJ?SnLv;lAlNmfdU5QPg!3ZCr6N13sA@A&cvycYwts*h_b1!cHKJCT6u#Mgew4+E^*PGe%GH1^E~4+K38HC=^j|J{Mfuo$0F(^ZaSwSEtIb&)_@>Kte@ z(N(C+a~3-kJ?Jeg0-cmeK_Qba*blbJ$smgRpM36z2?}uTb8Uttr zTVL6pw%~AvY!b(wGo)-e>-Dix}a zgebhC$sSSZiKPzLs-7h{L&3c78c!AkQ54~!s~A!1-wpq8@`mk3&Z)L!^1Pwcf1}}P z_)0RXv(ZNBrs?d6=;S|CRWRpl$l$J>WYz}Cqt!FDl~;sC*XQ6n+P2?ob^fflKN_0~ z!Y#8>UVeR;nrx`+KD%_$qnGpf-UYuY_0(ox>1rreVfOM!hdtWU^LVeb{m1aZ15TM( zAuLA8do15P^GH6r`fTCD96zEosj^Sc%5@)z=uvtN(f^AcsO3JcjbQF<6?#1BYc>1e z#H6xzaVo{{!y3HeCrACwS{~AiBKx0nb;4(kno+Mj#Kf#%6$XYPM50}!$7Q6YkTaTO zd}hALo0Yx`E_SE~D~GCj&Z`Q^|1!7O)CoDy18K z@$sbvuBl9oTEzv=8ADT~2oe{9HW(YIC5;|3Njv?d9U!&*s zT-%DWYH5A$gs#z0otMMSi1fEhZ(rd_=jU~*C4TW2ew}UqP8xft zAa`F@vlYgCxGvlB56ij3Au>N|PhA$+DB+-fBPzHP*pu04Vk>$Ur`dY-BgBlBR}-cu zHgRC*;e*PuZdAXRs(X%3dtK;wp4rp7;BnRLnW%pzqdVAnFst<-^)fL}sjt=Kfiv21 z@c>WHy!w03iX7mnu+d;0G_f2-DQoIhs17y4Y|v?WbG z7sBfTSU7FlsZA9((HF|7DD0(qKONb?l%vB#bzUV>*WE{dgO?|g-UX&KzN%}l!gQu}d9_{QS5BD?nEN-c= zQ(Cvw#z&0lGjKXrZmiIIT%mifR4+SFu9IKKP>Yq4jhAa@0y9WcbJDzjqFLi}= zhT(tsZAXUdx59GQ^#>d0Lh4Wq^(cnkRsEC`YNYgL#g$S}tgwd^zerG_x8gb9=bqu_ z!|l}bhOI=^);xa>(ht|%2j{rPgvL{h9buTf+GxV}|Wh1=s&}Lv4@3g*;ESW~^8^5+uA$2B&;)wqC&vpGo z2?*WXm89tH@wfdqyDkU9`8Pr>FS2h+QcKf^hDWu;P6&)V7C)*cEY+=F1Z;wP)p1L2 zNpITDeYIK~Z&UZN2tXcj2#3&38;1zKWP!C(mRo1m%!IRQF~KQT4HP z|0rRt4MgyLmb|Mj+bJ8>o1U||PwhLJ+dC=f7cD^tw01Jk${^L&&#A(vtr}~NFI-*< z&0n2mhcJ2`%n6Pj|7}`?g6#Mum7FobW{+TnRHe?%M-A`${aiFElleLqUifd~eK|VQ zmhWJHa}>^lY~XO{WimkfhO+eAs@PM4LT*V>+5zC^RWiycd@E z^vbSlBQ5UwxM#ONXd-{+#RX^YVBi5!Nd3A(s|Hi7w~A4q@)K=4rr2jk{=?7P9OQN; zA5L@e_!(nEsw!?8YYPuO0mo{V^J&N>)CC<+i_NLs}7$~9VIrkTn*!X zS@3L-ccr~Tm1~YEW+_vbZ?W}=9Xzfn5jCHpw=;rFW8iZ}6F+{1yznut+lG(rZsxx2 zPj+X4aO8%VI>+URWxKk%v^0C}w{4#7K9c!Zi1lS*ys%m7^lM*C$)BglA)|G^o9x$) zXTj$}##>A94bAiO;VO2|OEfY}kw|?1=5Z?U4 zCiOj=D}3~ZUeyZTJpRGA^xGZ1pW5&5U(b)YS0Q=H z@ME&ixeCyq;aS}v(p4nnrS7?jx1PT9cLADy8Lq9Sjux$=F^QY)mhIG?wHoiO6deXN zuXl~=;XO|El-g15Yas#JaPCnKtIDUOd%*((yQ5DQRY3^4YjgvIuJRSME9t-J&O7#k z*a$W-{yuO!learLPmjP$k6*yL;vOEcJdW-C-RJ6N2&wvXF|?TH?X`dTejp;r?dk_b z#-vDV_2tGx-s9M8_No1ZAhC&oAx^2EraK>lr58jWOB{D5qKq&!G}pJ6pLXBh|KR}# zkpWMS7!I-Qj?ssm*7F!qmmYZB4t4HdQ!^8Wf~L?pT(Ny~dmnQdt(mo(7qpzMR+?Vs zIMjr)i+cqQ&fvYb-O=taYStV2E90P5o%7E_`tMjm>T*`Jt~#@*(tL7h%$P2qJjD|O z-BH)jyvg;M7MtsT^G_D_!CQ}EkX|lgZFW*-(KmoM#6ON#dHpg4E?S>`;_E`aY!DZz z{$@tw51UBs-|GB~q&&|g$eOP6_f6P>=QoVEb(QlhYK`@O7jk=kZ{m4qv|BG)yu1BW zsx;{%dbD!p-s59 z-M0#CRpg|B^+BJ7#mxBK z1WwW2Jkz%KEK5yQTHZ?-nh?2BqaH3L*%wzF^TE|ev2-kKM<~~?)7@+A-)`pTqp3Kd z%Bs?G%ZCT$%yEW}hP7vHdU4`6xU#A<_tMPD+?_W1>*;^#Qci4sY?)w}+wAnbrh?tX z%n=y$QS6bRuSgX=n@fUSwon1j&}_6ycCFpIIAj(1P^gTl>&4u9pCzSl<$aWr=6Mta z#VP%1yL9Tf$sU7*nK7L8&Rr}T*g=DHS zYZMyq7PQPr?Z1Tl$j~6lHzPLt&*QUnZOGxx$Z@qvRWADL%yVUT7RVTIKZRK1ScsyVu)odaK`TG4}_bUIw1f}Can>3#KJH=gi zs1>Q$pAq*mL0{iz^HZ8M7fP2DJ-qv!Qkz|{cCWhd;$e*nOZ(Ai<_~JmnULe@>ic8j zZy;ar0_~X`%tp^I@&k;1|E$X*u0##hh`c{p?EQM};=;MiL4s;mAPL!p8~=INA|U=E zm|dStHh1+?K^EZS-f^qLs{WP`&t+XsbNj^u_{P|?YSgu^l+~=&joQuhzyv9}l=CK= z&6sj<%F+EW+sriS)8HsPxK680o-mPB&m5~qG*OzW_p?`*@FlzP##6;$i?>Tx=pHJU zl_Bh4%VXh72PBopw5$vNSaEg2QQCgsw@EiPtej$ZMSI69a}*2U;M&p;Ey5rC{ZapP zA=4zLltSt3ip_Y(gnrTFiA=9%nft2^DPH(S-EGNQX?;|oZqN57wFPrc-iYxhp~WJH ztGBr!^)4OKzUIL{iT%5C?TofP>rLagYLl;?0S)4E-n)6m8lqNdFu%oYDM7Zw;K0xLD*h;M=my5-bPPo?Ebs#PO$4~zYp zs5#B6<1Y*BN)m-+??R45$&XvNc0Tz zzFiraFV|;U^aLbLk!d9H^G-g*L7z5Ld4g>`zN3jv3?YRUfHn^T5$=+$*;M;GUs&pv zvEXIr1UfWf>q_Y+6-LV*(Qps0?uu-rgs+W$WecI+%1`{cE+e&7`rwj}2PHVw($w-O z63_&D3{6NMtebzOc=PW>Sv92RQ43>EX17`h=xfj1=8BHREoq)@h2;7A>(t!1wc12+r1`5%B;m8c)e06OVn0zPT@K?-mEuM-%LL; zd+rq-Jd!$iQ@X0#Y&;)mzGd*MC3Pww5nLhC(wPkpB0eH?E<<jhVN8-p>y{9ZHC-}5g^>4mt))v6%; zgOhh^>jmCYt~?Ec!`J#VQr1Db;H93h6p1GlA^Gr$0C^>yf1#wXnvJh;`SL;(wO_Lm z2nRCHjHg5p5A((OkZjk$jT^_rE>tKaq~Ol`w1ei&ipqvM`jMJdcE@^31JdhPab-Qy zlH%GWxx&A(<6Tb^Mr-810u84%J?$g!d%b3a*BVbXgTY3r%4zX>qVbRYmcUEnGOO5D zj06TR(O0RNKct~;+RBt#ygyX9{Q-5rdkm^nt4x5Z*?|tI;To9yg_ zHN=e>Zsm~^n6D}YMgJX6!*tK9Bx6LKo2s*|^Gk}OR@($z48|@=dl>1qcG@i9Rr%mL zLG%4)t|?QRIOm=3caqPQX&7%oejhGq3Hk>gc#Xjw^E8_;-`}B)3b*`I_{8?pM%GIT2Oo8H)AKjRZ*xC!kaj;vV1<-eQb()vLs+Tb>fl){m+hpvsKE2r#9&C*>!oB;BnvqP&#ecVQG_5 zE0hRGeHB!swQk|PK62dfPaPwHjBWn%*+ZZQH&X89_&E7L8#PI*?wO-n0R4Pj;4L4> zug}|0zioEy!-qW&RghWAwQQ(UQM0*!?{oNgL|wSN>CnkG#s*WGX-;k5_N^#OS$jzs zO3aWu(FWJ(r0d4(owMsDv5Gz99^AGwHFamik%X=e{aWU`>BMnP&nazxV7~bAA2z?% zkfi-T9hH&!JPjHLi|Mbk8L?&0sgZno zva8%sETVl~*is!suQ&0e7VFo=e&Of(lH=vqj`OD~>meMI8A&5u3%zlx?^~T}eDiX= zNKsMKpDP3Ej*Qc~b8ilRggA}5rlNXV#aPZ5=ypm)V@0l8%=UsZ2e-B=e1DFFEJa^I zM-z&}q9U#rPJh8wKJ_o`7GoIe#+9@!u|-r0T}e~V8UyPs2o}o3ZX8|z+3{?0P8c!k zW}|lWH62~YJ5_oTCwd)YOucs;{ZX1{MrT$ml+Sk@y@zRZk{hvJn(9bGHRG&q0$`-B zk)&(aJ^)?#RKI23=ei2df!dH>$KM&J1mBq@PH;~XH^79qX*?M0u>mE0Y*kFUit>Q5jn~Qr@V}uSqX#{_9qln@8 zq{;BXW=Pd%45uv=dGR2|>L$hLo3EGeet@IVQXv4QYFqDaWMaiRzWu5kEk7_ zF}ixIzdv=TlOqCp;C>FD7^U|vUke#g+582{deUKXIX1B@+2Y95#B@z{L74LrufFbw z-Fdp}Kbi$Vx=c5I;Cz_=Ohk@IiQV3o?_E}SsRoI@nF5V$>|FKUb_yM*{=$mp+FxpW zj+H_w*J)$bW7;#IvOW~vv+O0|KAuVf)wVF^W&wZsQBN5!M%^%Ev^7qd?<*nk3HZnP_wvs>CYS9 zyHb+)B2$|xOYU3sq*9qXe+&2%gGxZ7zf&qd?X{#UJ64qEcnNo_zV(lU=yg_3rgKz6(n;#zl=|-Q#pd^>^1}%~<0nhjOQQmfq-sXgY1eHt!{VT9T4?9y$D6pJO$h#b#g=Ij25}84gS-e6Qz;A&OpJ`;xMEIdXp6 z@-f`cxaP=$R0x-6zcMQ~clDg=+&igP_csMY<6(J}pGgJi*Ann z-P&Os#Xyo^t^kFI8lrH zK(O<3JuYP~#^L8mQciQy#mS~T`UmJvLc|`=`bG=yY1aoS8KKaeqNy-P>+O$4nzm_d z89cS>$kV=Rjc%w}>RzS6P2S_u%8PD0vnAgDAkZU7a2kPvWez@G(JSDiRwB&{ib;uH$2~`_-sdw#5pT`xKZ8v zp@p4(gEJ0-LvZD~exqB3Ga*w5zXfzDuOZOV?KGs9a>QL8x2G+oud+*RjmO?6=8 zK&|T8?L-x%#H%_I&uI87|J@3_`i;R|CH9-V&fHc<4DA{@{6cyAE*1he$eqcd(pSF% zB(o7op8sjz5}39Nx#f4NWlVe3{$L`g@{Rin^Eq*|*HU6duhX@&*+kUr)&O4BjjE|u_r2Yc^pGiPff0`` z9;jTDK#9NanAgpURo)IEVWu+2|hub*>M&1_C5NW{xxhr#f0(}}D zcNwTH-sCna2_@EGt-|5A zc}dGwSE)<=^`dyYSTFzNZ^1i5u3{5f!aH zDPX)&bIuXk)!m?P3sY~+H7NlVQV2!BmLbOsRrfs&JMt22B*c!mbXp52;bZ_{UO1AT z^2!gikc3+4F36GaJ+Ia2VfB~~@SovIW~U;#?5yw4ZVgFK{g2)n2gDY^UYz*tpHjoF zB_mS{fs*!gcIo6hKXVWS&)fQ1LFsh+^vU)jtfjn*Hqw$3-{^>Vc3-fuYg;lPvu{G_ zA^i-ml=|JsfRdRNeTSbmBze!~3P1;i5$;V#B3LsNnK?$4X*c1&yC0da2WKf@5x3ck zvrd%)L3&YzqHt0GKK+)V;pghV1;OOg6OXF|9VZsGZbVK97%(oC=Sh^k7W<`<`xZ)# zGC_Z1DJ+@x4+#z9ii@hfhx1St3p&hF3>p&A$e*5A=>*DIipx_oCTEUDL6rY>_a z1IFh|o)4*xB#M|rh4OOzBL{f`i>2o;h1z8c8!_Fa!_%Y@gKI6=Wxu8u-=|PtWsP#x4HdQhA1?@BSOa`gtf8CHE>%{ zp}ZlN>)xtw*>u~-~&%G#4bDNx(B~uf_JVBP0N|8yNFCR1(7#Rap^rs6k z8O3Au=qnb)<9>pRSM)??=ov66tcG^MPE+MxA_x_J7p2wKsU9Nb?JHmb}=fZtXxDV-$D=8!^wKq$;`nB znB|*=;mNJuhjPq$d!ArGV`$kHrq$MWYBEj$!)m*wF)Te-P9|ez-sH_-$T}-fslNPL zQUl1IKflSa-dbA;7Pcd{5Zn7x6F&5(AJ8AwUTi-whCrqIe?uGA$Ea*GCg{Gr6@6S< zMuArpNXv>1;aHxmEBu!}dRnQYkRYaKE>-u4@oN1u{dzYNH?&osnuW-~LVV7IAs@uk zny%Mf0{L}aN=KG&zYVVOU~w!7y5l*B@NXbE>wn}R@RofO1yGHbxwL%qn1wK!{Hp$< zHvd2Lb^oVKR><~jRD;0l;Z-Xw7*3K|*WKVI)C{US*E+2~%8M&%$okdLKq5pU;yXk3 z@rz(jzSP9)JM5>4xCqMn8&lV*0oOToBgW{pL6gZb)yAfxV;1AO$opg!>a=GQtUO4C z_+amYMVFxtd9j~`1z8tvsELw)QOM7-%&@Y!Ow8670bLBXo(AP6HO8KO*-+XY+DyNC zUCMjUB&epSW~A#z_a0rw%sxk*D`WrANFu3CN@OL^4Ihe)$w82*MSmE|_yk?r7`=m> zj91qFIi0c>W>t1K{xvra{Mvf54AdWTi)VGIg5KETc$9cz=!% zhmx-gCkGKtpf4h>J!|H6S)iI6uRNM)I@H>J1dQnQ&>YNXx%c)>ua&N>1XmRjdjEbr zE{%1@2zUpe_l$i+wsvnhln zR@5fnaJGAY8Z3OZ!bj)W4%rukj4cIgNG$;$KXQyGgeW_tWNn_tXj~C!S&K~wp=5R93jFvOmAQ_1`AZG>Wn^W+DTWurjXf zoX=rn+UU0+E1gW{D5t?)Xa>uS5mL;8mO^wX0K;U-@#M)X!ynHtYJl91ocsS1*kG*p zWM+N$b~8E2J0;Mq>SVTtkK* zV853BI$U7_um_^>6;akJ0ekE1p9%=8uZX0lc#b4U>|aA@>S_7=yn5zLf0O%1ICs$q$?@F@y`?Y!ek{cuWK>uJTPoS=(DJzHX>>~?xF^;qDP$Ocyg!SOrGY4P)98} zcC23%ncPEyO9`cCB%Cu=qtceLg!8YInrc>S0}Af!_x|N20R+VKKQ(513#b|HjL`Lw z)U8>!Eym3my!_$Xd~?x47=@TA(7TY0T~;XXQNljaOE~<7oPXH>Trs|vAmhIFrwTs`YvmudzQcYHS8=8+kwzD)Gkx{1FhgV@gEuOcJk1wmu6$#+X)$4E&Ourmi^vr(?T{?mUdV7gD z9_7Xy6(6&{H22R)7i*($yCqCj)TUzo$nn1>+?SSawD~X#ER23vFOI~f(l}?&LQrmm zi;MYuzZ_db+>^tCy5c}ljGQ?isw>0E+HQ$w65buzIr8z>Rm_rg2x?VyV!G}19-55^ z*YSp*4tN33yen7JlsS(X9{%qSh^yV9(^gg*>!6Z{bXVDRx7osMkjf721*#4N{Woc> z@gKuGF;}oM7q>J2{lV+u^v#P%>Njs@W@zUK+}lAA?W2IIW%S;3gjXBlwtH&=dlSx< zQNB}f@qDYE_4SJ`!6|m!Rr#}Yn76k52*#*mEcX1F_Tw-`d z6kS{{XQY^ghP!yk8dO8%74i(Y=@EEtYUFWg`}m(Z;Y&r!wp*k`k&Hh0k&JhM{UO~4 z3RbI-^H)wn#(~MMIYiQ9b)D))$YnQEV$?;-gj%aa%JwpP&^Dm zBoKkMNjH;+k(35o^{*TpQ7V?QE5l${@Hyq#=LJ(H{Pd#HhNDC_W7WG%B6aB@;fYVN zpqkA!!UQm;;+k=T*Lcecwhh2z)y{g=A}{ZuNa|qgU}3aH{4d{r!`GC%9i8bQ zO8OGuB2wY3p|1*I8n?yrgAs%thXfr{!pd}s^V)c>RweB;_B2L&hde+yh9bhq% z$cx*F9C+nJzRJNpwqlM*GD*+!ATkaaO^(nfQmYhY+B6U8cXz%oX_7!<7amD&!fhlI zuc9JcWDT{)!Z&r2z2q?YI_K-Oe@0@^rSP z6`o$rd&RhhcUXneL}l!FMdoRyK$+w48TK7O>04a5tlx=YAj8oBB{=W_YpBq(61ruQ zWn78pARi5(3WEp0y;n15*mmZ4eKr(jZY$@ix{87UG%#F0uW9LbIy>2sj124%7maME zNCmEJ7L1Rv)x!;5Clz1zXA6#XASU#-J}vT)P>~=bpU%6lY!d`LyIxSM)GMb4NIsjGX8d=&dOQV=})slO=jFz3F(I~kSR zVw4nR9$61C`8YYF)rRf1n~*GO7?dPMWT5OJ)F#sY81tF~(V()n%pbpP7Pf55|AI(L z#!ope)!yA@t|7w~(|D@2j4s^e!^Y!g^$T&24@kKPOe5+*tR5CH*Yh$*GS2CP>hb~5 zM^zRli3p0(NPm~FJ1&+GxAfdlN`ut65G(Ms{WFg|1Z8gfVr3%~oK1aV5FDK&0K=Vb zF;W8n2yS5Z@RgqVxAhjDsU=CJ+mP5XE}gc%6eW6!viOu~gV&S=D0z-KLU$9qDd5cw zmZq}0v&0UBjv^LR2Bcj$XTC2E6Jpg<+?cRZSQ4`hXen#CinV&X$b1g&>Jcxg@gx2M?xp(^&B#-48;+(K)lj<*r7%eRcxY ziw{dhxj7)teVsd)_6=s%o}Y&!hZrLvnWlo^RlydZ$A}h4^l#~gL3qo!W!TWMlfjmN zoH__=Kq<_L<@P<0p!X~1-tC21%<4QyYYDsWHXA2KzSho2o+I#l9SsEqps=7CSrf1D z)^bty-K!K3DJcNBlQNA#IelCjwd8U;9>ASrce2$)}o{0~i^6WX@Eb z7DH)Z!L=*Z*eHKnY_=nI)K5SUMu7U&bwS8!E(}Z^^rvbV1G*7Rxu79QnP&lxXn?-} z9_L(e1n@Nx_%+e_jX{>d;~G-@nUC9-n6>!?Ts^y?*e{)UODaTL22LLDBoV7I?I6Zx z9EM)0FTrjr+uZIVDl)GZ74M<%pQla_q5QKP3CO=NaB0ZA_zhPzY@{nSl>wBe)#zA5 z03fEug%Zk`bGD!lc+T+{KxexLFH zL(2qW;7jbdIo^$iuR$$c6^Q~hjcHr|)P=nDAL)_1X*8892YwM1k-?9+3Hx_CeW`n4 zkl3y33|jmSRpAQfLaS9YG$;2dar$dY2jk@-D)}dG_&So2@`x$Li&?OPIrhWJq_#2?fGmx_f>-*ej6MMfa2Mmx?1NiFtwi_c2+9i{nTNZ^6KelC zVaE8F^E{Ink z$}k(i5QhhE>M?O1{vAcHE!$TK!d=dcip0HJQ_XB985`Vo@ngEpm3oXq=p534qTzhUNv;~<1t^f3lnb9wR5=nA%6S#I8;=K zrUPQ$3ELH+WR*;26;Q+?-iqtQpj^w(Jpso06;)-Xww=*6G_**X$N($qo2N1pWl;;Z zn_A-LsZ&zbThDd!9hxevW9w^Z!Di|f^r7B(4MDW z09QX$dLlru2~psII7QQRfWz0$)SVP%*uwBX*0fCHGu%&B|5n{%azBsz?{iDHih$5- zLCYFSL1O?Gal~RnJ+E~)oV~{7fFm45SU|HPDdz%kbuGdDTKAnAcxz_hIcMOxm+(Oh zI8EcMrHGQ*7V-ZN7+-t>F`UtnQi)A`m!K}f&k*PX@z3WpaV;=X6l-~{3?4tU3_=$N zB+LqWqL8%P@q^h*Ff8cwEe{2(!a+l$TURncZa;#ukv@YzMoVGIC zRwL>T7Q(9L?&T&QnX6czo*-aVw>hjVX)WTXIv<(y!&lISWSQ!o0B3IlqW)hJ%6D(_ z&k5%V;;uit;-w*jEIlQ{Dhkk&v%7 zhI07w;NcZH9m~`m?x!~PVm(+417!waXmxq+tAreE7;eObzB15U-0s|!JHn{>VrEJY zF7a~W=|wL~7K+$mjFsh~w0K3J>=$NS+S*;3#|PEWg2H~edrz*+m)L@6#lVRP*KPMl z3h;t}^LIZSrivE444yX@+sDpDZT3qoGa&1H4PS5vzPTUI3PMw&BCk>HZZDK#MxJol zfQ3Ib=NJZXmk8i)joLFT=r4=;|7!lP;MgYmf9|a0>8>Ourj42R<9F-Gei%k)Oz3kC zs&8&e`e2+eUb-!*qb&-v?g1dYGva~CqT_Il8uFU2?ekyrRJR!;e_c2ZwaOEj3XtRa zYJnKit_V2xx_23g)us~owHKwI8W#b|Y>#)vF1Z~L9i9awhRx3%HuUo{g+oeJfx&yT z5tM7@8Q6LfVGsW+{AS4GQh~|ztxqk9_v62H&EiALLY=cRC=Hy&---fMDr@B(+Og_D zbj$@Y6KY~O4$`g*YabFTsbUM5qqlSMHX}cys?z=sd=PL7pz0S6&SO4AV(SlFaxN6y z;_)=h`)(w7E+Zxt1u>CYn)u2N90rx>IlEm^JCO(XrW2EspsC}TwC*SklF$Xa|4c4N zP=q6tEHi}2Apf=^zzEO`-?AdM=#pZ_Jhg^;E1z-toMF=($9Jotf#;413AFYiDg)#za9q0GzfUy`4paLE-%Sxg(5#S|so- zT|7RK!Ru78(ao9!WA=**e+pEhqVK_94xYdikv*?c+KISv1?)j<6+fj2;#C8)Zr5|w z%St|<_%HH5-bSKqW37y9VHh0*<;+=W>nc1yV8Vw$9RZE`UnC|==Xvvb<#v&Xwvm2t zg|#D$SqMOfKY$Kzx#+zx&iZ~<4sb%Whi>_E`Tw$G##}qPm4{s5gCU${IZ~ z$72^ExvgPi)(7^D=}I%)FmO##Mt0jc8Z;~aOHO~`2OW8PDf@H5a5qK3(B{8`;Ucn@ zczP=0AXgyWj*lLh+XP^N2>miw9tODc262WHixZAcP_t%y)o0dFM>;?PUx4=Br3I9h zr1ZgQc|vo=m;~+4oM2>6#n)H>F!!%^90FK7S;;?717Ms*bb~TMrU*KooPd6EIrA7n zyrK{IlEk1Im1WtQn4juSURhwU_eWU)725=i`3auSqQW#uP-r(rS-U6vM)=hA9?mFu z93w_q0o0n6*JXF^62}r!wjyf?xPg-}eo4uK=54~;bA(TwN_oKh6v9^v-rJrDAqj_g z6cAP5!abI|#xN$l+<>8wN)mEhMAF=?%{yQVS^r-QuRQqSJr)@{Z4U0IVN!94<4^DY zu()K@R>FejL|FhVwKMC$*wsg+g9w0>-6bP-6Az|F7YTxmR@B#kSGPEEr&;|^$hBo> zfiHx4!K6in;}59dkZxKY!1iCsZv$^ETMq(hqQgDI9bd0sCIF!5-;zF`i>|zVHi8^b z(4OOXgM1LG1)3t3K|N0i7jo+fvgbJlewRDmV;)!na-{#fcXSNKTt&cVd&wvOa)LWd zAznU!7L+^?)9z(~H95SlmL5;zXe#s zX)9TmC@21y}R~P^OF9XKy{*PBsmxq^yQ!)dl_kE_EY)RvG4>n%WmkT(N zf&Cv7H_SZ~0)X}U(St3HK>oT*=<*9NPU!O>rJB^Ql$W@`^1qT*r-n7iaRj!aA{lRk zSW(oDWJSh(!l!QIPvvENbGx(YHJOFP8isFyNNrwl;&+teO%=Q0Y9s!6CTAUit;e`w z6P6QC1V(LQ5B1D#Bp(01^M-J2!x5ud$15OK|HyM}npc0>f&d{eC&`%p@ChJ3udD$`e$|*=L!QMe_*y!GO_k1_hVOuph#eCj&T5k5RLEmN)8$4$ zSD7H_%7|N5@jpxDhO7xTlJsDAw?~WsDvRf%w^hZ6!OvfLm_@EjUxj{^04@`r z&PHSa(HozsKfu1|QWLgo$UR`if73TFP5|vV%up->&)ifGCg;SB*bD2S2s?4ReOHc% z{;NAa6(WgpJw4?Ah%aGM8Zaa{l8&tx1@y9(=cB2tZeUj%SzvfdJW$Rc zbdKICSpV^}KQUk`!Y0%fiQg_Zr9v0_BC8LNAE$WFfe^YkSN*p8AXO4I?GAHu4NT;qSt_!qMf z%{rK%;6@a1?tOmuX`xyyc!=mT0f57|0WLjO#^s#fjq1Yi@jqlNi?S&^pfnQ?{UG`U z+9S_0BiXBhMV^5ec{-LYmK=oazM}P@eU8pZG*P26n435QLRbL=mH6bzQ0F&T?~7qr zg_NI5!vAS&6AqbTcH%k^WPk)(^neT93HWbo3#*Oa$O=S1jSOHQE-re2qHxuD#s?6) zSzVgD@qDffBKr+m+wv~ueCB+GyRh@O7{LxIO0G-ECIgsw6TTJ!9`~A!8m5f)TLM;T zgn%W-%fF;%18s{rQ1hoTP8+Qo1KbFaG(qB(3C#~<6&Sl;*WfL~&q(@2V5p7AJ(edA zjPJpRCNr6~0+ED;y=ifuYRPdzQz!4qZBUy7ufO!ev>Igas#DI4vY-E(#!!{(XJc85OVW%k#^A4rk;fZ$r+Vu4R{K)W2YT}Ufny2 zvQWnZ5K*sVW+E9q0a7;QQe!y$eUMhUF|R;ZTd!sCQoD_);sF@_eO_qw{E4uRV~qU5 z&FxJoqj8(?7GBZ7r4f+NK8!jAh_L#e;&~^6XR|iO=zrT9yUT#!;HiNMtmFWNzD0=czx~}K!2lw&+ab7!v zaLUgZ$ZYP2A8V0qctg?Nj?yP2$1A!$NbL+Ss)72`x^0CRobjP1092|vA`f_=T; zkswx~5mXY{QK`vqC%aJHMFoCHS>M%X)?Lv!^Ex!v+5l~%pS1%G(B4iNnAb@Rbbnt$ zB?;;`J&Je%w76#Voyp;X-Nal^b`m$uZ&xw@$#Kt=dWeeD=3Xj-wCI+j15~w%8w9Dx z3@J#2eM1Kigrq!uEsHAfVc=z>kNOo*;>w(Gm{L_qIU)yy{s(B+T-)h^EYq{I0u&ls z@E>6yPwpcLRf5ceRvke~0WHsaMM#+_@^WOdfCOj_HUvZZr=QvEabVWA)XqXjk7|G< z`OeA_L~6Rd3N?%?UP0OOMdL)ldl)tosOn6fHDv4z0-!dyMavmg0#-g_dCBN8>)QeP zmBWfUP}%q2ZUaZiH$DRW5IHxI!Gly_WqnM|d)WIIAK(R<5dDD}(*fsv9gDP!V%$V@l z8Z%p2i{ps=f_4LoJ^v3;?;THd|NoC42a#2TlFgxHmNJqk!pVxVx0JnS<{`4mILclX zO7I~oF zyHSMNRWCxG5So;ym_X*+sd2UM3COU-lP-OM`dM6EOzh|?vRdh?RM-{bVS~QAc;4s* z;Ye>wRSPmtv%-K8r>7nX>{9WteH)NFmkLp|u7%tk3BCgGy94A1(=?viLP7hiW^ZQ&Jb){DlOxIQiD z1A-@Ek36Vy2-W9!g#)x!vPIW;jHji4CVo;yMhXG*aZtDZ0_%V9aVS5Xg#%V%Zu4Xa z;fU}j)RygS>C{F9q2NKb%ruo6EFkR$^_;shl))bGIYJ=KP>?}`#UNOGG0jtdppqyJ zodIj?@Gn9i*nq8stp2@m{VTz;zYd=Q?8u0uye|Z7v=vd4l*&#T7=hLld3_3hn@n6n4+>A`EjV)$ zFA&!H8A7MgKt4H`I3x!rK}yOmEnmZ64KUO{;$ha<{EaD%wC8Lq_|B7X>flO3?J-2f z0l%xjQNqJLYs9{Nj2>v{M>75GG@KmN=3S|bR1WfnL#H?tSV=11nL1AXXp@8)&ftkR zB}fF{3WPRh*>p%8nv5X2F8Rku3$q~qNFK%%tcrKbE!vpQ7*We`= zHNnUEKaXC3a_+$JQN)>L;oh1+T68sc4^&Jw>5i&{iyg~1v7?x17a6Ae5T*FQZ23Vq z|2K2Ut8arq1>sa?l+Kj2lmw}Ql#WT!rwP{r(3;<=ooDL#((3o| z#cCi&VEpN;-a?6PQ9Ia@L`t~ir;KzT-{t?rL|>pS>^TLqZTwF&a&{cuA_E`g-SSw> z6&k>Il~OrFNgvg&1T_Qt!LY7pGI$zM!wZ-o0f)I~`5sdE*1UmlTUZlu5jqAX5*7&K z{8y1qAc|}T?68P}?$Y0p9~#Gwrf7v%RUPa>8H}cVNC~5Wt}nI?L{><{)bQVVM?2vK zHnT9}dM17f#xt?3l+RZVs4laq!dZgZB+W7tm!=Vc_7hW>Gz^w^L)TW?alnM^-_0bx zlI8x|9s6qk%=dRWX&$xp=&A zk3!t^v6J6UH{KJ=!BzyPdjv9gE!fYaiv}4_Uxq?gq8el;qRw?)`VMO&yt8Vs2>o*; zSj4FG!iI`!?bN93iJG?^WoQ@Rsv2WUx6`+;7c=1^dQAEG`%kMFzM5z zB)~o7wz9{#P-BVuSfQe-f>L6%5XRv_$ag(50Vb>3idd~z2!|8nuU~{yM-4@Gy z{%M(uK7zAG#50P)M$!aRFd}pTV-zbPXCgk22ue(6qv>aIPtSEZ<%JCs@dTQKbHLtxCfGh6DFL!LT89;~eclsmy$1R(C^`Vw5U=87<4)hcN7c?e ze~7uvRsbJnhJY54BbYmYj1Dqc?4#EUifz+*j9+u{^EJUwn__{E74^6Y){{F^u?s6H zoF}H-#8ipq#2$n|SbM=Zgj9T)gB0M@L(<=1(qH?|ZR-#B~_V$Cm!z(%aZJ0;-WFZn?X&cdsX5ZYRDJ zInE?P)ES&GOya3LYMb{V2_dK_V`hPe`oDrWJ*bF`SBM3Mj?d{HLPmUSKb|-!NJHp! zGgbb48`MHEEbou=y&We^RpM?AlXTB7kwX#NG}ghOts`|d8qUS$y+0y3R?%!x=5X3! zM~^-ApaBMOv8=LMeOQTPOY-)uTc!VM?w!dvt@{;7ByEEJ;i9LXVd#fRqP^fH)Udv>Lo=Bc>zU+A< zokif0==5_j4A#=Ngv#)2{gSk<30fv%(A5GkqZ0W%%oTXL$GLt-%K{dlJ*V&21AXZt z81gkGG@FmEJHS6*8_03OHgPHJT#kLO+wmHN1xxe$dBF9=)ujfUCNxhe-B2UML<}Ut ze7o>AAu`61XivzWlL#fS?HO>0@-n`GIPt>97cTsBOu%Yis_0@KHK8sH+ymPU$3_LS zlQ1-??2X9FdnlUV(Wd;jdb1#zf$p=^+7#T?(!I(Kc6L3&Y!4yGlEF)vFUdk`s+_6c z9Rvgcjt=@qDsXWT1asg3qtI-5J4i4zuzc-@0J(#M80xsqBz}Vq#d19gMq3*W_-30a zNZGbmRi`L&{|dmHUPV?R*7<4Np~h{ZKk0AYqOjniEu^7`Ge(Qx1B=glwd!G9qh&Q? z02faIL7Q7M_0EkV~nK*(ng&uPe%?sPnM7k#_m3kXAdAxF_;Xo8A+P-};VT5g3fv#bAdu4nfrsmBxR#{A(cN)uMSE7UddcC0N&O92 zxm8<;JOqbJw0Cog^17=8#XkBY3-zqg>&<)hci*o5x%6D&VV9N5z9=jNkXgFOSkh8%yw?D2VHGMf*3Y7ND zWA&L4o97suzDMH}FkBjZrXB-v%H@HJ1?K`CC?6)`NFx?36)EG3Qf{npM-w@R_eyuzk zL4P0mtvaoQb<88%Z?*3fbY*D#H|mORDv?>ton)Xkdskq+D_7;0h{28g0foPx@}5T0 zv^)1d`nr7|amUM&B_bssR|(7u{x6W5mS6#Q(?<%E7yhv+w(70S4`RiCB4P4+B8o9( zd9`kFP^~Kd;@UfR@0mRO%{w$LVRT??z4<13oSne zHhvoH^5RiWj|^ycNVw(iN-5HcGg>IJv>0BpjJ`_4D8)MBvE4R0g>(Di(>}(7UB^(z z4kRW&eI;vcr137}LbR;V@-NDI3s{* z?h0)BUzP4=hF9Db!vB z$m})hs*~GNzg)p97gj8W4Tg_z@-~%44KEJ<`@Mq+u!yAvFT`jW+$KAosdoVsnfQ%g z&FW1oE89sncaa1#*3{Y>Zz{DZivXRJMAtzoyn?CmXGYTQu|;nFjY#EFtp`>32&Qby-|)A;xmkn22fs8&`WMal zz1*P2YcI|Eqv_eOz)r33eEqMaRCv&N2iCdite@Ow6z$G)g|d0)7hJ!lNOAnYdH|{~ zlW-)CMOC@@((>>BL=-k;qu*kce|RTk$Y6>*mB15z`JX)OE87G1Was6%Yo?iZH4pPv z_Fy#r%xt5;c0VCQFiN&*k^uk{r6iD)=kz4jPsG*UrI8jmXuECx`$(B;)BVgH74Ep7 ziwF55c5I;W%^35>60M% zBD^nw8#?H#-bwL)XPUYEic9~!9@VnZRi)n%s>@&KjDL`y2>HsChLG>=QQ}~yn_T;a z=8aoD3XQW9`4L9fkJ@vKm37Cj-5-DX21@icCJQDT?`P+_sK7?=-EDTy2z+{l!FgZl z?S-}Ak>@OL*|V!(z9kuJ(G8RMKl}qMqfhpwtK{h=DrnTJ+*Zk}rx;n9{WxOr0 z_8d`Sy%4G-m&*F?Ubq`1<9jLVt5F$P@al!CSFY23Yaha7scR8dh|;b*UTo>sRd}c# zsx8s{L3W2%vEx7hnE7}Cf1uxa&1)erdcwy*qvqm~50;j)w|1Hz7Cb{IV8i|@KP?4s z83KWIZ+iFhn%<|odPyYVMRke7H&onDd}So{KXVOqfbMKhOtv4SDLm{``k2_c#GG`< zu9jin`=@Q2%K%HmgII~0TZ3SM(YD5*#*?90^rzxHiK0Ds2opt3K}uC?dy~S%Rc%O( zVkZ%eDxXQ=y6G7|jAewZN~@BM=VAT7v6a(zo~_3fH5p-PAE<8x9c~I6v7aa^N8G{rmCZ@nYzA#>Or)+)sX+bNQrPRcX=ZJNVMn z-4qwfv9}W*7Bn7nRr!4Ab++~B+7;1MQ;o(3f8=>?5VV8fE$_`I=8^Pd=2TZvM2tyBpc& zLX5?Tyx%v*c$ppjX^RKUfPZ=l6fOQ$JIi%Kb9->I#?n-&;?8vu=iA$CNpT(UVv|et zLQrCo$c#4MuXNQ)_~;szl15xWw0G;6=)+N1>r%R^iPewm+vF5JDm(0M3KyTHTnYnN z;|XE)eJ4C>tddICEBU?G1sSybKkBt7i`$zW7Na^UG&W zVJB`nx8b_R@~+uy3&EvNp1V{%s6V96j}Sc(wbH+~ST4w!1(wTo-J&f34`DO!eFpRu{heNXDv-(*#ZD^xRL=+BJ^J&w4oid2u$L`=qbFSs%}p8KD$kP?W#h>0EJSeE3Ak{rmp(!CT=P zT4HU2;L6$O8g$irycpjFqS6r8=nemt*F9%KIFyuE_Kon5|KK({cJf_SGdzgRu2boQ zq{)Lvhx*v~5NMWbl z>EJRJmG?PQH{(xFZBe#;l$^)B%=FL7xm}Tif5MLst`ZeAIems@JnPGks%gQ>jR6rxZtwDe=YA#Lqiq7qXtw%tY;iW2Q2(Q* zx_r2AvsW&sr|0;>yXD_uvqrWV8+=th+O~CPn%xyeMnHFs#GTk-0tSZn5nNfE!7Uol z!?L*K?XkPICN4`&4=9B2#mG~gXNPa|^%`v{s~Rb-l95*0;%g8Gc;X$cnD;MN1%g?o zN8j~bdGnhby+&n@L`7Ajv^<_fjl92J?n+MS_`Kg(vDLF!?a_~W{ z(BnGTray|`ZtAgLHzi;*0vuANwrBX%uCY0*SoPB&)_y*m(Qwpt*_p{%Jp9}Uy*X$LEvUuL%6&n)W{!KS+o zXESGh(=%I%b@8S0+t1Rk8v~U!R;}W)<1x7b^PbU#bzThJkXiY`EnZncb4I>G-AG!e z&YbyNVB2vFa$*TB#M5*^%Vg{rEqq7F*6u+XuaA21yVB-+za$(N>xx!~nzSlEN-x9% zO{3gm)qZ++>BhC9ncXy>$rlxl#Coki9H!rB?@Hl~2IwCWTgJ(6ePb+0IP}x^F{YEx zlkGacMG+?$nlW6JC9Syocf-FaywlHlxgxN%qro9#qhw}FXZk?2Im^AtTEegv*_Gvx zm1Y4a-ks~@>(Y7i1Kp)ES5^FMNkMYt`@!QvN_u4^JV=M8}jHOxHE7Y5;QQvxV_ddYny zw=9~1$hnx?x+9qsMaD!&J%*aP2Ui@4{kNQu+LUneh1AOhEv{?my;TvqL}nvIo#6%V zt7G}09n;@Q_ybKwZ~eHr6!Pu~&OJFs`)RI=(rfWVWxBk&8enQat)3?t1f>>Vm)vZ} z|81Pcn)P?kFOVq4wJvpXxlT=e8#~kDTZaT@{aYx6A7@E_FiKGS+*EDGuSe>-aFfRO zI7IV8zWa-j;_fSvo#y|=#R`W_f7;nwvR%5|!L5E)JxAOp(;FG>e;zF}+V6{FGptQB zTZgi5YS1sxFs{DRc92FtQRdgo=;7?Ziq&Kl zsFUs4#Cs0^;_R%ltbzWJQt&6il|QT@>8>DQ>L)O#s(`kLx%GCZtNu@0875knF)2y( z33Jh(te@LRnW{ktpTTGOGk@MIo<7OwWhqZR>&k*7)6smBwfV}_-5^Wkn|)s5$EWtu zPYUb=oA$EWpHJDjsm0n1^_M0C?)l5Z+b{qjEM>%V6twu(-9RWBl41GufL7NdOm2Df>Sy!HTF+5Ut9WVr0pdoTmHHp<$}1< zeC3;Nqn|2Wjcdx|Bv8#%!Ic%bmfvfP5E^V-l-#C$`h&x&(ebZ2WMS$v>pYw?eGov-1Jrl>)|7LOrT zJItm*+ja=-mk?9eJ~(VQ&(>jkR%SokcQ@!4 z9jo-`B{gnbopf_mdZl+;jRnG1qKJNL2HLsy?Yw(*=m zO1dgeoDHls3sOSNHlx=lX$x@W*G$wl_`_q6EY_d^vR(H_+7`W9$M)o8>nHB>jB zwc6tsG{BoPCA0nv`utS#iMgm*WILK4(Gu;{H~DW8&yw03xtctr|0Fr*q%m@1f$Mh@ z$HQAJGmiU3LkgDhISDle8hLPAgBE$uEY|^Fr~*D!TdJZsSMm5`h=mzHZ1yuPxRgWPMqY&c^Rei+%Y-{tLam@@e}_El6(2pr6MWwUqcCk)Q$54AoNpm zXWjnVAi3TKr;7GvPt)TZZbi7116p=>ut$7li#r}Aj}N7G<;)L*az5Q%j{s4UDklT= zQ~9S87y04Kw#1`%P!R@o?P_by>6@(&*F0qtv~ZL)dI; zm4lF;=hX_KC_(baXVp^f&_{&JI_@IL9LgkS5IMts;vWxIh+ImR_)BHpc&*EKX_W4j zeA0pumv!*T@)qw(U%Q=HL_B(8KJ9Tlv7Z1>a#XN=JTE}A*d$?!mFi)0|1}&JTc-mS z#LjZ`QufB)Gvx3oRx+99-YLywOQS=XGuI~qj^Z+$l6*E4$=f3Y ze*}A`eKByDhs8&VgJuuuY$3rMfSfOa0NugJ+IYopS@L=l;kAEH4&IieT?p$f0rp4P z>+kQ|4i&TbZHIF9caHB4V8rzU1;_6(?O-rh*}~n7l97pF&_vO47EP`>md=&*$Eaw( z(^+59o} zQBAm5QnWRyBIhkU#7|BKBFF>sl zI_)B^|5zEPYKKJMlh1O0U?n#};%^J`=t3p}z3!EtN+s*v+$fNSaY@h*g9m*&1uw@r z=d_UDu_xIdE)sF=rX1}%JET^GIASX>%4SI!dZXdjZTa6mh8h>tQ2bY)jbz;hma%)) zf@zP~CC0g;pypc8vpu?EnT!Gm!MiN`*V;9S=Wu2KL&$W_`%rRI%Qq5pT`OIZ*`c@d z6ioLnswIEiRj|}6c`w+yNztSIy3Wx+KaJN2ioNg~y?9VTs0+G0b$PRSQxGv11Rt?j zQMk0@WrJ1OeP8;6Q(11BsW2^af*;W}pwXuzrCqDjBN%<6E0(HqVU|RWvEoc457kGb z`vO0a=EH8~)dTkENzdsihq=fQg66vH*K1|?LkTQX+<$)h6{JxLqs3x%UHoqHB#%kb ziyo|ix_t;*0Yct$W}PRSoldK67vUE~?SzvwF;-AFW@ksfO#P|3#uilz9CWu1uq3SN!haHDH5sxg>YZT z=+L~%Hx&sM7q-uWAC26ly|9wn+A%+`TVnqpU#llArP#A~ADbj+UaLwg-N7>Uy64EH zq@wFErI>Xy@>&PSv#-FR+jMS?F{N9#8ZZ(%a6vXIYN#9lb2F&aTw3_fnhxbso{Ye- z-0J)fP)$10sxoYxS}NV38$EoqO_$VvhB%5f22!3wN!{B634Zgxx5LxkOV!MteB)83 z+b{U>i1IQjClalB;#f>B$9a5@t4Qgrh3Y!XZ~^6WG`nJL)eA8U})5lw{SmY?=8>rXu8fL|3*Jc#i{GTO}_PGA954g!TCypeQ zCvgWu^<}-Rn6Ufq$IF*p1=GI$?>`)N${J9CwunYp`(^cdCwwv6YJ4pC~!sb5ULaVnUUeH;AHAFNmh zUKG#m_Oc_KeAVynrI@C9SWIo!Gc|Hil^OY%U!5-CJYkIN7>XWVq^I(^*CPz2ydpW? z*T=YK)%T5d5LTWRb_1pY7xs>hrCKlIx|*UHMd&&9qRf)859t^sVJeM<^pKTt4HI22 z$^FTyQ(?yuLy!v-^=yjkB6))Jrw*z!6p{B;7WTs)X-^)}G+uHwv^$Hx%^}io$L}bb zKM{o%f?wxK8+ODq=iQ_I2u99$Gh*1QIFUs!$c<;A!P-J3Yyndw%y6rQ-jwGFh#1*( z#mHq3Pfn@j&RFOHk2h=~*;L<~)qWOT?2c42|BDis?y;hvzYbKe_StIK?f(u87Kh!7 z##|Q2rAC=YFBf?byJWTcx*OZ;B&e`pJo;*(eAkZ#`|i*7DV89ojPehxnyGorPP zoZPC-?;)2#!RVrzeJ-M}00z2JF>JVAAQ-bFf&veB{IDJVA<|w}ABR^E2jW!AT??H2 z`#t>@USZ_uJ*AeR9EJ3WrDQYkYfy)`_*0L7@0?gH_;h3R+U!-=KP{$Cp@>|a+=a7 z5}jM0OYtIm?UE9_Qt~wQ*>7=W-_LVq-gSO)lW#5*`Q6$*M}Jt84oTi9SfDDK8Au9Z3Wudsy?$%ufSO#awyvy}qaPC>}gw0*x%Q)M7SGgmZYI&8<8 z%)}$5*(0|c@Icc0>*uvs4X9+;JmpLw?78a`6L~Y9SHajVql?poaNPp+ot_d(18LIi zy=)JG+T?S%DJ4+(4-qQX_KvRfvrX`Z!9kP9cIY-Io3P z67RGrldnSTx19LCnG{Cd$eaG6YUHre&t}&?lmqGJ%_3&U*@%rdL441*Y4YDVS03jJ ziXjo}PIP~?b9`zCb5!3iwK%vfNRa*Huc>?W*C~(h?y_(jxzwu~bD}GM@|4#jkSQ5I zedoHB)~2KqjrrwA#!IH_Ng1fzHEj^msnK5b!+wa86H!{K3M!m6o}8QO z1f%Q2@28n6x{xv}>gCsmO?OVCvT}p*ZoKU9edx3=Nc^h&;2y3A!xxK{&&wT$MG1~h z&1R+U>*5oX9y-+pel>^urYM!-1CD?*XGJHCM1i-DTDrboD8+Ctr7D)~N+Ve=1ubk_(3-b= ztfwO}2S8>KVGkR&W_*1IKrMsSL8Q3*76qZdFz3B2qiAvEn?r}Ib3f0>xE*UB{zxs5 z=+rey1tedNaP0F_(Ln0tvMQ-<+_cH}oEf-Dnv5pXzR+7Go>PF^N_P0;3M11xwon_o z#a}_Dtupk>f-qIPLs35$&Of9~#_qP^I80kO|MgQO-i7|G|B*m`(Pk0KI;eNB zqtjo^FxdU1dM@$-L*0gp1dI$YWVG{qGw%VIeJaTE9e*IKId(kh{0C^m!n3IWr=zKCB=2)uU5UoO%sIc@gZ#Bt-`wLG0%0#` zYLhwON53DSh7F%Z(#h(v0ciYyYgv5-IVM00vq33JO(C+%1q0ei* z7~5ZA<{xy#G9qaR9X?E|Cl8eJ2;8ej5B=7OvpaXrT3?06-yrS-M@+|s&<(oW9e#C` zCfzXU*Iw}|KjVivehSV2n-O}m3kfuj0Ys@4upQL zzWo*?=dVKIhuL~a42Q&z6T_r{58L_)SWaB8WlrcXqNMYP#p!*UM(yU`deG%o*2C`H z^9oos_b?p~FN@={S`wuek-JNWjhww}-U=u?T<HQx9o5 zCE!}_ECZAZ)15x5N=gu>SB>j?naY`6AJp-~zv-~)T_}N=>m3d;696RtE&RM+(U9~c zYU{<>;n(o+Pu;5_^Znw^9(U0v8o(}^Ni7#F+HW(3e8?o%Ui(wE@isx~fK>{#VP&b1 zIPc1_o)0G4p$}DC23hG$RF4hUaDNfaEXy-ewB8{rjzl#h#rJ zsq4x$QJ2i`t%I+zbJ9jHVSUu#6HYPJ;tVqdj5E6)V;(-tf4f zsKQ$g1gwF%AQ{t|v>6CIMqD35+QdIfDX*p&`(D7Hlh>2I5CRMsO*KFW70lY4|7kd! z0n%Aev+goeZg$n!1?(k9*AhBWU>9l=!w1`Bz&^<&W!?8I4@&zrH4q#{zS_d)IsvfR z)c#ENX2<6>1V-G+&F<0Qnnlh?#Rb>t@yho;V{?8~9+*K8d$?zD7phWk>HX%4GDkjv@;2%EyY7mb;}rH=K`V~Oz!4!LY_C<<$a z{Fm1==zVw}G(*t?dPf1K@N`W?eEBu%ujqNlW>5*(l;2OO6!K#P<2?o0R9e%Hy1Tx) zh$dF9&_4mtBB6h4%RtP>)>7X7LT2P?jeu2|%m`q=p7?zzu>I&M)hTiO$pxIina}Jh zL||GyHh_H<;RnGtwn6jfpdAo_)mx&-opsa@PPM7FV<$GIOXJ}Xvy&H5AUoNq+6O9T z#zArefR~9G;4vl$jqu?E98gv*BC~HDbn1%FlN~1PtTVR6w;vQhw3R`7S0W4uqdkeo zFlm6_?@r82=mJ9?W6=!+LUf;_g}q`;4bQRzQ0(n}i*o)snxZrT>^KQ1QjeqS&JJ6_ z09OVRt3U1;O)5wlP^FO$C>fF&-Hy4PZksO8??|P&2%Lz;z1~inT$N?clSmbP-LCcF z)4(W;R^Lvz0gF8V3AOsv->mmGZ;Z195Fb4a`nSWnuzi zpYLFwulXPP?+z)^gm%1y7-PIc_2J$W5US2U2B*3XPQ}rBbZfbcF!Ni|kIu$6Zw%nW z>#d|TWDARzWqh6j7KI*Jb(C-e1$Sn^Me$IIh@_I_mmA=)8&J6d zWZK`(Ydhe)*4FPAfoM?}Gf=20KGwwecufLcsVqUAr{pU092;WxRg`nRa^t3coJJ6oBX>fL;o^2yJZG^zXP*y+GD`X zL^Z_RA^LV+ON_UWreDVaq~Z%3QVM>YUsVhQNwCuja0N*~nF-vI=49yiFKgiDIb7%% zEVgI}3!%nmW{i1f){e+Ls{lK#zarnsADG`6NR%$U3V8JZ+mk=1-05Pmos(pbm%nn0 zgO^95`-=dHqyq{9h5J*VO~FN?B_Q3YKMV&%p7ga${nV#r$3ja|jdX3hzi0M&*?2(T zSm;>hBoaf@xTA%NJqrLcK2yj6Q4^R7n5h*0l&jMBr@KSm8Dpkj|J*(e7^36~A5u62 zrs*cQa|-ZwBcljVFIFDFc7*MO1}|1l6GlZGx|T`eP4T3T&(F`glCwi_^4s=)x3YPE zJBl!hf=rt?gdC_69!8k874zVk|e4=myQZa`qY8}_|Z;ri3? zxS|30b|*n_bd4wsnj`D)a1gakt=?~&;5`*MHbVh~!1idSCRC_-0smEIBq=Dq;?xNT zhU@eb!=VHU0Dybt1+H^a^e>^cxt{_UV@53o%2I~Yg=q5T^hWTt35{r$8F2}UQCdJd zZPh*i{7~3A9Ohe&cJ?G-JY`28YP6pr#Boi)d8Us^yZ8o2oN+V-;jTAP5~k+yajb4y z8rEEOA+52SlZzFn(NO@F;w_hgwyz0ct!*fE5G>E><*uXvbshKeThiJ|b<$E^UA~za zrrc%1%y){q-!xja`8w**c)O%f<80&(v5Eaxfh0C=NPMRUtTo4mL?_?`q6wq6yyNJ! z2_iL|U8n#!OZZ3rR0qF{UlGzA8&wkgu*x4O_{GXSBBW_S^d zWY2+TmsyE(2V1N6xFnyE$L{ok)B+oXs#t1goEOz~A-t~NdwU%j|aE|XK7OGf{hn)SODOVejRlzQZVUW|+_S_$oD0)}vz~Bsjs(jsa zC-$p^W(gg^e%zoVvv_USz1=$jIxn?)-DfZz7*d+s9pnM#RH+uk4+iZ&2EvtBkV{ zvf676nAwkTWhp+9_fn~n>_-PVXN?GWUgKOhMzB|==gX?9fY}78lkmD8>HU>$BwpE8 z1Ksmp(A?eW=jnc59>;+9u|*_7C7Kb4?pL$Y+Om&@nvaG#8w&lxKrOn21#i597h65S zvUJwlH{jes!_syq_h*6lxaC{9Iy4AaSB0FxuQG&|O~9?%z-Ry-8Kt-=u6_RHk2^G$ zodAL)&|S@6^Equ=0(Jq%q|He6PPkhCnri#w)Vm zfBkLV)dM2X4M1M>g}KlRQ2hF>@!A3MGR%ZsU3kqP@anX`5EhmKK5gsOdVv3KGXoC% z9Bwfl%Bp~+xG$1~ts`*cz1%5|MI~?>kg`4sM*#%B#S!OgA!_N5LGf9#LgF~#!varS zN3WC{^f8Ea>JxpHtN3=#RNhGFw1&i#@f_Wc|9nG_^i0P#;^1EtqR^W2(LnfTd$=C_ zQRg$Y4I{%0`|_%;UwH;v>*4}AXbT`bcFD?^p{xMjzdxsElB*oyei$yQBM}_{#cmD` zG6$l}tXns?JFtmdp{Q?p>PN_~D(I&h!fpH1Xz|JC`8k}6TD@mf)8KRog3Sy#$g_l# zDW*F@CyA%M(mV=WRss`X_@syJZA)rw*ZGI(D0CTN<)H`Y&InsCW(0*21;zk z*^i-9+6W#eAz4n%R6Y@KjunE5Tk!+Z1?9kA&golm9n;^g2#|7MX`KL*vruMGAqmL^#EOc@OYo+UF) z-4aP*+djnT%+c8dc!+^LM2Uc`+#G5!Nr|)u))Z=yRa@#n2TqPW!2UdfxAr=fqU|KK$$##;pZ3BfZawSo+1e% zQ#beo6YaDNtT5?|5AOjEpLa_PXcz~-B~_z-v}&~M`#*xHL`|lBilq&hDs%m*AYBwo z)x5XcamF6kZmbT1ouqeqK{;oj+gh5pFqc6xl9%R-s}PirS8fw5kQRKn4=nO%vt~GJ z##IS=pqe?CG>o7u8&E`7*bSdULCc#gGs1~P^{of_fR2Gp(zT~i80F;^@!%WyX*Ga{ z)nAdMCaE<4rHA~+5LcjQYHj~;$b7k@|LA?)uz~7tC$s(cACL8`qPk1{NvU|_feQ15 z@+QI;VL}3kXfxz4bWdG=xjeL_uT^N#9%o)(6Qmnnk^wlp^fM?1s1Z*Bmxk`b5$M&o z{?HcUaM~K-cq>wy-7?T9jkv>P~_kRKk-SGTv{ zf5+>_K*OsA(NL{`cllod%Pnp3kZV>s@UtOfs~fTA(udk$Y?IY=Zq+)3^oO*CEEbWp zP>OVWyCMmw=On+25S!|_f6uc7z{j5+u>gumVO-M{eq)`I9dCi#TcGfQTb!km{X3Zo z|LF}S;D+gNnPf;sFrf*n`_(hQT zL&eSoA^{|Z9m?&%i_j7^mwU)L2em}6J>;^TqA|Of1c><4Uq<{%Gqi6)eQ!Q81#(cW zFG$2+irCsA<}VRPe8#%HfsXOYU>+K)E^Odn>kDW(-#jBP^}(61;mS!NgqbKEWnZ^yh}Oy zY=Cyp9@6ranS^3L@STT4G+MKsPvuBC5VWaz=PWbQs#NW2?M$UEqXysNxLPs*`brBK zi|=Rm1?dq&#{|J!UxA8FaX_e0(0r&_On1k z`K^ynvjLG|--+GMvxgw!v4Y<7ywEr&eJPo>gz9!gNfRej>O)}Ny{~WgG*H4DN`_yr^{*g8nj}V0 zn+M)_90rq+N@lGO#JRUi)~l|MXmRu|z%)!+fdl;uwVgqS5D{3c=0A*;U~Jh!AGB{p zs2+rz!#OlYkE@dTUrCwMpzGZOxq#27X+d@mjqceZ=5q$q4VYSfMYy29*y#~H&7?h1 z$lj-SD}RVJNa_b=2aN&7(YKRht!?zDpYp*l80PH~xi*l1GDdAR_<>#>T>gm~RKz+* zkPzAdtPplRC3D8#$YwIuh2G!%;KuydKvZB*#c7aLrlErN8(h){pyIpCHz7Z5sKp@J zuvWVL0hu;SiH{Iz5%8l)?Qaav4BU=)IfcX`CtE>1(%w@bR(QG+xhzDp-gIv9L2V>N zYuFQVBJYllb)llhG?#{-M)5&)KYykG_8ro{wnVDIb#LUlDtZ&gYV}zbhhrt2#~1y4 zQqHEK{4E#I{cziq4Xyp>yX9|1NAHlKSZt2fY=fg^Kb!}E>|O`~>F|F|q72P%!#5dq zx0a-L=Gs(m$2WvjoI(>=Eub|ohn=V*#`ht|Mn3Z7sWz$G_-I*A5WFL6R^x5Cl+UN3KoJ0HUtBlWa&WGUo|3z-9+Bu-sutU*rCQlCPYXDTIxpL$K1(pXPjqZ z8agir6QEP%O4ox$Eu-|<)F2=imV#VAYI{Q-L`ZQprO{Bq?5^eN2qz6NM36gf*sS97 zPP5#GnX724-tyZE^l;?LPxzbj|CQ2T=Tw(lleAr({j}5 z)cXI4m9r_?>eVM+@A86;*9f}B5lUu>mOA_ zp-=yPUv4YG3N?2i|Nj(LSgv2W3cQ$`=aA0w!hw7LmVy;tHXg6-4;t`X26sOuv22x$Z!7-7qFr^u=d(C2PCs~EE`uOwDXjfaVquZ$Q{ebPUb<^;tjzl1hK_ou zL&1vx&}UQo0ox!bP0?rlX8MOB-}*#`ceN0cWt*U3fT zPfV1IkV9nfqbUuPz(PS+h`=M{zgv0nvSAM$S0Ra{bqd&XPz)t&x-!15f+Qs56^*<` ze~-Qp4&FskWd3l9;aq;GZy2rmH^_f+lMlvZ&;7e$+DE1>ujwoqeNVV9OKRZi^{;}z z{Oije5wzx9`o1Y7;1}Q{ZQ~w|#s!Pi0^{`E_<5Kyts$AGEACrTj%NKD;VM!tS~Y#j z9QKPwpRO(EGX{-v+vo>VYZnHK!pDtK9)H*jAWLqRg9smbCs|1z%D1S~_#c3Qzxvv}DL5CEs#_%zaSbmeeoC_nwd z6Iq6aGv9z?kZjReaeD2>7nuut_zP&0AK_Wi_`oo$_ksV5kzEPOlkF4ESM!NiTZCx~?Thp+y z2}$<({N4fQaNZ$98_v)P7Ar=Uh0~&Ll$wAFZYdqIR9PFfLqZJQS@L&fFA9ANXU#!n zy(KqI*vAv0JlsOH^8FjFw2ADl~hIt>tm zXAaB{VW-d>UCwK4E7s)`p=r{2T~qT|9h8gH6<)V+h+Le|fSUR^3Nz!4Y4LV+Ec`A~ z7#R{zDGbvUzIp$2>1j)%;8CHY;ANDURUl}DxFGN8mBRz|v9G^M74AO*xa6zT!W9+n zp7ZPQcJlDj5fH*F{-0#gsbj!X1{pR3)bXR7k&%&E*1yI3sW{g*DVd)0>TM%SZZY%# z$B1;h(clx+n#$x3GGDm2Cw9nlYwuR`&rk+R9}cU`p5BgXd{-3I1%sw%mv8=t&}KhW zgoCXVMj`-+;V7ojUYN4(rg#AtCu;8&9n8CGZy+xKMM0B|*or8EsEW&W!zSb=Z|2q@ z5-JAIL(Ng`EJcgdZY%unAm4p)%hJ-gG3a*{a6nlZX&kj}${P{N-CF1;jFaWVByPal zl^B5N3+>+%5K7Hw)qsnJ;Hy_0r@w))`y`&CY5UqwR;wmn{9*rB2-4KjwWS&a)^IJ? zaE7mdms29>dSteBza}Qaha@g(3-t4t2Bu@ zzJvqy7uQn@8*nmAwCT5H_yhXH$0aX>jEho6l1R5H;#m3TDDbWORl6z(42_+HEqHRI ze76u9@iWU5aCCmL*PMp*?+O*CMapYBh)sKI$s_b%6rg4ilDkj?4v}4c$+!_30GBWB z(FC}+&$gi=W_gvgQxQU75lwO(BFrxptMD3FmeDnI1w!pz1K%+g!46z#1F@4+Dc&uD zn4kxvfZ%RV5SPw*o(r_Vk7r=SiOBRC$(kit(@(>-FHx$t8ud&=sqHzkfJ0M+=Qj^B?3p>PNZ`Hz3R`{9XMuBKxe{4Gh{SUmMTL z;yXPj@CuIFb|BKD8_EEBkiMb)OM;S%M0ysW?52MiiGjJW-dMK=b%>VhKZY-Fa+;$4 zPQL#54f?8&AjZ{on_irdcfaMq=ZNYT4#&LwNcOxod2W(fDp$WmCLB{mmF@a1$dY$s zp`1e$#lL-(orGAyxm~#q#a?OGpG%iOIqBeh<2Naig?sX=RaPZ$_0XSmS&whboHklaxovW?F0^ZtDS+&^IqonVRZ<;(@-6+kd- z_eE~6uxK&YgYl>rh4)s`VXerIZH2+r3I-0x-h=ALwMuX-%6iFQ@Q9_#2f{oq4Z*v| zx^QDNhTsAUw5}6HYZB>GyC;#=L4_^gXx>xJVR9((etKfQIHlr}s*#gp3YVcuyD{)3 z2>+a^Cs`I^s4fk7=V%wK!&QIX7ih;Obi^>B; zk<9{PP6-_n(-tBgf)kLOwRCJHJHrn_&A(4eI@|)9OfbMahOoSvl%QS)t_yfc2z^KC z2gsXFLiC2enfPD`+z^HMsAe}ya3u(8;FoBTWJFSSa`-{i&Q~l)-!eSZt~W}=zzhuc zv4r{bwdvw1RkjpVR)FIwCwM?}NCp3OU(i~@*uT+6R4cx1QN*4=N;@8vRCu$l;;?S0 zw7O=`w?bkuT#<+?(6Jhnwi>r?rT2-0 z=|||}7X6RRP37lq#C34Rw(-juY{9}x*CMrhp0$tx#=c)TKNx6gC{dw&VV!1K@fE^h zzh4KmB6-#;)1y98sm65BWj5UB^vOc_nl#c27CY!zI%ot2pIm}TpO{tsADGb2qf(&$ z;g=eNRB+q9@NMDrg-Jw*V(k}fS}ZQ-`JJFAsl1S653)|E{ej~kazcSaGAL`AjX1rm z5l&T?j`u&NT+Z1Q!@C>=8jNRcs{{4IwL#plj_SKiW~{U|7nMz@-jEcwc+StJD@B$W$6N4=iG_IPk9>57?Sip zR>=23QWt%HDF=cumW+p423!{nV=!IC1$*}AAgQ)UiCl|u%E}p5$wQ&AOzNVFafCf& zknaoHG#@iW*6BGp$eT%%Tg{)j|E!AX+`1wGdFo@u`znXR2 zg)!7l7v2lEPnm&PGeNLUNd!o{7>a((u0*9cz zG}$)LWWk}r=)yBL#B^%>2K6wqY=JQ#ilyi6RoKtk@p{i9TS_O?5E1y;5e@br<8-|P z2J~3cAEmAIFVFHAb0rpp5{?k;%i6#+*)|Byc`0=yj82nrD;jc)?q>+Q5_R|Z1A(Ld z#s5yWzko)0@1{YHRq8q1R<{l4$KW110?#$Q zvCM{`6*)17w~*@pbDjWk?t@`t7;}}TLGuqHk$#|vPr#q=dOWW%ThD~Qx|O_M(6dwn zl6e-Qgzl;;cdhV5g}E{$^dF^eQAp=R`s=w0Jc5 *=~Zo%x3=}FA}i%!U+R?dCSA86^s3mx51QQoVf7pJuk=ioZFt`oXd zNc~7OtFpeHQXN8o!;B&d%Xp}=eza}pWkX$m=8 z1pLLl0jKhve4Rn*w0`5;R`mJ}kB)V1)u7oQ zy)tDQmk2(D=mvS-LUSizPmhwBY*BnBdflv%bC2k2=1msKJhlhfAw%=OIgG0=Rs6s9 zzALQBpzHPxh#NSBTxi1gkAf`Up59i#{8y>~=<7o>zL2!xJO zrJv#Zo^x?7&eebWa}zF-$zOjX<_L3~X86ZsLtS1bFd=)6`pmsG;LiP}4jo5q<KGSHR+nk25KO%5x9hhesz_l9;!3i%tWABVtkp zve0ytA=>>To7c$m2!^?Zk-&9s@Y1IK_sy}T`1u~*6#@c#LJklM!uC!oMU}|x!md0^ zyM(xQKKgO+l@g^F%SHhZMrnaqm%mtVh}RWgBvRTOO+yHw7pLVW^wYs_ZBY+wu?@dI zM%Ju+6Sb#o0Lw3A`g3F=d<%Gmi4)#dvcN*{ULv{Mi{u-6allq1s#eLj_P;7`{M{tL( z=YqXmr|=PS(@W8uZlTzuoEuJAek`7*u}GL_%(&Kl=7zX<7hEwtux7b0-wI(gGKh7* z|2|?z`Y>79B$D!5wIw7mHhU}uFfc4}w*h(LjEl@Y^7sQMYCA=W{`)+aO>%S(4< zepw>P_;qM^Q9p%d6Bok8>eb`pT55M5RZKSXmaNpW$|ftd9Pylg$eTXJF5Eka9G=?$ zQjGHb`*e^$cb7`;nqVAE^;48gw=7(1;CgM+PaSo>Jy3dtyEwQonl|=P9v%-?>!taI zdnc#Do`<@=V?}^^H|TlpY45VdAN;-VUv7`GFKr}*-28V?D_O)&TIllfStdG9F=MGG zp)R$|`8x@l*M;nQ!e3Ez6-^4=fV=`goMEnKKo1802!xcj?kzcLye5o{Z~B%=$8_&j z>RbF=W5inDx7o1rYl^-2gM0;J#Q4~g!~O1!1yy6L*|4X=PoeKKyZIC}S6Pz5!*Mhx zq(dPdNQpED3aF)y3VVavnM3zqu38@IxECRcs+mt<`7u9YW#&eWk7Q3y2HnDVYt)AA zf;CCTylfA3BVUlBDpV%@-)*$u33T6zkTKd?JvGM@oT*m2OvBn$2Bq848@$j}xU2tt z!hcl7%}x5bpFWSyYK#M0V-Vf~w@}iWd42c0Mwyfeyjdbao%ft07k+Y!P)q_P18A2;hHsIbGz| zP1G)L%m@I^g!+{6q0$l`D|zVn+4Qe8=RZk*1uDt8$3HMQD7)i2-i%`SDTg1IfyQBw zs|l=S`-@0}#G!AieZ=3fFO0enNA;q!k86(jArtG5Up2N!Lr2$4k-eF(s>JxCes6zX z7&SE>zd|&_%R<-oKvy~l{k%m8;AI-syAZLrMztnX{`Xk`Q{#}$t7{Ug;25m=@u!78 zl}c>jkVHdAc5djDR&>5hG_dMUM+fKR7AGl04btLOIUZSofqaVhdNEX*h8Wn(ga`ciDTYk zN+Kxat_kmi#|raZJ)8$DzQ48rdkcVNGn~3uXLi)30>cvt3AA5dVd&>LPjR}+aPyft zp*H^KB!X=I25+wsas!Gref9zFBt2t_b^tl9;khA}fmk8rwX|Sz%S@Ahz-?W70AC*lzCG|}z6|Y%nfGh+du7OY{cHW5&3UzhA zYpitB=sWNbs8xzPMd$OgVQ!QmkK2Z;D1#FIyr?^|9rTSH#_1Jr-dW6SYL<6G@x;Q$+TSBgAHG!vv7;ULh#;~Z|8FT_;neR}yFdTDXQF-0ske+fN6Y`Nf8fgpHH8QETOAEJsZ{;q3Lv(Q4q@L702! z#Ep_Q7a8U&L-e-#)mhcQ$?k zs2u43GUDS|Q~g_nRWK&46n`C6%zIQAA3}JUMkU0mN*`(-7#?+O6u7V-R*S5Mj|K;Fv0ryR+P6|F=9o>tJB-6W`BuHs!mN`SnOSG zEs?#wXj`Q9i7$Ve87Fr8lHqk9KN33frfl(TuSYEnkn=##e$)e}>P^i+XYmkNgh0N5 z>#@DvmN#qZ;4Ozq65Wdl(Wi~9*T}H5Mn@SK-0)d7AK+6Z#-)5FwSTYOL3MRqEwVn- zd`0~)4;;5JIl%c8`G1?8o(gHp*UNJ=!4?-t-|wY%B%g?U6k3O!q;tzvMV& z5@+=kZXG{Uaq=v_etk!W%*4;^MGL*bXru1%9So&hbj>=NH(w%5MLYizhhOqIl5D&0 z81%E#dOfzp#yVF`U2x3l`0{vcq6vw$xq_-y>p<2Tc0X-`u0%-N`0+8MICLkWrD&=V zuqnV_g3;B^m2SQv0vo2QCxJs*WJl+d;!%@Lr*cQ~ZYLJUJNkgTLxi+bc-l9C6G3%J zSh>4w;Ug@&>`SfFG2fN%p_F-@`v;k}HvbVtMyScx5$kTr@>S?~Ma}lT{ndyL|9ZE) zSxvDvD|O1#z>Rzd&Ymo z8>6dyrBRvDfu0>2K<+>Auz&RCJSD6C)+lsa&6`AbSZJ7#rL`^~k)l@AE6I@h!d800OJhhoO32;()!N&%D8Vvf$UT%Ha zgMhHGwBi@WS_orbH0He3e>f!VXP=J=!BmedS=aIBpR;JyGTxlrqVtv^Pg&y%r8P*yN zvmtCVlbH0JvA--}E%I$;sHH~)=vcH2Bv^ux8RrlEy9v;p!?R)dh^5;;S z8QF%bxrYrdX?Wsbh{o&5Ft>cilhw82pTpDDB>0uv^(V6I?kS*zx&;HKp_NJmOh>Mu zW0K_$Al`3`HaPmvMpfa4^2D&VmP?@QI4R$>;=AZKdSW>uGwWit^sKJxWsgzX%M=$e zs*0(zmp5B5bXuj}mX~{`)M+Cph1o(IXk5V3!>&sfU z_T%Bo%&2%P5@FwWsd;J}%W;oFYhTZDui`LNazAVLYQLon$ZDv+i>k!8&aZ78|45(7 z**uAEVtgm0@iR2(R<&0b532hkNSJ?2B$^BmhLc4pK!Q#RM`X3T3;%x2;6I$|d>0}c zwa0up9(AFe7_l*YO{x3h3JhTc#b@;*N+sZz|?qx?A;;xC0*F7`^^H9y46~IdA92AH6Oxhz8zib(yKOeW{(^6Q zcA!b=*%&7L%+JlyA7Gzl#>5ZgKj=B_30|yWwnOjL>`%KTP@An*R_}jcpeTG!`f1}} z-yoV6tp-Ih*{a8p74@7U%8c)QTvZR0SxZkH1H>sS`-xGy-IPY(+1O2SQ&0rI^i1fQ z30DAIgtZy0--iSFzjiiIo2t&!)ZHxI@aC*Z8%N1FO}yZm0)jdlcb9Q0giV@<+8~F> ziSFSmQQMm2*uFRIuDIm6?_rYA^Xu@eJ2P=w=hbRDXe3mcSlt^(Q8>^jIbd^_RI}*G zWaTVGZB?2ycfMGgnACSeg%p%2G=F`XcP?${ zvOcWMnl3w^o7=JWKQjvAn^6{mDJETv7d@0HR<@j4&~7=ldWES9ka-|%dh$gE!QW|5 z<;jo57YHq7lecbJ7fDGd8DWn>@S<+&Aya9#8P!0$zJ#?0=q=V{D5Gx)M|$Y$4Y%49 zs=lA>uQf1swr5_n$QqHLuX%fVez`qf`XDMfYt88;MT;f@!ulz0Y1BCBOL8C!*B0m19(?gRX&}O2-RdSp)!aj@$e-#GB`qrC9&#i3Hodg~igU8gD{V$}3OJ5CfzezTJETKkBAntXK@sBO6E5DWZ@Nm6(pHeP^#V zoiitnojOUlL?(_u<|2e|qGj3+X}HX7w%fpQX{)^QNCs_>ELVTHtq6>gvy(|;*x}hU z!;ewpTs;n_GPP!oEGVP?!xy@0qF-Ex5!;C8uH>%xBZ8Px7DnAH%+a>n>}O;?3E8WgztJBM)t(RtWo)+X z3=AmJY6_XlSCHs_HLfPuFE7Z6upPgh((S81?B2$_izDHmlToaK)RZC?J9xQlym}Uy z+4~_gc#?w;`!z|t9S{jD&R?MSh^+`Hv5%UMdgfEYmK^Llhjd-a;o+9iN`~h;BqvoA zBfk@~hr~|!+xN}Cc~gK0@Io80^qe4W}0L!te6%4 zC^db7?N_DROwE++q*(fD293mi1V^wRg}$fbyMZ%>1&2Qr@;BT@v!@FNo%i%R)<;y} z1(%qwIqkdfcX;^TE=(da^t5#L{+7L>&+CgD$Tz&RnoD#rNEmxb??_?sMJ&8zhJX`9 zC#0(Pz}mV(mPTtSI4l&TpRPJt;e+Kf-R9cvYpCMqN z?$L1NgF#>@nz&B+74go$w-tovsDp6!BkiA#x#qIC`-|$FQ!oOo;m`YJ>qFn2!oZc{ z$yHaG^?v3A96KVW5V9!uKhHmC<7Shi$0l6p-3GsKg@o{+a@I(NTye`WpKzUPx!;vH zT8@3^SJ&E|)3Mb#nrA_n7pyz?53wAh-NdK_qTz{^t)|V3c?(>GFH~w;CvjeFz9~vh zL28pK{Om%w+xL+pOwn<|N9Q~I{my)bFgdl`Q!;KR zj}X?HZn?+&=wvU{a{XFN>Z%jm;8&P zTc)A~C-*+wFkY~JpK~~yq2N}S7{fex^)M0!h04LK!$Xdz!&T4kM?#eNSe6oov$vJ( zg{CuEJ)&s7JMB=09zjVnqtVP?@n^n@b~Eia`9{E4+FpraR8ejla{DrfIorR3=Z=H& zJCFdVc|W*+xqtzrm&QsMH!JlM>tIAZrM*&Y1Rv3Qc}ou7X*{C!u#rR~cx^YKK$L)I zSCu4d&2TR`e&4vb7%ei}nz{%MKaf3yS@RplX*0R(?uJ}J-50>#s5;=2k_fTsl{ExL zOF)pKI9Gog$4Ko_ao4eFnhU92Vj3jfmo8*@) zzQw7Sp^>JTWB77aR<7(XPhY9{`!iw= ztB(y{^~-YRP6wnWb}7rk7a;l|yfK-;O&jK@(`%PQ&Khm?``is7dr>zZMCIfar%DlN z0Z};*|53)(bxCVExtW9#-jXy&%!SDhGaJ_;3(b(+$6Ffp$K0Z<r6L2?^XQKV7Fl( zg;+ZbTz}hZjQfQR(2R=p( zgK(a!wo*O?^(!b;5w_0Kdhh_Je83IH+cEId+1y-F+fb~p*nBPI7mg7`ld+hEU0V|O za5%t?c@5m2#I{^?Zz3&@OxLR$6cVGdZT0Wmd;2fC?d(IRL9U_VO*yt_EfT?x+P^W% z8}_m@v(rPYwg_ob6@;xxx@LXnj0{gVLL3$BG5$x{)`pg;E$cCGHx}pVtu23kW5m;~ zlac#3-gJ;{T6Xfj?Yj_$H9BP-sLXyt8qPBuMF`Eujk<^E-_gXoWA*{?*2 zPb7KOcb9`F5=|gql7L`?{`c>HumWEfFJN_fR>jhvKK}v3usc7}b$)5;{7S;y@fCQ1 zgaib|c?AV|g~T)kMM2fIgpeq=fPjR6z`BrJ)&KJW8@rcQ79Riq4 Date: Thu, 20 Jun 2019 15:10:05 +0200 Subject: [PATCH 002/116] =?UTF-8?q?Update=20M=C3=A9t=C3=A9o=20France=20com?= =?UTF-8?q?ponent=20documentation=20(#9239)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Update Météo France component documentation * Apply suggestions from code review Co-Authored-By: oncleben31 * :pencil2: Tweak --- source/_components/meteo_france.markdown | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/source/_components/meteo_france.markdown b/source/_components/meteo_france.markdown index aa66685875b..3226843488d 100644 --- a/source/_components/meteo_france.markdown +++ b/source/_components/meteo_france.markdown @@ -26,7 +26,7 @@ There is currently support for the following device types within Home Assistant: - Sensor - Weather -It displays the current weather along with a 4 days forecast and can create sensors based on the `monitored_conditions` set in your `configuration.yaml` file. +It displays the current weather along with a 4 days forecast and can create sensors based on the `monitored_conditions` set in your `configuration.yaml` file, including weather alerts from [Vigilance Météo-France](http://vigilance.meteofrance.com) ## {% linkable_title Configuration %} @@ -66,6 +66,8 @@ meteo_france: description: Probability of snow for the day. thunder_chance: description: Probability of thunderstorm for the day. + weather_alert: + description: Weather alert status. {% endconfiguration %} ### {% linkable_title About `city` configuration %} @@ -103,6 +105,16 @@ Possible value for each intervals attributes are: - 3 Moderate rain - 4 Heavy rain +### {% linkable_title About `weather_alert` sensor %} + +

+ The weather alert is available for the metropolitan France. +

+ +The `weather_alert` sensor value give the current weather alert status for the department linked to the city. Data is retrieve from [Météo-France vigilance website](http://vigilance.meteofrance.com/). + +The sensor attributes give access to each type of alerts and date of the bulletin emitted by Météo-France. + ### {% linkable_title Complete example %} This is an example for 3 cities forecast with different monitored conditions: @@ -121,6 +133,7 @@ meteo_france: - wind_speed - temperature - uv + - weather_alert - city: 'Oslo, norvege' monitored_conditions: - temperature From 536d0206db11ae5ef62efa25e4b8a130b304a582 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Thomas=20Lov=C3=A9n?= Date: Sat, 22 Jun 2019 05:55:32 +0200 Subject: [PATCH 003/116] Documentation for home-assistant/home-assistant#24675 (#9674) --- source/_components/frontend.markdown | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/source/_components/frontend.markdown b/source/_components/frontend.markdown index d287be2d843..aae2db6d12c 100644 --- a/source/_components/frontend.markdown +++ b/source/_components/frontend.markdown @@ -45,8 +45,12 @@ frontend: description: "List of additional [resources](/developers/frontend_creating_custom_ui/) to load in `latest` javascript mode." required: false type: list - extra_html_url_es5: - description: "List of additional [resources](/developers/frontend_creating_custom_ui/) to load in `es5` javascript mode." + extra_module_url: + description: "List of additional javascript modules to load." + required: false + type: list + extra_js_url_es5: + description: "List of additional javascript code to load in `es5` javascript mode." required: false type: list development_repo: From 8d99182d7866aa6fb9a8fa14da8103ea3d692739 Mon Sep 17 00:00:00 2001 From: Guy Khmelnitsky Date: Sat, 22 Jun 2019 00:05:11 -0700 Subject: [PATCH 004/116] Update Geocoding Quickstart link in Google Cloud (#9673) --- source/_components/google_cloud.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/google_cloud.markdown b/source/_components/google_cloud.markdown index ff386fe3133..dbd70115dda 100644 --- a/source/_components/google_cloud.markdown +++ b/source/_components/google_cloud.markdown @@ -31,7 +31,7 @@ API key obtaining process described in corresponding documentation: * [Text-to-Speach](https://cloud.google.com/text-to-speech/docs/quickstart-protocol) * [Speach-to-Text](https://cloud.google.com/speech-to-text/docs/quickstart-protocol) -* [Geocoding](https://cloud.google.com/translate/docs/quickstart) +* [Geocoding](https://developers.google.com/maps/documentation/geocoding/start) Basic instruction for all APIs: From 4e9d88c40dc6e6a4a282f9e1199cca6e4f390069 Mon Sep 17 00:00:00 2001 From: Penny Wood Date: Sun, 23 Jun 2019 01:44:03 +0800 Subject: [PATCH 005/116] Documentation for template expand (#9394) * Documentation for template expand * :pencil2: Tweak --- .../_docs/configuration/templating.markdown | 69 ++++++++++++++++--- 1 file changed, 61 insertions(+), 8 deletions(-) diff --git a/source/_docs/configuration/templating.markdown b/source/_docs/configuration/templating.markdown index c7922331d79..6f01adea669 100644 --- a/source/_docs/configuration/templating.markdown +++ b/source/_docs/configuration/templating.markdown @@ -33,7 +33,6 @@ We will not go over the basics of the syntax, as Jinja2 does a great job of this The frontend has a template editor tool to help develop and debug templates. Click on the template developer tool icon icon, create your template in the _Template editor_ and check the results on the right. - Templates can get big pretty fast. To keep a clear overview, consider using YAML multiline strings to define your templates: {% raw %} @@ -54,9 +53,10 @@ script: ## {% linkable_title Home Assistant template extensions %} - Extensions allow templates to access all of the Home Assistant specific states and adds other convenience functions and filters. +Extensions allow templates to access all of the Home Assistant specific states and adds other convenience functions and filters. ### {% linkable_title States %} + - Iterating `states` will yield each state sorted alphabetically by entity ID. - Iterating `states.domain` will yield each state of that domain sorted alphabetically by entity ID. - `states.sensor.temperature` returns the state object for `sensor.temperature`. @@ -67,7 +67,6 @@ script: Besides the normal [state object methods and properties](/topics/state_object/), `states.sensor.temperature.state_with_unit` will print the state of the entity and, if available, the unit. - #### {% linkable_title States examples %} The next two statements result in the same value if the state exists. The second one will result in an error if the state does not exist. @@ -112,7 +111,6 @@ Other state examples: ``` {% endraw %} - ### {% linkable_title Attributes %} You can print an attribute with `state_attr` if state is defined. @@ -143,8 +141,33 @@ With strings: ``` {% endraw %} +### {% linkable_title Working with Groups %} + +The `expand` function and filter can be used to sort entities and expand groups. It outputs a sorted array of entities with no duplicates. + +#### {% linkable_title Expand examples %} + +{% raw %} +```text +{% for tracker in expand('device_tracker.paulus', 'group.child_trackers') %} + {{ state_attr(tracker, 'battery') }} + {%- if not loop.last %}, {% endif -%} +{% endfor %} +``` +{% endraw %} + +The same thing can also be expressed as a filter: + +{% raw %} +```text +{{ ['device_tracker.paulus', 'group.child_trackers'] | expand + | selectattr("attributes.battery", 'defined') + | join(', ', attribute="attributes.battery") }} +``` +{% endraw %} ### {% linkable_title Time %} + - `now()` will be rendered as the current time in your time zone. - For specific values: `now().second`, `now().minute`, `now().hour`, `now().day`, `now().month`, `now().year`, `now().weekday()` and `now().isoweekday()` - `utcnow()` will be rendered as UTC time. @@ -156,10 +179,12 @@ With strings: - Filter `timestamp_custom(format_string, local_boolean)` will convert a UNIX timestamp to a custom format, the use of a local timestamp is default. Supports the standard [Python time formatting options](https://docs.python.org/3/library/time.html#time.strftime). ### {% linkable_title Distance %} + - `distance()` will measure the distance in kilometers between home, entity, coordinates. - `closest()` will find the closest entity. #### {% linkable_title Distance examples %} + If only one location is passed in, Home Assistant will measure the distance from home. {% raw %} @@ -174,12 +199,14 @@ These can also be combined in any combination: ``` {% endraw %} -Find entities closest to the Home Assistant location: +#### {% linkable_title Closest examples %} + +The closest function and filter will find the closest entity to the Home Assisant location: {% raw %} ```text Query all entities: {{ closest(states) }} -Query all entities of a specific domain: {{ closest('states.device_tracker') }} +Query all entities of a specific domain: {{ closest(states.device_tracker) }} Query all entities in group.children: {{ closest('group.children') }} Query all entities in group.children: {{ closest(states.group.children) }} ``` @@ -203,11 +230,37 @@ Since closest returns a state, we can combine it with distance too. ``` {% endraw %} +The last argument of the closest function has an implicit `expand`, and can take any iterable sequence of states or entity IDs, and will expand groups: + +{% raw %} +```text +Closest out of given entities: + {{ closest(['group.children', states.device_tracker]) }} +Closest to a coordinate: + {{ closest(23.456, 23.456, ['group.children', states.device_tracker]) }} +Closest to some entity: + {{ closest(states.zone.school, ['group.children', states.device_tracker]) }} +``` + +It will also work as a filter over a iterable group of entities or groups: + +```text +Closest out of given entities: + {{ ['group.children', states.device_tracker] | closest }} +Closest to a coordinate: + {{ ['group.children', states.device_tracker] | closest(23.456, 23.456) }} +Closest to some entity: + {{ ['group.children', states.device_tracker] | closest(states.zone.school) }} +``` + +{% endraw %} ### {% linkable_title Formatting %} + - `float` will format the output as float. ### {% linkable_title Numeric functions and filters %} + Some of these functions can also be used in a [filter](http://jinja.pocoo.org/docs/dev/templates/#id11). This means they can act as a normal function like this `sqrt(2)`, or as part of a filter like this `2|sqrt`. - `log(value, base)` will take the logarithm of the input. When the base is omitted, it defaults to `e` - the natural logarithm. Can also be used as a filter. @@ -225,6 +278,7 @@ Some of these functions can also be used in a [filter](http://jinja.pocoo.org/do - Filter `value_one|bitwise_or(value_two)` perform a bitwise or(\|) operation with two values. ### {% linkable_title Regular expressions %} + - Filter `string|regex_match(find, ignorecase=FALSE)` will match the find expression at the beginning of the string using regex. - Filter `string|regex_search(find, ignorecase=FALSE)` will match the find expression anywhere in the string using regex. - Filter `string|regex_replace(find='', replace='', ignorecase=False)` will replace the find expression with the replace string using regex. @@ -328,13 +382,13 @@ To evaluate a response, go to the Date: Sun, 23 Jun 2019 11:01:12 +0100 Subject: [PATCH 006/116] :pencil2: Fix typos (#9678) --- source/_components/google_cloud.markdown | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/source/_components/google_cloud.markdown b/source/_components/google_cloud.markdown index dbd70115dda..e7537126cf6 100644 --- a/source/_components/google_cloud.markdown +++ b/source/_components/google_cloud.markdown @@ -29,8 +29,8 @@ tts: API key obtaining process described in corresponding documentation: -* [Text-to-Speach](https://cloud.google.com/text-to-speech/docs/quickstart-protocol) -* [Speach-to-Text](https://cloud.google.com/speech-to-text/docs/quickstart-protocol) +* [Text-to-Speech](https://cloud.google.com/text-to-speech/docs/quickstart-protocol) +* [Speech-to-Text](https://cloud.google.com/speech-to-text/docs/quickstart-protocol) * [Geocoding](https://developers.google.com/maps/documentation/geocoding/start) Basic instruction for all APIs: @@ -70,7 +70,7 @@ The Cloud Text-to-Speech API is priced monthly based on the amount of characters | Standard (non-WaveNet) voices | 0 to 4 million characters | $4.00 USD / 1 million characters | | WaveNet voices | 0 to 1 million characters | $16.00 USD / 1 million characters | -### {% linkable_title Text-to-Speach configuration %} +### {% linkable_title Text-to-Speech configuration %} {% configuration %} key_file: From 804bee2294d8c50dfbfea3ee6f74eb9b0024e02c Mon Sep 17 00:00:00 2001 From: Phil Bruckner Date: Mon, 24 Jun 2019 10:05:57 -0500 Subject: [PATCH 007/116] Add new Life360 show_as_state option (#9684) --- source/_components/life360.markdown | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/source/_components/life360.markdown b/source/_components/life360.markdown index 51cfae1e40a..dd01a0624a6 100644 --- a/source/_components/life360.markdown +++ b/source/_components/life360.markdown @@ -94,6 +94,10 @@ prefix: required: false type: string default: life360 +show_as_state: + description: If device is not in a Home Assistant zone, it is determined to be driving (see attribute of same name) and `driving` is specified, the state of entity will be set to `driving`. If device is not in a zone, it is determined to be moving and `moving` is specified, then state of entity will be set to `moving`. + required: false + type: [string, list] warning_threshold: description: See [Communication Errors](#communication-errors) for a detailed description. required: false @@ -166,6 +170,9 @@ life360: max_gps_accuracy: 200 max_update_wait: minutes: 45 + show_as_state: + - driving + - moving # Set comm error thresholds so first is not logged, # second is logged as a WARNING, and third and fourth # are logged as ERRORs. From 4938733ed11ee015392b9379f8fdab96bb39f2f8 Mon Sep 17 00:00:00 2001 From: Matte23 Date: Wed, 26 Jun 2019 01:13:47 +0200 Subject: [PATCH 008/116] Add support for IPP Printers to CUPS integration (#9690) * Add support for IPP Printers to CUPS integration * Update source/_components/cups.markdown Co-Authored-By: Klaas Schoute --- source/_components/cups.markdown | 32 +++++++++++++++++++++++++++----- 1 file changed, 27 insertions(+), 5 deletions(-) diff --git a/source/_components/cups.markdown b/source/_components/cups.markdown index e9caecc22cc..62ca1bca705 100644 --- a/source/_components/cups.markdown +++ b/source/_components/cups.markdown @@ -17,14 +17,17 @@ redirect_from: --- -The `cups` sensor platform is using the open source printing system [CUPS](https://www.cups.org/) to show details about your printers. +The `cups` sensor platform is using the open source printing system [CUPS](https://www.cups.org/) to show details about your printers. It can obtain the informations using a CUPS server or communicating directly with the printer with the Internet Printing Protocol. -To set up the sensor the "Queue Name" of the printer is needed. The fastest way to get it, is to visit the CUPS web interface at "http://[IP ADDRESS PRINT SERVER]:631" and go to "Printers". +If you want to use an existing CUPS server the "Queue Name" of the printer is needed. The fastest way to get it, is to visit the CUPS web interface at "http://[IP ADDRESS PRINT SERVER]:631" and go to "Printers".

+If you want to communicate directly with the printer, you need the IP, the port number and the "Printer Name". Also your printer must support the IPP protocol. The port number is usually 631, while the "Printer Name" is usually "ipp/print". Remember to set "is_cups_server" to false. +If the platform fails to load with those settings, you can look into the web interface of your printer for the port number and the "Printer Name". The procedure is different for different models. + To enable the CUPS sensor, add the following lines to your `configuration.yaml`: ```yaml @@ -38,21 +41,40 @@ sensor: {% configuration %} printers: - description: List of printers to add. + description: List of printers to add. If you're not using a CUPS server, add here your "Printer Name". required: true type: list host: - description: IP address of the CUPS print server. + description: The IP address of the CUPS print server or of the printer. required: false type: string default: 127.0.0.1 port: - description: Port of the CUPS print server. + description: The port number of the CUPS print server or of the printer. required: false type: integer default: 631 +is_cups_server: + description: Set true if you want to use a CUPS print server, set false otherwise. + required: false + type: boolean + default: true {% endconfiguration %} +## {% linkable_title Examples %} + +Default configuration for an IPP printer: + +```yaml +# Example configuration.yaml entry for an IPP printer +sensor: + - platform: cups + host: PRINTER_IP + is_cups_server: false + printers: + - ipp/print +``` +

You will need to install the `python3-dev` or `python3-devel` and the development files for CUPS (`libcups2-dev` or`cups-devel`) package on your system manually (eg. `sudo apt-get install python3-dev libcups2-dev` or `sudo dnf -y install python3-devel cups-devel`) along with a compiler (`gcc`).

From 3ebcc2e7bc6babb323ac60376d8e6ffb12da6e1e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rodrigo=20P=C3=A9rez?= Date: Wed, 26 Jun 2019 01:16:02 -0300 Subject: [PATCH 009/116] vlc-telnet component documentation added (#9558) * vlc-telnet component documentation added * Updated the documentation to the last changes on the PR * Update source/_components/vlc-telnet.markdown Co-Authored-By: Klaas Schoute * Update source/_components/vlc-telnet.markdown Co-Authored-By: Klaas Schoute * Update source/_components/vlc-telnet.markdown Co-Authored-By: Klaas Schoute * Update source/_components/vlc-telnet.markdown Co-Authored-By: Klaas Schoute * Accepted suggestions by @klaasnicolaas * Configuration example and firewall recomendation --- source/_components/vlc-telnet.markdown | 71 ++++++++++++++++++++++++++ 1 file changed, 71 insertions(+) create mode 100644 source/_components/vlc-telnet.markdown diff --git a/source/_components/vlc-telnet.markdown b/source/_components/vlc-telnet.markdown new file mode 100644 index 00000000000..51f3ffd520f --- /dev/null +++ b/source/_components/vlc-telnet.markdown @@ -0,0 +1,71 @@ +--- +layout: page +title: "VLC Telnet" +description: "Instructions on how to integrate VLC media player into Home Assistant using the telnet interface." +date: 2019-06-02 23:58 +sidebar: true +comments: false +sharing: true +footer: true +logo: videolan.png +ha_category: + - Media Player +ha_release: 0.95 +ha_iot_class: Local Polling +--- + +The `vlc-telnet` platform allows you to control a [VLC media player](http://www.videolan.org/vlc/index.html) using the built in telnet interface. + +To add a VLC media player to your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +media_player: + - platform: vlc-telnet + host: IP_ADDRESS + password: PASSWORD +``` + +{% configuration %} +name: + default: VLC-TELNET + description: The name to use in the frontend. + required: false + type: string +pasword: + description: The password to control the VLC through the telnet interface. + required: true + type: string +host: + description: The hostname or IP address where the VLC Player is running. + required: true + type: string +port: + default: 4212 + description: The port number where the VLC Player is running. + required: false + type: integer +{% endconfiguration %} + +Only the "music" media type is supported for now. + +This service will control any instance of VLC player on the network with the telnet interface activated. +To activate the telnet interface on your VLC Player please read the [official VLC documentation](https://wiki.videolan.org/Documentation:Modules/telnet/). Also remember to add a firewall rule allowing inbound connections for the port used in the device running VLC. + +## {% linkable_title Full configuration %} + +A full configuration for VLC could look like the one below: + +```yaml +# Example configuration.yaml entry +media_player: + - platform: vlc-telnet + name: Remote Player + host: 192.168.1.48 + port: 4212 + password: your-secure-password +``` + +##### {% linkable_title Additional configuration for Rasperry Pi %} + +You can run a VLC Media Player inside your Hassio installation using the [hassio-local-vlc add-on](https://github.com/rodripf/hassio-local-vlc). Using it you can play files on the local network, Internet or files and playlist locally saved to the /share folder of your Hassio installation. From 5198c2f7d44ddfd5cef335e9e5e71edb898ab6e7 Mon Sep 17 00:00:00 2001 From: vivianpiketmedia <52200960+vivianpiketmedia@users.noreply.github.com> Date: Thu, 27 Jun 2019 00:21:42 +0300 Subject: [PATCH 010/116] Update lets_encrypt.markdown (#9695) Added link to broader description on SSL/TLS. --- source/_docs/ecosystem/certificates/lets_encrypt.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_docs/ecosystem/certificates/lets_encrypt.markdown b/source/_docs/ecosystem/certificates/lets_encrypt.markdown index 72506055769..af2717e7066 100644 --- a/source/_docs/ecosystem/certificates/lets_encrypt.markdown +++ b/source/_docs/ecosystem/certificates/lets_encrypt.markdown @@ -23,7 +23,7 @@ This guide was added by mf_social on 16/03/2017 and was valid at the time of wri * You can access your Home Assistant instance across your local network, and access the device that it is on via SSH from your local network. * You know the internal IP address of your router and can access your router's configuration pages. * You have already set up a password for your Home Assistant instance, following the advice on this page: [http](/docs/configuration/basic/) - * You want to access your Home Assistant instance when you are away from home (ie, not connected to your local network) and secure it with a TLS/SSL certificate. + * You want to access your Home Assistant instance when you are away from home (ie, not connected to your local network) and secure it with a [TLS/SSL certificate](https://hosting.review/web-hosting-glossary/#12). * You have a basic understanding of the phrases I have used so far. * You are not currently running anything on port 80 on your network (you'd know if you were). * If you are not using Home Assistant on a Debian/Raspian/Hassbian system you will be able to convert any of the terminology I use in to the correct syntax for your system. From e24f8c661a778d088b015bff485d41172430a522 Mon Sep 17 00:00:00 2001 From: Paulus Schoutsen Date: Wed, 26 Jun 2019 16:06:15 -0700 Subject: [PATCH 011/116] Tweak text little bit --- source/_posts/2019-06-26-release-95.markdown | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/_posts/2019-06-26-release-95.markdown b/source/_posts/2019-06-26-release-95.markdown index 987800a87ab..e23b35319f2 100644 --- a/source/_posts/2019-06-26-release-95.markdown +++ b/source/_posts/2019-06-26-release-95.markdown @@ -40,7 +40,7 @@ One cool new feature: because parental control is now available as a switch, you Screenshot of Frenck during his stream demoing AdGuard. -Frenck shows a demo of the AdGuard integration during his stream. See the full stream. +Frenck shows a demo of the AdGuard integration during his stream. See the demo.

## {% linkable_title Life360 %} @@ -51,7 +51,7 @@ If you are migrating from the custom integration, [please read the instructions] ## {% linkable_title Improved Alexa integration %} -One more thing… This release improves the Home Assistant Cloud Alexa integration. Just like Google Assistant, it is now possible to manage which entities are exposed to Amazon via the user interface. Alexa actually offers some cool features around this. Any change you make is reflected instantly inside Alexa. Add an entity? Control it instantly via Alexa. +One more thing… This release improves the Home Assistant Cloud Alexa integration. Just like Google Assistant, it is now possible to manage which entities are exposed to Amazon via the user interface. Alexa actually offers some cool features around this. Any change you make is instantly reflected inside Alexa. Add an entity? Control it instantly via Alexa. However, we didn't stop there. The [manual installations of Alexa](https://www.home-assistant.io/components/alexa.smart_home/#alexa-component-configuration) has had optional proactive state reporting since earlier this year, and this is now available for Home Assistant Cloud users too. If you choose to opt-in to this, every state change of your exposed entities is sent to Amazon as soon as they happen. It allows Amazon Echos with displays, to instantly reflect the state and allows you to create routines inside Amazon powered by your Home Assistant entities. From a232c7f43032b0966d217b74137b1b918e38ce28 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rodrigo=20P=C3=A9rez?= Date: Wed, 26 Jun 2019 01:16:02 -0300 Subject: [PATCH 012/116] vlc-telnet component documentation added (#9558) * vlc-telnet component documentation added * Updated the documentation to the last changes on the PR * Update source/_components/vlc-telnet.markdown Co-Authored-By: Klaas Schoute * Update source/_components/vlc-telnet.markdown Co-Authored-By: Klaas Schoute * Update source/_components/vlc-telnet.markdown Co-Authored-By: Klaas Schoute * Update source/_components/vlc-telnet.markdown Co-Authored-By: Klaas Schoute * Accepted suggestions by @klaasnicolaas * Configuration example and firewall recomendation --- source/_components/vlc-telnet.markdown | 71 ++++++++++++++++++++++++++ 1 file changed, 71 insertions(+) create mode 100644 source/_components/vlc-telnet.markdown diff --git a/source/_components/vlc-telnet.markdown b/source/_components/vlc-telnet.markdown new file mode 100644 index 00000000000..51f3ffd520f --- /dev/null +++ b/source/_components/vlc-telnet.markdown @@ -0,0 +1,71 @@ +--- +layout: page +title: "VLC Telnet" +description: "Instructions on how to integrate VLC media player into Home Assistant using the telnet interface." +date: 2019-06-02 23:58 +sidebar: true +comments: false +sharing: true +footer: true +logo: videolan.png +ha_category: + - Media Player +ha_release: 0.95 +ha_iot_class: Local Polling +--- + +The `vlc-telnet` platform allows you to control a [VLC media player](http://www.videolan.org/vlc/index.html) using the built in telnet interface. + +To add a VLC media player to your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +media_player: + - platform: vlc-telnet + host: IP_ADDRESS + password: PASSWORD +``` + +{% configuration %} +name: + default: VLC-TELNET + description: The name to use in the frontend. + required: false + type: string +pasword: + description: The password to control the VLC through the telnet interface. + required: true + type: string +host: + description: The hostname or IP address where the VLC Player is running. + required: true + type: string +port: + default: 4212 + description: The port number where the VLC Player is running. + required: false + type: integer +{% endconfiguration %} + +Only the "music" media type is supported for now. + +This service will control any instance of VLC player on the network with the telnet interface activated. +To activate the telnet interface on your VLC Player please read the [official VLC documentation](https://wiki.videolan.org/Documentation:Modules/telnet/). Also remember to add a firewall rule allowing inbound connections for the port used in the device running VLC. + +## {% linkable_title Full configuration %} + +A full configuration for VLC could look like the one below: + +```yaml +# Example configuration.yaml entry +media_player: + - platform: vlc-telnet + name: Remote Player + host: 192.168.1.48 + port: 4212 + password: your-secure-password +``` + +##### {% linkable_title Additional configuration for Rasperry Pi %} + +You can run a VLC Media Player inside your Hassio installation using the [hassio-local-vlc add-on](https://github.com/rodripf/hassio-local-vlc). Using it you can play files on the local network, Internet or files and playlist locally saved to the /share folder of your Hassio installation. From c63e488bb946a6b49a30d880e5044ead7845f639 Mon Sep 17 00:00:00 2001 From: Paulus Schoutsen Date: Wed, 26 Jun 2019 21:29:39 -0700 Subject: [PATCH 013/116] release 95.1 --- _config.yml | 4 ++-- source/_posts/2019-06-26-release-95.markdown | 16 ++++++++++++++++ 2 files changed, 18 insertions(+), 2 deletions(-) diff --git a/_config.yml b/_config.yml index f86c7aed19b..233341be8c6 100644 --- a/_config.yml +++ b/_config.yml @@ -139,8 +139,8 @@ social: # Home Assistant release details current_major_version: 0 current_minor_version: 95 -current_patch_version: 0 -date_released: 2019-06-26 +current_patch_version: 1 +date_released: 2019-06-27 # Either # or the anchor link to latest release notes in the blog post. # Must be prefixed with a # and have double quotes around it. diff --git a/source/_posts/2019-06-26-release-95.markdown b/source/_posts/2019-06-26-release-95.markdown index e23b35319f2..502f578401f 100644 --- a/source/_posts/2019-06-26-release-95.markdown +++ b/source/_posts/2019-06-26-release-95.markdown @@ -94,6 +94,22 @@ We have also realized that the default database clean up task never automaticall - Add incomfort sensor and binary_sensor ([@zxdavb] - [#23812]) ([incomfort docs]) (new-platform) - Added ELV PCA 301 smart emeter switch ([@majuss] - [#23300]) ([elv docs]) (new-platform) +## {% linkable_title Release 0.95.1 - June 26 %} + +- Fix life360 exception when no location provided ([@pnbruckner] - [#24777]) ([life360 docs]) +- Pubnub to 1.0.8 ([@w1ll1am23] - [#24781]) ([wink docs]) +- Catch uncaught Alexa error ([@balloob] - [#24785]) ([cloud docs]) + +[#24777]: https://github.com/home-assistant/home-assistant/pull/24777 +[#24781]: https://github.com/home-assistant/home-assistant/pull/24781 +[#24785]: https://github.com/home-assistant/home-assistant/pull/24785 +[@balloob]: https://github.com/balloob +[@pnbruckner]: https://github.com/pnbruckner +[@w1ll1am23]: https://github.com/w1ll1am23 +[cloud docs]: /components/cloud/ +[life360 docs]: /components/life360/ +[wink docs]: /components/wink/ + ## {% linkable_title If you need help... %} ...don't hesitate to use our very active [forums](https://community.home-assistant.io/) or join us for a little [chat](https://discord.gg/c5DvZ4e). From f310e4307d526e61bb70c2ffbdbad77c2ebe364f Mon Sep 17 00:00:00 2001 From: ajayjohn <1575879+ajayjohn@users.noreply.github.com> Date: Thu, 27 Jun 2019 05:44:31 -0500 Subject: [PATCH 014/116] Fixed typos (#9698) Corrected instances where 'speech' was spelt as 'speach'. It's not all (s)peachy now ;) --- source/_components/google_cloud.markdown | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/_components/google_cloud.markdown b/source/_components/google_cloud.markdown index dbd70115dda..5551d9466cf 100644 --- a/source/_components/google_cloud.markdown +++ b/source/_components/google_cloud.markdown @@ -29,8 +29,8 @@ tts: API key obtaining process described in corresponding documentation: -* [Text-to-Speach](https://cloud.google.com/text-to-speech/docs/quickstart-protocol) -* [Speach-to-Text](https://cloud.google.com/speech-to-text/docs/quickstart-protocol) +* [Text-to-Speech](https://cloud.google.com/text-to-speech/docs/quickstart-protocol) +* [Speech-to-Text](https://cloud.google.com/speech-to-text/docs/quickstart-protocol) * [Geocoding](https://developers.google.com/maps/documentation/geocoding/start) Basic instruction for all APIs: From 2fe931c8205f46f6ed28f9c4fb4278f2d16017c3 Mon Sep 17 00:00:00 2001 From: Raoul Teeuwen Date: Thu, 27 Jun 2019 12:45:38 +0200 Subject: [PATCH 015/116] Update google_cloud.markdown (#9699) fixed typo "speach" > "speech" --- source/_components/google_cloud.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/google_cloud.markdown b/source/_components/google_cloud.markdown index 5551d9466cf..e7537126cf6 100644 --- a/source/_components/google_cloud.markdown +++ b/source/_components/google_cloud.markdown @@ -70,7 +70,7 @@ The Cloud Text-to-Speech API is priced monthly based on the amount of characters | Standard (non-WaveNet) voices | 0 to 4 million characters | $4.00 USD / 1 million characters | | WaveNet voices | 0 to 1 million characters | $16.00 USD / 1 million characters | -### {% linkable_title Text-to-Speach configuration %} +### {% linkable_title Text-to-Speech configuration %} {% configuration %} key_file: From 4369499e8935bf8184f9e79a0180a6d2641afa1e Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Fri, 28 Jun 2019 05:10:56 +0200 Subject: [PATCH 016/116] Component(s) -> Integration(s) (#9705) --- source/_components/abode.markdown | 16 +++++++------- source/_components/actiontec.markdown | 2 +- source/_components/ads.markdown | 2 +- source/_components/aftership.markdown | 2 +- .../alarm_control_panel.mqtt.markdown | 4 ++-- source/_components/alarmdecoder.markdown | 4 ++-- source/_components/alert.markdown | 10 ++++----- source/_components/alexa.intent.markdown | 4 ++-- source/_components/alexa.smart_home.markdown | 2 +- source/_components/ambient_station.markdown | 4 ++-- source/_components/amcrest.markdown | 2 +- source/_components/android_ip_webcam.markdown | 4 ++-- source/_components/androidtv.markdown | 4 ++-- source/_components/apcupsd.markdown | 4 ++-- source/_components/api.markdown | 2 +- source/_components/aprs.markdown | 2 +- source/_components/aqualogic.markdown | 4 ++-- source/_components/arduino.markdown | 2 +- source/_components/arlo.markdown | 4 ++-- source/_components/aruba.markdown | 2 +- source/_components/asterisk_mbox.markdown | 4 ++-- source/_components/asuswrt.markdown | 4 ++-- source/_components/august.markdown | 2 +- source/_components/auth.markdown | 6 ++--- source/_components/automatic.markdown | 2 +- source/_components/aws.markdown | 6 ++--- source/_components/azure_event_hub.markdown | 4 ++-- source/_components/bbb_gpio.markdown | 4 ++-- source/_components/bbox.markdown | 2 +- source/_components/binary_sensor.knx.markdown | 2 +- .../_components/binary_sensor.rflink.markdown | 4 ++-- .../_components/binary_sensor.rfxtrx.markdown | 8 +++---- .../binary_sensor.xiaomi_aqara.markdown | 2 +- source/_components/blink.markdown | 4 ++-- source/_components/bloomsky.markdown | 10 ++++----- source/_components/bluesound.markdown | 2 +- source/_components/bme680.markdown | 2 +- .../_components/bmw_connected_drive.markdown | 12 +++++----- source/_components/browser.markdown | 4 ++-- source/_components/brunt.markdown | 2 +- source/_components/bt_home_hub_5.markdown | 2 +- source/_components/bt_smarthub.markdown | 2 +- source/_components/buienradar.markdown | 6 ++--- source/_components/caldav.markdown | 4 ++-- source/_components/calendar.google.markdown | 4 ++-- source/_components/calendar.markdown | 2 +- source/_components/camera.markdown | 10 ++++----- source/_components/canary.markdown | 2 +- source/_components/cast.markdown | 4 ++-- source/_components/cisco_ios.markdown | 2 +- .../cisco_mobility_express.markdown | 2 +- source/_components/clementine.markdown | 2 +- source/_components/climate.knx.markdown | 2 +- source/_components/climate.markdown | 2 +- source/_components/climate.mysensors.markdown | 2 +- source/_components/cloudflare.markdown | 6 ++--- source/_components/coinbase.markdown | 4 ++-- source/_components/comfoconnect.markdown | 6 ++--- source/_components/config.markdown | 2 +- source/_components/configurator.markdown | 6 ++--- source/_components/conversation.markdown | 4 ++-- source/_components/counter.markdown | 4 ++-- source/_components/cover.knx.markdown | 2 +- source/_components/cover.rflink.markdown | 2 +- source/_components/cover.template.markdown | 2 +- source/_components/cppm.markdown | 2 +- source/_components/daikin.markdown | 4 ++-- source/_components/danfoss_air.markdown | 4 ++-- source/_components/datadog.markdown | 6 ++--- source/_components/ddwrt.markdown | 2 +- source/_components/deconz.markdown | 4 ++-- source/_components/default_config.markdown | 4 ++-- source/_components/demo.markdown | 4 ++-- .../device_sun_light_trigger.markdown | 4 ++-- source/_components/device_tracker.markdown | 2 +- .../device_tracker.xiaomi.markdown | 2 +- source/_components/dialogflow.markdown | 4 ++-- source/_components/digital_ocean.markdown | 2 +- source/_components/digitalloggers.markdown | 2 +- source/_components/discord.markdown | 2 +- source/_components/discovery.markdown | 4 ++-- source/_components/dispatcher.markdown | 2 +- source/_components/dominos.markdown | 6 ++--- source/_components/dovado.markdown | 4 ++-- source/_components/downloader.markdown | 4 ++-- source/_components/dsmr.markdown | 4 ++-- source/_components/duckdns.markdown | 6 ++--- source/_components/dweet.markdown | 4 ++-- source/_components/dyson.markdown | 6 ++--- source/_components/ebusd.markdown | 2 +- source/_components/ecoal_boiler.markdown | 2 +- source/_components/ecobee.markdown | 10 ++++----- source/_components/ecovacs.markdown | 4 ++-- source/_components/edp_redy.markdown | 2 +- source/_components/ee_brightbox.markdown | 2 +- source/_components/egardia.markdown | 6 ++--- source/_components/eight_sleep.markdown | 2 +- source/_components/emoncms.markdown | 2 +- source/_components/emoncms_history.markdown | 4 ++-- source/_components/emulated_hue.markdown | 6 ++--- source/_components/emulated_roku.markdown | 8 +++---- source/_components/enocean.markdown | 2 +- source/_components/envisalink.markdown | 8 +++---- source/_components/esphome.markdown | 4 ++-- source/_components/eufy.markdown | 4 ++-- source/_components/evohome.markdown | 6 ++--- source/_components/facebox.markdown | 2 +- source/_components/fail2ban.markdown | 2 +- source/_components/fan.markdown | 2 +- source/_components/fan.template.markdown | 2 +- source/_components/fastdotcom.markdown | 6 ++--- source/_components/feedreader.markdown | 2 +- source/_components/ffmpeg.markdown | 2 +- source/_components/flexit.markdown | 2 +- source/_components/flic.markdown | 6 ++--- source/_components/flux.markdown | 2 +- source/_components/flux_led.markdown | 2 +- source/_components/folder_watcher.markdown | 4 ++-- source/_components/foursquare.markdown | 4 ++-- source/_components/freebox.markdown | 2 +- source/_components/freedns.markdown | 4 ++-- source/_components/fritz.markdown | 2 +- source/_components/fritzbox.markdown | 2 +- .../_components/fritzbox_netmonitor.markdown | 2 +- source/_components/fritzdect.markdown | 2 +- source/_components/frontier_silicon.markdown | 8 +++---- .../_components/generic_thermostat.markdown | 2 +- source/_components/geofency.markdown | 4 ++-- source/_components/goalfeed.markdown | 2 +- source/_components/google_assistant.markdown | 6 ++--- source/_components/google_domains.markdown | 4 ++-- source/_components/google_pubsub.markdown | 2 +- source/_components/google_translate.markdown | 2 +- source/_components/googlehome.markdown | 10 ++++----- source/_components/gpsd.markdown | 2 +- source/_components/gpslogger.markdown | 2 +- source/_components/graphite.markdown | 2 +- source/_components/greeneye_monitor.markdown | 2 +- source/_components/greenwave.markdown | 4 ++-- source/_components/group.markdown | 2 +- source/_components/habitica.markdown | 4 ++-- source/_components/hangouts.markdown | 12 +++++----- source/_components/hdmi_cec.markdown | 4 ++-- source/_components/heos.markdown | 4 ++-- source/_components/hipchat.markdown | 2 +- source/_components/history.markdown | 12 +++++----- source/_components/history_graph.markdown | 4 ++-- source/_components/history_stats.markdown | 10 ++++----- source/_components/hitron_coda.markdown | 4 ++-- source/_components/hive.markdown | 8 +++---- source/_components/homekit.markdown | 22 +++++++++---------- .../_components/homekit_controller.markdown | 4 ++-- source/_components/homematic.markdown | 6 ++--- source/_components/homematicip_cloud.markdown | 6 ++--- source/_components/homeworks.markdown | 6 ++--- source/_components/hook.markdown | 4 ++-- source/_components/horizon.markdown | 4 ++-- source/_components/hp_ilo.markdown | 2 +- source/_components/http.markdown | 6 ++--- source/_components/huawei_lte.markdown | 6 ++--- source/_components/huawei_router.markdown | 2 +- source/_components/hue.markdown | 4 ++-- source/_components/hydrawise.markdown | 2 +- source/_components/icloud.markdown | 4 ++-- source/_components/idteck_prox.markdown | 2 +- source/_components/ifttt.markdown | 4 ++-- source/_components/ihc.markdown | 6 ++--- source/_components/image_processing.markdown | 2 +- source/_components/imap.markdown | 2 +- source/_components/influxdb.markdown | 12 +++++----- source/_components/input_boolean.markdown | 6 ++--- source/_components/input_datetime.markdown | 8 +++---- source/_components/input_number.markdown | 8 +++---- source/_components/input_select.markdown | 8 +++---- source/_components/input_text.markdown | 8 +++---- source/_components/insteon.markdown | 4 ++-- source/_components/intent_script.markdown | 2 +- source/_components/introduction.markdown | 4 ++-- source/_components/ios.markdown | 2 +- source/_components/iota.markdown | 4 ++-- source/_components/iperf3.markdown | 8 +++---- source/_components/itach.markdown | 4 ++-- source/_components/joaoapps_join.markdown | 4 ++-- source/_components/keenetic_ndms2.markdown | 4 ++-- source/_components/keyboard.markdown | 2 +- source/_components/keyboard_remote.markdown | 6 ++--- source/_components/kira.markdown | 4 ++-- source/_components/knx.markdown | 8 +++---- source/_components/kodi.markdown | 2 +- source/_components/konnected.markdown | 10 ++++----- source/_components/kwb.markdown | 2 +- source/_components/lannouncer.markdown | 2 +- source/_components/lcn.markdown | 6 ++--- source/_components/lg_netcast.markdown | 2 +- source/_components/lg_soundbar.markdown | 2 +- source/_components/life360.markdown | 2 +- source/_components/lifx.markdown | 6 ++--- source/_components/light.knx.markdown | 4 ++-- source/_components/light.markdown | 2 +- source/_components/light.rflink.markdown | 4 ++-- source/_components/light.template.markdown | 2 +- .../_components/light.xiaomi_aqara.markdown | 2 +- source/_components/lightwave.markdown | 6 ++--- source/_components/linksys_ap.markdown | 2 +- source/_components/linksys_smart.markdown | 2 +- source/_components/linode.markdown | 2 +- source/_components/lirc.markdown | 4 ++-- source/_components/lock.markdown | 2 +- source/_components/lock.template.markdown | 2 +- source/_components/logbook.markdown | 14 ++++++------ source/_components/logentries.markdown | 4 ++-- source/_components/logger.markdown | 12 +++++----- source/_components/logi_circle.markdown | 2 +- source/_components/london_air.markdown | 2 +- source/_components/luci.markdown | 4 ++-- source/_components/luftdaten.markdown | 4 ++-- source/_components/lupusec.markdown | 2 +- source/_components/lutron.markdown | 6 ++--- source/_components/lutron_caseta.markdown | 8 +++---- source/_components/mailgun.markdown | 2 +- source/_components/manual.markdown | 2 +- source/_components/manual_mqtt.markdown | 2 +- source/_components/matrix.markdown | 2 +- source/_components/maxcube.markdown | 2 +- source/_components/mcp23017.markdown | 2 +- source/_components/media_extractor.markdown | 2 +- source/_components/media_player.markdown | 2 +- source/_components/mediaroom.markdown | 10 ++++----- source/_components/melissa.markdown | 6 ++--- source/_components/mercedesme.markdown | 8 +++---- source/_components/meteo_france.markdown | 4 ++-- source/_components/meteoalarm.markdown | 2 +- source/_components/metoffice.markdown | 2 +- source/_components/mhz19.markdown | 2 +- source/_components/microsoft.markdown | 2 +- source/_components/microsoft_face.markdown | 4 ++-- source/_components/mikrotik.markdown | 2 +- source/_components/mobile_app.markdown | 10 ++++----- source/_components/mochad.markdown | 2 +- source/_components/mold_indicator.markdown | 6 ++--- source/_components/mopar.markdown | 2 +- source/_components/mpchc.markdown | 2 +- source/_components/mqtt_eventstream.markdown | 2 +- source/_components/mqtt_room.markdown | 2 +- source/_components/mqtt_statestream.markdown | 12 +++++----- source/_components/mychevy.markdown | 6 ++--- source/_components/mysensors.markdown | 6 ++--- source/_components/mythicbeastsdns.markdown | 4 ++-- source/_components/n26.markdown | 2 +- source/_components/namecheapdns.markdown | 4 ++-- source/_components/neato.markdown | 2 +- source/_components/ness_alarm.markdown | 2 +- source/_components/nest.markdown | 8 +++---- source/_components/netatmo.markdown | 14 ++++++------ source/_components/netgear.markdown | 4 ++-- source/_components/nissan_leaf.markdown | 6 ++--- source/_components/nmap_tracker.markdown | 2 +- source/_components/nmbs.markdown | 2 +- source/_components/no_ip.markdown | 4 ++-- source/_components/norway_air.markdown | 2 +- source/_components/notify.knx.markdown | 2 +- source/_components/notify.markdown | 4 ++-- source/_components/nuheat.markdown | 2 +- source/_components/nuimo_controller.markdown | 2 +- source/_components/octoprint.markdown | 2 +- source/_components/onboarding.markdown | 4 ++-- source/_components/onkyo.markdown | 2 +- source/_components/opentherm_gw.markdown | 6 ++--- source/_components/openuv.markdown | 6 ++--- source/_components/openwrt.markdown | 2 +- source/_components/orangepi_gpio.markdown | 6 ++--- source/_components/owlet.markdown | 6 ++--- source/_components/panel_custom.markdown | 2 +- .../persistent_notification.markdown | 2 +- source/_components/person.markdown | 8 +++---- source/_components/pilight.markdown | 6 ++--- source/_components/ping.markdown | 4 ++-- source/_components/plaato.markdown | 2 +- source/_components/plant.markdown | 2 +- source/_components/plex.markdown | 2 +- source/_components/postnl.markdown | 2 +- source/_components/prometheus.markdown | 6 ++--- source/_components/proximity.markdown | 8 +++---- source/_components/ps4.markdown | 12 +++++----- source/_components/ptvsd.markdown | 6 ++--- .../_components/pulseaudio_loopback.markdown | 4 ++-- source/_components/pushover.markdown | 4 ++-- source/_components/python_script.markdown | 2 +- source/_components/qnap.markdown | 2 +- source/_components/quantum_gateway.markdown | 2 +- source/_components/qwikswitch.markdown | 4 ++-- source/_components/rachio.markdown | 2 +- source/_components/rainbird.markdown | 2 +- source/_components/raincloud.markdown | 2 +- source/_components/rainmachine.markdown | 2 +- source/_components/raspihats.markdown | 2 +- source/_components/raspyrfm.markdown | 6 ++--- source/_components/recorder.markdown | 10 ++++----- source/_components/remember_the_milk.markdown | 4 ++-- source/_components/remote_rpi_gpio.markdown | 2 +- source/_components/repetier.markdown | 2 +- source/_components/rest.markdown | 2 +- source/_components/rest_command.markdown | 2 +- source/_components/rflink.markdown | 10 ++++----- source/_components/rfxtrx.markdown | 2 +- source/_components/ring.markdown | 4 ++-- source/_components/ritassist.markdown | 2 +- source/_components/roku.markdown | 4 ++-- source/_components/roomba.markdown | 2 +- source/_components/route53.markdown | 8 +++---- source/_components/rova.markdown | 2 +- source/_components/rpi_camera.markdown | 2 +- source/_components/rpi_gpio.markdown | 2 +- source/_components/rpi_pfio.markdown | 2 +- source/_components/rss_feed_template.markdown | 4 ++-- source/_components/sabnzbd.markdown | 2 +- source/_components/satel_integra.markdown | 2 +- source/_components/scene.knx.markdown | 2 +- source/_components/scene.markdown | 2 +- source/_components/script.markdown | 2 +- source/_components/scsgate.markdown | 4 ++-- source/_components/sensehat.markdown | 2 +- source/_components/sensor.buienradar.markdown | 4 ++-- source/_components/sensor.knx.markdown | 2 +- source/_components/sensor.rflink.markdown | 2 +- source/_components/shell_command.markdown | 2 +- source/_components/shiftr.markdown | 4 ++-- source/_components/shopping_list.markdown | 2 +- source/_components/sigfox.markdown | 2 +- source/_components/simplisafe.markdown | 2 +- source/_components/sisyphus.markdown | 2 +- source/_components/sky_hub.markdown | 2 +- source/_components/smappee.markdown | 6 ++--- source/_components/smarthab.markdown | 4 ++-- source/_components/smartthings.markdown | 20 ++++++++--------- source/_components/smarty.markdown | 4 ++-- source/_components/smhi.markdown | 2 +- source/_components/snips.markdown | 4 ++-- source/_components/snmp.markdown | 4 ++-- source/_components/solax.markdown | 2 +- source/_components/somfy.markdown | 4 ++-- source/_components/sonos.markdown | 4 ++-- source/_components/spaceapi.markdown | 4 ++-- source/_components/speedtestdotnet.markdown | 14 ++++++------ source/_components/spider.markdown | 6 ++--- source/_components/splunk.markdown | 4 ++-- source/_components/spotify.markdown | 2 +- source/_components/sql.markdown | 2 +- source/_components/srp_energy.markdown | 2 +- source/_components/statistics.markdown | 4 ++-- source/_components/statsd.markdown | 4 ++-- source/_components/stiebel_eltron.markdown | 4 ++-- source/_components/stream.markdown | 2 +- source/_components/streamlabswater.markdown | 4 ++-- source/_components/sun.markdown | 2 +- source/_components/swisscom.markdown | 2 +- source/_components/switch.knx.markdown | 4 ++-- source/_components/switch.rflink.markdown | 4 ++-- source/_components/switch.rfxtrx.markdown | 2 +- source/_components/switch.template.markdown | 2 +- source/_components/switcher_kis.markdown | 4 ++-- source/_components/switchmate.markdown | 2 +- source/_components/synology.markdown | 2 +- source/_components/synology_srm.markdown | 2 +- source/_components/system_health.markdown | 6 ++--- source/_components/system_log.markdown | 8 +++---- source/_components/systemmonitor.markdown | 2 +- source/_components/tado.markdown | 4 ++-- source/_components/tahoma.markdown | 2 +- source/_components/tcp.markdown | 2 +- source/_components/telegram_bot.markdown | 4 ++-- source/_components/tellduslive.markdown | 6 ++--- source/_components/tellstick.markdown | 2 +- source/_components/tensorflow.markdown | 6 ++--- source/_components/tesla.markdown | 4 ++-- source/_components/tfiac.markdown | 2 +- source/_components/thethingsnetwork.markdown | 2 +- source/_components/thingspeak.markdown | 4 ++-- source/_components/thomson.markdown | 2 +- source/_components/tibber.markdown | 2 +- source/_components/timer.markdown | 4 ++-- source/_components/tod.markdown | 2 +- source/_components/todoist.markdown | 2 +- source/_components/tomato.markdown | 2 +- source/_components/toon.markdown | 6 ++--- source/_components/tplink.markdown | 8 +++---- source/_components/tradfri.markdown | 2 +- source/_components/transmission.markdown | 4 ++-- source/_components/tts.markdown | 4 ++-- source/_components/tuya.markdown | 2 +- source/_components/twilio.markdown | 8 +++---- source/_components/ubee.markdown | 4 ++-- source/_components/ubus.markdown | 4 ++-- source/_components/unifi.markdown | 8 +++---- source/_components/unifi_direct.markdown | 2 +- source/_components/upc_connect.markdown | 2 +- source/_components/upcloud.markdown | 2 +- source/_components/updater.markdown | 10 ++++----- source/_components/upnp.markdown | 8 +++---- source/_components/uscis.markdown | 2 +- source/_components/usps.markdown | 12 +++++----- source/_components/utility_meter.markdown | 4 ++-- source/_components/vacuum.markdown | 4 ++-- source/_components/vacuum.mqtt.markdown | 10 ++++----- .../_components/vacuum.xiaomi_miio.markdown | 2 +- source/_components/velbus.markdown | 2 +- source/_components/velux.markdown | 2 +- source/_components/vizio.markdown | 2 +- source/_components/volvooncall.markdown | 2 +- source/_components/vultr.markdown | 2 +- source/_components/w800rf32.markdown | 2 +- source/_components/wake_on_lan.markdown | 6 ++--- source/_components/water_heater.markdown | 2 +- source/_components/waterfurnace.markdown | 2 +- source/_components/watson_iot.markdown | 6 ++--- source/_components/waze_travel_time.markdown | 2 +- source/_components/webhooks.markdown | 2 +- source/_components/weblink.markdown | 4 ++-- source/_components/websocket_api.markdown | 2 +- source/_components/wemo.markdown | 6 ++--- source/_components/wink.markdown | 2 +- source/_components/wunderlist.markdown | 4 ++-- source/_components/xbox_live.markdown | 2 +- source/_components/xfinity.markdown | 2 +- source/_components/xiaomi_aqara.markdown | 2 +- source/_components/xs1.markdown | 4 ++-- source/_components/yamaha.markdown | 2 +- source/_components/yamaha_musiccast.markdown | 2 +- source/_components/yeelight.markdown | 6 ++--- source/_components/zabbix.markdown | 4 ++-- source/_components/zestimate.markdown | 2 +- source/_components/zha.markdown | 2 +- source/_components/zigbee.markdown | 2 +- source/_components/ziggo_mediabox_xl.markdown | 4 ++-- source/_components/zone.markdown | 4 ++-- source/_components/zoneminder.markdown | 4 ++-- source/_components/zwave.markdown | 2 +- .../python_component_automation.markdown | 2 +- 438 files changed, 862 insertions(+), 862 deletions(-) diff --git a/source/_components/abode.markdown b/source/_components/abode.markdown index 23f0002f664..b52572af492 100644 --- a/source/_components/abode.markdown +++ b/source/_components/abode.markdown @@ -31,7 +31,7 @@ redirect_from: - /components/sensor.abode/ --- -The `abode` component will allow users to integrate their Abode Home Security systems into Home Assistant and use its alarm system and sensors to automate their homes. +The `abode` integration will allow users to integrate their Abode Home Security systems into Home Assistant and use its alarm system and sensors to automate their homes. Please visit the [Abode website](https://goabode.com/) for further information about Abode Security. @@ -88,13 +88,13 @@ polling: exclude: description: > A list of devices to exclude from Home Assistant by their Abode `device_id` - or `automation_id`, found within the component attributes. + or `automation_id`, found within the integration attributes. required: false type: list lights: description: > A list of switch devices that Home Assistant should treat as lights by the - switches Abode `device_id`, found within the component attributes. + switches Abode `device_id`, found within the integration attributes. required: false type: list {% endconfiguration %} @@ -159,16 +159,16 @@ Trigger a quick action automation on your Abode system. ### {% linkable_title Binary Sensor %} -This component will add `Door Contacts`, `Connectivity` sensors (remotes, keypads, and status indicators), `Moisture` sensors, and `Motion` or `Occupancy` sensors. +This integration will add `Door Contacts`, `Connectivity` sensors (remotes, keypads, and status indicators), `Moisture` sensors, and `Motion` or `Occupancy` sensors. -This component will also list all Abode `Quick Actions` that are set up. You can trigger these quick actions by passing the `entity_id` of your quick action binary sensor to the [trigger_quick_action service](/components/abode/#trigger_quick_action). +This integration will also list all Abode `Quick Actions` that are set up. You can trigger these quick actions by passing the `entity_id` of your quick action binary sensor to the [trigger_quick_action service](/components/abode/#trigger_quick_action). ### {% linkable_title Light %} -This component will automatically add `Lights` configured in your Abode account. You can reclassify `Switches` to show up within Home Assistant as lights by listing the Abode device ID in your [configuration](/components/abode/#configuration). +This integration will automatically add `Lights` configured in your Abode account. You can reclassify `Switches` to show up within Home Assistant as lights by listing the Abode device ID in your [configuration](/components/abode/#configuration). ### {% linkable_title Switch %} -This component will automatically add `Power Switches` configured in your Abode account. You can reclassify switches to show up within Home Assistant as `Lights` by listing the Abode device ID in your [configuration](/components/abode/#configuration). +This integration will automatically add `Power Switches` configured in your Abode account. You can reclassify switches to show up within Home Assistant as `Lights` by listing the Abode device ID in your [configuration](/components/abode/#configuration). -This component will also list all Abode `Automations` that are set up within the Abode system, allowing you to activate and deactivate the automations. +This integration will also list all Abode `Automations` that are set up within the Abode system, allowing you to activate and deactivate the automations. diff --git a/source/_components/actiontec.markdown b/source/_components/actiontec.markdown index 837918b1b6d..9d90d557179 100644 --- a/source/_components/actiontec.markdown +++ b/source/_components/actiontec.markdown @@ -52,4 +52,4 @@ password: type: string {% endconfiguration %} -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. diff --git a/source/_components/ads.markdown b/source/_components/ads.markdown index 96adb3de43d..7dcbf645f14 100644 --- a/source/_components/ads.markdown +++ b/source/_components/ads.markdown @@ -62,7 +62,7 @@ ip_address: ## {% linkable_title Service %} -The ADS component will register the service `write_by_name` allowing you to write a value to a variable on your ADS device. +The ADS integration will register the service `write_by_name` allowing you to write a value to a variable on your ADS device. ```json { diff --git a/source/_components/aftership.markdown b/source/_components/aftership.markdown index 7ba102d0134..5991851acd6 100644 --- a/source/_components/aftership.markdown +++ b/source/_components/aftership.markdown @@ -70,5 +70,5 @@ api_key: | `slug` | `True` | string | Carrier e.g. `fedex`

-This component retrieves data from AfterShip public REST API, but the component is not affiliated with AfterShip. +This integration retrieves data from AfterShip public REST API, but the integration is not affiliated with AfterShip.

diff --git a/source/_components/alarm_control_panel.mqtt.markdown b/source/_components/alarm_control_panel.mqtt.markdown index 4b698510c49..b32ef6da3ce 100644 --- a/source/_components/alarm_control_panel.mqtt.markdown +++ b/source/_components/alarm_control_panel.mqtt.markdown @@ -16,7 +16,7 @@ ha_iot_class: Configurable The `mqtt` alarm panel platform enables the possibility to control MQTT capable alarm panels. The Alarm icon will change state after receiving a new state from `state_topic`. If these messages are published with *RETAIN* flag, the MQTT alarm panel will receive an instant state update after subscription and will start with the correct state. Otherwise, the initial state will be `unknown`. -The component will accept the following states from your Alarm Panel (in lower case): +The integration will accept the following states from your Alarm Panel (in lower case): - `disarmed` - `armed_home` @@ -25,7 +25,7 @@ The component will accept the following states from your Alarm Panel (in lower c - `pending` - `triggered` -The component can control your Alarm Panel by publishing to the `command_topic` when a user interacts with the Home Assistant frontend. +The integration can control your Alarm Panel by publishing to the `command_topic` when a user interacts with the Home Assistant frontend. ## {% linkable_title Configuration %} diff --git a/source/_components/alarmdecoder.markdown b/source/_components/alarmdecoder.markdown index 1ca8c276b12..0bde582eaa7 100644 --- a/source/_components/alarmdecoder.markdown +++ b/source/_components/alarmdecoder.markdown @@ -20,7 +20,7 @@ redirect_from: - /components/sensor.alarmdecoder/ --- -The `alarmdecoder` 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 Nu Tech Software Solutions, known as the AlarmDecoder. The AlarmDecoder devices provide a serial, TCP/IP socket or USB interface to the alarm panel, where it emulates an alarm keypad. +The `alarmdecoder` integration 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 Nu Tech Software Solutions, known as the AlarmDecoder. The AlarmDecoder devices provide a serial, TCP/IP socket or USB interface to the alarm panel, where it emulates an alarm keypad. Please visit the [AlarmDecoder website](https://www.alarmdecoder.com/) for further information about the AlarmDecoder devices. @@ -138,7 +138,7 @@ There are several attributes available on the alarm panel to give you more infor ## {% linkable_title Services %} -The Alarm Decoder component gives you access to several services for you to control your alarm with. +The Alarm Decoder integration gives you access to several services for you to control your alarm with. - `alarm_arm_away`: Arms the alarm in away mode; all faults will trigger the alarm. - `alarm_arm_home`: Arms the alarm in stay mode; faults to the doors or windows will trigger the alarm. diff --git a/source/_components/alert.markdown b/source/_components/alert.markdown index e1d74c78cc0..0819c986319 100644 --- a/source/_components/alert.markdown +++ b/source/_components/alert.markdown @@ -14,8 +14,8 @@ ha_release: 0.38 ha_qa_scale: internal --- -The `alert` component is designed to notify you when problematic issues arise. -For example, if the garage door is left open, the `alert` component can be used +The `alert` integration is designed to notify you when problematic issues arise. +For example, if the garage door is left open, the `alert` integration can be used remind you of this by sending you repeating notifications at customizable intervals. This is also used for low battery sensors, water leak sensors, or any condition that may need your attention. @@ -25,7 +25,7 @@ This entity allows you to silence an alert until it is resolved. ### {% linkable_title Basic Example %} -The `alert` component makes use of any of the `notifications` components. To +The `alert` integration makes use of any of the `notifications` components. To setup the `alert` component, first, you must setup a `notification` component. Then, add the following to your configuration file: @@ -97,7 +97,7 @@ done_message: required: false type: template notifiers: - description: "List of `notification` components to use for alerts." + description: "List of `notification` integrations to use for alerts." required: true type: list data: @@ -145,7 +145,7 @@ alert: ### {% linkable_title Complex Alert Criteria %} -By design, the `alert` component only handles very simple criteria for firing. +By design, the `alert` integration only handles very simple criteria for firing. That is, it only checks if a single entity's state is equal to a value. At some point, it may be desirable to have an alert with a more complex criteria. Possibly, when a battery percentage falls below a threshold. Maybe you want to diff --git a/source/_components/alexa.intent.markdown b/source/_components/alexa.intent.markdown index cb31bb9acb9..7c2c9552c4e 100644 --- a/source/_components/alexa.intent.markdown +++ b/source/_components/alexa.intent.markdown @@ -16,7 +16,7 @@ ha_release: "0.10" ## {% linkable_title I want to build custom commands to use with Echo %} -The built-in Alexa component allows you to integrate Home Assistant into Alexa/Amazon Echo. This component will allow you to query information and call services within Home Assistant by using your voice. Home Assistant offers no built-in sentences but offers a framework for you to define your own. +The built-in Alexa integration allows you to integrate Home Assistant into Alexa/Amazon Echo. This integration will allow you to query information and call services within Home Assistant by using your voice. Home Assistant offers no built-in sentences but offers a framework for you to define your own.
@@ -90,7 +90,7 @@ This means that we can now ask Alexa things like: ## {% linkable_title Configuring Home Assistant %} -When activated, the Alexa component will have Home Assistant's native intent support handle the incoming intents. If you want to run actions based on intents, use the [`intent_script`](/components/intent_script) component. +When activated, the Alexa integration will have Home Assistant's native intent support handle the incoming intents. If you want to run actions based on intents, use the [`intent_script`](/components/intent_script) component. To enable Alexa, add the following entry to your `configuration.yaml` file: diff --git a/source/_components/alexa.smart_home.markdown b/source/_components/alexa.smart_home.markdown index 6a1bf1d8ed0..6aa184a6010 100644 --- a/source/_components/alexa.smart_home.markdown +++ b/source/_components/alexa.smart_home.markdown @@ -58,7 +58,7 @@ For Home Assistant Cloud Users, documentation can be found [here](https://www.na ### {% linkable_title Create Your Lambda Function %} -Alexa Smart Home skill will trigger a AWS Lambda function to process the request, we will write a small piece of code hosted as an Lambda function basically redirect the request to your Home Assistant instance, then Alexa integration component in Home Assistant will process the request and send back the response. Your Lambda function will delivery the response back to Alexa. +Alexa Smart Home skill will trigger a AWS Lambda function to process the request, we will write a small piece of code hosted as an Lambda function basically redirect the request to your Home Assistant instance, then Alexa integration integration in Home Assistant will process the request and send back the response. Your Lambda function will delivery the response back to Alexa.

There already are some great tutorials and solutions in our community to achieve same goal "Create your Alexa Smart Home Skill to connect Home Assistant", for example: [Haaska](https://github.com/mike-grant/haaska/wiki). diff --git a/source/_components/ambient_station.markdown b/source/_components/ambient_station.markdown index 25b8e2dfb09..26b1d44306f 100644 --- a/source/_components/ambient_station.markdown +++ b/source/_components/ambient_station.markdown @@ -14,12 +14,12 @@ redirect_from: - /components/sensor.ambient_station/ --- -The `Ambient Weather Station` component retrieves local weather information +The `Ambient Weather Station` integration retrieves local weather information via personal weather stations from [Ambient Weather](https://ambientweather.net). ## {% linkable_title Setup %} -Using this component requires both an Application Key and an API Key. To +Using this integration requires both an Application Key and an API Key. To generate both, simply utilize the profile section of [your Ambient Weather dashboard](https://dashboard.ambientweather.net). diff --git a/source/_components/amcrest.markdown b/source/_components/amcrest.markdown index b117f5f0157..8496955b831 100644 --- a/source/_components/amcrest.markdown +++ b/source/_components/amcrest.markdown @@ -177,7 +177,7 @@ documentation to install the `ffmpeg`. ## {% linkable_title Services %} -Once loaded, the `amcrest` component will expose services that can be called to perform various actions. The `entity_id` service attribute can specify one or more specific cameras, or `all` can be used to specify all configured Amcrest cameras. +Once loaded, the `amcrest` integration will expose services that can be called to perform various actions. The `entity_id` service attribute can specify one or more specific cameras, or `all` can be used to specify all configured Amcrest cameras. Available services: `enable_audio`, `disable_audio`, diff --git a/source/_components/android_ip_webcam.markdown b/source/_components/android_ip_webcam.markdown index 23db722ce76..82b75d0905a 100644 --- a/source/_components/android_ip_webcam.markdown +++ b/source/_components/android_ip_webcam.markdown @@ -23,7 +23,7 @@ redirect_from: - /components/switch.android_ip_webcam/ --- -The `android_ip_webcam` component turns any Android phone or tablet into a network camera with multiple viewing options. +The `android_ip_webcam` integration turns any Android phone or tablet into a network camera with multiple viewing options. It's setup as an MJPEG camera and all settings as switches inside of Home Assistant. You can also expose the sensors. If you have multiple phones, you can use all options inside a list. @@ -193,7 +193,7 @@ binary_sensor: ## {% linkable_title Camera %} -The `android_ip_webcam` component adds a camera by default if you choose not to use the component but still want to see the video feed then the [`mjpeg` camera](/components/camera.mjpeg/) platform can be used. +The `android_ip_webcam` integration adds a camera by default if you choose not to use the integration but still want to see the video feed then the [`mjpeg` camera](/components/camera.mjpeg/) platform can be used. ## {% linkable_title Configuration %} diff --git a/source/_components/androidtv.markdown b/source/_components/androidtv.markdown index 5a86571d339..c88704769a4 100644 --- a/source/_components/androidtv.markdown +++ b/source/_components/androidtv.markdown @@ -137,7 +137,7 @@ media_player: ## {% linkable_title ADB Setup %} -This component works by sending ADB commands to your Android TV / Fire TV device. There are two ways to accomplish this: +This integration works by sending ADB commands to your Android TV / Fire TV device. There are two ways to accomplish this: ### {% linkable_title 1. ADB Server %} @@ -180,7 +180,7 @@ If you receive the error message `Error while setting up platform androidtv` in * Your key is not pre-authenticated. Before using the `adbkey` in Home Assistant, you _**must**_ connect to your device using the ADB binary and tell it to always allow connections from this computer. For more information, see the section [ADB Authentication](#adb-authentication) above. - * Home Assistant does not have the appropriate permissions for the `adbkey` file and so it is not able to use it. Once you fix the permissions, the component should work. + * Home Assistant does not have the appropriate permissions for the `adbkey` file and so it is not able to use it. Once you fix the permissions, the integration should work. 4. Some Android TV devices (e.g., Philips TVs running Android TV) only accept the initial ADB connection request over their Wi-Fi interface. If you have the TV wired, you need to connect it to WiFi and try the initial connection again. Once the authentication has been granted via Wi-Fi, you can connect to the TV over the wired interface as well. diff --git a/source/_components/apcupsd.markdown b/source/_components/apcupsd.markdown index 24ba1f4e0fb..1c0c34eb34b 100644 --- a/source/_components/apcupsd.markdown +++ b/source/_components/apcupsd.markdown @@ -64,7 +64,7 @@ In addition to the [APCUPSd Sensor](#sensor) devices, you may also create a devi ### {% linkable_title Configuration %} -To enable this sensor, you first have to set up apcupsd component (above), and add the following lines to your `configuration.yaml` file: +To enable this sensor, you first have to set up apcupsd integration (above), and add the following lines to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -86,7 +86,7 @@ name: ### {% linkable_title Configuration %} -To use this sensor platform, you first have to set up apcupsd component (above), and add the following to your `configuration.yaml` file: +To use this sensor platform, you first have to set up apcupsd integration (above), and add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/api.markdown b/source/_components/api.markdown index 5a52ecaadc1..8f6415bbe0b 100644 --- a/source/_components/api.markdown +++ b/source/_components/api.markdown @@ -14,7 +14,7 @@ ha_qa_scale: internal ha_release: 0.7 --- -The `api` component exposes a RESTful API and allows one to interact with a Home Assistant instance that is running headless. This component depends on the [`http` component](/components/http/). +The `api` integration exposes a RESTful API and allows one to interact with a Home Assistant instance that is running headless. This integration depends on the [`http` component](/components/http/).

It is HIGHLY recommended that you set the `api_password`, especially if you are planning to expose your installation to the internet. diff --git a/source/_components/aprs.markdown b/source/_components/aprs.markdown index c01cfb3519b..ec90a7bcdee 100644 --- a/source/_components/aprs.markdown +++ b/source/_components/aprs.markdown @@ -13,7 +13,7 @@ ha_category: Presence Detection ha_iot_class: Cloud Push --- -The `aprs` [(Automatic Packet Reporting System)](https://en.wikipedia.org/wiki/Automatic_Packet_Reporting_System) device tracker component connects to the [APRS-IS](http://aprs-is.net/) network for tracking amateur radio devices. +The `aprs` [(Automatic Packet Reporting System)](https://en.wikipedia.org/wiki/Automatic_Packet_Reporting_System) device tracker integration connects to the [APRS-IS](http://aprs-is.net/) network for tracking amateur radio devices. ## {% linkable_title Configuration %} diff --git a/source/_components/aqualogic.markdown b/source/_components/aqualogic.markdown index dcfb0dc2814..ebfc8d3773a 100644 --- a/source/_components/aqualogic.markdown +++ b/source/_components/aqualogic.markdown @@ -19,7 +19,7 @@ redirect_from: - /components/switch.aqualogic/ --- -The AquaLogic component provides connectivity to a Hayward/Goldline AquaLogic/ProLogic pool controller. Note that an RS-485 to Ethernet adapter connected to the pool controller is required. +The AquaLogic integration provides connectivity to a Hayward/Goldline AquaLogic/ProLogic pool controller. Note that an RS-485 to Ethernet adapter connected to the pool controller is required. There is currently support for the following device types within Home Assistant: @@ -28,7 +28,7 @@ There is currently support for the following device types within Home Assistant: ## {% linkable_title Configuration %} -To add the AquaLogic component to your installation, add the following to your `configuration.yaml` file: +To add the AquaLogic integration to your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/arduino.markdown b/source/_components/arduino.markdown index 99730e999c1..f61098f5d30 100644 --- a/source/_components/arduino.markdown +++ b/source/_components/arduino.markdown @@ -25,7 +25,7 @@ The equipment depends on the [type](https://www.arduino.cc/en/Main/Products) of There are a lot of extensions (so-called [shields](https://www.arduino.cc/en/Main/ArduinoShields)) available. Those shields can be plugged-in into the existing connectors and stacked on top of each other. This makes it possible to expand the capabilities of the Arduino boards. -The `arduino` component is designed to let you use a directly attached board to your Home Assistant host over USB. +The `arduino` integration is designed to let you use a directly attached board to your Home Assistant host over USB. There is currently support for the following device types within Home Assistant: diff --git a/source/_components/arlo.markdown b/source/_components/arlo.markdown index 7093ead44b1..d7316c4a790 100644 --- a/source/_components/arlo.markdown +++ b/source/_components/arlo.markdown @@ -59,7 +59,7 @@ It is recommended to create a dedicated user on Arlo website to be used within H Finish its configuration by visiting the [Arlo sensor page](/components/sensor.arlo/) or [Arlo camera page](/components/camera.arlo/) or [Arlo control panel page](/components/alarm_control_panel.arlo/). Arlo also has a service call `arlo.update` that can be manually called to force an update prior to the regular scheduled interval. -The Arlo component also provides a camera service to enable/disable the motion detection sensor. The example below enables the motion detection every time the Home Assistant service starts. +The Arlo integration also provides a camera service to enable/disable the motion detection sensor. The example below enables the motion detection every time the Home Assistant service starts. ```yaml #automation.yaml @@ -142,7 +142,7 @@ More examples and configuration options can be found on the [Manual Alarm Contro ## {% linkable_title Camera %} -This component is not yet able to live stream from your Arlo camera, but it will be able to playback the last video capture. +This integration is not yet able to live stream from your Arlo camera, but it will be able to playback the last video capture. ### {% linkable_title Configuration %} diff --git a/source/_components/aruba.markdown b/source/_components/aruba.markdown index b2c9c179cf4..ab1b1ebacb9 100644 --- a/source/_components/aruba.markdown +++ b/source/_components/aruba.markdown @@ -52,4 +52,4 @@ password: type: string {% endconfiguration %} -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. diff --git a/source/_components/asterisk_mbox.markdown b/source/_components/asterisk_mbox.markdown index d3c39d744b4..ea9796d3b07 100644 --- a/source/_components/asterisk_mbox.markdown +++ b/source/_components/asterisk_mbox.markdown @@ -16,7 +16,7 @@ redirect_from: - /components/mailbox.asterisk_mbox/ --- -The `asterisk_mbox` Asterisk Voicemail integration for Home Assistant allows you to view, listen to, and delete voicemails from an Asterisk voicemail mailbox. The component includes a panel on the frontend that provides caller-id and speech-to-text transcription (using Google's API) of messages in addition to playback and message deletion. There is also an included sensor that indicates of the number of available messages. There is no requirement that the Asterisk PBX and Home Assistant are running on the same machine. +The `asterisk_mbox` Asterisk Voicemail integration for Home Assistant allows you to view, listen to, and delete voicemails from an Asterisk voicemail mailbox. The integration includes a panel on the frontend that provides caller-id and speech-to-text transcription (using Google's API) of messages in addition to playback and message deletion. There is also an included sensor that indicates of the number of available messages. There is no requirement that the Asterisk PBX and Home Assistant are running on the same machine. To enable the component, a configuration is required in both Home Assistant as well as on the Asterisk server. @@ -52,5 +52,5 @@ port: {% endconfiguration %}

-Communication between the Asterisk PBX server and the Home Assistant server is password-protected, but the data transmission is not encrypted. It is recommended to only use this component when communication is contained within a local area network. +Communication between the Asterisk PBX server and the Home Assistant server is password-protected, but the data transmission is not encrypted. It is recommended to only use this integration when communication is contained within a local area network.

diff --git a/source/_components/asuswrt.markdown b/source/_components/asuswrt.markdown index b887ca33fdf..f6ef9bcfef9 100644 --- a/source/_components/asuswrt.markdown +++ b/source/_components/asuswrt.markdown @@ -19,7 +19,7 @@ redirect_from: - /components/sensor.asuswrt/ --- -The `asuswrt` component is the main component to connect to a [ASUSWRT](http://event.asus.com/2013/nw/ASUSWRT/) based router. +The `asuswrt` integration is the main integration to connect to a [ASUSWRT](http://event.asus.com/2013/nw/ASUSWRT/) based router. There is currently support for the following device types within Home Assistant: @@ -120,7 +120,7 @@ The example above, creates the following sensors: ## {% linkable_title Padavan custom firmware (The rt-n56u project) %} -The [rt-n56u project](https://bitbucket.org/padavan/rt-n56u) does not store `dnsmasq.leases` which is used to track devices at `/var/lib/misc/` as `asuswrt` do. However this component can still be used for the rt-n56u project by linking `dnsmasq.leases` during the boot process of the router. +The [rt-n56u project](https://bitbucket.org/padavan/rt-n56u) does not store `dnsmasq.leases` which is used to track devices at `/var/lib/misc/` as `asuswrt` do. However this integration can still be used for the rt-n56u project by linking `dnsmasq.leases` during the boot process of the router. Follow these steps to setup the link. diff --git a/source/_components/august.markdown b/source/_components/august.markdown index e0465ae7c87..fb641c641c1 100644 --- a/source/_components/august.markdown +++ b/source/_components/august.markdown @@ -21,7 +21,7 @@ redirect_from: - /components/lock.august/ --- -The `august` component allows you to integrate your [August](http://august.com) devices in Home Assistant. +The `august` integration allows you to integrate your [August](http://august.com) devices in Home Assistant. There is currently support for the following device types within Home Assistant: diff --git a/source/_components/auth.markdown b/source/_components/auth.markdown index f824be4c2e3..044caa74c1e 100644 --- a/source/_components/auth.markdown +++ b/source/_components/auth.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Auth" -description: "This component is responsible for providing the authentication endpoints." +description: "This integration is responsible for providing the authentication endpoints." date: 2018-03-19 21:04 sidebar: true comments: false @@ -14,5 +14,5 @@ ha_release: 0.73 ha_qa_scale: internal --- -This component creates the endpoints for the [authentication system](/docs/authentication/) that is built into Home Assistant. -There are no configuration options for this component directly as it relies on the auth system in the core. +This integration creates the endpoints for the [authentication system](/docs/authentication/) that is built into Home Assistant. +There are no configuration options for this integration directly as it relies on the auth system in the core. diff --git a/source/_components/automatic.markdown b/source/_components/automatic.markdown index d61633029fe..cc3608be1c6 100644 --- a/source/_components/automatic.markdown +++ b/source/_components/automatic.markdown @@ -80,4 +80,4 @@ automation: You can obtain the correct ID for your vehicle from your known_devices.yaml file. Be sure to lower-case any letters contained in your vehicle's ID when using it in an automation trigger.

-See the [device tracker component page](/components/device_tracker/) for instructions how to configure the cars to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the cars to be tracked. diff --git a/source/_components/aws.markdown b/source/_components/aws.markdown index 3ae8e046576..42d8a5cff76 100644 --- a/source/_components/aws.markdown +++ b/source/_components/aws.markdown @@ -21,11 +21,11 @@ You have to have an AWS account to use Amazon Web Services, create one [here](ht The `lambda`, `sns` and `sqs` services, used in the `aws` component, all provide an **Always Free** tier for all users even after the 12-month period. The general usage in Home Automation will most likely not reach the free tier limit. Please read [Lambda Pricing](https://aws.amazon.com/lambda/pricing/), [SNS Pricing](https://aws.amazon.com/sns/pricing/) and [SQS Pricing](https://aws.amazon.com/sqs/pricing/) for more details. -The `aws` component is using [botocore](https://botocore.amazonaws.com/v1/documentation/api/latest/index.html) to communicate with Amazon Web Services, which is also used by the [AWS Command Client Interface](https://aws.amazon.com/cli/) tool. Therefore, `aws` shares the same credential and profiles with `awscli` tool. Please read [Configuring the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html) to learn how to get access keys and how to manage them on your local system securely. +The `aws` integration is using [botocore](https://botocore.amazonaws.com/v1/documentation/api/latest/index.html) to communicate with Amazon Web Services, which is also used by the [AWS Command Client Interface](https://aws.amazon.com/cli/) tool. Therefore, `aws` shares the same credential and profiles with `awscli` tool. Please read [Configuring the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html) to learn how to get access keys and how to manage them on your local system securely. ## {% linkable_title Configuration %} -To use the `aws` component and the `notify` platform in your installation, add the following to your `configuration.yaml` file: +To use the `aws` integration and the `notify` platform in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -35,7 +35,7 @@ aws: aws_access_key_id: AWS_ID aws_secret_access_key: AWS_SECRET notify: - # use the first credential defined in aws component by default + # use the first credential defined in aws integration by default - service: lambda region_name: us-east-1 ``` diff --git a/source/_components/azure_event_hub.markdown b/source/_components/azure_event_hub.markdown index 63c0219676e..7a000e4b5b4 100644 --- a/source/_components/azure_event_hub.markdown +++ b/source/_components/azure_event_hub.markdown @@ -13,7 +13,7 @@ ha_category: ha_release: 0.94 --- -The `Azure Event Hub` component allows you to hook into the Home Assistant event bus and send events to [Azure Event Hub](https://azure.microsoft.com/en-us/services/event-hubs/) or to a [Azure IoT Hub](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-messages-read-builtin). +The `Azure Event Hub` integration allows you to hook into the Home Assistant event bus and send events to [Azure Event Hub](https://azure.microsoft.com/en-us/services/event-hubs/) or to a [Azure IoT Hub](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-messages-read-builtin). ## {% linkable_title First time setup %} @@ -23,7 +23,7 @@ You need to create a Event Hub namespace and a Event Hub in that namespace, you You must then create a Shared Access Policy for the Event Hub with 'Send' claims or use the RootManageAccessKey from your namespace (this key has additional claims, including managing the event hub and listening, which are not needed for this purpose), for more details on the security of Event Hubs [go here](https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-authentication-and-security-model-overview). -Once you have the name of your namespace, instance, Shared Access Policy and the key for that policy, you can setup the component itself. +Once you have the name of your namespace, instance, Shared Access Policy and the key for that policy, you can setup the integration itself. ## {% linkable_title Configuration %} diff --git a/source/_components/bbb_gpio.markdown b/source/_components/bbb_gpio.markdown index 9fcfe4b5169..41456239c96 100644 --- a/source/_components/bbb_gpio.markdown +++ b/source/_components/bbb_gpio.markdown @@ -19,8 +19,8 @@ redirect_from: - /components/switch.bbb_gpio/ --- -The `bbb_gpio` component is the base for all [BeagleBone Black](https://beagleboard.org/black) related GPIO platforms in Home Assistant. -There is no setup needed for the component itself. +The `bbb_gpio` integration is the base for all [BeagleBone Black](https://beagleboard.org/black) related GPIO platforms in Home Assistant. +There is no setup needed for the integration itself. ## {% linkable_title Binary Sensor %} diff --git a/source/_components/bbox.markdown b/source/_components/bbox.markdown index 402228e8cc7..6cea270f529 100644 --- a/source/_components/bbox.markdown +++ b/source/_components/bbox.markdown @@ -61,7 +61,7 @@ host: For now and due to third party limitation, the Bbox must be on the same local network as the Home Assistant installation.

-See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. ## {% linkable_title Sensor %} diff --git a/source/_components/binary_sensor.knx.markdown b/source/_components/binary_sensor.knx.markdown index c0351d17788..6e5f40cde95 100644 --- a/source/_components/binary_sensor.knx.markdown +++ b/source/_components/binary_sensor.knx.markdown @@ -18,7 +18,7 @@ The `knx` sensor platform allows you to monitor [KNX](http://www.knx.org) binary ## {% linkable_title Configuration %} -The `knx` component must be configured correctly, see [KNX Component](/components/knx). +The `knx` integration must be configured correctly, see [KNX Component](/components/knx). ```yaml # Example configuration.yaml entry diff --git a/source/_components/binary_sensor.rflink.markdown b/source/_components/binary_sensor.rflink.markdown index 11426bff5e6..af278eaac7c 100644 --- a/source/_components/binary_sensor.rflink.markdown +++ b/source/_components/binary_sensor.rflink.markdown @@ -14,11 +14,11 @@ ha_iot_class: Local Push ha_release: 0.81 --- -The `rflink` component supports devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver). +The `rflink` integration supports devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver). First, you have to set up your [RFLink hub](/components/rflink/). -The RFLink component does not know the difference between a `binary_sensor`, a `switch` and a `light`. Therefore all switchable devices are automatically added as `light` by default. +The RFLink integration does not know the difference between a `binary_sensor`, a `switch` and a `light`. Therefore all switchable devices are automatically added as `light` by default. RFLink binary_sensor/switch/light ID's are composed of: protocol, id, switch/channel. For example: `newkaku_0000c6c2_1`. diff --git a/source/_components/binary_sensor.rfxtrx.markdown b/source/_components/binary_sensor.rfxtrx.markdown index 1049752bb7c..2770ffc60a3 100644 --- a/source/_components/binary_sensor.rfxtrx.markdown +++ b/source/_components/binary_sensor.rfxtrx.markdown @@ -15,12 +15,12 @@ ha_release: 0.48 The `rfxtrx` platform support binary sensors that communicate in the frequency range of 433.92 MHz. -The rfxtrx binary sensor component provides support for them. +The rfxtrx binary sensor integration provides support for them. Many cheap sensors available on the web today are based on a particular RF chip called *PT-2262*. Depending on the running firmware on the RFXcom box, some of them may be recognized under the X10 protocol but most of them are recognized -under the *Lighting4* protocol. The rfxtrx binary sensor component provides +under the *Lighting4* protocol. The rfxtrx binary sensor integration provides some special options for them, while other rfxtrx protocols should work too. ## {% linkable_title Setting up your devices %} @@ -95,7 +95,7 @@ automatic_add: {% endconfiguration %}

-This component and the [rfxtrx switch](/components/switch/rfxtrx/) can steal each other's devices when setting the `automatic_add` configuration parameter to `true`. +This integration and the [rfxtrx switch](/components/switch/rfxtrx/) can steal each other's devices when setting the `automatic_add` configuration parameter to `true`. Set `automatic_add` only when you have some devices to add to your installation, otherwise leave it to `false`.

@@ -188,7 +188,7 @@ devices: command_off: 0x7 ``` -The *automatic_add* option makes the rfxtrx binary sensor component calculate +The *automatic_add* option makes the rfxtrx binary sensor integration calculate and display the configuration options for you in the Home Assistant logs: ```text diff --git a/source/_components/binary_sensor.xiaomi_aqara.markdown b/source/_components/binary_sensor.xiaomi_aqara.markdown index 30ee1d358cd..0933d4e0fab 100644 --- a/source/_components/binary_sensor.xiaomi_aqara.markdown +++ b/source/_components/binary_sensor.xiaomi_aqara.markdown @@ -186,7 +186,7 @@ As indicated in the table on top of this page there are 3 versions of the button #### {% linkable_title Xiaomi Cube %} -Available events are `flip90`, `flip180`, `move`, `tap_twice`, `shake_air`, `swing`, `alert`, `free_fall` and `rotate`. The component stores the last action as the attribute `last_action`. +Available events are `flip90`, `flip180`, `move`, `tap_twice`, `shake_air`, `swing`, `alert`, `free_fall` and `rotate`. The integration stores the last action as the attribute `last_action`. ```yaml - alias: Cube event flip90 diff --git a/source/_components/blink.markdown b/source/_components/blink.markdown index 483831ff3c7..72f1dc651ab 100644 --- a/source/_components/blink.markdown +++ b/source/_components/blink.markdown @@ -23,7 +23,7 @@ redirect_from: - /components/sensor.blink/ --- -The `blink` component lets you view camera images and motion events from [Blink](http://blinkforhome.com) camera and security systems. +The `blink` integration lets you view camera images and motion events from [Blink](http://blinkforhome.com) camera and security systems. ## {% linkable_title Setup %} @@ -85,7 +85,7 @@ mode: default: not set {% endconfiguration %} -Once Home Assistant starts, the `blink` component will create the following platforms: +Once Home Assistant starts, the `blink` integration will create the following platforms: - An `alarm_control_panel` to arm/disarm the whole blink system (note, `alarm_arm_home` is not implemented and will not actually do anything, despite it being an option in the GUI). - A `camera` for each camera linked to your Blink sync module. diff --git a/source/_components/bloomsky.markdown b/source/_components/bloomsky.markdown index 6f99dce63d5..fb698d76d57 100644 --- a/source/_components/bloomsky.markdown +++ b/source/_components/bloomsky.markdown @@ -19,7 +19,7 @@ redirect_from: - /components/binary_sensor.bloomsky/ --- -The `bloomsky` component allows you to access your [BloomSky](https://www.bloomsky.com/) weather station's. +The `bloomsky` integration allows you to access your [BloomSky](https://www.bloomsky.com/) weather station's. There is currently support for the following device types within Home Assistant: @@ -81,11 +81,11 @@ monitored_conditions: ## {% linkable_title Camera %} -The `bloomsky` camera component allows you to view the current photo created by the camera in the [BloomSky](https://www.bloomsky.com) weather station. This can work in concert with [BloomSky sensors](#sensor). +The `bloomsky` camera integration allows you to view the current photo created by the camera in the [BloomSky](https://www.bloomsky.com) weather station. This can work in concert with [BloomSky sensors](#sensor). ### {% linkable_title Configuration %} -To enable this camera in your installation, set up the BloomSky component with your API key and add the following to your `configuration.yaml` file: +To enable this camera in your installation, set up the BloomSky integration with your API key and add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -95,11 +95,11 @@ camera: ## {% linkable_title Sensor %} -The `bloomsky` sensor component allows you to view the measurements made by sensors in the [BloomSky](https://www.bloomsky.com) weather station. This can work in concert with the [BloomSky camera](#camera). +The `bloomsky` sensor integration allows you to view the measurements made by sensors in the [BloomSky](https://www.bloomsky.com) weather station. This can work in concert with the [BloomSky camera](#camera). ### {% linkable_title Configuration %} -To enable these sensors in your installation, set up the BloomSky component with your API key add the following to your `configuration.yaml` file: +To enable these sensors in your installation, set up the BloomSky integration with your API key add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/bluesound.markdown b/source/_components/bluesound.markdown index 8e1b4f1b972..e52956fde09 100644 --- a/source/_components/bluesound.markdown +++ b/source/_components/bluesound.markdown @@ -16,7 +16,7 @@ redirect_from: - /components/media_player.bluesound/ --- -The `bluesound` platform allows you to control your [Bluesound](http://www.bluesound.com/) HiFi wireless speakers and audio components from Home Assistant. +The `bluesound` platform allows you to control your [Bluesound](http://www.bluesound.com/) HiFi wireless speakers and audio integrations from Home Assistant. If you want to automatically discover new devices, just make sure you have discovery: in your configuration.yaml file. To manually add a Bluesound device to your installation, add the following to your configuration.yaml file: diff --git a/source/_components/bme680.markdown b/source/_components/bme680.markdown index 579da0493fa..ada45594307 100644 --- a/source/_components/bme680.markdown +++ b/source/_components/bme680.markdown @@ -99,7 +99,7 @@ gas_heater_duration: default: 150 type: integer aq_burn_in_time: - description: The duration to perform gas resistance measurements to establish a stable baseline measurements for Air Quality calculations in seconds. The burn in time is only performed when the sensor component is first initialized. + description: The duration to perform gas resistance measurements to establish a stable baseline measurements for Air Quality calculations in seconds. The burn in time is only performed when the sensor integration is first initialized. required: false default: 300 type: integer diff --git a/source/_components/bmw_connected_drive.markdown b/source/_components/bmw_connected_drive.markdown index b3d8f82384b..f3b96b9aa51 100644 --- a/source/_components/bmw_connected_drive.markdown +++ b/source/_components/bmw_connected_drive.markdown @@ -22,13 +22,13 @@ redirect_from: - /components/sensor.bmw_connected_drive/ --- -The `bmw_connected_drive` component lets you retrieve data of your BMW vehicle from the BMW Connected Drive portal. You need to have a working BMW Connected Drive account, and a Connected Drive enabled vehicle for this to work. +The `bmw_connected_drive` integration lets you retrieve data of your BMW vehicle from the BMW Connected Drive portal. You need to have a working BMW Connected Drive account, and a Connected Drive enabled vehicle for this to work. -The `bmw_connected_drive` component also works with (recent) Mini vehicles. You need to have a working Mini Connected account, and a Mini Connected enabled vehicle for this to work. +The `bmw_connected_drive` integration also works with (recent) Mini vehicles. You need to have a working Mini Connected account, and a Mini Connected enabled vehicle for this to work. For compatibility with your BMW vehicle check the [bimmer_connected page](https://github.com/m1n3rva/bimmer_connected) on github. -This component provides the following platforms: +This integration provides the following platforms: - Binary Sensors: Doors, windows, condition based services, check control messages, parking lights, door lock state, charging status (electric cars) and connections status (electric cars). - Device tracker: The location of your car. @@ -38,7 +38,7 @@ This component provides the following platforms: ## {% linkable_title Configuration %} -To enable this component in your installation, add the following to your +To enable this integration in your installation, add the following to your `configuration.yaml` file: ```yaml @@ -81,13 +81,13 @@ bmw_connected_drive: ## {% linkable_title Services %} -The `bmw_connected_drive` component offers several services. In case you need to provide the vehicle identification number (VIN) as a parameter, you can see the VIN in the attributes of the device tracker for the vehicle. The VIN is a 17 digit alphanumeric string, e.g., `WBANXXXXXX1234567`. +The `bmw_connected_drive` integration offers several services. In case you need to provide the vehicle identification number (VIN) as a parameter, you can see the VIN in the attributes of the device tracker for the vehicle. The VIN is a 17 digit alphanumeric string, e.g., `WBANXXXXXX1234567`. Using these services will impact the state of your vehicle. So use these services with care! ### {% linkable_title Locking and unlocking %} -The vehicle can be locked and unlocked via the lock component that is created automatically for each vehicle. Before invoking these services, make sure it's safe to lock/unlock the vehicle in the current situation. +The vehicle can be locked and unlocked via the lock integration that is created automatically for each vehicle. Before invoking these services, make sure it's safe to lock/unlock the vehicle in the current situation. ### {% linkable_title Air condition %} diff --git a/source/_components/browser.markdown b/source/_components/browser.markdown index c0a1501a0f6..be89e2b0fc5 100644 --- a/source/_components/browser.markdown +++ b/source/_components/browser.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Browser" -description: "Instructions on how to setup the browser component with Home Assistant." +description: "Instructions on how to setup the browser integration with Home Assistant." date: 2015-01-24 14:39 sidebar: true comments: false @@ -14,7 +14,7 @@ ha_qa_scale: internal ha_release: pre 0.7 --- -The `browser` component provides a service to open URLs in the default browser on the host machine. +The `browser` integration provides a service to open URLs in the default browser on the host machine. ## {% linkable_title Configuration %} diff --git a/source/_components/brunt.markdown b/source/_components/brunt.markdown index f1b62530d9d..3077d4388f8 100644 --- a/source/_components/brunt.markdown +++ b/source/_components/brunt.markdown @@ -46,5 +46,5 @@ password: {% endconfiguration %}

-This component is not affiliated with Brunt and retrieves data from the endpoints of the mobile application. Use at your own risk. +This integration is not affiliated with Brunt and retrieves data from the endpoints of the mobile application. Use at your own risk.

diff --git a/source/_components/bt_home_hub_5.markdown b/source/_components/bt_home_hub_5.markdown index 3b18f59ce59..ec1326906fa 100644 --- a/source/_components/bt_home_hub_5.markdown +++ b/source/_components/bt_home_hub_5.markdown @@ -34,4 +34,4 @@ host: type: string {% endconfiguration %} -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. diff --git a/source/_components/bt_smarthub.markdown b/source/_components/bt_smarthub.markdown index 4c60da14f48..e78c068af05 100644 --- a/source/_components/bt_smarthub.markdown +++ b/source/_components/bt_smarthub.markdown @@ -37,4 +37,4 @@ host: type: string {% endconfiguration %} -See the [device tracker component page](/components/device_tracker/) for instructions on how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions on how to configure the people to be tracked. diff --git a/source/_components/buienradar.markdown b/source/_components/buienradar.markdown index 67056c84e15..88d54720c6e 100644 --- a/source/_components/buienradar.markdown +++ b/source/_components/buienradar.markdown @@ -32,15 +32,15 @@ weather: {% configuration %} name: - description: "You can specify a name of the component, but do not have to. If you specify a name, the weather component will get an entity name of `weather.[name]`; if no name is specified, it will try to set its name to `weather.BR_[stationname]`. However at the moment in time, the entity is created, no data has been retrieved yet, so the entity will get named `weather.BR_unknown_station`. Later the station name will be known and get updated, but the entity name remains." + description: "You can specify a name of the component, but do not have to. If you specify a name, the weather integration will get an entity name of `weather.[name]`; if no name is specified, it will try to set its name to `weather.BR_[stationname]`. However at the moment in time, the entity is created, no data has been retrieved yet, so the entity will get named `weather.BR_unknown_station`. Later the station name will be known and get updated, but the entity name remains." required: false type: string latitude: - description: Latitude to use for selection of data source location. Longitude and latitude will be taken from Home Assistant configuration but can be overridden/changed in this component to select a different location for Buienradar. + description: Latitude to use for selection of data source location. Longitude and latitude will be taken from Home Assistant configuration but can be overridden/changed in this integration to select a different location for Buienradar. required: false type: float longitude: - description: Longitude to use for selection of data source location. Longitude and latitude will be taken from Home Assistant configuration but can be overridden/changed in this component to select a different location for Buienradar. + description: Longitude to use for selection of data source location. Longitude and latitude will be taken from Home Assistant configuration but can be overridden/changed in this integration to select a different location for Buienradar. required: false type: float forecast: diff --git a/source/_components/caldav.markdown b/source/_components/caldav.markdown index 4116c6122a7..62d911f705a 100644 --- a/source/_components/caldav.markdown +++ b/source/_components/caldav.markdown @@ -24,8 +24,8 @@ The WebDav calendar get updated roughly every 15 minutes. ### {% linkable_title Prerequisites %} -You need to have a CalDav server and credentials for it. This component was -tested against [Baikal](http://sabre.io/baikal/) but any component complying +You need to have a CalDav server and credentials for it. This integration was +tested against [Baikal](http://sabre.io/baikal/) but any integration complying with the RFC4791 should work. [Nextcloud](https://nextcloud.com/) and [Owncloud](https://owncloud.org/) work fine. diff --git a/source/_components/calendar.google.markdown b/source/_components/calendar.google.markdown index 41405af7e3a..680dd184974 100644 --- a/source/_components/calendar.google.markdown +++ b/source/_components/calendar.google.markdown @@ -17,7 +17,7 @@ ha_release: 0.33 The `google` calendar platform allows you to connect to your [Google Calendars](https://calendar.google.com) and generate binary sensors. The sensors created can trigger based on any event on the calendar or only for -matching events. When you first setup this component it will generate a new +matching events. When you first setup this integration it will generate a new configuration file `google_calendars.yaml` that will contain information about all of the calendars you can see. It also exposes a service to add an event to one of your Google Calendars. @@ -177,7 +177,7 @@ Otherwise everything following the hash sign would be considered a YAML comment. ### {% linkable_title Service `google.add_event` %} -You can use the service `google.add_event` to create a new calendar event in a calendar. Calendar id's can be found in the file `google_calendars.yaml`. All dates and times are in your local time, the component gets your time zone from your `configuration.yaml` file. +You can use the service `google.add_event` to create a new calendar event in a calendar. Calendar id's can be found in the file `google_calendars.yaml`. All dates and times are in your local time, the integration gets your time zone from your `configuration.yaml` file. | Service data attribute | Optional | Description | Example | | ---------------------- | -------- | ----------- | --------| diff --git a/source/_components/calendar.markdown b/source/_components/calendar.markdown index 8c44c4c68e0..921aadb1d48 100644 --- a/source/_components/calendar.markdown +++ b/source/_components/calendar.markdown @@ -10,4 +10,4 @@ footer: true ha_release: 0.33 --- -The calendar component allows you to integrate your calendars into Home Assistant. +The calendar integration allows you to integrate your calendars into Home Assistant. diff --git a/source/_components/camera.markdown b/source/_components/camera.markdown index a8a4b967042..8df12502fdd 100644 --- a/source/_components/camera.markdown +++ b/source/_components/camera.markdown @@ -14,11 +14,11 @@ ha_qa_scale: internal ha_release: 0.7 --- -The camera component allows you to use IP cameras with Home Assistant. +The camera integration allows you to use IP cameras with Home Assistant. ### {% linkable_title Streaming Video %} -If your camera supports it, and the [`stream`](/components/stream) component is setup, you will be able to stream your cameras in the frontend and on supported media players. +If your camera supports it, and the [`stream`](/components/stream) integration is setup, you will be able to stream your cameras in the frontend and on supported media players. This option will keep the stream alive, and preload the feed on Home Assistant startup. This will result in reduced latency when opening the stream in the frontend, as well as when using the `play_stream` service or Google Assistant integration. It does, however, utilize more resources on your machine, so it is recommended to check CPU usage if you plan to use this feature. @@ -36,13 +36,13 @@ Available services: `turn_on`, `turn_off`, `enable_motion_detection`, `disable_m #### {% linkable_title Service `play_stream` %} -Play a live stream from a camera to selected media player(s). Requires [`stream`](/components/stream) component to be set up. +Play a live stream from a camera to selected media player(s). Requires [`stream`](/components/stream) integration to be set up. | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | | `entity_id` | no | Name of entity to fetch stream from, e.g., `camera.living_room_camera`. | | `media_player` | no | Name of media player to play stream on, e.g., `media_player.living_room_tv`. | -| `format` | yes | Stream format supported by `stream` component and selected `media_player`. Default: `hls` | +| `format` | yes | Stream format supported by `stream` integration and selected `media_player`. Default: `hls` | For example, the following action in an automation would send an `hls` live stream to your chromecast. @@ -111,7 +111,7 @@ action: #### {% linkable_title Service `record` %} -Make a `.mp4` recording from a camera stream. Requires `stream` component to be set up. +Make a `.mp4` recording from a camera stream. Requires `stream` integration to be set up. Both `duration` and `lookback` options are suggestions, but should be consistent per camera. The actual length of the recording may vary. It is suggested that you tweak these settings to fit your needs. diff --git a/source/_components/canary.markdown b/source/_components/canary.markdown index 18ec9e71c7e..2ead4902559 100644 --- a/source/_components/canary.markdown +++ b/source/_components/canary.markdown @@ -20,7 +20,7 @@ redirect_from: - /components/sensor.canary/ --- -The `canary` component allows you to integrate your [Canary](https://canary.is) devices in Home Assistant. +The `canary` integration allows you to integrate your [Canary](https://canary.is) devices in Home Assistant. There is currently support for the following device types within Home Assistant: diff --git a/source/_components/cast.markdown b/source/_components/cast.markdown index 8bec9f32f5b..8fac5fb601c 100644 --- a/source/_components/cast.markdown +++ b/source/_components/cast.markdown @@ -18,12 +18,12 @@ redirect_from: /components/media_player.cast/ Google Cast devices like Android TVs and Chromecasts will be automatically discovered if you enable [the discovery component](/components/discovery/). If -you don't have the discovery component enabled, you can enable the Cast +you don't have the discovery integration enabled, you can enable the Cast component by going to the Integrations page inside the config panel. ## {% linkable_title Advanced use %} -The Cast component has some extra configuration options available for advanced +The Cast integration has some extra configuration options available for advanced users. You will still need to create a config entry to initialize the Cast component. diff --git a/source/_components/cisco_ios.markdown b/source/_components/cisco_ios.markdown index a51701b2de4..9a33ccc101a 100644 --- a/source/_components/cisco_ios.markdown +++ b/source/_components/cisco_ios.markdown @@ -75,4 +75,4 @@ password: type: string {% endconfiguration %} -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. diff --git a/source/_components/cisco_mobility_express.markdown b/source/_components/cisco_mobility_express.markdown index 8260e3d26c5..f5878c778d4 100644 --- a/source/_components/cisco_mobility_express.markdown +++ b/source/_components/cisco_mobility_express.markdown @@ -51,4 +51,4 @@ verify_ssl: type: boolean {% endconfiguration %} -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. diff --git a/source/_components/clementine.markdown b/source/_components/clementine.markdown index 2d5f57bd85d..3152d3859ac 100644 --- a/source/_components/clementine.markdown +++ b/source/_components/clementine.markdown @@ -52,4 +52,4 @@ Remember that Clementine must be configured to accept connections through its ne You can configure this through Clementine `Tools > Preferences > Network remote control` configuration menu. Enable `Use network remote control` and configure the other options for your use case. -This component does not implement the `play_media` service so you cannot add tracks to the playlist. +This integration does not implement the `play_media` service so you cannot add tracks to the playlist. diff --git a/source/_components/climate.knx.markdown b/source/_components/climate.knx.markdown index f99b2b3bd38..f7f7ba2063d 100644 --- a/source/_components/climate.knx.markdown +++ b/source/_components/climate.knx.markdown @@ -16,7 +16,7 @@ ha_iot_class: Local Polling The `knx` climate platform is used as in interface with KNX thermostats. -The `knx` component must be configured correctly, see [KNX Component](/components/knx). +The `knx` integration must be configured correctly, see [KNX Component](/components/knx). To use your KNX thermostats in your installation, add the following lines to your `configuration.yaml` file: diff --git a/source/_components/climate.markdown b/source/_components/climate.markdown index 131d13309b4..d19d54f49c6 100644 --- a/source/_components/climate.markdown +++ b/source/_components/climate.markdown @@ -14,7 +14,7 @@ ha_qa_scale: internal ha_release: 0.19 --- -The `climate` component is built for the controlling and monitoring of HVAC (heating, ventilating, and air conditioning) and thermostat devices. +The `climate` integration is built for the controlling and monitoring of HVAC (heating, ventilating, and air conditioning) and thermostat devices. ## {% linkable_title Services %} diff --git a/source/_components/climate.mysensors.markdown b/source/_components/climate.mysensors.markdown index 31259de0e55..a2979394e0b 100644 --- a/source/_components/climate.mysensors.markdown +++ b/source/_components/climate.mysensors.markdown @@ -25,7 +25,7 @@ S_TYPE | V_TYPE -------|----------------------------------------------------------------------------- S_HVAC | V_HVAC_FLOW_STATE*, V_HVAC_SETPOINT_HEAT, V_HVAC_SETPOINT_COOL, V_HVAC_SPEED, V_TEMP -V_HVAC_FLOW_STATE is mapped to the state of the Climate component in Home Assistant as follows: +V_HVAC_FLOW_STATE is mapped to the state of the Climate integration in Home Assistant as follows: Home Assistant State | MySensors State ---------------------|---------------- diff --git a/source/_components/cloudflare.markdown b/source/_components/cloudflare.markdown index 548db436602..5334b6a996a 100644 --- a/source/_components/cloudflare.markdown +++ b/source/_components/cloudflare.markdown @@ -13,9 +13,9 @@ ha_category: ha_release: 0.74 --- -With the `cloudflare` component can you keep your Cloudflare records up to date. +With the `cloudflare` integration can you keep your Cloudflare records up to date. -The component will run every hour, but can also be started manually by using the service `cloudflare.update_records` under services. +The integration will run every hour, but can also be started manually by using the service `cloudflare.update_records` under services. ## {% linkable_title Setup %} @@ -23,7 +23,7 @@ You will find your global API key in your Cloudflare account settings. ## {% linkable_title Configuration %} -To use the component in your installation, add the following to your `configuration.yaml` file: +To use the integration in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/coinbase.markdown b/source/_components/coinbase.markdown index 42a289aadc4..18bd47eb656 100644 --- a/source/_components/coinbase.markdown +++ b/source/_components/coinbase.markdown @@ -17,9 +17,9 @@ redirect_from: - /components/sensor.coinbase/ --- -The `coinbase` component lets you access account balances and exchange rates from [coinbase](https://coinbase.com). +The `coinbase` integration lets you access account balances and exchange rates from [coinbase](https://coinbase.com). -You will need to obtain an API key from coinbase's [developer site](https://www.coinbase.com/settings/api) to use this component. You need to give read access to `wallet:accounts` in order for the component to access relevant data. +You will need to obtain an API key from coinbase's [developer site](https://www.coinbase.com/settings/api) to use this component. You need to give read access to `wallet:accounts` in order for the integration to access relevant data. ## {% linkable_title Configuration %} diff --git a/source/_components/comfoconnect.markdown b/source/_components/comfoconnect.markdown index 7fe631538dc..da74d90b9d7 100644 --- a/source/_components/comfoconnect.markdown +++ b/source/_components/comfoconnect.markdown @@ -17,14 +17,14 @@ redirect_from: - /components/sensor.comfoconnect/ --- -The `comfoconnect` component lets you control Zehnder ComfoAir [Q350](http://www.international.zehnder-systems.com/products-and-systems/comfosystems/zehnder-comfoair-q350-st)/[450](http://www.international.zehnder-systems.com/products-and-systems/comfosystems/zehnder-comfoair-q450-st)/[600](http://www.international.zehnder-systems.com/products-and-systems/comfosystems/zehnder-comfoair-q600-st) +The `comfoconnect` integration lets you control Zehnder ComfoAir [Q350](http://www.international.zehnder-systems.com/products-and-systems/comfosystems/zehnder-comfoair-q350-st)/[450](http://www.international.zehnder-systems.com/products-and-systems/comfosystems/zehnder-comfoair-q450-st)/[600](http://www.international.zehnder-systems.com/products-and-systems/comfosystems/zehnder-comfoair-q600-st) ventilation units from Home Assistant. You need a [ComfoConnect LAN C](http://www.zehnder.co.uk/products-and-systems/comfortable-indoor-ventilation/ms-comfoair-q/ideal-control#node-21233) bridge to connect the unit to your local network. There is an official iPhone and Android app to configure and control your unit. This platform connects with the help of the unofficial [pycomfoconnect](https://github.com/michaelarnauts/comfoconnect) library. -The component has a fan platform to view and control the ventilation speed, and a sensors platform to read out the outdoor temperature and humidity, the indoor temperature and humidity, and the extract and supply air flow (in m³ per hour). +The integration has a fan platform to view and control the ventilation speed, and a sensors platform to read out the outdoor temperature and humidity, the indoor temperature and humidity, and the extract and supply air flow (in m³ per hour). To set it up, add the following information to your `configuration.yaml` file: @@ -75,5 +75,5 @@ sensor: ```

-Note that it's not possible to have multiple connection to the bridge at the same time. This component will keep the connection open, and if you open the app, it will ask you to disconnect Home Assistant. If you close the app again, Home Assistant will reconnect automatically. +Note that it's not possible to have multiple connection to the bridge at the same time. This integration will keep the connection open, and if you open the app, it will ask you to disconnect Home Assistant. If you close the app again, Home Assistant will reconnect automatically.

diff --git a/source/_components/config.markdown b/source/_components/config.markdown index 46613b40517..bee75a2f332 100644 --- a/source/_components/config.markdown +++ b/source/_components/config.markdown @@ -14,7 +14,7 @@ ha_release: 0.39 ha_qa_scale: internal --- -The `config` component is designed to display panels in the frontend to configure and manage parts of Home Assistant. +The `config` integration is designed to display panels in the frontend to configure and manage parts of Home Assistant. To enable the configuration panel, add the following to your `configuration.yaml` file: diff --git a/source/_components/configurator.markdown b/source/_components/configurator.markdown index 1778daa4ee7..cba5fe0f76f 100644 --- a/source/_components/configurator.markdown +++ b/source/_components/configurator.markdown @@ -15,15 +15,15 @@ ha_release: 0.7 ---

-This component is intended for developers. +This integration is intended for developers.

-The configurator component allows components to request information from the user. It is currently implemented as the minimum viable product: +The configurator integration allows integrations to request information from the user. It is currently implemented as the minimum viable product: - It supports showing a text, image and button to the user - Input fields can be defined with a description, and optional type - It will trigger a callback when the button is pressed -The Hue component in [the demo](/demo) and Plex are implemented using the configurator. See [the source of the demo component](https://github.com/home-assistant/home-assistant/tree/dev/homeassistant/components/demo) for a simple example. +The Hue integration in [the demo](/demo) and Plex are implemented using the configurator. See [the source of the demo component](https://github.com/home-assistant/home-assistant/tree/dev/homeassistant/components/demo) for a simple example. See [the source](https://github.com/home-assistant/home-assistant/tree/dev/homeassistant/components/configurator) for more details on how to use the configurator component. diff --git a/source/_components/conversation.markdown b/source/_components/conversation.markdown index 511a5de5aae..48817f6d338 100644 --- a/source/_components/conversation.markdown +++ b/source/_components/conversation.markdown @@ -14,7 +14,7 @@ ha_qa_scale: internal ha_release: 0.7 --- -The conversation component allows you to converse with Home Assistant. You can either converse by pressing the microphone in the frontend (supported browsers only (no iOS)) or by calling the `conversation/process` service with the transcribed text. +The conversation integration allows you to converse with Home Assistant. You can either converse by pressing the microphone in the frontend (supported browsers only (no iOS)) or by calling the `conversation/process` service with the transcribed text.

@@ -28,7 +28,7 @@ conversation: {% configuration %} intents: - description: Intents that the conversation component should understand. + description: Intents that the conversation integration should understand. required: false type: map keys: diff --git a/source/_components/counter.markdown b/source/_components/counter.markdown index db9702990c4..2ecc7ea4a31 100644 --- a/source/_components/counter.markdown +++ b/source/_components/counter.markdown @@ -14,7 +14,7 @@ ha_release: 0.53 ha_qa_scale: internal --- -The `counter` component allows one to count occurrences fired by automations. +The `counter` integration allows one to count occurrences fired by automations. ## {% linkable_title Configuration %} @@ -72,7 +72,7 @@ Pick an icon that you can find on [materialdesignicons.com](https://materialdesi ### {% linkable_title Restore State %} -This component will automatically restore the state it had prior to Home Assistant stopping as long as you your entity has `restore` set to `true` which is the default. To disable this feature, set `restore` to `false`. +This integration will automatically restore the state it had prior to Home Assistant stopping as long as you your entity has `restore` set to `true` which is the default. To disable this feature, set `restore` to `false`. If `restore` is set to `false`, the `initial` value will only be used when no previous state is found or when the counter is reset. diff --git a/source/_components/cover.knx.markdown b/source/_components/cover.knx.markdown index 77c17dd6d3d..0c93ae37070 100644 --- a/source/_components/cover.knx.markdown +++ b/source/_components/cover.knx.markdown @@ -17,7 +17,7 @@ ha_iot_class: Local Polling The `knx` cover platform is used as in interface with KNX covers. -The `knx` component must be configured correctly, see [KNX Component](/components/knx). +The `knx` integration must be configured correctly, see [KNX Component](/components/knx). To use your KNX covers in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/cover.rflink.markdown b/source/_components/cover.rflink.markdown index 5ad0066782a..06fd87054b0 100644 --- a/source/_components/cover.rflink.markdown +++ b/source/_components/cover.rflink.markdown @@ -14,7 +14,7 @@ ha_release: 0.55 --- -The `rflink` component supports devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver). +The `rflink` integration supports devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver). First, you have to set up your [RFLink hub](/components/rflink/). diff --git a/source/_components/cover.template.markdown b/source/_components/cover.template.markdown index 5f1188e5493..3c0cfc690d6 100644 --- a/source/_components/cover.template.markdown +++ b/source/_components/cover.template.markdown @@ -15,7 +15,7 @@ logo: home-assistant.png ha_qa_scale: internal --- -The `template` platform can create covers that combine components and provides +The `template` platform can create covers that combine integrations and provides the ability to run scripts or invoke services for each of the open, close, stop, position and tilt commands of a cover. diff --git a/source/_components/cppm.markdown b/source/_components/cppm.markdown index db74e277978..bdfb9c5b6b2 100644 --- a/source/_components/cppm.markdown +++ b/source/_components/cppm.markdown @@ -50,4 +50,4 @@ api_key: type: string {% endconfiguration %} -See the [device tracker component page](/components/device_tracker/) for instructions on how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions on how to configure the people to be tracked. diff --git a/source/_components/daikin.markdown b/source/_components/daikin.markdown index 55079e1a5cf..4da14c4ff84 100644 --- a/source/_components/daikin.markdown +++ b/source/_components/daikin.markdown @@ -20,7 +20,7 @@ redirect_from: - /components/sensor.daikin/ --- -The `daikin` component integrates Daikin air conditioning systems into Home Assistant. +The `daikin` integration integrates Daikin air conditioning systems into Home Assistant. There is currently support for the following device types within Home Assistant: @@ -36,7 +36,7 @@ There is currently support for the following device types within Home Assistant: ## {% linkable_title Configuration %} -The Daikin component can be configured in three ways. +The Daikin integration can be configured in three ways. - Automatically via the [discovery]({{site_root}}/components/discovery/) component. - Via the Home Assistant user interface where it will let you enter the IP-address of your Daikin AC. diff --git a/source/_components/danfoss_air.markdown b/source/_components/danfoss_air.markdown index 5b8ab36e70a..4c0949d006b 100644 --- a/source/_components/danfoss_air.markdown +++ b/source/_components/danfoss_air.markdown @@ -21,9 +21,9 @@ redirect_from: - /components/switch.danfoss_air/ --- -The `danfoss_air` component allows you to access information from your Danfoss Air HRV unit. +The `danfoss_air` integration allows you to access information from your Danfoss Air HRV unit. -*Note*: Danfoss Air CCM only accepts one TCP connection at a time. Due to this the component will not work while you have the HRV PC-Tool open. +*Note*: Danfoss Air CCM only accepts one TCP connection at a time. Due to this the integration will not work while you have the HRV PC-Tool open. There is currently support for the following device types within Home Assistant: diff --git a/source/_components/datadog.markdown b/source/_components/datadog.markdown index e2e5eaed0a6..b9cb8acc1e4 100644 --- a/source/_components/datadog.markdown +++ b/source/_components/datadog.markdown @@ -13,7 +13,7 @@ ha_category: ha_release: 0.45 --- -The `datadog` component sends all state changes to [Datadog](https://www.datadoghq.com/) using a [Datadog Agent](http://docs.datadoghq.com/guides/basic_agent_usage/). +The `datadog` integration sends all state changes to [Datadog](https://www.datadoghq.com/) using a [Datadog Agent](http://docs.datadoghq.com/guides/basic_agent_usage/). Datadog allows you to analyze, monitor, cross-reference and alert upon your data. You can use it to detect statistical anomalies, see graphs across multiple sources in real-time, send critical alerts to Slack, etc. @@ -21,13 +21,13 @@ Datadog allows you to analyze, monitor, cross-reference and alert upon your data

-The component also sends events from the logbook into Datadog, allowing you to correlate these events with your data. +The integration also sends events from the logbook into Datadog, allowing you to correlate these events with your data.

-To use the `datadog` component in your installation, add the following to your `configuration.yaml` file: +To use the `datadog` integration in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/ddwrt.markdown b/source/_components/ddwrt.markdown index 037c37f0647..9be10b84028 100644 --- a/source/_components/ddwrt.markdown +++ b/source/_components/ddwrt.markdown @@ -59,4 +59,4 @@ wireless_only: {% endconfiguration %} By default Home Assistant pulls information about connected devices from DD-WRT every 5 seconds. -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. diff --git a/source/_components/deconz.markdown b/source/_components/deconz.markdown index 68037c57594..da5893b492a 100644 --- a/source/_components/deconz.markdown +++ b/source/_components/deconz.markdown @@ -61,9 +61,9 @@ If you don't have the API key, you can generate an API key for deCONZ by using t You can manually add deCONZ by going to the integrations page. -## {% linkable_title Debugging component %} +## {% linkable_title Debugging integration %} -If you have problems with deCONZ or the component you can add debug prints to the log. +If you have problems with deCONZ or the integration you can add debug prints to the log. ```yaml logger: diff --git a/source/_components/default_config.markdown b/source/_components/default_config.markdown index 94da14c0739..4682e540076 100644 --- a/source/_components/default_config.markdown +++ b/source/_components/default_config.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Default Config" -description: "The default config component will initate a default configuration for Home Assistant." +description: "The default config integration will initate a default configuration for Home Assistant." date: 2019-02-15 20:00 sidebar: true comments: false @@ -13,7 +13,7 @@ ha_category: ha_release: 0.88 --- -This component is a meta-component and configures a default set of components for Home Assistant to load. The components that will be loaded can be found [here](https://github.com/home-assistant/home-assistant/blob/dev/homeassistant/components/default_config/manifest.json). +This integration is a meta-component and configures a default set of integrations for Home Assistant to load. The integrations that will be loaded can be found [here](https://github.com/home-assistant/home-assistant/blob/dev/homeassistant/components/default_config/manifest.json). ## {% linkable_title Configuration %} diff --git a/source/_components/demo.markdown b/source/_components/demo.markdown index ed6d3f8844c..91f62e8cf49 100644 --- a/source/_components/demo.markdown +++ b/source/_components/demo.markdown @@ -15,7 +15,7 @@ ha_release: 0.7 --- -The `demo` platform allows you to use components which are providing a demo of their implementation. The demo entities are dummies but show you how the actual platform looks like. This way you can run own demonstration instance like the online [Home Assistant demo](/demo/) or `hass --demo-mode` but combined with your own real/functional platforms. +The `demo` platform allows you to use integrations which are providing a demo of their implementation. The demo entities are dummies but show you how the actual platform looks like. This way you can run own demonstration instance like the online [Home Assistant demo](/demo/) or `hass --demo-mode` but combined with your own real/functional platforms. Available demo platforms: @@ -50,7 +50,7 @@ To integrate a demo platform in Home Assistant, add the following section to you {% configuration %} "[component]": - description: The name of the component as stated in the listing above the configuration example. + description: The name of the integration as stated in the listing above the configuration example. required: true type: string {% endconfiguration %} diff --git a/source/_components/device_sun_light_trigger.markdown b/source/_components/device_sun_light_trigger.markdown index 71e98fc27fc..d2e4a7724a7 100644 --- a/source/_components/device_sun_light_trigger.markdown +++ b/source/_components/device_sun_light_trigger.markdown @@ -14,13 +14,13 @@ ha_qa_scale: internal ha_release: pre 0.7 --- -Home Assistant has a built-in component called `device_sun_light_trigger` to help you automate your lights. The component will: +Home Assistant has a built-in integration called `device_sun_light_trigger` to help you automate your lights. The integration will: * Fade in the lights when the sun is setting and there are people home * Turn on the lights when people get home after the sun has set * Turn off the lights when all people leave the house -This component requires the components [sun](/components/sun/), [device_tracker](/components/device_tracker/) and [light](/components/light/) to be enabled. +This integration requires the integrations [sun](/components/sun/), [device_tracker](/components/device_tracker/) and [light](/components/light/) to be enabled. To enable this component, add the following lines to your `configuration.yaml` file: diff --git a/source/_components/device_tracker.markdown b/source/_components/device_tracker.markdown index dc671bfc810..fce0e65460e 100644 --- a/source/_components/device_tracker.markdown +++ b/source/_components/device_tracker.markdown @@ -67,7 +67,7 @@ Multiple device trackers can be used in parallel, such as [Owntracks](/component ## {% linkable_title `known_devices.yaml` %}

-As of 0.94 `known_devices.yaml` is being phased out, and no longer used by all trackers. Depending on the component you use this section may no longer apply. This includes the mobile app, OwnTracks, GeoFency, GPSLogger, and Locative. +As of 0.94 `known_devices.yaml` is being phased out, and no longer used by all trackers. Depending on the integration you use this section may no longer apply. This includes the mobile app, OwnTracks, GeoFency, GPSLogger, and Locative.

Once `device_tracker` is enabled, a file will be created in your config dir named `known_devices.yaml`. Edit this file to adjust which devices to be tracked. diff --git a/source/_components/device_tracker.xiaomi.markdown b/source/_components/device_tracker.xiaomi.markdown index 5bf0ab35e72..f38e0b2ca4b 100644 --- a/source/_components/device_tracker.xiaomi.markdown +++ b/source/_components/device_tracker.xiaomi.markdown @@ -43,7 +43,7 @@ password: type: string {% endconfiguration %} -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. ### {% linkable_title Compatibility test %} diff --git a/source/_components/dialogflow.markdown b/source/_components/dialogflow.markdown index b3596b1f561..658f2002e9c 100644 --- a/source/_components/dialogflow.markdown +++ b/source/_components/dialogflow.markdown @@ -14,9 +14,9 @@ ha_release: 0.56 redirect_from: /components/apiai/ --- -The `dialogflow` component is designed to be used with the [webhook](https://dialogflow.com/docs/fulfillment#webhook) integration of [Dialogflow](https://dialogflow.com/). When a conversation ends with a user, Dialogflow sends an action and parameters to the webhook. +The `dialogflow` integration is designed to be used with the [webhook](https://dialogflow.com/docs/fulfillment#webhook) integration of [Dialogflow](https://dialogflow.com/). When a conversation ends with a user, Dialogflow sends an action and parameters to the webhook. -To be able to receive messages from DialogFlow, your Home Assistant instance needs to be accessible from the web ([Hass.io instructions](/addons/duckdns/)) and you need to have the `base_url` configured for the HTTP component ([docs](/components/http/#base_url)). Dialogflow will return fallback answers if your server does not answer or takes too long (more than 5 seconds). +To be able to receive messages from DialogFlow, your Home Assistant instance needs to be accessible from the web ([Hass.io instructions](/addons/duckdns/)) and you need to have the `base_url` configured for the HTTP integration ([docs](/components/http/#base_url)). Dialogflow will return fallback answers if your server does not answer or takes too long (more than 5 seconds). Dialogflow could be [integrated](https://dialogflow.com/docs/integrations/) with many popular messaging, virtual assistant and IoT platforms. diff --git a/source/_components/digital_ocean.markdown b/source/_components/digital_ocean.markdown index 7449ceb98f0..2745b8d82a4 100644 --- a/source/_components/digital_ocean.markdown +++ b/source/_components/digital_ocean.markdown @@ -19,7 +19,7 @@ redirect_from: - /components/switch.digital_ocean/ --- -The `digital_ocean` component allows you to access the information about your [Digital Ocean](https://www.digitalocean.com/) droplets from Home Assistant. +The `digital_ocean` integration allows you to access the information about your [Digital Ocean](https://www.digitalocean.com/) droplets from Home Assistant. There is currently support for the following device types within Home Assistant: diff --git a/source/_components/digitalloggers.markdown b/source/_components/digitalloggers.markdown index 8270bef0e13..67076e7f7f8 100644 --- a/source/_components/digitalloggers.markdown +++ b/source/_components/digitalloggers.markdown @@ -63,4 +63,4 @@ cycletime: Your relays will be available in the form `switch.fantasticrelaydevice_individualrelayname` -**Note:** There is currently a limitation of the [dlipower library](https://github.com/dwighthubbard/python-dlipower) used by the `digitalloggers` component that communication is only available over port 80. +**Note:** There is currently a limitation of the [dlipower library](https://github.com/dwighthubbard/python-dlipower) used by the `digitalloggers` integration that communication is only available over port 80. diff --git a/source/_components/discord.markdown b/source/_components/discord.markdown index 1cd00bab30e..a331a67935f 100644 --- a/source/_components/discord.markdown +++ b/source/_components/discord.markdown @@ -15,7 +15,7 @@ redirect_from: - /components/notify.discord/ --- -The [Discord service](https://discordapp.com/) is a platform for the notify component. This allows components to send messages to the user using Discord. +The [Discord service](https://discordapp.com/) is a platform for the notify component. This allows integrations to send messages to the user using Discord. In order to get a token you need to go to the [Discord My Apps page](https://discordapp.com/developers/applications/me) and create a new application. Once the application is ready, create a [bot](https://discordapp.com/developers/docs/topics/oauth2#bots) user (**Create a Bot User**). diff --git a/source/_components/discovery.markdown b/source/_components/discovery.markdown index 040dd844878..0de9a0c918c 100644 --- a/source/_components/discovery.markdown +++ b/source/_components/discovery.markdown @@ -14,7 +14,7 @@ ha_qa_scale: internal ha_release: 0.7 --- -Home Assistant can discover and automatically configure [zeroconf](https://en.wikipedia.org/wiki/Zero-configuration_networking)/[mDNS](https://en.wikipedia.org/wiki/Multicast_DNS) and [uPnP](https://en.wikipedia.org/wiki/Universal_Plug_and_Play) devices on your network. Currently the `discovery` component can detect: +Home Assistant can discover and automatically configure [zeroconf](https://en.wikipedia.org/wiki/Zero-configuration_networking)/[mDNS](https://en.wikipedia.org/wiki/Multicast_DNS) and [uPnP](https://en.wikipedia.org/wiki/Universal_Plug_and_Play) devices on your network. Currently the `discovery` integration can detect: * [Apple TV](/components/apple_tv/) * [Belkin WeMo switches](/components/wemo/) @@ -120,7 +120,7 @@ If running Home Assistant in a [Docker container](/docs/installation/docker/) us ### {% linkable_title Windows %} #### {% linkable_title 64-bit Python %} -There is currently a known issue with running this component on a 64-bit version of Python and Windows. +There is currently a known issue with running this integration on a 64-bit version of Python and Windows. #### {% linkable_title Python 3.5 %} diff --git a/source/_components/dispatcher.markdown b/source/_components/dispatcher.markdown index 8b961db7b03..e901f747ea2 100644 --- a/source/_components/dispatcher.markdown +++ b/source/_components/dispatcher.markdown @@ -24,7 +24,7 @@ The `dispatcher` camera platform allows developers to create virtual camera's. ## {% linkable_title Configuration %} -You would normally not add this camera to your configuration directly but have it be discovered by one of the components that uses it. +You would normally not add this camera to your configuration directly but have it be discovered by one of the integrations that uses it. ```yaml # Example configuration.yaml entry diff --git a/source/_components/dominos.markdown b/source/_components/dominos.markdown index 4fdd41e3bc3..f5d001a1506 100644 --- a/source/_components/dominos.markdown +++ b/source/_components/dominos.markdown @@ -14,9 +14,9 @@ ha_iot_class: Cloud Polling ha_release: 0.59 --- -The `dominos` component allows you to order Dominos Pizza from within your Home Assistant scripts and automations. +The `dominos` integration allows you to order Dominos Pizza from within your Home Assistant scripts and automations. -At present, this component only supports ordering within Canada and the US. +At present, this integration only supports ordering within Canada and the US. ## {% linkable_title Configuration %} @@ -24,7 +24,7 @@ To enable the component, you need to set up your customer information and define Orders are a group of product codes. You can get these product codes by inspecting an order request from the Dominos web app, or you can [add this custom panel by following this readme](https://github.com/wardcraigj/hass-dominos-panel) to see the available product codes in a separate panel in your install. -Currently, there is no support in this component for toppings, coupons or order tracking. +Currently, there is no support in this integration for toppings, coupons or order tracking. ```yaml dominos: diff --git a/source/_components/dovado.markdown b/source/_components/dovado.markdown index 10d73bc62b0..b751f3090ed 100644 --- a/source/_components/dovado.markdown +++ b/source/_components/dovado.markdown @@ -19,14 +19,14 @@ redirect_from: - /components/sensor.dovado/ --- -The `dovado` component manages communication with the [Dovado](http://www.dovado.com/) router. +The `dovado` integration manages communication with the [Dovado](http://www.dovado.com/) router. There is currently support for the following device types within Home Assistant: - [Notifications](/components/dovado/#notifications) - [Sensor](/components/dovado/#sensor) -To add a Dovado component to your installation, add the following to your `configuration.yaml` file: +To add a Dovado integration to your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/downloader.markdown b/source/_components/downloader.markdown index 37844a8da15..e68266d7b58 100644 --- a/source/_components/downloader.markdown +++ b/source/_components/downloader.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Downloader" -description: "Instructions on how to setup the downloader component with Home Assistant." +description: "Instructions on how to setup the downloader integration with Home Assistant." date: 2015-01-24 14:39 sidebar: true comments: false @@ -14,7 +14,7 @@ ha_release: pre 0.7 ha_qa_scale: internal --- -The `downloader` component provides a service to download files. It will raise an error and not continue to set itself up when the download directory does not exist. The directory needs to be writable for the user that is running Home Assistant. +The `downloader` integration provides a service to download files. It will raise an error and not continue to set itself up when the download directory does not exist. The directory needs to be writable for the user that is running Home Assistant. To enable it, add the following lines to your `configuration.yaml` file: diff --git a/source/_components/dsmr.markdown b/source/_components/dsmr.markdown index b5ab05cf326..5b70e83d324 100644 --- a/source/_components/dsmr.markdown +++ b/source/_components/dsmr.markdown @@ -27,7 +27,7 @@ A sensor platform for Dutch Smart Meters which comply to DSMR (Dutch Smart Meter

-This component is known to work for: +This integration is known to work for: - Iskra ME382 / MT382 (DSMR 2.2) - ISKRA AM550 (DSMR 5.0) @@ -149,6 +149,6 @@ DSMR is a standard to which Dutch smartmeters must comply. It specifies that the The contents of this telegram differ between version but they generally consist of lines with 'obis' (Object Identification System, a numerical ID for a value) followed with the value and unit. -This module sets up an asynchronous reading loop using the `dsmr_parser` module which waits for a complete telegram, parser it and puts it on an async queue as a dictionary of `obis`/object mapping. The numeric value and unit of each value can be read from the objects attributes. Because the `obis` are know for each DSMR version the Entities for this component are create during bootstrap. +This module sets up an asynchronous reading loop using the `dsmr_parser` module which waits for a complete telegram, parser it and puts it on an async queue as a dictionary of `obis`/object mapping. The numeric value and unit of each value can be read from the objects attributes. Because the `obis` are know for each DSMR version the Entities for this integration are create during bootstrap. Another loop (DSMR class) is setup which reads the telegram queue, stores/caches the latest telegram and notifies the Entities that the telegram has been updated. diff --git a/source/_components/duckdns.markdown b/source/_components/duckdns.markdown index 9e34593fdfc..0b17ab99db3 100644 --- a/source/_components/duckdns.markdown +++ b/source/_components/duckdns.markdown @@ -13,11 +13,11 @@ ha_category: ha_release: 0.55 --- -With the DuckDNS component you can keep your DuckDNS record up to date. DuckDNS is a free dynamic DNS service that allows you to point a subdomain under `duckdns.org` at your computer. +With the DuckDNS integration you can keep your DuckDNS record up to date. DuckDNS is a free dynamic DNS service that allows you to point a subdomain under `duckdns.org` at your computer. ## {% linkable_title Configuration %} -To use the component in your installation, add the following to your `configuration.yaml` file: +To use the integration in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -38,5 +38,5 @@ duckdns: {% endconfiguration %}

-If you are running the Hass.io [DuckDNS add-on](/addons/duckdns/) this component is not required. The add-on will keep your IP updated with DuckDNS. +If you are running the Hass.io [DuckDNS add-on](/addons/duckdns/) this integration is not required. The add-on will keep your IP updated with DuckDNS.

diff --git a/source/_components/dweet.markdown b/source/_components/dweet.markdown index 26235c2997d..3ce577fe423 100644 --- a/source/_components/dweet.markdown +++ b/source/_components/dweet.markdown @@ -17,7 +17,7 @@ redirect_from: - /components/sensor.dweet/ --- -The `dweet` component makes it possible to transfer details collected with Home Assistant to [Dweet.io](http://dweet.io/) and visualize them with [freeboard.io](https://freeboard.io). Keep in mind that your information will be public! +The `dweet` integration makes it possible to transfer details collected with Home Assistant to [Dweet.io](http://dweet.io/) and visualize them with [freeboard.io](https://freeboard.io). Keep in mind that your information will be public!

@@ -33,7 +33,7 @@ There is currently support for the following device types within Home Assistant: ## {% linkable_title Configuration %} -To use the `dweet` component in your installation, add the following to your `configuration.yaml` file: +To use the `dweet` integration in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/dyson.markdown b/source/_components/dyson.markdown index 88a56255fac..6e8f9ebccf4 100644 --- a/source/_components/dyson.markdown +++ b/source/_components/dyson.markdown @@ -23,7 +23,7 @@ redirect_from: - /components/sensor.dyson/ --- -The `dyson` component is the main component to integrate all [Dyson](https://www.dyson.com) related platforms. +The `dyson` integration is the main integration to integrate all [Dyson](https://www.dyson.com) related platforms. There is currently support for the following device types within Home Assistant: @@ -107,7 +107,7 @@ The `dyson` vacuum platform allows you to control your Dyson 360 Eye robot vacuu ### {% linkable_title Component services %} -This component support the following services (see [Vacuum Cleaner Robots](/components/vacuum/)): +This integration support the following services (see [Vacuum Cleaner Robots](/components/vacuum/)): - [`turn_on`](/components/vacuum/#service-vacuumturn_on) - [`turn_off`](/components/vacuum/#service-vacuumturn_off) @@ -124,7 +124,7 @@ The `dyson` climate platform allows you to control your Dyson Pure Hot+Cool Fan ### {% linkable_title Component services %} -This component supports the following services (see [Climate](/components/climate/)): +This integration supports the following services (see [Climate](/components/climate/)): - [`turn_on`](/components/climate/#service-climateturn_on) - [`turn_off`](/components/climate/#service-climateturn_off) diff --git a/source/_components/ebusd.markdown b/source/_components/ebusd.markdown index 7b33fd61eb8..81ae63aba75 100644 --- a/source/_components/ebusd.markdown +++ b/source/_components/ebusd.markdown @@ -1,7 +1,7 @@ --- layout: page title: "ebusd" -description: "The ebusd component allows the integration between eBUS heating system and Home Assistant." +description: "The ebusd integration allows the integration between eBUS heating system and Home Assistant." date: 2018-12-27 15:00 sidebar: true comments: false diff --git a/source/_components/ecoal_boiler.markdown b/source/_components/ecoal_boiler.markdown index 1d963a80c02..f9fb1c13b61 100644 --- a/source/_components/ecoal_boiler.markdown +++ b/source/_components/ecoal_boiler.markdown @@ -17,7 +17,7 @@ redirect_from: - /components/switch.ecoal_boiler/ --- -The `ecoal_boiler` component is the base for pumps and sensors managed by [esterownik.pl eCoal boiler controller](https://esterownik.pl/nasze-produkty/ecoal). +The `ecoal_boiler` integration is the base for pumps and sensors managed by [esterownik.pl eCoal boiler controller](https://esterownik.pl/nasze-produkty/ecoal). ## {% linkable_title Configuration %} diff --git a/source/_components/ecobee.markdown b/source/_components/ecobee.markdown index fc20a8e1730..fb4338e3bb5 100644 --- a/source/_components/ecobee.markdown +++ b/source/_components/ecobee.markdown @@ -25,7 +25,7 @@ redirect_from: - /components/weather.ecobee/ --- -The `ecobee` component lets you control a thermostats and view sensor data from [ecobee](https://ecobee.com) thermostats. +The `ecobee` integration lets you control a thermostats and view sensor data from [ecobee](https://ecobee.com) thermostats. ## {% linkable_title Configuration %} @@ -48,7 +48,7 @@ Now login to the regular consumer portal, and in the hamburger menu there will b Now under the Name and Summary Section you will have an API key. Copy this key and use it in you configuration section below. Click the **X** to close the Developer section. -To add the Ecobee component to Home Assistant, add the following information to your [`configuration.yaml`](/docs/configuration/) file: +To add the Ecobee integration to Home Assistant, add the following information to your [`configuration.yaml`](/docs/configuration/) file: ```yaml # Example configuration.yaml entry @@ -58,11 +58,11 @@ ecobee: [Restart Home Assistant](https://www.home-assistant.io/docs/configuration/#reloading-changes) for the changes to take effect. -The first time you (re)run Home Assistant with this component it will give you a PIN code that you need to authorize in the [ecobee consumer portal](https://www.ecobee.com/consumerportal/index.html). You can do this by clicking **Add Application** in the **My Apps** section in the sidebar. +The first time you (re)run Home Assistant with this integration it will give you a PIN code that you need to authorize in the [ecobee consumer portal](https://www.ecobee.com/consumerportal/index.html). You can do this by clicking **Add Application** in the **My Apps** section in the sidebar. The PIN can be found from the Home Assistant portal on the Ecobee card or from the **configurator.ecobee** entity in states in the portal. -- If you do not have an ecobee card, you may be using groups with `default_view` that don't show the card. To get around this you can temporarily comment out the `default_view` section or add the `configurator.ecobee` component to your `default_view` and restart Home Assistant. +- If you do not have an ecobee card, you may be using groups with `default_view` that don't show the card. To get around this you can temporarily comment out the `default_view` section or add the `configurator.ecobee` integration to your `default_view` and restart Home Assistant. Once you enter the PIN on the ecobee site, wait approximately 5 minutes and then click on the **I have authorized the app** link at the bottom of the ecobee pop-up window. If everything worked correctly, you should now be able to restart Home Assistant again to see the full ecobee card with all of the sensors populated or see the list of sensors in the developer tools. Now you can re-enable your `default_view` (if you had to disable it) and add the ecobee sensors to a group and/or view. @@ -87,7 +87,7 @@ If for whatever reason you delete and re-create your ecobee app at ecobee.com su ## {% linkable_title Notifications %} -To get your Ecobee notifications working with Home Assistant, you must first have the main Ecobee component loaded and running. Once you have that configured, you can setup this component to send messages to your Ecobee device. +To get your Ecobee notifications working with Home Assistant, you must first have the main Ecobee integration loaded and running. Once you have that configured, you can setup this integration to send messages to your Ecobee device. To use this notification platform in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/ecovacs.markdown b/source/_components/ecovacs.markdown index 9caf28ea1fd..d9a2d423b09 100644 --- a/source/_components/ecovacs.markdown +++ b/source/_components/ecovacs.markdown @@ -17,7 +17,7 @@ redirect_from: - /components/vacuum.ecovacs/ --- -The `ecovacs` component is the main component to integrate all [Ecovacs](https://www.ecovacs.com) (Deebot) vacuums. You will need your Ecovacs account information (username, password) to discover and control vacuums in your account. +The `ecovacs` integration is the main integration to integrate all [Ecovacs](https://www.ecovacs.com) (Deebot) vacuums. You will need your Ecovacs account information (username, password) to discover and control vacuums in your account. There is currently support for the following device types within Home Assistant: @@ -62,7 +62,7 @@ The library that talks to the Ecovacs servers is in a very early state and still Please see the [sucks library documentation](https://github.com/wpietri/sucks) for some more information about what has been tested, and check out the GitHub issues to see if the issue you're having is known or being worked on. -If you have an issue with the Ecovacs component, please file a [GitHub Issue](https://github.com/home-assistant/home-assistant/issues) and include your Home Assistant logs in the report. To get full debug output from both the Ecovacs component and the underlying `sucks` library, place this in your `configuration.yaml` file: +If you have an issue with the Ecovacs component, please file a [GitHub Issue](https://github.com/home-assistant/home-assistant/issues) and include your Home Assistant logs in the report. To get full debug output from both the Ecovacs integration and the underlying `sucks` library, place this in your `configuration.yaml` file: ```yaml logger: diff --git a/source/_components/edp_redy.markdown b/source/_components/edp_redy.markdown index 7f64aed9867..58da62a3a9a 100644 --- a/source/_components/edp_redy.markdown +++ b/source/_components/edp_redy.markdown @@ -19,7 +19,7 @@ redirect_from: - /components/switch.edp_redy/ --- -[EDP re:dy](https://www.edp.pt/particulares/servicos/redy/) is a Home Automation platform from Portuguese energy provider EDP, that allows control of appliances and other devices, as well as monitoring power consumption. This component allows integrating EDP re:dy into Home Assistant. +[EDP re:dy](https://www.edp.pt/particulares/servicos/redy/) is a Home Automation platform from Portuguese energy provider EDP, that allows control of appliances and other devices, as well as monitoring power consumption. This integration allows integrating EDP re:dy into Home Assistant. ## {% linkable_title Configuration %} diff --git a/source/_components/ee_brightbox.markdown b/source/_components/ee_brightbox.markdown index 3af7fe694df..ad878df41dd 100644 --- a/source/_components/ee_brightbox.markdown +++ b/source/_components/ee_brightbox.markdown @@ -51,4 +51,4 @@ version: type: string {% endconfiguration %} -See the [device tracker component page](/components/device_tracker/) for instructions on how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions on how to configure the people to be tracked. diff --git a/source/_components/egardia.markdown b/source/_components/egardia.markdown index 39d7a66a367..0052d25a0b8 100644 --- a/source/_components/egardia.markdown +++ b/source/_components/egardia.markdown @@ -106,7 +106,7 @@ There seem to be multiple versions of software running on GATE-02 devices; we ha 1. Log in to your alarm system's control panel. You will need to access http://[IP of your control panel]. You know this already since you need it in the basic configuration from above. Log in to the control panel with your Egardia/Woonveilig username and password. 2. Once logged in, go to *System Settings*, *Report* and change the Server Address for your primary server to the IP or hostname of your Home Assistant machine. You can leave the port number set to 52010 or change it to anything you like. **Make sure to change the settings of the primary server otherwise the messages will not come through. Note that this will limit (or fully stop) the number of alarm messages you will get through Egardia's / Woonveilig services.** Maybe, that is just what you want. Make sure to save your settings by selecting 'OK'. -3. The Egardia component relies on capturing the status codes that your alarm emits when something happens (status change or trigger). These codes will be unique for every situation - i.e. the code emitted by the alarm when a sensor is triggered is unique to that sensor. Also, if you have multiple users or remotes, each remote has unique codes that are emitted by the alarm when status is changed using that remote or by that user. For the Egardia component to work correctly you will need to capture the codes. To do this, on your Home Assistant machine run `$ sudo python3 egardiaserver.py`. Refer to the [python-egardia repository](https://github.com/jeroenterheerdt/python-egardia) for detailed documentation on parameters. This will receive status codes from your alarm control panel and display them. Record the codes shown as well as the status they relate to (see step 4 below). Make sure to change the status of your alarm to all states (disarm, arm, home) by all means possible (all users, remotes, web login, app) as well as trigger the alarm in all ways possible to get 100% coverage of all the codes the alarm system generates. You will need to run this script once and stop it once you have captured all the possible codes. Also, if you ever add users, remotes or sensors to your alarm system, make sure to re-run the script to capture the extra codes so you can update your configuration (see step 4 below). **For comfort, before triggering the alarm it might be good to disable the siren temporarily (can be done in Panel Settings).** +3. The Egardia integration relies on capturing the status codes that your alarm emits when something happens (status change or trigger). These codes will be unique for every situation - i.e. the code emitted by the alarm when a sensor is triggered is unique to that sensor. Also, if you have multiple users or remotes, each remote has unique codes that are emitted by the alarm when status is changed using that remote or by that user. For the Egardia integration to work correctly you will need to capture the codes. To do this, on your Home Assistant machine run `$ sudo python3 egardiaserver.py`. Refer to the [python-egardia repository](https://github.com/jeroenterheerdt/python-egardia) for detailed documentation on parameters. This will receive status codes from your alarm control panel and display them. Record the codes shown as well as the status they relate to (see step 4 below). Make sure to change the status of your alarm to all states (disarm, arm, home) by all means possible (all users, remotes, web login, app) as well as trigger the alarm in all ways possible to get 100% coverage of all the codes the alarm system generates. You will need to run this script once and stop it once you have captured all the possible codes. Also, if you ever add users, remotes or sensors to your alarm system, make sure to re-run the script to capture the extra codes so you can update your configuration (see step 4 below). **For comfort, before triggering the alarm it might be good to disable the siren temporarily (can be done in Panel Settings).** 4. Once you have the codes, update your `configuration.yaml`: ```yaml # Example configuration.yaml entry @@ -123,8 +123,8 @@ There seem to be multiple versions of software running on GATE-02 devices; we ha triggered: XXXXXXXXXXXXXXXX, XXXXXXXXXXXXXXXX, XXXXXXXXXXXXXXXX ignore: XXXXXXXXXXXXXXXX ``` -Note that for all code groups (*arm*,*disarm*, etc) multiple codes can be entered since each sensor triggers with a different code and each user of the system has its own arm and disarm codes. Also note that your system will do regular system checks which will be reported as well. Since Home Assistant provides no way of handling them properly, you can enter those codes as *ignore* (again, multiple codes can be used here). The egardia component will ignore these codes and continue returning the old status if it receives any of the codes that are listed as ignore. This is useful for example when you have armed your alarm at night: normally a system check will occur at least once during the night and if that code is not specified anywhere Home Assistant will set the status of the alarm to its default, which is unarmed. This is in fact wrong. Listing the code as ignore changes this behavior and Home Assistant will continue to show the status the alarm is in (disarm, arm, home, triggered) even when system checks occur. -5. Test your setup and enjoy. The component will update if the alarm status changes, including triggers. You can use this to build your own automations and send notifications as you wish. *Note*: previous versions required a separate egardiaserver to be set up. This is no longer necessary and corresponding system services can be removed (using systemctl). +Note that for all code groups (*arm*,*disarm*, etc) multiple codes can be entered since each sensor triggers with a different code and each user of the system has its own arm and disarm codes. Also note that your system will do regular system checks which will be reported as well. Since Home Assistant provides no way of handling them properly, you can enter those codes as *ignore* (again, multiple codes can be used here). The egardia integration will ignore these codes and continue returning the old status if it receives any of the codes that are listed as ignore. This is useful for example when you have armed your alarm at night: normally a system check will occur at least once during the night and if that code is not specified anywhere Home Assistant will set the status of the alarm to its default, which is unarmed. This is in fact wrong. Listing the code as ignore changes this behavior and Home Assistant will continue to show the status the alarm is in (disarm, arm, home, triggered) even when system checks occur. +5. Test your setup and enjoy. The integration will update if the alarm status changes, including triggers. You can use this to build your own automations and send notifications as you wish. *Note*: previous versions required a separate egardiaserver to be set up. This is no longer necessary and corresponding system services can be removed (using systemctl). ## {% linkable_title Binary Sensor %} diff --git a/source/_components/eight_sleep.markdown b/source/_components/eight_sleep.markdown index 485925d994a..82f4bedaa6f 100644 --- a/source/_components/eight_sleep.markdown +++ b/source/_components/eight_sleep.markdown @@ -19,7 +19,7 @@ redirect_from: - /components/sensor.eight_sleep/ --- -The `eight_sleep` component allows Home Assistant to fetch data from your [Eight Sleep](https://eightsleep.com/) smart cover or mattress. +The `eight_sleep` integration allows Home Assistant to fetch data from your [Eight Sleep](https://eightsleep.com/) smart cover or mattress. There is currently support for the following device types within Home Assistant: diff --git a/source/_components/emoncms.markdown b/source/_components/emoncms.markdown index d25b2ae9740..10d2482bcd5 100644 --- a/source/_components/emoncms.markdown +++ b/source/_components/emoncms.markdown @@ -44,7 +44,7 @@ sensor: ## {% linkable_title Default naming scheme %} -The names of the sensors created by this component will use the feed names defined in EmonCMS if available, +The names of the sensors created by this integration will use the feed names defined in EmonCMS if available, or the feed ID otherwise, and will be prefixed with "EmonCMS", e.g., "EmonCMS Total Power" or "EmonCMS Feed 5". If the `id` property is anything but `1`, the ID will be shown as well, e.g., "EmonCMS 2 Feed 5". diff --git a/source/_components/emoncms_history.markdown b/source/_components/emoncms_history.markdown index aed353c14c9..b6fbae26a28 100644 --- a/source/_components/emoncms_history.markdown +++ b/source/_components/emoncms_history.markdown @@ -14,9 +14,9 @@ ha_release: 0.31 --- -The `emoncms_history` component makes it possible to transfer details collected with Home Assistant to [Emoncms.org](https://emoncms.org/) or your local running Emoncms instance. It will send the data to a specific input node on Emoncms with the entity IDs as a key. Afterwards you can create feeds and dashboards in Emoncms with the collected data. +The `emoncms_history` integration makes it possible to transfer details collected with Home Assistant to [Emoncms.org](https://emoncms.org/) or your local running Emoncms instance. It will send the data to a specific input node on Emoncms with the entity IDs as a key. Afterwards you can create feeds and dashboards in Emoncms with the collected data. -To use the `emoncms_history` component in your installation, add the following to your `configuration.yaml` file: +To use the `emoncms_history` integration in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/emulated_hue.markdown b/source/_components/emulated_hue.markdown index 348f81cc9be..e910eb6d0a8 100644 --- a/source/_components/emulated_hue.markdown +++ b/source/_components/emulated_hue.markdown @@ -19,7 +19,7 @@ ha_qa_scale: internal Be aware that `emulated_hue` doesn't work for new users of **Google Home** with `emulated_hue`. If you've not previously set this up and had it working, use the [Google Assistant component](/components/google_assistant/) or [Nabu Casa cloud](https://www.home-assistant.io/components/cloud) component.

-The `emulated_hue` component provides a virtual Philips Hue bridge, written entirely in software, which allows services that work with the Hue API to interact with Home Assistant +The `emulated_hue` integration provides a virtual Philips Hue bridge, written entirely in software, which allows services that work with the Hue API to interact with Home Assistant entities. The driving use case behind for functionality is to allow Home Assistant to work with an Amazon Echo or Google Home with no setup cost outside of configuration changes. The virtual bridge can turn entities on/off or change the brightness of dimmable lights. The volume level of media players can be controlled as brightness. @@ -61,7 +61,7 @@ type: type: string default: google_home host_ip: - description: The IP address that your Home Assistant installation is running on. If you do not specify this option, the component will attempt to determine the IP address on its own. + description: The IP address that your Home Assistant installation is running on. If you do not specify this option, the integration will attempt to determine the IP address on its own. required: false type: string listen_port: @@ -136,7 +136,7 @@ These attributes used to be found under the `customize` section of `homeassistan ### {% linkable_title Troubleshooting %} -You can verify that the `emulated_hue` component has been loaded and is responding by pointing a local browser to the following URL: +You can verify that the `emulated_hue` integration has been loaded and is responding by pointing a local browser to the following URL: - `http://:8300/description.xml` - This URL should return a descriptor file in the form of an XML file. - `http://:8300/api/pi/lights` - This will return a list of devices, lights, scenes, groups, etc.. that `emulated_hue` is exposing to Alexa. diff --git a/source/_components/emulated_roku.markdown b/source/_components/emulated_roku.markdown index ce3a6b14a85..ddc0b056069 100644 --- a/source/_components/emulated_roku.markdown +++ b/source/_components/emulated_roku.markdown @@ -14,7 +14,7 @@ ha_release: 0.86 ha_iot_class: Local Push --- -This component integrates an emulated Roku API into Home Assistant, +This integration integrates an emulated Roku API into Home Assistant, so remotes such as Harmony and Android apps can connect to it through WiFi as if it were a Roku player. Home Assistant will see key presses and app launches as Events, which you can use as triggers for automations. Multiple Roku servers may be started if you run out of buttons by specifying multiple server entries. @@ -24,14 +24,14 @@ Windows is not supported because Home Assistant uses `ProactorEventLoop` which d

-This component opens an unauthenticated API on the host, allowing anything on the local network to access +This integration opens an unauthenticated API on the host, allowing anything on the local network to access your Home Assistant instance through the automations you create with emulated Roku as the trigger. Using a proxy with whitelisted IP addresses is recommended. (set `advertise_ip` to the proxy's ip or DNS name)

## {% linkable_title Configuration %} -The component is configurable through the frontend. (**Configuration** -> **Integrations** -> **Emulated Roku**) +The integration is configurable through the frontend. (**Configuration** -> **Integrations** -> **Emulated Roku**) If you wish to configure advanced options, you can add the following entry in `configuration.yaml`. @@ -53,7 +53,7 @@ listen_port: required: true type: integer host_ip: - description: The IP address that your Home Assistant installation is running on. If you do not specify this option, the component will attempt to determine the IP address on its own. + description: The IP address that your Home Assistant installation is running on. If you do not specify this option, the integration will attempt to determine the IP address on its own. required: false type: string advertise_ip: diff --git a/source/_components/enocean.markdown b/source/_components/enocean.markdown index ada39a33b6e..7d6a89692c1 100644 --- a/source/_components/enocean.markdown +++ b/source/_components/enocean.markdown @@ -25,7 +25,7 @@ redirect_from: 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 necessary. -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. +The `enocean` integration 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: diff --git a/source/_components/envisalink.markdown b/source/_components/envisalink.markdown index 3cd6efeb54c..d6af76afa04 100644 --- a/source/_components/envisalink.markdown +++ b/source/_components/envisalink.markdown @@ -20,7 +20,7 @@ redirect_from: - /components/sensor.envisalink/ --- -The `envisalink` 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. +The `envisalink` integration 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 integration is built. Currently, the Envisalink version 4 is the latest model. This integration 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. @@ -80,7 +80,7 @@ password: required: true type: string code: - description: Your alarm panel's code, for authenticating user input during arm/disarm. If you do not provide this value, the component will prompt the user to enter the code at runtime. + description: Your alarm panel's code, for authenticating user input during arm/disarm. If you do not provide this value, the integration will prompt the user to enter the code at runtime. required: false type: string port: @@ -104,7 +104,7 @@ zonedump_interval: default: 30 type: integer timeout: - description: A network connectivity timeout when communicating with the envisalink. If connection is not obtained by this time (in seconds) the component will stop trying to connect. + description: A network connectivity timeout when communicating with the envisalink. If connection is not obtained by this time (in seconds) the integration will stop trying to connect. required: false default: 10 type: integer @@ -128,7 +128,7 @@ zones: default: opening type: string partitions: - description: 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. + description: 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 integrations are loaded. required: false type: integer keys: diff --git a/source/_components/esphome.markdown b/source/_components/esphome.markdown index 49f54e9f7ec..18f76a05528 100644 --- a/source/_components/esphome.markdown +++ b/source/_components/esphome.markdown @@ -21,9 +21,9 @@ redirect_from: - /components/switch.esphome/ --- -This component allows you to connect your [ESPHome](https://esphome.io) devices directly into Home Assistant with the [native ESPHome API](https://esphome.io/components/api.html). +This integration allows you to connect your [ESPHome](https://esphome.io) devices directly into Home Assistant with the [native ESPHome API](https://esphome.io/components/api.html). -## {% linkable_title Setup the component via the integrations screen %} +## {% linkable_title Setup the integration via the integrations screen %} Menu: *Configuration* -> *Integrations* diff --git a/source/_components/eufy.markdown b/source/_components/eufy.markdown index 1a979bceaa9..ca386741ef7 100644 --- a/source/_components/eufy.markdown +++ b/source/_components/eufy.markdown @@ -19,14 +19,14 @@ redirect_from: - /components/switch.eufy/ --- -The `eufy` component is the main component to integrate various [eufy](https://www.eufylife.com/) devices with Home Assistant. +The `eufy` integration is the main integration to integrate various [eufy](https://www.eufylife.com/) devices with Home Assistant. There is currently support for the following device types within Home Assistant: - Light - Switch -Supported devices will be discovered after the `eufy` component is configured: +Supported devices will be discovered after the `eufy` integration is configured: ```yaml # Example configuration.yaml entry diff --git a/source/_components/evohome.markdown b/source/_components/evohome.markdown index b8ea759a062..00cc88b3371 100644 --- a/source/_components/evohome.markdown +++ b/source/_components/evohome.markdown @@ -17,7 +17,7 @@ redirect_from: - /components/climate.evohome/ --- -The `evohome` component is the main component to set up and integrate all _non-US_ [Honeywell Total Connect Comfort (TCC)](https://international.mytotalconnectcomfort.com/Account/Login) CH/DHW systems, primarily the Honeywell evohome multi-zone CH/DHW system. It does not support the home security functionality of TCC. +The `evohome` integration is the main integration to set up and integrate all _non-US_ [Honeywell Total Connect Comfort (TCC)](https://international.mytotalconnectcomfort.com/Account/Login) CH/DHW systems, primarily the Honeywell evohome multi-zone CH/DHW system. It does not support the home security functionality of TCC. It uses v2 of the [evohome-client](https://github.com/watchforstock/evohome-client) client library and so will let you control (only) EU/international systems. It _does not_ leverage the [somecomfort](https://github.com/kk7ds/somecomfort) client library as used by US-based systems; for those, you may find what you need at the [honeywell climate platform](/components/climate.honeywell/). @@ -29,7 +29,7 @@ There is currently support for the following device types within Home Assistant: ## {% linkable_title Configuration %} -To use this component in your installation, add the following to your `configuration.yaml` file: +To use this integration in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -63,7 +63,7 @@ This is an IoT cloud-polling device, and the recommended minimum `scan_interval` ## {% linkable_title Climate %} -It is distinct from - but related to - the [`honeywell`](/components/climate.honeywell/) climate platform, which also allows (limited) integration with Honeywell Connected thermostats; these two components may well be usable side-by-side, but YMMV. +It is distinct from - but related to - the [`honeywell`](/components/climate.honeywell/) climate platform, which also allows (limited) integration with Honeywell Connected thermostats; these two integrations may well be usable side-by-side, but YMMV. The evohome evotouch Controller supports seven distict operating modes: Auto, AutoWithEco, Away, DayOff, HeatingOff, and Custom; AutoWithReset is a 7th, hidden, mode. diff --git a/source/_components/facebox.markdown b/source/_components/facebox.markdown index 21a818b2bb4..b408196d467 100644 --- a/source/_components/facebox.markdown +++ b/source/_components/facebox.markdown @@ -26,7 +26,7 @@ MB_KEY="INSERT-YOUR-KEY-HERE" sudo docker run --name=facebox --restart=always -p 8080:8080 -e "MB_KEY=$MB_KEY" machinebox/facebox ``` -You can run Facebox with a username and password by adding `-e "MB_BASICAUTH_USER=my_username" -e "MB_BASICAUTH_PASS=my_password"` but bear in mind that the component does not encrypt these credentials and this approach does not guarantee security on an unsecured network. +You can run Facebox with a username and password by adding `-e "MB_BASICAUTH_USER=my_username" -e "MB_BASICAUTH_PASS=my_password"` but bear in mind that the integration does not encrypt these credentials and this approach does not guarantee security on an unsecured network. If you only require face detection (number of faces) you can disable face recognition by adding `-e "MB_FACEBOX_DISABLE_RECOGNITION=true"` to the `docker run` command. diff --git a/source/_components/fail2ban.markdown b/source/_components/fail2ban.markdown index 9249e71ca79..8488a5fe6ea 100644 --- a/source/_components/fail2ban.markdown +++ b/source/_components/fail2ban.markdown @@ -67,7 +67,7 @@ For those of us using Docker, the above tutorial may not be sufficient. The foll #### {% linkable_title Set http logger %} -In your `configuration.yaml` file, add the following to the `logger` component to ensure that Home Assistant prints failed login attempts to the log. +In your `configuration.yaml` file, add the following to the `logger` integration to ensure that Home Assistant prints failed login attempts to the log. ```yaml logger: diff --git a/source/_components/fan.markdown b/source/_components/fan.markdown index 37631338b93..837749a1101 100644 --- a/source/_components/fan.markdown +++ b/source/_components/fan.markdown @@ -14,4 +14,4 @@ ha_qa_scale: internal ha_release: 0.27 --- -The `fan` component is built for the controlling of fan devices. +The `fan` integration is built for the controlling of fan devices. diff --git a/source/_components/fan.template.markdown b/source/_components/fan.template.markdown index 49e6dd81df6..7309eec950f 100644 --- a/source/_components/fan.template.markdown +++ b/source/_components/fan.template.markdown @@ -15,7 +15,7 @@ logo: home-assistant.png ha_qa_scale: internal --- -The `template` platform creates fans that combine components and provides the +The `template` platform creates fans that combine integrations and provides the ability to run scripts or invoke services for each of the turn_on, turn_off, set_speed, set_oscillating, and set_direction commands of a fan. diff --git a/source/_components/fastdotcom.markdown b/source/_components/fastdotcom.markdown index 9c1f730bda4..d095e5681e8 100644 --- a/source/_components/fastdotcom.markdown +++ b/source/_components/fastdotcom.markdown @@ -17,13 +17,13 @@ redirect_from: - /components/sensor.fastdotcom/ --- -The `fastdotcom` component uses the [Fast.com](https://fast.com/) web service to measure network bandwidth performance. +The `fastdotcom` integration uses the [Fast.com](https://fast.com/) web service to measure network bandwidth performance.

Currently fast.com only supports measuring download bandwidth. If you want to measure bandwidth metrics other then download such as ping and upload, utilize the [speedtest](/components/sensor.speedtest) component.

-Enabling this component will automatically create the Fast.com Sensor. +Enabling this integration will automatically create the Fast.com Sensor. By default, a speed test will be run every hour. The user can change the update frequency in the configuration by defining the `scan_interval` for a speed test to run. @@ -72,7 +72,7 @@ scan_interval: ### {% linkable_title Service %} -Once loaded, the `fastdotcom` component will expose a service (`fastdotcom.speedtest`) that can be called to run a Fast.com speed test on demand. This service takes no parameters. This can be useful if you have enabled manual mode. +Once loaded, the `fastdotcom` integration will expose a service (`fastdotcom.speedtest`) that can be called to run a Fast.com speed test on demand. This service takes no parameters. This can be useful if you have enabled manual mode. ```yaml action: diff --git a/source/_components/feedreader.markdown b/source/_components/feedreader.markdown index cebea072cd9..d79437e2a7e 100644 --- a/source/_components/feedreader.markdown +++ b/source/_components/feedreader.markdown @@ -86,7 +86,7 @@ automation: Any field under the `` tag in the feed can be used for example `trigger.event.data.content` will get the body of the feed entry. -For more advanced use cases, a custom component registering to the `feedreader` event type could be used instead: +For more advanced use cases, a custom integration registering to the `feedreader` event type could be used instead: ```python EVENT_FEEDREADER = "feedreader" diff --git a/source/_components/ffmpeg.markdown b/source/_components/ffmpeg.markdown index a051d575f55..44630cc5aee 100644 --- a/source/_components/ffmpeg.markdown +++ b/source/_components/ffmpeg.markdown @@ -13,7 +13,7 @@ ha_category: ha_release: 0.29 --- -The `ffmpeg` component allows other Home Assistant components to process video and audio streams. This component supports all FFmpeg versions since 3.0.0; if you have an older version, please update. +The `ffmpeg` integration allows other Home Assistant integrations to process video and audio streams. This integration supports all FFmpeg versions since 3.0.0; if you have an older version, please update.

You need the `ffmpeg` binary in your system path. On Hassbian you will need to login as the `pi` user and `sudo apt install ffmpeg`. On Debian 8 or Raspbian (Jessie) you can install it from [debian-backports](https://backports.debian.org/Instructions/). If you want [hardware acceleration](https://trac.ffmpeg.org/wiki/HWAccelIntro) support on a Raspberry Pi, you will need to build from source by yourself. Windows binaries are available on the [FFmpeg](http://www.ffmpeg.org/) website. diff --git a/source/_components/flexit.markdown b/source/_components/flexit.markdown index 1b08eb41014..44af442acc6 100644 --- a/source/_components/flexit.markdown +++ b/source/_components/flexit.markdown @@ -46,7 +46,7 @@ hub: {% endconfiguration %}

-This component requires the [Modbus](/components/modbus/) component to be set up to work +This integration requires the [Modbus](/components/modbus/) integration to be set up to work

Full configuration example including modbus setup shown below: diff --git a/source/_components/flic.markdown b/source/_components/flic.markdown index 0601178647b..35082555af2 100644 --- a/source/_components/flic.markdown +++ b/source/_components/flic.markdown @@ -48,7 +48,7 @@ port: type: integer default: 5551 discovery: - description: If `true` then the component is configured to constantly scan for new buttons. + description: If `true` then the integration is configured to constantly scan for new buttons. required: false type: boolean default: true @@ -73,7 +73,7 @@ If discovery is enabled, you can add a new button by pressing it for at least 7 #### {% linkable_title Events %} -The flic component fires `flic_click` events on the bus. You can capture the events and respond to them in automation scripts like this: +The flic integration fires `flic_click` events on the bus. You can capture the events and respond to them in automation scripts like this: ```yaml # Example configuration.yaml automation entry @@ -97,7 +97,7 @@ Event data: - **click_type**: The type of click. Possible values are `single`, `double` and `hold`. - **queued_time**: The amount of time this event was queued on the button, in seconds. -To help detect and debug flic button clicks, you can use this automation that send a notification on very click type of every button. This example uses the [HTML5 push notification platform](/components/notify.html5/). Visit the [notification component page](/components/notify/) for more information on setting up notifications. +To help detect and debug flic button clicks, you can use this automation that send a notification on very click type of every button. This example uses the [HTML5 push notification platform](/components/notify.html5/). Visit the [notification integration page](/components/notify/) for more information on setting up notifications. ```yaml automation: diff --git a/source/_components/flux.markdown b/source/_components/flux.markdown index 955d2ff9ee8..b0cd5a095a2 100644 --- a/source/_components/flux.markdown +++ b/source/_components/flux.markdown @@ -18,7 +18,7 @@ redirect_from: The `flux` switch platform will change the temperature of your lights similar to the way flux works on your computer, using circadian rhythm. They will be bright during the day, and gradually fade to a red/orange at night. -The component will update your lights based on the time of day. It will only affect lights that are turned on and listed in the flux configuration. +The integration will update your lights based on the time of day. It will only affect lights that are turned on and listed in the flux configuration. During the day (in between `start time` and `sunset time`), it will fade the lights from the `start_colortemp` to the `sunset_colortemp`. After sunset (between `sunset_time` and `stop_time`), the lights will fade from the `sunset_colortemp` to the `stop_colortemp`. If the lights are still on after the `stop_time` it will continue to change the light to the `stop_colortemp` until the light is turned off. The fade effect is created by updating the lights periodically. diff --git a/source/_components/flux_led.markdown b/source/_components/flux_led.markdown index 115b1492a3f..16b015ea174 100644 --- a/source/_components/flux_led.markdown +++ b/source/_components/flux_led.markdown @@ -89,7 +89,7 @@ devices:

Depending on your controller or bulb type, there are two ways to configure brightness. -The component defaults to rgbw. If your device has a separate white channel, you do not need to specify anything else; changing the white value will adjust the brightness of white channel keeping rgb color constant. However, if your device does not have a separate white channel, you will need to set the mode to rgb. In this mode, the device will keep the same color, and adjust the rgb values to dim or brighten the color. +The integration defaults to rgbw. If your device has a separate white channel, you do not need to specify anything else; changing the white value will adjust the brightness of white channel keeping rgb color constant. However, if your device does not have a separate white channel, you will need to set the mode to rgb. In this mode, the device will keep the same color, and adjust the rgb values to dim or brighten the color.

diff --git a/source/_components/folder_watcher.markdown b/source/_components/folder_watcher.markdown index b6d4112e92d..245a4ba1cc7 100644 --- a/source/_components/folder_watcher.markdown +++ b/source/_components/folder_watcher.markdown @@ -15,7 +15,7 @@ ha_release: 0.67 ha_qa_scale: internal --- -This component adds [Watchdog](https://pythonhosted.org/watchdog/) file system monitoring, publishing events on the Home Assistant bus on the creation/deletion/modification of files within configured folders. The monitored `event_type` are: +This integration adds [Watchdog](https://pythonhosted.org/watchdog/) file system monitoring, publishing events on the Home Assistant bus on the creation/deletion/modification of files within configured folders. The monitored `event_type` are: * `created` * `deleted` @@ -26,7 +26,7 @@ Configured folders must be added to [whitelist_external_dirs](/docs/configuratio ## {% linkable_title Configuration %} -To enable the Folder Watcher component in your installation, add the following to your `configuration.yaml` file: +To enable the Folder Watcher integration in your installation, add the following to your `configuration.yaml` file: {% raw %} ```yaml diff --git a/source/_components/foursquare.markdown b/source/_components/foursquare.markdown index a08d86d7120..02cf7f75117 100644 --- a/source/_components/foursquare.markdown +++ b/source/_components/foursquare.markdown @@ -14,7 +14,7 @@ ha_release: 0.26 ha_iot_class: Cloud Polling and Cloud Push --- -The `foursquare` component accepts pushes from the Foursquare [Real-Time API](https://developer.foursquare.com/overview/realtime) and a service to check users in on Swarm. +The `foursquare` integration accepts pushes from the Foursquare [Real-Time API](https://developer.foursquare.com/overview/realtime) and a service to check users in on Swarm. ```yaml # Example configuration.yaml entry @@ -50,7 +50,7 @@ After that, you will get redirected to your `REDIRECT_URL` with the `access_toke ### {% linkable_title Real-Time API %} -The component accepts pushes from Foursquare at `/api/foursquare`. The route does not require authentication. +The integration accepts pushes from Foursquare at `/api/foursquare`. The route does not require authentication. Foursquare check-in events can be used out of the box to trigger automation actions, e.g.: diff --git a/source/_components/freebox.markdown b/source/_components/freebox.markdown index 9fc7f1c2f6c..4c95a8d3551 100644 --- a/source/_components/freebox.markdown +++ b/source/_components/freebox.markdown @@ -20,7 +20,7 @@ redirect_from: - /components/sensor.freebox/ --- -The `freebox` component allows you to observe and control [Freebox router](http://www.free.fr/). +The `freebox` integration allows you to observe and control [Freebox router](http://www.free.fr/). There is currently support for the following device types within Home Assistant: diff --git a/source/_components/freedns.markdown b/source/_components/freedns.markdown index c31040e44a5..48d73fbec60 100644 --- a/source/_components/freedns.markdown +++ b/source/_components/freedns.markdown @@ -13,7 +13,7 @@ ha_category: ha_release: 0.67 --- -With the `freedns` component you can keep your [FreeDNS](https://freedns.afraid.org) record up to date. +With the `freedns` integration you can keep your [FreeDNS](https://freedns.afraid.org) record up to date. ## {% linkable_title Setup %} @@ -28,7 +28,7 @@ You need to determine your update URL or your access token. ## {% linkable_title Configuration %} -To use the component in your installation, add the following to your `configuration.yaml` file: +To use the integration in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/fritz.markdown b/source/_components/fritz.markdown index 9572f1068f1..2dbd28a2954 100644 --- a/source/_components/fritz.markdown +++ b/source/_components/fritz.markdown @@ -53,4 +53,4 @@ password: It seems that it is not necessary to use the password in current generation Fritz!Box routers because the necessary data can be retrieved anonymously.

-See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. diff --git a/source/_components/fritzbox.markdown b/source/_components/fritzbox.markdown index 4f887451f9a..ca460641e13 100644 --- a/source/_components/fritzbox.markdown +++ b/source/_components/fritzbox.markdown @@ -22,7 +22,7 @@ redirect_from: - /components/sensor.fritzbox/ --- -The [AVM](https://en.avm.de) Fritzbox component for Home Assistant allows you to integrate the switch and climate devices. +The [AVM](https://en.avm.de) Fritzbox integration for Home Assistant allows you to integrate the switch and climate devices. There is currently support for the following device types within Home Assistant: diff --git a/source/_components/fritzbox_netmonitor.markdown b/source/_components/fritzbox_netmonitor.markdown index 078db2dead6..fced5ad5c9f 100644 --- a/source/_components/fritzbox_netmonitor.markdown +++ b/source/_components/fritzbox_netmonitor.markdown @@ -63,5 +63,5 @@ The following statistics will be exposed as attributes. The sensor's state corresponds to the `is_linked` attribute and is either `online`, `offline`, or `unavailable` (in case connection to the router is lost).

-This component does not support "Fritz!Box 6490 Cable" with FritzOS 6.87 installed. +This integration does not support "Fritz!Box 6490 Cable" with FritzOS 6.87 installed.

diff --git a/source/_components/fritzdect.markdown b/source/_components/fritzdect.markdown index e5ece61a230..1b568645d31 100644 --- a/source/_components/fritzdect.markdown +++ b/source/_components/fritzdect.markdown @@ -57,5 +57,5 @@ host: It is recommended to create a dedicated user for Home Assistant and only allow access to "Smart Home".

-If this component throws an error when starting home-assistant you should check if all actors are plugged in and connected to the FritzBox. Inactive actors that are not deleted from FritzBox configuration might lead to errors. +If this integration throws an error when starting home-assistant you should check if all actors are plugged in and connected to the FritzBox. Inactive actors that are not deleted from FritzBox configuration might lead to errors.

diff --git a/source/_components/frontier_silicon.markdown b/source/_components/frontier_silicon.markdown index aa34ceca451..02c79c90b89 100644 --- a/source/_components/frontier_silicon.markdown +++ b/source/_components/frontier_silicon.markdown @@ -15,7 +15,7 @@ redirect_from: - /components/media_player.frontier_silicon/ --- -This component provides support for Internet Radios based on the [Frontier Silicon chipset]. Some of the manufacturers which offer products based on these chips include: Hama, Medion, Slivercrest, Auna, Technisat, Revo, Pinnel, etc. These devices will be usually controlled by the [UNDOK] app. +This integration provides support for Internet Radios based on the [Frontier Silicon chipset]. Some of the manufacturers which offer products based on these chips include: Hama, Medion, Slivercrest, Auna, Technisat, Revo, Pinnel, etc. These devices will be usually controlled by the [UNDOK] app. ## {% linkable_title Supported Models %} * Hama: [IR110], [DIR3110] @@ -23,7 +23,7 @@ This component provides support for Internet Radios based on the [Frontier Silic * Silvercrest: [SIRD 14 C2] * Some models from: Auna, Technisat, Revo, Pinell -This component was developed and tested with a Hama [DIR3110] and a Medion [MD 87466]. +This integration was developed and tested with a Hama [DIR3110] and a Medion [MD 87466]. ## Configuration @@ -90,12 +90,12 @@ Overview of the info dialog: ## Development Support is provided through the Python [fsapi] module. The Python module was developed by using the documentation provided by [flammy] and -is based on [tiwillam]'s fsapi project. Special thanks to both developers, this component would have not been possible without their work. +is based on [tiwillam]'s fsapi project. Special thanks to both developers, this integration would have not been possible without their work. ## Notes and Limitations

-The Frontier Silicon API does not provide a multi-user environment. There is always a single user (session) controlling a device, which means that once Home Assistant connects to a device all other sessions will be invalidated. This renders the usage of [UNDOK] almost impossible, as the Home Assistant component polls the device state every 30 seconds or issues a command by creating a new session. +The Frontier Silicon API does not provide a multi-user environment. There is always a single user (session) controlling a device, which means that once Home Assistant connects to a device all other sessions will be invalidated. This renders the usage of [UNDOK] almost impossible, as the Home Assistant integration polls the device state every 30 seconds or issues a command by creating a new session. *If you want to prevent Home Assistant to auto connect to your device, simply change the PIN code of the device to something else than: 1234*

diff --git a/source/_components/generic_thermostat.markdown b/source/_components/generic_thermostat.markdown index 73ebdecab89..3a2f6dda052 100644 --- a/source/_components/generic_thermostat.markdown +++ b/source/_components/generic_thermostat.markdown @@ -74,7 +74,7 @@ hot_tolerance: default: 0.3 type: float keep_alive: - description: Set a keep-alive interval. If set, the switch specified in the *heater* option will be triggered every time the interval elapses. Use with heaters and A/C units that shut off if they don't receive a signal from their remote for a while. Use also with switches that might lose state. The keep-alive call is done with the current valid climate component state (either on or off). + description: Set a keep-alive interval. If set, the switch specified in the *heater* option will be triggered every time the interval elapses. Use with heaters and A/C units that shut off if they don't receive a signal from their remote for a while. Use also with switches that might lose state. The keep-alive call is done with the current valid climate integration state (either on or off). required: false type: [time, integer] initial_operation_mode: diff --git a/source/_components/geofency.markdown b/source/_components/geofency.markdown index 70abf05f026..0383f42f051 100644 --- a/source/_components/geofency.markdown +++ b/source/_components/geofency.markdown @@ -16,7 +16,7 @@ redirect_from: - /components/device_tracker.geofency/ --- -This component sets up integration with [Geofency](http://www.geofency.com/). Geofency is a paid app for iOS that lets users to configure a request that will be sent when a geofence or iBeacon region is entered or exited. This can be configured with Home Assistant to update your location. +This integration sets up integration with [Geofency](http://www.geofency.com/). Geofency is a paid app for iOS that lets users to configure a request that will be sent when a geofence or iBeacon region is entered or exited. This can be configured with Home Assistant to update your location. ## {% linkable_title Configuration %} @@ -33,7 +33,7 @@ mobile_beacons: type: list {% endconfiguration %} -A sample configuration for the `geofency` component when using mobile beacons is shown below: +A sample configuration for the `geofency` integration when using mobile beacons is shown below: ```yaml # Example configuration.yaml entry diff --git a/source/_components/goalfeed.markdown b/source/_components/goalfeed.markdown index 9874df36e4a..284c1b238f6 100644 --- a/source/_components/goalfeed.markdown +++ b/source/_components/goalfeed.markdown @@ -13,7 +13,7 @@ ha_category: ha_release: 0.63 --- -The `goalfeed` component lets you use your Goalfeed account to trigger events in Home Assistant whenever a NHL or MLB team scores. +The `goalfeed` integration lets you use your Goalfeed account to trigger events in Home Assistant whenever a NHL or MLB team scores. To use this component, enter your email address and password from your goalfeed.ca account in your `configuration.yaml` file: diff --git a/source/_components/google_assistant.markdown b/source/_components/google_assistant.markdown index 498a9910ae3..b87d9a13c38 100644 --- a/source/_components/google_assistant.markdown +++ b/source/_components/google_assistant.markdown @@ -14,7 +14,7 @@ featured: true ha_release: 0.56 --- -The `google_assistant` component allows you to control things via Google Assistant (on your mobile or tablet) or a Google Home device. +The `google_assistant` integration allows you to control things via Google Assistant (on your mobile or tablet) or a Google Home device. ## {% linkable_title Automatic setup via Home Assistant Cloud %} @@ -24,7 +24,7 @@ For Home Assistant Cloud Users, documentation can be found [here](https://www.na ## {% linkable_title Manual setup %} -The Google Assistant component requires a bit more setup than most due to the way Google requires Assistant Apps to be set up. +The Google Assistant integration requires a bit more setup than most due to the way Google requires Assistant Apps to be set up.

To use Google Assistant, your Home Assistant configuration has to be [externally accessible with a hostname and SSL certificate](/docs/configuration/remote/). If you haven't already configured that, you should do so before continuing. @@ -81,7 +81,7 @@ You need to create an API Key with the [Google Cloud API Console](https://consol Screenshot: Account linking 3. Back on the overview page. Click `Simulator` under `TEST`. It will create a new draft version Test App. You don't have to actually test, but you need to generate this draft version Test App. -4. Add the `google_assistant` component configuration to your `configuration.yaml` file and restart Home Assistant following the [configuration guide](#configuration) below. +4. Add the `google_assistant` integration configuration to your `configuration.yaml` file and restart Home Assistant following the [configuration guide](#configuration) below. 5. Open the Google Home app and go into `Account > Settings > Assistant > Home Control`. 6. Click the `+` sign, and near the bottom, you should have `[test] your app name` listed under 'Add new.' Selecting that should lead you to a browser to login your Home Assistant instance, then redirect back to a screen where you can set rooms for your devices or nicknames for your devices.

diff --git a/source/_components/google_domains.markdown b/source/_components/google_domains.markdown index bbbf3a95f13..9c8928665af 100644 --- a/source/_components/google_domains.markdown +++ b/source/_components/google_domains.markdown @@ -13,11 +13,11 @@ ha_category: ha_release: 0.57 --- -With the Google Domains component you can keep your Google Domains record up to date. +With the Google Domains integration you can keep your Google Domains record up to date. ## {% linkable_title Configuration %} -To use the component in your installation, add the following to your `configuration.yaml` file: +To use the integration in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/google_pubsub.markdown b/source/_components/google_pubsub.markdown index 52413354f72..43458397e7e 100644 --- a/source/_components/google_pubsub.markdown +++ b/source/_components/google_pubsub.markdown @@ -13,7 +13,7 @@ ha_category: ha_release: 0.88 --- -The `google_pubsub` component allows you to hook into the Home Assistant event bus and send events to [Google Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/overview). The current [free tier](https://cloud.google.com/free/) of GCP should allow you to sync about 1 event every 2 seconds on average (2 million invocations per month). +The `google_pubsub` integration allows you to hook into the Home Assistant event bus and send events to [Google Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/overview). The current [free tier](https://cloud.google.com/free/) of GCP should allow you to sync about 1 event every 2 seconds on average (2 million invocations per month). ## {% linkable_title First time setup %} diff --git a/source/_components/google_translate.markdown b/source/_components/google_translate.markdown index e7978829b57..eb670a40413 100644 --- a/source/_components/google_translate.markdown +++ b/source/_components/google_translate.markdown @@ -54,7 +54,7 @@ tts: language: 'de' ``` -If you are using SSL certificate or Docker, you may need to add the `base_url` configuration variable to your `http` component as follows: +If you are using SSL certificate or Docker, you may need to add the `base_url` configuration variable to your `http` integration as follows: ```yaml #Example configuration.yaml entry diff --git a/source/_components/googlehome.markdown b/source/_components/googlehome.markdown index f1aa57feb75..5347dc7f12e 100644 --- a/source/_components/googlehome.markdown +++ b/source/_components/googlehome.markdown @@ -18,15 +18,15 @@ redirect_from: - /components/device_tracker.googlehome/ --- -The `googlehome` component allows you to connect to your Google Home device using an [unofficial Google Home API][googlehomeapi]. +The `googlehome` integration allows you to connect to your Google Home device using an [unofficial Google Home API][googlehomeapi]. -This component will provide: +This integration will provide: - [device_tracker](/components/device_tracker/) platform to track nearby bluetooth devices; - [sensor](/components/sensor/) platform to track the alarms and the timers. ## {% linkable_title Configuration %} -To integrate the `googlehome` component in Home Assistant, add the following section to your `configuration.yaml` file: +To integrate the `googlehome` integration in Home Assistant, add the following section to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -55,12 +55,12 @@ devices: required: false type: list track_alarms: - description: Setting to tell the component to track the alarms of the device. + description: Setting to tell the integration to track the alarms of the device. required: false type: boolean default: false track_devices: - description: Setting to tell the component to track nearby devices. + description: Setting to tell the integration to track nearby devices. required: false type: boolean default: true diff --git a/source/_components/gpsd.markdown b/source/_components/gpsd.markdown index 4e51ca7adac..cfb4796d4d4 100644 --- a/source/_components/gpsd.markdown +++ b/source/_components/gpsd.markdown @@ -16,7 +16,7 @@ redirect_from: - /components/sensor.gpsd/ --- -The `gpsd` component is using the GPS information collected by [gpsd](http://catb.org/gpsd/) and a GPS receiver. +The `gpsd` integration is using the GPS information collected by [gpsd](http://catb.org/gpsd/) and a GPS receiver. ## {% linkable_title Setup %} diff --git a/source/_components/gpslogger.markdown b/source/_components/gpslogger.markdown index 3174e7b7892..1d2308e837e 100644 --- a/source/_components/gpslogger.markdown +++ b/source/_components/gpslogger.markdown @@ -16,7 +16,7 @@ redirect_from: - /components/device_tracker.gpslogger/ --- -This component sets up integration with [GPSLogger](https://gpslogger.app/). GPSLogger is an open source app for Android that allows users to update your location in Home Assistant. +This integration sets up integration with [GPSLogger](https://gpslogger.app/). GPSLogger is an open source app for Android that allows users to update your location in Home Assistant. ## {% linkable_title Configuration %} diff --git a/source/_components/graphite.markdown b/source/_components/graphite.markdown index 15dfbc74b05..902bb85fa71 100644 --- a/source/_components/graphite.markdown +++ b/source/_components/graphite.markdown @@ -13,7 +13,7 @@ ha_category: ha_release: 0.13 --- -The `graphite` component records all events and state changes and feeds the data to a [graphite](http://graphite.wikidot.com/) instance. +The `graphite` integration records all events and state changes and feeds the data to a [graphite](http://graphite.wikidot.com/) instance. To enable this component, add the following lines to your `configuration.yaml`: diff --git a/source/_components/greeneye_monitor.markdown b/source/_components/greeneye_monitor.markdown index 0c0bd4cb7b9..84b8afdbd12 100644 --- a/source/_components/greeneye_monitor.markdown +++ b/source/_components/greeneye_monitor.markdown @@ -44,7 +44,7 @@ greeneye_monitor: name: back_porch_temperature ``` -By default, GEM will send updates every 5 seconds. That's a lot of data, and the databases used by the [`recorder`](/components/recorder) component for history don't do well with that much data, so it is recommended to configure the [`influxdb`](/components/influxdb) component and exclude the GEM sensors from `recorder`. +By default, GEM will send updates every 5 seconds. That's a lot of data, and the databases used by the [`recorder`](/components/recorder) integration for history don't do well with that much data, so it is recommended to configure the [`influxdb`](/components/influxdb) integration and exclude the GEM sensors from `recorder`. {% configuration %} port: diff --git a/source/_components/greenwave.markdown b/source/_components/greenwave.markdown index 23f123b69fe..6e19678ab47 100644 --- a/source/_components/greenwave.markdown +++ b/source/_components/greenwave.markdown @@ -16,9 +16,9 @@ redirect_from: - /components/light.greenwave/ --- -This component communicates with the Greenwave Reality (TCP Connected) Gateway to allow control of all lights and fixtures registered to the gateway. Bulbs and Fixtures can be created and modified inside the TCP Lighting App for Android and iOS. +This integration communicates with the Greenwave Reality (TCP Connected) Gateway to allow control of all lights and fixtures registered to the gateway. Bulbs and Fixtures can be created and modified inside the TCP Lighting App for Android and iOS. -This component has been tested on firmware revisions: +This integration has been tested on firmware revisions: - 2.0.105 diff --git a/source/_components/group.markdown b/source/_components/group.markdown index 830f5de89d5..cb183fd77b2 100644 --- a/source/_components/group.markdown +++ b/source/_components/group.markdown @@ -66,7 +66,7 @@ control: ## {% linkable_title Default groups %} -Some components automatically create special groups containing component entities. These groups are named like `group.all_...`, for example: +Some integrations automatically create special groups containing integration entities. These groups are named like `group.all_...`, for example: - `group.all_switches` - `group.all_lights` diff --git a/source/_components/habitica.markdown b/source/_components/habitica.markdown index f6d5ecbfeef..2e8ddb96894 100644 --- a/source/_components/habitica.markdown +++ b/source/_components/habitica.markdown @@ -17,7 +17,7 @@ redirect_from: - /components/sensor.habitica/ --- -This component allows you to monitor and manage your Habitica profile. This component exposes the [Habitica's API](https://habitica.com/apidoc/) as a Home Assistant service. It supports multiple users and allows you to automate checking out your habits and daily tasks or casting magics using Home Assistant. +This integration allows you to monitor and manage your Habitica profile. This integration exposes the [Habitica's API](https://habitica.com/apidoc/) as a Home Assistant service. It supports multiple users and allows you to automate checking out your habits and daily tasks or casting magics using Home Assistant. There is currently support for the following device types within Home Assistant: @@ -25,7 +25,7 @@ There is currently support for the following device types within Home Assistant: The sensors will automatically appear, after setup the Habitica component. -To use the component you should use this example configuration: +To use the integration you should use this example configuration: ```yaml # Minimum viable configuration.yaml entry diff --git a/source/_components/hangouts.markdown b/source/_components/hangouts.markdown index 377c3d7164b..0df9b7db699 100644 --- a/source/_components/hangouts.markdown +++ b/source/_components/hangouts.markdown @@ -16,13 +16,13 @@ redirect_from: - /components/notify.hangouts/ --- -This component allows you to send messages to [Google Hangouts](https://hangouts.google.com) conversations, as well as to react to messages in conversations. Reacting to commands is accomplished by firing an event when one of the configured commands is triggered. Home Assistant will impersonate a Smartisan YQ603 phone which will then show up in your Google devices. +This integration allows you to send messages to [Google Hangouts](https://hangouts.google.com) conversations, as well as to react to messages in conversations. Reacting to commands is accomplished by firing an event when one of the configured commands is triggered. Home Assistant will impersonate a Smartisan YQ603 phone which will then show up in your Google devices. There is currently support for the following device types within Home Assistant: - [Notifications](#notifications) -## {% linkable_title Setup the component via the frontend %} +## {% linkable_title Setup the integration via the frontend %} Menu: *Configuration* -> *Integrations* @@ -33,7 +33,7 @@ Configure the integration: ## {% linkable_title Manual Authentication %} -If you are sure your email and password are correct, but the component says the login is invalid then you would need to use the manual authentication method. +If you are sure your email and password are correct, but the integration says the login is invalid then you would need to use the manual authentication method. To use the manual method, first you would need to obtain an authorization code (see instructions below for details). @@ -83,7 +83,7 @@ hangouts: {% configuration %} intents: - description: "Intents that the hangouts component should understand." + description: "Intents that the hangouts integration should understand." required: false type: map default: empty @@ -131,7 +131,7 @@ error_suppressed_conversations: The conversations has to be precreated, the conversation id can be obtained from the `hangouts.conversations` entity. Make sure to use quotes around the conversation id or alias to escape special characters (`!`, and `#`) in YAML. -The intent `HangoutsHelp` is part of the component and return a list of all sentences the component unterstand in this conversation. +The intent `HangoutsHelp` is part of the integration and return a list of all sentences the integration unterstand in this conversation. ## {% linkable_title Adding sentences %} @@ -235,7 +235,7 @@ Reconnects the hangouts bot. ### {% linkable_title Automatic reconnect after ip change %} -The hangouts component can't detect if your ip address changes, so it can't automatic reconnect to the Google servers. This is a workaround for this problem. +The hangouts integration can't detect if your ip address changes, so it can't automatic reconnect to the Google servers. This is a workaround for this problem. {% raw %} diff --git a/source/_components/hdmi_cec.markdown b/source/_components/hdmi_cec.markdown index 4cb56e11a41..3576095a136 100644 --- a/source/_components/hdmi_cec.markdown +++ b/source/_components/hdmi_cec.markdown @@ -17,7 +17,7 @@ redirect_from: - /components/switch.hdmi_cec/ --- -The `hdmi_cec` component provides services that allow selecting the active device, powering on all devices, setting all devices to standby and creates switch entities for HDMI devices. Devices are defined in the configuration file by associating HDMI port number and a device name. Connected devices that provide further HDMI ports, such as sound-bars and AVRs are also supported. Devices are listed from the perspective of the CEC-enabled Home Assistant device. Any connected device can be listed, regardless of whether it supports CEC. Ideally the HDMI port number on your device will map correctly the CEC physical address. If it does not, use `cec-client` (part of the `libcec` package) to listen to traffic on the CEC bus and discover the correct numbers. +The `hdmi_cec` integration provides services that allow selecting the active device, powering on all devices, setting all devices to standby and creates switch entities for HDMI devices. Devices are defined in the configuration file by associating HDMI port number and a device name. Connected devices that provide further HDMI ports, such as sound-bars and AVRs are also supported. Devices are listed from the perspective of the CEC-enabled Home Assistant device. Any connected device can be listed, regardless of whether it supports CEC. Ideally the HDMI port number on your device will map correctly the CEC physical address. If it does not, use `cec-client` (part of the `libcec` package) to listen to traffic on the CEC bus and discover the correct numbers. ## {% linkable_title CEC Setup %} @@ -27,7 +27,7 @@ The computer running Home Assistant must support CEC, and of course be connected ### {% linkable_title libcec %} -[libcec](https://github.com/Pulse-Eight/libcec) must be installed for this component to work. Follow the installation instructions for your environment, provided at the link. `libcec` installs Python 3 bindings by default as a system Python module. If you are running Home Assistant in a [Python virtual environment](/docs/installation/virtualenv/), make sure it can access the system module, by either symlinking it or using the `--system-site-packages` flag. +[libcec](https://github.com/Pulse-Eight/libcec) must be installed for this integration to work. Follow the installation instructions for your environment, provided at the link. `libcec` installs Python 3 bindings by default as a system Python module. If you are running Home Assistant in a [Python virtual environment](/docs/installation/virtualenv/), make sure it can access the system module, by either symlinking it or using the `--system-site-packages` flag.

If you are using [Hass.io](/hassio/) then just move forward to the configuration as all requirements are already fulfilled. diff --git a/source/_components/heos.markdown b/source/_components/heos.markdown index ec870a19d39..44e9a75690f 100644 --- a/source/_components/heos.markdown +++ b/source/_components/heos.markdown @@ -24,7 +24,7 @@ The HEOS integration adds support for [HEOS](http://heosbydenon.denon.com) capab ## {% linkable_title Configuration %} -HEOS devices are discovered and setup automatically when the [discovery](/components/discovery) component is enabled. Alternatively, the component can be setup through the frontend control panel integrations page or manually by adding the following to your `configuration.yaml` file: +HEOS devices are discovered and setup automatically when the [discovery](/components/discovery) integration is enabled. Alternatively, the integration can be setup through the frontend control panel integrations page or manually by adding the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -148,7 +148,7 @@ You can play a URL through a HEOS media player using the `media_player.play_medi ### {% linkable_title Debugging %} -The HEOS component will log additional information about commands, events, and other messages when the log level is set to `debug`. Add the the relevent line below to the `configuration.yaml` to enable debug logging: +The HEOS integration will log additional information about commands, events, and other messages when the log level is set to `debug`. Add the the relevent line below to the `configuration.yaml` to enable debug logging: ```yaml logger: diff --git a/source/_components/hipchat.markdown b/source/_components/hipchat.markdown index 7caba355984..e06733ebd7d 100644 --- a/source/_components/hipchat.markdown +++ b/source/_components/hipchat.markdown @@ -16,7 +16,7 @@ redirect_from: ---

-This component will be removed from Home Assistant in the future. Slack has taken over Hipchat and Stride and will therefore stop these platforms. For more information: announcement. +This integration will be removed from Home Assistant in the future. Slack has taken over Hipchat and Stride and will therefore stop these platforms. For more information: announcement.

Hipchat will be discontinued after February 15th, 2019. This to give customers the opportunity to make a switch. diff --git a/source/_components/history.markdown b/source/_components/history.markdown index 52bfedae60d..3bb947defd4 100644 --- a/source/_components/history.markdown +++ b/source/_components/history.markdown @@ -14,7 +14,7 @@ ha_release: pre 0.7 ha_qa_scale: internal --- -The `history` component will track everything that is going on within Home +The `history` integration will track everything that is going on within Home Assistant and allows the user to browse through it. It depends on the `recorder` component for storing the data and uses the same database setting. If any entities are excluded from being recorded, @@ -41,7 +41,7 @@ Drawing is happening 100% in your browser. No data is transferred to anyone at a {% configuration %} exclude: - description: Configure which components should **not** be displayed. + description: Configure which integrations should **not** be displayed. required: false type: map keys: @@ -54,7 +54,7 @@ exclude: required: false type: list include: - description: Configure which components should be displayed. + description: Configure which integrations should be displayed. required: false type: map keys: @@ -145,9 +145,9 @@ history: #### {% linkable_title Implementation details %} The history is stored in a SQLite database `home-assistant_v2.db` within your -configuration directory unless the `recorder` component is set up differently. +configuration directory unless the `recorder` integration is set up differently. - - events table is all events except `time_changed` that happened while recorder component was running. + - events table is all events except `time_changed` that happened while recorder integration was running. - states table contains all the `new_state` values of `state_changed` events. - Inside the states table you have: - `entity_id`: the entity_id of the entity @@ -157,7 +157,7 @@ configuration directory unless the `recorder` component is set up differently. - `last_updated`: timestamp anything has changed (state, attributes) - `created`: timestamp this entry was inserted into the database -When the `history` component queries the states table it only selects states +When the `history` integration queries the states table it only selects states where the state has changed: `WHERE last_changed=last_updated` #### {% linkable_title On dates %} diff --git a/source/_components/history_graph.markdown b/source/_components/history_graph.markdown index 8d3dcfb083d..e7d5ca6d87f 100644 --- a/source/_components/history_graph.markdown +++ b/source/_components/history_graph.markdown @@ -18,9 +18,9 @@ ha_qa_scale: internal

-The `history_graph` component will make the UI display a graph similar to the graphs in `more-info` popups and the [history](/components/history/) panel. If you want to add history graphs to the Lovelace UI, please check the [History Graph Card](/lovelace/history-graph/) configuration as it slightly differs from the component. +The `history_graph` integration will make the UI display a graph similar to the graphs in `more-info` popups and the [history](/components/history/) panel. If you want to add history graphs to the Lovelace UI, please check the [History Graph Card](/lovelace/history-graph/) configuration as it slightly differs from the component. -To use this component in your installation, add the following to your `configuration.yaml` file: +To use this integration in your installation, add the following to your `configuration.yaml` file: ```yaml # Minimal configuration.yaml entry diff --git a/source/_components/history_stats.markdown b/source/_components/history_stats.markdown index 17facd9a152..9d2fa83b8a0 100644 --- a/source/_components/history_stats.markdown +++ b/source/_components/history_stats.markdown @@ -17,9 +17,9 @@ redirect_from: - /components/sensor.history_stats/ --- -The `history_stats` sensor platform provides quick statistics about another component or platforms, using data from the [history](/components/history/). +The `history_stats` sensor platform provides quick statistics about another integration or platforms, using data from the [history](/components/history/). -It can track how long the component has been in a specific state, in a custom time period. +It can track how long the integration has been in a specific state, in a custom time period. Examples of what you can track: @@ -86,15 +86,15 @@ duration: ## {% linkable_title Sensor type %} -Depending on the sensor type you choose, the `history_stats` component can show different values: +Depending on the sensor type you choose, the `history_stats` integration can show different values: - **time**: The default value, which is the tracked time, in hours - **ratio**: The tracked time divided by the length of your period, as a percentage -- **count**: How many times the component you track was changed to the state you track +- **count**: How many times the integration you track was changed to the state you track ## {% linkable_title Time periods %} -The `history_stats` component will execute a measure within a precise time period. You should always provide 2 of the following : +The `history_stats` integration will execute a measure within a precise time period. You should always provide 2 of the following : - When the period starts (`start` variable) - When the period ends (`end` variable) - How long is the period (`duration` variable) diff --git a/source/_components/hitron_coda.markdown b/source/_components/hitron_coda.markdown index 379f44132a7..10d38357a85 100644 --- a/source/_components/hitron_coda.markdown +++ b/source/_components/hitron_coda.markdown @@ -15,7 +15,7 @@ redirect_from: - /components/device_tracker.hitron_coda/ --- -This component offers presence detection by examining devices connected to a [Rogers Hitron CODA](https://www.rogers.com/customer/support/article/wi-fi-password-hitron-coda4582-cgn3amr-cgnm3552-cgn3acr-cgn3) +This integration offers presence detection by examining devices connected to a [Rogers Hitron CODA](https://www.rogers.com/customer/support/article/wi-fi-password-hitron-coda4582-cgn3amr-cgnm3552-cgn3acr-cgn3) or [Shaw Hitron CGNM](https://community.shaw.ca/docs/DOC-4066) Router. To use a Hitron router in your installation, add the following to your `configuration.yaml` file: @@ -49,4 +49,4 @@ type: type: string {% endconfiguration %} -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. diff --git a/source/_components/hive.markdown b/source/_components/hive.markdown index 7241947def8..a32aaaeafc1 100644 --- a/source/_components/hive.markdown +++ b/source/_components/hive.markdown @@ -25,9 +25,9 @@ redirect_from: - /components/switch.hive/ --- -The `hive` component is the main component to set up and integrate all supported Hive devices. Once configured with the minimum required details it will detect and add all your Hive devices into Home Assistant, including support for multizone heating. +The `hive` integration is the main integration to set up and integrate all supported Hive devices. Once configured with the minimum required details it will detect and add all your Hive devices into Home Assistant, including support for multizone heating. -This component uses the unofficial API used in the official Hive website [https://my.hivehome.com](https://my.hivehome.com), and you will need to use the same Username and Password you use on the Hive website to configure this Hive component in Home Assistant. +This integration uses the unofficial API used in the official Hive website [https://my.hivehome.com](https://my.hivehome.com), and you will need to use the same Username and Password you use on the Hive website to configure this Hive integration in Home Assistant. There is currently support for the following device types within Home Assistant: @@ -64,7 +64,7 @@ scan_interval: ## {% linkable_title Binary Sensor %} -The `hive` binary sensor component integrates your Hive sensors into Home Assistant. +The `hive` binary sensor integration integrates your Hive sensors into Home Assistant. The platform supports the following Hive products: @@ -95,7 +95,7 @@ The platform supports the following Hive products: ## {% linkable_title Sensor %} -The `hive` sensor component exposes Hive data as a sensor. +The `hive` sensor integration exposes Hive data as a sensor. The platform exposes the following sensors: diff --git a/source/_components/homekit.markdown b/source/_components/homekit.markdown index fece1ba1b39..bcbc32d7358 100644 --- a/source/_components/homekit.markdown +++ b/source/_components/homekit.markdown @@ -1,7 +1,7 @@ --- layout: page title: "HomeKit" -description: "Instructions on how to set up the HomeKit component in Home Assistant." +description: "Instructions on how to set up the HomeKit integration in Home Assistant." date: 2018-02-20 17:30 sidebar: true comments: false @@ -13,7 +13,7 @@ ha_release: 0.64 logo: apple-homekit.png --- -The `homekit` component allows you to forward entities from Home Assistant to Apple HomeKit, so they can be controlled from Apple's Home app and Siri. Please make sure that you have read the [considerations](#considerations) listed below to save you some trouble later. However if you do encounter issues, check out the [troubleshooting](#troubleshooting) section. +The `homekit` integration allows you to forward entities from Home Assistant to Apple HomeKit, so they can be controlled from Apple's Home app and Siri. Please make sure that you have read the [considerations](#considerations) listed below to save you some trouble later. However if you do encounter issues, check out the [troubleshooting](#troubleshooting) section.

If you want to control `HomeKit` only devices with Home Assistant, check out the [HomeKit controller](/components/homekit_controller/) component. @@ -71,7 +71,7 @@ homekit: type: integer default: 51827 name: - description: Need to be individual for each instance of Home Assistant using the component on the same local network. Between `3` and `25` characters. Alphanumeric and spaces allowed. + description: Need to be individual for each instance of Home Assistant using the integration on the same local network. Between `3` and `25` characters. Alphanumeric and spaces allowed. required: false type: string default: '`Home Assistant Bridge`' @@ -152,7 +152,7 @@ homekit: ## {% linkable_title Setup %} -To enable the HomeKit component in Home Assistant, add the following to your configuration file: +To enable the HomeKit integration in Home Assistant, add the following to your configuration file: ```yaml # Example for HomeKit setup @@ -169,7 +169,7 @@ After Home Assistant has started, the entities specified by the filter are expos 6. Follow the setup by clicking on `Next` and lastly `Done` in the top right-hand corner. 7. The `Home Assistant` Bridge and the Accessories should now be listed in the `Home` app. -After the setup is completed, you should be able to control your Home Assistant components through Apple's Home and Siri. +After the setup is completed, you should be able to control your Home Assistant integrations through Apple's Home and Siri. ## {% linkable_title Move Home Assistant install %} @@ -181,7 +181,7 @@ Before you copy it, make sure to stop the old and new Home Assistant instances f ### {% linkable_title Accessory ID %} -Currently, this component uses the `entity_id` to generate a unique `accessory id (aid)` for `HomeKit`. The `aid` is used to identify a device and save all configurations made for it. This, however, means that if you decide to change an `entity_id` all configurations for this accessory made in the `Home` app will be lost. +Currently, this integration uses the `entity_id` to generate a unique `accessory id (aid)` for `HomeKit`. The `aid` is used to identify a device and save all configurations made for it. This, however, means that if you decide to change an `entity_id` all configurations for this accessory made in the `Home` app will be lost. ### {% linkable_title Device Limit %} @@ -195,7 +195,7 @@ A common situation might be if you decide to disable parts of the configuration ## {% linkable_title Disable Auto Start %} -Depending on your setup, it might be necessary to disable `Auto Start` for all accessories to be available for `HomeKit`. Only those entities that are fully set up when the `HomeKit` component is started, can be added. To start `HomeKit` when `auto_start: false`, you can call the service `homekit.start`. +Depending on your setup, it might be necessary to disable `Auto Start` for all accessories to be available for `HomeKit`. Only those entities that are fully set up when the `HomeKit` integration is started, can be added. To start `HomeKit` when `auto_start: false`, you can call the service `homekit.start`. If you have Z-Wave entities you want to be exposed to HomeKit, then you'll need to disable auto start and then start it after the Z-Wave mesh is ready. This is because the Z-Wave entities won't be fully set up until then. This can be automated using an automation. @@ -223,7 +223,7 @@ automation: ``` {% endraw %} -For a general delay where your component doesn't generate an event, you can also do: +For a general delay where your integration doesn't generate an event, you can also do: {% raw %} ```yaml @@ -324,7 +324,7 @@ To avoid any errors, after you have successfully paired your Home Assistant Brid ## {% linkable_title Supported Components %} -The following components are currently supported: +The following integrations are currently supported: | Component | Type Name | Description | | --------- | --------- | ----------- | @@ -434,11 +434,11 @@ Check if the domain of your entity is [supported](#supported-components). If it #### {% linkable_title HomeKit doesn't work on second Home Assistant instance %} -To use the HomeKit component with to different Home Assistant instances on the same local network, you need to set a custom name for at least one of them. [config/name](#name) +To use the HomeKit integration with to different Home Assistant instances on the same local network, you need to set a custom name for at least one of them. [config/name](#name) #### {% linkable_title Specific entity doesn't work %} -Although we try our best, some entities don't work with the HomeKit component yet. The result will be that either pairing fails completely or all Home Assistant accessories will stop working. Use the filter to identify which entity is causing the issue. It's best to try pairing and step by step including more entities. If it works unpair and repeat until you find the one that is causing the issues. To help others and the developers, please open a new issue here: [home-assistant/issues/new](https://github.com/home-assistant/home-assistant/issues/new?labels=component: homekit) +Although we try our best, some entities don't work with the HomeKit integration yet. The result will be that either pairing fails completely or all Home Assistant accessories will stop working. Use the filter to identify which entity is causing the issue. It's best to try pairing and step by step including more entities. If it works unpair and repeat until you find the one that is causing the issues. To help others and the developers, please open a new issue here: [home-assistant/issues/new](https://github.com/home-assistant/home-assistant/issues/new?labels=component: homekit) #### {% linkable_title Accessories are all listed as not responding %} diff --git a/source/_components/homekit_controller.markdown b/source/_components/homekit_controller.markdown index 74d42d423ea..6e5a0763aab 100644 --- a/source/_components/homekit_controller.markdown +++ b/source/_components/homekit_controller.markdown @@ -30,7 +30,7 @@ redirect_from: - /components/sensor.homekit_controller/ --- -[HomeKit](https://developer.apple.com/homekit/) controller integration for Home Assistant allows you to connect HomeKit accessories to Home Assistant. This component should not be confused with the [HomeKit](/components/homekit/) component, which allows you to control Home Assistant devices via HomeKit. +[HomeKit](https://developer.apple.com/homekit/) controller integration for Home Assistant allows you to connect HomeKit accessories to Home Assistant. This integration should not be confused with the [HomeKit](/components/homekit/) component, which allows you to control Home Assistant devices via HomeKit. There is currently support for the following device types within Home Assistant: @@ -43,7 +43,7 @@ There is currently support for the following device types within Home Assistant: - Binary Sensor (HomeKit motion sensors) - Sensor (HomeKit humidity, temperature, and light level sensors) -The component will be automatically configured if the [`discovery:`](/components/discovery/) component is enabled and an enable entry added for HomeKit: +The integration will be automatically configured if the [`discovery:`](/components/discovery/) integration is enabled and an enable entry added for HomeKit: ```yaml discovery: diff --git a/source/_components/homematic.markdown b/source/_components/homematic.markdown index d8bb9127752..437293e9844 100644 --- a/source/_components/homematic.markdown +++ b/source/_components/homematic.markdown @@ -31,7 +31,7 @@ redirect_from: - /components/switch.homematic/ --- -The [Homematic](http://www.homematic.com/) component provides bi-directional communication with your CCU/Homegear. It uses a XML-RPC connection to set values on devices and subscribes to receive events the devices and the CCU emit. +The [Homematic](http://www.homematic.com/) integration provides bi-directional communication with your CCU/Homegear. It uses a XML-RPC connection to set values on devices and subscribes to receive events the devices and the CCU emit. If you are using Homegear with paired [Intertechno](http://intertechno.at/) devices, uni-directional communication is possible as well. There is currently support for the following device types within Home Assistant: @@ -50,7 +50,7 @@ Device support is available for most of the wired and wireless devices, as well If you want to see if a specific device you have is supported, head over to the [pyhomematic](https://github.com/danielperna84/pyhomematic/tree/master/pyhomematic/devicetypes) repository and browse through the source code. A dictionary with the device identifiers (e.g., HM-Sec-SC-2) can be found within the relevant modules near the bottom. If your device is not supported, feel free to contribute. We automatically detect all devices we currently support and try to generate useful names. If you enable name-resolving, we try to fetch names from Metadata (Homegear), via JSON-RPC or the XML-API you may have installed on your CCU. Since this may fail this is disabled by default. -You can manually rename the created entities by using Home Assistant's [Customizing](/docs/configuration/customizing-devices/) feature. With it you are also able to hide entities you don't want to see in the UI. The HomeMatic component is also supported by the [Entity Registry](https://developers.home-assistant.io/docs/en/entity_registry_index.html), which allows you to change the friendly name and the entity ID directly in the Home Assistant UI. +You can manually rename the created entities by using Home Assistant's [Customizing](/docs/configuration/customizing-devices/) feature. With it you are also able to hide entities you don't want to see in the UI. The HomeMatic integration is also supported by the [Entity Registry](https://developers.home-assistant.io/docs/en/entity_registry_index.html), which allows you to change the friendly name and the entity ID directly in the Home Assistant UI. To set up the component, add the following information to your `configuration.yaml` file: @@ -402,7 +402,7 @@ action: #### {% linkable_title Detecting lost connections %} -When the connection to your HomeMatic CCU or Homegear is lost, Home Assistant will stop getting updates from devices. This may happen after rebooting the CCU for example. Due to the nature of the communication protocol this cannot be handled automatically, so you must call *homematic.reconnect* in this case. That's why it is usually a good idea to check if your HomeMatic components are still updated properly, in order to detect connection losses. This can be done in several ways through an automation: +When the connection to your HomeMatic CCU or Homegear is lost, Home Assistant will stop getting updates from devices. This may happen after rebooting the CCU for example. Due to the nature of the communication protocol this cannot be handled automatically, so you must call *homematic.reconnect* in this case. That's why it is usually a good idea to check if your HomeMatic integrations are still updated properly, in order to detect connection losses. This can be done in several ways through an automation: - If you have a sensor which you know will be updated frequently (e.g., an outdoor temperature sensor, voltage sensor or light sensor) you could set up a helper binary sensor and an automation like this: diff --git a/source/_components/homematicip_cloud.markdown b/source/_components/homematicip_cloud.markdown index 94aa7655f32..800872f7269 100644 --- a/source/_components/homematicip_cloud.markdown +++ b/source/_components/homematicip_cloud.markdown @@ -29,7 +29,7 @@ redirect_from: - /components/switch.homematicip_cloud/ --- -The [HomematicIP](http://www.homematic-ip.com) component platform is used as an interface to the cloud server. Since there is no official documentation about this API, everything was done via reverse engineering. The [homematicip-rest-api](https://github.com/coreGreenberet/homematicip-rest-api) is used for communicating. Use at your own risk. +The [HomematicIP](http://www.homematic-ip.com) integration platform is used as an interface to the cloud server. Since there is no official documentation about this API, everything was done via reverse engineering. The [homematicip-rest-api](https://github.com/coreGreenberet/homematicip-rest-api) is used for communicating. Use at your own risk. There is currently support for the following device types within Home Assistant: @@ -42,7 +42,7 @@ There is currently support for the following device types within Home Assistant: * Switch * Weather -## {% linkable_title Setup the component via the frontend %} +## {% linkable_title Setup the integration via the frontend %} Menu: *Configuration* -> *Integrations* @@ -53,7 +53,7 @@ Fill the form: The authentification token will be generated and stored internally. -## {% linkable_title Setup the component using the configuration files %} +## {% linkable_title Setup the integration using the configuration files %} Generate the authentication token: diff --git a/source/_components/homeworks.markdown b/source/_components/homeworks.markdown index 2414a39019d..8ac001abbff 100644 --- a/source/_components/homeworks.markdown +++ b/source/_components/homeworks.markdown @@ -18,17 +18,17 @@ redirect_from: - /components/light.homeworks/ --- -[Lutron](http://www.lutron.com/) is an American lighting control company. The Lutron Homeworks Series 4 & 8 systems are relatively old (~2003), and use RS-232 connections to communicate with home automation systems. The `homeworks` component in Home Assistant is responsible for communicating with the main controller for these systems. Communication is through an ethernet to serial converter (NPort, for example). +[Lutron](http://www.lutron.com/) is an American lighting control company. The Lutron Homeworks Series 4 & 8 systems are relatively old (~2003), and use RS-232 connections to communicate with home automation systems. The `homeworks` integration in Home Assistant is responsible for communicating with the main controller for these systems. Communication is through an ethernet to serial converter (NPort, for example). Only a subset of the Homeworks system is supported - lights and keypads. -Lutron has created many systems over the years, each with their own unique interfacing protocol. There are three Homeworks systems - QS, Series 4 & 8, and original. This platform is only for Series 4 & 8. There is another component [lutron](/components/lutron/) which handles Lutron RadioRA 2 systems. +Lutron has created many systems over the years, each with their own unique interfacing protocol. There are three Homeworks systems - QS, Series 4 & 8, and original. This platform is only for Series 4 & 8. There is another integration [lutron](/components/lutron/) which handles Lutron RadioRA 2 systems. Homeworks keypad buttons are momentary switches. The button is pressed and released, meaning that there is no "state". Buttons generate `homeworks_button_press` and `homeworks_button_release` events. These events contain the "id", "name", and "button" of the button that was pressed. "id" is derived from "name", and "button" is the number of the button on the keypad (starting at 1). ## {% linkable_title Configuration %} -The protocol for automatically extracting device information from the controller isn't documented, so the `homeworks` component must be configured manually. To use Lutron Homeworks devices in your installation, add the following to your `configuration.yaml` file: +The protocol for automatically extracting device information from the controller isn't documented, so the `homeworks` integration must be configured manually. To use Lutron Homeworks devices in your installation, add the following to your `configuration.yaml` file: ``` yaml # Example configuration.yaml entry diff --git a/source/_components/hook.markdown b/source/_components/hook.markdown index 787bf6c8fa0..2b23bf0bed1 100644 --- a/source/_components/hook.markdown +++ b/source/_components/hook.markdown @@ -15,13 +15,13 @@ redirect_from: - /components/switch.hook/ --- -The `hook` component allows you to control the [Hook Smart Home Hub](http://www.hooksmarthome.com/) from within Home Assistant. +The `hook` integration allows you to control the [Hook Smart Home Hub](http://www.hooksmarthome.com/) from within Home Assistant. Hook allows you to control cheap mains electrical outlets, like these ones at [Amazon](https://amzn.to/2WVZdGG). In short, Hook is an RF to Wi-Fi bridge, controlling devices that receive commands at 315MHz and 433MHz. Unfortunately, this does not allow Hook to determine if the command was successful, so the state is assumed. -Hook provides a simple [REST API](https://app.swaggerhub.com/api/rahilj/GetHook_RestAPI/v1). This Home Assistant component reads in devices that have been set up in the official app. +Hook provides a simple [REST API](https://app.swaggerhub.com/api/rahilj/GetHook_RestAPI/v1). This Home Assistant integration reads in devices that have been set up in the official app. ## {% linkable_title Configuration %} diff --git a/source/_components/horizon.markdown b/source/_components/horizon.markdown index 61b49c76999..fea3cf69fb4 100644 --- a/source/_components/horizon.markdown +++ b/source/_components/horizon.markdown @@ -16,7 +16,7 @@ redirect_from: - /components/media_player.horizon/ --- -The `horizon` component allows you to control a [Unitymedia](https://www.unitymedia.de) Horizon HD Recorder from Home Assistant. +The `horizon` integration allows you to control a [Unitymedia](https://www.unitymedia.de) Horizon HD Recorder from Home Assistant. To add a Horizon HD Recorder to your installation, add the following to your `configuration.yaml` file: @@ -45,4 +45,4 @@ media_player: #### {% linkable_title Preparation of the Horizon HD Recorder %} -The Home Networking ("Heimnetzwerk") service needs to be enabled at the settings menu of the Horizon receiver. Once you have set up the Media Library ("Medienbibliothek"), we can determine whether the device is turned on or off. Without this, the component will fail to start. +The Home Networking ("Heimnetzwerk") service needs to be enabled at the settings menu of the Horizon receiver. Once you have set up the Media Library ("Medienbibliothek"), we can determine whether the device is turned on or off. Without this, the integration will fail to start. diff --git a/source/_components/hp_ilo.markdown b/source/_components/hp_ilo.markdown index da2dc4603ae..fdd982b7fe2 100644 --- a/source/_components/hp_ilo.markdown +++ b/source/_components/hp_ilo.markdown @@ -28,7 +28,7 @@ Some more details about what can be retrieved from these sensors is available in ## {% linkable_title Configuration %} -To use this component in your installation, add the following to your `configuration.yaml` file: +To use this integration in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/http.markdown b/source/_components/http.markdown index 3235e4667eb..eeb7c4952b9 100644 --- a/source/_components/http.markdown +++ b/source/_components/http.markdown @@ -20,7 +20,7 @@ redirect_from: - /components/sensor.http/ --- -The `http` component serves all files and data required for the Home Assistant frontend. You only need to add this to your configuration file if you want to change any of the default settings. +The `http` integration serves all files and data required for the Home Assistant frontend. You only need to add this to your configuration file if you want to change any of the default settings. There is currently support for the following device types within Home Assistant: @@ -103,7 +103,7 @@ ssl_profile: {% endconfiguration %}

-Configuring trusted_networks via the `http` component will be deprecated and moved to `auth_providers` instead. For instructions, see trusted networks. In Home Assistant 0.89.0 and 0.89.1, you need place the trusted network under both `http` and `auth_providers` if you still want to use trusted networks features. You can remove it from `http` section starting from 0.89.2. +Configuring trusted_networks via the `http` integration will be deprecated and moved to `auth_providers` instead. For instructions, see trusted networks. In Home Assistant 0.89.0 and 0.89.1, you need place the trusted network under both `http` and `auth_providers` if you still want to use trusted networks features. You can remove it from `http` section starting from 0.89.2.

The sample below shows a configuration entry with possible values: @@ -130,7 +130,7 @@ Or use a self signed certificate following the instructions here [Self-signed ce ## {% linkable_title APIs %} -On top of the `http` component is a [REST API](/developers/rest_api/), [Python API](/developers/python_api/) and [WebSocket API](/developers/websocket_api/) available. There is also support for [Server-sent events](/developers/server_sent_events/). +On top of the `http` integration is a [REST API](/developers/rest_api/), [Python API](/developers/python_api/) and [WebSocket API](/developers/websocket_api/) available. There is also support for [Server-sent events](/developers/server_sent_events/). The `http` platforms are not real platforms within the meaning of the terminology used around Home Assistant. Home Assistant's [REST API](/developers/rest_api/) sends and receives messages over HTTP. diff --git a/source/_components/huawei_lte.markdown b/source/_components/huawei_lte.markdown index e4b669e5159..9a1133cc658 100644 --- a/source/_components/huawei_lte.markdown +++ b/source/_components/huawei_lte.markdown @@ -61,14 +61,14 @@ password: ### {% linkable_title Tested routers %} -Routers we know to be working with this component based on the documentation of used libraries and reports by users: +Routers we know to be working with this integration based on the documentation of used libraries and reports by users: - Huawei B310s-22 - Huawei B525s-23a - Huawei E5186s-22a - Huawei B618 -This is not a complete list. The component can probably connect to other Huawei LTE routers running similar firmware. +This is not a complete list. The integration can probably connect to other Huawei LTE routers running similar firmware. ## {% linkable_title Presence Detection %} @@ -82,7 +82,7 @@ device_tracker: - platform: huawei_lte ``` -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. ## {% linkable_title Notifications %} diff --git a/source/_components/huawei_router.markdown b/source/_components/huawei_router.markdown index 31ecacd2b4d..eee20dcff20 100644 --- a/source/_components/huawei_router.markdown +++ b/source/_components/huawei_router.markdown @@ -47,4 +47,4 @@ password: type: string {% endconfiguration %} -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. diff --git a/source/_components/hue.markdown b/source/_components/hue.markdown index 60d5ba0f198..8fbb22e7cd7 100644 --- a/source/_components/hue.markdown +++ b/source/_components/hue.markdown @@ -32,7 +32,7 @@ When you configure the Hue bridge from Home Assistant, it writes a token to a fi Once registration is complete you should see the Hue lights listed as `light` entities, Hue presence sensors listed as `binary_sensor` entites, Hue temperature and light level sensors listed as `sensor` entities. If you don't you may have to restart Home Assistant once more. -If you want to enable the component without relying on the [discovery component](/components/discovery/), add the following lines to your `configuration.yaml` file: +If you want to enable the integration without relying on the [discovery component](/components/discovery/), add the following lines to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -43,7 +43,7 @@ hue: {% configuration %} host: - description: The IP address of the device, e.g., 192.168.1.10. Required if not using the `discovery` component to discover Hue bridges. + description: The IP address of the device, e.g., 192.168.1.10. Required if not using the `discovery` integration to discover Hue bridges. required: true type: string allow_unreachable: diff --git a/source/_components/hydrawise.markdown b/source/_components/hydrawise.markdown index 7020eda923c..3ec24f8dc7e 100644 --- a/source/_components/hydrawise.markdown +++ b/source/_components/hydrawise.markdown @@ -21,7 +21,7 @@ redirect_from: - /components/switch.hydrawise/ --- -The `hydrawise` component allows you to integrate your [Hunter Hydrawise](https://hydrawise.com) Wi-Fi irrigation controller system in Home Assistant. +The `hydrawise` integration allows you to integrate your [Hunter Hydrawise](https://hydrawise.com) Wi-Fi irrigation controller system in Home Assistant. There is currently support for the following device types within Home Assistant: diff --git a/source/_components/icloud.markdown b/source/_components/icloud.markdown index 46da072f17d..69aa317b105 100644 --- a/source/_components/icloud.markdown +++ b/source/_components/icloud.markdown @@ -66,11 +66,11 @@ You may receive an email from Apple stating that someone has logged into your ac To disable the drainage of the battery, a dynamic interval is being used for each individual device instead of a fixed interval for all devices linked to one account. The dynamic interval is based on the current zone of a device, the distance towards home and the battery level of the device. -If 2 Step Authentication is enabled for your iCloud account. The component will ask which device you want to use as Trusted Device and component will send a prompt to that device with the code which you can enter in Home Assistant. The duration of this authentication is determined by Apple, but is now at 2 months, so you will only need to verify your account each two months. +If 2 Step Authentication is enabled for your iCloud account. The integration will ask which device you want to use as Trusted Device and integration will send a prompt to that device with the code which you can enter in Home Assistant. The duration of this authentication is determined by Apple, but is now at 2 months, so you will only need to verify your account each two months. 2 Factor Authentication is the improved version of 2 Step Authentication, this is still not supported by the pyicloud library. Therefore it's not possible to use it with the device_tracker yet. 4 services are available for this component: - **icloud_update**: This service can be used to ask for an update of a certain iDevice. The `account_name` and `device_name` are optional. Request will result in new Home Assistant [state_changed](/docs/configuration/events/#event-state_changed) event describing current iphone location. Can be used in automations when manual location update is needed, e.g., to check if anyone is home when door's been opened. - **icloud_lost_iphone**: This service will play the Lost iPhone sound on a certain iDevice. The `account_name` and `device_name` are optional. - **icloud_set_interval**: This service will change the dynamic interval of an iDevice. The `account_name` and `device_name` are optional. If `interval` is used in the service_data, the iDevice will be updated with that new interval. That interval will be fixed until the iDevice changes zone or if this service is called again. If `interval` isn't used in the service_data, the interval for that iDevice will revert back to its default dynamic interval based on its current zone, its distance towards home and its battery level. -- **icloud_reset_account**: This service can be used to reset an iCloud account. This is helpful when not all devices are found by the component or if you have added a new iDevice to your account. The `account_name` is optional. +- **icloud_reset_account**: This service can be used to reset an iCloud account. This is helpful when not all devices are found by the integration or if you have added a new iDevice to your account. The `account_name` is optional. diff --git a/source/_components/idteck_prox.markdown b/source/_components/idteck_prox.markdown index 92145873a5d..cbd04ba75b0 100644 --- a/source/_components/idteck_prox.markdown +++ b/source/_components/idteck_prox.markdown @@ -14,7 +14,7 @@ ha_release: 0.85 ha_iot_class: Local Push --- -[IDTECK](http://www.idteck.com) makes ID systems used to control access and identify users. This component works with [Proximity Readers](http://www.idteck.com/en/products/proximity-reader-__-card-%26-tag-__125khz) (RFID card readers). The device is connected to Home Assistant through a serial to ethernet converter (NPort). +[IDTECK](http://www.idteck.com) makes ID systems used to control access and identify users. This integration works with [Proximity Readers](http://www.idteck.com/en/products/proximity-reader-__-card-%26-tag-__125khz) (RFID card readers). The device is connected to Home Assistant through a serial to ethernet converter (NPort). An `idteck_prox_keycard` event is fired whenever a card or key sequence has been entered. The event contains 'card' - the card/key sequence, and the 'name' of the card reader. Checking 'card' against known card numbers can be used as the basis of an entry control system, or as part of a check-in/check-out system. diff --git a/source/_components/ifttt.markdown b/source/_components/ifttt.markdown index a926362e593..f020b557c2e 100644 --- a/source/_components/ifttt.markdown +++ b/source/_components/ifttt.markdown @@ -19,7 +19,7 @@ ha_release: 0.80 ## {% linkable_title Sending events from IFTTT to Home Assistant %} -To be able to receive events from IFTTT, your Home Assistant instance needs to be accessible from the web ([Hass.io instructions](/addons/duckdns/)) and you need to have the `base_url` configured for the HTTP component ([docs](/components/http/#base_url)). +To be able to receive events from IFTTT, your Home Assistant instance needs to be accessible from the web ([Hass.io instructions](/addons/duckdns/)) and you need to have the `base_url` configured for the HTTP integration ([docs](/components/http/#base_url)). ### {% linkable_title Setting up the integration %} @@ -66,7 +66,7 @@ ifttt: Property screen of the Maker Channel

-Once you have added your key to your `configuration.yaml` file, restart your Home Assistant server. This will load up the IFTTT component and make a service available to trigger events in IFTTT. +Once you have added your key to your `configuration.yaml` file, restart your Home Assistant server. This will load up the IFTTT integration and make a service available to trigger events in IFTTT.

After restarting the server, be sure to watch the console for any logging errors that show up in red, white or yellow. diff --git a/source/_components/ihc.markdown b/source/_components/ihc.markdown index c2908dee144..8ead80d665c 100644 --- a/source/_components/ihc.markdown +++ b/source/_components/ihc.markdown @@ -1,7 +1,7 @@ --- layout: page title: "IHC" -description: "Instructions on how to integrate the IHC components with Home Assistant" +description: "Instructions on how to integrate the IHC integrations with Home Assistant" date: 2017-11-11 22:00 sidebar: true comments: false @@ -71,13 +71,13 @@ info: ## {% linkable_title Auto setup of IHC products %} -If the auto setup is enabled, the `ihc` component will automatically find IHC products and insert these as devices in Home Assistant. To disable this set auto_setup to false. See the individual device types for a list of IHC products to be recognized automatically. +If the auto setup is enabled, the `ihc` integration will automatically find IHC products and insert these as devices in Home Assistant. To disable this set auto_setup to false. See the individual device types for a list of IHC products to be recognized automatically. Components will get a default name that is a combination of the IHC group and IHC resource id. If you want to change the display names use the [Customizing entities](/docs/configuration/customizing-devices/). ## {% linkable_title Manual setup %} -Each device is associated with an IHC resource id. To manually setup components you specify resource ids from the IHC project. The IHC project is the file you edit/upload to the IHC Controller using LK IHC Visual - or similar program if your controller is not the LK brand. +Each device is associated with an IHC resource id. To manually setup integrations you specify resource ids from the IHC project. The IHC project is the file you edit/upload to the IHC Controller using LK IHC Visual - or similar program if your controller is not the LK brand. The project file is an XML file and you can view it with any text/XML editor. You can rename it to have the XML extension and use a browser like Chrome or Internet Explorer. The resources are the \ or \ elements. Shown as inputs or outputs of products in the IHC application. You can also use inputs and outputs from function blocks. These are the \ and \ elements from the project file. diff --git a/source/_components/image_processing.markdown b/source/_components/image_processing.markdown index d2dfd222ce2..3311c755604 100644 --- a/source/_components/image_processing.markdown +++ b/source/_components/image_processing.markdown @@ -60,7 +60,7 @@ The following event attributes will be present (platform-dependent): `entity_id` ## {% linkable_title scan_interval and Optimising Resources %} -Image processing components process the image from a camera at a fixed period given by the `scan_interval`. This leads to excessive processing if the image on the camera hasn't changed, as the default `scan_interval` is 10 seconds. You can override this by adding to your config `scan_interval: 10000` (setting the interval to 10,000 seconds), and then call the `image_processing.scan` service when you actually want to perform processing. +Image processing integrations process the image from a camera at a fixed period given by the `scan_interval`. This leads to excessive processing if the image on the camera hasn't changed, as the default `scan_interval` is 10 seconds. You can override this by adding to your config `scan_interval: 10000` (setting the interval to 10,000 seconds), and then call the `image_processing.scan` service when you actually want to perform processing. ```yaml # Example configuration.yaml diff --git a/source/_components/imap.markdown b/source/_components/imap.markdown index cd675022fe7..e7aa43b15ba 100644 --- a/source/_components/imap.markdown +++ b/source/_components/imap.markdown @@ -67,7 +67,7 @@ search: ### {% linkable_title Configuring IMAP Searches %} -By default, this component will count unread emails. By configuring the search string, you can count other results, for example: +By default, this integration will count unread emails. By configuring the search string, you can count other results, for example: * `ALL` to count all emails in a folder * `FROM`, `TO`, `SUBJECT` to find emails in a folder (see [IMAP RFC for all standard options](https://tools.ietf.org/html/rfc3501#section-6.4.4)) diff --git a/source/_components/influxdb.markdown b/source/_components/influxdb.markdown index c5d5047e84d..9aa71bbb39e 100644 --- a/source/_components/influxdb.markdown +++ b/source/_components/influxdb.markdown @@ -17,14 +17,14 @@ redirect_from: - /components/sensor.influxdb/ --- -The `influxdb` component makes it possible to transfer all state changes to an external [InfluxDB](https://influxdb.com/) database. See the [official installation documentation](https://docs.influxdata.com/influxdb/v1.7/introduction/installation/) for how to set up an InfluxDB database, or if you're using Hass.io, [there is a community add-on](https://community.home-assistant.io/t/community-hass-io-add-on-influxdb/54491) available. +The `influxdb` integration makes it possible to transfer all state changes to an external [InfluxDB](https://influxdb.com/) database. See the [official installation documentation](https://docs.influxdata.com/influxdb/v1.7/introduction/installation/) for how to set up an InfluxDB database, or if you're using Hass.io, [there is a community add-on](https://community.home-assistant.io/t/community-hass-io-add-on-influxdb/54491) available. There is currently support for the following device types within Home Assistant: - [Sensor](#sensor)

-The `influxdb` database component runs parallel to the Home Assistant database. It does not replace it. +The `influxdb` database integration runs parallel to the Home Assistant database. It does not replace it.

## {% linkable_title Configuration %} @@ -74,7 +74,7 @@ verify_ssl: default: true max_retries: type: integer - description: Set this to allow the component to retry if there was a network error when transmitting data. + description: Set this to allow the integration to retry if there was a network error when transmitting data. required: false default: 0 default_measurement: @@ -88,7 +88,7 @@ override_measurement: required: false exclude: type: list - description: Configure which components should be excluded from recording to InfluxDB. + description: Configure which integrations should be excluded from recording to InfluxDB. required: false keys: entities: @@ -101,7 +101,7 @@ exclude: required: false include: type: list - description: Configure which components should be included in recordings to InfluxDB. If set, all other entities will not be recorded to InfluxDB. Values set by the **exclude** lists will take precedence. + description: Configure which integrations should be included in recordings to InfluxDB. If set, all other entities will not be recorded to InfluxDB. Values set by the **exclude** lists will take precedence. required: false keys: entities: @@ -133,7 +133,7 @@ component_config: component_config_domain: type: string required: false - description: This attribute contains domain-specific component override values. See [Customizing devices and services](/getting-started/customizing-devices/) for format. + description: This attribute contains domain-specific integration override values. See [Customizing devices and services](/getting-started/customizing-devices/) for format. keys: override_measurement: type: string diff --git a/source/_components/input_boolean.markdown b/source/_components/input_boolean.markdown index 711f800b147..0273a07bbb4 100644 --- a/source/_components/input_boolean.markdown +++ b/source/_components/input_boolean.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Input Boolean" -description: "Instructions on how to integrate the Input Boolean component into Home Assistant." +description: "Instructions on how to integrate the Input Boolean integration into Home Assistant." date: 2016-01-17 16:58 sidebar: true comments: false @@ -14,7 +14,7 @@ ha_qa_scale: internal ha_release: 0.11 --- -The `input_boolean` component allows the user to define boolean values that can be controlled via the frontend and can be used within conditions of automation. This can for example be used to disable or enable certain automations. +The `input_boolean` integration allows the user to define boolean values that can be controlled via the frontend and can be used within conditions of automation. This can for example be used to disable or enable certain automations. To enable input booleans in your installation, add the following lines to your `configuration.yaml`: @@ -50,7 +50,7 @@ input_boolean: ### {% linkable_title Restore State %} -This component will automatically restore the state it had prior to Home Assistant stopping as long as your entity does **not** have a set value for `initial`. To disable this feature, set a valid value for `initial`. +This integration will automatically restore the state it had prior to Home Assistant stopping as long as your entity does **not** have a set value for `initial`. To disable this feature, set a valid value for `initial`. ## {% linkable_title Automation Examples %} diff --git a/source/_components/input_datetime.markdown b/source/_components/input_datetime.markdown index 24af729cd29..b77ba74547d 100644 --- a/source/_components/input_datetime.markdown +++ b/source/_components/input_datetime.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Input Datetime" -description: "Instructions on how to integrate the Input Datetime component into Home Assistant." +description: "Instructions on how to integrate the Input Datetime integration into Home Assistant." date: 2017-09-14 16:01 sidebar: true comments: false @@ -14,7 +14,7 @@ ha_release: 0.55 ha_qa_scale: internal --- -The `input_datetime` component allows the user to define date and time values +The `input_datetime` integration allows the user to define date and time values that can be controlled via the frontend and can be used within automations and templates. @@ -81,13 +81,13 @@ automations and templates. ### {% linkable_title Restore State %} -This component will automatically restore the state it had prior to Home +This integration will automatically restore the state it had prior to Home Assistant stopping as long as your entity does **not** have a set value for `initial`. To disable this feature, set a valid value for `initial`. ### {% linkable_title Services %} -This component provides a service to modify the state of the `input_datetime`. +This integration provides a service to modify the state of the `input_datetime`. | Service | Data | Description | | ----- | ----- | ----- | diff --git a/source/_components/input_number.markdown b/source/_components/input_number.markdown index 1fd23355f1f..75ab05c282e 100644 --- a/source/_components/input_number.markdown +++ b/source/_components/input_number.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Input Number" -description: "Instructions on how to integrate the Input Number component into Home Assistant." +description: "Instructions on how to integrate the Input Number integration into Home Assistant." date: 2017-09-19 03:30 sidebar: true comments: false @@ -16,10 +16,10 @@ ha_qa_scale: internal ---

-Before version 0.55 this component was known as `input_slider` and did not have the `mode` configuration option. Also, service `select_value` is now `set_value`. +Before version 0.55 this integration was known as `input_slider` and did not have the `mode` configuration option. Also, service `select_value` is now `set_value`.

-The `input_number` component allows the user to define values that can be controlled via the frontend and can be used within conditions of automation. The frontend can display a slider, or a numeric input box. Changes to the slider or numeric input box generate state events. These state events can be utilized as `automation` triggers as well. +The `input_number` integration allows the user to define values that can be controlled via the frontend and can be used within conditions of automation. The frontend can display a slider, or a numeric input box. Changes to the slider or numeric input box generate state events. These state events can be utilized as `automation` triggers as well. To enable this input number in your installation, add the following lines to your `configuration.yaml`: @@ -86,7 +86,7 @@ input_number: ### {% linkable_title Restore State %} -This component will automatically restore the state it had prior to Home Assistant stopping as long as your entity does **not** have a set value for `initial`. To disable this feature, set a valid value for `initial`. +This integration will automatically restore the state it had prior to Home Assistant stopping as long as your entity does **not** have a set value for `initial`. To disable this feature, set a valid value for `initial`. ## {% linkable_title Automation Examples %} diff --git a/source/_components/input_select.markdown b/source/_components/input_select.markdown index 9da10404134..e5218340884 100644 --- a/source/_components/input_select.markdown +++ b/source/_components/input_select.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Input Select" -description: "Instructions on how to integrate the Input Select component into Home Assistant." +description: "Instructions on how to integrate the Input Select integration into Home Assistant." date: 2016-02-02 17:00 sidebar: true comments: false @@ -14,7 +14,7 @@ ha_release: 0.13 ha_qa_scale: internal --- -The `input_select` component allows the user to define a list of values that can be selected via the frontend and can be used within conditions of automation. When a user selects a new item, a state transition event is generated. This state event can be used in an `automation` trigger. +The `input_select` integration allows the user to define a list of values that can be selected via the frontend and can be used within conditions of automation. When a user selects a new item, a state transition event is generated. This state event can be used in an `automation` trigger. To enable this platform in your installation, add the following lines to your `configuration.yaml`: @@ -66,11 +66,11 @@ Because YAML defines [booleans](http://yaml.org/type/bool.html) as equivalent, a ### {% linkable_title Restore State %} -This component will automatically restore the state it had prior to Home Assistant stopping as long as your entity does **not** have a set value for `initial`. To disable this feature, set a valid value for `initial`. +This integration will automatically restore the state it had prior to Home Assistant stopping as long as your entity does **not** have a set value for `initial`. To disable this feature, set a valid value for `initial`. ### {% linkable_title Services %} -This components provide three services to modify the state of the `input_select`. +This integrations provide three services to modify the state of the `input_select`. | Service | Data | Description | | ------- | ---- | ----------- | diff --git a/source/_components/input_text.markdown b/source/_components/input_text.markdown index 2cfa1bd7686..1ec62c4528d 100644 --- a/source/_components/input_text.markdown +++ b/source/_components/input_text.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Input Text" -description: "Instructions on how to integrate the Input Text component into Home Assistant." +description: "Instructions on how to integrate the Input Text integration into Home Assistant." date: 2016-03-15 06:00 sidebar: true comments: false @@ -14,7 +14,7 @@ ha_release: 0.53 ha_qa_scale: internal --- -The `input_text` component allows the user to define values that can be controlled via the frontend and can be used within conditions of automation. Changes to the value stored in the text box generate state events. These state events can be utilized as `automation` triggers as well. It can also be configured in password mode (obscured text). +The `input_text` integration allows the user to define values that can be controlled via the frontend and can be used within conditions of automation. Changes to the value stored in the text box generate state events. These state events can be utilized as `automation` triggers as well. It can also be configured in password mode (obscured text). ```yaml # Example configuration.yaml entries @@ -73,7 +73,7 @@ input_text: ### {% linkable_title Services %} -This components provide three services to modify the state of the `input_text`. +This integrations provide three services to modify the state of the `input_text`. | Service | Data | Description | | ------- | ---- | ----------- | @@ -81,7 +81,7 @@ This components provide three services to modify the state of the `input_text`. ### {% linkable_title Restore State %} -This component will automatically restore the state it had prior to Home Assistant stopping as long as your entity does **not** have a set value for `initial`. To disable this feature, set a valid value for `initial`. +This integration will automatically restore the state it had prior to Home Assistant stopping as long as your entity does **not** have a set value for `initial`. To disable this feature, set a valid value for `initial`. ## {% linkable_title Automation Examples %} diff --git a/source/_components/insteon.markdown b/source/_components/insteon.markdown index b3539442a7d..2d6c7df3676 100644 --- a/source/_components/insteon.markdown +++ b/source/_components/insteon.markdown @@ -27,7 +27,7 @@ redirect_from: ha_release: 0.39 --- -This component adds "local push" support for INSTEON Modems allowing linked INSTEON devices to be used within Home Assistant. +This integration adds "local push" support for INSTEON Modems allowing linked INSTEON devices to be used within Home Assistant. There is currently support for the following device types within Home Assistant: @@ -250,7 +250,7 @@ insteon: ### {% linkable_title What NOT to do %} -Insteon Modem is a top-level component and device discovery will identify the Home Assistant platform the device belongs in. As such, do not declare Insteon devices in other platforms. For example, this configuration will NOT work: +Insteon Modem is a top-level integration and device discovery will identify the Home Assistant platform the device belongs in. As such, do not declare Insteon devices in other platforms. For example, this configuration will NOT work: ```yaml light: diff --git a/source/_components/intent_script.markdown b/source/_components/intent_script.markdown index 20a0c06074a..03942ddd6c9 100644 --- a/source/_components/intent_script.markdown +++ b/source/_components/intent_script.markdown @@ -14,7 +14,7 @@ ha_release: "0.50" ha_qa_scale: internal --- -The `intent_script` component allows users to configure actions and responses to intents. Intents can be fired by any component that supports it. Examples are [Alexa](/components/alexa/) (Amazon Echo), [Dialogflow](/components/dialogflow/) (Google Assistant) and [Snips](/components/snips/). +The `intent_script` integration allows users to configure actions and responses to intents. Intents can be fired by any integration that supports it. Examples are [Alexa](/components/alexa/) (Amazon Echo), [Dialogflow](/components/dialogflow/) (Google Assistant) and [Snips](/components/snips/). ```yaml # Example configuration.yaml entry diff --git a/source/_components/introduction.markdown b/source/_components/introduction.markdown index 012bd24c055..c8764f871e1 100644 --- a/source/_components/introduction.markdown +++ b/source/_components/introduction.markdown @@ -14,9 +14,9 @@ ha_release: 0.7

This integration has been removed in Home Assistant 0.92. The UI will now take care of this text.

-The introduction component will show a card in the UI with 'Welcome Home!' and steps on how to get started. It will also print the same message to the console when starting up. +The introduction integration will show a card in the UI with 'Welcome Home!' and steps on how to get started. It will also print the same message to the console when starting up. -The introduction component is loaded by default on a new Home Assistant instance. +The introduction integration is loaded by default on a new Home Assistant instance. ```yaml # Example configuration.yaml entry diff --git a/source/_components/ios.markdown b/source/_components/ios.markdown index bbad6b84642..b9c35417ff5 100644 --- a/source/_components/ios.markdown +++ b/source/_components/ios.markdown @@ -14,4 +14,4 @@ ha_release: 0.31 ha_iot_class: Configurable --- -The `ios` component is the Home Assistant part for using the iOS companion app. For further details please check the [iOS section](/docs/ecosystem/ios/) in the documentation for further details. +The `ios` integration is the Home Assistant part for using the iOS companion app. For further details please check the [iOS section](/docs/ecosystem/ios/) in the documentation for further details. diff --git a/source/_components/iota.markdown b/source/_components/iota.markdown index f7793f606a4..17e1ac972f5 100644 --- a/source/_components/iota.markdown +++ b/source/_components/iota.markdown @@ -19,7 +19,7 @@ redirect_from: [IOTA](http://iota.org/) is a new blockless distributed ledger which is scalable, lightweight and makes it possible to transfer value without any fees. -The `iota` component displays various details (e.g., the balance, node attributes) of IOTA wallets. +The `iota` integration displays various details (e.g., the balance, node attributes) of IOTA wallets. ```yaml # configuration.yaml example @@ -67,7 +67,7 @@ iota: ## {% linkable_title Sensor %} -The sensors are automatically created if the IOTA component is present. +The sensors are automatically created if the IOTA integration is present. Available sensors: diff --git a/source/_components/iperf3.markdown b/source/_components/iperf3.markdown index 7fe67b3e436..44b6aa3b014 100644 --- a/source/_components/iperf3.markdown +++ b/source/_components/iperf3.markdown @@ -17,13 +17,13 @@ redirect_from: - /components/sensor.iperf3/ --- -The `iperf3` sensor component allows you to measure network bandwidth performance against a private or public [Iperf3](http://software.es.net/iperf/index.html) server. +The `iperf3` sensor integration allows you to measure network bandwidth performance against a private or public [Iperf3](http://software.es.net/iperf/index.html) server. -Enabling this component will automatically create the Iperf3 sensors for the monitored conditions (below). By default, it will run every hour. The user can change the update frequency in the config by defining the `scan_interval` for a Iperf3 test to run. +Enabling this integration will automatically create the Iperf3 sensors for the monitored conditions (below). By default, it will run every hour. The user can change the update frequency in the config by defining the `scan_interval` for a Iperf3 test to run. ## {% linkable_title Setup %} -This component requires the `iperf3` command to be installed on your OS. Please, refer to the [official Iperf3 documentation](http://software.es.net/iperf/obtaining.html) for installation instructions. +This integration requires the `iperf3` command to be installed on your OS. Please, refer to the [official Iperf3 documentation](http://software.es.net/iperf/obtaining.html) for installation instructions. ## {% linkable_title Configuration %} @@ -114,7 +114,7 @@ You can use the service `sensor.iperf3_update` to trigger a manual speed test fo ### {% linkable_title Service %} -Once loaded, the `iperf3` component will expose a service (`iperf3.speedtest`) that can be called to run a speed test on demand. This can be useful if you have enabled manual mode. +Once loaded, the `iperf3` integration will expose a service (`iperf3.speedtest`) that can be called to run a speed test on demand. This can be useful if you have enabled manual mode. | Service data attribute | Description | | `host` | String that point at a configured `host` from configuration.yaml. Otherwise, tests will be run against all configured hosts. diff --git a/source/_components/itach.markdown b/source/_components/itach.markdown index 9c39c7aeb99..63a851c75e1 100644 --- a/source/_components/itach.markdown +++ b/source/_components/itach.markdown @@ -80,9 +80,9 @@ devices: type: string {% endconfiguration %} -An example to call the component from developer tools using the `remote.send_command` service: `{ "entity_id":"remote.tv", "command":"menu" }` +An example to call the integration from developer tools using the `remote.send_command` service: `{ "entity_id":"remote.tv", "command":"menu" }` -Note: Global Cache devices expect data in their own format of "sendir...". This component converts hex code to Global Cache IR form. +Note: Global Cache devices expect data in their own format of "sendir...". This integration converts hex code to Global Cache IR form. API Docs: diff --git a/source/_components/joaoapps_join.markdown b/source/_components/joaoapps_join.markdown index b2429628127..cdd30ea0c94 100644 --- a/source/_components/joaoapps_join.markdown +++ b/source/_components/joaoapps_join.markdown @@ -16,7 +16,7 @@ redirect_from: - /components/notify.joaoapps_join/ --- -The `joaoapps_join` component exposes services from +The `joaoapps_join` integration exposes services from [Join](http://joaoapps.com/join). In Home Assistant, the Join features are divided up in two locations, the Join component, and the Join notify platform. The notify platform allows us to send messages to Join devices, the component @@ -102,7 +102,7 @@ You can use them like so: } ``` -The services exposed in the `joaoapps_join` component can be used with the +The services exposed in the `joaoapps_join` integration can be used with the service data described below: | Service | Data | diff --git a/source/_components/keenetic_ndms2.markdown b/source/_components/keenetic_ndms2.markdown index f3e7eb66d54..bcbebdd4fb0 100644 --- a/source/_components/keenetic_ndms2.markdown +++ b/source/_components/keenetic_ndms2.markdown @@ -15,7 +15,7 @@ redirect_from: - /components/device_tracker.keenetic_ndms2/ --- -This component offers presence detection by examining devices connected to a [Keenetic](https://keenetic.net/) +This integration offers presence detection by examining devices connected to a [Keenetic](https://keenetic.net/) Router running NDMS2 firmware. To use a Keenetic router in your installation, add the following to your `configuration.yaml` file: @@ -54,4 +54,4 @@ interface: type: string {% endconfiguration %} -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. diff --git a/source/_components/keyboard.markdown b/source/_components/keyboard.markdown index 45a044c1e33..eaf70a627da 100644 --- a/source/_components/keyboard.markdown +++ b/source/_components/keyboard.markdown @@ -13,7 +13,7 @@ ha_category: ha_release: pre 0.7 --- -The `keyboard` component simulates key presses on the host machine. It currently offers the following Buttons as a Service (BaaS): +The `keyboard` integration simulates key presses on the host machine. It currently offers the following Buttons as a Service (BaaS): - `keyboard/volume_up` - `keyboard/volume_down` diff --git a/source/_components/keyboard_remote.markdown b/source/_components/keyboard_remote.markdown index a01c19964a0..02fc97db18d 100644 --- a/source/_components/keyboard_remote.markdown +++ b/source/_components/keyboard_remote.markdown @@ -16,7 +16,7 @@ ha_iot_class: Local Push Receive signals from a keyboard and use it as a remote control. -This component allows you to use one or more keyboards as remote controls. It will fire `keyboard_remote_command_received` events which can then be used in automation rules. +This integration allows you to use one or more keyboards as remote controls. It will fire `keyboard_remote_command_received` events which can then be used in automation rules. The `evdev` package is used to interface with the keyboard and thus this is Linux only. It also means you can't use your normal keyboard for this because `evdev` will block it. @@ -84,9 +84,9 @@ automation: ## {% linkable_title Disconnections %} -This component manages disconnections and re-connections of the keyboard, for example in the case of a Bluetooth device that turns off automatically to preserve battery. +This integration manages disconnections and re-connections of the keyboard, for example in the case of a Bluetooth device that turns off automatically to preserve battery. -If the keyboard disconnects, the component will fire an event `keyboard_remote_disconnected`. +If the keyboard disconnects, the integration will fire an event `keyboard_remote_disconnected`. When the keyboard reconnects, an event `keyboard_remote_connected` will be fired. Here's an automation example that plays a sound through a media player whenever the keyboard connects/disconnects: diff --git a/source/_components/kira.markdown b/source/_components/kira.markdown index 3be677669b4..b75a784cdec 100644 --- a/source/_components/kira.markdown +++ b/source/_components/kira.markdown @@ -18,7 +18,7 @@ redirect_from: - /components/remote.kira/ --- -The `kira` component is the main component to integrate Keene Electronics IR over IP [Kira](https://www.keene.co.uk/keene-ir-anywhere-single-worldwide.html) modules with Home Assistant. +The `kira` integration is the main integration to integrate Keene Electronics IR over IP [Kira](https://www.keene.co.uk/keene-ir-anywhere-single-worldwide.html) modules with Home Assistant. There is currently support for the following device types within Home Assistant: @@ -93,7 +93,7 @@ If no sensors or remotes are specified, a sensor with default values will be add ### {% linkable_title Code Configuration %} -The first time the Kira component is loaded, `kira_codes.yaml` will be created in the Home Assistant configuration directory. +The first time the Kira integration is loaded, `kira_codes.yaml` will be created in the Home Assistant configuration directory. ```yaml # Example kira_codes.yaml entry diff --git a/source/_components/knx.markdown b/source/_components/knx.markdown index 3217c688da8..cf505449c26 100644 --- a/source/_components/knx.markdown +++ b/source/_components/knx.markdown @@ -17,7 +17,7 @@ ha_iot_class: Local Polling The [KNX](https://www.knx.org) integration for Home Assistant allows you to connect to a KNX/IP devices. -The component requires a local KNX/IP interface like the [Weinzierl 730](https://www.weinzierl.de/index.php/en/all-knx/knx-devices-en/produktarchiv-en/knx-ip-interface-730-en). Through this, it will send and receive commands to and from other devices to the KNX bus. +The integration requires a local KNX/IP interface like the [Weinzierl 730](https://www.weinzierl.de/index.php/en/all-knx/knx-devices-en/produktarchiv-en/knx-ip-interface-730-en). Through this, it will send and receive commands to and from other devices to the KNX bus.

Please note, the `knx` platform does not support Windows and needs at least python version 3.5. @@ -113,7 +113,7 @@ fire_event_filter: required: inclusive type: [list, string] state_updater: - description: The component will collect the current state of each configured device from the KNX bus to display it correctly within Home-Assistant. Set this option to False to prevent this behavior. + description: The integration will collect the current state of each configured device from the KNX bus to display it correctly within Home-Assistant. Set this option to False to prevent this behavior. required: false default: true type: boolean @@ -140,7 +140,7 @@ payload: ### {% linkable_title Exposing sensor values or time to knx bus %} -KNX component is able to expose time or sensor values to KNX bus. The component will broadcast any change of the exposed value to the KNX bus and answer read requests to the specified group address: +KNX integration is able to expose time or sensor values to KNX bus. The integration will broadcast any change of the exposed value to the KNX bus and answer read requests to the specified group address: ```yaml # Example configuration.yaml entry @@ -160,7 +160,7 @@ type: description: Type of the exposed value. Either time or datetime or any supported type of [KNX Sensor](/components/sensor.knx/) (e.g., "temperature" or "humidity"). type: string entity_id: - description: Entity id of the HASS component to be exposed. Not necessary for types time and datetime. + description: Entity id of the HASS integration to be exposed. Not necessary for types time and datetime. type: string address: description: KNX group address. diff --git a/source/_components/kodi.markdown b/source/_components/kodi.markdown index 3f0f335eafe..827545a0e24 100644 --- a/source/_components/kodi.markdown +++ b/source/_components/kodi.markdown @@ -138,7 +138,7 @@ With the `turn_on_action` and `turn_off_action` parameters you can run any combi #### Turn on Kodi with Wake on LAN -With this configuration, when calling `media_player/turn_on` on the Kodi device, a _magic packet_ will be sent to the specified MAC address. To use this service, first you need to config the [`wake_on_lan`](/components/wake_on_lan) component in Home Assistant, which is achieved simply by adding `wake_on_lan:` to your `configuration.yaml`. +With this configuration, when calling `media_player/turn_on` on the Kodi device, a _magic packet_ will be sent to the specified MAC address. To use this service, first you need to config the [`wake_on_lan`](/components/wake_on_lan) integration in Home Assistant, which is achieved simply by adding `wake_on_lan:` to your `configuration.yaml`. ```yaml media_player: diff --git a/source/_components/konnected.markdown b/source/_components/konnected.markdown index de134519eb4..93122801396 100644 --- a/source/_components/konnected.markdown +++ b/source/_components/konnected.markdown @@ -19,20 +19,20 @@ redirect_from: - /components/switch.konnected/ --- -The `konnected` component lets you connect wired sensors and switches to a NodeMCU ESP8226 based device running the [open source Konnected software](https://github.com/konnected-io/konnected-security). Reuse the wired sensors and siren from an old or pre-wired alarm system installation and integrate them directly into Home Assistant. +The `konnected` integration lets you connect wired sensors and switches to a NodeMCU ESP8226 based device running the [open source Konnected software](https://github.com/konnected-io/konnected-security). Reuse the wired sensors and siren from an old or pre-wired alarm system installation and integrate them directly into Home Assistant. Visit the [Konnected.io website](https://konnected.io) for more information about the Konnected Alarm Panel board and compatible hardware. -The component currently supports the following device types in Home Assistant: +The integration currently supports the following device types in Home Assistant: - Binary Sensor: Wired door and window sensors, motion detectors, glass-break detectors, leak sensors, smoke & CO detectors or any open/close switch. - Switch: Actuate a siren, strobe, buzzer or relay module. - Sensor: Periodic measurements from DHT temperature/humidity sensors and DS18B20 temperature sensors. -This component uses the [`discovery`](/components/discovery) component, which must be enabled for device discovery to work. If you don't want to use discovery, set the _host_ and _port_ for each device in the description. +This integration uses the [`discovery`](/components/discovery) component, which must be enabled for device discovery to work. If you don't want to use discovery, set the _host_ and _port_ for each device in the description.

-Konnected devices communicate with Home Assistant over your local LAN -- there is no cloud component! For best performance we recommend allowing unsecured HTTP API traffic between Konnected devices and Home Assistant on your LAN. This means that you should not use the `http` component to serve SSL/TLS certificates. Instead, use a proxy like Nginx or Caddy to serve SSL/TLS. [Read more.](https://help.konnected.io/support/solutions/articles/32000023964-set-up-hass-io-with-secure-remote-access-using-duckdns-and-nginx-proxy) +Konnected devices communicate with Home Assistant over your local LAN -- there is no cloud component! For best performance we recommend allowing unsecured HTTP API traffic between Konnected devices and Home Assistant on your LAN. This means that you should not use the `http` integration to serve SSL/TLS certificates. Instead, use a proxy like Nginx or Caddy to serve SSL/TLS. [Read more.](https://help.konnected.io/support/solutions/articles/32000023964-set-up-hass-io-with-secure-remote-access-using-duckdns-and-nginx-proxy)

### {% linkable_title Configuration %} @@ -299,7 +299,7 @@ Konnected runs on an ESP8266 board with the NodeMCU firmware. It is commonly use The `konnected` binary sensor allows you to monitor wired door sensors, window sensors, motion sensors, smoke detectors, CO detectors, glass-break sensors, water leak sensors or any other simple wired open/close circuit attached to a NodeMCU ESP8266 WiFi module running the [open source Konnected software](https://github.com/konnected-io/konnected-security). -This component supports all of the built-in device classes of the generic [Binary Sensor](/components/binary_sensor/) component. +This integration supports all of the built-in device classes of the generic [Binary Sensor](/components/binary_sensor/) component. ### {% linkable_title Switch %} diff --git a/source/_components/kwb.markdown b/source/_components/kwb.markdown index bb4736616f9..2f0fd0d6dd6 100644 --- a/source/_components/kwb.markdown +++ b/source/_components/kwb.markdown @@ -16,7 +16,7 @@ redirect_from: - /components/sensor.kwb/ --- -The `kwb` component integrates the sensors of KWB Easyfire pellet central heating units with the Comfort3 controller () into Home Assistant. +The `kwb` integration integrates the sensors of KWB Easyfire pellet central heating units with the Comfort3 controller () into Home Assistant. Direct connection via serial (RS485) or via telnet terminal server is supported. The serial cable has to be attached to the control unit port 25 (which is normally used for detached control terminals). diff --git a/source/_components/lannouncer.markdown b/source/_components/lannouncer.markdown index eb52832c2e6..b67ff08ed1c 100644 --- a/source/_components/lannouncer.markdown +++ b/source/_components/lannouncer.markdown @@ -46,7 +46,7 @@ port: ### {% linkable_title Installation %} -You need to install the Lannouncer app and enable the *Network (TCP) Listener* and *Auto-Start Network Listener*. You can disable the *GCM (Google Cloud) and WAN Messaging* and *SMS Listener* since this component doesn't use them. +You need to install the Lannouncer app and enable the *Network (TCP) Listener* and *Auto-Start Network Listener*. You can disable the *GCM (Google Cloud) and WAN Messaging* and *SMS Listener* since this integration doesn't use them. Lannouncer uses the default Android TTS voice. You can tweak that in the Android configuration, or you can install a different TTS engine from the Play Store. You might want to raise the volume in the app settings since that depends on the actual hardware device. diff --git a/source/_components/lcn.markdown b/source/_components/lcn.markdown index b796e6c7f27..bc6197675e7 100644 --- a/source/_components/lcn.markdown +++ b/source/_components/lcn.markdown @@ -27,7 +27,7 @@ redirect_from: The `lcn` integration for Home Assistant allows you to connect to [LCN](http://www.lcn.eu) hardware devices. -The component requires one unused license of the coupling software LCN-PCHK (version >2.8) and a LCN hardware coupler. Alternatively a LCN-PKE coupler can be used which offers two PCHK licenses. +The integration requires one unused license of the coupling software LCN-PCHK (version >2.8) and a LCN hardware coupler. Alternatively a LCN-PKE coupler can be used which offers two PCHK licenses. With this setup sending and receiving commands to and from LCN modules is possible. There is currently support for the following device types within Home Assistant: @@ -41,7 +41,7 @@ There is currently support for the following device types within Home Assistant: - [Switch](#switch)

- Please note: Besides the implemented platforms the `lcn` component offers a variety of [service calls](#services). + Please note: Besides the implemented platforms the `lcn` integration offers a variety of [service calls](#services). These service calls cover functionalities of the LCN system which cannot be represented by the platform implementations. They are ideal to be used in automation scripts or for the `template` platforms.

@@ -333,7 +333,7 @@ Modules can be arranged in _segments_. Segments can be addressed by their numeri LCN Modules within the _same_ segment can be grouped by their group id (5..254) or 3 (= target all groups.) -The LCN component allows the connection to more than one hardware coupler. In this case it has to be specified which hardware coupler should be used for addressing the specified module. +The LCN integration allows the connection to more than one hardware coupler. In this case it has to be specified which hardware coupler should be used for addressing the specified module. Whenever the address of a module or a group has to be specified, it can be addressed using one of the following syntaxes: diff --git a/source/_components/lg_netcast.markdown b/source/_components/lg_netcast.markdown index e5b59c32db2..6bb81bf3c13 100644 --- a/source/_components/lg_netcast.markdown +++ b/source/_components/lg_netcast.markdown @@ -45,7 +45,7 @@ name: To get the access token for your TV configure the `lg_netcast` platform in Home Assistant without the `access_token`. After starting Home Assistant the TV will display the access token on screen. -Just add the token to your configuration and restart Home Assistant and the media player component for your LG TV will show up. +Just add the token to your configuration and restart Home Assistant and the media player integration for your LG TV will show up.

The access token will not change until you factory reset your TV. diff --git a/source/_components/lg_soundbar.markdown b/source/_components/lg_soundbar.markdown index 14e54ca98a1..0bf1c27c243 100644 --- a/source/_components/lg_soundbar.markdown +++ b/source/_components/lg_soundbar.markdown @@ -22,7 +22,7 @@ Supported devices: - The SK range -Compatible devices will be automatically added if the [`discovery`](/components/discovery/) component is enabled. +Compatible devices will be automatically added if the [`discovery`](/components/discovery/) integration is enabled. ### {% linkable_title Supported operations %} diff --git a/source/_components/life360.markdown b/source/_components/life360.markdown index dd01a0624a6..7037636417a 100644 --- a/source/_components/life360.markdown +++ b/source/_components/life360.markdown @@ -243,4 +243,4 @@ automation: ## {% linkable_title Disclaimer %} -It does not appear that Life360 officially supports its REST API for use with other than its own apps. This integration is based on reverse engineering that has been done by the open source community, and an API token that was somehow discovered by the same community. At any time Life360 could disable that token or otherwise change its REST API such that this component would no longer work. +It does not appear that Life360 officially supports its REST API for use with other than its own apps. This integration is based on reverse engineering that has been done by the open source community, and an API token that was somehow discovered by the same community. At any time Life360 could disable that token or otherwise change its REST API such that this integration would no longer work. diff --git a/source/_components/lifx.markdown b/source/_components/lifx.markdown index 4a966855d21..ce77866a3d6 100644 --- a/source/_components/lifx.markdown +++ b/source/_components/lifx.markdown @@ -15,11 +15,11 @@ ha_release: 0.81 redirect_from: /components/light.lifx/ --- -The `lifx` component allows you to integrate your [LIFX](https://www.lifx.com) into Home Assistant. +The `lifx` integration allows you to integrate your [LIFX](https://www.lifx.com) into Home Assistant. -_Please note, the `lifx` component does not support Windows. The `lifx_legacy` light platform (supporting basic functionality) can be used instead._ +_Please note, the `lifx` integration does not support Windows. The `lifx_legacy` light platform (supporting basic functionality) can be used instead._ -You can configure the LIFX component by going to the integrations page inside the config panel. +You can configure the LIFX integration by going to the integrations page inside the config panel. ## {% linkable_title Set state %} diff --git a/source/_components/light.knx.markdown b/source/_components/light.knx.markdown index 794efa26195..80149d6185d 100644 --- a/source/_components/light.knx.markdown +++ b/source/_components/light.knx.markdown @@ -14,14 +14,14 @@ ha_release: 0.44 ha_iot_class: Local Polling --- -The `knx light` component is used as an interface to control knx actuators for lighting applications such as: +The `knx light` integration is used as an interface to control knx actuators for lighting applications such as: - switching actuators - dimming actuators - LED controllers - DALI gateways -The `knx` component must be configured correctly to use this component, see [KNX Component](/components/knx). +The `knx` integration must be configured correctly to use this component, see [KNX Component](/components/knx). ## {% linkable_title Configuration %} diff --git a/source/_components/light.markdown b/source/_components/light.markdown index cc0563c73c6..d2b5c8f9041 100644 --- a/source/_components/light.markdown +++ b/source/_components/light.markdown @@ -14,7 +14,7 @@ ha_qa_scale: internal ha_release: pre 0.7 --- -This component allows you to track and control various light bulbs. Read the integration documentation for your particular light hardware to learn how to enable it. +This integration allows you to track and control various light bulbs. Read the integration documentation for your particular light hardware to learn how to enable it. ### {% linkable_title Default turn-on values %} diff --git a/source/_components/light.rflink.markdown b/source/_components/light.rflink.markdown index 2dd1812b75f..f1a0024a4a1 100644 --- a/source/_components/light.rflink.markdown +++ b/source/_components/light.rflink.markdown @@ -14,7 +14,7 @@ ha_release: 0.38 ha_iot_class: Assumed State --- -The `rflink` component supports devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver). +The `rflink` integration supports devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver). First, you have to set up your [RFLink hub](/components/rflink/). @@ -140,7 +140,7 @@ Any on/off command from any alias ID updates the current state of the light. How ### {% linkable_title Light types %} -Light devices can come in different forms. Some only switch on and off, other support dimming. Dimmable devices might not always respond nicely to repeated `on` command as they turn into a pulsating state until `on` is pressed again (for example KlikAanKlikUit). The RFLink component support three types of lights to make things work in every situation: +Light devices can come in different forms. Some only switch on and off, other support dimming. Dimmable devices might not always respond nicely to repeated `on` command as they turn into a pulsating state until `on` is pressed again (for example KlikAanKlikUit). The RFLink integration support three types of lights to make things work in every situation: - *Hybrid*: This type sends a `dim` followed by an an `on` command; and `off` commands. This will make dimmable devices turn on at the requested dim level and on/off devices on. One caveat is this type is not compatible with signal repetition as multiple `on` signals will cause dimmers to go into disco mode. - *Switchable*: Device type that sends only `on` and `off` commands. It work for both on/off and dimmable type switches. However dimmables might have issues with signal repetition (see above). diff --git a/source/_components/light.template.markdown b/source/_components/light.template.markdown index f51d239cd96..22a874754b7 100644 --- a/source/_components/light.template.markdown +++ b/source/_components/light.template.markdown @@ -15,7 +15,7 @@ logo: home-assistant.png ha_qa_scale: internal --- -The `template` platform creates lights that combine components and provides the +The `template` platform creates lights that combine integrations and provides the ability to run scripts or invoke services for each of the on, off, and brightness commands of a light. diff --git a/source/_components/light.xiaomi_aqara.markdown b/source/_components/light.xiaomi_aqara.markdown index 76627f37d38..5b433fbab97 100644 --- a/source/_components/light.xiaomi_aqara.markdown +++ b/source/_components/light.xiaomi_aqara.markdown @@ -15,7 +15,7 @@ ha_iot_class: Local Push --- -The `xiaomi aqara` light platform allows you to control the internal light of the xiaomi gateway. The component will be loaded automatically and provides a device called `light.gateway_light_28ffffffffff`. +The `xiaomi aqara` light platform allows you to control the internal light of the xiaomi gateway. The integration will be loaded automatically and provides a device called `light.gateway_light_28ffffffffff`. The requirement is that you have setup [Xiaomi aqara](/components/xiaomi_aqara/). diff --git a/source/_components/lightwave.markdown b/source/_components/lightwave.markdown index 4caecd8e0e0..227e9128324 100644 --- a/source/_components/lightwave.markdown +++ b/source/_components/lightwave.markdown @@ -19,9 +19,9 @@ redirect_from: - /components/switch.lightwave/ --- -The `lightwave` component links Home Assistant with your Lightwave WiFi link for controlling Lightwave lights and switches. +The `lightwave` integration links Home Assistant with your Lightwave WiFi link for controlling Lightwave lights and switches. -This component uses the official API published by Lightwave on their website [https://api.lightwaverf.com/](https://api.lightwaverf.com/). +This integration uses the official API published by Lightwave on their website [https://api.lightwaverf.com/](https://api.lightwaverf.com/). To add your Lightwave devices into your Home Assistant installation, add the following to your `configuration.yaml` file: ```yaml @@ -53,7 +53,7 @@ Each `switch` or `light` requires an `id` and a `name`. The `id` takes the form The first use of a light or switch will try to register with your Lightwave WiFi Link hub. If the hub has not been registered a message on your hub will be displayed asking you to pair the device. You have 12 seconds to push the button on your hub to accept this. Once done, you should be able to control your lights and switches via Home Assistant. This only needs to be done if the hub has not been registered. -The Lightwave Home Assistant component currently supports the following Lightwave devices: +The Lightwave Home Assistant integration currently supports the following Lightwave devices: - Lightwave lights - Lightwave switches diff --git a/source/_components/linksys_ap.markdown b/source/_components/linksys_ap.markdown index 905a41f895b..3cc93ad60b3 100644 --- a/source/_components/linksys_ap.markdown +++ b/source/_components/linksys_ap.markdown @@ -68,4 +68,4 @@ device_tracker: consider_home: 12 ``` -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. diff --git a/source/_components/linksys_smart.markdown b/source/_components/linksys_smart.markdown index 40218e7173a..de5c03ff4be 100644 --- a/source/_components/linksys_smart.markdown +++ b/source/_components/linksys_smart.markdown @@ -44,4 +44,4 @@ host: type: string {% endconfiguration %} -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. diff --git a/source/_components/linode.markdown b/source/_components/linode.markdown index f114b51c969..758879c2c9f 100644 --- a/source/_components/linode.markdown +++ b/source/_components/linode.markdown @@ -19,7 +19,7 @@ redirect_from: - /components/switch.linode/ --- -The `linode` component allows you to access the information about your [Linode](https://linode.com) systems from Home Assistant. +The `linode` integration allows you to access the information about your [Linode](https://linode.com) systems from Home Assistant. There is currently support for the following device types within Home Assistant: diff --git a/source/_components/lirc.markdown b/source/_components/lirc.markdown index 0b25e8bcbd9..31021895773 100644 --- a/source/_components/lirc.markdown +++ b/source/_components/lirc.markdown @@ -16,7 +16,7 @@ ha_iot_class: Local Push [LIRC](http://www.lirc.org/) integration for Home Assistant allows you to receive signals from an infrared remote control and control actions based on the buttons you press. You can use them to set scenes or trigger any other [automation](/components/automation/). -Sending IR commands is not supported in this component (yet), but can be accomplished using the [shell_command component](/components/shell_command/) in conjunction with the `irsend` command. +Sending IR commands is not supported in this integration (yet), but can be accomplished using the [shell_command component](/components/shell_command/) in conjunction with the `irsend` command. ### {% linkable_title Installation %} @@ -82,7 +82,7 @@ lirc: #### {% linkable_title Events %} -The LIRC component fires `ir_command_received` events on the bus. You can capture the events and respond to them in automation scripts like this: +The LIRC integration fires `ir_command_received` events on the bus. You can capture the events and respond to them in automation scripts like this: ```yaml # Example configuration.yaml automation entry diff --git a/source/_components/lock.markdown b/source/_components/lock.markdown index 065cf915907..bc08dc77371 100644 --- a/source/_components/lock.markdown +++ b/source/_components/lock.markdown @@ -21,7 +21,7 @@ Keeps track which locks are in your environment, their state and allows you to c ### {% linkable_title Services %} -A lock component provides the following services: +A lock integration provides the following services: #### {% linkable_title Service `lock.lock` %} diff --git a/source/_components/lock.template.markdown b/source/_components/lock.template.markdown index b7282a64b61..39d6e4cde4b 100644 --- a/source/_components/lock.template.markdown +++ b/source/_components/lock.template.markdown @@ -19,7 +19,7 @@ The `template` platform creates locks that combines components. For example, if you have a garage door with a toggle switch that operates the motor and a sensor that allows you know whether the door is open or closed, you can combine these into a lock that knows whether the garage door is open or closed. -This can simplify the GUI and make it easier to write automations. You can mark the components you have combined as `hidden` so they don't appear themselves. +This can simplify the GUI and make it easier to write automations. You can mark the integrations you have combined as `hidden` so they don't appear themselves. In optimistic mode, the lock will immediately change state after every command. Otherwise, the lock will wait for state confirmation from the template. Try to enable it, if experiencing incorrect lock operation. diff --git a/source/_components/logbook.markdown b/source/_components/logbook.markdown index 51ec7583b94..5ed22180c9c 100644 --- a/source/_components/logbook.markdown +++ b/source/_components/logbook.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Logbook" -description: "Instructions on how to enable the logbook component for Home Assistant." +description: "Instructions on how to enable the logbook integration for Home Assistant." date: 2015-04-25 9:23 sidebar: true comments: false @@ -15,12 +15,12 @@ ha_release: 0.7 -The logbook component provides a different perspective on the history of your +The logbook integration provides a different perspective on the history of your house by showing all the changes that happened to your house in reverse chronological order. [See the demo for a live example](/demo/). It depends on -the `recorder` component for storing the data. This means that if the -[`recorder`](/components/recorder/) component is set up to use e.g., MySQL or -PostgreSQL as data store, the `logbook` component does not use the default +the `recorder` integration for storing the data. This means that if the +[`recorder`](/components/recorder/) integration is set up to use e.g., MySQL or +PostgreSQL as data store, the `logbook` integration does not use the default SQLite database to store data. To enable the logbook in your installation, @@ -33,7 +33,7 @@ logbook: {% configuration %} exclude: - description: "Configure which components should **not** create logbook entries." + description: "Configure which integrations should **not** create logbook entries." required: false type: map keys: @@ -46,7 +46,7 @@ exclude: required: false type: list include: - description: Configure which components should create logbook entries. + description: Configure which integrations should create logbook entries. required: false type: map keys: diff --git a/source/_components/logentries.markdown b/source/_components/logentries.markdown index 48d8e16dc08..67bf57d3bf3 100644 --- a/source/_components/logentries.markdown +++ b/source/_components/logentries.markdown @@ -13,11 +13,11 @@ ha_category: ha_release: 0.13 --- -The `logentries` component makes it possible to log all state changes to [Logentries](http://logentries.com/) using Logentries Webhook endpoint. +The `logentries` integration makes it possible to log all state changes to [Logentries](http://logentries.com/) using Logentries Webhook endpoint. Open the **Add a Log** page and choose **Manual**. Enter a name for your log in **Log Name**, add a group in **Select Log Set**, set **Token TCP - logs are identified by a token.** and press **Create Log Token**. The generated token is required for the Home Assistant configuration. -To use the `logentries` component in your installation, add the following to your `configuration.yaml` file: +To use the `logentries` integration in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/logger.markdown b/source/_components/logger.markdown index 9d186deb679..8e3ec41f2c5 100644 --- a/source/_components/logger.markdown +++ b/source/_components/logger.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Logger" -description: "Instructions on how to enable the logger component for Home Assistant." +description: "Instructions on how to enable the logger integration for Home Assistant." date: 2015-11-12 17:00 sidebar: true comments: false @@ -14,10 +14,10 @@ ha_qa_scale: internal ha_release: 0.8 --- -The `logger` component lets you define the level of logging activities in Home +The `logger` integration lets you define the level of logging activities in Home Assistant. -To enable the `logger` component in your installation, +To enable the `logger` integration in your installation, add the following to your `configuration.yaml` file: ```yaml @@ -68,7 +68,7 @@ logger: type: '[log_level](#log-levels)' default: debug logs: - description: List of components and their log level. + description: List of integrations and their log level. required: false type: map keys: @@ -94,7 +94,7 @@ Possible log severity levels, listed in order from most severe to least severe, ### {% linkable_title Service `set_default_level` %} -You can alter the default log level (for components without a specified log +You can alter the default log level (for integrations without a specified log level) using the service `logger.set_default_level`. An example call might look like this: @@ -107,7 +107,7 @@ data: ### {% linkable_title Service `set_level` %} -You can alter log level for one or several components using the service +You can alter log level for one or several integrations using the service `logger.set_level`. It accepts the same format as `logs` in the configuration. An example call might look like this: diff --git a/source/_components/logi_circle.markdown b/source/_components/logi_circle.markdown index a38aec5ea84..81255182169 100644 --- a/source/_components/logi_circle.markdown +++ b/source/_components/logi_circle.markdown @@ -85,7 +85,7 @@ Logi Circle cameras support the `camera.turn_on` and `camera.turn_off` services. The `logi_circle` sensor platform lets you monitor sensors connected to your [Logi Circle](https://circle.logi.com) cameras in Home Assistant. -To customize which sensors are setup, you can extend the Logi Circle component configuration in your `configuration.yaml` file with the following settings: +To customize which sensors are setup, you can extend the Logi Circle integration configuration in your `configuration.yaml` file with the following settings: ```yaml # Example configuration.yaml entry diff --git a/source/_components/london_air.markdown b/source/_components/london_air.markdown index 14d7cf26387..6bcfb0c93df 100644 --- a/source/_components/london_air.markdown +++ b/source/_components/london_air.markdown @@ -16,7 +16,7 @@ redirect_from: - /components/sensor.london_air/ --- -The `london_air` component [queries](http://api.erg.kcl.ac.uk/AirQuality/Hourly/MonitoringIndex/GroupName=London/Json) the London air quality [data feed](https://www.londonair.org.uk/LondonAir/API/) provided by Kings College London. A single sensor will be added for each `location` ([local authority district or borough](https://en.wikipedia.org/wiki/List_of_London_boroughs)) specified in the configuration file. The state of each sensor is the overall air quality in that borough. Note that only 28 of the 32 boroughs have data available. +The `london_air` integration [queries](http://api.erg.kcl.ac.uk/AirQuality/Hourly/MonitoringIndex/GroupName=London/Json) the London air quality [data feed](https://www.londonair.org.uk/LondonAir/API/) provided by Kings College London. A single sensor will be added for each `location` ([local authority district or borough](https://en.wikipedia.org/wiki/List_of_London_boroughs)) specified in the configuration file. The state of each sensor is the overall air quality in that borough. Note that only 28 of the 32 boroughs have data available. Boroughs can have multiple monitoring sites at different geographical positions within the borough, and each of those sites can monitor up to six different kinds of pollutant. The pollutants are described [here](http://api.erg.kcl.ac.uk/AirQuality/Information/Species/Json) and are Carbon Monoxide ([CO2](http://www.londonair.org.uk/LondonAir/guide/WhatIsCO.aspx)), Nitrogen Dioxide ([NO2](http://www.londonair.org.uk/LondonAir/guide/WhatIsNO2.aspx)), Ozone ([O3](http://www.londonair.org.uk/LondonAir/guide/WhatIsO3.aspx)), Sulfur Dioxide ([SO2](http://www.londonair.org.uk/LondonAir/guide/WhatIsSO2.aspx)), PM2.5 & PM10 [particulates](http://www.londonair.org.uk/LondonAir/guide/WhatIsPM.aspx). The `latitude` and `longitude` of each site is accessible through a `data` attribute of the sensor, as are details about the pollutants monitored at that site. The `sites` attribute of a sensor displays how many monitoring sites that sensor covers. The `updated` attribute of a sensor states when the data was last published. Nominally data is published hourly, but in my experience this can vary. To limit the number of requests made by the sensor, a single API request is made every 30 minutes. diff --git a/source/_components/luci.markdown b/source/_components/luci.markdown index 40e34119d92..83115e944af 100644 --- a/source/_components/luci.markdown +++ b/source/_components/luci.markdown @@ -20,7 +20,7 @@ _This is one of multiple ways we support OpenWRT. For an overview, see [openwrt] This is a presence detection scanner for OpenWRT using [luci](http://wiki.openwrt.org/doc/techref/luci).

-This component requires a [workaround](https://github.com/home-assistant/home-assistant/issues/1258#issuecomment-252469880) when using luci with HTTPS and a self-signed certificate. +This integration requires a [workaround](https://github.com/home-assistant/home-assistant/issues/1258#issuecomment-252469880) when using luci with HTTPS and a self-signed certificate.

Before this scanner can be used you have to install the luci RPC package on OpenWRT: @@ -60,7 +60,7 @@ ssl: type: boolean {% endconfiguration %} -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. This device tracker provides a number of additional attributes for each tracked device (if it is at home): `flags`, `ip`, `device`, and `host`. The first three attributes are taken from the ARP table returned by the luci RPC. The `host` attribute is taken from the platform configuration and can be used to distinguish in which router a device is logged in, if you are using multiple OpenWRT routers. diff --git a/source/_components/luftdaten.markdown b/source/_components/luftdaten.markdown index b55cb0b5f7a..aa8e259f80f 100644 --- a/source/_components/luftdaten.markdown +++ b/source/_components/luftdaten.markdown @@ -18,7 +18,7 @@ redirect_from: - /components/sensor.luftdaten/ --- -The `luftdaten` component will query the open data API of [luftdaten.info](http://luftdaten.info) to monitor air quality and other weather data from a specific (self build) sensor station. +The `luftdaten` integration will query the open data API of [luftdaten.info](http://luftdaten.info) to monitor air quality and other weather data from a specific (self build) sensor station. ## {% linkable_title Setup %} @@ -109,4 +109,4 @@ luftdaten: The `luftdaten` sensor platform will query the open data API of [luftdaten.info](http://luftdaten.info) to monitor air quality and other weather data from a specific (self build) sensor station. -You must have the `luftdaten` component (from above) configured to use this platform. After configuring that component, sensors will automatically appear. +You must have the `luftdaten` integration (from above) configured to use this platform. After configuring that component, sensors will automatically appear. diff --git a/source/_components/lupusec.markdown b/source/_components/lupusec.markdown index ad8027a720a..adbf025d5b1 100644 --- a/source/_components/lupusec.markdown +++ b/source/_components/lupusec.markdown @@ -21,7 +21,7 @@ redirect_from: - /components/switch.lupusec/ --- -The `lupusec` component allows the user to integrate their Lupusec alarm control panel and ultimately all connected sensors and other devices. For more information about the LUPUS-Electronics security system please visit their [website](https://www.lupus-electronics.de). +The `lupusec` integration allows the user to integrate their Lupusec alarm control panel and ultimately all connected sensors and other devices. For more information about the LUPUS-Electronics security system please visit their [website](https://www.lupus-electronics.de). Supported units: diff --git a/source/_components/lutron.markdown b/source/_components/lutron.markdown index 1b8496c5c6a..753c58008af 100644 --- a/source/_components/lutron.markdown +++ b/source/_components/lutron.markdown @@ -23,13 +23,13 @@ redirect_from: - /components/switch.lutron/ --- -[Lutron](http://www.lutron.com/) is an American lighting control company. They have several lines of home automation devices that manage light switches/dimmers, occupancy sensors, HVAC controls, etc. The `lutron` component in Home Assistant is responsible for communicating with the main hub for these systems. +[Lutron](http://www.lutron.com/) is an American lighting control company. They have several lines of home automation devices that manage light switches/dimmers, occupancy sensors, HVAC controls, etc. The `lutron` integration in Home Assistant is responsible for communicating with the main hub for these systems. Presently, there's only support for communicating with the [RadioRA 2](http://www.lutron.com/en-US/Products/Pages/WholeHomeSystems/RadioRA2/Overview.aspx) Main Repeater and only handle light switches, dimmers, and seeTouch keypad scenes. ## {% linkable_title Configuration %} -When configured, the `lutron` component will automatically discover the rooms and their associated switches/dimmers as configured by the RadioRA 2 software from Lutron. Each room will be treated as a separate group. +When configured, the `lutron` integration will automatically discover the rooms and their associated switches/dimmers as configured by the RadioRA 2 software from Lutron. Each room will be treated as a separate group. To use Lutron RadioRA 2 devices in your installation, add the following to your `configuration.yaml` file using the IP address of your RadioRA 2 main repeater: @@ -74,7 +74,7 @@ For single-action buttons (scene selection, etc.), `action` will be `single`, an ## {% linkable_title Scene %} -This component uses keypad programming to identify scenes. Currently, it only works with SeeTouch keypads. +This integration uses keypad programming to identify scenes. Currently, it only works with SeeTouch keypads. The Lutron scene platform allows you to control scenes programmed into your SeeTouch keypads. After setup, scenes will appear in Home Assistant using the area, keypad and button name. diff --git a/source/_components/lutron_caseta.markdown b/source/_components/lutron_caseta.markdown index b45e2da1771..ec5aeb37fb2 100644 --- a/source/_components/lutron_caseta.markdown +++ b/source/_components/lutron_caseta.markdown @@ -23,9 +23,9 @@ redirect_from: - /components/switch.lutron_caseta/ --- -[Lutron](http://www.lutron.com/) is an American lighting control company. They have several lines of home automation devices that manage light switches, dimmers, occupancy sensors, HVAC controls, etc. The `lutron_caseta` component in Home Assistant is responsible for communicating with the Lutron Caseta Smart Bridge for the [Caseta](http://www.casetawireless.com) product line of dimmers, switches and shades. +[Lutron](http://www.lutron.com/) is an American lighting control company. They have several lines of home automation devices that manage light switches, dimmers, occupancy sensors, HVAC controls, etc. The `lutron_caseta` integration in Home Assistant is responsible for communicating with the Lutron Caseta Smart Bridge for the [Caseta](http://www.casetawireless.com) product line of dimmers, switches and shades. -This component only supports the [Caseta](http://www.casetawireless.com) line of products. Both Smart Bridge (L-BDG2-WH) and Smart Bridge PRO (L-BDGPRO2-WH) models are supported. For the RadioRA 2 product line, see the [Lutron component](/components/lutron/). +This integration only supports the [Caseta](http://www.casetawireless.com) line of products. Both Smart Bridge (L-BDG2-WH) and Smart Bridge PRO (L-BDGPRO2-WH) models are supported. For the RadioRA 2 product line, see the [Lutron component](/components/lutron/). The currently supported Caseta devices are: @@ -34,7 +34,7 @@ The currently supported Caseta devices are: - Scenes as Home Assistant - Lutron shades as Home Assistant -When configured, the `lutron_caseta` component will automatically discover the currently supported devices as setup in the Lutron Smart Bridge. The name assigned in the Lutron mobile app will be used to form the `entity_id` used in Home Assistant. e.g., a dimmer called 'Lamp' in a room called 'Bedroom' becomes `light.bedroom_lamp` in Home Assistant. +When configured, the `lutron_caseta` integration will automatically discover the currently supported devices as setup in the Lutron Smart Bridge. The name assigned in the Lutron mobile app will be used to form the `entity_id` used in Home Assistant. e.g., a dimmer called 'Lamp' in a room called 'Bedroom' becomes `light.bedroom_lamp` in Home Assistant. To use Lutron Caseta devices in your installation, you must first log in to your Lutron account and generate a certificate that allows Home Assistant to connect to your bridge. This can be accomplished by downloading and executing [get_lutron_cert.py](https://github.com/gurumitts/pylutron-caseta/blob/master/get_lutron_cert.py), which will generate three files: caseta.key, caseta.crt, caseta-bridge.crt when you run it. See the instructions at the top of the script for more information. @@ -74,7 +74,7 @@ It is recommended to assign a static IP address to your Lutron Smart Bridge. Thi Use a DHCP reservation on your router to reserve the address or in the PRO model of the Smart Bridge, set the IP address under Network Settings in the Advanced / Integration menu in the mobile app.

-To get Lutron Caseta roller, honeycomb shades, lights, scene and switch working with Home Assistant. First follow the instructions for the general Lutron Caseta component above. +To get Lutron Caseta roller, honeycomb shades, lights, scene and switch working with Home Assistant. First follow the instructions for the general Lutron Caseta integration above. ## {% linkable_title Cover %} diff --git a/source/_components/mailgun.markdown b/source/_components/mailgun.markdown index db47b0549e9..904b883ed40 100644 --- a/source/_components/mailgun.markdown +++ b/source/_components/mailgun.markdown @@ -15,7 +15,7 @@ redirect_from: - /components/notify.mailgun/ --- -To be able to receive webhooks from Mailgun, your Home Assistant instance needs to be accessible from the web ([Hass.io instructions](/addons/duckdns/)) and you need to have the `base_url` configured for the HTTP component ([docs](/components/http/#base_url)). +To be able to receive webhooks from Mailgun, your Home Assistant instance needs to be accessible from the web ([Hass.io instructions](/addons/duckdns/)) and you need to have the `base_url` configured for the HTTP integration ([docs](/components/http/#base_url)). To set it up, go to the integrations page in the configuration screen and find Mailgun. Click on configure. Follow the instructions on the screen to configure Mailgun. diff --git a/source/_components/manual.markdown b/source/_components/manual.markdown index 18a0c98ce9f..611f755a4d3 100644 --- a/source/_components/manual.markdown +++ b/source/_components/manual.markdown @@ -92,7 +92,7 @@ armed_custom_bypass/armed_home/armed_away/armed_night/disarmed/triggered: ## {% linkable_title State machine %} -The state machine of the manual alarm component is complex but powerful. The +The state machine of the manual alarm integration is complex but powerful. The transitions are timed according to three values, **delay_time**, **pending_time** and **trigger_time**. The values in turn can come from the default configuration variable or from a state-specific override. diff --git a/source/_components/manual_mqtt.markdown b/source/_components/manual_mqtt.markdown index a0fa6aa8d76..ecf2e39821a 100644 --- a/source/_components/manual_mqtt.markdown +++ b/source/_components/manual_mqtt.markdown @@ -19,7 +19,7 @@ The `mqtt` platform extends the [manual alarm](/components/alarm_control_panel.m It's essentially the opposite of the [MQTT Alarm Panel](/components/alarm_control_panel.mqtt/) which allows Home Assistant to observe an existing, fully-featured alarm where all of the alarm logic is embedded in that physical device. -The component will accept the following commands from your Alarm Panel via the `command_topic`: +The integration will accept the following commands from your Alarm Panel via the `command_topic`: - `DISARM` - `ARM_HOME` diff --git a/source/_components/matrix.markdown b/source/_components/matrix.markdown index 4cc3ce41822..2f362d092db 100644 --- a/source/_components/matrix.markdown +++ b/source/_components/matrix.markdown @@ -16,7 +16,7 @@ redirect_from: - /components/notify.matrix/ --- -This component allows you to send messages to matrix rooms, as well as to react to messages in matrix rooms. Reacting to commands is accomplished by firing an event when one of the configured commands is triggered. +This integration allows you to send messages to matrix rooms, as well as to react to messages in matrix rooms. Reacting to commands is accomplished by firing an event when one of the configured commands is triggered. There is currently support for the following device types within Home Assistant: diff --git a/source/_components/maxcube.markdown b/source/_components/maxcube.markdown index 6ede1134ffe..a8ec3c95402 100644 --- a/source/_components/maxcube.markdown +++ b/source/_components/maxcube.markdown @@ -18,7 +18,7 @@ redirect_from: - /components/climate.maxcube/ --- -[eQ-3 MAX!](http://www.eq-3.com/products/max.html) integration for Home Assistant allows you to connect eQ-3 MAX! components via the eQ-3 MAX! Cube. The components connects to the eQ-3 MAX! Cube via TCP and automatically makes all supported components available in Home Assistant. The name for each device is created by concatenating the MAX! room and device names. +[eQ-3 MAX!](http://www.eq-3.com/products/max.html) integration for Home Assistant allows you to connect eQ-3 MAX! components via the eQ-3 MAX! Cube. The components connects to the eQ-3 MAX! Cube via TCP and automatically makes all supported integrations available in Home Assistant. The name for each device is created by concatenating the MAX! room and device names. There is currently support for the following device types within Home Assistant: diff --git a/source/_components/mcp23017.markdown b/source/_components/mcp23017.markdown index 4629de4e426..8725d9f9439 100644 --- a/source/_components/mcp23017.markdown +++ b/source/_components/mcp23017.markdown @@ -16,7 +16,7 @@ ha_release: 0.94 ha_iot_class: Local Polling --- -The `mcp23017` component is the base for all related mcp23017 platforms in Home Assistant. There is no setup needed for the component itself, for the platforms please check their corresponding sections. +The `mcp23017` integration is the base for all related mcp23017 platforms in Home Assistant. There is no setup needed for the integration itself, for the platforms please check their corresponding sections. For more details about the MCP23017 I2C I/O port expander you can find its datasheet here: [MCP23017](https://www.microchip.com/wwwproducts/en/MCP23017). diff --git a/source/_components/media_extractor.markdown b/source/_components/media_extractor.markdown index ccbfaff639e..d853f0c31bb 100644 --- a/source/_components/media_extractor.markdown +++ b/source/_components/media_extractor.markdown @@ -14,7 +14,7 @@ ha_release: 0.49 ha_qa_scale: internal --- -The `media_extractor` component gets a stream URL and sends it to a media player entity. This component can extract entity specific streams if configured accordingly. +The `media_extractor` integration gets a stream URL and sends it to a media player entity. This integration can extract entity specific streams if configured accordingly.

Media extractor doesn't transcode streams, it just tries to find stream that match requested query. diff --git a/source/_components/media_player.markdown b/source/_components/media_player.markdown index 7a0bbe6d858..cbce37a2b08 100644 --- a/source/_components/media_player.markdown +++ b/source/_components/media_player.markdown @@ -51,7 +51,7 @@ Available services: `turn_on`, `turn_off`, `toggle`, `volume_up`, `volume_down`, | Service data attribute | Optional | Description | | -----------------------| -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `entity_id` | yes | Target a specific media player. Defaults to all. | -| `media_content_id` | no | A media identifier. The format of this is component dependent. For example, you can provide URLs to Sonos and Cast but only a playlist ID to iTunes. | +| `media_content_id` | no | A media identifier. The format of this is integration dependent. For example, you can provide URLs to Sonos and Cast but only a playlist ID to iTunes. | | `media_content_type` | no | A media type. Must be one of `music`, `tvshow`, `video`, `episode`, `channel` or `playlist`. For example, to play music you would set `media_content_type` to `music`. | #### {% linkable_title Service `media_player.select_source` %} diff --git a/source/_components/mediaroom.markdown b/source/_components/mediaroom.markdown index e28fdac628a..5409e1d1d6c 100644 --- a/source/_components/mediaroom.markdown +++ b/source/_components/mediaroom.markdown @@ -16,7 +16,7 @@ redirect_from: - /components/media_player.mediaroom/ --- -The `mediaroom` component allows you to control a [Mediaroom](https://en.wikipedia.org/wiki/Ericsson_Mediaroom) Set-Top Box (STB) from Home Assistant. +The `mediaroom` integration allows you to control a [Mediaroom](https://en.wikipedia.org/wiki/Ericsson_Mediaroom) Set-Top Box (STB) from Home Assistant. To add a Mediaroom STB to your installation, add the following to your `configuration.yaml` file: @@ -38,7 +38,7 @@ media_player: type: string default: Mediaroom STB optimistic: - description: In case the component cannot determine the status of the box, consider the box always ON. + description: In case the integration cannot determine the status of the box, consider the box always ON. required: false type: boolean default: false @@ -46,13 +46,13 @@ media_player: Notice that all parameters are optional, and discovery should configure everything for you. -#### {% linkable_title Using the Mediaroom component %} +#### {% linkable_title Using the Mediaroom integration %} -The component has been developed for Portuguese TV operators currently using the Mediaroom platform, but should also work in other deployments in which the STB can be controlled remotely through a socket on port 8082. +The integration has been developed for Portuguese TV operators currently using the Mediaroom platform, but should also work in other deployments in which the STB can be controlled remotely through a socket on port 8082. In most cases (single STB) you just need to setup the *platform* and discovery will do the rest. -If the STB is on the same network segment as Home Assistant, it can determine whether the device is turned on or off. Without this, the component will fail to determine the Set-top box status, and you are required to add the *optimistic* configuration variable. +If the STB is on the same network segment as Home Assistant, it can determine whether the device is turned on or off. Without this, the integration will fail to determine the Set-top box status, and you are required to add the *optimistic* configuration variable. ## {% linkable_title Examples %} diff --git a/source/_components/melissa.markdown b/source/_components/melissa.markdown index 17eafe9bd02..f49f6c291a9 100644 --- a/source/_components/melissa.markdown +++ b/source/_components/melissa.markdown @@ -17,17 +17,17 @@ redirect_from: - /components/climate.melissa/ --- -The `melissa` component is the main component to connect to a [Melissa Climate](http://seemelissa.com/) A/C control. +The `melissa` integration is the main integration to connect to a [Melissa Climate](http://seemelissa.com/) A/C control. There is currently support for the following device types within Home Assistant: - Climate -The climate platform will be automatically configured if Melissa component is configured. +The climate platform will be automatically configured if Melissa integration is configured. ## {% linkable_title Configuration %} -To set the Melissa component up, add the following information to your `configuration.yaml` file: +To set the Melissa integration up, add the following information to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/mercedesme.markdown b/source/_components/mercedesme.markdown index e21c4adc556..5b12016f0e0 100644 --- a/source/_components/mercedesme.markdown +++ b/source/_components/mercedesme.markdown @@ -21,16 +21,16 @@ redirect_from: - /components/sensor.mercedesme/ --- -The `mercedesme` component offers integration with the [Mercedes me](https://www.mercedes-benz.com/de/mercedes-me/) cloud service and provides presence detection as well as sensors such as doors, tires, windows, and service interval. +The `mercedesme` integration offers integration with the [Mercedes me](https://www.mercedes-benz.com/de/mercedes-me/) cloud service and provides presence detection as well as sensors such as doors, tires, windows, and service interval. -This component provides the following platforms: +This integration provides the following platforms: - Binary Sensors: Windows, tires, doors and lock. - Sensors:Fuel status, service interval, remaining km, etc. - Device tracker: To track location of your car. -Platforms will be automatically configured if Mercedes me component is configured. +Platforms will be automatically configured if Mercedes me integration is configured.

- The component was removed. The vendor disabled the API endpoint and a new API is not available currently. + The integration was removed. The vendor disabled the API endpoint and a new API is not available currently.

diff --git a/source/_components/meteo_france.markdown b/source/_components/meteo_france.markdown index 3226843488d..9abd6cf3762 100644 --- a/source/_components/meteo_france.markdown +++ b/source/_components/meteo_france.markdown @@ -19,7 +19,7 @@ redirect_from: - /components/weather.meteo_france/ --- -The `meteo_france` component uses the [Météo-France](http://www.meteofrance.com/) web service as a source for meteorological data for your location. The location is based on the `city` configured in your `configuration.yaml` file. +The `meteo_france` integration uses the [Météo-France](http://www.meteofrance.com/) web service as a source for meteorological data for your location. The location is based on the `city` configured in your `configuration.yaml` file. There is currently support for the following device types within Home Assistant: @@ -72,7 +72,7 @@ meteo_france: ### {% linkable_title About `city` configuration %} -This component use the Météo-France search API to get the first city from the results returned. +This integration use the Météo-France search API to get the first city from the results returned. It works well with french postal code, city name, etc. In case your expected result doesn't come first, you can set a more specified query like `, `. diff --git a/source/_components/meteoalarm.markdown b/source/_components/meteoalarm.markdown index 5bb38e0a088..f57b9b51217 100644 --- a/source/_components/meteoalarm.markdown +++ b/source/_components/meteoalarm.markdown @@ -105,5 +105,5 @@ automation: {% endraw %}

-This component is not affiliated with MeteoAlarm and retrieves data from the website by using the XML feeds. Use it at your own risk. +This integration is not affiliated with MeteoAlarm and retrieves data from the website by using the XML feeds. Use it at your own risk.

diff --git a/source/_components/metoffice.markdown b/source/_components/metoffice.markdown index 7a5e787a859..de6704a3099 100644 --- a/source/_components/metoffice.markdown +++ b/source/_components/metoffice.markdown @@ -35,7 +35,7 @@ api_key: required: true type: string name: - description: Additional name for the weather component in Home Assistant. + description: Additional name for the weather integration in Home Assistant. required: false type: string default: Met Office diff --git a/source/_components/mhz19.markdown b/source/_components/mhz19.markdown index c01ff9d43fb..866dc57a9c6 100644 --- a/source/_components/mhz19.markdown +++ b/source/_components/mhz19.markdown @@ -66,4 +66,4 @@ Then (after a reboot): you can setup the sensor using: ## {% linkable_title Calibration %} -The MH-Z19B version of the sensor has Automatic Baseline Calibration enabled by default, which will calibrate the 400PPM level to the lowest measured PPM in the last 24h cycle. Currently the component does not allow turning this functionaly off. +The MH-Z19B version of the sensor has Automatic Baseline Calibration enabled by default, which will calibrate the 400PPM level to the lowest measured PPM in the last 24h cycle. Currently the integration does not allow turning this functionaly off. diff --git a/source/_components/microsoft.markdown b/source/_components/microsoft.markdown index 496a3513dec..9f7dac5fdf6 100644 --- a/source/_components/microsoft.markdown +++ b/source/_components/microsoft.markdown @@ -15,7 +15,7 @@ redirect_from: - /components/tts.microsoft/ --- -The `microsoft` text-to-speech platform uses [Microsoft Text-to-Speech engine](https://docs.microsoft.com/en-us/azure/cognitive-services/speech/home) to read a text with natural sounding voices. This component uses an API that is part of the Cognitive Services offering and is known as the Bing Speech API. +The `microsoft` text-to-speech platform uses [Microsoft Text-to-Speech engine](https://docs.microsoft.com/en-us/azure/cognitive-services/speech/home) to read a text with natural sounding voices. This integration uses an API that is part of the Cognitive Services offering and is known as the Bing Speech API. You will need an API key, which is free. You can use your [Azure subscription](https://azure.microsoft.com) or get an API key on the [Cognitive Services site](https://azure.microsoft.com/en-us/try/cognitive-services/). ## {% linkable_title Configuration %} diff --git a/source/_components/microsoft_face.markdown b/source/_components/microsoft_face.markdown index d26dffb6c0c..aae2a39cc02 100644 --- a/source/_components/microsoft_face.markdown +++ b/source/_components/microsoft_face.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Microsoft Face" -description: "Instructions on how to integrate Microsoft Face component into Home Assistant." +description: "Instructions on how to integrate Microsoft Face integration into Home Assistant." date: 2017-01-25 00:00 sidebar: true comments: false @@ -13,7 +13,7 @@ ha_category: ha_release: 0.37 --- -The `microsoft_face` component platform is the main component for Microsoft +The `microsoft_face` integration platform is the main integration for Microsoft Azure Cognitive service [Face](https://azure.microsoft.com/en-us/services/cognitive-services/face/). All data are stored in your own private instance in the Azure cloud. diff --git a/source/_components/mikrotik.markdown b/source/_components/mikrotik.markdown index 2ae7375363f..472015bccea 100644 --- a/source/_components/mikrotik.markdown +++ b/source/_components/mikrotik.markdown @@ -117,4 +117,4 @@ device_tracker: method: capsman ``` -See the [device tracker component page](/components/device_tracker/) for instructions on how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions on how to configure the people to be tracked. diff --git a/source/_components/mobile_app.markdown b/source/_components/mobile_app.markdown index ef2ab766b9a..f84a40bef45 100644 --- a/source/_components/mobile_app.markdown +++ b/source/_components/mobile_app.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Mobile App" -description: "The Mobile App component allows a generic platform for integrating with mobile apps." +description: "The Mobile App integration allows a generic platform for integrating with mobile apps." date: 2019-03-06 01:30 sidebar: true comments: false @@ -14,16 +14,16 @@ ha_release: 0.89 ha_qa_scale: internal --- -The Mobile App component allows Home Assistant mobile apps to easily integrate with Home Assistant. +The Mobile App integration allows Home Assistant mobile apps to easily integrate with Home Assistant. -If you are planning to use a mobile application that integrates with Home Assistant, we recommend that you keep this component enabled. +If you are planning to use a mobile application that integrates with Home Assistant, we recommend that you keep this integration enabled. If you are a mobile app developer, see the [developer documentation](https://developers.home-assistant.io/docs/en/app_integration_index.html) for instructions on how to build your app on top of the mobile app component. ## {% linkable_title Configuration %} -This component is by default enabled, unless you've disabled or removed the `default_config:` line from your configuration. -If that is the case, the following example shows you how to enable this component manually: +This integration is by default enabled, unless you've disabled or removed the `default_config:` line from your configuration. +If that is the case, the following example shows you how to enable this integration manually: ```yaml # Example configuration.yaml entry diff --git a/source/_components/mochad.markdown b/source/_components/mochad.markdown index a4873a903cf..692c3c90738 100644 --- a/source/_components/mochad.markdown +++ b/source/_components/mochad.markdown @@ -17,7 +17,7 @@ redirect_from: - /components/switch.mochad/ --- -The `mochad` component is the main component to integrate all X10 platforms being controlled by [mochad](https://sourceforge.net/projects/mochad/). Besides this component you will have to setup your X10 devices separately. +The `mochad` integration is the main integration to integrate all X10 platforms being controlled by [mochad](https://sourceforge.net/projects/mochad/). Besides this integration you will have to setup your X10 devices separately. There is currently support for the following device types within Home Assistant: diff --git a/source/_components/mold_indicator.markdown b/source/_components/mold_indicator.markdown index 65f3ac9d1a5..73981cc1d40 100644 --- a/source/_components/mold_indicator.markdown +++ b/source/_components/mold_indicator.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Mold Indicator" -description: "How to use the mold growth indication component in Home Assistant" +description: "How to use the mold growth indication integration in Home Assistant" date: 2016-02-11 22:00 sidebar: true comments: false @@ -17,7 +17,7 @@ redirect_from: - /components/sensor.mold_indicator/ --- -The Mold Indicator sensor component consumes information of two temperature sensors and a humidity sensor to give an indication for possible mold growth in your home. In case of bad ventilation and insulation, the indoor humidity may lead to condensation on cold surfaces as the windows or even walls. Condensation or a high relative humidity near those cold surfaces leads to a higher risk for mold growth. This sensor component estimates the temperature at a pre-calibrated critical point in the room (the coldest surface) and calculates the relative humidity of the air at that point. If the sensor value rises above approximately 70 percent, mold growth might occur and the room should be ventilated. At 100%, the air humidity condensates at the critical point. +The Mold Indicator sensor integration consumes information of two temperature sensors and a humidity sensor to give an indication for possible mold growth in your home. In case of bad ventilation and insulation, the indoor humidity may lead to condensation on cold surfaces as the windows or even walls. Condensation or a high relative humidity near those cold surfaces leads to a higher risk for mold growth. This sensor integration estimates the temperature at a pre-calibrated critical point in the room (the coldest surface) and calculates the relative humidity of the air at that point. If the sensor value rises above approximately 70 percent, mold growth might occur and the room should be ventilated. At 100%, the air humidity condensates at the critical point. The sensor data may be used e.g., to signal bad air quality (too high air humidity) or to automate operation of indoor air humidifiers to keep the indoor humidity at an optimum. @@ -62,7 +62,7 @@ In this case, the weather forecast temperature sensor is used for the outside te ## {% linkable_title Calibration %} -The Mold Indicator sensor component needs to be calibrated in order to estimate the temperature at the critical point from the outdoor and indoor temperature. First find the coldest surface in the room (critical point), which is typically near the window frames, but depends on the insulation of your home. For calibration you need to measure the temperature at this critical point and simultaneously write down the values for the indoor- and outdoor temperature sensors used for the Mold Indicator. Be sure that there is a significant indoor to outdoor temperature difference to get the best calibration results. +The Mold Indicator sensor integration needs to be calibrated in order to estimate the temperature at the critical point from the outdoor and indoor temperature. First find the coldest surface in the room (critical point), which is typically near the window frames, but depends on the insulation of your home. For calibration you need to measure the temperature at this critical point and simultaneously write down the values for the indoor- and outdoor temperature sensors used for the Mold Indicator. Be sure that there is a significant indoor to outdoor temperature difference to get the best calibration results. With the three measured temperatures (in Celsius or Fahrenheit), the calibration_factor for your configuration file is given by: ```text diff --git a/source/_components/mopar.markdown b/source/_components/mopar.markdown index 61ccb5e898c..82f4fa7a81b 100644 --- a/source/_components/mopar.markdown +++ b/source/_components/mopar.markdown @@ -19,7 +19,7 @@ redirect_from: - /components/sensor.mopar/ --- -The `mopar` component provides the following for owners of FCA vehicles with a uConnect subscription: +The `mopar` integration provides the following for owners of FCA vehicles with a uConnect subscription: - Sensor per vehicle with vehicle health report and other meta-data - Lock per vehicle allowing to lock/unlock the vehicle diff --git a/source/_components/mpchc.markdown b/source/_components/mpchc.markdown index 6793fe01e97..21cc0b83e2a 100644 --- a/source/_components/mpchc.markdown +++ b/source/_components/mpchc.markdown @@ -19,7 +19,7 @@ redirect_from: The `mpchc` platform allows you to connect a [Media Player Classic Home Cinema](https://mpc-hc.org/) to Home Assistant. It will allow you to see the current playing item, and respond to changes in the player's state. -For this component to function, you will need to enable the Web Interface in the MPC-HC options dialog. +For this integration to function, you will need to enable the Web Interface in the MPC-HC options dialog.

diff --git a/source/_components/mqtt_eventstream.markdown b/source/_components/mqtt_eventstream.markdown index b35a2e57d49..557312d2e07 100644 --- a/source/_components/mqtt_eventstream.markdown +++ b/source/_components/mqtt_eventstream.markdown @@ -14,7 +14,7 @@ ha_release: 0.11 ha_iot_class: Configurable --- -The `mqtt_eventstream` component connects two Home Assistant instances via MQTT. +The `mqtt_eventstream` integration connects two Home Assistant instances via MQTT. ## {% linkable_title Configuration %} diff --git a/source/_components/mqtt_room.markdown b/source/_components/mqtt_room.markdown index 362edcb75db..966b48b0ff3 100644 --- a/source/_components/mqtt_room.markdown +++ b/source/_components/mqtt_room.markdown @@ -69,7 +69,7 @@ Example JSON that should be published to the room topics: ### {% linkable_title Setting up clients %} -This component works with any software that is sending data in the given format. Each client should post the discovered devices in its own subtopic of the configured topic. +This integration works with any software that is sending data in the given format. Each client should post the discovered devices in its own subtopic of the configured topic. Instead of developing your own application, you can also use any of these already existing clients: - [**room-assistant**](https://github.com/mKeRix/room-assistant): looks for Bluetooth LE beacons, based on Node.js diff --git a/source/_components/mqtt_statestream.markdown b/source/_components/mqtt_statestream.markdown index 14ea333bc5b..b98d78ab071 100644 --- a/source/_components/mqtt_statestream.markdown +++ b/source/_components/mqtt_statestream.markdown @@ -14,7 +14,7 @@ ha_release: 0.54 ha_iot_class: Configurable --- -The `mqtt_statestream` component publishes state changes in Home Assistant to individual MQTT topics. +The `mqtt_statestream` integration publishes state changes in Home Assistant to individual MQTT topics. ## {% linkable_title Configuration %} @@ -44,7 +44,7 @@ publish_timestamps: default: false type: boolean exclude: - description: Configure which components should be excluded from recordings. See *Include/Exclude* section below for details. + description: Configure which integrations should be excluded from recordings. See *Include/Exclude* section below for details. required: false type: list keys: @@ -57,7 +57,7 @@ exclude: required: false type: list include: - description: Configure which components should be included in recordings. If set, all other entities will not be recorded. + description: Configure which integrations should be included in recordings. If set, all other entities will not be recorded. required: false type: list keys: @@ -73,14 +73,14 @@ include: ## {% linkable_title Operation %} -When any Home Assistant entity changes, this component will publish that change to MQTT. +When any Home Assistant entity changes, this integration will publish that change to MQTT. The topic for each entity is different, so you can easily subscribe other systems to just the entities you are interested in. The topic will be in the form `base_topic/domain/entity/state`. -For example, with the example configuration above, if an entity called 'light.master_bedroom_dimmer' is turned on, this component will publish `on` to `homeassistant/light/master_bedroom_dimmer/state`. +For example, with the example configuration above, if an entity called 'light.master_bedroom_dimmer' is turned on, this integration will publish `on` to `homeassistant/light/master_bedroom_dimmer/state`. -If that entity also has an attribute called `brightness`, the component will also publish the value of that attribute to `homeassistant/light/master_bedroom_dimmer/brightness`. +If that entity also has an attribute called `brightness`, the integration will also publish the value of that attribute to `homeassistant/light/master_bedroom_dimmer/brightness`. All states and attributes are passed through JSON serialization before publishing. **Please note** that this causes strings to be quoted (e.g., the string 'on' will be published as '"on"'). You can access the JSON deserialized values (as well as unquoted strings) at many places by using `value_json` instead of `value`. diff --git a/source/_components/mychevy.markdown b/source/_components/mychevy.markdown index 5d681a94199..b56b7b1a500 100644 --- a/source/_components/mychevy.markdown +++ b/source/_components/mychevy.markdown @@ -17,9 +17,9 @@ redirect_from: - /components/sensor.mychevy/ --- -The `mychevy` component communicates with the [my.chevrolet](https://my.chevrolet.com) website using the javascript API that the website uses (as of Dec 2018). The MyChevy website has been known to be both unstable (interfaces changing somewhat willy nilly) and has substantial outages. So be forwarned in using this component. +The `mychevy` integration communicates with the [my.chevrolet](https://my.chevrolet.com) website using the javascript API that the website uses (as of Dec 2018). The MyChevy website has been known to be both unstable (interfaces changing somewhat willy nilly) and has substantial outages. So be forwarned in using this component. -This component provides the following platforms: +This integration provides the following platforms: - Binary sensors: if the car is plugged in - Sensors: Battery Level, Charge Mode, EST Range, Total Distance Traveled @@ -55,7 +55,7 @@ country: The architecture of the GM automotive networking imposes some limitations on the functionality of the component. -The OnStar network link is very slow, and takes 1 - 3 minutes to get information back from the car. As such the `mychevy` component only polls every 30 minutes to not overwhelms that connection. +The OnStar network link is very slow, and takes 1 - 3 minutes to get information back from the car. As such the `mychevy` integration only polls every 30 minutes to not overwhelms that connection. The OnStar network (or more specifically the gateway used by the my.chevrolet website) appears to suffer more than most networks when the car is a) in a garage, and b) it's cold outside (like < 15 degrees F). One of the provided sensors is a status sensor which indicates if we got connectivity with the car on the last polling cycle or not. diff --git a/source/_components/mysensors.markdown b/source/_components/mysensors.markdown index b7fc620ea8d..4ae4e38e749 100644 --- a/source/_components/mysensors.markdown +++ b/source/_components/mysensors.markdown @@ -14,7 +14,7 @@ ha_iot_class: Local Push ha_release: 0.73 --- -The [MySensors](https://www.mysensors.org) project combines devices like Arduino, ESP8266, Raspberry Pi, NRF24L01+ and RFM69 to build affordable sensor networks. This component will automatically add all available devices to Home Assistant, after [presentation](#presentation) is done. That is, you do not need to add anything to your configuration for the devices for them to be added. Go to the **states** section of the developer tools to find the devices that have been identified. +The [MySensors](https://www.mysensors.org) project combines devices like Arduino, ESP8266, Raspberry Pi, NRF24L01+ and RFM69 to build affordable sensor networks. This integration will automatically add all available devices to Home Assistant, after [presentation](#presentation) is done. That is, you do not need to add anything to your configuration for the devices for them to be added. Go to the **states** section of the developer tools to find the devices that have been identified. ### {% linkable_title Configuration %} @@ -149,7 +149,7 @@ mysensors: Present a MySensors sensor or actuator, by following these steps: 1. Connect the serial gateway to your computer or the Ethernet or MQTT gateway to your network. -2. Configure the MySensors component in `configuration.yaml`. +2. Configure the MySensors integration in `configuration.yaml`. 3. Start Home Assistant. 4. Write and upload your MySensors sketch to the sensor. Make sure you: - Send sketch name. @@ -253,7 +253,7 @@ Message validation was introduced in version 0.52 of Home Assistant. ### {% linkable_title Debug logging %} -If you experience dropped messages or that a device is not added to Home Assistant, please turn on debug logging for the `mysensors` component and the `mysensors` package. This will help you see what is going on. Make sure you use these logging settings to collect a log sample if you report an issue about the `mysensors` integration in our github issue tracker. +If you experience dropped messages or that a device is not added to Home Assistant, please turn on debug logging for the `mysensors` integration and the `mysensors` package. This will help you see what is going on. Make sure you use these logging settings to collect a log sample if you report an issue about the `mysensors` integration in our github issue tracker. ```yaml logger: default: info diff --git a/source/_components/mythicbeastsdns.markdown b/source/_components/mythicbeastsdns.markdown index b5db1384f6b..67ae36f5a90 100644 --- a/source/_components/mythicbeastsdns.markdown +++ b/source/_components/mythicbeastsdns.markdown @@ -14,11 +14,11 @@ ha_iot_class: Cloud Push logo: mythic_beasts.png --- -With the `mythicbeastsdns` component you can automatically update your dynamic DNS entry at [Mythic Beasts](https://www.mythic-beasts.com/). +With the `mythicbeastsdns` integration you can automatically update your dynamic DNS entry at [Mythic Beasts](https://www.mythic-beasts.com/). ## {% linkable_title Configuration %} -To use the component in your installation, add the following to your `configuration.yaml` file: +To use the integration in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/n26.markdown b/source/_components/n26.markdown index b4ea134c675..a5430f2cff1 100644 --- a/source/_components/n26.markdown +++ b/source/_components/n26.markdown @@ -1,7 +1,7 @@ --- layout: page title: "N26" -description: "Instructions on how to integrate N26 component within Home Assistant." +description: "Instructions on how to integrate N26 integration within Home Assistant." date: 2019-03-11 20:00 sidebar: true comments: false diff --git a/source/_components/namecheapdns.markdown b/source/_components/namecheapdns.markdown index b0798ab5004..72884063846 100644 --- a/source/_components/namecheapdns.markdown +++ b/source/_components/namecheapdns.markdown @@ -13,7 +13,7 @@ ha_category: ha_release: 0.56 --- -With the `namecheapdns` component you can automatically update your dynamic DNS entry at [namecheapdns](https://www.namecheap.com/store/domains/freedns/). +With the `namecheapdns` integration you can automatically update your dynamic DNS entry at [namecheapdns](https://www.namecheap.com/store/domains/freedns/).

Namecheap only supports IPv4 addresses to update. @@ -21,7 +21,7 @@ Namecheap only supports IPv4 addresses to update. ## {% linkable_title Configuration %} -To use the component in your installation, add the following to your `configuration.yaml` file: +To use the integration in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/neato.markdown b/source/_components/neato.markdown index 6fe4639c023..ad19520fe74 100644 --- a/source/_components/neato.markdown +++ b/source/_components/neato.markdown @@ -19,7 +19,7 @@ redirect_from: - /components/vacuum.neato/ --- -The `neato` component allows you to control your [Neato Botvac Connected Robots](https://www.neatorobotics.com/robot-vacuum/botvac-connected-series/). +The `neato` integration allows you to control your [Neato Botvac Connected Robots](https://www.neatorobotics.com/robot-vacuum/botvac-connected-series/). To enable `neato` in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/ness_alarm.markdown b/source/_components/ness_alarm.markdown index cc60c07a848..6e54e59c29f 100644 --- a/source/_components/ness_alarm.markdown +++ b/source/_components/ness_alarm.markdown @@ -18,7 +18,7 @@ redirect_from: - /components/binary_sensor.ness_alarm/ --- -The `ness_alarm` component will allow Home Assistant users who own a Ness D8x/D16x alarm system to leverage their alarm system and its sensors to provide Home Assistant with information about their homes. Connectivity between Home Assistant and the alarm is accomplished through a IP232 module that must be connected to the alarm. +The `ness_alarm` integration will allow Home Assistant users who own a Ness D8x/D16x alarm system to leverage their alarm system and its sensors to provide Home Assistant with information about their homes. Connectivity between Home Assistant and the alarm is accomplished through a IP232 module that must be connected to the alarm. There is currently support for the following device types within Home Assistant: diff --git a/source/_components/nest.markdown b/source/_components/nest.markdown index 55a8da55918..7c8067cb8a6 100644 --- a/source/_components/nest.markdown +++ b/source/_components/nest.markdown @@ -24,7 +24,7 @@ redirect_from: ha_release: 0.7 --- -The Nest component is the main component to integrate all [Nest](https://nest.com/) related platforms. To connect Nest, you will have to [sign up for a developer account](https://developers.nest.com/products) and get a `client_id` and `client_secret`. +The Nest integration is the main integration to integrate all [Nest](https://nest.com/) related platforms. To connect Nest, you will have to [sign up for a developer account](https://developers.nest.com/products) and get a `client_id` and `client_secret`. There is currently support for the following device types within Home Assistant: @@ -50,7 +50,7 @@ There is currently support for the following device types within Home Assistant: * Use "[Home Assistant] [Edit] [For Home Automation]" as the description as it is not super important. 8. Click "Create Product" 9. Once the new product page opens the "Product ID" and "Product Secret" are located on the right side. These will be used as `client_id` and `client_secret` below. -10. Add the Nest component to your `configuration.yaml` and restart Home Assistant. Then, go to `Configuration > Integrations` and select `CONFIGURE` next to `Nest`. Click the link in the configurator pop up to log into your Nest account and complete the OAuth. Copy the resulting PIN code into the pop up. +10. Add the Nest integration to your `configuration.yaml` and restart Home Assistant. Then, go to `Configuration > Integrations` and select `CONFIGURE` next to `Nest`. Click the link in the configurator pop up to log into your Nest account and complete the OAuth. Copy the resulting PIN code into the pop up. Connecting to the Nest Developer API requires outbound port 9553 on your firewall. The configuration will fail if this is not accessible. @@ -207,7 +207,7 @@ You must have the [Nest component](/components/nest/) configured to use the plat The `nest` binary sensor platform lets you monitor various states of your [Nest](https://nest.com) devices.

-You must have the [Nest component](/components/nest/) configured to use these sensors. The binary sensors will be setup if the `nest` component is configured and the required configuration for the `nest binary sensor` is set. +You must have the [Nest component](/components/nest/) configured to use these sensors. The binary sensors will be setup if the `nest` integration is configured and the required configuration for the `nest binary sensor` is set.

## {% linkable_title Configuration %} @@ -277,7 +277,7 @@ Please note due to limitations with the European Nest Thermostat E, integration The `nest` sensor platform lets you monitor sensors connected to your [Nest](https://nest.com) devices.

-The sensors will be setup if the `nest` component is configured and the required configuration for the `nest sensor` is set. +The sensors will be setup if the `nest` integration is configured and the required configuration for the `nest sensor` is set.

## {% linkable_title Configuration %} diff --git a/source/_components/netatmo.markdown b/source/_components/netatmo.markdown index 19281f38514..44b496ffa24 100644 --- a/source/_components/netatmo.markdown +++ b/source/_components/netatmo.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Netatmo" -description: "Instructions on how to integrate Netatmo component into Home Assistant." +description: "Instructions on how to integrate Netatmo integration into Home Assistant." date: 2016-06-02 08:10 sidebar: true comments: false @@ -26,7 +26,7 @@ redirect_from: - /components/public_sensor.netatmo/ --- -The `netatmo` component platform is the main component to integrate all Netatmo related platforms. +The `netatmo` integration platform is the main integration to integrate all Netatmo related platforms. There is currently support for the following device types within Home Assistant: @@ -101,7 +101,7 @@ That's it. You can copy and paste your new `client id` and `client secret` in yo The Welcome and Presence cameras can send instant events to Home Assistant by using webhooks. There are different types of events, each with slightly different data attached. To enable the webhooks add `webhooks: true` to your configuration. It is also required to have your camera enabled in Home Assistant. You can do this either by manually setting up the [platform](https://www.home-assistant.io/components/camera.netatmo/) or by enabeling [discovery](https://www.home-assistant.io/components/netatmo/#discovery). -To be able to receive events from Netatmo, your Home Assistant instance needs to be accessible from the web ([Hass.io instructions](https://www.home-assistant.io/addons/duckdns/)) and you need to have the base_url configured for the HTTP component ([docs](https://www.home-assistant.io/components/http/#base_url)). +To be able to receive events from Netatmo, your Home Assistant instance needs to be accessible from the web ([Hass.io instructions](https://www.home-assistant.io/addons/duckdns/)) and you need to have the base_url configured for the HTTP integration ([docs](https://www.home-assistant.io/components/http/#base_url)). Events coming in from Netatmo will be available as events in Home Assistant and are fired as netatmo_*, along with their data. You can use this event to trigger automations. @@ -141,7 +141,7 @@ The Welcome camera additionally has these attributes for `netatmo_person` events | is_known | Boolean value if the person is known. | face_url | URL to a picture of the person. -The `netatmo_other` event passes all the webhook data through for all webhook events that don't match any of the above. Set the [level of logging](https://www.home-assistant.io/components/logger/) for the `netatmo` component to `debug` to view the data in the Home Assistant logs. +The `netatmo_other` event passes all the webhook data through for all webhook events that don't match any of the above. Set the [level of logging](https://www.home-assistant.io/components/logger/) for the `netatmo` integration to `debug` to view the data in the Home Assistant logs. ### {% linkable_title Services (only for webhooks) %} @@ -154,7 +154,7 @@ There are two services to manually add and drop the webhooks. This might be usef ## {% linkable_title Binary Sensor %} -This component allows you to get the latest event seen by the camera. +This integration allows you to get the latest event seen by the camera. ### {% linkable_title Binary Sensor Advanced configuration %} @@ -217,7 +217,7 @@ will create a specific sensor for each camera ## {% linkable_title Camera %} -The `netatmo` camera platform is consuming the information provided by a [Netatmo](https://www.netatmo.com) camera. This component allows you to view the current photo created by the Camera. +The `netatmo` camera platform is consuming the information provided by a [Netatmo](https://www.netatmo.com) camera. This integration allows you to view the current photo created by the Camera. ### {% linkable_title Camera Advanced configuration %} @@ -265,7 +265,7 @@ camera: ## {% linkable_title Climate %} -The `netatmo` thermostat platform is consuming the information provided by a [Netatmo Smart Thermostat](https://www.netatmo.com/product/energy/thermostat) thermostat. This component allows you to view the current temperature and setpoint. +The `netatmo` thermostat platform is consuming the information provided by a [Netatmo Smart Thermostat](https://www.netatmo.com/product/energy/thermostat) thermostat. This integration allows you to view the current temperature and setpoint. ### {% linkable_title Camera Advanced configuration %} diff --git a/source/_components/netgear.markdown b/source/_components/netgear.markdown index 689bbc7b193..622a451d59c 100644 --- a/source/_components/netgear.markdown +++ b/source/_components/netgear.markdown @@ -19,7 +19,7 @@ redirect_from: This platform allows you to detect presence by looking at connected devices to a [Netgear](http://www.netgear.com/) device.

-A recent updates of Orbi APs introduced a bug which takes several hours to detects presence on your local network. The current workaround is to force this component to use the Orbi's API v2 by adding the `accesspoints:` node to your configuration. +A recent updates of Orbi APs introduced a bug which takes several hours to detects presence on your local network. The current workaround is to force this integration to use the Orbi's API v2 by adding the `accesspoints:` node to your configuration.

To use this device tracker in your installation, add the following to your `configuration.yaml` file: @@ -76,4 +76,4 @@ List of models that are known to use port 80: - Nighthawk X4S - AC2600 (R7800) - Orbi -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. diff --git a/source/_components/nissan_leaf.markdown b/source/_components/nissan_leaf.markdown index 3eeb5148480..c291d89c383 100644 --- a/source/_components/nissan_leaf.markdown +++ b/source/_components/nissan_leaf.markdown @@ -18,7 +18,7 @@ redirect_from: - /components/switch.nissan_leaf/ --- -The `nissan_leaf` component offers integration with the [NissanConnect EV](http://youplus.nissan.co.uk/GB/en/YouPlus/ConnectedServices.html) cloud service. NissanConnect EV was previously known as Nissan Carwings. It offers: +The `nissan_leaf` integration offers integration with the [NissanConnect EV](http://youplus.nissan.co.uk/GB/en/YouPlus/ConnectedServices.html) cloud service. NissanConnect EV was previously known as Nissan Carwings. It offers: * sensors for the battery status, range and charging status * a switch to start and stop the climate control @@ -102,7 +102,7 @@ You can use the `nissan_leaf.start_charge` service to send a request to the Niss ## {% linkable_title Updating on-demand using Automation %} -You can also use the `nissan_leaf.update` service to request an on-demand update. To update almost exclusively via the service set the `update_interval` to a high value in the component configuration. The service requests the VIN number as described above. +You can also use the `nissan_leaf.update` service to request an on-demand update. To update almost exclusively via the service set the `update_interval` to a high value in the integration configuration. The service requests the VIN number as described above. ```yaml - id: update_when_driver_not_home @@ -125,7 +125,7 @@ You can also use the `nissan_leaf.update` service to request an on-demand update * The update interval has a minimum of two minutes. * Requesting updates uses a small amount of power from the 12 V battery. The 12 V battery charges from the main traction battery when the car is not plugged in. If the car is left plugged in for a long time, or if the main traction battery is very low then the 12 V battery may gradually discharge. A low update interval may cause the 12 V battery to become flat. When the 12 V battery is flat the car will not start. _Do not set the update interval too low. Use at your own risk._ -* This component communicates with the Nissan Servers which then communicate with the car. The communication between the car and the Nissan Servers is very slow, and takes up to five minutes to get information from the car, therefore the default polling interval is set to one hour to not overwhelm the connection. +* This integration communicates with the Nissan Servers which then communicate with the car. The communication between the car and the Nissan Servers is very slow, and takes up to five minutes to get information from the car, therefore the default polling interval is set to one hour to not overwhelm the connection. * Responses from the Nissan servers are received separately for the battery/range, climate control and location. The `updated_on` attribute will show the last time the data was retrieved from the server. There are separate attributes for when the `next_update` is scheduled, and to indicate if `update_in_progress`. The `nissan_leaf.update` service will reset the `next_update` attribute. * The Nissan APIs do not allow charging to be stopped remotely. * The Nissan servers have a history of being unstable, therefore please confirm that the official Nissan Leaf app/website is working correctly before reporting bugs. diff --git a/source/_components/nmap_tracker.markdown b/source/_components/nmap_tracker.markdown index fe414f96646..84aafaa55fc 100644 --- a/source/_components/nmap_tracker.markdown +++ b/source/_components/nmap_tracker.markdown @@ -105,4 +105,4 @@ And you can set up the device tracker as scan_options: " --privileged -sP " ``` -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. diff --git a/source/_components/nmbs.markdown b/source/_components/nmbs.markdown index 32c295f201e..061e6d332d2 100644 --- a/source/_components/nmbs.markdown +++ b/source/_components/nmbs.markdown @@ -32,7 +32,7 @@ sensor: exclude_vias: true ``` -The stations can only be provided by their standard names and not ids. The list of stations can be checked on the NMBS/SCNB website but for most accurate results check them on the [iRail API page](https://api.irail.be/stations/) which this component uses internally. +The stations can only be provided by their standard names and not ids. The list of stations can be checked on the NMBS/SCNB website but for most accurate results check them on the [iRail API page](https://api.irail.be/stations/) which this integration uses internally. {% configuration %} station_from: diff --git a/source/_components/no_ip.markdown b/source/_components/no_ip.markdown index c5b87a62c44..223f6f72bf0 100644 --- a/source/_components/no_ip.markdown +++ b/source/_components/no_ip.markdown @@ -13,11 +13,11 @@ ha_category: ha_release: 0.57 --- -With the `no_ip` component you can keep your current IP address in sync with your [NO-IP.com](https://www.noip.com) hostname or domain. +With the `no_ip` integration you can keep your current IP address in sync with your [NO-IP.com](https://www.noip.com) hostname or domain. Note that it does not confirm your hostname (as is required periodically for free domain names); you will still need to do that manually. -To use the component in your installation, add the following to your `configuration.yaml` file: +To use the integration in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/norway_air.markdown b/source/_components/norway_air.markdown index 068c9678a22..33c937cedb3 100644 --- a/source/_components/norway_air.markdown +++ b/source/_components/norway_air.markdown @@ -14,7 +14,7 @@ ha_iot_class: Cloud Polling ha_release: 0.88 --- -The `norway_air` component [queries](https://luftkvalitet.miljostatus.no/) the Norway air quality [data feed](https://api.met.no/weatherapi/airqualityforecast/0.1/documentation) provided by the Norwegian Meteorological Institute. +The `norway_air` integration [queries](https://luftkvalitet.miljostatus.no/) the Norway air quality [data feed](https://api.met.no/weatherapi/airqualityforecast/0.1/documentation) provided by the Norwegian Meteorological Institute. To add air quality sensor to your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/notify.knx.markdown b/source/_components/notify.knx.markdown index e0fc018b947..78877b65559 100644 --- a/source/_components/notify.knx.markdown +++ b/source/_components/notify.knx.markdown @@ -16,7 +16,7 @@ ha_iot_class: Local Push The `knx` notify platform allows you to send notifications to [KNX](http://www.knx.org) devices. -The `knx` component must be configured correctly, see [KNX Component](/components/knx). +The `knx` integration must be configured correctly, see [KNX Component](/components/knx). ## {% linkable_title Configuration %} diff --git a/source/_components/notify.markdown b/source/_components/notify.markdown index 87df0e81f63..e0677d806cd 100644 --- a/source/_components/notify.markdown +++ b/source/_components/notify.markdown @@ -14,7 +14,7 @@ ha_qa_scale: internal ha_release: 0.7 --- -The `notify` component makes it possible to send notifications to a wide variety of platforms. Please check the sidebar for a full list of platforms that are supported. +The `notify` integration makes it possible to send notifications to a wide variety of platforms. Please check the sidebar for a full list of platforms that are supported. If you want to send notifications to the Home Assistant Web Interface you may use the [Persistent Notification Component](/components/persistent_notification/). @@ -29,7 +29,7 @@ Once loaded, the `notify` platform will expose a service that can be called to s | `target` | yes | Some platforms will allow specifying a recipient that will receive the notification. See your platform page if it is supported. | `data` | yes | On platforms who have extended functionality. See your platform page if it is supported. -The notification component supports specifying [templates](/topics/templating/) with `data_template`. This will allow you to use the current state of Home Assistant in your notifications. +The notification integration supports specifying [templates](/topics/templating/) with `data_template`. This will allow you to use the current state of Home Assistant in your notifications. In an [action](/getting-started/automation-action/) of your [automation setup](/getting-started/automation/) it could look like this with a customized subject. diff --git a/source/_components/nuheat.markdown b/source/_components/nuheat.markdown index 9af3508e092..a6f6d25a215 100644 --- a/source/_components/nuheat.markdown +++ b/source/_components/nuheat.markdown @@ -16,7 +16,7 @@ redirect_from: - /components/climate.nuheat/ --- -The `nuheat` component lets control your connected [NuHeat Signature]([NuHeat Signature](http://www.nuheat.com/products/thermostats/signature-thermostat)) floor heating thermostats from [NuHeat](http://www.nuheat.com/). +The `nuheat` integration lets control your connected [NuHeat Signature]([NuHeat Signature](http://www.nuheat.com/products/thermostats/signature-thermostat)) floor heating thermostats from [NuHeat](http://www.nuheat.com/). There is currently support for the following device types within Home Assistant: diff --git a/source/_components/nuimo_controller.markdown b/source/_components/nuimo_controller.markdown index 89925b02407..968026dfdb6 100644 --- a/source/_components/nuimo_controller.markdown +++ b/source/_components/nuimo_controller.markdown @@ -14,7 +14,7 @@ ha_release: 0.29 ha_iot_class: Local Polling --- -The `nuimo_controller` component allows you to connect to a [Nuimo](http://www.senic.com/) device for receiving input events and displaying on the LED matrix via the [Nuimo SDK for Python on Linux](https://github.com/getSenic/nuimo-linux-python). +The `nuimo_controller` integration allows you to connect to a [Nuimo](http://www.senic.com/) device for receiving input events and displaying on the LED matrix via the [Nuimo SDK for Python on Linux](https://github.com/getSenic/nuimo-linux-python). To connect to a Nuimo device add the following section to your `configuration.yaml` file: diff --git a/source/_components/octoprint.markdown b/source/_components/octoprint.markdown index 5d5f4f7dc63..e08c2fe09f2 100644 --- a/source/_components/octoprint.markdown +++ b/source/_components/octoprint.markdown @@ -19,7 +19,7 @@ redirect_from: - /components/sensor.octoprint/ --- -[OctoPrint](http://octoprint.org/) is a web interface for your 3D printer. This is the main component to integrate OctoPrint sensors. +[OctoPrint](http://octoprint.org/) is a web interface for your 3D printer. This is the main integration to integrate OctoPrint sensors. There is currently support for the following device types within Home Assistant: diff --git a/source/_components/onboarding.markdown b/source/_components/onboarding.markdown index 56236903277..4214d6def9c 100644 --- a/source/_components/onboarding.markdown +++ b/source/_components/onboarding.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Onboarding" -description: "This component is responsible for providing the onboarding endpoints." +description: "This integration is responsible for providing the onboarding endpoints." date: 2018-03-19 21:04 sidebar: true comments: false @@ -14,4 +14,4 @@ ha_release: 0.73 ha_qa_scale: internal --- -This component creates the endpoints for the onboarding that is built into Home Assistant. There are no configuration options for this component directly. +This integration creates the endpoints for the onboarding that is built into Home Assistant. There are no configuration options for this integration directly. diff --git a/source/_components/onkyo.markdown b/source/_components/onkyo.markdown index 948ecf0797f..3f0d8dfe462 100644 --- a/source/_components/onkyo.markdown +++ b/source/_components/onkyo.markdown @@ -17,7 +17,7 @@ redirect_from: --- -The `onkyo` platform allows you to control a [Onkyo](http://www.onkyo.com/) and some recent [Pioneer](http://www.pioneerelectronics.com) receivers from Home Assistant. Please be aware that you need to enable "Network Standby" for this component to work in your Hardware. +The `onkyo` platform allows you to control a [Onkyo](http://www.onkyo.com/) and some recent [Pioneer](http://www.pioneerelectronics.com) receivers from Home Assistant. Please be aware that you need to enable "Network Standby" for this integration to work in your Hardware. ## {% linkable_title Configuration %} diff --git a/source/_components/opentherm_gw.markdown b/source/_components/opentherm_gw.markdown index 2cb03e5984e..c478bca543d 100644 --- a/source/_components/opentherm_gw.markdown +++ b/source/_components/opentherm_gw.markdown @@ -21,7 +21,7 @@ redirect_from: - /components/sensor.opentherm_gw/ --- -The `opentherm_gw` component is used to control the [OpenTherm Gateway](http://otgw.tclcode.com/) from Home Assistant. +The `opentherm_gw` integration is used to control the [OpenTherm Gateway](http://otgw.tclcode.com/) from Home Assistant. There is currently support for the following device types within Home Assistant: @@ -29,7 +29,7 @@ There is currently support for the following device types within Home Assistant: - Climate - Sensor -When enabled, this component will automatically add its [`climate` entity](/components/climate.opentherm_gw) to Home Assistant. +When enabled, this integration will automatically add its [`climate` entity](/components/climate.opentherm_gw) to Home Assistant.

The OpenTherm protocol is based on polling. The thermostat sends requests to the boiler at specific intervals. As a result, it may take some time for changes to propagate between Home Assistant and the thermostat. @@ -273,7 +273,7 @@ monitored_variables: ## {% linkable_title Supported Variables %} -The list above contains all supported variables. Note that not all boilers and thermostats properly support all variables, so the fact that a variable is listed here and published by your system does not necessarily mean that you will get useful data out of it. To see which variables are published in your situation, enable debug logging for the `opentherm_gw` component and look for the status updates. +The list above contains all supported variables. Note that not all boilers and thermostats properly support all variables, so the fact that a variable is listed here and published by your system does not necessarily mean that you will get useful data out of it. To see which variables are published in your situation, enable debug logging for the `opentherm_gw` integration and look for the status updates. # {% linkable_title Services %} diff --git a/source/_components/openuv.markdown b/source/_components/openuv.markdown index bccc8d3c049..472c1d06525 100644 --- a/source/_components/openuv.markdown +++ b/source/_components/openuv.markdown @@ -20,7 +20,7 @@ redirect_from: - /components/sensor.openuv/ --- -The `openuv` component displays UV and Ozone data from [openuv.io](http://openuv.io). +The `openuv` integration displays UV and Ozone data from [openuv.io](http://openuv.io). ## {% linkable_title Generating an API Key %} @@ -39,11 +39,11 @@ loads. To request new data, the `update_data` service may be used. Each use of the `update_data` service will consume 1 or 2 API calls, depending on which monitored conditions are configured. -If the OpenUV component is configured through the Home Assistant UI (via the +If the OpenUV integration is configured through the Home Assistant UI (via the `Configuration >> Integrations` panel), each service call will consume 2 API calls from the daily quota. -If the OpenUV component is configured via `configuration.yaml`, service calls +If the OpenUV integration is configured via `configuration.yaml`, service calls will consume 2 API calls if `monitored_conditions` contains both `uv_protection_window` and any other condition; any other scenarios will only consume 1 API call. diff --git a/source/_components/openwrt.markdown b/source/_components/openwrt.markdown index f9cf6785c48..4ac10e29a27 100644 --- a/source/_components/openwrt.markdown +++ b/source/_components/openwrt.markdown @@ -48,4 +48,4 @@ device_tracker: To get the best of both worlds, you can combine the two approaches, running both a periodic device scanner and an event-based device tracker. -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. diff --git a/source/_components/orangepi_gpio.markdown b/source/_components/orangepi_gpio.markdown index 1cdb9709981..168e16ff756 100644 --- a/source/_components/orangepi_gpio.markdown +++ b/source/_components/orangepi_gpio.markdown @@ -14,7 +14,7 @@ ha_release: 0.93 ha_iot_class: Local Push --- -The `orangepi_gpio` component is the base for all related GPIO platforms in Home Assistant. There is no setup needed for the component itself, for the platforms please check their corresponding pages. +The `orangepi_gpio` integration is the base for all related GPIO platforms in Home Assistant. There is no setup needed for the integration itself, for the platforms please check their corresponding pages. ## {% linkable_title Binary Sensor %} @@ -55,7 +55,7 @@ invert_logic: default: "`false` (ACTIVE HIGH)" {% endconfiguration %} -Compared to the [Raspberry Pi GPIO](/components/rpi_gpio/) component, this component does not support pull-up resistors or port debouncing. Use external pull-ups and external port-debouncing. +Compared to the [Raspberry Pi GPIO](/components/rpi_gpio/) component, this integration does not support pull-up resistors or port debouncing. Use external pull-ups and external port-debouncing. ## {% linkable_title Pin_mode %} @@ -70,7 +70,7 @@ As this platform supports different types of GPIO pinouts for difference Orange | `neocore2` | Supports the NanoPi Neocore 2 | ## {% linkable_title Additional steps %} -This component uses the `SYSFS` filesystem to get control of the GPIOs. Therefore an operatings system with `CONFIG_GPIO_SYSFS` is required. As far as I know, most out-of-the-box distributions still enable this by default. +This integration uses the `SYSFS` filesystem to get control of the GPIOs. Therefore an operatings system with `CONFIG_GPIO_SYSFS` is required. As far as I know, most out-of-the-box distributions still enable this by default. As of Linux 4.8 sysfs-gpio is marked as obsolete. However as of today, the alternative GPIO character device is not widely used. Therefore we will use this until the new character device is more widely supported. diff --git a/source/_components/owlet.markdown b/source/_components/owlet.markdown index 4b4b3954cf0..94ae8376a92 100644 --- a/source/_components/owlet.markdown +++ b/source/_components/owlet.markdown @@ -18,9 +18,9 @@ ha_iot_class: Cloud Polling [Owlet Care](https://owletcare.com/) baby monitors check your baby's oxygen level and heart rate while sleeping. -Configuring this component will enable tracking of heart rate, oxygen level, motion and base station connection status. Battery status is available as an attribute on oxygen and heart rate sensors. +Configuring this integration will enable tracking of heart rate, oxygen level, motion and base station connection status. Battery status is available as an attribute on oxygen and heart rate sensors. -This component enables the following platforms automatically: +This integration enables the following platforms automatically: #### {% linkable_title Binary Sensors %} @@ -57,5 +57,5 @@ name: {% endconfiguration %}

-The intended purpose of this component is to enable data logging and automations such as battery status updates and charging reminders. This component should not replace the Owlet app nor should it be used for life-critical notifications. +The intended purpose of this integration is to enable data logging and automations such as battery status updates and charging reminders. This integration should not replace the Owlet app nor should it be used for life-critical notifications.

diff --git a/source/_components/panel_custom.markdown b/source/_components/panel_custom.markdown index 89eb17fc89e..a69d84452a7 100644 --- a/source/_components/panel_custom.markdown +++ b/source/_components/panel_custom.markdown @@ -36,7 +36,7 @@ Store your custom panels in `/www` to make them available in the fronten {% configuration %} name: - description: Name of the web component that renders your panel. + description: Name of the web integration that renders your panel. required: true type: string sidebar_title: diff --git a/source/_components/persistent_notification.markdown b/source/_components/persistent_notification.markdown index eb8985c99e8..e13a48dbe6a 100644 --- a/source/_components/persistent_notification.markdown +++ b/source/_components/persistent_notification.markdown @@ -30,7 +30,7 @@ The service `persistent_notification/create` takes in `message`, `title`, and `n | `title` | yes | Title of the notification. | `notification_id` | yes | If `notification_id` is given, it will overwrite the notification if there already was a notification with that ID. -The `persistent_notification` component supports specifying [templates](/topics/templating/) for both the `message` and the `title`. This will allow you to use the current state of Home Assistant in your notifications. +The `persistent_notification` integration supports specifying [templates](/topics/templating/) for both the `message` and the `title`. This will allow you to use the current state of Home Assistant in your notifications. In an [action](/getting-started/automation-action/) of your [automation setup](/getting-started/automation/) it could look like this with a customized subject. diff --git a/source/_components/person.markdown b/source/_components/person.markdown index 332936306c8..6b0ca02a1f8 100644 --- a/source/_components/person.markdown +++ b/source/_components/person.markdown @@ -14,7 +14,7 @@ ha_qa_scale: internal ha_release: 0.88 --- -The person component allows connecting [device tracker](https://www.home-assistant.io/components/device_tracker/) entities to one or more person entities. The state updates of a connected device tracker will set the state of the person. When multiple device trackers are used, the state of person will be determined in this order: +The person integration allows connecting [device tracker](https://www.home-assistant.io/components/device_tracker/) entities to one or more person entities. The state updates of a connected device tracker will set the state of the person. When multiple device trackers are used, the state of person will be determined in this order: 1. If there are stationary trackers (non-GPS trackers, i.e., a router or Bluetooth 'device_trackers') presenting the status 'home', the tracker most recently updated will be used. 2. If there are trackers of type 'gps', then the most recently updated tracker will be used. @@ -36,15 +36,15 @@ TL;DR: When you're at home, your position is determined first by stationary trac You can manage persons via the UI from the person page inside the configuration panel or via `YAML` in your `configuration.yaml` file. -## {% linkable_title Configuring the `person` component via the Home Assistant configuration panel %} +## {% linkable_title Configuring the `person` integration via the Home Assistant configuration panel %} -If you prefer to use the configuration panel to configure the `person` component simply add one line to your `configuration.yaml` file and restart Home Assistant. +If you prefer to use the configuration panel to configure the `person` integration simply add one line to your `configuration.yaml` file and restart Home Assistant. ```yaml person: ``` -## {% linkable_title Configuring the `person` component via YAML %} +## {% linkable_title Configuring the `person` integration via YAML %} If you prefer YAML, you can also configure your persons via `configuration.yaml`: diff --git a/source/_components/pilight.markdown b/source/_components/pilight.markdown index 8dfe42157b5..4e1df44ff2f 100644 --- a/source/_components/pilight.markdown +++ b/source/_components/pilight.markdown @@ -25,7 +25,7 @@ redirect_from: This pilight hub connects to the [pilight-daemon](https://manual.pilight.org/programs/daemon.html) via a socket connection to receive and send codes. Thus Home Assistant does not have to run on the computer in charge of the RF communication. -The received and supported RF codes are put on the event bus of Home Assistant and are therefore directly usable by other components (e.g., automation). Additionally a send service is provided to send RF codes. +The received and supported RF codes are put on the event bus of Home Assistant and are therefore directly usable by other integrations (e.g., automation). Additionally a send service is provided to send RF codes. There is currently support for the following device types within Home Assistant: @@ -111,11 +111,11 @@ name: required: false type: string payload_on: - description: "Variable `on` value. The component will recognize this as logical '1'." + description: "Variable `on` value. The integration will recognize this as logical '1'." required: false type: [string, float, integer] payload_off: - description: "Variable `off` value. The component will recognize this as logical '0'." + description: "Variable `off` value. The integration will recognize this as logical '0'." required: false type: [string, float, integer] disarm_after_trigger: diff --git a/source/_components/ping.markdown b/source/_components/ping.markdown index e99c62b91c9..b74dbe40d37 100644 --- a/source/_components/ping.markdown +++ b/source/_components/ping.markdown @@ -61,7 +61,7 @@ The sensor exposes the different round trip times values measured by `ping` as a - `round trip time min` - `round trip time max` -The default polling interval is 5 minutes. As many components [based on the entity class](/docs/configuration/platform_options), it is possible to overwrite this scan interval by specifying a `scan_interval` configuration key (value in seconds). In the example below we setup the `ping` binary sensor to poll the devices every 30 seconds. +The default polling interval is 5 minutes. As many integrations [based on the entity class](/docs/configuration/platform_options), it is possible to overwrite this scan interval by specifying a `scan_interval` configuration key (value in seconds). In the example below we setup the `ping` binary sensor to poll the devices every 30 seconds. ```yaml # Example configuration.yaml entry to ping host 192.168.0.1 with 2 packets every 30 seconds. @@ -107,4 +107,4 @@ count: type: integer {% endconfiguration %} -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. diff --git a/source/_components/plaato.markdown b/source/_components/plaato.markdown index 5ae43cb5f8f..7fab3e8bd76 100644 --- a/source/_components/plaato.markdown +++ b/source/_components/plaato.markdown @@ -14,7 +14,7 @@ ha_category: ha_iot_class: Cloud Push --- -This component sets up integration with [Plaato Airlock](https://www.plaato.io/). +This integration sets up integration with [Plaato Airlock](https://www.plaato.io/). Plaato Airlock is a tool for beer brewers that wants a unique insight into the fermentation process. With this integration, you get all your fermentation data available in Home Assistant! diff --git a/source/_components/plant.markdown b/source/_components/plant.markdown index 7ba67c60fff..488aa2be4a5 100644 --- a/source/_components/plant.markdown +++ b/source/_components/plant.markdown @@ -35,7 +35,7 @@ plant: {% configuration %} entity_id: - description: Set by you and is used by the component as the `entity_id`. + description: Set by you and is used by the integration as the `entity_id`. required: true type: list keys: diff --git a/source/_components/plex.markdown b/source/_components/plex.markdown index be6245d2861..2533f91807b 100644 --- a/source/_components/plex.markdown +++ b/source/_components/plex.markdown @@ -87,7 +87,7 @@ verify: ### {% linkable_title Customization %} -You can customize the Plex component by adding any of the variables below to your configuration: +You can customize the Plex integration by adding any of the variables below to your configuration: ```yaml # Example configuration.yaml entry diff --git a/source/_components/postnl.markdown b/source/_components/postnl.markdown index d38f4e3d181..e39a79ae390 100644 --- a/source/_components/postnl.markdown +++ b/source/_components/postnl.markdown @@ -48,5 +48,5 @@ password: {% endconfiguration %}

-This component is not affiliated with PostNL and retrieves data from the endpoints of the mobile application. Use at your own risk. +This integration is not affiliated with PostNL and retrieves data from the endpoints of the mobile application. Use at your own risk.

diff --git a/source/_components/prometheus.markdown b/source/_components/prometheus.markdown index 1d31b5affa2..c428cefee07 100644 --- a/source/_components/prometheus.markdown +++ b/source/_components/prometheus.markdown @@ -13,9 +13,9 @@ ha_category: ha_release: 0.49 --- -The `prometheus` component exposes metrics in a format which [Prometheus](https://prometheus.io/) can read. +The `prometheus` integration exposes metrics in a format which [Prometheus](https://prometheus.io/) can read. -To use the `prometheus` component in your installation, add the following to your `configuration.yaml` file: +To use the `prometheus` integration in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -28,7 +28,7 @@ namespace: required: false type: string filter: - description: Filtering directives for the components which should be included or excluded from recording. + description: Filtering directives for the integrations which should be included or excluded from recording. required: false type: list keys: diff --git a/source/_components/proximity.markdown b/source/_components/proximity.markdown index 1c708cdac4a..f38e402fa86 100644 --- a/source/_components/proximity.markdown +++ b/source/_components/proximity.markdown @@ -14,9 +14,9 @@ ha_release: 0.13 ha_qa_scale: internal --- -The `proximity` component allows you to monitor the proximity of devices to a particular [zone](/components/zone/) and the direction of travel. The result is an entity created in Home Assistant which maintains the proximity data. +The `proximity` integration allows you to monitor the proximity of devices to a particular [zone](/components/zone/) and the direction of travel. The result is an entity created in Home Assistant which maintains the proximity data. -This component is useful to reduce the number of automation rules required when wanting to perform automations based on locations outside a particular zone. The [zone](/getting-started/automation-trigger/#zone-trigger) and [state](/getting-started/automation-trigger/#state-trigger) based triggers allow similar control but the number of rules grows exponentially when factors such as direction of travel need to be taken into account. +This integration is useful to reduce the number of automation rules required when wanting to perform automations based on locations outside a particular zone. The [zone](/getting-started/automation-trigger/#zone-trigger) and [state](/getting-started/automation-trigger/#state-trigger) based triggers allow similar control but the number of rules grows exponentially when factors such as direction of travel need to be taken into account. Some examples of its use include: @@ -40,7 +40,7 @@ The Proximity entity which is created has the following values: - 'mi' - 'ft' -To enable this component in your installation, add the following to your `configuration.yaml` file: +To enable this integration in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -56,7 +56,7 @@ proximity: {% configuration %} zone: - description: The zone to which this component is measuring the distance to. Default is the home zone. + description: The zone to which this integration is measuring the distance to. Default is the home zone. required: false type: map keys: diff --git a/source/_components/ps4.markdown b/source/_components/ps4.markdown index 24a360a73c8..764a1aff2a6 100644 --- a/source/_components/ps4.markdown +++ b/source/_components/ps4.markdown @@ -14,10 +14,10 @@ ha_release: 0.89 ha_iot_class: Local Polling --- -The `ps4` component allows you to control a +The `ps4` integration allows you to control a [Sony PlayStation 4 console](https://www.playstation.com/en-us/explore/ps4/). -- This component supports controlling a single PlayStation 4 for your instance. Additional consoles may be supported in a future release. +- This integration supports controlling a single PlayStation 4 for your instance. Additional consoles may be supported in a future release. ## {% linkable_title Requirements %} @@ -41,7 +41,7 @@ The `ps4` component allows you to control a ## {% linkable_title Granting Port Access %} -The PlayStation 4 component requires the use of privileged ports to work correctly, specifically UDP port 987 and TCP port 997. Depending on your OS of your Home Assistant instance you may need to allow usage of privileged ports manually. +The PlayStation 4 integration requires the use of privileged ports to work correctly, specifically UDP port 987 and TCP port 997. Depending on your OS of your Home Assistant instance you may need to allow usage of privileged ports manually.

Do not run your Home Assistant instance itself as root or with root/sudo privileges to accomplish this. This would create a security risk for your host system. @@ -77,7 +77,7 @@ sudo setcap 'cap_net_bind_service=+ep' /usr/bin/python3.5 To find your system Python path: -- Add the [System Health](https://www.home-assistant.io/components/system_health/) component to your `configuration.yaml`. In a web browser access your frontend and navigate to the about/logs page "http:///dev-info). In the System Health box locate the item **python_version** and note the value that is displayed. Then in terminal run: +- Add the [System Health](https://www.home-assistant.io/components/system_health/) integration to your `configuration.yaml`. In a web browser access your frontend and navigate to the about/logs page "http:///dev-info). In the System Health box locate the item **python_version** and note the value that is displayed. Then in terminal run: ```bash whereis python @@ -111,12 +111,12 @@ When running Home Assistant using Docker, make sure that the Home Assistant cont ## {% linkable_title Configuration %}

- The PlayStation 4 component does not use entries from `configuration.yaml`. You must configure this component by using `Integrations` + The PlayStation 4 integration does not use entries from `configuration.yaml`. You must configure this integration by using `Integrations`

## {% linkable_title Regions %} -Some titles will have different SKUs in the PlayStation Store database depending on your region. You must select your specific region in the setup in order to retrieve the cover art for such titles correctly. The component will attempt to search other databases for the correct title if it cannot be found, although it will take longer to do so and may fetch an incorrect cover. +Some titles will have different SKUs in the PlayStation Store database depending on your region. You must select your specific region in the setup in order to retrieve the cover art for such titles correctly. The integration will attempt to search other databases for the correct title if it cannot be found, although it will take longer to do so and may fetch an incorrect cover. | Available Regions | Unavailable Regions | | --------------------------------------------------------------------------- | -------------------------- | diff --git a/source/_components/ptvsd.markdown b/source/_components/ptvsd.markdown index ba7c77531ff..b80b5f693e7 100644 --- a/source/_components/ptvsd.markdown +++ b/source/_components/ptvsd.markdown @@ -13,11 +13,11 @@ ha_category: ha_release: 0.93 --- -The `ptvsd` component allows you to use the Visual Studio Code PTVSD debugger with Home Assistant. +The `ptvsd` integration allows you to use the Visual Studio Code PTVSD debugger with Home Assistant. This is useful in testing changes on a local development install, or connecting to a production server to debug issues. -To enable the `ptvsd` component add the following to your `configuration.yaml` file: +To enable the `ptvsd` integration add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -58,7 +58,7 @@ There have been reports of continually increasing memory use while the debugger ### {% linkable_title Waiting at startup %} -If you want to debug something in the boot-up sequence, configure the component to wait for a connection first: +If you want to debug something in the boot-up sequence, configure the integration to wait for a connection first: ```yaml # Example configuration.yaml entry diff --git a/source/_components/pulseaudio_loopback.markdown b/source/_components/pulseaudio_loopback.markdown index 5d60c9f99e7..08e2768ba13 100644 --- a/source/_components/pulseaudio_loopback.markdown +++ b/source/_components/pulseaudio_loopback.markdown @@ -22,7 +22,7 @@ For example, for a system with a 7.1 surround sound card, and 3 instances of [MP The benefit of this approach is that this audio routing can occur without modifying the design-time configuration of MPD or PulseAudio. -This component uses a TCP connection to control a local or remote PulseAudio server. So there are no local dependencies. +This integration uses a TCP connection to control a local or remote PulseAudio server. So there are no local dependencies. To enable this switch, add the following lines to your `configuration.yaml` file: @@ -69,5 +69,5 @@ tcp_timeout: {% endconfiguration %}

-This component relies on raw TCP commands to PulseAudio. In order for PulseAudio to accept commands with this component, `module-cli-protocol` must be loaded on the PulseAudio server. +This integration relies on raw TCP commands to PulseAudio. In order for PulseAudio to accept commands with this component, `module-cli-protocol` must be loaded on the PulseAudio server.

diff --git a/source/_components/pushover.markdown b/source/_components/pushover.markdown index 0371d118917..a25e7a4f2b6 100644 --- a/source/_components/pushover.markdown +++ b/source/_components/pushover.markdown @@ -15,7 +15,7 @@ redirect_from: - /components/notify.pushover/ --- -The [Pushover service](https://pushover.net/) is a platform for the notify component. This allows components to send messages to the user using Pushover. +The [Pushover service](https://pushover.net/) is a platform for the notify component. This allows integrations to send messages to the user using Pushover. ## {% linkable_title Configuration %} @@ -67,7 +67,7 @@ To use notifications, please see the [getting started with automation page](/get When sending a notification, optional parameters can also be set as per the pushover [API documentation](https://pushover.net/api). -Example notification triggered from the Alexa component for an intents is shown below which also uses [Automation Templating](/getting-started/automation-templating/) for the message: +Example notification triggered from the Alexa integration for an intents is shown below which also uses [Automation Templating](/getting-started/automation-templating/) for the message: {% raw %} diff --git a/source/_components/python_script.markdown b/source/_components/python_script.markdown index 574a426b159..d60955d5a20 100644 --- a/source/_components/python_script.markdown +++ b/source/_components/python_script.markdown @@ -14,7 +14,7 @@ ha_release: 0.47 ha_qa_scale: internal --- -This component allows you to write Python scripts that are exposed as services in Home Assistant. Each Python file created in the `/python_scripts/` folder will be exposed as a service. The content is not cached so you can easily develop: edit file, save changes, call service. The scripts are run in a sandboxed environment. The following variables are available in the sandbox: +This integration allows you to write Python scripts that are exposed as services in Home Assistant. Each Python file created in the `/python_scripts/` folder will be exposed as a service. The content is not cached so you can easily develop: edit file, save changes, call service. The scripts are run in a sandboxed environment. The following variables are available in the sandbox: | Name | Description | | ---- | ----------- | diff --git a/source/_components/qnap.markdown b/source/_components/qnap.markdown index bfdc37cfb56..95c6472996c 100644 --- a/source/_components/qnap.markdown +++ b/source/_components/qnap.markdown @@ -128,7 +128,7 @@ If your QNAP device uses self-signed certificates, set the `verify_ssl` option t ### {% linkable_title QNAP device support: %} -This component has been tested on the following devices: +This integration has been tested on the following devices: - TS-259 Pro+ (QTS 4.2.6) - TS-410 (QTS 4.2.3) diff --git a/source/_components/quantum_gateway.markdown b/source/_components/quantum_gateway.markdown index 2747c206742..8d2ec7e7396 100644 --- a/source/_components/quantum_gateway.markdown +++ b/source/_components/quantum_gateway.markdown @@ -48,4 +48,4 @@ ssl: default: True {% endconfiguration %} -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. diff --git a/source/_components/qwikswitch.markdown b/source/_components/qwikswitch.markdown index 2f330d4693b..9b87c0a5209 100644 --- a/source/_components/qwikswitch.markdown +++ b/source/_components/qwikswitch.markdown @@ -22,7 +22,7 @@ redirect_from: - /components/switch.qwikswitch/ --- -The `qwikswitch` component is the main component to integrate various [QwikSwitch](http://www.qwikswitch.co.za/) devices with Home Assistant. The integration requires the QSUSB Modem device and connects to the QS Mobile application. +The `qwikswitch` integration is the main integration to integrate various [QwikSwitch](http://www.qwikswitch.co.za/) devices with Home Assistant. The integration requires the QSUSB Modem device and connects to the QS Mobile application. There is currently support for the following device types within Home Assistant: @@ -31,7 +31,7 @@ There is currently support for the following device types within Home Assistant: - Sensor - Switch -The `qwikswitch` component discovers all devices from QS Mobile. Currently, Relays and LED dimmers are discovered in Home Assistant. Relay devices are [lights](/components/light.qwikswitch/) by default, and can be configured as [switches](/components/switch.qwikswitch/). +The `qwikswitch` integration discovers all devices from QS Mobile. Currently, Relays and LED dimmers are discovered in Home Assistant. Relay devices are [lights](/components/light.qwikswitch/) by default, and can be configured as [switches](/components/switch.qwikswitch/). {% linkable_title Configuration %} diff --git a/source/_components/rachio.markdown b/source/_components/rachio.markdown index 637c2d37782..b62b336addc 100644 --- a/source/_components/rachio.markdown +++ b/source/_components/rachio.markdown @@ -26,7 +26,7 @@ There is currently support for the following device types within Home Assistant: - **Binary Sensor** - Allows you to view the status of your [Rachio irrigation system](http://rachio.com/). - [**Switch**](#switch) -They will be automatically added if the Rachio component component is loaded. +They will be automatically added if the Rachio integration integration is loaded. ## {% linkable_title Getting your Rachio API Key %} diff --git a/source/_components/rainbird.markdown b/source/_components/rainbird.markdown index 82211c4c199..18ddecf21c7 100644 --- a/source/_components/rainbird.markdown +++ b/source/_components/rainbird.markdown @@ -19,7 +19,7 @@ redirect_from: - /components/switch.rainbird/ --- -This `rainbird` component allows interacting with [LNK WiFi](http://www.rainbird.com/landscape/products/controllers/LNK-WiFi.htm) module of the Rain Bird Irrigation system in Home Assistant. +This `rainbird` integration allows interacting with [LNK WiFi](http://www.rainbird.com/landscape/products/controllers/LNK-WiFi.htm) module of the Rain Bird Irrigation system in Home Assistant. There is currently support for the following device types within Home Assistant: diff --git a/source/_components/raincloud.markdown b/source/_components/raincloud.markdown index d88af8d316c..9a1f49a24f2 100644 --- a/source/_components/raincloud.markdown +++ b/source/_components/raincloud.markdown @@ -21,7 +21,7 @@ redirect_from: - /components/switch.raincloud/ --- -The `raincloud` component allows you to integrate your [Melnor RainCloud](https://wifiaquatimer.com) sprinkler system in Home Assistant. +The `raincloud` integration allows you to integrate your [Melnor RainCloud](https://wifiaquatimer.com) sprinkler system in Home Assistant. There is currently support for the following device types within Home Assistant: diff --git a/source/_components/rainmachine.markdown b/source/_components/rainmachine.markdown index 132313647ce..dcfc0bf45c5 100644 --- a/source/_components/rainmachine.markdown +++ b/source/_components/rainmachine.markdown @@ -21,7 +21,7 @@ redirect_from: - /components/switch.rainmachine/ --- -The `rainmachine` component is the main component to integrate all platforms related to [RainMachine smart Wi-Fi sprinkler controllers](http://www.rainmachine.com/). +The `rainmachine` integration is the main integration to integrate all platforms related to [RainMachine smart Wi-Fi sprinkler controllers](http://www.rainmachine.com/). There is currently support for the following device types within Home Assistant: diff --git a/source/_components/raspihats.markdown b/source/_components/raspihats.markdown index bf229a3eb14..df5b21c7e2b 100644 --- a/source/_components/raspihats.markdown +++ b/source/_components/raspihats.markdown @@ -19,7 +19,7 @@ redirect_from: - /components/switch.raspihats/ --- -The `raspihats` component is the base for all related Raspihats platforms in Home Assistant. There is no setup needed for the component itself. +The `raspihats` integration is the base for all related Raspihats platforms in Home Assistant. There is no setup needed for the integration itself. ## {% linkable_title Binary Sensor %} diff --git a/source/_components/raspyrfm.markdown b/source/_components/raspyrfm.markdown index 4c7c3180a9e..6aa2a81910f 100644 --- a/source/_components/raspyrfm.markdown +++ b/source/_components/raspyrfm.markdown @@ -16,11 +16,11 @@ redirect_from: - /components/switch.raspyrfm/ --- -The `raspyrfm` component adds support for cheap RC 433 MHz outlets via one of the supported gateways. +The `raspyrfm` integration adds support for cheap RC 433 MHz outlets via one of the supported gateways. -Initially, this component was created to support the Simple Solutions `ConnAir` gateway which has been discontinued. There are custom alternatives that reimplemented the protocol used by the ConnAir though like this [ConnAir emulator](https://github.com/Phunkafizer/RaspyRFM/blob/master/connair.py) which can be used in conjunction with the [RaspyRFM-II](https://www.seegel-systeme.de/produkt/raspyrfm-ii) RC module for a Raspberry Pi. +Initially, this integration was created to support the Simple Solutions `ConnAir` gateway which has been discontinued. There are custom alternatives that reimplemented the protocol used by the ConnAir though like this [ConnAir emulator](https://github.com/Phunkafizer/RaspyRFM/blob/master/connair.py) which can be used in conjunction with the [RaspyRFM-II](https://www.seegel-systeme.de/produkt/raspyrfm-ii) RC module for a Raspberry Pi. -Other vendors of 433 MHz RC outlets have also created gateways that use a very similar protocol and can also be used with this component like the Intertechno [ITGW-433 LAN Gateway](https://www.intertechno24.de/LAN-Gateway/Gateway-ITGW-433.html). +Other vendors of 433 MHz RC outlets have also created gateways that use a very similar protocol and can also be used with this integration like the Intertechno [ITGW-433 LAN Gateway](https://www.intertechno24.de/LAN-Gateway/Gateway-ITGW-433.html). ## {% linkable_title Configuration %} diff --git a/source/_components/recorder.markdown b/source/_components/recorder.markdown index 9c522e73cc5..609d9b721f8 100644 --- a/source/_components/recorder.markdown +++ b/source/_components/recorder.markdown @@ -14,13 +14,13 @@ ha_release: pre 0.7 ha_qa_scale: internal --- -The `recorder` component is responsible for storing details in a database, which then are handled by the [`history` component](/components/history/). +The `recorder` integration is responsible for storing details in a database, which then are handled by the [`history` component](/components/history/). Home Assistant uses [SQLAlchemy](http://www.sqlalchemy.org/), which is an Object Relational Mapper (ORM). This means that you can use **any** SQL backend for the recorder that is supported by SQLAlchemy, like [MySQL](https://www.mysql.com/), [MariaDB](https://mariadb.org/), [PostgreSQL](https://www.postgresql.org/), or [MS SQL Server](https://www.microsoft.com/en-us/sql-server/). The default database engine is [SQLite](https://www.sqlite.org/) which doesn't require any configuration. The database is stored in your Home Assistant configuration directory (`.homeassistant`) and called `home-assistant_v2.db`. -To change the defaults for the `recorder` component in your installation, add the following to your `configuration.yaml` file: +To change the defaults for the `recorder` integration in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -48,7 +48,7 @@ recorder: default: 1 type: integer exclude: - description: Configure which components should be excluded from recordings. + description: Configure which integrations should be excluded from recordings. required: false type: map keys: @@ -61,7 +61,7 @@ recorder: required: false type: List include: - description: Configure which components should be included in recordings. If set, all other entities will not be recorded. + description: Configure which integrations should be included in recordings. If set, all other entities will not be recorded. required: false type: map keys: @@ -129,7 +129,7 @@ Call the service `recorder.purge` to start a purge task which deletes events and | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | -| `keep_days` | yes | The number of history days to keep in recorder database (defaults to the component `purge_keep_days` configuration) +| `keep_days` | yes | The number of history days to keep in recorder database (defaults to the integration `purge_keep_days` configuration) | `repack` | yes | Rewrite the entire database, possibly saving some disk space. Only supported for SQLite and requires at least as much disk space free as the database currently uses. ## {% linkable_title Custom database engines %} diff --git a/source/_components/remember_the_milk.markdown b/source/_components/remember_the_milk.markdown index 890c7fed736..49eaafd508e 100644 --- a/source/_components/remember_the_milk.markdown +++ b/source/_components/remember_the_milk.markdown @@ -13,7 +13,7 @@ ha_category: ha_release: 0.57 --- -The `Remember The Milk` (RTM) component allows you to create tasks in [remember_the_milk](https://www.rememberthemilk.com) from Home Assistant. You can use this if you want Home Assistant to send you a task that you should not forget, e.g., water the plants. The component allows you to have several RTM accounts in parallel. +The `Remember The Milk` (RTM) integration allows you to create tasks in [remember_the_milk](https://www.rememberthemilk.com) from Home Assistant. You can use this if you want Home Assistant to send you a task that you should not forget, e.g., water the plants. The integration allows you to have several RTM accounts in parallel. ## {% linkable_title Setup %} @@ -60,7 +60,7 @@ In the background Home Assistant downloaded a "token" from the Remember The Milk ## {% linkable_title Creating/updating tasks with service ```create_task```%} -This component offers a new service domain ```remember_the_milk``` with the services ```_create_task```. You can call this service with the argument ```name``` and the optional parameter ```id``` to create a new task in your Remember The Milk account. You can call this service from your usual automations. +This integration offers a new service domain ```remember_the_milk``` with the services ```_create_task```. You can call this service with the argument ```name``` and the optional parameter ```id``` to create a new task in your Remember The Milk account. You can call this service from your usual automations. If you set an ```id``` and a task with that id exists already, the existing task is updated, rather than creating a new task. This way you can change the name of the task. If you do not set an ```id```, a new task is created with every call. If you're using this from an automation, you could use the name of your automation as id or the entity that triggered the task to be created. This way you can later on update or complete this task. diff --git a/source/_components/remote_rpi_gpio.markdown b/source/_components/remote_rpi_gpio.markdown index 8ae40a89946..f5ef991b05f 100644 --- a/source/_components/remote_rpi_gpio.markdown +++ b/source/_components/remote_rpi_gpio.markdown @@ -16,7 +16,7 @@ ha_release: 0.94 ha_iot_class: Local Push --- -The `rpi_gpio` component is the base for all related GPIO platforms in Home Assistant. There is no setup needed for the component itself, for the platforms please check their corresponding sections. +The `rpi_gpio` integration is the base for all related GPIO platforms in Home Assistant. There is no setup needed for the integration itself, for the platforms please check their corresponding sections. ## {% linkable_title Binary Sensor %} diff --git a/source/_components/repetier.markdown b/source/_components/repetier.markdown index 15654ed411a..03fb8adb5e8 100644 --- a/source/_components/repetier.markdown +++ b/source/_components/repetier.markdown @@ -17,7 +17,7 @@ ha_iot_class: Local Polling --- [Repetier-Server](https://www.repetier-server.com/) is a 3D printer/CNC server, able to control multiple devices on the same server. -This component handles the main integration to the server. +This integration handles the main integration to the server. There is currently support for the following device types within Home Assistant: diff --git a/source/_components/rest.markdown b/source/_components/rest.markdown index 5536b035395..41d033c6549 100644 --- a/source/_components/rest.markdown +++ b/source/_components/rest.markdown @@ -207,7 +207,7 @@ my_sensor_secret_token: Bearer gh_DHQIXKVf6Pr4H8Yqz8uhApk_mnV6Zje6Pr4H8Yqz8A8nCx ### {% linkable_title Use GitHub to get the latest release of Home Assistant %} -This sample is very similar to the [`updater`](/components/updater/) component but the information is received from GitHub. +This sample is very similar to the [`updater`](/components/updater/) integration but the information is received from GitHub. ```yaml sensor: diff --git a/source/_components/rest_command.markdown b/source/_components/rest_command.markdown index bde8f82b077..2a77a169171 100644 --- a/source/_components/rest_command.markdown +++ b/source/_components/rest_command.markdown @@ -14,7 +14,7 @@ ha_release: 0.36 ha_iot_class: Local Push --- -This component can expose regular REST commands as services. Services can be called from a [script] or in [automation]. +This integration can expose regular REST commands as services. Services can be called from a [script] or in [automation]. [script]: /components/script/ [automation]: /getting-started/automation/ diff --git a/source/_components/rflink.markdown b/source/_components/rflink.markdown index 8ab36707493..9ff0b8a4f91 100644 --- a/source/_components/rflink.markdown +++ b/source/_components/rflink.markdown @@ -13,7 +13,7 @@ ha_category: ha_release: 0.38 --- -The `rflink` component supports devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example, the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink Gateway is an Arduino Mega firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver). +The `rflink` integration supports devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example, the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink Gateway is an Arduino Mega firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver). The 433 MHz spectrum is used by many manufacturers mostly using their own protocol/standard and includes devices like: light switches, blinds, weather stations, alarms and various other sensors. @@ -25,7 +25,7 @@ Note: Versions later than R44 add support for Ikea Ansluta, Philips Living Color A complete list of devices supported by RFLink can be found [here](http://www.rflink.nl/blog2/devlist). -This component is tested with the following hardware/software: +This integration is tested with the following hardware/software: - Nodo RFLink Gateway V1.4/RFLink R46 @@ -120,7 +120,7 @@ sensor: [RFLink Switches](/components/switch.rflink/) and [RFLink Binary Sensors](/components/binary_sensor.rflink/) cannot be added automatically. -The RFLink component does not know the difference between a binary sensor, a switch and a light. Therefore all switchable devices are automatically added as light by default. However, once the ID of a switch is known, it can be used to configure it as a switch or a binary sensor type in Home Assistant, for example, to add it to a different group, hide it or configure a nice name. +The RFLink integration does not know the difference between a binary sensor, a switch and a light. Therefore all switchable devices are automatically added as light by default. However, once the ID of a switch is known, it can be used to configure it as a switch or a binary sensor type in Home Assistant, for example, to add it to a different group, hide it or configure a nice name. ### {% linkable_title Ignoring devices %} @@ -147,7 +147,7 @@ Wildcards only work at the end of the ID, not in the middle or front! ### {% linkable_title Device support %} -Even though a lot of devices are supported by RFLink, not all have been tested/implemented. If you have a device supported by RFLink but not by this component please consider testing and adding support yourself. +Even though a lot of devices are supported by RFLink, not all have been tested/implemented. If you have a device supported by RFLink but not by this integration please consider testing and adding support yourself. ### {% linkable_title Device Incorrectly Identified %} @@ -156,7 +156,7 @@ If you find a device is recognized differently, with different protocols or the ### {% linkable_title Technical Overview %} - The`rflink` Python module is an asyncio transport/protocol which is setup to fire a callback for every (valid/supported) packet received by the RFLink gateway. -- This component uses this callback to distribute 'rflink packet events' over [Home Assistant's event bus](/docs/configuration/events/) which can be subscribed to by entities/platform implementations. +- This integration uses this callback to distribute 'rflink packet events' over [Home Assistant's event bus](/docs/configuration/events/) which can be subscribed to by entities/platform implementations. - The platform implementation takes care of creating new devices (if enabled) for unseen incoming packet ID's. - Device entities take care of matching to the packet ID, interpreting and performing actions based on the packet contents. Common entity logic is maintained in this main component. diff --git a/source/_components/rfxtrx.markdown b/source/_components/rfxtrx.markdown index 2c933f81c1e..5cfcfc7e142 100644 --- a/source/_components/rfxtrx.markdown +++ b/source/_components/rfxtrx.markdown @@ -13,7 +13,7 @@ ha_category: ha_release: pre 0.7 --- -The `rfxtrx` component supports RFXtrx devices by [RFXCOM](http://www.rfxcom.com) which communicate in the frequency range of 433.92 MHz. +The `rfxtrx` integration supports RFXtrx devices by [RFXCOM](http://www.rfxcom.com) which communicate in the frequency range of 433.92 MHz. To enable RFXtrx in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/ring.markdown b/source/_components/ring.markdown index ef23e231d78..90b4bc2ffa5 100644 --- a/source/_components/ring.markdown +++ b/source/_components/ring.markdown @@ -109,7 +109,7 @@ Currently it supports doorbell and stickup cameras. ## {% linkable_title Saving the videos captured by your Ring Door Bell %} -You can save locally the latest video captured by your Ring Door Bell using the [downloader](/components/downloader) along with either an [automation](/components/automation) or [python_script](/components/python_script). First, enable the [downloader](/components/downloader) component in your configuration by adding the following to your `configuration.yaml`. +You can save locally the latest video captured by your Ring Door Bell using the [downloader](/components/downloader) along with either an [automation](/components/automation) or [python_script](/components/python_script). First, enable the [downloader](/components/downloader) integration in your configuration by adding the following to your `configuration.yaml`. ```yaml downloader: @@ -149,7 +149,7 @@ data = { 'filename': ring_cam.attributes.get('friendly_name') } -# call downloader component to save the video +# call downloader integration to save the video hass.services.call('downloader', 'download_file', data) ``` diff --git a/source/_components/ritassist.markdown b/source/_components/ritassist.markdown index 81cad07f613..33e4d7e11bc 100644 --- a/source/_components/ritassist.markdown +++ b/source/_components/ritassist.markdown @@ -61,7 +61,7 @@ include: type: strings {% endconfiguration %} -See the [device tracker component page](/components/device_tracker/) for instructions on how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions on how to configure the people to be tracked. ## {% linkable_title Available attributes %} diff --git a/source/_components/roku.markdown b/source/_components/roku.markdown index 6caf4c53e8d..7d2a95611e1 100644 --- a/source/_components/roku.markdown +++ b/source/_components/roku.markdown @@ -19,14 +19,14 @@ redirect_from: - /components/media_player.roku/ --- -The [Roku](http://www.roku.com/) component allows integration of Roku, which will be automatically discovered if you enable the [discovery component](/components/discovery/). +The [Roku](http://www.roku.com/) integration allows integration of Roku, which will be automatically discovered if you enable the [discovery component](/components/discovery/). There is currently support for the following device types within Home Assistant: - Media Player - Remote -The `roku` component can also be forced to load by adding the following lines to your `configuration.yaml`: +The `roku` integration can also be forced to load by adding the following lines to your `configuration.yaml`: ```yaml # Example configuration.yaml entry diff --git a/source/_components/roomba.markdown b/source/_components/roomba.markdown index ec0f7b30b6a..1b7dc688825 100644 --- a/source/_components/roomba.markdown +++ b/source/_components/roomba.markdown @@ -15,7 +15,7 @@ redirect_from: - /components/vacuum.roomba/ --- -The `roomba` component allows you to control your [iRobot Roomba](http://www.irobot.com/For-the-Home/Vacuuming/Roomba.aspx) vacuum. +The `roomba` integration allows you to control your [iRobot Roomba](http://www.irobot.com/For-the-Home/Vacuuming/Roomba.aspx) vacuum.

This platform has only been tested with an iRobot Roomba 980 but should work fine with any Wi-Fi enabled Roomba like the 690, 890 or the 960. diff --git a/source/_components/route53.markdown b/source/_components/route53.markdown index a69cf2f170b..45b635e93dd 100644 --- a/source/_components/route53.markdown +++ b/source/_components/route53.markdown @@ -13,9 +13,9 @@ ha_category: ha_release: 0.81 --- -With the `route53` component can you keep your AWS Route53 DNS records up to date. +With the `route53` integration can you keep your AWS Route53 DNS records up to date. -The component will run every hour, but can also be started manually by using the service `route53.update_records` under services. +The integration will run every hour, but can also be started manually by using the service `route53.update_records` under services. Please note that this platform uses the API from [ipify.org](https://www.ipify.org/) to set the public IP address. @@ -61,11 +61,11 @@ Here is an IAM Policy sample, don't forget to update your Zone ID on the Resourc 4. Once this has been done, create a new user called `homeassistant` and add the IAM policy to the user, allowing it to manage this DNS resource. -5. Under the security credentials tab for the `homeassistant` user, create a set of access keys for placement in the component definition YAML. +5. Under the security credentials tab for the `homeassistant` user, create a set of access keys for placement in the integration definition YAML. ## {% linkable_title Configuration %} -To use the component in your installation, add the following to your `configuration.yaml` file: +To use the integration in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/rova.markdown b/source/_components/rova.markdown index c0b810a0939..1ecc44969d4 100644 --- a/source/_components/rova.markdown +++ b/source/_components/rova.markdown @@ -109,5 +109,5 @@ automation: {% endraw %}

-This component is not affiliated with Rova and retrieves data from the endpoints of their website. Use at your own risk. +This integration is not affiliated with Rova and retrieves data from the endpoints of their website. Use at your own risk.

diff --git a/source/_components/rpi_camera.markdown b/source/_components/rpi_camera.markdown index 1af3b0db255..5cedd54b3e5 100644 --- a/source/_components/rpi_camera.markdown +++ b/source/_components/rpi_camera.markdown @@ -16,7 +16,7 @@ redirect_from: - /components/camera.rpi_camera/ --- -The `rpi_camera` platform allows you to integrate the Raspberry Pi camera into Home Assistant. This component uses the application [`raspistill`](https://www.raspberrypi.org/documentation/usage/camera/raspicam/raspistill.md) to store the image from camera. +The `rpi_camera` platform allows you to integrate the Raspberry Pi camera into Home Assistant. This integration uses the application [`raspistill`](https://www.raspberrypi.org/documentation/usage/camera/raspicam/raspistill.md) to store the image from camera. ## {% linkable_title Configuration %} diff --git a/source/_components/rpi_gpio.markdown b/source/_components/rpi_gpio.markdown index ed21af54d40..b93ef5ac8ad 100644 --- a/source/_components/rpi_gpio.markdown +++ b/source/_components/rpi_gpio.markdown @@ -21,7 +21,7 @@ redirect_from: - /components/switch.rpi_gpio/ --- -The `rpi_gpio` component is the base for all related GPIO platforms in Home Assistant. There is no setup needed for the component itself, for the platforms please check their corresponding pages. +The `rpi_gpio` integration is the base for all related GPIO platforms in Home Assistant. There is no setup needed for the integration itself, for the platforms please check their corresponding pages. ## {% linkable_title Binary Sensor %} diff --git a/source/_components/rpi_pfio.markdown b/source/_components/rpi_pfio.markdown index 02845b62720..c56ca851dfa 100644 --- a/source/_components/rpi_pfio.markdown +++ b/source/_components/rpi_pfio.markdown @@ -19,7 +19,7 @@ redirect_from: - /components/switch.rpi_pfio/ --- -The `rpi_pfio` component is the base for all related [PiFace Digital I/O (PFIO)](http://www.piface.org.uk/) platforms in Home Assistant. There is no setup needed for the component itself; for the platforms, please check their corresponding pages. +The `rpi_pfio` integration is the base for all related [PiFace Digital I/O (PFIO)](http://www.piface.org.uk/) platforms in Home Assistant. There is no setup needed for the integration itself; for the platforms, please check their corresponding pages. There is currently support for the following device types within Home Assistant: diff --git a/source/_components/rss_feed_template.markdown b/source/_components/rss_feed_template.markdown index 31ebb4251cc..83a91590044 100644 --- a/source/_components/rss_feed_template.markdown +++ b/source/_components/rss_feed_template.markdown @@ -1,7 +1,7 @@ --- layout: page title: "RSS feed template" -description: "Use this component to generate RSS feeds showing your latest data." +description: "Use this integration to generate RSS feeds showing your latest data." date: 2017-04-11 20:42 sidebar: true comments: false @@ -14,7 +14,7 @@ ha_release: 0.44 ha_qa_scale: internal --- -The `rss_feed_template` component can export any information from Home Assistant as a static RSS feed. This can be used to display that information on many types of devices using an RSS reader. While native apps for Home Assistant are not widely available, native RSS readers exist for almost any platform. +The `rss_feed_template` integration can export any information from Home Assistant as a static RSS feed. This can be used to display that information on many types of devices using an RSS reader. While native apps for Home Assistant are not widely available, native RSS readers exist for almost any platform. For example, on Android, the app "Simple RSS Widget" can be used to display temperatures on the home screen. diff --git a/source/_components/sabnzbd.markdown b/source/_components/sabnzbd.markdown index b8a44c5f26f..f78a3fea200 100644 --- a/source/_components/sabnzbd.markdown +++ b/source/_components/sabnzbd.markdown @@ -17,7 +17,7 @@ redirect_from: - /components/sensor.sabnzbd/ --- -The `sabnzbd` component will allow you to monitor and control your downloads with [SABnzbd](https://sabnzbd.org) from within Home Assistant and setup automations based on the information. +The `sabnzbd` integration will allow you to monitor and control your downloads with [SABnzbd](https://sabnzbd.org) from within Home Assistant and setup automations based on the information. If SABnzbd is discovered on your network, you can enter your API Key in the Configurator. Press "CONFIGURE" to do it. diff --git a/source/_components/satel_integra.markdown b/source/_components/satel_integra.markdown index be3b7b14dbe..85a067b0a38 100644 --- a/source/_components/satel_integra.markdown +++ b/source/_components/satel_integra.markdown @@ -20,7 +20,7 @@ redirect_from: - /components/binary_sensor.satel_integra/ --- -The `satel_integra` component will allow Home Assistant users who own a Satel Integra alarm panel to leverage their alarm system and its sensors to provide Home Assistant with information about their homes. Connectivity between Home Assistant and the alarm is accomplished through a ETHM extension module that must be installed in the alarm. Compatible with ETHM-1 Plus module with firmware version > 2.00 (version 2.04 confirmed). +The `satel_integra` integration will allow Home Assistant users who own a Satel Integra alarm panel to leverage their alarm system and its sensors to provide Home Assistant with information about their homes. Connectivity between Home Assistant and the alarm is accomplished through a ETHM extension module that must be installed in the alarm. Compatible with ETHM-1 Plus module with firmware version > 2.00 (version 2.04 confirmed). There is currently support for the following device types within Home Assistant: diff --git a/source/_components/scene.knx.markdown b/source/_components/scene.knx.markdown index e53322c85d2..c700914335e 100644 --- a/source/_components/scene.knx.markdown +++ b/source/_components/scene.knx.markdown @@ -15,7 +15,7 @@ ha_release: 0.63 The `knx` scenes platform allows you to trigger [KNX](http://www.knx.org) scenes. -The `knx` component must be configured correctly, see [KNX Component](/components/knx). +The `knx` integration must be configured correctly, see [KNX Component](/components/knx). ## {% linkable_title Configuration %} diff --git a/source/_components/scene.markdown b/source/_components/scene.markdown index 96b29b24cff..5ade0182a50 100644 --- a/source/_components/scene.markdown +++ b/source/_components/scene.markdown @@ -71,5 +71,5 @@ automation: ```

-Please note that the scene component for the most part only supports one service call per entity to achieve the state. Due to this limitation, you cannot set states belonging to different services. A workaround for this limitation is to write a script, which you then turn on in your scene. A few components have direct support for multiple service calls per state, Currently this is the media_player and climate components. +Please note that the scene integration for the most part only supports one service call per entity to achieve the state. Due to this limitation, you cannot set states belonging to different services. A workaround for this limitation is to write a script, which you then turn on in your scene. A few integrations have direct support for multiple service calls per state, Currently this is the media_player and climate components.

diff --git a/source/_components/script.markdown b/source/_components/script.markdown index 901f7dcf579..5efd98f0c19 100644 --- a/source/_components/script.markdown +++ b/source/_components/script.markdown @@ -14,7 +14,7 @@ ha_qa_scale: internal ha_release: 0.7 --- -The `script` component allows users to specify a sequence of actions to be executed by Home Assistant when turned on. The script component will create an entity for each script and allow them to be controlled via services. +The `script` integration allows users to specify a sequence of actions to be executed by Home Assistant when turned on. The script integration will create an entity for each script and allow them to be controlled via services. The sequence of actions is specified using the [Home Assistant Script Syntax](/getting-started/scripts/). diff --git a/source/_components/scsgate.markdown b/source/_components/scsgate.markdown index 21d33a67047..fa97b0f1b4a 100644 --- a/source/_components/scsgate.markdown +++ b/source/_components/scsgate.markdown @@ -21,7 +21,7 @@ redirect_from: - /components/switch.scsgate/ --- -The SCSGate component support the [SCSGate](https://translate.google.com/translate?hl=en&sl=it&tl=en&u=http%3A%2F%2Fguidopic.altervista.org%2Feibscsgt%2Finterface.html) device. This a home-brew device allows to interact with the MyHome system from BTicino/Legrande. +The SCSGate integration support the [SCSGate](https://translate.google.com/translate?hl=en&sl=it&tl=en&u=http%3A%2F%2Fguidopic.altervista.org%2Feibscsgt%2Finterface.html) device. This a home-brew device allows to interact with the MyHome system from BTicino/Legrande. There is currently support for the following device types within Home Assistant: @@ -46,7 +46,7 @@ device: ### {% linkable_title How to find the scs_id for your devices %} -The SCSGate component relies on the [scsgate](https://github.com/flavio/scsgate) Python module. +The SCSGate integration relies on the [scsgate](https://github.com/flavio/scsgate) Python module. This module provides also a command line tool called `scs-monitor`. This program can be used to find the IDs of your lights, switches and roller shutters and produce the YAML snippet to insert into your `configuration.yaml` file. diff --git a/source/_components/sensehat.markdown b/source/_components/sensehat.markdown index d42541c08c3..e38d76a4944 100644 --- a/source/_components/sensehat.markdown +++ b/source/_components/sensehat.markdown @@ -190,7 +190,7 @@ ln -s /usr/lib/python3/dist-packages/RTIMU.cpython-35m-arm-linux-gnueabihf.so /s sudo reboot ``` -Unfortunately enabling the SenseHAT Sensor component for a Virtual Environment install of Home Assistant fails with errors. +Unfortunately enabling the SenseHAT Sensor integration for a Virtual Environment install of Home Assistant fails with errors. _(The Raspberry Pi All-In-One installer and HASSbian both run Home Assistant in an virtual environment)._ These issues have been discussed in the repository issue [#5093](https://github.com/home-assistant/home-assistant/issues/5093) diff --git a/source/_components/sensor.buienradar.markdown b/source/_components/sensor.buienradar.markdown index 7c1b0022237..fe0abde9322 100644 --- a/source/_components/sensor.buienradar.markdown +++ b/source/_components/sensor.buienradar.markdown @@ -38,11 +38,11 @@ name: required: false type: string latitude: - description: Latitude to use for selection of data source location. Longitude and latitude will be taken from Home Assistant configuration, but can be overridden/changed in this component to select a different location for buienradar.nl. + description: Latitude to use for selection of data source location. Longitude and latitude will be taken from Home Assistant configuration, but can be overridden/changed in this integration to select a different location for buienradar.nl. required: false type: float longitude: - description: Longitude to use for selection of data source location. Longitude and latitude will be taken from Home Assistant configuration, but can be overridden/changed in this component to select a different location for buienradar.nl. + description: Longitude to use for selection of data source location. Longitude and latitude will be taken from Home Assistant configuration, but can be overridden/changed in this integration to select a different location for buienradar.nl. required: false type: float timeframe: diff --git a/source/_components/sensor.knx.markdown b/source/_components/sensor.knx.markdown index 88b5a2239f5..509091b5efa 100644 --- a/source/_components/sensor.knx.markdown +++ b/source/_components/sensor.knx.markdown @@ -16,7 +16,7 @@ ha_iot_class: Local Push The `knx` sensor platform allows you to monitor [KNX](http://www.knx.org) sensors. -The `knx` component must be configured correctly, see [KNX Component](/components/knx). +The `knx` integration must be configured correctly, see [KNX Component](/components/knx). ## {% linkable_title Configuration %} diff --git a/source/_components/sensor.rflink.markdown b/source/_components/sensor.rflink.markdown index 08dad307556..d4ae3cae133 100644 --- a/source/_components/sensor.rflink.markdown +++ b/source/_components/sensor.rflink.markdown @@ -14,7 +14,7 @@ ha_release: 0.38 ha_iot_class: Local Polling --- -The `rflink` component supports devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver). +The `rflink` integration supports devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver). ## {% linkable_title Configuration %} diff --git a/source/_components/shell_command.markdown b/source/_components/shell_command.markdown index a8129cd686f..631fc1331c5 100644 --- a/source/_components/shell_command.markdown +++ b/source/_components/shell_command.markdown @@ -14,7 +14,7 @@ ha_qa_scale: internal ha_release: 0.7.6 --- -This component can expose regular shell commands as services. Services can be called from a [script] or in [automation]. +This integration can expose regular shell commands as services. Services can be called from a [script] or in [automation]. Shell commands aren't allowed for a camel-case naming, please use lowercase naming only and separate the names with underscores. [script]: /components/script/ diff --git a/source/_components/shiftr.markdown b/source/_components/shiftr.markdown index 540bce296aa..e4b801c884c 100644 --- a/source/_components/shiftr.markdown +++ b/source/_components/shiftr.markdown @@ -13,13 +13,13 @@ ha_category: ha_release: 0.48 --- -The `shiftr` component makes it possible to transfer details collected with Home Assistant to [Shiftr.io](https://shiftr.io) and visualize the flow of the information. Keep in mind that your details will be public! +The `shiftr` integration makes it possible to transfer details collected with Home Assistant to [Shiftr.io](https://shiftr.io) and visualize the flow of the information. Keep in mind that your details will be public! ## {% linkable_title Configuration %} Create a new [namespace](https://shiftr.io/new) and generate a new token. You will need to use `Key (Username)` and `Secret (Password)` to setup the component. -To use the `shiftr` component in your installation, add the following to your `configuration.yaml` file: +To use the `shiftr` integration in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/shopping_list.markdown b/source/_components/shopping_list.markdown index 7edca86882d..91ad5757b2d 100644 --- a/source/_components/shopping_list.markdown +++ b/source/_components/shopping_list.markdown @@ -14,7 +14,7 @@ ha_release: "0.50" ha_qa_scale: internal --- -The `shopping_list` component allows you to keep track of shopping list items. Includes the ability to add items via your voice using the sentence "Add eggs to my shopping list". +The `shopping_list` integration allows you to keep track of shopping list items. Includes the ability to add items via your voice using the sentence "Add eggs to my shopping list". ## {% linkable_title Configuration %} diff --git a/source/_components/sigfox.markdown b/source/_components/sigfox.markdown index 9346bdc192b..b559f19083c 100644 --- a/source/_components/sigfox.markdown +++ b/source/_components/sigfox.markdown @@ -16,7 +16,7 @@ redirect_from: - /components/sensor.sigfox/ --- -[SigFox](https://www.sigfox.com/en) component adding a sensor for each Sigfox device registered with your account. The default name of sensors is `sigfox_{DEVICE_ID}` where `DEVICE_ID` is the devices Sigfox ID. The state of an added Sigfox sensor is the payload of the last message published by that device. Additionally, there are attributes for the latitude and longitude coordinates of the device, as well as the signal-to-noise ratio ([snr](https://en.wikipedia.org/wiki/Signal-to-noise_ratio)). +[SigFox](https://www.sigfox.com/en) integration adding a sensor for each Sigfox device registered with your account. The default name of sensors is `sigfox_{DEVICE_ID}` where `DEVICE_ID` is the devices Sigfox ID. The state of an added Sigfox sensor is the payload of the last message published by that device. Additionally, there are attributes for the latitude and longitude coordinates of the device, as well as the signal-to-noise ratio ([snr](https://en.wikipedia.org/wiki/Signal-to-noise_ratio)). ## {% linkable_title Setup %} diff --git a/source/_components/simplisafe.markdown b/source/_components/simplisafe.markdown index facc5b18d26..e1108078e63 100644 --- a/source/_components/simplisafe.markdown +++ b/source/_components/simplisafe.markdown @@ -15,7 +15,7 @@ redirect_from: - /components/alarm_control_panel.simplisafe/ --- -The `simplisafe` component integrates SimpliSafe home security (V2 and V3) systems into Home Assistant. Multiple SimpliSafe accounts can be accommodated. +The `simplisafe` integration integrates SimpliSafe home security (V2 and V3) systems into Home Assistant. Multiple SimpliSafe accounts can be accommodated. There is currently support for the following device types within Home Assistant: diff --git a/source/_components/sisyphus.markdown b/source/_components/sisyphus.markdown index 6b7476276a9..acee28dbf19 100644 --- a/source/_components/sisyphus.markdown +++ b/source/_components/sisyphus.markdown @@ -26,7 +26,7 @@ There is currently support for the following device types within Home Assistant: - **Light** - Can be used to sleep/wake the table or adjust the brightness of the table light. - **Media Player** - Can be used to sleep/wake the table, play/pause, move between tracks, or toggle shuffle on and off. The "volume" control adjusts the table's speed. -The Light and Media players will be automatically added for each of your Sisyphus tables, if the Sisyphus component is configured. +The Light and Media players will be automatically added for each of your Sisyphus tables, if the Sisyphus integration is configured. There are two ways to configure this component. For the automatic discovery of your table(s), simply add the following to your `configuration.yaml`: diff --git a/source/_components/sky_hub.markdown b/source/_components/sky_hub.markdown index c4f08e32b12..15af6329d70 100644 --- a/source/_components/sky_hub.markdown +++ b/source/_components/sky_hub.markdown @@ -34,4 +34,4 @@ host: type: string {% endconfiguration %} -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. diff --git a/source/_components/smappee.markdown b/source/_components/smappee.markdown index 84d4cec5973..8744012a21a 100644 --- a/source/_components/smappee.markdown +++ b/source/_components/smappee.markdown @@ -20,7 +20,7 @@ redirect_from: - /components/switch.smappee/ --- -The `smappee` component adds support for the [Smappee](https://www.smappee.com/) controller for energy monitoring and Comport plug switches. +The `smappee` integration adds support for the [Smappee](https://www.smappee.com/) controller for energy monitoring and Comport plug switches. There is currently support for the following device types within Home Assistant: @@ -29,13 +29,13 @@ There is currently support for the following device types within Home Assistant: Will be automatically added when you connect to the Smappee controller. -The smappee component gets information from [Smappee API](https://smappee.atlassian.net/wiki/spaces/DEVAPI/overview). Note: their cloud API now requires a subscription fee of €2.50 per month for Smappee Energy/Solar or €3 per month for Smappee Plus. +The smappee integration gets information from [Smappee API](https://smappee.atlassian.net/wiki/spaces/DEVAPI/overview). Note: their cloud API now requires a subscription fee of €2.50 per month for Smappee Energy/Solar or €3 per month for Smappee Plus. ## {% linkable_title Configuration %} Info on how to get API access is described in the [smappy wiki](https://github.com/EnergieID/smappy/wiki). -To use the `smappee` component in your installation, add the following to your `configuration.yaml` file: +To use the `smappee` integration in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/smarthab.markdown b/source/_components/smarthab.markdown index 6eac4877e80..c911db703a6 100644 --- a/source/_components/smarthab.markdown +++ b/source/_components/smarthab.markdown @@ -18,7 +18,7 @@ ha_iot_class: Cloud Polling If your home is fitted with [SmartHab](http://www.smarthab.fr/en/home/)'s devices and you have access to their app-based services, you will be able -to control your lights and shutters with the SmartHab component for Home +to control your lights and shutters with the SmartHab integration for Home Assistant. Once you have added a `smarthab` entry to your configuration, your supported @@ -27,7 +27,7 @@ devices will automatically be discovered and made available on your dashboard.

To prevent being automatically logged out of your SmartHab mobile app, you might want to create a secondary user in the app's settings and grant it - access to your home. You can then configure the component using this account's + access to your home. You can then configure the integration using this account's credentials. This is also more secure, as this user should be less priviledged.

diff --git a/source/_components/smartthings.markdown b/source/_components/smartthings.markdown index 5d51f701561..cb59245e6da 100644 --- a/source/_components/smartthings.markdown +++ b/source/_components/smartthings.markdown @@ -43,7 +43,7 @@ redirect_from: - /components/switch.smartthings/ --- -Samsung SmartThings is integrated into Home Assistant through the SmartThings Cloud API. The SmartThings component is the main component to integrate all SmartThings related platforms. The basic features of this integration include: +Samsung SmartThings is integrated into Home Assistant through the SmartThings Cloud API. The SmartThings integration is the main integration to integrate all SmartThings related platforms. The basic features of this integration include: 1. Controlling SmartThings devices with pushed state updates from SmartThings. 2. Entities automatically added, removed, or updated when changed in SmartThings (upon Home Assistant restart). @@ -62,7 +62,7 @@ The SmartThings integration utilizes a webhook to receive push updates from the ### {% linkable_title Cloudhook via Nabu Casa %} -If you are using Home Assistant Cloud (Nabu Casa) the integration will create a cloudhook automatically. This greatly simplifies the basic requirements and does not require Home Assistant to be exposed to the internet. **If you have previously setup the component prior to meeting the requirements for a cloudhook or prior to v0.90.0, you must remove all prior integrations and run through the configuration again.** +If you are using Home Assistant Cloud (Nabu Casa) the integration will create a cloudhook automatically. This greatly simplifies the basic requirements and does not require Home Assistant to be exposed to the internet. **If you have previously setup the integration prior to meeting the requirements for a cloudhook or prior to v0.90.0, you must remove all prior integrations and run through the configuration again.** 1. A [personal access token](https://account.smartthings.com/tokens) tied to a Samsung or SmartThings account (see below for instructions). 2. Home Assistant Cloud is configured and logged-in with a non-expired subscription. @@ -90,7 +90,7 @@ If you are using Home Assistant Cloud (Nabu Casa) the integration will create a ### {% linkable_title Configure Home Assistant %}

-The SmartThings component is configured exclusively through the front-end. Manual setup through `configuration.yaml` is not available at this time. +The SmartThings integration is configured exclusively through the front-end. Manual setup through `configuration.yaml` is not available at this time.

1. From the Home Assistant front-end, navigate to 'Configuration' then 'Integrations'. Under 'Set up a new integration' locate 'SmartThings' and click 'Configure'. @@ -110,11 +110,11 @@ See the [troubleshooting](#troubleshooting) if you are having issues setting up ## {% linkable_title Events %} -The SmartThings component triggers events for select device capabilities. +The SmartThings integration triggers events for select device capabilities. ### {% linkable_title smartthings.button %} -The component will trigger an event when a device with the [button](https://smartthings.developer.samsung.com/develop/api-ref/capabilities.html#Button) capability is actuated and can be used to trigger automations within Home Assistant. Below is an example of the data payload: +The integration will trigger an event when a device with the [button](https://smartthings.developer.samsung.com/develop/api-ref/capabilities.html#Button) capability is actuated and can be used to trigger automations within Home Assistant. Below is an example of the data payload: ```json { @@ -128,7 +128,7 @@ The component will trigger an event when a device with the [button](https://smar | Attribute | Description |---------------------------|------------------------------------------------------------------| -`component_id` | Describes which component of the device triggered the event. `main` represents the parent device. For devices with child-devices, this attribute identifies the child that raised the event. +`component_id` | Describes which integration of the device triggered the event. `main` represents the parent device. For devices with child-devices, this attribute identifies the child that raised the event. `device_id` | The unique id of the device in SmartThings. This can be located in the HASS device registry or in the [SmartThings Groovy IDE](https://developers.smartthings.com/). `location_id` | The unique id of the location the device is part of. This can be found in the config entry registry or in the [SmartThings Groovy IDE](https://developers.smartthings.com/). `value` | Describes the action taken on the button. See the [button](https://smartthings.developer.samsung.com/develop/api-ref/capabilities.html#Button) capability reference for a list of possible values (not all are supported by every device). @@ -138,7 +138,7 @@ Event data payloads are logged at the debug level, see [debugging](#debugging) f ## {% linkable_title Platforms %} -SmartThings represents devices as a set of [capabilities](https://smartthings.developer.samsung.com/develop/api-ref/capabilities.html) and the SmartThings component maps those to entity platforms in Home Assistant. A single device may be represented by one or more platforms. +SmartThings represents devices as a set of [capabilities](https://smartthings.developer.samsung.com/develop/api-ref/capabilities.html) and the SmartThings integration maps those to entity platforms in Home Assistant. A single device may be represented by one or more platforms. - [Binary Sensor](#binary-sensor) - [Climate](#climate) @@ -312,7 +312,7 @@ The SmartThings Switch platform lets you control devices that have the [`switch` Perform the following steps if you receive one of the following error messages while attempting to setup the integration (this does not apply when integrated through Home Assistant Cloud): -- "SmartThings could not validate the endpoint configured in base_url. Please review the component requirements." +- "SmartThings could not validate the endpoint configured in base_url. Please review the integration requirements." - "Unable to setup the SmartApp. Please try again." #### {% linkable_title Checklist %} @@ -344,11 +344,11 @@ Perform the following steps if you receive one of the following error messages w {"pingData": {"challenge": "00000000-0000-0000-0000-000000000000"}} ``` -If you have completed the checklist above and are still unable to setup the platform, [activate debug logging](#debugging) for the SmartThings component and include the log messages up until the point of failure in [a new issue](https://github.com/home-assistant/home-assistant/issues). +If you have completed the checklist above and are still unable to setup the platform, [activate debug logging](#debugging) for the SmartThings integration and include the log messages up until the point of failure in [a new issue](https://github.com/home-assistant/home-assistant/issues). ### {% linkable_title Debugging %} -The SmartThings component will log additional information about push updates received, events fired, and other messages when the log level is set to `debug`. Add the the relevent line below to the `configuration.yaml`: +The SmartThings integration will log additional information about push updates received, events fired, and other messages when the log level is set to `debug`. Add the the relevent line below to the `configuration.yaml`: ```yaml logger: diff --git a/source/_components/smarty.markdown b/source/_components/smarty.markdown index cf7caa1f13c..ed00b38f893 100644 --- a/source/_components/smarty.markdown +++ b/source/_components/smarty.markdown @@ -15,14 +15,14 @@ ha_category: ha_release: 0.95 --- -The `smarty` component lets you control Salda [Smarty](http://www.salda.lt/en/products/category/compact-counter-flow-units) ventilation units from Home Assistant. You need a [MB-GATEWAY](http://www.salda.lt/en/products/item/5637227077) or something similar to connect to your local network. +The `smarty` integration lets you control Salda [Smarty](http://www.salda.lt/en/products/category/compact-counter-flow-units) ventilation units from Home Assistant. You need a [MB-GATEWAY](http://www.salda.lt/en/products/item/5637227077) or something similar to connect to your local network. There is currently support for the following device types within Home Assistant: - Fan - Sensor -The component has a fan platform to view and control the ventilation speed, and a sensors platform to read: +The integration has a fan platform to view and control the ventilation speed, and a sensors platform to read: - Outdoor air temperature - Extract air temperature diff --git a/source/_components/smhi.markdown b/source/_components/smhi.markdown index 24564fc4e5e..9dc1df16236 100644 --- a/source/_components/smhi.markdown +++ b/source/_components/smhi.markdown @@ -17,7 +17,7 @@ redirect_from: - /components/weather.smhi/ --- -The `smhi` component adds support for the [SMHI.se](https://www.smhi.se/) web service as a source for meteorological data for your location. +The `smhi` integration adds support for the [SMHI.se](https://www.smhi.se/) web service as a source for meteorological data for your location. There is currently support for the following device types within Home Assistant: diff --git a/source/_components/snips.markdown b/source/_components/snips.markdown index 60dc41ef5b8..6087aaaad3c 100644 --- a/source/_components/snips.markdown +++ b/source/_components/snips.markdown @@ -93,7 +93,7 @@ followed by a command, e.g. > Set the lights to green in the living room -As the Snips Platform parses this query into an intent, it will be published on MQTT, on the `hermes/intent/` topic. The Snips Home Assistant component subscribes to this topic, and handles the intent according to the rules defined in `configuration.yaml` file, as explained below. +As the Snips Platform parses this query into an intent, it will be published on MQTT, on the `hermes/intent/` topic. The Snips Home Assistant integration subscribes to this topic, and handles the intent according to the rules defined in `configuration.yaml` file, as explained below. #### {% linkable_title Optional: specifying an external MQTT broker %} @@ -141,7 +141,7 @@ Alternatively, MQTT can be configured to bridge messages between servers if usin In Home Assistant, we trigger actions based on intents produced by Snips using the [`intent_script`](/components/intent_script) component. For instance, the following block handles a `ActivateLightColor` intent to change light colors: -Note: If your Snips action is prefixed with a username (e.g., `john:playmusic` or `john__playmusic`), the Snips component in Home Assistant [will try and strip off the username](https://github.com/home-assistant/home-assistant/blob/c664c20165ebeb248b98716cf61e865f274a2dac/homeassistant/components/snips.py#L126-L129). Bear this in mind if you get the error `Received unknown intent` even when what you see on the MQTT bus looks correct. Internally the Snips component is trying to match the non-username version of the intent (i.e., just `playmusic`). +Note: If your Snips action is prefixed with a username (e.g., `john:playmusic` or `john__playmusic`), the Snips integration in Home Assistant [will try and strip off the username](https://github.com/home-assistant/home-assistant/blob/c664c20165ebeb248b98716cf61e865f274a2dac/homeassistant/components/snips.py#L126-L129). Bear this in mind if you get the error `Received unknown intent` even when what you see on the MQTT bus looks correct. Internally the Snips integration is trying to match the non-username version of the intent (i.e., just `playmusic`). {% raw %} ```yaml diff --git a/source/_components/snmp.markdown b/source/_components/snmp.markdown index d6ac34a175e..a679debd103 100644 --- a/source/_components/snmp.markdown +++ b/source/_components/snmp.markdown @@ -35,7 +35,7 @@ This device tracker needs SNMP to be enabled on the router. It could be that you ## {% linkable_title Presence Detection %} -The following OID examples pull the current MAC Address table from a router. This reflects all recent devices seen on the network. However, since devices are not removed until they time out, this is less effective for [device tracker component page](/components/device_tracker/) than desirable. It is recommended to use [Ping](/components/device_tracker.ping/) or [Nmap](/components/device_tracker.nmap_tracker/) instead. +The following OID examples pull the current MAC Address table from a router. This reflects all recent devices seen on the network. However, since devices are not removed until they time out, this is less effective for [device tracker integration page](/components/device_tracker/) than desirable. It is recommended to use [Ping](/components/device_tracker.ping/) or [Nmap](/components/device_tracker.nmap_tracker/) instead. | Brand | Device/Firmware | OID | |---|---|---|---| @@ -101,7 +101,7 @@ priv_key: type: string {% endconfiguration %} -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. ## {% linkable_title Sensor %} diff --git a/source/_components/solax.markdown b/source/_components/solax.markdown index 180fee62291..bdb4bd37b8f 100644 --- a/source/_components/solax.markdown +++ b/source/_components/solax.markdown @@ -15,7 +15,7 @@ ha_release: 0.94 ha_iot_class: Local Polling --- -The `solax` component connects home-assistant to Solax solar power inverters. Solax inverters may be connected to a home Wi-Fi network and expose a REST API. This component retrieves information such as photovoltaic power production, battery levels and power, and how much power is being fed back into the grid. +The `solax` integration connects home-assistant to Solax solar power inverters. Solax inverters may be connected to a home Wi-Fi network and expose a REST API. This integration retrieves information such as photovoltaic power production, battery levels and power, and how much power is being fed back into the grid. ## {% linkable_title Configuration %} diff --git a/source/_components/somfy.markdown b/source/_components/somfy.markdown index 6a7d4a5fad2..4f837dd3a7b 100644 --- a/source/_components/somfy.markdown +++ b/source/_components/somfy.markdown @@ -14,7 +14,7 @@ ha_iot_class: Cloud Polling ha_release: 0.95 --- -The Somfy component will allow users to integrate their Somfy devices into Home Assistant using the [official API](https://developer.somfy.com/somfy-open-api/apis), unlike the [tahoma](/components/tahoma/) component. +The Somfy integration will allow users to integrate their Somfy devices into Home Assistant using the [official API](https://developer.somfy.com/somfy-open-api/apis), unlike the [tahoma](/components/tahoma/) component. ### {% linkable_title Setting up developer account %} @@ -51,7 +51,7 @@ client_secret: type: string {% endconfiguration %} -### {% linkable_title Potential duplicate with the Tahoma component %} +### {% linkable_title Potential duplicate with the Tahoma integration %} If you use the [tahoma](/component/tahoma) component, you will have to exclude the covers added by this one. Otherwise, they will be added twice. diff --git a/source/_components/sonos.markdown b/source/_components/sonos.markdown index 096ac6d69a0..b222753c6bf 100644 --- a/source/_components/sonos.markdown +++ b/source/_components/sonos.markdown @@ -16,9 +16,9 @@ ha_iot_class: Local Polling redirect_from: /components/media_player.sonos/ --- -The `sonos` component allows you to control your [Sonos](https://www.sonos.com) HiFi wireless speakers and audio components from Home Assistant. By default it supports auto-discovery provided by Home Assistant, and you don't need to add anything to your `configuration.yaml`. +The `sonos` integration allows you to control your [Sonos](https://www.sonos.com) HiFi wireless speakers and audio integrations from Home Assistant. By default it supports auto-discovery provided by Home Assistant, and you don't need to add anything to your `configuration.yaml`. -If you don't have the discovery component enabled, you can configure the Sonos component by going to the integrations page inside the config panel. +If you don't have the discovery integration enabled, you can configure the Sonos integration by going to the integrations page inside the config panel. ## {% linkable_title Services %} diff --git a/source/_components/spaceapi.markdown b/source/_components/spaceapi.markdown index 34d9add3420..81e8a83f9d3 100644 --- a/source/_components/spaceapi.markdown +++ b/source/_components/spaceapi.markdown @@ -13,11 +13,11 @@ ha_category: ha_release: "0.70" --- -The `spaceapi` component allow Hackerspaces to expose information to web apps or any other application with the [SpaceAPI](http://spaceapi.net/). +The `spaceapi` integration allow Hackerspaces to expose information to web apps or any other application with the [SpaceAPI](http://spaceapi.net/). ## {% linkable_title Configuration %} -To setup the `spaceapi` component in your installation, add the following to your `configuration.yaml` file: +To setup the `spaceapi` integration in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/speedtestdotnet.markdown b/source/_components/speedtestdotnet.markdown index 285897846b3..c9f7b1af7f9 100644 --- a/source/_components/speedtestdotnet.markdown +++ b/source/_components/speedtestdotnet.markdown @@ -18,9 +18,9 @@ redirect_from: - /components/sensor.speedtestdotnet/ --- -The `speedtestdotnet` component uses the [Speedtest.net](https://speedtest.net/) web service to measure network bandwidth performance. +The `speedtestdotnet` integration uses the [Speedtest.net](https://speedtest.net/) web service to measure network bandwidth performance. -Enabling this component will automatically create the Speedtest.net Sensors for the monitored conditions (below). +Enabling this integration will automatically create the Speedtest.net Sensors for the monitored conditions (below). By default, a speed test will be run every hour. The user can change the update frequency in the configuration by defining the `scan_interval` for a speed test to run. @@ -80,15 +80,15 @@ scan_interval: ### {% linkable_title Service %} -Once loaded, the `speedtestdotnet` component will expose a service (`speedtestdotnet.speedtest`) that can be called to run a Speedtest.net speed test on demand. This service takes no parameters. This can be useful if you have enabled manual mode. +Once loaded, the `speedtestdotnet` integration will expose a service (`speedtestdotnet.speedtest`) that can be called to run a Speedtest.net speed test on demand. This service takes no parameters. This can be useful if you have enabled manual mode. ```yaml action: service: speedtestdotnet.speedtest ``` -This component uses [speedtest-cli](https://github.com/sivel/speedtest-cli) to gather network performance data from Speedtest.net. -Please be aware of the potential [inconsistencies](https://github.com/sivel/speedtest-cli#inconsistency) that this component may display. +This integration uses [speedtest-cli](https://github.com/sivel/speedtest-cli) to gather network performance data from Speedtest.net. +Please be aware of the potential [inconsistencies](https://github.com/sivel/speedtest-cli#inconsistency) that this integration may display. When Home Assistant first starts up, the values of the speed test will show as `Unknown`. You can use the service `speedtestdotnet.speedtest` to run a manual speed test and populate the data or just wait for the next regularly scheduled test. You can turn on manual mode to disable the scheduled speed tests. @@ -136,7 +136,7 @@ automation: ## {% linkable_title Notes %} - When running on Raspberry Pi, just note that the maximum speed is limited by its 100 Mbit/s LAN adapter. The Raspberry Pi 3+ models comes with a Gigabit LAN adapter which supports a [maximum throughput](https://www.raspberrypi.org/products/raspberry-pi-3-model-b-plus/) of 300 Mbit/s. -- Running this component can have negative effects on the system's performance as it requires a fair amount of memory. +- Running this integration can have negative effects on the system's performance as it requires a fair amount of memory. - Entries under `monitored_conditions` only control what entities are available in Home Assistant, it does not disable the condition from running. -- If ran frequently, this component has the ability to use a considerable amount of data. Frequent updates should be avoided on bandwidth-capped connections. +- If ran frequently, this integration has the ability to use a considerable amount of data. Frequent updates should be avoided on bandwidth-capped connections. - While running, your network capacity is fully utilized. This may have a negative effect on other devices in use the network such as gaming consoles or streaming boxes. diff --git a/source/_components/spider.markdown b/source/_components/spider.markdown index 244e0e33416..11f9c5f4b37 100644 --- a/source/_components/spider.markdown +++ b/source/_components/spider.markdown @@ -19,7 +19,7 @@ redirect_from: - /components/climate.spider/ --- -The `spider` component is the main component to integrate all [Itho Daalderop Spider](https://www.ithodaalderop.nl/spider-thermostaat) related platforms. You will need your Spider account information (username, password) to discover and control devices which are related to your account. +The `spider` integration is the main integration to integrate all [Itho Daalderop Spider](https://www.ithodaalderop.nl/spider-thermostaat) related platforms. You will need your Spider account information (username, password) to discover and control devices which are related to your account. There is currently support for the following device types within Home Assistant: @@ -52,11 +52,11 @@ scan_interval: {% endconfiguration %}

-This component is not affiliated with Itho Daalderop Spider and retrieves data from the endpoints of the mobile application. Use at your own risk. +This integration is not affiliated with Itho Daalderop Spider and retrieves data from the endpoints of the mobile application. Use at your own risk.

### {% linkable_title Climate %}

-Although this component lets you change the operation mode to heating or cooling, it doesn't necessarily mean your boiler can. Spider is not aware of your current situation. +Although this integration lets you change the operation mode to heating or cooling, it doesn't necessarily mean your boiler can. Spider is not aware of your current situation.

diff --git a/source/_components/splunk.markdown b/source/_components/splunk.markdown index 3446eaf791f..de395889834 100644 --- a/source/_components/splunk.markdown +++ b/source/_components/splunk.markdown @@ -13,11 +13,11 @@ ha_category: ha_release: 0.13 --- -The `splunk` component makes it possible to log all state changes to an external [Splunk](http://splunk.com/) database using Splunk's HTTP Event Collector (HEC) feature. You can either use this alone, or with the Home Assistant for Splunk [app](https://github.com/miniconfig/splunk-homeassistant). Since the HEC feature is new to Splunk, you will need to use at least version 6.3. +The `splunk` integration makes it possible to log all state changes to an external [Splunk](http://splunk.com/) database using Splunk's HTTP Event Collector (HEC) feature. You can either use this alone, or with the Home Assistant for Splunk [app](https://github.com/miniconfig/splunk-homeassistant). Since the HEC feature is new to Splunk, you will need to use at least version 6.3. ## {% linkable_title Configuration %} -To use the `splunk` component in your installation, add the following to your `configuration.yaml` file: +To use the `splunk` integration in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/spotify.markdown b/source/_components/spotify.markdown index 605ed0dbac0..cf946f4185a 100644 --- a/source/_components/spotify.markdown +++ b/source/_components/spotify.markdown @@ -25,7 +25,7 @@ The `spotify` media player platform allows you to control - Spotify application, properly configured (see below)

-Controlling the Spotify component (pause, play, next, etc.) requires a Premium account. If you do not have a Premium account, the component in the frontend will not show the controls. +Controlling the Spotify integration (pause, play, next, etc.) requires a Premium account. If you do not have a Premium account, the integration in the frontend will not show the controls.

To create the required Spotify application: diff --git a/source/_components/sql.markdown b/source/_components/sql.markdown index a2ee887e342..e25521de468 100644 --- a/source/_components/sql.markdown +++ b/source/_components/sql.markdown @@ -16,7 +16,7 @@ redirect_from: --- The `sql` sensor platform enables you to use values from an [SQL](https://en.wikipedia.org/wiki/SQL) database supported by the [sqlalchemy](https://www.sqlalchemy.org) library, to populate a sensor state (and attributes). -This can be used to present statistics about Home Assistant sensors if used with the `recorder` component database. It can also be used with an external data source. +This can be used to present statistics about Home Assistant sensors if used with the `recorder` integration database. It can also be used with an external data source. ## {% linkable_title Configuration %} diff --git a/source/_components/srp_energy.markdown b/source/_components/srp_energy.markdown index 87f6f8b9978..a951ca8b058 100644 --- a/source/_components/srp_energy.markdown +++ b/source/_components/srp_energy.markdown @@ -13,7 +13,7 @@ redirect_from: - /components/sensor.srp_energy/ --- -The `srp_energy` component shows information from Srp hourly energy usage report for their customers. The srpenergy module fetches the data found on the website. +The `srp_energy` integration shows information from Srp hourly energy usage report for their customers. The srpenergy module fetches the data found on the website. You need a Username, Password, and AccountId which you can create at [Srp](https://www.srpnet.com). diff --git a/source/_components/statistics.markdown b/source/_components/statistics.markdown index 81183439949..db3eea3b7bd 100644 --- a/source/_components/statistics.markdown +++ b/source/_components/statistics.markdown @@ -19,7 +19,7 @@ redirect_from: The `statistics` sensor platform consumes the state from other sensors. It exports the `mean` value as state and the following values as attributes: `count`, `mean`, `median`, `stdev`, `variance`, `total`, `min`, `max`, `min_age`, `max_age`, `change`, `average_change` and `change_rate`. If it's a binary sensor then only state changes are counted. -If you are running the [recorder](/components/recorder/) component, on startup the data is read from the database. So after a restart of the platform, you will immediately have data available. If you're using the [history](/components/history/) component, this will automatically also start the `recorder` component on startup. +If you are running the [recorder](/components/recorder/) component, on startup the data is read from the database. So after a restart of the platform, you will immediately have data available. If you're using the [history](/components/history/) component, this will automatically also start the `recorder` integration on startup. If you are *not* running the `recorder` component, it can take time till the sensor starts to work because a couple of attributes need more than one value to do the calculation. ## {% linkable_title Configuration %} @@ -27,7 +27,7 @@ If you are *not* running the `recorder` component, it can take time till the sen To enable the statistics sensor, add the following lines to your `configuration.yaml`: ```yaml -# enable the recorder component (optional) +# enable the recorder integration (optional) recorder: # Example configuration.yaml entry diff --git a/source/_components/statsd.markdown b/source/_components/statsd.markdown index 467d6f60acf..0ee10e6e850 100644 --- a/source/_components/statsd.markdown +++ b/source/_components/statsd.markdown @@ -13,9 +13,9 @@ ha_category: ha_release: 0.12 --- -The `statsd` component makes it possible to transfer all state changes to an external [StatsD](https://github.com/etsy/statsd) instance. +The `statsd` integration makes it possible to transfer all state changes to an external [StatsD](https://github.com/etsy/statsd) instance. -To use the `statsd` component in your installation, add the following to your `configuration.yaml` file: +To use the `statsd` integration in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/stiebel_eltron.markdown b/source/_components/stiebel_eltron.markdown index 979d8065093..6be6d24fa7b 100644 --- a/source/_components/stiebel_eltron.markdown +++ b/source/_components/stiebel_eltron.markdown @@ -14,7 +14,7 @@ ha_release: 0.92 ha_iot_class: Local Polling --- -The `stiebel_eltron` component lets you control integral ventilation or heat pump units of [STIEBEL ELTRON](https://www.stiebel-eltron.com). +The `stiebel_eltron` integration lets you control integral ventilation or heat pump units of [STIEBEL ELTRON](https://www.stiebel-eltron.com). It requires the following components: @@ -66,7 +66,7 @@ hub: {% endconfiguration %}

-This component requires the [Modbus](/components/modbus/) component to be set up to work +This integration requires the [Modbus](/components/modbus/) integration to be set up to work

Full configuration example including modbus setup shown below: diff --git a/source/_components/stream.markdown b/source/_components/stream.markdown index 85f31bf63a7..a7bd237310e 100644 --- a/source/_components/stream.markdown +++ b/source/_components/stream.markdown @@ -15,7 +15,7 @@ ha_iot_class: Local Push ha_qa_scale: internal --- -The `stream` component provides a way to proxy live streams through Home Assistant. The component currently only supports proxying H.264 source streams to the HLS format and requires at least FFmpeg >= 3.2. +The `stream` integration provides a way to proxy live streams through Home Assistant. The integration currently only supports proxying H.264 source streams to the HLS format and requires at least FFmpeg >= 3.2. ## {% linkable_title Configuration %} diff --git a/source/_components/streamlabswater.markdown b/source/_components/streamlabswater.markdown index 21bd4583c48..a062d49a9c0 100644 --- a/source/_components/streamlabswater.markdown +++ b/source/_components/streamlabswater.markdown @@ -15,14 +15,14 @@ ha_release: "0.95" ha_iot_class: "Cloud Polling" --- -The `Streamlabs Water` component platform is used to interact with [Streamlabs water monitoring devices](https://www.streamlabswater.com/) in order to retrieve usage information and manage the away mode of the device. The [Streamlabs Water API](https://developer.streamlabswater.com) is used to retrieve daily, monthly, and yearly water usage along with the current away mode. +The `Streamlabs Water` integration platform is used to interact with [Streamlabs water monitoring devices](https://www.streamlabswater.com/) in order to retrieve usage information and manage the away mode of the device. The [Streamlabs Water API](https://developer.streamlabswater.com) is used to retrieve daily, monthly, and yearly water usage along with the current away mode. There is currently support for the following device types within Home Assistant: - Binary Sensor - Sensor -In preparation for using this component you will need to request an API key following the instructions in the [Streamlabs API Getting Started Section](https://developer.streamlabswater.com/docs/getting-started.html). Be sure to request an API key and not an OAuth token. +In preparation for using this integration you will need to request an API key following the instructions in the [Streamlabs API Getting Started Section](https://developer.streamlabswater.com/docs/getting-started.html). Be sure to request an API key and not an OAuth token. ## {% linkable_title Configuration %} diff --git a/source/_components/sun.markdown b/source/_components/sun.markdown index cae4f6d77d7..868642f98da 100644 --- a/source/_components/sun.markdown +++ b/source/_components/sun.markdown @@ -14,7 +14,7 @@ ha_qa_scale: internal ha_release: pre 0.7 --- -The sun component will use your current location to track if the sun is above or +The sun integration will use your current location to track if the sun is above or below the horizon. The sun can be used within automation as [a trigger with an optional offset to simulate dawn/dusk][sun_trigger] or as [a condition with an optional offset to test if the sun has already set or risen][sun_condition]. diff --git a/source/_components/swisscom.markdown b/source/_components/swisscom.markdown index b96a664655b..40407879a16 100644 --- a/source/_components/swisscom.markdown +++ b/source/_components/swisscom.markdown @@ -38,4 +38,4 @@ host: type: string {% endconfiguration %} -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. diff --git a/source/_components/switch.knx.markdown b/source/_components/switch.knx.markdown index 0d3139db41d..daba70717c1 100644 --- a/source/_components/switch.knx.markdown +++ b/source/_components/switch.knx.markdown @@ -14,9 +14,9 @@ ha_release: 0.24 ha_iot_class: Local Polling --- -The `knx` switch component is used as in interface to switching actuators. +The `knx` switch integration is used as in interface to switching actuators. -The `knx` component must be configured correctly, see [KNX Component](/components/knx). +The `knx` integration must be configured correctly, see [KNX Component](/components/knx). ## {% linkable_title Configuration %} diff --git a/source/_components/switch.rflink.markdown b/source/_components/switch.rflink.markdown index b69378cdd89..3dac74cce2b 100644 --- a/source/_components/switch.rflink.markdown +++ b/source/_components/switch.rflink.markdown @@ -13,11 +13,11 @@ ha_category: ha_release: 0.38 --- -The `rflink` component supports devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example, the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver). +The `rflink` integration supports devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example, the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver). First, you have to set up your [RFLink hub](/components/rflink/). -The RFLink component does not know the difference between a `switch`, a `binary_sensor` and a `light`. Therefore all switchable devices are automatically added as `light` by default. +The RFLink integration does not know the difference between a `switch`, a `binary_sensor` and a `light`. Therefore all switchable devices are automatically added as `light` by default. RFLink binary_sensor/switch/light ID's are composed of: protocol, id, switch/channel. For example: `newkaku_0000c6c2_1`. diff --git a/source/_components/switch.rfxtrx.markdown b/source/_components/switch.rfxtrx.markdown index 900c7e76d1a..132380544dd 100644 --- a/source/_components/switch.rfxtrx.markdown +++ b/source/_components/switch.rfxtrx.markdown @@ -73,7 +73,7 @@ signal_repetitions: {% endconfiguration %}

-This component and the [rfxtrx binary sensor](/components/binary_sensor.rfxtrx/) can steal each other's devices when setting the `automatic_add` configuration parameter to `true`. Set `automatic_add` only when you have some devices to add to your installation, otherwise leave it to `false`. +This integration and the [rfxtrx binary sensor](/components/binary_sensor.rfxtrx/) can steal each other's devices when setting the `automatic_add` configuration parameter to `true`. Set `automatic_add` only when you have some devices to add to your installation, otherwise leave it to `false`.

diff --git a/source/_components/switch.template.markdown b/source/_components/switch.template.markdown index 32eaa1cf798..e9522ea69cb 100644 --- a/source/_components/switch.template.markdown +++ b/source/_components/switch.template.markdown @@ -19,7 +19,7 @@ The `template` platform creates switches that combines components. For example, if you have a garage door with a toggle switch that operates the motor and a sensor that allows you know whether the door is open or closed, you can combine these into a switch that knows whether the garage door is open or closed. -This can simplify the GUI and make it easier to write automations. You can mark the components you have combined as `hidden` so they don't appear themselves. +This can simplify the GUI and make it easier to write automations. You can mark the integrations you have combined as `hidden` so they don't appear themselves. ## {% linkable_title Configuration %} diff --git a/source/_components/switcher_kis.markdown b/source/_components/switcher_kis.markdown index 52772e11d13..d61e2024507 100644 --- a/source/_components/switcher_kis.markdown +++ b/source/_components/switcher_kis.markdown @@ -16,7 +16,7 @@ ha_release: 0.93 ha_iot_class: Local Push --- -This `Switcher` component allows you to control the [Switcher V2 Water Heater](https://www.switcher.co.il/). +This `Switcher` integration allows you to control the [Switcher V2 Water Heater](https://www.switcher.co.il/). To enable it, add an entry to your `configuration.yaml` according to the following configuration instructions. @@ -31,7 +31,7 @@ To retrieve your device's details, please follow the instructions [here](https:/

- Please note, on the original script repository, users recently reported difficulties controling the device after upgrading the firmware to the new 3.0 version.As this component is based on that script, please do not upgrade to version 3.0 until this issue is resolved. You can follow the issue [here](https://github.com/NightRang3r/Switcher-V2-Python/issues/3). + Please note, on the original script repository, users recently reported difficulties controling the device after upgrading the firmware to the new 3.0 version.As this integration is based on that script, please do not upgrade to version 3.0 until this issue is resolved. You can follow the issue [here](https://github.com/NightRang3r/Switcher-V2-Python/issues/3).

```yaml switcher_kis: diff --git a/source/_components/switchmate.markdown b/source/_components/switchmate.markdown index 202c794df46..1a67fff3fe9 100644 --- a/source/_components/switchmate.markdown +++ b/source/_components/switchmate.markdown @@ -44,4 +44,4 @@ flip_on_off: default: false {% endconfiguration %} -The component is tested with SwitchMate Lighting Control Rocker and SwitchMate Lighting Control Toggle. +The integration is tested with SwitchMate Lighting Control Rocker and SwitchMate Lighting Control Toggle. diff --git a/source/_components/synology.markdown b/source/_components/synology.markdown index d1a04f3390c..e82052fcb64 100644 --- a/source/_components/synology.markdown +++ b/source/_components/synology.markdown @@ -19,7 +19,7 @@ redirect_from: The `synology` camera platform allows you to watch the live streams of your [Synology](https://www.synology.com/) Surveillance Station based IP cameras in Home Assistant.

-Synology has disabled the livestreaming API and the component is currently broken if you are using Surveillance Station version 8.2.3-5828. +Synology has disabled the livestreaming API and the integration is currently broken if you are using Surveillance Station version 8.2.3-5828. There is an unsupported preview fix available. (8.2.3-5829) - Instructions can be found [here](https://www.vcloudinfo.com/2019/04/how-to-manually-upgrade-your-synology-surveillance-system-firmware.html) for updating manually.

diff --git a/source/_components/synology_srm.markdown b/source/_components/synology_srm.markdown index 6a01e496875..99e165d2737 100644 --- a/source/_components/synology_srm.markdown +++ b/source/_components/synology_srm.markdown @@ -67,4 +67,4 @@ List of models known to be supported: - RT1900ac - RT2600ac -See the [device tracker component page](/components/device_tracker/) for instructions on how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions on how to configure the people to be tracked. diff --git a/source/_components/system_health.markdown b/source/_components/system_health.markdown index e226efd2a16..5cd3ae314ca 100644 --- a/source/_components/system_health.markdown +++ b/source/_components/system_health.markdown @@ -1,7 +1,7 @@ --- layout: page title: "System Health" -description: "Systeam Health component will report system info and allow to run system diagnostics." +description: "Systeam Health integration will report system info and allow to run system diagnostics." date: 2019-02-06 13:40 sidebar: true comments: false @@ -14,11 +14,11 @@ ha_qa_scale: internal ha_release: 0.87 --- -The System Health component provides an API to offer information on the system and its components. It also allows to run diagnostic tools to diagnose problems. +The System Health integration provides an API to offer information on the system and its components. It also allows to run diagnostic tools to diagnose problems. Add the following to your configuration.yaml file. ```yaml system_health: ``` -Once added the system health component data can be viewed in the developer tools under service developer tool icon. +Once added the system health integration data can be viewed in the developer tools under service developer tool icon. diff --git a/source/_components/system_log.markdown b/source/_components/system_log.markdown index 3096336ea0f..3d9f143f8b2 100644 --- a/source/_components/system_log.markdown +++ b/source/_components/system_log.markdown @@ -14,11 +14,11 @@ ha_release: 0.58 ha_qa_scale: internal --- -The `system_log` component stores information about all logged errors and warnings in Home Assistant. All collected information is accessible directly in the frontend, just navigate to the `Info` section under `Developer Tools`. In order to not overload Home Assistant with log data, only the 50 last errors and warnings will be stored. Older entries are automatically discarded from the log. It is possible to change the number of stored log entries using the parameter `max_entries`. +The `system_log` integration stores information about all logged errors and warnings in Home Assistant. All collected information is accessible directly in the frontend, just navigate to the `Info` section under `Developer Tools`. In order to not overload Home Assistant with log data, only the 50 last errors and warnings will be stored. Older entries are automatically discarded from the log. It is possible to change the number of stored log entries using the parameter `max_entries`. ## {% linkable_title Configuration %} -This component is automatically loaded by the `frontend` (so no need to do anything if you are using the frontend). If you are not doing so, or if you wish to change a parameter, add the following section to your `configuration.yaml` file: +This integration is automatically loaded by the `frontend` (so no need to do anything if you are using the frontend). If you are not doing so, or if you wish to change a parameter, add the following section to your `configuration.yaml` file: ```yaml system_log: @@ -69,14 +69,14 @@ Errors and warnings are posted as the event `system_log_event`, so it is possibl Live examples of these events can be found in the Home Assistant log file (`home-assistant.log`) or by just looking in the system log. An example could, for instance, look like this: ```text -2019-02-14 16:20:35 ERROR (MainThread) [homeassistant.loader] Unable to find component system_healt +2019-02-14 16:20:35 ERROR (MainThread) [homeassistant.loader] Unable to find integration system_healt 2019-02-14 16:20:36 ERROR (MainThread) [homeassistant.components.device_tracker] Error setting up platform google_maps Traceback (most recent call last): File "/home/fab/Documents/repos/ha/home-assistant/homeassistant/components/device_tracker/__init__.py", line 184, in [...] ``` -The message ("Unable to find component system_healt"), source (`homeassistant.loader`) and level (`ERROR`) can easily be extracted from the log. The exact timestamp and if there is a stack trace that's shown as well. Here is another error caused by the `google_map` integration with additional output present. +The message ("Unable to find integration system_healt"), source (`homeassistant.loader`) and level (`ERROR`) can easily be extracted from the log. The exact timestamp and if there is a stack trace that's shown as well. Here is another error caused by the `google_map` integration with additional output present. ## {% linkable_title Examples %} diff --git a/source/_components/systemmonitor.markdown b/source/_components/systemmonitor.markdown index dff45f1b268..4e69be1c6b2 100644 --- a/source/_components/systemmonitor.markdown +++ b/source/_components/systemmonitor.markdown @@ -18,7 +18,7 @@ redirect_from: The `systemmonitor` sensor platform allows you to monitor disk usage, memory usage, CPU usage, and running processes. This platform has superseded the -process component which is now considered deprecated. +process integration which is now considered deprecated. To add this platform to your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/tado.markdown b/source/_components/tado.markdown index 733f48f215c..85a84abf7a1 100644 --- a/source/_components/tado.markdown +++ b/source/_components/tado.markdown @@ -21,7 +21,7 @@ redirect_from: - /components/sensor.tado/ --- -The `tado` component platform is used as an interface to the [my.tado.com](https://my.tado.com/webapp/#/account/sign-in) website. +The `tado` integration platform is used as an interface to the [my.tado.com](https://my.tado.com/webapp/#/account/sign-in) website. There is currently support for the following device types within Home Assistant: @@ -90,7 +90,7 @@ home_id: After configuration, your device has to be at home at least once before showing up as *home* or *away*. Polling Tado API for presence information will happen at most once every 30 seconds. -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. Beware that the Tado (v2) API does not provide GPS location of devices, only a bearing, therefore Home Assistant only uses `home`/`not-home` status. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. Beware that the Tado (v2) API does not provide GPS location of devices, only a bearing, therefore Home Assistant only uses `home`/`not-home` status. ### {% linkable_title Finding your `home_id` %} diff --git a/source/_components/tahoma.markdown b/source/_components/tahoma.markdown index bfb36124078..fc8d3ccdf7d 100644 --- a/source/_components/tahoma.markdown +++ b/source/_components/tahoma.markdown @@ -25,7 +25,7 @@ redirect_from: - /components/sensor.tahoma/ --- -The `Tahoma` component platform is used as an interface to the [tahomalink.com](https://www.tahomalink.com) website. It adds covers, scenes and a sun sensor from the Tahoma platform. +The `Tahoma` integration platform is used as an interface to the [tahomalink.com](https://www.tahomalink.com) website. It adds covers, scenes and a sun sensor from the Tahoma platform. There is currently support for the following device types within Home Assistant: diff --git a/source/_components/tcp.markdown b/source/_components/tcp.markdown index 025a7987375..fc2b05b5795 100644 --- a/source/_components/tcp.markdown +++ b/source/_components/tcp.markdown @@ -18,7 +18,7 @@ redirect_from: - /components/sensor.tcp/ --- -The TCP component allows the integration of some services for which a specific Home Assistant component does not exist. If the service communicates over a TCP socket with a simple request/reply mechanism then the chances are that this component will allow integration with it. +The TCP integration allows the integration of some services for which a specific Home Assistant integration does not exist. If the service communicates over a TCP socket with a simple request/reply mechanism then the chances are that this integration will allow integration with it. There is currently support for the following device types within Home Assistant: diff --git a/source/_components/telegram_bot.markdown b/source/_components/telegram_bot.markdown index 524977f5263..6d6ebbda8eb 100644 --- a/source/_components/telegram_bot.markdown +++ b/source/_components/telegram_bot.markdown @@ -16,7 +16,7 @@ ha_iot_class: Cloud Push Use Telegram on your mobile or desktop device to send and receive messages or commands to/from your Home Assistant. -This component creates notification services to send, or edit previously sent, messages from a [Telegram Bot account](https://core.telegram.org/bots) configured either with the [polling](/components/telegram_bot.polling/) method or with the [webhooks](/components/telegram_bot.webhooks/) one, and trigger events when receiving messages. +This integration creates notification services to send, or edit previously sent, messages from a [Telegram Bot account](https://core.telegram.org/bots) configured either with the [polling](/components/telegram_bot.polling/) method or with the [webhooks](/components/telegram_bot.webhooks/) one, and trigger events when receiving messages. If you don't need to receive messages, you can use the [broadcast](/components/telegram_bot.broadcast/) platform instead. @@ -172,7 +172,7 @@ Remove the bot from the chat group where it was added. ## {% linkable_title `telegram` notification platform %} -The [`telegram` notification platform](/components/notify.telegram/) requires the `telegram_bot` component to work with, and it's designed to generate a customized shortcut (`notify.USERNAME`) to send notifications (messages, photos, documents and locations) to a particular `chat_id` with the old syntax, allowing backward compatibility. +The [`telegram` notification platform](/components/notify.telegram/) requires the `telegram_bot` integration to work with, and it's designed to generate a customized shortcut (`notify.USERNAME`) to send notifications (messages, photos, documents and locations) to a particular `chat_id` with the old syntax, allowing backward compatibility. The required YAML configuration now reduces to: diff --git a/source/_components/tellduslive.markdown b/source/_components/tellduslive.markdown index 7e212988eed..a9ed21c4a03 100644 --- a/source/_components/tellduslive.markdown +++ b/source/_components/tellduslive.markdown @@ -27,13 +27,13 @@ redirect_from: - /components/switch.tellduslive/ --- -The `tellduslive` component let you connect to [Telldus Live](https://live.telldus.com). It's cloud platform that connects to your Tellstick Net or Tellstick ZNet connected gear at home. +The `tellduslive` integration let you connect to [Telldus Live](https://live.telldus.com). It's cloud platform that connects to your Tellstick Net or Tellstick ZNet connected gear at home.

If you are upgrading from 0.58 or older, you need to remove all Telldus configuration from your `configuration.yaml` file before continuing.

-Home Assistant will automatically discover the presence of a Tellstick Net or Tellstick ZNet on your local network if the [discovery]({{site_root}}/components/discovery/) component is enabled. When discovery and the key exchange with Telldus Live have been completed, you will be presented with an option to integrate with the cloud or local API for direct communication with your hardware in your LAN. Local API supports only one device at this stage. Local API is only supported with the Znet Lite products, the older hardware (such as Tellstick Net) does not support local API. +Home Assistant will automatically discover the presence of a Tellstick Net or Tellstick ZNet on your local network if the [discovery]({{site_root}}/components/discovery/) integration is enabled. When discovery and the key exchange with Telldus Live have been completed, you will be presented with an option to integrate with the cloud or local API for direct communication with your hardware in your LAN. Local API supports only one device at this stage. Local API is only supported with the Znet Lite products, the older hardware (such as Tellstick Net) does not support local API. ## {% linkable_title Configuration %} @@ -60,4 +60,4 @@ scan_interval: It is only possible to configure the `scan_interval` when setting up the device. If the polling interval needs to be changed after the device is configured it must be changed manually by changing `"scan_interval": 60,` for the device in the file `.storage/core.config_entries`.

-The component will offer configuration through the Home Assistant user interface where it will let you associate it with your Telldus Live account. +The integration will offer configuration through the Home Assistant user interface where it will let you associate it with your Telldus Live account. diff --git a/source/_components/tellstick.markdown b/source/_components/tellstick.markdown index 4742b96c093..ca4ebf4d6cb 100644 --- a/source/_components/tellstick.markdown +++ b/source/_components/tellstick.markdown @@ -23,7 +23,7 @@ redirect_from: - /components/switch.tellstick/ --- -The `tellstick` component integrates [TellStick](https://telldus.com/produkt/z-wave-gateway-tellstick-znet-lite-ver-2/) devices into Home Assistant. This integration allows users to add switches, lights, and sensors which are communicating with 433 MHz. There are a number of vendors (Capidi Elro, Intertechno, Nexa, Proove, Sartano, and Viking) who are selling products that work with TellStick. For more details, please check the TellStick [protocol list](http://developer.telldus.com/wiki/TellStick_conf). +The `tellstick` integration integrates [TellStick](https://telldus.com/produkt/z-wave-gateway-tellstick-znet-lite-ver-2/) devices into Home Assistant. This integration allows users to add switches, lights, and sensors which are communicating with 433 MHz. There are a number of vendors (Capidi Elro, Intertechno, Nexa, Proove, Sartano, and Viking) who are selling products that work with TellStick. For more details, please check the TellStick [protocol list](http://developer.telldus.com/wiki/TellStick_conf). There is currently support for the following device types within Home Assistant: diff --git a/source/_components/tensorflow.markdown b/source/_components/tensorflow.markdown index ee8c2680d73..9158668a7e2 100644 --- a/source/_components/tensorflow.markdown +++ b/source/_components/tensorflow.markdown @@ -19,7 +19,7 @@ redirect_from: The `tensorflow` image processing platform allows you to detect and recognize objects in a camera image using [TensorFlow](https://www.tensorflow.org/). The state of the entity is the number of objects detected, and recognized objects are listed in the `summary` attribute along with quantity. The `matches` attribute provides the confidence `score` for recognition and the bounding `box` of the object for each detection category.

- The following packages must be installed on Hassbian/Raspbian before following the setup for the component to work: + The following packages must be installed on Hassbian/Raspbian before following the setup for the integration to work: `$ sudo apt-get install libatlas-base-dev libopenjp2-7 libtiff5`

@@ -27,7 +27,7 @@ The `tensorflow` image processing platform allows you to detect and recognize ob You need to install the `tensorflow` Python packages with: `$ pip3 install tensorflow==1.11.0`. The wheel is not available for all platforms. See [the official install guide](https://www.tensorflow.org/install/) for other options. Hass.io is not yet supported but an addon is under development. -This component requires files to be downloaded, compiled on your computer, and added to the Home Assistant configuration directory. These steps can be performed using the sample script at [this gist](https://gist.github.com/hunterjm/6f9332f92b60c3d5e448ad936d7353c3). Alternatively, if you wish to perform the process manually, the process is as follows: +This integration requires files to be downloaded, compiled on your computer, and added to the Home Assistant configuration directory. These steps can be performed using the sample script at [this gist](https://gist.github.com/hunterjm/6f9332f92b60c3d5e448ad936d7353c3). Alternatively, if you wish to perform the process manually, the process is as follows: - Clone [tensorflow/models](https://github.com/tensorflow/models/tree/master/research/object_detection) - Compile protobuf models located in `research/object_detection/protos` with `protoc` @@ -83,7 +83,7 @@ source: required: false type: string file_out: - description: A [template](/docs/configuration/templating/#processing-incoming-data) for the component to save processed images including bounding boxes. `camera_entity` is available as the `entity_id` string of the triggered source camera. + description: A [template](/docs/configuration/templating/#processing-incoming-data) for the integration to save processed images including bounding boxes. `camera_entity` is available as the `entity_id` string of the triggered source camera. required: false type: list model: diff --git a/source/_components/tesla.markdown b/source/_components/tesla.markdown index c424f77acbe..77c0282708b 100644 --- a/source/_components/tesla.markdown +++ b/source/_components/tesla.markdown @@ -27,9 +27,9 @@ redirect_from: - /components/switch.tesla/ --- -The `Tesla` component offers integration with the [Tesla](https://auth.tesla.com/login) cloud service and provides presence detection as well as sensors such as charger state and temperature. +The `Tesla` integration offers integration with the [Tesla](https://auth.tesla.com/login) cloud service and provides presence detection as well as sensors such as charger state and temperature. -This component provides the following platforms: +This integration provides the following platforms: - Binary sensors - such as parking and charger connection. - Sensors - such as Battery level, Inside/Outside temperature, odometer, and estimated range. diff --git a/source/_components/tfiac.markdown b/source/_components/tfiac.markdown index f0d1e330dfa..60e205f74e2 100644 --- a/source/_components/tfiac.markdown +++ b/source/_components/tfiac.markdown @@ -16,7 +16,7 @@ redirect_from: - /components/climate.tfiac/ --- -The `tfiac` component integrates several vendors air conditioning systems, that uses the Tfiac mobile app, into Home Assistant. App currently available at [Play Store](https://play.google.com/store/apps/details?id=com.tcl.export) and [App Store](https://itunes.apple.com/app/tfiac/id1059938398). +The `tfiac` integration integrates several vendors air conditioning systems, that uses the Tfiac mobile app, into Home Assistant. App currently available at [Play Store](https://play.google.com/store/apps/details?id=com.tcl.export) and [App Store](https://itunes.apple.com/app/tfiac/id1059938398). ## {% linkable_title Configuration %} diff --git a/source/_components/thethingsnetwork.markdown b/source/_components/thethingsnetwork.markdown index 320236003b0..fac90be48ba 100644 --- a/source/_components/thethingsnetwork.markdown +++ b/source/_components/thethingsnetwork.markdown @@ -17,7 +17,7 @@ redirect_from: - /components/sensor.thethingsnetwork/ --- -The `thethingsnetwork` component allows one to interact with the [The Things Network](https://www.thethingsnetwork.org). This community-driven and open network supports [LoRaWAN](https://www.lora-alliance.org/) for long range (~5 to 15km) communication with a low bandwidth (51 bytes/message). [Gateways](https://www.thethingsnetwork.org/docs/gateways/) transfers the received data from the sensors to the The Things Network. +The `thethingsnetwork` integration allows one to interact with the [The Things Network](https://www.thethingsnetwork.org). This community-driven and open network supports [LoRaWAN](https://www.lora-alliance.org/) for long range (~5 to 15km) communication with a low bandwidth (51 bytes/message). [Gateways](https://www.thethingsnetwork.org/docs/gateways/) transfers the received data from the sensors to the The Things Network. The Things network support various integrations to make the data available: diff --git a/source/_components/thingspeak.markdown b/source/_components/thingspeak.markdown index d8864c4d2d3..340df13334f 100644 --- a/source/_components/thingspeak.markdown +++ b/source/_components/thingspeak.markdown @@ -13,14 +13,14 @@ ha_category: ha_release: 0.32 --- -The `thingspeak` components makes Home Assistant communicate with the [ThingSpeak API](https://thingspeak.com/). +The `thingspeak` integrations makes Home Assistant communicate with the [ThingSpeak API](https://thingspeak.com/). For now, it records exactly one entity at once, which is great for testing purposes. For long-time storage you should rely on the [InfluxDB component](/components/influxdb/). ## {% linkable_title Configuration %} You will have to create a [new channel](https://thingspeak.com/channels/new) on ThingSpeak and grab your Write API Key from the "API Keys" tab of the channel you want to use. -To setup the ThingSpeak component in your installation, add the following to your `configuration.yaml` file: +To setup the ThingSpeak integration in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/thomson.markdown b/source/_components/thomson.markdown index 3eca5dd99bc..4eea5e8d68d 100644 --- a/source/_components/thomson.markdown +++ b/source/_components/thomson.markdown @@ -46,4 +46,4 @@ password: type: string {% endconfiguration %} -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. diff --git a/source/_components/tibber.markdown b/source/_components/tibber.markdown index 70af502cd8f..c9a7316eaf0 100644 --- a/source/_components/tibber.markdown +++ b/source/_components/tibber.markdown @@ -20,7 +20,7 @@ redirect_from: - /components/sensor.tibber/ --- -The `tibber` component provides a sensor with the current electricity price if you are a [Tibber](https://tibber.com/) customer. +The `tibber` integration provides a sensor with the current electricity price if you are a [Tibber](https://tibber.com/) customer. If you have a [Tibber Pulse](https://norge.tibber.com/products/pulse/) or [Watty](https://watty.io/) it will also show the electricity consumption in real time. There is currently support for the following device types within Home Assistant: diff --git a/source/_components/timer.markdown b/source/_components/timer.markdown index 6e214503133..f8280aa096f 100644 --- a/source/_components/timer.markdown +++ b/source/_components/timer.markdown @@ -14,7 +14,7 @@ ha_release: 0.57 ha_qa_scale: internal --- -The `timer` component aims to simplify automations based on (dynamic) durations. +The `timer` integration aims to simplify automations based on (dynamic) durations. When a timer finishes or gets canceled the corresponding events are fired. This allows you to differentiate if a timer has switched from `active` to `idle` because the given duration has elapsed or it has been canceled. To control timers in your automations you can use the services mentioned below. When calling the `start` service on a timer that is already running, it resets the duration it will need to finish and restart the timer without triggering a canceled or finished event. This, for example, makes it easy to create timed lights that get triggered by motion. Starting a timer triggers a started event unless the timer is paused, in that case, it triggers a restarted event. @@ -154,7 +154,7 @@ timer: ### {% linkable_title Control a timer manually %} -With the [`script`](/components/script/) component you would be able to control a timer (see above for a `timer` configuration sample) manually. +With the [`script`](/components/script/) integration you would be able to control a timer (see above for a `timer` configuration sample) manually. ```yaml script: diff --git a/source/_components/tod.markdown b/source/_components/tod.markdown index 1443df092da..6b97736c7dd 100644 --- a/source/_components/tod.markdown +++ b/source/_components/tod.markdown @@ -67,7 +67,7 @@ after_offset: ## {% linkable_title Considerations %} -The primary purpose of this sensor is to use a simple time range definition instead of creating a complex template with references to `sun.sun` component attributes. +The primary purpose of this sensor is to use a simple time range definition instead of creating a complex template with references to `sun.sun` integration attributes. The sensor state is ON when this condition `after` + `after_offset` <= `current time` < `before` + `before_offset`. diff --git a/source/_components/todoist.markdown b/source/_components/todoist.markdown index bf27c18791c..979718e761a 100644 --- a/source/_components/todoist.markdown +++ b/source/_components/todoist.markdown @@ -111,7 +111,7 @@ Home Assistant does its best to [determine what task in each project is "most" i - **location**: Not used. - - **start_time**: The last time the Todoist component got updated. Usually within the last 15 minutes. + - **start_time**: The last time the Todoist integration got updated. Usually within the last 15 minutes. - **end_time**: When the task is due. diff --git a/source/_components/tomato.markdown b/source/_components/tomato.markdown index 14d08f2847f..5498a025875 100644 --- a/source/_components/tomato.markdown +++ b/source/_components/tomato.markdown @@ -70,7 +70,7 @@ http_id: type: string {% endconfiguration %} -See the [device tracker component page](/components/device_tracker/) for +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. A description of the API s available in this diff --git a/source/_components/toon.markdown b/source/_components/toon.markdown index 3a72312b636..f09880dfc68 100644 --- a/source/_components/toon.markdown +++ b/source/_components/toon.markdown @@ -21,9 +21,9 @@ redirect_from: - /components/switch.toon/ --- -The `toon` component platform can be used to control your Toon thermostat. This component adds a climate device for your Toon thermostat, sensors for power and gas consumption, sensors for solar production and several binary sensors for things like boiler burner on/off, hot tap water and boiler health status. +The `toon` integration platform can be used to control your Toon thermostat. This integration adds a climate device for your Toon thermostat, sensors for power and gas consumption, sensors for solar production and several binary sensors for things like boiler burner on/off, hot tap water and boiler health status. -For the `toon` component to work, you'll need an active Toon subscription with Eneco and a Toon API developer account. +For the `toon` integration to work, you'll need an active Toon subscription with Eneco and a Toon API developer account. There is currently support for the following device types within Home Assistant: @@ -43,7 +43,7 @@ In order to be able to use this component, you'll need to sign up for a free Too 4. Click on "Create App" to complete the creation process. 5. Open the "[My Apps](https://developer.toon.eu/user/me/apps)" page again and click on the app that you've just created. 6. You need the codes now shown: "Consumer Key" and "Consumer Secret". -7. Add the Toon component to your `configuration.yaml` and restart Home Assistant. Then, go to `Configuration > Integrations` and select `CONFIGURE` next to Toon and follow the setup instructions. +7. Add the Toon integration to your `configuration.yaml` and restart Home Assistant. Then, go to `Configuration > Integrations` and select `CONFIGURE` next to Toon and follow the setup instructions. ## {% linkable_title Configuration %} diff --git a/source/_components/tplink.markdown b/source/_components/tplink.markdown index 57a1353ad92..158c2969e8c 100644 --- a/source/_components/tplink.markdown +++ b/source/_components/tplink.markdown @@ -21,7 +21,7 @@ redirect_from: - /components/device_tracker.tplink/ --- -The `tplink` component allows you to control your [TP-Link Smart Home Devices](https://www.tp-link.com/kasa-smart/) such as smart plugs and smart bulbs. +The `tplink` integration allows you to control your [TP-Link Smart Home Devices](https://www.tp-link.com/kasa-smart/) such as smart plugs and smart bulbs. There is currently support for the following device types within Home Assistant: @@ -34,7 +34,7 @@ The supported devices in your network are automatically discovered, but if you w ## {% linkable_title Supported Devices %} -This component supports devices that are controllable with the [KASA app](https://www.tp-link.com/us/kasa-smart/kasa.html). +This integration supports devices that are controllable with the [KASA app](https://www.tp-link.com/us/kasa-smart/kasa.html). The following devices are known to work with this component. ### {% linkable_title Plugs %} @@ -153,7 +153,7 @@ Currently supported devices includes the following: - Archer D9 firmware version 0.9.1 0.1 v0041.0 Build 160224 Rel.59129n

-TP-Link devices typically only allow one login at a time to the admin console. This component will count towards your one allowed login. Depending on how aggressively you configure device_tracker you may not be able to access the admin console of your TP-Link device without first stopping Home Assistant. Home Assistant takes a few seconds to login, collect data, and log out. If you log into the admin console manually, remember to log out so that Home Assistant can log in again. +TP-Link devices typically only allow one login at a time to the admin console. This integration will count towards your one allowed login. Depending on how aggressively you configure device_tracker you may not be able to access the admin console of your TP-Link device without first stopping Home Assistant. Home Assistant takes a few seconds to login, collect data, and log out. If you log into the admin console manually, remember to log out so that Home Assistant can log in again.

### {% linkable_title Configuration %} @@ -193,6 +193,6 @@ For Archer C9 models running firmware version 150811 or later please use the enc 5. Type `document.getElementById("login-password").value;` or `document.getElementById("pcPassword").value;`, depending on your firmware version. 6. Copy the returned value to your Home Assistant configuration as password. -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. For Archer D9 model the default ip is 192.168.1.1, the username is not necessary and you can leave that field blank. \ No newline at end of file diff --git a/source/_components/tradfri.markdown b/source/_components/tradfri.markdown index bc7307031c7..9718779da0f 100644 --- a/source/_components/tradfri.markdown +++ b/source/_components/tradfri.markdown @@ -22,7 +22,7 @@ redirect_from: - /components/switch.tradfri/ --- -The `tradfri` component support the IKEA Trådfri Gateway (a.k.a. IKEA Tradfri hub/bridge). The gateway can control compatible Zigbee-based lights (certified ZigBee Light Link products) connected to it and Home Assistant will automatically discover the gateways presence on your local network, if `discovery:` is present in your `configuration.yaml` file. +The `tradfri` integration support the IKEA Trådfri Gateway (a.k.a. IKEA Tradfri hub/bridge). The gateway can control compatible Zigbee-based lights (certified ZigBee Light Link products) connected to it and Home Assistant will automatically discover the gateways presence on your local network, if `discovery:` is present in your `configuration.yaml` file. You will be prompted to configure the gateway through the Home Assistant interface. The configuration process is very simple, when prompted, enter the security key printed on the physical sticker that is on the bottom of the IKEA Trådfri Gateway, then click configure. diff --git a/source/_components/transmission.markdown b/source/_components/transmission.markdown index e9bdc1d9a12..2e4bdc463dd 100644 --- a/source/_components/transmission.markdown +++ b/source/_components/transmission.markdown @@ -19,7 +19,7 @@ redirect_from: - /components/sensor.transmission/ --- -The `transmission` component allows you to monitor your downloads with [Transmission](http://www.transmissionbt.com/) from within Home Assistant and setup automation based on the information. +The `transmission` integration allows you to monitor your downloads with [Transmission](http://www.transmissionbt.com/) from within Home Assistant and setup automation based on the information. ## {% linkable_title Setup %} @@ -100,7 +100,7 @@ monitored_conditions: ## {% linkable_title Event Automation %} -The Transmission component is continuously monitoring the status of torrents in the target client. Once a torrent is started or completed, an event is triggered on the Home Assistant Bus, which allows to implement any kind of automation. +The Transmission integration is continuously monitoring the status of torrents in the target client. Once a torrent is started or completed, an event is triggered on the Home Assistant Bus, which allows to implement any kind of automation. Possible events are: diff --git a/source/_components/tts.markdown b/source/_components/tts.markdown index 85b775d1ba9..b58fe8bcd43 100644 --- a/source/_components/tts.markdown +++ b/source/_components/tts.markdown @@ -26,7 +26,7 @@ tts: Depending on your setup, you might need to set a base URL (`base_url`) inside the [http component](/components/http/) or in the parameters of this component.

-The following optional parameters can be used with any platform. However, the TTS component will only look for global settings under the configuration of the first configured platform: +The following optional parameters can be used with any platform. However, the TTS integration will only look for global settings under the configuration of the first configured platform: {% configuration %} cache: @@ -139,7 +139,7 @@ data_template: ## {% linkable_title Cache %} -The component has two caches. Both caches can be controlled with the `cache` option in the platform configuration or the service call `say`. A long time cache will be located on the file system. The in-memory cache for fast responses to media players will be auto-cleaned after a short period. +The integration has two caches. Both caches can be controlled with the `cache` option in the platform configuration or the service call `say`. A long time cache will be located on the file system. The in-memory cache for fast responses to media players will be auto-cleaned after a short period. ## {% linkable_title REST Api %} diff --git a/source/_components/tuya.markdown b/source/_components/tuya.markdown index ddb2840d330..7a0cea9e949 100644 --- a/source/_components/tuya.markdown +++ b/source/_components/tuya.markdown @@ -27,7 +27,7 @@ redirect_from: - /components/switch.tuya/ --- -The `tuya` component is the main component to integrate all [Tuya Smart](https://www.tuya.com) related platforms. You will need your Tuya account information (username, password and account country code) to discover and control devices which related to your account. +The `tuya` integration is the main integration to integrate all [Tuya Smart](https://www.tuya.com) related platforms. You will need your Tuya account information (username, password and account country code) to discover and control devices which related to your account. There is currently support for the following device types within Home Assistant: diff --git a/source/_components/twilio.markdown b/source/_components/twilio.markdown index 2485193b7d6..445fea0a2d2 100644 --- a/source/_components/twilio.markdown +++ b/source/_components/twilio.markdown @@ -13,14 +13,14 @@ ha_category: ha_release: "0.40" --- -The `twilio` component enables the sending of notifications via SMS and the creation of calls with [Twilio](https://twilio.com). +The `twilio` integration enables the sending of notifications via SMS and the creation of calls with [Twilio](https://twilio.com). A free trial account is available at [Twilio](https://twilio.com) website providing free calls to verified phone numbers. Calls are limited to 10 minutes and will play a short trial message before your message runs. Upgraded accounts have no limitation. ## {% linkable_title Configuration %} -To use this notification component in your installation, add the following to your `configuration.yaml` file: +To use this notification integration in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -42,9 +42,9 @@ auth_token: ### {% linkable_title Usage %} -After configuring the base Twilio component, add and configure either or both of the [twilio SMS](/components/notify.twilio_sms/) and [twilio Phone](/components/notify.twilio_call) components to utilize the notification functionality. +After configuring the base Twilio component, add and configure either or both of the [twilio SMS](/components/notify.twilio_sms/) and [twilio Phone](/components/notify.twilio_call) integrations to utilize the notification functionality. -To be able to receive events from Twilio, your Home Assistant instance needs to be accessible from the web ([Hass.io instructions](/addons/duckdns/)) and you need to have the `base_url` configured for the HTTP component ([docs](/components/http/#base_url)). +To be able to receive events from Twilio, your Home Assistant instance needs to be accessible from the web ([Hass.io instructions](/addons/duckdns/)) and you need to have the `base_url` configured for the HTTP integration ([docs](/components/http/#base_url)). To set it up, go to the integrations page in the configuration screen and find Twilio. Click on configure. Follow the instructions on the screen to configure Twilio. diff --git a/source/_components/ubee.markdown b/source/_components/ubee.markdown index 98033d9a96d..c547d0340a1 100644 --- a/source/_components/ubee.markdown +++ b/source/_components/ubee.markdown @@ -56,8 +56,8 @@ Supported models: - EVW3226@UPC

-This component uses pyUbee library, which was tested with models listed above. If you have different model of Ubee Router and it doesn't work with this component, please create pyUbee issue to request for support for your model. +This integration uses pyUbee library, which was tested with models listed above. If you have different model of Ubee Router and it doesn't work with this component, please create pyUbee issue to request for support for your model.

By default, Home Assistant pulls information about connected devices from Ubee router every 5 seconds. -See the [device tracker component page](/components/device_tracker/) for instructions on how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions on how to configure the people to be tracked. diff --git a/source/_components/ubus.markdown b/source/_components/ubus.markdown index 0a637ff158a..11871723c38 100644 --- a/source/_components/ubus.markdown +++ b/source/_components/ubus.markdown @@ -92,7 +92,7 @@ dhcp_software: type: string {% endconfiguration %} -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. ## {% linkable_title Troubleshooting %} @@ -186,7 +186,7 @@ Connection: keep-alive {"jsonrpc":"2.0","id":1,"result":{}} ``` -11. In this case we are actually receiving a valid response with no data. The request says that we are looking for ARP information from `hostapd.*`, which is the access point on the router. In my environment I don't use the AP on the router, and so it was correctly returning no data. Armed with this information, I know that I cannot use this component for device tracking or presence. +11. In this case we are actually receiving a valid response with no data. The request says that we are looking for ARP information from `hostapd.*`, which is the access point on the router. In my environment I don't use the AP on the router, and so it was correctly returning no data. Armed with this information, I know that I cannot use this integration for device tracking or presence. ### {% linkable_title Cleanup %} diff --git a/source/_components/unifi.markdown b/source/_components/unifi.markdown index 2be321f9cc2..f193cb2f6b0 100644 --- a/source/_components/unifi.markdown +++ b/source/_components/unifi.markdown @@ -34,9 +34,9 @@ Home Assistant offers UniFi integration through **Configuration** -> **Integrati Enter `host address`, `user name` and `password` and then continue to select which `site` you want to connect to Home Assistant. The user must have administrator privileges. -## {% linkable_title Debugging component %} +## {% linkable_title Debugging integration %} -If you have problems with UniFi or the component you can add debug prints to the log. +If you have problems with UniFi or the integration you can add debug prints to the log. ```yaml logger: @@ -112,7 +112,7 @@ monitored_conditions: {% endconfiguration %} -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. ### {% linkable_title Configuring Users %} @@ -120,7 +120,7 @@ The Unifi controller allows you to create multiple users on it besides the main ### {% linkable_title Conflicts with MQTT %} -The Unifi controller can either be a dedicated hardware device (Unifi's cloud key), or as software any Linux system. If you run the Unifi controller on the same operating system as Home Assistant there may be conflicts in ports if you have the MQTT component as well. +The Unifi controller can either be a dedicated hardware device (Unifi's cloud key), or as software any Linux system. If you run the Unifi controller on the same operating system as Home Assistant there may be conflicts in ports if you have the MQTT integration as well. It is recommended that you run the Unifi controller in a dedicated virtual machine to avoid that situation. diff --git a/source/_components/unifi_direct.markdown b/source/_components/unifi_direct.markdown index 3f3335b46bd..7dcd0fa5727 100644 --- a/source/_components/unifi_direct.markdown +++ b/source/_components/unifi_direct.markdown @@ -45,5 +45,5 @@ password: type: string {% endconfiguration %} -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. diff --git a/source/_components/upc_connect.markdown b/source/_components/upc_connect.markdown index 7a9a36fed15..e4adaf756ac 100644 --- a/source/_components/upc_connect.markdown +++ b/source/_components/upc_connect.markdown @@ -34,7 +34,7 @@ host: type: string {% endconfiguration %} -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. Also known to be working with the following devices: - Irish Virgin Media Super Hub 3.0 diff --git a/source/_components/upcloud.markdown b/source/_components/upcloud.markdown index 517f2ed39d3..e592650e94b 100644 --- a/source/_components/upcloud.markdown +++ b/source/_components/upcloud.markdown @@ -19,7 +19,7 @@ redirect_from: - /components/switch.upcloud/ --- -The `upcloud` component allows you to access the information about your [UpCloud](https://www.upcloud.com/) servers from Home Assistant. +The `upcloud` integration allows you to access the information about your [UpCloud](https://www.upcloud.com/) servers from Home Assistant. There is currently support for the following device types within Home Assistant: diff --git a/source/_components/updater.markdown b/source/_components/updater.markdown index 17453c0308d..6571e89c043 100644 --- a/source/_components/updater.markdown +++ b/source/_components/updater.markdown @@ -14,9 +14,9 @@ ha_qa_scale: internal ha_release: 0.8 --- -The `updater` component will check daily for new releases. It will show a badge in the frontend if a new version is found. As [Hass.io](/hassio/) has its own schedule for release it doesn't make sense to use this component on Hass.io. +The `updater` integration will check daily for new releases. It will show a badge in the frontend if a new version is found. As [Hass.io](/hassio/) has its own schedule for release it doesn't make sense to use this integration on Hass.io. -The updater component will also collect basic information about the running Home Assistant instance and its environment. The information includes the current Home Assistant version, the time zone, Python version and operating system information. No identifiable information (i.e., IP address, GPS coordinates, etc.) will ever be collected. If you are concerned about your privacy, you are welcome to scrutinize the Python [source code](https://github.com/home-assistant/home-assistant/blob/dev/homeassistant/components/updater.py#L91). +The updater integration will also collect basic information about the running Home Assistant instance and its environment. The information includes the current Home Assistant version, the time zone, Python version and operating system information. No identifiable information (i.e., IP address, GPS coordinates, etc.) will ever be collected. If you are concerned about your privacy, you are welcome to scrutinize the Python [source code](https://github.com/home-assistant/home-assistant/blob/dev/homeassistant/components/updater.py#L91). ## {% linkable_title Configuration %} @@ -33,7 +33,7 @@ reporting: type: boolean default: true include_used_components: - description: Whether or not to report the components that you are using in Home Assistant. + description: Whether or not to report the integrations that you are using in Home Assistant. required: false type: boolean default: false @@ -41,7 +41,7 @@ include_used_components: For further information about the Updater's data, please check the [detailed overview](/docs/backend/updater/). If you choose not to share any information when checking for updates, you can set `reporting: false`. -It is possible to report the components that you are using to the Home Assistant developers. This will help them focus on improving the popular ones. To enable this option, you have to add `include_used_components: true`. +It is possible to report the integrations that you are using to the Home Assistant developers. This will help them focus on improving the popular ones. To enable this option, you have to add `include_used_components: true`. ```json "components": [ @@ -60,7 +60,7 @@ It is possible to report the components that you are using to the Home Assistant ## {% linkable_title Notification %} -For an added bonus, an automation component can be created to send a message with a notifier when that state of this component's entity changes. +For an added bonus, an automation integration can be created to send a message with a notifier when that state of this component's entity changes. ```yaml # Example configuration.yaml entry diff --git a/source/_components/upnp.markdown b/source/_components/upnp.markdown index d26f55aace7..117f9014af4 100644 --- a/source/_components/upnp.markdown +++ b/source/_components/upnp.markdown @@ -17,7 +17,7 @@ redirect_from: - /components/sensor.upnp/ --- -The `upnp` component enables you to collect network statistics from your router such as bytes in/out and packets in/out. This information is provided by the [UPnP](https://en.wikipedia.org/wiki/Universal_Plug_and_Play)/[Internet Gateway Device (IGD) Protocol](https://en.wikipedia.org/wiki/Internet_Gateway_Device_Protocol) if enabled on your router. +The `upnp` integration enables you to collect network statistics from your router such as bytes in/out and packets in/out. This information is provided by the [UPnP](https://en.wikipedia.org/wiki/Universal_Plug_and_Play)/[Internet Gateway Device (IGD) Protocol](https://en.wikipedia.org/wiki/Internet_Gateway_Device_Protocol) if enabled on your router. The IGD can automatically create port forwarding mappings on your router for Home Assistant, exposing your installation to the internet. The mapping will never automatically expire. Upon stopping Home Assistant, the mapping will be removed from your router. @@ -25,7 +25,7 @@ There is currently support for the following device types within Home Assistant: - **Sensor** - Allows to get the network statistics from your router such as bytes in/out and packets in/out. -Please note that UPnP or NAT-PMP needs to be enabled on your router for this component to work. +Please note that UPnP or NAT-PMP needs to be enabled on your router for this integration to work. ## {% linkable_title Configuration %} @@ -44,12 +44,12 @@ With the default settings only the sensors are added for statistics. If you wish {% configuration %} port_mapping: - description: If the component should try to map ports. + description: If the integration should try to map ports. required: false type: boolean default: false sensors: - description: If the component should enable the UPNP sensors. + description: If the integration should enable the UPNP sensors. required: false type: boolean default: true diff --git a/source/_components/uscis.markdown b/source/_components/uscis.markdown index 3fe075065a1..2e9b5e97ba1 100644 --- a/source/_components/uscis.markdown +++ b/source/_components/uscis.markdown @@ -16,7 +16,7 @@ redirect_from: - /components/sensor.uscis/ --- -The `uscis` sensor component allows you get updates on your USCIS case using your case/receipt number. The sensor gets the case information from [USCIS Website]( https://egov.uscis.gov/casestatus/landing.do) +The `uscis` sensor integration allows you get updates on your USCIS case using your case/receipt number. The sensor gets the case information from [USCIS Website]( https://egov.uscis.gov/casestatus/landing.do) ## {% linkable_title Configuration %} diff --git a/source/_components/usps.markdown b/source/_components/usps.markdown index 76773a005f1..5c32f23119e 100644 --- a/source/_components/usps.markdown +++ b/source/_components/usps.markdown @@ -29,14 +29,14 @@ There is currently support for the following device types within Home Assistant: ## {% linkable_title Prerequisites %} -This component requires that a headless-capable web browser is installed on your system - either PhantomJS or Google Chrome. Preferably use Chrome if your operating system supports it, since PhantomJS is deprecated. +This integration requires that a headless-capable web browser is installed on your system - either PhantomJS or Google Chrome. Preferably use Chrome if your operating system supports it, since PhantomJS is deprecated.

If you are using a Raspberry Pi, you must use PhantomJS.

-Hass.io containers are based on Alpine Linux. PhantomJS is not available for Alpine Linux. Therefore it is currently not possible to use this component on Hass.io. +Hass.io containers are based on Alpine Linux. PhantomJS is not available for Alpine Linux. Therefore it is currently not possible to use this integration on Hass.io.

### {% linkable_title PhantomJS %} @@ -100,7 +100,7 @@ The USPS sensor logs into the MyUSPS website to scrape package data. It does not ## {% linkable_title Camera %} -The `usps` camera component allows you to view the mail piece images made available through USPS via the Informed Delivery service. You must "Opt-In" to [Informed Delivery](https://informeddelivery.usps.com/box/pages/intro/start.action) to see mail images. This works in concert with [USPS sensors](#sensor). +The `usps` camera integration allows you to view the mail piece images made available through USPS via the Informed Delivery service. You must "Opt-In" to [Informed Delivery](https://informeddelivery.usps.com/box/pages/intro/start.action) to see mail images. This works in concert with [USPS sensors](#sensor). ### {% linkable_title Configuration %} @@ -113,10 +113,10 @@ camera: scan_interval: 5 ``` -To enable this camera in your installation, set up the USPS component first. +To enable this camera in your installation, set up the USPS integration first. ## {% linkable_title Sensor %} -The `usps` sensor component allows you to view statistics on incoming mail and packages made available through USPS via the Informed Delivery service. You must "Opt-In" to [Informed Delivery](https://informeddelivery.usps.com/box/pages/intro/start.action) to see mail images. This works in concert with [USPS camera](#camera). +The `usps` sensor integration allows you to view statistics on incoming mail and packages made available through USPS via the Informed Delivery service. You must "Opt-In" to [Informed Delivery](https://informeddelivery.usps.com/box/pages/intro/start.action) to see mail images. This works in concert with [USPS camera](#camera). -To enable this sensor in your installation, set up the USPS component first. +To enable this sensor in your installation, set up the USPS integration first. diff --git a/source/_components/utility_meter.markdown b/source/_components/utility_meter.markdown index 509c03984dc..6f305cc76c7 100644 --- a/source/_components/utility_meter.markdown +++ b/source/_components/utility_meter.markdown @@ -15,14 +15,14 @@ logo: energy_meter.png ha_qa_scale: internal --- -The `utility meter` component provides functionality to track consumptions of various utilities (e.g., energy, gas, water, heating). +The `utility meter` integration provides functionality to track consumptions of various utilities (e.g., energy, gas, water, heating). From a user perspective, utility meters operate in cycles (usually monthly) for billing purposes. This sensor will track a source sensor values, automatically resetting the meter based on the configured cycle. On reset an attribute will store the previous meter value, providing the means for comparison operations (e.g., "did I spend more or less this month?") or billing estimation (e.g., through a sensor template that multiplies the metered value per the charged unit amount). Some utility providers have different tariffs according to time/resource availability/etc. The utility meter enables you to define the various tariffs supported by your utility provider and accounts your consumptions in accordance. When tariffs are defined a new entity will show up indicating the current tariff. In order to change the tariff, the user must call a service, usually through an automation that can be based in time or other external source (eg. a REST sensor).

-Sensors created with this component are persistent, so values are retained across restarts of home assistant. The first cycle for each sensor, will be incomplete; a sensor tracking daily usage, will start to be accurate the next day after the component was activated. A sensor tracking monthly usage, will present accurate data starting the first of the next month after being added to home assistant. +Sensors created with this integration are persistent, so values are retained across restarts of home assistant. The first cycle for each sensor, will be incomplete; a sensor tracking daily usage, will start to be accurate the next day after the integration was activated. A sensor tracking monthly usage, will present accurate data starting the first of the next month after being added to home assistant.

## {% linkable_title Configuration %} diff --git a/source/_components/vacuum.markdown b/source/_components/vacuum.markdown index 2a5da6f3263..db3c85f6399 100644 --- a/source/_components/vacuum.markdown +++ b/source/_components/vacuum.markdown @@ -10,11 +10,11 @@ footer: true ha_release: 0.51 --- -The `vacuum` component enables the ability to control home cleaning robots within Home Assistant. +The `vacuum` integration enables the ability to control home cleaning robots within Home Assistant. ## {% linkable_title Configuration %} -To use this component in your installation, add a `vacuum` platform to your `configuration.yaml` file, like the [Xiaomi](/components/vacuum.xiaomi_miio/). +To use this integration in your installation, add a `vacuum` platform to your `configuration.yaml` file, like the [Xiaomi](/components/vacuum.xiaomi_miio/). ```yaml # Example configuration.yaml entry diff --git a/source/_components/vacuum.mqtt.markdown b/source/_components/vacuum.mqtt.markdown index c02f97422c2..7a0bc6680e7 100644 --- a/source/_components/vacuum.mqtt.markdown +++ b/source/_components/vacuum.mqtt.markdown @@ -13,7 +13,7 @@ ha_category: ha_release: 0.54 --- -The `mqtt` vacuum component allows you to control your MQTT-enabled vacuum. +The `mqtt` vacuum integration allows you to control your MQTT-enabled vacuum. There are 2 possible message schemas - `legacy` and `state`. New installation should use `state` schema as `legacy` is deprecated and might be removed someday in the future. `state` schema is preferred because the vacuum will then be represented as a `StateVacuumDevice` which is preferred parent vacuum entity. @@ -228,7 +228,7 @@ vacuum: ## {% linkable_title Legacy MQTT Protocol %} -The above configuration for this component expects an MQTT protocol like the following. +The above configuration for this integration expects an MQTT protocol like the following. ### {% linkable_title Legacy Basic Commands %} @@ -399,7 +399,7 @@ vacuum: ## {% linkable_title State MQTT Protocol %} -The above configuration for this component expects an MQTT protocol like the following. +The above configuration for this integration expects an MQTT protocol like the following. ### {% linkable_title State Basic Commands %} @@ -475,7 +475,7 @@ State has to be one of vacuum states supported by Home Assistant: ## {% linkable_title Shared MQTT Protocol %} -The configuration for this component expects an MQTT protocol like the following. +The configuration for this integration expects an MQTT protocol like the following. These services are identical for both - legacy and state vacuum. ### {% linkable_title Set Fan Speed %} @@ -527,7 +527,7 @@ MQTT topic: `vacuum/send_command` ### {% linkable_title Usage with cloudless Xiaomi vacuums %} -This component is supported by the cloud-free Xiaomi Vacuum Webinterface [Valetudo](https://github.com/Hypfer/Valetudo). +This integration is supported by the cloud-free Xiaomi Vacuum Webinterface [Valetudo](https://github.com/Hypfer/Valetudo). ### {% linkable_title Retrofitting a non-wifi vacuums %} diff --git a/source/_components/vacuum.xiaomi_miio.markdown b/source/_components/vacuum.xiaomi_miio.markdown index 750b8d12e1b..6f4d7787de5 100644 --- a/source/_components/vacuum.xiaomi_miio.markdown +++ b/source/_components/vacuum.xiaomi_miio.markdown @@ -60,7 +60,7 @@ name: ## {% linkable_title Platform Services %} -In addition to all of the services provided by the `vacuum` component (`start`, `pause`, `stop`, `return_to_base`, `locate`, `set_fan_speed` and `send_command`), the `xiaomi` platform introduces specific services to access the remote control mode of the robot. These are: +In addition to all of the services provided by the `vacuum` integration (`start`, `pause`, `stop`, `return_to_base`, `locate`, `set_fan_speed` and `send_command`), the `xiaomi` platform introduces specific services to access the remote control mode of the robot. These are: - `xiaomi_remote_control_start` - `xiaomi_remote_control_stop` diff --git a/source/_components/velbus.markdown b/source/_components/velbus.markdown index 8c01061b410..1914c093aa9 100644 --- a/source/_components/velbus.markdown +++ b/source/_components/velbus.markdown @@ -23,7 +23,7 @@ redirect_from: - /components/switch.velbus/ --- -The `velbus` component supports the Velbus USB, Velbus serial and a TCP/IP gateway. +The `velbus` integration supports the Velbus USB, Velbus serial and a TCP/IP gateway. There is currently support for the following device types within Home Assistant: diff --git a/source/_components/velux.markdown b/source/_components/velux.markdown index a78a3490e48..3f31bc73c34 100644 --- a/source/_components/velux.markdown +++ b/source/_components/velux.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Velux" -description: "Instructions on how to integrate Velux KLF 200 component with Home Assistant." +description: "Instructions on how to integrate Velux KLF 200 integration with Home Assistant." date: 2017-07-09 12:00 sidebar: true comments: false diff --git a/source/_components/vizio.markdown b/source/_components/vizio.markdown index abe9e5996b7..d250a4ec784 100644 --- a/source/_components/vizio.markdown +++ b/source/_components/vizio.markdown @@ -16,7 +16,7 @@ redirect_from: - /components/media_player.vizio/ --- -The `vizio` component will allow you to control [SmartCast](https://www.vizio.com/smartcast-app) compatible TVs and Sound Bars (2016+ models). +The `vizio` integration will allow you to control [SmartCast](https://www.vizio.com/smartcast-app) compatible TVs and Sound Bars (2016+ models). ## {% linkable_title Find your device %} diff --git a/source/_components/volvooncall.markdown b/source/_components/volvooncall.markdown index eeed03ca4c1..54562cd4051 100644 --- a/source/_components/volvooncall.markdown +++ b/source/_components/volvooncall.markdown @@ -20,7 +20,7 @@ redirect_from: - /components/device_tracker.volvooncall/ --- -The `volvooncall` component offers integration with the [Volvo On Call](http://www.volvocars.com/intl/own/connectivity/volvo-on-call) cloud service and offers presence detection as well as sensors such as odometer and fuel level. +The `volvooncall` integration offers integration with the [Volvo On Call](http://www.volvocars.com/intl/own/connectivity/volvo-on-call) cloud service and offers presence detection as well as sensors such as odometer and fuel level. ## {% linkable_title Configuration %} diff --git a/source/_components/vultr.markdown b/source/_components/vultr.markdown index 0d445701761..6ec90e70ad0 100644 --- a/source/_components/vultr.markdown +++ b/source/_components/vultr.markdown @@ -21,7 +21,7 @@ redirect_from: - /components/switch.vultr/ --- -The `vultr` component allows you to access information about and interact with your [Vultr](https://www.vultr.com) subscriptions (Virtual Private Servers) from Home Assistant. +The `vultr` integration allows you to access information about and interact with your [Vultr](https://www.vultr.com) subscriptions (Virtual Private Servers) from Home Assistant. There is currently support for the following device types within Home Assistant: diff --git a/source/_components/w800rf32.markdown b/source/_components/w800rf32.markdown index 0012c015039..4f6da6b54f7 100644 --- a/source/_components/w800rf32.markdown +++ b/source/_components/w800rf32.markdown @@ -17,7 +17,7 @@ redirect_from: - /components/binary_sensor.w800rf32/ --- -The `w800rf32` component supports W800RF32 devices by [WGL Designs](http://www.wgldesigns.com/w800.html) which +The `w800rf32` integration supports W800RF32 devices by [WGL Designs](http://www.wgldesigns.com/w800.html) which communicate in the frequency range of 310MHz or if you are outside Canada or the U.S., 433.92 MHz. The W800 family of RF receivers are designed to receive X10 RF signals generated from X10 products: Palm Pad diff --git a/source/_components/wake_on_lan.markdown b/source/_components/wake_on_lan.markdown index b120e58f05b..61258d5efcb 100644 --- a/source/_components/wake_on_lan.markdown +++ b/source/_components/wake_on_lan.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Wake on LAN" -description: "Instructions on how to setup the Wake on LAN component in Home Assistant." +description: "Instructions on how to setup the Wake on LAN integration in Home Assistant." date: 2017-07-8 15:00 sidebar: true comments: false @@ -17,7 +17,7 @@ redirect_from: - /components/switch.wake_on_lan/ --- -The `wake_on_lan` component enables the ability to send _magic packets_ to [Wake on LAN](https://en.wikipedia.org/wiki/Wake-on-LAN) capable devices, to turn them on. +The `wake_on_lan` integration enables the ability to send _magic packets_ to [Wake on LAN](https://en.wikipedia.org/wiki/Wake-on-LAN) capable devices, to turn them on. There is currently support for the following device types within Home Assistant: @@ -25,7 +25,7 @@ There is currently support for the following device types within Home Assistant: ## {% linkable_title Configuration %} -To use this component in your installation, add the following to your `configuration.yaml` file: +To use this integration in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/water_heater.markdown b/source/_components/water_heater.markdown index 13fb3b24e47..bceda20af50 100644 --- a/source/_components/water_heater.markdown +++ b/source/_components/water_heater.markdown @@ -10,7 +10,7 @@ footer: true ha_release: 0.81 --- -The `water_heater` component is built for the controlling and monitoring of hot water heaters. +The `water_heater` integration is built for the controlling and monitoring of hot water heaters. To enable this component, pick one of the platforms, and add it to your `configuration.yaml`: diff --git a/source/_components/waterfurnace.markdown b/source/_components/waterfurnace.markdown index 322349760e7..b2a50f19822 100644 --- a/source/_components/waterfurnace.markdown +++ b/source/_components/waterfurnace.markdown @@ -16,7 +16,7 @@ redirect_from: - /components/sensor.waterfurnace/ --- -The `waterfurnace` component communicates with the WaterFurnace Symphony website's WebSocket to show you many of the sensors in your system. While not an official API, this is the same backend the Symphony website is based on, and should be reasonably stable. +The `waterfurnace` integration communicates with the WaterFurnace Symphony website's WebSocket to show you many of the sensors in your system. While not an official API, this is the same backend the Symphony website is based on, and should be reasonably stable. The sensors provided include: diff --git a/source/_components/watson_iot.markdown b/source/_components/watson_iot.markdown index dffff86af55..f2fd55a0732 100644 --- a/source/_components/watson_iot.markdown +++ b/source/_components/watson_iot.markdown @@ -13,7 +13,7 @@ ha_category: ha_release: 0.72 --- -The `watson_iot` component enables you to link the devices in Home Assistant +The `watson_iot` integration enables you to link the devices in Home Assistant with an [IBM Watson IoT Platform instance](https://www.ibm.com/us-en/marketplace/internet-of-things-cloud). ## {% linkable_title Configuration %} @@ -58,7 +58,7 @@ token: required: true type: string exclude: - description: Configure which components should be excluded from recording to Watson IoT Platform. + description: Configure which integrations should be excluded from recording to Watson IoT Platform. required: false type: map keys: @@ -71,7 +71,7 @@ exclude: required: false type: list include: - description: Configure which components should be included in recordings to Watson IoT Platform. If set, all other entities will not be recorded to Watson IoT Platform. Values set by the **blacklist** option will prevail. + description: Configure which integrations should be included in recordings to Watson IoT Platform. If set, all other entities will not be recorded to Watson IoT Platform. Values set by the **blacklist** option will prevail. required: false type: map keys: diff --git a/source/_components/waze_travel_time.markdown b/source/_components/waze_travel_time.markdown index a46e4147029..cea0d46a352 100644 --- a/source/_components/waze_travel_time.markdown +++ b/source/_components/waze_travel_time.markdown @@ -75,7 +75,7 @@ vehicle_type: ## {% linkable_title Example using dynamic destination %} -Using the flexible option to set a sensor value to the `destination`, you can setup a single Waze component that will calculate travel time to multiple optional locations on demand. +Using the flexible option to set a sensor value to the `destination`, you can setup a single Waze integration that will calculate travel time to multiple optional locations on demand. In the following example, the `Input Select` is converted into an address which is used to modify the destination for Waze route calculation from `device_tracker.myphone` location (It takes a few minutes for the value to update due to the interval set to fetch Waze data). diff --git a/source/_components/webhooks.markdown b/source/_components/webhooks.markdown index b9e015982fe..5ac9a9dbe41 100644 --- a/source/_components/webhooks.markdown +++ b/source/_components/webhooks.markdown @@ -62,7 +62,7 @@ proxy_params: required: false type: string url: - description: Allow to overwrite the `base_url` from the [`http`](/components/http/) component for different configurations (`https://:`). + description: Allow to overwrite the `base_url` from the [`http`](/components/http/) integration for different configurations (`https://:`). required: false type: string trusted_networks: diff --git a/source/_components/weblink.markdown b/source/_components/weblink.markdown index b957a3ee5d4..0615c7c001b 100644 --- a/source/_components/weblink.markdown +++ b/source/_components/weblink.markdown @@ -14,11 +14,11 @@ ha_release: 0.13 ha_qa_scale: internal --- -The `weblink` component allows you to display links in the Home Assistant frontend. +The `weblink` integration allows you to display links in the Home Assistant frontend. ## {% linkable_title Configuration %} -To use this component in your installation, add something like the following to your `configuration.yaml` file: +To use this integration in your installation, add something like the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/websocket_api.markdown b/source/_components/websocket_api.markdown index 41befadad65..dbbb74c9ce2 100644 --- a/source/_components/websocket_api.markdown +++ b/source/_components/websocket_api.markdown @@ -14,7 +14,7 @@ ha_qa_scale: internal ha_release: 0.34 --- -The `websocket_api` component set up a WebSocket API and allows one to interact with a Home Assistant instance that is running headless. This component depends on the [`http` component](/components/http/). +The `websocket_api` integration set up a WebSocket API and allows one to interact with a Home Assistant instance that is running headless. This integration depends on the [`http` component](/components/http/).

It is HIGHLY recommended that you set the `api_password`, especially if you are planning to expose your installation to the internet. diff --git a/source/_components/wemo.markdown b/source/_components/wemo.markdown index 0f8ca973c45..8a072ad7ec9 100644 --- a/source/_components/wemo.markdown +++ b/source/_components/wemo.markdown @@ -23,7 +23,7 @@ redirect_from: - /components/switch.wemo/ --- -The `wemo` component is the main component to integrate various [Belkin WeMo](http://www.belkin.com/us/Products/home-automation/c/wemo-home-automation/) devices with Home Assistant. +The `wemo` integration is the main integration to integrate various [Belkin WeMo](http://www.belkin.com/us/Products/home-automation/c/wemo-home-automation/) devices with Home Assistant. There is currently support for the following device types within Home Assistant: @@ -46,7 +46,7 @@ There is currently support for the following device types within Home Assistant: type: list {% endconfiguration %} -Supported devices will be automatically discovered if the optional `discovery` configuration item is omitted or set to true or if the `discovery` component is enabled. If the `discovery` configuration item is set to false, then automatic discovery of WeMo devices is disabled both for the `wemo` component and for the `discovery` component. Loading the `wemo` component with the `discovery` configuration item omitted or set to true will scan the local network for WeMo devices, even if you are not using the `discovery` component. +Supported devices will be automatically discovered if the optional `discovery` configuration item is omitted or set to true or if the `discovery` integration is enabled. If the `discovery` configuration item is set to false, then automatic discovery of WeMo devices is disabled both for the `wemo` integration and for the `discovery` component. Loading the `wemo` integration with the `discovery` configuration item omitted or set to true will scan the local network for WeMo devices, even if you are not using the `discovery` component. ```yaml # Example configuration.yaml entry with automatic discovery enabled (by omitting the discovery configuration item) @@ -88,7 +88,7 @@ wemo: The `wemo` platform allows you to control your Belkin WeMo humidifiers from within Home Assistant. This includes support for the [Holmes Smart Humidifier](https://www.holmesproducts.com/wemo-humidifier.html). -WeMo devices are automatically discovered if the `discovery` component is enabled. +WeMo devices are automatically discovered if the `discovery` integration is enabled. ### {% linkable_title Attributes %} diff --git a/source/_components/wink.markdown b/source/_components/wink.markdown index 3ee8fd06985..2af60e06163 100644 --- a/source/_components/wink.markdown +++ b/source/_components/wink.markdown @@ -139,7 +139,7 @@ Error sending local control request. Sending request online ## {% linkable_title Service `refresh_state_from_wink` %} -The Wink component only obtains the device states from the Wink API once, during startup. All updates after that are pushed via a third party called PubNub. On rare occasions where an update isn't pushed device states can be out of sync. +The Wink integration only obtains the device states from the Wink API once, during startup. All updates after that are pushed via a third party called PubNub. On rare occasions where an update isn't pushed device states can be out of sync. You can use the service wink/refresh_state_from_wink to pull the most recent state from the Wink API for all devices. If `local_control` is set to `true` states will be pulled from the devices controlling hub, not the online API. diff --git a/source/_components/wunderlist.markdown b/source/_components/wunderlist.markdown index fd754d35d3b..befac48e03d 100644 --- a/source/_components/wunderlist.markdown +++ b/source/_components/wunderlist.markdown @@ -13,7 +13,7 @@ ha_category: ha_release: 0.84 --- -The `wunderlist` component allows you to create tasks in [Wunderlist](https://www.wunderlist.com) from Home Assistant. You can use this if you want Home Assistant to send you a task that you should not forget, e.g., Congratulate Dani. +The `wunderlist` integration allows you to create tasks in [Wunderlist](https://www.wunderlist.com) from Home Assistant. You can use this if you want Home Assistant to send you a task that you should not forget, e.g., Congratulate Dani. ## {% linkable_title Setup %} @@ -46,7 +46,7 @@ access_token: ## {% linkable_title Creating tasks with service `create_task`%} -This component offers a new service domain `wunderlist` with the service `create_task`. +This integration offers a new service domain `wunderlist` with the service `create_task`. You can call this service with the argument `list_name` the argument `name` and the optional parameter `starred` to create a new task. | Service data attribute | Optional | Description | Example | diff --git a/source/_components/xbox_live.markdown b/source/_components/xbox_live.markdown index 234a18c22e0..a4fa60c4a7e 100644 --- a/source/_components/xbox_live.markdown +++ b/source/_components/xbox_live.markdown @@ -16,7 +16,7 @@ redirect_from: - /components/sensor.xbox_live/ --- -The Xbox Live component is able to track [Xbox](http://xbox.com/) profiles. +The Xbox Live integration is able to track [Xbox](http://xbox.com/) profiles. To use this sensor you need a free API key from [XboxAPI.com](http://xboxapi.com). diff --git a/source/_components/xfinity.markdown b/source/_components/xfinity.markdown index f29fbffc0ab..e5a68d950d4 100644 --- a/source/_components/xfinity.markdown +++ b/source/_components/xfinity.markdown @@ -39,4 +39,4 @@ host: default: 10.0.0.1 {% endconfiguration %} -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. +See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. diff --git a/source/_components/xiaomi_aqara.markdown b/source/_components/xiaomi_aqara.markdown index 0e31f5a0a88..d9eb7ce56bb 100644 --- a/source/_components/xiaomi_aqara.markdown +++ b/source/_components/xiaomi_aqara.markdown @@ -15,7 +15,7 @@ ha_iot_class: Local Push redirect_from: /components/xiaomi/ --- -The `xiaomi_aqara` component allows you to integrate [Xiaomi](http://www.mi.com/en/) Aqara-compatible devices into Home Assistant. +The `xiaomi_aqara` integration allows you to integrate [Xiaomi](http://www.mi.com/en/) Aqara-compatible devices into Home Assistant. Please note, there are two versions of the hub: v1 and v2. v1 can be used with Home Assistant without any problems, however, v2 might be less straight forward when it comes to enabling the local API, and might even require you to open up your device in order to do so. Xiaomi has suggested this is in the pipeline. diff --git a/source/_components/xs1.markdown b/source/_components/xs1.markdown index e77a3695096..eb02e826008 100644 --- a/source/_components/xs1.markdown +++ b/source/_components/xs1.markdown @@ -33,7 +33,7 @@ xs1: host: "192.168.2.100" ``` -The component will automatically detect the configuration of the XS1 Gateway only **on initialization** which currently means when Home Assistant boots. When you change the configuration of the XS1 you (currently) have to restart Home Assistant to see the effects. +The integration will automatically detect the configuration of the XS1 Gateway only **on initialization** which currently means when Home Assistant boots. When you change the configuration of the XS1 you (currently) have to restart Home Assistant to see the effects. {% configuration %} host: @@ -63,7 +63,7 @@ password: ## {% linkable_title Supported Device Types %}

-This component currently only covers part of the device types supported by the XS1 gateway, unsupported types are simply ignored. +This integration currently only covers part of the device types supported by the XS1 gateway, unsupported types are simply ignored.

### {% linkable_title Sensors %} diff --git a/source/_components/yamaha.markdown b/source/_components/yamaha.markdown index c361bfa79af..64bb53466f5 100644 --- a/source/_components/yamaha.markdown +++ b/source/_components/yamaha.markdown @@ -63,7 +63,7 @@ zone_names: ### {% linkable_title Discovery notes %} -- If the `discovery` component is enabled, all units on the network +- If the `discovery` integration is enabled, all units on the network will be discovered using UPNP. - For receivers that support more than one zone, Home Assistant will add one media player per zone supported by the player, named "$name diff --git a/source/_components/yamaha_musiccast.markdown b/source/_components/yamaha_musiccast.markdown index ea4796b76c7..e4b21af9029 100644 --- a/source/_components/yamaha_musiccast.markdown +++ b/source/_components/yamaha_musiccast.markdown @@ -47,7 +47,7 @@ interval_seconds: ### {% linkable_title Supported operations %} -Currently, this component supports powering on/off, mute, volume control, and source selection. Playback controls, for instance, play and stop are available for sources that support it. +Currently, this integration supports powering on/off, mute, volume control, and source selection. Playback controls, for instance, play and stop are available for sources that support it. ### {% linkable_title Example configuration %} diff --git a/source/_components/yeelight.markdown b/source/_components/yeelight.markdown index 8fab6bffae1..37b266cb3b8 100644 --- a/source/_components/yeelight.markdown +++ b/source/_components/yeelight.markdown @@ -16,7 +16,7 @@ redirect_from: - /components/light.yeelight/ --- -The `yeelight` component allows you to control your Yeelight Wifi bulbs with Home Assistant. There are two possible methods for configuration of the Yeelight: Manual or Automatic. +The `yeelight` integration allows you to control your Yeelight Wifi bulbs with Home Assistant. There are two possible methods for configuration of the Yeelight: Manual or Automatic. There is currently support for the following device types within Home Assistant: @@ -110,7 +110,7 @@ custom_effects: {% endconfiguration %} #### {% linkable_title Music mode %} -Per default the bulb limits the amount of requests per minute to 60, a limitation which can be bypassed by enabling the music mode. In music mode the bulb is commanded to connect back to a socket provided by the component and it tries to keep the connection open, which may not be wanted in all use-cases. +Per default the bulb limits the amount of requests per minute to 60, a limitation which can be bypassed by enabling the music mode. In music mode the bulb is commanded to connect back to a socket provided by the integration and it tries to keep the connection open, which may not be wanted in all use-cases. **Also note that bulbs in music mode will not update their state to "unavailable" if they are disconnected, which can cause delays in Home Assistant. Bulbs in music mode may also not react to commands from HASS the first time if the connection is dropped. If you experience this issue, turn the light off and back on again in the frontend and everything will return to normal.** ### {% linkable_title Initial setup %} @@ -124,7 +124,7 @@ Information on how to enable "LAN Mode" can be found [here](https://getyeti.co/p ### {% linkable_title Supported models %}

-This component is tested to work with the following models. If you have a different model and it is working please let us know. +This integration is tested to work with the following models. If you have a different model and it is working please let us know.

| Model ID | Model number | Product name | diff --git a/source/_components/zabbix.markdown b/source/_components/zabbix.markdown index e68b2841c6b..1b744cbca3b 100644 --- a/source/_components/zabbix.markdown +++ b/source/_components/zabbix.markdown @@ -17,7 +17,7 @@ redirect_from: - /components/sensor.zabbix/ --- -The `zabbix` component is the main component to connect to a [Zabbix](http://www.zabbix.com/) monitoring instance via the Zabbix API. +The `zabbix` integration is the main integration to connect to a [Zabbix](http://www.zabbix.com/) monitoring instance via the Zabbix API. There is currently support for the following device types within Home Assistant: @@ -25,7 +25,7 @@ There is currently support for the following device types within Home Assistant: ## {% linkable_title Configuration %} -To set the Zabbix component up, add the following information to your `configuration.yaml` file: +To set the Zabbix integration up, add the following information to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/zestimate.markdown b/source/_components/zestimate.markdown index 22e26652ccb..2bbea20b524 100644 --- a/source/_components/zestimate.markdown +++ b/source/_components/zestimate.markdown @@ -18,7 +18,7 @@ redirect_from: The `zestimate` sensor allows one to track the Zestimate® value of properties using the [Zillow API](https://www.zillow.com/howto/api/APIOverview.htm). According to Zillow's website, a Zestimate® home valuation is Zillow's estimated market value. It is not an appraisal. Use it as a starting point to determine a home's value. The Zestimate® is provided by [Zillow](https://www.zillow.com), a website primarily for listing homes to buy/sell/rent in the United States. -This component adds one entity per zpid specified, named `sensor.zestimate` with numbers appended if you choose to track more than one Zestimate. +This integration adds one entity per zpid specified, named `sensor.zestimate` with numbers appended if you choose to track more than one Zestimate. ## {% linkable_title Configuration %} diff --git a/source/_components/zha.markdown b/source/_components/zha.markdown index 69f4fbbf2e5..907fc0b202d 100644 --- a/source/_components/zha.markdown +++ b/source/_components/zha.markdown @@ -41,7 +41,7 @@ There is currently support for the following device types within Home Assistant: ## {% linkable_title ZHA exception and deviation handling %} -Zigbee devices that deviate from or do not fully conform to the standard specifications set by the [Zigbee Alliance](https://www.zigbee.org) may require the development of custom [ZHA Device Handlers](https://github.com/dmulcahey/zha-device-handlers) (ZHA custom quirks handler implementation) to for all their functions to work properly with the ZHA component in Home Assistant. These ZHA Device Handlers for Home Assistant can thus be used to parse custom messages to and from Zigbee devices. +Zigbee devices that deviate from or do not fully conform to the standard specifications set by the [Zigbee Alliance](https://www.zigbee.org) may require the development of custom [ZHA Device Handlers](https://github.com/dmulcahey/zha-device-handlers) (ZHA custom quirks handler implementation) to for all their functions to work properly with the ZHA integration in Home Assistant. These ZHA Device Handlers for Home Assistant can thus be used to parse custom messages to and from Zigbee devices. The custom quirks implementations for zigpy implemented as ZHA Device Handlers for Home Assistant are a similar concept to that of [Hub-connected Device Handlers for the SmartThings Classics platform](https://docs.smartthings.com/en/latest/device-type-developers-guide/) as well as that of [Zigbee-Shepherd Converters as used by Zigbee2mqtt](https://www.zigbee2mqtt.io/how_tos/how_to_support_new_devices.html), meaning they are each virtual representations of a physical device that expose additional functionality that is not provided out-of-the-box by the existing integration between these platforms. diff --git a/source/_components/zigbee.markdown b/source/_components/zigbee.markdown index 5d15a94c9ed..83107f9c911 100644 --- a/source/_components/zigbee.markdown +++ b/source/_components/zigbee.markdown @@ -22,7 +22,7 @@ redirect_from: - /components/switch.zigbee/ --- -[Zigbee](http://www.zigbee.org/what-is-zigbee/) integration for Home Assistant allows you to utilize modules such as the [XBee](http://www.digi.com/lp/xbee) as wireless General Purpose Input/Output (GPIO) devices. The component requires a local Zigbee device to be connected to a serial port. Through this, it will send and receive commands to and from other devices on the Zigbee mesh network. +[Zigbee](http://www.zigbee.org/what-is-zigbee/) integration for Home Assistant allows you to utilize modules such as the [XBee](http://www.digi.com/lp/xbee) as wireless General Purpose Input/Output (GPIO) devices. The integration requires a local Zigbee device to be connected to a serial port. Through this, it will send and receive commands to and from other devices on the Zigbee mesh network. There is currently support for the following device types within Home Assistant: diff --git a/source/_components/ziggo_mediabox_xl.markdown b/source/_components/ziggo_mediabox_xl.markdown index cef854b4770..8baf7a82dac 100644 --- a/source/_components/ziggo_mediabox_xl.markdown +++ b/source/_components/ziggo_mediabox_xl.markdown @@ -16,7 +16,7 @@ redirect_from: - /components/media_player.ziggo_mediabox_xl/ --- -The `ziggo_mediabox_xl` component allows you to control a [Ziggo](https://www.ziggo.nl/) Mediabox XL from Home Assistant. +The `ziggo_mediabox_xl` integration allows you to control a [Ziggo](https://www.ziggo.nl/) Mediabox XL from Home Assistant. To add a Ziggo Mediabox XL to your installation, add the following to your `configuration.yaml` file: @@ -43,4 +43,4 @@ The channel information (numbers and names) are downloaded from ziggo.nl on star #### {% linkable_title Preparation of the Mediabox %} -Makes sure to enable the Home Network ("mijn thuisnetwerk") service in the settings menu of the media box. Once you have set up the Media Library ("mediabiblotheek"), we can determine whether the device is turned on or off. Without this, the component will fail to start. +Makes sure to enable the Home Network ("mijn thuisnetwerk") service in the settings menu of the media box. Once you have set up the Media Library ("mediabiblotheek"), we can determine whether the device is turned on or off. Without this, the integration will fail to start. diff --git a/source/_components/zone.markdown b/source/_components/zone.markdown index 269492938dd..09962cefb7e 100644 --- a/source/_components/zone.markdown +++ b/source/_components/zone.markdown @@ -16,7 +16,7 @@ ha_release: 0.69 Zones allow you to specify certain regions on earth (for now). When a device tracker sees a device to be within a zone, the state will take the name from the zone. Zones can also be used as a [trigger](/getting-started/automation-trigger/#zone-trigger) or [condition](/getting-started/automation-condition/#zone-condition) inside automation setups. -The `zone` component uses YAML sequences to configure multiple zones: +The `zone` integration uses YAML sequences to configure multiple zones: ```yaml # Example configuration.yaml entry @@ -72,7 +72,7 @@ To find the latitude/longitude of a certain place you can use [Google Maps](http ## {% linkable_title Home zone %} -If no configuration is given, the `zone` component will create a zone for home. This zone will use location provided in the `configuration.yaml` file and have a radius of 100 meters. To override this, create a zone configuration and name it **'Home'**. +If no configuration is given, the `zone` integration will create a zone for home. This zone will use location provided in the `configuration.yaml` file and have a radius of 100 meters. To override this, create a zone configuration and name it **'Home'**.

Devices that are in the zone **'Home'** will not appear on the map in the Home Assistant UI. diff --git a/source/_components/zoneminder.markdown b/source/_components/zoneminder.markdown index a8a67d635a6..b5a8fd7172a 100644 --- a/source/_components/zoneminder.markdown +++ b/source/_components/zoneminder.markdown @@ -23,7 +23,7 @@ redirect_from: - /components/switch.zoneminder/ --- -The ZoneMinder component sets up the integration with your [ZoneMinder](https://www.zoneminder.com) instance. +The ZoneMinder integration sets up the integration with your [ZoneMinder](https://www.zoneminder.com) instance. There is currently support for the following device types within Home Assistant: @@ -169,7 +169,7 @@ monitored_conditions: The `zoneminder` switch platform allows you to toggle the current function of all cameras attached to your [ZoneMinder](https://www.zoneminder.com) instance.

-You must have the [ZoneMinder component](/components/zoneminder/) configured to use this and if ZoneMinder authentication is enabled the account specified in the component configuration must have "Edit" permission for "System". +You must have the [ZoneMinder component](/components/zoneminder/) configured to use this and if ZoneMinder authentication is enabled the account specified in the integration configuration must have "Edit" permission for "System".

To enable this switch, add the following lines to your `configuration.yaml` file: diff --git a/source/_components/zwave.markdown b/source/_components/zwave.markdown index b763a36811c..e79e1475336 100644 --- a/source/_components/zwave.markdown +++ b/source/_components/zwave.markdown @@ -64,7 +64,7 @@ Thermostats with support for fan modes or different operating modes, will be han If the thermostat supports different operating modes, you will get one thermostat entity for each mode. These can be hidden with settings using the customize setting in the `configuration.yaml` file.

-To enable the climate component for your Z-Wave network, add the following to your `configuration.yaml` file. +To enable the climate integration for your Z-Wave network, add the following to your `configuration.yaml` file. ```yaml climate: diff --git a/source/_cookbook/python_component_automation.markdown b/source/_cookbook/python_component_automation.markdown index e511c8b118d..9e9617cdceb 100644 --- a/source/_cookbook/python_component_automation.markdown +++ b/source/_cookbook/python_component_automation.markdown @@ -58,7 +58,7 @@ from homeassistant.helpers.event import (async_track_state_change, DOMAIN = "example" # List of integration names (string) your integration depends upon. -# We depend on group because group will be loaded after all the components that +# We depend on group because group will be loaded after all the integrations that # initialize devices have been setup. DEPENDENCIES = ['group', 'device_tracker', 'light'] From 4f9e1960c623d288de802bdcabd513738e58151c Mon Sep 17 00:00:00 2001 From: The PapaMaan <31101389+thepapamaan@users.noreply.github.com> Date: Fri, 28 Jun 2019 12:47:11 +0200 Subject: [PATCH 017/116] a space to many corrupted the equilibrium (#9708) fixed error in link/url --- source/_components/google_cloud.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/google_cloud.markdown b/source/_components/google_cloud.markdown index e7537126cf6..fc2309bb5cd 100644 --- a/source/_components/google_cloud.markdown +++ b/source/_components/google_cloud.markdown @@ -112,7 +112,7 @@ gain: type: float default: 0.0 profiles: - description: "An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given. Supported profile ids listed [here](https: //cloud.google.com/text-to-speech/docs/audio-profiles)." + description: "An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given. Supported profile ids listed [here](https://cloud.google.com/text-to-speech/docs/audio-profiles)." required: false type: list default: "[]" From a6433d20eb4c7747e9ec3818ffab8509c46ed713 Mon Sep 17 00:00:00 2001 From: Roelof Schuiling Date: Fri, 28 Jun 2019 15:04:36 +0200 Subject: [PATCH 018/116] add icon_template to configuration options (#9706) It wasn't listed in the list of config options, only as examples. --- source/_components/light.template.markdown | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/source/_components/light.template.markdown b/source/_components/light.template.markdown index 22a874754b7..f37c8081c8d 100644 --- a/source/_components/light.template.markdown +++ b/source/_components/light.template.markdown @@ -67,6 +67,10 @@ light: required: false type: template default: optimistic + icon_template: + description: Defines a template for an icon or picture, e.g. showing a different icon for different states. + required: false + type: template turn_on: description: Defines an action to run when the light is turned on. required: true From 71fc25730c24d6854ad71a86da093617959a9270 Mon Sep 17 00:00:00 2001 From: Tejpal Sahota Date: Fri, 28 Jun 2019 09:05:34 -0400 Subject: [PATCH 019/116] updated default_encoder to mp3 (#9704) --- source/_components/google_cloud.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/google_cloud.markdown b/source/_components/google_cloud.markdown index e7537126cf6..1571e63bfc0 100644 --- a/source/_components/google_cloud.markdown +++ b/source/_components/google_cloud.markdown @@ -95,7 +95,7 @@ encoding: description: "Default audio encoder. Supported encodings are `ogg_opus`, `mp3` and `linear16`." required: false type: string - default: ogg_opus + default: mp3 speed: description: "Default rate/speed of the voice, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed." required: false From 9b24ddaaa5cc1ee6dfb99e32b5b1f08a1f5504af Mon Sep 17 00:00:00 2001 From: Roelof Schuiling Date: Fri, 28 Jun 2019 15:10:45 +0200 Subject: [PATCH 020/116] Removing integration instead of .tradfri_psk.conf (#9707) When using the integration, you can simply remove the integration after a Tradfri firmware update. Everything will get rediscovered after a restart. This was not yet mentioned in the docs. --- source/_components/tradfri.markdown | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/source/_components/tradfri.markdown b/source/_components/tradfri.markdown index 9718779da0f..0d17b408d24 100644 --- a/source/_components/tradfri.markdown +++ b/source/_components/tradfri.markdown @@ -56,7 +56,11 @@ allow_tradfri_groups: ### {% linkable_title Firmware updates %} -After updating the firmware of your IKEA Trådfri Gateway it might be necessary to repeat the configuration process. If you encounter problems, delete the `.tradfri_psk.conf` file in your `.homeassistant` directory, restart Home Assistant, when prompted enter the security key and click configure, just like during initial setup. Possible errors: `Fatal DTLS error: code 115`. +After updating the firmware of your IKEA Trådfri Gateway it might be necessary to repeat the configuration process. Possible errors: `Fatal DTLS error: code 115`. If you encounter problems: +- when configured using the integration: remove the integration through Settings > Integrations > Tradfri > delete using trash can icon; +- with manual configuration: delete the `.tradfri_psk.conf` file in your `.homeassistant` directory; + +Then restart Home Assistant, when prompted enter the security key and click configure, just like during initial setup. ### {% linkable_title Compilation issues %} From 93153e306cda342b7e74db4c1c7c7d9f448260fe Mon Sep 17 00:00:00 2001 From: Edu_Coder Date: Fri, 28 Jun 2019 11:18:33 -0400 Subject: [PATCH 021/116] Update mqtt_room markdown (#9701) * Update mqtt_room markdown Added another reference at the bottom to my ESP32-MQTT-room project, which operates as a tracker. * Reverted unclear wording Removed specification that room-assistant runs on rPi, as it can run on many platforms. --- source/_components/mqtt_room.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/source/_components/mqtt_room.markdown b/source/_components/mqtt_room.markdown index 966b48b0ff3..eb9bcd1205d 100644 --- a/source/_components/mqtt_room.markdown +++ b/source/_components/mqtt_room.markdown @@ -74,3 +74,4 @@ Instead of developing your own application, you can also use any of these alread - [**room-assistant**](https://github.com/mKeRix/room-assistant): looks for Bluetooth LE beacons, based on Node.js - [**Happy Bubbles Presence Server**](https://github.com/happy-bubbles/presence): presence detection server for Happy Bubbles BLE-scanning devices, based on Go +- [**ESP32-MQTT-room**](https://jptrsn.github.io/ESP32-mqtt-room/): runs on an ESP32, and looks for Bluetooth LE devices, based on C++/Arduino From a0a946e3932583832531e5c6b169a0278c2b3e11 Mon Sep 17 00:00:00 2001 From: Paulus Schoutsen Date: Fri, 28 Jun 2019 11:37:24 -0700 Subject: [PATCH 022/116] Release 95.2 --- _config.yml | 4 +-- source/_posts/2019-06-26-release-95.markdown | 26 ++++++++++++++++++++ 2 files changed, 28 insertions(+), 2 deletions(-) diff --git a/_config.yml b/_config.yml index 233341be8c6..0f5c110cb3c 100644 --- a/_config.yml +++ b/_config.yml @@ -139,8 +139,8 @@ social: # Home Assistant release details current_major_version: 0 current_minor_version: 95 -current_patch_version: 1 -date_released: 2019-06-27 +current_patch_version: 2 +date_released: 2019-06-28 # Either # or the anchor link to latest release notes in the blog post. # Must be prefixed with a # and have double quotes around it. diff --git a/source/_posts/2019-06-26-release-95.markdown b/source/_posts/2019-06-26-release-95.markdown index 502f578401f..1befd3cc233 100644 --- a/source/_posts/2019-06-26-release-95.markdown +++ b/source/_posts/2019-06-26-release-95.markdown @@ -110,6 +110,32 @@ We have also realized that the default database clean up task never automaticall [life360 docs]: /components/life360/ [wink docs]: /components/wink/ +## {% linkable_title Release 0.95.2 - June 28 %} + +- Fix netatmo weatherstation setup error ([@cgtobi] - [#24788]) ([netatmo docs]) +- Update azure-pipelines-release.yml for Azure Pipelines ([@pvizeli] - [#24800]) +- Make sure entity config is never none ([@balloob] - [#24801]) ([google_assistant docs]) +- Bump ZHA quirks module ([@dmulcahey] - [#24802]) ([zha docs]) +- Fix another Life360 bug ([@pnbruckner] - [#24805]) ([life360 docs]) +- Fix calling empty script turn off ([@balloob] - [#24827]) ([script docs]) + +[#24788]: https://github.com/home-assistant/home-assistant/pull/24788 +[#24800]: https://github.com/home-assistant/home-assistant/pull/24800 +[#24801]: https://github.com/home-assistant/home-assistant/pull/24801 +[#24802]: https://github.com/home-assistant/home-assistant/pull/24802 +[#24805]: https://github.com/home-assistant/home-assistant/pull/24805 +[#24827]: https://github.com/home-assistant/home-assistant/pull/24827 +[@balloob]: https://github.com/balloob +[@cgtobi]: https://github.com/cgtobi +[@dmulcahey]: https://github.com/dmulcahey +[@pnbruckner]: https://github.com/pnbruckner +[@pvizeli]: https://github.com/pvizeli +[google_assistant docs]: /components/google_assistant/ +[life360 docs]: /components/life360/ +[netatmo docs]: /components/netatmo/ +[script docs]: /components/script/ +[zha docs]: /components/zha/ + ## {% linkable_title If you need help... %} ...don't hesitate to use our very active [forums](https://community.home-assistant.io/) or join us for a little [chat](https://discord.gg/c5DvZ4e). From d428b3c1b3045485a48942cf3b2f5a41f5f02fce Mon Sep 17 00:00:00 2001 From: mvn23 Date: Fri, 28 Jun 2019 21:15:50 +0200 Subject: [PATCH 023/116] Update docs to reflect multiple devices support in opentherm_gw (#9176) * Update docs to reflect support for multiple OpenTherm Gateway devices. * Update to reflect removing the 'monitored_variables' option. * Change bold and newline notation to markdown --- source/_components/opentherm_gw.markdown | 577 ++++++++++++++--------- 1 file changed, 342 insertions(+), 235 deletions(-) diff --git a/source/_components/opentherm_gw.markdown b/source/_components/opentherm_gw.markdown index 2cb03e5984e..51da98d68cf 100644 --- a/source/_components/opentherm_gw.markdown +++ b/source/_components/opentherm_gw.markdown @@ -1,6 +1,6 @@ --- layout: page -title: "OpenTherm Gateway Hub" +title: "OpenTherm Gateway" description: "Control your OpenTherm Gateway from Home Assistant." date: 2018-10-07 16:23 sidebar: true @@ -23,265 +23,58 @@ redirect_from: The `opentherm_gw` component is used to control the [OpenTherm Gateway](http://otgw.tclcode.com/) from Home Assistant. -There is currently support for the following device types within Home Assistant: - -- Binary Sensor -- Climate -- Sensor - -When enabled, this component will automatically add its [`climate` entity](/components/climate.opentherm_gw) to Home Assistant. +This component will add a single `climate` entity and multiple `sensor` and `binary_sensor` entities to Home Assistant for each configured gateway.

The OpenTherm protocol is based on polling. The thermostat sends requests to the boiler at specific intervals. As a result, it may take some time for changes to propagate between Home Assistant and the thermostat.

# {% linkable_title Configuration %} - +In this example, one gateway is configured with `gateway_id` `living_room`. ```yaml # Example configuration.yaml entry opentherm_gw: - device: /dev/ttyUSB0 + living_room: + device: /dev/ttyUSB0 ``` +Each configured gateway accepts the following configuration options. {% configuration %} device: description: "Path to OpenTherm Gateway device as supported by [PySerial](https://pythonhosted.org/pyserial/url_handlers.html)." required: true type: string +name: + description: "The friendly name used for the entities added for the gateway." + required: false + type: string + default: "The `gateway_id` of the gateway." climate: description: "Settings for the `opentherm_gw` climate entity." required: false type: map keys: - name: - description: "The name for the device within Home Assistant." - required: false - type: string - default: "OpenTherm Gateway" precision: description: "The desired precision for this device. Can be used to match your actual thermostat's precision. Supported values are `0.1`, `0.5` and `1.0`." required: false type: float default: "`0.5` for Celsius and `1.0` for Fahrenheit." floor_temperature: - description: "Some thermostats round all temperatures down to the lower value according to their precision. Default behavior for Home Assistant is to round temperatures to the nearest value. Set this to `true` to override Home Assistant and round to the lower value according to the configured `precision`." + description: "Some thermostats round all temperatures down to the lower value according to their precision. Default behavior for Home Assistant is to round temperatures to the nearest value. Set this to `true` to override this behavior and round to the lower value according to the configured `precision`." required: false type: boolean default: false -monitored_variables: - description: "A list of variables to expose as sensors." - required: false - type: list - keys: - burner_hours: - description: Boiler flame on time. - burner_starts: - description: Number of burner starts. - ch_pump_hours: - description: Central heating pump running time. - ch_pump_starts: - description: Number of central heating pump starts. - ch_water_pressure: - description: Central heating water pressure. - ch_water_temp: - description: Central heating water temperature. - ch_water_temp_2: - description: Central heating 2 water temperature. - control_setpoint: - description: Central heating water target temperature. - control_setpoint_2: - description: Central heating 2 water target temperature. - cooling_control: - description: Cooling control signal value. - dhw_burner_hours: - description: Hot water flame on time. - dhw_burner_starts: - description: Number of hot water burner starts. - dhw_flow_rate: - description: Hot water flow rate. - dhw_pump_hours: - description: Hot water pump running time. - dhw_pump_starts: - description: Number of hot water pump starts. - dhw_setpoint: - description: Hot water target temperature. - dhw_temp: - description: Hot water temperature. - dhw_temp_2: - description: Hot water 2 temperature. - exhaust_temp: - description: Boiler exhaust temperature. - master_ch2_enabled: - description: Thermostat requests central heating 2 on. - master_ch_enabled: - description: Thermostat requests central heating on. - master_cooling_enabled: - description: Thermostat requests cooling. - master_dhw_enabled: - description: Thermostat requests hot water to be heated. - master_memberid: - description: Thermostat member ID. - master_ot_version: - description: Thermostat OpenTherm protocol version. - master_otc_enabled: - description: Thermostat is using outside temperature correction. - master_product_type: - description: Thermostat product type. - master_product_version: - description: Thermostat product version. - max_ch_setpoint: - description: Boiler maximum central heating water temperature. - oem_diag: - description: OEM diagnostic information. - otgw_about: - description: OpenTherm Gateway firmware version. - otgw_build: - description: OpenTherm Gateway firmware build date and time. - otgw_clockmhz: - description: OpenTherm Gateway firmware design clock speed. - otgw_dhw_ovrd: - description: OpenTherm Gateway hot water override status. - otgw_gpio_a: - description: OpenTherm Gateway GPIO port A operating mode. - otgw_gpio_a_state: - description: OpenTherm Gateway GPIO A state. - otgw_gpio_b: - description: OpenTherm Gateway GPIO port B operating mode. - otgw_gpio_b_state: - description: OpenTherm Gateway GPIO B state. - otgw_ignore_transitions: - description: OpenTherm Gateway ignores ripples in the signal during high/low transitions. - otgw_led_a: - description: OpenTherm Gateway LED A operating mode. - otgw_led_b: - description: OpenTherm Gateway LED B operating mode. - otgw_led_c: - description: OpenTherm Gateway LED C operating mode. - otgw_led_d: - description: OpenTherm Gateway LED D operating mode. - otgw_led_e: - description: OpenTherm Gateway LED E operating mode. - otgw_led_f: - description: OpenTherm Gateway LED F operating mode. - otgw_mode: - description: OpenTherm Gateway operating mode. - otgw_ovrd_high_byte: - description: OpenTherm Gateway overrides high byte with message ID 100. - otgw_setback_temp: - description: OpenTherm Gateway setback temperature for `away mode`. - otgw_setpoint_ovrd_mode: - description: OpenTherm Gateway central heating setpoint override mode. - otgw_smart_pwr: - description: OpenTherm Gateway smart power operating mode. - otgw_thermostat_detect: - description: OpenTherm Gateway automatic thermostat detection status. - otgw_vref: - description: OpenTherm Gateway voltage reference setting. - outside_temp: - description: Outside temperature as reported in the OpenTherm protocol. - relative_mod_level: - description: Relative modulation level. - remote_rw_dhw: - description: Boiler supports writing hot water setpoint. - remote_rw_max_ch: - description: Boiler supports writing maximum central heating setpoint. - remote_transfer_dhw: - description: Boiler supports reading hot water setpoint. - remote_transfer_max_ch: - description: Boiler supports reading maximum central heating setpoint. - return_water_temp: - description: Boiler return water temperature. - room_setpoint: - description: Room target temperature. - room_setpoint_2: - description: Room 2 target temperature. - room_setpoint_ovrd: - description: Room target temperature override value. - room_temp: - description: Current room temperature. - rovrd_auto_prio: - description: Programmed room setpoint change takes priority over remote override setting. - rovrd_man_prio: - description: Manual room setpoint change takes priority over remote override setting. - slave_air_pressure_fault: - description: Boiler reports air pressure fault. - slave_ch2_active: - description: Boiler reports central heating 2 active. - slave_ch2_present: - description: Boiler has a central heating 2 circuit. - slave_ch_active: - description: Boiler reports central heating active. - slave_ch_max_setp: - description: Maximum boiler supported central heating water target temperature. - slave_ch_min_setp: - description: Minimum boiler supported central heating water target temperature. - slave_control_type: - description: Boiler control type ('off' is modulating, 'on' is on/off). - slave_cooling_active: - description: Boiler reports cooling active. - slave_cooling_supported: - description: Boiler supports cooling. - slave_dhw_active: - description: Boiler reports hot water active. - slave_dhw_config: - description: Boiler hot water mode ('off' is instantaneous or unspecified, 'on' is storage tank). - slave_dhw_max_setp: - description: Maximum boiler supported hot water target temperature. - slave_dhw_min_setp: - description: Minimum boiler supported hot water target temperature. - slave_dhw_present: - description: Boiler reports hot water present. - slave_diagnostic_indication: - description: Boiler diagnostic indication. - slave_fault_indication: - description: Boiler fault indication. - slave_flame_on: - description: Boiler reports flame on. - slave_gas_fault: - description: Boiler reports gas fault. - slave_low_water_pressure: - description: Boiler reports low water pressure. - slave_master_low_off_pump: - description: Boiler supports low-off and pump control commands (this sensor is inverted, 'on' is not supported, 'off' is supported) - slave_max_capacity: - description: Maximum boiler capacity. - slave_max_relative_modulation: - description: Maximum boiler supported relative modulation. - slave_memberid: - description: Boiler member ID. - slave_min_mod_level: - description: Minimum boiler supported modulation level. - slave_oem_fault: - description: Boiler OEM fault indication. - slave_ot_version: - description: Boiler OpenTherm protocol version. - slave_product_type: - description: Boiler product type. - slave_product_version: - description: Boiler product version. - slave_remote_reset: - description: Boiler reports 'lockout-reset' supported. - slave_service_required: - description: Boiler reports service required. - slave_water_overtemp: - description: Boiler reports water overtemperature. - solar_coll_temp: - description: Solar collector temperature. - solar_storage_temp: - description: Solar storage unit temperature. {% endconfiguration %} -## {% linkable_title Supported Variables %} - -The list above contains all supported variables. Note that not all boilers and thermostats properly support all variables, so the fact that a variable is listed here and published by your system does not necessarily mean that you will get useful data out of it. To see which variables are published in your situation, enable debug logging for the `opentherm_gw` component and look for the status updates. - # {% linkable_title Services %} ### {% linkable_title Service `opentherm_gw.reset_gateway` %} Reset the OpenTherm Gateway. -This service takes no parameters. +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `gateway_id` | no | The `gateway_id` as specified in `configuration.yaml`. ### {% linkable_title Service `opentherm_gw.set_clock` %} @@ -289,6 +82,7 @@ Provide the time and day of week to the OpenTherm Gateway. The value provided he | Service data attribute | Optional | Default | Description | | ---------------------- | -------- | ------- | ----------- | +| `gateway_id` | no | N/A | The `gateway_id` as specified in `configuration.yaml`. | `date` | yes | Today's date | Date from which the day of week will be extracted. Format: `YYYY-MM-DD`. | `time` | yes | Current time | Time in 24h format. @@ -304,6 +98,7 @@ In a normal situation, the thermostat will calculate and control the central hea | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | +| `gateway_id` | no | The `gateway_id` as specified in `configuration.yaml`. | `temperature` | no | The central heating setpoint. Values between `0.0` and `90.0` are accepted, but your boiler may not support the full range. Set to `0` to disable the override.

@@ -317,6 +112,7 @@ For an explanation of the possible modes, see [GPIO modes](#gpio-modes) | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | +| `gateway_id` | no | The `gateway_id` as specified in `configuration.yaml`. | `id` | no | The GPIO ID, `A` or `B`. | `mode` | no | The GPIO mode to be set. @@ -327,6 +123,7 @@ For a list of possible modes with explanation, see [LED modes](#led-modes) | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | +| `gateway_id` | no | The `gateway_id` as specified in `configuration.yaml`. | `id` | no | The LED ID, accepted values are `A` through `F`. | `mode` | no | The LED mode to be set. @@ -342,6 +139,7 @@ In a normal situation, the thermostat will control the maximum modulation level | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | +| `gateway_id` | no | The `gateway_id` as specified in `configuration.yaml`. | `level` | no | The maximum modulation level. Accepted values are `-1` through `100`. Set to `-1` to disable the override.

@@ -355,6 +153,7 @@ If your thermostat is unable to display an outside temperature and does not supp | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | +| `gateway_id` | no | The `gateway_id` as specified in `configuration.yaml`. | `temperature` | no | The outside temperature to provide to the thermostat. Accepted values are `-40.0` through `64.0`. Any value above `64.0` will clear a previously configured value (suggestion: `99`). ### {% linkable_title Service `opentherm_gw.set_setback_temperature` %} @@ -364,8 +163,319 @@ The value you provide here will be used with the GPIO `home` (5) and `away` (6) | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | +| `gateway_id` | no | The `gateway_id` as specified in `configuration.yaml`. | `temperature` | no | The setback temperature. Accepted values are `0.0` through `30.0`. +## {% linkable_title Sensors %} + +The following `sensor` entities will be created for each configured gateway. The `entity_id` of every sensor will have a suffix containing the `gateway_id` of the gateway to which it belongs. +

+Not all boilers and thermostats properly support all OpenTherm features, so not all of the sensors will have useful values. +

+ +- **burner_hours** + Boiler flame on time. + +- **burner_starts** + Number of burner starts. + +- **ch_pump_hours** + Central heating pump running time. + +- **ch_pump_starts** + Number of central heating pump starts. + +- **ch_water_pressure** + Central heating water pressure. + +- **ch_water_temp** + Central heating water temperature. + +- **ch_water_temp_2** + Central heating 2 water temperature. + +- **control_setpoint** + Central heating water target temperature. + +- **control_setpoint_2** + Central heating 2 water target temperature. + +- **cooling_control** + Cooling control signal value. + +- **dhw_burner_hours** + Hot water flame on time. + +- **dhw_burner_starts** + Number of hot water burner starts. + +- **dhw_flow_rate** + Hot water flow rate. + +- **dhw_pump_hours** + Hot water pump running time. + +- **dhw_pump_starts** + Number of hot water pump starts. + +- **dhw_setpoint** + Hot water target temperature. + +- **dhw_temp** + Hot water temperature. + +- **dhw_temp_2** + Hot water 2 temperature. + +- **exhaust_temp** + Boiler exhaust temperature. + +- **master_memberid** + Thermostat member ID. + +- **master_ot_version** + Thermostat OpenTherm protocol version. + +- **master_product_type** + Thermostat product type. + +- **master_product_version** + Thermostat product version. + +- **max_ch_setpoint** + Boiler maximum central heating water temperature. + +- **oem_diag** + OEM diagnostic information. + +- **otgw_about** + OpenTherm Gateway firmware version. + +- **otgw_build** + OpenTherm Gateway firmware build date and time. + +- **otgw_clockmhz** + OpenTherm Gateway firmware design clock speed. + +- **otgw_dhw_ovrd** + OpenTherm Gateway hot water override status. + +- **otgw_gpio_a** + OpenTherm Gateway GPIO port A operating mode. + +- **otgw_gpio_b** + OpenTherm Gateway GPIO port B operating mode. + +- **otgw_led_a** + OpenTherm Gateway LED A operating mode. + +- **otgw_led_b** + OpenTherm Gateway LED B operating mode. + +- **otgw_led_c** + OpenTherm Gateway LED C operating mode. + +- **otgw_led_d** + OpenTherm Gateway LED D operating mode. + +- **otgw_led_e** + OpenTherm Gateway LED E operating mode. + +- **otgw_led_f** + OpenTherm Gateway LED F operating mode. + +- **otgw_mode** + OpenTherm Gateway operating mode. + +- **otgw_setback_temp** + OpenTherm Gateway setback temperature for `away mode`. + +- **otgw_setpoint_ovrd_mode** + OpenTherm Gateway central heating setpoint override mode. + +- **otgw_smart_pwr** + OpenTherm Gateway smart power operating mode. + +- **otgw_thermostat_detect** + OpenTherm Gateway automatic thermostat detection status. + +- **otgw_vref** + OpenTherm Gateway voltage reference setting. + +- **outside_temp** + Outside temperature as reported in the OpenTherm protocol. + +- **relative_mod_level** + Relative modulation level. + +- **return_water_temp** + Boiler return water temperature. + +- **room_setpoint** + Room target temperature. + +- **room_setpoint_2** + Room 2 target temperature. + +- **room_setpoint_ovrd** + Room target temperature override value. + +- **room_temp** + Current room temperature. + +- **slave_ch_max_setp** + Maximum boiler supported central heating water target temperature. + +- **slave_ch_min_setp** + Minimum boiler supported central heating water target temperature. + +- **slave_dhw_max_setp** + Maximum boiler supported hot water target temperature. + +- **slave_dhw_min_setp** + Minimum boiler supported hot water target temperature. + +- **slave_max_capacity** + Maximum boiler capacity. + +- **slave_max_relative_modulation** + Maximum boiler supported relative modulation. + +- **slave_memberid** + Boiler member ID. + +- **slave_min_mod_level** + Minimum boiler supported modulation level. + +- **slave_oem_fault** + Boiler OEM fault indication. + +- **slave_ot_version** + Boiler OpenTherm protocol version. + +- **slave_product_type** + Boiler product type. + +- **slave_product_version** + Boiler product version. + +- **solar_coll_temp** + Solar collector temperature. + +- **solar_storage_temp** + Solar storage unit temperature. + + +## {% linkable_title Binary Sensors %} + +The following `binary_sensor` entities will be created for each configured gateway. The `entity_id` of every sensor will have a suffix containing the `gateway_id` of the gateway to which it belongs. +

+Not all boilers and thermostats properly support all OpenTherm features, so not all of the sensors will have useful values. +

+ +- **master_ch2_enabled** + Thermostat requests central heating 2 on. + +- **master_ch_enabled** + Thermostat requests central heating on. + +- **master_cooling_enabled** + Thermostat requests cooling. + +- **master_dhw_enabled** + Thermostat requests hot water to be heated. + +- **master_otc_enabled** + Thermostat is using outside temperature correction. + +- **otgw_gpio_a_state** + OpenTherm Gateway GPIO A state. + +- **otgw_gpio_b_state** + OpenTherm Gateway GPIO B state. + +- **otgw_ignore_transitions** + OpenTherm Gateway ignores ripples in the signal during high/low transitions. + +- **otgw_ovrd_high_byte** + OpenTherm Gateway overrides high byte with message ID 100. + +- **remote_rw_dhw** + Boiler supports writing hot water setpoint. + +- **remote_rw_max_ch** + Boiler supports writing maximum central heating setpoint. + +- **remote_transfer_dhw** + Boiler supports reading hot water setpoint. + +- **remote_transfer_max_ch** + Boiler supports reading maximum central heating setpoint. + +- **rovrd_auto_prio** + Programmed room setpoint change takes priority over remote override setting. + +- **rovrd_man_prio** + Manual room setpoint change takes priority over remote override setting. + +- **slave_air_pressure_fault** + Boiler reports air pressure fault. + +- **slave_ch2_active** + Boiler reports central heating 2 active. + +- **slave_ch2_present** + Boiler has a central heating 2 circuit. + +- **slave_ch_active** + Boiler reports central heating active. + +- **slave_control_type** + Boiler control type ('off' is modulating, 'on' is on/off). + +- **slave_cooling_active** + Boiler reports cooling active. + +- **slave_cooling_supported** + Boiler supports cooling. + +- **slave_dhw_active** + Boiler reports hot water active. + +- **slave_dhw_config** + Boiler hot water mode ('off' is instantaneous or unspecified, 'on' is storage tank). + +- **slave_dhw_present** + Boiler reports hot water present. + +- **slave_diagnostic_indication** + Boiler diagnostic indication. + +- **slave_fault_indication** + Boiler fault indication. + +- **slave_flame_on** + Boiler reports flame on. + +- **slave_gas_fault** + Boiler reports gas fault. + +- **slave_low_water_pressure** + Boiler reports low water pressure. + +- **slave_master_low_off_pump** + Boiler supports low-off and pump control commands (this sensor is inverted, 'on' is not supported, 'off' is supported) + +- **slave_remote_reset** + Boiler reports 'lockout-reset' supported. + +- **slave_service_required** + Boiler reports service required. + +- **slave_water_overtemp** + Boiler reports water overtemperature. + + ## {% linkable_title GPIO modes %} Possible modes and their meaning for the GPIO pins are listed here: @@ -399,24 +509,21 @@ Possible LED modes and their meaning are listed here: * M. Boiler requires maintenance. * P. Raised power mode active on thermostat interface. -

-The OpenTherm protocol is based on polling. The thermostat sends requests to the boiler at specific intervals. As a result, it may take some time for changes to propagate between Home Assistant and the thermostat. -

# {% linkable_title Example %} -A full configuration example with the OpenTherm Gateway connected to a remote host running `ser2net` looks like the one below. +A full configuration example with two configured OpenTherm Gateways - one connected via USB, the other over the network - looks like the one below. ```yaml # Full example configuration.yaml entry opentherm_gw: - device: socket://otgw.example.org:2345 - climate: - name: Thermostat - precision: 0.5 - floor_temperature: true - monitored_variables: - - room_setpoint - - room_temp - - otgw_about + living_room: + device: /dev/ttyUSB0 + name: "Living" + holiday_home: + device: socket://otgw.example.org:2345 + name: "Holiday Home" + climate: + precision: 0.5 + floor_temperature: true ``` From 727b1bb2a470bb5544a6e73227086e771fa41ff0 Mon Sep 17 00:00:00 2001 From: endor <1937941+endor-force@users.noreply.github.com> Date: Fri, 28 Jun 2019 21:25:52 +0200 Subject: [PATCH 024/116] Add documentation for trafikverket_train (#9333) * Added documentation for trafikverket_train * Removed data for image that was not relevant * Added information about data that is retreived * Removed redirect, added category sensors * Clarified sensor values * :pencil2: Tweak * Added information about missed weekday parameter * Cleaned up examples * Clarified examples for non required field * Don't use !secret in example Co-Authored-By: Klaas Schoute * Fix typo Co-Authored-By: Franck Nijhof * Fix typo Co-Authored-By: Franck Nijhof * Fix typo Co-Authored-By: Franck Nijhof * Fix typo Co-Authored-By: Franck Nijhof * Fix typo Co-Authored-By: Franck Nijhof * Fix typo Co-Authored-By: Franck Nijhof * Fix typo Co-Authored-By: Franck Nijhof * Fix typo Co-Authored-By: Franck Nijhof * Fix typo Co-Authored-By: Franck Nijhof * :pencil2: Fixed time to be optional --- .../_components/trafikverket_train.markdown | 125 ++++++++++++++++++ 1 file changed, 125 insertions(+) create mode 100644 source/_components/trafikverket_train.markdown diff --git a/source/_components/trafikverket_train.markdown b/source/_components/trafikverket_train.markdown new file mode 100644 index 00000000000..7237bcb4b86 --- /dev/null +++ b/source/_components/trafikverket_train.markdown @@ -0,0 +1,125 @@ +--- +layout: page +title: "Trafikverket Train" +description: "Instructions how to integrate Trafikverket Train within Home Assistant." +date: 2019-04-27 16:32 +sidebar: true +comments: false +sharing: true +footer: true +logo: trafikverket.png +ha_category: + - Transport + - Sensor +ha_release: 0.96 +ha_iot_class: Cloud Polling +--- + +Retrieve train departure information from [Trafikverket](https://www.trafikverket.se/). + +Use cases: + +- Retrieve the next departure and information connected to it for a specific train line. +- Retrieve information for specific departure time on a specific train line. +- Set up an alert or perform actions if your train is delayed or canceled. + +Data that is retrieved: + +- Next departure for the specific train line. +- Canceled status. +- The number of minutes delayed. +- Planned time if no delays occur. +- Estimated time of arrival if delays occur. +- Actual time - when it did arrive. +- Other information / additional texts. +- Deviations. + +## {% linkable_title Configuration %} + +To enable this sensor, use the following format in your `configuration.yaml`. + +```yaml +sensor: + - platform: trafikverket_train + api_key: TRAFIKVERKET_API + trains: + - name: "Morning train to Malmö" + from: "Stockholm Central" + to: "Malmö C" + time: "9:25" + + - name: "Next train to Uppsala" + from: "Stockholm Central" + to: "Uppsala C" +``` + +{% configuration %} +api_key: + description: Your personal API key from Trafikverket. + required: true + type: string +trains: + description: Specify details on the departures to monitor. + required: true + type: map + keys: + name: + description: The name of the departure, will be the sensor name. + required: true + type: string + from: + description: The station from where the train departs. + required: true + type: string + to: + description: The destination station. + required: true + type: string + time: + description: Departure time to monitor, if not entered it will retrieve the next departure. + required: false + type: string + weekday: + description: Specify which days in the week to monitor the specific departure. + required: false + type: list + default: "[mon, tue, wed, thu, fri, sat, sun]" +{% endconfiguration %} + +## {% linkable_title Obtaining API key %} + +Please click [here](https://api.trafikinfo.trafikverket.se/) and register to obtain the API key. + +## {% linkable_title Train station names %} + +Click [here](https://www.trafikverket.se/trafikinformation/tag/?ArrDep=departure&) to see an example of train station names. + +## {% linkable_title Examples %} + +```yaml +sensor: +- platform: trafikverket + api_key: !secret trafikverket_api_key + trains: + - name: "Train to work" + from: Sölvesborg + to: Kristianstad C + time: "07:28" + weekday: [mon, tue, wed, thu, fri] + + - name: "Train from work early" + from: Kristianstad C + to: Sölvesborg + time: "16:38" + + - name: "Train from work late" + from: Kristianstad C + to: Sölvesborg + time: "17:02" + weekday: [sat, sun] + + - name: "Next train to Uppsala" + from: "Stockholm Central" + to: "Uppsala C" + +``` From e5b6d9cde956b25c1a663981970ef5d306462442 Mon Sep 17 00:00:00 2001 From: Andre Richter Date: Fri, 28 Jun 2019 21:32:14 +0200 Subject: [PATCH 025/116] Add documentation for integration of Vallox ventilation units (#9668) * Add documentation for integration of Vallox ventilation units. * Address review comments #1. * Apply suggestions from code review Co-Authored-By: Franck Nijhof * Adapt to changed architecture of parent patch. * :pencil2: Component -> Integration --- source/_components/vallox.markdown | 108 +++++++++++++++++++++++++++++ 1 file changed, 108 insertions(+) create mode 100644 source/_components/vallox.markdown diff --git a/source/_components/vallox.markdown b/source/_components/vallox.markdown new file mode 100644 index 00000000000..08d229ea82a --- /dev/null +++ b/source/_components/vallox.markdown @@ -0,0 +1,108 @@ +--- +layout: page +title: "Vallox Ventilation Units" +description: "Instructions on how to integrate Vallox ventilation units into Home Assistant." +date: 2019-06-19 20:00 +sidebar: true +comments: false +sharing: true +footer: true +ha_category: + - Fan + - Sensor +ha_release: 0.96 +ha_iot_class: Local Polling +--- + +The `vallox` integration lets you control any Vallox ventilation unit that is supported by the [vallox_websocket_api](https://github.com/yozik04/vallox_websocket_api) (follow the link for a list of supported units). + +The **fan** platform of this integration allows you to either turn on/off the complete unit via the toggle switch or select a ventilation profile through the service `vallox/set_profile`. The four standard Vallox profiles are provided: + +- `At Home` +- `Away` +- `Boost` +- `Fireplace` + +Also, there is a **sensor** platform that exposes a number of relevant metrics like fan speed, various air temperatures and humidity. + +### {% linkable_title Configuration %} + +```yaml +vallox: + host: IP_ADDRESS +``` + +{% configuration %} +host: + description: The IP or hostname of the ventilation unit in your home network. + required: true + type: string +name: + description: The name of this device as you want to see it in Home Assistant. + required: false + default: Vallox + type: string +{% endconfiguration %} + +## {% linkable_title Profile Switching %} + +For convenient switching of ventilation profiles in the GUI, consider using an [input_select](../input_select) hooked to an automation, for example: + +{% raw %} +```yaml +input_select: + ventilation_profile: + name: Ventilation profile select + options: + - "Home" + - "Away" + - "Boost" + - "Fireplace" + icon: mdi:fan + +automation: + - alias: Set Ventilation Profile + trigger: + platform: state + entity_id: input_select.ventilation_profile + action: + service: vallox.set_profile + data_template: + profile: "{{ states('input_select.ventilation_profile') }}" +``` +{% endraw %} + +## {% linkable_title Fan Services %} + +### {% linkable_title Service `vallox.set_profile` %} + +Set the ventilation profile. + +| Service data attribute | Optional | Description | +|------------------------|----------|------------------------------------------------------| +| `profile` | no | Allowed values: `Home`, `Away`, `Boost`, `Fireplace` | + +### {% linkable_title Service `vallox.set_profile_fan_speed_home` %} + +Set the fan speed of the `Home` profile. + +| Service data attribute | Optional | Description | +|------------------------|----------|-------------------------------------------------| +| `fan_speed` | no | Fan speed in %. `Integer`, between 0 and 100. | + + +### {% linkable_title Service `vallox.set_profile_fan_speed_away` %} + +Set the fan speed of the `Away` profile. + +| Service data attribute | Optional | Description | +|------------------------|----------|-------------------------------------------------| +| `fan_speed` | no | Fan speed in %. `Integer`, between 0 and 100. | + +### {% linkable_title Service `vallox.set_profile_fan_speed_boost` %} + +Set the fan speed of the `Boost` profile. + +| Service data attribute | Optional | Description | +|------------------------|----------|-------------------------------------------------| +| `fan_speed` | no | Fan speed in %. `Integer`, between 0 and 100. | From 6ec17327ae6165730db4f79a51eb631d62d910d3 Mon Sep 17 00:00:00 2001 From: Luuk Date: Fri, 28 Jun 2019 21:40:42 +0200 Subject: [PATCH 026/116] Add Template vacuum documentation (#9496) * Add documentation for template vacuum component * Remove optional configuration items from example * Added more example configurations * Update template_vacuum version and date * Update source/_components/vacuum.template.markdown Co-Authored-By: Klaas Schoute * :pencil2: Tweaks * :arrow_up: ha_release 0.96 --- source/_components/vacuum.template.markdown | 153 ++++++++++++++++++++ 1 file changed, 153 insertions(+) create mode 100644 source/_components/vacuum.template.markdown diff --git a/source/_components/vacuum.template.markdown b/source/_components/vacuum.template.markdown new file mode 100644 index 00000000000..f327654fe4e --- /dev/null +++ b/source/_components/vacuum.template.markdown @@ -0,0 +1,153 @@ +--- +layout: page +title: "Template Vacuum" +description: "Instructions how to setup Template vacuums within Home Assistant." +date: 2019-05-20 16:00 +sidebar: true +comments: false +sharing: true +footer: true +ha_category: Vacuum +ha_release: 0.96 +ha_iot_class: Local Push +logo: home-assistant.png +ha_qa_scale: internal +--- + +The `template` platform creates vacuums that combine integrations and provides the +ability to run scripts or invoke services for each of the start, pause, stop, +return_to_base, clean_spot, locate and set_fan_speed commands of a vacuum. + +To enable Template Vacuums in your installation, add the following to your +`configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +vacuum: + - platform: template + vacuums: + living_room_vacuum: + start: + service: script.vacuum_start +``` + +{% configuration %} + vacuums: + description: List of your vacuums. + required: true + type: map + keys: + friendly_name: + description: Name to use in the frontend. + required: false + type: string + value_template: + description: "Defines a template to get the state of the vacuum. Valid value: `docked`/`cleaning`/`idle`/`paused`/`returning`/`error`" + required: false + type: template + battery_level_template: + description: "Defines a template to get the battery level of the vacuum. Legal values are numbers between `0` and `100`." + required: false + type: template + fan_speed_template: + description: Defines a template to get the fan speed of the vacuum. + required: false + type: template + start: + description: Defines an action to run when the vacuum is started. + required: true + type: action + pause: + description: Defines an action to run when the vacuum is paused. + required: false + type: action + stop: + description: Defines an action to run when the vacuum is stopped. + required: false + type: action + return_to_base: + description: Defines an action to run when the vacuum is given a return to base command. + required: false + type: action + clean_spot: + description: Defines an action to run when the vacuum is given a clean spot command. + required: false + type: action + locate: + description: Defines an action to run when the vacuum is given a locate command. + required: false + type: action + set_fan_speed: + description: Defines an action to run when the vacuum is given a command to set the fan speed. + required: false + type: action + fan_speeds: + description: List of fan speeds supported by the vacuum. + required: false + type: string list +{% endconfiguration %} + +## {% linkable_title Examples %} + +### {% linkable_title Control vacuum with Harmony Hub %} + +This example shows how you can use a Template Vacuum to control an IR vacuum cleaner using the [Harmony Hub Remote component](/components/remote.harmony/). + +```yaml +vacuum: + - platform: template + vacuums: + living_room_vacuum: + start: + - service: remote.send_command + data: + entity_id: remote.harmony_hub + command: Clean + device: 52840686 + return_to_base: + - service: remote.send_command + data: + entity_id: remote.harmony_hub + command: Home + device: 52840686 + clean_spot: + - service: remote.send_command + data: + entity_id: remote.harmony_hub + command: SpotCleaning + device: 52840686 +``` + +### {% linkable_title Vacuum with state %} + +This example shows how to use templates to specify the state of the vacuum. + +{% raw %} +```yaml +vacuum: + - platform: template + vacuums: + living_room_vacuum: + value_template: "{{ states('sensor.vacuum_state') }}" + battery_level_template: "{{ states('sensor.vacuum_battery_level')|int }}" + fan_speed_template: "{{ states('sensor.vacuum_fan_speed') }}" + start: + service: script.vacuum_start + pause: + service: script.vacuum_pause + stop: + service: script.vacuum_stop + return_to_base: + service: script.vacuum_return_to_base + clean_spot: + service: script.vacuum_clean_spot + locate: + service: script.vacuum_locate_vacuum + set_fan_speed: + service: script.vacuum_set_fan_speed + fan_speeds: + - Low + - Medium + - High +``` +{% endraw %} From 237181b632b4b8835823afc62e099981c7068db3 Mon Sep 17 00:00:00 2001 From: h3ndrik Date: Fri, 28 Jun 2019 21:42:48 +0200 Subject: [PATCH 027/116] Add offset option (#24600) (#9647) * Add offset option (#24600) * add description --- source/_components/deutsche_bahn.markdown | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/source/_components/deutsche_bahn.markdown b/source/_components/deutsche_bahn.markdown index cc653756249..012ace6beea 100644 --- a/source/_components/deutsche_bahn.markdown +++ b/source/_components/deutsche_bahn.markdown @@ -37,6 +37,11 @@ to: description: The name of the end/destination station. required: true type: string +offset: + description: Do not display departures leaving sooner than this number of minutes. Useful if you are a couple of minutes away from the stop. + required: false + type: time + default: 00:00 only_direct: description: Only show direct connections. required: false From 1b44e8625d7e5bafedb7939eeef5e6e7ded031c1 Mon Sep 17 00:00:00 2001 From: Gregory Knox Date: Fri, 28 Jun 2019 15:50:59 -0400 Subject: [PATCH 028/116] Update map for 'dark_mode' property (#9716) * Update map for 'dark_mode' property * :pencil2: Tweak --- source/_lovelace/map.markdown | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/source/_lovelace/map.markdown b/source/_lovelace/map.markdown index daae59d69f8..f06f10e374e 100644 --- a/source/_lovelace/map.markdown +++ b/source/_lovelace/map.markdown @@ -43,6 +43,11 @@ default_zoom: description: The default zoom level of the map. type: integer default: 14 (or whatever zoom level is required to fit all visible markers) +dark_mode: + required: false + description: Enable a dark theme for the map. + type: boolean + default: false {% endconfiguration %}

From 91b74d3631ef9616406db9d6a5bbf42b9a193f6b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Thomas=20Lov=C3=A9n?= Date: Fri, 28 Jun 2019 22:05:39 +0200 Subject: [PATCH 029/116] More detailed description of js imports (#9715) * More detailed description of js imports * :pencil2: Tweak --- source/_components/frontend.markdown | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/source/_components/frontend.markdown b/source/_components/frontend.markdown index aae2db6d12c..965fc3f11cd 100644 --- a/source/_components/frontend.markdown +++ b/source/_components/frontend.markdown @@ -128,7 +128,7 @@ When themes are enabled in the `configuration.yaml` file, a new option will show ## {% linkable_title Loading extra HTML %} -Starting with version 0.53 you can specify extra HTML files to load. +Starting with version 0.53 you can specify extra HTML files to load, and starting with version 0.95 extra JS modules. Example: @@ -137,10 +137,12 @@ Example: frontend: extra_html_url: - https://example.com/file1.html - - /file2.html + - /local/file2.html + extra_module_url: + - /local/my_module.js ``` -Those will be loaded via `` on any page (states and panels). +HTML will be loaded via `` on any page (states and panels), and modules via ``. ### {% linkable_title Manual Language Selection %} From 76fb9e7fdf17250bc246a4f5ef929a5887a719d9 Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Fri, 28 Jun 2019 22:07:01 +0200 Subject: [PATCH 030/116] =?UTF-8?q?=F0=9F=8E=A8=20Adds=20Vallox=20logo=20t?= =?UTF-8?q?o=20integration=20(#9717)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Franck Nijhof --- source/_components/vallox.markdown | 1 + source/images/supported_brands/vallox.png | Bin 0 -> 11541 bytes 2 files changed, 1 insertion(+) create mode 100644 source/images/supported_brands/vallox.png diff --git a/source/_components/vallox.markdown b/source/_components/vallox.markdown index 08d229ea82a..c5bfc7e7e99 100644 --- a/source/_components/vallox.markdown +++ b/source/_components/vallox.markdown @@ -7,6 +7,7 @@ sidebar: true comments: false sharing: true footer: true +logo: vallox.png ha_category: - Fan - Sensor diff --git a/source/images/supported_brands/vallox.png b/source/images/supported_brands/vallox.png new file mode 100644 index 0000000000000000000000000000000000000000..e8c0b6a3f708b5cd33a2ba4b618ffb5a04a76383 GIT binary patch literal 11541 zcmYjXc|4Tw*QRXQx5%FQ3W*_vY#|ESw=6@HFtTf89Y#pDLfOWiouQ2E23ZPYUurN2 zV;!ooWS#dJ{r-6W@)`GY&V82aT=zNm^TZk(-eaQYrKg~vVA8#R*OY>S7DGWnnM!va z_|L0qEi>SctnmYLZ4!w@VOLIJTS{S7L}8jwVUkB-kWFzvgTmqig>?x9xSZl)F@;eM zg-t1iZ5f4L7KM3X`FlFDIGewzp&5mWcl*lr5orh^RJ|8tbvk1xT#w z%FT%wpUX0I)W%f(1vhpb2(wRCo(;#7D#95lDcWV&YhT%w2Te2Vpl_I_OHfi!w40=B zn-gR`TR(UgJOs8dZgg%X@EwXgW(R&y-PiK}!LrsY13Va>)mP9TW;f?N>c}3W3ln!> zhedUA`e>mw;4;}2d4fs5K2|W5EqS6{%A^IJ*rYcnHwW3iihF-hC^j+UPpb0v9%&pu zzL2dykjvguk{FtG-Xq2Eqh$P>=4Zl|^ku{km%q#`h0FLDuT}iQ{Kh!yDX6=X9&f9# z{zn_}Wcq9P9hxoJ53i}_A3riopBRG-hl}37V11i0eo5%rhIa8zlX&rT{rI0YLy}~{ z)86Dbo0}37x%gp(RwD&u>fq%I9%n4N%Vmh9&~b1L{W-0EJks-!igeqR8DmmmYa%Y> zn^$l5qzPs}QGA>M@10pu!1gjsp0iYzi^1p3oLk+srC;zYqIP6OD3AV1bdjX1gaV=? z>IHVpJ4>g5ydgzZ`u*n_BmK_v-r7YPdDUt8xhB3J(Z2+C8B={#U}k!-S#1S|8F`<& zhUMXGSW(=XzysI}ed&ZFhUW3Twa`7Bf7EE^{IPL5OOU(98{s=-1yy&=?d21L58>Js z&!1Bq%69}#+A1G<$=uX3Jsz%tB|-?}@2BZ7@U?(*owfUU+Q%D*=qt=mhKe zR|o*Q&8vUrt0jwVaJpuFciA>jIZ?*gy?jfpqkI;Upb5KpxzQ>AGD+g$X2suXRz_hZ zj8Szfr^A`>L*}9VD`u8|H{lMGZJo&07N3AL_yjX1U+D&^ADbMZ0r^$ssbLq>?^g2U zm*9o?z11_VH3;HC`e)Xy)WjYcxy=yf-1-1mh+%LW_aEBkFyvrndCwZw>kZSjL zy|!58<~96W4UIA%xD#O#@1ne$)$XLLD_R|QEeZ9lK4u3J1Ww)iSsi9LSM=VYCQM}3 z4cXDy@ng@_L#O3vEni8l-dwqlzb}r|A~&*<*|ZZ43H8Q3mB(6rdrEcYN5r6g@kq`w z+Dun?MsN+<5PWEQofx@cNq=VU2(I;#mkMykOc#vIM#e+_>cz2AA^2S?q$Ucj^1H z00;7`TK!Jj>_*C7>?Dj{2?sF_*6v?!sNy`^_9V9|0onVT{)UF|Oj)-1QE1138P4pF z43-+r0py(BZ9@_=8(^!i(ogV3(!p9= z^lM!}_)in$ylfA+c7yxk27|MNeZNUg+B6usqSOnxg~%}^a-)|1X!Byef-Z7)s%jT2 zW9!xDKD~E-eEuUAh*CgcDd(3udw-i_k1=pfKWqGt6tzE#@6^v^{UWgTZ3eAPGs4#& zHc!@^S3j(Dcl;x@sbBPnTwlnk(S8RG&tR$B76G{@ta9@D=+KU9H5;cP|D5GwKM!_m z0?Z;p4T2f|A_t$Myx@T5*(AW9qtQ~2IgE=n5}T5$;k`vLpGrDDcu2-t+&iSxWeK6J z-)*ix*@Ql{-Bhf`jS&VfsQUnbiXFHx^v<&vDQDoINPR@RvYz`qgO32WqXfcte&P?I z$z~~TkXmj1`c@jLZ@wi^$kOaWJMyav}Xfa7}9z zV2(A?Kc{}vhHlDtXBu)8KeB;WrQ5nreTKqpti^B)bbF$Xb&C$hvwQ0*%j@0C4d(wq zcw4nK4>p{>j`|dgTMdet72C~a+1L}L3K(dz1~%nSk0ch+SqOygss7UVl~EE_#852c zRChGWpXryTR7A*nEIhLyy?k|u8xi1+QvDZLLltLMkRDZTzB&C}CRwQI;Y z00(4!Upx`c{anz_kdA|2Y9)Bn8ge3&h*TzFJKWj&b5may|1Jq37<^t_h=;c3H5w1k zki^>gGivFcqvvZY+CZdvyO=L#&rlm^8X%$(N{Ru#m;GupU)0jsKk{HGq>K4BU_DGa z%2Se~#m|R`YgQTFt7L0kziQ-!a#42CaM-5+>Pwn-rP)My=I5A6TB^|)UrbE9bvq=W zVNtT6&8?>op2kmb!m@(Ks)l+0O}v*go5S z^jEPZt#zbr^?xjM!X#7t6(tyG=F6Q+NjU9j{Np{nyYUZK=agB%9?`wI4&NbkuPfy{ z8h00c4}f)yo>u(y2&Mc{ zHW&A=%$o`>?B0qH&3N3#SMliLo0E=1`0FmEg$R6*hMz^-t395k@ySaYNB`q|!9`X_d3Qwxf{N~8y$lmTy>6vY@{i>+QoqqNF z|6c)pG!!XmT^N~-B`&Wbe!Fr_%uz)}DpT;)6?Y;Q>!e)Y7Cpa~VA8_j7^Z1IZON=%sdh(>0E*8*;ajzuJ3Ekivk;5BjsF-aQ$wJi-1%Jv;}&k z+pPa88|M*%hSsCXl}~PxJ}_l6P+?Z4Z!gxBP@E{ahc6}1hm4sEIGxA?1zm;W=B%w+ ze={9#^ioh5PDJ`>DN33H3mJT07TpZFlKe9egKu^qNYs5o=EUA z*A3ya=JiIx*>;S7$MH_n0HH|I(eTk4tK8)&`J)u$;f=ExLVQBd1L@t*^HqS{NP4#* zFd?sqc78|yUmzb)4yeq+a#Bv&f8&Dey-Bt*OWpLue^stG?|R#zp|wX*aR>_Ae?4*< z%MJs~5|1ck^{n9;rCl+dJ7l|dg5ahBw4}CQOl_#RHA-zcA?u;^^65Dfd!Tv|)0Xtu z^yZ^pJ7LA4K6IK!iURQLg9t5HQDViiSC~K5N)jiS6VC|fT{Dz$wc_pi&gHXx+3~OzE$3lYm3Gesj!~{^tC~hX7*^Ozqc65!8*A z-V?t!8yv>P6gZe><{M>IislM9;KVNg{@){pg0V2KkIhM;hhGkQvgMJ~lRx@gjV=*j zLu9H!6dr`Bp@UzjBFmbKIUeskOL~oQJ@4y?B8i;AkEVCWr=IjwEO666@dQ4r5;i$?ao@eQvC#4ynJddQ$a0mI(BVoVqNo65B;uzXq)|4ln=C5> zW9kL=H~;glR&ar+I@CA6BySyPPqL&mK=mAyF+>>7lr z9|{rgSF=V>5TnjxFAN61)bRFq;s=gxKRIqhKgmQtr@xfXK><*D{Mqx*(423+5Rf5$ zO!ZLC7YI}tF;+A==C8mcc}=*Ost2eelX>$=uOpRWW({T47t zA?vL^7ztCWMh&G<*AIk4JDNdu%v>9maJ8{uAPIpFR2?7ear+14N~gySZu4+cCA}fB zT?+rF_~D~Nt74BayQx;#L^u>qwEsT#zWO$7Ow0T9q3D-v zaXMf}2Eo{yGB6E~+$T0`d)j0#Syti~b3zNrNhi30eZaqzdJ|^X;%I=dx~yn;M+SaL z8RO3!%Ylj*EIV+Mo>fm-qZfr0jV85%Z=a6=PG=J8R&N&RWOh&6+cuFHr0X4ad;5bY zzeQu|j(mPM^Jcx2n|p=C=ct7E&d~bV-ot^hc+6eXQR=o3ang9_*Yp-c zA=pa*==`>{B2P>8X`0ZIAC1qgD5$K(wyh}wt>l>?GWW+s*mzJ=kk=3$&&ichNjt16 zS6RcaZ2%l9@1xZRz&<%noNCf^!G7tR({R<$*YY3$8Cqp-j!3JfO_#!WkXXc3#p)4z z15Zv@ASm}tFMhGBhBgYR+q&F2I_@~&@&I)Ybdq@hgFlykuj|0+kKu+H9h`WrhM9^v z@7*mx-T5*~zXjEWFCRb}XgDik>ILYU)joM)ag_?+Y1)9ams~Tfy)YP48`UBcbP4EI zjW$d>`4MyQ>KWg6|0!MaQY>ifvUYIcE#G#0vbVvj|}lpBQoO^ z0@_BYOJuVbhlZ+hlDw!+&l|-*`SZ>z|?sVlogU58} zQwilPqX%mb#UqGV#-bWsJzzXLn|C(UWluaO%LppUm_g3JEmSM#R#w|xxi2LEk!TKm z+IVtzVyx=w&%W@zz)0dV6*}a*Sa~3qN%_cPZp&^rpO*1YFXxYAtutds>~9137e;+u z=nnNw>p+`jcd;Ub2756T1C@M$!*sV_upY8iW9H4cWfSLB`0jO-J*XnrKNa{8;ym-Z zujwGJC~{s!Da|d{8S4XyaWOuw0Sz>t-^uUJUA+swmmc^0#~M3R=W_p;q=4 zp3(v)nG#GAbNL6kJ@XhpKIIpN`77X_3uW5q{gXC!OvLjKTG2pXe&3#Dl8g}ucy{7q-6Rj&JD!=%*RNmmHDvxV`x%xt%)hj-q}I7$9EQT7CpL{; zH?b_R!q)3*5sZLK#`h36K|zCA-))8^cq*Ba-~I7{#@9a0$@{nSn!8NcvA=bIjSzs* zS7Lj{q;FeZC>Dd}1)#hd4P}j7MPpq<6DbK)E7lR3i>k{7x>-^{Fr4*hyqe6b^sP)z z7^O5Ob-kt3aJW64V9Q;%YrwLF4a&VPB6>ee)a;y#Ac7&W{#56vJaaPuxcWej>IK_; zsQa29VB@VOqKJ-H7GW`vFZz1cA{S{e*?kxzTs_|68AdV=2It{lLcCbOO>bXa0FwR| z8Yyj9IdTt$cK%`bH{rs~wUj-1{P&?+KFVi>6&%(DtLN=jq5 zI}jR@rCRZwn!~xGyI8z|?#wQ~@~AU@d~<&{Ynyz8;0FrqIp0QoKMT}l>(u3<*^@Y3 z0M0Cf?sT-PBte4#{a(D zV8A|o>EChM#-SdR@y45NShwsHM5p78gwi#+{a#g zbN9mYKcsm{LdO!MhR^sIUFrSG>GQ_*2k?W-<4GHnO($spU36|rdXkNvNRt;H$w0>l z4jX!hx!(Jmy`^)+jvwLy;;cmksTWuI=p6Xg;zU>mL30?3F}W4tIZ>Ox)@PQ`s@DQ>cjIavZt7Ib$P_p*iLnQ4$$mpO2BT( zaaVr2E|ENMw~xjG!RJ~xA~ym+$9P=W7eVgTK(~+0iRTj7+^=Q<2?G{X?prGpDYN!I zUUKLQEnlHuCuNZ*Pe2{eVdZ2Dk@`s_54+SCYjdTsXXOBhc`5lr485iNObjDNPH(D| zoQ*?(Oh_Hix*pKRW3Vu!8A;RN8F@AYW}bt`ehc&+2Oc5GEjt)I$61Jgm9UFaS_!Ss zwyqSONGo86UJx>P01^NMv_Y+5RgW`R>)566I>8LCbt-^4%2((!`OIUA?8782X+0R) zuUyb>YNSSKBi#IeGsrVs>{|2fu$#dP^mTLZo{gx41T&hxn$hv9a{y%hVt4~e*J7Gp zCrVMRuot!l@ex#?T0Dl6-PH2KL`nSVPJCXV-^7wxKceQ8n50eyyFQIRwVV|$QuwbR z-Jnp%Aqq%@(F52zAayM1v+u09?ag$HE{a=g-2M51;1wfn*vs6r!=jTd5?^r*J)Y!W zr0LU7h{Yf{?*LHGYA4g&XSqi`^pYMw%-m{LrFlaOfo+t#h|2iwM82pyQ5c`eO zB7MT!m+fg@0Ui0Sx9Wjoq7g_i;ok>3c*qrxfbXl?d!(BC$Qyr;}6&^tCR@vNR) z)62I(k>tRTtoc&wP}&Yv_Q>9L$kYhgMU5{?o)yR2+<6iWh5$DlFvFEOF?brw<~QUJ zFkm$r@wYoI?FoO_5egAz1a}nZZR>mT5kX;kDBjm{!wNN4G%w15m|9n++qy7^f5_A# z3M6V)6k#&jwoz@EG9}H1NWyR{#^l`mSh+_Y?q;+&kG&0Dnvcgy^bNc`o-7uVDoYDd z|IWNLh@U9r)2Y)IyPZTwqxrW(YjDRl`wW0pnD&k^_2RvxV}?>?DCBM#KM;n;UtIpHIL)`HV*V9V^oD#!)p3YOI1# zSn@jsFR}3gjppBnTl#}^Ja8fg>x#b7#7Sn8qFzItI);K3Vz97Wjmv+xs}lCcI-ilb z1f8ck%7@Ww`+C|Oq`K9i6geNQ`(Xa;RRdBb02;qnzxb+F(Jg>wkcVoD$?071*_3wz zcaXutiUj>XNLW8`Vzs+lcyjAU4im7`dCoesi5&1;Qq>D_BG-!*J}sHQJzviJRmaDd z?`gw~M{`pjN-@)PbjxC6F!uZ8hAa&KD12bpYIQvn3fy7=OTl-O3`DxZfmjf+KBkL` zzWr%J*I01p7j2>(SutPF_)5L{UDl_c<59g#bm@55J052bnrt0s5%TctMEmx3L**J* z(89W0(>UFr!p60>Cp-IsfWt7m*g~sxqp+4ksNaZEN8oeM{O^cQDL_YauriT><5{jy za>#z6mB!l<=o_Xs0Xg~&)cC272dCsc-CS->oNo}#3M0INMu7F~Zi<-Xz8v-H&q#|+ z(>*}uVEq}21*9MhkcpH^n6ILP%3R{OFk{C-^Ol!c>cbb-;c|wo-e22}{e=KLiIfKBBdnlfU|}XR|QEk5VeKjLFnAhJC?!c&l3ESl_^>+wea5&eP{gI?6_s`9T7Y5ZUfSa#Sku&=T z!dZ9gL?+rF=M(c~=?wRA|DJajSWlrma1Hih(M;pjGHq&iy~hn?J9qMm8t*TNT^=5D z6sQ>GNna@NPmQ7e$6Erba|4HKriBAF*FP(+0+ZtL7%zOx^{O1nMFeRWTx*^@-y$9l zMUh`S*f1$@Xl6S3G~s66j1=i)`nbhI$H}eB?*Shtv*SX;%o1E>Rl9|nd=ixfU}(vc zhea(Up;Q&5VWB=jxSRD7;jF2k1?8{*P9A}*2Mdlft{L1Aa(*|GNFHUpDoy8GUYG9T z-@YYhUd#DuK0tK`43^4P4r;3A+}AyU$@`RTwp=OM73kAKM%l)#&f{UHHkA*i|1vq= z2mlLHLdXcR`60AYEDd`17U>lxgV0vU9!b0o=zl+?mE?CmJq=HE^BXy!5W7Uk_tGa% z#}{FU;Leas+Kv8Y76Ul-n^-pBX`w0myM04R_WA*;VV@Ia4wSDbqEmI0n}8!IcYk;! z*GtW3*($hr)%1(4+B=r>NH!D3(-szzIdKQDYg?MwjJ3>%cvj&Xz1A?;lFOpiRBqa2w+#+<1vf^cDZvF|dEAR)0+~ zeIxbK+Tl8;v8%fo=X#GkPR$L6j#bQ48@qWw$2L2Hn2BXDMlmv01$LW`_#*Ao?9QzQ z?#C5Zy`EQbL`{eM1$;l+2MH0z1iSFdLB4Xp&B|_xX6yg%$$vyt=L)IXR`t*thIU^8 zLue!CshV}q{E>`_TRv2Jzt1z6#kZ0BKp{4&-L;oYlrwS(m|g1k`gPKy6MiyojPMlR zf3V7OyfT$xZ4aHQ7;9KPE>O6$X7os&j9c^%)r*rPgy3fPI%O$0~TL}wl4$lvn zV;4v5l_)45dKH|`#BLa^_CA+~d8zTxup;at zwH119fL>nRn23&>C2D68mHJ3lsYxC*PjZ@aePrOE1xRi?Y_;Kt67w6kUg^zKF-wOH9)(?EV1Q~dFS2%_Rsp}Y+J;#rK zg%#1->VeMVTjRv*J^7PEVs81|3yjnNy!h$f2z1K2YQ7L#-xxs|k zSw-Kb{u39Uz8`cbUZ-q%CKiziTRJR#BM|S6yWu@Cu;%vxy&7`u{*?qc^m6tSFQWo{ zGiB<1)K;C~GoAR0Q9TE7ij)K&1Y`1vbw0j6LLs_g#y2uM2N|Y?KFqEPJU|vZcTFO0Cq7h0gvz?+b7D~U)otKc zScg5?>-0To6(BePhl|uM=o@fs!4I0rB++olDje#hg+c$Fk+^kEy;5Kh_W&;}znh9( z7-eU4WeLZM)J5{i3x%{MZWPWwoh~m)H)Wv6Ho6lm7Es{5s0Wb;g|(_}CRkU&kzcxH z?k~2S!)h5Y>){JI1B`?rChSMuDlvUxcebvFcKGW;R@BCSYl%=v>fu+T+5NL&sV?Sa?jp22M$!G;Usc?p=t_vg+zt zL^FbF9_tZ+`IeI4*j@%WZ7(nM`oUYp=EVp&1Pk1eM*WJ;8FEE)jY|dopoZA*FsgU8 zr0stUtl6GGnL(_6E!@A;Y|#0iTZ+K=u|NGqpUX%o8)PfbR@sOm`UDO&z6lA-$LET! zC@ye5^7c~u)BZ&YTHu4@kAyz6FKs+0@Zb$%PJOo1c@(yP(^~Xt$+#h&SHIqh5? zw4)>298+&zbRQ9E9@6+btM_dJ)s-pTrIP~a_^}QKCKS8*^?*h7?*b#K3XuDB1OB+6 zn-#(>I54N}Y(MmiPHw~hXa~AI%@wIe?e55o#)ld!L)r@QLM%%+p-5@nn#N$Sz6VN0 zmW2Mha>It}AjJm1@`HzO{9sODN;3opjI*HJpzYn^L3?_@7Bfsg9MQ}{R1@%I-H=>P zwV^V-;5wBE&m?uq*nDJL?N@U0e7@xdwYnF!AvZ{JwhPlZGTU{MO*E#y>Z2z=$GtR@ zonCEtBD(nusA%p=5 zOU@!X982x~NJkzGtl6IW-}W4ee`yA}dVHlp;-b5Wjk%pMajM#@Tj!DKARBSvPyx{w zTcJ6#5MZE^VH{^U3J};x&Isn_210fOUy*q8Ja(%qVY1n8hE?K{Z7Uj@P?ox zz~I@Tvo+0lSRUR>$)#K8m&Ojd&9X~{@s7bs>W6jMDL`|ZssR&`5-gB8T)7hSR$mLQ zgoeinC!ANM_#_p3ah9WGB-6w`Rc?MrF4m5H#I!-^!PQm5MQ!toDF z_(2o=v;oUK?^w(Ner`HQW4JWWb!lGLTs-z>z&gvYrj-MgKnp=SGPa63or)=X4Qwfc zxc*r2uFQIT4!gnS1UcquL^|;%JF1$UYN0UITW|%P`T^@?Tnh;Z<)uZK$ zZOeOTFg>?|b(?65OO|QyPn$>0VZCy~kb4+F{jD0a-)QX@(J{fG?l#vhwt%Uw{2@+` zGbD%YG#Oc8@duM%ZwaEtJwCIJT(od%ajKITM^fV6tC&Gt zq!~81Di%3<4o8wJ4x%&pPOm3&<-IfGvHm|H&4ecrt*ubH zbDIxJGbUQ{@aV^E{JV{I^tv#WmHl^11w?uFjOoyp*TN2SvL7?+spUywGn}ev@*3jx z(b~iG=h$KgB`I=RGT!}X-;s^(ts zntYvk0xR0ueX&e3CbMdwDxbiPTd|f*7<1oVh9~8(6vwVbW=*_QqU3TjjgBF?i*~qX z$-4iU8#5-{k!AWc`h#=NWk2VWwPDfMIXN-&^Mm<#*s~QWWw0z5l}-wDcPqaRtZU(?vqzdc^_VHz)ll!#r{2M{fbV?4 zOs&1CR;;4+I)I=?Wzeg@9L~5b;In4Mh@PPRzgs4%J>P8ks3<59@*@Q#`rk=E)yp$3 b{F+m!u+-qkKKTS_rl8Q(HoS|}d<6eLJRccS literal 0 HcmV?d00001 From 1defd6c2d0514ec90f0704687b3c04e5e9d71762 Mon Sep 17 00:00:00 2001 From: Andre Lengwenus Date: Fri, 28 Jun 2019 22:08:47 +0200 Subject: [PATCH 031/116] Examples for LCN service calls in yaml (#9672) * YAML examples for LCN service calls * Add LCN key states --- source/_components/lcn.markdown | 135 ++++++++++++++++++++++++-------- 1 file changed, 104 insertions(+), 31 deletions(-) diff --git a/source/_components/lcn.markdown b/source/_components/lcn.markdown index bc6197675e7..865a7662d0d 100644 --- a/source/_components/lcn.markdown +++ b/source/_components/lcn.markdown @@ -397,8 +397,9 @@ The [MOTOR_PORT](#ports) values specify which hardware relay configuration will | Constant | Values | | -------- | ------ | -| LED_STATE | `on`. `off`, `blink`, `flicker` | -| LOGICOP_STATE | `not`. `or`, `and` | +| LED_STATE | `on`, `off`, `blink`, `flicker` | +| LOGICOP_STATE | `not`, `or`, `and` | +| KEY_STATE | `hit`, `make`, `break`, `dontsend` | ### {% linkable_title Keys %}: @@ -486,8 +487,13 @@ Set absolute brightness of output port in percent. Example: -``` -{"address": "myhome.0.7", "output": "output1", "brightness": 100, "transition": 0} +```yaml +service: output_abs +data: + addres: myhome.0.7 + output: output1 + brightness: 100 + transition: 0 ``` ### {% linkable_title Service `output_rel` %} @@ -503,8 +509,12 @@ Set relative brightness of output port in percent. Example: -``` -{"address": "myhome.0.7", "output": "output1", "brightness": 30} +```yaml +service: output_rel +data: + address: myhome.0.7 + output: output1 + brightness: 30 ``` ### {% linkable_title Service `output_toggle` %} @@ -519,8 +529,12 @@ Toggle output port. Example: -``` -{"address": "myhome.0.7", "output": "output1", "transition": 0} +```yaml +service: output_toggle +data: + address: myhome.0.7 + output: output1 + transition: 0 ``` ### {% linkable_title Service `relays` %} @@ -537,8 +551,11 @@ Example states: `t---001-` Example: -``` -{"address": "myhome.0.7", "state": "t---001-"} +```yaml +service: relays +data: + address: myhome.0.7 + state: t---001- ``` ### {% linkable_title Service `led` %} @@ -552,8 +569,12 @@ Set the led status. Example: -``` -{"address": "myhome.0.7", "led": "led6", "state": "blink"} +```yaml +service: led +data: + address: myhome.0.7 + led: led6 + state: blink ``` ### {% linkable_title Service `var_abs` %} @@ -571,8 +592,13 @@ If `unit_of_measurement` is not defined, it is assumed to be `native`. Example: -``` -{"address": "myhome.0.7", "variable": "var1", "value": 75, "unit_of_measurement": "%"} +```yaml +service: var_abs +data: + address: myhome.0.7 + variable: var1 + value: 75 + unit_of_measurement: % ```

@@ -595,8 +621,13 @@ If `unit_of_measurement` is not defined, it is assumed to be `native`. Example: -``` -{"address": "myhome.0.7", "variable": "var1", "value": 10, "unit_of_measurement": "%"} +```yaml +service: var_rel +data: + address: myhome.0.7 + variable: var1 + value: 10 + unit_of_measurement: % ```

@@ -615,8 +646,11 @@ Reset value of variable or setpoint. Example: -``` -{"address": "myhome.0.7", "variable": "var1"} +```yaml +service: var_reset: +data: + address: myhome.0.7 + variable: var1 ```

@@ -637,8 +671,12 @@ If `state` is not defined, it is assumed to be `False`. Example: -``` -{"address": "myhome.0.7", "setpoint": "r1varsetpoint", "state": true} +```yaml +service: lock_regulator +data: + address: myhome.0.7 + setpoint: r1varsetpoint + state: true ``` ### {% linkable_title Service `send_keys` %} @@ -653,15 +691,29 @@ If `time_unit` is not defined, it is assumed to be `seconds`. | ---------------------- | -------- | ----------- | ------ | | `address` | No | [LCN address](#lcn-addresses) | | `keys` | No | Keys string | -| `state` | Yes | Keys state | [SENDKEYCOMMANDS](#states) | +| `state` | Yes | Keys state | [KEY_STATE](#states) | | `time` | Yes | Deferred time | 0.. | | `time_unit` | Yes | Time unit | [TIME_UNIT](#variables-and-units) Examples: +Send keys immediately: +```yaml +service: send_keys +data: + address: myhome.0.7 + keys: a1a5d8 + state: hit ``` -{"address": "myhome.0.7", "keys": "a1a5d8", "state": "hit"} -{"address": "myhome.0.7", "keys": "a1a5d8", "time": 5, "time_unit": "s"} + +Send keys deferred: +```yaml +service: send_keys +data: + address: myhome.0.7 + keys: a1a5d8 + time: 5 + time_unit: s ``` ### {% linkable_title Service `lock_keys` %} @@ -669,22 +721,36 @@ Examples: Locks keys. If table is not defined, it is assumend to be table `a`. The key lock states are defined as a string with eight characters. Each character represents the state change of a key lock (1=on, 0=off, t=toggle, -=nochange). -The command allows the locking of keys for a specified time period. For a time period the attributes `time` and `time_unit` have to be specified. For a time period only tabley `a` is allowed. +The command allows the locking of keys for a specified time period. For a time period the attributes `time` and `time_unit` have to be specified. For a time period only table `a` is allowed. If `time_unit` is not defined, it is assumed to be `seconds`. | Service data attribute | Optional | Description | Values | | ---------------------- | -------- | ----------- | ------ | | `address` | No | [LCN address](#lcn-addresses) | | `table` | Yes | Table with keys to lock | -| `state` | No | Key lock states as string | [SENDKEYCOMMANDS](#states) | +| `state` | No | Key lock states as string | [KEY_STATE](#states) | | `time` | Yes | Time period to lock | 0.. | | `time_unit` | Yes | Time unit | [TIME_UNIT](#variables-and-units) Examples: +Lock keys forever: +```yaml +service: lock_keys +data: + address: myhome.0.7 + table: a + state: 1---t0-- ``` -{"address": "myhome.0.7", "table": "a", "state": "1---t0--"} -{"address": "myhome.0.7", "state": "1---t0--", "time": 10, "time_unit": "s"} + +Lock keys for a specified time period: +```yaml +service: lock_keys +data: + address: myhome.0.7 + state: 1---t0-- + time: 10 + time_unit: s ``` ### {% linkable_title Service `dyn_text` %} @@ -702,8 +768,12 @@ Each row can be set independently and can store up to 60 characters (encoded in Example: -``` -{"address": "myhome.0.7", "row": 1, "text": "text in row 1"} +```yaml +service: dyn_text +data: + address: myhome.0.7 + row: 1 + text: "text in row 1" ``` ### {% linkable_title Service `pck` %} @@ -717,6 +787,9 @@ Send arbitrary PCK command. Only the command part of the PCK command has to be s Example: -``` -{"address": "myhome.0.7", "pck": "PIN4"} +```yaml +service: pck +data: + address: myhome.0.7 + pck: PIN4 ``` From 04ea9a1ebffcf8d40ce7db9ab406db864b4b7653 Mon Sep 17 00:00:00 2001 From: akasma74 Date: Fri, 28 Jun 2019 21:16:17 +0100 Subject: [PATCH 032/116] notes on using states(xxx) vs states.xxx (#9687) * notes on using states(xxx) vs states.xxx as per this discussion - https://community.home-assistant.io/t/using-better-templates-with-state/122912/14 * :pencil2: Moved content to warning message. * :pencil2: Tweak --- source/_docs/configuration/templating.markdown | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/source/_docs/configuration/templating.markdown b/source/_docs/configuration/templating.markdown index c7922331d79..d7cf62b6b8f 100644 --- a/source/_docs/configuration/templating.markdown +++ b/source/_docs/configuration/templating.markdown @@ -57,18 +57,24 @@ script: Extensions allow templates to access all of the Home Assistant specific states and adds other convenience functions and filters. ### {% linkable_title States %} + - Iterating `states` will yield each state sorted alphabetically by entity ID. - Iterating `states.domain` will yield each state of that domain sorted alphabetically by entity ID. -- `states.sensor.temperature` returns the state object for `sensor.temperature`. +- `states.sensor.temperature` returns the state object for `sensor.temperature` (avoid when possible, see note below). - `states('device_tracker.paulus')` will return the state string (not the object) of the given entity or `unknown` if it doesn't exist. - `is_state('device_tracker.paulus', 'home')` will test if the given entity is the specified state. - `state_attr('device_tracker.paulus', 'battery')` will return the value of the attribute or None if it doesn't exist. - `is_state_attr('device_tracker.paulus', 'battery', 40)` will test if the given entity attribute is the specified state (in this case, a numeric value). +

+ Avoid using `states.sensor.temperature`, instead use `states('sensor.temperature')`. It is strongly advised to use the `states()`, `is_state()`, `state_attr()` and `is_state_attr()` as much as possible, to avoid errors and error message when the entity isn't ready yet (e.g., during Home Assistant startup). +

+ Besides the normal [state object methods and properties](/topics/state_object/), `states.sensor.temperature.state_with_unit` will print the state of the entity and, if available, the unit. #### {% linkable_title States examples %} + The next two statements result in the same value if the state exists. The second one will result in an error if the state does not exist. {% raw %} From 52f78c70c2ddbf0a24afe30f83389338daf55bce Mon Sep 17 00:00:00 2001 From: Paulus Schoutsen Date: Fri, 28 Jun 2019 20:45:53 -0700 Subject: [PATCH 033/116] Release 0.95.3 --- _config.yml | 4 ++-- source/_posts/2019-06-26-release-95.markdown | 8 ++++++++ 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/_config.yml b/_config.yml index 0f5c110cb3c..c3bfb11752a 100644 --- a/_config.yml +++ b/_config.yml @@ -139,8 +139,8 @@ social: # Home Assistant release details current_major_version: 0 current_minor_version: 95 -current_patch_version: 2 -date_released: 2019-06-28 +current_patch_version: 3 +date_released: 2019-06-29 # Either # or the anchor link to latest release notes in the blog post. # Must be prefixed with a # and have double quotes around it. diff --git a/source/_posts/2019-06-26-release-95.markdown b/source/_posts/2019-06-26-release-95.markdown index 1befd3cc233..5bf94938e8e 100644 --- a/source/_posts/2019-06-26-release-95.markdown +++ b/source/_posts/2019-06-26-release-95.markdown @@ -136,6 +136,14 @@ We have also realized that the default database clean up task never automaticall [script docs]: /components/script/ [zha docs]: /components/zha/ +## {% linkable_title Release 0.95.3 - June 28 %} + +- Alexa sync state report ([@balloob] - [#24835]) ([cloud docs]) + +[#24835]: https://github.com/home-assistant/home-assistant/pull/24835 +[@balloob]: https://github.com/balloob +[cloud docs]: /components/cloud/ + ## {% linkable_title If you need help... %} ...don't hesitate to use our very active [forums](https://community.home-assistant.io/) or join us for a little [chat](https://discord.gg/c5DvZ4e). From 83bf4a8028ae379ae10b58725b11a94b3d58a533 Mon Sep 17 00:00:00 2001 From: Paulus Schoutsen Date: Fri, 28 Jun 2019 22:43:05 -0700 Subject: [PATCH 034/116] 95.4 --- _config.yml | 2 +- source/_posts/2019-06-26-release-95.markdown | 13 +++++++++++++ 2 files changed, 14 insertions(+), 1 deletion(-) diff --git a/_config.yml b/_config.yml index c3bfb11752a..44988388256 100644 --- a/_config.yml +++ b/_config.yml @@ -139,7 +139,7 @@ social: # Home Assistant release details current_major_version: 0 current_minor_version: 95 -current_patch_version: 3 +current_patch_version: 4 date_released: 2019-06-29 # Either # or the anchor link to latest release notes in the blog post. diff --git a/source/_posts/2019-06-26-release-95.markdown b/source/_posts/2019-06-26-release-95.markdown index 5bf94938e8e..bdb9c6ffef2 100644 --- a/source/_posts/2019-06-26-release-95.markdown +++ b/source/_posts/2019-06-26-release-95.markdown @@ -144,6 +144,19 @@ We have also realized that the default database clean up task never automaticall [@balloob]: https://github.com/balloob [cloud docs]: /components/cloud/ +## {% linkable_title Release 0.95.4 - June 28 %} + +- Improve autodiscovered yeelights model detection ([@zewelor] - [#24671]) ([yeelight docs]) +- Guard for None entity config ([@balloob] - [#24838]) ([alexa docs]) ([cloud docs]) + +[#24671]: https://github.com/home-assistant/home-assistant/pull/24671 +[#24838]: https://github.com/home-assistant/home-assistant/pull/24838 +[@balloob]: https://github.com/balloob +[@zewelor]: https://github.com/zewelor +[alexa docs]: /components/alexa/ +[cloud docs]: /components/cloud/ +[yeelight docs]: /components/yeelight/ + ## {% linkable_title If you need help... %} ...don't hesitate to use our very active [forums](https://community.home-assistant.io/) or join us for a little [chat](https://discord.gg/c5DvZ4e). From cc2735d032a6e4adfa7d64fa3f31c205b913ca55 Mon Sep 17 00:00:00 2001 From: Ross Cullen <35301905+rosscullen@users.noreply.github.com> Date: Sat, 29 Jun 2019 08:35:05 +0100 Subject: [PATCH 035/116] Additional YAML Example (#9720) * Additional YAML Example Original config was hard to follow for "monitored_conditions:" so added example configuration.yaml * Add header --- source/_components/pi_hole.markdown | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/source/_components/pi_hole.markdown b/source/_components/pi_hole.markdown index c8c9d5bd1d0..82d8aa32231 100644 --- a/source/_components/pi_hole.markdown +++ b/source/_components/pi_hole.markdown @@ -75,4 +75,22 @@ monitored_conditions: description: Total number of seen clients. {% endconfiguration %} +### {% linkable_title Full example %} + +```yaml +# Example configuration.yaml entry +sensor: + - platform: pi_hole + host: IP_ADDRESS + monitored_conditions: + - ads_blocked_today + - ads_percentage_today + - dns_queries_today + - domains_being_blocked + - queries_cached + - queries_forwarded + - unique_clients + - unique_domains +``` + This sensor platform was not made by Pi-hole LLC or the Pi-hole community. They did not provide support, feedback, testing, or any other help during its creation. This is a third party platform which may break if Pi-hole changes their API in a later release. It is not official, not developed, not supported, and not endorsed Pi-hole LLC or the Pi-hole community. The trademark `Pi-hole` and the logo is used here to describe the platform. `Pi-hole` is a registered trademark of Pi-hole LLC. From 1bfde0770d3fa91014a3325b2156406654120310 Mon Sep 17 00:00:00 2001 From: aidbish <38182386+aidbish@users.noreply.github.com> Date: Sat, 29 Jun 2019 17:57:16 +1000 Subject: [PATCH 036/116] Add list of supported languages. (#9721) * Add list of supported languages. The integration does not list the languages that it supports. Some languages are missing from the integration itself compared to the Microsoft documentation, adding the languages it supports should prevent users trying to add an non-supported language * Updated supported languages added link to languages supported by the integration * Updated supported Languages * Minor change --- source/_components/microsoft.markdown | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/source/_components/microsoft.markdown b/source/_components/microsoft.markdown index 9f7dac5fdf6..300befd307b 100644 --- a/source/_components/microsoft.markdown +++ b/source/_components/microsoft.markdown @@ -35,7 +35,7 @@ api_key: required: true type: string language: - description: The language to use. Accepted values are listed in the documentation mentioned below. Note that if you set the language to anything other than the default, you will need to specify a matching voice type as well. + description: The language to use. Note that if you set the language to anything other than the default, you will need to specify a matching voice type as well. For the supported languages check the list of [available languages](https://github.com/home-assistant/home-assistant/blob/dev/homeassistant/components/microsoft/tts.py#L20). required: false type: string default: "`en-us`" @@ -70,6 +70,7 @@ contour: type: string {% endconfiguration %} + ## {% linkable_title Full configuration example %} A full configuration sample including optional variables: From 3d3e801122af3cf24612be45c09f0c2b296ee517 Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Sat, 29 Jun 2019 14:29:09 +0200 Subject: [PATCH 037/116] Adds support for VS Code Remote Development (#9726) * Adds support for VS Code Remote Development * Adds support for VS Code Remote Development --- .devcontainer/Dockerfile | 33 +++++++++++++ .devcontainer/devcontainer.json | 30 ++++++++++++ .gitignore | 5 +- .vscode/cSpell.json | 83 +++++++++++++++++++++++++++++++++ .vscode/extensions.json | 8 ++++ .vscode/tasks.json | 23 +++++++++ 6 files changed, 181 insertions(+), 1 deletion(-) create mode 100644 .devcontainer/Dockerfile create mode 100644 .devcontainer/devcontainer.json create mode 100644 .vscode/cSpell.json create mode 100644 .vscode/extensions.json create mode 100644 .vscode/tasks.json diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile new file mode 100644 index 00000000000..a981cd420fc --- /dev/null +++ b/.devcontainer/Dockerfile @@ -0,0 +1,33 @@ +FROM ruby:2.6 + +# Avoid warnings by switching to noninteractive +ENV DEBIAN_FRONTEND=noninteractive + +# Use Bash as the default shell +ENV SHELL=/bin/bash + +# Locale env vars +ENV \ + LANG=en_US.UTF-8 \ + LANGUAGE=en_US:en \ + LC_ALL=en_US.UTF-8 + +# Install git, process tools +RUN apt update \ + && apt-get install -y --no-install-recommends \ + ack \ + git \ + locales \ + procps \ + && echo "en_US UTF-8" > /etc/locale.gen \ + && locale-gen en_US.UTF-8 \ + && echo 'export PS1="\\w\$ "' > /root/.bashrc \ + && apt-get autoremove -y \ + && apt-get clean -y \ + && rm -rf /var/lib/apt/lists/* + +# Install the specific version of bundler we need +RUN gem install bundler -v 2.0.1 + +# Switch back to dialog for any ad-hoc use of apt-get +ENV DEBIAN_FRONTEND=dialog diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json new file mode 100644 index 00000000000..399a22a2be6 --- /dev/null +++ b/.devcontainer/devcontainer.json @@ -0,0 +1,30 @@ +{ + "name": "home-assistant.io", + "dockerFile": "Dockerfile", + "appPort": [ + 4000 + ], + "postCreateCommand": "bundle install", + "extensions": [ + "davidanson.vscode-markdownlint", + "eamodio.gitlens", + "editorconfig.editorconfig", + "github.vscode-pull-request-github", + "mrmlnc.vscode-scss", + "ms-vsliveshare.vsliveshare", + "rebornix.Ruby", + "streetsidesoftware.code-spell-checker", + "yzhang.markdown-all-in-one" + ], + "settings": { + "editor.rulers": [80, 100, 120], + "editor.renderWhitespace": "boundary", + "errorLens.gutterIconsEnabled": true, + "errorLens.addAnnotationTextPrefixes": false, + "errorLens.enabledDiagnosticLevels": [ + "error", + "warning" + ], + "terminal.integrated.shell.linux": "/bin/bash" + } +} diff --git a/.gitignore b/.gitignore index 933ece07209..7578554e295 100644 --- a/.gitignore +++ b/.gitignore @@ -19,5 +19,8 @@ source/.jekyll-metadata /.vs/config/applicationhost.config /.vs/slnx.sqlite-journal /.vs/VSWorkspaceState.json -.vscode +.vscode/* +!.vscode/cSpell.json +!.vscode/extensions.json +!.vscode/tasks.json *.suo diff --git a/.vscode/cSpell.json b/.vscode/cSpell.json new file mode 100644 index 00000000000..42c5d088e2f --- /dev/null +++ b/.vscode/cSpell.json @@ -0,0 +1,83 @@ +// cSpell Settings +// Contains additional words for our project +{ + "version": "0.1", + "language": "en", + "words": [ + "arest", + "automations", + "bloomsky", + "bluesound", + "BTLE", + "Denon", + "endconfiguration", + "endraw", + "fitbit", + "Flexit", + "geizhals", + "Harman", + "hass", + "hass.io", + "hassos", + "hcitool", + "heos", + "hikvision", + "Homematic", + "IBAN", + "icloud", + "kardon", + "macos", + "Modbus", + "Mosquitto", + "nginx", + "ohmconnect", + "Onkyo", + "paulus", + "templating", + "waqi", + "Webhook" + ], + // flagWords - list of words to be always considered incorrect + // This is useful for offensive words and common spelling errors. + // For example "hte" should be "the" + "flagWords": [ + "hte", + "asssistant" + ], + "enabledLanguageIds": [ + "asciidoc", + "c", + "cpp", + "csharp", + "css", + "dockerfile", + "gemfile", + "git-commit", + "go", + "handlebars", + "html", + "jade", + "java", + "javascript", + "javascriptreact", + "json", + "jsonc", + "latex", + "less", + "liquid", + "markdown", + "php", + "plaintext", + "pug", + "python", + "restructuredtext", + "rust", + "scala", + "scss", + "text", + "typescript", + "typescriptreact", + "yaml", + "yml" + ] +} \ No newline at end of file diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 00000000000..5f55e50474f --- /dev/null +++ b/.vscode/extensions.json @@ -0,0 +1,8 @@ +{ + "recommendations": [ + "davidanson.vscode-markdownlint", + "editorconfig.editorconfig", + "streetsidesoftware.code-spell-checker", + "yzhang.markdown-all-in-one" + ] +} \ No newline at end of file diff --git a/.vscode/tasks.json b/.vscode/tasks.json new file mode 100644 index 00000000000..7a872b87d91 --- /dev/null +++ b/.vscode/tasks.json @@ -0,0 +1,23 @@ +{ + "version": "2.0.0", + "tasks": [ + { + "label": "Generate", + "type": "shell", + "command": "bundle exec rake generate", + "group": { + "kind": "build", + "isDefault": true + } + }, + { + "label": "Preview", + "type": "shell", + "command": "bundle exec rake preview", + "group": { + "kind": "test", + "isDefault": true, + } + } + ] +} \ No newline at end of file From d1713e329f8d1c62ea0bf3028b7eed99551fdeac Mon Sep 17 00:00:00 2001 From: aidbish <38182386+aidbish@users.noreply.github.com> Date: Sat, 29 Jun 2019 22:30:28 +1000 Subject: [PATCH 038/116] Delete bluetooth_bcm43xx page (#9728) This add-on is no longer available --- source/_addons/bluetooth_bcm43xx.markdown | 22 ---------------------- 1 file changed, 22 deletions(-) delete mode 100644 source/_addons/bluetooth_bcm43xx.markdown diff --git a/source/_addons/bluetooth_bcm43xx.markdown b/source/_addons/bluetooth_bcm43xx.markdown deleted file mode 100644 index cc2327e2c26..00000000000 --- a/source/_addons/bluetooth_bcm43xx.markdown +++ /dev/null @@ -1,22 +0,0 @@ ---- -layout: page -title: "Bluetooth BCM43xx" -description: "Activate the BCM43xx Bluetooth chipset on a Raspberry Pi 3." -date: 2017-04-30 13:28 -sidebar: true -comments: false -sharing: true -footer: true ---- - -Start this add-on to activate the BCM43xx Bluetooth chipset in the old ResinOS based builds. If you first installed Hass.io after mid July 2018 then you will have a HassOS based system. - -You can identify the base of your system by looking in the System tab of the Hass.io menu. - -

- This is not required on the new HassOS based Hass.io installs and should not be installed. -

- -Supported platforms: - -- Raspberry Pi 3 From 2e1791b0c10f8324663c0453e43795320f7d38ec Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Sat, 29 Jun 2019 14:35:45 +0200 Subject: [PATCH 039/116] Adds MarkdownLint configuration (#9725) * Adds MarkdownLint configuration * Removes misplaced dockerfile --- .markdownlint.json | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 .markdownlint.json diff --git a/.markdownlint.json b/.markdownlint.json new file mode 100644 index 00000000000..191f03e0f0a --- /dev/null +++ b/.markdownlint.json @@ -0,0 +1,6 @@ +{ + "MD002": { "level": 2 }, + "MD013": false, + "MD024": { "siblings_only": true }, + "MD033": false +} From 0b5db73ec290ec622b69dc948d2880b963f33e50 Mon Sep 17 00:00:00 2001 From: Dubh Ad Date: Sat, 29 Jun 2019 14:27:35 +0100 Subject: [PATCH 040/116] Update for Pi4 and A2 (#9724) * Update for Pi4 and A2 Mentioning the new Pi4, and the recommendation for the A2 SD card * :pencil2: Tweak + link --- source/_docs/installation.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_docs/installation.markdown b/source/_docs/installation.markdown index 0a8d6dcc2c4..c2771402458 100644 --- a/source/_docs/installation.markdown +++ b/source/_docs/installation.markdown @@ -38,7 +38,7 @@ This is a list of popular platforms and what to expect from them. Platform | Notes -- | -- Raspberry Pi Zero/Pi 2 | **Only** use these for testing -Raspberry Pi 3/3+ | This is a good starting point, and depending on the amount of devices you integrate this can be enough +Raspberry Pi 3/3+/4 | This is a good starting point, and depending on the amount of devices you integrate this can be enough - use an [A2 class SD](https://amzn.to/2X0Z2di) card if possible. NUC i3 | This is if you need a little more power over a Pi NUC i5 | This will allow you to run multiple services without any issues, perfect for a homelab NUC i7/i9 | Pure power, you should not have *any* performance issues From e4288c00cfaecbfbdfca2a556280c3b238eae845 Mon Sep 17 00:00:00 2001 From: Robert Van Gorkom Date: Sat, 29 Jun 2019 08:10:28 -0700 Subject: [PATCH 041/116] Updating tplink docs to include missing dimmer option. (#9689) * Fixing tplink docs. * Cleaning up PR. --- source/_components/tplink.markdown | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/source/_components/tplink.markdown b/source/_components/tplink.markdown index 158c2969e8c..28bb3a8d88f 100644 --- a/source/_components/tplink.markdown +++ b/source/_components/tplink.markdown @@ -84,7 +84,16 @@ light: required: true type: string switch: - description: List of switch devices. + description: List of on/off switch devices. + required: false + type: list + keys: + host: + description: Hostname or IP address of the device. + required: true + type: string +dimmer: + description: List of dimmable switch devices. required: false type: list keys: @@ -106,6 +115,9 @@ tplink: switch: - host: 192.168.200.3 - host: 192.168.200.4 + dimmer: + - host: 192.168.200.5 + - host: 192.168.200.6 ``` ## {% linkable_title Extracting Energy Sensor data %} From 8b83098a778acca015817747149895e3522231b8 Mon Sep 17 00:00:00 2001 From: Phil Bruckner Date: Sat, 29 Jun 2019 10:20:47 -0500 Subject: [PATCH 042/116] Add template support to template trigger's for option (#9714) --- source/_docs/automation/trigger.markdown | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/source/_docs/automation/trigger.markdown b/source/_docs/automation/trigger.markdown index 0b5bcab21ee..7ee0fef0e73 100644 --- a/source/_docs/automation/trigger.markdown +++ b/source/_docs/automation/trigger.markdown @@ -201,6 +201,21 @@ automation: ``` {% endraw %} +You can also use templates in the `for` option. + +{% raw %} +```yaml +automation: + trigger: + platform: template + value_template: "{{ is_state('device_tracker.paulus', 'home') }}" + for: + minutes: "{{ states('input_number.minutes')|int(0) }}" +``` +{% endraw %} + +The `for` template(s) will be evaluated when the `value_template` becomes `true`. +

Rendering templates with time (`now()`) is dangerous as trigger templates only update based on entity state changes.

From cd6beb54751d1c0b67ba98264d7f75aa654c3ca0 Mon Sep 17 00:00:00 2001 From: Austin Mroczek Date: Sat, 29 Jun 2019 08:33:54 -0700 Subject: [PATCH 043/116] Update totalconnect.markdown (#9517) Adds detail on the trigger source. See https://github.com/home-assistant/home-assistant/pull/24106 --- source/_components/totalconnect.markdown | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/source/_components/totalconnect.markdown b/source/_components/totalconnect.markdown index 7d97bf463f3..ec49d053284 100644 --- a/source/_components/totalconnect.markdown +++ b/source/_components/totalconnect.markdown @@ -19,6 +19,11 @@ The `totalconnect` platform provides connectivity with the Honeywell TotalConnec This platform supports the following services: `alarm_arm_away`, `alarm_arm_home`, `alarm_arm_night` and `alarm_disarm`. +The `triggered` state also provides a state attribute called `triggered_source` giving more detail on what triggered the alarm: +- `Police/Medical` is when sensors detected a burglar and/or a person pushed the Police or Medical button +- `Fire/Smoke` is when fire or smoke is detected, or a person pushed the Fire button +- `Carbon Monoxide` is when carbon monoxide is detected + If you have issues running this component, you may require `libxml2-dev` and `libxmlsec1-dev` packages. To install these on Hassbian, run the command `apt install libxml2-dev libxmlsec1-dev` with sudo. ## {% linkable_title Configuration %} From f205c30c239fd3893b0e3424202c9b64ade9cfa3 Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Sat, 29 Jun 2019 21:28:35 +0200 Subject: [PATCH 044/116] Adds support for Gitpod.io (#9727) * Adds support for Gitpod * Adds Gitpod Dockerfile * Adds Gitpod prebuild configuration * Adds Theia tasks file (for use with Gitpod) * Revert "Adds Gitpod Dockerfile" This reverts commit bf2d76fdc057d3d05972f6d7f8e1b0c61476c2b7. * Fixes broken json in Theia tasks file --- .gitpod.yml | 16 ++++++++++++++++ .theia/tasks.json | 30 ++++++++++++++++++++++++++++++ 2 files changed, 46 insertions(+) create mode 100644 .gitpod.yml create mode 100644 .theia/tasks.json diff --git a/.gitpod.yml b/.gitpod.yml new file mode 100644 index 00000000000..16d7a920856 --- /dev/null +++ b/.gitpod.yml @@ -0,0 +1,16 @@ +tasks: + - init: gem install bundler -v 2.0.1 + - init: bundle install +ports: + - port: 4000 + onOpen: open-browser +github: + prebuilds: + master: true + branches: true + pullRequests: true + pullRequestsFromForks: true + addCheck: true + addComment: false + addBadge: true + addLabel: false diff --git a/.theia/tasks.json b/.theia/tasks.json new file mode 100644 index 00000000000..fa5f725110c --- /dev/null +++ b/.theia/tasks.json @@ -0,0 +1,30 @@ +{ + "tasks": [ + { + "label": "Generate", + "type": "shell", + "command": "bundle", + "args": [ + "exec", + "rake", + "generate" + ], + "options": { + "cwd": "${workspaceFolder}" + } + }, + { + "label": "Preview", + "type": "shell", + "command": "bundle", + "args": [ + "exec", + "rake", + "preview" + ], + "options": { + "cwd": "${workspaceFolder}" + } + } + ] +} \ No newline at end of file From d91a1c08c956d32a204d6da071eb52f2e3f2db5f Mon Sep 17 00:00:00 2001 From: qqgg231 Date: Sun, 30 Jun 2019 11:04:19 +0200 Subject: [PATCH 045/116] added i2c group to homeassistant user (#9731) * added i2c group to homeassistant user this change should ease user experience * :pencil2: Tweak --- source/_docs/installation/raspberry-pi.markdown | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/_docs/installation/raspberry-pi.markdown b/source/_docs/installation/raspberry-pi.markdown index b5b3780372c..59d3d1fc663 100644 --- a/source/_docs/installation/raspberry-pi.markdown +++ b/source/_docs/installation/raspberry-pi.markdown @@ -49,10 +49,10 @@ $ sudo apt-get install python3 python3-venv python3-pip libffi-dev libssl-dev ``` Add an account for Home Assistant called `homeassistant`. -Since this account is only for running Home Assistant the extra arguments of `-rm` is added to create a system account and create a home directory. The arguments `-G dialout,gpio` adds the user to the `dialout` and the `gpio` group. The first is required for using Z-Wave and Zigbee controllers, while the second is required to communicate with Raspberry's GPIO. +Since this account is only for running Home Assistant the extra arguments of `-rm` is added to create a system account and create a home directory. The arguments `-G dialout,gpio,i2c` adds the user to the `dialout`, `gpio` and the `i2c` group. The first is required for using Z-Wave and Zigbee controllers, while the second is required to communicate with Raspberry's GPIO. ```bash -$ sudo useradd -rm homeassistant -G dialout,gpio +$ sudo useradd -rm homeassistant -G dialout,gpio,i2c ``` Next we will create a directory for the installation of Home Assistant and change the owner to the `homeassistant` account. From 56747c08238e7512cbe53eebecbc5d2116b5e18d Mon Sep 17 00:00:00 2001 From: bvansambeek <35294853+bvansambeek@users.noreply.github.com> Date: Sun, 30 Jun 2019 14:07:13 +0200 Subject: [PATCH 046/116] Added a DIY solution that is nice (#9733) --- source/_components/dsmr.markdown | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/source/_components/dsmr.markdown b/source/_components/dsmr.markdown index 5b70e83d324..4140cebb3e5 100644 --- a/source/_components/dsmr.markdown +++ b/source/_components/dsmr.markdown @@ -48,6 +48,10 @@ Serial to network proxies: - ser2net - +DIY solutions (ESP8266 based): + +- [esp8266_p1meter (fliphess)](https://github.com/fliphess/esp8266_p1meter) + ```yaml # Example configuration.yaml entry sensor: From 24a50f468c21eef029457939a2678acb39d6516a Mon Sep 17 00:00:00 2001 From: aidbish <38182386+aidbish@users.noreply.github.com> Date: Sun, 30 Jun 2019 22:31:45 +1000 Subject: [PATCH 047/116] Show whats loaded with links to the integrations (#9734) * Show whats loaded with links to the integrations https://github.com/home-assistant/home-assistant.io/issues/9209 * :pencil2: Tweaks --- source/_components/default_config.markdown | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/source/_components/default_config.markdown b/source/_components/default_config.markdown index 4682e540076..00edddfe221 100644 --- a/source/_components/default_config.markdown +++ b/source/_components/default_config.markdown @@ -13,7 +13,23 @@ ha_category: ha_release: 0.88 --- -This integration is a meta-component and configures a default set of integrations for Home Assistant to load. The integrations that will be loaded can be found [here](https://github.com/home-assistant/home-assistant/blob/dev/homeassistant/components/default_config/manifest.json). +This integration is a meta-component and configures a default set of integrations for Home Assistant to load. The integrations that will be loaded are: + +- [automation](/components/automation/) +- [cloud](/components/cloud/) +- [config](/components/config/) +- [frontend](/components/frontend/) +- [history](/components/history/) +- [logbook](/components/logbook/) +- [map](/components/map/) +- [mobile_app](/components/mobile_app/) +- [person](/components/person/) +- [script](/components/script/) +- [ssdp](/components/ssdp/) +- [sun](/components/sun/) +- [system_health](/components/system_health/) +- [updater](/components/updater/) +- [zeroconf](/components/zeroconf/) ## {% linkable_title Configuration %} @@ -23,4 +39,3 @@ To integrate this into Home Assistant, add the following section to your `config # Example configuration.yaml entry default_config: ``` - From 3644c69b27fca483794d949c96d722a2dda735ab Mon Sep 17 00:00:00 2001 From: Dubh Ad Date: Sun, 30 Jun 2019 13:32:12 +0100 Subject: [PATCH 048/116] Fix typo (#9735) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The entity in the example is missing the domain 🤦‍♂ --- source/_components/switch.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/switch.markdown b/source/_components/switch.markdown index acf851afdf6..899e19d255f 100644 --- a/source/_components/switch.markdown +++ b/source/_components/switch.markdown @@ -24,7 +24,7 @@ Keeps track which switches are in your environment, their state and allows you t In the frontend open the sidebar. At the bottom, under **Developer Tools**, click **Services**. From the Service dropdown menu choose `switch.turn_on` or `switch.turn_off` from the list of available services. In the Entity dropdown menu choose or enter the entity ID you want to work with. This will enter something like the sample below into the **Service Data** field. Now hit **CALL SERVICE**. ```json -{"entity_id":"livingroom_pin2"} +{"entity_id":"switch.livingroom_pin2"} ``` | Service data attribute | Optional | Description | From 2599e7fcbc0ec6e88e0c82c8156747614fc6bcb6 Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Sun, 30 Jun 2019 19:03:07 +0200 Subject: [PATCH 049/116] Adjust stalebot to ignore 'Help wanted' (#9738) --- .github/stale.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/stale.yml b/.github/stale.yml index 304bb82e08f..9a93a800d10 100644 --- a/.github/stale.yml +++ b/.github/stale.yml @@ -5,6 +5,7 @@ daysUntilClose: 7 # Issues with these labels will never be considered stale exemptLabels: - has-parent + - Help wanted # Label to use when marking an issue as stale staleLabel: Stale # Comment to post when marking an issue as stale. Set to `false` to disable From 4cdc129f2f5c855abb0106245a183ba0968a173c Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Sun, 30 Jun 2019 19:10:45 +0200 Subject: [PATCH 050/116] Adjust Gitpod to run Jekyll generate in pre-build (#9739) * Adjust Gitpod to run Jekyll generate in pre-build * Works-around parallel execution of init tasks in GitPod --- .gitpod.yml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.gitpod.yml b/.gitpod.yml index 16d7a920856..d51137f4222 100644 --- a/.gitpod.yml +++ b/.gitpod.yml @@ -1,6 +1,5 @@ tasks: - - init: gem install bundler -v 2.0.1 - - init: bundle install + - init: gem install bundler -v 2.0.1 && bundle install && bundle exec rake generate ports: - port: 4000 onOpen: open-browser From 337b210cce8c6ec7b3396c954b2358c5e2ec31e4 Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Sun, 30 Jun 2019 20:45:03 +0200 Subject: [PATCH 051/116] Rewrites states.xxx -> states('xxx') (and similar) (#9736) * Rewrites states.xxx -> states('xxx') (and similar) * Adds template escaping on some places --- source/_components/alert.markdown | 2 +- .../binary_sensor.template.markdown | 4 ++-- .../binary_sensor.xiaomi_aqara.markdown | 18 +++++++++--------- source/_components/calendar.google.markdown | 2 +- source/_components/cover.template.markdown | 2 +- source/_components/deconz.markdown | 4 ++-- source/_components/deutsche_bahn.markdown | 2 +- .../_components/fritzbox_callmonitor.markdown | 6 +++--- source/_components/garadget.markdown | 6 +++--- source/_components/hangouts.markdown | 2 +- source/_components/harmony.markdown | 4 ++-- source/_components/homematic.markdown | 2 +- source/_components/input_datetime.markdown | 2 +- source/_components/input_number.markdown | 2 +- source/_components/iss.markdown | 2 +- source/_components/light.template.markdown | 14 +++++++------- source/_components/lock.template.markdown | 2 +- source/_components/london_air.markdown | 6 +++--- source/_components/min_max.markdown | 6 +++--- source/_components/modem_callerid.markdown | 6 +++--- source/_components/mvglive.markdown | 2 +- source/_components/mystrom.markdown | 2 +- source/_components/opengarage.markdown | 2 +- source/_components/pvoutput.markdown | 8 ++++---- source/_components/rest.markdown | 10 +++++----- source/_components/ring.markdown | 8 +++++--- source/_components/rmvtransport.markdown | 2 +- source/_components/rova.markdown | 4 ++-- source/_components/rss_feed_template.markdown | 2 +- source/_components/script.markdown | 2 +- source/_components/sensehat.markdown | 6 +++--- .../_components/sensor.command_line.markdown | 2 +- source/_components/seven_segments.markdown | 2 +- source/_components/shell_command.markdown | 2 +- source/_components/solaredge.markdown | 2 +- source/_components/solaredge_local.markdown | 2 +- source/_components/switch.rest.markdown | 2 +- source/_components/switch.template.markdown | 2 +- source/_components/template.markdown | 2 +- source/_components/threshold.markdown | 2 +- source/_components/tibber.markdown | 4 ++-- source/_components/transport_nsw.markdown | 2 +- source/_components/uk_transport.markdown | 18 +++++++++--------- source/_components/vacuum.xiaomi_miio.markdown | 10 ++++++++-- source/_components/webostv.markdown | 4 +++- .../_cookbook/automation_first_light.markdown | 6 +++--- .../_cookbook/dim_and_brighten_lights.markdown | 8 ++++---- source/_cookbook/google_maps_card.markdown | 2 +- .../notify_if__new_ha_release.markdown | 2 +- .../notify_if_over_threshold.markdown | 4 ++-- source/_cookbook/track_battery_level.markdown | 6 +++--- source/_docs/automation/action.markdown | 4 ++-- source/_docs/automation/condition.markdown | 4 ++-- source/_docs/configuration/templating.markdown | 2 +- source/_docs/scripts.markdown | 2 +- source/_docs/scripts/conditions.markdown | 6 +++--- source/_docs/scripts/service-calls.markdown | 2 +- 57 files changed, 128 insertions(+), 118 deletions(-) diff --git a/source/_components/alert.markdown b/source/_components/alert.markdown index 0819c986319..a881dfaa487 100644 --- a/source/_components/alert.markdown +++ b/source/_components/alert.markdown @@ -159,7 +159,7 @@ binary_sensor: - platform: template sensors: motion_battery_low: - value_template: '{{ states.sensor.motion.attributes.battery < 15 }}' + value_template: '{{ state_attr('sensor.motion', 'battery') < 15 }}' friendly_name: 'Motion battery is low' alert: diff --git a/source/_components/binary_sensor.template.markdown b/source/_components/binary_sensor.template.markdown index 521757fbb1e..8212202166a 100644 --- a/source/_components/binary_sensor.template.markdown +++ b/source/_components/binary_sensor.template.markdown @@ -32,7 +32,7 @@ binary_sensor: sun_up: friendly_name: "Sun is up" value_template: >- - {{ states.sun.sun.attributes.elevation|float > 0 }} + {{ state_attr('sun.sun', 'elevation')|float > 0 }} ``` {% endraw %} @@ -91,7 +91,7 @@ Template Binary Sensor may get an `unknown` state during startup. This results in error messages in your log file until that platform has completed loading. If you use `is_state()` function in your template, you can avoid this situation. For example, you would replace -{% raw %}`{{ states.switch.source.state == 'on' }}`{% endraw %} +{% raw %}`{{ is_state('switch.source', 'on') }}`{% endraw %} with this equivalent that returns `true`/`false` and never gives an unknown result: {% raw %}`{{ is_state('switch.source', 'on') }}`{% endraw %} diff --git a/source/_components/binary_sensor.xiaomi_aqara.markdown b/source/_components/binary_sensor.xiaomi_aqara.markdown index 0933d4e0fab..e6a955d4004 100644 --- a/source/_components/binary_sensor.xiaomi_aqara.markdown +++ b/source/_components/binary_sensor.xiaomi_aqara.markdown @@ -141,7 +141,7 @@ The requirement is that you have setup the [`xiaomi aqara` component](/component - service: notify.html5 data_template: title: Gas alarm! - message: 'Gas with a density of {% raw %}{{ states.binary_sensor.natgas_sensor_158dxxxxxxxxxx.attributes.density }}{% endraw %} detected.' + message: 'Gas with a density of {% raw %}{{ state_attr('binary_sensor.natgas_sensor_158dxxxxxxxxxx', 'density') }}{% endraw %} detected.' ``` #### {% linkable_title Xiaomi Wireless Button %} @@ -268,11 +268,11 @@ The Aqara Wireless Switch is available as single-key and double-key version. Eac entity_id: light.gateway_light_34xxxxxxxx13 data_template: brightness: {% raw %}>- - {% if states.light.gateway_light_34xxxxxxxx13.attributes.brightness %} - {% if states.light.gateway_light_34xxxxxxxx13.attributes.brightness - 60 >= 10 %} - {{states.light.gateway_light_34xxxxxxxx13.attributes.brightness - 60}} + {% if state_attr('light.gateway_light_34xxxxxxxx13', 'brightness') %} + {% if state_attr('light.gateway_light_34xxxxxxxx13', 'brightness') - 60 >= 10 %} + {{state_attr('light.gateway_light_34xxxxxxxx13', 'brightness') - 60}} {% else %} - {{states.light.gateway_light_34xxxxxxxx13.attributes.brightness}} + {{state_attr('light.gateway_light_34xxxxxxxx13', 'brightness')}} {% endif %} {% else %} 10 @@ -290,11 +290,11 @@ The Aqara Wireless Switch is available as single-key and double-key version. Eac entity_id: light.gateway_light_34xxxxxxxx13 data_template: brightness: {% raw %}>- - {% if states.light.gateway_light_34xxxxxxxx13.attributes.brightness %} - {% if states.light.gateway_light_34xxxxxxxx13.attributes.brightness + 60 <= 255 %} - {{states.light.gateway_light_34xxxxxxxx13.attributes.brightness + 60}} + {% if state_attr('light.gateway_light_34xxxxxxxx13', 'brightness') %} + {% if state_attr('light.gateway_light_34xxxxxxxx13', 'brightness') + 60 <= 255 %} + {{state_attr('light.gateway_light_34xxxxxxxx13', 'brightness') + 60}} {% else %} - {{states.light.gateway_light_34xxxxxxxx13.attributes.brightness}} + {{state_attr('light.gateway_light_34xxxxxxxx13', 'brightness')}} {% endif %} {% else %} 10 diff --git a/source/_components/calendar.google.markdown b/source/_components/calendar.google.markdown index 680dd184974..b5fcc847704 100644 --- a/source/_components/calendar.google.markdown +++ b/source/_components/calendar.google.markdown @@ -215,6 +215,6 @@ For example, the actions following this condition will only be executed for even ```yaml condition: condition: template - value_template: "{{states.calendar.calendar_name.attributes.message == 'vacation' }}" + value_template: "{{is_state_attr('calendar.calendar_name', 'message', 'vacation') }}" ``` {% endraw %} diff --git a/source/_components/cover.template.markdown b/source/_components/cover.template.markdown index 3c0cfc690d6..7f93b55e982 100644 --- a/source/_components/cover.template.markdown +++ b/source/_components/cover.template.markdown @@ -115,7 +115,7 @@ Template Cover may get an `unknown` state during startup. This results in error messages in your log file until that platform has completed loading. If you use `is_state()` function in your template, you can avoid this situation. For example, you would replace -{% raw %}`{{ states.switch.source.state == 'on' }}`{% endraw %} +{% raw %}`{{ is_state('switch.source', 'on') }}`{% endraw %} with this equivalent that returns `true`/`false` and never gives an unknown result: {% raw %}`{{ is_state('switch.source', 'on') }}`{% endraw %} diff --git a/source/_components/deconz.markdown b/source/_components/deconz.markdown index da5893b492a..e03c60279e6 100644 --- a/source/_components/deconz.markdown +++ b/source/_components/deconz.markdown @@ -155,7 +155,7 @@ automation: data_template: entity_id: light.lamp brightness: > - {% set bri = states.light.lamp.attributes.brightness | int %} + {% set bri = state_attr('light.lamp', 'brightness') | int %} {{ [bri+30, 249] | min }} - alias: 'Decrease brightness of lamp from dimmer' @@ -171,7 +171,7 @@ automation: data_template: entity_id: light.lamp brightness: > - {% set bri = states.light.lamp.attributes.brightness | int %} + {% set bri = state_attr('light.lamp', 'brightness') | int %} {{ [bri-30, 0] | max }} ``` diff --git a/source/_components/deutsche_bahn.markdown b/source/_components/deutsche_bahn.markdown index cc653756249..047d713f259 100644 --- a/source/_components/deutsche_bahn.markdown +++ b/source/_components/deutsche_bahn.markdown @@ -52,7 +52,7 @@ sensor: platform: template sensors: next_departure: - value_template: '{% raw %}{{ states.sensor.munich_to_ulm.attributes.next }}{% endraw %}' + value_template: '{% raw %}{{ state_attr('sensor.munich_to_ulm', 'next') }}{% endraw %}' friendly_name: 'Next departure' ``` diff --git a/source/_components/fritzbox_callmonitor.markdown b/source/_components/fritzbox_callmonitor.markdown index e36b630a673..a1f36c15eb4 100644 --- a/source/_components/fritzbox_callmonitor.markdown +++ b/source/_components/fritzbox_callmonitor.markdown @@ -124,11 +124,11 @@ automation: {% if is_state("sensor.phone", "idle") %} Phone is idle {% elif is_state("sensor.phone", "dialing") %} - Calling {{ states.sensor.phone.attributes.to_name }} ({{ states.sensor.phone.attributes.to }}) + Calling {{ state_attr('sensor.phone', 'to_name') }} ({{ state_attr('sensor.phone', 'to') }}) {% elif is_state("sensor.phone", "ringing") %} - Incoming call from {{ states.sensor.phone.attributes.from_name }} ({{ states.sensor.phone.attributes.from }}) + Incoming call from {{ state_attr('sensor.phone', 'from_name') }} ({{ state_attr('sensor.phone', 'from') }}) {% else %} - Talking to {{ states.sensor.phone.attributes.with_name }} ({{ states.sensor.phone.attributes.with }}) + Talking to {{ state_attr('sensor.phone', 'with_name') }} ({{ state_attr('sensor.phone', 'with') }}) {% endif %} ``` {% endraw %} diff --git a/source/_components/garadget.markdown b/source/_components/garadget.markdown index df0e457bae0..252b0d369e2 100644 --- a/source/_components/garadget.markdown +++ b/source/_components/garadget.markdown @@ -95,13 +95,13 @@ sensor: sensors: garage_door_status: friendly_name: 'State of the door' - value_template: '{{ states.cover.garage_door.state }}' + value_template: '{{ states('cover.garage_door') }}' garage_door_time_in_state: friendly_name: 'Since' - value_template: '{{ states.cover.garage_door.attributes.time_in_state }}' + value_template: '{{ state_attr('cover.garage_door', 'time_in_state') }}' garage_door_wifi_signal_strength: friendly_name: 'WiFi strength' - value_template: '{{ states.cover.garage_door.attributes.wifi_signal_strength }}' + value_template: '{{ state_attr('cover.garage_door', 'wifi_signal_strength') }}' unit_of_measurement: 'dB' group: diff --git a/source/_components/hangouts.markdown b/source/_components/hangouts.markdown index 0df9b7db699..e9cffa0816d 100644 --- a/source/_components/hangouts.markdown +++ b/source/_components/hangouts.markdown @@ -155,7 +155,7 @@ hangouts: intent_script: Ping: speech: - text: I know {{ states.hangouts.conversations.state }} conversations + text: I know {{ states('hangouts.conversations') }} conversations ``` {% endraw %} diff --git a/source/_components/harmony.markdown b/source/_components/harmony.markdown index 2d492e009b1..270140faec7 100644 --- a/source/_components/harmony.markdown +++ b/source/_components/harmony.markdown @@ -225,10 +225,10 @@ sensor: - platform: template sensors: family_room: - value_template: '{{ states.remote.family_room.attributes.current_activity }}' + value_template: '{{ state_attr('remote.family_room', 'current_activity') }}' friendly_name: 'Family Room' bedroom: - value_template: '{{ states.remote.bedroom.attributes.current_activity }}' + value_template: '{{ state_attr('remote.bedroom', 'current_activity') }}' friendly_name: 'bedroom' ``` {% endraw %} diff --git a/source/_components/homematic.markdown b/source/_components/homematic.markdown index 437293e9844..f8d42285939 100644 --- a/source/_components/homematic.markdown +++ b/source/_components/homematic.markdown @@ -210,7 +210,7 @@ sensor: - platform: template sensors: bedroom_valve: - value_template: '{% raw %}{{ states.climate.leq123456.attributes.Valve }}{% endraw %}' + value_template: '{% raw %}{{ state_attr('climate.leq123456', 'Valve') }}{% endraw %}' entity_id: climate.leq123456 friendly_name: 'Bedroom valve' ``` diff --git a/source/_components/input_datetime.markdown b/source/_components/input_datetime.markdown index b77ba74547d..32144ead5ec 100644 --- a/source/_components/input_datetime.markdown +++ b/source/_components/input_datetime.markdown @@ -107,7 +107,7 @@ automation (note that you will need a automation: trigger: platform: template -    value_template: "{{ states('sensor.time') == (states.input_datetime.bedroom_alarm_clock_time.attributes.timestamp | int | timestamp_custom('%H:%M', False)) }}" +    value_template: "{{ states('sensor.time') == (state_attr('input_datetime.bedroom_alarm_clock_time', 'timestamp') | int | timestamp_custom('%H:%M', False)) }}"  action: service: light.turn_on entity_id: light.bedroom diff --git a/source/_components/input_number.markdown b/source/_components/input_number.markdown index 75ab05c282e..2a64b74fbc8 100644 --- a/source/_components/input_number.markdown +++ b/source/_components/input_number.markdown @@ -225,7 +225,7 @@ automation: entity_id: switch.something to: 'on' action: - - delay: '00:{{ states.input_number.minutes.state | int }}:{{ states.input_number.seconds.state | int }}' + - delay: '00:{{ states('input_number.minutes') | int }}:{{ states('input_number.seconds') | int }}' - service: switch.turn_off entity_id: switch.something ``` diff --git a/source/_components/iss.markdown b/source/_components/iss.markdown index 34d47020994..d5b9854355f 100644 --- a/source/_components/iss.markdown +++ b/source/_components/iss.markdown @@ -64,7 +64,7 @@ the possibility to show the location of the ISS on OpenStreetMap. camera: - platform: generic name: ISS - still_image_url: http://staticmap.openstreetmap.de/staticmap.php?center={{ states.binary_sensor.iss.attributes.lat }},{{ states.binary_sensor.iss.attributes.long }}&zoom=4&size=865x512&maptype=mapnik&markers={{ states.binary_sensor.iss.attributes.lat }},{{ states.binary_sensor.iss.attributes.long }},lightblue + still_image_url: http://staticmap.openstreetmap.de/staticmap.php?center={{ state_attr('binary_sensor.iss', 'lat') }},{{ state_attr('binary_sensor.iss', 'long') }}&zoom=4&size=865x512&maptype=mapnik&markers={{ state_attr('binary_sensor.iss', 'lat') }},{{ state_attr('binary_sensor.iss', 'long') }},lightblue limit_refetch_to_url_change: true ``` {% endraw %} diff --git a/source/_components/light.template.markdown b/source/_components/light.template.markdown index f37c8081c8d..e38f011e1bd 100644 --- a/source/_components/light.template.markdown +++ b/source/_components/light.template.markdown @@ -92,7 +92,7 @@ Template Light may get an `unknown` state during startup. This results in error messages in your log file until that platform has completed loading. If you use `is_state()` function in your template, you can avoid this situation. For example, you would replace -{% raw %}`{{ states.switch.source.state == 'on' }}`{% endraw %} +{% raw %}`{{ is_state('switch.source', 'on') }}`{% endraw %} with this equivalent that returns `true`/`false` and never gives an unknown result: {% raw %}`{{ is_state('switch.source', 'on') }}`{% endraw %} @@ -118,7 +118,7 @@ light: friendly_name: "Receiver Volume" value_template: >- {% if is_state('media_player.receiver', 'on') %} - {% if states.media_player.receiver.attributes.is_volume_muted %} + {% if state_attr('media_player.receiver', 'is_volume_muted') %} off {% else %} on @@ -143,7 +143,7 @@ light: volume_level: "{{ (brightness / 255 * 100)|int / 100 }}" level_template: >- {% if is_state('media_player.receiver', 'on') %} - {{ (states.media_player.receiver.attributes.volume_level|float * 255)|int }} + {{ (state_attr('media_player.receiver', 'volume_level')|float * 255)|int }} {% else %} 0 {% endif %} @@ -163,7 +163,7 @@ light: friendly_name: "Receiver Volume" value_template: >- {% if is_state('media_player.receiver', 'on') %} - {% if states.media_player.receiver.attributes.is_volume_muted %} + {% if state_attr('media_player.receiver', 'is_volume_muted') %} off {% else %} on @@ -173,7 +173,7 @@ light: {% endif %} icon_template: >- {% if is_state('media_player.receiver', 'on') %} - {% if states.media_player.receiver.attributes.is_volume_muted %} + {% if state_attr('media_player.receiver', 'is_volume_muted') %} mdi:lightbulb-off {% else %} mdi:lightbulb-on @@ -207,7 +207,7 @@ light: friendly_name: "Receiver Volume" value_template: >- {% if is_state('media_player.receiver', 'on') %} - {% if states.media_player.receiver.attributes.is_volume_muted %} + {% if state_attr('media_player.receiver', 'is_volume_muted') %} off {% else %} on @@ -217,7 +217,7 @@ light: {% endif %} icon_template: >- {% if is_state('media_player.receiver', 'on') %} - {% if states.media_player.receiver.attributes.is_volume_muted %} + {% if state_attr('media_player.receiver', 'is_volume_muted') %} /local/lightbulb-off.png {% else %} /local/lightbulb-on.png diff --git a/source/_components/lock.template.markdown b/source/_components/lock.template.markdown index 39d6e4cde4b..c138f82247f 100644 --- a/source/_components/lock.template.markdown +++ b/source/_components/lock.template.markdown @@ -72,7 +72,7 @@ lock: ## {% linkable_title Considerations %} -If you are using the state of a platform that takes extra time to load, the Template Lock may get an `unknown` state during startup. This results in error messages in your log file until that platform has completed loading. If you use `is_state()` function in your template, you can avoid this situation. For example, you would replace {% raw %}`{{ states.switch.source.state == 'on' }}`{% endraw %} with this equivalent that returns `true`/`false` and never gives an unknown result: {% raw %}`{{ is_state('switch.source', 'on') }}`{% endraw %} +If you are using the state of a platform that takes extra time to load, the Template Lock may get an `unknown` state during startup. This results in error messages in your log file until that platform has completed loading. If you use `is_state()` function in your template, you can avoid this situation. For example, you would replace {% raw %}`{{ is_state('switch.source', 'on') }}`{% endraw %} with this equivalent that returns `true`/`false` and never gives an unknown result: {% raw %}`{{ is_state('switch.source', 'on') }}`{% endraw %} ## {% linkable_title Examples %} diff --git a/source/_components/london_air.markdown b/source/_components/london_air.markdown index 6bcfb0c93df..64f806e1036 100644 --- a/source/_components/london_air.markdown +++ b/source/_components/london_air.markdown @@ -72,11 +72,11 @@ To explore the data available within the `data` attribute of a sensor use the `d sensors: updated: friendly_name: 'Updated' - value_template: {% raw %}'{{states.sensor.merton.attributes.updated}}'{% endraw %} + value_template: {% raw %}'{{state_attr('sensor.merton', 'updated')}}'{% endraw %} merton_pm10: friendly_name: 'Merton PM10' - value_template: {% raw %}'{{states.sensor.merton.attributes.data[0].pollutants[0].summary}}'{% endraw %} + value_template: {% raw %}'{{state_attr('sensor.merton', 'data')[0].pollutants[0].summary}}'{% endraw %} westminster_s02: friendly_name: 'Westminster S02' - value_template: {% raw %}'{{states.sensor.westminster.attributes.data[0].pollutants[3].summary}}'{% endraw %} + value_template: {% raw %}'{{state_attr('sensor.westminster', 'data')[0].pollutants[3].summary}}'{% endraw %} ``` diff --git a/source/_components/min_max.markdown b/source/_components/min_max.markdown index 28a6ca136e5..209765f8173 100644 --- a/source/_components/min_max.markdown +++ b/source/_components/min_max.markdown @@ -23,9 +23,9 @@ This sensor is an alternative to the [template sensor](/components/sensor.templa {% raw %} ```yaml -{{ ((float(states.sensor.kitchen_temperature.state) + - float(states.sensor.living_room_temperature.state) + - float(states.sensor.office_temperature.state)) / 3) | round(2) +{{ ((float(states('sensor.kitchen_temperature')) + + float(states('sensor.living_room_temperature')) + + float(states('sensor.office_temperature'))) / 3) | round(2) }} ``` {% endraw %} diff --git a/source/_components/modem_callerid.markdown b/source/_components/modem_callerid.markdown index ca8a08b1964..cf6965fa18e 100644 --- a/source/_components/modem_callerid.markdown +++ b/source/_components/modem_callerid.markdown @@ -83,7 +83,7 @@ automation: action: service: notify.notify data: - message: 'Call from {{ states.sensor.modem_callerid.attributes.cid_name }} at {{ states.sensor.modem_callerid.attributes.cid_number }} ' + message: 'Call from {{ state_attr('sensor.modem_callerid', 'cid_name') }} at {{ state_attr('sensor.modem_callerid', 'cid_number') }} ' - alias: Notify CallerID webui trigger: platform: state @@ -93,7 +93,7 @@ automation: service: persistent_notification.create data: title: "Call from" - message: '{{ states.sensor.modem_callerid.attributes.cid_time.strftime("%I:%M %p") }} {{ states.sensor.modem_callerid.attributes.cid_name }} {{ states.sensor.modem_callerid.attributes.cid_number }} ' + message: '{{ state_attr('sensor.modem_callerid', 'cid_time').strftime("%I:%M %p") }} {{ state_attr('sensor.modem_callerid', 'cid_name') }} {{ state_attr('sensor.modem_callerid', 'cid_number') }} ' - alias: Say CallerID trigger: platform: state @@ -102,6 +102,6 @@ automation: action: service: tts.google_say data_template: - message: 'Call from {{ states.sensor.modem_callerid.attributes.cid_name }}' + message: 'Call from {{ state_attr('sensor.modem_callerid', 'cid_name') }}' ``` {% endraw %} diff --git a/source/_components/mvglive.markdown b/source/_components/mvglive.markdown index fcec67914b8..4d3d11ed901 100644 --- a/source/_components/mvglive.markdown +++ b/source/_components/mvglive.markdown @@ -93,5 +93,5 @@ sensor: ``` The first sensor will return S-Bahn departures to Munich Airport or Markt Schwaben that are at least 2 minutes away. -The second sensor returns U2 and U8 departures from Sendlinger Tor and stores a total of 5 departures in attributes. To retrieve the time until the second departure, you would use states.sensor.ENTITY_NAME.attributes.departures[1].time. +The second sensor returns U2 and U8 departures from Sendlinger Tor and stores a total of 5 departures in attributes. To retrieve the time until the second departure, you would use state_attr('sensor.ENTITY_NAME', 'departures')[1].time. The third sensor returns all south-bound U-Bahn trains from Scheidplatz. diff --git a/source/_components/mystrom.markdown b/source/_components/mystrom.markdown index 83e5495d6e8..67d32ea6f82 100644 --- a/source/_components/mystrom.markdown +++ b/source/_components/mystrom.markdown @@ -218,6 +218,6 @@ sensor: power: friendly_name: "Current Power" unit_of_measurement: "W" - value_template: "{{ states.switch.office.attributes.current_power_w }}" + value_template: "{{ state_attr('switch.office', 'current_power_w') }}" ``` {% endraw %} \ No newline at end of file diff --git a/source/_components/opengarage.markdown b/source/_components/opengarage.markdown index b746fd3b52c..b2c93df3c1e 100644 --- a/source/_components/opengarage.markdown +++ b/source/_components/opengarage.markdown @@ -105,7 +105,7 @@ sensor: garage_car_present: friendly_name: 'Honda in Garage' value_template: {% raw %}'{% if states.cover.honda %} - {% if states.cover.honda.state == "open" %} + {% if is_state('cover.honda', 'open') %} n/a {% elif ((states.cover.honda.attributes["distance_sensor"] > 40) and (states.cover.honda.attributes["distance_sensor"] < 100)) %} Yes diff --git a/source/_components/pvoutput.markdown b/source/_components/pvoutput.markdown index 82993d2b07f..d67614ef98e 100644 --- a/source/_components/pvoutput.markdown +++ b/source/_components/pvoutput.markdown @@ -60,19 +60,19 @@ sensor: - platform: template sensors: power_consumption: - value_template: {% raw %}'{% if is_state_attr("sensor.pvoutput", "power_consumption", "NaN") %}0{% else %}{{ states.sensor.pvoutput.attributes.power_consumption }}{% endif %}'{% endraw %} + value_template: {% raw %}'{% if is_state_attr("sensor.pvoutput", "power_consumption", "NaN") %}0{% else %}{{ state_attr('sensor.pvoutput', 'power_consumption') }}{% endif %}'{% endraw %} friendly_name: 'Using' unit_of_measurement: 'Watt' energy_consumption: - value_template: {% raw %}'{{ "%0.1f"|format(states.sensor.pvoutput.attributes.energy_consumption|float/1000) }}'{% endraw %} + value_template: {% raw %}'{{ "%0.1f"|format(state_attr('sensor.pvoutput', 'energy_consumption')|float/1000) }}'{% endraw %} friendly_name: 'Used' unit_of_measurement: 'kWh' power_generation: - value_template: {% raw %}'{% if is_state_attr("sensor.pvoutput", "power_generation", "NaN") %}0{% else %}{{ states.sensor.pvoutput.attributes.power_generation }}{% endif %}'{% endraw %} + value_template: {% raw %}'{% if is_state_attr("sensor.pvoutput", "power_generation", "NaN") %}0{% else %}{{ state_attr('sensor.pvoutput', 'power_generation') }}{% endif %}'{% endraw %} friendly_name: 'Generating' unit_of_measurement: 'Watt' energy_generation: - value_template: {% raw %}'{% if is_state_attr("sensor.pvoutput", "energy_generation", "NaN") %}0{% else %}{{ "%0.2f"|format(states.sensor.pvoutput.attributes.energy_generation|float/1000) }}{% endif %}'{% endraw %} + value_template: {% raw %}'{% if is_state_attr("sensor.pvoutput", "energy_generation", "NaN") %}0{% else %}{{ "%0.2f"|format(state_attr('sensor.pvoutput', 'energy_generation')|float/1000) }}{% endif %}'{% endraw %} friendly_name: 'Generated' unit_of_measurement: 'kWh' ``` diff --git a/source/_components/rest.markdown b/source/_components/rest.markdown index 41d033c6549..7e191542a05 100644 --- a/source/_components/rest.markdown +++ b/source/_components/rest.markdown @@ -263,22 +263,22 @@ sensor: - platform: template sensors: owm_weather: - value_template: '{{ states.sensor.owm_report.attributes.weather[0]["description"].title() }}' - entity_picture_template: '{{ "http://openweathermap.org/img/w/"+states.sensor.owm_report.attributes.weather[0]["icon"].lower()+".png" }}' + value_template: '{{ state_attr('sensor.owm_report', 'weather')[0]["description"].title() }}' + entity_picture_template: '{{ "http://openweathermap.org/img/w/"+state_attr('sensor.owm_report', 'weather')[0]["icon"].lower()+".png" }}' entity_id: sensor.owm_report owm_temp: friendly_name: 'Outside temp' - value_template: '{{ states.sensor.owm_report.attributes.main["temp"]-273.15 }}' + value_template: '{{ state_attr('sensor.owm_report', 'main')["temp"]-273.15 }}' unit_of_measurement: "°C" entity_id: sensor.owm_report owm_pressure: friendly_name: 'Outside pressure' - value_template: '{{ states.sensor.owm_report.attributes.main["pressure"] }}' + value_template: '{{ state_attr('sensor.owm_report', 'main')["pressure"] }}' unit_of_measurement: "hP" entity_id: sensor.owm_report owm_humidity: friendly_name: 'Outside humidity' - value_template: '{{ states.sensor.owm_report.attributes.main["humidity"] }}' + value_template: '{{ state_attr('sensor.owm_report', 'main')["humidity"] }}' unit_of_measurement: "%" entity_id: sensor.owm_report ``` diff --git a/source/_components/ring.markdown b/source/_components/ring.markdown index 90b4bc2ffa5..30921308775 100644 --- a/source/_components/ring.markdown +++ b/source/_components/ring.markdown @@ -118,14 +118,16 @@ downloader: Then you can use the following `action` in your automation (this will save the video file under `/downloads/ring_/`): +{% raw %} ```yaml action: - service: downloader.download_file data_template: - url: "{{ states.camera.front_door.attributes.video_url }}" - subdir: "{{states.camera.front_door.attributes.friendly_name}}" - filename: "{{states.camera.front_door.attributes.friendly_name}}" + url: "{{ state_attr('camera.front_door', 'video_url') }}" + subdir: "{{state_attr('camera.front_door', 'friendly_name')}}" + filename: "{{state_attr('camera.front_door', 'friendly_name')}}" ``` +{% endraw %} If you want to use `python_script`, enable it your `configuration.yaml` file first: diff --git a/source/_components/rmvtransport.markdown b/source/_components/rmvtransport.markdown index a133f813677..62be7f2e6bc 100644 --- a/source/_components/rmvtransport.markdown +++ b/source/_components/rmvtransport.markdown @@ -118,6 +118,6 @@ sensor: The first sensor will return S-Bahn, bus, RB and RE trains departures from Frankfurt Hauptbahnhof to Frankfurt Airport or Stadium that are at least 5 minutes away. -The second sensor returns bus departures from Wiesbaden Hauptbahnhof going to Dernsches Gelände and Mainz Hauptbahnhof. To retrieve the time of the second departure, you would use `states.sensor.ENTITY_NAME.attributes.departures[1].time`. +The second sensor returns bus departures from Wiesbaden Hauptbahnhof going to Dernsches Gelände and Mainz Hauptbahnhof. To retrieve the time of the second departure, you would use `state_attr('sensor.ENTITY_NAME', 'departures')[1].time`. The third sensor returns all S-Bahn trains from Mainz Hauptbahnhof for line S8. diff --git a/source/_components/rova.markdown b/source/_components/rova.markdown index 1ecc44969d4..1229162f701 100644 --- a/source/_components/rova.markdown +++ b/source/_components/rova.markdown @@ -98,9 +98,9 @@ automation: at: '19:00:00' condition: - condition: template - value_template: "{% if (as_timestamp(states.sensor.rova_garbage_gft.state) - as_timestamp(now())) < 43200 %}true{% endif %}" + value_template: "{% if (as_timestamp(states('sensor.rova_garbage_gft')) - as_timestamp(now())) < 43200 %}true{% endif %}" - condition: template - value_template: "{% if (as_timestamp(states.sensor.rova_garbage_gft.state) - as_timestamp(now())) > 0 %}true{% endif %}" + value_template: "{% if (as_timestamp(states('sensor.rova_garbage_gft')) - as_timestamp(now())) > 0 %}true{% endif %}" action: - service: NOTIFICATION_SERVICE data: diff --git a/source/_components/rss_feed_template.markdown b/source/_components/rss_feed_template.markdown index 83a91590044..c6fc484644f 100644 --- a/source/_components/rss_feed_template.markdown +++ b/source/_components/rss_feed_template.markdown @@ -28,7 +28,7 @@ rss_feed_template: title: "Garden {% raw %}{{ as_timestamp(now())|timestamp_custom('%H:%M', True) }}{% endraw %}" items: - title: "Outside temperature" - description: "{% raw %}{% if is_state('sensor.temp_outside','unknown') %}---{% else %}{{states.sensor.temp_outside.state}} °C{% endif %}{% endraw %}" + description: "{% raw %}{% if is_state('sensor.temp_outside','unknown') %}---{% else %}{{states('sensor.temp_outside')}} °C{% endif %}{% endraw %}" ``` {% configuration %} diff --git a/source/_components/script.markdown b/source/_components/script.markdown index 5efd98f0c19..7a1af47d4b0 100644 --- a/source/_components/script.markdown +++ b/source/_components/script.markdown @@ -26,7 +26,7 @@ script: # This is Home Assistant Script Syntax - service: notify.notify data_template: -          message: Current temperature is {% raw %}{{ states.sensor.temperature.state }}{% endraw %} +          message: Current temperature is {% raw %}{{ states('sensor.temperature') }}{% endraw %} ```

Script names (e.g., `message_temperature` in the example above) are not allowed to contain capital letters, or dash (minus) characters, i.e. `-`. The preferred way to separate words for better readability is to use underscore (`_`) characters. diff --git a/source/_components/sensehat.markdown b/source/_components/sensehat.markdown index e38d76a4944..6a7f2cf99e9 100644 --- a/source/_components/sensehat.markdown +++ b/source/_components/sensehat.markdown @@ -96,13 +96,13 @@ sensor: - platform: template sensors: sensehat_temperature: - value_template: '{{ states.sensor.temperature.state | round(1) }}' + value_template: '{{ states('sensor.temperature') | round(1) }}' unit_of_measurement: '°C' sensehat_pressure: - value_template: '{{ states.sensor.pressure.state | round(1) }}' + value_template: '{{ states('sensor.pressure') | round(1) }}' unit_of_measurement: 'mb' sensehat_humidity: - value_template: '{{ states.sensor.humidity.state | round(1) }}' + value_template: '{{ states('sensor.humidity') | round(1) }}' unit_of_measurement: '%' ``` diff --git a/source/_components/sensor.command_line.markdown b/source/_components/sensor.command_line.markdown index 502e7175b96..7c3fc82d51b 100644 --- a/source/_components/sensor.command_line.markdown +++ b/source/_components/sensor.command_line.markdown @@ -185,7 +185,7 @@ sensor: sensor: - platform: command_line name: wind direction - command: 'sh /home/pi/.homeassistant/scripts/wind_direction.sh {{ states.sensor.wind_direction.state }}' + command: 'sh /home/pi/.homeassistant/scripts/wind_direction.sh {{ states('sensor.wind_direction') }}' unit_of_measurement: "Direction" ``` {% endraw %} diff --git a/source/_components/seven_segments.markdown b/source/_components/seven_segments.markdown index 18b62f7ca63..a617be3c417 100644 --- a/source/_components/seven_segments.markdown +++ b/source/_components/seven_segments.markdown @@ -146,7 +146,7 @@ sensor: - platform: template sensors: power_meter: - value_template: '{{ states.image_processing.sevensegment_ocr_seven_segments.state }}' + value_template: '{{ states('image_processing.sevensegment_ocr_seven_segments') }}' friendly_name: 'Ampere' unit_of_measurement: 'A' ``` diff --git a/source/_components/shell_command.markdown b/source/_components/shell_command.markdown index 631fc1331c5..76d4c611f2d 100644 --- a/source/_components/shell_command.markdown +++ b/source/_components/shell_command.markdown @@ -61,6 +61,6 @@ input_number: {% raw %} shell_command: - set_ac_to_slider: 'irsend SEND_ONCE DELONGHI AC_{{ states.input_number.ac_temperature.state }}_AUTO' + set_ac_to_slider: 'irsend SEND_ONCE DELONGHI AC_{{ states('input_number.ac_temperature') }}_AUTO' {% endraw %} ``` diff --git a/source/_components/solaredge.markdown b/source/_components/solaredge.markdown index 9cad0e098cc..764181e05f9 100644 --- a/source/_components/solaredge.markdown +++ b/source/_components/solaredge.markdown @@ -131,6 +131,6 @@ sensors: platform: template sensors: solaredge_energy_this_year_template: - value_template: '{{(states.sensor.solaredge_energy_this_year.state | float / 1000) | round(2)}}' + value_template: '{{(states('sensor.solaredge_energy_this_year') | float / 1000) | round(2)}}' ``` {% endraw %} diff --git a/source/_components/solaredge_local.markdown b/source/_components/solaredge_local.markdown index 5187a313ee8..17d43a5913c 100644 --- a/source/_components/solaredge_local.markdown +++ b/source/_components/solaredge_local.markdown @@ -69,6 +69,6 @@ sensors: platform: template sensors: solaredge_energy_this_year_template: - value_template: '{{(states.sensor.solaredge_energy_this_year.state | float / 1000) | round(2)}}' + value_template: '{{(states('sensor.solaredge_energy_this_year') | float / 1000) | round(2)}}' ``` {% endraw %} diff --git a/source/_components/switch.rest.markdown b/source/_components/switch.rest.markdown index c0cc52e102d..91eb3dbde20 100644 --- a/source/_components/switch.rest.markdown +++ b/source/_components/switch.rest.markdown @@ -108,4 +108,4 @@ switch: ``` {% endraw %} -`body_on` and `body_off` can also depend on the state of the system. For example, to enable a remote temperature sensor tracking on a radio thermostat, one has to send the current value of the remote temperature sensor. This can be achieved by using the template `{% raw %}'{"rem_temp":{{states.sensor.bedroom_temp.state}}}'{% endraw %}`. +`body_on` and `body_off` can also depend on the state of the system. For example, to enable a remote temperature sensor tracking on a radio thermostat, one has to send the current value of the remote temperature sensor. This can be achieved by using the template `{% raw %}'{"rem_temp":{{states('sensor.bedroom_temp')}}}'{% endraw %}`. diff --git a/source/_components/switch.template.markdown b/source/_components/switch.template.markdown index e9522ea69cb..5b6acb64ede 100644 --- a/source/_components/switch.template.markdown +++ b/source/_components/switch.template.markdown @@ -82,7 +82,7 @@ switch: ## {% linkable_title Considerations %} -If you are using the state of a platform that takes extra time to load, the Template Switch may get an `unknown` state during startup. This results in error messages in your log file until that platform has completed loading. If you use `is_state()` function in your template, you can avoid this situation. For example, you would replace {% raw %}`{{ states.switch.source.state == 'on' }}`{% endraw %} with this equivalent that returns `true`/`false` and never gives an unknown result: {% raw %}`{{ is_state('switch.source', 'on') }}`{% endraw %} +If you are using the state of a platform that takes extra time to load, the Template Switch may get an `unknown` state during startup. This results in error messages in your log file until that platform has completed loading. If you use `is_state()` function in your template, you can avoid this situation. For example, you would replace {% raw %}`{{ is_state('switch.source', 'on') }}`{% endraw %} with this equivalent that returns `true`/`false` and never gives an unknown result: {% raw %}`{{ is_state('switch.source', 'on') }}`{% endraw %} ## {% linkable_title Examples %} diff --git a/source/_components/template.markdown b/source/_components/template.markdown index 21c2bca30d4..4db49040570 100644 --- a/source/_components/template.markdown +++ b/source/_components/template.markdown @@ -85,7 +85,7 @@ sensor: ### {% linkable_title Startup %} -If you are using the state of a platform that takes extra time to load, the Template Sensor may get an `unknown` state during startup. To avoid this (and the resulting error messages in your log file), you can use `is_state()` function in your template. For example, you would replace {% raw %}`{{ states.switch.source.state == 'on' }}`{% endraw %} with this equivalent that returns `true`/`false` and never gives an `unknown` result: +If you are using the state of a platform that takes extra time to load, the Template Sensor may get an `unknown` state during startup. To avoid this (and the resulting error messages in your log file), you can use `is_state()` function in your template. For example, you would replace {% raw %}`{{ is_state('switch.source', 'on') }}`{% endraw %} with this equivalent that returns `true`/`false` and never gives an `unknown` result: {% raw %}`{{ is_state('switch.source', 'on') }}`{% endraw %} diff --git a/source/_components/threshold.markdown b/source/_components/threshold.markdown index 4e679a2930a..0ca2df5e2da 100644 --- a/source/_components/threshold.markdown +++ b/source/_components/threshold.markdown @@ -25,7 +25,7 @@ It's an alternative to the template binary sensor's `value_template:` to get the {% raw %} ```yaml -{{ states.sensor.furnace.state > 2.5 }} +{{ states('sensor.furnace') > 2.5 }} ``` {% endraw %} diff --git a/source/_components/tibber.markdown b/source/_components/tibber.markdown index c9a7316eaf0..491cded5e2d 100644 --- a/source/_components/tibber.markdown +++ b/source/_components/tibber.markdown @@ -90,13 +90,13 @@ The electricity price can be used to make automations. The sensor has a `max_pri minutes: 1 condition: condition: template - value_template: '{{ float(states.sensor.electricity_price_hamretunet_10.state) > 0.9 * float(states.sensor.electricity_price_hamretunet_10.attributes.max_price) }}' + value_template: '{{ float(states('sensor.electricity_price_hamretunet_10')) > 0.9 * float(state_attr('sensor.electricity_price_hamretunet_10', 'max_price')) }}' action: - service: notify.pushbullet data: title: "Electricity price" target: "device/daniel_telefon_cat" - message: "The electricity price is now {{ states.sensor.electricity_price_hamretunet_10.state }}" + message: "The electricity price is now {{ states('sensor.electricity_price_hamretunet_10') }}" ``` {% endraw %} diff --git a/source/_components/transport_nsw.markdown b/source/_components/transport_nsw.markdown index cac249d8553..3966d348f62 100644 --- a/source/_components/transport_nsw.markdown +++ b/source/_components/transport_nsw.markdown @@ -100,7 +100,7 @@ The sensor returns n/a if no stop event is found within the next 24h. A `templat {% if is_state_attr('sensor.bus', 'due', 'n/a') %} No schedule found {% else %} - {{ states.sensor.bus.attributes.route }} in {{ states.sensor.bus.attributes.due }}m ({{ states.sensor.bus.attributes.delay }}) + {{ state_attr('sensor.bus', 'route') }} in {{ state_attr('sensor.bus', 'due') }}m ({{ state_attr('sensor.bus', 'delay') }}) {% endif %} ``` {% endraw %} diff --git a/source/_components/uk_transport.markdown b/source/_components/uk_transport.markdown index b8b3967d42a..12341bbba5c 100644 --- a/source/_components/uk_transport.markdown +++ b/source/_components/uk_transport.markdown @@ -90,19 +90,19 @@ Attributes can be accessed using the [template sensor](/components/sensor.templa sensors: next_train_status: friendly_name: 'Next train status' - value_template: {% raw %}'{{states.sensor.next_train_to_wat.attributes.next_trains[0].status}}'{% endraw %} + value_template: {% raw %}'{{state_attr('sensor.next_train_to_wat', 'next_trains')[0].status}}'{% endraw %} next_trains_origin: friendly_name: 'Next train origin' - value_template: {% raw %}'{{states.sensor.next_train_to_wat.attributes.next_trains[0].origin_name}}'{% endraw %} + value_template: {% raw %}'{{state_attr('sensor.next_train_to_wat', 'next_trains')[0].origin_name}}'{% endraw %} next_trains_estimated: friendly_name: 'Next train estimated' - value_template: {% raw %}'{{states.sensor.next_train_to_wat.attributes.next_trains[0].estimated}}'{% endraw %} + value_template: {% raw %}'{{state_attr('sensor.next_train_to_wat', 'next_trains')[0].estimated}}'{% endraw %} next_trains_scheduled: friendly_name: 'Next train scheduled' - value_template: {% raw %}'{{states.sensor.next_train_to_wat.attributes.next_trains[0].scheduled}}'{% endraw %} + value_template: {% raw %}'{{state_attr('sensor.next_train_to_wat', 'next_trains')[0].scheduled}}'{% endraw %} next_trains_platform: friendly_name: 'Next train platform' - value_template: {% raw %}'{{states.sensor.next_train_to_wat.attributes.next_trains[0].platform}}'{% endraw %} + value_template: {% raw %}'{{state_attr('sensor.next_train_to_wat', 'next_trains')[0].platform}}'{% endraw %} ``` Bus sensors require as their `origin` a bus stop ATCO code which can be found by browsing OpenStreetMap data as @@ -138,16 +138,16 @@ And the template sensor for viewing the next bus attributes. sensors: next_bus_route: friendly_name: 'Next bus route' - value_template: {% raw %}'{{states.sensor.next_bus_to_wantage.attributes.next_buses[0].route}}'{% endraw %} + value_template: {% raw %}'{{state_attr('sensor.next_bus_to_wantage', 'next_buses')[0].route}}'{% endraw %} next_bus_direction: friendly_name: 'Next bus direction' - value_template: {% raw %}'{{states.sensor.next_bus_to_wantage.attributes.next_buses[0].direction}}'{% endraw %} + value_template: {% raw %}'{{state_attr('sensor.next_bus_to_wantage', 'next_buses')[0].direction}}'{% endraw %} next_bus_scheduled: friendly_name: 'Next bus scheduled' - value_template: {% raw %}'{{states.sensor.next_bus_to_wantage.attributes.next_buses[0].scheduled}}'{% endraw %} + value_template: {% raw %}'{{state_attr('sensor.next_bus_to_wantage', 'next_buses')[0].scheduled}}'{% endraw %} next_bus_estimated: friendly_name: 'Next bus estimated' - value_template: {% raw %}'{{states.sensor.next_bus_to_wantage.attributes.next_buses[0].estimated}}'{% endraw %} + value_template: {% raw %}'{{state_attr('sensor.next_bus_to_wantage', 'next_buses')[0].estimated}}'{% endraw %} ``` ## {% linkable_title Managing API requests %} diff --git a/source/_components/vacuum.xiaomi_miio.markdown b/source/_components/vacuum.xiaomi_miio.markdown index 6f4d7787de5..f9f122c053e 100644 --- a/source/_components/vacuum.xiaomi_miio.markdown +++ b/source/_components/vacuum.xiaomi_miio.markdown @@ -119,6 +119,7 @@ Start the cleaning operation in the areas selected for the number of repeats ind Example of `vacuum.xiaomi_clean_zone` use: Inline array: +{% raw %} ```yaml automation: - alias: Test vacuum zone3 @@ -130,10 +131,13 @@ automation: - service: vacuum.xiaomi_clean_zone data_template: entity_id: vacuum.xiaomi_vacuum - repeats: '{{states.input_number.vacuum_passes.state|int}}' + repeats: '{{states('input_number.vacuum_passes')|int}}' zone: [[30914,26007,35514,28807], [20232,22496,26032,26496]] ``` +{% endraw %} + Array with inline zone: +{% raw %} ```yaml automation: - alias: Test vacuum zone3 @@ -145,11 +149,13 @@ automation: - service: vacuum.xiaomi_clean_zone data_template: entity_id: vacuum.xiaomi_vacuum - repeats: '{{states.input_number.vacuum_passes.state|int}}' + repeats: '{{states('input_number.vacuum_passes')|int}}' zone: - [30914,26007,35514,28807] - [20232,22496,26032,26496] ``` +{% endraw %} + Array mode: ```yaml automation: diff --git a/source/_components/webostv.markdown b/source/_components/webostv.markdown index bbaf032b47f..b2911b0d30c 100644 --- a/source/_components/webostv.markdown +++ b/source/_components/webostv.markdown @@ -202,6 +202,7 @@ icon: A possible automation could be: +{% raw %} ```yaml # Example configuration.yaml entry automation: @@ -213,8 +214,9 @@ automation: action: service: notify.livingroom_tv data: - message: "You should open a window! (Livingroom Co2: {{ states.sensor.netatmo_livingroom_co2.state }}ppm)" + message: "You should open a window! (Livingroom Co2: {{ states('sensor.netatmo_livingroom_co2') }}ppm)" ``` +{% endraw %} The icon can be overridden for individual notifications by providing a path to an alternative icon image to use: diff --git a/source/_cookbook/automation_first_light.markdown b/source/_cookbook/automation_first_light.markdown index be4770c4f7e..7c1319cd1e0 100644 --- a/source/_cookbook/automation_first_light.markdown +++ b/source/_cookbook/automation_first_light.markdown @@ -73,16 +73,16 @@ automation: - condition: numeric_state entity_id: light.livingroom_ec # if light is off, force a 0, otherwise use the brightness value - value_template: {% raw %}'{% if states.light.livingroom_ec.state == "on" %}{{ states.light.livingroom_ec.attributes.brightness }}{% else %}0{% endif %}'{% endraw %} + value_template: {% raw %}'{% if is_state('light.livingroom_ec', 'on') %}{{ state_attr('light.livingroom_ec', 'brightness') }}{% else %}0{% endif %}'{% endraw %} # brightness below 50% (255 = 100%) below: 128 - condition: numeric_state entity_id: light.kitchen_bar - value_template: {% raw %}'{% if states.light.kitchen_bar.state == "on" %}{{ states.light.kitchen_bar.attributes.brightness }}{% else %}0{% endif %}'{% endraw %} + value_template: {% raw %}'{% if is_state('light.kitchen_bar', 'on') %}{{ state_attr('light.kitchen_bar', 'brightness') }}{% else %}0{% endif %}'{% endraw %} below: 128 - condition: numeric_state entity_id: light.kitchen_ceiling - value_template: {% raw %}'{% if states.light.kitchen_ceiling.state == "on" %}{{ states.light.kitchen_ceiling.attributes.brightness }}{% else %}0{% endif %}'{% endraw %} + value_template: {% raw %}'{% if is_state('light.kitchen_ceiling', 'on') %}{{ state_attr('light.kitchen_ceiling', 'brightness') }}{% else %}0{% endif %}'{% endraw %} below: 128 # Trigger a scene diff --git a/source/_cookbook/dim_and_brighten_lights.markdown b/source/_cookbook/dim_and_brighten_lights.markdown index 98222e719cf..85ba24b9215 100644 --- a/source/_cookbook/dim_and_brighten_lights.markdown +++ b/source/_cookbook/dim_and_brighten_lights.markdown @@ -115,7 +115,7 @@ script: data_template: entity_id: light.YOUR_LIGHT brightness: >- - {% raw %}{% set current = states.light.YOUR_LIGHT.attributes.brightness|default(0)|int %} + {% raw %}{% set current = state_attr('light.YOUR_LIGHT', 'brightness')|default(0)|int %} {% set step = states('input_number.light_step')|int %} {% set next = current + step %} {% if next > states('input_number.light_maximum')|int %} @@ -124,7 +124,7 @@ script: {{ next }}{% endraw %} - service_template: > - {% raw %}{% if states.light.YOUR_LIGHT.attributes.brightness|default(0)|int < states('input_number.light_maximum')|int %} + {% raw %}{% if state_attr('light.YOUR_LIGHT', 'brightness')|default(0)|int < states('input_number.light_maximum')|int %} script.turn_on {% else %} script.turn_off @@ -146,7 +146,7 @@ script: data_template: entity_id: light.YOUR_LIGHT brightness: >- - {% raw %}{% set current = states.light.YOUR_LIGHT.attributes.brightness|default(0)|int %} + {% raw %}{% set current = state_attr('light.YOUR_LIGHT', 'brightness')|default(0)|int %} {% set step = states('input_number.light_step')|int %} {% set next = current - step %} {% if next < states('input_number.light_minimum')|int %} @@ -155,7 +155,7 @@ script: {{ next }}{% endraw %} - service_template: > - {% raw %}{% if states.light.YOUR_LIGHT.attributes.brightness|default(0)|int > states('input_number.light_minimum')|int %} + {% raw %}{% if state_attr('light.YOUR_LIGHT', 'brightness')|default(0)|int > states('input_number.light_minimum')|int %} script.turn_on {% else %} script.turn_off diff --git a/source/_cookbook/google_maps_card.markdown b/source/_cookbook/google_maps_card.markdown index 56b3e14f639..f22a886d3e8 100644 --- a/source/_cookbook/google_maps_card.markdown +++ b/source/_cookbook/google_maps_card.markdown @@ -22,7 +22,7 @@ It also leverages the `limit_refetch_to_url_change` option to ensure that we do camera: name: Paulus platform: generic - still_image_url: {% raw %}https://maps.googleapis.com/maps/api/staticmap?center={{ states.device_tracker.demo_paulus.attributes.latitude }},{{ states.device_tracker.demo_paulus.attributes.longitude }}&zoom=13&size=500x500&maptype=roadmap&markers=color:blue%7Clabel:P%7C{{ states.device_tracker.demo_paulus.attributes.latitude }},{{ states.device_tracker.demo_paulus.attributes.longitude }}{% endraw %}&key=YOUR_API_KEY + still_image_url: {% raw %}https://maps.googleapis.com/maps/api/staticmap?center={{ state_attr('device_tracker.demo_paulus', 'latitude') }},{{ state_attr('device_tracker.demo_paulus', 'longitude') }}&zoom=13&size=500x500&maptype=roadmap&markers=color:blue%7Clabel:P%7C{{ state_attr('device_tracker.demo_paulus', 'latitude') }},{{ state_attr('device_tracker.demo_paulus', 'longitude') }}{% endraw %}&key=YOUR_API_KEY limit_refetch_to_url_change: true ``` diff --git a/source/_cookbook/notify_if__new_ha_release.markdown b/source/_cookbook/notify_if__new_ha_release.markdown index e502d7b5a8c..65149a9810e 100644 --- a/source/_cookbook/notify_if__new_ha_release.markdown +++ b/source/_cookbook/notify_if__new_ha_release.markdown @@ -49,6 +49,6 @@ automation: data_template: title: 'New Home Assistant Release' target: 'YOUR_TARGET_HERE' #See Pushbullet integration for usage - message: "Home Assistant {% raw %} {{ states.updater.updater.state }} {% endraw %} is now available." + message: "Home Assistant {% raw %} {{ states('updater.updater') }} {% endraw %} is now available." ``` diff --git a/source/_cookbook/notify_if_over_threshold.markdown b/source/_cookbook/notify_if_over_threshold.markdown index c7dbc72ea1c..1d7a32b2f9d 100644 --- a/source/_cookbook/notify_if_over_threshold.markdown +++ b/source/_cookbook/notify_if_over_threshold.markdown @@ -29,7 +29,7 @@ automation: service: notify.mypushbullet data_template: title: "Furnace fan is running" - message: "Fan running because current is {% raw %}{{ states.sensor.furnace.state }}{% endraw %} amps" + message: "Fan running because current is {% raw %}{{ states('sensor.furnace') }}{% endraw %} amps" ``` If you also want a notification when it drops back down below that limit, you could add this as well: @@ -44,5 +44,5 @@ If you also want a notification when it drops back down below that limit, you co service: notify.mypushbullet data_template: title: "Furnace fan is stopped" - message: "Fan stopped because current is {% raw %}{{ states.sensor.furnace.state }}{% endraw %} amps" + message: "Fan stopped because current is {% raw %}{{ states('sensor.furnace') }}{% endraw %} amps" ``` diff --git a/source/_cookbook/track_battery_level.markdown b/source/_cookbook/track_battery_level.markdown index f0203b3f252..aa8a1f51bb1 100644 --- a/source/_cookbook/track_battery_level.markdown +++ b/source/_cookbook/track_battery_level.markdown @@ -23,10 +23,10 @@ sensor: friendly_name: iPhone Battery unit_of_measurement: '%' value_template: >- - {%- if states.device_tracker.iphone.attributes.battery %} - {{ states.device_tracker.iphone.attributes.battery|round }} + {%- if state_attr('device_tracker.iphone', 'battery') %} + {{ state_attr('device_tracker.iphone', 'battery')|round }} {% else %} - {{ states.sensor.battery_iphone.state }} + {{ states('sensor.battery_iphone') }} {%- endif %} device_class: battery ``` diff --git a/source/_docs/automation/action.markdown b/source/_docs/automation/action.markdown index 0df212be7cd..3a99d3e6768 100644 --- a/source/_docs/automation/action.markdown +++ b/source/_docs/automation/action.markdown @@ -61,9 +61,9 @@ automation: - condition: or conditions: - condition: template - value_template: '{% raw %}{{ states.sun.sun.attributes.elevation < 4 }}{% endraw %}' + value_template: '{% raw %}{{ state_attr('sun.sun', 'elevation') < 4 }}{% endraw %}' - condition: template - value_template: '{% raw %}{{ states.sensor.sensorluz_7_0.state < 10 }}{% endraw %}' + value_template: '{% raw %}{{ states('sensor.sensorluz_7_0') < 10 }}{% endraw %}' - service: scene.turn_on entity_id: scene.DespiertaDespacho ``` diff --git a/source/_docs/automation/condition.markdown b/source/_docs/automation/condition.markdown index cae9f96a978..1ec98f8efa9 100644 --- a/source/_docs/automation/condition.markdown +++ b/source/_docs/automation/condition.markdown @@ -27,9 +27,9 @@ automation: condition: or conditions: - condition: template - value_template: '{% raw %}{{ states.sun.sun.attributes.elevation < 4 }}{% endraw %}' + value_template: '{% raw %}{{ state_attr('sun.sun', 'elevation') < 4 }}{% endraw %}' - condition: template - value_template: '{% raw %}{{ states.sensor.sensorluz_7_0.state < 10 }}{% endraw %}' + value_template: '{% raw %}{{ states('sensor.sensorluz_7_0') < 10 }}{% endraw %}' action: - service: scene.turn_on entity_id: scene.DespiertaDespacho diff --git a/source/_docs/configuration/templating.markdown b/source/_docs/configuration/templating.markdown index d7cf62b6b8f..339342376e0 100644 --- a/source/_docs/configuration/templating.markdown +++ b/source/_docs/configuration/templating.markdown @@ -80,7 +80,7 @@ The next two statements result in the same value if the state exists. The second {% raw %} ```text {{ states('device_tracker.paulus') }} -{{ states.device_tracker.paulus.state }} +{{ states('device_tracker.paulus') }} ``` {% endraw %} diff --git a/source/_docs/scripts.markdown b/source/_docs/scripts.markdown index 72bc4b0cd72..c1b79c6c150 100644 --- a/source/_docs/scripts.markdown +++ b/source/_docs/scripts.markdown @@ -136,7 +136,7 @@ You can also get the script to abort after the timeout by using `continue_on_tim {% raw %} ```yaml # Wait until a valve is < 10 or abort after 1 minute. -- wait_template: "{{ states.climate.kitchen.attributes.valve|int < 10 }}" +- wait_template: "{{ state_attr('climate.kitchen', 'valve')|int < 10 }}" timeout: '00:01:00' continue_on_timeout: 'false' ``` diff --git a/source/_docs/scripts/conditions.markdown b/source/_docs/scripts/conditions.markdown index 26968f97601..14287fd3678 100644 --- a/source/_docs/scripts/conditions.markdown +++ b/source/_docs/scripts/conditions.markdown @@ -150,15 +150,15 @@ condition: condition: and # 'twilight' condition: dusk and dawn, in typical locations conditions: - condition: template - value_template: {% raw %}'{{ states.sun.sun.attributes.elevation < 0 }}'{% endraw %} + value_template: {% raw %}'{{ state_attr('sun.sun', 'elevation') < 0 }}'{% endraw %} - condition: template - value_template: {% raw %}'{{ states.sun.sun.attributes.elevation > -6 }}'{% endraw %} + value_template: {% raw %}'{{ state_attr('sun.sun', 'elevation') > -6 }}'{% endraw %} ``` ```yaml condition: condition: template # 'night' condition: from dusk to dawn, in typical locations - value_template: {% raw %}'{{ states.sun.sun.attributes.elevation < -6 }}'{% endraw %} + value_template: {% raw %}'{{ state_attr('sun.sun', 'elevation') < -6 }}'{% endraw %} ``` #### {% linkable_title Sunset/sunrise condition %} diff --git a/source/_docs/scripts/service-calls.markdown b/source/_docs/scripts/service-calls.markdown index 05d222d9b64..bdfb0cf30e7 100644 --- a/source/_docs/scripts/service-calls.markdown +++ b/source/_docs/scripts/service-calls.markdown @@ -49,7 +49,7 @@ You can use [templating] support to dynamically choose which service to call. Fo ```yaml service_template: > - {% raw %}{% if states.sensor.temperature.state | float > 15 %} + {% raw %}{% if states('sensor.temperature') | float > 15 %} switch.turn_on {% else %} switch.turn_off From 0df23b1a72227f1d00a49989b2a33858242d248b Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Sun, 30 Jun 2019 22:08:52 +0200 Subject: [PATCH 052/116] Removes self referencing git submodule (#9743) --- .gitmodules | 3 --- _deploy | 1 - 2 files changed, 4 deletions(-) delete mode 100644 .gitmodules delete mode 160000 _deploy diff --git a/.gitmodules b/.gitmodules deleted file mode 100644 index be241929d63..00000000000 --- a/.gitmodules +++ /dev/null @@ -1,3 +0,0 @@ -[submodule "_deploy"] - path = _deploy - url = https://github.com/home-assistant/home-assistant.github.io.git diff --git a/_deploy b/_deploy deleted file mode 160000 index 69146ecaf4d..00000000000 --- a/_deploy +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 69146ecaf4d31902ab9ea0a4e6c9f3985d99e808 From b954f01b1379364f463fe3a557a108ff762d4e22 Mon Sep 17 00:00:00 2001 From: Paulus Schoutsen Date: Sun, 30 Jun 2019 15:21:32 -0700 Subject: [PATCH 053/116] Mention website analytics platform in privacy policy (#9746) --- source/privacy/index.markdown | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/privacy/index.markdown b/source/privacy/index.markdown index 213d0fe0011..63189c2e719 100644 --- a/source/privacy/index.markdown +++ b/source/privacy/index.markdown @@ -19,7 +19,7 @@ If you have questions about deleting or correcting your personal data please con ## {% linkable_title Website Visitors %} -Like most website operators, Home Assistant collects non-personally-identifying information of the sort that web browsers and servers typically make available, such as the browser type, language preference, referring site, and the date and time of each visitor request. Home Assistant’s purpose in collecting non-personally identifying information is to better understand how Home Assistant’s visitors use its website. From time to time, Home Assistant may release non-personally-identifying information in the aggregate, e.g., by publishing a report on trends in the usage of its website. +Like most website operators, Home Assistant collects non-personally-identifying information of the sort that web browsers and servers typically make available, such as the browser type, language preference, referring site, and the date and time of each visitor request. Home Assistant uses the Google Analytics service for this. Home Assistant’s purpose in collecting non-personally identifying information is to better understand how Home Assistant’s visitors use its website. From time to time, Home Assistant may release non-personally-identifying information in the aggregate, e.g., by publishing a report on trends in the usage of its website. Home Assistant also collects potentially personally-identifying information like Internet Protocol (IP) addresses for logged in users and for users leaving comments on the blog or forums. Home Assistant only discloses logged in user and commenter IP addresses under the same circumstances that it uses and discloses personally-identifying information as described below. @@ -33,7 +33,7 @@ Home Assistant may collect statistics about the behavior of visitors to its webs ## {% linkable_title Information We Collect from Other Sources %} -With your authorization, we may also obtain information about you from other sources. For example, if you create or log into your WordPress.com account through a social media service (like Facebook or Google) or if you connect your account to a social media service, we will receive information from that service (such as your username, basic profile information, and friends list) via the authorization procedures used by that service. The information we receive depends on which services you authorize and any options that are available. +With your authorization, we may also obtain information about you from other sources. For example, if you create or log into your Home Assistant Community account through a social media service (like Facebook or Google) or if you connect your account to a social media service, we will receive information from that service (such as your username, basic profile information, and friends list) via the authorization procedures used by that service. The information we receive depends on which services you authorize and any options that are available. ## {% linkable_title Protection of Certain Personally-Identifying Information %} From 18b489c67476fa0370e83ff82693131a2b57e2e3 Mon Sep 17 00:00:00 2001 From: Maikel Punie Date: Mon, 1 Jul 2019 00:32:24 +0200 Subject: [PATCH 054/116] Added Covers to the velbus docu (#9742) * Added Covers to the velbus docu * :pencil2: Removed redirect --- source/_components/velbus.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/source/_components/velbus.markdown b/source/_components/velbus.markdown index 1914c093aa9..3aced2e7d8b 100644 --- a/source/_components/velbus.markdown +++ b/source/_components/velbus.markdown @@ -31,6 +31,7 @@ There is currently support for the following device types within Home Assistant: - Climate - Sensor - Switch +- Cover ## {% linkable_title Configuration %} From a9809ddabab81bbcaccec9b937401d96bc8a140d Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Mon, 1 Jul 2019 00:34:37 +0200 Subject: [PATCH 055/116] Collection of small technical cleanups (#9744) * Cleanup .gitignore * Removes .travis.yaml * Removes .project file * Renamed README.markdown -> README.md --- .gitignore | 8 -------- .project | 11 ----------- .travis.yml | 8 -------- README.markdown => README.md | 0 4 files changed, 27 deletions(-) delete mode 100644 .project delete mode 100644 .travis.yml rename README.markdown => README.md (100%) diff --git a/.gitignore b/.gitignore index 7578554e295..6ea9502ede3 100644 --- a/.gitignore +++ b/.gitignore @@ -4,8 +4,6 @@ .gist-cache .pygments-cache public -sass.old -source.old source/_stash source/stylesheets/screen.css vendor @@ -13,12 +11,6 @@ node_modules source/.jekyll-metadata *.iml .idea/ -/.vs/home-assistant.github.io/v15/.suo -/.vs/ProjectSettings.json -/.vs/slnx.sqlite -/.vs/config/applicationhost.config -/.vs/slnx.sqlite-journal -/.vs/VSWorkspaceState.json .vscode/* !.vscode/cSpell.json !.vscode/extensions.json diff --git a/.project b/.project deleted file mode 100644 index 8039da0a1cc..00000000000 --- a/.project +++ /dev/null @@ -1,11 +0,0 @@ - - - home-assistant.github.io - - - - - - - - diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index 7d2e817ef4f..00000000000 --- a/.travis.yml +++ /dev/null @@ -1,8 +0,0 @@ -language: ruby -sudo: false -cache: bundler -before_install: - - gem install bundler:2.0.1 -script: travis_wait bundle exec rake generate -after_success: - - '[ "${TRAVIS_BRANCH}" = "current" ] && [ "${TRAVIS_PULL_REQUEST}" = "false" ] && bundle exec rake deploy || false' diff --git a/README.markdown b/README.md similarity index 100% rename from README.markdown rename to README.md From 2c4b35bbefe50553055b26e6ceb1a4395b3d95aa Mon Sep 17 00:00:00 2001 From: aidbish <38182386+aidbish@users.noreply.github.com> Date: Mon, 1 Jul 2019 16:44:37 +1000 Subject: [PATCH 056/116] Removes Hassio external storage page (#9737) * No longer valid https://github.com/home-assistant/home-assistant.io/issues/9712 * Remove External storage --- .../_includes/asides/hassio_navigation.html | 1 - source/hassio/external_storage.markdown | 21 ------------------- 2 files changed, 22 deletions(-) delete mode 100644 source/hassio/external_storage.markdown diff --git a/source/_includes/asides/hassio_navigation.html b/source/_includes/asides/hassio_navigation.html index f8e6a3debeb..124a47ff1be 100644 --- a/source/_includes/asides/hassio_navigation.html +++ b/source/_includes/asides/hassio_navigation.html @@ -17,7 +17,6 @@

  • {% active_link /hassio/commandline/ Command line %}
  • {% active_link /hassio/zwave/ Z-Wave %}
    • -
  • {% active_link /hassio/external_storage/ External storage %}
  • {% active_link /hassio/run_local/ Execute local things %}
  • {% active_link /hassio/enable_i2c/ Enable I2C %}
diff --git a/source/hassio/external_storage.markdown b/source/hassio/external_storage.markdown deleted file mode 100644 index b4a930bc194..00000000000 --- a/source/hassio/external_storage.markdown +++ /dev/null @@ -1,21 +0,0 @@ ---- -layout: page -title: "External device" -description: "How to map external device on Hass.io." -date: 2017-04-30 13:28 -sidebar: true -comments: false -sharing: true -footer: true ---- - -### {% linkable_title ResinOS / Generic %} - -Map the USB drive into add-on with `devices` options. If you need it on multiple add-ons, you can use the `/share` folder which is accessible from various add-ons. -It is also possible to create an add-on that only mounts stuff to `share`. - -You can format the USB device with multiple volumes and map it to a specific add-on. - -### {% linkable_title Generic %} - -The `share` defaults to `/usr/share/hassio/share` so you can mount your volumes into this folder. From e1e337d4a47fe692aca651c88d6f3b6c31a8fd79 Mon Sep 17 00:00:00 2001 From: aidbish <38182386+aidbish@users.noreply.github.com> Date: Mon, 1 Jul 2019 17:22:40 +1000 Subject: [PATCH 057/116] Removes Hassio running local things (#9748) * No longer required https://github.com/home-assistant/home-assistant.io/issues/9713 * Update Hassio_navigation --- .../_includes/asides/hassio_navigation.html | 1 - source/hassio/run_local.markdown | 104 ------------------ 2 files changed, 105 deletions(-) delete mode 100644 source/hassio/run_local.markdown diff --git a/source/_includes/asides/hassio_navigation.html b/source/_includes/asides/hassio_navigation.html index 124a47ff1be..ffb99b948b0 100644 --- a/source/_includes/asides/hassio_navigation.html +++ b/source/_includes/asides/hassio_navigation.html @@ -17,7 +17,6 @@
  • {% active_link /hassio/commandline/ Command line %}
  • {% active_link /hassio/zwave/ Z-Wave %}
    • -
  • {% active_link /hassio/run_local/ Execute local things %}
  • {% active_link /hassio/enable_i2c/ Enable I2C %}
diff --git a/source/hassio/run_local.markdown b/source/hassio/run_local.markdown deleted file mode 100644 index ff94891a927..00000000000 --- a/source/hassio/run_local.markdown +++ /dev/null @@ -1,104 +0,0 @@ ---- -layout: page -title: "Run local scripts" -description: "Instructions on how to run a local script for Home Assistant." -date: 2017-04-30 13:28 -sidebar: true -comments: false -sharing: true -footer: true ---- - -Hass.io is a managed environment, which means you can't install applications that can be embedded into Home Assistant using the `command_line` sensor/switch. - -There are three options if you need to run a script which reads data from a sensor or sends commands to other devices on Hass.io. - -The first option is to write a custom integration for Home Assistant. This implies that you can communicate with your device using Python. For more information about developing a custom component, take a look at [custom-component development][custom-component]. - -The second option is to use STDIN inside an add-on and use the service `hassio.addon_stdin` to send data. For more information, have a look at [internal add-on communication][communication]. Here you will also find how you can easily access the Home Assistant Rest API. - -The third option is to create a local add-on for Hass.io that sends the data to Home Assistant via MQTT. Before we dive into this, read up on [Hass.io add-on development][addons-tutorial] first. - -For security and speed, Hass.io does not provide a way for containers to communicate directly. So the first step is to set up a communication channel. We're going to use MQTT for this using the [MQTT broker add-on][mqtt-addon]. - -### {% linkable_title Sensors %} - -We loop in our script to fetch data and push it to MQTT and wait until the next process is ready. Here is a basic example and structure for that process. - -In our Dockerfile we need to install: - -``` -RUN apk --no-cache add jq mosquitto-clients -``` - -Now we can process it with `run.sh`: - -```bash -#!/bin/bash -set -e - -CONFIG_PATH=/data/options.json - -# possible options for processing -MQTT_SERVER=$(jq --raw-output '.server' $CONFIG_PATH) -MQTT_PORT=$(jq --raw-output '.port' $CONFIG_PATH) -TOPIC=$(jq --raw-output '.topic' $CONFIG_PATH) -USER=$(jq --raw-output '.user' $CONFIG_PATH) -PASSWORD=$(jq --raw-output '.password' $CONFIG_PATH) -WAIT_TIME=$(jq --raw-output '.seconds' $CONFIG_PATH) - -# read data -while true -do - if OUTPUT="$(/read_my_sensor.sh)" - then - mosquitto_pub -h "$MQTT_SERVER" -p "$MQTT_PORT" -u "$USER" -P "$PASSWORD" -t "$TOPIC" -m "$OUTPUT" || true - else - echo "$(data) [ERROR] can't read sensor: $OUTPUT" - fi - - sleep "$WAIT_TIME" -done -``` - -### {% linkable_title Commands %} - -We wait for incoming data from the MQTT broker. We can also use an `input_boolean` that triggers an automation to publish a custom command to MQTT topic that can process multiple things in one add-on. - -In our Dockerfile we need to install: - -``` -RUN apk --no-cache add jq mosquitto-clients -``` - -Now we can process it with `run.sh`: - -```bash -#!/bin/bash -set -e - -CONFIG_PATH=/data/options.json - -# possible options for processing -MQTT_SERVER=$(jq --raw-output '.server' $CONFIG_PATH) -MQTT_PORT=$(jq --raw-output '.port' $CONFIG_PATH) -TOPIC=$(jq --raw-output '.topic' $CONFIG_PATH) -USER=$(jq --raw-output '.user' $CONFIG_PATH) -PASSWORD=$(jq --raw-output '.password' $CONFIG_PATH) - -# read data -while read -r message -do - if [ "$message" == "on" ]; then - /do_command_on.sh || true - else - /do_command_off.sh || true - fi - -done < <(mosquitto_sub -h "$MQTT_SERVER" -p "$MQTT_PORT" -u "$USER" -P "$PASSWORD" -t "$TOPIC" -q 1) -``` - -[MQTT-addon]: /addons/mosquitto/ -[custom-component]: /developers/component_loading/ -[addons-tutorial]: /developers/hassio/addon_tutorial/ -[communication]: /developers/hassio/addon_communication/ From 36b90f61f6c0dbe70aad5a5acd69befd065108ce Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Mon, 1 Jul 2019 16:29:56 +0200 Subject: [PATCH 058/116] Revert "Update lets_encrypt.markdown (#9695)" (#9751) This reverts commit 5198c2f7d44ddfd5cef335e9e5e71edb898ab6e7. --- source/_docs/ecosystem/certificates/lets_encrypt.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_docs/ecosystem/certificates/lets_encrypt.markdown b/source/_docs/ecosystem/certificates/lets_encrypt.markdown index af2717e7066..72506055769 100644 --- a/source/_docs/ecosystem/certificates/lets_encrypt.markdown +++ b/source/_docs/ecosystem/certificates/lets_encrypt.markdown @@ -23,7 +23,7 @@ This guide was added by mf_social on 16/03/2017 and was valid at the time of wri * You can access your Home Assistant instance across your local network, and access the device that it is on via SSH from your local network. * You know the internal IP address of your router and can access your router's configuration pages. * You have already set up a password for your Home Assistant instance, following the advice on this page: [http](/docs/configuration/basic/) - * You want to access your Home Assistant instance when you are away from home (ie, not connected to your local network) and secure it with a [TLS/SSL certificate](https://hosting.review/web-hosting-glossary/#12). + * You want to access your Home Assistant instance when you are away from home (ie, not connected to your local network) and secure it with a TLS/SSL certificate. * You have a basic understanding of the phrases I have used so far. * You are not currently running anything on port 80 on your network (you'd know if you were). * If you are not using Home Assistant on a Debian/Raspian/Hassbian system you will be able to convert any of the terminology I use in to the correct syntax for your system. From f40fecf0848bd5f620f82c057898a645adcd5e2e Mon Sep 17 00:00:00 2001 From: Maarten Lakerveld Date: Mon, 1 Jul 2019 19:27:06 +0200 Subject: [PATCH 059/116] Add deprecation warning to MQTT page for embedded broker (#9750) * Add deprecation warning to MQTT page for embedded broker * :pencil2: Tweak --- source/_components/mqtt.markdown | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/source/_components/mqtt.markdown b/source/_components/mqtt.markdown index 58be848946c..7897167ccf3 100644 --- a/source/_components/mqtt.markdown +++ b/source/_components/mqtt.markdown @@ -31,6 +31,10 @@ mqtt: You can also use the [embedded MQTT broker](/docs/mqtt/broker#embedded-broker). A separate broker is advised for more stability. +

+As of release 0.92, the embedded broker has been marked as deprecated. This means bugs may not be fixed, and the broker functionality will be removed in a future release. +

+ ```yaml # Example configuration.yaml entry mqtt: From 94157b55aee94f718ef2399c87b0d560a1b4cea1 Mon Sep 17 00:00:00 2001 From: Andrew Wong Date: Tue, 2 Jul 2019 04:14:49 +1000 Subject: [PATCH 060/116] Fix daemon script (#9741) * Fix start command execution (trailing semicolon causing an 'unrecognised argument' error) * Fixed process ID functionality --- source/_docs/autostart/init.d.markdown | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/source/_docs/autostart/init.d.markdown b/source/_docs/autostart/init.d.markdown index 9363ed07be6..18eb819bc45 100644 --- a/source/_docs/autostart/init.d.markdown +++ b/source/_docs/autostart/init.d.markdown @@ -84,8 +84,8 @@ If any commands need to run before executing hass (like loading a virtual enviro PRE_EXEC="" # Typically /usr/bin/hass HASS_BIN="hass" -RUN_AS="USER" -PID_DIR="/var/run" +RUN_AS="homeassistant" +PID_DIR="/var/run/hass" PID_FILE="$PID_DIR/hass.pid" CONFIG_DIR="/var/opt/homeassistant" LOG_DIR="/var/log/homeassistant" @@ -100,7 +100,7 @@ start() { return 1 fi echo -n 'Starting service… ' >&2 - local CMD="$PRE_EXEC $HASS_BIN $FLAGS;" + local CMD="$PRE_EXEC $HASS_BIN $FLAGS" su -s /bin/bash -c "$CMD" $RUN_AS if [ $? -ne 0 ]; then echo "Failed" >&2 @@ -161,7 +161,7 @@ remove_piddir() { if [ -e "$PID_FILE" ]; then rm -fv "$PID_FILE" fi - rmdir -fv "$PID_DIR" + rmdir -v "$PID_DIR" fi } @@ -220,7 +220,7 @@ start() { return 1 fi echo -n 'Starting service… ' >&2 - local CMD="$PRE_EXEC $HASS_BIN $FLAGS;" + local CMD="$PRE_EXEC $HASS_BIN $FLAGS" su -s /bin/bash -c "$CMD" $RUN_AS if [ $? -ne 0 ]; then echo "Failed" >&2 @@ -281,7 +281,7 @@ remove_piddir() { if [ -e "$PID_FILE" ]; then rm -fv "$PID_FILE" fi - rmdir -fv "$PID_DIR" + rmdir -v "$PID_DIR" fi } From e209c74b0a75a0dccb272dc062b2e241842f4c22 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Joakim=20S=C3=B8rensen?= Date: Mon, 1 Jul 2019 23:27:44 +0200 Subject: [PATCH 061/116] Disable autoplay for Twitch clip (#9754) --- source/_posts/2019-05-16-release-93.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_posts/2019-05-16-release-93.markdown b/source/_posts/2019-05-16-release-93.markdown index 685225332f2..d26a2e5f083 100644 --- a/source/_posts/2019-05-16-release-93.markdown +++ b/source/_posts/2019-05-16-release-93.markdown @@ -17,7 +17,7 @@ It's time for our 0.93 release and it is a whopping cool one. It's a day later t
From 0a8be2dc1fdd5a0522ccd636ab5efab335710196 Mon Sep 17 00:00:00 2001 From: leytpapas Date: Tue, 2 Jul 2019 18:55:38 +0300 Subject: [PATCH 062/116] Fixed Hassbian 404 URLs (#9755) * Fixed URLs .md were moved from 'hassbian-scripts/blob/master/docs' to 'hassbian-scripts/tree/dev/docs/suites' * Fixed Hassbian 404 URLs Also updated the list with more available scripts. Homebridge was not found in the hassbian-scripts repository so it was deleted --- .../hassbian/customization.markdown | 38 ++++++++++++------- 1 file changed, 25 insertions(+), 13 deletions(-) diff --git a/source/_docs/installation/hassbian/customization.markdown b/source/_docs/installation/hassbian/customization.markdown index cb52818895b..c14491b9502 100644 --- a/source/_docs/installation/hassbian/customization.markdown +++ b/source/_docs/installation/hassbian/customization.markdown @@ -16,26 +16,38 @@ The tool is available by running `hassbian-config`. ### Install scripts To view the available suites run `hassbian-config show` or have a look at the [hassbian-scripts repository][hassbian-repo]. These are some of the available suites: - - [AppDaemon](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/appdaemon.md) - - [Duck DNS](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/duckdns.md) _This can also be configured to generate Let's Encrypt SSL certificates_ - - [Homebridge](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/homebridge.md) - - [Mosquitto](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/mosquitto.md) - - [Samba](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/samba.md) - - [Webterminal](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/webterminal.md) + - [AppDaemon](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/appdaemon.md) + - [Cloud9](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/cloud9.md) + - [Custom Component Store](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/custom-component-store.md) + - [Fail2Ban](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/fail2ban.md) **This suite can't be installed on Raspberry Pi Zero** + - [Duck DNS](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/duckdns.md) _This can also be configured to generate Let's Encrypt SSL certificates_ + - [Hue](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/hue.md) + - [Hassbian Manager](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/manager.md) is a web UI tool that can help you manage your suites. + - [Mosquitto](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/mosquitto.md) + - [Pi-hole](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/pihole.md) + - [Razberry](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/razberry.md) + - [Samba](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/samba.md) + - [Trådfri](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/tradfri.md) + - [Webterminal](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/webterminal.md) + - [Zigbee2mqtt](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/zigbee2mqtt.md) - Various database engines. - - [MariaDB](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/mariadb.md) - - [PostgreSQL](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/postgresql.md) - - [MS SQL](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/mssql.md) + - [MariaDB](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/mariadb.md) + - [PostgreSQL](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/postgresql.md) + - [MS SQL](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/mssql.md) To install any of them simply run `sudo hassbian-config install SUITE`. ### Upgrade scripts To view the available suites run `hassbian-config show` or have a look at the [hassbian-scripts repository][hassbian-repo]. These are some of the available suites: -- [AppDaemon](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/appdaemon.md) -- [Hassbian](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/hassbian.md) -- [Home Assistant](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/homeassistant.md) -- [hassbian-config (hassbian-scripts)](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/hassbian_config.md) +- [AppDaemon](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/appdaemon.md) +- [Cloud9](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/cloud9.md) +- [Custom Component Store](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/custom-component-store.md) +- [Hassbian](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/hassbian.md) +- [Hassbian Manager](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/manager.md) +- [Home Assistant](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/homeassistant.md) +- [hassbian-config (hassbian-scripts)](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/hassbian_config.md) +- [Python](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/python.md) To upgrade any of them simply run `sudo hassbian-config upgrade SUITE`. From 7e9f3dff56af4ea185907eaa971b5ff3802d0c92 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Tue, 2 Jul 2019 19:48:16 +0200 Subject: [PATCH 063/116] :pencil2: Fix urls and markdown rules (#9758) --- .../hassbian/common-tasks.markdown | 7 ++- .../hassbian/customization.markdown | 54 ++++++++++--------- .../hassbian/integrations.markdown | 18 +++---- .../installation/hassbian/upgrading.markdown | 1 + 4 files changed, 45 insertions(+), 35 deletions(-) diff --git a/source/_docs/installation/hassbian/common-tasks.markdown b/source/_docs/installation/hassbian/common-tasks.markdown index 3a0894c6c37..765552e5322 100644 --- a/source/_docs/installation/hassbian/common-tasks.markdown +++ b/source/_docs/installation/hassbian/common-tasks.markdown @@ -11,6 +11,7 @@ redirect_from: /docs/hassbian/common-tasks/ --- ### {% linkable_title Login to the Raspberry Pi %} + To login to your Raspberry Pi running Hassbian you're going to be using a ssh client. Depending on your platform there are several alternatives for doing this. Linux and Mac OS generally have a ssh client installed. Windows users are recommended to download and install the ssh client [Putty][ssh-putty]. Connect to the Raspberry Pi over ssh. Default user name is `pi` and password is `raspberry`. @@ -25,6 +26,7 @@ Windows users start [Putty][ssh-putty], enter the IP address of the Raspberry Pi Optionally, starting with Windows 10 anniversary update, you can use the built-in '[Bash on Windows][bash-windows]' to use SSH if you have enabled Developer mode and have installed the "Windows Subsystem for Linux (beta)" feature. ### {% linkable_title Start/Stop/Restart Home Assistant %} + Log in as the `pi` account and execute the following commands: ```bash @@ -61,6 +63,7 @@ This will in order do the following: - Start the Home Assistant service. ### {% linkable_title Manually launch Home Assistant %} + Log in as the `pi` account and execute the following commands: ```bash @@ -72,6 +75,7 @@ $ hass This will start Home Assistant in your shell and output anything that ends up in the log and more into the console. This will fail if the Home Assistant service is already running so don't forget to [stop][stop-homeassistant] it first. If you want the log output to be colored, execute `hass --script check_config` first. This will install the `colorlog` module. ### {% linkable_title Check your configuration %} + Log in as the `pi` account and execute the following commands: ```bash @@ -83,6 +87,7 @@ $ hass --script check_config This will output any errors in your configuration files to console. ### {% linkable_title Read the Home Assistant log file %} + Log in as the `pi` account and execute the following commands: ```bash @@ -130,5 +135,5 @@ $ sudo raspi-config [configuring-homeassistant]: /getting-started/configuration/ [ssh-putty]: http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html -[stop-homeassistant]: /getting-started/installation-raspberry-pi-image/#startstoprestart-home-assistant-on-hassbian +[stop-homeassistant]: /docs/installation/hassbian/common-tasks/#startstoprestart-home-assistant [bash-windows]: https://msdn.microsoft.com/en-us/commandline/wsl/about diff --git a/source/_docs/installation/hassbian/customization.markdown b/source/_docs/installation/hassbian/customization.markdown index c14491b9502..b20b925fd12 100644 --- a/source/_docs/installation/hassbian/customization.markdown +++ b/source/_docs/installation/hassbian/customization.markdown @@ -13,33 +13,37 @@ redirect_from: /docs/hassbian/customization/ To allow you to customize your installation further, we have included a tool called `hassbian-config`. This tool comes with a set of suites that can easily be installed or upgraded for easier customization of your Home Assistant installation. The tool is available by running `hassbian-config`. -### Install scripts -To view the available suites run `hassbian-config show` or have a look at the [hassbian-scripts repository][hassbian-repo]. -These are some of the available suites: - - [AppDaemon](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/appdaemon.md) - - [Cloud9](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/cloud9.md) - - [Custom Component Store](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/custom-component-store.md) - - [Fail2Ban](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/fail2ban.md) **This suite can't be installed on Raspberry Pi Zero** - - [Duck DNS](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/duckdns.md) _This can also be configured to generate Let's Encrypt SSL certificates_ - - [Hue](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/hue.md) - - [Hassbian Manager](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/manager.md) is a web UI tool that can help you manage your suites. - - [Mosquitto](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/mosquitto.md) - - [Pi-hole](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/pihole.md) - - [Razberry](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/razberry.md) - - [Samba](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/samba.md) - - [Trådfri](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/tradfri.md) - - [Webterminal](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/webterminal.md) - - [Zigbee2mqtt](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/zigbee2mqtt.md) - - Various database engines. - - [MariaDB](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/mariadb.md) - - [PostgreSQL](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/postgresql.md) - - [MS SQL](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/mssql.md) +### {% linkable_title Install scripts %} - To install any of them simply run `sudo hassbian-config install SUITE`. +To view the available suites run `hassbian-config show` or have a look at the [hassbian-scripts repository][hassbian-repo]. +These are some of the available suites: + +- [AppDaemon](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/appdaemon.md) +- [Cloud9](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/cloud9.md) +- [Custom Component Store](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/custom-component-store.md) +- [Fail2Ban](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/fail2ban.md) **This suite can't be installed on Raspberry Pi Zero** +- [Duck DNS](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/duckdns.md) _This can also be configured to generate Let's Encrypt SSL certificates_ +- [Hue](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/hue.md) +- [Hassbian Manager](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/manager.md) is a web UI tool that can help you manage your suites. +- [Mosquitto](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/mosquitto.md) +- [Pi-hole](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/pihole.md) +- [Razberry](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/razberry.md) +- [Samba](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/samba.md) +- [Trådfri](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/tradfri.md) +- [Webterminal](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/webterminal.md) +- [Zigbee2mqtt](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/zigbee2mqtt.md) +- Various database engines. + - [MariaDB](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/mariadb.md) + - [PostgreSQL](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/postgresql.md) + - [MS SQL](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/mssql.md) + +To install any of them simply run `sudo hassbian-config install SUITE`. + +### {% linkable_title Upgrade scripts %} + +To view the available suites run `hassbian-config show` or have a look at the [hassbian-scripts repository][hassbian-repo]. +These are some of the available suites: -### Upgrade scripts -To view the available suites run `hassbian-config show` or have a look at the [hassbian-scripts repository][hassbian-repo]. -These are some of the available suites: - [AppDaemon](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/appdaemon.md) - [Cloud9](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/cloud9.md) - [Custom Component Store](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/suites/custom-component-store.md) diff --git a/source/_docs/installation/hassbian/integrations.markdown b/source/_docs/installation/hassbian/integrations.markdown index 9e16275662d..aea7b972b5f 100644 --- a/source/_docs/installation/hassbian/integrations.markdown +++ b/source/_docs/installation/hassbian/integrations.markdown @@ -10,13 +10,13 @@ footer: true redirect_from: /docs/hassbian/integrations/ --- -Some integrations that are specific for the Raspberry Pi can require some further configuration outside of Home Assistant. All commands below are assumed to be executed with the `pi` account. For full documentation of these integrations refer to the [components](/components) page. +Some integrations that are specific for the Raspberry Pi can require some further configuration outside of Home Assistant. All commands below are assumed to be executed with the `pi` account. For full documentation of these integrations refer to the [integrations](/components) page. ### {% linkable_title Bluetooth Tracker %} The Bluetooth tracker will work on a Raspberry Pi 3 with the built-in Bluetooth module or with a USB Bluetooth device on any of the other Raspberry Pi's. -Software needed for the tracker is pre-installed so just follow the [Bluetooth Tracker component](/components/device_tracker.bluetooth_tracker/) and [Device Tracker page](/components/device_tracker/) pages. +Software needed for the tracker is pre-installed so just follow the [Bluetooth Tracker integration](/components/bluetooth_tracker/) and [Device Tracker page](/components/device_tracker/) pages. ### {% linkable_title Raspberry Pi GPIO %} @@ -26,11 +26,11 @@ For more details about the GPIO layout, visit the [documentation](https://www.ra Permission have been given to the `homeassistant` user to use the GPIO pins and all of the following integrations should require no underlying changes to work. Just follow the integration pages for each on how to add them to your Home Assistant installation. - - [DHT Sensor](/components/sensor.dht/) - - [Raspberry Pi Cover](/components/cover.rpi_gpio/) - - [Raspberry Pi GPIO Binary Sensor](/components/binary_sensor.rpi_gpio/) - - [Raspberry Pi GPIO Switch](/components/switch.rpi_gpio/) - - [Raspberry Pi RF Switch](/components/switch.rpi_rf/) + - [DHT Sensor](/components/dht/) + - [Raspberry Pi Cover](/components/rpi_gpio/#cover) + - [Raspberry Pi GPIO Binary Sensor](/components/rpi_gpio/#binary-sensor) + - [Raspberry Pi GPIO Switch](/components/rpi_gpio/#switch) + - [Raspberry Pi RF Switch](/components/rpi_rf/) ### {% linkable_title Raspberry Pi Camera %} @@ -44,7 +44,7 @@ $ sudo raspi-config Go to `Interfacing Options`, select `Enable camera` choose `` and hit `Enter`, then go to `Finish` and you'll be prompted to reboot. -After this follow the [Raspberry Pi Camera component](/components/camera.rpi_camera/) page. +After this follow the [Raspberry Pi Camera integration](/components/rpi_camera/) page. ### {% linkable_title One wire Sensor %} @@ -53,4 +53,4 @@ To enable One Wire support add the following line to the end of `/boot/config.tx ```yaml dtoverlay=w1-gpio ``` -After this follow the [One Wire Sensor component](/components/sensor.onewire/) page. +After this follow the [One Wire Sensor integration](/components/onewire/) page. diff --git a/source/_docs/installation/hassbian/upgrading.markdown b/source/_docs/installation/hassbian/upgrading.markdown index 1a6b37d4968..16c0c46c51a 100644 --- a/source/_docs/installation/hassbian/upgrading.markdown +++ b/source/_docs/installation/hassbian/upgrading.markdown @@ -19,6 +19,7 @@ $ sudo apt-get -y upgrade ``` #### {% linkable_title Updating Home Assistant %} +

You can use `hassbian-config` to automate the process by running `sudo hassbian-config upgrade homeassistant`

From 9ae34605afc2103afd514130dcb4cfc9aaf4c060 Mon Sep 17 00:00:00 2001 From: CV Date: Wed, 3 Jul 2019 13:01:38 +0200 Subject: [PATCH 064/116] Added warning_types (#9766) Added more warning types which were missing. --- source/_components/dwd_weather_warnings.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/dwd_weather_warnings.markdown b/source/_components/dwd_weather_warnings.markdown index 838ed29b4c2..d9a77bc1ecb 100644 --- a/source/_components/dwd_weather_warnings.markdown +++ b/source/_components/dwd_weather_warnings.markdown @@ -64,7 +64,7 @@ name: | `region_id` | Region ID assigned by DWD. | | `warning_count` | *(int)* Number of issued warnings. There can be more than one warning issued at once. | | `warning__level` | *(int)* Issued warning level between 0 and 4.
0: Keine Warnungen
1: Wetterwarnungen
2: Warnungen vor markantem Wetter
3: Unwetterwarnungen
4: Warnungen vor extremem Unwetter | -| `warning__type` | *(int)* Issued warning type.
0: Gewitter, Starkes Gewitter
1: Windböen, Sturmböen
2: ?
3: Schneefall
4: Nebel
5: Frost
6: Glätte, Glatteis
Please be aware that the type numbers represent more like a category than an exact number-to-string match. For example Type `6` can mean `GLÄTTE` or `GLATTEIS` or similar. | +| `warning__type` | *(int)* Issued warning type.
0: Gewitter, Starkes Gewitter
1: Windböen, Sturmböen
2: ?
3: Schneefall
4: Nebel
5: Frost
6: Glätte, Glatteis
8: Hitze (always level 10)
9: UV-Index (always level 20)
Please be aware that the type numbers represent more like a category than an exact number-to-string match. For example Type `6` can mean `GLÄTTE` or `GLATTEIS` or similar. | | `warning__name` | This name correlates with the warning type and indicates it in short as a string. | | `warning__headline` | Official headline the weather warning. | | `warning__start` | Starting time and date of the issued warning. | From b1ef4996eb83735a9bf444494ecd0f6a4c839ff2 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Wed, 3 Jul 2019 13:48:38 +0200 Subject: [PATCH 065/116] =?UTF-8?q?=E2=9C=8F=EF=B8=8F=20The=20great=20inte?= =?UTF-8?q?gration=20migration=20-=20part=202=20(#9760)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * :pencil2: The great integration migration - part 2 * :pencil2: Tweak --- source/_addons/snips.markdown | 4 ++-- source/_components/air_quality.markdown | 3 ++- source/_components/alarm_control_panel.ifttt.markdown | 2 +- source/_components/alarmdecoder.markdown | 2 +- source/_components/alert.markdown | 4 ++-- source/_components/alexa.intent.markdown | 2 +- source/_components/alexa.markdown | 2 +- source/_components/alexa.smart_home.markdown | 2 +- source/_components/api.markdown | 2 +- source/_components/asterisk_cdr.markdown | 2 +- source/_components/binary_sensor.knx.markdown | 2 +- source/_components/binary_sensor.markdown | 2 +- source/_components/binary_sensor.xiaomi_aqara.markdown | 2 +- source/_components/blink.markdown | 2 +- source/_components/bme680.markdown | 2 +- source/_components/camera.ffmpeg.markdown | 2 +- source/_components/canary.markdown | 8 ++++---- source/_components/cast.markdown | 6 +++--- source/_components/climate.knx.markdown | 2 +- source/_components/configurator.markdown | 4 ++-- source/_components/conversation.markdown | 2 +- source/_components/cover.knx.markdown | 2 +- source/_components/daikin.markdown | 2 +- source/_components/deconz.markdown | 4 ++-- source/_components/device_sun_light_trigger.markdown | 2 +- source/_components/dialogflow.markdown | 5 +++-- source/_components/directv.markdown | 2 +- source/_components/dlib_face_detect.markdown | 2 +- source/_components/dlib_face_identify.markdown | 2 +- .../_cookbook/automation_telegram_presence_alert.markdown | 2 +- source/_cookbook/dim_lights_when_playing_media.markdown | 2 +- source/_cookbook/python_component_mqtt_basic.markdown | 4 ++-- source/_cookbook/python_component_simple_alarm.markdown | 2 +- source/_docs/authentication.markdown | 3 ++- source/_docs/security.markdown | 2 +- source/_docs/z-wave.markdown | 4 ++-- source/_lovelace/alarm-panel.markdown | 4 ++-- source/cloud/alexa.markdown | 3 ++- source/hassio/installation.markdown | 2 +- source/help/reporting_issues.markdown | 6 +++--- source/help/trivia.markdown | 2 +- source/lovelace/index.markdown | 3 ++- 42 files changed, 62 insertions(+), 57 deletions(-) diff --git a/source/_addons/snips.markdown b/source/_addons/snips.markdown index 90ae974b03c..919e842cdbd 100644 --- a/source/_addons/snips.markdown +++ b/source/_addons/snips.markdown @@ -68,7 +68,7 @@ tts_platform: ### {% linkable_title Home Assistant configuration %} -A simple configuration just requires this. Consult [Snips.ai component](/components/snips/) for more options. +A simple configuration just requires this. Consult [Snips.ai integration](/components/snips/) for more options. ```yaml snips: @@ -98,7 +98,7 @@ Next create a weather sensor, e.g., one for (Dark Sky)[/components/sensor.darksk - temperature_min ``` -Next add this to your `configuration.yaml` file to reference a new `intent_script` component. This is a good practice to [split your configuration files](/docs/configuration/splitting_configuration/) up. +Next add this to your `configuration.yaml` file to reference a new `intent_script` integration. This is a good practice to [split your configuration files](/docs/configuration/splitting_configuration/) up. ```yaml intent_script: !include intent_script.yaml diff --git a/source/_components/air_quality.markdown b/source/_components/air_quality.markdown index 26318e9d27b..3ff556c6f07 100644 --- a/source/_components/air_quality.markdown +++ b/source/_components/air_quality.markdown @@ -7,7 +7,8 @@ sidebar: true comments: false sharing: true footer: true -redirect_from: /components/air_pollutants/ +redirect_from: + - /components/air_pollutants/ ha_release: 0.85 --- diff --git a/source/_components/alarm_control_panel.ifttt.markdown b/source/_components/alarm_control_panel.ifttt.markdown index 1cb7ebd51d6..3e7d4ebf81f 100644 --- a/source/_components/alarm_control_panel.ifttt.markdown +++ b/source/_components/alarm_control_panel.ifttt.markdown @@ -15,7 +15,7 @@ ha_release: 0.66 The `ifttt` platform allows you to integrate security systems that have no open API but can be controlled through [IFTTT](https://ifttt.com/discover). -This platform depends on the [IFTTT](/components/ifttt/) Home Assistant component. See the component's documentation to set it up. +This platform depends on the [IFTTT](/components/ifttt/) Home Assistant integration. See the integrations documentation to set it up.

It is important to note that this platform fully relies on IFTTT to receive updates when the security system's state changes. Therefore, this platform shows an assumed state. diff --git a/source/_components/alarmdecoder.markdown b/source/_components/alarmdecoder.markdown index 0bde582eaa7..d9ed822f076 100644 --- a/source/_components/alarmdecoder.markdown +++ b/source/_components/alarmdecoder.markdown @@ -91,7 +91,7 @@ panel_display: default: false type: boolean zones: - description: "AlarmDecoder has 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 [Binary Sensor](/components/binary_sensor.alarmdecoder/) docs. *Note: If no zones are specified, Home Assistant will not load any binary_sensor components.*" + description: "AlarmDecoder has 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 [Binary Sensor](/components/binary_sensor.alarmdecoder/) docs. *Note: If no zones are specified, Home Assistant will not load any binary_sensor integrations.*" required: false type: list keys: diff --git a/source/_components/alert.markdown b/source/_components/alert.markdown index a881dfaa487..6b7eb22d442 100644 --- a/source/_components/alert.markdown +++ b/source/_components/alert.markdown @@ -25,8 +25,8 @@ This entity allows you to silence an alert until it is resolved. ### {% linkable_title Basic Example %} -The `alert` integration makes use of any of the `notifications` components. To -setup the `alert` component, first, you must setup a `notification` component. +The `alert` integration makes use of any of the `notifications` integrations. To +setup the `alert` integration, first, you must setup a `notification` integration. Then, add the following to your configuration file: ```yaml diff --git a/source/_components/alexa.intent.markdown b/source/_components/alexa.intent.markdown index 7c2c9552c4e..925d33f8f53 100644 --- a/source/_components/alexa.intent.markdown +++ b/source/_components/alexa.intent.markdown @@ -90,7 +90,7 @@ This means that we can now ask Alexa things like: ## {% linkable_title Configuring Home Assistant %} -When activated, the Alexa integration will have Home Assistant's native intent support handle the incoming intents. If you want to run actions based on intents, use the [`intent_script`](/components/intent_script) component. +When activated, the Alexa integration will have Home Assistant's native intent support handle the incoming intents. If you want to run actions based on intents, use the [`intent_script`](/components/intent_script) integration. To enable Alexa, add the following entry to your `configuration.yaml` file: diff --git a/source/_components/alexa.markdown b/source/_components/alexa.markdown index f9bf1a3ba92..7a7df1f7a9c 100644 --- a/source/_components/alexa.markdown +++ b/source/_components/alexa.markdown @@ -27,7 +27,7 @@ There are a few ways that you can use Amazon Alexa and Home Assistant together. - [Build custom commands to use](/components/alexa.intent/) - [Create a new Flash Briefing source](/components/alexa.flash_briefings/) - [Use the Smart Home API to control lights, etc](/components/alexa.smart_home/) -- Alternative: use the [Emulated Hue component][emulated-hue-component] to trick Alexa to thinking Home Assistant is a Philips Hue hub. +- Alternative: use the [Emulated Hue integration][emulated-hue-component] to trick Alexa to thinking Home Assistant is a Philips Hue hub. ### {% linkable_title Requirements %} diff --git a/source/_components/alexa.smart_home.markdown b/source/_components/alexa.smart_home.markdown index 6aa184a6010..d5f3e819b07 100644 --- a/source/_components/alexa.smart_home.markdown +++ b/source/_components/alexa.smart_home.markdown @@ -19,7 +19,7 @@ ha_release: "0.54" While the Skills API described above allows for arbitrary intents, all utterances must begin with "Alexa, tell $invocation_name ..." -The [Emulated Hue component][emulated-hue-component] provides a simpler +The [Emulated Hue integration][emulated-hue-component] provides a simpler interface such as, "Alexa, turn on the kitchen light". However, it has some limitations since everything looks like a light bulb. diff --git a/source/_components/api.markdown b/source/_components/api.markdown index 8f6415bbe0b..151530947b7 100644 --- a/source/_components/api.markdown +++ b/source/_components/api.markdown @@ -14,7 +14,7 @@ ha_qa_scale: internal ha_release: 0.7 --- -The `api` integration exposes a RESTful API and allows one to interact with a Home Assistant instance that is running headless. This integration depends on the [`http` component](/components/http/). +The `api` integration exposes a RESTful API and allows one to interact with a Home Assistant instance that is running headless. This integration depends on the [`http` integration](/components/http/).

It is HIGHLY recommended that you set the `api_password`, especially if you are planning to expose your installation to the internet. diff --git a/source/_components/asterisk_cdr.markdown b/source/_components/asterisk_cdr.markdown index 59c27d946dd..4cc68d5d505 100644 --- a/source/_components/asterisk_cdr.markdown +++ b/source/_components/asterisk_cdr.markdown @@ -15,4 +15,4 @@ redirect_from: - /components/mailbox.asterisk_cdr/ --- -The Asterisk Call Data Recorder provides access to Asterisk call logs on the Asterisk PBX server. This mailbox is enabled automatically through the [Asterisk Voicemail component](/components/asterisk_mbox/) configuration if the `asterisk_mbox_server` is configured to provide CDR data. More information on configuring the server can be found in the [Asterisk PBX configuration guide](/docs/asterisk_mbox/). +The Asterisk Call Data Recorder provides access to Asterisk call logs on the Asterisk PBX server. This mailbox is enabled automatically through the [Asterisk Voicemail integration](/components/asterisk_mbox/) configuration if the `asterisk_mbox_server` is configured to provide CDR data. More information on configuring the server can be found in the [Asterisk PBX configuration guide](/docs/asterisk_mbox/). diff --git a/source/_components/binary_sensor.knx.markdown b/source/_components/binary_sensor.knx.markdown index 6e5f40cde95..b89ee64f261 100644 --- a/source/_components/binary_sensor.knx.markdown +++ b/source/_components/binary_sensor.knx.markdown @@ -18,7 +18,7 @@ The `knx` sensor platform allows you to monitor [KNX](http://www.knx.org) binary ## {% linkable_title Configuration %} -The `knx` integration must be configured correctly, see [KNX Component](/components/knx). +The `knx` integration must be configured correctly, see [KNX Integration](/components/knx). ```yaml # Example configuration.yaml entry diff --git a/source/_components/binary_sensor.markdown b/source/_components/binary_sensor.markdown index 2d83527eed8..7b93b7dc757 100644 --- a/source/_components/binary_sensor.markdown +++ b/source/_components/binary_sensor.markdown @@ -45,7 +45,7 @@ The way these sensors are displayed in the frontend can be modified in the [cust - **vibration**: `On` means vibration detected, `Off` means no vibration (clear) - **window**: `On` means open, `Off` means closed -For analog sensors please check the [component overview](/components/#sensor). +For analog sensors please check the [integration overview](/components/#sensor).

diff --git a/source/_components/binary_sensor.xiaomi_aqara.markdown b/source/_components/binary_sensor.xiaomi_aqara.markdown index e6a955d4004..4aae23f5a9c 100644 --- a/source/_components/binary_sensor.xiaomi_aqara.markdown +++ b/source/_components/binary_sensor.xiaomi_aqara.markdown @@ -16,7 +16,7 @@ ha_iot_class: Local Push The `xiaomi aqara` binary sensor platform allows you to get data from your [Xiaomi](http://www.mi.com/en/) binary sensors. -The requirement is that you have setup the [`xiaomi aqara` component](/components/xiaomi_aqara/). +The requirement is that you have setup the [`xiaomi aqara` integration](/components/xiaomi_aqara/). ### {% linkable_title Type of sensors supported %} diff --git a/source/_components/blink.markdown b/source/_components/blink.markdown index 72f1dc651ab..aa87420e647 100644 --- a/source/_components/blink.markdown +++ b/source/_components/blink.markdown @@ -160,7 +160,7 @@ The following are some examples showing how to correctly make service calls usin ### {% linkable_title Snap Picture and Save Locally %} -This example script shows how to take a picture with your camera, named `My Camera` in your Blink app (this is **not necessarily** the friendly name in home-assistant). After snapping a picture, the image will then be saved to a local directory called `/tmp/my_image.jpg`. Note that this example makes use of services found in the [camera component](https://www.home-assistant.io/components/camera#service-snapshot) +This example script shows how to take a picture with your camera, named `My Camera` in your Blink app (this is **not necessarily** the friendly name in home-assistant). After snapping a picture, the image will then be saved to a local directory called `/tmp/my_image.jpg`. Note that this example makes use of services found in the [camera integration](https://www.home-assistant.io/components/camera#service-snapshot) ```yaml alias: Blink Snap Picture diff --git a/source/_components/bme680.markdown b/source/_components/bme680.markdown index ada45594307..a2cd6ce52a1 100644 --- a/source/_components/bme680.markdown +++ b/source/_components/bme680.markdown @@ -114,7 +114,7 @@ aq_humidity_bias: default: 25 type: integer temp_offset: - description: "The temperature for the sensor will always be too high as it pulls heat from the components around it. Consider adding a negative offset to ensure the sensor returns an accurate temperature. Note: This value is in celsius." + description: "The temperature for the sensor will always be too high as it pulls heat from the components around it. Consider adding a negative offset to ensure the sensor returns an accurate temperature. Note: This value is in celsius." required: false default: 0 type: float diff --git a/source/_components/camera.ffmpeg.markdown b/source/_components/camera.ffmpeg.markdown index f47dcef0de6..57e93d7d9f3 100644 --- a/source/_components/camera.ffmpeg.markdown +++ b/source/_components/camera.ffmpeg.markdown @@ -18,7 +18,7 @@ The `ffmpeg` platform allows you to use any video feed as a camera in Home Assis ## {% linkable_title Configuration %} -To enable your FFmpeg feed in your installation you must first configure the [ffmpeg component](/components/ffmpeg/), then add the following to your `configuration.yaml` file: +To enable your FFmpeg feed in your installation you must first configure the [ffmpeg integration](/components/ffmpeg/), then add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/canary.markdown b/source/_components/canary.markdown index 2ead4902559..c115703c1e5 100644 --- a/source/_components/canary.markdown +++ b/source/_components/canary.markdown @@ -57,7 +57,7 @@ timeout: default: 10 {% endconfiguration %} -Once loaded, your front end will have the following components: +Once loaded, your front end will have the following integrations: - A camera image triggered by motion for each camera. - An alarm control panel for each location. @@ -67,9 +67,9 @@ Once loaded, your front end will have the following components: ## {% linkable_title Camera %} -The `canary` camera platform allows you to watch the live stream of your [Canary](https://canary.is) camera in Home Assistant. This requires the [`ffmpeg` component](/components/ffmpeg/) to be already configured. +The `canary` camera platform allows you to watch the live stream of your [Canary](https://canary.is) camera in Home Assistant. This requires the [`ffmpeg` integration](/components/ffmpeg/) to be already configured. -Once you have [Canary component](/components/canary/) setup, your [Canary](https://canary.is) camera(s) should show up automatically. +Once you have [Canary integration](/components/canary/) setup, your [Canary](https://canary.is) camera(s) should show up automatically. ## {% linkable_title Configuration %} @@ -82,7 +82,7 @@ camera: {% configuration %} ffmpeg_arguments: - description: Extra options to pass to `ffmpeg`, e.g., image quality or video filter options. More details in [FFmpeg component](/components/ffmpeg). + description: Extra options to pass to `ffmpeg`, e.g., image quality or video filter options. More details in [FFmpeg integration](/components/ffmpeg). required: false type: string {% endconfiguration %} diff --git a/source/_components/cast.markdown b/source/_components/cast.markdown index 8fac5fb601c..09529e9567b 100644 --- a/source/_components/cast.markdown +++ b/source/_components/cast.markdown @@ -17,15 +17,15 @@ redirect_from: /components/media_player.cast/ --- Google Cast devices like Android TVs and Chromecasts will be automatically -discovered if you enable [the discovery component](/components/discovery/). If +discovered if you enable [the discovery integration(/components/discovery/). If you don't have the discovery integration enabled, you can enable the Cast -component by going to the Integrations page inside the config panel. +integration by going to the Integrations page inside the config panel. ## {% linkable_title Advanced use %} The Cast integration has some extra configuration options available for advanced users. You will still need to create a config entry to initialize the Cast -component. +integration. For example, Cast devices can only be discovered if they are on the same subnet as Home Assistant. If this is not the case, diff --git a/source/_components/climate.knx.markdown b/source/_components/climate.knx.markdown index f7f7ba2063d..b37c5ab075c 100644 --- a/source/_components/climate.knx.markdown +++ b/source/_components/climate.knx.markdown @@ -16,7 +16,7 @@ ha_iot_class: Local Polling The `knx` climate platform is used as in interface with KNX thermostats. -The `knx` integration must be configured correctly, see [KNX Component](/components/knx). +The `knx` integration must be configured correctly, see [KNX Integration](/components/knx). To use your KNX thermostats in your installation, add the following lines to your `configuration.yaml` file: diff --git a/source/_components/configurator.markdown b/source/_components/configurator.markdown index cba5fe0f76f..296c74560e6 100644 --- a/source/_components/configurator.markdown +++ b/source/_components/configurator.markdown @@ -24,6 +24,6 @@ The configurator integration allows integrations to request information from the - Input fields can be defined with a description, and optional type - It will trigger a callback when the button is pressed -The Hue integration in [the demo](/demo) and Plex are implemented using the configurator. See [the source of the demo component](https://github.com/home-assistant/home-assistant/tree/dev/homeassistant/components/demo) for a simple example. +The Hue integration in [the demo](/demo) and Plex are implemented using the configurator. See [the source of the demo integration](https://github.com/home-assistant/home-assistant/tree/dev/homeassistant/components/demo) for a simple example. -See [the source](https://github.com/home-assistant/home-assistant/tree/dev/homeassistant/components/configurator) for more details on how to use the configurator component. +See [the source](https://github.com/home-assistant/home-assistant/tree/dev/homeassistant/components/configurator) for more details on how to use the configurator integration. diff --git a/source/_components/conversation.markdown b/source/_components/conversation.markdown index 48817f6d338..4aae2f49683 100644 --- a/source/_components/conversation.markdown +++ b/source/_components/conversation.markdown @@ -40,7 +40,7 @@ intents: ## {% linkable_title Adding custom sentences %} -By default, it will support turning devices on and off. You can say things like "turn on kitchen lights" or "turn the living room lights off". You can also configure your own sentences to be processed. This works by mapping sentences to intents and then configure the [intent script component](/components/intent_script/) to handle these intents. +By default, it will support turning devices on and off. You can say things like "turn on kitchen lights" or "turn the living room lights off". You can also configure your own sentences to be processed. This works by mapping sentences to intents and then configure the [intent script integration](/components/intent_script/) to handle these intents. Here is a simple example to be able to ask what the temperature in the living room is. diff --git a/source/_components/cover.knx.markdown b/source/_components/cover.knx.markdown index 0c93ae37070..606845df77c 100644 --- a/source/_components/cover.knx.markdown +++ b/source/_components/cover.knx.markdown @@ -17,7 +17,7 @@ ha_iot_class: Local Polling The `knx` cover platform is used as in interface with KNX covers. -The `knx` integration must be configured correctly, see [KNX Component](/components/knx). +The `knx` integration must be configured correctly, see [KNX Integration](/components/knx). To use your KNX covers in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/daikin.markdown b/source/_components/daikin.markdown index 4da14c4ff84..110c245418f 100644 --- a/source/_components/daikin.markdown +++ b/source/_components/daikin.markdown @@ -38,7 +38,7 @@ There is currently support for the following device types within Home Assistant: The Daikin integration can be configured in three ways. -- Automatically via the [discovery]({{site_root}}/components/discovery/) component. +- Automatically via the [discovery]({{site_root}}/components/discovery/) integration. - Via the Home Assistant user interface where it will let you enter the IP-address of your Daikin AC. - Or via the `configuration.yaml` file by adding the following: diff --git a/source/_components/deconz.markdown b/source/_components/deconz.markdown index e03c60279e6..faa9093bc22 100644 --- a/source/_components/deconz.markdown +++ b/source/_components/deconz.markdown @@ -329,7 +329,7 @@ The `entity_id` name will be `binary_sensor.device_name`, where `device_name` is ## {% linkable_title Climate %} -See the [deCONZ main component](/components/deconz/) for configuration instructions. +See the [deCONZ main integration](/components/deconz/) for configuration instructions. Climate currently represent thermostats. @@ -386,7 +386,7 @@ The following sensor types are supported: - Switches - Temperature sensor -The `entity_id` name will be `sensor.device_name`, where `device_name` is defined in deCONZ. Switches aren't exposed as ordinary entities, see the [deCONZ main component](/components/deconz/) for more details. +The `entity_id` name will be `sensor.device_name`, where `device_name` is defined in deCONZ. Switches aren't exposed as ordinary entities, see the [deCONZ main integration](/components/deconz/) for more details. ### {% linkable_title Verified to be supported sensors %} diff --git a/source/_components/device_sun_light_trigger.markdown b/source/_components/device_sun_light_trigger.markdown index d2e4a7724a7..9c4c011aab1 100644 --- a/source/_components/device_sun_light_trigger.markdown +++ b/source/_components/device_sun_light_trigger.markdown @@ -22,7 +22,7 @@ Home Assistant has a built-in integration called `device_sun_light_trigger` to h This integration requires the integrations [sun](/components/sun/), [device_tracker](/components/device_tracker/) and [light](/components/light/) to be enabled. -To enable this component, add the following lines to your `configuration.yaml` file: +To enable this integration, add the following lines to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/dialogflow.markdown b/source/_components/dialogflow.markdown index 658f2002e9c..1126bd5d99f 100644 --- a/source/_components/dialogflow.markdown +++ b/source/_components/dialogflow.markdown @@ -11,7 +11,8 @@ logo: dialogflow.png ha_category: - Voice ha_release: 0.56 -redirect_from: /components/apiai/ +redirect_from: + - /components/apiai/ --- The `dialogflow` integration is designed to be used with the [webhook](https://dialogflow.com/docs/fulfillment#webhook) integration of [Dialogflow](https://dialogflow.com/). When a conversation ends with a user, Dialogflow sends an action and parameters to the webhook. @@ -62,7 +63,7 @@ Take a look to "Integrations", in the left menu, to configure third parties. ### {% linkable_title Configuring Home Assistant %} -When activated, the [`alexa` component](/components/alexa/) will have Home Assistant's native intent support handle the incoming intents. If you want to run actions based on intents, use the [`intent_script`](/components/intent_script) component. +When activated, the [`alexa` integration](/components/alexa/) will have Home Assistant's native intent support handle the incoming intents. If you want to run actions based on intents, use the [`intent_script`](/components/intent_script) integration. ## {% linkable_title Examples %} diff --git a/source/_components/directv.markdown b/source/_components/directv.markdown index 97d6cc9b61c..a13e1adadc7 100644 --- a/source/_components/directv.markdown +++ b/source/_components/directv.markdown @@ -16,7 +16,7 @@ redirect_from: - /components/media_player.directv/ --- -Master [DirecTV](http://www.directv.com/) receivers (ie: those that have tuners) will be automatically discovered if you enable the [discovery component](/components/discovery/) and the receiver is powered-on. Slave/RVU client/Genie boxes will also be discovered, but only if they are also online at the time of discovery. +Master [DirecTV](http://www.directv.com/) receivers (ie: those that have tuners) will be automatically discovered if you enable the [discovery integration](/components/discovery/) and the receiver is powered-on. Slave/RVU client/Genie boxes will also be discovered, but only if they are also online at the time of discovery. To ensure that your DirecTV boxes are always found and configured, they should be added into your `configuration.yaml`. diff --git a/source/_components/dlib_face_detect.markdown b/source/_components/dlib_face_detect.markdown index 5ba7c2ca0d9..273bd3240f1 100644 --- a/source/_components/dlib_face_detect.markdown +++ b/source/_components/dlib_face_detect.markdown @@ -17,7 +17,7 @@ redirect_from: The `dlib_face_detect` image processing platform allows you to use the [Dlib](http://www.dlib.net/) through Home Assistant. This platform enables face detection from cameras, and can fire events with attributes. -This can be used to trigger an automation rule. Further info is on the [component](/components/image_processing/) page. +This can be used to trigger an automation rule. Further info is on the [integration](/components/image_processing/) page. ### {% linkable_title Configuration Home Assistant %} diff --git a/source/_components/dlib_face_identify.markdown b/source/_components/dlib_face_identify.markdown index 3efb0ac8179..186b9f81242 100644 --- a/source/_components/dlib_face_identify.markdown +++ b/source/_components/dlib_face_identify.markdown @@ -17,7 +17,7 @@ redirect_from: The `dlib_face_identify` image processing platform allows you to use the [Dlib](http://www.dlib.net/) through Home Assistant. This platform allow you to identify persons on camera and fire an event with identify persons. -For using the result inside an automation rule, take a look at the [component](/components/image_processing/) page. +For using the result inside an automation rule, take a look at the [integration](/components/image_processing/) page. ### {% linkable_title Configuration Home Assistant %} diff --git a/source/_cookbook/automation_telegram_presence_alert.markdown b/source/_cookbook/automation_telegram_presence_alert.markdown index d701f0cdc4f..0dcb5aacdbf 100644 --- a/source/_cookbook/automation_telegram_presence_alert.markdown +++ b/source/_cookbook/automation_telegram_presence_alert.markdown @@ -10,7 +10,7 @@ footer: true ha_category: Automation Examples --- -This will send a message when someone in your known devices list connects to your local network. In other words, when someone arrives home. It will only work if you are using the [Nmap](/components/device_tracker.nmap_tracker/) device tracker or a similar component. +This will send a message when someone in your known devices list connects to your local network. In other words, when someone arrives home. It will only work if you are using the [Nmap](/components/device_tracker.nmap_tracker/) device tracker or a similar integration. This example uses [Telegram](/components/notify.telegram/) to send the notification. diff --git a/source/_cookbook/dim_lights_when_playing_media.markdown b/source/_cookbook/dim_lights_when_playing_media.markdown index a53c90d9f0a..e5e6b883524 100644 --- a/source/_cookbook/dim_lights_when_playing_media.markdown +++ b/source/_cookbook/dim_lights_when_playing_media.markdown @@ -12,7 +12,7 @@ ha_category: Automation Examples Like it how the lights dim up/down at the movies? Do it at home as well! -This example uses the [media player](/components/media_player/), [lights](/components/light/) (transitions) and the [sun](/components/sun/) component. We'll use actions to detect media player state changes and [scenes](/components/scene/) to control multiple lights and transition between scenes. +This example uses the [media player](/components/media_player/), [lights](/components/light/) (transitions) and the [sun](/components/sun/) integration. We'll use actions to detect media player state changes and [scenes](/components/scene/) to control multiple lights and transition between scenes. #### {% linkable_title Scenes %} One scene for normal light, one for when movies are on. A 2 second transition gives a nice 'feel' to the switch. diff --git a/source/_cookbook/python_component_mqtt_basic.markdown b/source/_cookbook/python_component_mqtt_basic.markdown index c7e09c8ee25..a5508d129d8 100644 --- a/source/_cookbook/python_component_mqtt_basic.markdown +++ b/source/_cookbook/python_component_mqtt_basic.markdown @@ -11,10 +11,10 @@ ha_category: Custom Python Component Examples ---

-This example requires you to have the [MQTT component](/components/mqtt/) up and running. +This example requires you to have the [MQTT integration](/components/mqtt/) up and running.

-This is a simple hello world example to show the basics of using MQTT in a custom component. To use this example, create the file `/custom_components/hello_mqtt.py` and copy the below example code. +This is a simple hello world example to show the basics of using MQTT in a custom integration. To use this example, create the file `/custom_components/hello_mqtt.py` and copy the below example code. This example follows a topic on MQTT and updates the state of an entity to the last message received on that topic. It will also register a service 'set_state' that will publish a message to the MQTT topic that we're listening to. diff --git a/source/_cookbook/python_component_simple_alarm.markdown b/source/_cookbook/python_component_simple_alarm.markdown index 80ae163161b..63c5bdf05d8 100644 --- a/source/_cookbook/python_component_simple_alarm.markdown +++ b/source/_cookbook/python_component_simple_alarm.markdown @@ -10,7 +10,7 @@ footer: true ha_category: Automation in Python Examples --- -This example integration will detect intruders. It does so by checking if lights are being turned on while there is no one at home. When this happens it will turn the lights red, flash them for 30 seconds and send a message via [the notify component](/components/notify/). It will also flash a specific light when a known person comes home. +This example integration will detect intruders. It does so by checking if lights are being turned on while there is no one at home. When this happens it will turn the lights red, flash them for 30 seconds and send a message via [the notify integration](/components/notify/). It will also flash a specific light when a known person comes home. This integration depends on the integrations [device_tracker](/components/device_tracker/) and [light](/components/light/) being setup. diff --git a/source/_docs/authentication.markdown b/source/_docs/authentication.markdown index 084846798c5..8de0f3e1dc3 100644 --- a/source/_docs/authentication.markdown +++ b/source/_docs/authentication.markdown @@ -3,7 +3,8 @@ layout: page title: "Authentication" description: "Guide on authentication in Home Assistant." date: 2018-08-23 09:40 -redirect_from: /components/auth/ +redirect_from: + - /components/auth/ sidebar: true comments: false sharing: true diff --git a/source/_docs/security.markdown b/source/_docs/security.markdown index db321bb51fb..132f3435443 100644 --- a/source/_docs/security.markdown +++ b/source/_docs/security.markdown @@ -27,7 +27,7 @@ See the [open ports](/docs/security/porosity/) of a Hass.io instance with variou ## {% linkable_title HTTP SSL/TLS %} -Home Assistant is following the [Mozilla's Operations Security team recommendations](https://wiki.mozilla.org/Security/Server_Side_TLS) for Server side SSL/TLS settings. Home Assistant uses **Modern compatibility** by default. If an user wishes to use **Intermediate compatibilty**, this is configurable in the [`http` component](/components/http/). +Home Assistant is following the [Mozilla's Operations Security team recommendations](https://wiki.mozilla.org/Security/Server_Side_TLS) for Server side SSL/TLS settings. Home Assistant uses **Modern compatibility** by default. If an user wishes to use **Intermediate compatibilty**, this is configurable in the [`http` integration](/components/http/). ## {% linkable_title SSH %} diff --git a/source/_docs/z-wave.markdown b/source/_docs/z-wave.markdown index caf4e3ad221..ebc7948e510 100644 --- a/source/_docs/z-wave.markdown +++ b/source/_docs/z-wave.markdown @@ -20,7 +20,7 @@ Before configuring the Z-Wave setup, please take a moment and read [this article Z-Wave is a wireless communication protocol designed for home automation. It uses a low power, and low bandwidth, mesh network that allows devices that aren't within direct range of each other to communicate indirectly, via other nodes. Any device that's permanently powered (not battery powered) will help build the mesh, if you don't have enough powered devices, or you locate these poorly, your mesh will be unreliable. You can [view the state](https://community.home-assistant.io/t/graph-your-z-wave-mesh-python-auto-update/40549) of your mesh [by graphing it](https://community.home-assistant.io/t/z-wave-graph-without-the-python/64275). -There is a limit of 232 devices in a single Z-Wave network. If you need more devices then you could set up a second Home Assistant system with its own Z-Wave network and connect these with the [MQTT Eventstream](/components/mqtt_eventstream/) or [MQTT Statestream](/components/mqtt_statestream) components. There is also a limit of 4 hops for Z-Wave, so placing the controller as centrally as you can is important. +There is a limit of 232 devices in a single Z-Wave network. If you need more devices then you could set up a second Home Assistant system with its own Z-Wave network and connect these with the [MQTT Eventstream](/components/mqtt_eventstream/) or [MQTT Statestream](/components/mqtt_statestream) integrations. There is also a limit of 4 hops for Z-Wave, so placing the controller as centrally as you can is important. The Z-Wave standard was improved with Z-Wave Plus, and if you only use Z-Wave plus devices then you will gain the full benefits. @@ -34,7 +34,7 @@ There are 12 different regions for Z-Wave devices, which relates to the frequenc ## {% linkable_title Getting started %} -You'll now need to connect your [controller](/docs/z-wave/controllers/), [configure](/docs/z-wave/installation) the Z-Wave component, then [add some devices](/docs/z-wave/adding) using the [control panel](/docs/z-wave/control-panel). [This explains](/docs/z-wave/devices/) about devices, and how [entities are named](/docs/z-wave/entities). +You'll now need to connect your [controller](/docs/z-wave/controllers/), [configure](/docs/z-wave/installation) the Z-Wave integration, then [add some devices](/docs/z-wave/adding) using the [control panel](/docs/z-wave/control-panel). [This explains](/docs/z-wave/devices/) about devices, and how [entities are named](/docs/z-wave/entities). You can get more information on the [available services](/docs/z-wave/services/) and [events](/docs/z-wave/events/), what the [query stages](/docs/z-wave/query-stage) of battery powered devices are, as well as details on configuring [specific devices](/docs/z-wave/device-specific/). diff --git a/source/_lovelace/alarm-panel.markdown b/source/_lovelace/alarm-panel.markdown index 103df57a77a..f3d9f8de0d7 100644 --- a/source/_lovelace/alarm-panel.markdown +++ b/source/_lovelace/alarm-panel.markdown @@ -2,7 +2,7 @@ layout: page title: "Alarm Panel Card" sidebar_label: Alarm Panel -description: "The Alarm Panel allows you to Arm and Disarm your Alarm Control Panel Components" +description: "The Alarm Panel allows you to Arm and Disarm your Alarm Control Panel Integrations" date: 2018-10-15 10:28 +00:00 sidebar: true comments: false @@ -10,7 +10,7 @@ sharing: true footer: true --- -The Alarm Panel allows you to Arm and Disarm your Alarm Control Panel Components. +The Alarm Panel allows you to Arm and Disarm your Alarm Control Panel Integrations.

Screenshot of the alarm panel card diff --git a/source/cloud/alexa.markdown b/source/cloud/alexa.markdown index 148e8cfe2d0..f09fe535993 100644 --- a/source/cloud/alexa.markdown +++ b/source/cloud/alexa.markdown @@ -7,7 +7,8 @@ sidebar: false comments: false sharing: true footer: true -redirect_from: /components/cloud.alexa/ +redirect_from: + - /components/cloud.alexa/ --- Home Assistant Cloud is a subscription service provided by our partner Nabu Casa, Inc. Check out [the Nabu Casa website](https://www.nabucasa.com/config/amazon_alexa/) for help with the Amazon Alexa integration via Home Assistant Cloud. diff --git a/source/hassio/installation.markdown b/source/hassio/installation.markdown index 8c90ce1f509..c1b92029b25 100644 --- a/source/hassio/installation.markdown +++ b/source/hassio/installation.markdown @@ -116,7 +116,7 @@ The packages you need to have available on your system that will run Hass.io may - software-properties-common

- The `modemmanager` package will interfere with any Z-Wave or Zigbee stick and should be removed or disabled. Failure to do so will result in random failures of those components. For example you can disable with `sudo systemctl disable ModemManager` and remove with `sudo apt-get purge modemmanager` + The `modemmanager` package will interfere with any Z-Wave or Zigbee stick and should be removed or disabled. Failure to do so will result in random failures of those integrations. For example you can disable with `sudo systemctl disable ModemManager` and remove with `sudo apt-get purge modemmanager`

### {% linkable_title Arch Linux %} diff --git a/source/help/reporting_issues.markdown b/source/help/reporting_issues.markdown index 25a3b321f3b..6ea2cf377fd 100644 --- a/source/help/reporting_issues.markdown +++ b/source/help/reporting_issues.markdown @@ -33,12 +33,12 @@ If possible, provide the latest release of which you know that the integration o There are many different ways to run Home Assistant. In this section please mention which you are using, e.g., manual installation, [Hass.io](/hassio/), Hasbian or as container (Docker). It can help if you mention which operating system you are using because not all are supported on the same level. -### {% linkable_title Component/platform %} +### {% linkable_title Integration/platform %} -Please add the link to the documention of the component/platform in question. E.g., +Please add the link to the documention of the integration/platform in question. E.g., - issue with the `random` sensor: [/components/sensor.random/](/components/sensor.random/) -- issue with the `hue` component: [/components/hue/](/components/hue/) +- issue with the `hue` integration: [/components/hue/](/components/hue/) ### {% linkable_title Description of problem %} diff --git a/source/help/trivia.markdown b/source/help/trivia.markdown index f4a91f4a664..4ecf61372c5 100644 --- a/source/help/trivia.markdown +++ b/source/help/trivia.markdown @@ -17,7 +17,7 @@ Isn't it obvious? Home Assistant is the good soul that is assisting you in your ### {% linkable_title Website %} -The website [https://www.home-assistant.io](/) was launched on December 18, 2014 and contains documentation about the setup process, the platforms and components, and for the developers. +The website [https://www.home-assistant.io](/) was launched on December 18, 2014 and contains documentation about the setup process, the platforms and integrations, and for the developers. ### {% linkable_title Logo %} diff --git a/source/lovelace/index.markdown b/source/lovelace/index.markdown index 20364d518e3..acc9240c39b 100644 --- a/source/lovelace/index.markdown +++ b/source/lovelace/index.markdown @@ -7,7 +7,8 @@ sidebar: true comments: false sharing: true footer: true -redirect_from: /components/lovelace/ +redirect_from: + - /components/lovelace/ --- Lovelace is the name of the Home Assistant user interface. It is a fast, customizable and powerful way for users to manage their homes, working both on mobile and desktop. From af76168a949483cae2126912e6863addc4f197fa Mon Sep 17 00:00:00 2001 From: SonicMagna <52136729+SonicMagna@users.noreply.github.com> Date: Wed, 3 Jul 2019 12:38:29 -0400 Subject: [PATCH 066/116] Linked to Shopping List component (#9769) * Linked to Shopping List component Converted existing text to a link to the HA ShoppingList component page. * :pencil2: Tweak --- source/_addons/snips.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_addons/snips.markdown b/source/_addons/snips.markdown index 919e842cdbd..08887b5c76b 100644 --- a/source/_addons/snips.markdown +++ b/source/_addons/snips.markdown @@ -17,7 +17,7 @@ The Snips add-on depends on the Mosquitto add on to bridge to Home Assistant, so Home Assistant comes with certain Intents builtin to handle common tasks. A complete list of Intents can be found in this wiki [Hass Snips Bundle](https://github.com/tschmidty69/hass-snips-bundle-intents/wiki). -The Snips add-on by default comes with an assistant that allows you to turn on lights or switches, open covers, or add and list items to a shopping list if that integration is enabled. +The Snips add-on by default comes with an assistant that allows you to turn on lights or switches, open covers, or add and list items to a [Shopping List](/components/shopping_list/) if that integration is enabled. If using a USB microphone and speakers plugged into the Raspberry Pi output, Snips will work without any change to the configuration. Trying saying things like: From 50d54e40e1aa6427ddc08eb2e89facdb2cde9cb6 Mon Sep 17 00:00:00 2001 From: aidbish <38182386+aidbish@users.noreply.github.com> Date: Thu, 4 Jul 2019 02:42:46 +1000 Subject: [PATCH 067/116] Update met.markdown (#9768) * Update met.markdown * :pencil2: Tweak * :pencil2: Tweak --- source/_components/met.markdown | 25 ++++++++++++++----------- 1 file changed, 14 insertions(+), 11 deletions(-) diff --git a/source/_components/met.markdown b/source/_components/met.markdown index 9e970b9abec..a1df12a9f8f 100644 --- a/source/_components/met.markdown +++ b/source/_components/met.markdown @@ -18,28 +18,31 @@ redirect_from: The `met` platform uses the [Met.no](https://met.no/) web service as a source for meteorological data for your location. The weather forecast is delivered by the Norwegian Meteorological Institute and the NRK. +

+ Configuration of the Met.no platform via configuration.yaml is deprecated from version 0.95 +

+ ## {% linkable_title Configuration %} -To add Met to your installation, add the following to your `configuration.yaml` file: - -```yaml -weather: - - platform: met -``` +To add Met.no to your installation, go to Configuration >> Integrations in the UI and enable the Met.no integration. By default the values will be taken from the Home Assistant configuration. {% configuration %} +name: + description: Manually specify Name. + required: true + default: Provided by Home Assistant configuration latitude: - description: Manually specify latitude. By default the value will be taken from the Home Assistant configuration. - required: false + description: Manually specify latitude. + required: true type: number default: Provided by Home Assistant configuration longitude: - description: Manually specify longitude. By default the value will be taken from the Home Assistant configuration. - required: false + description: Manually specify longitude. + required: true type: number default: Provided by Home Assistant configuration altitude: - description: Manually specify altitude. By default the value will be taken from the Home Assistant configuration. + description: Manually specify altitude. required: false type: number default: Provided by Home Assistant configuration From e6605e5405f3ef298663a8a3bf2f15a94be0a8e5 Mon Sep 17 00:00:00 2001 From: DKAutomater <52005923+DKAutomater@users.noreply.github.com> Date: Thu, 4 Jul 2019 17:13:51 +0200 Subject: [PATCH 068/116] link on tahoma does not work (#9773) link on tahoma does not work, needed s in componets --- source/_components/somfy.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/somfy.markdown b/source/_components/somfy.markdown index 4f837dd3a7b..81552d054b4 100644 --- a/source/_components/somfy.markdown +++ b/source/_components/somfy.markdown @@ -53,7 +53,7 @@ client_secret: ### {% linkable_title Potential duplicate with the Tahoma integration %} -If you use the [tahoma](/component/tahoma) component, you will have to exclude the covers added by this one. Otherwise, they will be added twice. +If you use the [tahoma](/components/tahoma) component, you will have to exclude the covers added by this one. Otherwise, they will be added twice. ```yaml # Example configuration.yaml entry From ebca3218c76caa46c68b98d3d7b1676b0f221fac Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Thu, 4 Jul 2019 19:08:27 +0200 Subject: [PATCH 069/116] =?UTF-8?q?=F0=9F=94=A5Removes=20linkable=5Ftitle?= =?UTF-8?q?=20everywhere=20(#9772)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Automatically create linkable headers * Visually improve position of linkable header chain icon * Do not auto link headers on homepage * Remove linkable_title everywhere * :ambulance: Re-instante linkable_title plugin as NOOP --- plugins/linkable_title.rb | 27 +- plugins/no_follow.rb | 33 - plugins/output_modder.rb | 50 ++ sass/custom/_paulus.scss | 2 +- source/_addons/check_config.markdown | 4 +- source/_addons/configurator.markdown | 6 +- source/_addons/duckdns.markdown | 6 +- source/_addons/google_assistant.markdown | 2 +- source/_addons/homematic.markdown | 6 +- source/_addons/lets_encrypt.markdown | 4 +- source/_addons/mariadb.markdown | 2 +- source/_addons/mosquitto.markdown | 10 +- source/_addons/rpc_shutdown.markdown | 2 +- source/_addons/snips.markdown | 8 +- source/_addons/tellstick.markdown | 6 +- source/_components/abode.markdown | 18 +- source/_components/acer_projector.markdown | 2 +- source/_components/adguard.markdown | 18 +- source/_components/ads.markdown | 14 +- source/_components/aftership.markdown | 8 +- source/_components/airvisual.markdown | 8 +- source/_components/aladdin_connect.markdown | 2 +- .../alarm_control_panel.ifttt.markdown | 4 +- .../alarm_control_panel.mqtt.markdown | 2 +- source/_components/alarmdecoder.markdown | 10 +- source/_components/alarmdotcom.markdown | 2 +- source/_components/alert.markdown | 10 +- .../alexa.flash_briefings.markdown | 8 +- source/_components/alexa.intent.markdown | 16 +- source/_components/alexa.markdown | 6 +- source/_components/alexa.smart_home.markdown | 22 +- source/_components/alpha_vantage.markdown | 4 +- source/_components/amazon_polly.markdown | 6 +- source/_components/ambiclimate.markdown | 2 +- source/_components/ambient_station.markdown | 4 +- source/_components/amcrest.markdown | 18 +- source/_components/ampio.markdown | 4 +- source/_components/android_ip_webcam.markdown | 16 +- source/_components/androidtv.markdown | 22 +- source/_components/anthemav.markdown | 2 +- source/_components/apcupsd.markdown | 14 +- source/_components/apns.markdown | 8 +- source/_components/apple_tv.markdown | 18 +- source/_components/aprs.markdown | 2 +- source/_components/aqualogic.markdown | 6 +- source/_components/arduino.markdown | 6 +- source/_components/arest.markdown | 6 +- source/_components/arlo.markdown | 16 +- source/_components/asterisk_mbox.markdown | 2 +- source/_components/asuswrt.markdown | 6 +- source/_components/august.markdown | 6 +- source/_components/aurora.markdown | 4 +- source/_components/automatic.markdown | 4 +- source/_components/avion.markdown | 6 +- source/_components/awair.markdown | 4 +- source/_components/aws.markdown | 16 +- source/_components/axis.markdown | 8 +- source/_components/azure_event_hub.markdown | 6 +- source/_components/baidu.markdown | 2 +- source/_components/bayesian.markdown | 4 +- source/_components/bbb_gpio.markdown | 8 +- source/_components/bbox.markdown | 6 +- source/_components/bh1750.markdown | 8 +- source/_components/binary_sensor.knx.markdown | 4 +- source/_components/binary_sensor.markdown | 2 +- .../_components/binary_sensor.modbus.markdown | 4 +- .../_components/binary_sensor.mqtt.markdown | 10 +- .../binary_sensor.mysensors.markdown | 2 +- .../_components/binary_sensor.rest.markdown | 8 +- .../_components/binary_sensor.rflink.markdown | 6 +- .../_components/binary_sensor.rfxtrx.markdown | 6 +- .../binary_sensor.template.markdown | 18 +- .../binary_sensor.xiaomi_aqara.markdown | 20 +- source/_components/blackbird.markdown | 2 +- source/_components/blink.markdown | 24 +- source/_components/blinksticklight.markdown | 4 +- source/_components/blinkt.markdown | 2 +- source/_components/bloomsky.markdown | 16 +- source/_components/bluesound.markdown | 8 +- .../_components/bluetooth_le_tracker.markdown | 2 +- source/_components/bme280.markdown | 10 +- source/_components/bme680.markdown | 12 +- .../_components/bmw_connected_drive.markdown | 16 +- source/_components/bom.markdown | 16 +- source/_components/braviatv.markdown | 4 +- source/_components/broadcast.markdown | 2 +- source/_components/broadlink.markdown | 26 +- source/_components/brottsplatskartan.markdown | 8 +- source/_components/browser.markdown | 6 +- source/_components/brunt.markdown | 2 +- source/_components/bt_smarthub.markdown | 2 +- source/_components/buienradar.markdown | 4 +- source/_components/caldav.markdown | 10 +- source/_components/calendar.google.markdown | 12 +- source/_components/camera.ffmpeg.markdown | 4 +- source/_components/camera.markdown | 20 +- source/_components/camera.mqtt.markdown | 2 +- source/_components/canary.markdown | 8 +- source/_components/cast.markdown | 2 +- source/_components/cert_expiry.markdown | 2 +- source/_components/channels.markdown | 6 +- source/_components/cisco_webex_teams.markdown | 2 +- source/_components/citybikes.markdown | 4 +- source/_components/clickatell.markdown | 4 +- source/_components/clicksend.markdown | 4 +- source/_components/climate.markdown | 40 +- source/_components/climate.modbus.markdown | 4 +- source/_components/climate.mqtt.markdown | 8 +- source/_components/climate.mysensors.markdown | 4 +- source/_components/cloudflare.markdown | 4 +- source/_components/co2signal.markdown | 6 +- source/_components/coinbase.markdown | 4 +- source/_components/command_line.markdown | 10 +- source/_components/concord232.markdown | 4 +- source/_components/config.markdown | 14 +- source/_components/conversation.markdown | 6 +- source/_components/counter.markdown | 16 +- .../_components/cover.command_line.markdown | 4 +- source/_components/cover.group.markdown | 2 +- source/_components/cover.markdown | 14 +- source/_components/cover.mqtt.markdown | 10 +- source/_components/cover.mysensors.markdown | 2 +- source/_components/cover.rflink.markdown | 6 +- source/_components/cover.rfxtrx.markdown | 8 +- source/_components/cover.template.markdown | 16 +- source/_components/cpuspeed.markdown | 2 +- source/_components/crimereports.markdown | 10 +- source/_components/daikin.markdown | 10 +- source/_components/danfoss_air.markdown | 6 +- source/_components/darksky.markdown | 8 +- source/_components/deconz.markdown | 58 +- source/_components/default_config.markdown | 2 +- source/_components/deluge.markdown | 4 +- source/_components/denon.markdown | 2 +- source/_components/device_tracker.markdown | 8 +- .../_components/device_tracker.mqtt.markdown | 4 +- .../device_tracker.mysensors.markdown | 2 +- .../device_tracker.xiaomi.markdown | 4 +- source/_components/dht.markdown | 4 +- source/_components/dialogflow.markdown | 6 +- source/_components/digital_ocean.markdown | 12 +- source/_components/digitalloggers.markdown | 2 +- source/_components/directv.markdown | 6 +- source/_components/discogs.markdown | 4 +- source/_components/discord.markdown | 6 +- source/_components/discovery.markdown | 14 +- source/_components/dispatcher.markdown | 2 +- source/_components/dlib_face_detect.markdown | 2 +- .../_components/dlib_face_identify.markdown | 2 +- source/_components/dlna_dmr.markdown | 2 +- source/_components/dnsip.markdown | 4 +- source/_components/dominos.markdown | 2 +- source/_components/doorbird.markdown | 22 +- source/_components/dovado.markdown | 6 +- source/_components/downloader.markdown | 4 +- source/_components/dsmr.markdown | 2 +- source/_components/duckdns.markdown | 2 +- source/_components/duke_energy.markdown | 4 +- .../_components/dwd_weather_warnings.markdown | 4 +- source/_components/dweet.markdown | 10 +- source/_components/dyson.markdown | 22 +- source/_components/ebox.markdown | 2 +- source/_components/ebusd.markdown | 2 +- source/_components/ecoal_boiler.markdown | 2 +- source/_components/ecobee.markdown | 64 +- source/_components/econet.markdown | 6 +- source/_components/ecovacs.markdown | 10 +- .../eddystone_temperature.markdown | 2 +- source/_components/edimax.markdown | 2 +- source/_components/edp_redy.markdown | 2 +- source/_components/ee_brightbox.markdown | 2 +- source/_components/efergy.markdown | 4 +- source/_components/egardia.markdown | 6 +- source/_components/eight_sleep.markdown | 6 +- source/_components/elkm1.markdown | 2 +- source/_components/emoncms.markdown | 6 +- source/_components/emulated_hue.markdown | 6 +- source/_components/emulated_roku.markdown | 10 +- source/_components/enocean.markdown | 18 +- source/_components/enphase_envoy.markdown | 2 +- .../entur_public_transport.markdown | 8 +- .../_components/environment_canada.markdown | 8 +- source/_components/envirophat.markdown | 4 +- source/_components/eq3btsmart.markdown | 4 +- source/_components/esphome.markdown | 2 +- source/_components/everlights.markdown | 4 +- source/_components/evohome.markdown | 4 +- source/_components/facebook.markdown | 4 +- source/_components/facebox.markdown | 8 +- source/_components/fail2ban.markdown | 20 +- source/_components/familyhub.markdown | 2 +- source/_components/fan.mqtt.markdown | 6 +- source/_components/fan.xiaomi_miio.markdown | 40 +- source/_components/fastdotcom.markdown | 8 +- source/_components/fedex.markdown | 2 +- source/_components/ffmpeg.markdown | 8 +- source/_components/ffmpeg_motion.markdown | 6 +- source/_components/ffmpeg_noise.markdown | 2 +- source/_components/fibaro.markdown | 4 +- source/_components/fido.markdown | 2 +- source/_components/file.markdown | 8 +- source/_components/filesize.markdown | 2 +- source/_components/filter.markdown | 16 +- source/_components/fints.markdown | 2 +- source/_components/fixer.markdown | 4 +- source/_components/flic.markdown | 12 +- source/_components/flock.markdown | 4 +- source/_components/flunearyou.markdown | 4 +- source/_components/flux_led.markdown | 6 +- source/_components/folder.markdown | 2 +- source/_components/folder_watcher.markdown | 2 +- source/_components/foobot.markdown | 4 +- source/_components/foscam.markdown | 4 +- source/_components/foursquare.markdown | 4 +- source/_components/freebox.markdown | 14 +- source/_components/freedns.markdown | 4 +- source/_components/fritz.markdown | 4 +- source/_components/fritzbox.markdown | 12 +- .../_components/fritzbox_callmonitor.markdown | 12 +- source/_components/frontend.markdown | 10 +- source/_components/frontier_silicon.markdown | 2 +- source/_components/futurenow.markdown | 4 +- source/_components/garadget.markdown | 4 +- source/_components/gc100.markdown | 6 +- source/_components/gearbest.markdown | 2 +- source/_components/geizhals.markdown | 2 +- source/_components/generic.markdown | 14 +- source/_components/geniushub.markdown | 14 +- source/_components/geo_json_events.markdown | 6 +- source/_components/geo_location.markdown | 4 +- source/_components/geo_rss_events.markdown | 4 +- source/_components/geofency.markdown | 4 +- source/_components/github.markdown | 4 +- source/_components/gitlab_ci.markdown | 4 +- source/_components/gitter.markdown | 2 +- source/_components/glances.markdown | 4 +- source/_components/gogogate2.markdown | 2 +- source/_components/google_assistant.markdown | 26 +- source/_components/google_cloud.markdown | 12 +- source/_components/google_domains.markdown | 2 +- source/_components/google_maps.markdown | 2 +- source/_components/google_pubsub.markdown | 6 +- source/_components/google_translate.markdown | 4 +- .../_components/google_travel_time.markdown | 10 +- source/_components/googlehome.markdown | 6 +- source/_components/gpsd.markdown | 4 +- source/_components/gpslogger.markdown | 4 +- source/_components/group.markdown | 8 +- source/_components/gstreamer.markdown | 8 +- source/_components/habitica.markdown | 2 +- source/_components/hangouts.markdown | 26 +- source/_components/harmony.markdown | 16 +- source/_components/haveibeenpwned.markdown | 4 +- source/_components/hdmi_cec.markdown | 32 +- source/_components/heos.markdown | 26 +- source/_components/hikvision.markdown | 6 +- source/_components/hipchat.markdown | 2 +- source/_components/history.markdown | 6 +- source/_components/history_graph.markdown | 2 +- source/_components/history_stats.markdown | 10 +- source/_components/hive.markdown | 10 +- source/_components/homekit.markdown | 66 +- source/_components/homematic.markdown | 28 +- source/_components/homematicip_cloud.markdown | 6 +- source/_components/homeworks.markdown | 2 +- source/_components/honeywell.markdown | 6 +- source/_components/hook.markdown | 2 +- source/_components/horizon.markdown | 2 +- source/_components/hp_ilo.markdown | 8 +- source/_components/html5.markdown | 40 +- source/_components/http.markdown | 18 +- source/_components/htu21d.markdown | 8 +- source/_components/huawei_lte.markdown | 10 +- source/_components/huawei_router.markdown | 2 +- source/_components/hue.markdown | 12 +- source/_components/hydrawise.markdown | 10 +- source/_components/hyperion.markdown | 4 +- source/_components/ialarm.markdown | 2 +- source/_components/idteck_prox.markdown | 2 +- source/_components/ifttt.markdown | 16 +- source/_components/ign_sismologia.markdown | 6 +- source/_components/ihc.markdown | 14 +- source/_components/image_processing.markdown | 6 +- source/_components/imap.markdown | 6 +- .../_components/imap_email_content.markdown | 4 +- source/_components/incomfort.markdown | 2 +- source/_components/influxdb.markdown | 12 +- source/_components/input_boolean.markdown | 4 +- source/_components/input_datetime.markdown | 8 +- source/_components/input_number.markdown | 4 +- source/_components/input_select.markdown | 8 +- source/_components/input_text.markdown | 6 +- source/_components/insteon.markdown | 18 +- source/_components/integration.markdown | 4 +- source/_components/iota.markdown | 2 +- source/_components/iperf3.markdown | 10 +- source/_components/ipma.markdown | 2 +- source/_components/iqvia.markdown | 6 +- .../_components/islamic_prayer_times.markdown | 2 +- source/_components/iss.markdown | 4 +- source/_components/isy994.markdown | 10 +- source/_components/itunes.markdown | 2 +- source/_components/jewish_calendar.markdown | 6 +- source/_components/juicenet.markdown | 6 +- source/_components/kankun.markdown | 2 +- source/_components/keyboard.markdown | 4 +- source/_components/keyboard_remote.markdown | 4 +- source/_components/kira.markdown | 8 +- source/_components/kiwi.markdown | 2 +- source/_components/knx.markdown | 8 +- source/_components/kodi.markdown | 22 +- source/_components/konnected.markdown | 16 +- source/_components/lacrosse.markdown | 8 +- source/_components/lametric.markdown | 12 +- source/_components/lannouncer.markdown | 4 +- source/_components/lastfm.markdown | 4 +- source/_components/launch_library.markdown | 2 +- source/_components/lcn.markdown | 58 +- source/_components/lg_soundbar.markdown | 2 +- source/_components/life360.markdown | 24 +- source/_components/lifx.markdown | 14 +- source/_components/light.group.markdown | 2 +- source/_components/light.knx.markdown | 4 +- source/_components/light.markdown | 8 +- source/_components/light.mqtt.markdown | 46 +- source/_components/light.mysensors.markdown | 4 +- source/_components/light.rflink.markdown | 10 +- source/_components/light.template.markdown | 10 +- source/_components/light.xiaomi_miio.markdown | 18 +- source/_components/limitlessled.markdown | 8 +- source/_components/linksys_ap.markdown | 4 +- source/_components/linksys_smart.markdown | 4 +- source/_components/linky.markdown | 2 +- source/_components/linode.markdown | 8 +- source/_components/lirc.markdown | 8 +- source/_components/liveboxplaytv.markdown | 4 +- source/_components/local_file.markdown | 4 +- source/_components/lock.markdown | 12 +- source/_components/lock.mqtt.markdown | 6 +- source/_components/lock.template.markdown | 12 +- source/_components/lockitron.markdown | 4 +- source/_components/logbook.markdown | 4 +- source/_components/logger.markdown | 8 +- source/_components/logi_circle.markdown | 16 +- source/_components/luftdaten.markdown | 10 +- source/_components/lupusec.markdown | 2 +- source/_components/lutron.markdown | 6 +- source/_components/lutron_caseta.markdown | 8 +- source/_components/lw12wifi.markdown | 2 +- source/_components/magicseaweed.markdown | 4 +- source/_components/mailgun.markdown | 8 +- source/_components/manual.markdown | 8 +- source/_components/manual_mqtt.markdown | 6 +- source/_components/marytts.markdown | 4 +- source/_components/mastodon.markdown | 4 +- source/_components/matrix.markdown | 8 +- source/_components/maxcube.markdown | 4 +- source/_components/mcp23017.markdown | 8 +- source/_components/media_extractor.markdown | 2 +- source/_components/media_player.markdown | 18 +- source/_components/mediaroom.markdown | 8 +- source/_components/melissa.markdown | 2 +- source/_components/meraki.markdown | 4 +- source/_components/message_bird.markdown | 8 +- source/_components/met.markdown | 2 +- source/_components/meteo_france.markdown | 10 +- source/_components/meteoalarm.markdown | 6 +- source/_components/metoffice.markdown | 2 +- source/_components/mfi.markdown | 4 +- source/_components/mhz19.markdown | 6 +- source/_components/microsoft.markdown | 4 +- source/_components/microsoft_face.markdown | 6 +- .../microsoft_face_detect.markdown | 2 +- .../microsoft_face_identify.markdown | 2 +- source/_components/miflora.markdown | 8 +- source/_components/mikrotik.markdown | 8 +- source/_components/mill.markdown | 4 +- source/_components/min_max.markdown | 2 +- source/_components/mitemp_bt.markdown | 6 +- source/_components/mjpeg.markdown | 4 +- source/_components/mobile_app.markdown | 2 +- source/_components/mochad.markdown | 8 +- source/_components/modbus.markdown | 14 +- source/_components/modem_callerid.markdown | 6 +- source/_components/mold_indicator.markdown | 4 +- source/_components/monoprice.markdown | 4 +- source/_components/moon.markdown | 2 +- source/_components/mopar.markdown | 6 +- source/_components/mqtt.markdown | 2 +- source/_components/mqtt_eventstream.markdown | 4 +- source/_components/mqtt_json.markdown | 4 +- source/_components/mqtt_room.markdown | 6 +- source/_components/mqtt_statestream.markdown | 6 +- source/_components/mvglive.markdown | 6 +- source/_components/mychevy.markdown | 4 +- source/_components/mycroft.markdown | 2 +- source/_components/myq.markdown | 2 +- source/_components/mysensors.markdown | 12 +- source/_components/mystrom.markdown | 12 +- source/_components/mythicbeastsdns.markdown | 2 +- source/_components/n26.markdown | 2 +- source/_components/namecheapdns.markdown | 2 +- source/_components/nanoleaf.markdown | 4 +- source/_components/neato.markdown | 12 +- source/_components/nello.markdown | 6 +- source/_components/ness_alarm.markdown | 10 +- source/_components/nest.markdown | 28 +- source/_components/netatmo.markdown | 28 +- source/_components/netdata.markdown | 6 +- source/_components/netgear_lte.markdown | 16 +- source/_components/nfandroidtv.markdown | 2 +- source/_components/niko_home_control.markdown | 2 +- source/_components/nilu.markdown | 16 +- source/_components/nissan_leaf.markdown | 10 +- source/_components/nmap_tracker.markdown | 4 +- source/_components/nmbs.markdown | 2 +- source/_components/noaa_tides.markdown | 4 +- source/_components/notify.group.markdown | 4 +- source/_components/notify.knx.markdown | 2 +- source/_components/notify.markdown | 4 +- source/_components/notify.mysensors.markdown | 4 +- source/_components/nsw_fuel_station.markdown | 4 +- .../nsw_rural_fire_service_feed.markdown | 6 +- source/_components/nuheat.markdown | 30 +- source/_components/nuki.markdown | 6 +- source/_components/nut.markdown | 6 +- source/_components/nx584.markdown | 6 +- source/_components/oasa_telematics.markdown | 4 +- source/_components/octoprint.markdown | 6 +- source/_components/ohmconnect.markdown | 2 +- source/_components/onewire.markdown | 10 +- source/_components/onkyo.markdown | 8 +- source/_components/onvif.markdown | 4 +- source/_components/openalpr_cloud.markdown | 2 +- source/_components/openalpr_local.markdown | 4 +- source/_components/opencv.markdown | 2 +- source/_components/openevse.markdown | 2 +- source/_components/opengarage.markdown | 2 +- .../_components/openhardwaremonitor.markdown | 4 +- source/_components/opensensemap.markdown | 4 +- source/_components/opensky.markdown | 4 +- source/_components/opentherm_gw.markdown | 28 +- source/_components/openuv.markdown | 12 +- source/_components/openweathermap.markdown | 4 +- source/_components/openwrt.markdown | 2 +- source/_components/orangepi_gpio.markdown | 8 +- source/_components/otp.markdown | 2 +- source/_components/owlet.markdown | 6 +- source/_components/owntracks.markdown | 18 +- source/_components/panasonic_bluray.markdown | 2 +- source/_components/panasonic_viera.markdown | 2 +- source/_components/pandora.markdown | 4 +- source/_components/pencom.markdown | 2 +- .../persistent_notification.markdown | 6 +- source/_components/person.markdown | 4 +- source/_components/pi_hole.markdown | 4 +- source/_components/picotts.markdown | 4 +- source/_components/piglow.markdown | 2 +- source/_components/pilight.markdown | 16 +- source/_components/ping.markdown | 6 +- source/_components/pjlink.markdown | 2 +- source/_components/plaato.markdown | 2 +- source/_components/plant.markdown | 4 +- source/_components/plex.markdown | 10 +- source/_components/plum_lightpad.markdown | 2 +- source/_components/pocketcasts.markdown | 2 +- source/_components/point.markdown | 14 +- source/_components/polling.markdown | 2 +- source/_components/postnl.markdown | 2 +- source/_components/prezzibenzina.markdown | 6 +- source/_components/prowl.markdown | 2 +- source/_components/proxy.markdown | 4 +- source/_components/ps4.markdown | 24 +- source/_components/ptvsd.markdown | 10 +- source/_components/push.markdown | 4 +- source/_components/pushbullet.markdown | 20 +- source/_components/pushover.markdown | 2 +- source/_components/pushsafer.markdown | 2 +- source/_components/python_script.markdown | 4 +- source/_components/qbittorrent.markdown | 4 +- source/_components/qld_bushfire.markdown | 6 +- source/_components/qnap.markdown | 6 +- source/_components/qrcode.markdown | 2 +- source/_components/quantum_gateway.markdown | 2 +- source/_components/qwikswitch.markdown | 8 +- source/_components/rachio.markdown | 12 +- source/_components/radarr.markdown | 14 +- source/_components/rainbird.markdown | 6 +- source/_components/raincloud.markdown | 8 +- source/_components/rainmachine.markdown | 30 +- source/_components/random.markdown | 8 +- source/_components/raspihats.markdown | 16 +- source/_components/raspyrfm.markdown | 10 +- source/_components/recollect_waste.markdown | 2 +- source/_components/recorder.markdown | 14 +- source/_components/recswitch.markdown | 2 +- source/_components/reddit.markdown | 4 +- source/_components/rejseplanen.markdown | 8 +- source/_components/remember_the_milk.markdown | 14 +- source/_components/remote.markdown | 2 +- .../_components/remote.xiaomi_miio.markdown | 18 +- source/_components/remote_rpi_gpio.markdown | 4 +- source/_components/repetier.markdown | 4 +- source/_components/rest.markdown | 14 +- source/_components/rest_command.markdown | 2 +- source/_components/rflink.markdown | 18 +- source/_components/ring.markdown | 10 +- source/_components/ritassist.markdown | 6 +- source/_components/rmvtransport.markdown | 8 +- source/_components/rocketchat.markdown | 6 +- source/_components/roku.markdown | 6 +- source/_components/roomba.markdown | 4 +- source/_components/route53.markdown | 4 +- source/_components/rova.markdown | 4 +- source/_components/rpi_camera.markdown | 2 +- source/_components/rpi_gpio.markdown | 16 +- source/_components/rpi_gpio_pwm.markdown | 8 +- source/_components/rpi_pfio.markdown | 6 +- source/_components/rpi_rf.markdown | 2 +- source/_components/sabnzbd.markdown | 8 +- source/_components/samsungtv.markdown | 4 +- source/_components/satel_integra.markdown | 6 +- source/_components/scene.knx.markdown | 2 +- source/_components/scrape.markdown | 16 +- source/_components/script.markdown | 4 +- source/_components/scsgate.markdown | 8 +- source/_components/season.markdown | 2 +- source/_components/sendgrid.markdown | 4 +- source/_components/sense.markdown | 2 +- source/_components/sensehat.markdown | 20 +- source/_components/sensibo.markdown | 4 +- source/_components/sensor.buienradar.markdown | 6 +- .../_components/sensor.command_line.markdown | 20 +- source/_components/sensor.knx.markdown | 4 +- source/_components/sensor.markdown | 2 +- source/_components/sensor.modbus.markdown | 4 +- source/_components/sensor.mqtt.markdown | 14 +- source/_components/sensor.mysensors.markdown | 16 +- source/_components/sensor.rflink.markdown | 10 +- .../_components/sensor.websocket_api.markdown | 4 +- .../_components/sensor.xiaomi_miio.markdown | 2 +- source/_components/serial.markdown | 12 +- source/_components/serial_pm.markdown | 6 +- source/_components/sesame.markdown | 2 +- source/_components/seven_segments.markdown | 2 +- source/_components/seventeentrack.markdown | 2 +- source/_components/shiftr.markdown | 2 +- source/_components/shopping_list.markdown | 6 +- source/_components/sht31.markdown | 2 +- source/_components/sigfox.markdown | 4 +- source/_components/simulated.markdown | 4 +- source/_components/skybeacon.markdown | 2 +- source/_components/skybell.markdown | 14 +- source/_components/slack.markdown | 6 +- source/_components/sleepiq.markdown | 4 +- source/_components/sma.markdown | 2 +- source/_components/smappee.markdown | 2 +- source/_components/smartthings.markdown | 48 +- source/_components/smarty.markdown | 2 +- source/_components/smhi.markdown | 2 +- source/_components/snips.markdown | 36 +- source/_components/snmp.markdown | 12 +- source/_components/socialblade.markdown | 4 +- source/_components/solaredge.markdown | 4 +- source/_components/solaredge_local.markdown | 4 +- source/_components/solax.markdown | 4 +- source/_components/somfy.markdown | 6 +- source/_components/sonarr.markdown | 14 +- source/_components/songpal.markdown | 6 +- source/_components/sonos.markdown | 20 +- source/_components/sony_projector.markdown | 2 +- source/_components/soundtouch.markdown | 10 +- source/_components/spaceapi.markdown | 8 +- source/_components/spc.markdown | 4 +- source/_components/speedtestdotnet.markdown | 14 +- source/_components/spider.markdown | 4 +- source/_components/splunk.markdown | 2 +- source/_components/spotcrime.markdown | 8 +- source/_components/spotify.markdown | 12 +- source/_components/sql.markdown | 14 +- source/_components/squeezebox.markdown | 2 +- source/_components/srp_energy.markdown | 2 +- source/_components/ssdp.markdown | 4 +- source/_components/starlingbank.markdown | 4 +- source/_components/startca.markdown | 4 +- source/_components/statistics.markdown | 2 +- source/_components/steam_online.markdown | 6 +- source/_components/stiebel_eltron.markdown | 6 +- source/_components/stream.markdown | 10 +- source/_components/streamlabswater.markdown | 4 +- source/_components/stride.markdown | 2 +- source/_components/sun.markdown | 6 +- source/_components/supla.markdown | 2 +- .../swiss_hydrological_data.markdown | 4 +- .../_components/switch.command_line.markdown | 10 +- source/_components/switch.knx.markdown | 2 +- source/_components/switch.markdown | 2 +- source/_components/switch.modbus.markdown | 2 +- source/_components/switch.mqtt.markdown | 8 +- source/_components/switch.mysensors.markdown | 16 +- source/_components/switch.pca.markdown | 2 +- source/_components/switch.rest.markdown | 6 +- source/_components/switch.rflink.markdown | 6 +- source/_components/switch.rfxtrx.markdown | 4 +- source/_components/switch.template.markdown | 16 +- .../_components/switch.xiaomi_miio.markdown | 22 +- source/_components/switchbot.markdown | 2 +- source/_components/switcher_kis.markdown | 6 +- source/_components/switchmate.markdown | 2 +- source/_components/synology.markdown | 4 +- source/_components/synology_srm.markdown | 2 +- source/_components/synologydsm.markdown | 4 +- source/_components/system_log.markdown | 18 +- source/_components/systemmonitor.markdown | 4 +- source/_components/sytadin.markdown | 2 +- source/_components/tado.markdown | 6 +- source/_components/tahoma.markdown | 2 +- source/_components/tank_utility.markdown | 8 +- source/_components/tapsaff.markdown | 2 +- source/_components/tautulli.markdown | 6 +- source/_components/tcp.markdown | 10 +- source/_components/teksavvy.markdown | 2 +- source/_components/telegram.markdown | 14 +- source/_components/telegram_bot.markdown | 32 +- source/_components/tellduslive.markdown | 2 +- source/_components/tellstick.markdown | 14 +- source/_components/temper.markdown | 2 +- source/_components/template.markdown | 26 +- source/_components/tensorflow.markdown | 8 +- source/_components/tesla.markdown | 2 +- source/_components/tfiac.markdown | 2 +- source/_components/thermoworks_smoke.markdown | 10 +- source/_components/thethingsnetwork.markdown | 10 +- source/_components/thingspeak.markdown | 2 +- source/_components/thinkingcleaner.markdown | 4 +- source/_components/threshold.markdown | 2 +- source/_components/tibber.markdown | 14 +- source/_components/timer.markdown | 22 +- source/_components/tod.markdown | 4 +- source/_components/todoist.markdown | 10 +- source/_components/tof.markdown | 8 +- source/_components/toon.markdown | 6 +- source/_components/torque.markdown | 6 +- source/_components/totalconnect.markdown | 4 +- source/_components/tplink.markdown | 18 +- source/_components/tplink_lte.markdown | 2 +- source/_components/traccar.markdown | 2 +- source/_components/tradfri.markdown | 10 +- .../trafikverket_weatherstation.markdown | 8 +- source/_components/transmission.markdown | 6 +- source/_components/transport_nsw.markdown | 6 +- source/_components/travisci.markdown | 4 +- source/_components/trend.markdown | 6 +- source/_components/tts.markdown | 16 +- source/_components/tuya.markdown | 4 +- source/_components/twilio.markdown | 4 +- source/_components/twilio_call.markdown | 2 +- source/_components/twilio_sms.markdown | 2 +- source/_components/twitch.markdown | 4 +- source/_components/twitter.markdown | 4 +- source/_components/ubus.markdown | 6 +- source/_components/uk_transport.markdown | 2 +- source/_components/unifi.markdown | 18 +- source/_components/universal.markdown | 6 +- source/_components/upcloud.markdown | 8 +- source/_components/updater.markdown | 4 +- source/_components/upnp.markdown | 4 +- source/_components/ups.markdown | 2 +- source/_components/uptime.markdown | 4 +- source/_components/uptimerobot.markdown | 2 +- source/_components/uscis.markdown | 2 +- .../usgs_earthquakes_feed.markdown | 6 +- source/_components/usps.markdown | 14 +- source/_components/utility_meter.markdown | 16 +- source/_components/uvc.markdown | 4 +- source/_components/vacuum.markdown | 26 +- source/_components/vacuum.mqtt.markdown | 34 +- .../_components/vacuum.xiaomi_miio.markdown | 36 +- source/_components/velbus.markdown | 2 +- source/_components/velux.markdown | 2 +- source/_components/venstar.markdown | 2 +- source/_components/vera.markdown | 8 +- source/_components/verisure.markdown | 4 +- source/_components/version.markdown | 6 +- source/_components/vesync.markdown | 4 +- source/_components/vizio.markdown | 14 +- source/_components/vlc-telnet.markdown | 4 +- source/_components/vlc.markdown | 8 +- source/_components/voicerss.markdown | 4 +- source/_components/volkszaehler.markdown | 4 +- source/_components/volvooncall.markdown | 6 +- source/_components/vultr.markdown | 16 +- source/_components/w800rf32.markdown | 4 +- source/_components/wake_on_lan.markdown | 14 +- source/_components/water_heater.markdown | 16 +- source/_components/waterfurnace.markdown | 4 +- source/_components/watson_iot.markdown | 6 +- source/_components/watson_tts.markdown | 6 +- source/_components/waze_travel_time.markdown | 4 +- source/_components/weather.darksky.markdown | 2 +- source/_components/weather.markdown | 2 +- source/_components/webhooks.markdown | 4 +- source/_components/weblink.markdown | 2 +- source/_components/webostv.markdown | 16 +- source/_components/websocket_api.markdown | 4 +- source/_components/wemo.markdown | 10 +- source/_components/whois.markdown | 2 +- source/_components/wink.markdown | 86 +-- source/_components/wirelesstag.markdown | 8 +- source/_components/workday.markdown | 8 +- source/_components/worldclock.markdown | 2 +- source/_components/worldtidesinfo.markdown | 4 +- source/_components/wsdot.markdown | 4 +- source/_components/wunderground.markdown | 16 +- source/_components/wunderlist.markdown | 6 +- source/_components/xeoma.markdown | 4 +- source/_components/xfinity.markdown | 2 +- source/_components/xiaomi.markdown | 6 +- source/_components/xiaomi_aqara.markdown | 34 +- source/_components/xmpp.markdown | 10 +- source/_components/xs1.markdown | 14 +- source/_components/yale_smart_alarm.markdown | 4 +- source/_components/yamaha.markdown | 10 +- source/_components/yamaha_musiccast.markdown | 4 +- source/_components/yandextts.markdown | 4 +- source/_components/yeelight.markdown | 24 +- source/_components/yi.markdown | 10 +- source/_components/zabbix.markdown | 6 +- source/_components/zamg.markdown | 4 +- source/_components/zengge.markdown | 2 +- source/_components/zeroconf.markdown | 2 +- source/_components/zestimate.markdown | 4 +- source/_components/zha.markdown | 10 +- source/_components/zigbee.markdown | 20 +- source/_components/ziggo_mediabox_xl.markdown | 2 +- source/_components/zone.markdown | 6 +- source/_components/zoneminder.markdown | 16 +- source/_components/zwave.markdown | 12 +- .../_cookbook/automation_first_light.markdown | 6 +- .../automation_flashing_lights.markdown | 2 +- source/_cookbook/automation_sun.markdown | 8 +- ...n_using_timeinterval_inputboolean.markdown | 2 +- .../dim_lights_when_playing_media.markdown | 4 +- source/_cookbook/fail2ban.markdown | 8 +- source/_cookbook/ifttt.manything.markdown | 4 +- source/_cookbook/notify.mqtt.markdown | 6 +- ...ha_if_wemo_switch_is_not_detected.markdown | 2 +- source/_cookbook/sonos_say.markdown | 2 +- source/_cookbook/track_battery_level.markdown | 4 +- ...r_10_minutes_when_motion_detected.markdown | 2 +- source/_docs/asterisk_mbox.markdown | 4 +- source/_docs/authentication.markdown | 24 +- .../authentication/multi-factor-auth.markdown | 12 +- .../_docs/authentication/providers.markdown | 16 +- source/_docs/automation.markdown | 6 +- source/_docs/automation/editor.markdown | 4 +- source/_docs/automation/templating.markdown | 26 +- source/_docs/automation/trigger.markdown | 30 +- source/_docs/autostart/init.d.markdown | 18 +- source/_docs/autostart/systemd.markdown | 8 +- source/_docs/backend/database.markdown | 6 +- source/_docs/configuration.markdown | 4 +- .../customizing-devices.markdown | 14 +- source/_docs/configuration/devices.markdown | 6 +- source/_docs/configuration/events.markdown | 18 +- .../configuration/group_visibility.markdown | 8 +- source/_docs/configuration/packages.markdown | 4 +- .../configuration/platform_options.markdown | 4 +- source/_docs/configuration/secrets.markdown | 6 +- source/_docs/configuration/securing.markdown | 8 +- .../splitting_configuration.markdown | 12 +- .../_docs/configuration/templating.markdown | 34 +- .../configuration/troubleshooting.markdown | 12 +- source/_docs/configuration/yaml.markdown | 10 +- source/_docs/ecosystem/apache.markdown | 6 +- source/_docs/ecosystem/appdaemon/api.markdown | 712 +++++++++--------- .../ecosystem/appdaemon/running.markdown | 6 +- .../ecosystem/appdaemon/tutorial.markdown | 6 +- .../ecosystem/appdaemon/windows.markdown | 2 +- .../ecosystem/backup/backup_dropbox.markdown | 8 +- .../ecosystem/backup/backup_github.markdown | 18 +- .../ecosystem/backup/backup_usb.markdown | 12 +- source/_docs/ecosystem/caddy.markdown | 12 +- .../certificates/lets_encrypt.markdown | 20 +- .../tls_domain_certificate.markdown | 8 +- source/_docs/ecosystem/haproxy.markdown | 12 +- .../ecosystem/hass-configurator.markdown | 14 +- source/_docs/ecosystem/ios.markdown | 8 +- source/_docs/ecosystem/ios/location.markdown | 4 +- .../ios/notifications/actions.markdown | 12 +- .../ios/notifications/basic.markdown | 4 +- .../privacy_security_rate_limits.markdown | 6 +- .../ios/notifications/sounds.markdown | 4 +- source/_docs/ecosystem/nginx.markdown | 24 +- .../_docs/ecosystem/nginx_subdomain.markdown | 6 +- source/_docs/ecosystem/scenegen.markdown | 18 +- source/_docs/ecosystem/synology.markdown | 6 +- source/_docs/ecosystem/tor.markdown | 8 +- source/_docs/frontend/browsers.markdown | 10 +- source/_docs/frontend/mobile.markdown | 4 +- source/_docs/installation.markdown | 10 +- source/_docs/installation/centos.markdown | 6 +- source/_docs/installation/docker.markdown | 22 +- source/_docs/installation/hassbian.markdown | 2 +- .../hassbian/common-tasks.markdown | 16 +- .../hassbian/customization.markdown | 4 +- .../hassbian/installation.markdown | 16 +- .../hassbian/integrations.markdown | 8 +- .../installation/hassbian/upgrading.markdown | 2 +- .../_docs/installation/raspberry-pi.markdown | 10 +- .../installation/troubleshooting.markdown | 14 +- source/_docs/installation/updating.markdown | 8 +- source/_docs/installation/vagrant.markdown | 18 +- source/_docs/installation/virtualenv.markdown | 14 +- source/_docs/installation/windows.markdown | 6 +- source/_docs/mqtt.markdown | 2 +- source/_docs/mqtt/broker.markdown | 12 +- source/_docs/mqtt/discovery.markdown | 4 +- source/_docs/mqtt/service.markdown | 2 +- source/_docs/quality_scale.markdown | 10 +- source/_docs/scripts.markdown | 12 +- source/_docs/scripts/conditions.markdown | 26 +- source/_docs/scripts/editor.markdown | 2 +- source/_docs/scripts/service-calls.markdown | 12 +- source/_docs/security.markdown | 10 +- source/_docs/security/porosity.markdown | 6 +- source/_docs/tools/dev-tools.markdown | 12 +- source/_docs/z-wave.markdown | 10 +- source/_docs/z-wave/adding.markdown | 12 +- source/_docs/z-wave/control-panel.markdown | 20 +- source/_docs/z-wave/controllers.markdown | 10 +- source/_docs/z-wave/device-specific.markdown | 42 +- source/_docs/z-wave/devices.markdown | 18 +- source/_docs/z-wave/entities.markdown | 34 +- source/_docs/z-wave/events.markdown | 14 +- source/_docs/z-wave/installation.markdown | 36 +- source/_layouts/default.html | 7 +- source/_lovelace/alarm-panel.markdown | 2 +- source/_lovelace/conditional.markdown | 2 +- source/_lovelace/entities.markdown | 14 +- source/_lovelace/entity-button.markdown | 2 +- source/_lovelace/entity-filter.markdown | 2 +- source/_lovelace/gauge.markdown | 2 +- source/_lovelace/glance.markdown | 4 +- source/_lovelace/history-graph.markdown | 4 +- source/_lovelace/horizontal-stack.markdown | 2 +- source/_lovelace/iframe.markdown | 2 +- source/_lovelace/light.markdown | 2 +- source/_lovelace/map.markdown | 2 +- source/_lovelace/markdown.markdown | 2 +- source/_lovelace/media-control.markdown | 2 +- source/_lovelace/picture-elements.markdown | 32 +- source/_lovelace/picture-entity.markdown | 2 +- source/_lovelace/picture-glance.markdown | 4 +- source/_lovelace/picture.markdown | 2 +- source/_lovelace/plant-status.markdown | 2 +- source/_lovelace/sensor.markdown | 2 +- source/_lovelace/shopping-list.markdown | 2 +- source/_lovelace/thermostat.markdown | 2 +- source/_lovelace/vertical-stack.markdown | 2 +- source/_lovelace/weather-forecast.markdown | 2 +- ...015-05-09-utc-time-zone-awareness.markdown | 2 +- ...mped-ui-and-improved-distribution.markdown | 4 +- ...s-to-use-mqtt-with-home-assistant.markdown | 6 +- ...-09-13-home-assistant-meets-ifttt.markdown | 10 +- ...e-with-esp8266-and-report-to-mqtt.markdown | 12 +- ...tup-encryption-using-lets-encrypt.markdown | 8 +- ...016-01-19-perfect-home-automation.markdown | 10 +- ...9-insteon-lifx-twitter-and-zigbee.markdown | 2 +- ...lassifying-the-internet-of-things.markdown | 24 +- .../2016-02-20-community-highlights.markdown | 8 +- ...ng-presence-detection-work-better.markdown | 18 +- source/_posts/2016-05-21-release-020.markdown | 2 +- ...hat-cant-track-themselves-part-ii.markdown | 10 +- .../2016-06-01-community-highlights.markdown | 4 +- ...-home-hub-5-and-local-file-camera.markdown | 4 +- ...matic-hdmi-cec-and-sony-bravia-tv.markdown | 6 +- ...16-sqlalchemy-knx-join-simplisafe.markdown | 4 +- ...xploration-with-jupyter-notebooks.markdown | 8 +- ...anels--jupyter-notebooks--directv.markdown | 6 +- ...the-home-assistant-mobile-web-app.markdown | 26 +- ...3-foursquare-fast-com-ffmpeg-gpsd.markdown | 8 +- .../2016-08-16-we-have-apps-now.markdown | 8 +- ...otifications-hue-fake-unification.markdown | 38 +- ...-31-esp8266-and-micropython-part2.markdown | 2 +- ...10-notify-group-reload-api-pihole.markdown | 20 +- ...9-29-async-sleepiq-emoncms-stocks.markdown | 28 +- ...10-01-we-have-raspberry-image-now.markdown | 2 +- ...10-08-hassbian-rest-digital-ocean.markdown | 18 +- ...sh-briefing-updater-hacktoberfest.markdown | 22 +- ...2016-10-24-explaining-the-updater.markdown | 12 +- ...05-hacktoberfest-influxdb-weather.markdown | 24 +- ...ndar--wink-thermostats--cisco-ios.markdown | 14 +- ...16-12-03-remote-websockets-sonarr.markdown | 26 +- ...-text-to-speech-aquostv-flic-zamg.markdown | 18 +- ...17-01-14-iss-usps-images-packages.markdown | 20 +- ...7-01-21-home-assistant-governance.markdown | 28 +- .../2017-01-28-face-coffee-wink.markdown | 26 +- .../2017-02-03-hassbian-toybox.markdown | 6 +- source/_posts/2017-02-04-babyphone.markdown | 6 +- ...02-11-alert-appletv-mqtt-yeelight.markdown | 34 +- ...onfig-panel-and-state-restoration.markdown | 6 +- ...se-any-android-phone-as-ip-camera.markdown | 4 +- .../2017-03-28-http-to-mqtt-bridge.markdown | 8 +- .../2017-04-01-thomas-krenn-award.markdown | 2 +- ...s--lockitron-locks--total-connect.markdown | 8 +- ...fri-internet-of-things-done-right.markdown | 20 +- .../2017-04-22-ikea-tradfri--spotify.markdown | 10 +- ...4-30-hassbian-1.21-its-about-time.markdown | 4 +- .../2017-05-06-zigbee-opencv-dlib.markdown | 14 +- ...automation-editor-zwave-panel-ocr.markdown | 12 +- source/_posts/2017-06-04-release-46.markdown | 12 +- source/_posts/2017-06-17-release-47.markdown | 20 +- source/_posts/2017-07-02-release-48.markdown | 16 +- ...me-assistant-is-moving-to-discord.markdown | 22 +- source/_posts/2017-07-16-release-49.markdown | 16 +- .../2017-07-25-introducing-hassio.markdown | 12 +- source/_posts/2017-07-29-release-50.markdown | 22 +- source/_posts/2017-08-12-release-51.markdown | 20 +- .../_posts/2017-08-26-release-0-52.markdown | 6 +- source/_posts/2017-09-09-release-53.markdown | 20 +- ...6-hassbian-1.3-a-bit-of-a-stretch.markdown | 4 +- source/_posts/2017-09-23-release-54.markdown | 10 +- ...017-09-25-new-hassio-build-system.markdown | 4 +- source/_posts/2017-10-07-release-55.markdown | 22 +- source/_posts/2017-10-21-release-56.markdown | 22 +- source/_posts/2017-10-28-demo.markdown | 6 +- source/_posts/2017-11-04-release-57.markdown | 26 +- .../2017-11-05-frontend-translations.markdown | 2 +- .../_posts/2017-11-10-ttn-with-mqtt.markdown | 8 +- source/_posts/2017-11-12-tor.markdown | 8 +- source/_posts/2017-11-18-release-58.markdown | 18 +- source/_posts/2017-12-03-release-59.markdown | 24 +- ...-introducing-home-assistant-cloud.markdown | 22 +- source/_posts/2017-12-17-release-60.markdown | 20 +- source/_posts/2018-01-14-release-61.markdown | 18 +- source/_posts/2018-01-27-release-62.markdown | 6 +- source/_posts/2018-02-10-release-63.markdown | 20 +- source/_posts/2018-02-26-release-64.markdown | 26 +- source/_posts/2018-03-09-release-65.markdown | 32 +- source/_posts/2018-03-30-release-66.markdown | 6 +- source/_posts/2018-04-14-release-67.markdown | 12 +- source/_posts/2018-04-22-hassio-2018.markdown | 12 +- source/_posts/2018-04-27-release-68.markdown | 16 +- source/_posts/2018-05-11-release-69.markdown | 14 +- source/_posts/2018-05-18-release-70.markdown | 16 +- source/_posts/2018-06-04-esphomelib.markdown | 6 +- source/_posts/2018-06-10-release-71.markdown | 14 +- source/_posts/2018-06-22-release-72.markdown | 14 +- source/_posts/2018-07-06-release-73.markdown | 12 +- .../_posts/2018-07-11-hassio-images.markdown | 6 +- source/_posts/2018-07-21-release-74.markdown | 14 +- source/_posts/2018-08-03-release-75.markdown | 18 +- source/_posts/2018-08-17-release-76.markdown | 18 +- source/_posts/2018-08-29-release-77.markdown | 22 +- source/_posts/2018-09-15-release-78.markdown | 18 +- .../_posts/2018-09-17-thinking-big.markdown | 20 +- .../_posts/2018-09-30-hacktoberfest.markdown | 16 +- source/_posts/2018-10-01-release-79.markdown | 18 +- source/_posts/2018-10-12-release-80.markdown | 20 +- source/_posts/2018-10-29-release-81.markdown | 24 +- source/_posts/2018-11-08-release-82.markdown | 14 +- source/_posts/2018-11-28-release-83.markdown | 18 +- source/_posts/2018-12-12-release-84.markdown | 32 +- ...ogitech-harmony-removes-local-api.markdown | 2 +- source/_posts/2019-01-09-release-85.markdown | 14 +- .../2019-01-23-lovelace-released.markdown | 8 +- source/_posts/2019-01-23-release-86.markdown | 24 +- source/_posts/2019-02-06-release-87.markdown | 16 +- source/_posts/2019-02-20-release-88.markdown | 20 +- source/_posts/2019-03-13-release-89.markdown | 18 +- source/_posts/2019-03-20-release-90.markdown | 26 +- source/_posts/2019-04-03-release-91.markdown | 30 +- .../_posts/2019-04-15-hassio-ingress.markdown | 10 +- source/_posts/2019-04-24-release-92.markdown | 22 +- .../2019-05-03-update-from-the-field.markdown | 4 +- .../2019-05-08-nest-data-bye-bye.markdown | 2 +- source/_posts/2019-05-16-release-93.markdown | 22 +- source/_posts/2019-06-05-release-94.markdown | 30 +- source/_posts/2019-06-26-release-95.markdown | 34 +- source/addons/index.html | 4 +- source/code_of_conduct/index.markdown | 14 +- source/cookbook/index.markdown | 2 +- source/developers/credits.markdown | 4 +- source/faq/index.markdown | 4 +- source/getting-started/configuration.markdown | 2 +- source/getting-started/index.markdown | 6 +- .../presence-detection.markdown | 4 +- source/hassio/commandline.markdown | 12 +- source/hassio/enable_i2c.markdown | 8 +- source/hassio/index.markdown | 2 +- source/hassio/installation.markdown | 14 +- .../installing_third_party_addons.markdown | 2 +- source/hassio/zwave.markdown | 10 +- source/help/index.markdown | 8 +- source/help/reporting_issues.markdown | 16 +- source/help/trivia.markdown | 14 +- source/lovelace/changelog.markdown | 42 +- source/lovelace/index.markdown | 4 +- source/lovelace/views.markdown | 20 +- source/privacy/index.markdown | 20 +- source/tos/index.markdown | 36 +- 1002 files changed, 4820 insertions(+), 4801 deletions(-) delete mode 100644 plugins/no_follow.rb create mode 100644 plugins/output_modder.rb diff --git a/plugins/linkable_title.rb b/plugins/linkable_title.rb index 7a5ba4c2b0f..06e9c2bbaf9 100644 --- a/plugins/linkable_title.rb +++ b/plugins/linkable_title.rb @@ -1,16 +1,15 @@ -module Jekyll - class LinkableTitleTag < Liquid::Tag - def initialize(tag_name, text, token) - super - @title = text - end +module Jekyll + class LinkableTitleTag < Liquid::Tag + def initialize(tag_name, text, token) + super + @title = text + end - def render(context) - title = Liquid::Template.parse(@title).render context - slug = title.downcase.strip.gsub(' ', '-').gsub(/[^\w-]/, '') - " #{title}" - end - end -end + def render(context) + title = Liquid::Template.parse(@title).render context + "#{title}" + end + end +end -Liquid::Template.register_tag('linkable_title', Jekyll::LinkableTitleTag) + Liquid::Template.register_tag('linkable_title', Jekyll::LinkableTitleTag) \ No newline at end of file diff --git a/plugins/no_follow.rb b/plugins/no_follow.rb deleted file mode 100644 index 27da6c90f25..00000000000 --- a/plugins/no_follow.rb +++ /dev/null @@ -1,33 +0,0 @@ -# Jekyll Auto Nofollow Plugin -# Automatically adds rel='external nofollow' to outgoing links. - -require 'jekyll' -require 'nokogiri' - -module Jekyll - module NoFollow - def nofollow(content) - dom = Nokogiri::HTML.fragment(content) - - # Find all links - dom.css('a').each do |link| - rel = ['external', 'nofollow'] - - # All external links start with 'http', skip when this one does not - next unless link.get_attribute('href') =~ /\Ahttp/i - - # Play nice with our own links - next if link.get_attribute('href') =~ /\Ahttps?:\/\/\w*.?home-assistant.io/i - - # Play nice with links that already have a rel attribute set - rel.unshift(link.get_attribute('rel')) - - # Add rel attribute to link - link.set_attribute('rel', rel.join(' ').strip) - end - dom.to_s - end - end -end - -Liquid::Template.register_filter(Jekyll::NoFollow) diff --git a/plugins/output_modder.rb b/plugins/output_modder.rb new file mode 100644 index 00000000000..a515f9629f6 --- /dev/null +++ b/plugins/output_modder.rb @@ -0,0 +1,50 @@ +# Jekyll Out Modder - Allows for mangling/modding the HTML output +# +# This is combined in a single plugin/filter to reduce the NokoGiri dom +# parsing to just once per page/content. +# +# - Automatically adds rel='external nofollow' to outgoing links. +# - Automatically make headers linkable +# +require 'jekyll' +require 'nokogiri' + +module Jekyll + module OutputModder + def output_modder(content) + dom = Nokogiri::HTML.fragment(content) + + # Find all links, make all external links rel='external nofollow' + dom.css('a').each do |link| + rel = ['external', 'nofollow'] + + # All external links start with 'http', skip when this one does not + next unless link.get_attribute('href') =~ /\Ahttp/i + + # Play nice with our own links + next if link.get_attribute('href') =~ /\Ahttps?:\/\/\w*.?home-assistant.io/i + + # Play nice with links that already have a rel attribute set + rel.unshift(link.get_attribute('rel')) + + # Add rel attribute to link + link.set_attribute('rel', rel.join(' ').strip) + end + + # Find all headers, make them linkable + dom.css('h2,h3,h4,h5,h6,h7,h8').each do |header| + + # Skip linked headers + next if header.at_css('a') + + title = header.content + slug = title.downcase.strip.gsub(' ', '-').gsub(/[^\w-]/, '') + header.children = " #{title}" + end + + dom.to_s + end + end +end + +Liquid::Template.register_filter(Jekyll::OutputModder) diff --git a/sass/custom/_paulus.scss b/sass/custom/_paulus.scss index af314eff8b9..1281efeb3f1 100644 --- a/sass/custom/_paulus.scss +++ b/sass/custom/_paulus.scss @@ -210,7 +210,7 @@ dt:hover a.title-link { &::before { position: absolute; - top: 2px; + top: 5px; left: -25px; padding-right: 40px; font-family: "FontAwesome"; diff --git a/source/_addons/check_config.markdown b/source/_addons/check_config.markdown index 9ae856d22a3..350c2c4a6f3 100644 --- a/source/_addons/check_config.markdown +++ b/source/_addons/check_config.markdown @@ -11,7 +11,7 @@ footer: true You can use this add-on to check whether your configuration files are valid against the new version of Home Assistant before you actually update your Home Assistant installation. This add-on will help you avoid errors due to breaking changes, resulting in a smooth update. -### {% linkable_title How to use this add-on %} +### How to use this add-on 1. Just start the add-on. 2. Wait (On a Raspberry Pi it can take several minutes). @@ -19,7 +19,7 @@ You can use this add-on to check whether your configuration files are valid agai If you get errors, then you should look for **Breaking Changes** against the version you specified for this add-on and change your configuration accordingly. -### {% linkable_title Add-on configuration %} +### Add-on configuration ```json { diff --git a/source/_addons/configurator.markdown b/source/_addons/configurator.markdown index 42bf968290c..fbfb8cb1bb5 100644 --- a/source/_addons/configurator.markdown +++ b/source/_addons/configurator.markdown @@ -20,7 +20,7 @@ More information and a standalone version for regular Home Assistant installatio Screenshot of the HASS Configurator.

-### {% linkable_title Feature list %} +### Feature list - Web-based editor to modify your files with syntax highlighting and YAML linting. - Upload and download files. @@ -32,7 +32,7 @@ Screenshot of the HASS Configurator. - Editor settings are saved in your browser. - And much more... -### {% linkable_title Add-on Configuration %} +### Add-on Configuration ```json { @@ -54,6 +54,6 @@ enforce_basepath: default: false {% endconfiguration %} -### {% linkable_title Old port based Access %} +### Old port based Access You can set a network Port and the Add-on listens on that Port with Home Assistant user credential. That is as a backup if you are not able to connect to Home Assistant anymore. Today, you can restart Home Assistant with broken config, but maybe some times usefully. diff --git a/source/_addons/duckdns.markdown b/source/_addons/duckdns.markdown index 9a63a87dbd2..3bc8ec8fdcf 100644 --- a/source/_addons/duckdns.markdown +++ b/source/_addons/duckdns.markdown @@ -49,7 +49,7 @@ seconds: type: integer {% endconfiguration %} -## {% linkable_title Home Assistant configuration %} +## Home Assistant configuration Use the following configuration in Home Assistant to use the generated certificate: @@ -62,7 +62,7 @@ http: If you use a port other than `8123` or an SSL proxy, change the port number accordingly. -## {% linkable_title Router configuration %} +## Router configuration You'll need to forward the port you listed in your configuration (8123 in the example above) on your router to your Home Assistant system. You can find guides on how to do this on [Port Forward](https://portforward.com/). Noting that you'll only need to forward the TCP port. @@ -70,7 +70,7 @@ Ensure that you allocate the Home Assistant system a fixed IP on your network be Restart Home Assistant for the configured changes to take effect. When you access the Home Assistant frontend you will now need to use `https`, even when accessing local instances, for example at `https://192.168.0.1:8123`. -## {% linkable_title Generate Let's Encrypt certificate for Duck DNS sub sub domains %} +## Generate Let's Encrypt certificate for Duck DNS sub sub domains To generate certificates for nr.my-domain.duckdns.org update the domain JSON settings to: diff --git a/source/_addons/google_assistant.markdown b/source/_addons/google_assistant.markdown index 9bb978212fe..367161be274 100644 --- a/source/_addons/google_assistant.markdown +++ b/source/_addons/google_assistant.markdown @@ -79,7 +79,7 @@ speaker: type: string {% endconfiguration %} -### {% linkable_title Home Assistant configuration %} +### Home Assistant configuration Use the Home Assistant [DialogFlow component][comp] to integrate the add-on into Home Assistant. diff --git a/source/_addons/homematic.markdown b/source/_addons/homematic.markdown index b3b23f25d3c..41bd7352253 100644 --- a/source/_addons/homematic.markdown +++ b/source/_addons/homematic.markdown @@ -103,7 +103,7 @@ hmip: type: string {% endconfiguration %} -## {% linkable_title Home Assistant configuration %} +## Home Assistant configuration Use the following configuration in Home Assistant to use it: @@ -121,7 +121,7 @@ homematic: port: 2010 ``` -## {% linkable_title Raspberry Pi3 %} +## Raspberry Pi3 With HM-MOD-RPI-PCB you need to add follow into your `config.txt` on boot partition: @@ -129,6 +129,6 @@ With HM-MOD-RPI-PCB you need to add follow into your `config.txt` on boot partit dtoverlay=pi3-miniuart-bt ``` -## {% linkable_title HmIP-RFUSB %} +## HmIP-RFUSB HassOS > 1.11 support HmIP-RFUSB default and don't need any configuration. If you run a Linux, you need to follow the installation guide from documentation to set up the UART USB interface on your computer. diff --git a/source/_addons/lets_encrypt.markdown b/source/_addons/lets_encrypt.markdown index ae9cbb36811..ef3bfd86f5b 100644 --- a/source/_addons/lets_encrypt.markdown +++ b/source/_addons/lets_encrypt.markdown @@ -45,7 +45,7 @@ keyfile: default: privkey.pem {% endconfiguration %} -## {% linkable_title Home Assistant configuration %} +## Home Assistant configuration Use the following configuration in Home Assistant to use the generated certificate: @@ -58,7 +58,7 @@ http: If you use another port such as `8123` or an SSL proxy, change the port number. -## {% linkable_title Enabling auto-renewals %} +## Enabling auto-renewals Out of the box, the add-on will not automatically renew your certificate. In fact, it only starts, tries to get/renew your certificate, and then stops. It's up to you to manually start it again whenever your certificate comes close to expiry. diff --git a/source/_addons/mariadb.markdown b/source/_addons/mariadb.markdown index 1ff9d87095b..c53bb4a5dd1 100644 --- a/source/_addons/mariadb.markdown +++ b/source/_addons/mariadb.markdown @@ -77,7 +77,7 @@ rights: type: string {% endconfiguration %} -## {% linkable_title Home Assistant configuration %} +## Home Assistant configuration Use the following configuration in Home Assistant to use the database above: diff --git a/source/_addons/mosquitto.markdown b/source/_addons/mosquitto.markdown index f8cb8748fa5..06ff1adbc5c 100644 --- a/source/_addons/mosquitto.markdown +++ b/source/_addons/mosquitto.markdown @@ -47,15 +47,15 @@ customize: type: [boolean, string] {% endconfiguration %} -### {% linkable_title Home Assistant user management %} +### Home Assistant user management This add-on is attached to the Home Assistant user system, so mqtt clients can make use of these credentials. Local users may also still be set independently within the configuration options for the add-on. For the internal Hass.io ecosystem we register `homeassistant` and `addons`, so these may not be used as user names. -### {% linkable_title Home Assistant configuration %} +### Home Assistant configuration To use the Mosquitto as [broker](/docs/mqtt/broker/#run-your-own), go to the integration page and install the configuration with one click. If you have old MQTT settings available, remove this old integration and restart Home Assistant to see the new one. -#### {% linkable_title Using Mosquitto with Hass.io %} +#### Using Mosquitto with Hass.io 1. Install the [Mosquitto add-on](/addons/mosquitto/) with the default configuration via 'Hass.io > ADD-ON STORE'. (Don't forget to start the add-on & verify that 'Start on boot' is enabled.) @@ -73,11 +73,11 @@ To use the Mosquitto as [broker](/docs/mqtt/broker/#run-your-own), go to the int Note: .yaml modifications are not required. See [testing your setup](/docs/mqtt/testing/) to verify the steps above. -### {% linkable_title Disable listening on insecure (1883) ports %} +### Disable listening on insecure (1883) ports Remove the ports from the add-on page network card (set them as blank) to disable them. -### {% linkable_title Access Control Lists (ACLs) %} +### Access Control Lists (ACLs) It is possible to restrict access to topics based upon the user logged in to Mosquitto. In this scenario it is recommended to create individual users for each of your clients and create an appropriate ACL. diff --git a/source/_addons/rpc_shutdown.markdown b/source/_addons/rpc_shutdown.markdown index a7647690562..67bcf773cad 100644 --- a/source/_addons/rpc_shutdown.markdown +++ b/source/_addons/rpc_shutdown.markdown @@ -33,7 +33,7 @@ Allows you to shut down a Windows computer with a service call from Home Assista - **computers/address** (*Required*): IP address or NetBIOS name of the computer for the shutdown. - **computers/credentials** (*Required*): Credentials for logging into computer. Use a `%` as the delimiter of username and password. -### {% linkable_title Home Assistant configuration %} +### Home Assistant configuration Use the following inside Home Assistant service call to use it: diff --git a/source/_addons/snips.markdown b/source/_addons/snips.markdown index 08887b5c76b..3a7d14681dd 100644 --- a/source/_addons/snips.markdown +++ b/source/_addons/snips.markdown @@ -33,7 +33,7 @@ Now install and activate the [Samba](/addons/samba/) add-on so you can upload yo Now it's time to start Snips for the first time. You can configure the microphone and sound card using the Add-on interface. Now start the add-on. -### {% linkable_title Add-On configuration %} +### Add-On configuration ```json { @@ -66,7 +66,7 @@ tts_platform: type: string {% endconfiguration %} -### {% linkable_title Home Assistant configuration %} +### Home Assistant configuration A simple configuration just requires this. Consult [Snips.ai integration](/components/snips/) for more options. @@ -74,11 +74,11 @@ A simple configuration just requires this. Consult [Snips.ai integration](/compo snips: ``` -### {% linkable_title Home Assistant configuration %} +### Home Assistant configuration There is an active [discord](https://discordapp.com/invite/3939Kqx) channel for further support. -### {% linkable_title Examples %} +### Examples So now you can turn lights on and off, let's check the weather. Log on to the [console](https://console.snips.ai/). If this is your first time, create a new assistant and add the Home Assistant skill, along with the Weather skill by snips. Download your assistant manually and copy it to the `/share` folder on your HassIO installation using the Samba add-on. diff --git a/source/_addons/tellstick.markdown b/source/_addons/tellstick.markdown index 42729674b4d..f1e8f19f82c 100644 --- a/source/_addons/tellstick.markdown +++ b/source/_addons/tellstick.markdown @@ -29,7 +29,7 @@ To add [lights](/components/light.tellstick/), [sensors](/components/sensor.tell The add-on will also enable you to interact with the `tdtool` via a Home Assistant services call, see example below for self-learning device. -## {% linkable_title Examples %} +## Examples Example for adding more devices in the add-on configuration (note the comma separator between devices): @@ -93,7 +93,7 @@ code: For more information about the configuration including protocols, see the [telldus documentation](https://developer.telldus.com/wiki/TellStick_conf). -## {% linkable_title Service calls %} +## Service calls If you wish to teach a self-learning device in your TellStick configuration: @@ -108,7 +108,7 @@ Replace `1` with the corresponding ID of the device in your TellStick configurat You can also use this to list devices or sensors and read the output in the add-on log: `{"addon":"core_tellstick","input":{"function":"list-sensors"}}` -### {% linkable_title Supported service commands %} +### Supported service commands - `"function":"list"`: List currently configured devices with name and device id and all discovered sensors. diff --git a/source/_components/abode.markdown b/source/_components/abode.markdown index b52572af492..89172186e9a 100644 --- a/source/_components/abode.markdown +++ b/source/_components/abode.markdown @@ -46,7 +46,7 @@ There is currently support for the following device types within Home Assistant: - [**Switch**](/components/abode/#switch): Reports on `Power Switch` devices and can be used to turn the power switch on and off. Also reports on `Automations` set up in the Abode system and allows you to activate or deactivate them. - **Sensor**: Reports on `Temperature`, `Humidity`, and `Light` sensors. -## {% linkable_title Configuration %} +## Configuration To use Abode devices in your installation, add the following `abode` section to your `configuration.yaml` file: @@ -99,7 +99,7 @@ lights: type: list {% endconfiguration %} -## {% linkable_title Events %} +## Events There are a number of events that can be triggered from Abode. They are grouped into the below events: @@ -128,9 +128,9 @@ Field | Description There is a unique list of known event_codes that can be found [here](https://github.com/MisterWil/abodepy/files/1262019/timeline_events.txt). -## {% linkable_title Services %} +## Services -### {% linkable_title Service `change_setting` %} +### Service `change_setting` Change settings on your Abode system. For a full list of settings and valid values, consult the @@ -141,7 +141,7 @@ For a full list of settings and valid values, consult the | `setting` | No | The setting you wish to change. | `value` | No | The value you wish to change the setting to. -### {% linkable_title Service `capture_image` %} +### Service `capture_image` Request a new still image from your Abode IR camera. @@ -149,7 +149,7 @@ Request a new still image from your Abode IR camera. | ---------------------- | -------- | ----------- | | `entity_id` | No | String or list of strings that point at `entity_id`s of Abode cameras. -### {% linkable_title Service `trigger_quick_action` %} +### Service `trigger_quick_action` Trigger a quick action automation on your Abode system. @@ -157,17 +157,17 @@ Trigger a quick action automation on your Abode system. | ---------------------- | -------- | ----------- | | `entity_id` | No | String or list of strings that point at `entity_id`s of binary_sensors that represent your Abode quick actions. -### {% linkable_title Binary Sensor %} +### Binary Sensor This integration will add `Door Contacts`, `Connectivity` sensors (remotes, keypads, and status indicators), `Moisture` sensors, and `Motion` or `Occupancy` sensors. This integration will also list all Abode `Quick Actions` that are set up. You can trigger these quick actions by passing the `entity_id` of your quick action binary sensor to the [trigger_quick_action service](/components/abode/#trigger_quick_action). -### {% linkable_title Light %} +### Light This integration will automatically add `Lights` configured in your Abode account. You can reclassify `Switches` to show up within Home Assistant as lights by listing the Abode device ID in your [configuration](/components/abode/#configuration). -### {% linkable_title Switch %} +### Switch This integration will automatically add `Power Switches` configured in your Abode account. You can reclassify switches to show up within Home Assistant as `Lights` by listing the Abode device ID in your [configuration](/components/abode/#configuration). diff --git a/source/_components/acer_projector.markdown b/source/_components/acer_projector.markdown index f057915f22d..c791e349ada 100644 --- a/source/_components/acer_projector.markdown +++ b/source/_components/acer_projector.markdown @@ -18,7 +18,7 @@ redirect_from: The `acer_projector` switch platform allows you to control the state of RS232 connected projectors from [Acer](http://www.acer.com). -## {% linkable_title Configuration %} +## Configuration To use your Acer Projector in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/adguard.markdown b/source/_components/adguard.markdown index 298351a35de..5d17644798d 100644 --- a/source/_components/adguard.markdown +++ b/source/_components/adguard.markdown @@ -20,7 +20,7 @@ AdGuard Home is a network-wide ad-and-tracker blocking DNS server with parental control (adult content blocking) capabilities. The `adguard` integration allows you to control and monitor your AdGuard Home instance in Home Assistant. -## {% linkable_title Configuration via the frontend %} +## Configuration via the frontend Menu: **Configuration** -> **Integrations**. @@ -28,7 +28,7 @@ Click on the `+` sign to add an integration and click on **AdGuard Home**. Follow the configuration flow, after finishing, the AdGuard Home integration will be available. -## {% linkable_title Sensors %} +## Sensors This integration provides sensors for the following information from AdGuard Home: @@ -41,7 +41,7 @@ This integration provides sensors for the following information from AdGuard Hom - Total number of active filter rules loaded. - Average response time of AdGuard's DNS server in milliseconds. -## {% linkable_title Switches %} +## Switches The integration will create a number of switches: @@ -63,7 +63,7 @@ Turning off Query Log will result in all sensors not receiving updates anymore. AdGuard relies on Query Log to provide stats.

-## {% linkable_title Services %} +## Services These services allow one to manage filter subscriptions in AdGuard Home. Using these services in automations could be helpful to block certain @@ -72,7 +72,7 @@ sites/domains at certain times. For example, you could create a custom filter list blocking social media sites, during the day and release them during the evening, using a simple automation. -### {% linkable_title Service `add_url` %} +### Service `add_url` Add a new filter subscription to AdGuard Home. @@ -81,7 +81,7 @@ Add a new filter subscription to AdGuard Home. | `name` | No | The name of the filter subscription. | | `url` | No | The filter URL to subscribe to, containing the filter rules. | -### {% linkable_title Service `remove_url` %} +### Service `remove_url` Removes a filter subscription from AdGuard Home. @@ -89,7 +89,7 @@ Removes a filter subscription from AdGuard Home. | ---------------------- | -------- | -------------------------------------- | | `url` | No | The filter subscription URL to remove. | -### {% linkable_title Service `enable_url` %} +### Service `enable_url` Enables a filter subscription in AdGuard Home. @@ -97,7 +97,7 @@ Enables a filter subscription in AdGuard Home. | ---------------------- | -------- | -------------------------------------- | | `url` | No | The filter subscription URL to enable. | -### {% linkable_title Service `disable_url` %} +### Service `disable_url` Disables a filter subscription in AdGuard Home. @@ -105,7 +105,7 @@ Disables a filter subscription in AdGuard Home. | ---------------------- | -------- | --------------------------------------- | | `url` | No | The filter subscription URL to disable. | -### {% linkable_title Service `refresh` %} +### Service `refresh` Refresh all filter subscriptions in AdGuard Home. diff --git a/source/_components/ads.markdown b/source/_components/ads.markdown index 7dcbf645f14..d91b221761f 100644 --- a/source/_components/ads.markdown +++ b/source/_components/ads.markdown @@ -34,7 +34,7 @@ There is currently support for the following device types within Home Assistant: - [Switch](#switch) - [Cover](#cover) -## {% linkable_title Configuration %} +## Configuration To enable ADS, add the following lines to your `configuration.yaml` file: @@ -60,7 +60,7 @@ ip_address: type: string {% endconfiguration %} -## {% linkable_title Service %} +## Service The ADS integration will register the service `write_by_name` allowing you to write a value to a variable on your ADS device. @@ -78,7 +78,7 @@ Service parameters: - **adstype**: Specify the type of the variable. Use one of the following: `int`, `byte`, `uint`, `bool` - **value**: The value that will be written in the variable. -## {% linkable_title Binary Sensor %} +## Binary Sensor The `ads` binary sensor platform can be used to monitor a boolean value on your ADS device. @@ -107,7 +107,7 @@ device_class: type: string {% endconfiguration %} -## {% linkable_title Light %} +## Light The `ads` light platform allows you to control your connecte ADS lights. @@ -137,7 +137,7 @@ name: type: string {% endconfiguration %} -## {% linkable_title Sensor %} +## Sensor The `ads` sensor platform allows reading the value of a numeric variable on your ADS device. The variable can be of type *INT*, *UINT*, *BYTE*, *DINT* or *UDINT*. @@ -176,7 +176,7 @@ factor: The *factor* can be used to implement fixed decimals. E.g., set *factor* to 100 if you want to display a fixed decimal value with two decimals. A variable value of `123` will be displayed as `1.23`. -## {% linkable_title Switch %} +## Switch The `ads` switch platform accesses a boolean variable on the connected ADS device. The variable is identified by its name. @@ -201,7 +201,7 @@ name: type: string {% endconfiguration %} -## {% linkable_title Cover %} +## Cover The `ads` cover platform allows you to control your connected ADS covers. diff --git a/source/_components/aftership.markdown b/source/_components/aftership.markdown index 5991851acd6..b4a40fd554c 100644 --- a/source/_components/aftership.markdown +++ b/source/_components/aftership.markdown @@ -20,7 +20,7 @@ The `aftership` platform allows one to track deliveries by [AfterShip](https://w The sensor value shows the number of packages that are not in `Delivered` state. As attributes are the number of packages per status. -## {% linkable_title Setup %} +## Setup To use this sensor, you need an [AfterShip Account](https://accounts.aftership.com/register) and set up an API Key. To set up an API Key go to [AfterShip API](https://secure.aftership.com/#/settings/api) page, and copy existing key or generate a new one. @@ -28,7 +28,7 @@ To use this sensor, you need an [AfterShip Account](https://accounts.aftership.c AfterShip recently started requiring having a credit card on file even if you are only using the free plan. That does not change the functionality of the platform, just something to be aware of.

-## {% linkable_title Configuration %} +## Configuration To enable this sensor, add the following lines to your `configuration.yaml`: @@ -50,7 +50,7 @@ api_key: type: string {% endconfiguration %} -## {% linkable_title Service `add_tracking` %} +## Service `add_tracking` You can use the service `aftership.add_tracking` to add trackings to Aftership. @@ -60,7 +60,7 @@ api_key: | `slug` | `False` | string | Carrier e.g. `fedex` | `title` | `False` | string | Friendly name of package -## {% linkable_title Service `remove_tracking` %} +## Service `remove_tracking` You can use the service `aftership.remove_tracking` to remove trackings from Aftership. diff --git a/source/_components/airvisual.markdown b/source/_components/airvisual.markdown index cc23835a5d5..b8b0eebdf5e 100644 --- a/source/_components/airvisual.markdown +++ b/source/_components/airvisual.markdown @@ -26,7 +26,7 @@ The Community API key is valid for 12 months after which it will expire. You mus The "Community" API key is limited to 10,000 calls per month. In order to leave a buffer, the `airvisual` platform queries the API every 10 minutes (600 seconds) by default. Modification of this (via the `scan_interval` key) to a too-low value may result in your API key being deactivated.

-## {% linkable_title Configuration %} +## Configuration To enable the platform and gather data via latitude/longitude, add the following lines to your `configuration.yaml` file: @@ -80,7 +80,7 @@ country: type: string {% endconfiguration %} -## {% linkable_title Example Configurations %} +## Example Configurations Configuration using custom Latitude and Longitude: @@ -111,7 +111,7 @@ sensor: country: USA ``` -## {% linkable_title Determining the City/State/Country %} +## Determining the City/State/Country To easily determine the proper values for a particular location, use the [AirVisual region directory](https://airvisual.com/world). Once you browse to the particular city you want, take note of the breadcrumb title, which is of the form `country > state/region > city`. Use this information to fill out `configuration.yaml`. @@ -129,7 +129,7 @@ sensor: country: brazil ``` -## {% linkable_title Sensor Types %} +## Sensor Types When configured, the platform will create three sensors for each configured air quality standard: diff --git a/source/_components/aladdin_connect.markdown b/source/_components/aladdin_connect.markdown index cdf2ecfa394..e421dca78bb 100644 --- a/source/_components/aladdin_connect.markdown +++ b/source/_components/aladdin_connect.markdown @@ -22,7 +22,7 @@ The `aladdin_connect` cover platform lets you control Genie Aladdin Connect gara Only doors that are owned by your Aladdin Connect account will be available. Doors that your account has been granted shared access to are not yet supported.

-## {% linkable_title Configuration %} +## Configuration To use your Aladdin Connect cover in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/alarm_control_panel.ifttt.markdown b/source/_components/alarm_control_panel.ifttt.markdown index 3e7d4ebf81f..445cbb0f5d3 100644 --- a/source/_components/alarm_control_panel.ifttt.markdown +++ b/source/_components/alarm_control_panel.ifttt.markdown @@ -21,7 +21,7 @@ This platform depends on the [IFTTT](/components/ifttt/) Home Assistant integrat It is important to note that this platform fully relies on IFTTT to receive updates when the security system's state changes. Therefore, this platform shows an assumed state.

-## {% linkable_title Configuration %} +## Configuration To enable this, add the following lines to your `configuration.yaml` file: @@ -80,7 +80,7 @@ optimistic: It is strongly discouraged to use this platform when you don't use encryption; otherwise, your API password will be send unprotected through the IFTTT Webhooks. It is advised to [setup encryption using Let's Encrypt](https://home-assistant.io/blog/2017/09/27/effortless-encryption-with-lets-encrypt-and-duckdns/).

-### {% linkable_title Required IFTTT applets %} +### Required IFTTT applets Next, you will need to set up the required IFTTT applets as listed below. diff --git a/source/_components/alarm_control_panel.mqtt.markdown b/source/_components/alarm_control_panel.mqtt.markdown index b32ef6da3ce..4948f151cdb 100644 --- a/source/_components/alarm_control_panel.mqtt.markdown +++ b/source/_components/alarm_control_panel.mqtt.markdown @@ -27,7 +27,7 @@ The integration will accept the following states from your Alarm Panel (in lower The integration can control your Alarm Panel by publishing to the `command_topic` when a user interacts with the Home Assistant frontend. -## {% linkable_title Configuration %} +## Configuration To enable this platform, add the following lines to your `configuration.yaml`: diff --git a/source/_components/alarmdecoder.markdown b/source/_components/alarmdecoder.markdown index d9ed822f076..d2c9ea1b50e 100644 --- a/source/_components/alarmdecoder.markdown +++ b/source/_components/alarmdecoder.markdown @@ -32,7 +32,7 @@ There is currently support for the following device types within Home Assistant: This is a fully event-based component. Any event sent by the AlarmDecoder device will be immediately reflected within Home Assistant. -## {% linkable_title Configuration %} +## Configuration An `alarmdecoder` section must be present in the `configuration.yaml` file and contain the following options as required: @@ -122,7 +122,7 @@ zones: type: integer {% endconfiguration %} -## {% linkable_title Alarm Control Panel %} +## Alarm Control Panel There are several attributes available on the alarm panel to give you more information about your alarm. @@ -136,7 +136,7 @@ There are several attributes available on the alarm panel to give you more infor - `ready`: Set to `true` if your system is ready to be armed. Any faults, including motions sensors, will make this value `false`. - `zone_bypassed`: Set to `true` if your system is currently bypassing a zone. -## {% linkable_title Services %} +## Services The Alarm Decoder integration gives you access to several services for you to control your alarm with. @@ -150,11 +150,11 @@ The Alarm Decoder integration gives you access to several services for you to co `alarm_arm_custom_bypass` and `alarm_trigger`, while available in the services list in Home Assistant, are not currently implemented in the Alarm Decoder platform.

-### {% linkable_title Examples %} +### Examples Using a combination of the available services and attributes, you can create switch templates. -### {% linkable_title Chime Status and Control %} +### Chime Status and Control {% raw %} ```yaml diff --git a/source/_components/alarmdotcom.markdown b/source/_components/alarmdotcom.markdown index a7e0cfb2064..423660da8a0 100644 --- a/source/_components/alarmdotcom.markdown +++ b/source/_components/alarmdotcom.markdown @@ -17,7 +17,7 @@ redirect_from: The `alarmdotcom` platform is consuming the information provided by [Alarm.com](https://www.alarm.com/). -## {% linkable_title Configuration %} +## Configuration To enable this, add the following lines to your `configuration.yaml`: diff --git a/source/_components/alert.markdown b/source/_components/alert.markdown index 6b7eb22d442..33abf381f06 100644 --- a/source/_components/alert.markdown +++ b/source/_components/alert.markdown @@ -23,7 +23,7 @@ water leak sensors, or any condition that may need your attention. Alerts will add an entity to the front end only when they are firing. This entity allows you to silence an alert until it is resolved. -### {% linkable_title Basic Example %} +### Basic Example The `alert` integration makes use of any of the `notifications` integrations. To setup the `alert` integration, first, you must setup a `notification` integration. @@ -143,7 +143,7 @@ alert: - john_phone_sms ``` -### {% linkable_title Complex Alert Criteria %} +### Complex Alert Criteria By design, the `alert` integration only handles very simple criteria for firing. That is, it only checks if a single entity's state is equal to a value. At some @@ -177,7 +177,7 @@ This example will begin firing as soon as the entity `sensor.motion`'s `battery` attribute falls below 15. It will continue to fire until the battery attribute raises above 15 or the alert is acknowledged on the frontend. -### {% linkable_title Dynamic Notification Delay Times %} +### Dynamic Notification Delay Times It may be desirable to have the delays between alert notifications dynamically change as the alert continues to fire. This can be done by setting the `repeat` @@ -208,7 +208,7 @@ following notification. For example, if the garage door opens at 2:00, a notification will be sent at 2:15, 2:45, 3:45, 4:45, etc., continuing every 60 minutes. -### {% linkable_title Message Templates %} +### Message Templates It may be desirable to have the alert notifications include information about the state of the entity. [Templates](/docs/configuration/templating/) @@ -237,7 +237,7 @@ alert: The resulting message could be `Plant Officeplant needs help (moisture low)`. -### {% linkable_title Additional parameters for notifiers %} +### Additional parameters for notifiers Some notifiers support more parameters (e.g., to set text color or action buttons). These can be supplied via the `data` parameter: diff --git a/source/_components/alexa.flash_briefings.markdown b/source/_components/alexa.flash_briefings.markdown index d487946db2d..d6a158ad0b1 100644 --- a/source/_components/alexa.flash_briefings.markdown +++ b/source/_components/alexa.flash_briefings.markdown @@ -14,11 +14,11 @@ featured: false ha_release: "0.31" --- -## {% linkable_title Flash Briefing Skills %} +## Flash Briefing Skills As of version [0.31][zero-three-one] Home Assistant supports the new [Alexa Flash Briefing Skills API][flash-briefing-api]. A Flash Briefing Skill adds a new Flash Briefing source that is generated by Home Assistant. -### {% linkable_title Requirements %} +### Requirements Amazon requires the endpoint of a skill to be hosted via SSL. Self-signed certificates are OK because our skills will only run in development mode. Read more on [our blog][blog-lets-encrypt] about how to set up encryption for Home Assistant. When running Hass.io, using the [Let's Encrypt](/addons/lets_encrypt/) and [Duck DNS](/addons/duckdns/) add-ons is the easiest method. If you are unable to get HTTPS up and running, consider using [this AWS Lambda proxy for Alexa skills](https://community.home-assistant.io/t/aws-lambda-proxy-custom-alexa-skill-when-you-dont-have-https/5230). @@ -30,7 +30,7 @@ Additionally, note that at the time of this writing, your Alexa skill endpoint * [blog-lets-encrypt]: /blog/2015/12/13/setup-encryption-using-lets-encrypt/ -### {% linkable_title Configuring a Flash Briefing skill in Home Assistant %} +### Configuring a Flash Briefing skill in Home Assistant You can use [templates] for the `title`, `audio`, `text` and `display_url` configuration parameters. @@ -56,7 +56,7 @@ You can add multiple items for a feed if you want. The Amazon required UID and t Please refer to the [Amazon documentation][flash-briefing-api-docs] for more information about allowed configuration parameters and formats. -### {% linkable_title Configuring your Flash Briefing skill %} +### Configuring your Flash Briefing skill - Log in to [Amazon developer console][amazon-dev-console] - Click the Alexa navigation tab at the top of the console diff --git a/source/_components/alexa.intent.markdown b/source/_components/alexa.intent.markdown index 925d33f8f53..5e1dc0db34c 100644 --- a/source/_components/alexa.intent.markdown +++ b/source/_components/alexa.intent.markdown @@ -14,7 +14,7 @@ featured: false ha_release: "0.10" --- -## {% linkable_title I want to build custom commands to use with Echo %} +## I want to build custom commands to use with Echo The built-in Alexa integration allows you to integrate Home Assistant into Alexa/Amazon Echo. This integration will allow you to query information and call services within Home Assistant by using your voice. Home Assistant offers no built-in sentences but offers a framework for you to define your own. @@ -22,7 +22,7 @@ The built-in Alexa integration allows you to integrate Home Assistant into Alexa
-### {% linkable_title Requirements %} +### Requirements Amazon requires the endpoint of a skill to be hosted via SSL. Self-signed certificates are OK because our skills will only run in development mode. Read more on [our blog][blog-lets-encrypt] about how to set up encryption for Home Assistant. When running Hass.io, using the [Let's Encrypt](/addons/lets_encrypt/) and [Duck DNS](/addons/duckdns/) add-ons is the easiest method. If you are unable to get HTTPS up and running, consider using [this AWS Lambda proxy for Alexa skills](https://community.home-assistant.io/t/aws-lambda-proxy-custom-alexa-skill-when-you-dont-have-https/5230). @@ -49,7 +49,7 @@ To get started with Alexa skills: You can use this [specially sized Home Assistant logo][large-icon] as the large icon and [this one][small-icon] as the small one. -### {% linkable_title Configuring your Amazon Alexa skill %} +### Configuring your Amazon Alexa skill Alexa works based on intents. Each intent has a name and variable slots. For example, a `LocateIntent` with a slot that contains a `User`. Example intent schema: @@ -88,7 +88,7 @@ This means that we can now ask Alexa things like: - Alexa, ask Home Assistant where Paul is - Alexa, ask Home Assistant where we are -## {% linkable_title Configuring Home Assistant %} +## Configuring Home Assistant When activated, the Alexa integration will have Home Assistant's native intent support handle the incoming intents. If you want to run actions based on intents, use the [`intent_script`](/components/intent_script) integration. @@ -98,7 +98,7 @@ To enable Alexa, add the following entry to your `configuration.yaml` file: alexa: ``` -### {% linkable_title Working With Scenes %} +### Working With Scenes One of the most useful applications of Alexa integrations is to call scenes directly. This is easily achieved with some simple setup on the Home Assistant side and by letting Alexa know which scenes you want to run. @@ -157,7 +157,7 @@ Here we are using [templates] to take the name we gave to Alexa e.g., `downstair Now say `Alexa ask Home Assistant to activate ` and Alexa will activate that scene for you. -### {% linkable_title Adding Scripts %} +### Adding Scripts We can easily extend the above idea to work with scripts as well. As before, add an intent for scripts: @@ -203,7 +203,7 @@ intent_script: Now say `Alexa ask Home Assistant to run ` and Alexa will run that script for you. -### {% linkable_title Support for Launch Requests %} +### Support for Launch Requests There may be times when you want to respond to a launch request initiated from a command such as "Alexa, Red Alert!". @@ -227,7 +227,7 @@ intent_script: text: OK ``` -## {% linkable_title Giving Alexa Some Personality %} +## Giving Alexa Some Personality In the examples above, we told Alexa to say `OK` when she successfully completed the task. This is effective but a little dull! We can again use [templates] to spice things up a little. diff --git a/source/_components/alexa.markdown b/source/_components/alexa.markdown index 7a7df1f7a9c..a46dbe6b2c7 100644 --- a/source/_components/alexa.markdown +++ b/source/_components/alexa.markdown @@ -14,13 +14,13 @@ featured: true ha_release: "0.10" --- -## {% linkable_title Automatic setup via Home Assistant Cloud %} +## Automatic setup via Home Assistant Cloud With [Home Assistant Cloud](/cloud/), you can connect your Home Assistant instance in a few simple clicks to Amazon Alexa. With Home Assistant Cloud you don't have to deal with dynamic DNS, SSL certificates or opening ports on your router. Just log in via the user interface and a secure connection with the cloud will be established. Home Assistant Cloud requires a paid subscription after a 30-day free trial. For Home Assistant Cloud Users, documentation can be found [here](https://www.nabucasa.com/config/amazon_alexa/). -## {% linkable_title Manual setup %} +## Manual setup There are a few ways that you can use Amazon Alexa and Home Assistant together. @@ -29,7 +29,7 @@ There are a few ways that you can use Amazon Alexa and Home Assistant together. - [Use the Smart Home API to control lights, etc](/components/alexa.smart_home/) - Alternative: use the [Emulated Hue integration][emulated-hue-component] to trick Alexa to thinking Home Assistant is a Philips Hue hub. -### {% linkable_title Requirements %} +### Requirements Manual setup the integration with Amazon Alexa needs several requirements diff --git a/source/_components/alexa.smart_home.markdown b/source/_components/alexa.smart_home.markdown index d5f3e819b07..ea7cc328e8d 100644 --- a/source/_components/alexa.smart_home.markdown +++ b/source/_components/alexa.smart_home.markdown @@ -14,7 +14,7 @@ featured: false ha_release: "0.54" --- -## {% linkable_title Amazon Alexa Smart Home %} +## Amazon Alexa Smart Home While the Skills API described above allows for arbitrary intents, all utterances must begin with "Alexa, tell $invocation_name ..." @@ -38,13 +38,13 @@ With [Home Assistant Cloud](/cloud/), you can connect your Home Assistant instan For Home Assistant Cloud Users, documentation can be found [here](https://www.nabucasa.com/config/amazon_alexa/).

-### {% linkable_title Requirements %} +### Requirements - Amazon Developer Account. You can sign on [here](https://developer.amazon.com). - An [AWS account](https://aws.amazon.com/free/) is need if you want to use Smart Home Skill API. Part of your Smart Home Skill will be hosted on [AWS Lambda](https://aws.amazon.com/lambda/pricing/). However you don't need worry the cost, AWS Lambda allow free to use up to 1 millions requests and 1GB outbound data transfer per month. - Smart Home API also needs your Home Assistant instance can be accessed from Internet. We strongly suggest you host HTTPS server and use validation certificate. Read more on [our blog](/blog/2015/12/13/setup-encryption-using-lets-encrypt/) about how to set up encryption for Home Assistant. When running Hass.io, using the [Let's Encrypt](/addons/lets_encrypt/) and [Duck DNS](/addons/duckdns/) add-ons is the easiest method. -### {% linkable_title Create Your Amazon Alexa Smart Home Skill %} +### Create Your Amazon Alexa Smart Home Skill - Sign in [Alexa Developer Console][alexa-dev-console], you can create your free account on the sign in page. - Go to `Alexa Skills` page if you are not, click `Create Skill` button to start the process. @@ -56,7 +56,7 @@ For Home Assistant Cloud Users, documentation can be found [here](https://www.na - In next screen, make sure *v3* is selected in `Payload version`. - Now, you have created a skeleton of Smart Home skill. Next step we will do some "real" developer work. You can keep Alex Developer Console opened, we need change the skill configuration later. -### {% linkable_title Create Your Lambda Function %} +### Create Your Lambda Function Alexa Smart Home skill will trigger a AWS Lambda function to process the request, we will write a small piece of code hosted as an Lambda function basically redirect the request to your Home Assistant instance, then Alexa integration integration in Home Assistant will process the request and send back the response. Your Lambda function will delivery the response back to Alexa. @@ -70,7 +70,7 @@ Amazon also provided a [step-by-step guide](https://developer.amazon.com/docs/sm OK, let's go. You first need sign in your [AWS console](https://console.aws.amazon.com/), if you don't have an AWS account yet, you can create a new user [here](https://aws.amazon.com/free/) with 12-month free tire benefit. You don't need worry the cost if your account already pass the first 12 months, AWS provides up to 1 million Lambda request, 1GB outbound data and all inbound data for free, every month, all users. See [Lambda pricing](https://aws.amazon.com/lambda/pricing/) for details. -#### {% linkable_title Create an IAM Role for Lambda %} +#### Create an IAM Role for Lambda First thing you need to do after sing in [AWS console](https://console.aws.amazon.com/) is to create an IAM Role for Lambda execution. AWS has very strict access control, you have to specific define and assign the permissions. @@ -83,7 +83,7 @@ First thing you need to do after sing in [AWS console](https://console.aws.amazo - You can skip `Add tags` page, click `Next: Review`. - Give your new role a name, such as `AWSLambdaBasicExecutionRole-SmartHome`, then click `Create role` button. You should be able to find your new role in the roles list now. -#### {% linkable_title Create a Lambda function and add code %} +#### Create a Lambda function and add code Next you need create a Lambda function. @@ -111,7 +111,7 @@ Next you need create a Lambda function. - Now scroll up to the top, click `Save` button. - You need copy the ARN displayed in the top of the page, which is the identify of this Lambda function. You will need this ARN to continue Alexa Smart Home skill configuration later. -#### {% linkable_title Test the Lambda function %} +#### Test the Lambda function Now, you have created the Lambda function, before you can test it, you have to set up your Home Assistant. Put following minimal configuration to your configuration.yaml, it will exposures all of your supported device and automation to Alexa. Check the [configuration section](#alexa-component-configuration) if you want more control of the exposure. @@ -150,7 +150,7 @@ Now, you can login to your Home Assistant and [generate a long-lived access toke This time, you will get a list of your devices as the response. 🎉 -### {% linkable_title Config the Smart Home Service Endpoint %} +### Config the Smart Home Service Endpoint Now removed the long-lived access token if you want, copied the ARN of your Lambda function, then back to [Alexa Developer Console][alexa-dev-console]. You will finish the configuration of the Smart Home skill. @@ -159,7 +159,7 @@ Now removed the long-lived access token if you want, copied the ARN of your Lamb - Click `SMART HOME` in the left navigation bar of build page. - Fill in `Default endpoint` under `2. Smart Home service endpoint` using the `ARN` you copied from your Lambda function configuration. -### {% linkable_title Account Linking %} +### Account Linking Alexa can link your Amazon account to your Home Assistant account. Therefore Home Assistant can make sure only authenticated Alexa request be able to access your home's devices. In order to link the account, you have to make sure your Home Assistant can be accessed from Internet. @@ -193,7 +193,7 @@ Alexa can link your Amazon account to your Home Assistant account. Therefore Hom * You can discovery your devices now. - Now, you can ask your Echo or in Alexa App, *turn on bedroom* 🎉 -### {% linkable_title Alexa Component Configuration %} +### Alexa Component Configuration Example configuration: @@ -226,7 +226,7 @@ The `endpoint`, `client_id` and `client_secret` are optional, and are only requi - If the "Send Alexa Events" permission was not enabled previously, you need to unlink and relink the skill using the Alexa App, or else Home Assistant will show the following error: "Token invalid and no refresh token available." -### {% linkable_title Alexa web-based app %} +### Alexa web-based app The following is a list of regions and the corresponding URL for the web-based Alexa app: diff --git a/source/_components/alpha_vantage.markdown b/source/_components/alpha_vantage.markdown index 65728778d9c..09e1e7d2fd4 100644 --- a/source/_components/alpha_vantage.markdown +++ b/source/_components/alpha_vantage.markdown @@ -78,11 +78,11 @@ foreign_exchange: type: string {% endconfiguration %} -## {% linkable_title Examples %} +## Examples In this section you find some real-life examples of how to use this sensor. -### {% linkable_title Google and the exchange rate for Bitcoin %} +### Google and the exchange rate for Bitcoin ```yaml sensor: diff --git a/source/_components/amazon_polly.markdown b/source/_components/amazon_polly.markdown index 1f14b27427a..864d52967c8 100644 --- a/source/_components/amazon_polly.markdown +++ b/source/_components/amazon_polly.markdown @@ -18,13 +18,13 @@ redirect_from: The `amazon_polly` text-to-speech platform that works with [Amazon Polly](https://aws.amazon.com/polly/) to create the spoken output. Polly is a paid service via Amazon Web Services. There is a [free tier](https://aws.amazon.com/polly/pricing/) for the first 12 months and then a charge per million characters afterwards. -## {% linkable_title Setup %} +## Setup For more information, please read the [AWS General Reference regarding Security Credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html) to get the needed details. Also, check the [boto3 Documentation](http://boto3.readthedocs.io/en/latest/guide/configuration.html#shared-credentials-file) about the profiles and the [AWS Regions and Endpoints Reference](https://docs.aws.amazon.com/general/latest/gr/rande.html#pol_region) for available regions. Available voices are listed in the [Amazon Documentation](http://docs.aws.amazon.com/polly/latest/dg/voicelist.html). -## {% linkable_title Configuration %} +## Configuration To get started, add the following lines to your `configuration.yaml` (example for Amazon Polly): @@ -79,7 +79,7 @@ sample_rate: default: 22050 for MP3 and Ogg Vorbis, 16000 for pcm {% endconfiguration %} -## {% linkable_title Usage %} +## Usage Say to all `media_player` device entities: diff --git a/source/_components/ambiclimate.markdown b/source/_components/ambiclimate.markdown index 03215193451..ea52e5bf2d5 100644 --- a/source/_components/ambiclimate.markdown +++ b/source/_components/ambiclimate.markdown @@ -42,7 +42,7 @@ client_secret: Note that you have to select manual mode from the Ambiclimate app to be able to control the A/C from Home Assistant. -## {% linkable_title Component services %} +## Component services Enable comfort mode on your AC: diff --git a/source/_components/ambient_station.markdown b/source/_components/ambient_station.markdown index 26b1d44306f..3be9275f6dd 100644 --- a/source/_components/ambient_station.markdown +++ b/source/_components/ambient_station.markdown @@ -17,13 +17,13 @@ redirect_from: The `Ambient Weather Station` integration retrieves local weather information via personal weather stations from [Ambient Weather](https://ambientweather.net). -## {% linkable_title Setup %} +## Setup Using this integration requires both an Application Key and an API Key. To generate both, simply utilize the profile section of [your Ambient Weather dashboard](https://dashboard.ambientweather.net). -## {% linkable_title Configuration %} +## Configuration To add your Ambient Weather PWS to your Home Assistant installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/amcrest.markdown b/source/_components/amcrest.markdown index 8496955b831..a96fa665ab4 100644 --- a/source/_components/amcrest.markdown +++ b/source/_components/amcrest.markdown @@ -31,7 +31,7 @@ There is currently support for the following device types within Home Assistant: - Sensor - Switch (deprecated) -## {% linkable_title Configuration %} +## Configuration To enable your camera in your installation, add the following to your `configuration.yaml` file: @@ -175,7 +175,7 @@ Newer Amcrest firmware may not work, then **rtsp** is recommended instead. make sure to follow the steps mentioned at [FFMPEG](/components/ffmpeg/) documentation to install the `ffmpeg`. -## {% linkable_title Services %} +## Services Once loaded, the `amcrest` integration will expose services that can be called to perform various actions. The `entity_id` service attribute can specify one or more specific cameras, or `all` can be used to specify all configured Amcrest cameras. @@ -186,7 +186,7 @@ Available services: `goto_preset`, `set_color_bw`, `start_tour` and `stop_tour` -#### {% linkable_title Service `enable_audio`/`disable_audio` %} +#### Service `enable_audio`/`disable_audio` These services enable or disable the camera's audio stream. @@ -194,7 +194,7 @@ Service data attribute | Optional | Description -|-|- `entity_id` | no | Name(s) of entities, e.g., `camera.living_room_camera`. -#### {% linkable_title Service `enable_motion_recording`/`disable_motion_recording` %} +#### Service `enable_motion_recording`/`disable_motion_recording` These services enable or disable the camera to record a clip to its configured storage location when motion is detected. @@ -202,7 +202,7 @@ Service data attribute | Optional | Description -|-|- `entity_id` | no | Name(s) of entities, e.g., `camera.living_room_camera`. -#### {% linkable_title Service `enable_recording`/`disable_recording` %} +#### Service `enable_recording`/`disable_recording` These services enable or disable the camera to continuously record to its configured storage location. @@ -210,7 +210,7 @@ Service data attribute | Optional | Description -|-|- `entity_id` | no | Name(s) of entities, e.g., `camera.living_room_camera`. -#### {% linkable_title Service `goto_preset` %} +#### Service `goto_preset` This service will cause the camera to move to one of the PTZ locations configured within the camera. @@ -219,7 +219,7 @@ Service data attribute | Optional | Description `entity_id` | no | Name(s) of entities, e.g., `camera.living_room_camera`. `preset` | no | Preset number, starting from 1. -#### {% linkable_title Service `set_color_bw` %} +#### Service `set_color_bw` This service will set the color mode of the camera. @@ -228,7 +228,7 @@ Service data attribute | Optional | Description `entity_id` | no | Name(s) of entities, e.g., `camera.living_room_camera`. `color_bw` | no | One of `auto`, `bw` or `color`. -#### {% linkable_title Service `start_tour`/`stop_tour` %} +#### Service `start_tour`/`stop_tour` These services start or stop the camera's PTZ tour function. @@ -236,7 +236,7 @@ Service data attribute | Optional | Description -|-|- `entity_id` | no | Name(s) of entities, e.g., `camera.living_room_camera`. -## {% linkable_title Advanced Configuration %} +## Advanced Configuration You can also use this more advanced configuration example: diff --git a/source/_components/ampio.markdown b/source/_components/ampio.markdown index a6564672767..cdd587dec49 100644 --- a/source/_components/ampio.markdown +++ b/source/_components/ampio.markdown @@ -17,11 +17,11 @@ ha_iot_class: "Cloud Polling" The `ampio` air quality platform will query the open data API of [ampio.pl](http://smog1.ampio.pl:3050/) to monitor air quality sensor station. -## {% linkable_title Setup %} +## Setup To get the ID of a station you need to contact Ampio directly. -## {% linkable_title Manual Configuration %} +## Manual Configuration To enable this platform, add the following lines to your `configuration.yaml` file: diff --git a/source/_components/android_ip_webcam.markdown b/source/_components/android_ip_webcam.markdown index 82b75d0905a..04c19a03dac 100644 --- a/source/_components/android_ip_webcam.markdown +++ b/source/_components/android_ip_webcam.markdown @@ -34,11 +34,11 @@ There is currently support for the following device types within Home Assistant: - Sensor - Switch -## {% linkable_title Setup %} +## Setup Download [the IP Webcam app](https://play.google.com/store/apps/details?id=com.pas.webcam) and launch the app. When you press 'Start Server', it will start streaming video from your phone and the IP address of the device will be shown on screen. -## {% linkable_title Configuration %} +## Configuration To set up the component, add the following information to your `configuration.yaml` file: @@ -134,7 +134,7 @@ motion_sensor: You need to enable logging in the Android app (`Data logging` > `Enable data logging`), if you wish to see the sensor states in Home Assistant. The sensor states stays as `unknown`, until it's enabled.

-## {% linkable_title Full example %} +## Full example ```yaml # Example configuration.yaml entry @@ -170,11 +170,11 @@ android_ip_webcam: - torch ``` -## {% linkable_title Binary Sensor %} +## Binary Sensor The `android_ip_webcam` binary sensor platform lets you observe the motion state of [Android IP webcam](https://play.google.com/store/apps/details?id=com.pas.webcam) sensors through Home Assistant. Devices will be configured automatically. -## {% linkable_title Examples %} +## Examples You can also setup the binary motion sensor with the following script: @@ -191,11 +191,11 @@ binary_sensor: {% endraw %} -## {% linkable_title Camera %} +## Camera The `android_ip_webcam` integration adds a camera by default if you choose not to use the integration but still want to see the video feed then the [`mjpeg` camera](/components/camera.mjpeg/) platform can be used. -## {% linkable_title Configuration %} +## Configuration To enable only the camera in your installation, add the following to your `configuration.yaml` file: @@ -206,7 +206,7 @@ camera: mjpeg_url: http://IP_ADDRESS:8080/video ``` -## {% linkable_title Sensor %} +## Sensor The `android_ip_webcam` sensor platform lets you observe states of [Android IP webcam](https://play.google.com/store/apps/details?id=com.pas.webcam) sensors through Home Assistant. Devices will be configured automatically. diff --git a/source/_components/androidtv.markdown b/source/_components/androidtv.markdown index c88704769a4..ec7e91393f3 100644 --- a/source/_components/androidtv.markdown +++ b/source/_components/androidtv.markdown @@ -18,7 +18,7 @@ redirect_from: The `androidtv` platform allows you to control an Android TV device or [Amazon Fire TV](https://www.amazon.com/b/?node=8521791011) device. -## {% linkable_title Device preparation %} +## Device preparation To set up your device, you will need to find its IP address and enable ADB debugging. For Android TV devices, please consult the documentation for your device. @@ -32,7 +32,7 @@ For Fire TV devices, the instructions are as follows: - From the main (Launcher) screen, select Settings. - Select System > About > Network. -## {% linkable_title Configuration %} +## Configuration ```yaml # Example configuration.yaml entry @@ -108,7 +108,7 @@ turn_off_command: type: string {% endconfiguration %} -### {% linkable_title Full Configuration %} +### Full Configuration ```yaml # Example configuration.yaml entry @@ -135,23 +135,23 @@ media_player: get_sources: false ``` -## {% linkable_title ADB Setup %} +## ADB Setup This integration works by sending ADB commands to your Android TV / Fire TV device. There are two ways to accomplish this: -### {% linkable_title 1. ADB Server %} +### 1. ADB Server You can use an ADB server to connect to your Android TV and Fire TV devices. For Hass.io users, you can install the [Android Debug Bridge](https://github.com/hassio-addons/addon-adb/blob/master/README.md) addon. Using this approach, Home Assistant will send the ADB commands to the server, which will then send them to the Android TV / Fire TV device and report back to Home Assistant. To use this option, add the `adb_server_ip` option to your configuration. If you are running the server on the same machine as Home Assistant, you can use `127.0.0.1` for this value. -### {% linkable_title 2. Python ADB Implementation %} +### 2. Python ADB Implementation The second option is to connect to your device using the `adb` Python package. If your device requires ADB authentication, you will need to follow the instructions in the [ADB Authentication](#adb-authentication) section below. Once you have an authenticated key, this approach does not require any additional setup or addons. However, users with newer devices may find that the ADB connection is unstable. For a Fire TV device, you can try setting the `get_sources` configuration option to `false`. If the problem cannot be resolved, you should use the ADB server option. -#### {% linkable_title ADB Authentication %} +#### ADB Authentication If you get a "Device authentication required, no keys available" error when trying to set up your Android TV or Fire TV, then you'll need to create an adbkey and add its path to your configuration. Follow the instructions on this page to connect to your device from your computer: [Connecting to Fire TV Through adb](https://developer.amazon.com/zh/docs/fire-tv/connecting-adb-to-device.html). @@ -166,7 +166,7 @@ Once you've successfully connected to your Android TV / Fire TV via the command Copy the `adbkey` file to your Home Assistant folder and add the path to the `adbkey` file to your configuration. -## {% linkable_title ADB Troubleshooting %} +## ADB Troubleshooting If you receive the error message `Error while setting up platform androidtv` in your log when trying to set up an Android TV or Fire TV device, then there is probably an issue with your ADB connection. Here are some possible causes. @@ -184,9 +184,9 @@ If you receive the error message `Error while setting up platform androidtv` in 4. Some Android TV devices (e.g., Philips TVs running Android TV) only accept the initial ADB connection request over their Wi-Fi interface. If you have the TV wired, you need to connect it to WiFi and try the initial connection again. Once the authentication has been granted via Wi-Fi, you can connect to the TV over the wired interface as well. -## {% linkable_title Services %} +## Services -### {% linkable_title `media_player.select_source` %} +### `media_player.select_source` For Fire TV devices, you can launch an app using the `media_player.select_source` command. Simply provide the app ID as the `source`. You can also stop an app by prefixing the app ID with a `!`. For example, you could define [scripts](/docs/scripts) to start and stop Netflix as follows: @@ -206,7 +206,7 @@ stop_netflix: source: '!com.netflix.ninja' ``` -### {% linkable_title `androidtv.adb_command` %} +### `androidtv.adb_command` The service `androidtv.adb_command` allows you to send either keys or ADB shell commands to your Android TV / Fire TV device. If there is any output, it will be stored in the `'adb_response'` attribute (i.e., `state_attr('media_player.android_tv_living_room', 'adb_response')` in a template) and logged at the INFO level. diff --git a/source/_components/anthemav.markdown b/source/_components/anthemav.markdown index ca83e56e9fd..5e3b892f2cc 100644 --- a/source/_components/anthemav.markdown +++ b/source/_components/anthemav.markdown @@ -18,7 +18,7 @@ redirect_from: Both [Anthem]'s current and last generation of A/V Receivers and Processors support IP-based, network control. This Home Assistant platform adds proper "local push" support for any of these receivers on your network. -## {% linkable_title Supported Models %} +## Supported Models * MRX 520, MRX 720, MRX 1120, and AVM 60 * MRX 310, MRX 510, MRX 710 diff --git a/source/_components/apcupsd.markdown b/source/_components/apcupsd.markdown index 1c0c34eb34b..911db2cd7f1 100644 --- a/source/_components/apcupsd.markdown +++ b/source/_components/apcupsd.markdown @@ -26,13 +26,13 @@ There is currently support for the following device types within Home Assistant: - [Binary Sensor](#binary-sensor) - [Sensor](#sensor) -## {% linkable_title Hass.io Installation %} +## Hass.io Installation Install this [unofficial add-on](https://github.com/korylprince/hassio-apcupsd/) to use this integration with Hass.io. Keep in mind that we can't give you support for this add-on. After installation, follow the instructions on the Github page to configure the plugin. Then continue to follow the integration configurations below. -## {% linkable_title Configuration %} +## Configuration To enable this sensor, add the following lines to your `configuration.yaml`: @@ -58,11 +58,11 @@ port: If you get `ConnectionRefusedError: Connection refused` errors in the Home assistant logs, ensure the [APCUPSd](http://www.apcupsd.org/) configuration directives used by its Network Information Server is set to permit connections from all addresses [NISIP 0.0.0.0](http://www.apcupsd.org/manual/manual.html#configuration-directives-used-by-the-network-information-server), else non-local addesses will not connect. This includes Hass.io running in Docker, even when hosted on the same machine or a virtual machine.

-## {% linkable_title Binary sensor %} +## Binary sensor In addition to the [APCUPSd Sensor](#sensor) devices, you may also create a device which is simply "on" when the UPS status is online and "off" at all other times. -### {% linkable_title Configuration %} +### Configuration To enable this sensor, you first have to set up apcupsd integration (above), and add the following lines to your `configuration.yaml` file: @@ -80,11 +80,11 @@ name: default: UPS Online Status {% endconfiguration %} -## {% linkable_title Sensor %} +## Sensor The `apcupsd` sensor platform allows you to monitor a UPS (battery backup) by using data from the [apcaccess](http://linux.die.net/man/8/apcaccess) command. -### {% linkable_title Configuration %} +### Configuration To use this sensor platform, you first have to set up apcupsd integration (above), and add the following to your `configuration.yaml` file: @@ -104,7 +104,7 @@ resources: type: list {% endconfiguration %} -### {% linkable_title Example %} +### Example Given the following output from `apcaccess`: diff --git a/source/_components/apns.markdown b/source/_components/apns.markdown index 038e599e17d..ca29ec3ecf3 100644 --- a/source/_components/apns.markdown +++ b/source/_components/apns.markdown @@ -17,11 +17,11 @@ redirect_from: The `apns` platform uses the Apple Push Notification service (APNS) to deliver notifications from Home Assistant. -## {% linkable_title Setup %} +## Setup To use the APNS service you will need an Apple developer account and you will need to create an app to receive push notifications. For more information, see the Apple developer documentation. -## {% linkable_title Configuration %} +## Configuration To enable APNS notifications, add the following lines to your `configuration.yaml`: @@ -56,13 +56,13 @@ sandbox: The APNS platform will register two services, `notify.NOTIFIER_NAME` and `notify.apns_NOTIFIER_NAME`. -### {% linkable_title notify.apns_NOTIFIER_NAME %} +### notify.apns_NOTIFIER_NAME This service will register device IDs with Home Assistant. In order to receive a notification a device must be registered. The app on the device can use this service to send an ID to Home Assistant during startup, the ID will be stored in `[NOTIFIER_NAME]_apns.yaml`. See `didRegisterForRemoteNotificationsWithDeviceToken` in the [Apple developer documentation](https://developer.apple.com/library/ios/documentation/UIKit/Reference/UIApplicationDelegate_Protocol/#//apple_ref/occ/intfm/UIApplicationDelegate/application:didRegisterForRemoteNotificationsWithDeviceToken:) for more information about how to obtain a device ID. -### {% linkable_title notify.NOTIFIER_NAME %} +### notify.NOTIFIER_NAME This service will send messages to a registered device. The following parameters can be used: diff --git a/source/_components/apple_tv.markdown b/source/_components/apple_tv.markdown index 79da7887cf6..d7cf830ecb0 100644 --- a/source/_components/apple_tv.markdown +++ b/source/_components/apple_tv.markdown @@ -30,7 +30,7 @@ There is currently support for the following device types within Home Assistant: Currently, you must have Home Sharing enabled for this to work. Support for pairing Home Assistant with your device will be supported in a later release.

-## {% linkable_title Configuration %} +## Configuration To use this component, you must first install some system libraries and a compiler. For Debian or a similar system, this should be enough: @@ -80,9 +80,9 @@ credentials: In order to connect to the device, you need a *login id*. The easiest way to obtain this identifier is to use the `apple_tv_scan` service (described below). Additional information about `start_off` and `credentials` can also be found under the guides section. -## {% linkable_title Guides %} +## Guides -### {% linkable_title Scanning for devices %} +### Scanning for devices Make sure Home Sharing is enabled on the Apple TV. @@ -110,7 +110,7 @@ Note: You must use 'pair' with devices that have home sharing disabled Just copy and paste the `login_id` from the device you want to add. For more details about `atvremote`, see: [this page](http://pyatv.readthedocs.io/en/master/atvremote.html). -### {% linkable_title Setting up device authentication %} +### Setting up device authentication If you, when playing media with `play_url`, get the following error message: @@ -140,7 +140,7 @@ apple_tv: Restart Home Assistant, and you should now be able to use `play_url` as before. -### {% linkable_title My Apple TV turns on when I restart Home Assistant %} +### My Apple TV turns on when I restart Home Assistant The Apple TV will automatically turn on if a request is sent to it, e.g., if a button is pressed, something is streamed to it via AirPlay or if current state (currently playing) is accessed. This is how Apple has designed it, and it will cause problems if you are using HDMI CEC. Every time Home Assistant is started, a new request is sent to the device to figure out what is currently playing. When using CEC, this will wake up your TV and other devices you have configured. @@ -158,9 +158,9 @@ To put a device into fake standby when starting Home Assistant, add `start_off: Turning the device on/off in the user interface will *not* turn the physical device on/off according to the description above.

-## {% linkable_title Services %} +## Services -### {% linkable_title Service `apple_tv_authenticate` %} +### Service `apple_tv_authenticate` To play media on an Apple TV with device authentication enabled (e.g., ATV4 with tvOS 10.2+), Home Assistant must be properly authenticated. This method starts the process and presents the credentials needed for playback as a persistent notification. Please see guide above for usage. @@ -168,11 +168,11 @@ To play media on an Apple TV with device authentication enabled (e.g., ATV4 with | ---------------------- | -------- | ----------- | | `entity_id` | yes | String or list of strings that point at `entity_id`s of Apple TVs. -### {% linkable_title Service `apple_tv_scan` %} +### Service `apple_tv_scan` Scans the local network for Apple TVs. All found devices are presented as a persistent notification. -## {% linkable_title Remote %} +## Remote The `apple_tv` remote platform allows you to send remote control buttons to an Apple TV. It is automatically setup when an Apple TV is configured. diff --git a/source/_components/aprs.markdown b/source/_components/aprs.markdown index ec90a7bcdee..25ae43b2be4 100644 --- a/source/_components/aprs.markdown +++ b/source/_components/aprs.markdown @@ -15,7 +15,7 @@ ha_iot_class: Cloud Push The `aprs` [(Automatic Packet Reporting System)](https://en.wikipedia.org/wiki/Automatic_Packet_Reporting_System) device tracker integration connects to the [APRS-IS](http://aprs-is.net/) network for tracking amateur radio devices. -## {% linkable_title Configuration %} +## Configuration To enable APRS tracking in Home Assistant, add the following section to `configuration.yaml`: diff --git a/source/_components/aqualogic.markdown b/source/_components/aqualogic.markdown index ebfc8d3773a..b133221bc97 100644 --- a/source/_components/aqualogic.markdown +++ b/source/_components/aqualogic.markdown @@ -26,7 +26,7 @@ There is currently support for the following device types within Home Assistant: - [Sensor](#sensor) - [Switch](#switch) -## {% linkable_title Configuration %} +## Configuration To add the AquaLogic integration to your installation, add the following to your `configuration.yaml` file: @@ -48,7 +48,7 @@ port: type: int {% endconfiguration %} -## {% linkable_title Sensor %} +## Sensor Once you have enabled the AquaLogic component, add the following to your `configuration.yaml` file: @@ -87,7 +87,7 @@ monitored_conditions: description: The current system status. {% endconfiguration %} -## {% linkable_title Switch %} +## Switch Once you have enabled the AquaLogic component, add the following to your `configuration.yaml` file: diff --git a/source/_components/arduino.markdown b/source/_components/arduino.markdown index f61098f5d30..8704d81038c 100644 --- a/source/_components/arduino.markdown +++ b/source/_components/arduino.markdown @@ -32,7 +32,7 @@ There is currently support for the following device types within Home Assistant: - [Sensor](#sensor) - [Switch](#switch) -## {% linkable_title Configuration %} +## Configuration You need to have the [Firmata firmware](https://github.com/firmata/) on your board. Please upload the `StandardFirmata` sketch to your board; please refer to the [Arduino documentation](https://www.arduino.cc/en/Main/Howto) for further information. @@ -69,7 +69,7 @@ Add the user who is used to run Home Assistant to the groups to allow access to $ sudo usermod -a -G dialout,lock $USER ``` -## {% linkable_title Sensor %} +## Sensor The `arduino` sensor platform allows you to get numerical values from an analog input pin of an [Arduino](https://www.arduino.cc/) board. Usually the value is between 0 and 1024. @@ -104,7 +104,7 @@ pins: The 6 analog pins of an Arduino UNO are numbered from A0 to A5. -## {% linkable_title Switch %} +## Switch The `arduino` switch platform allows you to control the digital pins of your [Arduino](https://www.arduino.cc/) board. Support for switching pins is limited to high/on and low/off of the digital pins. PWM (pin 3, 5, 6, 9, 10, and 11 on an Arduino Uno) is not supported yet. diff --git a/source/_components/arest.markdown b/source/_components/arest.markdown index 8130a9a4bd4..bb48218c52d 100644 --- a/source/_components/arest.markdown +++ b/source/_components/arest.markdown @@ -27,7 +27,7 @@ There is currently support for the following device types within Home Assistant: - [Sensor](#sensor) - [Switch](#switch) -## {% linkable_title Binary Sensor %} +## Binary Sensor The `arest` binary sensor platform allows you to get all data from your devices (like Arduinos with an ethernet/wifi connection, the ESP8266, and the Raspberry Pi) running the [aREST](http://arest.io/) RESTful framework. @@ -78,7 +78,7 @@ binary_sensor: This sensor is not suitable for fast state changes because there is a high possibility that the change took place between two update cycle.

-## {% linkable_title Sensor %} +## Sensor The `arest` sensor platform allows you to get all data from your devices (like Arduinos with a Ethernet/Wifi connection, the ESP8266, and the Raspberry Pi) running the [aREST](http://arest.io/) RESTful framework. @@ -181,7 +181,7 @@ The root will give you a JSON response that contains all variables and their cur {"return_value": 34, "id": "sensor02", "name": "livingroom", "connected": true} ``` -## {% linkable_title Switch %} +## Switch The `arest` switch platform allows you to toggle pins of your devices (like Arduino boards with an Ethernet/Wifi connection, ESP8266 based devices, and the Raspberry Pi) running the [aREST](http://arest.io/) RESTful framework. diff --git a/source/_components/arlo.markdown b/source/_components/arlo.markdown index d7316c4a790..681c09b3a96 100644 --- a/source/_components/arlo.markdown +++ b/source/_components/arlo.markdown @@ -29,7 +29,7 @@ There is currently support for the following device types within Home Assistant: - [Camera](#camera) - [Sensor](#sensor) -## {% linkable_title Configuration %} +## Configuration To enable device linked in your [Arlo](https://arlo.netgear.com/) account, add the following to your `configuration.yaml` file: @@ -73,9 +73,9 @@ The Arlo integration also provides a camera service to enable/disable the motion entity_id: camera.arlo_frontdoor ``` -## {% linkable_title Alarm %} +## Alarm -### {% linkable_title Configuration %} +### Configuration Once you have enabled the [Arlo component](/components/arlo), add the following to your `configuration.yaml` file: @@ -102,7 +102,7 @@ night_mode_name: default: "`Armed` mode in Arlo" {% endconfiguration %} -### {% linkable_title Examples %} +### Examples These examples are based on an Arlo base station named `my_arlo_base_station`. Replace this with the name of your base station's `entity_id`. @@ -140,11 +140,11 @@ You can also completely disarm the Arlo base station by calling the `alarm_contr More examples and configuration options can be found on the [Manual Alarm Control page](/components/alarm_control_panel.manual/#examples). -## {% linkable_title Camera %} +## Camera This integration is not yet able to live stream from your Arlo camera, but it will be able to playback the last video capture. -### {% linkable_title Configuration %} +### Configuration Once you have enabled the [Arlo component](/components/arlo), add the following to your `configuration.yaml` file: @@ -164,13 +164,13 @@ ffmpeg_arguments: **Note:** To be able to playback the last capture, it is required to install the `ffmpeg` component. Make sure to follow the steps mentioned at [FFMPEG](/components/ffmpeg/) documentation. -## {% linkable_title Sensor %} +## Sensor To get your [Arlo](https://arlo.netgear.com/) sensors working within Home Assistant, please follow the instructions for the general [Arlo component](/components/arlo). This platform does not support Arlo Q. -### {% linkable_title Configuration %} +### Configuration Once you have enabled the [Arlo component](/components/arlo), add the following to your `configuration.yaml` file: diff --git a/source/_components/asterisk_mbox.markdown b/source/_components/asterisk_mbox.markdown index ea9796d3b07..e2ab37d0a11 100644 --- a/source/_components/asterisk_mbox.markdown +++ b/source/_components/asterisk_mbox.markdown @@ -22,7 +22,7 @@ To enable the component, a configuration is required in both Home Assistant as w First follow the [Asterisk PBX configuration guide](/docs/asterisk_mbox/) to setup the necessary server on the Asterisk PBX server (this is needed even if Asterisk and Home Assistant are running on the same server) -## {% linkable_title Configuration %} +## Configuration Once that is complete, add the following entry `configuration.yaml` file: diff --git a/source/_components/asuswrt.markdown b/source/_components/asuswrt.markdown index f6ef9bcfef9..abd1a385c71 100644 --- a/source/_components/asuswrt.markdown +++ b/source/_components/asuswrt.markdown @@ -26,7 +26,7 @@ There is currently support for the following device types within Home Assistant: - **Presence Detection** - The asuswrt platform offers presence detection by looking at connected devices to a ASUSWRT based router. - **Sensor** - The asuswrt sensor platform allows you to get upload and download data from your ASUSWRT within Home Assistant. -## {% linkable_title Configuration %} +## Configuration To use an ASUSWRT router in your installation, add the following to your `configuration.yaml` file: @@ -93,7 +93,7 @@ sensors: You need to [enable telnet](https://www.asus.com/support/faq/1005449/) on your router if you choose to use `protocol: telnet`.

-### {% linkable_title Example Sensor Configuration %} +### Example Sensor Configuration To enable ASUSWRT sensors as part of your installation, reference the following example configuration: @@ -118,7 +118,7 @@ The example above, creates the following sensors: - sensor.asuswrt_upload_speed (unit_of_measurement: Mbit/s) -## {% linkable_title Padavan custom firmware (The rt-n56u project) %} +## Padavan custom firmware (The rt-n56u project) The [rt-n56u project](https://bitbucket.org/padavan/rt-n56u) does not store `dnsmasq.leases` which is used to track devices at `/var/lib/misc/` as `asuswrt` do. However this integration can still be used for the rt-n56u project by linking `dnsmasq.leases` during the boot process of the router. diff --git a/source/_components/august.markdown b/source/_components/august.markdown index fb641c641c1..8400ab48eae 100644 --- a/source/_components/august.markdown +++ b/source/_components/august.markdown @@ -34,7 +34,7 @@ There is currently support for the following device types within Home Assistant: August Lock 2nd Gen will need either August Connect or Doorbell to connect to Home Assistant.

-## {% linkable_title Configuration %} +## Configuration You will need your August login information (username (either phone# or email), and password) to use this module. @@ -70,7 +70,7 @@ timeout: Once Home Assistant is started, a configurator will pop up asking you to enter verification code that is sent to your phone number or email. -### {% linkable_title Binary Sensor %} +### Binary Sensor If you have August Doorbell, once you have enabled the August component, you should see following sensors: @@ -82,6 +82,6 @@ If you have August Smart Lock with DoorSense, once you have enabled the August c - Door sensor -### {% linkable_title Camera %} +### Camera The `august` camera platform allows you to view the latest camera image (triggered by motion) by your [August](http://august.com) device in Home Assistant. diff --git a/source/_components/aurora.markdown b/source/_components/aurora.markdown index e8a4185a663..dd0f5539c2b 100644 --- a/source/_components/aurora.markdown +++ b/source/_components/aurora.markdown @@ -21,7 +21,7 @@ This service gives a number 0-100 representing the current likelihood of visible You can check the attributes of the sensor to see your exact forecast. -## {% linkable_title Configuration %} +## Configuration To add the aurora binary sensor to your installation, add the following to your `configuration.yaml` file: @@ -44,7 +44,7 @@ name: default: Aurora Visibility {% endconfiguration %} -## {% linkable_title Full example %} +## Full example ```yaml binary_sensor: diff --git a/source/_components/automatic.markdown b/source/_components/automatic.markdown index cc3608be1c6..26bb173fe96 100644 --- a/source/_components/automatic.markdown +++ b/source/_components/automatic.markdown @@ -19,13 +19,13 @@ redirect_from: The `automatic` device tracker platform offers presence detection by retrieving your car's information from the [Automatic](http://automatic.com/) cloud service. -## {% linkable_title Setup %} +## Setup To use Automatic with Home Assistant, first you must [create a free development account](https://developer.automatic.com/). Automatic will generate a Client ID and Secret for you to use in your Home Assistant configuration. You will need to update your Event Delivery preferences to ensure Home Assistant can receive updates. On the developer page, under App Settings / Event Delivery, select "Websocket" for Event Delivery Preference. Next, specify the OAuth Redirect URL in the developer page. This should be configured to `/api/automatic/callback`. (Example: `http://hassio.local:8123/api/automatic/callback`) Note that this URL only needs to be accessible from the browser you use to perform the authentication. Home Assistant can also take advantage of `scope:current_location` if available. This will allow Home Assistant to receive periodic location updates during a trip. In order to use this functionality, you must request the scope for your application from Automatic. Once `scope:current_location` is available, change `current_location` to `true` in your configuration.yaml. -## {% linkable_title Configuration %} +## Configuration Once your developer account is created, add the following to your `configuration.yaml` file: diff --git a/source/_components/avion.markdown b/source/_components/avion.markdown index d8d82e8245f..4607e0213b0 100644 --- a/source/_components/avion.markdown +++ b/source/_components/avion.markdown @@ -18,7 +18,7 @@ redirect_from: Support for the Avi-on Bluetooth dimmer switch [Avi-On](http://avi-on.com/). -## {% linkable_title Setup %} +## Setup If you want to add your devices manually (like in the example below) then you need to get the API key. The API key can be obtained by executing the following command: @@ -30,7 +30,7 @@ $ curl -X POST -H "Content-Type: application/json" \ with the email and password fields replaced with those used when registering the device via the mobile app. The pass phrase field of the output should be used as the API key in the configuration. -## {% linkable_title Configuration %} +## Configuration To enable these lights, add the following lines to your `configuration.yaml` file: @@ -70,7 +70,7 @@ devices: type: string {% endconfiguration %} -## {% linkable_title Full example %} +## Full example If username and password are not supplied, devices must be configured manually like so: diff --git a/source/_components/awair.markdown b/source/_components/awair.markdown index f21d41eb257..e5b3c70d9dd 100644 --- a/source/_components/awair.markdown +++ b/source/_components/awair.markdown @@ -20,7 +20,7 @@ The `awair` sensor platform will fetch data from your [Awair device(s)](https:// You will need to request access to the Awair API and obtain an access token from the Awair [Developer Console](https://developer.getawair.com/). -## {% linkable_title Configuring the Platform %} +## Configuring the Platform To enable these sensors, add the following lines to your `configuration.yaml` file: @@ -58,7 +58,7 @@ devices: type: string {% endconfiguration %} -## {% linkable_title Available Sensors %} +## Available Sensors The platform will fetch all available sensors from each Awair device linked to your account. Supported sensors: diff --git a/source/_components/aws.markdown b/source/_components/aws.markdown index 42d8a5cff76..307bea1572e 100644 --- a/source/_components/aws.markdown +++ b/source/_components/aws.markdown @@ -15,7 +15,7 @@ ha_release: "0.91" The `aws` integration provides a single place to interact with [Amazon Web Services](https://aws.amazon.com/). Currently it provides a notification platform that can send a message to [AWS SQS](https://aws.amazon.com/sqs/), [AWS SNS](https://aws.amazon.com/sns/), or invoke [AWS Lambda](https://aws.amazon.com/lambda/) functions. -## {% linkable_title Setup %} +## Setup You have to have an AWS account to use Amazon Web Services, create one [here](https://aws.amazon.com/free/) with a 12 months free tier benefit. Please note, even in the first 12-months, you may still be billed if you use more resources than offered in the free tier. We advise you to monitor your costs in the [AWS Billing Console](https://console.aws.amazon.com/billing/) closely. You can read the [Control your AWS costs](https://aws.amazon.com/getting-started/tutorials/control-your-costs-free-tier-budgets/) guide for more information. @@ -23,7 +23,7 @@ The `lambda`, `sns` and `sqs` services, used in the `aws` component, all provide The `aws` integration is using [botocore](https://botocore.amazonaws.com/v1/documentation/api/latest/index.html) to communicate with Amazon Web Services, which is also used by the [AWS Command Client Interface](https://aws.amazon.com/cli/) tool. Therefore, `aws` shares the same credential and profiles with `awscli` tool. Please read [Configuring the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html) to learn how to get access keys and how to manage them on your local system securely. -## {% linkable_title Configuration %} +## Configuration To use the `aws` integration and the `notify` platform in your installation, add the following to your `configuration.yaml` file: @@ -40,7 +40,7 @@ aws: region_name: us-east-1 ``` -### {% linkable_title Configuration for credentials %} +### Configuration for credentials {% configuration %} name: @@ -66,7 +66,7 @@ validate: type: boolean {% endconfiguration %} -### {% linkable_title Configuration for notify %} +### Configuration for notify {% configuration %} service: @@ -104,7 +104,7 @@ context: type: string {% endconfiguration %} -## {% linkable_title Lambda Notify Usage %} +## Lambda Notify Usage AWS Lambda is a notification platform and thus can be controlled by calling the `notify` service [as described here](/components/notify/). It will invoke a Lambda for all targets given in the notification payload. A target can be formatted as a function name, an entire ARN ([Amazon Resource Name](http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)) or a partial ARN. For more information, please see the [botocore docs](https://botocore.amazonaws.com/v1/documentation/api/latest/reference/services/lambda.html#Lambda.Client.invoke). @@ -132,13 +132,13 @@ The context will look like this: } ``` -## {% linkable_title SNS Notify Usage %} +## SNS Notify Usage AWS SNS is a notification platform and thus can be controlled by calling the `notify` service [as described here](/components/notify/). It will publish a message to all targets given in the notification payload. A target must be a SNS topic or endpoint ARN ([Amazon Resource Name](http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)). For more information, please see the [botocore docs](https://botocore.amazonaws.com/v1/documentation/api/latest/reference/services/sns.html#SNS.Client.publish). If one exists, the SNS Subject will be set to the title. All attributes from the payload, except the message, will be sent as stringified message attributes. -### {% linkable_title Setting up SNS within AWS %} +### Setting up SNS within AWS - Log into your AWS console and under "Security and Identity", select "Identity & Access Management". - On the left-hand side, select "Users" then click "Create New Users". Enter a name here and then click "Create". @@ -158,7 +158,7 @@ If one exists, the SNS Subject will be set to the title. All attributes from the - Repeat for additional numbers. - Back in the "Users" section you will see a long alphanumeric line that starts with "arn:" and ends with the Topic Name you choose previously. This is what your "target" in Home Assistant will be. -## {% linkable_title SQS Notify Usage %} +## SQS Notify Usage AWS SQS is a notification platform and thus can be controlled by calling the `notify` service [as described here](/components/notify/). It will publish a message to the queue for all targets given in the notification payload. A target must be a SQS topic URL. For more information, please see the [SQS docs](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/ImportantIdentifiers.html) and [bototcore docs](https://botocore.amazonaws.com/v1/documentation/api/latest/reference/services/sqs.html#SQS.Client.send_message) diff --git a/source/_components/axis.markdown b/source/_components/axis.markdown index b1f99ee480c..f1694d780ba 100644 --- a/source/_components/axis.markdown +++ b/source/_components/axis.markdown @@ -24,7 +24,7 @@ redirect_from: Home Assistant will automatically discover their presence on your network. -## {% linkable_title Configuration %} +## Configuration For configuration go to the `Integrations pane` on your Home Assistant instance. @@ -32,11 +32,11 @@ For configuration go to the `Integrations pane` on your Home Assistant instance. It is recommended that you create a user on your Axis device specifically for Home Assistant. For all current functionality, it is enough to create a user belonging to user group viewer.

-## {% linkable_title Troubleshooting discovery %} +## Troubleshooting discovery If your device is not discovered. On your camera, go to **System Options** -> **Advanced** -> **Plain Config**. Change the drop-down box to `network` and click `Select Group`. If `Network Interface I0 ZeroConf` contains the `169.x.x.x` IP address, unchecked the box next to `Enabled` for this section and click `Save`. -## {% linkable_title Binary Sensor %} +## Binary Sensor The following sensor types are supported: @@ -46,7 +46,7 @@ The following sensor types are supported: - Day/night mode - Inputs and Supervised Inputs -## {% linkable_title Switch %} +## Switch The following controllable port types are supported: diff --git a/source/_components/azure_event_hub.markdown b/source/_components/azure_event_hub.markdown index 7a000e4b5b4..802c77f8f98 100644 --- a/source/_components/azure_event_hub.markdown +++ b/source/_components/azure_event_hub.markdown @@ -15,7 +15,7 @@ ha_release: 0.94 The `Azure Event Hub` integration allows you to hook into the Home Assistant event bus and send events to [Azure Event Hub](https://azure.microsoft.com/en-us/services/event-hubs/) or to a [Azure IoT Hub](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-messages-read-builtin). -## {% linkable_title First time setup %} +## First time setup This assumes you already have a Azure account. Otherwise create a Free account [here](https://azure.microsoft.com/en-us/free/). @@ -25,7 +25,7 @@ You must then create a Shared Access Policy for the Event Hub with 'Send' claims Once you have the name of your namespace, instance, Shared Access Policy and the key for that policy, you can setup the integration itself. -## {% linkable_title Configuration %} +## Configuration Add the following lines to your `configuration.yaml` file: @@ -92,7 +92,7 @@ filter: Event Hubs have a retention time of at most 7 days, if you do not capture or use the events they are deleted automatically from the Event Hub, the default retention is 1 day.

-### {% linkable_title Using the data in Azure %} +### Using the data in Azure There are a number of ways to stream the data that comes into the Event Hub into storages in Azure, the easiest way is to use the built-in Capture function and this allows you to capture the data in Azure Blob Storage or Azure Data Lake store, [details here](https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-capture-overview). diff --git a/source/_components/baidu.markdown b/source/_components/baidu.markdown index 0bc6c21bf65..43f3cb97911 100644 --- a/source/_components/baidu.markdown +++ b/source/_components/baidu.markdown @@ -17,7 +17,7 @@ redirect_from: The `baidu` text-to-speech platform uses [Baidu TTS engine](https://cloud.baidu.com/product/speech/tts) to read a text with natural sounding voices. -## {% linkable_title Configuration %} +## Configuration To get started, add the following lines to your `configuration.yaml`: diff --git a/source/_components/bayesian.markdown b/source/_components/bayesian.markdown index 8b62aa14653..13bc25c6b9c 100644 --- a/source/_components/bayesian.markdown +++ b/source/_components/bayesian.markdown @@ -21,7 +21,7 @@ The `bayesian` binary sensor platform observes the state from multiple sensors a This allows for the detection of complex events that may not be readily observable, e.g., cooking, showering, in bed, the start of a morning routine, etc. It can also be used to gain greater confidence about events that _are_ directly observable, but for which the sensors can be unreliable, e.g., presence. -## {% linkable_title Configuration %} +## Configuration To enable the Bayesian sensor, add the following lines to your `configuration.yaml`: @@ -90,7 +90,7 @@ observations: type: string {% endconfiguration %} -## {% linkable_title Full examples %} +## Full examples The following is an example for the `state` observation platform. diff --git a/source/_components/bbb_gpio.markdown b/source/_components/bbb_gpio.markdown index 41456239c96..825f7e94611 100644 --- a/source/_components/bbb_gpio.markdown +++ b/source/_components/bbb_gpio.markdown @@ -22,11 +22,11 @@ redirect_from: The `bbb_gpio` integration is the base for all [BeagleBone Black](https://beagleboard.org/black) related GPIO platforms in Home Assistant. There is no setup needed for the integration itself. -## {% linkable_title Binary Sensor %} +## Binary Sensor The `bbb_gpio` binary sensor platform allows you to read sensor values of the GPIOs of your [BeagleBone Black](https://beagleboard.org/black). -## {% linkable_title Configuration %} +## Configuration To use your BeagleBone Black's GPIO in your installation, add the following to your `configuration.yaml` file: @@ -75,11 +75,11 @@ pins: For more details about the GPIO layout, visit the [article](http://elinux.org/Beagleboard:BeagleBoneBlack) about the BeagleBone Black. -## {% linkable_title Switch %} +## Switch The `bbb_gpio` switch platform allows you to control the GPIOs of your [BeagleBone Black](https://beagleboard.org/black). -## {% linkable_title Configuration %} +## Configuration To use your BeagleBone Black's GPIO in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/bbox.markdown b/source/_components/bbox.markdown index 6cea270f529..639f102092a 100644 --- a/source/_components/bbox.markdown +++ b/source/_components/bbox.markdown @@ -30,7 +30,7 @@ There is currently support for the following device types within Home Assistant: Due to third party limitation, the sensors will only be available if Home Assistant and the Bbox are on the same local area network. You can check this by going to 192.168.1.254 with your web browser.

-## {% linkable_title Presence Detection %} +## Presence Detection The `bbox` platform offers presence detection by looking at connected devices to a [Bbox](https://fr.wikipedia.org/wiki/Bbox) based router from [Bouygues](https://www.bouyguestelecom.fr/), which is one of the main Internet provider in France. @@ -38,7 +38,7 @@ Bbox is a generic name for different hardware routers. The platform has been tes - Sagem F@st 5330b -### {% linkable_title Configuration %} +### Configuration To use an Bbox router in your installation, add the following to your `configuration.yaml` file: @@ -63,7 +63,7 @@ For now and due to third party limitation, the Bbox must be on the same local ne See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. -## {% linkable_title Sensor %} +## Sensor To add Bbox sensors to your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/bh1750.markdown b/source/_components/bh1750.markdown index 4bd83fa5ce4..4a99008a375 100644 --- a/source/_components/bh1750.markdown +++ b/source/_components/bh1750.markdown @@ -22,7 +22,7 @@ Tested devices: - [Raspberry Pi](https://www.raspberrypi.org/) -## {% linkable_title Configuration %} +## Configuration To use your BH1750 sensor in your installation, add the following to your `configuration.yaml` file: @@ -70,7 +70,7 @@ multiplier: type: integer {% endconfiguration %} -## {% linkable_title Full Examples %} +## Full Examples If you want to specify the resolution mode of the digital sensor or need to change the default I2c address (which is 0x23), add more details to the `configuration.yaml` file. @@ -88,7 +88,7 @@ sensor: scan_interval: 25 ``` -## {% linkable_title Directions for installing smbus support on Raspberry Pi %} +## Directions for installing smbus support on Raspberry Pi Enable I2c interface with the Raspberry Pi configuration utility: @@ -112,7 +112,7 @@ $ sudo addgroup homeassistant i2c $ sudo reboot ``` -### {% linkable_title Check the i2c address of the sensor %} +### Check the i2c address of the sensor After installing `i2c-tools`, a new utility is available to scan the addresses of the connected sensors: diff --git a/source/_components/binary_sensor.knx.markdown b/source/_components/binary_sensor.knx.markdown index b89ee64f261..6f9e15a22e8 100644 --- a/source/_components/binary_sensor.knx.markdown +++ b/source/_components/binary_sensor.knx.markdown @@ -16,7 +16,7 @@ ha_iot_class: Local Polling The `knx` sensor platform allows you to monitor [KNX](http://www.knx.org) binary sensors. -## {% linkable_title Configuration %} +## Configuration The `knx` integration must be configured correctly, see [KNX Integration](/components/knx). @@ -51,7 +51,7 @@ reset_after: type: integer {% endconfiguration %} -### {% linkable_title Automation actions %} +### Automation actions You can also attach actions to binary sensors (e.g., to switch on a light when a switch was pressed). In this example, one light is switched on when the button was pressed once and two others when the button was pressed a second time. diff --git a/source/_components/binary_sensor.markdown b/source/_components/binary_sensor.markdown index 7b93b7dc757..650e5770aed 100644 --- a/source/_components/binary_sensor.markdown +++ b/source/_components/binary_sensor.markdown @@ -16,7 +16,7 @@ ha_release: 0.9 Binary sensors gather information about the state of devices which have a "digital" return value (either 1 or 0). These can be switches, contacts, pins, etc. These sensors only have two states: **0/off/low/closed/false** and **1/on/high/open/true**. Knowing that there are only two states allows Home Assistant to represent these sensors in a better way in the frontend according to their functionality. -### {% linkable_title Device Class %} +### Device Class The way these sensors are displayed in the frontend can be modified in the [customize section](/getting-started/customizing-devices/). The following device classes are supported for binary sensors: diff --git a/source/_components/binary_sensor.modbus.markdown b/source/_components/binary_sensor.modbus.markdown index 4fd3dd2ffca..f5ecf118eea 100644 --- a/source/_components/binary_sensor.modbus.markdown +++ b/source/_components/binary_sensor.modbus.markdown @@ -16,7 +16,7 @@ ha_iot_class: Local Push The `modbus` binary sensor allows you to gather data from [Modbus](http://www.modbus.org/) coils. -## {% linkable_title Configuration %} +## Configuration To use your Modbus binary sensors in your installation, add the following to your `configuration.yaml` file: @@ -62,7 +62,7 @@ coils: It's possible to change the default 30 seconds scan interval for the sensor updates as shown in the [Platform options](/docs/configuration/platform_options/#scan-interval) documentation. -## {% linkable_title Full example %} +## Full example Example a sensor with a 10 seconds scan interval: diff --git a/source/_components/binary_sensor.mqtt.markdown b/source/_components/binary_sensor.mqtt.markdown index 3aec89fc491..4fa2ad249e9 100644 --- a/source/_components/binary_sensor.mqtt.markdown +++ b/source/_components/binary_sensor.mqtt.markdown @@ -20,7 +20,7 @@ The binary sensor state will be updated only after a new message is published on the binary sensor will receive an instant state update after subscription and Home Assistant will display the correct state on startup. Otherwise, the initial state displayed in Home Assistant will be `unknown`. -## {% linkable_title Configuration %} +## Configuration The `mqtt` binary sensor platform optionally supports an `availability_topic` to receive online and offline messages (birth and LWT messages) from the MQTT device. During normal operation, if the MQTT sensor device goes offline (i.e., publishes `payload_not_available` to `availability_topic`), Home Assistant will display the binary sensor as `unavailable`. If these messages are published with the `retain` flag set, the binary sensor will receive an instant update after subscription and Home Assistant will display the correct availability state of the binary sensor when Home Assistant starts up. If the `retain` flag is not set, Home Assistant will display the binary sensor as `unavailable` when Home Assistant starts up. If no `availability_topic` is defined, Home Assistant will consider the MQTT device to be available. @@ -134,11 +134,11 @@ device: type: string {% endconfiguration %} -## {% linkable_title Examples %} +## Examples In this section, you will find some real-life examples of how to use this sensor. -### {% linkable_title Full configuration %} +### Full configuration To test, you can use the command line tool `mosquitto_pub` shipped with `mosquitto` or the `mosquitto-clients` package to send MQTT messages. @@ -168,7 +168,7 @@ binary_sensor: ``` {% endraw %} -### {% linkable_title Toggle the binary sensor each time a message is received on state_topic %} +### Toggle the binary sensor each time a message is received on state_topic {% raw %} ```yaml # Example configuration.yaml entry @@ -179,7 +179,7 @@ binary_sensor: ``` {% endraw %} -### {% linkable_title Get the state of a device with ESPEasy %} +### Get the state of a device with ESPEasy Assuming that you have flashed your ESP8266 unit with [ESPEasy](https://github.com/letscontrolit/ESPEasy). Under "Config" is a name ("Unit Name:") set for your device (here it's "bathroom"). A configuration for a "Controller" for MQTT with the protocol "OpenHAB MQTT" is present and the entries ("Controller Subscribe:" and "Controller Publish:") are adjusted to match your needs. In this example, the topics are prefixed with "home". Also, add a "Switch Input" in the "Devices" tap with the name "switch" and "button" as value. diff --git a/source/_components/binary_sensor.mysensors.markdown b/source/_components/binary_sensor.mysensors.markdown index 34c2559af8a..26bd943d707 100644 --- a/source/_components/binary_sensor.mysensors.markdown +++ b/source/_components/binary_sensor.mysensors.markdown @@ -39,7 +39,7 @@ S_MOISTURE | V_TRIPPED For more information, visit the [serial api] of MySensors. -### {% linkable_title Example sketch %} +### Example sketch ```cpp /** diff --git a/source/_components/binary_sensor.rest.markdown b/source/_components/binary_sensor.rest.markdown index b35c6ba008a..c551709bef9 100644 --- a/source/_components/binary_sensor.rest.markdown +++ b/source/_components/binary_sensor.rest.markdown @@ -34,7 +34,7 @@ The JSON messages can contain different values like `1`, `"1"`, } ``` -## {% linkable_title Configuration %} +## Configuration To enable this sensor, add the following lines to your `configuration.yaml` file for a GET request: @@ -118,11 +118,11 @@ headers: Make sure that the URL exactly matches your endpoint or resource.

-## {% linkable_title Examples %} +## Examples In this section you find some real-life examples of how to use this sensor. -### {% linkable_title aREST sensor %} +### aREST sensor Instead of using an [aREST](/components/binary_sensor.arest/) binary sensor, you could retrieve the value of a device supporting @@ -138,7 +138,7 @@ binary_sensor: value_template: {% raw %}'{{ value_json.return_value }}'{% endraw %} ``` -### {% linkable_title Accessing an HTTP authentication protected endpoint %} +### Accessing an HTTP authentication protected endpoint The REST sensor supports HTTP authentication and customized headers. diff --git a/source/_components/binary_sensor.rflink.markdown b/source/_components/binary_sensor.rflink.markdown index af278eaac7c..005e1103066 100644 --- a/source/_components/binary_sensor.rflink.markdown +++ b/source/_components/binary_sensor.rflink.markdown @@ -69,15 +69,15 @@ devices: default: false {% endconfiguration %} -### {% linkable_title Sensor state %} +### Sensor state Initially, the state of a binary sensor is unknown. When a sensor update is received, the state is known and will be shown in the frontend. -### {% linkable_title Device support %} +### Device support See [device support](/components/rflink/#device-support) -### {% linkable_title Additional configuration examples %} +### Additional configuration examples Multiple sensors with custom name and device class and set off_delay diff --git a/source/_components/binary_sensor.rfxtrx.markdown b/source/_components/binary_sensor.rfxtrx.markdown index 2770ffc60a3..dc0c63f2201 100644 --- a/source/_components/binary_sensor.rfxtrx.markdown +++ b/source/_components/binary_sensor.rfxtrx.markdown @@ -23,7 +23,7 @@ them may be recognized under the X10 protocol but most of them are recognized under the *Lighting4* protocol. The rfxtrx binary sensor integration provides some special options for them, while other rfxtrx protocols should work too. -## {% linkable_title Setting up your devices %} +## Setting up your devices Once you have set up your [rfxtrx hub](/components/rfxtrx/), the easiest way to find your binary sensors is to add this to your `configuration.yaml`: @@ -133,7 +133,7 @@ binary_sensor: seconds: 5 ``` -### {% linkable_title Options for PT-2262 devices under the Lighting4 protocol %} +### Options for PT-2262 devices under the Lighting4 protocol When a data packet is transmitted by a PT-2262 device using the Lighting4 protocol, there is no way to automatically extract the device identifier and the @@ -203,7 +203,7 @@ This automatic guess should work most of the time but there is no guarantee on that. You should activate it only when you want to configure your new devices and leave it off otherwise. -### {% linkable_title Known working devices %} +### Known working devices The following devices are known to work with the rfxtrx binary sensor component. There are too many other to list. diff --git a/source/_components/binary_sensor.template.markdown b/source/_components/binary_sensor.template.markdown index 8212202166a..48b55320fa0 100644 --- a/source/_components/binary_sensor.template.markdown +++ b/source/_components/binary_sensor.template.markdown @@ -19,7 +19,7 @@ The `template` platform supports binary sensors which get their values from other entities. The state of a Template Binary Sensor can only be `on` or `off`. -## {% linkable_title Configuration %} +## Configuration Here is an example of adding a Template Binary Sensor to the `configuration.yaml` file: @@ -82,7 +82,7 @@ sensors: type: time {% endconfiguration %} -## {% linkable_title Considerations %} +## Considerations ### Startup @@ -104,11 +104,11 @@ the contents of a group. In this case you can use `entity_id` to provide a list of entity IDs that will cause the sensor to update or you can run the service `homeassistant.update_entity` to update the sensor at will. -## {% linkable_title Examples %} +## Examples In this section you find some real-life examples of how to use this sensor. -### {% linkable_title Sensor Threshold %} +### Sensor Threshold This example indicates true if a sensor is above a given threshold. Assuming a sensor of `furnace` that provides a current reading for the fan motor, we can @@ -126,7 +126,7 @@ binary_sensor: ``` {% endraw %} -### {% linkable_title Switch as Sensor %} +### Switch as Sensor Some movement sensors and door/window sensors will appear as a switch. By using a Template Binary Sensor, the switch can be displayed as a binary sensors. The @@ -147,7 +147,7 @@ binary_sensor: ``` {% endraw %} -### {% linkable_title Combining Multiple Sensors %} +### Combining Multiple Sensors This example combines multiple CO sensors into a single overall status. When using templates with binary sensors, you need to return @@ -168,7 +168,7 @@ binary_sensor: ``` {% endraw %} -### {% linkable_title Washing Machine Running %} +### Washing Machine Running This example creates a washing machine "load running" sensor by monitoring an energy meter connected to the washer. During the washer's operation, the energy @@ -191,7 +191,7 @@ binary_sensor: ``` {% endraw %} -### {% linkable_title Is Anyone Home? %} +### Is Anyone Home? This example is determining if anyone is home based on the combination of device tracking and motion sensors. It's extremely useful if you have kids/baby sitter/ @@ -216,7 +216,7 @@ binary_sensor: ``` {% endraw %} -### {% linkable_title Change the icon when state changes %} +### Change the icon when state changes This example demonstrates how to use `icon_template` to change the entity's icon as its state changes, it evaluates the state of its own sensor and uses a diff --git a/source/_components/binary_sensor.xiaomi_aqara.markdown b/source/_components/binary_sensor.xiaomi_aqara.markdown index 4aae23f5a9c..f998800dda5 100644 --- a/source/_components/binary_sensor.xiaomi_aqara.markdown +++ b/source/_components/binary_sensor.xiaomi_aqara.markdown @@ -18,7 +18,7 @@ The `xiaomi aqara` binary sensor platform allows you to get data from your [Xiao The requirement is that you have setup the [`xiaomi aqara` integration](/components/xiaomi_aqara/). -### {% linkable_title Type of sensors supported %} +### Type of sensors supported | Name | Zigbee entity | Model no. | States | Event | Event key | Event values | | ---- | ------------- | --------- | ------ | ----- | --------- | ------------ | @@ -39,9 +39,9 @@ The requirement is that you have setup the [`xiaomi aqara` integration](/compone | Cube | cube | MFKZQ01LM | off (always) | `xiaomi_aqara.cube_action` | `action_type`, `action_value` (rotate) | `flip90`, `flip180`, `move`, `tap_twice`, `shake_air`, `swing`, `alert`, `free_fall`, `rotate` (degrees at action_value) | | Vibration Sensor | vibration | DJT11LM | off (always) | `xiaomi_aqara.movement` | `movement_type` | `vibrate`, `tilt`, `free_fall` | -### {% linkable_title Automation examples %} +### Automation examples -#### {% linkable_title Motion %} +#### Motion ```yaml - alias: If there is motion and its dark turn on the gateway light @@ -78,7 +78,7 @@ The requirement is that you have setup the [`xiaomi aqara` integration](/compone entity_id: automation.Motion_off ``` -#### {% linkable_title Door and/or Window %} +#### Door and/or Window ```yaml - alias: If the window is open turn off the radiator @@ -107,7 +107,7 @@ The requirement is that you have setup the [`xiaomi aqara` integration](/compone operation_mode: 'Smart schedule' ``` -#### {% linkable_title Smoke %} +#### Smoke ```yaml - alias: Send notification on fire alarm @@ -128,7 +128,7 @@ The requirement is that you have setup the [`xiaomi aqara` integration](/compone ringtone_vol: 100 ``` -#### {% linkable_title Gas %} +#### Gas ```yaml - alias: Send notification on gas alarm @@ -144,7 +144,7 @@ The requirement is that you have setup the [`xiaomi aqara` integration](/compone message: 'Gas with a density of {% raw %}{{ state_attr('binary_sensor.natgas_sensor_158dxxxxxxxxxx', 'density') }}{% endraw %} detected.' ``` -#### {% linkable_title Xiaomi Wireless Button %} +#### Xiaomi Wireless Button As indicated in the table on top of this page there are 3 versions of the button. For the round shaped button the available events are `single`, `double`, `hold`, `long_click_press` and `long_click_release`. Aqara branded buttons are square shaped. Model WXKG11LM only supports `single` and `double` events. WXKG12LM supports `single`, `double`, `long_click_press` and `shake` events. For the Aqara versions the delay between two clicks to generate a double click must be larger than with the round button. Clicking too quickly generates a single click event. @@ -184,7 +184,7 @@ As indicated in the table on top of this page there are 3 versions of the button ringtone_vol: 8 ``` -#### {% linkable_title Xiaomi Cube %} +#### Xiaomi Cube Available events are `flip90`, `flip180`, `move`, `tap_twice`, `shake_air`, `swing`, `alert`, `free_fall` and `rotate`. The integration stores the last action as the attribute `last_action`. @@ -251,7 +251,7 @@ Available events are `flip90`, `flip180`, `move`, `tap_twice`, `shake_air`, `swi color_name: "blue" ``` -#### {% linkable_title Aqara Wireless Switch %} +#### Aqara Wireless Switch The Aqara Wireless Switch is available as single-key and double-key version. Each key behaves like the Wireless Button limited to the click event `single`. The double key version adds a third device called `binary_sensor.wall_switch_both_158xxxxxxxxx12` which reports a click event called `both` if both keys are pressed. @@ -312,7 +312,7 @@ The Aqara Wireless Switch is available as single-key and double-key version. Eac entity_id: light.gateway_light_34xxxxxxxx13 ``` -#### {% linkable_title Vibration Sensor %} +#### Vibration Sensor This automation toggles the living room lamp on vibration/tilt. diff --git a/source/_components/blackbird.markdown b/source/_components/blackbird.markdown index aaca513c055..daf32ef63fb 100644 --- a/source/_components/blackbird.markdown +++ b/source/_components/blackbird.markdown @@ -58,7 +58,7 @@ sources: description: The name of the source. {% endconfiguration %} -### {% linkable_title Service `media_player.blackbird_set_all_zones` %} +### Service `media_player.blackbird_set_all_zones` Set all zones to the same input source. This service allows you to immediately synchronize all the TVs in your home. Regardless of `entity_id` provided, all zones will be updated. diff --git a/source/_components/blink.markdown b/source/_components/blink.markdown index aa87420e647..465f2753dee 100644 --- a/source/_components/blink.markdown +++ b/source/_components/blink.markdown @@ -25,11 +25,11 @@ redirect_from: The `blink` integration lets you view camera images and motion events from [Blink](http://blinkforhome.com) camera and security systems. -## {% linkable_title Setup %} +## Setup You will need your Blink login information (username, which is usually your email address, and password) to use this module. -## {% linkable_title Configuration %} +## Configuration To enable devices linked in your [Blink](https://blinkforhome.com) account, add the following to your `configuration.yaml` file: @@ -115,15 +115,15 @@ blink: - wifi_strength ``` -## {% linkable_title Services %} +## Services Any sequential calls to services relating to blink should have a minimum of a 5 second delay in between them to prevent the calls fro being throttled and ignored. -### {% linkable_title `blink.blink_update` %} +### `blink.blink_update` Force a refresh of the Blink system. -### {% linkable_title `blink.trigger_camera` %} +### `blink.trigger_camera` Trigger a camera to take a new still image. @@ -131,7 +131,7 @@ Trigger a camera to take a new still image. |------------------------|----------|----------------------------------------| | `name` | no | Name of camera to take new image with. | -### {% linkable_title `blink.save_video` %} +### `blink.save_video` Save the last recorded video of a camera to a local file. Note that in most cases, Home Assistant will need to know that the directory is writable via the `whitelist_external_dirs` in your `configuration.yaml` file (see example below). @@ -149,16 +149,16 @@ homeassistant: - '/path/to/whitelist' ``` -### {% linkable_title Other Services %} +### Other Services In addition to the services mentioned above, there are generic `camera` and `alarm_control_panel` services available for use as well. The `camera.enable_motion_detection` and `camera.disable_motion_detection` services allow for individual cameras to be enabled and disabled, respectively, within the Blink system. The `alarm_control_panel.alarm_arm_away` and `alarm_control_panel.alarm_disarm` services allow for the whole system to be armed and disarmed, respectively. -## {% linkable_title Examples %} +## Examples The following are some examples showing how to correctly make service calls using Blink: -### {% linkable_title Snap Picture and Save Locally %} +### Snap Picture and Save Locally This example script shows how to take a picture with your camera, named `My Camera` in your Blink app (this is **not necessarily** the friendly name in home-assistant). After snapping a picture, the image will then be saved to a local directory called `/tmp/my_image.jpg`. Note that this example makes use of services found in the [camera integration](https://www.home-assistant.io/components/camera#service-snapshot) @@ -176,7 +176,7 @@ sequence: filename: /tmp/my_image.jpg ``` -### {% linkable_title Arm Blink When Away %} +### Arm Blink When Away This example automation will arm your blink sync module to detect motion on any of your blink cameras that have motion detection enabled. By default, Blink enables motion detection on all cameras so, unless you've changed anything in your app, you're all set. If you want to manually enable motion detection for individual cameras, you can utilize the [appropriate camera service](https://www.home-assistant.io/components/camera#service-enable_motion_detection) but pelase note that motion will only be captured if the sync module is armed. @@ -194,7 +194,7 @@ Here, this example assumes your blink module is named `My Sync Module` and that entity_id: alarm_control_panel.blink_my_sync_module ``` -### {% linkable_title Disarm Blink When Home %} +### Disarm Blink When Home Similar to the previous example, this automation will disarm blink when arriving home. @@ -210,7 +210,7 @@ Similar to the previous example, this automation will disarm blink when arriving entity_id: alarm_control_panel.blink_my_sync_module ``` -### {% linkable_title Save Video Locally When Motion Detected %} +### Save Video Locally When Motion Detected When motion is detected, you can use the Blink Home-Assistant integration to save the last recorded video locally, rather than relying on Blink's servers to save your data. diff --git a/source/_components/blinksticklight.markdown b/source/_components/blinksticklight.markdown index 84549b1edc1..f0af6ec55de 100644 --- a/source/_components/blinksticklight.markdown +++ b/source/_components/blinksticklight.markdown @@ -19,7 +19,7 @@ redirect_from: The `blinkstick` platform lets you control your [Blinkstick](https://www.blinkstick.com/) lights from within Home Assistant. -## {% linkable_title Setup %} +## Setup To use your Blinkstick, you need to allow the access to the device for [non-root users](https://github.com/arvydas/blinkstick-python#permission-problems-in-linux-and-mac-os-x). @@ -27,7 +27,7 @@ To use your Blinkstick, you need to allow the access to the device for [non-root $ sudo blinkstick --add-udev-rule ``` -## {% linkable_title Configuration %} +## Configuration To add a Blinkstick to your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/blinkt.markdown b/source/_components/blinkt.markdown index 82e8c0899b8..320c456c96c 100644 --- a/source/_components/blinkt.markdown +++ b/source/_components/blinkt.markdown @@ -18,7 +18,7 @@ redirect_from: The `blinkt` light platform lets you control the [Blinkt!](https://shop.pimoroni.com/products/blinkt) board, featuring eight super-bright RGB LEDs. -## {% linkable_title Configuration %} +## Configuration To enable `blinkt` in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/bloomsky.markdown b/source/_components/bloomsky.markdown index fb698d76d57..6f10f46ef47 100644 --- a/source/_components/bloomsky.markdown +++ b/source/_components/bloomsky.markdown @@ -27,11 +27,11 @@ There is currently support for the following device types within Home Assistant: - [Camera](#camera) - [Sensor](#sensor) -## {% linkable_title Setup %} +## Setup Obtain your API key from your [BloomSky dashboard](https://dashboard.bloomsky.com). Click `developers` in the bottom left of the screen. -## {% linkable_title Configuration %} +## Configuration To integrate your BloomSky hub with Home Assistant, add the following section to your `configuration.yaml` file: @@ -48,13 +48,13 @@ api_key: type: string {% endconfiguration %} -## {% linkable_title Binary Sensor %} +## Binary Sensor The `bloomsky` binary sensor platform allows you to get data from your BloomSky device. To get your BloomSky binary sensors working with Home Assistant, follow the instructions above first. -### {% linkable_title Configuration %} +### Configuration To use your BloomSky binary sensor in your installation, add the following to your `configuration.yaml` file: @@ -79,11 +79,11 @@ monitored_conditions: description: Rain {% endconfiguration %} -## {% linkable_title Camera %} +## Camera The `bloomsky` camera integration allows you to view the current photo created by the camera in the [BloomSky](https://www.bloomsky.com) weather station. This can work in concert with [BloomSky sensors](#sensor). -### {% linkable_title Configuration %} +### Configuration To enable this camera in your installation, set up the BloomSky integration with your API key and add the following to your `configuration.yaml` file: @@ -93,11 +93,11 @@ camera: - platform: bloomsky ``` -## {% linkable_title Sensor %} +## Sensor The `bloomsky` sensor integration allows you to view the measurements made by sensors in the [BloomSky](https://www.bloomsky.com) weather station. This can work in concert with the [BloomSky camera](#camera). -### {% linkable_title Configuration %} +### Configuration To enable these sensors in your installation, set up the BloomSky integration with your API key add the following to your `configuration.yaml` file: diff --git a/source/_components/bluesound.markdown b/source/_components/bluesound.markdown index e52956fde09..370c7a4ec39 100644 --- a/source/_components/bluesound.markdown +++ b/source/_components/bluesound.markdown @@ -63,7 +63,7 @@ media_player: - host: 192.168.1.131 ``` -### {% linkable_title Service `bluesound_join` %} +### Service `bluesound_join` Group players together under a single master speaker. That will make a new group or join an existing group. @@ -72,7 +72,7 @@ Group players together under a single master speaker. That will make a new group | `master` | no | A single `entity_id` that will become/hold the master speaker. | `entity_id` | no | String or list of a single `entity_id` that will group to master speaker. -### {% linkable_title Service `bluesound_unjoin` %} +### Service `bluesound_unjoin` Remove one or more speakers from a group of speakers. If no `entity_id` is provided, all speakers are unjoined. @@ -80,7 +80,7 @@ Remove one or more speakers from a group of speakers. If no `entity_id` is provi | ---------------------- | -------- | ----------- | | `entity_id` | yes | String or list of `entity_id`s that will be separated from their master speaker. -### {% linkable_title Service `bluesound_set_sleep_timer` %} +### Service `bluesound_set_sleep_timer` Sets a timer that will turn off the speaker. For each time you call this it will increase the time by one step. The steps are (in minutes): 15, 30, 45, 60, 90, 0. If you increase an ongoing timer of for example 13 minutes, it will increase it to 15. If the timer is set to 90, it will remove the time (hence the 0). @@ -89,7 +89,7 @@ If you increase an ongoing timer of for example 13 minutes, it will increase it | ---------------------- | -------- | ----------- | | `entity_id` | no | String or list of `entity_id`s that will have their timers set. -### {% linkable_title Service `bluesound_clear_sleep_timer` %} +### Service `bluesound_clear_sleep_timer` Clear the sleep timer on a speaker, if one is set. diff --git a/source/_components/bluetooth_le_tracker.markdown b/source/_components/bluetooth_le_tracker.markdown index c02b89fc100..aeb85d85692 100644 --- a/source/_components/bluetooth_le_tracker.markdown +++ b/source/_components/bluetooth_le_tracker.markdown @@ -55,7 +55,7 @@ interval_seconds: As some BT LE devices change their MAC address regularly, a new device is only discovered when it has been seen 5 times. Some BTLE devices (e.g., fitness trackers) are only visible to the devices that they are paired with. In this case, the BTLE tracker won't see this device. -## {% linkable_title Rootless Setup %} +## Rootless Setup Normally accessing the Bluetooth stack is reserved for root, but running programs that are networked as root is a bad security wise. To allow non-root access to the Bluetooth stack we can give Python 3 and hcitool the missing capabilities to access the Bluetooth stack. Quite like setting the setuid bit (see [Stack Exchange](http://unix.stackexchange.com/questions/96106/bluetooth-le-scan-as-non-root) for more information). diff --git a/source/_components/bme280.markdown b/source/_components/bme280.markdown index 097b46240f5..501fca6feff 100644 --- a/source/_components/bme280.markdown +++ b/source/_components/bme280.markdown @@ -22,7 +22,7 @@ Tested devices: - [Raspberry Pi](https://www.raspberrypi.org/) -## {% linkable_title Configuration %} +## Configuration To use your BME280 sensor in your installation, add the following to your `configuration.yaml` file: @@ -90,7 +90,7 @@ monitored_conditions: type: list {% endconfiguration %} -## {% linkable_title Full Examples %} +## Full Examples If you want to specify the working mode of the digital sensor or need to change the default I2c address (which is 0x76), add more details to the `configuration.yaml` file: @@ -115,7 +115,7 @@ sensor: This sensor is somehow famous for generating relatively high temperature measurements compared to other sensors (it looks like self-heating does not feel good for some encapsulations). If you experience this problem, you can define an absolute delta of temperature correction using a negative number. -## {% linkable_title Customizing the sensor data %} +## Customizing the sensor data Give the values friendly names and icons, add the following to your `customize:` section. @@ -146,7 +146,7 @@ group: - sensor.ambient_pressure ``` -## {% linkable_title Directions for installing smbus support on Raspberry Pi %} +## Directions for installing smbus support on Raspberry Pi Enable I2c interface with the Raspberry Pi configuration utility: @@ -170,7 +170,7 @@ $ sudo addgroup homeassistant i2c $ sudo reboot ``` -### {% linkable_title Check the i2c address of the sensor %} +### Check the i2c address of the sensor After installing `i2c-tools`, a new utility is available to scan the addresses of the connected sensors: diff --git a/source/_components/bme680.markdown b/source/_components/bme680.markdown index a2cd6ce52a1..b4b99793268 100644 --- a/source/_components/bme680.markdown +++ b/source/_components/bme680.markdown @@ -22,7 +22,7 @@ Tested devices: - [Raspberry Pi](https://www.raspberrypi.org/) -## {% linkable_title Configuration %} +## Configuration To use your BME680 sensor in your installation, add the following to your `configuration.yaml` file: @@ -120,7 +120,7 @@ temp_offset: type: float {% endconfiguration %} -## {% linkable_title Full Examples %} +## Full Examples If you want to specify the working mode of the digital sensor or need to change the default I2C address (which is 0x77), add more details to the `configuration.yaml` file: @@ -149,7 +149,7 @@ sensor: temp_offset: -5.5 ``` -## {% linkable_title Customizing the sensor data %} +## Customizing the sensor data Give the values friendly names and icons, add the following to your `customize:` section. @@ -188,11 +188,11 @@ group: - sensor.bme680_sensor_air_quality ``` -## {% linkable_title Directions for enabling I2C interface on Hass.io %} +## Directions for enabling I2C interface on Hass.io Follow the instructions here to [enable I2C on Hass.io.](/hassio/enable_i2c/). -## {% linkable_title Directions for installing SMBus support on Raspberry Pi %} +## Directions for installing SMBus support on Raspberry Pi Enable I2C interface with the Raspberry Pi configuration utility: @@ -216,7 +216,7 @@ $ sudo addgroup homeassistant i2c $ sudo reboot ``` -### {% linkable_title Check the I2C address of the sensor %} +### Check the I2C address of the sensor After installing `i2c-tools`, a new utility is available to scan the addresses of the connected sensors: diff --git a/source/_components/bmw_connected_drive.markdown b/source/_components/bmw_connected_drive.markdown index f3b96b9aa51..0adea3cfc35 100644 --- a/source/_components/bmw_connected_drive.markdown +++ b/source/_components/bmw_connected_drive.markdown @@ -36,7 +36,7 @@ This integration provides the following platforms: - Sensors: Mileage, remaining range, remaining fuel, charging time remaining (electric cars), charging status (electric cars), remaining range electric (electric cars). - Services: Turn on air condition, sound the horn, flash the lights and update the state. More details can be found [here](/components/bmw_connected_drive/#services). -## {% linkable_title Configuration %} +## Configuration To enable this integration in your installation, add the following to your `configuration.yaml` file: @@ -79,17 +79,17 @@ bmw_connected_drive: default: false {% endconfiguration %} -## {% linkable_title Services %} +## Services The `bmw_connected_drive` integration offers several services. In case you need to provide the vehicle identification number (VIN) as a parameter, you can see the VIN in the attributes of the device tracker for the vehicle. The VIN is a 17 digit alphanumeric string, e.g., `WBANXXXXXX1234567`. Using these services will impact the state of your vehicle. So use these services with care! -### {% linkable_title Locking and unlocking %} +### Locking and unlocking The vehicle can be locked and unlocked via the lock integration that is created automatically for each vehicle. Before invoking these services, make sure it's safe to lock/unlock the vehicle in the current situation. -### {% linkable_title Air condition %} +### Air condition The air condition of the vehicle can be activated with the service `bmw_connected_drive.activate_air_conditioning`. @@ -97,20 +97,20 @@ What exactly is started here depends on the type of vehicle. It might range from The vehicle is identified via the parameter `vin`. -### {% linkable_title Sound the horn %} +### Sound the horn The service `bmw_connected_drive.sound_horn` sounds the horn of the vehicle. This option is not available in some countries (among which the UK). Use this feature responsibly, as it might annoy your neighbors. The vehicle is identified via the parameter `vin`. -### {% linkable_title Flash the lights %} +### Flash the lights The service `bmw_connected_drive.light_flash` flashes the lights of the vehicle. The vehicle is identified via the parameter `vin`. -### {% linkable_title Update the state %} +### Update the state The service `bmw_connected_drive.update_state` fetches the last state of the vehicles of all your accounts from the BMW server. This does *not* trigger an update from the vehicle; it gets the data from the BMW servers. So this service does *not* interact with your vehicles. This service does not require any attributes. -## {% linkable_title Disclaimer %} +## Disclaimer This software is not affiliated with or endorsed by BMW Group. diff --git a/source/_components/bom.markdown b/source/_components/bom.markdown index dd1fbfcd7cd..ec69cbff90a 100644 --- a/source/_components/bom.markdown +++ b/source/_components/bom.markdown @@ -26,7 +26,7 @@ There is currently support for the following device types within Home Assistant: - [Camera](#camera) - [Sensor](#sensor) -## {% linkable_title Configuration %} +## Configuration To add the BOM weather platform to your installation, add the following to your `configuration.yaml` file: @@ -53,7 +53,7 @@ This platform is an alternative to the [`bom`](#sensor) sensor. The weather platform is easier to configure but less customizable.

-## {% linkable_title Camera %} +## Camera The `bom` camera platform uses the [Australian Bureau of Meteorology (BOM)](http://www.bom.gov.au) [radar web service](http://www.bom.gov.au/australia/radar/) as a source to generate an animated radar image. @@ -95,7 +95,7 @@ filename: type: string {% endconfiguration %} -### {% linkable_title Valid `location` values %} +### Valid `location` values ``` Adelaide Albany AliceSprings Bairnsdale Bowen @@ -112,9 +112,9 @@ Weipa WillisIs Wollongong Woomera Wyndham Yarrawonga ``` -### {% linkable_title Examples %} +### Examples -#### {% linkable_title Using `location` and `name` %} +#### Using `location` and `name` Example `configuration.yaml` entry to display the `Townsville` radar with a camera named `mytowsvilleradar`: @@ -125,7 +125,7 @@ camera: location: Townsville ``` -#### {% linkable_title Using `id`, `delta` and `frames` %} +#### Using `id`, `delta` and `frames` In the event BOM creates a new radar, or a radar's ID changes, you may define a custom `id` along with corresponding `delta` and `frames` values. You may also specify custom `delta` and `frames` values, along with a valid `location`, to override the default values for an existing radar. You may not define `location` and `id` in the same entity; you must specify one or the other. If `id` is specified, then `delta` and `frames` values _must_ be provided. If `location` is specified, `delta` and `frames` _may_ be provided to override the default values. @@ -148,7 +148,7 @@ camera: name: 'Carnarvon' ``` -#### {% linkable_title Using `filename` %} +#### Using `filename` This option can be specified to save the animated radar-imagery GIF to the given filesystem path. @@ -163,7 +163,7 @@ camera: The file will be updated every `delta` seconds when the camera regenerates the animation. -## {% linkable_title Sensor %} +## Sensor The `bom` sensor platform uses the [Australian Bureau of Meteorology (BOM)](http://www.bom.gov.au) as a source for current (half-hourly) meteorological data. diff --git a/source/_components/braviatv.markdown b/source/_components/braviatv.markdown index 15ca122bfdf..4e87c7362fd 100644 --- a/source/_components/braviatv.markdown +++ b/source/_components/braviatv.markdown @@ -49,11 +49,11 @@ You are also able to configure the TV manually by placing a `bravia.conf` file i {"192.168.0.10": {"pin": "7745", "mac": "ac:1e:0a:e1:0c:01"}} ``` -## {% linkable_title For TVs older than 2013 %} +## For TVs older than 2013 Users of TVs older than 2013 have another option for controlling their TV via Home Assistant. -### {% linkable_title Using HDMI-CEC %} +### Using HDMI-CEC If you have a Raspberry Pi connected to your TV: diff --git a/source/_components/broadcast.markdown b/source/_components/broadcast.markdown index 5c865eeac30..806ee3253aa 100644 --- a/source/_components/broadcast.markdown +++ b/source/_components/broadcast.markdown @@ -17,7 +17,7 @@ redirect_from: Telegram implementation to support **sending messages only**. Your Home Assistant instance does not have to be exposed to the Internet and there is no polling to receive messages sent to the bot. -## {% linkable_title Configuration %} +## Configuration To integrate this into Home Assistant, add the following section to your `configuration.yaml` file: diff --git a/source/_components/broadlink.markdown b/source/_components/broadlink.markdown index 55efe41007b..cefa1cd990e 100644 --- a/source/_components/broadlink.markdown +++ b/source/_components/broadlink.markdown @@ -23,7 +23,7 @@ There is currently support for the following device types within Home Assistant: - [Sensor](#sensor) - [Switch](#switch) -## {% linkable_title Sensor %} +## Sensor The `broadlink` sensor platform let you monitor data from an RM2 and A1 E-air. There is currently no support for the cloud API. @@ -110,7 +110,7 @@ sensor: - temperature ``` -### {% linkable_title Microsoft Windows installation %} +### Microsoft Windows installation

The pycrypto library needs to be available on your platform. On a typical windows sysytem `pip install pycrypto` will fail, as a compiler needs to be installed first. @@ -124,11 +124,11 @@ Be sure to get the correct 64 or 32-bit binary for your system, the full command pip install --use-wheel --no-index --find-links=https://github.com/sfbahr/PyCrypto-Wheels/raw/master/pycrypto-2.6.1-cp35-none-win_amd64.whl pycrypto ``` -## {% linkable_title Switch %} +## Switch This `Broadlink` switch platform allow to you control Broadlink [devices](http://www.ibroadlink.com/). -### {% linkable_title Configuration %} +### Configuration To enable it, add the following lines to your `configuration.yaml`: @@ -208,7 +208,7 @@ slots: Information about how to install on Windows can be found [here](/components/sensor.broadlink/#microsoft-windows-installation). -### {% linkable_title How to obtain IR/RF packets? %} +### How to obtain IR/RF packets? Choose Call Service from the Developer Tools. Choose the service `broadlink.learn` from the list of **Available services:**, write in "Service Data" JSON with 1 field "host":"your_broadlink_IP" and hit **CALL SERVICE**. Press the button on your remote with in 20 seconds. The packet will be printed as a persistent notification in the States page of the web interface. @@ -288,7 +288,7 @@ switch: slot_4: 'Speaker slot' ``` -### {% linkable_title Service `broadlink.send` %} +### Service `broadlink.send` You can use the service `broadlink.send` to directly send IR packets without the need to assign a switch entity for each command. @@ -311,7 +311,7 @@ script: - "JgBGAJSTFDUUNhM2ExITEhMSExITEhM2EzYTNhQRFBEUERQRFBEUNRQ2ExITNhMSExITNhMSExITEhM2ExITNhQ1FBEUNhMADQUAAA==" ``` -### {% linkable_title Using E-Control remotes %} +### Using E-Control remotes If you already have your remotes learned on E-Control app you can use this method to "copy" them to Home Assistant. @@ -359,7 +359,7 @@ First get or learn all the remotes you want to add to Home Assistant in E-Contro 8. Convert the HEX codes to base64. Use [this](http://tomeko.net/online_tools/hex_to_base64.php?lang=en1) tool to convert the hex codes to base64 for use with Home Assistant. -### {% linkable_title Using iOS and Windows to obtain codes %} +### Using iOS and Windows to obtain codes 1. Use the E-Control app to learn the codes from all of your suitable remotes. Depending on the remote, try to add useful names for the buttons and/or the remotes. This will mean that you should only have to run this process once and will help with getting them quickly into Home Assistant. Dump the files in the app by navigating to the hamburger icon, select `share and select`, then choose `Share to other phones on WLAN`. @@ -407,7 +407,7 @@ First get or learn all the remotes you want to add to Home Assistant in E-Contro 6. Now there should be a file with the name of the remote you chose in the same directory ending in `.txt`. Open that up and it will contain the Base64 code required for Home Assistant. To ensure these codes work correctly you may need to add `==` to the end of the code in your config.yaml file (or wherever you have your switches). -### {% linkable_title Using Windows to obtain codes with Broadlink Manager %} +### Using Windows to obtain codes with Broadlink Manager 1. Install Broadlink Manager from this SourceForge link [here](https://sourceforge.net/projects/broadlink-manager/). 2. Open the application and hit "scan" to activate your broadlink device. @@ -415,7 +415,7 @@ First get or learn all the remotes you want to add to Home Assistant in E-Contro 4. The "OnRawData Base64" is the value to be used with Home Assistant. -### {% linkable_title Using Node-RED to obtain codes %} +### Using Node-RED to obtain codes 1. Install the Broadlink Control palette in Node-RED (click the Hamburger menu at top right corner> Settings> Palette> Install and type Broadlink. Click install on the node-red-contrib-broadlink-control. 2. Once installed, verify that the new palette titled broadlink is available in the nodes menu. @@ -452,7 +452,7 @@ First get or learn all the remotes you want to add to Home Assistant in E-Contro ``` This is the code we need to transmit again to replicate the same remote function. -### {% linkable_title Using Node red to Transmit Codes %} +### Using Node red to Transmit Codes 1. Drag another RM node on the same flow we created earlier. The RM node should be configured to the RM device created earlier by default. 2. In the Action field, select - Set from msg.payload -. @@ -479,11 +479,11 @@ The "status" : "OK" at the end is a feedback that the Broadlink RM device is con Now you can add as many template nodes, each having a specific code, and add any type of input nodes to activate the template and transmit the code. -### {% linkable_title Using broadlink_cli to obtain codes %} +### Using broadlink_cli to obtain codes It is also possible to obtain codes using `broadlink_cli` from [python-broadlink](https://github.com/mjg59/python-broadlink) project. -### {% linkable_title Conversion of codes from other projects %} +### Conversion of codes from other projects For old/awkward devices another possibility is to try to get codes by using data gathered by the LIRC project. diff --git a/source/_components/brottsplatskartan.markdown b/source/_components/brottsplatskartan.markdown index 9844385f1d8..008a2d906da 100644 --- a/source/_components/brottsplatskartan.markdown +++ b/source/_components/brottsplatskartan.markdown @@ -18,7 +18,7 @@ redirect_from: The `brottsplatskartan` sensor allows one to track reported incidents occurring in a given area. Incidents include anything reported to [Brottsplatskartan](https://brottsplatskartan.se). The sensor only counts incidents from the current day. -## {% linkable_title Configuration %} +## Configuration To enable this sensor, add the following lines to your `configuration.yaml`. @@ -48,12 +48,12 @@ longitude: {% endconfiguration %} -## {% linkable_title Notes %} +## Notes -### {% linkable_title Area %} +### Area Brottsplatskartan captures all incidents in a region, e.g Stockholms län. If area parameter is defined, any latitude and longitude parameters are ignored. -### {% linkable_title Latitude and Longitude %} +### Latitude and Longitude The radius is set to 5 km when using latitude and longitude to monitor an area. It's not possible to explicitly set radius to another value. diff --git a/source/_components/browser.markdown b/source/_components/browser.markdown index be89e2b0fc5..b33e41d1c47 100644 --- a/source/_components/browser.markdown +++ b/source/_components/browser.markdown @@ -16,7 +16,7 @@ ha_release: pre 0.7 The `browser` integration provides a service to open URLs in the default browser on the host machine. -## {% linkable_title Configuration %} +## Configuration To load this component, add the following lines to your `configuration.yaml`: @@ -25,14 +25,14 @@ To load this component, add the following lines to your `configuration.yaml`: browser: ``` -#### {% linkable_title Service `browser/browse_url` %} +#### Service `browser/browse_url` | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | | `url` | no | The URL to open. -### {% linkable_title Usage %} +### Usage To use this service, choose **Call Service** from the **Developer Tools**. Choose the service *browser/browse_url* from the list of **Available services:** and enter the URL into the **Service Data** field and hit **CALL SERVICE**. diff --git a/source/_components/brunt.markdown b/source/_components/brunt.markdown index 3077d4388f8..20bbf768da0 100644 --- a/source/_components/brunt.markdown +++ b/source/_components/brunt.markdown @@ -18,7 +18,7 @@ redirect_from: The `brunt` platform allows one to control Blind Engines by [Brunt](https://www.brunt.co). To use this sensor, you need a Brunt App Account. All Brunt Blind devices registered to your account are automatically added to your Home Assistant with the names given them through the Brunt app. -## {% linkable_title Configuration %} +## Configuration To enable this integration, add the following lines to your `configuration.yaml`: diff --git a/source/_components/bt_smarthub.markdown b/source/_components/bt_smarthub.markdown index e78c068af05..b550004018d 100644 --- a/source/_components/bt_smarthub.markdown +++ b/source/_components/bt_smarthub.markdown @@ -19,7 +19,7 @@ redirect_from: This platform offers presence detection by looking at connected devices to a [BT Smart Hub](https://en.wikipedia.org/wiki/BT_Smart_Hub) based router. This router is sometimes referred to as the BT Home Hub 6. -## {% linkable_title Configuration %} +## Configuration To use a BT Smart Hub router in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/buienradar.markdown b/source/_components/buienradar.markdown index 88d54720c6e..2931cd336f8 100644 --- a/source/_components/buienradar.markdown +++ b/source/_components/buienradar.markdown @@ -20,7 +20,7 @@ The `buienradar` platform uses [buienradar.nl](http://buienradar.nl/) as a sourc The relevant weather station used will be automatically selected based on the location specified in the Home Assistant configuration (or in the Buienradar weather/sensor component). A map of all available weather stations can be found [here](https://www.google.com/maps/d/embed?mid=1NivHkTGQUOs0dwQTnTMZi8Uatj0). -## {% linkable_title Configuration %} +## Configuration To add the Buienradar weather to your installation, add the following to your `configuration.yaml` file: @@ -50,7 +50,7 @@ forecast: default: true {% endconfiguration %} -### {% linkable_title Full configuration %} +### Full configuration A full configuration example: diff --git a/source/_components/caldav.markdown b/source/_components/caldav.markdown index 62d911f705a..64bf40cd27d 100644 --- a/source/_components/caldav.markdown +++ b/source/_components/caldav.markdown @@ -22,7 +22,7 @@ that below). These sensors will be `on` if you have an on going event in that calendar or `off` if the event is later in time, or if there is no event at all. The WebDav calendar get updated roughly every 15 minutes. -### {% linkable_title Prerequisites %} +### Prerequisites You need to have a CalDav server and credentials for it. This integration was tested against [Baikal](http://sabre.io/baikal/) but any integration complying @@ -36,7 +36,7 @@ Python caldav library. On a Debian based system, install them by: $ sudo apt-get install libxml2-dev libxslt1-dev zlib1g-dev ``` -### {% linkable_title Basic Setup %} +### Basic Setup To integrate a WebDav calendar in Home Assistant, add the following section to your `configuration.yaml` file: @@ -65,7 +65,7 @@ your account. Those calendars will be `on` when there is an ongoing event and You have to setup custom calendars in order to take them into account or for advanced event filtering. -### {% linkable_title Custom calendars %} +### Custom calendars You have the possibility to create multiple binary sensors for events that match certain conditions. @@ -134,7 +134,7 @@ custom_calendars: type: string {% endconfiguration %} -### {% linkable_title Sensor attributes %} +### Sensor attributes - **offset_reached**: If set in the event title and parsed out will be on/off once the offset in the title in minutes is reached. So the title Very important meeting !!-10 would trigger this attribute to be on 10 minutes before the event starts. - **all_day**: `True/False` if this is an all day event. Will be `False` if there is no event found. @@ -144,7 +144,7 @@ custom_calendars: - **start_time**: Start time of event. - **end_time**: End time of event. -### {% linkable_title Examples %} +### Examples All events of the calendars "private" and "holidays". Note that all day events are not included. ```yaml diff --git a/source/_components/calendar.google.markdown b/source/_components/calendar.google.markdown index b5fcc847704..9ee52b731e1 100644 --- a/source/_components/calendar.google.markdown +++ b/source/_components/calendar.google.markdown @@ -22,7 +22,7 @@ configuration file `google_calendars.yaml` that will contain information about all of the calendars you can see. It also exposes a service to add an event to one of your Google Calendars. -## {% linkable_title Prerequisites %} +## Prerequisites Generate a Client ID and Client Secret on [Google Developers Console](https://console.developers.google.com/start/api?id=calendar). @@ -39,7 +39,7 @@ Generate a Client ID and Client Secret on If you are adding more Google API scopes later to the OAuth than just "Google Calendar API" then you need to delete your token file. You will lose your refresh token due to the re-authenticating to add more API access. It's recommended to use different authorizations for different pieces of Google. -## {% linkable_title Configuration %} +## Configuration To integrate Google Calendar in Home Assistant, add the following section to your `configuration.yaml` file: @@ -77,7 +77,7 @@ It will give you a URL and a code to enter. This will grant your Home Assistant service access to all the Google Calendars that the account you authenticate with can read. This is a Read-Only view of these calendars. -## {% linkable_title Calendar Configuration %} +## Calendar Configuration Editing the `google_calendars.yaml` file. @@ -165,7 +165,7 @@ If you use a `#` sign for `search` then wrap the whole search term in quotes. Otherwise everything following the hash sign would be considered a YAML comment.

-### {% linkable_title Sensor attributes %} +### Sensor attributes - **offset_reached**: If set in the event title and parsed out will be `on`/`off` once the offset in the title in minutes is reached. So the title `Very important meeting #Important !!-10` would trigger this attribute to be `on` 10 minutes before the event starts. - **all_day**: `true`/`false` if this is an all day event. Will be `false` if there is no event found. @@ -175,7 +175,7 @@ Otherwise everything following the hash sign would be considered a YAML comment. - **start_time**: Start time of event. - **end_time**: End time of event. -### {% linkable_title Service `google.add_event` %} +### Service `google.add_event` You can use the service `google.add_event` to create a new calendar event in a calendar. Calendar id's can be found in the file `google_calendars.yaml`. All dates and times are in your local time, the integration gets your time zone from your `configuration.yaml` file. @@ -194,7 +194,7 @@ You can use the service `google.add_event` to create a new calendar event in a c You either use `start_date_time` and `end_date_time`, or `start_date` and `end_date`, or `in`.

-## {% linkable_title Using calendar in automations %} +## Using calendar in automations A calendar can be used as an external scheduler for special events or reoccurring events instead of hardcoding them in automations. diff --git a/source/_components/camera.ffmpeg.markdown b/source/_components/camera.ffmpeg.markdown index 57e93d7d9f3..3240f027f2e 100644 --- a/source/_components/camera.ffmpeg.markdown +++ b/source/_components/camera.ffmpeg.markdown @@ -16,7 +16,7 @@ ha_iot_class: Local Polling The `ffmpeg` platform allows you to use any video feed as a camera in Home Assistant via [FFmpeg](http://www.ffmpeg.org/). This video source must support multiple simultaneous reads, because for every concurrent Home Assistant user, a connection will be made to the source every 10 seconds. Normally this should not be a problem. -## {% linkable_title Configuration %} +## Configuration To enable your FFmpeg feed in your installation you must first configure the [ffmpeg integration](/components/ffmpeg/), then add the following to your `configuration.yaml` file: @@ -43,7 +43,7 @@ extra_arguments: default: "-pred 1" {% endconfiguration %} -### {% linkable_title Image quality %} +### Image quality You can control the image quality with [`extra_arguments`](https://www.ffmpeg.org/ffmpeg-codecs.html#jpeg2000) `-q:v 2-32` or with lossless option `-pred 1`. Default is lossless. diff --git a/source/_components/camera.markdown b/source/_components/camera.markdown index 8df12502fdd..22eba9e3fbf 100644 --- a/source/_components/camera.markdown +++ b/source/_components/camera.markdown @@ -16,7 +16,7 @@ ha_release: 0.7 The camera integration allows you to use IP cameras with Home Assistant. -### {% linkable_title Streaming Video %} +### Streaming Video If your camera supports it, and the [`stream`](/components/stream) integration is setup, you will be able to stream your cameras in the frontend and on supported media players. @@ -28,13 +28,13 @@ This option will keep the stream alive, and preload the feed on Home Assistant s

-### {% linkable_title Services %} +### Services Once loaded, the `camera` platform will expose services that can be called to perform various actions. Available services: `turn_on`, `turn_off`, `enable_motion_detection`, `disable_motion_detection`, `snapshot`, and `play_stream`. -#### {% linkable_title Service `play_stream` %} +#### Service `play_stream` Play a live stream from a camera to selected media player(s). Requires [`stream`](/components/stream) integration to be set up. @@ -54,7 +54,7 @@ action: media_player: media_player.chromecast ``` -#### {% linkable_title Service `turn_on` %} +#### Service `turn_on` Turn on camera. Not all camera models support this service, please consult individual camera page. @@ -62,7 +62,7 @@ Turn on camera. Not all camera models support this service, please consult indiv | ---------------------- | -------- | ----------- | | `entity_id` | yes | Name(s) of entities to turn on, e.g., `camera.living_room_camera`. | -#### {% linkable_title Service `turn_off` %} +#### Service `turn_off` Turn off camera. Not all camera models support this service, please consult individual camera page. @@ -70,7 +70,7 @@ Turn off camera. Not all camera models support this service, please consult indi | ---------------------- | -------- | ----------- | | `entity_id` | yes | Name(s) of entities to turn off, e.g., `camera.living_room_camera`. | -#### {% linkable_title Service `enable_motion_detection` %} +#### Service `enable_motion_detection` Enable the motion detection in a camera. @@ -78,7 +78,7 @@ Enable the motion detection in a camera. | ---------------------- | -------- | ----------- | | `entity_id` | yes | Name(s) of entities to enable motion detection, e.g., `camera.living_room_camera`. | -#### {% linkable_title Service `disable_motion_detection` %} +#### Service `disable_motion_detection` Disable the motion detection in a camera. @@ -86,7 +86,7 @@ Disable the motion detection in a camera. | ---------------------- | -------- | ----------- | | `entity_id` | yes | Name(s) of entities to disable motion detection, e.g., `camera.living_room_camera`. | -#### {% linkable_title Service `snapshot` %} +#### Service `snapshot` Take a snapshot from a camera. @@ -109,7 +109,7 @@ action: ``` {% endraw %} -#### {% linkable_title Service `record` %} +#### Service `record` Make a `.mp4` recording from a camera stream. Requires `stream` integration to be set up. @@ -136,7 +136,7 @@ action: ``` {% endraw %} -### {% linkable_title Test if it works %} +### Test if it works A simple way to test if you have set up your `camera` platform correctly, is to use service developer tool icon **Services** from the **Developer Tools**. Choose your service from the dropdown menu **Service**, enter something like the sample below into the **Service Data** field, and hit **CALL SERVICE**. diff --git a/source/_components/camera.mqtt.markdown b/source/_components/camera.mqtt.markdown index 54d3a965af5..b3574c644e8 100644 --- a/source/_components/camera.mqtt.markdown +++ b/source/_components/camera.mqtt.markdown @@ -18,7 +18,7 @@ The `mqtt` camera platform allows you to integrate the content of an image file This can be used with an application or a service capable of sending images through MQTT, for example [Zanzito](https://play.google.com/store/apps/details?id=it.barbaro.zanzito). -## {% linkable_title Configuration %} +## Configuration To enable this camera in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/canary.markdown b/source/_components/canary.markdown index c115703c1e5..3ecdd85df5a 100644 --- a/source/_components/canary.markdown +++ b/source/_components/canary.markdown @@ -28,7 +28,7 @@ There is currently support for the following device types within Home Assistant: - [Camera](#camera) - [Sensor](#sensor) -## {% linkable_title Configuration %} +## Configuration You will need your Canary login information (username, usually your email address, and password) to use this module. @@ -65,13 +65,13 @@ Once loaded, your front end will have the following integrations: - A sensor per camera that reports humidity. - A sensor per camera that reports air quality. -## {% linkable_title Camera %} +## Camera The `canary` camera platform allows you to watch the live stream of your [Canary](https://canary.is) camera in Home Assistant. This requires the [`ffmpeg` integration](/components/ffmpeg/) to be already configured. Once you have [Canary integration](/components/canary/) setup, your [Canary](https://canary.is) camera(s) should show up automatically. -## {% linkable_title Configuration %} +## Configuration You can add the following to your `configuration.yaml` file to configure `canary` camera with optional settings: @@ -87,7 +87,7 @@ ffmpeg_arguments: type: string {% endconfiguration %} -## {% linkable_title Sensor %} +## Sensor The `canary` sensor platform allows you to integrate the sensors of your [Canary](https://canary.is) devices in Home Assistant. diff --git a/source/_components/cast.markdown b/source/_components/cast.markdown index 09529e9567b..02d31753b95 100644 --- a/source/_components/cast.markdown +++ b/source/_components/cast.markdown @@ -21,7 +21,7 @@ discovered if you enable [the discovery integration(/components/discovery/). If you don't have the discovery integration enabled, you can enable the Cast integration by going to the Integrations page inside the config panel. -## {% linkable_title Advanced use %} +## Advanced use The Cast integration has some extra configuration options available for advanced users. You will still need to create a config entry to initialize the Cast diff --git a/source/_components/cert_expiry.markdown b/source/_components/cert_expiry.markdown index a4dc3144eb0..e6719b83b4f 100644 --- a/source/_components/cert_expiry.markdown +++ b/source/_components/cert_expiry.markdown @@ -18,7 +18,7 @@ redirect_from: The `cert_expiry` sensor fetches information from a configured URL and displays the certificate expiry in days. -## {% linkable_title Configuration %} +## Configuration To add the Certificate Expiry sensor to your installation, add these options to `configuration.yaml` file: diff --git a/source/_components/channels.markdown b/source/_components/channels.markdown index f5a79bdb99a..9ab1f12dc0d 100644 --- a/source/_components/channels.markdown +++ b/source/_components/channels.markdown @@ -48,7 +48,7 @@ name: type: string {% endconfiguration %} -### {% linkable_title Service `channels_seek_forward` %} +### Service `channels_seek_forward` Seek forward by the number of seconds currently set in settings on the instance of Channels. @@ -57,7 +57,7 @@ Seek forward by the number of seconds currently set in settings on the instance | `entity_id` | no | String that points at `entity_id` of Channels app. -### {% linkable_title Service `channels_seek_backward` %} +### Service `channels_seek_backward` Seek backward by the number of seconds currently set in settings on the instance of Channels. @@ -65,7 +65,7 @@ Seek backward by the number of seconds currently set in settings on the instance | ---------------------- | -------- | ----------- | | `entity_id` | no | String that points at `entity_id` of Channels app. -### {% linkable_title Service `channels_seek_by` %} +### Service `channels_seek_by` Seek forward or backward by a provided number of seconds. diff --git a/source/_components/cisco_webex_teams.markdown b/source/_components/cisco_webex_teams.markdown index a2d49717d66..149fbea8f53 100644 --- a/source/_components/cisco_webex_teams.markdown +++ b/source/_components/cisco_webex_teams.markdown @@ -38,7 +38,7 @@ notify: room_id: CISCO_WEBEX_TEAMS_ROOMID ``` -## {% linkable_title Rich Text Formatting %} +## Rich Text Formatting Webex Teams clients can render rich text via a whitelisted set of html tags. diff --git a/source/_components/citybikes.markdown b/source/_components/citybikes.markdown index ef003ed52d8..aa904d95091 100644 --- a/source/_components/citybikes.markdown +++ b/source/_components/citybikes.markdown @@ -18,7 +18,7 @@ redirect_from: The `citybikes` sensor platform monitors bike availability at bike sharing stations in a chosen area. The data is provided by [CityBikes](https://citybik.es/#about), which supports bike sharing systems all around the world. -## {% linkable_title Configuration %} +## Configuration To enable it, add the following lines to your `configuration.yaml`: @@ -59,7 +59,7 @@ stations: {% endconfiguration %} -## {% linkable_title Example %} +## Example Additional configuration samples: diff --git a/source/_components/clickatell.markdown b/source/_components/clickatell.markdown index 15718dab4b3..0c2ccc317d3 100644 --- a/source/_components/clickatell.markdown +++ b/source/_components/clickatell.markdown @@ -17,7 +17,7 @@ redirect_from: The `clickatell` platform uses [Clickatell](https://clickatell.com) to deliver SMS notifications from Home Assistant. -## {% linkable_title Setup %} +## Setup Go to your [Clickatell SMS Platform Portal](https://portal.clickatell.com/#/) section and create a new SMS integration. There are three screens of information required to create an integration. Please ensure the following: @@ -28,7 +28,7 @@ Go to your [Clickatell SMS Platform Portal](https://portal.clickatell.com/#/) se 5. Be aware of the international number format option as this impacts the structure of the phone numbers you provide. 6. Once you have completed entering your details an API key is generated. Copy the API key. -## {% linkable_title Configuration %} +## Configuration To add Clickatell to your installation, add the following to your Home Assistant `configuration.yaml` file: diff --git a/source/_components/clicksend.markdown b/source/_components/clicksend.markdown index 406de2dd060..e83092f9844 100644 --- a/source/_components/clicksend.markdown +++ b/source/_components/clicksend.markdown @@ -18,11 +18,11 @@ redirect_from: The `clicksend` platform uses [ClickSend](https://clicksend.com) to deliver notifications from Home Assistant. -## {% linkable_title Prerequisites %} +## Prerequisites Go to your [ClickSend Dashboard](https://dashboard.clicksend.com) section and create your new project. After creating your project, you should now be able to obtain your `username` and `api_key`. -## {% linkable_title Configuration %} +## Configuration To add ClickSend to your installation, add the following to your Home Assistant `configuration.yaml` file: diff --git a/source/_components/climate.markdown b/source/_components/climate.markdown index d19d54f49c6..8b6bd73bc9a 100644 --- a/source/_components/climate.markdown +++ b/source/_components/climate.markdown @@ -16,16 +16,16 @@ ha_release: 0.19 The `climate` integration is built for the controlling and monitoring of HVAC (heating, ventilating, and air conditioning) and thermostat devices. -## {% linkable_title Services %} +## Services -### {% linkable_title Climate control services %} +### Climate control services Available services: `climate.set_aux_heat`, `climate.set_away_mode`, `climate.set_temperature`, `climate.set_humidity`, `climate.set_fan_mode`, `climate.set_operation_mode`, `climate.set_swing_mode`, `climate.set_hold_mode`, `climate.turn_on`, `climate.turn_off`

Not all climate services may be available for your platform. Be sure to check the available services Home Assistant has enabled by checking service developer tool icon **Services**.

-### {% linkable_title Service `climate.set_aux_heat` %} +### Service `climate.set_aux_heat` Turn auxiliary heater on/off for climate device @@ -34,7 +34,7 @@ Turn auxiliary heater on/off for climate device | `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all. | `aux_heat` | no | New value of auxiliary heater. -#### {% linkable_title Automation example %} +#### Automation example ```yaml automation: @@ -48,7 +48,7 @@ automation: aux_heat: true ``` -### {% linkable_title Service `climate.set_away_mode` %} +### Service `climate.set_away_mode` Set away mode for climate device. The away mode changes the target temperature permanently to a temperature reflecting a situation where the climate device is set to save energy. This may be used to emulate a @@ -59,7 +59,7 @@ reflecting a situation where the climate device is set to save energy. This may | `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all. | `away_mode` | no | New value of away mode. -#### {% linkable_title Automation example %} +#### Automation example ```yaml automation: @@ -74,7 +74,7 @@ automation: ``` -### {% linkable_title Service `climate.set_hold_mode` %} +### Service `climate.set_hold_mode` Set hold mode for climate device. The hold mode changes the target temperature of the client device temporarily to a different temperature. Typical hold modes provided by a climate device are "away" or "home", where the hold temperature @@ -86,7 +86,7 @@ temporary target temperature. The particular modes available depend on the clima | `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all. | `hold_mode` | no | New value of hold mode. -#### {% linkable_title Automation example %} +#### Automation example ```yaml automation: @@ -100,7 +100,7 @@ automation: hold_mode: 'away' ``` -### {% linkable_title Service `climate.set_temperature` %} +### Service `climate.set_temperature` Set target temperature of climate device @@ -112,7 +112,7 @@ Set target temperature of climate device | `target_temp_low` | yes | New target low temperature for hvac | `operation_mode` | yes | Operation mode to set temperature to. This defaults to current_operation mode if not set, or set incorrectly. -#### {% linkable_title Automation example %} +#### Automation example ```yaml automation: @@ -127,7 +127,7 @@ automation: operation_mode: Heat ``` -### {% linkable_title Service `climate.set_humidity` %} +### Service `climate.set_humidity` Set target humidity of climate device @@ -136,7 +136,7 @@ Set target humidity of climate device | `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all. | `humidity` | no | New target humidity for climate device -#### {% linkable_title Automation example %} +#### Automation example ```yaml automation: @@ -150,7 +150,7 @@ automation: humidity: 60 ``` -### {% linkable_title Service `climate.set_fan_mode` %} +### Service `climate.set_fan_mode` Set fan operation for climate device @@ -159,7 +159,7 @@ Set fan operation for climate device | `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all. | `fan_mode` | no | New value of fan mode -#### {% linkable_title Automation example %} +#### Automation example ```yaml automation: @@ -173,7 +173,7 @@ automation: fan_mode: 'On Low' ``` -### {% linkable_title Service `climate.set_operation_mode` %} +### Service `climate.set_operation_mode` Set operation mode for climate device @@ -182,7 +182,7 @@ Set operation mode for climate device | `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all. | `operation_mode` | no | New value of operation mode -#### {% linkable_title Automation example %} +#### Automation example ```yaml automation: @@ -196,7 +196,7 @@ automation: operation_mode: Heat ``` -### {% linkable_title Service `climate.set_swing_mode` %} +### Service `climate.set_swing_mode` Set operation mode for climate device @@ -205,7 +205,7 @@ Set operation mode for climate device | `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all. | `swing_mode` | no | New value of swing mode -#### {% linkable_title Automation example %} +#### Automation example ```yaml automation: @@ -218,7 +218,7 @@ automation: entity_id: climate.kitchen swing_mode: 1 ``` -### {% linkable_title Service `climate.turn_on` %} +### Service `climate.turn_on` Turn climate device on @@ -226,7 +226,7 @@ Turn climate device on | ---------------------- | -------- | ----------- | | `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Targets all when omitted. -### {% linkable_title Service `climate.turn_off` %} +### Service `climate.turn_off` Turn climate device off diff --git a/source/_components/climate.modbus.markdown b/source/_components/climate.modbus.markdown index 74838e0d420..aa6a702ba7a 100644 --- a/source/_components/climate.modbus.markdown +++ b/source/_components/climate.modbus.markdown @@ -17,7 +17,7 @@ ha_iot_class: Local Polling The `modbus` thermostat allows you to use a sensor value (current temperature) and target value (target temperature) from [Modbus](http://www.modbus.org/) registers. -## {% linkable_title Configuration %} +## Configuration To use your Modbus thermostat in your installation, add the following to your `configuration.yaml` file: @@ -71,7 +71,7 @@ precision: {% endconfiguration %} -### {% linkable_title Services %} +### Services | Service | Description | | ------- | ----------- | diff --git a/source/_components/climate.mqtt.markdown b/source/_components/climate.mqtt.markdown index bc4204808be..6e083ba1fd1 100644 --- a/source/_components/climate.mqtt.markdown +++ b/source/_components/climate.mqtt.markdown @@ -20,7 +20,7 @@ The platform currently works in optimistic mode, which means it does not obtain It uses a sensor under the hood to obtain the current temperature. -## {% linkable_title Configuration %} +## Configuration To enable this climate platform in your installation, first add the following to your `configuration.yaml` file: @@ -267,11 +267,11 @@ device: type: string {% endconfiguration %} -#### {% linkable_title Optimistic mode %} +#### Optimistic mode If a property works in *optimistic mode* (when the corresponding state topic is not set), Home Assistant will assume that any state changes published to the command topics did work and change the internal state of the entity immediately after publishing to the command topic. If it does not work in optimistic mode, the internal state of the entity is only updated when the requested update is confirmed by the device through the state topic. -#### {% linkable_title Using Templates %} +#### Using Templates For all `*_state_topic`s, a template can be specified that will be used to render the incoming payloads on these topics. Also, a default template that applies to all state topis can be specified as `value_template`. This can be useful if you received payloads are e.g., in JSON format. Since in JSON, a quoted string (e.g., `"foo"`) is just a string, this can also be used for unquoting. @@ -295,7 +295,7 @@ climate: This will parse the incoming `"auto"` as JSON, resulting in `auto`. Obviously, in this case you could also just set `value_template: {% raw %}"{{ value_json }}"{% endraw %}`. -### {% linkable_title Example %} +### Example A full configuration example looks like the one below. diff --git a/source/_components/climate.mysensors.markdown b/source/_components/climate.mysensors.markdown index a2979394e0b..d53c2a89f47 100644 --- a/source/_components/climate.mysensors.markdown +++ b/source/_components/climate.mysensors.markdown @@ -44,7 +44,7 @@ You can use V_TEMP to send the current temperature from the node to Home Assista For more information, visit the [serial api] of MySensors. -### {% linkable_title Example sketch for MySensors 2.x %} +### Example sketch for MySensors 2.x ```cpp @@ -190,7 +190,7 @@ void sendHeatpumpCommand() { } ``` -### {% linkable_title Example sketch for MySensors 1.x %} +### Example sketch for MySensors 1.x ```cpp /* diff --git a/source/_components/cloudflare.markdown b/source/_components/cloudflare.markdown index 5334b6a996a..a2105b84750 100644 --- a/source/_components/cloudflare.markdown +++ b/source/_components/cloudflare.markdown @@ -17,11 +17,11 @@ With the `cloudflare` integration can you keep your Cloudflare records up to dat The integration will run every hour, but can also be started manually by using the service `cloudflare.update_records` under services. -## {% linkable_title Setup %} +## Setup You will find your global API key in your Cloudflare account settings. -## {% linkable_title Configuration %} +## Configuration To use the integration in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/co2signal.markdown b/source/_components/co2signal.markdown index 4c283286897..bd31a054c30 100644 --- a/source/_components/co2signal.markdown +++ b/source/_components/co2signal.markdown @@ -26,7 +26,7 @@ At the moment, the free CO2Signal API only supports the average carbon intensity The "free" API key is limited to a limited number of calls. Too many requests can result in data loss.

-## {% linkable_title Configuration %} +## Configuration To set up this platform, get your [API key](https://www.co2signal.com/) and add the following lines to your `configuration.yaml` file: @@ -78,7 +78,7 @@ sensor: country_code: YOUR_COUNTRY_CODE ``` -## {% linkable_title Example Configurations %} +## Example Configurations Configuration using custom latitude and longitude: @@ -99,7 +99,7 @@ sensor: country_code: BE ``` -## {% linkable_title Sensor Types %} +## Sensor Types When configured, the platform will create one sensor for each configured location. diff --git a/source/_components/coinbase.markdown b/source/_components/coinbase.markdown index 18bd47eb656..22854c1ca44 100644 --- a/source/_components/coinbase.markdown +++ b/source/_components/coinbase.markdown @@ -21,7 +21,7 @@ The `coinbase` integration lets you access account balances and exchange rates f You will need to obtain an API key from coinbase's [developer site](https://www.coinbase.com/settings/api) to use this component. You need to give read access to `wallet:accounts` in order for the integration to access relevant data. -## {% linkable_title Configuration %} +## Configuration To set it up, add the following information to your `configuration.yaml` file: @@ -54,7 +54,7 @@ exchange_rate_currencies: Possible currencies are codes that conform to the ISO 4217 standard where possible. Currencies which have or had no representation in ISO 4217 may use a custom code (e.g. BTC). A list of values can be obtained via https://api.coinbase.com/v2/currencies, for more information visit [the Coinbase API documentation](https://developers.coinbase.com/api/v2#get-currencies). -## {% linkable_title Full configuration example %} +## Full configuration example A full configuration sample including optional variables: diff --git a/source/_components/command_line.markdown b/source/_components/command_line.markdown index 76fd3b8e9c4..7c182c757bc 100644 --- a/source/_components/command_line.markdown +++ b/source/_components/command_line.markdown @@ -18,7 +18,7 @@ redirect_from: The `command_line` binary sensor platform issues specific commands to get data. -## {% linkable_title Configuration %} +## Configuration To use your Command binary sensor in your installation, add the following to your `configuration.yaml` file: @@ -72,11 +72,11 @@ command_timeout: default: 15 {% endconfiguration %} -## {% linkable_title Examples %} +## Examples In this section you find some real-life examples of how to use this sensor. -### {% linkable_title SickRage %} +### SickRage Check the state of an [SickRage](https://github.com/sickragetv/sickrage) instance. @@ -91,7 +91,7 @@ binary_sensor: payload_off: "Not running" ``` -### {% linkable_title Check RasPlex %} +### Check RasPlex Check if [RasPlex](http://www.rasplex.com/) is `online`. @@ -119,7 +119,7 @@ binary_sensor: Consider to use the [`ping` sensor ](/components/binary_sensor.ping/) as an alternative to the samples above. -### {% linkable_title Check if a system service is running %} +### Check if a system service is running The services running is listed in `/etc/systemd/system` and can be checked with the `systemctl` command: diff --git a/source/_components/concord232.markdown b/source/_components/concord232.markdown index d5e4f5f4f12..9c9a051fdb8 100644 --- a/source/_components/concord232.markdown +++ b/source/_components/concord232.markdown @@ -26,7 +26,7 @@ There is currently support for the following device types within Home Assistant: - [Alarm](#alarm-control-panel) - [Binary Sensor](#binary-sensor) -## {% linkable_title Alarm Control Panel %} +## Alarm Control Panel To enable the alarm control panel platform, add the following lines to your `configuration.yaml`: @@ -58,7 +58,7 @@ mode: default: audible {% endconfiguration %} -## {% linkable_title Binary Sensor %} +## Binary Sensor To enable the binary sensor platform, add the following lines to your `configuration.yaml`: diff --git a/source/_components/config.markdown b/source/_components/config.markdown index bee75a2f332..d11115d8519 100644 --- a/source/_components/config.markdown +++ b/source/_components/config.markdown @@ -23,15 +23,15 @@ To enable the configuration panel, add the following to your `configuration.yaml config: ``` -### {% linkable_title Integrations %} +### Integrations This section enables you to manage integrations for devices such as Philips Hue and Sonos from within Home Assistant. -### {% linkable_title Users %} +### Users This section enables you to manage your Home Assistant users. -### {% linkable_title General %} +### General This section enables you to control Home Assistant from within Home Assistant. Check your configuration, reload the core, groups, scripts, automations, and the Home Assistant process itself with a single mouse click. @@ -39,18 +39,18 @@ This section enables you to control Home Assistant from within Home Assistant. C

-### {% linkable_title Customization %} +### Customization This section enables you to customize entities within Home Assistant. Use this to set friendly names, change icons, hide entities, and modify other attributes. -### {% linkable_title Automation %} +### Automation This section enables you to create and modify automations from within Home Assistant, without needing to write out the yaml code. -### {% linkable_title Script %} +### Script Similar to the automation editor, this section enables you to create and modify scripts from within Home Assistant, without needing to write out the yaml code. -### {% linkable_title Z-Wave %} +### Z-Wave This section enables you to control your Z-Wave network and devices from within Home Assistant. You can add and remove devices, as well as change device specific configuration variables. diff --git a/source/_components/conversation.markdown b/source/_components/conversation.markdown index 4aae2f49683..dd8a5fcb2de 100644 --- a/source/_components/conversation.markdown +++ b/source/_components/conversation.markdown @@ -38,7 +38,7 @@ intents: type: list {% endconfiguration %} -## {% linkable_title Adding custom sentences %} +## Adding custom sentences By default, it will support turning devices on and off. You can say things like "turn on kitchen lights" or "turn the living room lights off". You can also configure your own sentences to be processed. This works by mapping sentences to intents and then configure the [intent script integration](/components/intent_script/) to handle these intents. @@ -57,7 +57,7 @@ intent_script: text: It is currently {% raw %}{{ states.sensor.temperature }}{% endraw %} degrees in the living room. ``` -## {% linkable_title Adding advanced custom sentences %} +## Adding advanced custom sentences Sentences can contain slots (marked with curly braces: `{name}`) and optional words (marked with square brackets: `[the]`). The values of slots will be passed on to the intent and are available inside the templates. @@ -91,7 +91,7 @@ intent_script: {% endraw %} ``` -#### {% linkable_title Service `conversation.process` %} +#### Service `conversation.process` | Service data attribute | Optional | Description | |------------------------|----------|--------------------------------------------------| diff --git a/source/_components/counter.markdown b/source/_components/counter.markdown index 2ecc7ea4a31..1c4a493efcd 100644 --- a/source/_components/counter.markdown +++ b/source/_components/counter.markdown @@ -16,7 +16,7 @@ ha_qa_scale: internal The `counter` integration allows one to count occurrences fired by automations. -## {% linkable_title Configuration %} +## Configuration To add a counter to your installation, add the following to your `configuration.yaml` file: @@ -70,17 +70,17 @@ counter: Pick an icon that you can find on [materialdesignicons.com](https://materialdesignicons.com/) to use for your input and prefix the name with `mdi:`. For example `mdi:car`, `mdi:ambulance` or `mdi:motorbike`. -### {% linkable_title Restore State %} +### Restore State This integration will automatically restore the state it had prior to Home Assistant stopping as long as you your entity has `restore` set to `true` which is the default. To disable this feature, set `restore` to `false`. If `restore` is set to `false`, the `initial` value will only be used when no previous state is found or when the counter is reset. -## {% linkable_title Services %} +## Services Available services: `increment`, `decrement`, and `reset`. -#### {% linkable_title Service `counter.increment` %} +#### Service `counter.increment` Increments the counter with 1 or the given value for the steps. @@ -88,7 +88,7 @@ Increments the counter with 1 or the given value for the steps. | ---------------------- | -------- | ----------- | | `entity_id` | no | Name of the entity to take action, e.g., `counter.my_custom_counter`. | -#### {% linkable_title Service `counter.decrement` %} +#### Service `counter.decrement` Decrements the counter with 1 or the given value for the steps. @@ -96,7 +96,7 @@ Decrements the counter with 1 or the given value for the steps. | ---------------------- | -------- | ----------- | | `entity_id` | no | Name of the entity to take action, e.g., `counter.my_custom_counter`. | -#### {% linkable_title Service `counter.reset` %} +#### Service `counter.reset` With this service the counter is reset to its initial value. @@ -104,7 +104,7 @@ With this service the counter is reset to its initial value. | ---------------------- | -------- | ----------- | | `entity_id` | no | Name of the entity to take action, e.g., `counter.my_custom_counter`. | -#### {% linkable_title Service `counter.configure` %} +#### Service `counter.configure` With this service the properties of the counter can be changed while running. @@ -117,7 +117,7 @@ With this service the properties of the counter can be changed while running. -### {% linkable_title Use the service %} +### Use the service Select service developer tool icon **Services** from the **Developer Tools**. Choose **counter** from the list of **Domains**, select the **Service**, enter something like the sample below into the **Service Data** field, and hit **CALL SERVICE**. diff --git a/source/_components/cover.command_line.markdown b/source/_components/cover.command_line.markdown index 3ebb35ddc3f..8326fc6ea04 100644 --- a/source/_components/cover.command_line.markdown +++ b/source/_components/cover.command_line.markdown @@ -70,11 +70,11 @@ covers: type: string {% endconfiguration %} -## {% linkable_title Examples %} +## Examples In this section you find some real-life examples of how to use this sensor. -### {% linkable_title Full configuration %} +### Full configuration ```yaml # Example configuration.yaml entry diff --git a/source/_components/cover.group.markdown b/source/_components/cover.group.markdown index 5512be8fefb..824ab062413 100644 --- a/source/_components/cover.group.markdown +++ b/source/_components/cover.group.markdown @@ -40,6 +40,6 @@ cover: type: [string | list] {% endconfiguration %} -## {% linkable_title Functionality %} +## Functionality It works best if you group covers with the same supported features together (like support for `open`/`close`/`stop`/`position`/`tilt controls`), but is not limited to it. In case you have bundled covers with different features together, the controls will only affect those covers that support the actions. diff --git a/source/_components/cover.markdown b/source/_components/cover.markdown index 99c934289e7..a4fa15639e3 100644 --- a/source/_components/cover.markdown +++ b/source/_components/cover.markdown @@ -16,7 +16,7 @@ ha_release: 0.27 Home Assistant can give you an interface to control covers such as rollershutters, blinds, and garage doors. -## {% linkable_title Device Class %} +## Device Class The way these sensors are displayed in the frontend can be modified in the [customize section](/docs/configuration/customizing-devices/). The following device classes are supported for covers: @@ -31,9 +31,9 @@ The way these sensors are displayed in the frontend can be modified in the [cust - **shutter**: Control of shutters, which are linked slats that swing out/in to covering an opening or may be tilted to partially cover an opening, such as indoor or exterior window shutters. - **window**: Control of a physical window that opens and closes or may tilt. -## {% linkable_title Services %} +## Services -### {% linkable_title Cover control services %} +### Cover control services Available services: `cover.open_cover`, `cover.close_cover`, `cover.stop_cover`, `cover.toggle`, `cover.open_cover_tilt`, `cover.close_cover_tilt`, `cover.stop_cover_tilt`, `cover.toggle_tilt` @@ -41,7 +41,7 @@ Available services: `cover.open_cover`, `cover.close_cover`, `cover.stop_cover`, | ---------------------- | -------- | ----------- | | `entity_id` | yes | String or list of strings that point at `entity_id`'s of covers. Else targets all. -### {% linkable_title Service `cover.set_cover_position` %} +### Service `cover.set_cover_position` Set cover position of one or multiple covers. @@ -50,7 +50,7 @@ Set cover position of one or multiple covers. | `entity_id` | yes | String or list of strings that point at `entity_id`'s of covers. Else targets all. | `position` | no | Integer between 0 and 100. -#### {% linkable_title Automation example %} +#### Automation example ```yaml automation: @@ -64,7 +64,7 @@ automation: position: 50 ``` -### {% linkable_title Service `cover.set_cover_tilt_position` %} +### Service `cover.set_cover_tilt_position` Set cover tilt position of one or multiple covers. @@ -73,7 +73,7 @@ Set cover tilt position of one or multiple covers. | `entity_id` | yes | String or list of strings that point at `entity_id`'s of covers. Else targets all. | `tilt_position` | no | Integer between 0 and 100. -#### {% linkable_title Automation example %} +#### Automation example ```yaml automation: diff --git a/source/_components/cover.mqtt.markdown b/source/_components/cover.mqtt.markdown index 72b3dca8660..360e7284751 100644 --- a/source/_components/cover.mqtt.markdown +++ b/source/_components/cover.mqtt.markdown @@ -16,7 +16,7 @@ ha_release: 0.18 The `mqtt` cover platform allows you to control an MQTT cover (such as blinds, a rollershutter or a garage door). -## {% linkable_title Configuration %} +## Configuration The device state (`open` or `closed`) will be updated only after a new message is published on `state_topic` matching `state_open` or `state_closed`. If these messages are published with the `retain` flag set, the cover will receive an instant state update after subscription and Home Assistant will display the correct state on startup. Otherwise, the initial state displayed in Home Assistant will be `unknown`. `state_topic` can only manage `state_open` and `state_closed`. No percentage positons etc. @@ -225,11 +225,11 @@ device: type: string {% endconfiguration %} -## {% linkable_title Examples %} +## Examples In this section you will find some real-life examples of how to use this platform. -### {% linkable_title Full configuration state topic without tilt %} +### Full configuration state topic without tilt The example below shows a full configuration for a cover without tilt with state topic only. @@ -256,7 +256,7 @@ cover: ``` {% endraw %} -### {% linkable_title Full configuration position topic without tilt %} +### Full configuration position topic without tilt The example below shows a full configuration for a cover without tilt with position topic. @@ -284,7 +284,7 @@ cover: ``` {% endraw %} -### {% linkable_title Full configuration %} +### Full configuration The example below shows a full configuration for a cover. diff --git a/source/_components/cover.mysensors.markdown b/source/_components/cover.mysensors.markdown index 4e0fb43fa01..02bf5333443 100644 --- a/source/_components/cover.mysensors.markdown +++ b/source/_components/cover.mysensors.markdown @@ -35,7 +35,7 @@ All V_TYPES above are required. Use V_PERCENTAGE (or V_DIMMER) if you know the e For more information, visit the [serial api] of MySensors. -### {% linkable_title Example sketch %} +### Example sketch ```cpp /* diff --git a/source/_components/cover.rflink.markdown b/source/_components/cover.rflink.markdown index 06fd87054b0..91148dd676d 100644 --- a/source/_components/cover.rflink.markdown +++ b/source/_components/cover.rflink.markdown @@ -20,7 +20,7 @@ First, you have to set up your [RFLink hub](/components/rflink/). After configuring the RFLink hub, covers will be automatically discovered and added. Except the Somfy RTS devices. -### {% linkable_title Setting up a Somfy RTS device %} +### Setting up a Somfy RTS device You have to add the Somfy RTS manually with the supplied RFlinkLoader (Windows only). @@ -132,11 +132,11 @@ devices: type: [list, string] {% endconfiguration %} -### {% linkable_title Device support %} +### Device support See [device support](/components/rflink/#device-support). -### {% linkable_title Additional configuration examples %} +### Additional configuration examples Multiple covers with custom names and aliases diff --git a/source/_components/cover.rfxtrx.markdown b/source/_components/cover.rfxtrx.markdown index c098a1d9bf9..29bd8762549 100644 --- a/source/_components/cover.rfxtrx.markdown +++ b/source/_components/cover.rfxtrx.markdown @@ -17,9 +17,9 @@ The `rfxtrx` platform supports Siemens/LightwaveRF and RFY roller shutters that First you have to set up your [rfxtrx hub](/components/rfxtrx/). -### {% linkable_title Configuration %} +### Configuration -##### {% linkable_title Siemens/LightwaveRF %} +##### Siemens/LightwaveRF The easiest way to find your roller shutters is to add this to your `configuration.yaml`: @@ -41,11 +41,11 @@ cover: name: device_name ``` -##### {% linkable_title RFY %} +##### RFY The [RFXtrx433e](http://www.rfxcom.com/RFXtrx433E-USB-43392MHz-Transceiver/en) is required for RFY support, however it does not support receive for the RFY protocol - as such devices cannot be automatically added. Instead, configure the device in the [rfxmngr](http://www.rfxcom.com/downloads.htm) tool. Make a note of the assigned ID and Unit Code and then add a device to the configuration with the following id `071a0000[id][unit_code]`. E.g., if the id was `0a` `00` `01`, and the unit code was `01` then the fully qualified id would be `071a00000a000101`, if you set your id/code to single digit in the rfxmngr, e.g., id: `1` `02` `04` and unit code: `1` you will need to add `0` before, so `102031` becomes `071a000001020301`. -##### {% linkable_title Common %} +##### Common Example configuration: diff --git a/source/_components/cover.template.markdown b/source/_components/cover.template.markdown index 7f93b55e982..a363bd9cc49 100644 --- a/source/_components/cover.template.markdown +++ b/source/_components/cover.template.markdown @@ -19,7 +19,7 @@ The `template` platform can create covers that combine integrations and provides the ability to run scripts or invoke services for each of the open, close, stop, position and tilt commands of a cover. -## {% linkable_title Configuration %} +## Configuration To enable Template Covers in your installation, add the following to your `configuration.yaml` file: @@ -108,7 +108,7 @@ cover: type: template {% endconfiguration %} -## {% linkable_title Considerations %} +## Considerations If you are using the state of a platform that takes extra time to load, the Template Cover may get an `unknown` state during startup. This results in error @@ -120,7 +120,7 @@ with this equivalent that returns `true`/`false` and never gives an unknown result: {% raw %}`{{ is_state('switch.source', 'on') }}`{% endraw %} -## {% linkable_title Optimistic Mode %} +## Optimistic Mode In optimistic mode, the cover position state is maintained internally. This mode is automatically enabled if neither [`value_template`](#value_template) or @@ -132,11 +132,11 @@ There is an equivalent mode for `tilt_position` that is enabled when [`tilt_template`](#tilt_template) is not specified or when the [`tilt_optimistic`](#tilt_optimistic) attribute is used. -## {% linkable_title Examples %} +## Examples In this section you will find some real-life examples of how to use this cover. -### {% linkable_title Garage Door %} +### Garage Door This example converts a garage door with a controllable switch and position sensor into a cover. @@ -170,7 +170,7 @@ cover: ``` {% endraw %} -### {% linkable_title Multiple Covers %} +### Multiple Covers This example allows you to control two or more covers at once. @@ -257,7 +257,7 @@ automation: ``` {% endraw %} -### {% linkable_title Change The Icon %} +### Change The Icon This example shows how to change the icon based on the cover state. @@ -290,7 +290,7 @@ cover: ``` {% endraw %} -### {% linkable_title Change The Entity Picture %} +### Change The Entity Picture This example shows how to change the entity picture based on the cover state. diff --git a/source/_components/cpuspeed.markdown b/source/_components/cpuspeed.markdown index af09719b0df..acd55e0bc84 100644 --- a/source/_components/cpuspeed.markdown +++ b/source/_components/cpuspeed.markdown @@ -24,7 +24,7 @@ The `cpuspeed` sensor platform to allow you to monitor the current CPU speed. You can't use this sensor in a Container (like Hass.io) as it requires access to the physical CPU. Also, not all [ARM CPUs](https://github.com/workhorsy/py-cpuinfo/#cpu-support) are supported.

-## {% linkable_title Configuration %} +## Configuration To add this platform to your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/crimereports.markdown b/source/_components/crimereports.markdown index da79b588027..84f66326c88 100644 --- a/source/_components/crimereports.markdown +++ b/source/_components/crimereports.markdown @@ -18,7 +18,7 @@ redirect_from: The `crimereports` sensor allows one to track reported incidents occurring in a given area. Incidents include anything reported to [Crime Reports](https://www.crimereports.com). Your regional emergency services may or may not report data. The sensor only counts incidents from the current day. -## {% linkable_title Configuration %} +## Configuration To enable this sensor, add the following lines to your `configuration.yaml`. Your `radius` should be of sufficient size to capture incidents in your area. @@ -57,13 +57,13 @@ exclude: {% endconfiguration %} -## {% linkable_title Notes %} +## Notes -### {% linkable_title Area %} +### Area Crime Reports captures all incidents in a region defined by a square shape. Home Assistant zones are circular. Therefore, the region defined by a Home Assistant zone in a Crime Reports context is a square that is big enough to fit the zone circle. Practically, this means some incidents may be captured that are outside your zone. -### {% linkable_title Incident Types %} +### Incident Types You can explicitly include or exclude incident types. Specifying `include`s restricts the incidents to those types. Specifying `exclude`s will return all incident types except those specified. @@ -104,6 +104,6 @@ These incident types are available: - Vehicle Stop - Weapons Offense -### {% linkable_title Events %} +### Events The `crimealerts` sensor fires a `crimealerts_incident` event when a new incident is detected, including the type, description, time, location, and coordinates of the incident. diff --git a/source/_components/daikin.markdown b/source/_components/daikin.markdown index 110c245418f..bebcb82cf42 100644 --- a/source/_components/daikin.markdown +++ b/source/_components/daikin.markdown @@ -28,13 +28,13 @@ There is currently support for the following device types within Home Assistant: - [Sensor](#sensor) - [Switch](#switch) -## {% linkable_title Supported hardware %} +## Supported hardware - The European versions of the Wifi Controller Unit (BRP069A41, 42, 43, 45), which is powered by the [Daikin Online Controller](https://play.google.com/store/apps/details?id=eu.daikin.remoapp) application. - The Australian version of the Daikin Wifi Controller Unit BRP072A42. Confirmed working on a Daikin Cora Series Reverse Cycle Split System Air Conditioner 2.5kW Cooling FTXM25QVMA with operation mode, temp, fan swing (3d, horizontal, vertical) which is powered by the [DAIKIN Mobile Controller](https://itunes.apple.com/au/app/daikin-mobile-controller/id917168708?mt=8) ([Android version](https://play.google.com/store/apps/details?id=eu.daikin.remoapp)) application. - The Australian version of the Daikin Wifi Controller for **AirBase** units (BRP15B61), which is powered by the [Daikin Airbase](https://play.google.com/store/apps/details?id=au.com.daikin.airbase) application. -## {% linkable_title Configuration %} +## Configuration The Daikin integration can be configured in three ways. @@ -57,7 +57,7 @@ hosts: type: list {% endconfiguration %} -## {% linkable_title Climate %} +## Climate The `daikin` climate platform integrates Daikin air conditioning systems into Home Assistant, enabling control of setting the following parameters: @@ -74,7 +74,7 @@ Current inside temperature is displayed. Some models do not support setting of **fan speed** or **swing mode**.

-## {% linkable_title Sensor %} +## Sensor The `daikin` sensor platform integrates Daikin air conditioning systems into Home Assistant, enabling displaying the following parameters: @@ -85,7 +85,7 @@ The `daikin` sensor platform integrates Daikin air conditioning systems into Hom Some models only report outside temperature when they are turned on.

-## {% linkable_title Switch %} +## Switch Daikin AirBase units exposes zones (typically rooms) that can be switched on/off individually. diff --git a/source/_components/danfoss_air.markdown b/source/_components/danfoss_air.markdown index 4c0949d006b..2baa37ef111 100644 --- a/source/_components/danfoss_air.markdown +++ b/source/_components/danfoss_air.markdown @@ -44,13 +44,13 @@ host: type: string {% endconfiguration %} -## {% linkable_title Binary sensor %} +## Binary sensor The following binary sensor is supported. - **Bypass active:** Indicator if heat recovery is currrently bypassed. -## {% linkable_title Sensor %} +## Sensor The following sensors are supported. @@ -60,7 +60,7 @@ The following sensors are supported. - **Exhaust temperature:** Exhausted air temperature. - **Remaining filter lifetime:** Reamining filter lifetime measured in percent. -## {% linkable_title Switch %} +## Switch The following switches are supported. diff --git a/source/_components/darksky.markdown b/source/_components/darksky.markdown index 33757a91179..896f5d3717f 100644 --- a/source/_components/darksky.markdown +++ b/source/_components/darksky.markdown @@ -19,7 +19,7 @@ redirect_from: The `darksky` platform uses the [Dark Sky](https://darksky.net/) web service as a source for meteorological data for your location. The location is based on the `longitude` and `latitude` coordinates configured in your `configuration.yaml` file. The coordinates are auto-detected but to take advantage of the hyper-local weather reported by Dark Sky, you can refine them down to your exact home address. GPS coordinates can be found by using [Google Maps](https://www.google.com/maps) and clicking on your home or [Openstreetmap](http://www.openstreetmap.org/). -## {% linkable_title Setup %} +## Setup You need an API key which is free but requires [registration](https://darksky.net/dev/register). You can make up to 1000 calls per day for free which means that you could make one approximately every 86 seconds. @@ -27,7 +27,7 @@ You need an API key which is free but requires [registration](https://darksky.ne [Dark Sky](https://darksky.net/dev/) will charge you $0.0001 per API call if you enter your credit card details and create more than 1000 calls per day.

-## {% linkable_title Configuration %} +## Configuration To add Dark Sky to your installation, add the following to your `configuration.yaml` file: @@ -163,7 +163,7 @@ scan_interval: Please note that some monitored conditions, such as `temperature_high` or `temperature_low`, may only work when setting the `forecast` attribute to at least `0` (current day).

-#### {% linkable_title Time period dictionary example %} +#### Time period dictionary example ```yaml scan_interval: @@ -175,7 +175,7 @@ scan_interval: milliseconds: 0 ``` -#### {% linkable_title Language options %} +#### Language options All language options are described in this table that you can use for the dark sky sensor. diff --git a/source/_components/deconz.markdown b/source/_components/deconz.markdown index faa9093bc22..89c7a7a14c4 100644 --- a/source/_components/deconz.markdown +++ b/source/_components/deconz.markdown @@ -44,16 +44,16 @@ There is currently support for the following device types within Home Assistant: - [Sensor](#sensor) - [Switch](#switch) -## {% linkable_title Recommended way of running deCONZ %} +## Recommended way of running deCONZ If you are running Hass.io, an official add-on for Deconz is available in the add-on store. Otherwise, use [community container](https://hub.docker.com/r/marthoc/deconz/) by Marthoc for your deCONZ needs. -### {% linkable_title Supported devices %} +### Supported devices See [deCONZ wiki](https://github.com/dresden-elektronik/deconz-rest-plugin/wiki/Supported-Devices) for a list of supported devices. -## {% linkable_title Configuration %} +## Configuration Home Assistant will automatically discover deCONZ presence on your network, if `discovery:` is present in your `configuration.yaml` file. @@ -61,7 +61,7 @@ If you don't have the API key, you can generate an API key for deCONZ by using t You can manually add deCONZ by going to the integrations page. -## {% linkable_title Debugging integration %} +## Debugging integration If you have problems with deCONZ or the integration you can add debug prints to the log. @@ -73,11 +73,11 @@ logger:    homeassistant.components.deconz: debug ``` -## {% linkable_title Device services %} +## Device services Available services: `configure` and `deconz.device_refresh`. -### {% linkable_title Service `deconz.configure` %} +### Service `deconz.configure` Set attribute of device in deCONZ using [Rest API](http://dresden-elektronik.github.io/deconz-rest-doc/rest/). @@ -97,13 +97,13 @@ Either `entity` or `field` must be provided. If both are present, `field` will b { "field": "/config", "data": {"permitjoin": 60} } -#### {% linkable_title Service `deconz.device_refresh` %} +#### Service `deconz.device_refresh` Refresh with devices added to deCONZ after Home Assistants latest restart. Note: deCONZ automatically signals Home Assistant when new sensors are added, but other devices must at this point in time (deCONZ v2.05.35) be added manually using this service or a restart of Home Assistant. -## {% linkable_title Remote control devices %} +## Remote control devices Remote controls (ZHASwitch category) will not be exposed as regular entities, but as events named `deconz_event` with a payload of `id` and `event`. Id will be the device name from deCONZ and Event will be the momentary state of the switch. However, a sensor entity will be created that shows the battery level of the switch as reported by deCONZ, named sensor.device_name_battery_level. @@ -120,11 +120,11 @@ Where for example on a Philips Hue Dimmer, 2001 would be holding the dim up butt For the IKEA Tradfri remote the first digit equals, 1 for the middle button, 2 for up, 3 for down, 4 for left, and 5 for right (e.g., "event: 1002" for middle button short release). -## {% linkable_title Examples %} +## Examples -### {% linkable_title YAML %} +### YAML -#### {% linkable_title Step up and step down input number with wireless dimmer %} +#### Step up and step down input number with wireless dimmer {% raw %} @@ -177,9 +177,9 @@ automation: {% endraw %} -### {% linkable_title Appdaemon %} +### Appdaemon -#### {% linkable_title Appdaemon event helper %} +#### Appdaemon event helper Helper app that creates a sensor `sensor.deconz_event` with a state that represents the id from the last event and an attribute to show the event data. @@ -216,7 +216,7 @@ class DeconzHelper(hass.Hass): Note: the event will not be visible before one event gets sent. -#### {% linkable_title Appdaemon remote template %} +#### Appdaemon remote template {% raw %} @@ -252,7 +252,7 @@ class RemoteControl(hass.Hass): {% endraw %} -#### {% linkable_title Appdaemon remote template %} +#### Appdaemon remote template Community app from [Teachingbirds](https://community.home-assistant.io/u/teachingbirds/summary). This app uses an Ikea Tradfri remote to control Sonos speakers with play/pause, volume up and down, next and previous track. @@ -306,7 +306,7 @@ class SonosRemote(hass.Hass): {% endraw %} -## {% linkable_title Binary Sensor %} +## Binary Sensor The following sensor types are supported: @@ -317,7 +317,7 @@ The following sensor types are supported: The `entity_id` name will be `binary_sensor.device_name`, where `device_name` is defined in deCONZ. -### {% linkable_title Verified supported binary sensors %} +### Verified supported binary sensors - Open/Close Detection - Xiaomi Smart Home Security Door & Window Contact Sensor @@ -327,7 +327,7 @@ The `entity_id` name will be `binary_sensor.device_name`, where `device_name` is - Xiaomi Motion Sensor - Xiaomi Smart Home Aqara Human Body Sensor -## {% linkable_title Climate %} +## Climate See the [deCONZ main integration](/components/deconz/) for configuration instructions. @@ -337,12 +337,12 @@ Note that devices in the climate platform identify as sensors, so there is a man The `entity_id` name will be `climate.device_name`, where `device_name` is defined in deCONZ. -#### {% linkable_title Verified supported climate devices %} +#### Verified supported climate devices - Bitron Thermostat 902010/32 - Eurotronic SPZB0001 -## {% linkable_title Cover %} +## Cover Covers are devices like ventilation dampers or smart window covers. @@ -350,16 +350,16 @@ Note that devices in the cover platform identify as lights, so there is a manual The `entity_id` name will be `cover.device_name`, where `device_name` is defined in deCONZ. -### {% linkable_title Verified supported covers %} +### Verified supported covers - Keen vents - Xiaomi Aqara Curtain controller -## {% linkable_title Light %} +## Light The `entity_id` names will be `light.device_name`, where `device_name` is defined in deCONZ. Light groups created in deCONZ will be created in Home Assistant as lights named `light.group_name_in_deconz`, allowing the user to control groups of lights with only a single API call to deCONZ. -### {% linkable_title Verified supported lights %} +### Verified supported lights - IKEA Trådfri bulb E14 WS opal 400lm - IKEA Trådfri Bulb E27 WS Opal 980lm @@ -372,11 +372,11 @@ The `entity_id` names will be `light.device_name`, where `device_name` is define - Philips Hue Hue White ambiance Milliskin (recessed spotlight) LTW013 - Busch Jaeger ZigBee Light Link univ. relai (6711 U) with ZigBee Light Link control element 6735-84 -## {% linkable_title Scene %} +## Scene The `entity_id` name will be `scene.group_scene_name`, where `group` is which group the scene belongs to and the name of the scene, both group and name are defined in deCONZ. -## {% linkable_title Sensor %} +## Sensor The following sensor types are supported: @@ -388,7 +388,7 @@ The following sensor types are supported: The `entity_id` name will be `sensor.device_name`, where `device_name` is defined in deCONZ. Switches aren't exposed as ordinary entities, see the [deCONZ main integration](/components/deconz/) for more details. -### {% linkable_title Verified to be supported sensors %} +### Verified to be supported sensors - Humidity Sensor - Xiaomi Aqara Humidity/Temperature Sensor @@ -407,7 +407,7 @@ The `entity_id` name will be `sensor.device_name`, where `device_name` is define - Temperature Sensor - Xiaomi Temperature/Humidity Sensor -### {% linkable_title deCONZ Daylight Sensor %} +### deCONZ Daylight Sensor The deCONZ Daylight sensor is a special sensor built into the deCONZ software since version 2.05.12. It is represented in Home Assistant as a sensor called sensor.daylight. The sensor's state value is a string corresponding to the phase of daylight (descriptions below taken from https://github.com/mourner/suncalc, on which the deCONZ implementation is based): @@ -432,7 +432,7 @@ The sensor also has an attribute called "daylight" that has the value `true` whe These states can be used in automations as a trigger (e.g., trigger when a certain phase of daylight starts or ends) or condition (e.g., trigger only if in a certain phase of daylight). -## {% linkable_title Switch %} +## Switch Switches are devices like power plugs and sirens. @@ -440,7 +440,7 @@ Note that devices in the switch platform identify as lights, so there is a manua The `entity_id` name will be `switch.device_name`, where `device_name` is defined in deCONZ. -### {% linkable_title Verified supported switches %} +### Verified supported switches - Innr SP120 - Osram Outdoor plug diff --git a/source/_components/default_config.markdown b/source/_components/default_config.markdown index 00edddfe221..490065939ec 100644 --- a/source/_components/default_config.markdown +++ b/source/_components/default_config.markdown @@ -31,7 +31,7 @@ This integration is a meta-component and configures a default set of integration - [updater](/components/updater/) - [zeroconf](/components/zeroconf/) -## {% linkable_title Configuration %} +## Configuration To integrate this into Home Assistant, add the following section to your `configuration.yaml` file: diff --git a/source/_components/deluge.markdown b/source/_components/deluge.markdown index ef80b12ce96..15b7879d98d 100644 --- a/source/_components/deluge.markdown +++ b/source/_components/deluge.markdown @@ -24,7 +24,7 @@ There is currently support for the following device types within Home Assistant: - [Sensor](#sensor) - [Switch](#switch) -## {% linkable_title Sensor %} +## Sensor The `deluge` platform allows you to monitor your downloads with [Deluge](http://deluge-torrent.org/) from within Home Assistant and setup automation based on the information. @@ -79,7 +79,7 @@ monitored_variables: description: The current upload speed. {% endconfiguration %} -## {% linkable_title Switch %} +## Switch The `deluge` switch platform allows you to control your [Deluge](http://deluge-torrent.org/) client from within Home Assistant. The platform enables you switch all your torrents in pause, and then unpause them all. diff --git a/source/_components/denon.markdown b/source/_components/denon.markdown index 41d886f922b..5adf62188d7 100644 --- a/source/_components/denon.markdown +++ b/source/_components/denon.markdown @@ -27,7 +27,7 @@ Supported devices: To add a Denon Network Receiver to your installation, add the following to your `configuration.yaml` file: -## {% linkable_title Telnet platform %} +## Telnet platform ```yaml # Example configuration.yaml entry diff --git a/source/_components/device_tracker.markdown b/source/_components/device_tracker.markdown index fce0e65460e..b91a5ab8ce2 100644 --- a/source/_components/device_tracker.markdown +++ b/source/_components/device_tracker.markdown @@ -16,7 +16,7 @@ ha_release: 0.7 The device tracker allows you to track devices in Home Assistant. This can happen by querying your wireless router or by having applications push location info. -## {% linkable_title Configuring a `device_tracker` platform %} +## Configuring a `device_tracker` platform To get started add the following lines to your `configuration.yaml` (example for Netgear): @@ -64,7 +64,7 @@ device_tracker: Multiple device trackers can be used in parallel, such as [Owntracks](/components/owntracks/#using-owntracks-with-other-device-trackers) and [Nmap](/components/nmap_tracker/). The state of the device will be determined by the source that reported last. -## {% linkable_title `known_devices.yaml` %} +## `known_devices.yaml`

As of 0.94 `known_devices.yaml` is being phased out, and no longer used by all trackers. Depending on the integration you use this section may no longer apply. This includes the mobile app, OwnTracks, GeoFency, GPSLogger, and Locative. @@ -98,11 +98,11 @@ devicename: | `hide_if_away` | false | If `yes`/`on`/`true` then the device will be hidden if it is not at home. | | `consider_home` | [uses platform setting] | Seconds to wait till marking someone as not home after not being seen. Allows you to override the global `consider_home` setting from the platform configuration on a per device level. | -## {% linkable_title Device states %} +## Device states The state of your tracked device will be `'home'` if it is in the [home zone](/components/zone#home-zone), detected by your network or Bluetooth based presence detection. If you're using a presence detection method that includes coordinates then when it's in a zone the state will be the name of the zone (case sensitive). When a device isn't at home and isn't in any zone, the state will be `'not_home'`. -## {% linkable_title `device_tracker.see` service %} +## `device_tracker.see` service The `device_tracker.see` service can be used to manually update the state of a device tracker: diff --git a/source/_components/device_tracker.mqtt.markdown b/source/_components/device_tracker.mqtt.markdown index 459ea2e3a48..91e67c845b5 100644 --- a/source/_components/device_tracker.mqtt.markdown +++ b/source/_components/device_tracker.mqtt.markdown @@ -17,7 +17,7 @@ ha_release: 0.7.3 The `mqtt` device tracker platform allows you to detect presence by monitoring an MQTT topic for new locations. To use this platform, you specify a unique topic for each device. -## {% linkable_title Configuration %} +## Configuration To use this device tracker in your installation, add the following to your `configuration.yaml` file: @@ -41,7 +41,7 @@ qos: type: integer {% endconfiguration %} -## {% linkable_title Usage %} +## Usage Example JSON you can publish to the topic (e.g., via mqtt.publish service): diff --git a/source/_components/device_tracker.mysensors.markdown b/source/_components/device_tracker.mysensors.markdown index 4f8fb3b92d8..7c5cbd25242 100644 --- a/source/_components/device_tracker.mysensors.markdown +++ b/source/_components/device_tracker.mysensors.markdown @@ -27,7 +27,7 @@ S_GPS | V_POSITION For more information, visit the [serial api] of MySensors. -### {% linkable_title MySensors 2.x example sketch %} +### MySensors 2.x example sketch ```cpp /** diff --git a/source/_components/device_tracker.xiaomi.markdown b/source/_components/device_tracker.xiaomi.markdown index f38e0b2ca4b..db783f15b6d 100644 --- a/source/_components/device_tracker.xiaomi.markdown +++ b/source/_components/device_tracker.xiaomi.markdown @@ -15,7 +15,7 @@ ha_release: 0.36 The `xiaomi` platform offers presence detection by looking at connected devices to a [Xiaomi](http://miwifi.com) router. -## {% linkable_title Setup %} +## Setup To use an Xiaomi router in your installation, add the following to your `configuration.yaml` file: @@ -45,7 +45,7 @@ password: See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. -### {% linkable_title Compatibility test %} +### Compatibility test To ensure that your router is compatible, navigate to `http://YOUR_ROUTER_IP/api/misystem/devicelist`. You should see a listing of the device currently connected to your router. diff --git a/source/_components/dht.markdown b/source/_components/dht.markdown index 153956e1234..a882343ac93 100644 --- a/source/_components/dht.markdown +++ b/source/_components/dht.markdown @@ -19,7 +19,7 @@ redirect_from: The `dht` sensor platform allows you to get the current temperature and humidity from a DHT11, DHT22 or AM2302 device. -## {% linkable_title Configuration %} +## Configuration To use your DHTxx sensor in your installation, add the following to your `configuration.yaml` file: @@ -71,7 +71,7 @@ humidity_offset: The name of the pin to which the sensor is connected has different names on different platforms. 'P8_11' for Beaglebone, '23' for Raspberry Pi. -### {% linkable_title Example %} +### Example An example for a Raspberry Pi 3 with a DHT22 sensor connected to GPIO4 (pin 7): diff --git a/source/_components/dialogflow.markdown b/source/_components/dialogflow.markdown index 1126bd5d99f..c96d607b1e5 100644 --- a/source/_components/dialogflow.markdown +++ b/source/_components/dialogflow.markdown @@ -37,7 +37,7 @@ Using Dialogflow will be easy to create conversations like: To use this integration, you should define a conversation (intent) in Dialogflow, configure Home Assistant with the speech to return and, optionally, the action to execute. -### {% linkable_title Configuring your Dialogflow account %} +### Configuring your Dialogflow account To get the webhook URL, go to the integrations page in the configuration screen and find "Dialogflow". Click on "configure". Follow the instructions on the screen. @@ -61,11 +61,11 @@ To get the webhook URL, go to the integrations page in the configuration screen Take a look to "Integrations", in the left menu, to configure third parties. -### {% linkable_title Configuring Home Assistant %} +### Configuring Home Assistant When activated, the [`alexa` integration](/components/alexa/) will have Home Assistant's native intent support handle the incoming intents. If you want to run actions based on intents, use the [`intent_script`](/components/intent_script) integration. -## {% linkable_title Examples %} +## Examples Download [this zip](https://github.com/home-assistant/home-assistant.github.io/blob/next/source/assets/HomeAssistant_APIAI.zip) and load it in your Dialogflow agent (**Settings** -> **Export and Import**) for examples intents to use with this configuration: diff --git a/source/_components/digital_ocean.markdown b/source/_components/digital_ocean.markdown index 2745b8d82a4..22005a23422 100644 --- a/source/_components/digital_ocean.markdown +++ b/source/_components/digital_ocean.markdown @@ -26,11 +26,11 @@ There is currently support for the following device types within Home Assistant: - [Binary Sensor](/components/digital_ocean/#binary-sensor) - [Switch](/components/digital_ocean/#switch) -## {% linkable_title Setup %} +## Setup Obtain your API key from your [Digital Ocean dashboard](https://cloud.digitalocean.com/settings/api/tokens). -## {% linkable_title Configuration %} +## Configuration To integrate your Digital Ocean droplets with Home Assistant, add the following section to your `configuration.yaml` file: @@ -47,11 +47,11 @@ access_token: type: string {% endconfiguration %} -## {% linkable_title Binary Sensor %} +## Binary Sensor The `digital_ocean` binary sensor platform allows you to monitor your Digital Ocean droplets. -### {% linkable_title Configuration %} +### Configuration To use your Digital Ocean droplets, you first have to set up your [Digital Ocean hub](/components/digital_ocean/) and then add the following to your `configuration.yaml` file: @@ -71,11 +71,11 @@ droplets: type: list {% endconfiguration %} -## {% linkable_title Switch %} +## Switch The `digital_ocean` switch platform allows you to control (start/stop) your Digital Ocean droplets. -### {% linkable_title Configuration %} +### Configuration To use your Digital Ocean droplets, you first have to set up your [Digital Ocean hub](/components/digital_ocean/) and then add the following to your `configuration.yaml` file: diff --git a/source/_components/digitalloggers.markdown b/source/_components/digitalloggers.markdown index 67076e7f7f8..e8566551384 100644 --- a/source/_components/digitalloggers.markdown +++ b/source/_components/digitalloggers.markdown @@ -18,7 +18,7 @@ redirect_from: The `digitalloggers` switch platform allows you to control the state of your [Digital Loggers](http://www.digital-loggers.com/dinfaqs.html) switches. -## {% linkable_title Configuration %} +## Configuration To use your digitalloggers switch in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/directv.markdown b/source/_components/directv.markdown index a13e1adadc7..a3a1235c78e 100644 --- a/source/_components/directv.markdown +++ b/source/_components/directv.markdown @@ -91,13 +91,13 @@ media_player: It is important to notice that the host and port variables for slave/Genie receivers are the same as the master receiver. -## {% linkable_title Services %} +## Services -### {% linkable_title Media control services %} +### Media control services Available services: turn_on, turn_off, media_play, media_pause, media_stop, media_next_track, media_previous_track, play_media -#### {% linkable_title Service `media_player.play_media` %} +#### Service `media_player.play_media` | Service data attribute | Optional | Description | | -----------------------| -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | diff --git a/source/_components/discogs.markdown b/source/_components/discogs.markdown index 1fed3dfb5bf..bdaf1147af0 100644 --- a/source/_components/discogs.markdown +++ b/source/_components/discogs.markdown @@ -18,12 +18,12 @@ redirect_from: The `discogs` platform allows you to see the current amount of records in your [Discogs](https://discogs.com) collection. -## {% linkable_title Setup %} +## Setup First, you'll need to get a personal access token from your Discogs account. You can generate a token from your profile's [Developer settings](https://www.discogs.com/settings/developers). -## {% linkable_title Configuration %} +## Configuration To enable this sensor, add the following lines to your `configuration.yaml`: diff --git a/source/_components/discord.markdown b/source/_components/discord.markdown index a331a67935f..be9ba27b241 100644 --- a/source/_components/discord.markdown +++ b/source/_components/discord.markdown @@ -44,7 +44,7 @@ token: type: string {% endconfiguration %} -### {% linkable_title Setting up the bot %} +### Setting up the bot Bots can only send messages to servers or attach local available images. To add the bot to a server you are an admin on, get the details of the bot from the [Discord My Apps page](https://discordapp.com/developers/applications/me). @@ -72,7 +72,7 @@ Right click channel name and copy the channel ID (**Copy ID**). This channel ID has to be used as the target when calling the notification service. Multiple channel IDs can be specified, across multiple servers. -#### {% linkable_title Example service payload %} +#### Example service payload ```json { @@ -89,7 +89,7 @@ This channel ID has to be used as the target when calling the notification servi } ``` -### {% linkable_title Notes %} +### Notes You can tag any user inside a channel by using their user ID in the message like so: `<@userid>` replacing `userid` with the ID you copied. To get the user ID right click on the user name to copy the ID like you did for the channel ID up above. diff --git a/source/_components/discovery.markdown b/source/_components/discovery.markdown index 0de9a0c918c..3e8708f576f 100644 --- a/source/_components/discovery.markdown +++ b/source/_components/discovery.markdown @@ -110,26 +110,26 @@ Valid values for enable are: * `dlna_dmr`: DLNA DMR enabled devices -## {% linkable_title Troubleshooting %} +## Troubleshooting -### {% linkable_title UPnP %} +### UPnP Home Assistant must be on the same network as the devices for uPnP discovery to work. If running Home Assistant in a [Docker container](/docs/installation/docker/) use switch `--net=host` to put it on the host's network. -### {% linkable_title Windows %} +### Windows -#### {% linkable_title 64-bit Python %} +#### 64-bit Python There is currently a known issue with running this integration on a 64-bit version of Python and Windows. -#### {% linkable_title Python 3.5 %} +#### Python 3.5 If you are on Windows and you're using Python 3.5, download the [Netifaces](http://www.lfd.uci.edu/~gohlke/pythonlibs/#netifaces) dependency. -### {% linkable_title could not install dependency netdisco %} +### could not install dependency netdisco If you see `Not initializing discovery because could not install dependency netdisco==0.6.1` in the logs, you will need to install the `python3-dev` or `python3-devel` package on your system manually (eg. `sudo apt-get install python3-dev` or `sudo dnf -y install python3-devel`). On the next restart of Home Assistant, the discovery should work. If you still get an error, check if you have a compiler (`gcc`) available on your system. -### {% linkable_title DSM and Synology %} +### DSM and Synology For DSM/Synology, install via debian-chroot [see this forum post](https://community.home-assistant.io/t/error-starting-home-assistant-on-synology-for-first-time/917/15). diff --git a/source/_components/dispatcher.markdown b/source/_components/dispatcher.markdown index e901f747ea2..7f3e2b51f0b 100644 --- a/source/_components/dispatcher.markdown +++ b/source/_components/dispatcher.markdown @@ -22,7 +22,7 @@ This platform is meant for developers only. The `dispatcher` camera platform allows developers to create virtual camera's. -## {% linkable_title Configuration %} +## Configuration You would normally not add this camera to your configuration directly but have it be discovered by one of the integrations that uses it. diff --git a/source/_components/dlib_face_detect.markdown b/source/_components/dlib_face_detect.markdown index 273bd3240f1..69c07a31098 100644 --- a/source/_components/dlib_face_detect.markdown +++ b/source/_components/dlib_face_detect.markdown @@ -19,7 +19,7 @@ The `dlib_face_detect` image processing platform allows you to use the [Dlib](ht This can be used to trigger an automation rule. Further info is on the [integration](/components/image_processing/) page. -### {% linkable_title Configuration Home Assistant %} +### Configuration Home Assistant ```yaml # Example configuration.yaml entry diff --git a/source/_components/dlib_face_identify.markdown b/source/_components/dlib_face_identify.markdown index 186b9f81242..eaa13e089db 100644 --- a/source/_components/dlib_face_identify.markdown +++ b/source/_components/dlib_face_identify.markdown @@ -19,7 +19,7 @@ The `dlib_face_identify` image processing platform allows you to use the [Dlib]( For using the result inside an automation rule, take a look at the [integration](/components/image_processing/) page. -### {% linkable_title Configuration Home Assistant %} +### Configuration Home Assistant ```yaml # Example configuration.yaml entry diff --git a/source/_components/dlna_dmr.markdown b/source/_components/dlna_dmr.markdown index 16b29ef8f03..315c28a84c2 100644 --- a/source/_components/dlna_dmr.markdown +++ b/source/_components/dlna_dmr.markdown @@ -20,7 +20,7 @@ The `dlna_dmr` platform allows you to control a [DLNA Digital Media Renderer](ht Please note that some devices, such as Samsung TVs, are rather picky about the source used to play from. The TTS service might not work in combination with these devices. If the play_media service does not work, please try playing from a DLNA/DMS (such as [MiniDLNA](https://sourceforge.net/projects/minidlna/)). -## {% linkable_title Configuration %} +## Configuration To add a DLNA DMR device to your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/dnsip.markdown b/source/_components/dnsip.markdown index 117e5910e03..11283754964 100644 --- a/source/_components/dnsip.markdown +++ b/source/_components/dnsip.markdown @@ -23,7 +23,7 @@ The `dnsip` sensor will expose an IP address, fetched via DNS resolution, as its You may also override the nameserver that is being used by setting the `resolver` parameter to any nameserver you like. -## {% linkable_title Configuration %} +## Configuration To enable this sensor, add the following lines to your `configuration.yaml` file: @@ -66,7 +66,7 @@ scan_interval: type: integer {% endconfiguration %} -## {% linkable_title Extended example %} +## Extended example ```yaml # Example configuration.yaml entry diff --git a/source/_components/dominos.markdown b/source/_components/dominos.markdown index f5d001a1506..7a116e5a6a0 100644 --- a/source/_components/dominos.markdown +++ b/source/_components/dominos.markdown @@ -18,7 +18,7 @@ The `dominos` integration allows you to order Dominos Pizza from within your Hom At present, this integration only supports ordering within Canada and the US. -## {% linkable_title Configuration %} +## Configuration To enable the component, you need to set up your customer information and define some orders. diff --git a/source/_components/doorbird.markdown b/source/_components/doorbird.markdown index 05805997bb7..5c2b16266a9 100644 --- a/source/_components/doorbird.markdown +++ b/source/_components/doorbird.markdown @@ -26,11 +26,11 @@ There is currently support for the following device types within Home Assistant: - [Camera](#camera) - View live and historical event based images. - [Switch](#switch) - Enable control of relays and camera night vision. -## {% linkable_title Setup %} +## Setup The user, which you are going to use with Home Assistant, needs the "API-Operator" permission enabled. -## {% linkable_title Configuration %} +## Configuration To connect your device, add the following to your `configuration.yaml` file: @@ -82,7 +82,7 @@ devices: {% endconfiguration %} -## {% linkable_title Full example %} +## Full example ```yaml doorbird: @@ -106,7 +106,7 @@ doorbird: - rfid_card_scanned ``` -## {% linkable_title Events %} +## Events Events can be defined for each configured DoorBird device independently. These events will be registered on the device and can be attached to a schedule via the DoorBird app. @@ -120,7 +120,7 @@ See [Automation Example](#automation_example) section below for details on how t Events will not be received in Home Assistant until a schedule is defined via the DoorBird app.

-#### {% linkable_title Clearing Registered Events %} +#### Clearing Registered Events Events can be cleared from DoorBird devices by visiting a special URL. Simply open a new browser window and navigate to `{Home Assistant URL}/api/doorbird/clear?token={DEVICE_TOKEN}`. Replace `{Home Assistant URL}` with the full path to your running instance, such as `http://localhost:8123`. Replace `{DEVICE_TOKEN}` with the token specified in your configuration for the device you would like to clear. @@ -128,7 +128,7 @@ Simply open a new browser window and navigate to `{Home Assistant URL}/api/doorb Please note that clearing device events will require configuration steps above to be taken again. It could also affect other third-party applications you may use with your DoorBird device. It will not break the official mobile app in any way, so mobile push notifications will still work. -#### {% linkable_title Event Data %} +#### Event Data Each event will include live image and video URLs for the Doorbird device that triggered the event. These URLs can be found on the event data and can be useful in automation actions. For example, you could use `html5_viewer_url` on a notification to be linked directly to the live view of the device that triggered the automation. @@ -144,7 +144,7 @@ The following keys are available on `event_data`: The URLs on the event will be based on the configuration used to connect to your Doorbird device. Ability to connect from outside your network will depend on your configuration.

-#### {% linkable_title Schedules %} +#### Schedules Once events have been registered on the DoorBird device, they must be attached to a schedule using the official DoorBird app on Android or iOS. Currently there are schedules available for doorbell, motion, relay, and RFID events (on supported devices). @@ -161,7 +161,7 @@ On the desired event, you should be able to specify blocks of time for when you Remember to complete the schedule assignment steps above for each event type that you registered. -### {% linkable_title Automation Example %} +### Automation Example ```yaml - alias: Doorbird Ring @@ -173,11 +173,11 @@ Remember to complete the schedule assignment steps above for each event type tha entity_id: light.side_entry_porch ``` -## {% linkable_title Camera %} +## Camera The `doorbird` implementation allows you to view the live video, the last doorbell ring image, and the last motion sensor image from your [DoorBird](http://www.doorbird.com/) device in Home Assistant. -### {% linkable_title Configuration %} +### Configuration To enable the camera, add the following to your `configuration.yaml` file: @@ -187,7 +187,7 @@ camera: - platform: doorbird ``` -## {% linkable_title Switch %} +## Switch The `doorbird` switch platform allows you to power connected relays and trigger the IR array in your [DoorBird](http://www.doorbird.com/) video doorbell device. diff --git a/source/_components/dovado.markdown b/source/_components/dovado.markdown index b751f3090ed..b274d61eeb1 100644 --- a/source/_components/dovado.markdown +++ b/source/_components/dovado.markdown @@ -56,7 +56,7 @@ port: default: 6435 {% endconfiguration %} -## {% linkable_title Notifications %} +## Notifications The `dovado` notify platform allows you to send SMS from your [Dovado](http://www.dovado.com/) router, if it supports it. @@ -68,7 +68,7 @@ notify: - platform: dovado ``` -### {% linkable_title Usage %} +### Usage This is a notify platform and thus can be controlled by calling the notify service [as described here](/components/notify/). It will send an SMS notification to a single phone number in the notification **target**. @@ -86,7 +86,7 @@ automation: target: '+14151234567' ``` -## {% linkable_title Sensor %} +## Sensor The `dovado` sensor platform let you monitor your [Dovado](http://www.dovado.com/) router. diff --git a/source/_components/downloader.markdown b/source/_components/downloader.markdown index e68266d7b58..c756cae308f 100644 --- a/source/_components/downloader.markdown +++ b/source/_components/downloader.markdown @@ -31,7 +31,7 @@ download_dir: type: string {% endconfiguration %} -### {% linkable_title Use the service %} +### Use the service Go to the "Developer Tools", then to "Call Service", and choose `downloader/download_file` from the list of available services. Fill the "Service Data" field as shown in the example below and hit "CALL SERVICE". @@ -48,7 +48,7 @@ This will download the file from the given URL. | `filename` | yes | Determine the filename. | | `overwrite` | yes | Whether to overwrite the file or not, defaults to `false`. | -### {% linkable_title Download Status Events %} +### Download Status Events When a download finished successfully, Home Assistant will emit a 'downloader_download_completed' event to the event bus which you can use to write automations against. In case download failed another event 'downloader_download_failed' is emitted to indicate that the download did not complete successfully. diff --git a/source/_components/dsmr.markdown b/source/_components/dsmr.markdown index 4140cebb3e5..0bb9981df91 100644 --- a/source/_components/dsmr.markdown +++ b/source/_components/dsmr.markdown @@ -147,7 +147,7 @@ Docker users have to allow Docker access to the device by adding `--device /dev/ $ docker run --device /dev/ttyUSB0:/dev/ttyUSB0 -d --name="home-assistant" -v /home/USERNAME/hass:/config -v /etc/localtime:/etc/localtime:ro --net=host homeassistant/home-assistant ``` -### {% linkable_title Technical overview %} +### Technical overview DSMR is a standard to which Dutch smartmeters must comply. It specifies that the smartmeter must send out a 'telegram' every 10 seconds (every second for DSMR 5.0 devices) over a serial port. diff --git a/source/_components/duckdns.markdown b/source/_components/duckdns.markdown index 0b17ab99db3..225a81f4589 100644 --- a/source/_components/duckdns.markdown +++ b/source/_components/duckdns.markdown @@ -15,7 +15,7 @@ ha_release: 0.55 With the DuckDNS integration you can keep your DuckDNS record up to date. DuckDNS is a free dynamic DNS service that allows you to point a subdomain under `duckdns.org` at your computer. -## {% linkable_title Configuration %} +## Configuration To use the integration in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/duke_energy.markdown b/source/_components/duke_energy.markdown index 27621e1a897..94550a9c079 100644 --- a/source/_components/duke_energy.markdown +++ b/source/_components/duke_energy.markdown @@ -18,13 +18,13 @@ redirect_from: The `duke_energy` sensor platform allows you get the previous days usage for all of your Duke Energy smart meters. -## {% linkable_title Setup %} +## Setup You will only have access to meters listed in your account at [Duke Energy Usage](https://www.duke-energy.com/my-account/usage-analysis). This supports both electric and gas meters. Along with previous days usage, each sensor will have attributes for the previous bills total usage and average usage. -## {% linkable_title Configuration %} +## Configuration To enable the sensor, add the following lines to your `configuration.yaml`: diff --git a/source/_components/dwd_weather_warnings.markdown b/source/_components/dwd_weather_warnings.markdown index d9a77bc1ecb..87b1f0918f2 100644 --- a/source/_components/dwd_weather_warnings.markdown +++ b/source/_components/dwd_weather_warnings.markdown @@ -21,7 +21,7 @@ The `dwd_weather_warnings` sensor platform uses the [Deutsche Wetter Dienst (DWD - A name is optional but if multiple regions are used a name will be required. - The sensor checks for new data every 15 minutes. -## {% linkable_title Configuration %} +## Configuration To add the DWD WarnApp sensor to your installation, add the following to your `configuration.yaml` file: @@ -54,7 +54,7 @@ name: default: DWD-Weather-Warnings {% endconfiguration %} -### {% linkable_title Attributes %} +### Attributes | Attribute | Description | | ------------ | -------------------------------------- | diff --git a/source/_components/dweet.markdown b/source/_components/dweet.markdown index 3ce577fe423..88f86a7a94b 100644 --- a/source/_components/dweet.markdown +++ b/source/_components/dweet.markdown @@ -31,7 +31,7 @@ There is currently support for the following device types within Home Assistant: - [Sensor](#sensor) -## {% linkable_title Configuration %} +## Configuration To use the `dweet` integration in your installation, add the following to your `configuration.yaml` file: @@ -57,11 +57,11 @@ whitelist: type: list {% endconfiguration %} -## {% linkable_title Sensor %} +## Sensor The `dweet` sensor platform allows you to get details from your devices which are publishing their values to [Dweet.io](https://dweet.io/). -### {% linkable_title Configuration %} +### Configuration To use Dweet.io sensors in your installation, add the following to your `configuration.yaml` file: @@ -95,7 +95,7 @@ unit_of_measurement: type: string {% endconfiguration %} -### {% linkable_title Full configuration sample %} +### Full configuration sample A full configuration entry could look like the sample below. @@ -111,7 +111,7 @@ sensor: ``` {% endraw %} -### {% linkable_title Interacting with Dweet.io %} +### Interacting with Dweet.io You can easily send dweets from the command-line to test your sensor with `curl`. diff --git a/source/_components/dyson.markdown b/source/_components/dyson.markdown index 6e8f9ebccf4..324690730cf 100644 --- a/source/_components/dyson.markdown +++ b/source/_components/dyson.markdown @@ -33,7 +33,7 @@ There is currently support for the following device types within Home Assistant: - Vacuum - Air Quality -## {% linkable_title Configuration %} +## Configuration To enable this component, add the following lines to your `configuration.yaml`: @@ -101,11 +101,11 @@ For example: $ nmap -p 1883 192.168.0.0/24 -- open ``` -## {% linkable_title Vacuum %} +## Vacuum The `dyson` vacuum platform allows you to control your Dyson 360 Eye robot vacuum. -### {% linkable_title Component services %} +### Component services This integration support the following services (see [Vacuum Cleaner Robots](/components/vacuum/)): @@ -118,11 +118,11 @@ This integration support the following services (see [Vacuum Cleaner Robots](/co - `Quiet` - `Max` -## {% linkable_title Climate %} +## Climate The `dyson` climate platform allows you to control your Dyson Pure Hot+Cool Fan thermal control. For controlling the fan functionality, see the Dyson fan part on this page. -### {% linkable_title Component services %} +### Component services This integration supports the following services (see [Climate](/components/climate/)): @@ -132,17 +132,17 @@ This integration supports the following services (see [Climate](/components/clim - [`set_fan_mode`](/components/climate/#service-climateset_fan_mode) - [`set_operation_mode`](/components/climate/#service-climateset_operation_mode) -## {% linkable_title Fan %} +## Fan The `dyson` fan platform allows you to control your Dyson Purifier fans. -### {% linkable_title Supported fan devices %} +### Supported fan devices - Pure Cool link (desk and tower) - Pure Hot+cool link (see climate part) for thermal control - Pure Cool 2018 (DP04 and TP04) -### {% linkable_title Attributes %} +### Attributes There are several attributes which can be used for automations and templates. @@ -157,11 +157,11 @@ There are several attributes which can be used for automations and templates. | `hepa filter` | State of the fan's HEPA filter in % (only for DP04 and TP04).| | `carbon filter` | State of the fan's carbon filter in % (only for DP04 and TP04).| -## {% linkable_title Sensor %} +## Sensor The `dyson` sensor platform provides temperature and humidity sensors. -## {% linkable_title Air Quality %} +## Air Quality The `dyson` air quality platform provides the following levels: @@ -173,7 +173,7 @@ The `dyson` air quality platform provides the following levels: Note: currently only the 2018 dyson fans are supported(TP04 and DP04). -### {% linkable_title Supported fan devices %} +### Supported fan devices - Pure Cool link (desk and tower) - Pure Hot+cool link (see climate part) for thermal control diff --git a/source/_components/ebox.markdown b/source/_components/ebox.markdown index 130a7ef7a67..494393c937e 100644 --- a/source/_components/ebox.markdown +++ b/source/_components/ebox.markdown @@ -18,7 +18,7 @@ redirect_from: Integrate your [EBox](https://client.ebox.ca/) account information into Home Assistant. -## {% linkable_title Configuration %} +## Configuration To use your EBox sensor in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/ebusd.markdown b/source/_components/ebusd.markdown index 81ae63aba75..c8d0b2019d2 100644 --- a/source/_components/ebusd.markdown +++ b/source/_components/ebusd.markdown @@ -17,7 +17,7 @@ redirect_from: Integration between [ebusd](https://github.com/john30/ebusd/) daemon for communication with eBUS heating systems, and Home Assistant using sensor component. -## {% linkable_title Configuration %} +## Configuration Enable the sensor by adding the following to your `configuration.yaml` file: diff --git a/source/_components/ecoal_boiler.markdown b/source/_components/ecoal_boiler.markdown index f9fb1c13b61..06d4b903333 100644 --- a/source/_components/ecoal_boiler.markdown +++ b/source/_components/ecoal_boiler.markdown @@ -19,7 +19,7 @@ redirect_from: The `ecoal_boiler` integration is the base for pumps and sensors managed by [esterownik.pl eCoal boiler controller](https://esterownik.pl/nasze-produkty/ecoal). -## {% linkable_title Configuration %} +## Configuration To use your eCoal pumps or sensors in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/ecobee.markdown b/source/_components/ecobee.markdown index fb4338e3bb5..23bca332038 100644 --- a/source/_components/ecobee.markdown +++ b/source/_components/ecobee.markdown @@ -27,7 +27,7 @@ redirect_from: The `ecobee` integration lets you control a thermostats and view sensor data from [ecobee](https://ecobee.com) thermostats. -## {% linkable_title Configuration %} +## Configuration You will need to obtain an API key from ecobee's [developer site](https://www.ecobee.com/developers/) to use this component. To get the key, first you need to register your thermostat which should be done as part of the ecobee installation. Once you have done that perform the following steps. @@ -85,7 +85,7 @@ hold_temp: If for whatever reason you delete and re-create your ecobee app at ecobee.com such that your developer API key changes, you will need to delete your `/conf/ecobee.conf file`. You will also need to update the `api_key:` in the `configuration.yaml` or `secrets.yaml` file. -## {% linkable_title Notifications %} +## Notifications To get your Ecobee notifications working with Home Assistant, you must first have the main Ecobee integration loaded and running. Once you have that configured, you can setup this integration to send messages to your Ecobee device. @@ -108,9 +108,9 @@ name: To use notifications, please see the [getting started with automation page](/getting-started/automation/). -## {% linkable_title Thermostat %} +## Thermostat -### {% linkable_title Concepts %} +### Concepts The Ecobee Thermostat supports the following key concepts. @@ -146,7 +146,7 @@ The _operation mode_ of the device is the currently active operational modes that the Ecobee thermostat provides: heat, auxHeatOnly, cool, auto, and off. -## {% linkable_title Attributes %} +## Attributes The following attributes are provided by the Ecobee Thermostat: `name`, `temperature_unit`, `current_temperature`, `target_temperature`, @@ -156,7 +156,7 @@ The following attributes are provided by the Ecobee Thermostat: `is_away_mode_on`, `vacation`, `climate_list`, `aux_heat`. The attributes `min_temp` and `max_temp` are meaningless constant values. -### {% linkable_title Attribute `name` %} +### Attribute `name` Returns the name of the Ecobee Thermostat. @@ -164,7 +164,7 @@ Returns the name of the Ecobee Thermostat. | ---------------| ----------- | | String | Name of the Ecobee Thermostat -### {% linkable_title Attribute `temperature_unit` %} +### Attribute `temperature_unit` Returns the unit of measurement used for temperature by the thermostat. @@ -172,7 +172,7 @@ Returns the unit of measurement used for temperature by the thermostat. | ---------------| ----------- | | String | Name of the temperature unit -### {% linkable_title Attribute `current_temperature` %} +### Attribute `current_temperature` Returns the current temperature measured by the thermostat. @@ -180,7 +180,7 @@ Returns the current temperature measured by the thermostat. | ---------------| ----------- | | Integer | Currently measured temperature -### {% linkable_title Attribute `target_temperature` %} +### Attribute `target_temperature` Returns the target temperature of the thermostat, when the thermostat is not in auto operation mode. @@ -189,7 +189,7 @@ not in auto operation mode. | ---------------| ----------- | | Integer | Target temperature -### {% linkable_title Attribute `target_temperature_low` %} +### Attribute `target_temperature_low` Returns the desired heating temperature set in the thermostat when in auto operation mode. @@ -198,7 +198,7 @@ auto operation mode. | ---------------| ----------- | | Integer | Target temperature -### {% linkable_title Attribute `target_temperature_high` %} +### Attribute `target_temperature_high` Returns the desired cooling temperature set in the thermostat when in auto operation mode. @@ -207,7 +207,7 @@ auto operation mode. | ---------------| ----------- | | Integer | Target temperature -### {% linkable_title Attribute `desired_fan_mode` %} +### Attribute `desired_fan_mode` Returns the desired fan mode of the current operation. @@ -215,7 +215,7 @@ Returns the desired fan mode of the current operation. | ---------------| ----------- | | String | 'on', 'off' -### {% linkable_title Attribute `fan` %} +### Attribute `fan` Returns the current fan state. @@ -223,7 +223,7 @@ Returns the current fan state. | ---------------| ----------- | | String | 'on', 'off' -### {% linkable_title Attribute `current_hold_mode` %} +### Attribute `current_hold_mode` Returns the current temperature hold, if any. @@ -231,7 +231,7 @@ Returns the current temperature hold, if any. | ---------------| ----------- | | String | 'temp', 'vacation', 'home', 'away', etc., None -### {% linkable_title Attribute `operation` %} +### Attribute `operation` Returns the current operation of the thermostat. @@ -239,7 +239,7 @@ Returns the current operation of the thermostat. | ---------------| ----------- | | String | 'auto', 'cool', 'heat', 'off' -### {% linkable_title Attribute `operation_list` %} +### Attribute `operation_list` Returns the list of available operation modes. @@ -247,7 +247,7 @@ Returns the list of available operation modes. | ---------------| ----------- | | List of String | Available operation modes -### {% linkable_title Attribute `operation_mode` %} +### Attribute `operation_mode` Returns the current operation mode of the thermostat. @@ -255,7 +255,7 @@ Returns the current operation mode of the thermostat. | ---------------| ----------- | | String | Currently active operation mode -### {% linkable_title Attribute `equipment_running` %} +### Attribute `equipment_running` Returns the list of equipment that is currently operating from the thermostat. @@ -263,12 +263,12 @@ Returns the list of equipment that is currently operating from the thermostat. | ---------------| ----------- | | String | If no equipment is currently running empty string is returned. Possible values are a comma separated list of any of the following: heatPump, heatPump2, heatPump3, compCool1, compCool2, auxHeat1, auxHeat2, auxHeat3, fan, humidifier, dehumidifier, ventilator, economizer, compHotWater, auxHotWater. -### {% linkable_title Attribute `mode` %} +### Attribute `mode` Returns the climate currently active on the thermostat. The mode is returned as the user-visible name (rather than the internally used name). -### {% linkable_title Attribute `fan_min_on_time` %} +### Attribute `fan_min_on_time` Returns the current fan minimum on time. @@ -276,12 +276,12 @@ Returns the current fan minimum on time. | ---------------| ----------- | | Integer | Current fan minimum on time in minutes -### {% linkable_title Attribute `is_away_mode_on` %} +### Attribute `is_away_mode_on` Returns whether the thermostat is in away mode (see the corresponding service for more detail). -### {% linkable_title Attribute `actual humidity` %} +### Attribute `actual humidity` Returns the humidity as measured by the thermostat. @@ -289,7 +289,7 @@ Returns the humidity as measured by the thermostat. | ---------------| ----------- | | Integer | Current humidity -### {% linkable_title Attribute `vacation` %} +### Attribute `vacation` Returns the currently active vacation or `None`. @@ -297,11 +297,11 @@ Returns the currently active vacation or `None`. | ---------------| ----------- | | String | Name of currently active vacation | -### {% linkable_title Attribute `climate_list` %} +### Attribute `climate_list` Returns the list of climates defined in the thermostat. -### {% linkable_title Attribute `aux_heat` %} +### Attribute `aux_heat` Returns the current auxiliary heat state. @@ -309,7 +309,7 @@ Returns the current auxiliary heat state. | ---------------| ----------- | | String | 'on', 'off' -## {% linkable_title Services %} +## Services The following services are provided by the Ecobee Thermostat: `set_away_mode`, `set_hold_mode`, `set_temperature`, `set_operation_mode`, @@ -318,7 +318,7 @@ The services `set_aux_heat`, `set_humidity`, `set_fan_mode`, and `set_swing_mode` offered by the [Climate component](/components/climate/) are not implemented for this thermostat. -### {% linkable_title Service `set_away_mode` %} +### Service `set_away_mode` Turns Away Mode on or off, ignoring the next scheduled activity. This setting will override the thermostat Hold Duration setting, even if you set the hold duration to "Until the next scheduled activity" within thermostat preferences. @@ -327,7 +327,7 @@ Turns Away Mode on or off, ignoring the next scheduled activity. This setting wi | `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all. | `away_mode` | no | 'on' or 'off' -### {% linkable_title Service `set_hold_mode` %} +### Service `set_hold_mode` Puts the thermostat into the given hold mode. For 'home', 'away', 'sleep', and any other hold based on a comfort setting, the @@ -345,7 +345,7 @@ canceled. NOTE: If you create custom hold modes (also known as "Comfort Settings") on your ecobee.com dashboard, their hold_modes are `smart1`, `smart2`, `smart3`, etc. The number for each custom mode should match the mode's icon on your ecobee.com dashboard. Also note that the mode numbers/icons in the ecobee mobile app *may not match* the numbers/icons from the ecobee.com web dashboard. The ones on the website are the ones you shoud use to determine the correct `smartX` hold_mode IDs. -### {% linkable_title Service `set_temperature` %} +### Service `set_temperature` Puts the thermostat into a temporary hold at the given temperature. @@ -359,7 +359,7 @@ Puts the thermostat into a temporary hold at the given temperature. Only the target temperatures relevant for the current operation mode need to be provided. -### {% linkable_title Service `set_operation_mode` %} +### Service `set_operation_mode` Sets the current operation mode of the thermostat. @@ -368,7 +368,7 @@ Sets the current operation mode of the thermostat. | `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all. | `operation_mode` | no | 'auto', 'auxHeatOnly', 'cool', 'heat', 'off' -### {% linkable_title Service `fan_min_on_time` %} +### Service `fan_min_on_time` Sets the fan minimum on time. @@ -377,7 +377,7 @@ Sets the fan minimum on time. | `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all. | `fan_min_on_time` | no | Desired fan minimum on time -### {% linkable_title Service `resume_program` %} +### Service `resume_program` Resumes the currently active schedule. diff --git a/source/_components/econet.markdown b/source/_components/econet.markdown index 9753313bd3d..369f696c6c1 100644 --- a/source/_components/econet.markdown +++ b/source/_components/econet.markdown @@ -19,7 +19,7 @@ redirect_from: The `econet` water heater platform is consuming the information provided by a [EcoNet enabled Rheem water heater](http://www.rheem.com/EcoNet/Home). This platform allows you to set the temperature, the operation mode, and enable vacation mode. -## {% linkable_title Configuration %} +## Configuration To enable the `econet` water heater platform, add the following information to your `configuration.yaml` file: @@ -42,7 +42,7 @@ password: type: string {% endconfiguration %} -### {% linkable_title Service `econet.add_vacation` %} +### Service `econet.add_vacation` You can use the service `econet.add_vacation` to create a new vacation for your EcoNet water heaters. @@ -56,7 +56,7 @@ You can use the service `econet.add_vacation` to create a new vacation for your The Unix timestamps can be obtained from the `input_datetime` component. This will allow you to graphically set the start and end date.

-### {% linkable_title Service `econet.delete_vacation` %} +### Service `econet.delete_vacation` You can use the service `econet.delete_vacation` to remove all vacations from an EcoNet water heater. diff --git a/source/_components/ecovacs.markdown b/source/_components/ecovacs.markdown index d9a2d423b09..b5fd46c5626 100644 --- a/source/_components/ecovacs.markdown +++ b/source/_components/ecovacs.markdown @@ -23,7 +23,7 @@ There is currently support for the following device types within Home Assistant: - [Vacuum](#vacuum) -## {% linkable_title Configuration %} +## Configuration To add your Ecovacs devices into your Home Assistant installation, add the following to your `configuration.yaml` file: @@ -56,7 +56,7 @@ continent: Note: For some countries, you will need to set `continent` to `ww` (meaning worldwide.) There is unfortunately no way to know the correct settings other than guessing and checking. See the [sucks library protocol documentation](https://github.com/wpietri/sucks/blob/master/protocol.md) for more information about what has been figured out about the Ecovacs servers. -### {% linkable_title Stability and Reporting Bugs %} +### Stability and Reporting Bugs The library that talks to the Ecovacs servers is in a very early state and still under development. As such, it is likely that not all regions and devices will work at the current time. @@ -75,11 +75,11 @@ logger: Warning: doing this will cause your authentication token to visible in your log files. Be sure to remove any tokens and other authentication details from your log before posting them in an issue. -## {% linkable_title Vacuum %} +## Vacuum The `ecovacs` vacuum platform allows you to monitor and control your Ecovacs Deebot vacuums. -### {% linkable_title Component Lifespans %} +### Component Lifespans The remaining lifespan of components on your Deebot vacuum will be reported as attributes on the vacuum entity. The value will be a whole number representing the percentage of life remaining. @@ -113,7 +113,7 @@ binary_sensor: ``` {% endraw %} -### {% linkable_title Handling Errors %} +### Handling Errors The vacuum entity has an `error` attribute that will contain the _most recent_ error message that came from the vacuum. There is not a comprehensive list of all error messages, so you may need to do some experimentation to determine the error messages that your vacuum can send. diff --git a/source/_components/eddystone_temperature.markdown b/source/_components/eddystone_temperature.markdown index 5fd1384f143..95ec4ab3384 100644 --- a/source/_components/eddystone_temperature.markdown +++ b/source/_components/eddystone_temperature.markdown @@ -19,7 +19,7 @@ redirect_from: The `eddystone_temperature` sensor platform reads temperature information from Bluetooth LE advertisements transmitted by [Eddystone](https://en.wikipedia.org/wiki/Eddystone_(Google)) beacons. Your beacons must be configured to transmit UID frames (for identification) and TLM frames (for temperature). All beacons that support the Eddystone protocol, have a temperature sensor and can transmit TLM frames are compatible with this platform. For example [Gimbal](https://store.gimbal.com/collections/beacons/), [Estimote](http://estimote.com/) or [kontakt.io](https://kontakt.io/). For more manufacturers see [this overview](https://developers.google.com/beacons/eddystone#beacon_manufacturers) by Google. -## {% linkable_title Requirements %} +## Requirements As this platform uses `bluez` to scan for Bluetooth LE devices **a Linux OS with bluez installed** is required. In addition to that, the `libbluetooth` headers need to be installed: diff --git a/source/_components/edimax.markdown b/source/_components/edimax.markdown index fa82a66b07b..9768ce73f8e 100644 --- a/source/_components/edimax.markdown +++ b/source/_components/edimax.markdown @@ -48,7 +48,7 @@ name: type: string {% endconfiguration %} -## {% linkable_title Power consumption sensor %} +## Power consumption sensor Starting with [version 2 of the firmware](https://www.edimax.com/edimax/download/download/data/edimax/global/download/), the Edimax switches can also report the current and accumulated daily power consumption in their state objects. Use a [template sensor](/components/sensor.template/) to extract their values: diff --git a/source/_components/edp_redy.markdown b/source/_components/edp_redy.markdown index 58da62a3a9a..02eeca1e50b 100644 --- a/source/_components/edp_redy.markdown +++ b/source/_components/edp_redy.markdown @@ -21,7 +21,7 @@ redirect_from: [EDP re:dy](https://www.edp.pt/particulares/servicos/redy/) is a Home Automation platform from Portuguese energy provider EDP, that allows control of appliances and other devices, as well as monitoring power consumption. This integration allows integrating EDP re:dy into Home Assistant. -## {% linkable_title Configuration %} +## Configuration You will need your re:dy login information (username and password) to use this component. diff --git a/source/_components/ee_brightbox.markdown b/source/_components/ee_brightbox.markdown index ad878df41dd..c19e57ee00b 100644 --- a/source/_components/ee_brightbox.markdown +++ b/source/_components/ee_brightbox.markdown @@ -18,7 +18,7 @@ redirect_from: This platform offers presence detection by looking at connected devices to a [EE Bright Box 2](https://ee.co.uk/help/phones-and-device/home-broadband/bright-box-2-wireless-router/bright-box-2-wireless-router) router. -## {% linkable_title Configuration %} +## Configuration To use a EE Bright Box router in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/efergy.markdown b/source/_components/efergy.markdown index e2ebb91456a..cceca5dd031 100644 --- a/source/_components/efergy.markdown +++ b/source/_components/efergy.markdown @@ -18,7 +18,7 @@ redirect_from: Integrate your [Efergy](https://efergy.com) meter information into Home Assistant. -## {% linkable_title Setup %} +## Setup To get an app token: @@ -27,7 +27,7 @@ To get an app token: 3. Click on App tokens 4. Click "Add token" -## {% linkable_title Configuration %} +## Configuration To enable the sensor, add the following lines to your `configuration.yaml`: diff --git a/source/_components/egardia.markdown b/source/_components/egardia.markdown index 0052d25a0b8..ab7fe2b47f0 100644 --- a/source/_components/egardia.markdown +++ b/source/_components/egardia.markdown @@ -23,7 +23,7 @@ The `egardia` platform enables the ability to control an [Egardia](http://egardi You will need to know the IP of your alarm panel on your local network. Test if you can login to the panel by browsing to the IP address and log in using your Egardia/Woonveilig account. -## {% linkable_title Basic configuration %} +## Basic configuration To enable the integration with your alarm panel, add the following lines to your `configuration.yaml` file: @@ -102,7 +102,7 @@ You can change this, however, using the following procedure. This is a more adva There seem to be multiple versions of software running on GATE-02 devices; we have received reports from GATE-02 users who successfully run this package in GATE-02 mode. Others have reported they needed to specify GATE-03 as their version to integrate their GATE-02.

-## {% linkable_title Advanced configuration %} +## Advanced configuration 1. Log in to your alarm system's control panel. You will need to access http://[IP of your control panel]. You know this already since you need it in the basic configuration from above. Log in to the control panel with your Egardia/Woonveilig username and password. 2. Once logged in, go to *System Settings*, *Report* and change the Server Address for your primary server to the IP or hostname of your Home Assistant machine. You can leave the port number set to 52010 or change it to anything you like. **Make sure to change the settings of the primary server otherwise the messages will not come through. Note that this will limit (or fully stop) the number of alarm messages you will get through Egardia's / Woonveilig services.** Maybe, that is just what you want. Make sure to save your settings by selecting 'OK'. @@ -126,7 +126,7 @@ There seem to be multiple versions of software running on GATE-02 devices; we ha Note that for all code groups (*arm*,*disarm*, etc) multiple codes can be entered since each sensor triggers with a different code and each user of the system has its own arm and disarm codes. Also note that your system will do regular system checks which will be reported as well. Since Home Assistant provides no way of handling them properly, you can enter those codes as *ignore* (again, multiple codes can be used here). The egardia integration will ignore these codes and continue returning the old status if it receives any of the codes that are listed as ignore. This is useful for example when you have armed your alarm at night: normally a system check will occur at least once during the night and if that code is not specified anywhere Home Assistant will set the status of the alarm to its default, which is unarmed. This is in fact wrong. Listing the code as ignore changes this behavior and Home Assistant will continue to show the status the alarm is in (disarm, arm, home, triggered) even when system checks occur. 5. Test your setup and enjoy. The integration will update if the alarm status changes, including triggers. You can use this to build your own automations and send notifications as you wish. *Note*: previous versions required a separate egardiaserver to be set up. This is no longer necessary and corresponding system services can be removed (using systemctl). -## {% linkable_title Binary Sensor %} +## Binary Sensor The `egardia` platform allows you to get data from your [Egardia](http://www.egardia.com)/[Woonveilig](http://www.woonveilig.nl) binary sensors from within Home Assistant. Currently only door contacts are supported. IR sensors are not supported and will probably never be since their status cannot be read outside of the alarm control panel. Smoke sensors and others might be added but currently are not supported. diff --git a/source/_components/eight_sleep.markdown b/source/_components/eight_sleep.markdown index 82f4bedaa6f..cd6b58f37a5 100644 --- a/source/_components/eight_sleep.markdown +++ b/source/_components/eight_sleep.markdown @@ -26,7 +26,7 @@ There is currently support for the following device types within Home Assistant: - Binary Sensor - lets observe the presence state of a [Eight Sleep](https://eightsleep.com/) cover/mattress through Home Assistant. - Sensor - This includes bed state and results of the current and previous sleep sessions. -## {% linkable_title Configuration %} +## Configuration It's setup utilizing 'Sensor' platform to convey the current state of your bed and results of your sleep sessions and a 'Binary Sensor' platform to indicate your presence in the bed. A service is also provided to set the heating level and duration of the bed. @@ -57,7 +57,7 @@ partner: default: false {% endconfiguration %} -### {% linkable_title Supported features %} +### Supported features Sensors: @@ -72,7 +72,7 @@ Binary Sensors: - eight_left/right_bed_presence -### {% linkable_title Service `heat_set` %} +### Service `heat_set` You can use the service eight_sleep/heat_set to adjust the target heating level and heating duration of your bed. diff --git a/source/_components/elkm1.markdown b/source/_components/elkm1.markdown index 61dc2e45acb..727da614faf 100644 --- a/source/_components/elkm1.markdown +++ b/source/_components/elkm1.markdown @@ -40,7 +40,7 @@ There is currently support for the following device types within Home Assistant: - **Sensor** - Elk-M1 counters, keypads, panel, settings, and zones are represented as `sensor` entities. - **Switch** - Elk-M1 outputs are represented as `switch` entities. -## {% linkable_title Configuration %} +## Configuration To integrate Elk-M1 controller with Home Assistant, add the following section to your `configuration.yaml` file: diff --git a/source/_components/emoncms.markdown b/source/_components/emoncms.markdown index 10d2482bcd5..b03d4cdcc1f 100644 --- a/source/_components/emoncms.markdown +++ b/source/_components/emoncms.markdown @@ -30,7 +30,7 @@ sensor: id: 1 ``` -## {% linkable_title Configuration variables %} +## Configuration variables - **api_key** (*Required*): The read API key for your Emoncms user. - **url** (*Required*): The base URL of Emoncms, use "https://emoncms.org" for the cloud based version. @@ -42,7 +42,7 @@ sensor: - **scan_interval** (*Optional*): Defines the update interval of the sensor in seconds. - **unit_of_measurement** (*Optional*): Defines the unit of measurement of for all the sensors. default is "W". -## {% linkable_title Default naming scheme %} +## Default naming scheme The names of the sensors created by this integration will use the feed names defined in EmonCMS if available, or the feed ID otherwise, and will be prefixed with "EmonCMS", e.g., "EmonCMS Total Power" or "EmonCMS Feed 5". @@ -50,7 +50,7 @@ If the `id` property is anything but `1`, the ID will be shown as well, e.g., "E If `sensor_names` is used, any feeds with defined names will get those names exactly, with no prefix. -### {% linkable_title Examples %} +### Examples In this section you find some more examples of how this sensor can be used. diff --git a/source/_components/emulated_hue.markdown b/source/_components/emulated_hue.markdown index e910eb6d0a8..2667e8db0cc 100644 --- a/source/_components/emulated_hue.markdown +++ b/source/_components/emulated_hue.markdown @@ -35,7 +35,7 @@ It is recommended to assign a static IP address to the computer running Home Ass Both Google Home and Alexa use the device they were initially set up with for communication with `emulated_hue`. In other words: if you remove/replace this device you will also break `emulated_hue`. To recover your `emulated_hue` functionality, backup your `config/emulated_hue_ids.json` file, delete the original one and reboot your Home Assistant instance.

-### {% linkable_title Configuration %} +### Configuration To enable the emulated Hue bridge, add one of the following configs to your `configuration.yaml` file: @@ -134,7 +134,7 @@ The following are attributes that can be applied in the `entities` section: These attributes used to be found under the `customize` section of `homeassistant`, however, they have now been moved to `entities`. Emulated Hue configuration under `homeassistant.customize` will be deprecated in the near future.

-### {% linkable_title Troubleshooting %} +### Troubleshooting You can verify that the `emulated_hue` integration has been loaded and is responding by pointing a local browser to the following URL: @@ -150,6 +150,6 @@ sudo setcap 'cap_net_bind_service=+ep' /srv/homeassistant/homeassistant_venv/bin ``` Please note that your path may be different depending on your installation method. For example, if you followed the [Virtualenv instructions](/docs/installation/virtualenv/), your path will be `/srv/homeassistant/bin/python3`. -### {% linkable_title License %} +### License Much of this code is based on work done by Bruce Locke on his [ha-local-echo](https://github.com/blocke/ha-local-echo) project, originally released under the MIT License. The license is located [here](https://github.com/blocke/ha-local-echo/blob/b9bf5dcaae6d8e305e2283179ffba64bde9ed29e/LICENSE). diff --git a/source/_components/emulated_roku.markdown b/source/_components/emulated_roku.markdown index ddc0b056069..520e5a922b6 100644 --- a/source/_components/emulated_roku.markdown +++ b/source/_components/emulated_roku.markdown @@ -29,7 +29,7 @@ your Home Assistant instance through the automations you create with emulated Ro Using a proxy with whitelisted IP addresses is recommended. (set `advertise_ip` to the proxy's ip or DNS name)

-## {% linkable_title Configuration %} +## Configuration The integration is configurable through the frontend. (**Configuration** -> **Integrations** -> **Emulated Roku**) @@ -73,9 +73,9 @@ upnp_bind_multicast: After starting up, you can check if the emulated Roku is reachable at the specified ports on your Home Assistant instance (eg.: `http://192.168.1.101:8060/`). -## {% linkable_title Events %} +## Events -### {% linkable_title Event `roku_command` %} +### Event `roku_command` All Roku commands are sent as `roku_command` events. @@ -89,7 +89,7 @@ Field | Description The available keys are listed here: [Roku key codes](https://sdkdocs.roku.com/display/sdkdoc/External+Control+API#ExternalControlAPI-KeypressKeyValues) -## {% linkable_title Automations %} +## Automations The following is an example implementation of an automation: ```yaml @@ -108,7 +108,7 @@ The following is an example implementation of an automation: entity_id: media_player.amplifier ``` -## {% linkable_title Troubleshooting %} +## Troubleshooting If you change your advertised IP or ports, you will have to re-add the emulated Roku in your app. When using Harmony, the app should auto-discover any changes via UPnP discovery (if `name` is unchanged) once it detects that the device is unreachable. diff --git a/source/_components/enocean.markdown b/source/_components/enocean.markdown index 7d6a89692c1..72210ac6311 100644 --- a/source/_components/enocean.markdown +++ b/source/_components/enocean.markdown @@ -51,7 +51,7 @@ The available profiles are usually listed somewhere in the device manual. Support for tech-in messages is not implemented. -## {% linkable_title Hub %} +## Hub To integrate an EnOcean controller with Home Assistant, add the following section to your `configuration.yaml` file: @@ -68,7 +68,7 @@ device: type: string {% endconfiguration %} -## {% linkable_title Binary Sensor %} +## Binary Sensor This can typically be one of those batteryless wall switches. Tested with: @@ -114,7 +114,7 @@ EnOcean binary sensors have no state, they only generate 'button_pressed' events - **which**: Always `0` when using the single rocket. `0` or `1` when using the dual rocket switch. - **onoff**: `0` or `1` for either side of the rocket. -## {% linkable_title Automation example %} +## Automation example Sample automation to switch lights on and off: @@ -134,7 +134,7 @@ automation: entity_id: "{% raw %}{% if trigger.event.data.which == 1 %} light.hall_left {% else %} light.hall_right {%endif %}{% endraw %}" ``` -## {% linkable_title Light %} +## Light An EnOcean light can take many forms. Currently only one type has been tested: Eltako FUD61 dimmer. @@ -164,7 +164,7 @@ name: type: string {% endconfiguration %} -## {% linkable_title Sensor %} +## Sensor The EnOcean sensor platform currently supports the following device types: @@ -200,7 +200,7 @@ device_class: {% endconfiguration %} -### {% linkable_title Power sensor %} +### Power sensor This has been tested with a Permundo PSC234 switch, but any device sending EEP **A5-12-01** messages will work. @@ -216,7 +216,7 @@ sensor: ``` -### {% linkable_title Humidity sensor %} +### Humidity sensor The following [EnOcean Equipment Profiles](https://www.enocean-alliance.org/what-is-enocean/specifications/) are supported: @@ -236,7 +236,7 @@ sensor: device_class: humidity ``` -### {% linkable_title Temperature sensor %} +### Temperature sensor This sensor has been tested with a generic STM-330 sensor, which is used in most indoor temperature sensor devices. @@ -309,7 +309,7 @@ sensor: range_max: 250 ``` -## {% linkable_title Switch %} +## Switch An EnOcean switch can take many forms. Currently, only a few types have been tested: Permundo PSC234 and Nod On SIN-2-1-01. diff --git a/source/_components/enphase_envoy.markdown b/source/_components/enphase_envoy.markdown index e34f48b633b..26409c14ff6 100644 --- a/source/_components/enphase_envoy.markdown +++ b/source/_components/enphase_envoy.markdown @@ -18,7 +18,7 @@ redirect_from: A sensor platform for the [Enphase Envoy](https://enphase.com/en-us/products-and-services/envoy) solar energy gateway. Works with older models that only have production metrics (ie. Envoy-C) and newer models that offer both production and consumption metrics (ie. Envoy-S). -### {% linkable_title Configuration %} +### Configuration To enable this sensor, add the following lines to your `configuration.yaml` file: diff --git a/source/_components/entur_public_transport.markdown b/source/_components/entur_public_transport.markdown index 1f618f85524..dd6516c325d 100644 --- a/source/_components/entur_public_transport.markdown +++ b/source/_components/entur_public_transport.markdown @@ -25,7 +25,7 @@ Real-time data is fetched from [Entur](https://www.entur.org). Entur is a servic

Note that the underlying API is rate limited and to avoid getting your instance blocked from entur the sensor is only fetching new information every 45 seconds. It's recommended to not schedule updates more often than this.

-## {% linkable_title Configuration %} +## Configuration ```yaml # Example configuration.yaml entry @@ -72,7 +72,7 @@ number_of_departures: default: 2 {% endconfiguration %} -## {% linkable_title Example usage %} +## Example usage Example of multiple stop places, with expanded sensors for each platform under the station, and with the platforms added to the map. @@ -108,7 +108,7 @@ sensor: - 'NSB:Line:59' ``` -## {% linkable_title Obtaining a stop id %} +## Obtaining a stop id [Entur's travel planer](https://en-tur.no) has a map of all stops used in Norway. Use the map to find the stops you're interested in. When you have found one of your stops, click on it. @@ -118,7 +118,7 @@ Now the web browser should contain an URL with the id in it. Such as this: The stop id is the content after `id=` parameter in the url. Copy paste this into the configuration. -## {% linkable_title FAQ - Troubleshooting %} +## FAQ - Troubleshooting **Q:** I have multiple stop ids and have added whitelisting of a line. Now some of the stop places are showing `unknown`. diff --git a/source/_components/environment_canada.markdown b/source/_components/environment_canada.markdown index e1eab1a79b6..40c74f709f7 100644 --- a/source/_components/environment_canada.markdown +++ b/source/_components/environment_canada.markdown @@ -24,7 +24,7 @@ The following device types and data are supported: - [Sensor](#sensor) - Current conditions and alerts - [Camera](#camera) - Radar imagery -## {% linkable_title Location Selection %} +## Location Selection Each platform automatically determines which weather station's data to use. However, as station coordinates provided by Environment Canada are somewhat imprecise, in some cases you may need to override the automatic selection to use the desired station. @@ -34,7 +34,7 @@ For each platform, the location to use is determined according to the following - Closest station to latitude/longitude specified in platform configuration (optional - Closest station to latitude/longitude specified in Home Assistant core configuration -## {% linkable_title Weather %} +## Weather The `environment_canada` weather platform populates a weather card with Environment Canada current conditions and forecast [data](https://weather.gc.ca/canada_e.html). @@ -76,7 +76,7 @@ forecast: default: daily {% endconfiguration %} -## {% linkable_title Sensor %} +## Sensor The `environment_canada` sensor platform creates sensors based on Environment Canada [current conditions](https://weather.gc.ca/canada_e.html) and [alerts](https://weather.gc.ca/warnings/index_e.html). @@ -159,7 +159,7 @@ monitored_conditions: description: Alerts that have recently ended. {% endconfiguration %} -## {% linkable_title Camera %} +## Camera The `environment_canada` camera platform displays Environment Canada meteorological [radar imagery](https://weather.gc.ca/radar/index_e.html). diff --git a/source/_components/envirophat.markdown b/source/_components/envirophat.markdown index 72c0c11bcc1..72354900f5c 100644 --- a/source/_components/envirophat.markdown +++ b/source/_components/envirophat.markdown @@ -96,7 +96,7 @@ use_led: type: boolean {% endconfiguration %} -### {% linkable_title Notes %} +### Notes #### X, Y, Z axes @@ -108,7 +108,7 @@ use_led: - voltage readings are done in the 0-3.3V range, please do not connect higher voltages than that! See the [Enviro pHAT's getting started guide](https://learn.pimoroni.com/tutorial/sandyj/getting-started-with-enviro-phat) regarding how to make a voltage divider -### {% linkable_title Give the values friendly names & icons %} +### Give the values friendly names & icons Add something like the following to your [customize section](/docs/configuration/customizing-devices/): diff --git a/source/_components/eq3btsmart.markdown b/source/_components/eq3btsmart.markdown index 3f80f7cb217..d855781b4a2 100644 --- a/source/_components/eq3btsmart.markdown +++ b/source/_components/eq3btsmart.markdown @@ -22,7 +22,7 @@ The current functionality allows setting the temperature as well as controlling As the device doesn't contain a temperature sensor ([read more](https://forum.fhem.de/index.php/topic,39308.15.html)), we report target temperature also as current one. -### {% linkable_title Testing the connectivity %} +### Testing the connectivity Before configuring Home Assistant you should check that connectivity with the thermostat is working, which can be done with the eq3cli tool: @@ -39,7 +39,7 @@ Current mode: auto dst Valve: 0 ``` -### {% linkable_title Configuration %} +### Configuration ```yaml # Example configuration.yaml entry diff --git a/source/_components/esphome.markdown b/source/_components/esphome.markdown index 18f76a05528..14cc080732b 100644 --- a/source/_components/esphome.markdown +++ b/source/_components/esphome.markdown @@ -23,7 +23,7 @@ redirect_from: This integration allows you to connect your [ESPHome](https://esphome.io) devices directly into Home Assistant with the [native ESPHome API](https://esphome.io/components/api.html). -## {% linkable_title Setup the integration via the integrations screen %} +## Setup the integration via the integrations screen Menu: *Configuration* -> *Integrations* diff --git a/source/_components/everlights.markdown b/source/_components/everlights.markdown index 849a042a8a6..09d33ec971f 100644 --- a/source/_components/everlights.markdown +++ b/source/_components/everlights.markdown @@ -18,7 +18,7 @@ redirect_from: [EverLights](https://myeverlights.com/) are permanent Christmas lights installed on a home's gutters or flashing. This integration can change all LEDs in a zone to a single color or activate a pattern that was previously saved to the control box. -### {% linkable_title Configuration Details %} +### Configuration Details To enable EverLights, add the following lines to your `configuration.yaml` file: @@ -38,7 +38,7 @@ hosts: type: list {% endconfiguration %} -### {% linkable_title Effects %} +### Effects EverLights patterns saved to the control box can be activated using the effect parameter to the `light.turn_on` service. If an effect is specified, then the color and brightness are ignored. diff --git a/source/_components/evohome.markdown b/source/_components/evohome.markdown index 00cc88b3371..8596939630f 100644 --- a/source/_components/evohome.markdown +++ b/source/_components/evohome.markdown @@ -27,7 +27,7 @@ There is currently support for the following device types within Home Assistant: - [Climate](#climate) -## {% linkable_title Configuration %} +## Configuration To use this integration in your installation, add the following to your `configuration.yaml` file: @@ -61,7 +61,7 @@ scan_interval: This is an IoT cloud-polling device, and the recommended minimum `scan_interval` is 300 seconds. Testing has indicated that this is a safe interval that - by itself - shouldn't cause you to be rate-limited by Honeywell. -## {% linkable_title Climate %} +## Climate It is distinct from - but related to - the [`honeywell`](/components/climate.honeywell/) climate platform, which also allows (limited) integration with Honeywell Connected thermostats; these two integrations may well be usable side-by-side, but YMMV. diff --git a/source/_components/facebook.markdown b/source/_components/facebook.markdown index c051fbc3fc7..2ae65844614 100644 --- a/source/_components/facebook.markdown +++ b/source/_components/facebook.markdown @@ -39,7 +39,7 @@ name: type: string {% endconfiguration %} -### {% linkable_title Usage %} +### Usage With Facebook notify service, you can send your notifications to your Facebook messenger with help of your Facebook page. You have to create a [Facebook Page and App](https://developers.facebook.com/docs/messenger-platform/guides/quick-start) for this service. You can control it by calling the notify service [as described here](/components/notify/). It will send a message on messenger to user specified by **target** on behalf of your page. See the [quick start](https://developers.facebook.com/docs/messenger-platform/guides/quick-start) guide for more information. The phone number used in **target** should be registered with Facebook messenger. Phone number of the recipient should be in +1(212)555-2368 format. If your app is not approved by Facebook then the recipient should by either admin, developer or tester for your Facebook app. [More information](https://developers.facebook.com/docs/messenger-platform/send-api-reference#phone_number) about the phone number. @@ -105,7 +105,7 @@ if (preg_match('/get my id/', strtolower($message))) { ``` -### {% linkable_title Rich messages %} +### Rich messages You could also send rich messing (cards, buttons, images, videos, etc). [Info](https://developers.facebook.com/docs/messenger-platform/send-api-reference) to which types of messages and how to build them. ```yaml diff --git a/source/_components/facebox.markdown b/source/_components/facebox.markdown index b408196d467..e77f812d912 100644 --- a/source/_components/facebox.markdown +++ b/source/_components/facebox.markdown @@ -17,7 +17,7 @@ redirect_from: The `facebox` image processing platform allows you to detect and recognize faces in a camera image using [Facebox](https://machinebox.io/docs/facebox). The state of the entity is the number of faces detected, and recognized faces are listed in the `matched_faces` attribute. An `image_processing.detect_face` event is fired for each recognized face, and the event `data` provides the `confidence` of recognition, the `name` of the person, the `image_id` of the image associated with the match, the `bounding_box` that contains the face in the image, and the `entity_id` that processing was performed on. -## {% linkable_title Setup %} +## Setup Facebox runs in a Docker container and it is recommended that you run this container on a machine with a minimum of 2 GB RAM. On your machine with Docker, run the Facebox container with: @@ -30,7 +30,7 @@ You can run Facebox with a username and password by adding `-e "MB_BASICAUTH_USE If you only require face detection (number of faces) you can disable face recognition by adding `-e "MB_FACEBOX_DISABLE_RECOGNITION=true"` to the `docker run` command. -## {% linkable_title Configuration %} +## Configuration To enable this platform in your installation, add the following to your `configuration.yaml` file: @@ -77,7 +77,7 @@ source: type: string {% endconfiguration %} -## {% linkable_title Automations %} +## Automations Use the `image_processing.detect_face` events to trigger automations, and breakout the `trigger.event.data` using a [data_template](/docs/automation/templating/). The following example automation sends a notification when Ringo Star is recognized: @@ -98,7 +98,7 @@ Use the `image_processing.detect_face` events to trigger automations, and breako ``` {% endraw %} -## {% linkable_title Service `facebox_teach_face` %} +## Service `facebox_teach_face` The service `facebox_teach_face` can be used to teach Facebox faces. diff --git a/source/_components/fail2ban.markdown b/source/_components/fail2ban.markdown index 8488a5fe6ea..ceefb1c8769 100644 --- a/source/_components/fail2ban.markdown +++ b/source/_components/fail2ban.markdown @@ -23,7 +23,7 @@ The `fail2ban` sensor allows for IPs banned by [fail2ban](https://www.fail2ban.o Your system must have `fail2ban` installed and correctly configured for this sensor to work. In addition, Home Assistant must be able to read the `fail2ban` log file.

-## {% linkable_title Configuration %} +## Configuration To enable this sensor, add the following lines to your `configuration.yaml`: @@ -53,11 +53,11 @@ file_path: default: /var/log/fail2ban.log {% endconfiguration %} -### {% linkable_title Set up Fail2Ban %} +### Set up Fail2Ban For most setups, you can follow [this tutorial](/cookbook/fail2ban/) to set up `fail2ban` on your system. It will walk you through creating jails and filters, allowing you to monitor IP addresses that have been banned for too many failed SSH login attempts, as well as too many failed Home Assistant login attempts. -### {% linkable_title Fail2Ban with Docker %} +### Fail2Ban with Docker

These steps assume you already have the Home Assistant docker running behind NGINX and that it is externally accessible. It also assumes the docker is running with the `--net='host'` flag. @@ -65,7 +65,7 @@ These steps assume you already have the Home Assistant docker running behind NGI For those of us using Docker, the above tutorial may not be sufficient. The following steps specifically outline how to set up `fail2ban` and Home Assistant when running Home Assistant within a Docker behind NGINX. The setup this was tested on was an unRAID server using the [let's encrypt docker](https://github.com/linuxserver/docker-letsencrypt) from linuxserver.io. -#### {% linkable_title Set http logger %} +#### Set http logger In your `configuration.yaml` file, add the following to the `logger` integration to ensure that Home Assistant prints failed login attempts to the log. @@ -75,7 +75,7 @@ logger: homeassistant.components.http.ban: warning ``` -#### {% linkable_title Edit the `jail.local` file %} +#### Edit the `jail.local` file Next, we need to edit the `jail.local` file that is included with the Let's Encrypt docker linked above. Note, for this tutorial, we'll only be implementing the `[hass-iptables]` jail from the [previously linked tutorial](/cookbook/fail2ban/). @@ -90,7 +90,7 @@ logpath = /hass/home-assistant.log maxretry = 5 ``` -#### {% linkable_title Create a filter for the Home Assistant jail %} +#### Create a filter for the Home Assistant jail Now we need to create a filter for `fail2ban` so that it can properly parse the log. This is done with a `failregex`. Create a file called `hass.local` within the `filter.d` directory in `/mnt/user/appdata/letsencrypt/fail2ban` and add the following: @@ -107,7 +107,7 @@ ignoreregex = datepattern = ^%%Y-%%m-%%d %%H:%%M:%%S ``` -#### {% linkable_title Map log file directories %} +#### Map log file directories First, we need to make sure that fail2ban log can be passed to Home Assistant and that the Home Assistant log can be passed to fail2ban. When starting the Let's Encrypt docker, you need to add the following argument (adjust paths based on your setup): @@ -124,7 +124,7 @@ Now do the same for the Home Assistant docker, but this time we'll be mapping th ``` -#### {% linkable_title Send client IP to Home Assistant %} +#### Send client IP to Home Assistant By default, the IP address that Home Assistant sees will be that of the container (something like `172.17.0.16`). What this means is that for any failed login attempt, assuming you have correctly configured `fail2ban`, the Docker IP will be logged as banned, but the originating IP is still allowed to make attempts. We need `fail2ban` to recognize the originating IP to properly ban it. @@ -172,7 +172,7 @@ http: At this point, once the Let's Encrypt and Home Assistant dockers are restarted, Home Assistant should be correctly logging the originating IP of any failed login attempt. Once that's done and verified, we can move onto the final step. -#### {% linkable_title Add the fail2ban sensor %} +#### Add the fail2ban sensor Now that we've correctly set everything up for Docker, we can add our sensors to `configuration.yaml` with the following: @@ -186,7 +186,7 @@ sensor: Assuming you've followed all of the steps, you should have one fail2ban sensor, `sensor.fail2ban_hassiptables`, within your front-end. -### {% linkable_title Other debug tips %} +### Other debug tips If, after following these steps, you're unable to get the `fail2ban` sensor working, here are some other steps you can take that may help: diff --git a/source/_components/familyhub.markdown b/source/_components/familyhub.markdown index fb5ba25d73a..8976e766cd8 100644 --- a/source/_components/familyhub.markdown +++ b/source/_components/familyhub.markdown @@ -18,7 +18,7 @@ redirect_from: The `familyhub` platform allows you to get images of the inside of your [Samsung Family Hub refrigerator](https://www.samsung.com/us/explore/family-hub-refrigerator/connected-hub/) in Home Assistant. -## {% linkable_title Configuration %} +## Configuration To enable your Family Hub camera in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/fan.mqtt.markdown b/source/_components/fan.mqtt.markdown index 189b3139758..bdb177d3663 100644 --- a/source/_components/fan.mqtt.markdown +++ b/source/_components/fan.mqtt.markdown @@ -16,7 +16,7 @@ ha_iot_class: Configurable The `mqtt` fan platform lets you control your MQTT enabled fans. -## {% linkable_title Configuration %} +## Configuration In an ideal scenario, the MQTT device will have a `state_topic` to publish state changes. If these messages are published with a `RETAIN` flag, the MQTT fan will receive an instant state update after subscription and will start with the correct state. Otherwise, the initial state of the fan will be `false` / `off`. @@ -190,11 +190,11 @@ device: Make sure that your topics match exactly. `some-topic/` and `some-topic` are different topics.

-## {% linkable_title Examples %} +## Examples In this section you find some real-life examples of how to use this fan. -### {% linkable_title Full configuration %} +### Full configuration The example below shows a full configuration for a MQTT fan. diff --git a/source/_components/fan.xiaomi_miio.markdown b/source/_components/fan.xiaomi_miio.markdown index 7e1bcf92b68..910a88b0d70 100644 --- a/source/_components/fan.xiaomi_miio.markdown +++ b/source/_components/fan.xiaomi_miio.markdown @@ -309,9 +309,9 @@ model: type: string {% endconfiguration %} -## {% linkable_title Platform Services %} +## Platform Services -### {% linkable_title Service `fan.set_speed` %} +### Service `fan.set_speed` Set the fan speed/operation mode. @@ -320,7 +320,7 @@ Set the fan speed/operation mode. | `entity_id` | yes | Only act on a specific air purifier. Else targets all. | | `speed` | no | Fan speed. Valid values are 'Auto', 'Silent', 'Favorite' and 'Idle' | -### {% linkable_title Service `fan.xiaomi_miio_set_buzzer_on` %} (Air Purifier Pro excluded) +### Service `fan.xiaomi_miio_set_buzzer_on` (Air Purifier Pro excluded) Turn the buzzer on. @@ -328,7 +328,7 @@ Turn the buzzer on. |---------------------------|----------|---------------------------------------------------------| | `entity_id` | yes | Only act on a specific Xiaomi miIO fan entity. Else targets all. | -### {% linkable_title Service `fan.xiaomi_miio_set_buzzer_off` %} (Air Purifier Pro excluded) +### Service `fan.xiaomi_miio_set_buzzer_off` (Air Purifier Pro excluded) Turn the buzzer off. @@ -336,7 +336,7 @@ Turn the buzzer off. |---------------------------|----------|---------------------------------------------------------| | `entity_id` | yes | Only act on a specific Xiaomi miIO fan entity. Else targets all. | -### {% linkable_title Service `fan.xiaomi_miio_set_led_on` %} (Air Purifiers only) +### Service `fan.xiaomi_miio_set_led_on` (Air Purifiers only) Turn the led on. @@ -344,7 +344,7 @@ Turn the led on. |---------------------------|----------|---------------------------------------------------------| | `entity_id` | yes | Only act on a specific Xiaomi miIO fan entity. Else targets all. | -### {% linkable_title Service `fan.xiaomi_miio_set_led_off` %} (Air Purifiers only) +### Service `fan.xiaomi_miio_set_led_off` (Air Purifiers only) Turn the led off. @@ -352,7 +352,7 @@ Turn the led off. |---------------------------|----------|---------------------------------------------------------| | `entity_id` | yes | Only act on a specific Xiaomi miIO fan entity. Else targets all. | -### {% linkable_title Service `fan.xiaomi_miio_set_child_lock_on` %} +### Service `fan.xiaomi_miio_set_child_lock_on` Turn the child lock on. @@ -360,7 +360,7 @@ Turn the child lock on. |---------------------------|----------|---------------------------------------------------------| | `entity_id` | yes | Only act on a specific Xiaomi miIO fan entity. Else targets all. | -### {% linkable_title Service `fan.xiaomi_miio_set_child_lock_off` %} +### Service `fan.xiaomi_miio_set_child_lock_off` Turn the child lock off. @@ -368,7 +368,7 @@ Turn the child lock off. |---------------------------|----------|---------------------------------------------------------| | `entity_id` | yes | Only act on a specific Xiaomi miIO fan entity. Else targets all. | -### {% linkable_title Service `fan.xiaomi_miio_set_led_brightness` %} (Air Purifier 2S and Air Purifier Pro excluded) +### Service `fan.xiaomi_miio_set_led_brightness` (Air Purifier 2S and Air Purifier Pro excluded) Set the led brightness. Supported values are 0 (Bright), 1 (Dim), 2 (Off). @@ -377,7 +377,7 @@ Set the led brightness. Supported values are 0 (Bright), 1 (Dim), 2 (Off). | `entity_id` | yes | Only act on a specific Xiaomi miIO fan entity. Else targets all. | | `brightness` | no | Brightness, between 0 and 2. | -### {% linkable_title Service `fan.xiaomi_miio_set_favorite_level` %} (Air Purifiers only) +### Service `fan.xiaomi_miio_set_favorite_level` (Air Purifiers only) Set the favorite level of the operation mode "favorite". @@ -386,7 +386,7 @@ Set the favorite level of the operation mode "favorite". | `entity_id` | yes | Only act on a specific Xiaomi miIO fan entity. Else targets all. | | `level` | no | Level, between 0 and 16. | -### {% linkable_title Service `fan.xiaomi_miio_set_auto_detect_on` %} (Air Purifier 2S and Air Purifier Pro only) +### Service `fan.xiaomi_miio_set_auto_detect_on` (Air Purifier 2S and Air Purifier Pro only) Turn the auto detect on. @@ -394,7 +394,7 @@ Turn the auto detect on. |---------------------------|----------|---------------------------------------------------------| | `entity_id` | yes | Only act on a specific Xiaomi miIO fan entity. Else targets all. | -### {% linkable_title Service `fan.xiaomi_miio_set_auto_detect_off` %} (Air Purifier 2S and Air Purifier Pro only) +### Service `fan.xiaomi_miio_set_auto_detect_off` (Air Purifier 2S and Air Purifier Pro only) Turn the auto detect off. @@ -402,7 +402,7 @@ Turn the auto detect off. |---------------------------|----------|---------------------------------------------------------| | `entity_id` | yes | Only act on a specific Xiaomi miIO fan entity. Else targets all. | -### {% linkable_title Service `fan.xiaomi_miio_set_learn_mode_on` %} (Air Purifier 2 only) +### Service `fan.xiaomi_miio_set_learn_mode_on` (Air Purifier 2 only) Turn the learn mode on. @@ -410,7 +410,7 @@ Turn the learn mode on. |---------------------------|----------|---------------------------------------------------------| | `entity_id` | yes | Only act on a specific Xiaomi miIO fan entity. Else targets all. | -### {% linkable_title Service `fan.xiaomi_miio_set_learn_mode_off` %} (Air Purifier 2 only) +### Service `fan.xiaomi_miio_set_learn_mode_off` (Air Purifier 2 only) Turn the learn mode off. @@ -418,7 +418,7 @@ Turn the learn mode off. |---------------------------|----------|---------------------------------------------------------| | `entity_id` | yes | Only act on a specific Xiaomi miIO fan entity. Else targets all. | -### {% linkable_title Service `fan.xiaomi_miio_set_volume` %} (Air Purifier Pro only) +### Service `fan.xiaomi_miio_set_volume` (Air Purifier Pro only) Set the sound volume. @@ -427,7 +427,7 @@ Set the sound volume. | `entity_id` | yes | Only act on a specific Xiaomi miIO fan entity. Else targets all. | | `volume` | no | Volume, between 0 and 100. | -### {% linkable_title Service `fan.xiaomi_miio_reset_filter` %} (Air Purifier 2 only) +### Service `fan.xiaomi_miio_reset_filter` (Air Purifier 2 only) Reset the filter lifetime and usage. @@ -435,7 +435,7 @@ Reset the filter lifetime and usage. |---------------------------|----------|---------------------------------------------------------| | `entity_id` | yes | Only act on a specific Xiaomi miIO fan entity. Else targets all. | -### {% linkable_title Service `fan.xiaomi_miio_set_extra_features` %} (Air Purifier only) +### Service `fan.xiaomi_miio_set_extra_features` (Air Purifier only) Set the extra features. @@ -444,7 +444,7 @@ Set the extra features. | `entity_id` | yes | Only act on a specific Xiaomi miIO fan entity. Else targets all. | | `features` | no | Integer, known values are 0 and 1. | -### {% linkable_title Service `fan.xiaomi_miio_set_target_humidity` %} (Air Humidifier only) +### Service `fan.xiaomi_miio_set_target_humidity` (Air Humidifier only) Set the target humidity. @@ -453,7 +453,7 @@ Set the target humidity. | `entity_id` | yes | Only act on a specific Xiaomi miIO fan entity. Else targets all. | | `humidity` | no | Target humidity. Allowed values are 30, 40, 50, 60, 70 and 80 | -### {% linkable_title Service `fan.xiaomi_miio_set_dry_on` %} (Air Humidifier CA only) +### Service `fan.xiaomi_miio_set_dry_on` (Air Humidifier CA only) Turn the dry mode on. @@ -461,7 +461,7 @@ Turn the dry mode on. |---------------------------|----------|---------------------------------------------------------| | `entity_id` | yes | Only act on a specific Xiaomi miIO fan entity. Else targets all. | -### {% linkable_title Service `fan.xiaomi_miio_set_dry_off` %} (Air Humidifier CA only) +### Service `fan.xiaomi_miio_set_dry_off` (Air Humidifier CA only) Turn the dry mode off. diff --git a/source/_components/fastdotcom.markdown b/source/_components/fastdotcom.markdown index d095e5681e8..562fd9400bf 100644 --- a/source/_components/fastdotcom.markdown +++ b/source/_components/fastdotcom.markdown @@ -27,7 +27,7 @@ Enabling this integration will automatically create the Fast.com Sensor. By default, a speed test will be run every hour. The user can change the update frequency in the configuration by defining the `scan_interval` for a speed test to run. -## {% linkable_title Configuration %} +## Configuration To add Fast.com to your installation, add the following to your `configuration.yaml` file: @@ -58,7 +58,7 @@ manual: type: boolean {% endconfiguration %} -#### {% linkable_title Time period dictionary example %} +#### Time period dictionary example ```yaml scan_interval: @@ -70,7 +70,7 @@ scan_interval: milliseconds: 0 ``` -### {% linkable_title Service %} +### Service Once loaded, the `fastdotcom` integration will expose a service (`fastdotcom.speedtest`) that can be called to run a Fast.com speed test on demand. This service takes no parameters. This can be useful if you have enabled manual mode. @@ -79,7 +79,7 @@ action: service: fastdotcom.speedtest ``` -## {% linkable_title Notes %} +## Notes - When running on Raspberry Pi, the maximum speed is limited by its 100 Mbit/s LAN adapter. - The sensor will return the maximum measured speed during a 15-second test. diff --git a/source/_components/fedex.markdown b/source/_components/fedex.markdown index 182a0df191b..9673ee4eed4 100644 --- a/source/_components/fedex.markdown +++ b/source/_components/fedex.markdown @@ -18,7 +18,7 @@ redirect_from: The `fedex` platform allows one to track deliveries by [FedEx](http://www.fedex.com/). To use this sensor, you need a [FedEx Delivery Manager](https://www.fedex.com/us/delivery/) account. -## {% linkable_title Configuration %} +## Configuration To enable this sensor, add the following lines to your `configuration.yaml`: diff --git a/source/_components/ffmpeg.markdown b/source/_components/ffmpeg.markdown index 44630cc5aee..be586c9c01d 100644 --- a/source/_components/ffmpeg.markdown +++ b/source/_components/ffmpeg.markdown @@ -23,7 +23,7 @@ You need the `ffmpeg` binary in your system path. On Hassbian you will need to l If you are using [Hass.io](/hassio/) then just move forward to the configuration as all requirements are already fulfilled.

-## {% linkable_title Configuration %} +## Configuration To set it up, add the following information to your `configuration.yaml` file: @@ -39,7 +39,7 @@ ffmpeg_bin: type: string {% endconfiguration %} -### {% linkable_title Raspbian Debian Jessie Lite Installations %} +### Raspbian Debian Jessie Lite Installations To get the binary on Raspbian Debian Jessie Lite on a RPi you need to perform the following: ```bash @@ -55,7 +55,7 @@ ffmpeg: ffmpeg_bin: /usr/bin/ffmpeg ``` -### {% linkable_title Troubleshooting %} +### Troubleshooting In most cases, `ffmpeg` automatically detects all needed options to read a video or audio stream or file. But it is possible in rare cases that you will need to set options to help `ffmpeg` out. @@ -70,7 +70,7 @@ Now you should be able to see what is going wrong. The following list contains s - `[rtsp @ ...] UDP timeout, retrying with TCP`: You need to set an RTSP transport in the configuration with: `input: -rtsp_transport tcp -i INPUT` - `[rtsp @ ...] Could not find codec parameters for stream 0 (Video: ..., none): unspecified size`: FFmpeg needs more data or time for autodetection (the default is 5 seconds). You can set the `analyzeduration` and/or `probesize` options to experiment with giving FFmpeg more leeway. If you find the needed value, you can set it with: `input: -analyzeduration xy -probesize xy -i INPUT`. More information about this can be found [here](https://www.ffmpeg.org/ffmpeg-formats.html#Description). -#### {% linkable_title USB cameras %} +#### USB cameras For `INPUT` a valid source is needed. A USB camera is an easy way to test your video setup. To get all available USB cameras connected to the system, e.g., use the v4l2 tools on a Linux machine. diff --git a/source/_components/ffmpeg_motion.markdown b/source/_components/ffmpeg_motion.markdown index 2e35be038ba..104a1c3610d 100644 --- a/source/_components/ffmpeg_motion.markdown +++ b/source/_components/ffmpeg_motion.markdown @@ -22,11 +22,11 @@ The `ffmpeg` platform allows you to use any video feed with [FFmpeg](http://www. If the `ffmpeg` process is broken, the sensor will be unavailable. To control the ffmpeg process of sensor, use the service *ffmpeg.start*, *ffmpeg.stop*, *ffmpeg.restart*.

-## {% linkable_title Motion %} +## Motion FFmpeg doesn't have a motion detection filter, but can use a scene filter to detect a new scene/motion. You can set how much needs to change in order to detect motion with the option 'changes', the percent value of change between frames. If you want a really small value for 'changes', you can also add a denoise filter. -## {% linkable_title Configuration %} +## Configuration To add FFmpeg with motion detection to your installation, add the following to your `configuration.yaml` file: @@ -85,7 +85,7 @@ $ ffmpeg -i YOUR_INPUT -an -filter:v select=gt(scene\,0.1) -f framemd5 - If you are running into trouble with this sensor, please refer to the [troubleshooting section](/components/ffmpeg/#troubleshooting). -#### {% linkable_title Tips %} +#### Tips - Use motion only in a custom area with [crop filter](https://ffmpeg.org/ffmpeg-filters.html#crop): diff --git a/source/_components/ffmpeg_noise.markdown b/source/_components/ffmpeg_noise.markdown index 3dd7870c378..24792aad04f 100644 --- a/source/_components/ffmpeg_noise.markdown +++ b/source/_components/ffmpeg_noise.markdown @@ -21,7 +21,7 @@ The `ffmpeg` platform allows you to use any video or audio feed with [FFmpeg](ht If the `ffmpeg` process is broken, the sensor will be unavailable. To control the ffmpeg process of sensor, use the service *ffmpeg.start*, *ffmpeg.stop*, *ffmpeg.restart*.

-## {% linkable_title Configuration %} +## Configuration To add FFmpeg with noise detection to your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/fibaro.markdown b/source/_components/fibaro.markdown index ea1384335d5..efafc31d291 100644 --- a/source/_components/fibaro.markdown +++ b/source/_components/fibaro.markdown @@ -42,7 +42,7 @@ There is currently support for the following device types within Home Assistant: They will be automatically added when the `fibaro` hub is connected to Home Assistant. -## {% linkable_title Configuration %} +## Configuration To use Fibaro devices in your installation, add the following to your `configuration.yaml` file using the IP and port number of your Fibaro controller: @@ -95,6 +95,6 @@ device_config: It is recommended to assign a static IP address to your Fibaro controller. This ensures that it won't change its IP address, so you won't have to change the `url` if the controller reboots and comes up with a different IP address. See your router's manual for details on how to set this up. If you need the MAC address of your Fibaro, check the label on the bottom.

-### {% linkable_title Using Z-Wave devices in automation %} +### Using Z-Wave devices in automation If you want to use a Z-Wave device from the Fibaro controller in Home Assistant automation, you'll need the entity id. In the Home Assistant UI you'll find all entities listed under the service developer tool icon icon of the Developer Tools section. Look for entities that contain 'fibaro_id' in their attributes, and you'll find the entity id on the left. diff --git a/source/_components/fido.markdown b/source/_components/fido.markdown index b4de25d306d..96d7bfca41b 100644 --- a/source/_components/fido.markdown +++ b/source/_components/fido.markdown @@ -18,7 +18,7 @@ redirect_from: Integrate your [Fido](https://www.fido.ca/) account information into Home Assistant. -## {% linkable_title Configuration %} +## Configuration To enable this sensor, add the following lines to your `configuration.yaml` file: diff --git a/source/_components/file.markdown b/source/_components/file.markdown index 56a35c24e9e..35f0a3a0ad9 100644 --- a/source/_components/file.markdown +++ b/source/_components/file.markdown @@ -24,7 +24,7 @@ There is currently support for the following device types within Home Assistant: - [Notifications](#notifications) - [Sensor](#sensor) -## {% linkable_title Notifications %} +## Notifications The `file` platform allows you to store notifications from Home Assistant as a file. @@ -57,7 +57,7 @@ timestamp: To use notifications, please see the [getting started with automation page](/getting-started/automation/). -## {% linkable_title Sensor %} +## Sensor The `file` sensor platform reads the entries from a plain-text file and shows the found value. Only the last line of the file is used. This is similar to do `$ tail -n 1 sensor.txt` on the command-line. Note that file paths must be added to [whitelist_external_dirs](/docs/configuration/basic/). @@ -90,11 +90,11 @@ value_template: type: template {% endconfiguration %} -### {% linkable_title Examples %} +### Examples In this section you find some real-life examples of how to use this sensor. -#### {% linkable_title Entries as JSON %} +#### Entries as JSON Assuming that the log file contains multiple values formatted as JSON like shown below: diff --git a/source/_components/filesize.markdown b/source/_components/filesize.markdown index a50862e11f2..3f6d8fde2db 100644 --- a/source/_components/filesize.markdown +++ b/source/_components/filesize.markdown @@ -18,7 +18,7 @@ redirect_from: The `filesize` sensor for displaying the size in MB of a file. Note that paths must be added to [whitelist_external_dirs](/docs/configuration/basic/). -## {% linkable_title Configuration %} +## Configuration To enable the `filesize` sensor, add the following lines to your `configuration.yaml`: diff --git a/source/_components/filter.markdown b/source/_components/filter.markdown index 6f75c5cc6e5..65678b31807 100644 --- a/source/_components/filter.markdown +++ b/source/_components/filter.markdown @@ -25,7 +25,7 @@ The `filter` platform enables sensors that process the states of other entities.

-## {% linkable_title Configuration %} +## Configuration To enable Filter Sensors in your installation, add the following to your `configuration.yaml` file: @@ -113,9 +113,9 @@ filters: default: positive infinity {% endconfiguration %} -## {% linkable_title Filters %} +## Filters -### {% linkable_title Low-pass %} +### Low-pass The Low-pass filter (`lowpass`) is one of signal processing most common filters, as it smooths data by shortcutting peaks and valleys. @@ -129,7 +129,7 @@ LowPass(state) = A * previous_state + B * state The returned value is rounded to the number of decimals defined in (`precision`). -### {% linkable_title Outlier %} +### Outlier The Outlier filter (`outlier`) is a basic Band-pass filter, as it cuts out any value outside a specific range. @@ -144,7 +144,7 @@ else: state ``` -### {% linkable_title Throttle %} +### Throttle The Throttle filter (`throttle`) will only update the state of the sensor for the first state in the window. This means the filter will skip all other values. @@ -152,7 +152,7 @@ To adjust the rate you need to set the window_size. To throttle a sensor down to This filter is relevant when you have a sensor which produces states at a very high-rate, which you might want to throttle down for storing or visualization purposes. -### {% linkable_title Time Throttle %} +### Time Throttle The Time Throttle filter (`time_throttle`) will only update the state of the sensor for the first state in the window. This means the filter will skip all other values. @@ -160,7 +160,7 @@ To adjust the rate you need to set the window_size. To throttle a sensor down to This filter is relevant when you have a sensor which produces states at a very high inconstant rate, which you might want to throttle down to some constant rate for storing or visualization purposes. -### {% linkable_title Time Simple Moving Average %} +### Time Simple Moving Average The Time SMA filter (`time_simple_moving_average`) is based on the paper [Algorithms for Unevenly Spaced Time Series: Moving Averages and Other Rolling Operators](http://www.eckner.com/papers/Algorithms%20for%20Unevenly%20Spaced%20Time%20Series.pdf) by Andreas Eckner. @@ -168,7 +168,7 @@ The paper defines three types/versions of the Simple Moving Average (SMA): *last Theta, as described in the paper, is the `window_size` parameter, and can be expressed using time notation (e.g., 00:05 for a five minutes time window). -### {% linkable_title Range %} +### Range The Range filter (`range`) restricts incoming data to a range specified by a lower and upper bound. diff --git a/source/_components/fints.markdown b/source/_components/fints.markdown index 84aeff38ab6..6a5247ab1e4 100644 --- a/source/_components/fints.markdown +++ b/source/_components/fints.markdown @@ -17,7 +17,7 @@ redirect_from: With the FinTS sensor, you can fetch your account information from your bank. This only works with banks that support the FinTS (aka. HBCI) standard. The FinTS standard used by many German banks. So if you do not have a German bank account, this will most likely not work for you. To find out if your bank supports FinTS, check the bank's website or call their hotline. -## {% linkable_title Configuration %} +## Configuration To find out the configuration for your bank, check their website or call their hotline. Do not use random information you find on the Internet! As you're storing your bank account information in the Home Assistant configuration: Make sure that this configuration is not accessible to anyone. diff --git a/source/_components/fixer.markdown b/source/_components/fixer.markdown index 08779752fdf..1d11848b626 100644 --- a/source/_components/fixer.markdown +++ b/source/_components/fixer.markdown @@ -21,11 +21,11 @@ The `fixer` sensor will show you the current exchange rate from [Fixer.io](http: To get an overview about the available [currencies](https://fixer.io/symbols). -## {% linkable_title Setup %} +## Setup You need to create an [API key](https://fixer.io/product). There is a rate limit of 1000 calls per month. -## {% linkable_title Configuration %} +## Configuration To enable this sensor, add the following lines to your `configuration.yaml` file: diff --git a/source/_components/flic.markdown b/source/_components/flic.markdown index 35082555af2..6379ec0408f 100644 --- a/source/_components/flic.markdown +++ b/source/_components/flic.markdown @@ -20,13 +20,13 @@ The `flic` platform allows you to receive click events from [flic](https://flic. The platform does not directly interact with the buttons, *but communicates with a flic service* that manages the buttons. The service can run on the same instance as Home Assistant or any other reachable machine. -#### {% linkable_title Service setup %} +#### Service setup If you are using Hass.io, you can run the service locally by [installing](/hassio/installing_third_party_addons/) the flicd add-on from [pschmitt's repository](https://github.com/pschmitt/hassio-addons). On a Hass.io installation that's not yet based on HassOS, you also need to install the [bluetooth add-on](/addons/bluetooth_bcm43xx/). For instructions on how to install the service manually, visit the GitHub repository of the service for [Linux](https://github.com/50ButtonsEach/fliclib-linux-hci), [OS X](https://github.com/50ButtonsEach/flic-service-osx) or [Windows](https://github.com/50ButtonsEach/fliclib-windows). -#### {% linkable_title Configuration %} +#### Configuration To use your flic buttons in your installation, add the following to your `configuration.yaml` file: @@ -63,15 +63,15 @@ timeout: default: 3 {% endconfiguration %} -#### {% linkable_title Discovery %} +#### Discovery If discovery is enabled, you can add a new button by pressing it for at least 7 seconds. The button will be paired with the flic service and added to Home Assistant. Otherwise, you have to manually pair it with the flic service. The Home Assistant platform will not scan for new buttons and will only connect to buttons already paired. -#### {% linkable_title Timeout %} +#### Timeout When the flic button is triggered while disconnected from flic service, it will queue all events and try to connect and transmit them as soon as possible. The timeout variable can be used to stop events from triggering if too much time passed between the action and the notification in Home Assistant. -#### {% linkable_title Events %} +#### Events The flic integration fires `flic_click` events on the bus. You can capture the events and respond to them in automation scripts like this: @@ -113,6 +113,6 @@ automation: message: {% raw %}"flic {{ trigger.event.data.button_name }} was {{ trigger.event.data.click_type }} clicked"{% endraw %} ``` -##### {% linkable_title Ignoring Click Types %} +##### Ignoring Click Types For some purposes it might make sense to exclude a specific click type from triggering click events. For example when ignoring double clicks, pressing the button twice fast results in two `single` instead of a `double` click event. This is very useful for applications where you want to click fast. diff --git a/source/_components/flock.markdown b/source/_components/flock.markdown index f136a27578b..e82290757c7 100644 --- a/source/_components/flock.markdown +++ b/source/_components/flock.markdown @@ -18,7 +18,7 @@ redirect_from: The `flock` platform uses [Flock.com](https://flock.com) to deliver notifications from Home Assistant. -## {% linkable_title Setup %} +## Setup Go to the [Flock.com Admin website](https://admin.flock.com/#!/webhooks) and create a new "Incoming Webhooks". Choose a channel to send the notifications from Home Assistant to, specify a name and press *Save and Generate URL*. @@ -32,7 +32,7 @@ You will need the last part of the URL which is the `access_token` for your room

-## {% linkable_title Configuration %} +## Configuration To add Flock notifications to your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/flunearyou.markdown b/source/_components/flunearyou.markdown index f51b98556be..cb16b130615 100644 --- a/source/_components/flunearyou.markdown +++ b/source/_components/flunearyou.markdown @@ -21,7 +21,7 @@ territories to get information regarding reported flu symptoms from Flu Near You. The platform can return user-reported information as well reports from the Center for Disease Control (CDC). -## {% linkable_title Configuration %} +## Configuration To enable the platform, add the following lines to your `configuration.yaml` file: @@ -49,7 +49,7 @@ longitude: default: The longitude defined under the `homeassistant` key in `configuration.yaml`. {% endconfiguration %} -## {% linkable_title Sensor Types %} +## Sensor Types ### User Report diff --git a/source/_components/flux_led.markdown b/source/_components/flux_led.markdown index 16b015ea174..d2aed2bdfbd 100644 --- a/source/_components/flux_led.markdown +++ b/source/_components/flux_led.markdown @@ -31,7 +31,7 @@ Examples of controllers: - [SUPERNIGHT WiFi Wireless LED Smart Controller](https://amzn.to/2WURx7w) -### {% linkable_title Configuration Details %} +### Configuration Details To enable those lights, add the following lines to your `configuration.yaml` file: @@ -93,7 +93,7 @@ The integration defaults to rgbw. If your device has a separate white channel, y

-### {% linkable_title Example configuration %} +### Example configuration Will automatically search and add all lights on start up: @@ -163,7 +163,7 @@ light: protocol: 'ledenet' ``` -### {% linkable_title Effects %} +### Effects The Flux Led light offers a number of effects which are not included in other lighting packages. These can be selected from the front-end, or sent in the effect field of the `light.turn_on` command. diff --git a/source/_components/folder.markdown b/source/_components/folder.markdown index bdd09519a1c..1041e990e72 100644 --- a/source/_components/folder.markdown +++ b/source/_components/folder.markdown @@ -18,7 +18,7 @@ redirect_from: Sensor for monitoring the contents of a folder. Note that folder paths must be added to [whitelist_external_dirs](/docs/configuration/basic/). Optionally a [wildcard filter](https://docs.python.org/3.6/library/fnmatch.html) can be applied to the files considered within the folder. The state of the sensor is the size in MB of files within the folder that meet the filter criteria. The number of filtered files in the folder and total size in bytes of those files are exposed as attributes. -## {% linkable_title Configuration %} +## Configuration To enable the `folder` sensor in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/folder_watcher.markdown b/source/_components/folder_watcher.markdown index 245a4ba1cc7..551a934246a 100644 --- a/source/_components/folder_watcher.markdown +++ b/source/_components/folder_watcher.markdown @@ -24,7 +24,7 @@ This integration adds [Watchdog](https://pythonhosted.org/watchdog/) file system Configured folders must be added to [whitelist_external_dirs](/docs/configuration/basic/). Note that by default folder monitoring is recursive, meaning that the contents of sub-folders are also monitored. -## {% linkable_title Configuration %} +## Configuration To enable the Folder Watcher integration in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/foobot.markdown b/source/_components/foobot.markdown index b4a06b50c31..5a10d9ca0ce 100644 --- a/source/_components/foobot.markdown +++ b/source/_components/foobot.markdown @@ -20,7 +20,7 @@ The `foobot` sensor platform will fetch air quality data from your or yours [Foo This sensor requires an API token. Please obtain one at [Foobot API site](https://api.foobot.io/apidoc/index.html). -## {% linkable_title Configuring the Platform %} +## Configuring the Platform To enable this sensor, add the following lines to your `configuration.yaml` file: @@ -42,7 +42,7 @@ sensor: type: string {% endconfiguration %} -## {% linkable_title Available Metrics %} +## Available Metrics Every ten minutes, it'll fetch the last ten minutes average of the following measurements: diff --git a/source/_components/foscam.markdown b/source/_components/foscam.markdown index 2c1ee27945d..7cf9451dcc4 100644 --- a/source/_components/foscam.markdown +++ b/source/_components/foscam.markdown @@ -18,7 +18,7 @@ redirect_from: The `foscam` platform allows you to watch the live stream of your [Foscam](http://www.foscam.com/) IP camera in Home Assistant. -## {% linkable_title Configuration %} +## Configuration To enable your Foscam IP camera in your installation, add the following to your `configuration.yaml` file: @@ -64,6 +64,6 @@ name: There seems to be some issues within Foscam with lengthy passwords and passwords containing certain symbols. Be sure to check your camera's documentation.

-### {% linkable_title Control Foscam PTZ (Pan/Tilt/Zoom) - Home/Away %} +### Control Foscam PTZ (Pan/Tilt/Zoom) - Home/Away Foscam Webcams which support CGI Commands can be controlled by Home Assistant ([Source](http://www.ipcamcontrol.net/files/Foscam%20IPCamera%20CGI%20User%20Guide-V1.0.4.pdf)). For an example of how this can be done, see the [Foscam IP Camera Pan, Tilt, Zoom Control](/cookbook/foscam_away_mode_PTZ/) Cookbook entry. diff --git a/source/_components/foursquare.markdown b/source/_components/foursquare.markdown index 02cf7f75117..d5dc45dce43 100644 --- a/source/_components/foursquare.markdown +++ b/source/_components/foursquare.markdown @@ -48,7 +48,7 @@ and change the `CLIENT_ID` and `YOUR_REGISTERED_REDIRECT_URL` to your actual val You will receive an OAuth request landing page, asking you if you want to connect your Foursquare account to your newly created app. Say "Yes". After that, you will get redirected to your `REDIRECT_URL` with the `access_token` as an HTTP GET variable. Copy everything after the = and paste it in your configuration.yaml as the `access_token`. -### {% linkable_title Real-Time API %} +### Real-Time API The integration accepts pushes from Foursquare at `/api/foursquare`. The route does not require authentication. @@ -65,7 +65,7 @@ automation: entity_id: script.my_action ``` -### {% linkable_title Check ins %} +### Check ins To check a user in, use the `foursquare/checkin` service. diff --git a/source/_components/freebox.markdown b/source/_components/freebox.markdown index 4c95a8d3551..d50c2e34c1c 100644 --- a/source/_components/freebox.markdown +++ b/source/_components/freebox.markdown @@ -28,7 +28,7 @@ There is currently support for the following device types within Home Assistant: * [Device tracker](#presence-detection) for connected devices * [Switch](#switch) to control WiFi -## {% linkable_title Configuration %} +## Configuration If you have enabled the [discovery component](/components/discovery/), your Freebox should be detected automatically. Otherwise, you can set it @@ -55,7 +55,7 @@ You can find out your Freebox host and port by opening [this address](http://mafreebox.freebox.fr/api_version) in your browser. The returned json should contain an api_domain (`host`) and a https_port (`port`). -### {% linkable_title Initial setup %} +### Initial setup

You must have set a password for your Freebox router web administration page. Enable the option "Permettre les nouvelles demandes d'associations" and check that the option "Accès à distance sécurisé à Freebox OS" is active in "Gestion des ports" > "Connexions entrantes". @@ -68,7 +68,7 @@ prompted to do so. To make the WiFi switch working you will have to add "Modification des réglages de la Freebox " permission to Home Assitant application in "Paramètres de la Freebox" > "Gestion des accès" > "Applications". -### {% linkable_title Supported routers %} +### Supported routers Only the routers with Freebox OS are supported: @@ -76,12 +76,12 @@ Only the routers with Freebox OS are supported: * Freebox V6 also known as Freebox Revolution * Freebox mini 4k -## {% linkable_title Presence Detection %} +## Presence Detection This platform offers presence detection by keeping track of the devices connected to a [Freebox](http://www.free.fr/) router. -### {% linkable_title Notes %} +### Notes Note that the Freebox waits for some time before marking a device as inactive, meaning that there will be a small delay (1 or 2 minutes) @@ -92,11 +92,11 @@ On the contrary, the Freebox immediately reports devices newly connected, so they should appear as "home" almost instantly, as soon as Home Assistant refreshes the devices states. -## {% linkable_title Sensor %} +## Sensor This platform offers you sensors to monitor a Freebox router. The monitored conditions are instant upload and download rates in KB/s. -## {% linkable_title Switch %} +## Switch This platform offers you a switch to toggle the Wifi on or off. This will toggle all WiFi interfaces of the router (all SSID and all bands). diff --git a/source/_components/freedns.markdown b/source/_components/freedns.markdown index 48d73fbec60..251844f64c6 100644 --- a/source/_components/freedns.markdown +++ b/source/_components/freedns.markdown @@ -15,7 +15,7 @@ ha_release: 0.67 With the `freedns` integration you can keep your [FreeDNS](https://freedns.afraid.org) record up to date. -## {% linkable_title Setup %} +## Setup You need to determine your update URL or your access token. @@ -26,7 +26,7 @@ You need to determine your update URL or your access token. 5. The access token is the part at the end of the link: `https://freedns.afraid.org/dynamic/update.php?YOUR_UPDATE_TOKEN` 6. Either put the token as `access_token` _or_ the whole URL into the `url` attribute. -## {% linkable_title Configuration %} +## Configuration To use the integration in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/fritz.markdown b/source/_components/fritz.markdown index 2dbd28a2954..c92dad1bd0a 100644 --- a/source/_components/fritz.markdown +++ b/source/_components/fritz.markdown @@ -18,13 +18,13 @@ redirect_from: The `fritz` platform offers presence detection by looking at connected devices to a [AVM Fritz!Box](http://avm.de/produkte/fritzbox/) based router. -## {% linkable_title Setup %} +## Setup

It might be necessary to install additional packages: $ sudo apt-get install python3-lxml libxslt-dev libxml2-dev zlib1g-dev If you installed Home Assistant in a virtualenv, run the following commands inside it: $ pip3 install lxml; be patient this will take a while.

-## {% linkable_title Configuration %} +## Configuration To use an Fritz!Box router in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/fritzbox.markdown b/source/_components/fritzbox.markdown index ca460641e13..4afc8b1eb06 100644 --- a/source/_components/fritzbox.markdown +++ b/source/_components/fritzbox.markdown @@ -31,7 +31,7 @@ There is currently support for the following device types within Home Assistant: - [Sensor](#sensor) - Switch -#### {% linkable_title Tested Devices %} +#### Tested Devices - [FRITZ!Box 6490 Cable](https://en.avm.de/products/fritzbox/fritzbox-6490-cable/) - [FRITZ!Box 7590](https://en.avm.de/products/fritzbox/fritzbox-7590/) @@ -40,7 +40,7 @@ There is currently support for the following device types within Home Assistant: - [FRITZ!DECT 301](https://en.avm.de/products/fritzdect/fritzdect-301/) - [Eurotronic Comet DECT](https://eurotronic.org/produkte/elektronische-heizkoerperthermostate/sparmatic-comet/) -## {% linkable_title Setup %} +## Setup ```yaml # Example configuration.yaml entry @@ -71,11 +71,11 @@ devices: type: string {% endconfiguration %} -## {% linkable_title Switch & Thermostat %} +## Switch & Thermostat To get AVM Fritzbox switch and thermostat follow the instructions above. -### {% linkable_title Attributes %} +### Attributes The are several attributes that can be useful for automations and templates. @@ -93,11 +93,11 @@ The are several attributes that can be useful for automations and templates. | `total_consumption` | The total power consumption since the beginning of operation (only available if the device supports power meter function). | `total_consumption_unit` | The unit of the total_consumption (only available if the device supports power meter function). -## {% linkable_title Sensor %} +## Sensor To get AVM Fritzbox temperature sensor (e.g. FRITZ!DECT Repeater 100) follow the instructions for the [Fritzbox component](#setup). -### {% linkable_title Attributes %} +### Attributes The are several attributes that can be useful for automations and templates. diff --git a/source/_components/fritzbox_callmonitor.markdown b/source/_components/fritzbox_callmonitor.markdown index a1f36c15eb4..674d745d81e 100644 --- a/source/_components/fritzbox_callmonitor.markdown +++ b/source/_components/fritzbox_callmonitor.markdown @@ -19,7 +19,7 @@ redirect_from: The `fritzbox_callmonitor` sensor monitors the call monitor exposed by [AVM Fritz!Box](http://avm.de/produkte/fritzbox/) routers on TCP port 1012. It will assume the values `idle`, `ringing`, `dialing` or `talking` with the phone numbers involved contained in the state attributes. It can also access the internal phone book of the router to look up the names corresponding to the phone numbers and store them in the state attributes. -## {% linkable_title Prerequisites %} +## Prerequisites To build the package you have to install some dependencies first. @@ -35,11 +35,11 @@ Be patient this will take a while. pip3 install lxml ``` -## {% linkable_title Setup%} +## Setup To activate the call monitor on your Fritz!Box, dial #96\*5\* from any phone connected to it. -## {% linkable_title Configuration %} +## Configuration To use the Fritz!Box call monitor in your installation, add the following to your `configuration.yaml` file: @@ -84,9 +84,9 @@ prefixes: type: list {% endconfiguration %} -## {% linkable_title Examples %} +## Examples -### {% linkable_title Full configuration %} +### Full configuration The example below shows a full configuration for a call monitor with phone book support. @@ -104,7 +104,7 @@ sensor: - '089' ``` -### {% linkable_title Send notifications on state change %} +### Send notifications on state change This example shows how to send notifications whenever the sensor's state changes. You will get notified both when you receive a call and also when a call is placed. diff --git a/source/_components/frontend.markdown b/source/_components/frontend.markdown index 965fc3f11cd..7b3d7e5a2c7 100644 --- a/source/_components/frontend.markdown +++ b/source/_components/frontend.markdown @@ -60,7 +60,7 @@ frontend: {% endconfiguration %} -## {% linkable_title Defining Themes %} +## Defining Themes Starting with version 0.49 you can define themes: @@ -78,7 +78,7 @@ The example above defined two themes named `happy` and `sad`. For each theme you Check our [community forums](https://community.home-assistant.io/c/projects/themes) to find themes to use. -### {% linkable_title Theme automation %} +### Theme automation There are 2 themes-related services: @@ -117,7 +117,7 @@ automation: name: darkred ``` -### {% linkable_title Manual Theme Selection %} +### Manual Theme Selection When themes are enabled in the `configuration.yaml` file, a new option will show up in the user profile menu (accessed by clicking your user account initials at the top of the sidebar). You can then choose any installed theme from the dropdown list and it will be applied immediately. @@ -126,7 +126,7 @@ When themes are enabled in the `configuration.yaml` file, a new option will show Set a theme

-## {% linkable_title Loading extra HTML %} +## Loading extra HTML Starting with version 0.53 you can specify extra HTML files to load, and starting with version 0.95 extra JS modules. @@ -144,7 +144,7 @@ frontend: HTML will be loaded via `` on any page (states and panels), and modules via ``. -### {% linkable_title Manual Language Selection %} +### Manual Language Selection The browser language is automatically detected. To use a different language, go to the user profile menu (accessed by clicking your user account initials at the top of the sidebar) and select one. It will be applied immediately. diff --git a/source/_components/frontier_silicon.markdown b/source/_components/frontier_silicon.markdown index 02c79c90b89..7558b7e03e6 100644 --- a/source/_components/frontier_silicon.markdown +++ b/source/_components/frontier_silicon.markdown @@ -17,7 +17,7 @@ redirect_from: This integration provides support for Internet Radios based on the [Frontier Silicon chipset]. Some of the manufacturers which offer products based on these chips include: Hama, Medion, Slivercrest, Auna, Technisat, Revo, Pinnel, etc. These devices will be usually controlled by the [UNDOK] app. -## {% linkable_title Supported Models %} +## Supported Models * Hama: [IR110], [DIR3110] * Medion: [Medion Radios] * Silvercrest: [SIRD 14 C2] diff --git a/source/_components/futurenow.markdown b/source/_components/futurenow.markdown index db9c7526842..647d56b7f4b 100644 --- a/source/_components/futurenow.markdown +++ b/source/_components/futurenow.markdown @@ -19,7 +19,7 @@ The `futurenow` light platform allows you to use [P5](http://www.p5.hu) FutureNo * [FutureNow FNIP-6x2AD](http://www.p5.hu/index.php/products/ethernet-modules/265-fnip-6x2ad) dimmer unit (outputs only) * [FutureNow FNIP-8x10A](http://www.p5.hu/index.php/products/ethernet-modules/263-fnip-8x10a) relay unit (outputs only) -### {% linkable_title Configuration Sample %} +### Configuration Sample To use your FutureNow units, add the following to your `configuration.yaml` file: @@ -70,7 +70,7 @@ devices: default: false {% endconfiguration %} -### {% linkable_title Extended Configuration Sample %} +### Extended Configuration Sample The following example `configuration.yaml` has two different FutureNow units with multiple channels: diff --git a/source/_components/garadget.markdown b/source/_components/garadget.markdown index 252b0d369e2..2767f7d8de8 100644 --- a/source/_components/garadget.markdown +++ b/source/_components/garadget.markdown @@ -19,7 +19,7 @@ redirect_from: The `garadget` cover platform lets you control [Garadget](http://www.garadget.com/) garage door futurizers through Home Assistant. -## {% linkable_title Configuration %} +## Configuration To enable Garadget Covers in your installation, add the following to your `configuration.yaml` file: @@ -73,7 +73,7 @@ covers: If provided, the **access_token** will be used, otherwise the **username** and **password** will be used to automatically generate an access token at start time. -## {% linkable_title Example %} +## Example

diff --git a/source/_components/gc100.markdown b/source/_components/gc100.markdown index 91d92fd3c32..7edb21fefd9 100644 --- a/source/_components/gc100.markdown +++ b/source/_components/gc100.markdown @@ -28,7 +28,7 @@ There is currently support for the following device types within Home Assistant: Currently, only relays and ports configured to be digital inputs are supported in Home Assistant. For IR support, please use the [iTach remote platform](/components/remote.itach/), but note that it will likely not function concurrently on the same GC100 due to limitations in the TCP socket server implementation used by Global Caché. -## {% linkable_title Configuration %} +## Configuration To enable this device, add the following lines to your `configuration.yaml`: @@ -50,7 +50,7 @@ port: type: integer {% endconfiguration %} -## {% linkable_title Binary Sensor %} +## Binary Sensor To enable this sensor, you first have to set up [gc100](#configuration), and add the following lines to your `configuration.yaml` file: @@ -72,7 +72,7 @@ ports: type: list {% endconfiguration %} -## {% linkable_title Switch %} +## Switch This allows you to control and monitor the relay state on your GC100. diff --git a/source/_components/gearbest.markdown b/source/_components/gearbest.markdown index 1b1cb38c5cd..1503ad714ec 100644 --- a/source/_components/gearbest.markdown +++ b/source/_components/gearbest.markdown @@ -58,7 +58,7 @@ items: type: string {% endconfiguration %} -### {% linkable_title Extended example %} +### Extended example ```yaml # Example configuration.yaml entry diff --git a/source/_components/geizhals.markdown b/source/_components/geizhals.markdown index f38675845af..7f27e62e3e2 100644 --- a/source/_components/geizhals.markdown +++ b/source/_components/geizhals.markdown @@ -49,7 +49,7 @@ locale: type: string {% endconfiguration %} -#### {% linkable_title Extended example %} +#### Extended example ```yaml # Example configuration.yaml entry diff --git a/source/_components/generic.markdown b/source/_components/generic.markdown index b3d0aa213d6..9295eae9bd7 100644 --- a/source/_components/generic.markdown +++ b/source/_components/generic.markdown @@ -20,7 +20,7 @@ The `generic` camera platform allows you to integrate any IP camera or other URL Home Assistant will serve the images via its server, making it possible to view your IP cameras while outside of your network. The endpoint is `/api/camera_proxy/camera.[name]`. -## {% linkable_title Configuration %} +## Configuration To enable this camera in your installation, add the following to your `configuration.yaml` file: @@ -85,11 +85,11 @@ verify_ssl:

-## {% linkable_title Examples %} +## Examples In this section, you find some real-life examples of how to use this camera platform. -### {% linkable_title Weather graph from yr.no %} +### Weather graph from yr.no ```yaml camera: @@ -99,7 +99,7 @@ camera: content_type: 'image/svg+xml' ``` -### {% linkable_title Local image with Hass.io %} +### Local image with Hass.io You can show a static image with this platform. Just place the image here: `/config/www/your_image.png` @@ -111,7 +111,7 @@ camera: verify_ssl: false ``` -### {% linkable_title Sharing a camera feed from one Home Assistant instance to another %} +### Sharing a camera feed from one Home Assistant instance to another If you are running more than one Home Assistant instance (let's call them the 'host' and 'receiver' instances) you may wish to display the camera feed from the host instance on the receiver instance. You can use the [REST API](/developers/rest_api/#get-apicamera_proxycameraltentity_id) to access the camera feed on the host (IP address 127.0.0.5) and display it on the receiver instance by configuring the receiver with the following: @@ -121,7 +121,7 @@ camera: name: Host instance camera feed still_image_url: https://127.0.0.5:8123/api/camera_proxy/camera.live_view ``` -### {% linkable_title Image from HTTP only camera %} +### Image from HTTP only camera To access a camera which is only available via HTTP, you must turn off SSL verification. @@ -133,7 +133,7 @@ camera: verify_ssl: false ``` -### {% linkable_title Live stream %} +### Live stream To access a camera that has both a snapshot and live stream URL, utilizing the [stream](/components/stream/) component. diff --git a/source/_components/geniushub.markdown b/source/_components/geniushub.markdown index 2a007514e5b..8d3433d1ff9 100644 --- a/source/_components/geniushub.markdown +++ b/source/_components/geniushub.markdown @@ -21,7 +21,7 @@ The `geniushub` integration links Home Assistant with your Genius Hub for contro It uses the [geniushub-client](https://pypi.org/project/geniushub-client/) library. -### {% linkable_title Zones %} +### Zones Each Zone controlled by your Genius hub will be exposed as either a: @@ -34,7 +34,7 @@ Each such entity will report back its mode, state, setpoint and current temperat In addition, the entity's mode and setpoint can be changed. The entity's `operating_mode` can be set to one of `off`, `timer`, `on` (i.e. **Override** mode) or `eco`. The `eco` mode is a proxy for the **Footprint** mode and so is only available to **Radiator** Zones that have room sensors. -### {% linkable_title Devices %} +### Devices If the Hub is directly polled using the v3 API (see below), then each Device controlled by your Genius hub will be exposed as either a: @@ -43,7 +43,7 @@ If the Hub is directly polled using the v3 API (see below), then each Device con Each such entity will report back its primary state; in addition, `assigned_zone` and `last_comms` (last communications time) are available via the entity's attributes. -### {% linkable_title Issues %} +### Issues There are three `Sensor` entities that will indicate the number of **Errors**, **Warnings** and **Information** issues. @@ -66,7 +66,7 @@ Each such entity has a state attribute that will contain a list of any such issu ``` {% endraw %} -### {% linkable_title State Attributes %} +### State Attributes Other properties are available via each entity's state attributes. For example, in the case of **Radiator** Zones/`Climate` devices: @@ -100,11 +100,11 @@ value_template: "{{ state_attr('climate.main_room', 'status').occupied }}" ``` {% endraw %} -## {% linkable_title Configuration %} +## Configuration To add your Genius Hub into your Home Assistant installation, add one of the following to your `configuration.yaml` file. -### {% linkable_title Option 1: hub token only %} +### Option 1: hub token only - requires a **hub token** obtained from [my.geniushub.co.uk/tokens](https://my.geniushub.co.uk/tokens) - uses the v1 API - which is well-documented @@ -116,7 +116,7 @@ geniushub: token: GENIUS_HUB_TOKEN ``` -### {% linkable_title Option 2: hub hostname/address with user credentials %} +### Option 2: hub hostname/address with user credentials - requires your **username** & **password**, as used with [www.geniushub.co.uk/app](https://www.geniushub.co.uk/app) - uses the v3 API - unofficial, but there are additional features (e.g., battery levels) diff --git a/source/_components/geo_json_events.markdown b/source/_components/geo_json_events.markdown index 828a406e276..f7856098e98 100644 --- a/source/_components/geo_json_events.markdown +++ b/source/_components/geo_json_events.markdown @@ -23,7 +23,7 @@ Entities are generated, updated and removed automatically with each update from The data is updated every 5 minutes. -## {% linkable_title Configuration %} +## Configuration To integrate a GeoJSON feed, add the following lines to your `configuration.yaml`. This is an example configuration showing [earthquake data provided by the U.S. Geological Survey](https://earthquake.usgs.gov/earthquakes/feed/v1.0/geojson.php). @@ -56,7 +56,7 @@ longitude: default: Longitude defined in your `configuration.yaml` {% endconfiguration %} -## {% linkable_title State Attributes %} +## State Attributes The following state attributes are available for each entity in addition to the standard ones: @@ -67,7 +67,7 @@ The following state attributes are available for each entity in addition to the | source | `geo_json_events` to be used in conjunction with `geo_location` automation trigger. | | external_id | The external ID used in the feed to identify the event in the feed. | -## {% linkable_title Advanced Configuration Example %} +## Advanced Configuration Example When integrating several GeoJSON feeds, it may be useful to distinguish the entities of different feeds. The easiest way to do that is by defining an [`entity_namespace`](/docs/configuration/platform_options/#entity-namespace/) for each platform which will prefix each entity ID with the defined value. diff --git a/source/_components/geo_location.markdown b/source/_components/geo_location.markdown index 3155b55100c..8b6600e2444 100644 --- a/source/_components/geo_location.markdown +++ b/source/_components/geo_location.markdown @@ -15,7 +15,7 @@ Geolocation aware entities are typically related to events in the real world in Entities can have associated geolocation coordinates (latitude and longitude) so that they are displayed on the map. The distance from the entity's coordinates to Home Assistant's location can be used for filtering. -## {% linkable_title Geolocation trigger %} +## Geolocation trigger The [Geolocation trigger](/docs/automation/trigger/#geolocation-trigger) can be used in automations triggered by Geolocation entities appearing in or disappearing from zones. The following value must be used as `source` of the trigger depending on which platform is managing the entities: @@ -29,7 +29,7 @@ The [Geolocation trigger](/docs/automation/trigger/#geolocation-trigger) can be Conditions can be used to further filter entities, for example by inspecting their state attributes. -## {% linkable_title Geolocation notification example %} +## Geolocation notification example The following example automation creates a notification on the screen when a fire classified as 'Bush Fire' is reported within a predefined bush fire alert zone: diff --git a/source/_components/geo_rss_events.markdown b/source/_components/geo_rss_events.markdown index f20cea15d50..a03fcc390a4 100644 --- a/source/_components/geo_rss_events.markdown +++ b/source/_components/geo_rss_events.markdown @@ -30,7 +30,7 @@ Only entries of the feed are considered that define a location as `point` or `po The data is updated every 5 minutes. -## {% linkable_title Configuration %} +## Configuration To enable the GeoRSS events sensor, add the following lines to your `configuration.yaml`. This is an example configuration showing bush fire incidents from the NSW Rural Fire Service. @@ -84,7 +84,7 @@ unit_of_measurement: default: Events {% endconfiguration %} -## {% linkable_title Example Feeds %} +## Example Feeds **Bush Fire Alerts** diff --git a/source/_components/geofency.markdown b/source/_components/geofency.markdown index 0383f42f051..58043c8fb36 100644 --- a/source/_components/geofency.markdown +++ b/source/_components/geofency.markdown @@ -18,7 +18,7 @@ redirect_from: This integration sets up integration with [Geofency](http://www.geofency.com/). Geofency is a paid app for iOS that lets users to configure a request that will be sent when a geofence or iBeacon region is entered or exited. This can be configured with Home Assistant to update your location. -## {% linkable_title Configuration %} +## Configuration To configure Geofency, you must set it up via the integrations panel in the configuration screen. You must then configure the iOS app (via the Webhook feature) to send a POST request to your Home Assistant server at the webhook URL provided by the integration during setup. Use the default POST format. Make sure to enable the 'Update Geo-Position' functionality for mobile beacons. @@ -43,7 +43,7 @@ geofency: - keys ``` -### {% linkable_title Zones %} +### Zones When you enter a geofence or stationary beacon, your location name in Home Assistant will be set to the name of the geofence or beacon location in Geofency. When you exit a geofence or stationary beacon, your location name in Home Assistant will be set to `not home`. For mobile beacons, the location name will be `not_home` whenever the beacon is entered or exited outside of a [zone](/components/zone/), otherwise, it will be set to the name of the zone. diff --git a/source/_components/github.markdown b/source/_components/github.markdown index d8f8fe50440..8ff1b4f3f8c 100644 --- a/source/_components/github.markdown +++ b/source/_components/github.markdown @@ -18,11 +18,11 @@ redirect_from: The GitHub sensor integrates data from [GitHub](https://github.com/) to monitor your favorite repositories. -## {% linkable_title Setup %} +## Setup To set up this sensor you will need a [personal access token](https://github.com/settings/tokens). You will need to check the `repo` scope for the sensor to function. -## {% linkable_title Configuration %} +## Configuration To enable this platform, add the following to your `configuration.yaml` file: diff --git a/source/_components/gitlab_ci.markdown b/source/_components/gitlab_ci.markdown index e3e2cccc40c..ebdf7770fa4 100644 --- a/source/_components/gitlab_ci.markdown +++ b/source/_components/gitlab_ci.markdown @@ -18,7 +18,7 @@ redirect_from: The `gitlab_ci` sensor platform integrates results reported by CI/CD Pipeline Jobs in [GitLab](https://gitlab.com/). -## {% linkable_title Setup %} +## Setup You will need a GitLab repository ID. On the **Details** page for your GitLab repo, just below the project name is **Project ID:**. @@ -26,7 +26,7 @@ Alternatively, you can use `GitLab_Username/GitLab_RepositoryName`, e.g., `MyCoo A GitLab token with at least the API permission scope is needed, which can be created on the [GitLab Personal Access Tokens](https://gitlab.com/profile/personal_access_tokens) page of your GitLab User Settings. -## {% linkable_title Configuration %} +## Configuration To enable this platform, please add the following to your `configuration.yaml` file: diff --git a/source/_components/gitter.markdown b/source/_components/gitter.markdown index e6c638da140..fa9b0c16208 100644 --- a/source/_components/gitter.markdown +++ b/source/_components/gitter.markdown @@ -18,7 +18,7 @@ redirect_from: This `gitter` sensor allows one to monitor a [Gitter.im](https://gitter.im) chatroom for unread messages. -## {% linkable_title Configuration %} +## Configuration Visit [Gitter Developer Apps](https://developer.gitter.im/apps) to retrieve your "Personal Access Token". diff --git a/source/_components/glances.markdown b/source/_components/glances.markdown index 8fb45cbc0be..f3b54a52666 100644 --- a/source/_components/glances.markdown +++ b/source/_components/glances.markdown @@ -19,7 +19,7 @@ redirect_from: The `glances` sensor platform is consuming the system information provided by the [Glances](https://github.com/nicolargo/glances) API. This enables one to track remote host and display their stats in Home Assistant. -## {% linkable_title Setup %} +## Setup This sensors needs a running instance of `glances` on the host. The minimal supported version of `glances` is 2.3. To start a Glances RESTful API server on its default port 61208, the a test the following command can be used: @@ -42,7 +42,7 @@ If this doesn't work, try changing the `2` for `3`, if you have installed the la For details about auto-starting `glances`, please refer to [Start Glances through Systemd](https://github.com/nicolargo/glances/wiki/Start-Glances-through-Systemd). -## {% linkable_title Configuration %} +## Configuration To enable the Glances sensor, add the following lines to your `configuration.yaml`: diff --git a/source/_components/gogogate2.markdown b/source/_components/gogogate2.markdown index 26656bf7d98..756be2750cc 100644 --- a/source/_components/gogogate2.markdown +++ b/source/_components/gogogate2.markdown @@ -18,7 +18,7 @@ redirect_from: The `gogogate2` cover platform lets you control Gogogate2-Enabled garage doors through Home Assistant. Device names in Home Assistant are generated based on the names defined in your Gogogate2 mobile app. -## {% linkable_title Configuration %} +## Configuration To use your Gogogate2 cover in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/google_assistant.markdown b/source/_components/google_assistant.markdown index b87d9a13c38..df1726c4b12 100644 --- a/source/_components/google_assistant.markdown +++ b/source/_components/google_assistant.markdown @@ -16,13 +16,13 @@ ha_release: 0.56 The `google_assistant` integration allows you to control things via Google Assistant (on your mobile or tablet) or a Google Home device. -## {% linkable_title Automatic setup via Home Assistant Cloud %} +## Automatic setup via Home Assistant Cloud With [Home Assistant Cloud](/cloud/), you can connect your Home Assistant instance in a few simple clicks to Google Assistant. With Home Assistant Cloud you don't have to deal with dynamic DNS, SSL certificates or opening ports on your router. Just log in via the user interface and a secure connection with the cloud will be established. Home Assistant Cloud requires a paid subscription after a 30-day free trial. For Home Assistant Cloud Users, documentation can be found [here](https://www.nabucasa.com/config/google_assistant/). -## {% linkable_title Manual setup %} +## Manual setup The Google Assistant integration requires a bit more setup than most due to the way Google requires Assistant Apps to be set up. @@ -30,7 +30,7 @@ The Google Assistant integration requires a bit more setup than most due to the To use Google Assistant, your Home Assistant configuration has to be [externally accessible with a hostname and SSL certificate](/docs/configuration/remote/). If you haven't already configured that, you should do so before continuing.

-## {% linkable_title Migrate to release 0.80 and above %} +## Migrate to release 0.80 and above

If this is the first time setting up your Google Assistant integration, you can skip this section and continue with the [manual setup instructions](#first-time-setup) below.

@@ -58,7 +58,7 @@ If you've added Home Assistant to the home screen, you have to first remove it f If you're still having trouble, make sure that you're not connected to the same network Home Assistant is running on, e.g., use 4G/LTE instead.

-## {% linkable_title First time setup %} +## First time setup You need to create an API Key with the [Google Cloud API Console](https://console.cloud.google.com/apis/api/homegraph.googleapis.com/overview) which allows you to update devices without unlinking and relinking an account (see [below](#troubleshooting-the-request_sync-service)). If you don't provide one, the `google_assistant.request_sync` service is not exposed. It is recommended to set up this configuration key as it also allows the usage of the following command, "Ok Google, sync my devices". Once you have set up this component, you will need to call this service (or command) each time you add a new device that you wish to control via the Google Assistant integration. @@ -100,7 +100,7 @@ If you've added Home Assistant to the home screen, you have to first remove it f 3. Go to Credentials, which you can find on the left navigation bar under the key icon, and select API Key from Create Credentials. 4. Note down the generated API Key and use this in the configuration. -## {% linkable_title Configuration %} +## Configuration Now add the following lines to your `configuration.yaml` file: @@ -176,7 +176,7 @@ entity_config: type: string {% endconfiguration %} -### {% linkable_title Available domains %} +### Available domains Currently, the following domains are available to be used with Google Assistant, listed with their default types: @@ -199,13 +199,13 @@ Currently, the following domains are available to be used with Google Assistant, The domain groups contains groups containing all items, by example group.all_automations. When telling Google Assistant to shut down everything, this will lead in this example to disabling all automations

-### {% linkable_title Secure Devices %} +### Secure Devices Certain devices are considered secure, including anything in the `lock` domain, and `covers` with device types `garage` and `door`. By default these cannot be opened by Google Assistant unless a `secure_devices_pin` is set up. To allow opening, set the `secure_devices_pin` to something and you will be prompted to speak the pin when opening the device. Closing and locking these devices does not require a pin. -### {% linkable_title Media Player Sources %} +### Media Player Sources Media Player sources are sent via the Modes trait in Google Assistant. There is currently a limitation with this feature that requires a hard-coded set of settings. Because of this, the only sources that will be usable by this feature are listed here: @@ -215,11 +215,11 @@ https://developers.google.com/actions/reference/smarthome/traits/modes "Hey Google, change input source to TV on Living Room Receiver" -### {% linkable_title Room/Area support %} +### Room/Area support Entities that have not got rooms explicitly set and that have been placed in Home Assistant areas will return room hints to Google with the devices in those areas. -### {% linkable_title Climate Operation Modes %} +### Climate Operation Modes There is not an exact 1-1 match between Home Assistant and Google Assistant for the available operation modes. Here are the modes that are currently available: @@ -232,7 +232,7 @@ Here are the modes that are currently available: - dry - eco -### {% linkable_title Troubleshooting the request_sync service %} +### Troubleshooting the request_sync service The request_sync service requires that the initial sync from Google includes the agent_user_id. If not, the service will log an error that reads something like "Request contains an invalid argument". If this happens, then [unlink the account](https://support.google.com/googlehome/answer/7506443) from Home Control and relink. @@ -246,12 +246,12 @@ The request_sync service may fail with a 404 if the project_id of the Homegraph Syncing may also fail after a period of time, likely around 30 days, due to the fact that your Actions on Google app is techincally in testing mode and has never been published. Eventually, it seems that the test expires. Control of devices will continue to work but syncing may not. If you say "Ok Google, sync my devices" and get the response "Unable to sync Home Assistant", this can usually be resolved by going back to your test app in the [Actions on Google console](https://console.actions.google.com/) and clicking `Simulator` under `TEST`. Regenerate the draft version Test App and try asking Google to sync your devices again. -### {% linkable_title Troubleshooting with NGINX %} +### Troubleshooting with NGINX When using NGINX, ensure that your `proxy_pass` line *does not* have a trailing `/`, as this will result in errors. Your line should look like: proxy_pass http://localhost:8123; -### {% linkable_title Unlink and relink %} +### Unlink and relink If you're having trouble with *Account linking failed* after you unlinked your service, try clearing the browser history and cache. diff --git a/source/_components/google_cloud.markdown b/source/_components/google_cloud.markdown index fc2309bb5cd..6a6382f001d 100644 --- a/source/_components/google_cloud.markdown +++ b/source/_components/google_cloud.markdown @@ -14,7 +14,7 @@ ha_release: 0.95 The `google_cloud` platform allows you to use [Google Cloud Platform](https://cloud.google.com/) API and integrate them into Home Assistant. -## {% linkable_title Configuration %} +## Configuration To use Google Cloud Platform, you need to provide `config` directory relative path of [`API key`](#obtaining-api-key) file you are going to use. Place it under `config` folder and set `key_file` parameter in `configuration.yaml`: @@ -25,7 +25,7 @@ tts: key_file: googlecloud.json ``` -## {% linkable_title Obtaining an API key %} +## Obtaining an API key API key obtaining process described in corresponding documentation: @@ -57,11 +57,11 @@ Basic instruction for all APIs: 5. Click `Create`. A note appears, warning that this service account has no role. 6. Click `Create without role`. A JSON file that contains your `API key` downloads to your computer. -## {% linkable_title Google Cloud Text-to-Speech %} +## Google Cloud Text-to-Speech [Google Cloud Text-to-Speech](https://cloud.google.com/text-to-speech/) converts text into human-like speech in more than 100 voices across 20+ languages and variants. It applies groundbreaking research in speech synthesis (WaveNet) and Google's powerful neural networks to deliver high-fidelity audio. With this easy-to-use API, you can create lifelike interactions with your users that transform customer service, device interaction, and other applications. -### {% linkable_title Pricing %} +### Pricing The Cloud Text-to-Speech API is priced monthly based on the amount of characters to synthesize into audio sent to the service. @@ -70,7 +70,7 @@ The Cloud Text-to-Speech API is priced monthly based on the amount of characters | Standard (non-WaveNet) voices | 0 to 4 million characters | $4.00 USD / 1 million characters | | WaveNet voices | 0 to 1 million characters | $16.00 USD / 1 million characters | -### {% linkable_title Text-to-Speech configuration %} +### Text-to-Speech configuration {% configuration %} key_file: @@ -118,7 +118,7 @@ profiles: default: "[]" {% endconfiguration %} -### {% linkable_title Full configuration example %} +### Full configuration example The Google Cloud Text-to-Speech configuration can look like: diff --git a/source/_components/google_domains.markdown b/source/_components/google_domains.markdown index 9c8928665af..f19649e4409 100644 --- a/source/_components/google_domains.markdown +++ b/source/_components/google_domains.markdown @@ -15,7 +15,7 @@ ha_release: 0.57 With the Google Domains integration you can keep your Google Domains record up to date. -## {% linkable_title Configuration %} +## Configuration To use the integration in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/google_maps.markdown b/source/_components/google_maps.markdown index e99833dd5eb..9f81b0c1a91 100644 --- a/source/_components/google_maps.markdown +++ b/source/_components/google_maps.markdown @@ -18,7 +18,7 @@ redirect_from: The `google_maps` platform allows you to detect presence using the unofficial API of [Google Maps Location Sharing](https://myaccount.google.com/locationsharing). -## {% linkable_title Configuration %} +## Configuration You first need to create an additional Google account and share your location with that account. This platform will use that account to fetch the location of your device(s). You have to setup sharing through the Google Maps app on your mobile phone. You can find more information [here](https://support.google.com/accounts?p=location_sharing). diff --git a/source/_components/google_pubsub.markdown b/source/_components/google_pubsub.markdown index 43458397e7e..490909b2555 100644 --- a/source/_components/google_pubsub.markdown +++ b/source/_components/google_pubsub.markdown @@ -15,7 +15,7 @@ ha_release: 0.88 The `google_pubsub` integration allows you to hook into the Home Assistant event bus and send events to [Google Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/overview). The current [free tier](https://cloud.google.com/free/) of GCP should allow you to sync about 1 event every 2 seconds on average (2 million invocations per month). -## {% linkable_title First time setup %} +## First time setup This assumes you already have a Google Cloud project. If you don't, please create one in the [Google Cloud Console](https://console.cloud.google.com/projectcreate) @@ -28,7 +28,7 @@ This will download the Service Account JSON key to your machine. Do NOT share th Next, create a Google Pub/Sub topic in the [Google Cloud API Console](https://console.cloud.google.com/cloudpubsub/topicList). The topic name will become something like `projects/project-198373/topics/topic-name`. Note the last part only (the name you chose): `topic-name`. -## {% linkable_title Configuration %} +## Configuration Add the following lines to your `configuration.yaml` file: @@ -80,7 +80,7 @@ filter: Not filtering domains or entities will send every event to Google PubSub, thus hitting the free tier limit very fast. Be sure to fill in this configuration parameter or have a paid subscription for Google Cloud.

-### {% linkable_title Saving the data using a Google Cloud Function %} +### Saving the data using a Google Cloud Function To save your data automatically to BigQuery, follow the [instructions here](https://github.com/timvancann/home-assistant-pubsub-cloud-function). The current [free tier](https://cloud.google.com/free/) of GCP should allow to store up to 10GB of data. diff --git a/source/_components/google_translate.markdown b/source/_components/google_translate.markdown index eb670a40413..7a01d4dc5e7 100644 --- a/source/_components/google_translate.markdown +++ b/source/_components/google_translate.markdown @@ -22,7 +22,7 @@ The `google_translate` text-to-speech platform uses unofficial [Google Translate This platform renamed to `google_translate` from `google` since release 0.92.

-## {% linkable_title Configuration %} +## Configuration To enable text-to-speech with Google, add the following lines to your `configuration.yaml`: @@ -43,7 +43,7 @@ language: Check the [complete list of supported languages](https://translate.google.com/intl/en_ALL/about/languages/) (languages where "Talk" feature is enabled in Google Translate) for allowed values. Use the 2 digit language code which you can find at the end of URL when you click on Language name. -## {% linkable_title Full configuration example %} +## Full configuration example A full configuration sample including optional variables: diff --git a/source/_components/google_travel_time.markdown b/source/_components/google_travel_time.markdown index 56838a2b52a..22a6ba23c8d 100644 --- a/source/_components/google_travel_time.markdown +++ b/source/_components/google_travel_time.markdown @@ -18,7 +18,7 @@ redirect_from: The `google_travel_time` sensor provides travel time from the [Google Distance Matrix API](https://developers.google.com/maps/documentation/distance-matrix/). -## {% linkable_title Setup %} +## Setup You need to register for an API key by following the instructions [here](https://github.com/googlemaps/google-maps-services-python#api-keys). You only need to turn on the Distance Matrix API. @@ -26,7 +26,7 @@ You need to register for an API key by following the instructions [here](https:/ A quota can be set against the API to avoid exceeding the free credit amount. Set the 'Elements per day' to a limit of 645 or less. Details on how to configure a quota can be found [here](https://developers.google.com/maps/documentation/distance-matrix/usage-and-billing#set-caps) -## {% linkable_title Configuration %} +## Configuration To enable the sensor, add the following lines to your `configuration.yaml` file: @@ -98,7 +98,7 @@ options: type: string {% endconfiguration %} -## {% linkable_title Dynamic Configuration %} +## Dynamic Configuration Tracking can be setup to track entities of type `device_tracker`, `zone`, `sensor` and `person`. If an entity is placed in the origin or destination then every 5 minutes when the platform updates it will use the latest location of that entity. @@ -127,7 +127,7 @@ sensor: units: imperial # 'metric' for Metric, 'imperial' for Imperial ``` -## {% linkable_title Entity Tracking %} +## Entity Tracking - **device_tracker** - If state is a zone then the zone location will be used @@ -140,7 +140,7 @@ sensor: - All other states will be passed directly into the Google API - This includes all valid locations listed in the *Configuration Variables* -## {% linkable_title Updating sensors on-demand using Automation %} +## Updating sensors on-demand using Automation You can also use the `homeassistant.update_entity` service to update the sensor on-demand. For example, if you want to update `sensor.morning_commute` every 2 minutes on weekday mornings, you can use the following automation: diff --git a/source/_components/googlehome.markdown b/source/_components/googlehome.markdown index 5347dc7f12e..5d4cb29f40c 100644 --- a/source/_components/googlehome.markdown +++ b/source/_components/googlehome.markdown @@ -24,7 +24,7 @@ This integration will provide: - [device_tracker](/components/device_tracker/) platform to track nearby bluetooth devices; - [sensor](/components/sensor/) platform to track the alarms and the timers. -## {% linkable_title Configuration %} +## Configuration To integrate the `googlehome` integration in Home Assistant, add the following section to your `configuration.yaml` file: @@ -66,7 +66,7 @@ devices: default: true {% endconfiguration %} -## {% linkable_title Device types %} +## Device types Device type | Description -- | -- @@ -74,7 +74,7 @@ Device type | Description 2 | Low Energy - LE-only 3 | Dual Mode - BR/EDR/LE -## {% linkable_title Notes %} +## Notes Devices will appear in the format `device_tracker._`. Note that dots are removed from the IP and BT MAC addresses. diff --git a/source/_components/gpsd.markdown b/source/_components/gpsd.markdown index cfb4796d4d4..64af59c6b1b 100644 --- a/source/_components/gpsd.markdown +++ b/source/_components/gpsd.markdown @@ -18,7 +18,7 @@ redirect_from: The `gpsd` integration is using the GPS information collected by [gpsd](http://catb.org/gpsd/) and a GPS receiver. -## {% linkable_title Setup %} +## Setup A requirement is that `gpsd` is installed (`$ sudo apt-get install gpsd` or `$ sudo dnf -y install gpsd`). `gpsd` uses the socket activation feature of systemd on recent Linux distributions for USB receivers. This means that if you plug your GPS receiver in, `gpsd` is started. Other GPS device may work too, but this was not tested. @@ -45,7 +45,7 @@ Escape character is '^]'. {"class":"VERSION","release":"3.15","rev":"3.15-2.fc23","proto_major":3,"proto_minor":11} ``` -## {% linkable_title Configuration %} +## Configuration To setup a GPSD sensor in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/gpslogger.markdown b/source/_components/gpslogger.markdown index 1d2308e837e..d8acd113ba5 100644 --- a/source/_components/gpslogger.markdown +++ b/source/_components/gpslogger.markdown @@ -18,11 +18,11 @@ redirect_from: This integration sets up integration with [GPSLogger](https://gpslogger.app/). GPSLogger is an open source app for Android that allows users to update your location in Home Assistant. -## {% linkable_title Configuration %} +## Configuration To configure GPSLogger, you must set it up via the integrations panel in the configuration screen. This will give you the webhook URL to use during mobile device configuration (below). -## {% linkable_title Setup on your smartphone %} +## Setup on your smartphone Install [GPSLogger for Android](https://play.google.com/store/apps/details?id=com.mendhak.gpslogger) on your device. diff --git a/source/_components/group.markdown b/source/_components/group.markdown index cb183fd77b2..db00da88802 100644 --- a/source/_components/group.markdown +++ b/source/_components/group.markdown @@ -64,7 +64,7 @@ control: type: string {% endconfiguration %} -## {% linkable_title Default groups %} +## Default groups Some integrations automatically create special groups containing integration entities. These groups are named like `group.all_...`, for example: @@ -76,13 +76,13 @@ Some integrations automatically create special groups containing integration ent You can see list of these groups in **State** page of the **Developer Tools**. -## {% linkable_title Group behavior %} +## Group behavior By default when any member of a group is `on` then the group will also be `on`. Similarly with a device tracker, when any member of the group is `home` then the group is `home`. If you set the `all` option to `true` though, this behavior is inverted and all members of the group have to be `on` for the group to turn on as well. --- -## {% linkable_title Old user interface %} +## Old user interface This section only applies if you've not moved off the deprecated `/states` user interface. @@ -171,7 +171,7 @@ group: - group.all_scripts ``` -## {% linkable_title Customize group order %} +## Customize group order You can also order your groups using [customize](/docs/configuration/customizing-devices/) with `order: ` if they don't show up in the order you want them in. ```yaml diff --git a/source/_components/gstreamer.markdown b/source/_components/gstreamer.markdown index 6221cd61178..6f711de1a24 100644 --- a/source/_components/gstreamer.markdown +++ b/source/_components/gstreamer.markdown @@ -39,7 +39,7 @@ pipeline: Only the `music` media type is supported. -## {% linkable_title Setup %} +## Setup And then install the following system dependencies: @@ -73,9 +73,9 @@ On a Raspberry Pi, you may need to add the Home Assistant user to the `audio` gr sudo usermod -a -G audio ``` -## {% linkable_title Example Usage %} +## Example Usage -### {% linkable_title Using with TTS %} +### Using with TTS To play TTS on your local computer (for example, if you have speakers attached to your Raspberry Pi: @@ -92,7 +92,7 @@ script: message: "example text-to-speech message" ``` -### {% linkable_title Using with Snapcast %} +### Using with Snapcast To play to a named pipe for consumption by Snapcast: diff --git a/source/_components/habitica.markdown b/source/_components/habitica.markdown index 2e8ddb96894..7082fd5bcfd 100644 --- a/source/_components/habitica.markdown +++ b/source/_components/habitica.markdown @@ -65,7 +65,7 @@ sensors: default: all (`name`, `hp`, `maxHealth`, `mp`, `maxMP`, `exp`, `toNextLevel`, `lvl`, `gp`, `class`) {% endconfiguration %} -### {% linkable_title API Service Parameters %} +### API Service Parameters The API is exposed to Home Assistant as a service called `habitica.api_call`. To call it you should specify this keys in service data: diff --git a/source/_components/hangouts.markdown b/source/_components/hangouts.markdown index e9cffa0816d..e117fafc7b5 100644 --- a/source/_components/hangouts.markdown +++ b/source/_components/hangouts.markdown @@ -22,7 +22,7 @@ There is currently support for the following device types within Home Assistant: - [Notifications](#notifications) -## {% linkable_title Setup the integration via the frontend %} +## Setup the integration via the frontend Menu: *Configuration* -> *Integrations* @@ -31,7 +31,7 @@ Configure the integration: * In the authentication form there is an Optional Field: **Authorization Code** which should only be used if you get an invalid login error with email and password (see note below for details). * If you secured your account with 2-factor authentication you will be asked for a 2-factor authentication token. -## {% linkable_title Manual Authentication %} +## Manual Authentication If you are sure your email and password are correct, but the integration says the login is invalid then you would need to use the manual authentication method. @@ -39,7 +39,7 @@ To use the manual method, first you would need to obtain an authorization code ( Once the code is obtained fill in the form with your email, password and the authorization code to complete authentication. -### {% linkable_title Steps to obtain Authorization Code %}: +### Steps to obtain Authorization Code: 1. To obtain your authorization code, open [this URL](https://accounts.google.com/o/oauth2/programmatic_auth?scope=https%3A%2F%2Fwww.google.com%2Faccounts%2FOAuthLogin+https%3A%2F%2Fwww.googleapis.com%2Fauth%2Fuserinfo.email&client_id=936475272427.apps.googleusercontent.com&device_name=hangups) in your browser. 2. Log into your Google account normally. @@ -133,7 +133,7 @@ The conversations has to be precreated, the conversation id can be obtained from The intent `HangoutsHelp` is part of the integration and return a list of all sentences the integration unterstand in this conversation. -## {% linkable_title Adding sentences %} +## Adding sentences {% raw %} @@ -165,7 +165,7 @@ This configuration will: - Toggle the light in the given location in a specific conversation. - Return the conversations the bot know. -## {% linkable_title Adding advanced custom sentences %} +## Adding advanced custom sentences Sentences can contain slots (marked with curly braces: `{name}`) and optional words (marked with square brackets: `[the]`). The values of slots will be passed on to the intent and are available inside the templates. @@ -203,9 +203,9 @@ intent_script: {% endraw %} -## {% linkable_title Services %} +## Services -### {% linkable_title Service `hangouts.update` %} +### Service `hangouts.update` Updates the list of conversations. @@ -213,7 +213,7 @@ Updates the list of conversations. |------------------------|----------|--------------------------------------------------| | | | | -### {% linkable_title Service `hangouts.send_message` %} +### Service `hangouts.send_message` Sends a message to the given conversations. @@ -223,7 +223,7 @@ Sends a message to the given conversations. | message | List of message segments, only the "text" field is required in every segment. [Required] | [{"text":"test", "is_bold": false, "is_italic": false, "is_strikethrough": false, "is_underline": false, "parse_str": false, "link_target": "http://google.com"}, ...] | | data | Extra options | {"image_file": "path"} / {"image_url": "url"} | -### {% linkable_title Service `hangouts.reconnect` %} +### Service `hangouts.reconnect` Reconnects the hangouts bot. @@ -231,9 +231,9 @@ Reconnects the hangouts bot. |------------------------|----------|--------------------------------------------------| | | | | -## {% linkable_title Advanced %} +## Advanced -### {% linkable_title Automatic reconnect after ip change %} +### Automatic reconnect after ip change The hangouts integration can't detect if your ip address changes, so it can't automatic reconnect to the Google servers. This is a workaround for this problem. @@ -263,7 +263,7 @@ automation: {% endraw %} -## {% linkable_title Notifications %} +## Notifications The `hangouts` platform allows you to deliver notifications from Home Assistant to [Google Hangouts](http://hangouts.google.com) conversations. Conversations can be both direct as well as group chats. @@ -295,7 +295,7 @@ default_conversations: type: string {% endconfiguration %} -### {% linkable_title Finding the conversation ID %} +### Finding the conversation ID The conversations has to be precreated, the conversation id can be obtained from the `hangouts.conversations` entity, this can be found in with the states developer tool that is shown as this icon in the side bar. Using your web browsers search tool to find the `hangouts.conversations` entity. You will find something like below. diff --git a/source/_components/harmony.markdown b/source/_components/harmony.markdown index 270140faec7..dbcf68641c2 100644 --- a/source/_components/harmony.markdown +++ b/source/_components/harmony.markdown @@ -75,7 +75,7 @@ hold_secs: default: 0 {% endconfiguration %} -### {% linkable_title Configuration file %} +### Configuration file Upon startup one file will be written to your Home Assistant configuration directory per device in the following format: `harmony_REMOTENAME.conf`. The file will contain: @@ -85,7 +85,7 @@ Upon startup one file will be written to your Home Assistant configuration direc This file will be overwritten whenever the Harmony HUB has a new configuration, there is no need to restart Home Assistant. -### {% linkable_title Service `remote.turn_off` %} +### Service `remote.turn_off` Turn off all devices that were switched on from the start of the current activity. @@ -93,7 +93,7 @@ Turn off all devices that were switched on from the start of the current activit | ---------------------- | -------- | ----------- | | `entity_id` | no | Entity ID to target. -### {% linkable_title Service `remote.turn_on` %} +### Service `remote.turn_on` Start an activity. Will start the default `activity` from configuration.yaml if no activity is specified. The specified activity can either be the activity name or the activity ID from the configuration file written to your [Home Assistant configuration directory](/docs/configuration/). @@ -102,7 +102,7 @@ Start an activity. Will start the default `activity` from configuration.yaml if | `entity_id` | no | Entity ID to target. | `activity` | yes | Activity ID or Activity Name to start. -##### {% linkable_title Example %} +##### Example In the file 'harmony_REMOTENAME.conf' you can find the available activities, for example: @@ -127,7 +127,7 @@ action: activity: "Watch TV" ``` -### {% linkable_title Service `remote.send_command` %} +### Service `remote.send_command` Send a single command or a set of commands to one device, device ID and available commands are written to the configuration file at startup. You can optionally specify the number of times you wish to repeat the command(s) and delay you want between repeated command(s). @@ -189,7 +189,7 @@ data: delay_secs: 0.6 ``` -### {% linkable_title Service `remote.harmony_change_channel` %} +### Service `remote.harmony_change_channel` Sends the change channel command to the Harmony HUB @@ -207,7 +207,7 @@ data: channel: 200 ``` -### {% linkable_title Service `remote.harmony_sync` %} +### Service `remote.harmony_sync` Force synchronization between the Harmony device and the Harmony cloud. @@ -215,7 +215,7 @@ Force synchronization between the Harmony device and the Harmony cloud. | ---------------------- | -------- | ----------- | | `entity_id` | no | Entity ID to target. -### {% linkable_title Examples %} +### Examples Template sensors can be utilized to display current activity in the frontend. diff --git a/source/_components/haveibeenpwned.markdown b/source/_components/haveibeenpwned.markdown index cf7326d03ac..3d6feb54adb 100644 --- a/source/_components/haveibeenpwned.markdown +++ b/source/_components/haveibeenpwned.markdown @@ -18,7 +18,7 @@ redirect_from: The `haveibeenpwned` sensor platform creates sensors that check for breached email accounts on [haveibeenpwned](https://haveibeenpwned.com). -## {% linkable_title Configuration %} +## Configuration To enable this sensor, add the following lines to your `configuration.yaml`, it will list every specified email address as a sensor showing the number of breaches on that email account. @@ -39,7 +39,7 @@ email: type: list {% endconfiguration %} -## {% linkable_title Breach meta data %} +## Breach meta data If one of your email accounts is breached the sensor will display breach meta data. It will list the title of the site where your email account has been breached as well as the added date of the breach data. This data is displayed in descending order so that the state attribute diff --git a/source/_components/hdmi_cec.markdown b/source/_components/hdmi_cec.markdown index 3576095a136..391a35e344c 100644 --- a/source/_components/hdmi_cec.markdown +++ b/source/_components/hdmi_cec.markdown @@ -19,13 +19,13 @@ redirect_from: The `hdmi_cec` integration provides services that allow selecting the active device, powering on all devices, setting all devices to standby and creates switch entities for HDMI devices. Devices are defined in the configuration file by associating HDMI port number and a device name. Connected devices that provide further HDMI ports, such as sound-bars and AVRs are also supported. Devices are listed from the perspective of the CEC-enabled Home Assistant device. Any connected device can be listed, regardless of whether it supports CEC. Ideally the HDMI port number on your device will map correctly the CEC physical address. If it does not, use `cec-client` (part of the `libcec` package) to listen to traffic on the CEC bus and discover the correct numbers. -## {% linkable_title CEC Setup %} +## CEC Setup -### {% linkable_title Adapter %} +### Adapter The computer running Home Assistant must support CEC, and of course be connected via HDMI to a device also supporting CEC. You can purchase a [USB CEC adapter](https://www.pulse-eight.com/p/104/usb-hdmi-cec-adapter) to add support if necessary. Note that all Raspberry Pi models support CEC natively. -### {% linkable_title libcec %} +### libcec [libcec](https://github.com/Pulse-Eight/libcec) must be installed for this integration to work. Follow the installation instructions for your environment, provided at the link. `libcec` installs Python 3 bindings by default as a system Python module. If you are running Home Assistant in a [Python virtual environment](/docs/installation/virtualenv/), make sure it can access the system module, by either symlinking it or using the `--system-site-packages` flag. @@ -33,7 +33,7 @@ The computer running Home Assistant must support CEC, and of course be connected If you are using [Hass.io](/hassio/) then just move forward to the configuration as all requirements are already fulfilled.

-#### {% linkable_title Symlinking into virtual environment %} +#### Symlinking into virtual environment Create a symlink to the `cec` installation including the _cec.so file. Keep in mind different installation methods will result in different locations of cec. @@ -43,7 +43,7 @@ $ ln -s /path/to/your/installation/of/_cec.so /path/to/your/venv/lib/python*/sit ``` -##### {% linkable_title Symlinking examples: %} +##### Symlinking examples: For the default virtual environment of a [HASSbian Image for Raspberry Pi](/docs/installation/raspberry-pi/) the command would be as follows. @@ -57,7 +57,7 @@ $ ln -s /usr/local/lib/python*/dist-packages/_cec.so /srv/homeassistant/lib/pyth `* failed to open vchiq instance` you will also need to add the user account Home Assistant runs under, to the `video` group. To add the Home Assistant user account to the `video` group, run the following command. `$ usermod -a -G video `

-## {% linkable_title Testing your installation %} +## Testing your installation * Login to Raspberry Pi @@ -92,7 +92,7 @@ language: ???

`address:` entry above this will be used to configure Home Assistant, this address is represented below as 3: BlueRay player.

-## {% linkable_title Configuration Example %} +## Configuration Example In the following example, a Pi Zero running Home Assistant is on a TV's HDMI port 1. HDMI port 2 is attached to a AV receiver. Three devices are attached to the AV receiver on HDMI ports 1 through 3. @@ -147,9 +147,9 @@ hdmi_cec: ``` -## {% linkable_title Services %} +## Services -### {% linkable_title Select Device %} +### Select Device Call the `hdmi_cec.select_device` service with the name of the device from config or entity_id or physical address"to select it, for example: @@ -174,7 +174,7 @@ action: device: Chromecast ``` -### {% linkable_title Power On %} +### Power On Call the `hdmi_cec.power_on` service (no arguments) to power on any devices that support this function. @@ -185,7 +185,7 @@ action: service: hdmi_cec.power_on ``` -### {% linkable_title Standby %} +### Standby Call the `hdmi_cec.standby` service (no arguments) to place in standby any devices that support this function. @@ -196,11 +196,11 @@ action: service: hdmi_cec.standby ``` -### {% linkable_title Change volume level %} +### Change volume level Call the `hdmi_cec.volume` service with one of following commands: -#### {% linkable_title Volume up %} +#### Volume up Increase volume three times: ```json @@ -219,7 +219,7 @@ Stop increasing volume: {"up": "release"} ``` -#### {% linkable_title Volume down %} +#### Volume down Decrease volume three times: ```json @@ -238,7 +238,7 @@ Stop decreasing volume: {"down": "release"} ``` -#### {% linkable_title Volume mute %} +#### Volume mute Toggle mute: ```json @@ -248,7 +248,7 @@ Toggle mute: value is ignored. -## {% linkable_title Useful References %} +## Useful References * [CEC overview](http://wiki.kwikwai.com/index.php?title=The_HDMI-CEC_bus) * [CEC-o-matic](http://www.cec-o-matic.com/) diff --git a/source/_components/heos.markdown b/source/_components/heos.markdown index 44e9a75690f..d3462afa07e 100644 --- a/source/_components/heos.markdown +++ b/source/_components/heos.markdown @@ -22,7 +22,7 @@ The HEOS integration adds support for [HEOS](http://heosbydenon.denon.com) capab - Clear playlist - Select source from device physical inputs and HEOS favorites -## {% linkable_title Configuration %} +## Configuration HEOS devices are discovered and setup automatically when the [discovery](/components/discovery) integration is enabled. Alternatively, the integration can be setup through the frontend control panel integrations page or manually by adding the following to your `configuration.yaml` file: @@ -43,9 +43,9 @@ host: A connection to a single device enables control for all devices on the network. If you have multiple HEOS devices, enter the host of one that is connected to the LAN via wire or has the strongest wireless signal.

-## {% linkable_title Services %} +## Services -### {% linkable_title Service `heos.sign_in` %} +### Service `heos.sign_in` Use the sign-in service to sign the connected controller into a HEOS account so that it can retreive and play HEOS favorites and playlists. An error message is logged if sign-in is unsuccessful. Example service data payload: @@ -61,13 +61,13 @@ Use the sign-in service to sign the connected controller into a HEOS account so | `username` | The username or email of the HEOS account. [Required] | `password` | The password of the HEOS account. [Required] -### {% linkable_title Service `heos.sign_out` %} +### Service `heos.sign_out` Use the sign-out service to sign the connected controller out of a HEOS account. An error message is logged if sign-out is unsuccessful. There are no parameters to this service. -### {% linkable_title Service `media_player.play_media` %} +### Service `media_player.play_media` -#### {% linkable_title Play Favorite %} +#### Play Favorite You can play a HEOS favorite by number or name with the `media_player.play_media` service. Example service data payload: @@ -85,7 +85,7 @@ You can play a HEOS favorite by number or name with the `media_player.play_media | `media_content_type` | Set to the value `playlist` | `media_content_id` | The nubmer (i.e. `1`) or name (i.e. `Thumbprint Radio`) of the HEOS favorite -#### {% linkable_title Play Playlist %} +#### Play Playlist You can play a HEOS playlist with the `media_player.play_media` service. Example service data payload: @@ -103,7 +103,7 @@ You can play a HEOS playlist with the `media_player.play_media` service. Example | `media_content_type` | Set to the value `playlist` | `media_content_id` | The name of the HEOS playlist -#### {% linkable_title Play Quick Select %} +#### Play Quick Select You can play a HEOS Quick Select by nubmer or name with the `media_player.play_media` service. Example service data payload: @@ -121,7 +121,7 @@ You can play a HEOS Quick Select by nubmer or name with the `media_player.play_m | `media_content_type` | Set to the value `quick_select` | `media_content_id` | The quick select number (i.e. `1`) or name (i.e. `Quick Select 1`) -#### {% linkable_title Play Url %} +#### Play Url You can play a URL through a HEOS media player using the `media_player.play_media` service. The HEOS player must be able to reach the URL. Example service data payload: @@ -139,14 +139,14 @@ You can play a URL through a HEOS media player using the `media_player.play_medi | `media_content_type` | Set to the value `url` | `media_content_id` | The full URL to the stream -## {% linkable_title Notes %} +## Notes - HEOS groups are not currently supported. - Receivers with multiple zones are represented as a single media player. They will be turned on when playback is started, but cannot be turned off by the integration at this time. -## {% linkable_title Troubleshooing %} +## Troubleshooing -### {% linkable_title Debugging %} +### Debugging The HEOS integration will log additional information about commands, events, and other messages when the log level is set to `debug`. Add the the relevent line below to the `configuration.yaml` to enable debug logging: @@ -158,7 +158,7 @@ logger: pyheos: debug ``` -### {% linkable_title Missing Favorites %} +### Missing Favorites If the HEOS controller is not signed in to a HEOS account, HEOS favorites will not be populated in the media player source selection and the service `media_player.play_media` for `favorite` and `playlist` will fail. Additionally, the following warning will be logged at startup: > IP_ADDRESS is not logged in to a HEOS account and will be unable to retrieve HEOS favorites: Use the 'heos.sign_in' service to sign-in to a HEOS account diff --git a/source/_components/hikvision.markdown b/source/_components/hikvision.markdown index b59068d4517..15d91c1014a 100644 --- a/source/_components/hikvision.markdown +++ b/source/_components/hikvision.markdown @@ -64,7 +64,7 @@ and has been confirmed to work with the following models: - DS-2CD2142FWD-I - DS-2CD2155FWD-IS -## {% linkable_title Configuration %} +## Configuration To enable this sensor, add the following lines are required in your `configuration.yaml` file: @@ -128,7 +128,7 @@ customize: default: 5 {% endconfiguration %} -### {% linkable_title Supported types %} +### Supported types Supported sensor/event types are: @@ -149,7 +149,7 @@ Supported sensor/event types are: - Face Detection - Scene Change Detection -## {% linkable_title Examples %} +## Examples Example of a configuration in your `configuration.yaml` that utilizes the customize options for a camera: diff --git a/source/_components/hipchat.markdown b/source/_components/hipchat.markdown index e06733ebd7d..97cac0dceb0 100644 --- a/source/_components/hipchat.markdown +++ b/source/_components/hipchat.markdown @@ -73,7 +73,7 @@ host: type: string {% endconfiguration %} -### {% linkable_title HipChat service data %} +### HipChat service data The following attributes can be placed `data` for extended functionality. diff --git a/source/_components/history.markdown b/source/_components/history.markdown index 3bb947defd4..56839afa3b3 100644 --- a/source/_components/history.markdown +++ b/source/_components/history.markdown @@ -142,7 +142,7 @@ history: - light.front_porch ``` -#### {% linkable_title Implementation details %} +#### Implementation details The history is stored in a SQLite database `home-assistant_v2.db` within your configuration directory unless the `recorder` integration is set up differently. @@ -160,7 +160,7 @@ configuration directory unless the `recorder` integration is set up differently. When the `history` integration queries the states table it only selects states where the state has changed: `WHERE last_changed=last_updated` -#### {% linkable_title On dates %} +#### On dates SQLite databases do not support native dates. That's why all the dates are saved in seconds since the UNIX epoch. Convert them manually using @@ -171,7 +171,7 @@ from datetime import datetime datetime.fromtimestamp(1422830502) ``` -#### {% linkable_title API %} +#### API The history information is also available through the [RESTful API](/developers/rest_api/#get-apihistory). diff --git a/source/_components/history_graph.markdown b/source/_components/history_graph.markdown index e7d5ca6d87f..c4d89a29d40 100644 --- a/source/_components/history_graph.markdown +++ b/source/_components/history_graph.markdown @@ -53,7 +53,7 @@ refresh: type: integer {% endconfiguration %} -### {% linkable_title Full Example %} +### Full Example ```yaml # Full configuration.yaml entry diff --git a/source/_components/history_stats.markdown b/source/_components/history_stats.markdown index 9d2fa83b8a0..9e0ded8b066 100644 --- a/source/_components/history_stats.markdown +++ b/source/_components/history_stats.markdown @@ -27,7 +27,7 @@ Examples of what you can track: - How long the lights were ON yesterday - How long you watched TV today -## {% linkable_title Configuration %} +## Configuration To enable the history statistics sensor, add the following lines to your `configuration.yaml`: @@ -84,7 +84,7 @@ duration: You can use [template extensions](/topics/templating/#home-assistant-template-extensions) such as `now()` or `as_timestamp()` to handle dynamic dates, as shown in the examples below.

-## {% linkable_title Sensor type %} +## Sensor type Depending on the sensor type you choose, the `history_stats` integration can show different values: @@ -92,7 +92,7 @@ Depending on the sensor type you choose, the `history_stats` integration can sho - **ratio**: The tracked time divided by the length of your period, as a percentage - **count**: How many times the integration you track was changed to the state you track -## {% linkable_title Time periods %} +## Time periods The `history_stats` integration will execute a measure within a precise time period. You should always provide 2 of the following : - When the period starts (`start` variable) @@ -101,7 +101,7 @@ The `history_stats` integration will execute a measure within a precise time per As `start` and `end` variables can be either datetimes or timestamps, you can configure almost any period you want. -### {% linkable_title Duration %} +### Duration The duration variable is used when the time period is fixed. Different syntaxes for the duration are supported, as shown below. @@ -123,7 +123,7 @@ duration: minutes: 30 ``` -### {% linkable_title Examples %} +### Examples Here are some examples of periods you could work with, and what to write in your `configuration.yaml`: diff --git a/source/_components/hive.markdown b/source/_components/hive.markdown index a32aaaeafc1..1085481707e 100644 --- a/source/_components/hive.markdown +++ b/source/_components/hive.markdown @@ -62,7 +62,7 @@ scan_interval: default: 2 {% endconfiguration %} -## {% linkable_title Binary Sensor %} +## Binary Sensor The `hive` binary sensor integration integrates your Hive sensors into Home Assistant. @@ -71,7 +71,7 @@ The platform supports the following Hive products: - Hive Window or Door Sensor - Hive Motion Sensor -## {% linkable_title Climate %} +## Climate The `hive` climate platform integrates your Hive thermostat and hot water into Home Assistant, enabling control of setting the **mode** and setting the **target temperature**. @@ -83,7 +83,7 @@ The platform supports the following Hive products: - Hive Multizone - Hot water control -## {% linkable_title Light %} +## Light The `hive` light platform integrates your Hive lights into Home Assistant, enabling control of various settings, depending on the model light. @@ -93,7 +93,7 @@ The platform supports the following Hive products: - Hive Active Light Cool to Warm White - Hive Active Light Color Changing -## {% linkable_title Sensor %} +## Sensor The `hive` sensor integration exposes Hive data as a sensor. @@ -102,7 +102,7 @@ The platform exposes the following sensors: - Hive Hub Online Status - Hive Outside Temperature -## {% linkable_title Switch %} +## Switch The `hive` switch platform integrates your Hive plugs into Home Assistant, enabling control of your devices. diff --git a/source/_components/homekit.markdown b/source/_components/homekit.markdown index bcbc32d7358..fea03fdaa12 100644 --- a/source/_components/homekit.markdown +++ b/source/_components/homekit.markdown @@ -150,7 +150,7 @@ homekit: {% endconfiguration %} -## {% linkable_title Setup %} +## Setup To enable the HomeKit integration in Home Assistant, add the following to your configuration file: @@ -171,29 +171,29 @@ After Home Assistant has started, the entities specified by the filter are expos After the setup is completed, you should be able to control your Home Assistant integrations through Apple's Home and Siri. -## {% linkable_title Move Home Assistant install %} +## Move Home Assistant install If you like to retain your HomeKit pairing through a move to a new Home Assistant device or installation, besides copying the configurations files you need to copy the `.homekit.state` file inside your configurations directory. Keep in mind though that the file is usually hidden by default, depending on your operating system. Before you copy it, make sure to stop the old and new Home Assistant instances first entirely, otherwise it won't work. -## {% linkable_title Considerations %} +## Considerations -### {% linkable_title Accessory ID %} +### Accessory ID Currently, this integration uses the `entity_id` to generate a unique `accessory id (aid)` for `HomeKit`. The `aid` is used to identify a device and save all configurations made for it. This, however, means that if you decide to change an `entity_id` all configurations for this accessory made in the `Home` app will be lost. -### {% linkable_title Device Limit %} +### Device Limit The HomeKit guidelines only allow a maximum of 100 unique accessories (`aid`) per bridge. Be mindful of this when configuring the filter(s). -### {% linkable_title Persistence Storage %} +### Persistence Storage Unfortunately `HomeKit` doesn't support any persistent storage - only the configuration for accessories that are added to the `Home Assistant Bridge` are kept. To avoid problems, it is recommended to use an automation to always start `HomeKit` with at least the same entities setup. If for some reason some entities are not set up, their config will be deleted. (State unknown or similar will not cause any issues.) A common situation might be if you decide to disable parts of the configuration for testing. Please make sure to disable `auto start` and `turn off` the `Start HomeKit` automation (if you have one). -## {% linkable_title Disable Auto Start %} +## Disable Auto Start Depending on your setup, it might be necessary to disable `Auto Start` for all accessories to be available for `HomeKit`. Only those entities that are fully set up when the `HomeKit` integration is started, can be added. To start `HomeKit` when `auto_start: false`, you can call the service `homekit.start`. @@ -271,7 +271,7 @@ automation: ``` {% endraw %} -## {% linkable_title Configure Filter %} +## Configure Filter By default, no entity will be excluded. To limit which entities are being exposed to `HomeKit`, you can use the `filter` parameter. Keep in mind only [supported components](#supported-components) can be added. @@ -305,7 +305,7 @@ Filters are applied as follows: - if entity is included, pass (as #2 above) - if entity include and exclude, the entity exclude is ignored -## {% linkable_title Safe Mode %} +## Safe Mode The `safe_mode` option should only be used (and only works) if you encounter issues during the pairing. ([Paring hangs - zeroconf error](#pairing-hangs---zeroconf-error)). @@ -322,7 +322,7 @@ Restart your Home Assistant instance. If you don't see a `pincode`, follow the [ To avoid any errors, after you have successfully paired your Home Assistant Bridge, remove the `safe_mode` option from your config and restart Home Assistant.

-## {% linkable_title Supported Components %} +## Supported Components The following integrations are currently supported: @@ -352,9 +352,9 @@ The following integrations are currently supported: | switch | Switch | Represented as a switch by default but can be changed by using `type` within `entity_config`. | | water_heater | WaterHeater | All water_heater devices. | -## {% linkable_title Troubleshooting %} +## Troubleshooting -### {% linkable_title Deleting the `.homekit.state` file %} +### Deleting the `.homekit.state` file The `.homekit.state` file can be found in the configurations directory. You might need to enable `view hidden files` to see it. @@ -362,7 +362,7 @@ The `.homekit.state` file can be found in the configurations directory. You migh 2. Delete the `.homekit.state` file 3. **Start** Home Assistant -### {% linkable_title Errors during pairing %} +### Errors during pairing If you encounter any issues during pairing, make sure to: @@ -384,11 +384,11 @@ homekit: - demo.demo ``` -#### {% linkable_title PIN doesn't appear as persistent status %} +#### PIN doesn't appear as persistent status You might have paired the `Home Assistant Bridge` already. If not, delete the `.homekit.state` file ([guide](#deleting-the-homekitstate-file)). -#### {% linkable_title `Home Assistant Bridge` doesn't appear in the Home App (for pairing) %} +#### `Home Assistant Bridge` doesn't appear in the Home App (for pairing) This is often setup and network related. Make sure to check the other issues below as well, but things that might work include: - Check your router configuration @@ -397,73 +397,73 @@ This is often setup and network related. Make sure to check the other issues bel Remember that the iOS device needs to be in the same local network as the Home Assistant device for paring. -#### {% linkable_title `Home Assistant Bridge` doesn't appear in the Home App (for pairing) - Docker %} +#### `Home Assistant Bridge` doesn't appear in the Home App (for pairing) - Docker Set `network_mode: host`. If you have further problems this [issue](https://github.com/home-assistant/home-assistant/issues/15692) might help. -#### {% linkable_title `Home Assistant Bridge` doesn't appear in the Home App (for pairing) - VirtualBox %} +#### `Home Assistant Bridge` doesn't appear in the Home App (for pairing) - VirtualBox Configure the network mode as `networkbridge`. Otherwise the Home Assistant Bridge won't be exposed to the network. -#### {% linkable_title Pairing hangs - zeroconf error %} +#### Pairing hangs - zeroconf error Pairing eventually fails, you might see and an error message `NonUniqueNameException`. Add the `safe_mode` option to your config, see [safe_mode](#safe-mode). -#### {% linkable_title Pairing hangs - only works with debug config %} +#### Pairing hangs - only works with debug config Pairing works fine when the filter is set to only include `demo.demo`, but fails with normal config. See [specific entity doesn't work](#specific-entity-doesnt-work) -#### {% linkable_title Pairing hangs - no error %} +#### Pairing hangs - no error 1. Make sure that you don't try to add more than 100 accessories, see [device limit](#device-limit). In rare cases, one of your entities doesn't work with the HomeKit component. Use the [filter](#configure-filter) to find out which one. Feel free to open a new issue in the `home-assistant` repo, so we can resolve it. 2. Check logs, and search for `Starting accessory Home Assistant Bridge on address`. Make sure Home Assistant Bridge hook ups to a correct interface. If it did not, explicitly set `homekit.ip_address` configuration variable. -#### {% linkable_title Duplicate AID found when attempting to add accessory %} +#### Duplicate AID found when attempting to add accessory Two of your entities share the same `entity_id`. Either resolve this or configure the [filter](#configure-filter) to exclude them. -### {% linkable_title Issues during normal use %} +### Issues during normal use -#### {% linkable_title Some of my devices don't show up - Z-Wave / Discovery %} +#### Some of my devices don't show up - Z-Wave / Discovery See [disable auto start](#disable-auto-start) -#### {% linkable_title My entity doesn't show up %} +#### My entity doesn't show up Check if the domain of your entity is [supported](#supported-components). If it is, check your [filter](#configure-filter) settings. Make sure the spelling is correct, especially if you use `include_entities`. -#### {% linkable_title HomeKit doesn't work on second Home Assistant instance %} +#### HomeKit doesn't work on second Home Assistant instance To use the HomeKit integration with to different Home Assistant instances on the same local network, you need to set a custom name for at least one of them. [config/name](#name) -#### {% linkable_title Specific entity doesn't work %} +#### Specific entity doesn't work Although we try our best, some entities don't work with the HomeKit integration yet. The result will be that either pairing fails completely or all Home Assistant accessories will stop working. Use the filter to identify which entity is causing the issue. It's best to try pairing and step by step including more entities. If it works unpair and repeat until you find the one that is causing the issues. To help others and the developers, please open a new issue here: [home-assistant/issues/new](https://github.com/home-assistant/home-assistant/issues/new?labels=component: homekit) -#### {% linkable_title Accessories are all listed as not responding %} +#### Accessories are all listed as not responding See [specific entity doesn't work](#specific-entity-doesnt-work) -#### {% linkable_title Accessory not responding - after restart or update %} +#### Accessory not responding - after restart or update See [device limit](#device-limit) -#### {% linkable_title Accessory not responding - randomly %} +#### Accessory not responding - randomly Unfortunately, that sometimes happens at the moment. It might help to close the `Home` App and delete it from the cache. Usually, the accessory should get back to responding after a few minutes at most. -#### {% linkable_title Accessories not responding / behaving unusual - Upgrade from `0.65.x` %} +#### Accessories not responding / behaving unusual - Upgrade from `0.65.x` To fix this, you need to unpair the `Home Assistant Bridge`, delete the `.homekit.state` file ([guide](#deleting-the-homekitstate-file)) and pair it again. This should only be an issue if you're upgrading from `0.65.x` or below. -#### {% linkable_title The linked battery sensor isn't recognized %} +#### The linked battery sensor isn't recognized Try removing the entity from HomeKit and then adding it again. If you are adding this config option to an existing entity in HomeKit, any changes you make to this entity's config options won't appear until the accessory is removed from HomeKit and then re-added. -#### {% linkable_title My media player is not showing up as a television accessory %} +#### My media player is not showing up as a television accessory Media Player entities with `device_class: tv` will show up as Television accessories on devices running iOS 12.2/macOS 10.14.4 or later. If needed, try removing the entity from HomeKit and then adding it again, especially if the `media_player` was previously exposed as a series of switches. Any changes, including changed supported features, made to an existing accessory won't appear until the accessory is removed from HomeKit and then re-added. -#### {% linkable_title Can't control volume of your TV media player? %} +#### Can't control volume of your TV media player? The volume and play/pause controls will show up on the Remote app or Control Center. If your TV supports volume control through Home Assistant, you will be able to control the volume using the side volume buttons on the device while having the remote selected on screen. diff --git a/source/_components/homematic.markdown b/source/_components/homematic.markdown index f8d42285939..d336247b126 100644 --- a/source/_components/homematic.markdown +++ b/source/_components/homematic.markdown @@ -185,7 +185,7 @@ homematic: ``` -### {% linkable_title The `resolvenames` option %} +### The `resolvenames` option We use three approaches to fetch the names of devices. Each assumes you have properly named your devices in your existing Homematic setup. As a general advice: Use ASCII for your devices names. Home Assistant won't include non-ASCII characters in entity-names. @@ -195,13 +195,13 @@ We use three approaches to fetch the names of devices. Each assumes you have pro Resolving names can take some time. So when you start Home Assistant you won't see you devices at first. For a setup with 20+ devices it can take up to a minute until all devices show up in the UI. -### {% linkable_title Multiple hosts %} +### Multiple hosts In order to allow communication with multiple hosts or different protocols in parallel (wireless, wired and ip), multiple connections will be established, each to the configured destination. The name you choose for the host has to be unique and limited to ASCII letters. Using multiple hosts has the drawback, that the services (explained below) may not work as expected. Only one connection can be used for services, which limits the devices/variables a service can use to the scope/protocol of the host. This does *not* affect the entities in Home Assistant. They all use their own connection and work as expected. -### {% linkable_title Reading attributes of entities %} +### Reading attributes of entities Most devices have, besides their state, additional attributes like their battery state or valve position. These can be accessed using templates in automations, or even as their own entities using the [template sensor](/components/sensor.template/) component. Here's an example of a template sensor that exposes the valve state of a thermostat. @@ -215,20 +215,20 @@ sensor: friendly_name: 'Bedroom valve' ``` -### {% linkable_title Variables %} +### Variables It is possible to read and set values of system variables you have setup on the CCU/Homegear. The supported types for setting values are float- and bool-variables. With the CCU a user with Admin-access is required. The states of the variables are available through the attributes of your hub entity (e.g., `homematic.ccu2`). Use templates (as mentioned above) to make your variables available to automations or as entities. The values of variables are polled from the CCU/Homegear in an interval of 30 seconds. Setting the value of a variable happens instantly and is directly pushed. -### {% linkable_title Events %} +### Events When HomeMatic devices change their state or some other internal value, the CCU/Homegear sends event messages to Home Assistant. These events are automatically parsed and the entities in Home Assistant are updated. However, you can also manually use these events to trigger automations. Two event-types are available: - **homematic.keypress**: For devices with buttons, see information below - **homematic.impulse**: For impulse sensors -#### {% linkable_title Devices with buttons %} +#### Devices with buttons Devices with buttons (e.g., HM-Sen-MDIR-WM55, remote controls) may not be fully visible in the UI. This is intended, as buttons don't serve any value here and all they do is trigger events. As an example: @@ -263,7 +263,7 @@ You can test whether your button works within Home Assistant if you look at the It may happen that "your_nice_name" is not resolved correctly; the according message (#2 in the above example) will be missing. This might be due to secure communication between your HM interface and the HM device. You can change the communication from "secure" to "standard" within your HM-interface to solve that issue (in "Einstellungen" - "Geräte" find your device and change "Übertragungsmodus" from secure to standard) - not recommended for devices that should have secure communication. -#### {% linkable_title `homematic.keypress` events for HomeMatic IP devices %} +#### `homematic.keypress` events for HomeMatic IP devices To get the `homematic.keypress` event for some HomeMatic IP devices like WRC2 / WRC6 (wall switch) or SPDR (passage sensor) or the KRC4 (key ring remote control) you have to temporary create an empty program for each channel in the CCU: @@ -277,7 +277,7 @@ To get the `homematic.keypress` event for some HomeMatic IP devices like WRC2 / 8. When your channel is working now, you can edit it to select the other channels one by one 9. At the end, you can delete this program from the CCU -### {% linkable_title Services %} +### Services - *homematic.virtualkey*: Simulate a keypress (or other valid action) on CCU/Homegear with device or virtual keys. - *homematic.reconnect*: Reconnect to CCU/Homegear without restarting Home Assistant (useful when CCU has been restarted) @@ -285,7 +285,7 @@ To get the `homematic.keypress` event for some HomeMatic IP devices like WRC2 / - *homematic.set_device_value*: Control a device manually (even devices without support). Equivalent to setValue-method from XML-RPC. - *homematic.put_paramset*: Manually change a device's paramset (even devices without support). Equivalent to putParamset-method from XML-RPC. -#### {% linkable_title Examples %} +#### Examples Simulate a button being pressed: @@ -323,7 +323,7 @@ action: value: true ``` -#### {% linkable_title Advanced examples %} +#### Advanced examples If you are familiar with the internals of HomeMatic devices, you can manually set values on the devices. This can serve as a workaround if support for a device is currently not available, or only limited functionality has been implemented. Using this service provides you direct access to the setValue-method of the primary connection. If you have multiple hosts, you may select the one hosting a specific device by providing the proxy-parameter with a value equivalent to the name you have chosen. In the example configuration from above `rf`, `wired` and `ip` would be valid values. @@ -400,7 +400,7 @@ action: entity_id: lock.leq1234567 ``` -#### {% linkable_title Detecting lost connections %} +#### Detecting lost connections When the connection to your HomeMatic CCU or Homegear is lost, Home Assistant will stop getting updates from devices. This may happen after rebooting the CCU for example. Due to the nature of the communication protocol this cannot be handled automatically, so you must call *homematic.reconnect* in this case. That's why it is usually a good idea to check if your HomeMatic integrations are still updated properly, in order to detect connection losses. This can be done in several ways through an automation: @@ -470,13 +470,13 @@ When the connection to your HomeMatic CCU or Homegear is lost, Home Assistant wi service: homematic.reconnect ``` -## {% linkable_title Notifications %} +## Notifications The `homematic` notification platform enables invoking Homematic devices. To use this notification platform in your installation, add the following to your `configuration.yaml` file: -## {% linkable_title Configuration %} +## Configuration ```yaml # Example configuration.yaml entry @@ -512,7 +512,7 @@ value: type: string {% endconfiguration %} -### {% linkable_title Usage %} +### Usage `homematic` is a notify platform and can be controlled by calling the notify service [as described here](/components/notify/). diff --git a/source/_components/homematicip_cloud.markdown b/source/_components/homematicip_cloud.markdown index 800872f7269..23920f15f44 100644 --- a/source/_components/homematicip_cloud.markdown +++ b/source/_components/homematicip_cloud.markdown @@ -42,7 +42,7 @@ There is currently support for the following device types within Home Assistant: * Switch * Weather -## {% linkable_title Setup the integration via the frontend %} +## Setup the integration via the frontend Menu: *Configuration* -> *Integrations* @@ -53,7 +53,7 @@ Fill the form: The authentification token will be generated and stored internally. -## {% linkable_title Setup the integration using the configuration files %} +## Setup the integration using the configuration files Generate the authentication token: @@ -85,7 +85,7 @@ authtoken: type: string {% endconfiguration %} -## {% linkable_title Implemented and tested devices %} +## Implemented and tested devices * homematicip_cloud.alarm_control_panel * Combined Alarm Control Panal with INTERNAL and EXTERNAL Security zones (*HmIP-SecurityZone*) diff --git a/source/_components/homeworks.markdown b/source/_components/homeworks.markdown index 8ac001abbff..b2b2ce3c420 100644 --- a/source/_components/homeworks.markdown +++ b/source/_components/homeworks.markdown @@ -26,7 +26,7 @@ Lutron has created many systems over the years, each with their own unique inter Homeworks keypad buttons are momentary switches. The button is pressed and released, meaning that there is no "state". Buttons generate `homeworks_button_press` and `homeworks_button_release` events. These events contain the "id", "name", and "button" of the button that was pressed. "id" is derived from "name", and "button" is the number of the button on the keypad (starting at 1). -## {% linkable_title Configuration %} +## Configuration The protocol for automatically extracting device information from the controller isn't documented, so the `homeworks` integration must be configured manually. To use Lutron Homeworks devices in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/honeywell.markdown b/source/_components/honeywell.markdown index 3c50ddaefe5..6a738563fd4 100644 --- a/source/_components/honeywell.markdown +++ b/source/_components/honeywell.markdown @@ -24,13 +24,13 @@ There is some potential confusion over this integration because it is currently These two regions are _not_ interchangeable, so you must be clear which applies to your climate system.

-## {% linkable_title US-based Systems %} +## US-based Systems These systems are based in North America, and temperatures are usually in Fahrenheit. They would likely be HVAC systems. They always use the [somecomfort](https://github.com/kk7ds/somecomfort) client library. In this integration, this is called the `us` region. If your system is US-based, then you can access your system via [https://mytotalconnectcomfort.com/portal/](https://mytotalconnectcomfort.com/portal/) (note the `/portal/`). -## {% linkable_title EU-based Systems %} +## EU-based Systems These systems are based in Europe (including the UK & Ireland), and temperatures are usually in Celsius. They would likely be heating-only systems. They always use the [evohome-client](https://github.com/watchforstock/evohome-client) client library. In this integration, this is called the `eu` region. @@ -38,7 +38,7 @@ If your system is US-based, then you can access it via [https://international.my The `eu` region is soon to be deprecated, and ongoing support for such systems is available via the [evohome](/components/evohome/) integration. -## {% linkable_title Configuration %} +## Configuration To set up this integration, first confirm your region, then add the following information to your **configuration.yaml** file (the below example is for US-based systems): diff --git a/source/_components/hook.markdown b/source/_components/hook.markdown index 2b23bf0bed1..a7fe81ed0d1 100644 --- a/source/_components/hook.markdown +++ b/source/_components/hook.markdown @@ -23,7 +23,7 @@ In short, Hook is an RF to Wi-Fi bridge, controlling devices that receive comman Hook provides a simple [REST API](https://app.swaggerhub.com/api/rahilj/GetHook_RestAPI/v1). This Home Assistant integration reads in devices that have been set up in the official app. -## {% linkable_title Configuration %} +## Configuration Configure with either your username/password or your API token for the official app. diff --git a/source/_components/horizon.markdown b/source/_components/horizon.markdown index fea3cf69fb4..5839379b7bc 100644 --- a/source/_components/horizon.markdown +++ b/source/_components/horizon.markdown @@ -43,6 +43,6 @@ media_player: {% endconfiguration %} -#### {% linkable_title Preparation of the Horizon HD Recorder %} +#### Preparation of the Horizon HD Recorder The Home Networking ("Heimnetzwerk") service needs to be enabled at the settings menu of the Horizon receiver. Once you have set up the Media Library ("Medienbibliothek"), we can determine whether the device is turned on or off. Without this, the integration will fail to start. diff --git a/source/_components/hp_ilo.markdown b/source/_components/hp_ilo.markdown index fdd982b7fe2..0300a457a52 100644 --- a/source/_components/hp_ilo.markdown +++ b/source/_components/hp_ilo.markdown @@ -26,7 +26,7 @@ Some more details about what can be retrieved from these sensors is available in

-## {% linkable_title Configuration %} +## Configuration To use this integration in your installation, add the following to your `configuration.yaml` file: @@ -97,7 +97,7 @@ Valid sensor_types: - **server_health**: Get server health information. - **network_settings**: Get the iLO network settings. -## {% linkable_title Example %} +## Example In order to get two sensors reporting CPU fan speed and Ambient Inlet Temperature, as well as a dump of `server_health` on a HP Microserver Gen8, you could use the following in your `configuration.yaml` file @@ -125,13 +125,13 @@ sensor:

-## {% linkable_title Hardware specifics %} +## Hardware specifics

Not every hardware supports all values.

-### {% linkable_title HP Microserver Gen8 %} +### HP Microserver Gen8 On this hardware you should avoid using the following sensor_types as `monitored_variables:` to prevent errors. diff --git a/source/_components/html5.markdown b/source/_components/html5.markdown index 6e9035f00ce..7e1e63c2c14 100644 --- a/source/_components/html5.markdown +++ b/source/_components/html5.markdown @@ -25,7 +25,7 @@ HTML5 push notifications **do not** work on iOS. The GCM configuration option is deprecated and will stop working in April 2019, see [https://developers.google.com/cloud-messaging/faq](https://developers.google.com/cloud-messaging/faq). If you are installing this platform for the first time, follow the VAPID configuration steps. To migrate your current installation from GCM to VAPID configuration, follow the instructions below. You can skip the first 3 steps and continue in step 4 with your existing project. You will also need to delete `html5_push_registrations.conf` and [re-enable the notifications in your browser](#setting-up-your-browser).

-## {% linkable_title Configuration %} +## Configuration To enable this platform, add the following lines to your `configuration.yaml` file: @@ -79,7 +79,7 @@ gcm_sender_id: type: string {% endconfiguration %} -### {% linkable_title Requirements %} +### Requirements The `html5` platform can only function if all of the following requirements are met: @@ -90,7 +90,7 @@ The `html5` platform can only function if all of the following requirements are * You have configured SSL/TLS for your Home Assistant. It doesn't need to be configured in Home Assistant though, e.g., you can be running [NGINX](/ecosystem/nginx/) in front of Home Assistant and this will still work. The certificate must be trustworthy (i.e. not self signed). * You are willing to accept the notification permission in your browser. -### {% linkable_title Configuring the platform %} +### Configuring the platform 1. Make sure you can access your Home Assistant installation from outside your network over HTTPS ([see docs](/docs/configuration/remote/)). 2. Create a new project at [https://console.cloud.google.com/home/dashboard](https://console.cloud.google.com/home/dashboard). @@ -100,7 +100,7 @@ The `html5` platform can only function if all of the following requirements are 6. Select 'Cloud Messaging' tab. 7. Generate a new key pair under the Web configuration listing at the bottom of the page. To view the private key click the three dots to the right and 'Show private key'. -### {% linkable_title Setting up your browser %} +### Setting up your browser Assuming you have already configured the platform: @@ -113,7 +113,7 @@ Assuming you have already configured the platform: **Note:** If you aren't prompted for a device name when enabling notifications, open the `html5_push_registrations.conf` file in your configuration directory. You will see a new entry for the browser you just added. Rename it from `unnamed device` to a name of your choice, which will make it easier to identify later. _Do not change anything else in this file!_ You need to restart Home Assistant after making any changes to the file. -### {% linkable_title Testing %} +### Testing Assuming the previous test completed successfully and your browser was registered, you can test the notification as follows: @@ -123,12 +123,12 @@ Assuming the previous test completed successfully and your browser was registere 4. In the Service Data text box enter: `{"message":"hello world"}`, then press the CALL SERVICE button. 5. If everything worked you should see a popup notification. -### {% linkable_title Usage %} +### Usage The `html5` platform accepts a standard notify payload. However, there are also some special features built in which you can control in the payload. -#### {% linkable_title Actions %} +#### Actions Chrome supports notification actions, which are configurable buttons that arrive with the notification and can cause actions on Home Assistant to happen when pressed. You can send up to 2 actions. @@ -143,7 +143,7 @@ data: title: Open door ``` -#### {% linkable_title Data %} +#### Data Any parameters that you pass in the notify payload that aren't valid for use in the HTML5 notification (`actions`, `badge`, `body`, `dir`, `icon`, `image`, `lang`, `renotify`, `requireInteraction`, `tag`, `timestamp`, `vibrate`, `priority`, `ttl`) will be sent back to you in the [callback events](#automating-notification-events). @@ -154,7 +154,7 @@ data: my-custom-parameter: front-door-open ``` -#### {% linkable_title Tag %} +#### Tag By default, every notification sent has a randomly generated UUID (v4) set as its _tag_ or unique identifier. The tag is unique to the notification, _not_ to a specific target. If you pass your own tag in the notify payload you can replace the notification by sending another notification with the same tag. You can provide a `tag` like so: @@ -183,7 +183,7 @@ Example of adding a tag to your notification. This won't create new notification ``` {% endraw %} -#### {% linkable_title Targets %} +#### Targets If you do not provide a `target` parameter in the notify payload a notification will be sent to all registered targets as listed in `html5_push_registrations.conf`. You can provide a `target` parameter like so: @@ -203,11 +203,11 @@ target: - unnamed device 2 ``` -#### {% linkable_title Overrides %} +#### Overrides You can pass any of the parameters listed [here](https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerRegistration/showNotification#Parameters) in the `data` dictionary. Please note, Chrome specifies that the maximum size for an icon is 320px by 320px, the maximum `badge` size is 96px by 96px and the maximum icon size for an action button is 128px by 128px. -#### {% linkable_title URL %} +#### URL You can provide a URL to open when the notification is clicked by putting `url` in the data dictionary like so: @@ -220,7 +220,7 @@ data: If no URL or actions are provided, interacting with a notification will open your Home Assistant in the browser. You can use relative URLs to refer to Home Assistant, i.e. `/map` would turn into `https://192.168.1.2:8123/map`. -#### {% linkable_title TTL and Priority %} +#### TTL and Priority Newer Android versions introduced stronger battery optimization, so notifications by default are delivered only when phone is awake. Options TTL and priority tries to help users solve those problems. Default value of TTL is `86400s` and priority is `normal`. @@ -234,7 +234,7 @@ data: priority: high ``` -### {% linkable_title Dismiss %} +### Dismiss You can dismiss notifications by using service notify.html5_dismiss like so: @@ -250,7 +250,7 @@ You can dismiss notifications by using service notify.html5_dismiss like so: If no target is provided, it dismisses for all. If no tag is provided, it dismisses all notifications. -### {% linkable_title Automating notification events %} +### Automating notification events During the lifespan of a single push notification, Home Assistant will emit a few different events to the event bus which you can use to write automations against. @@ -266,7 +266,7 @@ Common event payload parameters are: You can use the `target` parameter to write automations against a single `target`. For more granularity, use `action` and `target` together to write automations which will do specific things based on what target clicked an action. -#### {% linkable_title received event %} +#### received event You will receive an event named `html5_notification.received` when the notification is received on the device. @@ -278,7 +278,7 @@ notification is received on the device. event_type: html5_notification.received ``` -#### {% linkable_title clicked event %} +#### clicked event You will receive an event named `html5_notification.clicked` when the notification or a notification action button is clicked. The action button clicked is available as `action` in the `event_data`. @@ -300,7 +300,7 @@ or action: open_door ``` -#### {% linkable_title closed event %} +#### closed event You will receive an event named `html5_notification.closed` when the notification is closed. @@ -311,7 +311,7 @@ You will receive an event named `html5_notification.closed` when the notificatio event_type: html5_notification.closed ``` -### {% linkable_title Making notifications work with NGINX proxy %} +### Making notifications work with NGINX proxy If you use [NGINX](/ecosystem/nginx/) as a proxy with authentication in front of your Home Assistant instance, you may have trouble with receiving events back to Home Assistant. It's because of authentication token that cannot be passed through the proxy. @@ -336,7 +336,7 @@ If you still have the problem, even with mentioned rule, try to add this code: proxy_pass_header Authorization; ``` -#### {% linkable_title Verify your domain %} +#### Verify your domain If you need to verify domain ownership with Google Webmaster Central/Search Console while configuring this component, follow these steps: diff --git a/source/_components/http.markdown b/source/_components/http.markdown index eeb7c4952b9..904de87d5db 100644 --- a/source/_components/http.markdown +++ b/source/_components/http.markdown @@ -128,13 +128,13 @@ The [Set up encryption using Let's Encrypt](/blog/2015/12/13/setup-encryption-us Or use a self signed certificate following the instructions here [Self-signed certificate for SSL/TLS](/docs/ecosystem/certificates/tls_self_signed_certificate/). -## {% linkable_title APIs %} +## APIs On top of the `http` integration is a [REST API](/developers/rest_api/), [Python API](/developers/python_api/) and [WebSocket API](/developers/websocket_api/) available. There is also support for [Server-sent events](/developers/server_sent_events/). The `http` platforms are not real platforms within the meaning of the terminology used around Home Assistant. Home Assistant's [REST API](/developers/rest_api/) sends and receives messages over HTTP. -## {% linkable_title HTTP sensors %} +## HTTP sensors To use those kind of [sensors](#sensor) or [binary sensors](#binary-sensor) in your installation no configuration in Home Assistant is needed. All configuration is done on the devices themselves. This means that you must be able to edit the target URL or endpoint and the payload. The entity will be created after the first message has arrived. @@ -142,7 +142,7 @@ Create a [Long-Lived Access Tokens](https://developers.home-assistant.io/docs/en All [requests](/developers/rest_api/#post-apistatesltentity_id) need to be sent to the endpoint of the device and must be **POST**. -## {% linkable_title IP filtering and banning %} +## IP filtering and banning If you want to apply additional IP filtering, and automatically ban brute force attempts, set `ip_ban_enabled` to `true` and the maximum number of attempts. After the first ban, an `ip_bans.yaml` file will be created in the root configuration folder. It will have the banned IP address and time in UTC when it was added: @@ -157,7 +157,7 @@ After a ban is added a Persistent Notification is populated to the Home Assistan Please note, that sources from `trusted_networks` won't be banned automatically.

-## {% linkable_title Hosting files %} +## Hosting files If you want to use Home Assistant to host or serve static files then create a directory called `www` under the configuration path (`/config` on Hass.io, `.homeassistant` elsewhere). The static files in `www/` can be accessed by the following URL `http://your.domain:8123/local/`, for example `audio.mp3` would be accessed as `http://your.domain:8123/local/audio.mp3`. @@ -165,7 +165,7 @@ If you want to use Home Assistant to host or serve static files then create a di If you've had to create the `www/` folder for the first time, you'll need to restart Home Assistant.

-## {% linkable_title Binary Sensor %} +## Binary Sensor The HTTP binary sensor is dynamically created with the first request that is made to its URL. You don't have to define it in the configuration first. @@ -213,11 +213,11 @@ $ curl -X GET -H "Authorization: Bearer LONG_LIVED_ACCESS_TOKEN" \ } ``` -### {% linkable_title Examples %} +### Examples In this section you'll find some real-life examples of how to use this sensor, besides `curl`, which was shown earlier. -#### {% linkable_title Using Python request module %} +#### Using Python request module As already shown on the [API](/developers/rest_api/) page, it's very simple to use Python and the [Requests](http://docs.python-requests.org/en/latest/) module for the interaction with Home Assistant. @@ -229,7 +229,7 @@ response = requests.post( print(response.text) ``` -#### {% linkable_title Using `httpie` %} +#### Using `httpie` [`httpie`](https://github.com/jkbrzt/httpie) is a user-friendly CLI HTTP client. @@ -239,7 +239,7 @@ $ http -v POST http://localhost:8123/api/states/binary_sensor.radio \ attributes:='{"friendly_name": "Radio"}' ``` -## {% linkable_title Sensor %} +## Sensor The HTTP sensor is dynamically created with the first request that is made to its URL. You don't have to define it in the configuration first. diff --git a/source/_components/htu21d.markdown b/source/_components/htu21d.markdown index a7ffd731ea3..11ad7267d31 100644 --- a/source/_components/htu21d.markdown +++ b/source/_components/htu21d.markdown @@ -22,7 +22,7 @@ Tested devices: - [Raspberry Pi](https://www.raspberrypi.org/) -## {% linkable_title Configuration %} +## Configuration To use your HTU21D sensor in your installation, add the following to your `configuration.yaml` file: @@ -45,7 +45,7 @@ i2c_bus: type: integer {% endconfiguration %} -## {% linkable_title Customizing the sensor data %} +## Customizing the sensor data Give the values friendly names and icons, add the following to your `customize:` section. @@ -72,7 +72,7 @@ group: - sensor.htu21d_sensor_humidity ``` -## {% linkable_title Directions for installing smbus support on Raspberry Pi %} +## Directions for installing smbus support on Raspberry Pi Enable I2c interface with the Raspberry Pi configuration utility: @@ -96,7 +96,7 @@ $ sudo addgroup homeassistant i2c $ sudo reboot ``` -### {% linkable_title Check the i2c address of the sensor %} +### Check the i2c address of the sensor After installing `i2c-tools`, a new utility is available to scan the addresses of the connected sensors: diff --git a/source/_components/huawei_lte.markdown b/source/_components/huawei_lte.markdown index 9a1133cc658..8df7f452a91 100644 --- a/source/_components/huawei_lte.markdown +++ b/source/_components/huawei_lte.markdown @@ -31,7 +31,7 @@ There is currently support for the following device types within Home Assistant: All platform requires you to have set up the [Huawei LTE component](#configuration). -## {% linkable_title Configuration %} +## Configuration To enable the component, add the following lines to your `configuration.yaml` file: @@ -59,7 +59,7 @@ password: type: string {% endconfiguration %} -### {% linkable_title Tested routers %} +### Tested routers Routers we know to be working with this integration based on the documentation of used libraries and reports by users: @@ -70,7 +70,7 @@ Routers we know to be working with this integration based on the documentation o This is not a complete list. The integration can probably connect to other Huawei LTE routers running similar firmware. -## {% linkable_title Presence Detection %} +## Presence Detection This platform offers presence detection by looking at connected devices to a [Huawei LTE router](https://consumer.huawei.com/en/smart-home/). @@ -84,7 +84,7 @@ device_tracker: See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked. -## {% linkable_title Notifications %} +## Notifications The `huawei_lte` platform allows you to use a Huawei LTE router for notifications from Home Assistant. The messages will be sent as SMS text messages. @@ -113,7 +113,7 @@ url: To use notifications, please see the [getting started with automation page](/getting-started/automation/). -## {% linkable_title Sensor %} +## Sensor The `huawei_lte` sensor platform allows you to monitor Huawei LTE routers. diff --git a/source/_components/huawei_router.markdown b/source/_components/huawei_router.markdown index eee20dcff20..36f5f8fa8b6 100644 --- a/source/_components/huawei_router.markdown +++ b/source/_components/huawei_router.markdown @@ -19,7 +19,7 @@ The `huawei` device tracker platform offers presence detection by looking at con Currently, this was only tested with the Huawei HG8247H and HG8247Q Smart Router (used by Vodafone Portugal). -## {% linkable_title Configuration %} +## Configuration To use a Huawei router in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/hue.markdown b/source/_components/hue.markdown index 8fbb22e7cd7..6c3c272fd8e 100644 --- a/source/_components/hue.markdown +++ b/source/_components/hue.markdown @@ -60,7 +60,7 @@ allow_hue_groups: type: boolean {% endconfiguration %} -## {% linkable_title Examples %} +## Examples ```yaml # Example configuration.yaml entry specifying optional parameters @@ -71,7 +71,7 @@ hue: allow_hue_groups: true ``` -### {% linkable_title Multiple Hue bridges %} +### Multiple Hue bridges Multiple Hue bridges work transparently with discovery, you don't have to do anything. If you prefer to configure them manually and use multiple Hue bridges then it's needed that you provide a configuration file for every bridge. The bridges can't share a single configuration file. @@ -87,7 +87,7 @@ hue: filename: phue2.conf ``` -### {% linkable_title Using Hue Groups in Home Assistant %} +### Using Hue Groups in Home Assistant The Hue API allows you to group lights. Home Assistant also supports grouping of entities natively, but sometimes it can be useful to use Hue Groups to group light bulbs. By doing so, Home Assistant only needs to send one API call to change the state of all the bulbs in those groups instead of one call for every light in the group. This causes all the bulbs to change state simultaneously. @@ -119,7 +119,7 @@ Home Assistant will automatically detect your new `LightGroup` and add it to the More information can be found on the [Philips Hue API documentation](https://www.developers.meethue.com/documentation/groups-api#22_create_group) website. -### {% linkable_title Using Hue Scenes in Home Assistant %} +### Using Hue Scenes in Home Assistant The Hue platform has its own concept of scenes for setting the colors of a group of lights at once. Hue Scenes are very cheap, get created by all kinds of apps (as it is the only way to have 2 or more lights change at the same time), and are rarely deleted. A typical Hue hub might have hundreds of scenes stored in them, many that you've never used, almost all very poorly named. @@ -145,7 +145,7 @@ script: *Note*: `group_name` is not linked to Home Assistant group name. -### {% linkable_title Finding Group and Scene Names %} +### Finding Group and Scene Names How do you find these names? @@ -153,7 +153,7 @@ The easiest way to do this is only use the scenes from the 2nd generation Hue ap Alternatively, you can dump all rooms and scene names using this [gist](https://gist.github.com/sdague/5479b632e0fce931951c0636c39a9578). This does **not** tell you which groups and scenes work together but it's sufficient to get values that you can test in the `dev-service` console. -### {% linkable_title Caveats %} +### Caveats The Hue API doesn't activate scenes directly, only on a Hue Group (typically rooms, especially if using the 2nd gen app). But Hue Scenes don't actually reference their group. So heuristic matching is used. diff --git a/source/_components/hydrawise.markdown b/source/_components/hydrawise.markdown index 3ec24f8dc7e..f44eebb6cf8 100644 --- a/source/_components/hydrawise.markdown +++ b/source/_components/hydrawise.markdown @@ -29,7 +29,7 @@ There is currently support for the following device types within Home Assistant: - [Sensor](#sensor) - [Switch](#switch) -## {% linkable_title Configuration %} +## Configuration To enable it, add the following to your `configuration.yaml` file: @@ -53,7 +53,7 @@ scan_interval: To get your API access token log into your [Hydrawise account](https://app.hydrawise.com/config/account) and in the 'My Account Details' section under Account Settings click 'Generate API Key'. Enter that key in your configuration file as the `API_KEY`. -## {% linkable_title Binary Sensor %} +## Binary Sensor Once you have enabled the `hydrawise` component, add the following to your `configuration.yaml` file: @@ -78,7 +78,7 @@ monitored_conditions: description: This will indicate `on` when there is a connection to the Hydrawise cloud. It is not an indication of whether the irrigation controller hardware is online. {% endconfiguration %} -## {% linkable_title Sensor %} +## Sensor Once you have enabled the `hydrawise` component, add the following to your `configuration.yaml` file: @@ -101,7 +101,7 @@ monitored_conditions: description: The day and time when the next scheduled automatic watering cycle will start. If the zone is suspended then the value will be `NS` to indicate Not Scheduled. {% endconfiguration %} -## {% linkable_title Switch %} +## Switch Once you have enabled the `hydrawise` component, add the following to your `configuration.yaml` file: @@ -129,7 +129,7 @@ monitored_conditions: description: Enables the manual watering control for this zone. {% endconfiguration %} -### {% linkable_title Switch Operation %} +### Switch Operation When `auto_watering` is `on` the irrigation zone will follow the Smart Watering schedule set through the Hydrawise [mobile or web app](https://www.hydrawise.com). When the `auto_watering` switch is `off` the zone's Smart Watering schedule is suspended for 1 year. diff --git a/source/_components/hyperion.markdown b/source/_components/hyperion.markdown index a5142049d84..779b3c33b6a 100644 --- a/source/_components/hyperion.markdown +++ b/source/_components/hyperion.markdown @@ -18,7 +18,7 @@ redirect_from: The `hyperion` platform allows you to integrate your [Hyperion](https://hyperion-project.org/wiki) into Home Assistant. Hyperion is an open source Ambilight implementation which runs on many platforms. -## {% linkable_title Configuration %} +## Configuration To use your Hyperion light in your installation, add the following to your `configuration.yaml` file: @@ -65,7 +65,7 @@ light: default: "['HDMI', 'Cinema brighten lights', 'Cinema dim lights', 'Knight rider', 'Blue mood blobs', 'Cold mood blobs', 'Full color mood blobs', 'Green mood blobs', 'Red mood blobs', 'Warm mood blobs', 'Police Lights Single', 'Police Lights Solid', 'Rainbow mood', 'Rainbow swirl fast', 'Rainbow swirl', 'Random', 'Running dots', 'System Shutdown', 'Snake', 'Sparks Color', 'Sparks', 'Strobe blue', 'Strobe Raspbmc', 'Strobe white', 'Color traces', 'UDP multicast listener', 'UDP listener', 'X-Mas']" {% endconfiguration %} -## {% linkable_title Examples %} +## Examples To start Hyperion with an effect, use the following automation: diff --git a/source/_components/ialarm.markdown b/source/_components/ialarm.markdown index 446f65cadcc..54b95ab3755 100644 --- a/source/_components/ialarm.markdown +++ b/source/_components/ialarm.markdown @@ -19,7 +19,7 @@ The `ialarm` platform provides connectivity with the [Antifurto365](https://www. This platform supports the following services: `alarm_arm_away`, `alarm_arm_home` and `alarm_disarm`. -## {% linkable_title Configuration %} +## Configuration To enable this, add the following lines to your `configuration.yaml` file: diff --git a/source/_components/idteck_prox.markdown b/source/_components/idteck_prox.markdown index cbd04ba75b0..b9200304c43 100644 --- a/source/_components/idteck_prox.markdown +++ b/source/_components/idteck_prox.markdown @@ -18,7 +18,7 @@ ha_iot_class: Local Push An `idteck_prox_keycard` event is fired whenever a card or key sequence has been entered. The event contains 'card' - the card/key sequence, and the 'name' of the card reader. Checking 'card' against known card numbers can be used as the basis of an entry control system, or as part of a check-in/check-out system. -## {% linkable_title Configuration %} +## Configuration ``` yaml # Example configuration.yaml entry diff --git a/source/_components/ifttt.markdown b/source/_components/ifttt.markdown index f020b557c2e..50c837c1ea8 100644 --- a/source/_components/ifttt.markdown +++ b/source/_components/ifttt.markdown @@ -17,15 +17,15 @@ ha_release: 0.80 [IFTTT](https://ifttt.com) is a web service that allows users to create chains of simple conditional statements, so-called "Applets". With the IFTTT component, you can trigger applets through the **"Webhooks"** service (which was previously the **"Maker"** channel). -## {% linkable_title Sending events from IFTTT to Home Assistant %} +## Sending events from IFTTT to Home Assistant To be able to receive events from IFTTT, your Home Assistant instance needs to be accessible from the web ([Hass.io instructions](/addons/duckdns/)) and you need to have the `base_url` configured for the HTTP integration ([docs](/components/http/#base_url)). -### {% linkable_title Setting up the integration %} +### Setting up the integration To set it up, go to the integrations page in the configuration screen and find IFTTT. Click on configure. Follow the instructions on the screen to configure IFTTT. -### {% linkable_title Using the incoming data %} +### Using the incoming data Events coming in from IFTTT will be available as events in Home Assistant and are fired as `ifttt_webhook_received`. The data specified in IFTTT will be available as the event data. You can use this event to trigger automations. @@ -50,7 +50,7 @@ automation: entity_id: '{% raw %}{{ trigger.event.data.entity_id }}{% endraw %}' ``` -## {% linkable_title Sending events to IFTTT %} +## Sending events to IFTTT ```yaml # Example configuration.yaml entry @@ -72,7 +72,7 @@ Once you have added your key to your `configuration.yaml` file, restart your Hom After restarting the server, be sure to watch the console for any logging errors that show up in red, white or yellow.

-### {% linkable_title Multiple IFTTT keys %} +### Multiple IFTTT keys If you have multiple IFTTT users you can specify multiple IFTTT keys with: @@ -85,7 +85,7 @@ ifttt: ``` -### {% linkable_title Testing your trigger %} +### Testing your trigger You can use the **Developer tools** to test your [Webhooks](https://ifttt.com/maker_webhooks) trigger. To do this, open the Home Assistant frontend, open the sidebar, click on the first icon in the developer tools. This should get you to the **Call Service** screen. Fill in the following values: @@ -111,7 +111,7 @@ Service Data | `{"event": "EventName", "value1": "Hello World", "target": "YOUR_ The `target` field can contain a single key name or a list of key names. -### {% linkable_title Setting up a recipe %} +### Setting up a recipe Press the *New applet* button and search for *Webhooks*. @@ -168,7 +168,7 @@ ifttt_notify: ``` {% endraw %} -### {% linkable_title Additional Channel Examples %} +### Additional Channel Examples Additional examples of using IFTTT channels can be found below. diff --git a/source/_components/ign_sismologia.markdown b/source/_components/ign_sismologia.markdown index dab95336634..37499875434 100644 --- a/source/_components/ign_sismologia.markdown +++ b/source/_components/ign_sismologia.markdown @@ -32,7 +32,7 @@ of each entity. The data is updated every 5 minutes. -## {% linkable_title Configuration %} +## Configuration To integrate the IGN Sismología feed, add the following lines to your `configuration.yaml`. @@ -66,7 +66,7 @@ longitude: {% endconfiguration %} -## {% linkable_title State Attributes %} +## State Attributes The following state attributes are available for each entity in addition to the standard ones: @@ -84,7 +84,7 @@ the standard ones: | image_url | URL to a map supplied in the feed marking the location of the event. This could for example be used in notifications. | -## {% linkable_title Full Configuration %} +## Full Configuration ```yaml # Example configuration.yaml entry diff --git a/source/_components/ihc.markdown b/source/_components/ihc.markdown index 8ead80d665c..70927c5deb2 100644 --- a/source/_components/ihc.markdown +++ b/source/_components/ihc.markdown @@ -69,13 +69,13 @@ info: type: boolean {% endconfiguration %} -## {% linkable_title Auto setup of IHC products %} +## Auto setup of IHC products If the auto setup is enabled, the `ihc` integration will automatically find IHC products and insert these as devices in Home Assistant. To disable this set auto_setup to false. See the individual device types for a list of IHC products to be recognized automatically. Components will get a default name that is a combination of the IHC group and IHC resource id. If you want to change the display names use the [Customizing entities](/docs/configuration/customizing-devices/). -## {% linkable_title Manual setup %} +## Manual setup Each device is associated with an IHC resource id. To manually setup integrations you specify resource ids from the IHC project. The IHC project is the file you edit/upload to the IHC Controller using LK IHC Visual - or similar program if your controller is not the LK brand. @@ -87,7 +87,7 @@ If you want an easier way to get the IHC resource ids, you can download the [Alt See the manual of each device type for configuration options. -## {% linkable_title Binary Sensor %} +## Binary Sensor Before you can use the IHC Binary Sensor platform, you must setup the IHC Component. @@ -101,7 +101,7 @@ When auto setup is enabled the following products will be found in the IHC proje - Dataline gas detector - Dataline light sensor -## {% linkable_title Manual configuration %} +## Manual configuration To manually configure IHC Binary Sensors insert the "binary_sensor" section in your IHC configuration: @@ -156,7 +156,7 @@ binary_sensor: The resource id should be an id of a boolean IHC resource. For more information about IHC resource ids see [Manual Setup](#manual-setup). -## {% linkable_title Sensor %} +## Sensor Before you can use the IHC Sensor platform, you must setup the IHC Component. @@ -214,7 +214,7 @@ sensor: The resource id should be a IHC float resource. For more information about IHC resource ids see [Manual Setup](#manual-setup). -## {% linkable_title Light %} +## Light Before you can use the IHC Light platform, you must setup the IHC Component. @@ -281,7 +281,7 @@ light: In the example above 12345 is ihc resource id and "tablelight" is the name. The IHC resource id can be a light level for dimmers or a boolean output of a relay. For more information about IHC resource ids see [Manual Setup](#manual-setup). -## {% linkable_title Switch %} +## Switch Before you can use the IHC Switch platform, you must setup the IHC Component. diff --git a/source/_components/image_processing.markdown b/source/_components/image_processing.markdown index 3311c755604..9a0f64a3050 100644 --- a/source/_components/image_processing.markdown +++ b/source/_components/image_processing.markdown @@ -16,7 +16,7 @@ Image processing enables Home Assistant to process images from [cameras](/compon If you are running Home Assistant over SSL or from within a container, you will have to setup a base URL (`base_url`) inside the [http component](/components/http/).

-## {% linkable_title ALPR %} +## ALPR ALPR entities have a vehicle counter attribute `vehicles` and all found plates are stored in the `plates` attribute. @@ -37,7 +37,7 @@ automation: The following event attributes will be present (platform-dependent): `entity_id`, `plate`, `confidence` -## {% linkable_title Face %} +## Face Face entities have a face counter attribute `total_faces` and all face data is stored in the `faces` attribute. @@ -58,7 +58,7 @@ automation: The following event attributes will be present (platform-dependent): `entity_id`, `name`, `confidence`, `age`, `gender`, `motion`, `glasses` -## {% linkable_title scan_interval and Optimising Resources %} +## scan_interval and Optimising Resources Image processing integrations process the image from a camera at a fixed period given by the `scan_interval`. This leads to excessive processing if the image on the camera hasn't changed, as the default `scan_interval` is 10 seconds. You can override this by adding to your config `scan_interval: 10000` (setting the interval to 10,000 seconds), and then call the `image_processing.scan` service when you actually want to perform processing. diff --git a/source/_components/imap.markdown b/source/_components/imap.markdown index e7aa43b15ba..d32547a4f51 100644 --- a/source/_components/imap.markdown +++ b/source/_components/imap.markdown @@ -18,7 +18,7 @@ redirect_from: The `imap` sensor platform is observing your [IMAP server](https://en.wikipedia.org/wiki/Internet_Message_Access_Protocol) and reporting the amount of unread emails. -## {% linkable_title Configuration %} +## Configuration To enable this sensor, add the following lines to your `configuration.yaml` file: @@ -65,7 +65,7 @@ search: type: string {% endconfiguration %} -### {% linkable_title Configuring IMAP Searches %} +### Configuring IMAP Searches By default, this integration will count unread emails. By configuring the search string, you can count other results, for example: @@ -73,7 +73,7 @@ By default, this integration will count unread emails. By configuring the search * `FROM`, `TO`, `SUBJECT` to find emails in a folder (see [IMAP RFC for all standard options](https://tools.ietf.org/html/rfc3501#section-6.4.4)) * [Gmail's IMAP extensions](https://developers.google.com/gmail/imap/imap-extensions) allow raw Gmail searches, like `X-GM-RAW "in: inbox older_than:7d"` to show emails older than one week in your inbox. Note that raw Gmail searches will ignore your folder configuration and search all emails in your account! -#### {% linkable_title Full configuration sample with search %} +#### Full configuration sample with search ```yaml # Example configuration.yaml entry diff --git a/source/_components/imap_email_content.markdown b/source/_components/imap_email_content.markdown index 8e2888bfe32..6e7e198c0ad 100644 --- a/source/_components/imap_email_content.markdown +++ b/source/_components/imap_email_content.markdown @@ -18,7 +18,7 @@ redirect_from: The `imap_email_content` sensor platform will read emails from an IMAP email server and report them as a state change within Home Assistant. This is useful if you have a device that only reports its state via email. -## {% linkable_title Configuration %} +## Configuration To enable this sensor, add the following lines to your `configuration.yaml` file: @@ -81,7 +81,7 @@ value_template: description: The date and time the email was sent. {% endconfiguration %} -## {% linkable_title Example %} +## Example The following example shows the usage of the IMAP email content sensor to scan the subject of an email for text, in this case, an email from the APC SmartConnect service which tells whether the UPS is running on battery or not. diff --git a/source/_components/incomfort.markdown b/source/_components/incomfort.markdown index a9dc603b53e..41b9fd4bcbc 100644 --- a/source/_components/incomfort.markdown +++ b/source/_components/incomfort.markdown @@ -48,7 +48,7 @@ To send an alert if the CV pressure is too low or too high, consider the followi Other properties are available via each device's attributes. -### {% linkable_title Configuration %} +### Configuration To add your Lan2RF gateway into your Home Assistant installation, add one of the following to your `configuration.yaml` file. diff --git a/source/_components/influxdb.markdown b/source/_components/influxdb.markdown index 9aa71bbb39e..0b12fbee44b 100644 --- a/source/_components/influxdb.markdown +++ b/source/_components/influxdb.markdown @@ -27,7 +27,7 @@ There is currently support for the following device types within Home Assistant: The `influxdb` database integration runs parallel to the Home Assistant database. It does not replace it.

-## {% linkable_title Configuration %} +## Configuration The default InfluxDB configuration doesn't enforce authentication. If you have installed InfluxDB on the same host where Home Assistant is running and haven't made any configuration changes, add the following to your `configuration.yaml` file: @@ -150,9 +150,9 @@ component_config_glob: required: false {% endconfiguration %} -## {% linkable_title Examples %} +## Examples -### {% linkable_title Full configuration %} +### Full configuration ```yaml influxdb: @@ -180,7 +180,7 @@ influxdb: source: hass ``` -## {% linkable_title Sensor %} +## Sensor The `influxdb` sensor allows you to use values from an [InfluxDB](https://influxdb.com/) database to populate a sensor state. This can be use to present statistic about home_assistant sensors if used with the `influxdb` history component. It can also be used with an external data source. @@ -267,9 +267,9 @@ queries: default: value {% endconfiguration %} -## {% linkable_title Examples %} +## Examples -### {% linkable_title Full configuration %} +### Full configuration The example configuration entry below create two request to your local InfluxDB instance, one to the database `db1`, the other to `db2`: diff --git a/source/_components/input_boolean.markdown b/source/_components/input_boolean.markdown index 0273a07bbb4..74d7d45bd90 100644 --- a/source/_components/input_boolean.markdown +++ b/source/_components/input_boolean.markdown @@ -48,11 +48,11 @@ input_boolean: type: icon {% endconfiguration %} -### {% linkable_title Restore State %} +### Restore State This integration will automatically restore the state it had prior to Home Assistant stopping as long as your entity does **not** have a set value for `initial`. To disable this feature, set a valid value for `initial`. -## {% linkable_title Automation Examples %} +## Automation Examples Here's an example of an automation using the above `input_boolean`. This action will only occur if the switch is on. diff --git a/source/_components/input_datetime.markdown b/source/_components/input_datetime.markdown index 32144ead5ec..08fca824434 100644 --- a/source/_components/input_datetime.markdown +++ b/source/_components/input_datetime.markdown @@ -66,7 +66,7 @@ input_datetime: default: 1970-01-01 00:00 | 1970-01-01 | 00:00 {% endconfiguration %} -### {% linkable_title Attributes %} +### Attributes A datetime input entity's state exports several attributes that can be useful in automations and templates. @@ -79,13 +79,13 @@ automations and templates. | `hour`
`minute`
`second` | The hour, minute and second of the time.
(only available if `has_time: true`) | `timestamp` | A timestamp representing the time held in the input.
If `has_date: true`, this is the UNIX timestamp of the date / time held by the input. Otherwise if only `has_time: true`, this is the number of seconds since midnight representing the time held by the input. -### {% linkable_title Restore State %} +### Restore State This integration will automatically restore the state it had prior to Home Assistant stopping as long as your entity does **not** have a set value for `initial`. To disable this feature, set a valid value for `initial`. -### {% linkable_title Services %} +### Services This integration provides a service to modify the state of the `input_datetime`. @@ -94,7 +94,7 @@ This integration provides a service to modify the state of the `input_datetime`. | `set_datetime` | `time` | This can be used to dynamically set the time. | `set_datetime` | `date` | This can be used to dynamically set the date. -## {% linkable_title Automation Examples %} +## Automation Examples The following example shows the usage of the `input_datetime` as a trigger in an automation (note that you will need a diff --git a/source/_components/input_number.markdown b/source/_components/input_number.markdown index 2a64b74fbc8..8c8440d6674 100644 --- a/source/_components/input_number.markdown +++ b/source/_components/input_number.markdown @@ -84,11 +84,11 @@ input_number: type: icon {% endconfiguration %} -### {% linkable_title Restore State %} +### Restore State This integration will automatically restore the state it had prior to Home Assistant stopping as long as your entity does **not** have a set value for `initial`. To disable this feature, set a valid value for `initial`. -## {% linkable_title Automation Examples %} +## Automation Examples Here's an example of `input_number` being used as a trigger in an automation. diff --git a/source/_components/input_select.markdown b/source/_components/input_select.markdown index e5218340884..9dede4b40d9 100644 --- a/source/_components/input_select.markdown +++ b/source/_components/input_select.markdown @@ -64,11 +64,11 @@ input_select: Because YAML defines [booleans](http://yaml.org/type/bool.html) as equivalent, any variations of 'On', 'Yes', 'Y', 'Off', 'No', or 'N' (regardless of case) used as option names will be replaced by True and False unless they are defined in quotation marks.

-### {% linkable_title Restore State %} +### Restore State This integration will automatically restore the state it had prior to Home Assistant stopping as long as your entity does **not** have a set value for `initial`. To disable this feature, set a valid value for `initial`. -### {% linkable_title Services %} +### Services This integrations provide three services to modify the state of the `input_select`. @@ -79,7 +79,7 @@ This integrations provide three services to modify the state of the `input_selec | `select_previous` | | Select the previous option. | `select_next` | | Select the next option. -### {% linkable_title Scenes %} +### Scenes To specify a target option in a [Scene](/components/scene/) you have to specify the target as `option` attribute: @@ -92,7 +92,7 @@ scene: option: Paulus ``` -## {% linkable_title Automation Examples %} +## Automation Examples The following example shows the usage of the `input_select.select_option` service in an automation: diff --git a/source/_components/input_text.markdown b/source/_components/input_text.markdown index 1ec62c4528d..5fa1dddb288 100644 --- a/source/_components/input_text.markdown +++ b/source/_components/input_text.markdown @@ -71,7 +71,7 @@ input_text: default: text {% endconfiguration %} -### {% linkable_title Services %} +### Services This integrations provide three services to modify the state of the `input_text`. @@ -79,11 +79,11 @@ This integrations provide three services to modify the state of the `input_text` | ------- | ---- | ----------- | | `set_value` | `value`
`entity_id(s)` | Set the value for specific `input_text` entities. -### {% linkable_title Restore State %} +### Restore State This integration will automatically restore the state it had prior to Home Assistant stopping as long as your entity does **not** have a set value for `initial`. To disable this feature, set a valid value for `initial`. -## {% linkable_title Automation Examples %} +## Automation Examples Here's an example using `input_text` in an action in an automation. diff --git a/source/_components/insteon.markdown b/source/_components/insteon.markdown index 2d6c7df3676..fb95eff7d12 100644 --- a/source/_components/insteon.markdown +++ b/source/_components/insteon.markdown @@ -47,7 +47,7 @@ Device support is provided by the underlying [insteonplm] package. It is known t [2245]: https://www.insteon.com/insteon-hub/ [2242]: https://www.insteon.com/support-knowledgebase/2014/9/26/insteon-hub-owners-manual -### {% linkable_title INSTEON Modem configuration %} +### INSTEON Modem configuration To set up an INSTEON Powerline Modem (PLM) device such as the [2413U], use the following configuration: @@ -186,13 +186,13 @@ x10_all_lights_off: type: string {% endconfiguration %} -### {% linkable_title Autodiscovery %} +### Autodiscovery The first time autodiscovery runs, the duration may require up to 20 seconds per device. Subsequent startups will occur much quicker using cached device information. If a device is not recognized during autodiscovery, you can add the device to the **device_override** configuration. In order for a device to be discovered, it must be linked to the INSTEON Modem as either a responder or a controller. -### {% linkable_title Linking Devices to the INSTEON Modem %} +### Linking Devices to the INSTEON Modem In order for any two Insteon devices to talk with one another, they must be linked. For an overview of device linking, please read the Insteon page on [understanding linking]. The Insteon Modem module supports All-Linking through [Development Tools] service calls. The following services are available: @@ -210,7 +210,7 @@ If you are looking for more advanced options, you can use the [insteonplm_intera [Insteon Terminal]: https://github.com/pfrommerd/insteon-terminal [insteonplm_interactive]: https://github.com/nugget/python-insteonplm#command-line-interface -### {% linkable_title Customization %} +### Customization The only configuration item that is necessary is the PLM port or Hub IP address, username and password so that Home Assistant can connect to the INSTEON Modem. This will expose all the supported INSTEON devices which exist in the modem’s ALL-Link database. However, devices will only be shown by their INSTEON hex address (e.g., “1A.2B.3C”) which can be a bit unwieldy. As you link and unlink devices using the ‘Set’ buttons, they’ll be added and removed from Home Assistant automatically. @@ -218,7 +218,7 @@ You can use the normal Home Assistant [device customization] section of your con [device customization]: /getting-started/customizing-devices/ -### {% linkable_title Device Overrides %} +### Device Overrides INSTEON devices are added to Home Assistant using the platform(s) that make the most sense given the model and features of the hardware. The features of the INSTEON devices are built into the Home Assistant platform. Changing the platform is not recommended. @@ -227,7 +227,7 @@ There are two primary uses for the **device_override** feature: - Devices that do not respond during autodiscovery. This is common for battery operated devices. - Devices that have not been fully developed. This allows an unknown device to be mapped to a device that operates similarly to another device. -### {% linkable_title Example Configuration with Options%} +### Example Configuration with Options ```yaml # Full example of Insteon configuration with customizations and overrides @@ -248,7 +248,7 @@ insteon: subcat: 0x11 ``` -### {% linkable_title What NOT to do %} +### What NOT to do Insteon Modem is a top-level integration and device discovery will identify the Home Assistant platform the device belongs in. As such, do not declare Insteon devices in other platforms. For example, this configuration will NOT work: @@ -258,7 +258,7 @@ light: address: 1a2b3c ``` -### {% linkable_title Events and Mini-Remotes %} +### Events and Mini-Remotes Mini-Remote devices do not appear as Home Assistant entities, they generate events. The following events are available: @@ -303,7 +303,7 @@ automation: entity_id: light.some_light ``` -### {% linkable_title Known Issues with the INSTEON Hub %} +### Known Issues with the INSTEON Hub The INSTEON Hub has three known issues that are inherent to the design of the Hub: diff --git a/source/_components/integration.markdown b/source/_components/integration.markdown index 892421583fa..4ac9c85a8db 100644 --- a/source/_components/integration.markdown +++ b/source/_components/integration.markdown @@ -20,7 +20,7 @@ redirect_from: The `integration` platform provides the [Riemann sum](https://en.wikipedia.org/wiki/Riemann_sum) of the values provided by a source sensor. The Riemann sum is an approximation of an **integral** by a finite sum. The integration sensors is updated upon changes of the the **source**. Fast sampling source sensors provide better results. In this implementation, the default is the Trapezoidal method, but Left and Right methods can optionally be used. -## {% linkable_title Configuration %} +## Configuration To enable Integration Sensor in your installation, add the following to your `configuration.yaml` file: @@ -68,7 +68,7 @@ method: If 'unit' is set then 'unit_prefix' and 'unit_time' are ignored. -## {% linkable_title Energy %} +## Energy An `integration` sensor is quite useful in energy billing scenarios since energy is generally billed in kWh and many sensors provide power in W (Watts). diff --git a/source/_components/iota.markdown b/source/_components/iota.markdown index 17e1ac972f5..c93a7eb75ff 100644 --- a/source/_components/iota.markdown +++ b/source/_components/iota.markdown @@ -65,7 +65,7 @@ iota: seed: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX ``` -## {% linkable_title Sensor %} +## Sensor The sensors are automatically created if the IOTA integration is present. diff --git a/source/_components/iperf3.markdown b/source/_components/iperf3.markdown index 44b6aa3b014..26a4af07ff6 100644 --- a/source/_components/iperf3.markdown +++ b/source/_components/iperf3.markdown @@ -21,11 +21,11 @@ The `iperf3` sensor integration allows you to measure network bandwidth performa Enabling this integration will automatically create the Iperf3 sensors for the monitored conditions (below). By default, it will run every hour. The user can change the update frequency in the config by defining the `scan_interval` for a Iperf3 test to run. -## {% linkable_title Setup %} +## Setup This integration requires the `iperf3` command to be installed on your OS. Please, refer to the [official Iperf3 documentation](http://software.es.net/iperf/obtaining.html) for installation instructions. -## {% linkable_title Configuration %} +## Configuration To add the `iperf3` sensor to your installation, add the following to your `configuration.yaml` file: @@ -92,7 +92,7 @@ Configuration variables (host): type: string {% endconfiguration %} -#### {% linkable_title Time period dictionary example %} +#### Time period dictionary example ```yaml scan_interval: @@ -112,7 +112,7 @@ Parallel streams can help in some situations. As TCP attempts to be fair and con You can use the service `sensor.iperf3_update` to trigger a manual speed test for all sensors. Iperf3 has its own service call that allow to perform a speed test on a particular entity. -### {% linkable_title Service %} +### Service Once loaded, the `iperf3` integration will expose a service (`iperf3.speedtest`) that can be called to run a speed test on demand. This can be useful if you have enabled manual mode. @@ -125,6 +125,6 @@ Example Service data: {"host": "192.168.0.121"} ``` -## {% linkable_title Notes %} +## Notes - When running on Raspberry Pi, just note that the maximum speed is limited by its 100 Mbit/s LAN adapter. diff --git a/source/_components/ipma.markdown b/source/_components/ipma.markdown index dfb2a64f705..2c9c3a65c79 100644 --- a/source/_components/ipma.markdown +++ b/source/_components/ipma.markdown @@ -18,7 +18,7 @@ redirect_from: The `ipma` weather platform uses the [Instituto Português do Mar e Atmosfera](http://www.ipma.pt) as a source for current and forecast meteorological data. -## {% linkable_title Configuration %} +## Configuration To add the IPMA weather platform to your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/iqvia.markdown b/source/_components/iqvia.markdown index 12969ba0c89..3480b70eedd 100644 --- a/source/_components/iqvia.markdown +++ b/source/_components/iqvia.markdown @@ -26,7 +26,7 @@ Data measured includes: * Current outlook * more! -## {% linkable_title Configuring the Platform %} +## Configuring the Platform To integrate `iqvia` into Home Assistant, add the following section to your `configuration.yaml` file (adjusting the `monitored_conditions` list to your @@ -79,7 +79,7 @@ It is important to ensure the ZIP code is quoted if it starts with a 0. Unquoted ZIP codes that start with 0 will cause errors.

-## {% linkable_title Understanding the Indices %} +## Understanding the Indices Any index-related sensor will have a value between 0.0 and 12.0. The values map to the following human-friendly ratings: @@ -92,7 +92,7 @@ Range | Rating 7.3 - 9.6 | Medium/High 9.7 - 12.0 | High -## {% linkable_title Understanding Asthma Allergens %} +## Understanding Asthma Allergens Several asthma-related sensors carry information regarding the top three "asthma allergens" (i.e., irritants that may exacerbate asthma symptoms). diff --git a/source/_components/islamic_prayer_times.markdown b/source/_components/islamic_prayer_times.markdown index c66dde38efc..3b4f377372d 100644 --- a/source/_components/islamic_prayer_times.markdown +++ b/source/_components/islamic_prayer_times.markdown @@ -24,7 +24,7 @@ This platform calculates prayer times using the following calculation methods: - Muslim World League - Umm Al-Qura University in Makkah -## {% linkable_title Configuration %} +## Configuration To enable this sensor in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/iss.markdown b/source/_components/iss.markdown index d5b9854355f..f3bc3d1133b 100644 --- a/source/_components/iss.markdown +++ b/source/_components/iss.markdown @@ -24,7 +24,7 @@ This means that ISS is 10° above the horizon of your home. You can check in the attributes of the sensor to see the timestamp for the next rise of the station, its current coordinates, and the number of people in space. -## {% linkable_title Configuration %} +## Configuration To add ISS binary sensor to your installation, add the following to your `configuration.yaml` file: @@ -53,7 +53,7 @@ If you set `show_on_map: true` then the location attributes are named `latitude` The default name of the location attributes is `lat` and `long` to avoid showing them on the map.

-### {% linkable_title Show position on map with camera platform %} +### Show position on map with camera platform The [generic camera platform](/components/camera.mjpeg/) offers the possibility to show the location of the ISS on OpenStreetMap. diff --git a/source/_components/isy994.markdown b/source/_components/isy994.markdown index b6783c2b773..2c054715ea5 100644 --- a/source/_components/isy994.markdown +++ b/source/_components/isy994.markdown @@ -42,7 +42,7 @@ There is currently support for the following device types within Home Assistant: - Sensor - Switch -### {% linkable_title Basic Configuration %} +### Basic Configuration Home Assistant is capable of communicating with any binary sensor, cover, fan, light, lock, sensor and switch that is configured on the controller. Using the programs on the controller, custom binary sensors, cover, fan, lock, and switches can also be created. @@ -92,7 +92,7 @@ tls: Once the ISY controller is configured, it will automatically import any binary sensors, covers, fans, lights, locks, sensors and switches it can locate. -### {% linkable_title Sensors %} +### Sensors An Insteon door/window sensor will show up as a single Binary Sensor rather than two discrete devices like it does in the ISY994 admin panel. Note that when in "Two Nodes" mode, the sensor will have an UNKNOWN state until the sensor changes for the first time since the last Home Assistant reboot. If you do not use Insteon scenes that are controlled directly from the door sensor, you may prefer to set the sensor to "One Node" mode using the ISY Admin Panel. @@ -100,7 +100,7 @@ Each Insteon leak sensor will also show up as a single Binary Sensor as opposed If your leak or door/window sensor supports heartbeats, a new binary_sensor device will be added to Home Assistant to represent the battery state. The sensor will stay "Off" so long as the daily heartbeats occur. If a heartbeat is missed, the sensor will flip to "On". The name of this device will be based on the heartbeat node in the ISY. -### {% linkable_title Handling Insteon Control Events %} +### Handling Insteon Control Events A Home Assistant `isy994_control` event is emitted for every "control" event in the Insteon network. This allows you to write automations that trigger based on Insteon button presses. You can also trigger off of the unique Insteon events, such as double-presses, long-holds etc. @@ -130,11 +130,11 @@ All `isy994_control` events will have an `entity_id` and `control` parameter in - `BRT`: "Brighten", from controllers that issue a single command to slightly brighten a light. - `DIM`: "Dim", from controllers that issue a single command to slightly dim a light. -### {% linkable_title Insteon Scenes %} +### Insteon Scenes All Insteon scenes configured in the ISY994 will show up as switches in Home Assistant. -### {% linkable_title Creating Custom Devices %} +### Creating Custom Devices Using the Programs tab in the controller's Administrative Console, custom devices can be created that will appear natively inside of Home Assistant. Home Assistant will scan the following folders and build the device to the associated domains: diff --git a/source/_components/itunes.markdown b/source/_components/itunes.markdown index 5a1c5fddbeb..f1b88555eb5 100644 --- a/source/_components/itunes.markdown +++ b/source/_components/itunes.markdown @@ -21,7 +21,7 @@ The `itunes` media player platform allows you to control [iTunes](http://apple.c In addition to controlling iTunes, your available AirPlay endpoints will be added as media players as well. You can then individually address them and turn them on, turn them off or adjust their volume. -## {% linkable_title Configuration %} +## Configuration To add iTunes to your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/jewish_calendar.markdown b/source/_components/jewish_calendar.markdown index ae53869a010..ddd9e221aeb 100644 --- a/source/_components/jewish_calendar.markdown +++ b/source/_components/jewish_calendar.markdown @@ -17,7 +17,7 @@ redirect_from: The Jewish Calendar (`jewish_calendar`) sensor platform displays a variety of information related to the Jewish Calendar as a variety of sensors. -## {% linkable_title Configuration %} +## Configuration To enable this sensor in your installation, add the following to your `configuration.yaml` file: @@ -94,7 +94,7 @@ sensors: {% endconfiguration %} -### {% linkable_title Holyness levels %} +### Holyness levels 1. Mido'rayta - by Torah ordination (Rosh Hashana, Yom Kippur, Pesach, Shavuot, Sukkot) 2. Erev Yom Tov @@ -106,7 +106,7 @@ sensors: 8. Memorial days: yom hazikaron and yom hashoah 9. Days mentioned by the Israeli parliament: Rabin memorial day, Ze'ev Zhabotinsky day, etc. -## {% linkable_title Full configuration sample %} +## Full configuration sample ```yaml # Example configuration.yaml entry diff --git a/source/_components/juicenet.markdown b/source/_components/juicenet.markdown index b2dd405fcdb..edfcb9e3559 100644 --- a/source/_components/juicenet.markdown +++ b/source/_components/juicenet.markdown @@ -18,7 +18,7 @@ redirect_from: The `juicenet` sensor platform pulls data from a [JuiceNet](https://emotorwerks.com/products/juicenet/) charging station equipped with a wifi connection. It will access and make available all of the devices attached to your account. -## {% linkable_title Configuration %} +## Configuration To enable the platform in your installation, add the following to your `configuration.yaml` file: @@ -35,11 +35,11 @@ access_token: type: string {% endconfiguration %} -## {% linkable_title Sensor %} +## Sensor The `juicenet` sensor platform allows you to get data from your [JuiceNet](https://emotorwerks.com/products/juicenet/) sensors. -### {% linkable_title Added sensors %} +### Added sensors These sensors will be added for each juicenet device in your account: diff --git a/source/_components/kankun.markdown b/source/_components/kankun.markdown index 57c9e938b08..f9d73200a9b 100644 --- a/source/_components/kankun.markdown +++ b/source/_components/kankun.markdown @@ -21,7 +21,7 @@ script to provide an HTTP API. Details of the necessary modifications can be fou [here](http://www.homeautomationforgeeks.com/openhab_http.shtml#kankun) (be sure to install the JSON version of the script as linked above). -## {% linkable_title Configuration %} +## Configuration To enable it, add the following lines to your `configuration.yaml`: diff --git a/source/_components/keyboard.markdown b/source/_components/keyboard.markdown index eaf70a627da..740f3ee601b 100644 --- a/source/_components/keyboard.markdown +++ b/source/_components/keyboard.markdown @@ -28,7 +28,7 @@ To load this component, add the following lines to your `configuration.yaml`: keyboard: ``` -## {% linkable_title Dependencies %} +## Dependencies You may need to install platform-specific [dependencies for PyUserInput](https://github.com/PyUserInput/PyUserInput#dependencies) in order to use the keyboard component. In most cases this can be done by running: @@ -36,7 +36,7 @@ You may need to install platform-specific [dependencies for PyUserInput](https:/ pip3 install [package name] ``` -### {% linkable_title Windows %} +### Windows x64 Windows users may have trouble installing pywin through pip. Using an [executable installer](http://sourceforge.net/projects/pywin32/files/pywin32/) should work around this issue. diff --git a/source/_components/keyboard_remote.markdown b/source/_components/keyboard_remote.markdown index 02fc97db18d..c766cdf88c5 100644 --- a/source/_components/keyboard_remote.markdown +++ b/source/_components/keyboard_remote.markdown @@ -82,7 +82,7 @@ automation: `device_descriptor` or `device_name` may be specificed in the trigger so the automation will be fired only for that keyboard. This is especially useful if you wish to use several bluetooth remotes to control different devices. Omit them to ensure the same key triggers the automation for all keyboards/remotes. -## {% linkable_title Disconnections %} +## Disconnections This integration manages disconnections and re-connections of the keyboard, for example in the case of a Bluetooth device that turns off automatically to preserve battery. @@ -118,7 +118,7 @@ automation: media_content_type: music ``` -## {% linkable_title Permissions %} +## Permissions There might be permissions problems with the event input device file. If this is the case, the user that Home Assistant runs as must be allowed read and write permissions with: diff --git a/source/_components/kira.markdown b/source/_components/kira.markdown index b75a784cdec..9f73d031bc2 100644 --- a/source/_components/kira.markdown +++ b/source/_components/kira.markdown @@ -25,7 +25,7 @@ There is currently support for the following device types within Home Assistant: - Remote - Sensor -### {% linkable_title Example Configuration %} +### Example Configuration ```yaml # Example configuration.yaml entry @@ -34,7 +34,7 @@ kira: Kira modules have no built-in mechanism for auto-discovery, so will need to be configured to send packets to Home Assistant. Documentation for this can be found on the manufacturer's website [Here](https://www.keene.co.uk/pages/iranywhere/index.html). -### {% linkable_title Configuration Options %} +### Configuration Options ```yaml # Example configuration.yaml entry @@ -91,7 +91,7 @@ remotes: If no sensors or remotes are specified, a sensor with default values will be added. -### {% linkable_title Code Configuration %} +### Code Configuration The first time the Kira integration is loaded, `kira_codes.yaml` will be created in the Home Assistant configuration directory. @@ -137,7 +137,7 @@ repeat: Some manufacturers (e.g., Samsung) require an IR code to be sent a number of times in a row in rapid succession (usually 3). This doesn't apply to the vast majority of devices, but it can be helpful if needed. -### {% linkable_title Code Types %} +### Code Types When creating an entry in `kira_codes.yaml`, a few different kinds of codes can be used. diff --git a/source/_components/kiwi.markdown b/source/_components/kiwi.markdown index 701baab7a95..78edc656e6f 100644 --- a/source/_components/kiwi.markdown +++ b/source/_components/kiwi.markdown @@ -19,7 +19,7 @@ redirect_from: The `KIWI` platform allows you to open your KIWI Smart Locks and Smart Entry Devices. All you need to get started is a KIWI account. Register at [the KIWI website](https://kiwi.ki/login/). -## {% linkable_title Configuration %} +## Configuration ```yaml # Example configuration.yaml entry diff --git a/source/_components/knx.markdown b/source/_components/knx.markdown index cf505449c26..0749dc101f9 100644 --- a/source/_components/knx.markdown +++ b/source/_components/knx.markdown @@ -34,7 +34,7 @@ There is currently support for the following device types within Home Assistant: - [Notify](/components/notify.knx) - [Scene](/components/scene.knx) -## {% linkable_title Configuration %} +## Configuration To use your KNX in your installation, add the following lines to your `configuration.yaml` file: @@ -119,7 +119,7 @@ state_updater: type: boolean {% endconfiguration %} -### {% linkable_title Services %} +### Services In order to directly interact with the KNX bus, you can now use the following service: @@ -138,7 +138,7 @@ payload: type: [integer, list] {% endconfiguration %} -### {% linkable_title Exposing sensor values or time to knx bus %} +### Exposing sensor values or time to knx bus KNX integration is able to expose time or sensor values to KNX bus. The integration will broadcast any change of the exposed value to the KNX bus and answer read requests to the specified group address: @@ -167,6 +167,6 @@ address: type: string {% endconfiguration %} -### {% linkable_title Known issues %} +### Known issues Due to lame multicast support the routing abstraction and the gateway scanner only work with Python >=3.5. diff --git a/source/_components/kodi.markdown b/source/_components/kodi.markdown index 827545a0e24..552dac04e15 100644 --- a/source/_components/kodi.markdown +++ b/source/_components/kodi.markdown @@ -27,7 +27,7 @@ There is currently support for the following device types within Home Assistant: - [Media Player](#configuration) - [Notifications](#notifications) -## {% linkable_title Configuration %} +## Configuration In case the discovery does not work, or you need specific configuration variables, you can add the following to your `configuration.yaml` file: @@ -90,9 +90,9 @@ timeout: default: 5 {% endconfiguration %} -### {% linkable_title Services %} +### Services -#### {% linkable_title Service `kodi_add_to_playlist` %} +#### Service `kodi_add_to_playlist` Add music to the default playlist (i.e. playlistid=0). @@ -104,14 +104,14 @@ Add music to the default playlist (i.e. playlistid=0). | `media_name` | no| Optional media name for filtering media. Can be 'ALL' when `media_type` is 'ALBUM' and `artist_name` is specified, to add all songs from one artist. | | `artist_name` | no | Optional artist name for filtering media. | -#### {% linkable_title Service `media_player/kodi_set_shuffle` %} +#### Service `media_player/kodi_set_shuffle` | Service data attribute | Optional | Description | |------------------------|----------|-------------| | `entity_id` | yes | Target a specific media player. It must be of type kodi. | | `shuffle_on` | no | True/false for shuffle on/off. | -#### {% linkable_title Service `kodi_call_method` %} +#### Service `kodi_call_method` Call a [Kodi JSONRPC API](http://kodi.wiki/?title=JSON-RPC_API) method with optional parameters. Results of the Kodi API call will be redirected in a Home Assistant event: `kodi_call_method_result`. @@ -121,7 +121,7 @@ Call a [Kodi JSONRPC API](http://kodi.wiki/?title=JSON-RPC_API) method with opti | `method` | yes | Name of the Kodi JSONRPC API method to be called. | | any other parameter | no | Optional parameters for the Kodi API call. | -### {% linkable_title Event triggering %} +### Event triggering When calling the `kodi_call_method` service, if the Kodi JSONRPC API returns data, when received by Home Assistant it will fire a `kodi_call_method_result` event on the event bus with the following `event_data`: @@ -132,7 +132,7 @@ input: result: ``` -### {% linkable_title Kodi turn on/off samples %} +### Kodi turn on/off samples With the `turn_on_action` and `turn_off_action` parameters you can run any combination of Home Assistant actions to turn on/off your Kodi instance. Here are a few examples of this usage, including the **migration instructions for the old `turn_off_action` list of options**. @@ -253,7 +253,7 @@ media_player: This example and the following requires to have the [script.json-cec](https://github.com/joshjowen/script.json-cec) plugin installed on your kodi player. It'll also expose the endpoints standby, toggle and activate without authentication on your kodi player. Use this with caution.

-### {% linkable_title Kodi services samples %} +### Kodi services samples #### Simple script to turn on the PVR in some channel as a time function @@ -305,7 +305,7 @@ script: For a more complex usage of the `kodi_call_method` service, with event triggering of Kodi API results, you can have a look at this [example](/cookbook/automation_kodi_dynamic_input_select/) -## {% linkable_title Notifications %} +## Notifications The `kodi` notifications platform allows you to send messages to your [Kodi](https://kodi.tv/) multimedia system from Home Assistant. @@ -348,7 +348,7 @@ password: type: string {% endconfiguration %} -### {% linkable_title Script example %} +### Script example ```yaml kodi_notification: @@ -362,7 +362,7 @@ kodi_notification: icon: "warning" ``` -#### {% linkable_title Message variables %} +#### Message variables {% configuration %} title: diff --git a/source/_components/konnected.markdown b/source/_components/konnected.markdown index 93122801396..00d1b166dd3 100644 --- a/source/_components/konnected.markdown +++ b/source/_components/konnected.markdown @@ -35,7 +35,7 @@ This integration uses the [`discovery`](/components/discovery) component, which Konnected devices communicate with Home Assistant over your local LAN -- there is no cloud component! For best performance we recommend allowing unsecured HTTP API traffic between Konnected devices and Home Assistant on your LAN. This means that you should not use the `http` integration to serve SSL/TLS certificates. Instead, use a proxy like Nginx or Caddy to serve SSL/TLS. [Read more.](https://help.konnected.io/support/solutions/articles/32000023964-set-up-hass-io-with-secure-remote-access-using-duckdns-and-nginx-proxy)

-### {% linkable_title Configuration %} +### Configuration A `konnected` section must be present in the `configuration.yaml` file that specifies the Konnected devices on the network and the sensors or actuators attached to them: @@ -172,12 +172,12 @@ devices: {% endconfiguration%} -#### {% linkable_title Configuration Notes %} +#### Configuration Notes - Either **pin** or **zone** is required for each actuator or sensor. Do not use both in the same definition. - Pin `D8` or the `out` zone will only work when activation is set to high (the default). -### {% linkable_title Extended Configuration %} +### Extended Configuration ```yaml # Example configuration.yaml entry @@ -231,7 +231,7 @@ konnected: ``` -### {% linkable_title Unique IDs and the Entity Registry %} +### Unique IDs and the Entity Registry Beginning in Home Assistant release 0.90, unique IDs are generated for each sensor or switch entity. This enables end users to modify the entity names and entity IDs through the Home Assistant UI on the _Entity Registry_ page (under _Configuration_). @@ -247,7 +247,7 @@ Unique IDs are internally generated as follows: \* Switches are identified by a unique hash including the pin number, `momentary`, `pause`, and `repeat` values. If these values are modified, a new entity will be created and the old entity must be removed manually from the _Entity Registry_. -### {% linkable_title Pin Mapping %} +### Pin Mapping Konnected runs on an ESP8266 board with the NodeMCU firmware. It is commonly used with the NodeMCU dev kit WiFi module and optionally Konnected's Alarm Panel hardware. The following table shows the pin mapping between the Konnected hardware labeled zones, the NodeMCU labeled pins and the ESP8266 GPIO pins. @@ -261,7 +261,7 @@ Konnected runs on an ESP8266 board with the NodeMCU firmware. It is commonly use | 6 | RX | 9 | GPIO3 | | ALARM or OUT | D8 | 8 | GPIO15 | -### {% linkable_title Revision History %} +### Revision History #### 0.91 @@ -295,12 +295,12 @@ Konnected runs on an ESP8266 board with the NodeMCU firmware. It is commonly use - Initial release -### {% linkable_title Binary Sensor %} +### Binary Sensor The `konnected` binary sensor allows you to monitor wired door sensors, window sensors, motion sensors, smoke detectors, CO detectors, glass-break sensors, water leak sensors or any other simple wired open/close circuit attached to a NodeMCU ESP8266 WiFi module running the [open source Konnected software](https://github.com/konnected-io/konnected-security). This integration supports all of the built-in device classes of the generic [Binary Sensor](/components/binary_sensor/) component. -### {% linkable_title Switch %} +### Switch The `konnected` switch platform allows you to actuate an alarm system siren, strobe light, buzzer or any other wired device using a [Konnected Alarm Panel board](https://konnected.io) or relay module and a NodeMCU ESP8266 WiFi module running the [open source Konnected software](https://github.com/konnected-io/konnected-security). \ No newline at end of file diff --git a/source/_components/lacrosse.markdown b/source/_components/lacrosse.markdown index 63a6885d369..6d0d4954989 100644 --- a/source/_components/lacrosse.markdown +++ b/source/_components/lacrosse.markdown @@ -18,12 +18,12 @@ redirect_from: The `lacrosse` sensor platform is using the data provided by a [Jeelink](https://www.digitalsmarties.net/products/jeelink) USB dongle or this [Arduino sketch](https://svn.fhem.de/trac/browser/trunk/fhem/contrib/arduino/36_LaCrosse-LaCrosseITPlusReader.zip). -## {% linkable_title Tested Devices %} +## Tested Devices - Technoline TX 29 IT (temperature only) - Technoline TX 29 DTH-IT (including humidity) -## {% linkable_title Setup %} +## Setup Since the sensor change their ID after each powercycle/battery change you can check what sensor IDs are available by using the command-line tool `pylacrosse` from the pylacrosse package. @@ -31,7 +31,7 @@ Since the sensor change their ID after each powercycle/battery change you can ch sudo pylacrosse -d /dev/ttyUSB0 scan ``` -## {% linkable_title Configuration %} +## Configuration To use your `lacrosse` compatible sensor in your installation, add the following to your `configuration.yaml` file: @@ -95,7 +95,7 @@ sensor: type: integer {% endconfiguration %} -## {% linkable_title Examples %} +## Examples To setup a lacrosse sensor with multiple sensors, add the following to your `configuration.yaml` file: diff --git a/source/_components/lametric.markdown b/source/_components/lametric.markdown index 02c1f46c7e9..80517890ea3 100644 --- a/source/_components/lametric.markdown +++ b/source/_components/lametric.markdown @@ -31,7 +31,7 @@ lametric: client_secret: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx ``` -## {% linkable_title Setup Steps %} +## Setup Steps LaMetric needs an OAuth2 `client_id` and `client_secret` from the LaMetric developer portal to use it with Home Assistant. These are the steps to take: @@ -48,7 +48,7 @@ These are the steps to take: 5. Set up some notifications in Home Assistant by following the instructions on the [Lametric Notify](/components/notify.lametric) page. 6. Save all configuration files and restart Home Assistant. -## {% linkable_title Notifications %} +## Notifications The `lametric` notification platform allows to send notification to a LaMetric device. It needs the LaMetric platform to be configured first. @@ -90,9 +90,9 @@ priority: Check out the list of all icons at [https://developer.lametric.com/icons](https://developer.lametric.com/icons). Note that icons always begin with "i" while animations begin with "a". This is part of the name, you can't just use the number! -## {% linkable_title Examples %} +## Examples -### {% linkable_title Full configuration example %} +### Full configuration example ```yaml # Example configuration.yaml entry @@ -105,7 +105,7 @@ notify: priority: info ``` -### {% linkable_title Changing sounds and icons %} +### Changing sounds and icons To add a notification sound, icon, cycles, or priority override, it has to be done via service data. @@ -127,7 +127,7 @@ To add a notification sound, icon, cycles, or priority override, it has to be do priority: 'critical' ``` -### {% linkable_title Only notify specific device %} +### Only notify specific device If you have more than one La Metric device, you can specify which will receive the message by adding `target:` to the service data: diff --git a/source/_components/lannouncer.markdown b/source/_components/lannouncer.markdown index b67ff08ed1c..cb1aed42f6e 100644 --- a/source/_components/lannouncer.markdown +++ b/source/_components/lannouncer.markdown @@ -44,7 +44,7 @@ port: type: integer {% endconfiguration %} -### {% linkable_title Installation %} +### Installation You need to install the Lannouncer app and enable the *Network (TCP) Listener* and *Auto-Start Network Listener*. You can disable the *GCM (Google Cloud) and WAN Messaging* and *SMS Listener* since this integration doesn't use them. @@ -52,7 +52,7 @@ Lannouncer uses the default Android TTS voice. You can tweak that in the Android More information can be found [here](http://www.keybounce.com/lannouncer/configuring-lannouncer/). -### {% linkable_title Sending messages %} +### Sending messages Lannouncer supports two types of messages. diff --git a/source/_components/lastfm.markdown b/source/_components/lastfm.markdown index 10657b58fc5..f8f4a54e586 100644 --- a/source/_components/lastfm.markdown +++ b/source/_components/lastfm.markdown @@ -18,11 +18,11 @@ redirect_from: The `lastfm` sensor platform will allow you to see whenever a user starts scrobbling, their play count, last song played, and top song played on [Last.fm](http://www.last.fm). -## {% linkable_title Setup %} +## Setup To get an API key you need to create an [API account](http://www.last.fm/api/account/create). -## {% linkable_title Configuration %} +## Configuration To use Last.fm sensor with your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/launch_library.markdown b/source/_components/launch_library.markdown index 9d1d8a38c48..1cd6706cb75 100644 --- a/source/_components/launch_library.markdown +++ b/source/_components/launch_library.markdown @@ -18,7 +18,7 @@ redirect_from: The `launch_library` sensor will provide you with information about the next planned space launch. -## {% linkable_title Configuration %} +## Configuration Add the data to your `configuration.yaml` file as shown in the example: diff --git a/source/_components/lcn.markdown b/source/_components/lcn.markdown index 865a7662d0d..479ca0d3c4f 100644 --- a/source/_components/lcn.markdown +++ b/source/_components/lcn.markdown @@ -46,7 +46,7 @@ There is currently support for the following device types within Home Assistant: They are ideal to be used in automation scripts or for the `template` platforms.

-## {% linkable_title Configuration %} +## Configuration To use your LCN system in your installation, add the following lines to your `configuration.yaml` file. You have to specify at least one ip/port with login credentials for a PCHK host. @@ -325,7 +325,7 @@ switches: type: string {% endconfiguration %} -## {% linkable_title LCN Addresses %} +## LCN Addresses LCN hardware devices connected to the LCN bus are called _modules_. LCN modules are addressed by their numeric id in the range (5..254). @@ -357,11 +357,11 @@ s0.g7 Leading zeroes in the segment id or module/group id can be omitted. If the `connection_id` is omitted, the first connection defined in the [configuration](#configuration) will be used. -## {% linkable_title LCN Constants %} +## LCN Constants The platforms and service calls use several predefined constants as parameters. -### {% linkable_title Ports %} +### Ports | Constant | Values | | -------- | ------ | @@ -381,7 +381,7 @@ The [MOTOR_PORT](#ports) values specify which hardware relay configuration will | `motor3` | `relay5` | `relay6` | | `motor4` | `relay7` | `relay8` | -### {% linkable_title Variables and Units %} +### Variables and Units | Constant | Values | | -------- | ------ | @@ -393,7 +393,7 @@ The [MOTOR_PORT](#ports) values specify which hardware relay configuration will | TIME_UNIT | `seconds`, `minutes`, `hours`, `days` | | RELVARREF | `current`, `prog` | -### {% linkable_title States %}: +### States: | Constant | Values | | -------- | ------ | @@ -401,14 +401,14 @@ The [MOTOR_PORT](#ports) values specify which hardware relay configuration will | LOGICOP_STATE | `not`, `or`, `and` | | KEY_STATE | `hit`, `make`, `break`, `dontsend` | -### {% linkable_title Keys %}: +### Keys: Whenever a key has to be provided, it is defined by a joint string consisting of the table identifier (`a`, `b`, `c`, `d`) and the corresponding key number. Examples: `a1`, `a5`, `d8`. -## {% linkable_title Platforms %} +## Platforms -### {% linkable_title Binary Sensor %} +### Binary Sensor The `lcn` binary sensor platform allows the monitoring of the following [LCN](http://www.lcn.eu) binary data sources: @@ -418,7 +418,7 @@ The `lcn` binary sensor platform allows the monitoring of the following [LCN](ht The binary sensor can be used in automation scripts or in conjunction with `template` platforms. -### {% linkable_title Climate %} +### Climate The `lcn` climate platform allows the control of the [LCN](http://www.lcn.eu) climate regulators. This platform depends on the correct configuration of the module's regulators which has to be done in the LCN-PRO programming software. @@ -429,22 +429,22 @@ If the control is set lockable, the regulator can be turned on/off. If you intend to leave the regulation to home assistant, you should consider using the [Generic Thermostat](climate.generic_thermostat) in conjuction with [LCN Sensor](#sensor) and [LCN Switch](#switch).

-### {% linkable_title Cover %} +### Cover The `lcn` cover platform allows the control of [LCN](http://www.lcn.eu) relays which have been configured as motor controllers. -### {% linkable_title Light %} +### Light The `lcn` light platform allows the control of the following [LCN](http://www.lcn.eu) ports: - (Dimmable) output ports - Relays -### {% linkable_title Scene %} +### Scene The `lcn` scene platform allows the activation of previously programmed [LCN](http://www.lcn.eu) scenes. -### {% linkable_title Sensor %} +### Sensor The `lcn` sensor platform allows the monitoring of the following [LCN](http://www.lcn.eu) data sources: @@ -462,19 +462,19 @@ The sensor can be used in automation scripts or in conjunction with `template` p Otherwise the module might show unexpected behavior or return error messages.

-### {% linkable_title Switch %} +### Switch The `lcn` switch platform allows the control of the following [LCN](http://www.lcn.eu) ports: - Output ports - Relays -## {% linkable_title Services %} +## Services In order to directly interact with the LCN system, and invoke commands which are not covered by the implemented platforms, the following service calls can be used. Refer to the (Services Calls)[/docs/scripts/service-calls] page for examples on how to use them. -### {% linkable_title Service `output_abs` %} +### Service `output_abs` Set absolute brightness of output port in percent. @@ -496,7 +496,7 @@ data: transition: 0 ``` -### {% linkable_title Service `output_rel` %} +### Service `output_rel` Set relative brightness of output port in percent. @@ -517,7 +517,7 @@ data: brightness: 30 ``` -### {% linkable_title Service `output_toggle` %} +### Service `output_toggle` Toggle output port. @@ -537,7 +537,7 @@ data: transition: 0 ``` -### {% linkable_title Service `relays` %} +### Service `relays` Set the relays status. The relays states are defined as a string with eight characters. Each character represents the state change of a relay (1=on, 0=off, t=toggle, -=nochange). @@ -558,7 +558,7 @@ data: state: t---001- ``` -### {% linkable_title Service `led` %} +### Service `led` Set the led status. @@ -577,7 +577,7 @@ data: state: blink ``` -### {% linkable_title Service `var_abs` %} +### Service `var_abs` Set the absolute value of a variable or setpoint. If `value` is not defined, it is assumed to be 0. @@ -606,7 +606,7 @@ data: Otherwise the module might show unexpected behaviors or return error messages.

-### {% linkable_title Service `var_rel` %} +### Service `var_rel` Set the relative value of a variable or setpoint. If `value` is not defined, it is assumed to be 0. @@ -635,7 +635,7 @@ data: Otherwise the module might show unexpected behavior or return error messages.

-### {% linkable_title Service `var_reset` %} +### Service `var_reset` Reset value of variable or setpoint. @@ -658,7 +658,7 @@ data: Otherwise the module might show unexpected behavior or return error messages.

-### {% linkable_title Service `lock_regulator` %} +### Service `lock_regulator` Locks a regulator setpoint. If `state` is not defined, it is assumed to be `False`. @@ -679,7 +679,7 @@ data: state: true ``` -### {% linkable_title Service `send_keys` %} +### Service `send_keys` Send keys (which executes bound commands). The keys attribute is a string with one or more key identifiers. Example: `a1a5d8` @@ -716,7 +716,7 @@ data: time_unit: s ``` -### {% linkable_title Service `lock_keys` %} +### Service `lock_keys` Locks keys. If table is not defined, it is assumend to be table `a`. @@ -753,7 +753,7 @@ data: time_unit: s ``` -### {% linkable_title Service `dyn_text` %} +### Service `dyn_text` Send dynamic text to LCN-GTxD displays. The displays support four rows for text messages. @@ -776,7 +776,7 @@ data: text: "text in row 1" ``` -### {% linkable_title Service `pck` %} +### Service `pck` Send arbitrary PCK command. Only the command part of the PCK command has to be specified in the `pck` string. diff --git a/source/_components/lg_soundbar.markdown b/source/_components/lg_soundbar.markdown index 0bf1c27c243..c3a027d5a01 100644 --- a/source/_components/lg_soundbar.markdown +++ b/source/_components/lg_soundbar.markdown @@ -24,6 +24,6 @@ Supported devices: Compatible devices will be automatically added if the [`discovery`](/components/discovery/) integration is enabled. -### {% linkable_title Supported operations %} +### Supported operations - These devices support mute, volume control, source selection and mode selection. diff --git a/source/_components/life360.markdown b/source/_components/life360.markdown index 7037636417a..a1cbf577849 100644 --- a/source/_components/life360.markdown +++ b/source/_components/life360.markdown @@ -16,7 +16,7 @@ ha_iot_class: Cloud Polling The `life360` integration allows you to detect presence using the [unofficial API](#disclaimer) of [Life360](https://www.life360.com/). -## {% linkable_title Life360 Account %} +## Life360 Account You must first [create a Life360 account](https://www.life360.com/websignup). @@ -104,7 +104,7 @@ warning_threshold: type: integer {% endconfiguration %} -## {% linkable_title Additional attributes %} +## Additional attributes Attribute | Description -|- @@ -119,7 +119,7 @@ raw_speed | "Raw" speed value provided by Life360 server. (Units unknown.) speed | Estimated speed of device (in MPH or KPH depending on Home Assistant's unit system configuration.) wifi_on | Device WiFi is turned on (`true`/`false`.) -## {% linkable_title Filtering %} +## Filtering For most users, filtering is not needed, and in such cases, the corresponding configuration variables should not be used. @@ -133,11 +133,11 @@ For a particular Member to be tracked, they must be included (or at least not ex Note that Life360's app and website typically only show Members' first names. However, you must use their _full_ names here. If you're not sure what a Member's full name (i.e., first and last) is in Life360, ask them. Alternatively, you can set the [`logger`](https://www.home-assistant.io/components/logger/) to `debug` and look in `home-assistant.log`. The full names of all Life360 Circles & Members will be logged. -## {% linkable_title Home - Home Assistant vs. Life360 %} +## Home - Home Assistant vs. Life360 Normally Home Assistant device trackers are "Home" when they enter `zone.home`. Also, Life360 normally considers your device "Home" when it enters the Place that coincides with your home. Since the definitions of these areas can be different, this can lead to a disagreement between Home Assistant and Life360 as to whether or not you're "Home." To avoid this, make sure these two areas are defined the same -- i.e., same location and radius. (See next section.) -## {% linkable_title Home Assistant Zones & Life360 Places %} +## Home Assistant Zones & Life360 Places See [Zone documentation](https://www.home-assistant.io/components/zone/#home-zone) for details about how HA zones are defined. If you'd like to create HA zones from Life360 Places (e.g., to make HA's `zone.home` be identical to Life360's "Home Place"), make sure `logger` is set to `debug`. Then when HA starts the details of all the Places defined in the included Circles will be written to `home-assistant.log` in a format that can be copied into your configuration under `zone:`. E.g., you would see something like this: @@ -150,15 +150,15 @@ See [Zone documentation](https://www.home-assistant.io/components/zone/#home-zon radius: ZZZ ``` -## {% linkable_title Communication Errors %} +## Communication Errors It is not uncommon for communication errors to occur between Home Assistant and the Life360 server. This can happen for many reasons, including Internet connection issues, Life360 server load, etc. However, in most cases, they are temporary and do not significantly affect the ability to keep device_tracker entities up to date. Therefore, an optional filtering mechanism has been implemented to prevent inconsequential communication errors from filling the log, while still logging unusual error activity. Two thresholds are defined: [**warning_threshold**](#warning_threshold) and [**error_threshold**](#error_threshold). When a particular type of communication error happens on consecutive update cycles, it will not be logged until the number of occurrences reaches these thresholds. When the number reaches **warning_threshold** (but does not exceed **error_threshold**, and only if **warning_threshold** is defined), it will be logged as a WARNING. Once the number reaches **error_threshold**, it will be logged as an ERROR. Only two consecutive communication errors of a particular type will be logged as an ERROR, after which it will no longer be logged until it stops occurring and then happens again. -## {% linkable_title Examples %} +## Examples -### {% linkable_title Typical configuration %} +### Typical configuration {% raw %} ```yaml @@ -181,7 +181,7 @@ life360: ``` {% endraw %} -### {% linkable_title Circle and Member Filtering Example %} +### Circle and Member Filtering Example {% raw %} ```yaml @@ -195,7 +195,7 @@ life360: ``` {% endraw %} -### {% linkable_title Entering accounts in configuration %} +### Entering accounts in configuration {% raw %} ```yaml @@ -206,7 +206,7 @@ life360: ``` {% endraw %} -### {% linkable_title Example overdue update automations %} +### Example overdue update automations {% raw %} ```yaml @@ -241,6 +241,6 @@ automation: ``` {% endraw %} -## {% linkable_title Disclaimer %} +## Disclaimer It does not appear that Life360 officially supports its REST API for use with other than its own apps. This integration is based on reverse engineering that has been done by the open source community, and an API token that was somehow discovered by the same community. At any time Life360 could disable that token or otherwise change its REST API such that this integration would no longer work. diff --git a/source/_components/lifx.markdown b/source/_components/lifx.markdown index ce77866a3d6..7cab06739f8 100644 --- a/source/_components/lifx.markdown +++ b/source/_components/lifx.markdown @@ -21,13 +21,13 @@ _Please note, the `lifx` integration does not support Windows. The `lifx_legacy` You can configure the LIFX integration by going to the integrations page inside the config panel. -## {% linkable_title Set state %} +## Set state The LIFX bulbs allow a change of color and brightness even when they are turned off. This way you can control the light during the day so its settings are correct when events for turning on are received, for example from motion detectors or external buttons. The normal `light.turn_on` call cannot be used for this because it always turns the power on. Thus, LIFX has its own service call that allows color changes without affecting the current power state. -### {% linkable_title Service `light.lifx_set_state` %} +### Service `light.lifx_set_state` Change the light to a new state. @@ -40,7 +40,7 @@ Change the light to a new state. | `power` | Turn the light on (`True`) or off (`False`). Leave out to keep the power as it is. | `...` | Use `color_name`, `brightness` etc. from [`light.turn_on`]({{site_root}}/components/light/#service-lightturn_on) to specify the new state. -## {% linkable_title Light effects %} +## Light effects The LIFX platform supports several light effects. You can start these effects with default options by using the `effect` attribute of the normal [`light.turn_on`]({{site_root}}/components/light/#service-lightturn_on) service, for example like this: ```yaml @@ -72,7 +72,7 @@ script: The available light effects and their options are listed below. -### {% linkable_title Service `light.lifx_effect_pulse` %} +### Service `light.lifx_effect_pulse` Run a flash effect by changing to a color and then back. @@ -87,7 +87,7 @@ Run a flash effect by changing to a color and then back. | `mode` | The way to change between colors. Valid modes: `blink` (default - direct transition to new color for 'period' time with original color between cycles), `breathe` (color fade transition to new color and back to original), `ping` (short pulse of new color), `strobe` (light turns off between color changes), `solid`(light does not return to original color between cycles). | `power_on` | Set this to False to skip the effect on lights that are turned off (defaults to True). -### {% linkable_title Service `light.lifx_effect_colorloop` %} +### Service `light.lifx_effect_colorloop` Run an effect with colors looping around the color wheel. All participating lights will coordinate to keep similar (but not identical) colors. @@ -101,7 +101,7 @@ Run an effect with colors looping around the color wheel. All participating ligh | `spread` | Maximum color difference between participating lights, in degrees on a color wheel (ranges from 0 to 359). | `power_on` | Set this to False to skip the effect on lights that are turned off (defaults to True). -### {% linkable_title Service `light.lifx_effect_stop` %} +### Service `light.lifx_effect_stop` Run an effect that does nothing, thereby stopping any other effect that might be running. @@ -110,7 +110,7 @@ Run an effect that does nothing, thereby stopping any other effect that might be | `entity_id` | String or list of strings that point at `entity_id`s of lights. Else targets all. -## {% linkable_title Advanced configuration %} +## Advanced configuration There are some manual configuration options available. These are only needed with unusual network setups where automatic configuration does not find your LIFX devices. diff --git a/source/_components/light.group.markdown b/source/_components/light.group.markdown index 1af62ea6f99..574a556df2b 100644 --- a/source/_components/light.group.markdown +++ b/source/_components/light.group.markdown @@ -49,7 +49,7 @@ Example of the light group "Kitchen Lights". The supported features of all lights will be added together. For example, if you have one RGB light in a group of otherwise brightness-only lights, the light group will be shown with a color picker. -## {% linkable_title Script Example %} +## Script Example Here's an example of a script using the above light group. diff --git a/source/_components/light.knx.markdown b/source/_components/light.knx.markdown index 80149d6185d..c47374bfb91 100644 --- a/source/_components/light.knx.markdown +++ b/source/_components/light.knx.markdown @@ -23,7 +23,7 @@ The `knx light` integration is used as an interface to control knx actuators for The `knx` integration must be configured correctly to use this component, see [KNX Component](/components/knx). -## {% linkable_title Configuration %} +## Configuration To use your KNX light in your installation, add the following lines to your `configuration.yaml` file: @@ -99,7 +99,7 @@ For switching/light actuators that are only controlled by a single group address *Note on tunable white:* Home-Assistant uses Mireds as the unit for color temperature, whereas KNX typically uses Kelvin. The Kelvin/Mireds relationship is reciprocal, not linear, therefore the color temperature pickers (sliders) in Home-Assistant may not align with ones of KNX visualizations. This is the expected behavior. -## {% linkable_title Extended configuration example %} +## Extended configuration example ```yaml light: diff --git a/source/_components/light.markdown b/source/_components/light.markdown index d2b5c8f9041..caaa824f5c4 100644 --- a/source/_components/light.markdown +++ b/source/_components/light.markdown @@ -16,13 +16,13 @@ ha_release: pre 0.7 This integration allows you to track and control various light bulbs. Read the integration documentation for your particular light hardware to learn how to enable it. -### {% linkable_title Default turn-on values %} +### Default turn-on values To set the default color and brightness values when the light is turned on, create a custom `light_profiles.csv` (as described below in the `profile` attribute of `light.turn_on`). The `.default` suffix should be added to the entity identifier of each light to define a default value, e.g., for `light.ceiling_2` the `id` field is `light.ceiling_2.default`. To define a default for all lights, the identifier `group.all_lights.default` can be used. Individual settings always supercede the `all_lights` default setting. -### {% linkable_title Service `light.turn_on` %} +### Service `light.turn_on` Turns one light on or multiple lights on using [groups]({{site_root}}/components/group/). @@ -80,7 +80,7 @@ automation: rgb_color: [255,0,0] ``` -### {% linkable_title Service `light.turn_off` %} +### Service `light.turn_off` Turns one or multiple lights off. @@ -89,7 +89,7 @@ Turns one or multiple lights off. | `entity_id` | yes | String or list of strings that point at `entity_id`s of lights. Else targets all. | `transition` | yes | Integer that represents the time the light should take to transition to the new state in seconds. -### {% linkable_title Service `light.toggle` %} +### Service `light.toggle` Toggles the state of one or multiple lights using [groups]({{site_root}}/components/group/). Takes the same arguments as [`turn_on`](#service-lightturn_on) service. diff --git a/source/_components/light.mqtt.markdown b/source/_components/light.mqtt.markdown index 084a8f13e7e..35bbbdda890 100644 --- a/source/_components/light.mqtt.markdown +++ b/source/_components/light.mqtt.markdown @@ -19,7 +19,7 @@ ha_release: 0.8 The `mqtt` light platform with lets you control your MQTT enabled lights through one of the supported message schemas. -## {% linkable_title Comparison of light MQTT schemas %} +## Comparison of light MQTT schemas | Function | [`default`](#default-schema) | [`json`](#json-schema) | [`template`](#template-schema) | |-------------------|------------------------------------------------------------|----------------------------------------------------------------------|------------------------------------------------------------------------------| @@ -34,11 +34,11 @@ The `mqtt` light platform with lets you control your MQTT enabled lights through | White Value | ✔ | ✔ | ✔ | -## {% linkable_title Default schema %} +## Default schema The `mqtt` light platform with default schema lets you control your MQTT enabled lights. It supports setting brightness, color temperature, effects, flashing, on/off, RGB colors, transitions, XY colors and white values. -## {% linkable_title Default schema - Configuration %} +## Default schema - Configuration In an ideal scenario, the MQTT device will have a state topic to publish state changes. If these messages are published with a `RETAIN` flag, the MQTT light will receive an instant state update after subscription and will start with the correct state. Otherwise, the initial state of the switch will be `false` / `off`. @@ -274,11 +274,11 @@ device: XY and RGB can not be used at the same time. If both are provided, XY overrides RGB.

-## {% linkable_title Default schema - Examples %} +## Default schema - Examples In this section you will find some real-life examples of how to use this sensor. -### {% linkable_title Brightness and RGB support %} +### Brightness and RGB support To enable a light with brightness and RGB support in your installation, add the following to your `configuration.yaml` file: @@ -304,7 +304,7 @@ light: ``` {% endraw %} -### {% linkable_title Brightness and no RGB support %} +### Brightness and no RGB support To enable a light with brightness (no RGB version) in your installation, add the following to your `configuration.yaml` file: @@ -323,7 +323,7 @@ light: optimistic: false ``` -### {% linkable_title Brightness without on commands %} +### Brightness without on commands To enable a light that sends only brightness topics to turn it on, add the following to your `configuration.yaml` file. The `command_topic` is only used to send an off command in this case: @@ -340,13 +340,13 @@ light: on_command_type: 'brightness' ``` -## {% linkable_title Default schema - Implementations %} +## Default schema - Implementations - A [basic example](https://github.com/mertenats/open-home-automation/tree/master/ha_mqtt_light) using a nodeMCU board (ESP8266) to control its built-in LED (on/off). - Another [example](https://github.com/mertenats/open-home-automation/tree/master/ha_mqtt_rgb_light) to control a RGB LED (on/off, brightness, and colors). - [Integration guide](https://github.com/xoseperez/espurna/wiki/HomeAssistant) for the ESPUrna firmware (ESP8285/ESP8266). -## {% linkable_title JSON schema %} +## JSON schema The `mqtt` light platform with JSON schema lets you control a MQTT-enabled light that can receive [JSON](https://en.wikipedia.org/wiki/JSON) messages. @@ -372,7 +372,7 @@ This schema supports on/off, brightness, RGB colors, XY colors, color temperatur } ``` -## {% linkable_title JSON schema - Configuration %} +## JSON schema - Configuration In an ideal scenario, the MQTT device will have a state topic to publish state changes. If these messages are published with the RETAIN flag, the MQTT light will receive an instant state update after subscription and will start with the correct state. Otherwise, the initial state of the light will be off. @@ -536,11 +536,11 @@ device: RGB, XY and HSV can not be used at the same time in `state_topic` messages. Make sure that only one of the color models is in the "color" section of the state MQTT payload.

-## {% linkable_title JSON schema - Examples %} +## JSON schema - Examples In this section you find some real-life examples of how to use this sensor. -### {% linkable_title Brightness and RGB support %} +### Brightness and RGB support To enable a light with brightness and RGB support in your installation, add the following to your `configuration.yaml` file: @@ -556,7 +556,7 @@ light: rgb: true ``` -### {% linkable_title Brightness and no RGB support %} +### Brightness and no RGB support To enable a light with brightness (but no color support) in your installation, add the following to your `configuration.yaml` file: @@ -571,7 +571,7 @@ light: brightness: true ``` -### {% linkable_title Brightness Scaled %} +### Brightness Scaled To enable a light using a brightness scale other than 8bit the `brightness_scale` option may be added to denote the "fully on" value: ```yaml @@ -595,7 +595,7 @@ Home Assistant will then convert its 8bit value in the message to and from the d } ``` -### {% linkable_title HS Color %} +### HS Color To use a light with hue+saturation as the color model, set `hs` to `true` in the platform configuration: @@ -621,7 +621,7 @@ Home Assistant expects the hue values to be in the range 0 to 360 and the satura } ``` -### {% linkable_title Brightness and RGBW support %} +### Brightness and RGBW support To enable a light with brightness, RGB support and a separate white channel (RGBW) in your installation, add the following to your `configuration.yaml` file: @@ -639,7 +639,7 @@ light: ``` -## {% linkable_title Implementations %} +## Implementations - A full example of custom lighting using this platform and an ESP8266 microcontroller can be found [here](https://github.com/corbanmailloux/esp-mqtt-rgb-led). It supports on/off, brightness, transitions, RGB colors, and flashing. @@ -653,14 +653,14 @@ light: - [AiLight](https://github.com/stelgenhof/AiLight) is a custom firmware for the Ai-Thinker (and equivalent) RGBW WiFi light bulbs that has an ESP8266 onboard and controlled by the MY9291 LED driver. It implements the [MQTT JSON light](/components/light.mqtt_json/) platform and supports ON/OFF, RGBW colours, brightness, colour temperature, flashing and transitions. Also it includes [MQTT Auto Discovery](/docs/mqtt/discovery/)) and the MQTT Last Will and Testament is enabled as well. -## {% linkable_title Template schema %} +## Template schema The `mqtt` light platform with template schema lets you control a MQTT-enabled light that receive commands on a command topic and optionally sends status update on a state topic. It is format-agnostic so you can use any data format you want (i.e. string, JSON), just configure it with templating. This schema supports on/off, brightness, RGB colors, XY colors, color temperature, transitions, short/long flashing, effects and white values. -## {% linkable_title Template schema - Configuration %} +## Template schema - Configuration In an ideal scenario, the MQTT device will have a state topic to publish state changes. If these messages are published with the RETAIN flag, the MQTT light will receive an instant state update after subscription and will start with the correct state. Otherwise, the initial state of the light will be off. @@ -806,11 +806,11 @@ device: Make sure that your topics match exact. `some-topic/` and `some-topic` are different topics.

-## {% linkable_title Template schema - Examples %} +## Template schema - Examples In this section you find some real-life examples of how to use this light. -### {% linkable_title Simple string payload %} +### Simple string payload For a simple string payload with the format `state,brightness,r-g-b` (e.g., `on,255,255-255-255`), add the following to your `configuration.yaml` file: @@ -830,7 +830,7 @@ light: blue_template: "{% raw %}{{ value.split(',')[2].split('-')[2] }}{% endraw %}" ``` -### {% linkable_title JSON payload %} +### JSON payload For a JSON payload with the format `{"state": "on", "brightness": 255, "color": [255, 255, 255], "effect": "rainbow"}`, add the following to your `configuration.yaml` file: @@ -865,6 +865,6 @@ light: effect_template: '{% raw %}{{ value_json.effect }}{% endraw %}' ``` -### {% linkable_title Template schema - No brightness or color support %} +### Template schema - No brightness or color support If you don't want brightness, color or effect support, just omit the corresponding configuration sections. diff --git a/source/_components/light.mysensors.markdown b/source/_components/light.mysensors.markdown index b5c8cae29f7..150d4ca21a9 100644 --- a/source/_components/light.mysensors.markdown +++ b/source/_components/light.mysensors.markdown @@ -39,7 +39,7 @@ Sketch should acknowledge a command sent from controller with the same type. If For more information, visit the [serial api] of MySensors. -### {% linkable_title MySensors 1.x example sketch %} +### MySensors 1.x example sketch ```cpp /* @@ -114,7 +114,7 @@ void incomingMessage(const MyMessage &message) { } ``` -### {% linkable_title MySensors 2.x example sketch %} +### MySensors 2.x example sketch ```cpp /* diff --git a/source/_components/light.rflink.markdown b/source/_components/light.rflink.markdown index f1a0024a4a1..5a16281dc38 100644 --- a/source/_components/light.rflink.markdown +++ b/source/_components/light.rflink.markdown @@ -119,7 +119,7 @@ devices: type: [list, string] {% endconfiguration %} -### {% linkable_title Light state %} +### Light state Initially the state of a light is unknown. When the light is turned on or off (via frontend or remote) the state is known and will be shown in the frontend. @@ -138,7 +138,7 @@ light: Any on/off command from any alias ID updates the current state of the light. However when sending a command through the frontend only the primary ID is used. -### {% linkable_title Light types %} +### Light types Light devices can come in different forms. Some only switch on and off, other support dimming. Dimmable devices might not always respond nicely to repeated `on` command as they turn into a pulsating state until `on` is pressed again (for example KlikAanKlikUit). The RFLink integration support three types of lights to make things work in every situation: @@ -149,7 +149,7 @@ Light devices can come in different forms. Some only switch on and off, other su By default new lights are assigned the `switchable` type. Protocol supporting dimming are assigned the `hybrid` type. Currently only `newkaku` protocol is detected as dimmable. Please refer to Device Support to get your dimmers supported. -### {% linkable_title Hiding/ignoring lights %} +### Hiding/ignoring lights Lights are added automatically when the RFLink gateway intercepts a wireless command in the ether. To prevent cluttering the frontend use any of these methods: @@ -157,11 +157,11 @@ Lights are added automatically when the RFLink gateway intercepts a wireless com - Hide unwanted devices using [customizations](/getting-started/customizing-devices/) - [Ignore devices on a platform level](/components/rflink/#ignoring-devices) -### {% linkable_title Device support %} +### Device support See [device support](/components/rflink/#device-support) -### {% linkable_title Additional configuration examples %} +### Additional configuration examples Multiple lights with `signal_repetitions` and custom names diff --git a/source/_components/light.template.markdown b/source/_components/light.template.markdown index e38f011e1bd..54f1f79cd38 100644 --- a/source/_components/light.template.markdown +++ b/source/_components/light.template.markdown @@ -85,7 +85,7 @@ light: type: action {% endconfiguration %} -## {% linkable_title Considerations %} +## Considerations If you are using the state of a platform that takes extra time to load, the Template Light may get an `unknown` state during startup. This results @@ -97,11 +97,11 @@ with this equivalent that returns `true`/`false` and never gives an unknown result: {% raw %}`{{ is_state('switch.source', 'on') }}`{% endraw %} -## {% linkable_title Examples %} +## Examples In this section you will find some real-life examples of how to use this light. -### {% linkable_title Theater Volume Control %} +### Theater Volume Control This example shows a light that is actually a home theater's volume. This component gives you the flexibility to provide whatever you'd like to send as @@ -150,7 +150,7 @@ light: ``` {% endraw %} -### {% linkable_title Change The Icon %} +### Change The Icon This example shows how to change the icon based on the light state. @@ -194,7 +194,7 @@ light: ``` {% endraw %} -### {% linkable_title Change The Entity Picture %} +### Change The Entity Picture This example shows how to change the entity picture based on the light state. diff --git a/source/_components/light.xiaomi_miio.markdown b/source/_components/light.xiaomi_miio.markdown index 7b03b3f3c12..ab2f1cd46ac 100644 --- a/source/_components/light.xiaomi_miio.markdown +++ b/source/_components/light.xiaomi_miio.markdown @@ -136,9 +136,9 @@ model: type: string {% endconfiguration %} -## {% linkable_title Platform Services %} +## Platform Services -### {% linkable_title Service `light.xiaomi_miio_set_scene` %} +### Service `light.xiaomi_miio_set_scene` Set one of the 4 available fixed scenes. @@ -147,7 +147,7 @@ Set one of the 4 available fixed scenes. | `entity_id` | yes | Only act on a specific light. Else targets all. | | `scene` | no | Scene, between 1 and 4. | -### {% linkable_title Service `light.xiaomi_miio_set_delayed_turn_off` %} +### Service `light.xiaomi_miio_set_delayed_turn_off` Delayed turn off. @@ -156,7 +156,7 @@ Delayed turn off. | `entity_id` | yes | Only act on a specific light. Else targets all. | | `time_period` | no | Time period for the delayed turn off. | -### {% linkable_title Service `light.xiaomi_miio_reminder_on` %} (Eyecare Smart Lamp 2 only) +### Service `light.xiaomi_miio_reminder_on` (Eyecare Smart Lamp 2 only) Enable the eye fatigue reminder/notification. @@ -164,7 +164,7 @@ Enable the eye fatigue reminder/notification. |---------------------------|----------|-------------------------------------------------------| | `entity_id` | yes | Only act on a specific light. Else targets all. | -### {% linkable_title Service `light.xiaomi_miio_reminder_off` %} (Eyecare Smart Lamp 2 only) +### Service `light.xiaomi_miio_reminder_off` (Eyecare Smart Lamp 2 only) Disable the eye fatigue reminder/notification. @@ -172,7 +172,7 @@ Disable the eye fatigue reminder/notification. |---------------------------|----------|-------------------------------------------------------| | `entity_id` | yes | Only act on a specific light. Else targets all. | -### {% linkable_title Service `light.xiaomi_miio_night_light_mode_on` %} (Eyecare Smart Lamp 2 only) +### Service `light.xiaomi_miio_night_light_mode_on` (Eyecare Smart Lamp 2 only) Turn the smart night light mode on. @@ -180,7 +180,7 @@ Turn the smart night light mode on. |---------------------------|----------|-------------------------------------------------------| | `entity_id` | yes | Only act on a specific light. Else targets all. | -### {% linkable_title Service `light.xiaomi_miio_night_light_mode_off` %} (Eyecare Smart Lamp 2 only) +### Service `light.xiaomi_miio_night_light_mode_off` (Eyecare Smart Lamp 2 only) Turn the smart night light mode off. @@ -188,7 +188,7 @@ Turn the smart night light mode off. |---------------------------|----------|-------------------------------------------------------| | `entity_id` | yes | Only act on a specific light. Else targets all. | -### {% linkable_title Service `light.xiaomi_miio_eyecare_mode_on` %} (Eyecare Smart Lamp 2 only) +### Service `light.xiaomi_miio_eyecare_mode_on` (Eyecare Smart Lamp 2 only) Turn the eyecare mode on. @@ -196,7 +196,7 @@ Turn the eyecare mode on. |---------------------------|----------|-------------------------------------------------------| | `entity_id` | yes | Only act on a specific light. Else targets all. | -### {% linkable_title Service `light.xiaomi_miio_eyecare_mode_off` %} (Eyecare Smart Lamp 2 only) +### Service `light.xiaomi_miio_eyecare_mode_off` (Eyecare Smart Lamp 2 only) Turn the eyecare mode off. diff --git a/source/_components/limitlessled.markdown b/source/_components/limitlessled.markdown index f5853c4d083..1bd989a41ee 100644 --- a/source/_components/limitlessled.markdown +++ b/source/_components/limitlessled.markdown @@ -24,7 +24,7 @@ Note: you can assign an `rgbw`, `rgbww`, `white` and `dimmer` group to the same An archive of the extensive API can be found [here](https://github.com/Fantasmos/LimitlessLED-DevAPI). -### {% linkable_title Setup %} +### Setup Before configuring Home Assistant, make sure you can control your bulbs or LEDs with the MiLight mobile application. Next, discover your bridge(s) IP address. You can do this via your router or a mobile application like Fing ([android](https://play.google.com/store/apps/details?id=com.overlook.android.fing&hl=en) or [iTunes](https://itunes.apple.com/us/app/fing-network-scanner/id430921107?mt=8)). @@ -103,7 +103,7 @@ bridges: type: boolean {% endconfiguration %} -### {% linkable_title Night Effect %} +### Night Effect LimitlessLED has a `night` effect that can be used to dim the lights below `brightness: 1`. This night mode is meant to temporarily turn the lights into a nightlight. This mode can be especially helpful when wall switches are also being used. For example, when a light is using the `night` effect one way to return it to its previous brightness level (other than using Home Assistant) is to switch the lights off and then back on from the wall switch. @@ -121,7 +121,7 @@ automation: effect: night ``` -### {% linkable_title Properties %} +### Properties Refer to the [light]({{site_root}}/components/light/) documentation for general property usage, but keep in mind the following notes specific to LimitlessLED. @@ -142,7 +142,7 @@ Refer to the [light]({{site_root}}/components/light/) documentation for general - **Transitions** - If a transition time is set, the group will transition between the current settings and the target settings for the duration specified. Transitions from or to white are not possible - the color will change immediately. -### {% linkable_title Initialization & Synchronization %} +### Initialization & Synchronization When starting Home Assistant, the last recorded state will be shown. This might no longer match the actual state of the bulbs. diff --git a/source/_components/linksys_ap.markdown b/source/_components/linksys_ap.markdown index 3cc93ad60b3..e4bf531c8f3 100644 --- a/source/_components/linksys_ap.markdown +++ b/source/_components/linksys_ap.markdown @@ -19,7 +19,7 @@ The `linksys_ap` platform offers presence detection by looking at connected devi It was tested with a LAPAC1750 AC1750 Dual Band Access Point. -## {% linkable_title Configuration %} +## Configuration To use a Linksys Access Point in your installation, add the following to your `configuration.yaml` file: @@ -52,7 +52,7 @@ verify_ssl: type: boolean {% endconfiguration %} -## {% linkable_title Example %} +## Example Example for all configuration options: diff --git a/source/_components/linksys_smart.markdown b/source/_components/linksys_smart.markdown index de5c03ff4be..f0132a9ad64 100644 --- a/source/_components/linksys_smart.markdown +++ b/source/_components/linksys_smart.markdown @@ -22,11 +22,11 @@ Tested routers: - Linksys WRT3200ACM MU-MIMO Gigabit Wi-Fi Wireless Router - Linksys WRT1900ACS Dual-band Wi-Fi Router -## {% linkable_title Setup %} +## Setup For this platform to work correctly, it is necessary to disable the "Access via wireless" feature in the Local Management Access section of the router administration page. If "Access via wireless" is not disabled, a connectivity conflict arises because the Home Assistant integration is trying to pass userid and password, but the router is only expecting a password. -## {% linkable_title Configuration %} +## Configuration To use a Linksys Smart Wifi Router in your Home Assistant installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/linky.markdown b/source/_components/linky.markdown index fe8b2189450..e4f1fd52164 100644 --- a/source/_components/linky.markdown +++ b/source/_components/linky.markdown @@ -19,7 +19,7 @@ redirect_from: The `linky` sensor platform is retrieving the consumption of your home from the [Linky electric meter](https://www.enedis.fr/linky-compteur-communicant). -## {% linkable_title Configuration %} +## Configuration First, you need to create an Enedis account [here](https://espace-client-connexion.enedis.fr/auth/UI/Login?realm=particuliers), if you don't have already one. diff --git a/source/_components/linode.markdown b/source/_components/linode.markdown index 758879c2c9f..fe02e625b87 100644 --- a/source/_components/linode.markdown +++ b/source/_components/linode.markdown @@ -26,7 +26,7 @@ There is currently support for the following device types within Home Assistant: - [Binary Sensor](#binary-sensor) - [Switch](#switch) -## {% linkable_title Setup %} +## Setup Obtain your oAuth2 Access Token from Linode account. @@ -36,7 +36,7 @@ Obtain your oAuth2 Access Token from Linode account. - Create a Personal Access Token, - Assigned scope (Please choose the least possible access required.) -## {% linkable_title Configuration %} +## Configuration To integrate Linode with Home Assistant, add the following section to your `configuration.yaml` file: @@ -53,7 +53,7 @@ linode: type: string {% endconfiguration %} -## {% linkable_title Binary Sensor %} +## Binary Sensor The `linode` binary sensor platform allows you to monitor your Linode nodes. @@ -74,7 +74,7 @@ nodes: type: string {% endconfiguration %} -## {% linkable_title Switch %} +## Switch The `linode` switch platform allows you to turn your Linode nodes on and off. diff --git a/source/_components/lirc.markdown b/source/_components/lirc.markdown index 31021895773..71d386d78fc 100644 --- a/source/_components/lirc.markdown +++ b/source/_components/lirc.markdown @@ -18,7 +18,7 @@ ha_iot_class: Local Push Sending IR commands is not supported in this integration (yet), but can be accomplished using the [shell_command component](/components/shell_command/) in conjunction with the `irsend` command. -### {% linkable_title Installation %} +### Installation To allow Home Assistant to talk to your IR receiver, you need to first make sure you have the correct dependencies installed: @@ -37,7 +37,7 @@ The configuration is slightly different : For more information have a look at `/usr/share/doc/lirc/README.Debian.gz` where the update process is explained when you have updated from jessie to stretch.

-### {% linkable_title Configuring LIRC %} +### Configuring LIRC Now teach LIRC about your particular remote control by preparing a lircd configuration file (`/etc/lirc/lircd.conf`). Search the [LIRC remote database](http://lirc.sourceforge.net/remotes/) for your model. If you can't find it, then you can always use the `irrecord` program to learn your remote. This will create a valid configuration file. Add as many remotes as you want by pasting them into the file. If `irrecord` doesn't work (e.g., for some air conditioner remotes), then the `mode2` program is capable of reading the codes in raw mode, followed by `irrecord -a` to extract hex codes. @@ -73,14 +73,14 @@ $ ircat home-assistant and pressing some buttons on the remote. You should see them register on the screen if LIRC is properly configured. -### {% linkable_title Configuration Home Assistant %} +### Configuration Home Assistant ```yaml # Example configuration.yaml entry lirc: ``` -#### {% linkable_title Events %} +#### Events The LIRC integration fires `ir_command_received` events on the bus. You can capture the events and respond to them in automation scripts like this: diff --git a/source/_components/liveboxplaytv.markdown b/source/_components/liveboxplaytv.markdown index 796f25f8bc2..dc4e1815fed 100644 --- a/source/_components/liveboxplaytv.markdown +++ b/source/_components/liveboxplaytv.markdown @@ -18,7 +18,7 @@ redirect_from: The `liveboxplaytv` platform allows you to control [Orange Livebox Play TV appliances](https://boutique.orange.fr/internet/decodeur-tv-livebox). -## {% linkable_title Configuration %} +## Configuration To add an Orange Livebox Play TV to your installation, add the following to your `configuration.yaml` file: @@ -46,7 +46,7 @@ port: type: integer {% endconfiguration %} -## {% linkable_title Full configuration %} +## Full configuration A full configuration example for an Orange TV appliance can look like this: diff --git a/source/_components/local_file.markdown b/source/_components/local_file.markdown index 84ac707ae03..218b9cd142f 100644 --- a/source/_components/local_file.markdown +++ b/source/_components/local_file.markdown @@ -20,7 +20,7 @@ The `local_file` camera platform allows you to integrate an image file from disk The `local_file` camera can for example be used with various camera platforms that save a temporary images locally. It can also be used to display a graph that you render periodically and will then be displayed in Home Assistant. -## {% linkable_title Configuration %} +## Configuration To enable this camera in your installation, add the following to your `configuration.yaml` file: @@ -42,7 +42,7 @@ name: type: string {% endconfiguration %} -### {% linkable_title Service `camera.local_file_update_file_path` %} +### Service `camera.local_file_update_file_path` Use this service to change the file displayed by the camera. diff --git a/source/_components/lock.markdown b/source/_components/lock.markdown index bc08dc77371..b5e7ad675d9 100644 --- a/source/_components/lock.markdown +++ b/source/_components/lock.markdown @@ -19,11 +19,11 @@ Keeps track which locks are in your environment, their state and allows you to c * Maintains a state per lock and a combined state `all_locks`. * Registers services `lock.lock`, `lock.unlock` and `lock.open` (unlatch) to control locks. -### {% linkable_title Services %} +### Services A lock integration provides the following services: -#### {% linkable_title Service `lock.lock` %} +#### Service `lock.lock` Lock your door, the attribute should appear under a 'data' attribute for the service. @@ -31,7 +31,7 @@ Lock your door, the attribute should appear under a 'data' attribute for the ser |---------------------------|----------|-------------------------------------------------------| | `entity_id` | no | Entity of the relevant lock. | -##### {% linkable_title Example %} +##### Example ```yaml action: @@ -40,7 +40,7 @@ action: entity_id: lock.my_place ``` -#### {% linkable_title Service `lock.unlock` %} +#### Service `lock.unlock` Unlock your door, the attribute should appear under a 'data' attribute for the service. @@ -48,7 +48,7 @@ Unlock your door, the attribute should appear under a 'data' attribute for the s |---------------------------|----------|-------------------------------------------------------| | `entity_id` | no | Entity of the relevant lock. | -##### {% linkable_title Example %} +##### Example ```yaml action: @@ -57,7 +57,7 @@ action: entity_id: lock.my_place ``` -### {% linkable_title Use the services %} +### Use the services Go to the **Developer Tools**, then to **Call Service** in the frontend, and choose `lock.lock`, `lock.unlock` or `lock.open` from the list of available services (**Services:** on the left). Enter something like the sample below into the **Service Data** field and hit **CALL SERVICE**. diff --git a/source/_components/lock.mqtt.markdown b/source/_components/lock.mqtt.markdown index b35d237aa9c..fb4d2ebffc7 100644 --- a/source/_components/lock.mqtt.markdown +++ b/source/_components/lock.mqtt.markdown @@ -16,7 +16,7 @@ ha_iot_class: Configurable The `mqtt` lock platform lets you control your MQTT enabled locks. -## {% linkable_title Configuration %} +## Configuration In an ideal scenario, the MQTT device will have a `state_topic` to publish state changes. If these messages are published with a `RETAIN` flag, the MQTT lock will receive an instant state update after subscription and will start with correct state. Otherwise, the initial state of the lock will be `false` / unlocked. @@ -137,11 +137,11 @@ device: Make sure that your topics match exactly. `some-topic/` and `some-topic` are different topics.

-## {% linkable_title Examples %} +## Examples In this section you will find some real-life examples of how to use this lock. -### {% linkable_title Full configuration %} +### Full configuration The example below shows a full configuration for a MQTT lock. diff --git a/source/_components/lock.template.markdown b/source/_components/lock.template.markdown index c138f82247f..dda6caa7207 100644 --- a/source/_components/lock.template.markdown +++ b/source/_components/lock.template.markdown @@ -23,7 +23,7 @@ This can simplify the GUI and make it easier to write automations. You can mark In optimistic mode, the lock will immediately change state after every command. Otherwise, the lock will wait for state confirmation from the template. Try to enable it, if experiencing incorrect lock operation. -## {% linkable_title Configuration %} +## Configuration To enable Template Locks in your installation, add the following to your `configuration.yaml` file: @@ -70,15 +70,15 @@ lock: default: false {% endconfiguration %} -## {% linkable_title Considerations %} +## Considerations If you are using the state of a platform that takes extra time to load, the Template Lock may get an `unknown` state during startup. This results in error messages in your log file until that platform has completed loading. If you use `is_state()` function in your template, you can avoid this situation. For example, you would replace {% raw %}`{{ is_state('switch.source', 'on') }}`{% endraw %} with this equivalent that returns `true`/`false` and never gives an unknown result: {% raw %}`{{ is_state('switch.source', 'on') }}`{% endraw %} -## {% linkable_title Examples %} +## Examples In this section, you find some real-life examples of how to use this lock. -### {% linkable_title Lock from Switch %} +### Lock from Switch This example shows a lock that copies data from a switch. @@ -99,7 +99,7 @@ lock: ``` {% endraw %} -### {% linkable_title Optimistic Mode %} +### Optimistic Mode This example shows a lock in optimistic mode. This lock will immediately change state after command and will not wait for state update from the sensor. @@ -121,7 +121,7 @@ lock: ``` {% endraw %} -### {% linkable_title Sensor and Two Switches %} +### Sensor and Two Switches This example shows a lock that takes its state from a sensor, and uses two momentary switches to control a device. diff --git a/source/_components/lockitron.markdown b/source/_components/lockitron.markdown index ac7875556cd..663a1aa2f40 100644 --- a/source/_components/lockitron.markdown +++ b/source/_components/lockitron.markdown @@ -18,11 +18,11 @@ redirect_from: The `lockitron` platform allows you to control your [Lockitron](https://lockitron.com/) lock from within Home Assistant. -## {% linkable_title Setup %} +## Setup In order to get the correct `access_token` and `id`, log on to their [developer page](https://api.lockitron.com/), create a new app, and get the access_token they give you. Then, call the retrieve all locks function on the page and get the id of your lock (make sure you get your lock's id and not the virtual lock they create for you). -## {% linkable_title Configuration %} +## Configuration To enable the lock, add the following lines to your `configuration.yaml` file: diff --git a/source/_components/logbook.markdown b/source/_components/logbook.markdown index 5ed22180c9c..051ce219e7b 100644 --- a/source/_components/logbook.markdown +++ b/source/_components/logbook.markdown @@ -106,7 +106,7 @@ logbook: - sensor.date ``` -### {% linkable_title Exclude Events %} +### Exclude Events Entities customized as hidden are excluded from the logbook by default, but sometimes you want to show the entity in the UI and not in the logbook. @@ -120,7 +120,7 @@ list. For instance you use the `sun` domain only to trigger automations on the `azimuth` attribute, then you possible are not interested in the logbook entries for sun rise and sun set. -### {% linkable_title Custom Entries %} +### Custom Entries It is possible to add custom entries to the logbook by using the script component to fire an event. diff --git a/source/_components/logger.markdown b/source/_components/logger.markdown index 8e3ec41f2c5..009601811c5 100644 --- a/source/_components/logger.markdown +++ b/source/_components/logger.markdown @@ -77,7 +77,7 @@ logger: type: '[log_level](#log-levels)' {% endconfiguration %} -### {% linkable_title Log Levels %} +### Log Levels Possible log severity levels, listed in order from most severe to least severe, are: @@ -90,9 +90,9 @@ Possible log severity levels, listed in order from most severe to least severe, - debug - notset -## {% linkable_title Services %} +## Services -### {% linkable_title Service `set_default_level` %} +### Service `set_default_level` You can alter the default log level (for integrations without a specified log level) using the service `logger.set_default_level`. @@ -105,7 +105,7 @@ data: level: info ``` -### {% linkable_title Service `set_level` %} +### Service `set_level` You can alter log level for one or several integrations using the service `logger.set_level`. It accepts the same format as `logs` in the configuration. diff --git a/source/_components/logi_circle.markdown b/source/_components/logi_circle.markdown index 81255182169..71bbfd151d7 100644 --- a/source/_components/logi_circle.markdown +++ b/source/_components/logi_circle.markdown @@ -20,7 +20,7 @@ redirect_from: The `logi_circle` implementation allows you to integrate your [Logi Circle](https://circle.logi.com/) cameras in Home Assistant. To connect Logi Circle, you will have to [sign up for API access](#requesting-api-access) and get a `client_id`, `client_secret` and `api_key`. -## {% linkable_title Requesting API access %} +## Requesting API access 1. Navigate to the [Circle OAuth2 Client Request Form](https://docs.google.com/forms/d/184FUILJ10rVxotyOQR5DAiu6GcCbK31AZszUdzT1ybs). 2. Fill out your contact name and e-mail address. @@ -40,7 +40,7 @@ The `logi_circle` implementation allows you to integrate your [Logi Circle](http Please note that the turn-around time for API access takes a few business days after which you will be contacted by Logitech using the email address you provided in the form. -## {% linkable_title Configuration %} +## Configuration To integrate cameras linked with your [Logi Circle](https://circle.logi.com/) account, add the following to your `configuration.yaml` file: @@ -75,13 +75,13 @@ redirect_uri: type: string {% endconfiguration %} -### {% linkable_title Camera %} +### Camera The `logi_circle` camera platform allows you to view still frames from your [Logi Circle](https://circle.logi.com/) camera's live stream in Home Assistant. Logi Circle cameras support the `camera.turn_on` and `camera.turn_off` services. This will set the streaming mode property of your camera accordingly, controlling whether the live stream is available and activity recordings are captured. -### {% linkable_title Sensor %} +### Sensor The `logi_circle` sensor platform lets you monitor sensors connected to your [Logi Circle](https://circle.logi.com) cameras in Home Assistant. @@ -128,11 +128,11 @@ sensor: description: The soft on/off status of the camera. {% endconfiguration %} -## {% linkable_title Services %} +## Services The `logi_circle` platform exposes 3 services for interacting with your Logi Circle device. When calling a service with one or more entity IDs, please ensure you target the camera entity (eg. `camera.living_room_camera`). -### {% linkable_title Service `logi_circle.livestream_record` %} +### Service `logi_circle.livestream_record` Initiates a recording of the camera's live stream. @@ -144,7 +144,7 @@ Initiates a recording of the camera's live stream. The path part of `filename` must be an entry in the `whitelist_external_dirs` in your [`homeassistant:`](/docs/configuration/basic/) section of your `configuration.yaml` file. -### {% linkable_title Service `logi_circle.livestream_snapshot` %} +### Service `logi_circle.livestream_snapshot` Take a snapshot from a camera's live stream. This differs from the generic [snapshot](/components/camera/#service-snapshot) service in that explicitly requests a fresh image from Logi Circle's API. This will force cameras in a deep sleep state to wake. @@ -157,7 +157,7 @@ Please note that new snapshots will only be generated if the cached snapshot is The path part of `filename` must be an entry in the `whitelist_external_dirs` in your [`homeassistant:`](/docs/configuration/basic/) section of your `configuration.yaml` file. -### {% linkable_title Service `logi_circle.set_config` %} +### Service `logi_circle.set_config` Sets a configuration property for your camera. diff --git a/source/_components/luftdaten.markdown b/source/_components/luftdaten.markdown index aa8e259f80f..bd1a91f1c49 100644 --- a/source/_components/luftdaten.markdown +++ b/source/_components/luftdaten.markdown @@ -20,12 +20,12 @@ redirect_from: The `luftdaten` integration will query the open data API of [luftdaten.info](http://luftdaten.info) to monitor air quality and other weather data from a specific (self build) sensor station. -## {% linkable_title Setup %} +## Setup - To get the ID of a particle sensor you need to select it on the [Feinstaub map](http://deutschland.maps.luftdaten.info/) and find it in the sidebar (Column "Sensor ID"). - To get the ID of a temperature/humidity sensor you need to find it on the map hosted on [Madavi](https://www.madavi.de/sensor/feinstaub-map-dht/). -## {% linkable_title Configuration via the frontend %} +## Configuration via the frontend Menu: **Configuration** -> **Integrations** @@ -34,7 +34,7 @@ Configure the integration: - Enter the **Sensor ID** - Choose if you want to show the sensor's location on the map. -## {% linkable_title Manual Configuration %} +## Manual Configuration To enable this sensor, add the following lines to your `configuration.yaml` file: @@ -90,7 +90,7 @@ Not all sensors provide all conditions. Also, it's possible that the sensor valu $ curl https://api.luftdaten.info/v1/sensor/[sensorid]/ ``` -## {% linkable_title Full example %} +## Full example This example would use the sensor with the ID 155, show it on the `map` and would monitor `temperature` and `humidity`. @@ -105,7 +105,7 @@ luftdaten: - humidity ``` -## {% linkable_title Sensor %} +## Sensor The `luftdaten` sensor platform will query the open data API of [luftdaten.info](http://luftdaten.info) to monitor air quality and other weather data from a specific (self build) sensor station. diff --git a/source/_components/lupusec.markdown b/source/_components/lupusec.markdown index adbf025d5b1..629121651fa 100644 --- a/source/_components/lupusec.markdown +++ b/source/_components/lupusec.markdown @@ -33,7 +33,7 @@ The following devices are supported by the underlying `lupupy` Python library an - **Binary Sensor**: Displays the status of binary sensors. Currently only Door and window sensors are supported. - **Switch**: Turn off and on your Lupus power switches. -## {% linkable_title Configuration %} +## Configuration To use Lupusec devices in your installation, add the following `lupusec` section to your `configuration.yaml` file: diff --git a/source/_components/lutron.markdown b/source/_components/lutron.markdown index 753c58008af..a7f5459a602 100644 --- a/source/_components/lutron.markdown +++ b/source/_components/lutron.markdown @@ -27,7 +27,7 @@ redirect_from: Presently, there's only support for communicating with the [RadioRA 2](http://www.lutron.com/en-US/Products/Pages/WholeHomeSystems/RadioRA2/Overview.aspx) Main Repeater and only handle light switches, dimmers, and seeTouch keypad scenes. -## {% linkable_title Configuration %} +## Configuration When configured, the `lutron` integration will automatically discover the rooms and their associated switches/dimmers as configured by the RadioRA 2 software from Lutron. Each room will be treated as a separate group. @@ -60,7 +60,7 @@ password: It is recommended to assign a static IP address to your main repeater. This ensures that it won't change IP addresses, so you won't have to change the `host` if it reboots and comes up with a different IP address.

-## {% linkable_title Keypad buttons %} +## Keypad buttons Individual buttons on keypads are not represented as entities. Instead, they fire events called `lutron_event` whose payloads include `id` and `action` attributes. @@ -72,7 +72,7 @@ For raise/lower buttons (dimmer buttons, shade controls, etc.) there will be two For single-action buttons (scene selection, etc.), `action` will be `single`, and there will only be one event fired. This is a limitation of the Lutron controller which doesn't give Home Assistant any way of knowing when a single-action button is released. -## {% linkable_title Scene %} +## Scene This integration uses keypad programming to identify scenes. Currently, it only works with SeeTouch keypads. The Lutron scene platform allows you to control scenes programmed into your SeeTouch keypads. diff --git a/source/_components/lutron_caseta.markdown b/source/_components/lutron_caseta.markdown index ec5aeb37fb2..4e9e436cc6a 100644 --- a/source/_components/lutron_caseta.markdown +++ b/source/_components/lutron_caseta.markdown @@ -76,7 +76,7 @@ Use a DHCP reservation on your router to reserve the address or in the PRO model To get Lutron Caseta roller, honeycomb shades, lights, scene and switch working with Home Assistant. First follow the instructions for the general Lutron Caseta integration above. -## {% linkable_title Cover %} +## Cover After setup, shades will appear in Home Assistant using an `entity_id` based on the name used in the Lutron mobile app. For example, a shade called 'Living Room Window' will appear in Home Assistant as `cover.living_room_window`. @@ -84,7 +84,7 @@ For more information on working with shades in Home Assistant, see the [Covers c Available services: `cover.open_cover`, `cover.close_cover` and `cover.set_cover_position`. Cover `position` ranges from `0` for fully closed to `100` for fully open. -## {% linkable_title Light %} +## Light After setup, dimmable lights including wall and plug-in dimmers will appear in Home Assistant using an `entity_id` based on the name used in the Lutron mobile app. For example, a light called 'Bedroom Lamp' will appear in Home Assistant as `light.bedroom_lamp`. @@ -94,7 +94,7 @@ For more information on working with lights in Home Assistant, see the [Lights c Available services: `light.turn_on`, `light.turn_off` and `light.toggle`. The `light.turn_on` service supports attributes `brightness` and `brightness_pct`. -## {% linkable_title Scene %} +## Scene The Lutron Caseta scene platform allows you to control your Smart Bridge Scenes that are created in the Lutron mobile app. @@ -104,7 +104,7 @@ For more information on working with scenes in Home Assistant, see the [Scenes c Available services: `scene.turn_on`. -## {% linkable_title Switch %} +## Switch After setup, switches will appear in Home Assistant using an `entity_id` based on the name used in the Lutron mobile app. For example, a light switch called 'Master Bathroom Vanity' will appear in Home Assistant as `switch.master_bathroom_vanity`. diff --git a/source/_components/lw12wifi.markdown b/source/_components/lw12wifi.markdown index 6177029aafe..72115c2994d 100644 --- a/source/_components/lw12wifi.markdown +++ b/source/_components/lw12wifi.markdown @@ -18,7 +18,7 @@ redirect_from: The `lw12wifi` light platform supports Lagute LW-12 Wifi LED controller. -## {% linkable_title Configuration %} +## Configuration To enable these lights, add the following lines to your `configuration.yaml` file: diff --git a/source/_components/magicseaweed.markdown b/source/_components/magicseaweed.markdown index 6aa596a1323..91a41655be8 100644 --- a/source/_components/magicseaweed.markdown +++ b/source/_components/magicseaweed.markdown @@ -18,11 +18,11 @@ redirect_from: The `magicseaweed` platform uses the [Magicseaweed Forecast API](https://magicseaweed.com/developer/forecast-api) as a source for surf forecasting data for the surf spots of your choice. -## {% linkable_title Setup %} +## Setup You need an API key which is free but requires [registration](https://magicseaweed.com/developer/sign-up). Magicseaweed is limiting users of the API to 1 spot for the free plan. -## {% linkable_title Configuration %} +## Configuration To add Magicseaweed forecasts to your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/mailgun.markdown b/source/_components/mailgun.markdown index 904b883ed40..29e4c17f0f9 100644 --- a/source/_components/mailgun.markdown +++ b/source/_components/mailgun.markdown @@ -25,7 +25,7 @@ There is currently support for the following device types within Home Assistant: - [Notifications](#notifications). -## {% linkable_title Configuration %} +## Configuration ```yaml # Example configuration.yaml entry @@ -66,11 +66,11 @@ automation: entity_id: light.office ``` -## {% linkable_title Notifications %} +## Notifications The Mailgun notification service allows you to send emails via Mailgun's REST API. It requires the [Mailgun component](#configuration) to be set up. -### {% linkable_title Notifications configuration %} +### Notifications configuration ```yaml # Example configuration.yaml entry @@ -105,7 +105,7 @@ sender: type: string {% endconfiguration %} -### {% linkable_title Example automation %} +### Example automation The following automation reacts to an event by sending out an email with two attachments. diff --git a/source/_components/manual.markdown b/source/_components/manual.markdown index 611f755a4d3..6f87545eb8c 100644 --- a/source/_components/manual.markdown +++ b/source/_components/manual.markdown @@ -18,7 +18,7 @@ redirect_from: The `manual` alarm control panel platform enables you to set manual alarms in Home Assistant. -## {% linkable_title Configuration %} +## Configuration To enable this, add the following lines to your `configuration.yaml` file: @@ -90,7 +90,7 @@ armed_custom_bypass/armed_home/armed_away/armed_night/disarmed/triggered: type: integer {% endconfiguration %} -## {% linkable_title State machine %} +## State machine The state machine of the manual alarm integration is complex but powerful. The transitions are timed according to three values, **delay_time**, **pending_time** @@ -129,7 +129,7 @@ garage door opens, but not for the "armed home" state. **trigger_time** is useful to disable the alarm when disarmed, but it can also be used for example to sound the siren for a shorter time during the night. -## {% linkable_title Examples %} +## Examples In the config example below: @@ -155,7 +155,7 @@ alarm_control_panel: In the rest of this section, you find some real-life examples on how to use this panel. -### {% linkable_title Sensors %} +### Sensors Using sensors to trigger the alarm. diff --git a/source/_components/manual_mqtt.markdown b/source/_components/manual_mqtt.markdown index ecf2e39821a..4b912bb6de1 100644 --- a/source/_components/manual_mqtt.markdown +++ b/source/_components/manual_mqtt.markdown @@ -35,7 +35,7 @@ When the state of the manual alarm changes, Home Assistant will publish one of t - 'pending' - 'triggered' -## {% linkable_title Configuration %} +## Configuration To use your panel in your installation, add the following to your `configuration.yaml` file: @@ -153,7 +153,7 @@ payload_arm_night: default: ARM_NIGHT {% endconfiguration %} -## {% linkable_title Examples %} +## Examples In the configuration example below: @@ -182,7 +182,7 @@ alarm_control_panel: Refer to the [Manual Alarm Control page](/components/alarm_control_panel.manual/#examples) for more real-life examples on how to use this panel. -## {% linkable_title MQTT Control %} +## MQTT Control The state of this alarm can be controlled using [MQTT](/components/mqtt/). Ensure you've configured that before adding this component. diff --git a/source/_components/marytts.markdown b/source/_components/marytts.markdown index c55f7a86f84..aba32454a4b 100644 --- a/source/_components/marytts.markdown +++ b/source/_components/marytts.markdown @@ -17,7 +17,7 @@ redirect_from: The `marytts` text-to-speech platform uses [MaryTTS](http://mary.dfki.de/) Text-to-Speech engine to read a text with natural sounding voices. -## {% linkable_title Configuration %} +## Configuration To enable text-to-speech with MaryTTS, add the following lines to your `configuration.yaml`: @@ -57,7 +57,7 @@ language: See [documentation](http://mary.dfki.de/documentation/index.html) for details. -## {% linkable_title Full configuration example %} +## Full configuration example A full configuration sample including optional variables: diff --git a/source/_components/mastodon.markdown b/source/_components/mastodon.markdown index dafa44fbbaa..df074b1e606 100644 --- a/source/_components/mastodon.markdown +++ b/source/_components/mastodon.markdown @@ -17,11 +17,11 @@ redirect_from: The `mastodon` platform uses [Mastodon](https://joinmastodon.org/) to deliver notifications from Home Assistant. -### {% linkable_title Setup %} +### Setup Go to **Preferences** in the Mastodon web interface, then to **Development** and create a new application. -### {% linkable_title Configuration %} +### Configuration To add Mastodon to your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/matrix.markdown b/source/_components/matrix.markdown index 2f362d092db..e0fb914dcbf 100644 --- a/source/_components/matrix.markdown +++ b/source/_components/matrix.markdown @@ -22,7 +22,7 @@ There is currently support for the following device types within Home Assistant: - [Notifications](#notifications) -## {% linkable_title Configuration %} +## Configuration ```yaml # Example configuration.yaml entry @@ -85,13 +85,13 @@ commands: default: empty {% endconfiguration %} -### {% linkable_title Event Data %} +### Event Data If a command is triggered, a `matrix_command` event is fired. The event contains the name of the command in the `name` field. If the command is a word command, the `data` field contains a list of the command's arguments, i.e., everything that stood behind the word, split at spaces. If the command is an expression command, the `data` field contains the [group dictionary](https://docs.python.org/3.6/library/re.html?highlight=re#re.match.groupdict) of the regular expression that matched the message. -### {% linkable_title Comprehensive Configuration Example %} +### Comprehensive Configuration Example This example also uses the [matrix `notify` platform](#notifications). @@ -147,7 +147,7 @@ This configuration will: - Listen for "!testword" in the room "#someothertest:matrix.org" (and *only*) there. If such a message is encountered, it will answer with "It looks like you wrote !testword" into the "#hasstest:matrix.org" channel. - Listen in both rooms for any message matching "My name is " and answer with "Hello " into "#hasstest:matrix.org". -## {% linkable_title Notifications %} +## Notifications The `matrix` platform allows you to deliver notifications from Home Assistant to a [Matrix](http://matrix.org) room. Rooms can be both direct as well as group chats. diff --git a/source/_components/maxcube.markdown b/source/_components/maxcube.markdown index a8ec3c95402..caf4f987340 100644 --- a/source/_components/maxcube.markdown +++ b/source/_components/maxcube.markdown @@ -37,7 +37,7 @@ Supported Devices: - MAX! Window Sensor (tested) - MAX! Wall Thermostat (tested) -### {% linkable_title One Gateway %} +### One Gateway A `maxcube` section must be present in the `configuration.yaml` file and contain the following options as required: @@ -48,7 +48,7 @@ maxcube: - host: 192.168.0.20 ``` -### {% linkable_title Multiple Gateways %} +### Multiple Gateways ```yaml # Example configuration.yaml entry diff --git a/source/_components/mcp23017.markdown b/source/_components/mcp23017.markdown index 8725d9f9439..e906d4114ed 100644 --- a/source/_components/mcp23017.markdown +++ b/source/_components/mcp23017.markdown @@ -20,13 +20,13 @@ The `mcp23017` integration is the base for all related mcp23017 platforms in Hom For more details about the MCP23017 I2C I/O port expander you can find its datasheet here: [MCP23017](https://www.microchip.com/wwwproducts/en/MCP23017). -## {% linkable_title Binary Sensor %} +## Binary Sensor The `mcp23017` binary sensor platform allows you to read sensor values from the I/O pins of your [MCP23017 I2C I/O expander](https://www.adafruit.com/product/732). The pin numbers are from 0 to 15 where: 0-7 correspond to port A (A1-A8) and 8-15 to port B (B1-B8). -### {% linkable_title Configuration %} +### Configuration To use the I/O pins of an mcp23017 connected to an I2C bus of your Raspberry Pi as binary sensors, add the following to your `configuration.yaml` file: @@ -78,13 +78,13 @@ pull_mode: MCP23017 only has internal pull-up resistors, if you want to use pull-down you will have to wire your own pull-down resistors.

-## {% linkable_title Switch %} +## Switch The `mcp23017` switch platform allows you to write to the I/O pins of your [MCP23017 I2C I/O expander](https://www.adafruit.com/product/732). The pin numbers are from 0 to 15 where: 0-7 correspond to port A (A1-A8) and 8-15 to port B (B1-B8). -### {% linkable_title Configuration %} +### Configuration To use the I/O pins of an mcp23017 connected to an I2C bus of your Raspberry Pi as switches, add the following to your `configuration.yaml` file: diff --git a/source/_components/media_extractor.markdown b/source/_components/media_extractor.markdown index d853f0c31bb..0aeb880cbd0 100644 --- a/source/_components/media_extractor.markdown +++ b/source/_components/media_extractor.markdown @@ -69,7 +69,7 @@ Query examples with explanations: More info about queries [here](https://github.com/rg3/youtube-dl#format-selection) -### {% linkable_title Use the service %} +### Use the service Use service developer tool icon **Services** from the **Developer Tools**. Choose `media_extractor` from the dropdown menu **Domain** and `play_media` from **Service**, enter something like the JSON sample from above into the **Service Data** field, and hit **CALL SERVICE**. diff --git a/source/_components/media_player.markdown b/source/_components/media_player.markdown index cbce37a2b08..65b1fc27652 100644 --- a/source/_components/media_player.markdown +++ b/source/_components/media_player.markdown @@ -16,37 +16,37 @@ ha_release: 0.7 Interacts with media players on your network. -## {% linkable_title Services %} +## Services -### {% linkable_title Media control services %} +### Media control services Available services: `turn_on`, `turn_off`, `toggle`, `volume_up`, `volume_down`, `volume_set`, `volume_mute`, `media_play_pause`, `media_play`, `media_pause`, `media_stop`, `media_next_track`, `media_previous_track`, `clear_playlist`, `shuffle_set` | Service data attribute | Optional | Description | | ---------------------- | -------- | ------------------------------------------------ | | `entity_id` | yes | Target a specific media player. Defaults to all. | -#### {% linkable_title Service `media_player.volume_mute` %} +#### Service `media_player.volume_mute` | Service data attribute | Optional | Description | |------------------------|----------|--------------------------------------------------| | `entity_id` | yes | Target a specific media player. Defaults to all. | | `is_volume_muted` | no | True/false for mute/unmute | -#### {% linkable_title Service `media_player.volume_set` %} +#### Service `media_player.volume_set` | Service data attribute | Optional | Description | |------------------------|----------|--------------------------------------------------| | `entity_id` | yes | Target a specific media player. Defaults to all. | | `volume_level` | no | Float for volume level. Range 0..1 | -#### {% linkable_title Service `media_player.media_seek` %} +#### Service `media_player.media_seek` | Service data attribute | Optional | Description | |------------------------|----------|--------------------------------------------------------| | `entity_id` | yes | Target a specific media player. Defaults to all. | | `seek_position` | no | Position to seek to. The format is platform dependent. | -#### {% linkable_title Service `media_player.play_media` %} +#### Service `media_player.play_media` | Service data attribute | Optional | Description | | -----------------------| -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | @@ -54,14 +54,14 @@ Available services: `turn_on`, `turn_off`, `toggle`, `volume_up`, `volume_down`, | `media_content_id` | no | A media identifier. The format of this is integration dependent. For example, you can provide URLs to Sonos and Cast but only a playlist ID to iTunes. | | `media_content_type` | no | A media type. Must be one of `music`, `tvshow`, `video`, `episode`, `channel` or `playlist`. For example, to play music you would set `media_content_type` to `music`. | -#### {% linkable_title Service `media_player.select_source` %} +#### Service `media_player.select_source` | Service data attribute | Optional | Description | | ---------------------- | -------- | ---------------------------------------------------- | | `entity_id` | yes | Target a specific media player. Defaults to all. | | `source` | no | Name of the source to switch to. Platform dependent. | -#### {% linkable_title Service `media_player.select_sound_mode` %} +#### Service `media_player.select_sound_mode` Currently only supported on [Denon AVR](/components/media_player.denonavr/) and [Songpal](/components/media_player.songpal/). @@ -70,7 +70,7 @@ Currently only supported on [Denon AVR](/components/media_player.denonavr/) and | `entity_id` | no | Target a specific media player. For example `media_player.marantz`| | `sound_mode` | no | Name of the sound mode to switch to. Platform dependent.| -#### {% linkable_title Service `media_player.shuffle_set` %} +#### Service `media_player.shuffle_set` Currently only supported on [Spotify](/components/media_player.spotify/), [MPD](/components/media_player.mpd/), [Kodi](/components/media_player.kodi/), [Squeezebox](/components/media_player.squeezebox/) and [Universal](/components/media_player.universal/). diff --git a/source/_components/mediaroom.markdown b/source/_components/mediaroom.markdown index 5409e1d1d6c..1bf9dd3d4f6 100644 --- a/source/_components/mediaroom.markdown +++ b/source/_components/mediaroom.markdown @@ -46,7 +46,7 @@ media_player: Notice that all parameters are optional, and discovery should configure everything for you. -#### {% linkable_title Using the Mediaroom integration %} +#### Using the Mediaroom integration The integration has been developed for Portuguese TV operators currently using the Mediaroom platform, but should also work in other deployments in which the STB can be controlled remotely through a socket on port 8082. @@ -54,9 +54,9 @@ In most cases (single STB) you just need to setup the *platform* and discovery w If the STB is on the same network segment as Home Assistant, it can determine whether the device is turned on or off. Without this, the integration will fail to determine the Set-top box status, and you are required to add the *optimistic* configuration variable. -## {% linkable_title Examples %} +## Examples -### {% linkable_title Example `press_button` script %} +### Example `press_button` script The `play_media` function can be used in scripts to change channels and emulate button pressing from a remote control. @@ -74,7 +74,7 @@ press_button: ``` {% endraw %} -### {% linkable_title Example configuration with 2 STB %} +### Example configuration with 2 STB ```yaml # Example configuration.yaml entry for 2 STB diff --git a/source/_components/melissa.markdown b/source/_components/melissa.markdown index f49f6c291a9..1225eb38086 100644 --- a/source/_components/melissa.markdown +++ b/source/_components/melissa.markdown @@ -25,7 +25,7 @@ There is currently support for the following device types within Home Assistant: The climate platform will be automatically configured if Melissa integration is configured. -## {% linkable_title Configuration %} +## Configuration To set the Melissa integration up, add the following information to your `configuration.yaml` file: diff --git a/source/_components/meraki.markdown b/source/_components/meraki.markdown index f83aad46993..d3d82a14a52 100644 --- a/source/_components/meraki.markdown +++ b/source/_components/meraki.markdown @@ -17,7 +17,7 @@ redirect_from: Use your Meraki AP as device tracker. Note that Meraki will see all devices, not only connected to the network. -### {% linkable_title Prerequisites %} +### Prerequisites 1. Go to Network-wide/General page, and find the Location and scanning section. 1. Make sure analytics and Scanning API are both enabled. @@ -28,7 +28,7 @@ Use your Meraki AP as device tracker. Note that Meraki will see all devices, not 1. Make sure the API Version is set to `2.0`. 1. Hit **Save** in the bottom right of the page. -## {% linkable_title Configuration %} +## Configuration After you configure access to the Meraki CMX API, add the following to your `configuration.yaml` file: diff --git a/source/_components/message_bird.markdown b/source/_components/message_bird.markdown index aa32b1b98b4..d71a9a36c73 100644 --- a/source/_components/message_bird.markdown +++ b/source/_components/message_bird.markdown @@ -17,11 +17,11 @@ redirect_from: The `MessageBird` notification platform sends notifications as SMS messages using [MessageBird](https://www.messagebird.com/) to your mobile phone. -## {% linkable_title Setup %} +## Setup Go to https://www.messagebird.com/ to retrieve your API key. -## {% linkable_title Configuration %} +## Configuration To enable MessageBird notifications in your installation, add the following to your `configuration.yaml` file: @@ -50,11 +50,11 @@ sender: type: string {% endconfiguration %} -### {% linkable_title Usage %} +### Usage MessageBird is a notify platform and thus can be controlled by calling the notify service [as described here](/components/notify/). It will send a notification to the specified mobile phone number(s). -#### {% linkable_title Example service payload %} +#### Example service payload ```json { diff --git a/source/_components/met.markdown b/source/_components/met.markdown index a1df12a9f8f..a656578fed7 100644 --- a/source/_components/met.markdown +++ b/source/_components/met.markdown @@ -22,7 +22,7 @@ The `met` platform uses the [Met.no](https://met.no/) web service as a source fo Configuration of the Met.no platform via configuration.yaml is deprecated from version 0.95

-## {% linkable_title Configuration %} +## Configuration To add Met.no to your installation, go to Configuration >> Integrations in the UI and enable the Met.no integration. By default the values will be taken from the Home Assistant configuration. diff --git a/source/_components/meteo_france.markdown b/source/_components/meteo_france.markdown index 9abd6cf3762..e041a5b94ce 100644 --- a/source/_components/meteo_france.markdown +++ b/source/_components/meteo_france.markdown @@ -28,7 +28,7 @@ There is currently support for the following device types within Home Assistant: It displays the current weather along with a 4 days forecast and can create sensors based on the `monitored_conditions` set in your `configuration.yaml` file, including weather alerts from [Vigilance Météo-France](http://vigilance.meteofrance.com) -## {% linkable_title Configuration %} +## Configuration To add Météo-France to your installation, add the following to your `configuration.yaml` file: @@ -70,7 +70,7 @@ meteo_france: description: Weather alert status. {% endconfiguration %} -### {% linkable_title About `city` configuration %} +### About `city` configuration This integration use the Météo-France search API to get the first city from the results returned. @@ -87,7 +87,7 @@ meteo_france: - city: 'montreal,amerique' ``` -### {% linkable_title About `next_rain` condition sensor %} +### About `next_rain` condition sensor

The 1 hour rain forecast is supported for more than 75 % of metropolitan France.
@@ -105,7 +105,7 @@ Possible value for each intervals attributes are: - 3 Moderate rain - 4 Heavy rain -### {% linkable_title About `weather_alert` sensor %} +### About `weather_alert` sensor

The weather alert is available for the metropolitan France. @@ -115,7 +115,7 @@ The `weather_alert` sensor value give the current weather alert status for the d The sensor attributes give access to each type of alerts and date of the bulletin emitted by Météo-France. -### {% linkable_title Complete example %} +### Complete example This is an example for 3 cities forecast with different monitored conditions: diff --git a/source/_components/meteoalarm.markdown b/source/_components/meteoalarm.markdown index f57b9b51217..07ee8f8c4a4 100644 --- a/source/_components/meteoalarm.markdown +++ b/source/_components/meteoalarm.markdown @@ -17,7 +17,7 @@ The `MeteoAlarm` platform allows one to watch for weather alerts in europe from The binary sensor state shows if applicable the warning message. The details are available as attribute. -## {% linkable_title Configuration %} +## Configuration To enable this binary sensor, add the following lines to your `configuration.yaml`: @@ -50,7 +50,7 @@ language: {% endconfiguration %} -{% linkable_title Example output %} +Example output You will find an example below when the state is "on". @@ -84,7 +84,7 @@ There are a few awareness levels: * 3; orange; Severe * 4; red; High -{% linkable_title Example automation %} +Example automation Below you find an example of an automation. diff --git a/source/_components/metoffice.markdown b/source/_components/metoffice.markdown index de6704a3099..1410c447717 100644 --- a/source/_components/metoffice.markdown +++ b/source/_components/metoffice.markdown @@ -18,7 +18,7 @@ redirect_from: The `metoffice` weather platform uses the Met Office's [DataPoint API](http://www.metoffice.gov.uk/datapoint) for weather data. -## {% linkable_title Configuration %} +## Configuration To add the Met Office weather platform to your installation, you'll need to register for a free API key at the link above and then add the following to your `configuration.yaml` file: diff --git a/source/_components/mfi.markdown b/source/_components/mfi.markdown index 14f568bafa6..04af0134ac1 100644 --- a/source/_components/mfi.markdown +++ b/source/_components/mfi.markdown @@ -24,7 +24,7 @@ There is currently support for the following device types within Home Assistant: - [Sensor](#sensor) - [Switch](#switch) -## {% linkable_title Sensor %} +## Sensor The `mfi` sensor platform to allow you to monitor [mFi mPort interface and sensors](https://www.ubnt.com/mfi/mport/). @@ -69,7 +69,7 @@ verify_ssl: type: boolean {% endconfiguration %} -## {% linkable_title Switch %} +## Switch The `mfi` switch platform to allow you to control [mFi Controllable Power Outlets](https://www.ubnt.com/mfi/mpower/). diff --git a/source/_components/mhz19.markdown b/source/_components/mhz19.markdown index 866dc57a9c6..5a5dfed9e7b 100644 --- a/source/_components/mhz19.markdown +++ b/source/_components/mhz19.markdown @@ -22,7 +22,7 @@ Check out the [Open Home Automation web site](https://www.open-homeautomation.co **Note:** the new version MH-Z19B requires the VIN to be connected to a 5V pin, rather than 3.3V. -## {% linkable_title Configuration %} +## Configuration To use this sensor in your installation, add the following to your `configuration.yaml` file: @@ -50,7 +50,7 @@ sensor: - temperature ``` -## {% linkable_title Raspberry Pi 3(+) GPIO UART and Hass.io %} +## Raspberry Pi 3(+) GPIO UART and Hass.io To directly connect the sensor on the GPIO pins of a RPi, first append the following to `config.txt` in the boot directory: @@ -64,6 +64,6 @@ Then (after a reboot): you can setup the sensor using: serial_device: /dev/tty.S0 ``` -## {% linkable_title Calibration %} +## Calibration The MH-Z19B version of the sensor has Automatic Baseline Calibration enabled by default, which will calibrate the 400PPM level to the lowest measured PPM in the last 24h cycle. Currently the integration does not allow turning this functionaly off. diff --git a/source/_components/microsoft.markdown b/source/_components/microsoft.markdown index 300befd307b..25c9bfb07e3 100644 --- a/source/_components/microsoft.markdown +++ b/source/_components/microsoft.markdown @@ -18,7 +18,7 @@ redirect_from: The `microsoft` text-to-speech platform uses [Microsoft Text-to-Speech engine](https://docs.microsoft.com/en-us/azure/cognitive-services/speech/home) to read a text with natural sounding voices. This integration uses an API that is part of the Cognitive Services offering and is known as the Bing Speech API. You will need an API key, which is free. You can use your [Azure subscription](https://azure.microsoft.com) or get an API key on the [Cognitive Services site](https://azure.microsoft.com/en-us/try/cognitive-services/). -## {% linkable_title Configuration %} +## Configuration To enable text-to-speech with Microsoft, add the following lines to your `configuration.yaml`: @@ -71,7 +71,7 @@ contour: {% endconfiguration %} -## {% linkable_title Full configuration example %} +## Full configuration example A full configuration sample including optional variables: diff --git a/source/_components/microsoft_face.markdown b/source/_components/microsoft_face.markdown index aae2a39cc02..9ddf62c6d6c 100644 --- a/source/_components/microsoft_face.markdown +++ b/source/_components/microsoft_face.markdown @@ -18,7 +18,7 @@ Azure Cognitive service [Face](https://azure.microsoft.com/en-us/services/cognitive-services/face/). All data are stored in your own private instance in the Azure cloud. -## {% linkable_title Setup %} +## Setup You need an API key, which is free, but requires an [Azure registration](https://azure.microsoft.com/en-us/free/) using your @@ -28,7 +28,7 @@ get an API key by registering with [cognitive-services](https://azure.microsoft.com/en-us/try/cognitive-services/). Please note that all keys on cognitive services must be recreated every 90 days. -## {% linkable_title Configuration %} +## Configuration To enable the Microsoft Face component, add the following to your `configuration.yaml` file: @@ -56,7 +56,7 @@ timeout: default: 10s {% endconfiguration %} -### {% linkable_title Person and Groups %} +### Person and Groups For most services, you need to set up a group or a person. This limits the processing and detection to elements provided by the group. diff --git a/source/_components/microsoft_face_detect.markdown b/source/_components/microsoft_face_detect.markdown index 0391fb387b4..354d65254c8 100644 --- a/source/_components/microsoft_face_detect.markdown +++ b/source/_components/microsoft_face_detect.markdown @@ -30,7 +30,7 @@ take a look at the [Image Processing component](/components/image_processing/) p The free version of the Microsoft Face identify API limits the number of requests possible per month. Therefore, it is strongly recommended that you limit the `scan_interval` when setting up an instance of this entity as detailed on the main [Image Processing component](/components/image_processing/) page.

-### {% linkable_title Configuration %} +### Configuration ```yaml # Example configuration.yaml entry diff --git a/source/_components/microsoft_face_identify.markdown b/source/_components/microsoft_face_identify.markdown index f3408dbb8f5..ebd4b254768 100644 --- a/source/_components/microsoft_face_identify.markdown +++ b/source/_components/microsoft_face_identify.markdown @@ -30,7 +30,7 @@ take a look at the [Image Processing component](/components/image_processing/) p The free version of the Microsoft Face identify API limits the number of requests possible per month. Therefore, it is strongly recommended that you limit the `scan_interval` when setting up an instance of this entity as detailed on the main [Image Processing component](/components/image_processing/) page.

-### {% linkable_title Configuration %} +### Configuration ```yaml # Example configuration.yaml entry diff --git a/source/_components/miflora.markdown b/source/_components/miflora.markdown index 72d157dee8a..ebf011be9fa 100644 --- a/source/_components/miflora.markdown +++ b/source/_components/miflora.markdown @@ -20,7 +20,7 @@ The `miflora` sensor platform allows one to monitor plant soil and air condition There are "Chinese" and "International" versions available and there is a [report](https://community.home-assistant.io/t/miflora-showing-data-unknown/19550/8) that only the "International" works. -## {% linkable_title Install a Bluetooth Backend %} +## Install a Bluetooth Backend Before configuring Home Assistant you need a Bluetooth backend and the MAC address of your sensor. Depending on your operating system, you may have to configure the proper Bluetooth backend for your system: @@ -31,7 +31,7 @@ Before configuring Home Assistant you need a Bluetooth backend and the MAC addre  - Fallback solution: Install `gatttool` via your package manager. Depending on the distribution, the package name might be: `bluez`, `bluetooth`, `bluez-deprecated` - On Windows and MacOS there is currently no support for the [miflora library](https://github.com/open-homeautomation/miflora/). -## {% linkable_title Scan for devices %} +## Scan for devices Start a scan to determine the MAC addresses of the sensor (you can identify your sensor by looking for `Flower care` or `Flower mate` entries) using this command: @@ -55,7 +55,7 @@ $ bluetoothctl If you can't use `hcitool` or `bluetoothctl` but have access to an Android phone you can try `BLE Scanner` or similar scanner applications from the Play Store to easily find your sensor MAC address. If you are using Windows 10, try the `Microsoft Bluetooth LE Explorer` app from the Windows Store. -## {% linkable_title Configuration %} +## Configuration To use your Mi Flora plant sensor in your installation, add the following to your `configuration.yaml` file: @@ -112,7 +112,7 @@ adapter: By default the sensor is only polled once every 20 minutes (`scan_interval` is 1200 seconds by default). On a Home Assistant restart sensor will report initial value. If you set `median: 3`, it will take _at least_ 40 minutes before the sensor will report an average value. Keep in mind though that reducing polling intervals will have a negative effect on the battery life.

-## {% linkable_title Full example %} +## Full example A full configuration example could look like the one below: diff --git a/source/_components/mikrotik.markdown b/source/_components/mikrotik.markdown index 472015bccea..9614e40ce4d 100644 --- a/source/_components/mikrotik.markdown +++ b/source/_components/mikrotik.markdown @@ -17,7 +17,7 @@ redirect_from: The `mikrotik` platform offers presence detection by looking at connected devices to a [MikroTik RouterOS](http://mikrotik.com) based router. -## {% linkable_title Configuring `mikrotik` device tracker %} +## Configuring `mikrotik` device tracker You have to enable accessing the RouterOS API on your router to use this platform. @@ -75,7 +75,7 @@ method: type: string {% endconfiguration %} -## {% linkable_title Use a certificate %} +## Use a certificate To use SSL to connect to the API (via `api-ssl` instead of `api` service) further configuration is required at RouterOS side. You have to upload or generate a certificate and configure `api-ssl` service to use it. Here is an example of a self-signed certificate: @@ -94,7 +94,7 @@ If everything is working fine you can disable the pure `api` service in RouterOS /ip service disable api ``` -## {% linkable_title The user privileges in RouterOS %} +## The user privileges in RouterOS To use this device tracker you need restricted privileges only. To enhance the security of your MikroTik device create a "read only" user who is able to connect to API only: @@ -104,7 +104,7 @@ To use this device tracker you need restricted privileges only. To enhance the s /user set password="YOUR_PASSWORD" homeassistant ``` -## {% linkable_title Using the additional configuration to the `mikrotik` device tracker entry in your `configuration.yaml` file: %} +## Using the additional configuration to the `mikrotik` device tracker entry in your `configuration.yaml` file: ```yaml device_tracker: diff --git a/source/_components/mill.markdown b/source/_components/mill.markdown index b5efbaf4741..093bf7e2ee2 100644 --- a/source/_components/mill.markdown +++ b/source/_components/mill.markdown @@ -18,7 +18,7 @@ redirect_from: Integrates Mill heater into Home Assistant. -## {% linkable_title Configuration %} +## Configuration To enable this platform, add the following lines to your `configuration.yaml` file: @@ -40,7 +40,7 @@ password: type: string {% endconfiguration %} -## {% linkable_title Component services %} +## Component services This platform supports a service to set the temperature for the room connected to heater in the Mill app: diff --git a/source/_components/min_max.markdown b/source/_components/min_max.markdown index 209765f8173..fbcf66d44d7 100644 --- a/source/_components/min_max.markdown +++ b/source/_components/min_max.markdown @@ -32,7 +32,7 @@ This sensor is an alternative to the [template sensor](/components/sensor.templa Sensors with an unknown state will be ignored in the calculation. If the unit of measurement of the sensors differs, the `min_max` sensor will go to an error state where the value is `UNKNOWN` and unit of measurement is `ERR`. -## {% linkable_title Configuration %} +## Configuration To enable the `min_max` sensor, add the following lines to your `configuration.yaml`: diff --git a/source/_components/mitemp_bt.markdown b/source/_components/mitemp_bt.markdown index 93c8ead2496..35954e7e775 100644 --- a/source/_components/mitemp_bt.markdown +++ b/source/_components/mitemp_bt.markdown @@ -18,7 +18,7 @@ redirect_from: The `mitemp_bt` sensor platform allows one to monitor room temperature and humidity. The [Xiaomi Mijia BLE Temperature and Humidity sensor with LCD](https://www.amazon.com/Temperature-Humidity-Xiaomi-Bluetooth-Screen-Remote/dp/B079L6N6PC) is a small Bluetooth Low Energy device that monitors the room temperature and humidity. As only a single BLE device can be polled at the same time, the library employs locking to make sure this is the case. -## {% linkable_title Installation %} +## Installation Depending on the operating system you're running, you have to configure the proper Bluetooth backend on your system: @@ -29,7 +29,7 @@ Depending on the operating system you're running, you have to configure the prop - Fallback solution: Install `btlewrap` library (via pip) and `gatttool` via your package manager. Depending on the distribution, the package name might be: `bluez`, `bluetooth` or `bluez-deprecated`. - Windows and MacOS are currently not supported by the `btlewrap` library. -## {% linkable_title Configuration %} +## Configuration Start a scan to determine the MAC addresses of the sensor: @@ -117,7 +117,7 @@ adapter: Note that by default the sensor is only polled once every 5 minutes. This means with the `median: 3` setting will take as least 15 minutes before the sensor will report a value after a Home Assistant restart. Even though the hardware is able to provide new values every second, room temperatures don't change that quickly. Reducing polling intervals will have a negative effect on the battery life. -## {% linkable_title Full example %} +## Full example A full configuration example could look like the one below: diff --git a/source/_components/mjpeg.markdown b/source/_components/mjpeg.markdown index 428b710f2b7..3f1ce4400b3 100644 --- a/source/_components/mjpeg.markdown +++ b/source/_components/mjpeg.markdown @@ -19,7 +19,7 @@ redirect_from: The `mjpeg` camera platform allows you to integrate IP cameras which are capable to stream their video with MJPEG into Home Assistant. -## {% linkable_title Configuration %} +## Configuration To enable this camera in your installation, add the following to your `configuration.yaml` file: @@ -64,7 +64,7 @@ verify_ssl: default: true {% endconfiguration %} -## {% linkable_title Examples %} +## Examples Example of using a DCS-930L Wireless N Network Camera from D-Link: diff --git a/source/_components/mobile_app.markdown b/source/_components/mobile_app.markdown index f84a40bef45..fd28efdff3e 100644 --- a/source/_components/mobile_app.markdown +++ b/source/_components/mobile_app.markdown @@ -20,7 +20,7 @@ If you are planning to use a mobile application that integrates with Home Assist If you are a mobile app developer, see the [developer documentation](https://developers.home-assistant.io/docs/en/app_integration_index.html) for instructions on how to build your app on top of the mobile app component. -## {% linkable_title Configuration %} +## Configuration This integration is by default enabled, unless you've disabled or removed the `default_config:` line from your configuration. If that is the case, the following example shows you how to enable this integration manually: diff --git a/source/_components/mochad.markdown b/source/_components/mochad.markdown index 692c3c90738..d4207ffe5bb 100644 --- a/source/_components/mochad.markdown +++ b/source/_components/mochad.markdown @@ -24,7 +24,7 @@ There is currently support for the following device types within Home Assistant: - [Light](#light) - [Switch](#switch) -## {% linkable_title Configuration %} +## Configuration To integrate your Mochad units with Home Assistant, add the following section to your `configuration.yaml` file: @@ -46,7 +46,7 @@ port: default: 1099 {% endconfiguration %} -## {% linkable_title Example %} +## Example A full configuration sample could look like the one below: @@ -57,7 +57,7 @@ mochad: port: 1099 ``` -## {% linkable_title Light %} +## Light The `mochad` light platform lets you control an X10 enabled dimmer/light device. @@ -94,7 +94,7 @@ brightness_levels: type: integer {% endconfiguration %} -## {% linkable_title Switch %} +## Switch The `mochad` switch platform lets you control an X10 enabled switch device. diff --git a/source/_components/modbus.markdown b/source/_components/modbus.markdown index c62832b0e0f..98cbb20da3f 100644 --- a/source/_components/modbus.markdown +++ b/source/_components/modbus.markdown @@ -18,11 +18,11 @@ ha_iot_class: Local Push [Modbus](http://www.modbus.org/) is a serial communication protocol to control PLCs (Programmable logic controller). It currently supports sensors and switches which can be controlled over serial, TCP, and UDP connections. -## {% linkable_title Configuration %} +## Configuration The configuration for adding modbus to your installation depends on the connection type, either a network or serial connection. -### {% linkable_title Network connection %} +### Network connection For a network connection, add the following to your `configuration.yaml` file: @@ -60,7 +60,7 @@ timeout: type: integer {% endconfiguration %} -### {% linkable_title Serial connection %} +### Serial connection For a serial connection, add the following to your `configuration.yaml` file: @@ -118,7 +118,7 @@ timeout: type: integer {% endconfiguration %} -### {% linkable_title Multiple connections %} +### Multiple connections Multiple connections are possible, add something like the following to your `configuration.yaml` file: @@ -136,14 +136,14 @@ modbus: name: hub2 ``` -### {% linkable_title Services %} +### Services | Service | Description | | ------- | ----------- | | write_register | Write register. Requires `hub`, `unit`, `address` and `value` fields. `value` can be either single value or an array | -#### {% linkable_title Service Data Attributes %} +#### Service Data Attributes | Attribute | Description | | --------- | ----------- | @@ -152,7 +152,7 @@ modbus: | address | Address of the Register (e.g., 138) | | value | A single value or an array of 16-bit values. Single value will call modbus function code 6. Array will call modbus function code 16. Array might need reverse ordering. E.g., to set 0x0004 you might need to set `[4,0]` | -## {% linkable_title Building on top of Modbus %} +## Building on top of Modbus - [Modbus Binary Sensor](/components/binary_sensor.modbus/) - [Modbus Sensor](/components/sensor.modbus/) diff --git a/source/_components/modem_callerid.markdown b/source/_components/modem_callerid.markdown index cf6965fa18e..51ef586329f 100644 --- a/source/_components/modem_callerid.markdown +++ b/source/_components/modem_callerid.markdown @@ -19,7 +19,7 @@ The `modem_callerid` sensor platform uses an available modem for collecting call When the sensor detects a new call, its state changes to 'ring' for each ring and 'callerid' when caller id information is received. It returns to 'idle' once ringing stops. The state event includes an attribute payload that includes the time of the call, name and number. -## {% linkable_title Setup %} +## Setup To find the path of your USB modem, run: @@ -35,7 +35,7 @@ sudo usermod -a -G dialout homeassistant Depending on what's plugged into your USB ports, the name found above may change. You can lock in a name, such as `/dev/modem`, by following [these instructions](http://hintshop.ludvig.co.nz/show/persistent-names-usb-serial-devices/). -## {% linkable_title Configuration %} +## Configuration To enable the sensor, add the following lines to your `configuration.yaml`: @@ -68,7 +68,7 @@ If Home Assistant (`hass`) runs with another user (e.g., `homeassistant` on Hass Depending on what's plugged into your USB ports, the name found above may change. You can lock in a name, such as `/dev/modem`, by following [these instructions](http://hintshop.ludvig.co.nz/show/persistent-names-usb-serial-devices/). -## {% linkable_title Examples %} +## Examples Some example automations: diff --git a/source/_components/mold_indicator.markdown b/source/_components/mold_indicator.markdown index 73981cc1d40..ec8c3722058 100644 --- a/source/_components/mold_indicator.markdown +++ b/source/_components/mold_indicator.markdown @@ -21,7 +21,7 @@ The Mold Indicator sensor integration consumes information of two temperature se The sensor data may be used e.g., to signal bad air quality (too high air humidity) or to automate operation of indoor air humidifiers to keep the indoor humidity at an optimum. -## {% linkable_title Configuration %} +## Configuration To use the Mold Indicator sensor in your installation, add the following to your `configuration.yaml` file: @@ -60,7 +60,7 @@ calibration_factor: In this case, the weather forecast temperature sensor is used for the outside temperature. -## {% linkable_title Calibration %} +## Calibration The Mold Indicator sensor integration needs to be calibrated in order to estimate the temperature at the critical point from the outdoor and indoor temperature. First find the coldest surface in the room (critical point), which is typically near the window frames, but depends on the insulation of your home. For calibration you need to measure the temperature at this critical point and simultaneously write down the values for the indoor- and outdoor temperature sensors used for the Mold Indicator. Be sure that there is a significant indoor to outdoor temperature difference to get the best calibration results. With the three measured temperatures (in Celsius or Fahrenheit), the calibration_factor for your configuration file is given by: diff --git a/source/_components/monoprice.markdown b/source/_components/monoprice.markdown index 5fe57db0fc9..8f5fa9cce8f 100644 --- a/source/_components/monoprice.markdown +++ b/source/_components/monoprice.markdown @@ -60,7 +60,7 @@ sources: type: integer {% endconfiguration %} -### {% linkable_title Service `snapshot` %} +### Service `snapshot` Take a snapshot of one or more zones' states. This service, and the following one are useful if you want to play a doorbell or notification sound and resume playback afterward. If no `entity_id` is provided, all zones are snapshotted. @@ -74,7 +74,7 @@ The following attributes are stored in a snapshot: | ---------------------- | -------- | ----------- | | `entity_id` | yes | String or list of strings that point at `entity_id`s of zones. -### {% linkable_title Service `restore` %} +### Service `restore` Restore a previously taken snapshot of one or more speakers. If no `entity_id` is provided, all zones are restored. diff --git a/source/_components/moon.markdown b/source/_components/moon.markdown index fc14c92ca13..7254e672d69 100644 --- a/source/_components/moon.markdown +++ b/source/_components/moon.markdown @@ -19,7 +19,7 @@ redirect_from: The `moon` sensor platform is tracking the moon phases. -## {% linkable_title Configuration %} +## Configuration To enable the moon sensor, add the following lines to your `configuration.yaml`: diff --git a/source/_components/mopar.markdown b/source/_components/mopar.markdown index 82f4fa7a81b..74993eaa693 100644 --- a/source/_components/mopar.markdown +++ b/source/_components/mopar.markdown @@ -26,11 +26,11 @@ The `mopar` integration provides the following for owners of FCA vehicles with a - Switch per vehicle allowing to turn the engine on and off - A service for running the horn & lights -## {% linkable_title Setup %} +## Setup Be sure you have a [mopar.com](http://mopar.com) account with your vehicle(s) registered by VIN. You must also have a current uConnect subscription. -## {% linkable_title Configuration %} +## Configuration To enable this component, add the following lines to your `configuration.yaml`. All platforms will be automatically loaded. @@ -57,7 +57,7 @@ pin: type: string {% endconfiguration %} -## {% linkable_title Service %} +## Service Call the `mopar.sound_horn` service to sound the horn and flash the lights on your vehicle. diff --git a/source/_components/mqtt.markdown b/source/_components/mqtt.markdown index 7897167ccf3..b26b6f7163f 100644 --- a/source/_components/mqtt.markdown +++ b/source/_components/mqtt.markdown @@ -43,7 +43,7 @@ mqtt: This allows you to connect to the MQTT broker with user `homeassistant` and password `hello`. -## {% linkable_title Additional features %} +## Additional features - [Certificate](/docs/mqtt/certificate/) - [Discovery](/docs/mqtt/discovery/) diff --git a/source/_components/mqtt_eventstream.markdown b/source/_components/mqtt_eventstream.markdown index 557312d2e07..feb0354ff44 100644 --- a/source/_components/mqtt_eventstream.markdown +++ b/source/_components/mqtt_eventstream.markdown @@ -16,7 +16,7 @@ ha_iot_class: Configurable The `mqtt_eventstream` integration connects two Home Assistant instances via MQTT. -## {% linkable_title Configuration %} +## Configuration To integrate MQTT Eventstream into Home Assistant, add the following section to your `configuration.yaml` file: @@ -42,7 +42,7 @@ ignore_event: type: list {% endconfiguration %} -## {% linkable_title Multiple Instances %} +## Multiple Instances Events from multiple instances can be aggregated to a single master instance by subscribing to a wildcard topic from the master instance. diff --git a/source/_components/mqtt_json.markdown b/source/_components/mqtt_json.markdown index 9d4494d5b8a..2daf308fcfe 100644 --- a/source/_components/mqtt_json.markdown +++ b/source/_components/mqtt_json.markdown @@ -18,7 +18,7 @@ redirect_from: The `mqtt_json` device tracker platform allows you to detect presence by monitoring an MQTT topic for new locations. To use this platform, you specify a unique topic for each device. -## {% linkable_title Configuration %} +## Configuration To use this device tracker in your installation, add the following to your `configuration.yaml` file: @@ -42,7 +42,7 @@ qos: type: string {% endconfiguration %} -## {% linkable_title Usage %} +## Usage This platform receives JSON formatted payloads containing GPS information, for example: diff --git a/source/_components/mqtt_room.markdown b/source/_components/mqtt_room.markdown index eb9bcd1205d..f3d24bdc9e7 100644 --- a/source/_components/mqtt_room.markdown +++ b/source/_components/mqtt_room.markdown @@ -18,7 +18,7 @@ redirect_from: The `mqtt_room` sensor platform allows you to detect the indoor location of devices using MQTT clients. -## {% linkable_title Configuration %} +## Configuration To use this device tracker in your installation, add the following to your `configuration.yaml` file: @@ -55,7 +55,7 @@ away_timeout: type: integer {% endconfiguration %} -## {% linkable_title Usage %} +## Usage Example JSON that should be published to the room topics: @@ -67,7 +67,7 @@ Example JSON that should be published to the room topics: } ``` -### {% linkable_title Setting up clients %} +### Setting up clients This integration works with any software that is sending data in the given format. Each client should post the discovered devices in its own subtopic of the configured topic. Instead of developing your own application, you can also use any of these already existing clients: diff --git a/source/_components/mqtt_statestream.markdown b/source/_components/mqtt_statestream.markdown index b98d78ab071..891d882df61 100644 --- a/source/_components/mqtt_statestream.markdown +++ b/source/_components/mqtt_statestream.markdown @@ -16,7 +16,7 @@ ha_iot_class: Configurable The `mqtt_statestream` integration publishes state changes in Home Assistant to individual MQTT topics. -## {% linkable_title Configuration %} +## Configuration To enable MQTT Statestream in Home Assistant, add the following section to your `configuration.yaml` file: @@ -71,7 +71,7 @@ include: type: list {% endconfiguration %} -## {% linkable_title Operation %} +## Operation When any Home Assistant entity changes, this integration will publish that change to MQTT. @@ -86,7 +86,7 @@ All states and attributes are passed through JSON serialization before publishin The last_updated and last_changed values for the entity will be published to `homeassistant/light/master_bedroom_dimmer/last_updated` and `homeassistant/light/master_bedroom_dimmer/last_changed`, respectively. The timestamps are in ISO 8601 format - for example, `2017-10-01T23:20:30.920969+00:00`. -## {% linkable_title Include/exclude %} +## Include/exclude The **exclude** and **include** configuration variables can be used to filter the items that are published to MQTT. diff --git a/source/_components/mvglive.markdown b/source/_components/mvglive.markdown index 4d3d11ed901..95b51353fa1 100644 --- a/source/_components/mvglive.markdown +++ b/source/_components/mvglive.markdown @@ -18,7 +18,7 @@ redirect_from: The `mvglive` sensor will give you the departure time of the next bus, tram, subway, or train at the next station or stop in the Munich public transport network. Additional details such as the line number and destination are present in the attributes. -## {% linkable_title Configuration %} +## Configuration To enable this sensor, add the following lines to your `configuration.yaml` file: @@ -68,9 +68,9 @@ name: type: string {% endconfiguration %} -## {% linkable_title Examples %} +## Examples -### {% linkable_title Full configuration %} +### Full configuration The example below shows a full configuration with three sensors that showcase the various configuration options. diff --git a/source/_components/mychevy.markdown b/source/_components/mychevy.markdown index b56b7b1a500..a4bc25370e0 100644 --- a/source/_components/mychevy.markdown +++ b/source/_components/mychevy.markdown @@ -24,7 +24,7 @@ This integration provides the following platforms: - Binary sensors: if the car is plugged in - Sensors: Battery Level, Charge Mode, EST Range, Total Distance Traveled -## {% linkable_title Configuration %} +## Configuration To use MyChevy in your installation, add the following to your `configuration.yaml` file: @@ -51,7 +51,7 @@ country: type: string {% endconfiguration %} -### {% linkable_title Limitations %} +### Limitations The architecture of the GM automotive networking imposes some limitations on the functionality of the component. diff --git a/source/_components/mycroft.markdown b/source/_components/mycroft.markdown index 67d4bdca4aa..7d06ea10ac0 100644 --- a/source/_components/mycroft.markdown +++ b/source/_components/mycroft.markdown @@ -22,7 +22,7 @@ There is currently support for the following device types within Home Assistant: - **Notifications** - Allows to deliver notifications from Home Assistant to [Mycroft AI](https://mycroft.ai/). -## {% linkable_title Configuration %} +## Configuration To use Mycroft in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/myq.markdown b/source/_components/myq.markdown index 4eba68ac803..31f02870e0d 100644 --- a/source/_components/myq.markdown +++ b/source/_components/myq.markdown @@ -18,7 +18,7 @@ redirect_from: The `myq` cover platform lets you control MyQ-Enabled garage doors through Home Assistant. Device names in Home Assistant are generated based on the names defined in your MyQ Device mobile app. -## {% linkable_title Configuration %} +## Configuration To use your MyQ cover in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/mysensors.markdown b/source/_components/mysensors.markdown index 4ae4e38e749..ffb975624fc 100644 --- a/source/_components/mysensors.markdown +++ b/source/_components/mysensors.markdown @@ -16,7 +16,7 @@ ha_release: 0.73 The [MySensors](https://www.mysensors.org) project combines devices like Arduino, ESP8266, Raspberry Pi, NRF24L01+ and RFM69 to build affordable sensor networks. This integration will automatically add all available devices to Home Assistant, after [presentation](#presentation) is done. That is, you do not need to add anything to your configuration for the devices for them to be added. Go to the **states** section of the developer tools to find the devices that have been identified. -### {% linkable_title Configuration %} +### Configuration Integrate your Serial, Ethernet (LAN) or MQTT MySensors Gateway by adding the following to your `configuration.yaml` file: @@ -114,7 +114,7 @@ mqtt: The MQTT gateway requires MySensors version 2.0+ and only the MQTT client gateway is supported.

-### {% linkable_title Extended configuration example %} +### Extended configuration example ```yaml # Example configuration.yaml entry @@ -144,7 +144,7 @@ mysensors: version: '2.0' ``` -### {% linkable_title Presentation %} +### Presentation Present a MySensors sensor or actuator, by following these steps: @@ -237,13 +237,13 @@ void receive(const MyMessage &message) { } ``` -### {% linkable_title SmartSleep %} +### SmartSleep Sending a heartbeat, `I_HEARTBEAT_RESPONSE`, from the MySensors device to Home Assistant, using MySensors version 2.0 - 2.1, activates the SmartSleep functionality in Home Assistant. This means that messages are buffered and only sent to the device upon receiving a heartbeat from the device. State changes are stored so that only the last requested state change is sent to the device. Other types of messages are queued in a FIFO queue. SmartSleep is useful for battery powered actuators that are waiting for commands. See the MySensors library API for information on how to send heartbeats and sleep the device. In MySensors version 2.2 the serial API changed from using `I_HEARTBEAT_RESPONSE` to signal SmartSleep, to using `I_PRE_SLEEP_NOTIFICATION` and `I_POST_SLEEP_NOTIFICATION`. Home Assistant has been upgraded to support the new message types and will activate SmartSleep when receiving a message of type `I_PRE_SLEEP_NOTIFICATION`, if using MySensors version 2.2.x or higher. If Home Assistant is configured to use MySensors version 2.0 - 2.1 the old SmartSleep behavior is retained. -### {% linkable_title Message validation %} +### Message validation Messages sent to or from Home Assistant from or to a MySensors device will be validated according to the MySensors [serial API](https://www.mysensors.org/download/serial_api_20). If a message doesn't pass validation, it will be dropped and not be passed forward either to or from Home Assistant. Make sure you follow the serial API for your version of MySensors when writing your Arduino sketch. @@ -251,7 +251,7 @@ The log should warn you of messages that failed validation or if a child value i Message validation was introduced in version 0.52 of Home Assistant. -### {% linkable_title Debug logging %} +### Debug logging If you experience dropped messages or that a device is not added to Home Assistant, please turn on debug logging for the `mysensors` integration and the `mysensors` package. This will help you see what is going on. Make sure you use these logging settings to collect a log sample if you report an issue about the `mysensors` integration in our github issue tracker. ```yaml diff --git a/source/_components/mystrom.markdown b/source/_components/mystrom.markdown index 67d32ea6f82..050cfe5fbe3 100644 --- a/source/_components/mystrom.markdown +++ b/source/_components/mystrom.markdown @@ -28,7 +28,7 @@ There is currently support for the following device types within Home Assistant: - [Light](#light) - [Switch](#switch) -## {% linkable_title Light %} +## Light To use your myStrom WiFi Bulb in your installation, add the following to your `configuration.yaml` file: @@ -77,7 +77,7 @@ $ curl http://[IP_ADDRESS]/api/v1/device/[MAC_ADDRESS] } ``` -## {% linkable_title Binary Sensor %} +## Binary Sensor The `mystrom` binary sensor platform allows you to use [myStrom Wifi Buttons](https://mystrom.ch/wifi-button/) with Home Assistant. The myStrom Wifi Buttons support three and the myStrom WiFi Button + four different push pattern: @@ -105,7 +105,7 @@ binary_sensor: The firmware version 2.56 doesn't support TLS/SSL. This means that you are only able to use the WiFi Buttons if you are using plain-text communication between Home Assistant and the clients/entities.

-### {% linkable_title Setup of myStrom Buttons %} +### Setup of myStrom Buttons You need to configure every button to make it work with Home Assistant. First connect the Wifi Buttons to your wireless network. Once a button is connected you have three minutes to set the actions for the push patterns if the button is not charging. The fastest way is to use `curl`. Check the [documentation](https://mystrom.ch/wp-content/uploads/REST_API_WBP.txt) of the WiFi Button for further details about the implementation (`http://` is replaced by `get://` or `post://`). `action` is the name of the corresponding push pattern (see above). @@ -156,11 +156,11 @@ The command-line tool [`mystrom`](https://github.com/fabaff/python-mystrom) is a If you have set [`login_attempts_threshold`](/components/http/) and forget to include the `api_password` for an action and that action is triggered then after the threshold is reached will the button no longer work because it is banned. See [IP filtering and banning](/components/http/#ip-filtering-and-banning) about how to revert the banning. -## {% linkable_title Switch %} +## Switch The `mystrom` switch platform allows you to control the state of your [myStrom](https://mystrom.ch/en/) switches. The built-in sensor is measuring the power consumption while the switch is on. -### {% linkable_title Setup %} +### Setup Make sure that you have enabled the REST API under **Advanced** in the web frontend of the switch. @@ -205,7 +205,7 @@ or change its state: curl -G -X GET http://IP_ADDRESS/relay -d 'state=1' ``` -### {% linkable_title Get the current power consumption %} +### Get the current power consumption The switch is measuring the current power consumption. To expose this as a sensor use a [`template` sensor](/components/sensor.template/). diff --git a/source/_components/mythicbeastsdns.markdown b/source/_components/mythicbeastsdns.markdown index 67ae36f5a90..1b721ffe012 100644 --- a/source/_components/mythicbeastsdns.markdown +++ b/source/_components/mythicbeastsdns.markdown @@ -16,7 +16,7 @@ logo: mythic_beasts.png With the `mythicbeastsdns` integration you can automatically update your dynamic DNS entry at [Mythic Beasts](https://www.mythic-beasts.com/). -## {% linkable_title Configuration %} +## Configuration To use the integration in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/n26.markdown b/source/_components/n26.markdown index a5430f2cff1..a9e7d5c2ee1 100644 --- a/source/_components/n26.markdown +++ b/source/_components/n26.markdown @@ -21,7 +21,7 @@ The [N26](https://n26.com) integration for Home Assistant allows you to track yo N26 is a bank from germany that launched as a start up. It is an "online only" bank in that it has no local "stores" to retrieve or deposit money and account management is done only through their web interface and mobile apps. The sensor allows to show account info including balance, spaces (sub-accounts within an account) and bank card status. The switch allows to change the "Blocked/Unblocked" status of an N26 bank card. -## {% linkable_title Configuration %} +## Configuration Add the following entry to the `configuration.yaml` file: diff --git a/source/_components/namecheapdns.markdown b/source/_components/namecheapdns.markdown index 72884063846..6189ac0aea0 100644 --- a/source/_components/namecheapdns.markdown +++ b/source/_components/namecheapdns.markdown @@ -19,7 +19,7 @@ With the `namecheapdns` integration you can automatically update your dynamic DN Namecheap only supports IPv4 addresses to update.

-## {% linkable_title Configuration %} +## Configuration To use the integration in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/nanoleaf.markdown b/source/_components/nanoleaf.markdown index 2a404a0e267..1a14a5744a9 100644 --- a/source/_components/nanoleaf.markdown +++ b/source/_components/nanoleaf.markdown @@ -16,7 +16,7 @@ redirect_from: - /components/light.nanoleaf/ --- -### {% linkable_title Configuration Sample %} +### Configuration Sample The `nanoleaf` platform allows you to control [Nanoleaf Light Panels](https://nanoleaf.me) from Home Assistant. @@ -48,7 +48,7 @@ name: default: Nanoleaf {% endconfiguration %} -### {% linkable_title Getting The Auth Token %} +### Getting The Auth Token 1. Make sure that your Nanoleaf Light Panel is fully patched (as of the time of writing the latest version was 3.0.8 for Aurora and 1.2.0 for Canvas) 2. Hold down the *ON* button on the Panel for 5 seconds; the LED will start flashing diff --git a/source/_components/neato.markdown b/source/_components/neato.markdown index ad19520fe74..73b76c84d67 100644 --- a/source/_components/neato.markdown +++ b/source/_components/neato.markdown @@ -45,7 +45,7 @@ password: After the update to firmware 4.0 (which adds cleaning maps) there is also support for displaying the maps of the Botvac D3 Connected and Botvac D5 Connected robots. More information on how to update can be found [here](https://support.neatorobotics.com/hc/en-us/articles/115004320694-Software-Update-4-0-for-Neato-Botvac-Connected-D3-D5-).

-## {% linkable_title Vacuum %} +## Vacuum The `neato` vacuum platform allows you to control your [Neato Botvac Connected](https://www.neatorobotics.com/robot-vacuum/botvac-connected-series/). The status will contain attributes on the robots last clean session. @@ -54,7 +54,7 @@ The status will contain attributes on the robots last clean session. If you notice the robot stops responding to commands check the state to see if the robot is "unavailable". If you see "unavailable" first try to restart the vacuum and wait about 5 minutes to see if it is no longer "unavailable". If you are still having issues check the Neato app and make sure your robot is connected and working. If it is not then follow the steps in the app to reset your robot and give it the same name as before then restart Home Assistant.

-### {% linkable_title Services %} +### Services Currently supported services are: @@ -69,9 +69,9 @@ And a specific Platform Service: - `vacuum.neato_custom_cleaning` -### {% linkable_title Platform Services %} +### Platform Services -#### {% linkable_title Service `vacuum.neato_custom_cleaning` %} +#### Service `vacuum.neato_custom_cleaning` Starts a custom cleaning of your house. You can set the various options like in the mobile application (mode, map usage, navigation mode, zone). @@ -89,11 +89,11 @@ Some information about the capabilities might be found on the [Neato Developer P | `zone` | yes | Only supported on the Botvac D7. Name of the zone to clean from the Neato app. Use unique names for the zones to avoid the wrong zone from running. Defaults to no zone i.e. complete house cleanup. | -## {% linkable_title Camera %} +## Camera The `neato` camera platform allows you to view the latest cleaning map of your [Neato Botvac Connected](https://www.neatorobotics.com/robot-vacuum/botvac-connected-series/botvac-connected/). -## {% linkable_title Switch %} +## Switch The `neato` switch platform allows you to enable or disable the schedule of your [Neato Botvac Connected](https://www.neatorobotics.com/robot-vacuum/botvac-connected-series/botvac-connected/). diff --git a/source/_components/nello.markdown b/source/_components/nello.markdown index 4dc7c326c53..022b6cbb430 100644 --- a/source/_components/nello.markdown +++ b/source/_components/nello.markdown @@ -25,7 +25,7 @@ To get started you need to create a secondary Nello account and authorize it to Be aware that if you use your main account for Home Assistant you may not be able to use it with the App.

-## {% linkable_title Configuration %} +## Configuration To add your Nello locks to your installation, add the following to your `configuration.yaml` file: @@ -48,9 +48,9 @@ password: type: string {% endconfiguration %} -## {% linkable_title Events %} +## Events -### {% linkable_title Event `nello_bell_ring` %} +### Event `nello_bell_ring` Every time someone rings the bell, a `nello_bell_ring` event will be fired. diff --git a/source/_components/ness_alarm.markdown b/source/_components/ness_alarm.markdown index 6e54e59c29f..02bf59f53db 100644 --- a/source/_components/ness_alarm.markdown +++ b/source/_components/ness_alarm.markdown @@ -27,7 +27,7 @@ There is currently support for the following device types within Home Assistant: The module communicates via the [Ness D8x/D16x ASCII protocol](http://www.nesscorporation.com/Software/Ness_D8-D16_ASCII_protocol.pdf). -## {% linkable_title Configuration %} +## Configuration A `ness_alarm` section must be present in the `configuration.yaml` file and contain the following options as required: @@ -89,7 +89,7 @@ zones: type: string {% endconfiguration %} -#### {% linkable_title Time period dictionary example %} +#### Time period dictionary example ```yaml scan_interval: @@ -101,9 +101,9 @@ scan_interval: milliseconds: 0 ``` -## {% linkable_title Services %} +## Services -### {% linkable_title Service `aux` %} +### Service `aux` Trigger an aux output. This requires PCB version 7.8 or higher. @@ -112,7 +112,7 @@ Trigger an aux output. This requires PCB version 7.8 or higher. | `output_id` | No | The aux output you wish to change. A number from 1-4. | `state` | Yes | The On/Off State, represented as true/false. Default is true. If P14xE 8E is enabled then a value of true will pulse output x for the time specified in P14(x+4)E. -### {% linkable_title Service `panic` %} +### Service `panic` Trigger a panic diff --git a/source/_components/nest.markdown b/source/_components/nest.markdown index 7c8067cb8a6..5512645fc80 100644 --- a/source/_components/nest.markdown +++ b/source/_components/nest.markdown @@ -33,7 +33,7 @@ There is currently support for the following device types within Home Assistant: - [Climate](#climate) - [Sensor](#sensor) -### {% linkable_title Setting up developer account %} +### Setting up developer account 1. Visit [Nest Developers](https://developers.nest.com/), and sign in. Create an account if you don't have one already. 2. Fill in account details: @@ -54,7 +54,7 @@ There is currently support for the following device types within Home Assistant: Connecting to the Nest Developer API requires outbound port 9553 on your firewall. The configuration will fail if this is not accessible. -### {% linkable_title Configuration %} +### Configuration ```yaml # Example configuration.yaml entry @@ -88,7 +88,7 @@ structure: type: list {% endconfiguration %} -### {% linkable_title Service `set_away_mode` %} +### Service `set_away_mode` You can use the service `nest/set_away_mode` to set the structure(s) to "Home" or "Away". @@ -121,7 +121,7 @@ script: - Apartment ``` -### {% linkable_title Service `set_eta` %} +### Service `set_eta` You can use the service `nest/set_eta` to set or update the estimated time of arrival window. Calling this service will automatically set the structure(s) to "Away". Structures must have an associated Nest thermostat in order to use ETA function. @@ -159,7 +159,7 @@ script: - Apartment ``` -### {% linkable_title Service `cancel_eta` %} +### Service `cancel_eta` You can use the service `nest/cancel_eta` to cancel an existing estimated time of arrival window. Structures must have an associated Nest thermostat in order to use ETA function. @@ -192,17 +192,17 @@ script: - Apartment ``` -### {% linkable_title Troubleshooting %} +### Troubleshooting - If you're getting [rickrolled](https://www.youtube.com/watch?v=dQw4w9WgXcQ) instead of being able to see your Nest cameras, you may not have set up your developer account's permissions correctly. Go back through and make sure you've selected read/write under every category that it's an option. -## {% linkable_title Platforms %} +## Platforms

You must have the [Nest component](/components/nest/) configured to use the platforms below.

-## {% linkable_title Binary Sensor %} +## Binary Sensor The `nest` binary sensor platform lets you monitor various states of your [Nest](https://nest.com) devices. @@ -210,7 +210,7 @@ The `nest` binary sensor platform lets you monitor various states of your [Nest] You must have the [Nest component](/components/nest/) configured to use these sensors. The binary sensors will be setup if the `nest` integration is configured and the required configuration for the `nest binary sensor` is set.

-## {% linkable_title Configuration %} +## Configuration To enable binary sensors and customize which sensors are setup, you can extend the [Nest component](/components/nest/) configuration in your `configuration.yaml` file with the following settings: @@ -250,7 +250,7 @@ The following conditions are available by device: - person\_detected - sound\_detected -## {% linkable_title Camera %} +## Camera The `nest` platform allows you to watch still frames from a video stream (not live stream) of your [Nest](https://nest.com/camera/meet-nest-cam/) camera in Home Assistant. @@ -260,7 +260,7 @@ The `nest` camera will automatically be setup when you do. Nest Camera supports the `camera.turn_on` and `camera.turn_off` services since the 0.75 release. -## {% linkable_title Climate %} +## Climate The `nest` climate platform lets you control a thermostat from [Nest](https://nest.com). @@ -272,7 +272,7 @@ Please note due to limitations with the European Nest Thermostat E, integration

-## {% linkable_title Sensor %} +## Sensor The `nest` sensor platform lets you monitor sensors connected to your [Nest](https://nest.com) devices. @@ -280,7 +280,7 @@ The `nest` sensor platform lets you monitor sensors connected to your [Nest](htt The sensors will be setup if the `nest` integration is configured and the required configuration for the `nest sensor` is set.

-## {% linkable_title Configuration %} +## Configuration To enable sensors and customize which sensors are setup, you can extend the [Nest component](/components/nest/) configuration in your `configuration.yaml` file with the following settings: @@ -320,7 +320,7 @@ The following conditions are available by device: - color\_status: `gray`, `green`, `yellow` or `red`. Indicates device status by color in the Nest app UI. It is an aggregate condition for battery+smoke+CO states, and reflects the actual color indicators displayed in the Nest app. - Nest Camera: none -## {% linkable_title Security State %} +## Security State

This feature is not designed to transfer your Home Assistant to a security system, neither Home Assistant nor Nest be liable to You for damages, diff --git a/source/_components/netatmo.markdown b/source/_components/netatmo.markdown index 44b496ffa24..fdb8a0ffbb4 100644 --- a/source/_components/netatmo.markdown +++ b/source/_components/netatmo.markdown @@ -35,7 +35,7 @@ There is currently support for the following device types within Home Assistant: - [Climate](#climate) - [Sensor](#sensor) -## {% linkable_title Configuration %} +## Configuration To enable the Netatmo component, add the following lines to your `configuration.yaml`: @@ -77,7 +77,7 @@ webhooks: default: false {% endconfiguration %} -### {% linkable_title Get API and Secret Key %} +### Get API and Secret Key To get your API credentials, you have to declare a new application in the [Netatmo Developer Page](https://dev.netatmo.com/). Sign in using your username and password from your regular Netatmo account. Click on 'Create an App' at the top of the page. @@ -97,7 +97,7 @@ That's it. You can copy and paste your new `client id` and `client secret` in yo

-### {% linkable_title Webhooks %} +### Webhooks The Welcome and Presence cameras can send instant events to Home Assistant by using webhooks. There are different types of events, each with slightly different data attached. To enable the webhooks add `webhooks: true` to your configuration. It is also required to have your camera enabled in Home Assistant. You can do this either by manually setting up the [platform](https://www.home-assistant.io/components/camera.netatmo/) or by enabeling [discovery](https://www.home-assistant.io/components/netatmo/#discovery). @@ -105,7 +105,7 @@ To be able to receive events from Netatmo, your Home Assistant instance needs to Events coming in from Netatmo will be available as events in Home Assistant and are fired as netatmo_*, along with their data. You can use this event to trigger automations. -#### {% linkable_title Events %} +#### Events The following events are available: @@ -143,7 +143,7 @@ The Welcome camera additionally has these attributes for `netatmo_person` events The `netatmo_other` event passes all the webhook data through for all webhook events that don't match any of the above. Set the [level of logging](https://www.home-assistant.io/components/logger/) for the `netatmo` integration to `debug` to view the data in the Home Assistant logs. -### {% linkable_title Services (only for webhooks) %} +### Services (only for webhooks) There are two services to manually add and drop the webhooks. This might be useful if your webhook has been banned and you want to readd the webhook without restarting Home Assistant. @@ -152,11 +152,11 @@ There are two services to manually add and drop the webhooks. This might be usef | addwebhook | Subscribe to webhooks. By default the automatically generated URL will be used. But you can pass `{"url": "https://yourdomain.com/yourwebhook/"}` as service data to the service call if you want to use a manually created [webhook trigger](https://www.home-assistant.io/docs/automation/trigger/#webhook-trigger). In this case you have to manually process the data that is sent by Netatmo. | dropwebhook | Unsubscribe existing webhooks. -## {% linkable_title Binary Sensor %} +## Binary Sensor This integration allows you to get the latest event seen by the camera. -### {% linkable_title Binary Sensor Advanced configuration %} +### Binary Sensor Advanced configuration If you want to select a specific sensor, set discovery to `false` for [netatmo](/components/netatmo/) @@ -215,11 +215,11 @@ If **home** and **cameras** is not provided, all cameras will be used. If multiple cameras are available then each monitored conditions will create a specific sensor for each camera -## {% linkable_title Camera %} +## Camera The `netatmo` camera platform is consuming the information provided by a [Netatmo](https://www.netatmo.com) camera. This integration allows you to view the current photo created by the Camera. -### {% linkable_title Camera Advanced configuration %} +### Camera Advanced configuration If you want to select a specific camera, set discovery to `false` for [netatmo](/components/netatmo/) @@ -263,11 +263,11 @@ camera: - camera_name2 ``` -## {% linkable_title Climate %} +## Climate The `netatmo` thermostat platform is consuming the information provided by a [Netatmo Smart Thermostat](https://www.netatmo.com/product/energy/thermostat) thermostat. This integration allows you to view the current temperature and setpoint. -### {% linkable_title Camera Advanced configuration %} +### Camera Advanced configuration If you want to select specific homes or specific rooms, set discovery to `false` for [netatmo](/components/netatmo/) @@ -313,7 +313,7 @@ climate: - room5_name ``` -## {% linkable_title Sensor %} +## Sensor The `netatmo` sensor platform is consuming the information provided by a [Netatmo Weather Station](https://www.netatmo.com/en-us/weather/weatherstation), a [Netatmo Home Coach](https://www.netatmo.com/en-us/aircare/homecoach) [Netatmo](https://www.netatmo.com) device or the public sensors of others available via the [Netatmo API](https://weathermap.netatmo.com/) even if you don't own a Netatmo device. @@ -327,7 +327,7 @@ Public sensors have to be set up manually. Currently the following conditions ar * windstrength * guststrength -## {% linkable_title Advanced sensor configuration %} +## Advanced sensor configuration If you want to select a specific sensor, set discovery to False for [netatmo](/components/netatmo/) and add the following lines to your `configuration.yaml`: @@ -450,7 +450,7 @@ areas: default: avg {% endconfiguration %} -## {% linkable_title Find your modules name %} +## Find your modules name You can find your modules name in your [online NetAtmo account](https://my.netatmo.com/app/station). These names can be found and changed in parameters. You have to provide these name in your Home Assistant `configuration.yaml` file. diff --git a/source/_components/netdata.markdown b/source/_components/netdata.markdown index 6246eb756f2..d69d9dc4e2f 100644 --- a/source/_components/netdata.markdown +++ b/source/_components/netdata.markdown @@ -18,7 +18,7 @@ redirect_from: The `netdata` sensor platform allows you to display information collected by [Netdata](http://my-netdata.io/). -## {% linkable_title Setup %} +## Setup Getting the details to configure the sensors is a bit tricky as Netdata uses different name for the `element:` value that is required. To get the value for the `data_group:` use Netdata's web interface. `1.` marks the name for the `data_group:`. `2.` are the names for the element to show in Home Assistant. The name that is shown can be different than the name under which the metrics are available. @@ -70,7 +70,7 @@ Alternatively you can browse to the built in Netdata API in your browser `http:/ Once the `data_group` "system.load" and the `element` "load15" have been identified from the JSON it can be configured in your configuration.yaml like the example below. -## {% linkable_title Configuration %} +## Configuration Add the following to your `configuration.yaml`. @@ -130,7 +130,7 @@ resources: default: false {% endconfiguration %} -### {% linkable_title Full Example %} +### Full Example ```yaml # Example configuration.yaml entry diff --git a/source/_components/netgear_lte.markdown b/source/_components/netgear_lte.markdown index 56a195073cf..d728a6c2dc4 100644 --- a/source/_components/netgear_lte.markdown +++ b/source/_components/netgear_lte.markdown @@ -30,7 +30,7 @@ There is currently support for the following device types within Home Assistant: The integration supports sending notifications with SMS, reporting incoming SMS with events and reporting the modem and connection state in a number of sensors and binary sensors. -## {% linkable_title Configuration %} +## Configuration To enable the integration, add the following lines to your `configuration.yaml` file: @@ -131,9 +131,9 @@ binary_sensor: description: The current roaming state. {% endconfiguration %} -## {% linkable_title Events %} +## Events -### {% linkable_title Event `netgear_lte_sms` %} +### Event `netgear_lte_sms` Messages arriving in the modem inbox are sent as events of type `netgear_lte_sms` with the following content. @@ -144,9 +144,9 @@ Messages arriving in the modem inbox are sent as events of type `netgear_lte_sms | `from` | The sender of the message. | `message` | The SMS message content. -## {% linkable_title Services %} +## Services -### {% linkable_title Service `netgear_lte.connect_lte` %} +### Service `netgear_lte.connect_lte` This service asks the modem to establish its LTE connection, useful if the modem does not autoconnect. @@ -154,7 +154,7 @@ This service asks the modem to establish its LTE connection, useful if the modem | ---------------------- | -------- | ----------- | | `host` | yes | The modem that should connect (optional when just one modem is configured). -### {% linkable_title Service `netgear_lte.delete_sms` %} +### Service `netgear_lte.delete_sms` The integration makes a service available to delete messages from the modem inbox. This can be used to clean up after incoming SMS events. @@ -163,7 +163,7 @@ The integration makes a service available to delete messages from the modem inbo | `host` | yes | The modem that should have a message deleted (optional when just one modem is configured). | `sms_id` | no | Integer or list of integers with inbox IDs of messages to delete. -### {% linkable_title Service `netgear_lte.set_option` %} +### Service `netgear_lte.set_option` This service can set modem configuration options (otherwise available in the modem web UI). @@ -173,7 +173,7 @@ This service can set modem configuration options (otherwise available in the mod | `autoconnect` | yes | Autoconnect value: `never`/`home`/`always`, with `home` meaning "not roaming". | `failover` | yes | Failover mode: `wire` (wired connection only), `mobile` (mobile connection only), `auto` (wired connection with failover to mobile connection). -## {% linkable_title Examples %} +## Examples The following automation example processes incoming SMS messages with the [Conversation](/components/conversation/) integration and then deletes the message from the inbox. diff --git a/source/_components/nfandroidtv.markdown b/source/_components/nfandroidtv.markdown index dfd81f0853f..fa396171800 100644 --- a/source/_components/nfandroidtv.markdown +++ b/source/_components/nfandroidtv.markdown @@ -96,7 +96,7 @@ This is a fully customized JSON you can use to test how the final notification w } ``` -### {% linkable_title Service data for sending images %} +### Service data for sending images The following attributes can be placed inside `data` to send images. diff --git a/source/_components/niko_home_control.markdown b/source/_components/niko_home_control.markdown index 20a688fb88c..3e5ea691327 100644 --- a/source/_components/niko_home_control.markdown +++ b/source/_components/niko_home_control.markdown @@ -17,7 +17,7 @@ redirect_from: The `niko_home_control` platform allows you to integrate your [Niko Home Control](https://www.niko.eu/enus/products/niko-home-control) into Home Assistant. -## {% linkable_title Configuration %} +## Configuration To enable this lights, add the following lines to your `configuration.yaml`: diff --git a/source/_components/nilu.markdown b/source/_components/nilu.markdown index 001c590ff43..65969efc2a2 100644 --- a/source/_components/nilu.markdown +++ b/source/_components/nilu.markdown @@ -18,7 +18,7 @@ redirect_from: The `nilu` air quality platform shows measurements of current air quality from NILU (Norsk Institutt for luftforskning/Norwegian Institute for Air Research) sensor stations within Norway. Makes data from the open API at [luftkvalitet.info](http://luftkvalitet.info/) and [nilu.no](https://nilu.no/) available in Home Assistant. -## {% linkable_title Configuration %} +## Configuration To enable this platform, add the following lines to your `configuration.yaml` file: @@ -59,29 +59,29 @@ air_quality: type: boolean {% endconfiguration %} -## {% linkable_title Health risk index explainations %} +## Health risk index explainations Under the attributes from a NILU station, there will be a `nilu pollution index`. This indicates how polluted the air is in the area around the sensor station. Following is a longer explanation of what the indexes mean. -### {% linkable_title Low %} +### Low Low or no health risk linked to measured air pollution. Outdoor activites are recommended. -### {% linkable_title Moderate %} +### Moderate Health effects may occur in some asthmatics and people with other respiratory diseases, as well as serious cardiovascular diseases. Outdoor activity can be recommended for the vast majority, but some should consider their activity in areas with high traffic or high emissions. -### {% linkable_title High %} +### High Health effects may occur in asthmatics and people with other respiratory diseases, as well as serious cardiovascular disease. Children with respiratory distress (asthma, bronchitis) and adults with severe cardiac or respiratory distress should reduce outdoor activity and not stay in the most polluted areas. -### {% linkable_title Extremely high %} +### Extremely high Sensitive groups in the population can have health effects. Respiratory irritation and discomfort may occur in healthy subjects. People with heart or respiratory distress should reduce outdoor activity and not stay in the most polluted areas. Source: [Explainations in Norwegian](http://www.luftkvalitet.info/home/Varslingsklasser.aspx) -## {% linkable_title Available areas %} +## Available areas The `area` configuration is restricted to the areas NILU has defined. Here is the list of available areas: @@ -121,7 +121,7 @@ The `area` configuration is restricted to the areas NILU has defined. Here is th - `Zeppelinfjellet` - `Ålesund` -## {% linkable_title Configuration examples %} +## Configuration examples Example of adding health risk monitoring from sensor stations around the Home Assistant location. diff --git a/source/_components/nissan_leaf.markdown b/source/_components/nissan_leaf.markdown index c291d89c383..250e22e8a9d 100644 --- a/source/_components/nissan_leaf.markdown +++ b/source/_components/nissan_leaf.markdown @@ -25,7 +25,7 @@ The `nissan_leaf` integration offers integration with the [NissanConnect EV](htt * a device tracker to locate the car (only on later Leaf models) * services to request updates from the car and to request the car starts charging. -## {% linkable_title Configuration %} +## Configuration To use Nissan Leaf in your installation, add the following to your `configuration.yaml` file: @@ -70,7 +70,7 @@ update_interval_climate: type: time {% endconfiguration %} -## {% linkable_title Full configuration sample %} +## Full configuration sample A more advanced example for setting the update interval: @@ -90,7 +90,7 @@ nissan_leaf: force_miles: true ``` -## {% linkable_title Starting a Charge %} +## Starting a Charge You can use the `nissan_leaf.start_charge` service to send a request to the Nissan servers to start a charge. The car must be plugged in! The service requires you to provide the vehicle identification number (VIN) as a parameter. You can see the VIN on the attributes of all the entities created by this component, except the device_tracker. @@ -100,7 +100,7 @@ You can use the `nissan_leaf.start_charge` service to send a request to the Niss vin: '1HGBH41JXMN109186' # replace ``` -## {% linkable_title Updating on-demand using Automation %} +## Updating on-demand using Automation You can also use the `nissan_leaf.update` service to request an on-demand update. To update almost exclusively via the service set the `update_interval` to a high value in the integration configuration. The service requests the VIN number as described above. @@ -121,7 +121,7 @@ You can also use the `nissan_leaf.update` service to request an on-demand update vin: '1HGBH41JXMN109186' # replace ``` -## {% linkable_title Hints %} +## Hints * The update interval has a minimum of two minutes. * Requesting updates uses a small amount of power from the 12 V battery. The 12 V battery charges from the main traction battery when the car is not plugged in. If the car is left plugged in for a long time, or if the main traction battery is very low then the 12 V battery may gradually discharge. A low update interval may cause the 12 V battery to become flat. When the 12 V battery is flat the car will not start. _Do not set the update interval too low. Use at your own risk._ diff --git a/source/_components/nmap_tracker.markdown b/source/_components/nmap_tracker.markdown index 84aafaa55fc..3ac31cf5e75 100644 --- a/source/_components/nmap_tracker.markdown +++ b/source/_components/nmap_tracker.markdown @@ -59,7 +59,7 @@ scan_options: type: string {% endconfiguration %} -## {% linkable_title Examples %} +## Examples A full example for the `nmap` tracker could look like the following sample: @@ -90,7 +90,7 @@ In the above example, Nmap will be call with the process: An example of how the Nmap scanner can be customized: -### {% linkable_title Linux capabilities %} +### Linux capabilities On Linux systems (such as Hass.io) you can extend the functionality of Nmap, without having to run it as root, by using *Linux capabilities*. Be sure to specify the full path to wherever you installed Nmap: diff --git a/source/_components/nmbs.markdown b/source/_components/nmbs.markdown index 061e6d332d2..06ba7603c29 100644 --- a/source/_components/nmbs.markdown +++ b/source/_components/nmbs.markdown @@ -18,7 +18,7 @@ redirect_from: The `nmbs` platform will create sensors for monitoring travel time and information between 2 stations. -## {% linkable_title Configuration %} +## Configuration To enable this sensor, add the following lines to your `configuration.yaml`: diff --git a/source/_components/noaa_tides.markdown b/source/_components/noaa_tides.markdown index 7ccddd4bbe6..2f6ca17d99a 100644 --- a/source/_components/noaa_tides.markdown +++ b/source/_components/noaa_tides.markdown @@ -17,11 +17,11 @@ redirect_from: The `noaa_tides` sensor platform uses details from [NOAA Tides and Currents](https://tidesandcurrents.noaa.gov/api/) to provide information about the prediction for the tides for any location in the United States. -## {% linkable_title Setup %} +## Setup This sensor requires the use of a NOAA station ID. Search [NOAA Tide Predictions](https://tidesandcurrents.noaa.gov/tide_predictions.html) to find a location. Use the ID from the search results in your configuration. Alternatively, you can determine a station ID from a URL. For example, `8721164` in the following URL: `https://tidesandcurrents.noaa.gov/noaatidepredictions.html?id=8721164` -## {% linkable_title Configuration %} +## Configuration To use this sensor, add the following to your `configuration.yaml` file: diff --git a/source/_components/notify.group.markdown b/source/_components/notify.group.markdown index d0b8d247d2b..afda9b6f25b 100644 --- a/source/_components/notify.group.markdown +++ b/source/_components/notify.group.markdown @@ -16,7 +16,7 @@ ha_qa_scale: internal The `group` notification platform allows you to combine multiple `notify` platforms into a single service. -## {% linkable_title Configuration %} +## Configuration ```yaml # Example configuration.yaml entry @@ -50,7 +50,7 @@ services: type: string {% endconfiguration %} -## {% linkable_title Example %} +## Example An example on how to use it in an automation: diff --git a/source/_components/notify.knx.markdown b/source/_components/notify.knx.markdown index 78877b65559..5c5db243871 100644 --- a/source/_components/notify.knx.markdown +++ b/source/_components/notify.knx.markdown @@ -18,7 +18,7 @@ The `knx` notify platform allows you to send notifications to [KNX](http://www.k The `knx` integration must be configured correctly, see [KNX Component](/components/knx). -## {% linkable_title Configuration %} +## Configuration To use your KNX switch in your installation, add the following lines to your `configuration.yaml` file: diff --git a/source/_components/notify.markdown b/source/_components/notify.markdown index e0677d806cd..5255e2482d5 100644 --- a/source/_components/notify.markdown +++ b/source/_components/notify.markdown @@ -18,7 +18,7 @@ The `notify` integration makes it possible to send notifications to a wide varie If you want to send notifications to the Home Assistant Web Interface you may use the [Persistent Notification Component](/components/persistent_notification/). -## {% linkable_title Service %} +## Service Once loaded, the `notify` platform will expose a service that can be called to send notifications. @@ -41,7 +41,7 @@ action: title: "Custom subject" ``` -### {% linkable_title Test if it works %} +### Test if it works A simple way to test if you have set up your notify platform correctly, is to use service developer tool icon **Services** from the **Developer Tools**. Choose your service from the dropdown menu **Service**, enter something like the sample below into the **Service Data** field, and hit **CALL SERVICE**. diff --git a/source/_components/notify.mysensors.markdown b/source/_components/notify.mysensors.markdown index 0fe8e8318ab..1a0f71e7875 100644 --- a/source/_components/notify.mysensors.markdown +++ b/source/_components/notify.mysensors.markdown @@ -19,7 +19,7 @@ Integrates MySensors notifications into Home Assistant. See the [main component] Setting the `target` key in the service call will target the name of the MySensors device in Home Assistant. MySensors device names follow the notation: "[Sketch name] [Node id] [Child id]". -### {% linkable_title Automation example %} +### Automation example ```yaml ... @@ -40,7 +40,7 @@ S_INFO | V_TEXT For more information, visit the [api] page of MySensors. -### {% linkable_title Example sketch %} +### Example sketch ```cpp /* diff --git a/source/_components/nsw_fuel_station.markdown b/source/_components/nsw_fuel_station.markdown index 96eb596d703..cf6dd619386 100644 --- a/source/_components/nsw_fuel_station.markdown +++ b/source/_components/nsw_fuel_station.markdown @@ -18,7 +18,7 @@ redirect_from: The `nsw_fuel_station` sensor platform uses the [NSW Fuel Check App](https://www.fuelcheck.nsw.gov.au/app) data as a source for current fuel price data. -## {% linkable_title Setup %} +## Setup To get the station ID for any NSW fuel station you will need to: @@ -27,7 +27,7 @@ To get the station ID for any NSW fuel station you will need to: - In the Fuel Check App, search for your postcode or click "Fuel Near Me". - In the developer console, you should see a request to `/FuelCheckApp/v1/fuel/prices/bylocation`. Open this request and preview the response. Find the station you wish to add, and copy down the `ServiceStationID` field. -## {% linkable_title Configuration %} +## Configuration To add the NSW fuel station price sensor to your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/nsw_rural_fire_service_feed.markdown b/source/_components/nsw_rural_fire_service_feed.markdown index 264208357a3..e14053f7c13 100644 --- a/source/_components/nsw_rural_fire_service_feed.markdown +++ b/source/_components/nsw_rural_fire_service_feed.markdown @@ -32,7 +32,7 @@ The entity's information can be used for example if a bush fire that produces sm The data is updated every 5 minutes. -## {% linkable_title Configuration %} +## Configuration To integrate the NSW Rural Fire Service Incidents feed, add the following lines to your `configuration.yaml`. @@ -65,7 +65,7 @@ longitude: default: Longitude defined in your `configuration.yaml` {% endconfiguration %} -## {% linkable_title State Attributes %} +## State Attributes The following state attributes are available for each entity in addition to the standard ones: @@ -85,7 +85,7 @@ The following state attributes are available for each entity in addition to the | size | Size in hectare | | responsible_agency | Agency responsible for this incident. | -## {% linkable_title Advanced Configuration Example %} +## Advanced Configuration Example Depending on your personal circumstances with regards to bush fire risk you may want to adjust the radius and define the categories of fire warnings you are actually interested in. diff --git a/source/_components/nuheat.markdown b/source/_components/nuheat.markdown index a6f6d25a215..cee7f13126c 100644 --- a/source/_components/nuheat.markdown +++ b/source/_components/nuheat.markdown @@ -57,19 +57,19 @@ devices: type: [string, int] {% endconfiguration %} -## {% linkable_title Concepts %} +## Concepts The NuHeat Thermostat supports the following key concepts. The `target temperature` is the temperature that the device attempts to achieve. The target temperature is either determined by the schedule programmed into the thermostat (`auto mode`) or may be overridden. When the target temperature is set by Home Assistant, the thermostat will hold this temperature until the schedule is resumed. -## {% linkable_title Attributes %} +## Attributes The following attributes are provided by the NuHeat thermostat: `name`, `temperature_unit`, `current_temperature`, `target_temperature`, `current_hold_mode`, `current_operation`, `operation_list`, `min_temp` and `max_temp`. -### {% linkable_title Attribute `name` %} +### Attribute `name` Returns the name of the NuHeat Thermostat. @@ -77,7 +77,7 @@ Returns the name of the NuHeat Thermostat. | ---------------| ----------- | | String | Name of the thermostat -### {% linkable_title Attribute `temperature_unit` %} +### Attribute `temperature_unit` Returns the unit of measurement used for temperature by the thermostat. @@ -85,7 +85,7 @@ Returns the unit of measurement used for temperature by the thermostat. | ---------------| ----------- | | String | Name of the temperature unit -### {% linkable_title Attribute `current_temperature` %} +### Attribute `current_temperature` Returns the current temperature measured by the thermostat. @@ -93,7 +93,7 @@ Returns the current temperature measured by the thermostat. | ---------------| ----------- | | Integer | Currently measured temperature -### {% linkable_title Attribute `target_temperature` %} +### Attribute `target_temperature` Returns the target temperature of the thermostat, when the thermostat is not in auto operation mode. @@ -102,7 +102,7 @@ not in auto operation mode. | ---------------| ----------- | | Integer | Target temperature -### {% linkable_title Attribute `current_hold_mode` %} +### Attribute `current_hold_mode` Returns the current temperature hold, if any. @@ -110,7 +110,7 @@ Returns the current temperature hold, if any. | ---------------| ----------- | | String | 'temperature', 'temporary_temperature', 'auto', etc. -### {% linkable_title Attribute `current_operation` %} +### Attribute `current_operation` Returns the current operation of the thermostat. @@ -118,7 +118,7 @@ Returns the current operation of the thermostat. | ---------------| ----------- | | String | 'heat', 'idle' -### {% linkable_title Attribute `operation_list` %} +### Attribute `operation_list` Returns the list of available operation modes. @@ -126,7 +126,7 @@ Returns the list of available operation modes. | ---------------| ----------- | | List of String | Available operation modes -### {% linkable_title Attribute `min_temp` %} +### Attribute `min_temp` Returns the minimum supported temperature by the thermostat @@ -134,7 +134,7 @@ Returns the minimum supported temperature by the thermostat | ---------------| ----------- | | Integer | Minimum supported temperature -### {% linkable_title Attribute `max_temp` %} +### Attribute `max_temp` Returns the maximum supported temperature by the thermostat @@ -143,13 +143,13 @@ Returns the maximum supported temperature by the thermostat | Integer | Maximum supported temperature -## {% linkable_title Services %} +## Services The following services are provided by the NuHeat Thermostat: `set_temperature`, `set_hold_mode`, `nuheat_resume_program`. The services `fan_min_on_time`, `set_aux_heat`, `set_away_mode`, `set_humidity`, `set_fan_mode`, `set_operation_mode` and `set_swing_mode` offered by the [Climate component](/components/climate/) are not implemented for this thermostat. -### {% linkable_title Service `set_temperature` %} +### Service `set_temperature` Puts the thermostat into an indefinite hold at the given temperature. @@ -161,7 +161,7 @@ Puts the thermostat into an indefinite hold at the given temperature. Only the target temperatures relevant for the current operation mode need to be provided. -### {% linkable_title Service `set_hold_mode` %} +### Service `set_hold_mode` Sets the thermostat's hold mode. The NuHeat thermostat supports "auto" (to run the thermostat's programmed schedule), "temperature" (to indefinitely hold the thermostat's current target temperature), or "temporary_temperature" (to hold the thermostat's current target temperature until the thermostat's next scheduled event). @@ -170,7 +170,7 @@ Sets the thermostat's hold mode. The NuHeat thermostat supports "auto" (to run t | `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all. | `hold_mode` | no | New value of hold mode. -### {% linkable_title Service `nuheat_resume_program` %} +### Service `nuheat_resume_program` Resumes the currently active schedule. diff --git a/source/_components/nuki.markdown b/source/_components/nuki.markdown index 0b862989f82..1706f363579 100644 --- a/source/_components/nuki.markdown +++ b/source/_components/nuki.markdown @@ -45,9 +45,9 @@ token: type: string {% endconfiguration %} -## {% linkable_title Services %} +## Services -### {% linkable_title Service `nuki_unlatch` %} +### Service `nuki_unlatch` This will unlatch the door, ie. open it (provided this works with your type of door). @@ -55,7 +55,7 @@ This will unlatch the door, ie. open it (provided this works with your type of d | ---------------------- | -------- | ----------- | | `entity_id` | yes | String or list of strings that point at `entity_id`s Nuki Locks. -### {% linkable_title Service `nuki_lock_n_go` %} +### Service `nuki_lock_n_go` This will first unlock, wait a few seconds (20 by default) then re-lock. The wait period can be customized through the app. See the [Nuki Website](https://nuki.io/en/support/smart-lock/sl-features/locking-with-the-smart-lock/) for more details about this feature. diff --git a/source/_components/nut.markdown b/source/_components/nut.markdown index ebb70c5d2e1..b0863ba2a33 100644 --- a/source/_components/nut.markdown +++ b/source/_components/nut.markdown @@ -18,7 +18,7 @@ redirect_from: The `nut` sensor platform allows you to monitor a UPS (battery backup) by using data from a [NUT](http://networkupstools.org/) (Network UPS Tools) server. -## {% linkable_title Configuration %} +## Configuration To use this sensor platform, you need to add the following to your `configuration.yaml` file: @@ -70,7 +70,7 @@ sensor: type: list {% endconfiguration %} -## {% linkable_title Example %} +## Example Given the following example output from NUT (your variables may differ): @@ -132,7 +132,7 @@ sensor: - battery.runtime ``` -## {% linkable_title UPS Status - human-readable version %} +## UPS Status - human-readable version An additional virtual sensor type `ups.status.display` is available translating the UPS status value retrieved from `ups.status` into a human-readable version. diff --git a/source/_components/nx584.markdown b/source/_components/nx584.markdown index 8d4d42816f5..73c489f466f 100644 --- a/source/_components/nx584.markdown +++ b/source/_components/nx584.markdown @@ -24,7 +24,7 @@ There is currently support for the following device types within Home Assistant: - [Binary Sensor](#binary-sensor) -## {% linkable_title Configuration %} +## Configuration To enable this, add the following lines to your `configuration.yaml`: @@ -52,7 +52,7 @@ port: default: 5007 {% endconfiguration %} -## {% linkable_title Binary Sensor %} +## Binary Sensor Enabling this binary sensor platform exposes all of your zones as binary sensors, which provides visibility through the UI as well as the ability to trigger automation actions instantly when something happens like a door opening, or a motion sensor trigger. @@ -98,7 +98,7 @@ zone_types: description: Safety {% endconfiguration %} -## {% linkable_title Full example %} +## Full example An extended configuration entry could look like this: diff --git a/source/_components/oasa_telematics.markdown b/source/_components/oasa_telematics.markdown index a00c9d38bd8..36cb1e3a18c 100644 --- a/source/_components/oasa_telematics.markdown +++ b/source/_components/oasa_telematics.markdown @@ -17,7 +17,7 @@ ha_release: 0.92 The `oasa_telematics` sensor will provide you with bus and trolley arrival times for Greek public transport for Athens, using real-time data from [OASA Telematics](http://telematics.oasa.gr/en/). -## {% linkable_title Configuration %} +## Configuration Add a sensor to your `configuration.yaml` file as shown in the example: @@ -59,7 +59,7 @@ name: type: string {% endconfiguration %} -## {% linkable_title Examples %} +## Examples A more extensive example on how to use this sensor: diff --git a/source/_components/octoprint.markdown b/source/_components/octoprint.markdown index e08c2fe09f2..95efbbdbd5e 100644 --- a/source/_components/octoprint.markdown +++ b/source/_components/octoprint.markdown @@ -30,7 +30,7 @@ There is currently support for the following device types within Home Assistant: You must have the OctoPrint component configured (below) to use the sensor and binary sensor. After configuring that component, the sensors and binary sensors automatically appear.

-## {% linkable_title Configuration %} +## Configuration To get started with the OctoPrint API, please follow the directions on their [site](http://docs.octoprint.org/en/master/api/general.html). Once OctoPrint is configured you will need to add your API key and host to your `configuration.yaml`. @@ -151,7 +151,7 @@ camera: mjpeg_url: http://YOUR_OCTOPRINT_HOST_IP/webcam/?action=stream ``` -## {% linkable_title Binary Sensor %} +## Binary Sensor The `octoprint` binary sensor platform let you monitor if your 3D printer is printing or if there was a printing error. @@ -182,6 +182,6 @@ name: default: OctoPrint {% endconfiguration %} -## {% linkable_title Sensor %} +## Sensor The `octoprint` sensor platform let you monitor various states of your 3D printer and its print jobs. diff --git a/source/_components/ohmconnect.markdown b/source/_components/ohmconnect.markdown index 8ddfdbec2cc..065138acd8e 100644 --- a/source/_components/ohmconnect.markdown +++ b/source/_components/ohmconnect.markdown @@ -20,7 +20,7 @@ The `ohmconnect` sensor will show you the current [OhmConnect](https://www.ohmco OhmConnect monitors real-time conditions on the electricity grid. When dirty and unsustainable power plants turn on, our users receive a notification to save energy. By saving energy at that time, California does not have to turn on additional power plants and California's energy authorities pay you for that. -## {% linkable_title Configuration %} +## Configuration You can find your OhmConnect ID under "Open Source Projects" on the [settings page](https://login.ohmconnect.com/settings). It's the string after the last `/` in the URL, e.g., for the URL `https://login.ohmconnect.com/verify-ohm-hour/AbCd1e` your ID is `AbCd1e`. diff --git a/source/_components/onewire.markdown b/source/_components/onewire.markdown index f571786b323..cb2d92857ad 100644 --- a/source/_components/onewire.markdown +++ b/source/_components/onewire.markdown @@ -30,18 +30,18 @@ Supported devices: The 1-Wire bus can be connected directly to the IO pins of Raspberry Pi or using dedicated interface adapter (e.g [DS9490R](https://datasheets.maximintegrated.com/en/ds/DS9490-DS9490R.pdf)). -## {% linkable_title Raspberry Pi setup %} +## Raspberry Pi setup In order to setup 1-Wire support on Raspberry Pi, you'll need to edit `/boot/config.txt` following [this documentation](https://www.waveshare.com/wiki/Raspberry_Pi_Tutorial_Series:_1-Wire_DS18B20_Sensor#Enable_1-Wire). To edit `/boot/config.txt` on Hass.io use [this documentation](https://developers.home-assistant.io/docs/en/hassio_debugging.html) to enable SSH and edit `/mnt/boot/config.txt` via `vi`. -## {% linkable_title Interface adapter setup %} +## Interface adapter setup -### {% linkable_title owfs %} +### owfs When an interface adapter is used, sensors can be accessed on Linux hosts via [owfs 1-Wire file system](http://owfs.org/). When using an interface adapter and the owfs, the `mount_dir` option must be configured to correspond a directory, where owfs device tree has been mounted. -### {% linkable_title Units with multiple sensors %} +### Units with multiple sensors This platform works with devices with multiple sensors which will cause a discontinuity in recorded values. Existing devices will receive a new ID and therefore show up as new devices. If you wish to maintain continuity it can be resolved in the database by renaming the old devices to the new names. @@ -61,7 +61,7 @@ UPDATE states SET entity_id='sensor._humidity' WHERE entity_id LIKE Remember to replace `` with the actual name of the sensor as seen in the `SELECT` query. -## {% linkable_title Configuration %} +## Configuration To enable One wire sensors in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/onkyo.markdown b/source/_components/onkyo.markdown index 3f0d8dfe462..822717cb504 100644 --- a/source/_components/onkyo.markdown +++ b/source/_components/onkyo.markdown @@ -19,7 +19,7 @@ redirect_from: The `onkyo` platform allows you to control a [Onkyo](http://www.onkyo.com/) and some recent [Pioneer](http://www.pioneerelectronics.com) receivers from Home Assistant. Please be aware that you need to enable "Network Standby" for this integration to work in your Hardware. -## {% linkable_title Configuration %} +## Configuration To add an Onkyo or Pioneer receiver to your installation, add the following to your `configuration.yaml` file: @@ -83,7 +83,7 @@ List of source names: - xm - sirius -### {% linkable_title Service `onkyo_select_hdmi_output` %} +### Service `onkyo_select_hdmi_output` Changes HDMI output of your receiver @@ -97,7 +97,7 @@ Accepted values are: which one to use seems to vary depending on model so you will have to try them out. ( For model TX-NR676E it seems to be 'out' for main, 'out-sub' for sub, and 'sub' for both ) -### {% linkable_title Example `play_media` script %} +### Example `play_media` script The `play_media` function can be used in script to play radio station by preset number. Not working for NET radio. @@ -120,7 +120,7 @@ script: ``` -### {% linkable_title Example `onkyo_select_hdmi_output` script %} +### Example `onkyo_select_hdmi_output` script ```yaml # Example onkyo_select_hdmi_output script diff --git a/source/_components/onvif.markdown b/source/_components/onvif.markdown index e33e21c7287..f6721103f53 100644 --- a/source/_components/onvif.markdown +++ b/source/_components/onvif.markdown @@ -17,7 +17,7 @@ redirect_from: The `onvif` camera platform allows you to use an [ONVIF](https://www.onvif.org/) camera in Home Assistant. This requires the [`ffmpeg` component](/components/ffmpeg/) to be already configured. -## {% linkable_title Configuration %} +## Configuration To enable your ONVIF camera in your installation, add the following to your `configuration.yaml` file: @@ -67,7 +67,7 @@ extra_arguments: Most of the ONVIF cameras support more than one audio/video profile. Each profile provides different image quality. Usually, the first profile has the highest quality and it is the profile used by default. However, you may want to use a lower quality image. One of the reasons may be that your hardware isn't able to render the highest quality image in real-time, especially when running on Raspberry Pi. Therefore you can choose which profile do you want to use by setting in config `profile` variable. -### {% linkable_title Service `camera.onvif_ptz` %} +### Service `camera.onvif_ptz` If your ONVIF camera supports PTZ, you will be able to pan, tilt or zoom your camera. diff --git a/source/_components/openalpr_cloud.markdown b/source/_components/openalpr_cloud.markdown index 1c86ceeedc5..8ba6284898b 100644 --- a/source/_components/openalpr_cloud.markdown +++ b/source/_components/openalpr_cloud.markdown @@ -22,7 +22,7 @@ or trigger any other [automation](/components/automation/). For using the result inside an automation rule, take a look at the [component](/components/image_processing/) page. -### {% linkable_title Configuration %} +### Configuration ```yaml # Example configuration.yaml entry diff --git a/source/_components/openalpr_local.markdown b/source/_components/openalpr_local.markdown index 920d293d5c4..6206c7feaef 100644 --- a/source/_components/openalpr_local.markdown +++ b/source/_components/openalpr_local.markdown @@ -23,7 +23,7 @@ or trigger any other [automation](/components/automation/). For using the result inside an automation rule, take a look at the [component](/components/image_processing) page. -### {% linkable_title Local installation %} +### Local installation If you want process all data locally, you need version 2.3.1 or higher of the `alpr` commandline tool. @@ -49,7 +49,7 @@ Verify your `alpr` installation with: $ wget -O- -q http://plates.openalpr.com/h786poj.jpg | alpr - ``` -### {% linkable_title Configuration %} +### Configuration ```yaml # Example configuration.yaml entry diff --git a/source/_components/opencv.markdown b/source/_components/opencv.markdown index 97f5dd71cab..e9047b10432 100644 --- a/source/_components/opencv.markdown +++ b/source/_components/opencv.markdown @@ -19,7 +19,7 @@ redirect_from: Some pre-defined classifiers can be found [here](https://github.com/opencv/opencv/tree/master/data). -## {% linkable_title Configuration %} +## Configuration To setup OpenCV with Home Assistant, add the following section to your `configuration.yaml` file: diff --git a/source/_components/openevse.markdown b/source/_components/openevse.markdown index a2b33f9467f..dd5e1dd4bd9 100644 --- a/source/_components/openevse.markdown +++ b/source/_components/openevse.markdown @@ -18,7 +18,7 @@ redirect_from: This `openevse` sensor platform pulls data from an [OpenEVSE](https://www.openevse.com/) Charging station equipped with an ESP8266-based wifi connection. -## {% linkable_title Configuration %} +## Configuration To enable this sensor in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/opengarage.markdown b/source/_components/opengarage.markdown index b2c93df3c1e..fc433c1d2e0 100644 --- a/source/_components/opengarage.markdown +++ b/source/_components/opengarage.markdown @@ -17,7 +17,7 @@ redirect_from: The `opengarage` cover platform lets you control the open-source [OpenGarage.io](https://opengarage.io/) device through Home Assistant. -## {% linkable_title Configuration %} +## Configuration To enable OpenGarage Covers in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/openhardwaremonitor.markdown b/source/_components/openhardwaremonitor.markdown index eff34caca5a..6abc3fafc86 100644 --- a/source/_components/openhardwaremonitor.markdown +++ b/source/_components/openhardwaremonitor.markdown @@ -18,7 +18,7 @@ redirect_from: The `openhardwaremonitor` platform uses your [Open Hardware Monitor](http://openhardwaremonitor.org/) installation as a source for sensors that will display system information. -## {% linkable_title Setup %} +## Setup OpenHardwareMonitor must be running on the host, with "Remote web server" active. You also need to open inbound port (TCP 8085) on the host.. @@ -40,7 +40,7 @@ sudo firewall-cmd --permanent --add-port=8085/tcp sudo firewall-cmd --reload ``` -## {% linkable_title Configuration %} +## Configuration To add Open Hardware Monitor to your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/opensensemap.markdown b/source/_components/opensensemap.markdown index de1687f07da..ff26c8b9d3f 100644 --- a/source/_components/opensensemap.markdown +++ b/source/_components/opensensemap.markdown @@ -19,11 +19,11 @@ redirect_from: The `opensensemap` air quality platform will query the open data API of [openSenseMap.org](https://opensensemap.org/) to monitor air quality sensor station. -## {% linkable_title Setup %} +## Setup To get the ID of a station you need to select it on the [openSense map](https://opensensemap.org/) and find it in the addressbar of your browser. It's the last part of the URL, e.g., `5b450e565dc1ec001bf7cd1d` [https://opensensemap.org/explore/5b450e565dc1ec001bf7cd1d](https://opensensemap.org/explore/5b450e565dc1ec001bf7cd1d). -## {% linkable_title Manual Configuration %} +## Manual Configuration To enable this platform, add the following lines to your `configuration.yaml` file: diff --git a/source/_components/opensky.markdown b/source/_components/opensky.markdown index 50643203c77..13613a87df4 100644 --- a/source/_components/opensky.markdown +++ b/source/_components/opensky.markdown @@ -18,7 +18,7 @@ redirect_from: The `opensky` sensor allows one to track overhead flights in a given region. It uses crowd-sourced data from the [OpenSky Network](https://opensky-network.org/) public API. It will also fire Home Assistant events when flights enter and exit the defined region. -## {% linkable_title Configuration %} +## Configuration To enable this sensor, add the following lines to your `configuration.yaml` file: @@ -36,7 +36,7 @@ Configuration options for the OpenSky Network sensor: - **altitude** (*Optional*): The maximum altitude (in meters) for planes to be detected in, 0 sets it to unlimited. Defaults to 0). - **name** (*Optional*): Sensor name. Defaults to opensky. -## {% linkable_title Events %} +## Events - **opensky_entry**: Fired when a flight enters the region. - **opensky_exit**: Fired when a flight exits the region. diff --git a/source/_components/opentherm_gw.markdown b/source/_components/opentherm_gw.markdown index c478bca543d..0320bdddc63 100644 --- a/source/_components/opentherm_gw.markdown +++ b/source/_components/opentherm_gw.markdown @@ -35,7 +35,7 @@ When enabled, this integration will automatically add its [`climate` entity](/co The OpenTherm protocol is based on polling. The thermostat sends requests to the boiler at specific intervals. As a result, it may take some time for changes to propagate between Home Assistant and the thermostat.

-# {% linkable_title Configuration %} +# Configuration ```yaml # Example configuration.yaml entry @@ -271,19 +271,19 @@ monitored_variables: description: Solar storage unit temperature. {% endconfiguration %} -## {% linkable_title Supported Variables %} +## Supported Variables The list above contains all supported variables. Note that not all boilers and thermostats properly support all variables, so the fact that a variable is listed here and published by your system does not necessarily mean that you will get useful data out of it. To see which variables are published in your situation, enable debug logging for the `opentherm_gw` integration and look for the status updates. -# {% linkable_title Services %} +# Services -### {% linkable_title Service `opentherm_gw.reset_gateway` %} +### Service `opentherm_gw.reset_gateway` Reset the OpenTherm Gateway. This service takes no parameters. -### {% linkable_title Service `opentherm_gw.set_clock` %} +### Service `opentherm_gw.set_clock` Provide the time and day of week to the OpenTherm Gateway. The value provided here will be forwarded to the thermostat on the next date/time request from the thermostat. The OpenTherm Gateway does not have the ability to accurately keep track of time, so it will only retain the information provided here for a maximum of about 61 seconds. @@ -292,7 +292,7 @@ Provide the time and day of week to the OpenTherm Gateway. The value provided he | `date` | yes | Today's date | Date from which the day of week will be extracted. Format: `YYYY-MM-DD`. | `time` | yes | Current time | Time in 24h format. -### {% linkable_title Service `opentherm_gw.set_control_setpoint` %} +### Service `opentherm_gw.set_control_setpoint`

Improper use of this service may continuously keep your central heating system active, resulting in an overheated house and a significant increase in gas and/or electricity consumption. @@ -310,7 +310,7 @@ In a normal situation, the thermostat will calculate and control the central hea Please read [this information](http://otgw.tclcode.com/standalone.html) from the designer of the OpenTherm Gateway before considering to write your own software thermostat.

-### {% linkable_title Service `opentherm_gw.set_gpio_mode` %} +### Service `opentherm_gw.set_gpio_mode` Configure the GPIO behavior on the OpenTherm Gateway. For an explanation of the possible modes, see [GPIO modes](#gpio-modes) @@ -320,7 +320,7 @@ For an explanation of the possible modes, see [GPIO modes](#gpio-modes) | `id` | no | The GPIO ID, `A` or `B`. | `mode` | no | The GPIO mode to be set. -### {% linkable_title Service `opentherm_gw.set_led_mode` %} +### Service `opentherm_gw.set_led_mode` Configure the function of the LEDs on the OpenTherm Gateway. For a list of possible modes with explanation, see [LED modes](#led-modes) @@ -330,7 +330,7 @@ For a list of possible modes with explanation, see [LED modes](#led-modes) | `id` | no | The LED ID, accepted values are `A` through `F`. | `mode` | no | The LED mode to be set. -### {% linkable_title Service `opentherm_gw.set_max_modulation` %} +### Service `opentherm_gw.set_max_modulation`

Improper use of this service may impair the performance of your central heating system. @@ -348,7 +348,7 @@ In a normal situation, the thermostat will control the maximum modulation level Please read [this information](http://otgw.tclcode.com/standalone.html) from the designer of the OpenTherm Gateway before considering to write your own software thermostat.

-### {% linkable_title Service `opentherm_gw.set_outside_temperature` %} +### Service `opentherm_gw.set_outside_temperature` Provide the outside temperature to the thermostat. If your thermostat is unable to display an outside temperature and does not support OTC (Outside Temperature Correction), this has no effect. Note that not all thermostats are able to display the full supported range. @@ -357,7 +357,7 @@ If your thermostat is unable to display an outside temperature and does not supp | ---------------------- | -------- | ----------- | | `temperature` | no | The outside temperature to provide to the thermostat. Accepted values are `-40.0` through `64.0`. Any value above `64.0` will clear a previously configured value (suggestion: `99`). -### {% linkable_title Service `opentherm_gw.set_setback_temperature` %} +### Service `opentherm_gw.set_setback_temperature` Configure the setback temperature on the OpenTherm Gateway. The value you provide here will be used with the GPIO `home` (5) and `away` (6) modes. @@ -366,7 +366,7 @@ The value you provide here will be used with the GPIO `home` (5) and `away` (6) | ---------------------- | -------- | ----------- | | `temperature` | no | The setback temperature. Accepted values are `0.0` through `30.0`. -## {% linkable_title GPIO modes %} +## GPIO modes Possible modes and their meaning for the GPIO pins are listed here: {% comment %} @@ -382,7 +382,7 @@ Possible modes and their meaning for the GPIO pins are listed here: * 7\. Away - Set thermostat to setback temperature when pulled high. * 8\. DS1820 (GPIO port B only) - Data line for a DS18S20 or DS18B20 temperature sensor used to measure the outside temperature. A 4k7 resistor should be connected between GPIO port B and Vcc. -## {% linkable_title LED modes %} +## LED modes Possible LED modes and their meaning are listed here: @@ -403,7 +403,7 @@ Possible LED modes and their meaning are listed here: The OpenTherm protocol is based on polling. The thermostat sends requests to the boiler at specific intervals. As a result, it may take some time for changes to propagate between Home Assistant and the thermostat.

-# {% linkable_title Example %} +# Example A full configuration example with the OpenTherm Gateway connected to a remote host running `ser2net` looks like the one below. diff --git a/source/_components/openuv.markdown b/source/_components/openuv.markdown index 472c1d06525..7c83aa13f27 100644 --- a/source/_components/openuv.markdown +++ b/source/_components/openuv.markdown @@ -22,7 +22,7 @@ redirect_from: The `openuv` integration displays UV and Ozone data from [openuv.io](http://openuv.io). -## {% linkable_title Generating an API Key %} +## Generating an API Key To generate an API key, [simply log in to the OpenUV website](https://www.openuv.io/auth/google). @@ -52,7 +52,7 @@ Ensure that you understand these specifications when calling the `update_data` service.

-## {% linkable_title Configuration %} +## Configuration To retrieve data from OpenUV, add the following to your `configuration.yaml` file: @@ -117,7 +117,7 @@ The approximate number of minutes of a particular skin type can be exposed to the sun before burning/tanning starts is based on the [Fitzpatrick scale](https://en.wikipedia.org/wiki/Fitzpatrick_scale). -## {% linkable_title Full Configuration Example %} +## Full Configuration Example To configure additional functionality, add configuration options beneath a `binary_sensor` and/or `sensor` key within the `openuv` section of the @@ -149,13 +149,13 @@ decision making. They should not replace analysis, advice or diagnosis from a trained medical professional.

-## {% linkable_title Services %} +## Services -### {% linkable_title `openuv.update_data` %} +### `openuv.update_data` Perform an on-demand update of OpenUV data. -## {% linkable_title Examples of Updating Data %} +## Examples of Updating Data One method to retrieve data every 30 minutes and still leave plenty of API key usage is to only retrieve data during the daytime: diff --git a/source/_components/openweathermap.markdown b/source/_components/openweathermap.markdown index dbbd87b16ee..4581bfe0c78 100644 --- a/source/_components/openweathermap.markdown +++ b/source/_components/openweathermap.markdown @@ -27,7 +27,7 @@ There is currently support for the following device types within Home Assistant: You need an API key which is free but requires a [registration](http://home.openweathermap.org/users/sign_up). -## {% linkable_title Weather %} +## Weather To add OpenWeatherMap to your installation, add the following to your `configuration.yaml` file: @@ -69,7 +69,7 @@ longitude: This platform is an alternative to the [`openweathermap`](/components/sensor.openweathermap/) sensor.

-## {% linkable_title Sensor %} +## Sensor The `openweathermap` platform uses [OpenWeatherMap](http://openweathermap.org/) as a source for current meteorological data for your location. The `forecast` will show you the condition in 3h. diff --git a/source/_components/openwrt.markdown b/source/_components/openwrt.markdown index 4ac10e29a27..81df537190d 100644 --- a/source/_components/openwrt.markdown +++ b/source/_components/openwrt.markdown @@ -38,7 +38,7 @@ There are _multiple_ ways of integrating an OpenWRT router for presence detectio * [openwrt_hass_devicetracker](https://github.com/mueslo/openwrt_hass_devicetracker) * your own custom script -### {% linkable_title Event-based device tracker %} +### Event-based device tracker This can be achieved by running a simple shell script on the OpenWRT router which calls the appropriate Home Assistant service. An OpenWRT package which does this is listed above. As this method directly calls the [service API](/developers/rest_api.markdown#post-apiservicesltdomainltservice), no special configuration is necessary on the Home Assistant side, except for ensuring the device_tracker API is running, which is achieved by adding the following to your `configuration.yaml` file: diff --git a/source/_components/orangepi_gpio.markdown b/source/_components/orangepi_gpio.markdown index 168e16ff756..8a3c0c0684b 100644 --- a/source/_components/orangepi_gpio.markdown +++ b/source/_components/orangepi_gpio.markdown @@ -16,11 +16,11 @@ ha_iot_class: Local Push The `orangepi_gpio` integration is the base for all related GPIO platforms in Home Assistant. There is no setup needed for the integration itself, for the platforms please check their corresponding pages. -## {% linkable_title Binary Sensor %} +## Binary Sensor The `orangepi_gpio` binary sensor platform allows you to read sensor values of the GPIOs of your Orange Pi or NanoPi. -## {% linkable_title Configuration %} +## Configuration To use your Orange Pi's GPIO in your installation, add the following to your `configuration.yaml` file: @@ -57,7 +57,7 @@ invert_logic: Compared to the [Raspberry Pi GPIO](/components/rpi_gpio/) component, this integration does not support pull-up resistors or port debouncing. Use external pull-ups and external port-debouncing. -## {% linkable_title Pin_mode %} +## Pin_mode As this platform supports different types of GPIO pinouts for difference Orange Pi or Nano Pi devices, we use the `pin_mode` value to specify which one to use. Enabled values are: @@ -69,7 +69,7 @@ As this platform supports different types of GPIO pinouts for difference Orange | `duo` | Supports the NanoPi Duo | | `neocore2` | Supports the NanoPi Neocore 2 | -## {% linkable_title Additional steps %} +## Additional steps This integration uses the `SYSFS` filesystem to get control of the GPIOs. Therefore an operatings system with `CONFIG_GPIO_SYSFS` is required. As far as I know, most out-of-the-box distributions still enable this by default. As of Linux 4.8 sysfs-gpio is marked as obsolete. However as of today, the alternative GPIO character device is not widely used. Therefore we will use this until the new character device is more widely supported. diff --git a/source/_components/otp.markdown b/source/_components/otp.markdown index 204925a2a2b..41e4a27980d 100644 --- a/source/_components/otp.markdown +++ b/source/_components/otp.markdown @@ -19,7 +19,7 @@ redirect_from: The `otp` sensor generates One-Time Passwords according to [RFC6238](https://tools.ietf.org/html/rfc6238) that is compatible with most OTP generators available, including Google Authenticator. You can use this when building custom security solutions and want to use "rolling codes", that change every 30 seconds. -## {% linkable_title Configuration %} +## Configuration To enable the OTP sensor, add the following lines to your `configuration.yaml`: diff --git a/source/_components/owlet.markdown b/source/_components/owlet.markdown index 94ae8376a92..e822dfcfc85 100644 --- a/source/_components/owlet.markdown +++ b/source/_components/owlet.markdown @@ -22,17 +22,17 @@ Configuring this integration will enable tracking of heart rate, oxygen level, m This integration enables the following platforms automatically: -#### {% linkable_title Binary Sensors %} +#### Binary Sensors - Base Station Status - Motion -#### {% linkable_title Sensors %} +#### Sensors - Heart rate - Oxygen level -### {% linkable_title Configuration %} +### Configuration ```yaml # Example configuration.yaml entry diff --git a/source/_components/owntracks.markdown b/source/_components/owntracks.markdown index fafb7ab9573..244e72fea58 100644 --- a/source/_components/owntracks.markdown +++ b/source/_components/owntracks.markdown @@ -24,11 +24,11 @@ By default the integration will listen for incoming messages from OwnTracks via -## {% linkable_title Configuration %} +## Configuration To configure OwnTracks, you must set it up via the integrations panel in the configuration screen. This will give you the webhook URL to use during mobile device configuration (below). -### {% linkable_title Configuring the app - Android %} +### Configuring the app - Android [Install the OwnTracks application for Android.](https://play.google.com/store/apps/details?id=org.owntracks.android) @@ -44,7 +44,7 @@ In the OwnTracks app, open sidebar and click on preferences, then on connection. Your tracker device will be known in home assistant as `_`. If you entered a Tracker ID the tid attribute will be set to that ID. -### {% linkable_title Configuring the app - iOS %} +### Configuring the app - iOS [Install the OwnTracks application for iOS.](https://itunes.apple.com/us/app/owntracks/id692424691?mt=8) @@ -55,7 +55,7 @@ In the OwnTracks app, tap the (i) in the top left and click on settings. Change - Turn on authentication - User ID: `` -## {% linkable_title Advanced configuration %} +## Advanced configuration OwnTracks allows the user to set advanced configuration by adding a section to your `configuration.yaml`. @@ -115,7 +115,7 @@ owntracks: office: work ``` -## {% linkable_title Using Owntracks regions %} +## Using Owntracks regions Owntracks can track regions, and send region entry and exit information to Home Assistant. You set up a region in the Owntracks app which you should name the same as your Home Assistant Zone, and then make sure to turn on the `share` option for the region in the owntracks app. Please see the [owntracks documentation](http://owntracks.org/booklet/guide/waypoints/). @@ -123,7 +123,7 @@ Home Assistant will use the enter and leave messages to set your zone location. When you exit a zone, Home Assistant will start using location updates to track you again. To make sure that Home Assistant correctly exits a zone (which it calculates based on your GPS coordinates), you may want to set your Zone radius in HA to be slightly smaller that the Owntracks region radius. -## {% linkable_title Using Owntracks regions - forcing Owntracks to update using iBeacons %} +## Using Owntracks regions - forcing Owntracks to update using iBeacons

Owntracks v2.0.0 removes support for iBeacons on Android. @@ -139,7 +139,7 @@ When you exit an iBeacon region HA will switch back to using GPS to determine yo Sometimes Owntracks will lose connection with an iBeacon for a few seconds. If you name your beacon starting with `-` Owntracks will wait longer before deciding it has exited the beacon zone. HA will ignore the `-` when it matches the Owntracks region with Zones. So if you call your Owntracks region `-home` then HA will recognize it as `home`, but you will have a more stable iBeacon connection. -## {% linkable_title Using Owntracks iBeacons to track devices %} +## Using Owntracks iBeacons to track devices iBeacons don't need to be stationary. You could put one on your key ring, or in your car. @@ -149,11 +149,11 @@ To use mobile iBeacons with HA, you just set up a region that doesn't match your This allows you to write zone automations for devices that can't track themselves (for example *alert me if I leave the house and my keys are still at home*). Another example would be *open the gates if my car arrives home*. -## {% linkable_title Using mobile and fixed iBeacons together %} +## Using mobile and fixed iBeacons together You can use iBeacons of both types together, so if you have a Zone `drive` with an iBeacon region called `-drive` and you arrive home with a mobile iBeacon called `-car`, then `device_tracker.beacon_car` will be set to a state of `drive`. -## {% linkable_title Importing Owntracks waypoints as zones %} +## Importing Owntracks waypoints as zones By default, any Owntracks user connected to Home Assistant can export their waypoint definitions (from the *Export - Export to Endpoint* menu item) which will then be translated to zone definitions in Home Assistant. The zones will be named `- - `. This functionality can be controlled in 2 ways: diff --git a/source/_components/panasonic_bluray.markdown b/source/_components/panasonic_bluray.markdown index 16d043a9518..9120ea72a6a 100644 --- a/source/_components/panasonic_bluray.markdown +++ b/source/_components/panasonic_bluray.markdown @@ -49,6 +49,6 @@ name: type: string {% endconfiguration %} -### {% linkable_title Supported operations %} +### Supported operations - These devices support play, pause, stop and power on/off operations. They will also report the current status, title duration and current playing position. diff --git a/source/_components/panasonic_viera.markdown b/source/_components/panasonic_viera.markdown index 359356075ea..c6a8761dba1 100644 --- a/source/_components/panasonic_viera.markdown +++ b/source/_components/panasonic_viera.markdown @@ -74,7 +74,7 @@ name: type: string {% endconfiguration %} -### {% linkable_title Example `play_media` script %} +### Example `play_media` script The `play_media` function can be used to open web pages and other media types (images, movies) in the TV web browser. diff --git a/source/_components/pandora.markdown b/source/_components/pandora.markdown index 7d8849a67b2..fbb8664e261 100644 --- a/source/_components/pandora.markdown +++ b/source/_components/pandora.markdown @@ -19,7 +19,7 @@ redirect_from: If you have a Pandora account, you can control it from Home Assistant with this media player. -### {% linkable_title Installation of Pianobar %} +### Installation of Pianobar This media player uses the [Pianobar command-line Pandora client](https://github.com/PromyLOPh/pianobar), which you have to install separately. This can be done on a Raspberry Pi 2/3 with Raspbian Jessie as follows . _(Note: Other platforms may have different installation processes)_ @@ -53,7 +53,7 @@ user = you@youraccount.com Test it out by running `pianobar` in the command line. You should be able to listen to your Pandora stations. -### {% linkable_title Configuration in Home Assistant %} +### Configuration in Home Assistant The Pandora player can be loaded by adding the following lines to your `configuration.yaml`: diff --git a/source/_components/pencom.markdown b/source/_components/pencom.markdown index fb1cb2da507..300fef6149b 100644 --- a/source/_components/pencom.markdown +++ b/source/_components/pencom.markdown @@ -18,7 +18,7 @@ redirect_from: [Pencom Design](http://www.pencomdesign.com/) is a manufacturer of computer-controlled relay, I/O and custom boards for commercial and industrial applications. This interface to [Pencom's Relay Control Boards](https://www.pencomdesign.com/relay-boards/) is designed to work over an ethernet to serial adapter (NPort). Each switch (relay) can be turned on/off, and the state of the relay can be read. -## {% linkable_title Configuration %} +## Configuration The Pencom relays can be daisy-chained to allow for up to 8 boards. diff --git a/source/_components/persistent_notification.markdown b/source/_components/persistent_notification.markdown index e13a48dbe6a..4138fef8711 100644 --- a/source/_components/persistent_notification.markdown +++ b/source/_components/persistent_notification.markdown @@ -20,7 +20,7 @@ The `persistent_notification` can be used to show a message on the frontend that

-### {% linkable_title Service %} +### Service The service `persistent_notification/create` takes in `message`, `title`, and `notification_id`. @@ -81,7 +81,7 @@ This automation example shows a notification when the Z-Wave network is starting notification_id: zwave ``` -### {% linkable_title Markdown support %} +### Markdown support The message attribute supports the [Markdown formatting syntax](https://daringfireball.net/projects/markdown/syntax). Some examples are: @@ -100,7 +100,7 @@ The message attribute supports the [Markdown formatting syntax](https://daringfi

-### {% linkable_title Create a persistent notification %} +### Create a persistent notification Choose service developer tool icon **Services** from the **Developer Tools** to call the `persistent_notification` service. Select `persistent_notification/create` from the list of **Available services:** and enter something like the sample below into the **Service Data** field and hit **CALL SERVICE**. diff --git a/source/_components/person.markdown b/source/_components/person.markdown index 6b0ca02a1f8..0d240eb7351 100644 --- a/source/_components/person.markdown +++ b/source/_components/person.markdown @@ -36,7 +36,7 @@ TL;DR: When you're at home, your position is determined first by stationary trac You can manage persons via the UI from the person page inside the configuration panel or via `YAML` in your `configuration.yaml` file. -## {% linkable_title Configuring the `person` integration via the Home Assistant configuration panel %} +## Configuring the `person` integration via the Home Assistant configuration panel If you prefer to use the configuration panel to configure the `person` integration simply add one line to your `configuration.yaml` file and restart Home Assistant. @@ -44,7 +44,7 @@ If you prefer to use the configuration panel to configure the `person` integrati person: ``` -## {% linkable_title Configuring the `person` integration via YAML %} +## Configuring the `person` integration via YAML If you prefer YAML, you can also configure your persons via `configuration.yaml`: diff --git a/source/_components/pi_hole.markdown b/source/_components/pi_hole.markdown index 82d8aa32231..9fc4c447797 100644 --- a/source/_components/pi_hole.markdown +++ b/source/_components/pi_hole.markdown @@ -18,7 +18,7 @@ redirect_from: The `pi_hole` sensor platform displays the statistical summary of a [Pi-hole](https://pi-hole.net/) system. -## {% linkable_title Configuration %} +## Configuration To enable this sensor, add the following lines to your `configuration.yaml` file for a GET request: @@ -75,7 +75,7 @@ monitored_conditions: description: Total number of seen clients. {% endconfiguration %} -### {% linkable_title Full example %} +### Full example ```yaml # Example configuration.yaml entry diff --git a/source/_components/picotts.markdown b/source/_components/picotts.markdown index 2dee48aaa6d..72bd863e746 100644 --- a/source/_components/picotts.markdown +++ b/source/_components/picotts.markdown @@ -19,7 +19,7 @@ The `picotts` text-to-speech platform uses offline pico Text-to-Speech engine to This requires to install the pico tts library on the system, typically on debian just do `sudo apt-get install libttspico-utils` On some Raspbian release, this package is missing but you can just copy the arm deb package from debian. -## {% linkable_title Configuration %} +## Configuration To enable text-to-speech with Pico, add the following lines to your `configuration.yaml`: @@ -37,7 +37,7 @@ language: default: "`en-US`" {% endconfiguration %} -## {% linkable_title Full configuration example %} +## Full configuration example The configuration sample below shows how an entry can look like: diff --git a/source/_components/piglow.markdown b/source/_components/piglow.markdown index e9dfb6c52fe..2f239c948a5 100644 --- a/source/_components/piglow.markdown +++ b/source/_components/piglow.markdown @@ -19,7 +19,7 @@ redirect_from: The `piglow` platform lets you control the [Piglow](https://shop.pimoroni.com/products/piglow) lights on your Raspberry Pi from within Home Assistant. -## {% linkable_title Configuration %} +## Configuration To add piglow to your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/pilight.markdown b/source/_components/pilight.markdown index 4e1df44ff2f..f8b9ba414b4 100644 --- a/source/_components/pilight.markdown +++ b/source/_components/pilight.markdown @@ -33,7 +33,7 @@ There is currently support for the following device types within Home Assistant: - [Sensor](#sensor) - [Switch](#switch) -## {% linkable_title Configuration %} +## Configuration To integrate pilight into Home Assistant, add the following section to your `configuration.yaml` file: @@ -82,7 +82,7 @@ pilight: - 42 ``` -## {% linkable_title Binary Sensor %} +## Binary Sensor The `pilight` binary sensor platform implement the [pilight hub](#configuration) binary sensor functionality. Two type of Pilight binary sensor configuration available. A normal sensor which send the on and off state cyclical and a trigger sensor which send only a trigger when an event happened (for example lots of cheap PIR motion detector). @@ -131,7 +131,7 @@ reset_delay_sec: default: 30 {% endconfiguration %} -### {% linkable_title Full example %} +### Full example A full configuration example could look like this: @@ -148,7 +148,7 @@ binary_sensor: reset_delay_sec: 30 ``` -## {% linkable_title Sensor %} +## Sensor This `pilight` sensor platform for 433 MHz devices uses a value in the message payload as the sensor value. Unique identifiers (e.g., _uuid_) can be set to distinguish between multiple pilight devices. To use a pilight sensor the pilight Home Assistant hub has to be set up. @@ -183,7 +183,7 @@ unit_of_measurement: type: string {% endconfiguration %} -### {% linkable_title Example: Weather station %} +### Example: Weather station This section shows a real life example how to use values of a weather station. @@ -210,7 +210,7 @@ sensor: unit_of_measurement: '%' ``` -## {% linkable_title Switch %} +## Switch The `pilight` switch platform is issuing 433 MHz commands using [pilight](https://www.pilight.org/) to turn a 433 MHz device on or off. The Pilight Home Assistant hub has to be set up. @@ -282,7 +282,7 @@ Variables for the different receive codes (`on_code_receive` and `off_code_recei This is useful if you have paired your sender directly with the receiver to prevent sending the signal twice. -### {% linkable_title Examples %} +### Examples ```yaml switch: @@ -313,7 +313,7 @@ switch: state: 'off' ``` -## {% linkable_title Troubleshooting %} +## Troubleshooting - A list of tested RF transceiver hardware is available [here](https://manual.pilight.org/electronics/index.html). This might be useful before buying. - Sending commands is simple when the protocol is known by pilight, but receiving commands can be rather difficult. It can happen that the code is not correctly recognized due to different timings in the sending hardware or the RF receiver. If this happens follow these steps: diff --git a/source/_components/ping.markdown b/source/_components/ping.markdown index b74dbe40d37..9d843846aa3 100644 --- a/source/_components/ping.markdown +++ b/source/_components/ping.markdown @@ -24,7 +24,7 @@ There is currently support for the following device types within Home Assistant: - [Binary Sensor](#binary-sensor) - [Presence Detection](#presence-detection) -## {% linkable_title Binary Sensor %} +## Binary Sensor The `ping` binary sensor platform allows you to use `ping` to send ICMP echo requests. This way you can check if a given host is online and determine the round trip times from your Home Assistant instance to that system. @@ -76,7 +76,7 @@ binary_sensor: When run on Windows systems, the round trip time attributes are rounded to the nearest millisecond and the mdev value is unavailable.

-## {% linkable_title Presence Detection %} +## Presence Detection The `ping` device tracker platform offers presence detection by using `ping` to send ICMP echo requests. This can be useful when devices are running a firewall and are blocking UDP or TCP packets but responding to ICMP requests (like Android phones). This tracker doesn't need to know the MAC address since the host can be on a different subnet. This makes this an option to detect hosts on a different subnet when `nmap` or other solutions don't work since `arp` doesn't work. @@ -84,7 +84,7 @@ The `ping` device tracker platform offers presence detection by using `ping` to Please keep in mind that modern smart phones will usually turn off WiFi when they are idle. Simple trackers like this may not be reliable on their own.

-### {% linkable_title Configuration %} +### Configuration To use this presence detection in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/pjlink.markdown b/source/_components/pjlink.markdown index 7e434f164b4..f597e9c2b30 100644 --- a/source/_components/pjlink.markdown +++ b/source/_components/pjlink.markdown @@ -18,7 +18,7 @@ redirect_from: The `pjlink` platform allows you to control from Home Assistant, projectors with support for the [PJLink protocol](http://pjlink.jbmia.or.jp/english/index.html). -## {% linkable_title Configuration %} +## Configuration To add a PJLink projector to your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/plaato.markdown b/source/_components/plaato.markdown index 7fab3e8bd76..e2a310a85f6 100644 --- a/source/_components/plaato.markdown +++ b/source/_components/plaato.markdown @@ -18,7 +18,7 @@ This integration sets up integration with [Plaato Airlock](https://www.plaato.io Plaato Airlock is a tool for beer brewers that wants a unique insight into the fermentation process. With this integration, you get all your fermentation data available in Home Assistant! -## {% linkable_title Configuration %} +## Configuration To configure Plaato Airlock, you must set it up via the integrations panel in the Home Assistant frontend. diff --git a/source/_components/plant.markdown b/source/_components/plant.markdown index 488aa2be4a5..c694c3b8c8f 100644 --- a/source/_components/plant.markdown +++ b/source/_components/plant.markdown @@ -16,7 +16,7 @@ ha_qa_scale: internal This`plant`component lets you merge moisture, conductivity, light intensity, temperature and battery level for a plant into a single UI element. It also supports setting minimum and maximum values for each measurement and will change its state to "problem" if it is not within those limits. -## {% linkable_title Configuration %} +## Configuration To use your `plant` sensor in your installation, add the following to your `configuration.yaml` file: @@ -112,7 +112,7 @@ entity_id: type: integer {% endconfiguration %} -## {% linkable_title Examples %} +## Examples ### Using plain MQTT sensor to get the data This is a practical example that uses a multiple of `MQTT sensors` to supply the readings used by the `plant` sensor. Another good source of this data would be the [Mi Flora](/components/sensor.miflora/) component. diff --git a/source/_components/plex.markdown b/source/_components/plex.markdown index 2533f91807b..0e551978e04 100644 --- a/source/_components/plex.markdown +++ b/source/_components/plex.markdown @@ -27,7 +27,7 @@ There is currently support for the following device types within Home Assistant: - [Media Player](#setup---media-player) - [Sensor](#sensor) -## {% linkable_title Setup - Media Player %} +## Setup - Media Player The preferred way to setup the Plex platform is by enabling the [discovery component](/components/discovery/) which requires GDM enabled on your Plex server. This can be found on your Plex Web App under Settings > (server Name) > settings > Network and choose "Enable local network discovery (GDM)". @@ -85,7 +85,7 @@ verify: type: boolean {% endconfiguration %} -### {% linkable_title Customization %} +### Customization You can customize the Plex integration by adding any of the variables below to your configuration: @@ -122,7 +122,7 @@ client_remove_interval: type: integer {% endconfiguration %} -### {% linkable_title Service `play_media` %} +### Service `play_media` Plays a song, playlist, TV episode, or video on a connected client. @@ -171,7 +171,7 @@ Plays a song, playlist, TV episode, or video on a connected client. | Plex Web | None | | Tivo Plex App | Only play, pause, stop/off controls enabled | -### {% linkable_title Notes %} +### Notes * At this moment, the Plex platform only supports one Plex Media Server. * It is possible to get errors that look like the following. @@ -184,7 +184,7 @@ Plays a song, playlist, TV episode, or video on a connected client. If this occurs, check the setting `Server`>`Network`>`Secure connections` on your Plex Media Server: if it is set to `Preferred` or `Required`, you may need to manually set the `ssl` and `verify` booleans in the `plex.conf` file to, respectively, `true` and `false`. See the **"Setup"** section above for details. * Movies must be located under 'Movies' section in the Plex library to properly get 'playing' state. -## {% linkable_title Sensor %} +## Sensor The `plex` sensor platform will monitor activity on a given [Plex Media Server](https://plex.tv/). It will create a sensor that shows the number of currently watching users as the state. If you click the sensor for more details it will show you who is watching what. diff --git a/source/_components/plum_lightpad.markdown b/source/_components/plum_lightpad.markdown index 59b3314b18d..f8c501c1abb 100644 --- a/source/_components/plum_lightpad.markdown +++ b/source/_components/plum_lightpad.markdown @@ -26,7 +26,7 @@ Configurable/Dimmable WiFi Lightswitch - Wifi & Bluetooth connectivity - Phone Apps for iOS & Android -## {% linkable_title Configuration %} +## Configuration To enable Plum Lightpad support, add the following lines to your `configuration.yaml` file: diff --git a/source/_components/pocketcasts.markdown b/source/_components/pocketcasts.markdown index b39cae4a855..64ad0a07c3a 100644 --- a/source/_components/pocketcasts.markdown +++ b/source/_components/pocketcasts.markdown @@ -18,7 +18,7 @@ redirect_from: The `pocketcasts` sensor platform lets one monitor the podcasts at [Pocket Casts](https://play.pocketcasts.com/). -## {% linkable_title Configuration %} +## Configuration To enable this sensor, add the following lines to your `configuration.yaml`: diff --git a/source/_components/point.markdown b/source/_components/point.markdown index 1b277812703..9882b0b518f 100644 --- a/source/_components/point.markdown +++ b/source/_components/point.markdown @@ -32,7 +32,7 @@ There is currently support for the following device types within Home Assistant: - [Binary Sensor](#binary-sensor) - [Sensor](#sensor) -### {% linkable_title Configuration %} +### Configuration ```yaml # Example configuration.yaml entry @@ -52,7 +52,7 @@ client_secret: type: string {% endconfiguration %} -# {% linkable_title Device types %} +# Device types The integration supports the following device types within Home Assistant: - [Alarm](#alarm) @@ -63,7 +63,7 @@ The integration supports the following device types within Home Assistant: The Point is just active occasionally so the [Sensors](#sensor) are only updated every hour or so. The [Binary Sensors](#binary-sensor) are however updated via [Cloud Push](https://www.home-assistant.io/blog/2016/02/12/classifying-the-internet-of-things/#cloud-pushing-new-state), making the changes close to instant.

-## {% linkable_title Alarm %} +## Alarm Each home configured in the Point mobile application will show up as a separate alarm control panel. The panels allow **arming** and **disarming** of the Point home alarm system. @@ -71,7 +71,7 @@ Each home configured in the Point mobile application will show up as a separate The Point only supports a Arm/Disarm action, so it is only `Arm Away` that is implememented.

-## {% linkable_title Binary Sensor %} +## Binary Sensor Each Point exposes the following binary sensors: @@ -90,7 +90,7 @@ Each Point exposes the following binary sensors: The binary sensors **button_press**, **sound** and **tamper** are switched `On` for a breif moment and are then switched back to `Off`.

-### {% linkable_title Automation example %} +### Automation example The following example show how to implement an automation for the **button_press** binary sensor. @@ -111,7 +111,7 @@ automation: ``` {% endraw %} -### {% linkable_title Webhook events %} +### Webhook events The events shown as [binary sensors](#binary-sensor) are sent to Home Assistant as webhooks with the `event_type` set to `point_webhook_received`. Below is an example of how to use such a webhook do note the `trigger.event.data.event.device_id` which translates to the id of the Point device that sent the event. @@ -135,7 +135,7 @@ automation: ``` {% endraw %} -## {% linkable_title Sensor %} +## Sensor Each Point exposes the following sensors: diff --git a/source/_components/polling.markdown b/source/_components/polling.markdown index 0108a7bf825..f4e4b23aa93 100644 --- a/source/_components/polling.markdown +++ b/source/_components/polling.markdown @@ -19,7 +19,7 @@ Telegram chatbot polling implementation. One of two bot implementations supported by Telegram. Your Home Assistant does not have to be exposed to the internet. -## {% linkable_title Configuration %} +## Configuration To integrate this into Home Assistant, add the following section to your `configuration.yaml` file: diff --git a/source/_components/postnl.markdown b/source/_components/postnl.markdown index e39a79ae390..0ff4c3c6ee8 100644 --- a/source/_components/postnl.markdown +++ b/source/_components/postnl.markdown @@ -20,7 +20,7 @@ The `postnl` platform allows one to track deliveries by [PostNL](https://www.pos The sensor value shows the number of packages to be delivered. The packages are available in the shipments attribute. -## {% linkable_title Configuration %} +## Configuration To enable this sensor, add the following lines to your `configuration.yaml`: diff --git a/source/_components/prezzibenzina.markdown b/source/_components/prezzibenzina.markdown index fa5affd3061..bde2995dbad 100644 --- a/source/_components/prezzibenzina.markdown +++ b/source/_components/prezzibenzina.markdown @@ -18,7 +18,7 @@ redirect_from: The `prezzibenzina` platform allows you to monitor the fuel prices with [PrezziBenzina.it](https://www.prezzibenzina.it/) from within Home Assistant and setup automations based on the information. -## {% linkable_title Setup %} +## Setup To use this sensor you need the station ID. To get this information go to [PrezziBenzina.it](https://www.prezzibenzina.it/) with your browser and find your station. Then copy the ID from the URL bar. @@ -26,7 +26,7 @@ To use this sensor you need the station ID. To get this information go to [Prezz https://www.prezzibenzina.it/distributori/STATION_ID/ ``` -## {% linkable_title Configuration %} +## Configuration To enable this sensor, add the following lines to your `configuration.yaml`: @@ -52,7 +52,7 @@ name: type: string {% endconfiguration %} -## {% linkable_title Full example %} +## Full example This is a full example of the sensor: diff --git a/source/_components/prowl.markdown b/source/_components/prowl.markdown index 59d427b5446..a3b86309372 100644 --- a/source/_components/prowl.markdown +++ b/source/_components/prowl.markdown @@ -41,7 +41,7 @@ api_key: type: string {% endconfiguration %} -### {% linkable_title Prowl service data %} +### Prowl service data The following attributes can be placed `data` for extended functionality. diff --git a/source/_components/proxy.markdown b/source/_components/proxy.markdown index 1b958e342bc..e2d46e7abff 100644 --- a/source/_components/proxy.markdown +++ b/source/_components/proxy.markdown @@ -20,7 +20,7 @@ The current post-processing supports resizing and/or cropping the image/MJPEG as The current proxy capabilities are intended to reduce the camera bandwidth for slower internet connections. -## {% linkable_title Configuration %} +## Configuration To enable this camera in your installation, you must first have an existing working camera configured in Home Assistant. Next, add the following to your `configuration.yaml` file: @@ -97,7 +97,7 @@ cache_images: type: boolean {% endconfiguration %} -## {% linkable_title Examples %} +## Examples Example of using two Camera proxies along with a Foscam camera: diff --git a/source/_components/ps4.markdown b/source/_components/ps4.markdown index 764a1aff2a6..62b9f110f40 100644 --- a/source/_components/ps4.markdown +++ b/source/_components/ps4.markdown @@ -19,12 +19,12 @@ The `ps4` integration allows you to control a - This integration supports controlling a single PlayStation 4 for your instance. Additional consoles may be supported in a future release. -## {% linkable_title Requirements %} +## Requirements - Android or iOS device - PS4 Second Screen App for [Android](https://play.google.com/store/apps/details?id=com.playstation.mobile2ndscreen&hl=en_US) or [iOS](https://itunes.apple.com/us/app/ps4-second-screen/id1201372796?mt=8) installed on device. -## {% linkable_title Set up %} +## Set up 1. Download the Second Screen App and make sure that you can find and control your PlayStation 4 normally. @@ -39,7 +39,7 @@ The `ps4` integration allows you to control a 4. Pair Home Assistant to your PlayStation 4 by filling in the fields. - **Note:** To find your correct region refer to the section [Regions](#regions) -## {% linkable_title Granting Port Access %} +## Granting Port Access The PlayStation 4 integration requires the use of privileged ports to work correctly, specifically UDP port 987 and TCP port 997. Depending on your OS of your Home Assistant instance you may need to allow usage of privileged ports manually. @@ -53,7 +53,7 @@ There are varying methods to perform this, dependent on your OS that is running If your Home Assistant device is running Hass.io on HassOS, it does not require additional configuration.

-### {% linkable_title Debian-based %} +### Debian-based Home Assistant installed on a Debian-type OS may require configuration. This section is applicable but not limited to the following operating systems: - Debian @@ -104,17 +104,17 @@ To find your system Python path: The output will be your system Python path. -### {% linkable_title Docker %} +### Docker When running Home Assistant using Docker, make sure that the Home Assistant container is discoverable by the PS4. This can be achieved by ensuring that the Home Assistant container uses the `host` network driver (by passing `--net=host` to the container when creating, or adding `network_mode: "host"` to your compose file when using `docker-compose`). -## {% linkable_title Configuration %} +## Configuration

The PlayStation 4 integration does not use entries from `configuration.yaml`. You must configure this integration by using `Integrations`

-## {% linkable_title Regions %} +## Regions Some titles will have different SKUs in the PlayStation Store database depending on your region. You must select your specific region in the setup in order to retrieve the cover art for such titles correctly. The integration will attempt to search other databases for the correct title if it cannot be found, although it will take longer to do so and may fetch an incorrect cover. @@ -135,9 +135,9 @@ Some titles will have different SKUs in the PlayStation Store database depending The regions which are unavailable have no database or have formatting in the database which can not be used by the component.

-## {% linkable_title Services %} +## Services -### {% linkable_title Service `send_command` %} +### Service `send_command` Emulate button press on PlayStation 4. This emulates the commands available for the PS4 Second Screen App. This is not to be confused with DualShock 4 controller buttons. @@ -146,7 +146,7 @@ Emulate button press on PlayStation 4. This emulates the commands available for | `entity_id` | No | `media_player.playstation_4` | The entity id for your PlayStation 4. | | `command` | No | `ps` | The command you want to send. | -#### {% linkable_title Available Commands %} +#### Available Commands Full list of supported commands. @@ -161,9 +161,9 @@ Full list of supported commands. | `left` | Swipe Left | | `right` | Swipe Right | -## {% linkable_title Troubleshooting %} +## Troubleshooting -### {% linkable_title Cover Art Issues %} +### Cover Art Issues If you are running a game/title on your PS4 that does not display a cover or displays the incorrect cover, post an issue [here](https://github.com/ktnrg45/pyps4-homeassistant/issues). Be sure to include the following information: diff --git a/source/_components/ptvsd.markdown b/source/_components/ptvsd.markdown index b80b5f693e7..6ec01abb881 100644 --- a/source/_components/ptvsd.markdown +++ b/source/_components/ptvsd.markdown @@ -44,7 +44,7 @@ wait: type: boolean {% endconfiguration %} -### {% linkable_title Security %} +### Security Ensure if this is a public-facing server, that the port is secured. Anyone who is able to access the debugger port can *execute arbitary code* on the home assistant server, which is very unsafe. @@ -52,11 +52,11 @@ If the home assistant server is behind your firewall with only the http(s) port Another way of securing the port is to set `host` to localhost and have a secured SSH TCP tunnel with a client certificate for access from the outside internet. -### {% linkable_title Memory Use %} +### Memory Use There have been reports of continually increasing memory use while the debugger is running, although this doesn't seem to appear on all systems. Only configure the debugger on a persistent server when it's actually required. -### {% linkable_title Waiting at startup %} +### Waiting at startup If you want to debug something in the boot-up sequence, configure the integration to wait for a connection first: @@ -68,7 +68,7 @@ ptvsd: The ptvsd debugger is loaded quite early on in the boot-up sequence, before any other components. This will allow you to set breakpoints in `async_setup` or similar and debug the loading of the component. -### {% linkable_title Alternate host and port %} +### Alternate host and port You can also listen on a different server address or port: @@ -81,7 +81,7 @@ ptvsd: This is useful for multi-homed servers, or for localhost only access -### {% linkable_title Example Visual Studio Code configuration %} +### Example Visual Studio Code configuration This can be copied into your `launch.json` in the `.vscode` subdirectory in your Visual Studio Code project to connect to the debugger. diff --git a/source/_components/push.markdown b/source/_components/push.markdown index fe5596fe4d6..d085c9c317d 100644 --- a/source/_components/push.markdown +++ b/source/_components/push.markdown @@ -22,7 +22,7 @@ Optionally the Push Camera can **buffer** a given number of images, creating an Images are cleared on new events, and events are separated by a soft (configurable) **timeout**. -## {% linkable_title Integration with motionEye %} +## Integration with motionEye The `push` camera can as an example be used with [motionEye](https://github.com/ccrisan/motioneye/wiki) a web frontend for the motion daemon. motionEye is usually configured to save/record files ***only*** when motion is detected. It provides a hook to run a command whenever an image is saved, which can be used together with cURL to send the motion detected images to the `push` camera, as shown in this example: @@ -45,7 +45,7 @@ camera: webhook_id: my_custom_webhook_id ``` -## {% linkable_title Configuration %} +## Configuration To enable this camera in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/pushbullet.markdown b/source/_components/pushbullet.markdown index 98f67c88305..5082a2a3178 100644 --- a/source/_components/pushbullet.markdown +++ b/source/_components/pushbullet.markdown @@ -27,17 +27,17 @@ There is currently support for the following device types within Home Assistant: The free tier is [limited](https://docs.pushbullet.com/#push-limit) to 500 pushes per month.

-### {% linkable_title Sensor %} +### Sensor The `pushbullet` sensor platform reads messages from [Pushbullet](https://www.pushbullet.com/), a free service to send information between your phones, browsers, and friends. This sensor platform provides sensors that show the properties of the latest received Pushbullet notification mirror. -### {% linkable_title Setup %} +### Setup Notification Mirroring allows users to see their Android device's notifications on their computer. It must be first enabled in the app and is currently only available on the Android platform. For more information, please see [this announcement](https://blog.pushbullet.com/2013/11/12/real-time-notification-mirroring-from-android-to-your-computer/) on the Pushbullet Blog. Go to [https://www.pushbullet.com/#settings/account](https://www.pushbullet.com/#settings/account) to retrieve your API key/access token. -### {% linkable_title Configuration %} +### Configuration To enable the Pushbullet sensor in your installation, add the following to your `configuration.yaml` file: @@ -85,7 +85,7 @@ monitored_conditions: All properties will be displayed as attributes. The properties array are just for logging the sensor readings for multiple properties. -## {% linkable_title Notifications %} +## Notifications The `pushbullet` notification platform sends messages to [Pushbullet](https://www.pushbullet.com/), a free service to send information between your phones, browsers, and friends. The free tier is [limited](https://docs.pushbullet.com/#push-limit) to 500 pushes per month. @@ -111,7 +111,7 @@ name: type: string {% endconfiguration %} -### {% linkable_title Usage %} +### Usage Pushbullet is a notify platform and thus can be controlled by calling the notify service [as described here](/components/notify/). It will send a notification to all devices registered in the Pushbullet account. An optional **target** parameter can be given to Pushbullet to specify specific account's devices, contacts or channels. @@ -123,7 +123,7 @@ Email | `email/` | Contact's email address | `email/email@example.com` If using targets, your own account's email address functions as 'send to all devices'. All targets are verified (if exists) before sending, except email. -#### {% linkable_title Example service payload %} +#### Example service payload ```json { @@ -138,7 +138,7 @@ If using targets, your own account's email address functions as 'send to all dev To use notifications, please see the [getting started with automation page](/getting-started/automation/). -### {% linkable_title URL support %} +### URL support ```yaml action: @@ -152,7 +152,7 @@ action: - **url** (*Required*): Page URL to send with Pushbullet. -### {% linkable_title File support %} +### File support ```yaml action: @@ -166,7 +166,7 @@ action: - **file** (*Required*): File to send with Pushbullet. -### {% linkable_title File URL support %} +### File URL support ```yaml action: @@ -180,7 +180,7 @@ action: - **file_url** (*Required*): File to send with Pushbullet. -### {% linkable_title Single target %} +### Single target ```yaml action: diff --git a/source/_components/pushover.markdown b/source/_components/pushover.markdown index a25e7a4f2b6..bd28231695d 100644 --- a/source/_components/pushover.markdown +++ b/source/_components/pushover.markdown @@ -17,7 +17,7 @@ redirect_from: The [Pushover service](https://pushover.net/) is a platform for the notify component. This allows integrations to send messages to the user using Pushover. -## {% linkable_title Configuration %} +## Configuration In order to get an API key you need to [register an application](https://pushover.net/apps/clone/home_assistant) on the Pushover website. Your Pushover user key can be found on the [Pushover dashboard](https://pushover.net/dashboard). diff --git a/source/_components/pushsafer.markdown b/source/_components/pushsafer.markdown index 426ebc631a7..84f3e4dc022 100644 --- a/source/_components/pushsafer.markdown +++ b/source/_components/pushsafer.markdown @@ -41,7 +41,7 @@ private_key: type: string {% endconfiguration %} -### {% linkable_title Examples %} +### Examples Message to two devices with formatted text. diff --git a/source/_components/python_script.markdown b/source/_components/python_script.markdown index d60955d5a20..feb29f8d6ef 100644 --- a/source/_components/python_script.markdown +++ b/source/_components/python_script.markdown @@ -25,7 +25,7 @@ This integration allows you to write Python scripts that are exposed as services [hass-api]: /developers/development_hass_object/ [logger-api]: https://docs.python.org/3.4/library/logging.html#logger-objects -## {% linkable_title Writing your first script %} +## Writing your first script - Add to `configuration.yaml`: `python_script:` - Create folder `/python_scripts` @@ -46,7 +46,7 @@ hass.bus.fire(name, { "wow": "from a Python script!" }) } ``` -## {% linkable_title Calling Services %} +## Calling Services The following example shows how to call a service from `python_script`. This script takes two parameters: `entity_id` (required), `rgb_color` (optional) and calls `light.turn_on` service by setting the brightness value to `255`. diff --git a/source/_components/qbittorrent.markdown b/source/_components/qbittorrent.markdown index d25d73eba57..730a7d56d13 100644 --- a/source/_components/qbittorrent.markdown +++ b/source/_components/qbittorrent.markdown @@ -18,11 +18,11 @@ redirect_from: The `qbittorrent` platform allows you to monitor your downloads with [qBittorrent](https://www.qbittorrent.org/) from within Home Assistant and setup automations based on the information. -## {% linkable_title Setup %} +## Setup This sensor requires the qBittorrent Web UI enabled. The [official reference](https://github.com/qbittorrent/qBittorrent/wiki#webui-related) describes how to set up the Web UI. -## {% linkable_title Configuration %} +## Configuration To enable this sensor, add the following lines to your `configuration.yaml`: diff --git a/source/_components/qld_bushfire.markdown b/source/_components/qld_bushfire.markdown index 8cdf9868ce9..9596e67d97a 100644 --- a/source/_components/qld_bushfire.markdown +++ b/source/_components/qld_bushfire.markdown @@ -37,7 +37,7 @@ It has only been modified for the purpose of presenting the material in Home Ass Please refer to the [creator's copyright notice](https://www.qfes.qld.gov.au/Pages/copyright.aspx) for more information.

-## {% linkable_title Configuration %} +## Configuration To integrate the Queensland Bushfire Alert feed, add the following lines to your `configuration.yaml`. @@ -71,7 +71,7 @@ longitude: {% endconfiguration %} -## {% linkable_title State Attributes %} +## State Attributes The following state attributes are available for each entity in addition to the standard ones: @@ -87,7 +87,7 @@ the standard ones: | updated_date | Date and time when this alert was last updated. | | status | Status of the alert, for example, "Patrolled", "Going", "Contained" | -## {% linkable_title Full Configuration %} +## Full Configuration ```yaml # Example configuration.yaml entry diff --git a/source/_components/qnap.markdown b/source/_components/qnap.markdown index 95c6472996c..e818b35d6a9 100644 --- a/source/_components/qnap.markdown +++ b/source/_components/qnap.markdown @@ -18,7 +18,7 @@ redirect_from: This `qnap` sensor allows getting various statistics from your [QNAP NAS](https://www.qnap.com/en-us/). -## {% linkable_title Configuration %} +## Configuration To use the `qnap` sensor in your installation, add the following to your `configuration.yaml` file: @@ -122,11 +122,11 @@ monitored_conditions: description: Displays the used space of the volume as a percentage (creates a new entry for each volume). {% endconfiguration %} -### {% linkable_title Self-signed certificates %} +### Self-signed certificates If your QNAP device uses self-signed certificates, set the `verify_ssl` option to `false`. -### {% linkable_title QNAP device support: %} +### QNAP device support: This integration has been tested on the following devices: diff --git a/source/_components/qrcode.markdown b/source/_components/qrcode.markdown index b19a820cd4f..f9e5adef305 100644 --- a/source/_components/qrcode.markdown +++ b/source/_components/qrcode.markdown @@ -19,7 +19,7 @@ The `qrcode` image processing platform enables QR code recognition from cameras. To get this running, please install `zbar-tools` (Ubuntu 18.04) -## {% linkable_title Configuration %} +## Configuration To enable this, add the following lines to your `configuration.yaml` file: diff --git a/source/_components/quantum_gateway.markdown b/source/_components/quantum_gateway.markdown index 8d2ec7e7396..df4bf1247f1 100644 --- a/source/_components/quantum_gateway.markdown +++ b/source/_components/quantum_gateway.markdown @@ -19,7 +19,7 @@ The `quantum_gateway` device tracker platform offers presence detection by looki It was tested with a Verizon Fios-G1100 Quantum Gateway. -## {% linkable_title Configuration %} +## Configuration To use a Verizon Fios Quantum Gateway in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/qwikswitch.markdown b/source/_components/qwikswitch.markdown index 9b87c0a5209..07302d20fd1 100644 --- a/source/_components/qwikswitch.markdown +++ b/source/_components/qwikswitch.markdown @@ -33,7 +33,7 @@ There is currently support for the following device types within Home Assistant: The `qwikswitch` integration discovers all devices from QS Mobile. Currently, Relays and LED dimmers are discovered in Home Assistant. Relay devices are [lights](/components/light.qwikswitch/) by default, and can be configured as [switches](/components/switch.qwikswitch/). -{% linkable_title Configuration %} +Configuration ```yaml # Example configuration.yaml entry @@ -97,7 +97,7 @@ sensors: type: string {% endconfiguration %} -### {% linkable_title QwikSwitch Events %} +### QwikSwitch Events QwikSwitch devices (i.e., transmitter buttons) will fire events on the Home Assistant bus. These events can then be used as triggers for any `automation` action, as follows: @@ -123,7 +123,7 @@ The list of recognized commands can be extended for Keyfobs, door sensors, and P On some QS Mobile servers button events are only generated for switches added to the QS Mobile application, so it might be best to test button presses through the `/&listen` API -### {% linkable_title Qwikswitch Sensors %} +### Qwikswitch Sensors The sensor configuration is a list of sensors. Depending on the type of sensor, it will be a sensor or binary_sensor. @@ -146,7 +146,7 @@ qwikswitch: type: imod ``` -### {% linkable_title Switch %} +### Switch The `qwikswitch` platform allows you to control your [QwikSwitch](http://www.qwikswitch.co.za/) relays as switches from within Home Assistant. diff --git a/source/_components/rachio.markdown b/source/_components/rachio.markdown index b62b336addc..ba3192d2e94 100644 --- a/source/_components/rachio.markdown +++ b/source/_components/rachio.markdown @@ -28,14 +28,14 @@ There is currently support for the following device types within Home Assistant: They will be automatically added if the Rachio integration integration is loaded. -## {% linkable_title Getting your Rachio API Key %} +## Getting your Rachio API Key 1. Log in at [https://app.rach.io/](https://app.rach.io/). 2. Click the "Account Settings" menu item at the bottom of the left sidebar 3. Click "Get API Key" 4. Copy the API key from the dialog that opens. -## {% linkable_title Configuration %} +## Configuration To add this platform to your installation, add the following to your `configuration.yaml` file: @@ -66,7 +66,7 @@ manual_run_mins: Set `manual_run_mins` to a high maximum failsafe value when using scripts to control zones. If something goes wrong with your script, Home Assistant, or you hit the Rachio API rate limit of 1700 calls per day, the controller will still turn off the zone after this amount of time.

-### {% linkable_title iFrame %} +### iFrame If you would like to see and control more detailed zone information, create an [iFrame](/components/panel_iframe/) that renders the Rachio web app. @@ -78,17 +78,17 @@ panel_iframe: icon: mdi:water-pump ``` -## {% linkable_title Switch %} +## Switch The `rachio` switch platform allows you to toggle zones connected to your [Rachio irrigation system](http://rachio.com/) on and off. Once configured, a switch will be added for every zone that is enabled on every controller in the account provided, as well as a switch to toggle each controller's standby mode. -## {% linkable_title Examples %} +## Examples In this section, you find some real-life examples of how to use this switch. -### {% linkable_title `groups.yaml` example %} +### `groups.yaml` example ```yaml irrigation: diff --git a/source/_components/radarr.markdown b/source/_components/radarr.markdown index 877bb163ceb..0cb895345a5 100644 --- a/source/_components/radarr.markdown +++ b/source/_components/radarr.markdown @@ -17,7 +17,7 @@ redirect_from: This `radarr` sensor platform pulls data from a given [Radarr](https://radarr.video/) instance. -## {% linkable_title Configuration %} +## Configuration To use your Radarr sensor in your installation, add the following to your `configuration.yaml` file: @@ -84,11 +84,11 @@ ssl: default: false {% endconfiguration %} -## {% linkable_title Examples %} +## Examples In this section you find some real-life examples of how to use this sensor. -### {% linkable_title Get Episodes airing in next 2 days %} +### Get Episodes airing in next 2 days ```yaml # Example configuration.yaml entry @@ -101,7 +101,7 @@ sensor: days: 2 ``` -### {% linkable_title Enable SSL %} +### Enable SSL SSL may run on a different port than the default (7878). The SSL port can be bound to any port in Radarr, so it should be set in the config here (unless it is changed to 7878). @@ -118,7 +118,7 @@ sensor: ssl: true ``` -### {% linkable_title Get disk space for all storage locations %} +### Get disk space for all storage locations ```yaml # Example configuration.yaml entry @@ -130,7 +130,7 @@ sensor: - diskspace ``` -### {% linkable_title Get disk space for listed storage locations %} +### Get disk space for listed storage locations The storage locations Radarr returns are in the system page and in some cases this can list duplicates if sub paths are mounted separately. By listing paths to include, you can choose what data is reported by the sensor. @@ -146,7 +146,7 @@ sensor: - /tank/plex ``` -### {% linkable_title Get disk space in different unit %} +### Get disk space in different unit The Radarr API returns available space in bytes, but this sensor will default to reporting it in GB to make the number more manageable. This can be overridden if your storage needs require a different unit. All units from bytes (B) to yottabytes (YB) are supported. diff --git a/source/_components/rainbird.markdown b/source/_components/rainbird.markdown index 18ddecf21c7..463751fe9af 100644 --- a/source/_components/rainbird.markdown +++ b/source/_components/rainbird.markdown @@ -26,7 +26,7 @@ There is currently support for the following device types within Home Assistant: - [Sensor](#sensor) - [Switch](#switch) -## {% linkable_title Configuration %} +## Configuration To enable it, add the following to your `configuration.yaml` file: @@ -52,7 +52,7 @@ password: Please note that due to the implementation of the API within the LNK Module, there is a concurrency issue. For example, the Rain Bird app will give connection issues (like already a connection active).

-## {% linkable_title Sensor %} +## Sensor This `rainbird` sensor allows interacting with [LNK WiFi](http://www.rainbird.com/landscape/products/controllers/LNK-WiFi.htm) module of the Rain Bird Irrigation system in Home Assistant. @@ -74,7 +74,7 @@ monitored_conditions: description: Returns the sensor level. {% endconfiguration %} -## {% linkable_title Switch %} +## Switch This `rainbird` switch platform allows interacting with [LNK WiFi](http://www.rainbird.com/landscape/products/controllers/LNK-WiFi.htm) module of the Rain Bird Irrigation system in Home Assistant. diff --git a/source/_components/raincloud.markdown b/source/_components/raincloud.markdown index 9a1f49a24f2..bd4937e35a4 100644 --- a/source/_components/raincloud.markdown +++ b/source/_components/raincloud.markdown @@ -29,7 +29,7 @@ There is currently support for the following device types within Home Assistant: - [Sensor](#sensor) - [Switch](#switch) -## {% linkable_title Configuration %} +## Configuration To enable it, add the following to your `configuration.yaml` file: @@ -51,7 +51,7 @@ password: type: string {% endconfiguration %} -## {% linkable_title Binary Sensor %} +## Binary Sensor Once you have enabled the [Raincloud component](#configuration), add the following to your `configuration.yaml` file: @@ -74,7 +74,7 @@ monitored_conditions: description: Return status from the Melnor RainCloud Controller and Melnor RainCloud Faucet. {% endconfiguration %} -## {% linkable_title Sensor %} +## Sensor Once you have enabled the [Raincloud component](#configuration), add the following to your `configuration.yaml` file: @@ -101,7 +101,7 @@ monitored_conditions: description: Return the watering remaining minutes per zone. {% endconfiguration %} -## {% linkable_title Switch %} +## Switch Once you have enabled the [Raincloud component](#configuration), add the following to your `configuration.yaml` file: diff --git a/source/_components/rainmachine.markdown b/source/_components/rainmachine.markdown index dcfc0bf45c5..4650f896f0e 100644 --- a/source/_components/rainmachine.markdown +++ b/source/_components/rainmachine.markdown @@ -29,7 +29,7 @@ There is currently support for the following device types within Home Assistant: - Sensor - [Switch](#switch) -## {% linkable_title Base Configuration %} +## Base Configuration To connect to your RainMachine device, add the following to your `configuration.yaml` file: @@ -111,9 +111,9 @@ switches: default: 600 {% endconfiguration %} -## {% linkable_title Services %} +## Services -### {% linkable_title `rainmachine.disable_program` %} +### `rainmachine.disable_program` Disable a RainMachine program. This will mark the program switch as `Unavailable` in the UI. @@ -122,7 +122,7 @@ Disable a RainMachine program. This will mark the program switch as |---------------------------|----------|-------------------------| | `program_id` | no | The program to disable | -### {% linkable_title `rainmachine.disable_zone` %} +### `rainmachine.disable_zone` Disable a RainMachine zone. This will mark the zone switch as `Unavailable` in the UI. @@ -131,7 +131,7 @@ Disable a RainMachine zone. This will mark the zone switch as |---------------------------|----------|-------------------------| | `zone_id` | no | The zone to disable | -### {% linkable_title `rainmachine.enable_program` %} +### `rainmachine.enable_program` Enable a RainMachine program. @@ -139,7 +139,7 @@ Enable a RainMachine program. |---------------------------|----------|-------------------------| | `program_id` | no | The program to enable | -### {% linkable_title `rainmachine.enable_zone` %} +### `rainmachine.enable_zone` Enable a RainMachine zone. @@ -147,7 +147,7 @@ Enable a RainMachine zone. |---------------------------|----------|-------------------------| | `zone_id` | no | The zone to enable | -### {% linkable_title `rainmachine.pause_watering` %} +### `rainmachine.pause_watering` Pause all watering activities for a number of seconds. @@ -155,7 +155,7 @@ Pause all watering activities for a number of seconds. |---------------------------|----------|--------------------------------| | `seconds` | no | The number of seconds to pause | -### {% linkable_title `rainmachine.start_program` %} +### `rainmachine.start_program` Start a RainMachine program. @@ -163,7 +163,7 @@ Start a RainMachine program. |---------------------------|----------|----------------------| | `program_id` | no | The program to start | -### {% linkable_title `rainmachine.start_zone` %} +### `rainmachine.start_zone` Start a RainMachine zone for a set number of seconds. @@ -172,11 +172,11 @@ Start a RainMachine zone for a set number of seconds. | `zone_id` | no | The zone to start | | `zone_run_time` | yes | The number of seconds to run; defaults to 60 seconds | -### {% linkable_title `rainmachine.stop_all` %} +### `rainmachine.stop_all` Stop all watering activities. -### {% linkable_title `rainmachine.stop_program` %} +### `rainmachine.stop_program` Stop a RainMachine program. @@ -184,7 +184,7 @@ Stop a RainMachine program. |---------------------------|----------|----------------------| | `program_id` | no | The program to stop | -### {% linkable_title `rainmachine.stop_zone` %} +### `rainmachine.stop_zone` Stop a RainMachine zone. @@ -192,15 +192,15 @@ Stop a RainMachine zone. |---------------------------|----------|----------------------| | `zone_id` | no | The zone to stop | -### {% linkable_title `rainmachine.unpause_watering` %} +### `rainmachine.unpause_watering` Unpause all watering activities. -## {% linkable_title Switch %} +## Switch The `rainmachine` switch platform allows you to control programs and zones within a [RainMachine smart Wi-Fi sprinkler controller](http://www.rainmachine.com/). -### {% linkable_title Controlling Your Device %} +### Controlling Your Device After Home Assistant loads, new switches will be added for every enabled program and zone. These work as expected: diff --git a/source/_components/random.markdown b/source/_components/random.markdown index 764623cac64..d4345a51987 100644 --- a/source/_components/random.markdown +++ b/source/_components/random.markdown @@ -22,11 +22,11 @@ redirect_from: The `random` integration simply creates random values or state. This can be useful if you want to test automation rules or run an interactive demo. It generates a new state every time it is polled. -## {% linkable_title Binary Sensor %} +## Binary Sensor The `random` binary sensor platform is creating random states (`true`, 1, `on` or `false`, 0, `off`). -### {% linkable_title Configuration %} +### Configuration To enable the random binary sensor, add the following lines to your `configuration.yaml` file: @@ -44,11 +44,11 @@ name: default: Random Binary Sensor {% endconfiguration %} -## {% linkable_title Sensor %} +## Sensor The `random` sensor platform is creating random sensor values (integers) out of a given range. Returned values form a [discrete uniform distribution](https://en.wikipedia.org/wiki/Discrete_uniform_distribution), meaning that each integer value in the range configured is equally likely to be drawn. -### {% linkable_title Configuration %} +### Configuration To enable the random sensor, add the following lines to your `configuration.yaml` file: diff --git a/source/_components/raspihats.markdown b/source/_components/raspihats.markdown index df5b21c7e2b..63a95ddaa3b 100644 --- a/source/_components/raspihats.markdown +++ b/source/_components/raspihats.markdown @@ -21,11 +21,11 @@ redirect_from: The `raspihats` integration is the base for all related Raspihats platforms in Home Assistant. There is no setup needed for the integration itself. -## {% linkable_title Binary Sensor %} +## Binary Sensor The `raspihats` binary sensor platform allows you to read sensor values ​​using the digital inputs of the [raspihats](http://www.raspihats.com/) boards. -## {% linkable_title Configuration %} +## Configuration To use your `raspihats` boards in your installation, add the following to your `configuration.yaml` file: @@ -84,7 +84,7 @@ i2c_hats: type: string {% endconfiguration %} -## {% linkable_title Directions for installing smbus support on Raspberry Pi %} +## Directions for installing smbus support on Raspberry Pi Enable I2c interface with the Raspberry Pi configuration utility: @@ -105,7 +105,7 @@ $ sudo apt-get install build-essential libi2c-dev i2c-tools python-dev libffi-de $ sudo usermod -a -G i2c homeassistant ``` -### {% linkable_title Check the i2c address of the sensor %} +### Check the i2c address of the sensor After installing `i2c-tools`, a new utility is available to scan the addresses of the connected sensors, so you can see the sensor address: @@ -129,11 +129,11 @@ It will output a table like this: For more details about the `raspihats` add-on boards for Raspberry Pi, visit [raspihats.com](http://www.raspihats.com/). -## {% linkable_title Switch %} +## Switch The `raspihats` switch platform allows you to control the digital outputs of your [Raspihats](http://www.raspihats.com/) boards. -## {% linkable_title Configuration %} +## Configuration To use your Raspihats boards in your installation, add the following to your `configuration.yaml` file: @@ -192,7 +192,7 @@ i2c_hats: type: boolean {% endconfiguration %} -## {% linkable_title Directions for installing smbus support on Raspberry Pi %} +## Directions for installing smbus support on Raspberry Pi Enable I2c interface with the Raspberry Pi configuration utility: @@ -213,7 +213,7 @@ $ sudo apt-get install build-essential libi2c-dev i2c-tools python-dev libffi-de $ sudo usermod -a -G i2c homeassistant ``` -## {% linkable_title Check the i2c address of the sensor %} +## Check the i2c address of the sensor After installing `i2c-tools`, a new utility is available to scan the addresses of the connected sensors, so you can see the sensor address: diff --git a/source/_components/raspyrfm.markdown b/source/_components/raspyrfm.markdown index 6aa2a81910f..bd20d3fced0 100644 --- a/source/_components/raspyrfm.markdown +++ b/source/_components/raspyrfm.markdown @@ -22,7 +22,7 @@ Initially, this integration was created to support the Simple Solutions `ConnAir Other vendors of 433 MHz RC outlets have also created gateways that use a very similar protocol and can also be used with this integration like the Intertechno [ITGW-433 LAN Gateway](https://www.intertechno24.de/LAN-Gateway/Gateway-ITGW-433.html). -## {% linkable_title Configuration %} +## Configuration ```yaml # Example configuration.yaml entry @@ -81,15 +81,15 @@ switches: type: dict {% endconfiguration %} -## {% linkable_title Device support %} +## Device support Have a look at the underlying library [raspyrfm-client](https://github.com/markusressel/raspyrfm-client) to check what gateways and control units (outlets) are supported. -## {% linkable_title Channel configuration %} +## Channel configuration Depending on the control unit the channel config can have varying formats. Have a look at the underlying library [raspyrfm-client](https://github.com/markusressel/raspyrfm-client) to find out about a specific model. -## {% linkable_title Switch state %} +## Switch state Initially, the state of a switch is unknown. When the switch is turned on or off (via frontend) the state is known and will be shown in the frontend. @@ -97,7 +97,7 @@ Initially, the state of a switch is unknown. When the switch is turned on or off Note that due to the way those cheap RC units work it is **not possible to query their current state**. Therefore the only way to preserve a consistent state within Home Assistant is to only use Home Assistant as the controller.

-## {% linkable_title Full example %} +## Full example ```yaml switch: diff --git a/source/_components/recollect_waste.markdown b/source/_components/recollect_waste.markdown index 0b75a4cdf98..efd433f3eb5 100644 --- a/source/_components/recollect_waste.markdown +++ b/source/_components/recollect_waste.markdown @@ -27,7 +27,7 @@ The `Recollect Waste` platform allows you to track the next scheduled waste pick 5. Use the place_id and service_id when configuring the sensor. -## {% linkable_title Configuration %} +## Configuration To enable this sensor, add the following lines to your `configuration.yaml`: diff --git a/source/_components/recorder.markdown b/source/_components/recorder.markdown index 609d9b721f8..5801f9bd61d 100644 --- a/source/_components/recorder.markdown +++ b/source/_components/recorder.markdown @@ -123,7 +123,7 @@ recorder: If you only want to hide events from your history, take a look at the [`history` component](/components/history/). The same goes for the [logbook](/components/logbook/). But if you have privacy concerns about certain events or want them in neither the history or logbook, you should use the `exclude`/`include` options of the `recorder` component. That way they aren't even in your database, you can reduce storage and keep the database small by excluding certain often-logged events (like `sensor.last_boot`). -### {% linkable_title Service `purge` %} +### Service `purge` Call the service `recorder.purge` to start a purge task which deletes events and states older than x days, according to `keep_days` service data. @@ -132,7 +132,7 @@ Call the service `recorder.purge` to start a purge task which deletes events and | `keep_days` | yes | The number of history days to keep in recorder database (defaults to the integration `purge_keep_days` configuration) | `repack` | yes | Rewrite the entire database, possibly saving some disk space. Only supported for SQLite and requires at least as much disk space free as the database currently uses. -## {% linkable_title Custom database engines %} +## Custom database engines | Database engine | `db_url` | | :---------------|:---------------------------------------------------------| @@ -160,7 +160,7 @@ If you want to use Unix Sockets for PostgreSQL you need to modify the `pg_hba.co If you are using the default `FULL` recovery model for MS SQL Server you will need to manually backup your log file to prevent your transaction log from growing too large. It is recommended you change the recovery model to `SIMPLE` unless you are worried about data loss between backups.

-### {% linkable_title Database startup %} +### Database startup If you are running a database server instance on the same server as Home Assistant then you must ensure that this service starts before Home Assistant. For a Linux instance running Systemd (Raspberry Pi, Debian, Ubuntu and others) then you should edit the service file. @@ -182,11 +182,11 @@ Save the file then reload `systemctl`: $ sudo systemctl daemon-reload ``` -## {% linkable_title Installation notes %} +## Installation notes Not all Python bindings for the chosen database engine can be installed directly. This section contains additional details that should help you to get it working. -### {% linkable_title MariaDB and MySQL %} +### MariaDB and MySQL If you are in a virtual environment, don't forget to activate it before installing the `mysqlclient` Python package described below. @@ -216,7 +216,7 @@ After installing the dependencies, it is required to create the database manuall Once Home Assistant finds the database, with the right level of permissions, all the required tables will then be automatically created and the data will be populated accordingly. -### {% linkable_title PostgreSQL %} +### PostgreSQL For PostgreSQL you may have to install a few dependencies: @@ -241,7 +241,7 @@ $ sudo -i -u postgres psql -c "SELECT pg_reload_conf();" ``` A service restart will work as well. -### {% linkable_title MS SQL Server %} +### MS SQL Server For MS SQL Server you may have to install a few dependencies: diff --git a/source/_components/recswitch.markdown b/source/_components/recswitch.markdown index f6bc3102354..50bfc818a59 100644 --- a/source/_components/recswitch.markdown +++ b/source/_components/recswitch.markdown @@ -24,7 +24,7 @@ Supported devices (tested): - Lumitek CSW201 NEO WiFi - MALMBERGS CSW201 -## {% linkable_title Configuration %} +## Configuration To enable this switch, add the following lines to your `configuration.yaml`: diff --git a/source/_components/reddit.markdown b/source/_components/reddit.markdown index 608f1b1d4a7..51727cc8d50 100644 --- a/source/_components/reddit.markdown +++ b/source/_components/reddit.markdown @@ -18,11 +18,11 @@ redirect_from: The Reddit sensor integrates data from [Reddit](https://reddit.com/) to monitor your favorite subreddits. -## {% linkable_title Setup %} +## Setup To set up this sensor, you will need to generate a `client_id` and `client_secret` for the user account you will use to connect. Follow the first steps in [this Wiki page](https://github.com/reddit-archive/reddit/wiki/OAuth2-Quick-Start-Example). -## {% linkable_title Configuration %} +## Configuration To enable this platform, add the following to your `configuration.yaml` file: diff --git a/source/_components/rejseplanen.markdown b/source/_components/rejseplanen.markdown index c25a921d1ac..e5b05d7839a 100644 --- a/source/_components/rejseplanen.markdown +++ b/source/_components/rejseplanen.markdown @@ -18,7 +18,7 @@ redirect_from: The `rejseplanen` sensor will provide you with travel details for Danish public transport, using timetable data from [Rejseplanen](https://www.rejseplanen.dk/). -## {% linkable_title Setup %} +## Setup The `stop_id` can be obtained through the following steps: @@ -43,7 +43,7 @@ You will se a output like this: Find the name of your stop in the list and the "id" is the one you are looking for to us as value for `stop_id:`. -## {% linkable_title Configuration %} +## Configuration Add a sensor to your `configuration.yaml` file as shown in the example: @@ -73,7 +73,7 @@ departure_type: type: string|list {% endconfiguration %} -## {% linkable_title Direction %} +## Direction If you use the `direction` filter it's important to put correct destination or else the sensor will not work at all. The direction has to be the destination(s) for the transport type(s) for the departure stop destination, and NOT the stop where you want to get off. Check [http://rejseplanen.dk](http://rejseplanen.dk), make a search and use the destinations from there in your configuration. Make sure you use the exact name as the destination(s). @@ -103,7 +103,7 @@ sensor: It fails because the destination from the departure is NOT København H, but 'CPH Lufthavn', 'Helsingør St.' and others. -## {% linkable_title Examples %} +## Examples A more extensive example on how to use this sensor: diff --git a/source/_components/remember_the_milk.markdown b/source/_components/remember_the_milk.markdown index 49eaafd508e..e15ba207128 100644 --- a/source/_components/remember_the_milk.markdown +++ b/source/_components/remember_the_milk.markdown @@ -15,11 +15,11 @@ ha_release: 0.57 The `Remember The Milk` (RTM) integration allows you to create tasks in [remember_the_milk](https://www.rememberthemilk.com) from Home Assistant. You can use this if you want Home Assistant to send you a task that you should not forget, e.g., water the plants. The integration allows you to have several RTM accounts in parallel. -## {% linkable_title Setup %} +## Setup The setup consists of two steps: getting an API key and registering your account -### {% linkable_title Step 1: API key %} +### Step 1: API key To be able to use this component, you need a Remember The Milk account and you need to apply for your own [API key](https://www.rememberthemilk.com/services/api/keys.rtm). With the API key you will also receive your personal `shared secret`. Both of them need to be stored in your Home Assistant configuration: @@ -48,7 +48,7 @@ remember_the_milk: type: string {% endconfiguration %} -### {% linkable_title Step 2: registering your account %} +### Step 2: registering your account After saving the configuration, you need to (re-)start Home Assistant. On the first start you will notice a new "Configuration" panel appearing on the Home Assistant page. After opening the configuration page, follow the link "Remember The Milk login". This will take you to a login page where you have to log in with your normal Remember The Milk credentials. This will authorize Home Assistant to access your Remember The Milk account. @@ -58,7 +58,7 @@ If the registration was successful, the Configuration panel will disappear from In the background Home Assistant downloaded a "token" from the Remember The Milk server which is stored in the `remember_the_milk.conf` file locally. So you only need to register once. After that the token is used to authenticate with the server. -## {% linkable_title Creating/updating tasks with service ```create_task```%} +## Creating/updating tasks with service ```create_task``` This integration offers a new service domain ```remember_the_milk``` with the services ```_create_task```. You can call this service with the argument ```name``` and the optional parameter ```id``` to create a new task in your Remember The Milk account. You can call this service from your usual automations. @@ -74,7 +74,7 @@ At the moment, smart syntax is *not* supported when updating tasks. All smart sy | name | no | Name of the new task, you can use the smart syntax here. | "do this ^today #from_hass" | | id | yes | Identifier for the task you're creating, can be used to update or complete the task later on | "myid" | -## {% linkable_title Completing tasks with service ```complete_task```%} +## Completing tasks with service ```complete_task``` Complete a tasks that was privously created from Home Assistant. You can not complete tasks that were created outside of Home Assistant. @@ -84,7 +84,7 @@ If you have created your task with an ```id```, calling ```_complete_ta |-----------------------|----------|-------------|---------| | id | no | Identifier that was defined when creating the task | "myid" | -## {% linkable_title Automation example %} +## Automation example Here's an example for an automation that creates a new task whenever ```sensor.mysensor``` is ```on``` and completes it when the sensor reports ```off```. This way it reminds you to switch it off. By using the ```entity_id``` as id for the task, you can use the same rule also for multiple sensors. @@ -111,6 +111,6 @@ Here's an example for an automation that creates a new task whenever ```sensor.m ``` -## {% linkable_title Disclaimer %} +## Disclaimer This product uses the Remember The Milk API but is not endorsed or certified by Remember The Milk. diff --git a/source/_components/remote.markdown b/source/_components/remote.markdown index 004b1d9feb8..41d34ace16b 100644 --- a/source/_components/remote.markdown +++ b/source/_components/remote.markdown @@ -15,7 +15,7 @@ Keeps track which remotes are in your environment, their state and allows you to * Maintains a state per remote and a combined state `all_remotes`. * Registers services `remote/turn_on`, `remote/turn_off`, `remote/toggle`, and `remote/send_command` to control remotes. -### {% linkable_title Use the services %} +### Use the services Go to the **Developer Tools**, then to **Call Service** in the frontend, and choose `remote/turn_on`, `remote/turn_off`, or `remote/toggle` from the list of available services (**Available services:** on the left). Enter something like the sample below into the **Service Data** field and hit **Call Service**. diff --git a/source/_components/remote.xiaomi_miio.markdown b/source/_components/remote.xiaomi_miio.markdown index 8f46fce2d06..15431804943 100644 --- a/source/_components/remote.xiaomi_miio.markdown +++ b/source/_components/remote.xiaomi_miio.markdown @@ -18,7 +18,7 @@ The `xiaomi miio` remote platform allows you to send IR commands from your Xiaom Please follow the instructions on [Retrieving the Access Token](/components/vacuum.xiaomi_miio/#retrieving-the-access-token) to get the API token to use in the `configuration.yaml` file. -## {% linkable_title Configuring the Platform %} +## Configuring the Platform To add a Xiaomi IR Remote to your installation, add the following to your configuration.yaml file: ```yaml @@ -67,7 +67,7 @@ commands: {% endconfiguration %} -## {% linkable_title Full Configuration %} +## Full Configuration ```yaml remote: @@ -88,7 +88,7 @@ remote: - pronto:pronto_hex:[optional_repeat] ``` -## {% linkable_title Use named commands to create UI buttons %} +## Use named commands to create UI buttons ```yaml script: @@ -108,11 +108,11 @@ script: - 'read_bad_poem' ``` -## {% linkable_title Command Types %} +## Command Types The Xiaomi IR Remote Platform currently supports two different formats for IR codes. -### {% linkable_title Raw %} +### Raw A raw command is a command learned from [`remote.xiaomi_miio_learn_command`](/components/remote.xiaomi_miio/#remotexiaomi_miio_learn_command). @@ -121,7 +121,7 @@ A raw command is defined as in the following example: with an optional last parameter of frequency: `raw:Z6UFANEAAAAjAQAAAwkAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQIAE=:38400` -### {% linkable_title Pronto Hex Code %} +### Pronto Hex Code A pronto hex code is a hex code often supplied by the device manufacturer. @@ -130,15 +130,15 @@ A pronto hex code is defined as in the following example: with an optional last parameter of repeats (required by some devices): `pronto:0000 006C 0022 0002 015B 00AD 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0041 0016 0041 0016 0041 0016 0041 0016 0041 0016 0041 0016 0041 0016 0016 0016 0016 0016 0041 0016 0016 0016 0041 0016 0016 0016 0016 0016 0016 0016 0016 0016 0041 0016 0016 0016 0041 0016 0016 0016 0041 0016 0041 0016 0041 0016 0041 0016 0623 015B 0057 0016 0E6E:2` -## {% linkable_title Platform Services %} +## Platform Services The Xiaomi IR Remote Platform registers two services. -### {% linkable_title `remote.send_command` %} +### `remote.send_command` Allows sending either named commands using an identifier or sending commands as one of the two types defined in [Command Types](/components/remote.xiaomi_miio/#command-types). -### {% linkable_title `remote.xiaomi_miio_learn_command` %} +### `remote.xiaomi_miio_learn_command` Used to learn new commands. diff --git a/source/_components/remote_rpi_gpio.markdown b/source/_components/remote_rpi_gpio.markdown index f5ef991b05f..e88e072a0fb 100644 --- a/source/_components/remote_rpi_gpio.markdown +++ b/source/_components/remote_rpi_gpio.markdown @@ -18,7 +18,7 @@ ha_iot_class: Local Push The `rpi_gpio` integration is the base for all related GPIO platforms in Home Assistant. There is no setup needed for the integration itself, for the platforms please check their corresponding sections. -## {% linkable_title Binary Sensor %} +## Binary Sensor The `remote_rpi_gpio` binary sensor platform allows you to read sensor values of the GPIOs of a [Remote Raspberry Pi](https://www.raspberrypi.org/). @@ -65,7 +65,7 @@ pull_mode: For more details about the GPIO layout, visit the Wikipedia [article](https://en.wikipedia.org/wiki/Raspberry_Pi#GPIO_connector) about the Raspberry Pi. -## {% linkable_title Switch %} +## Switch The `remote_rpi_gpio` switch platform allows you to control the GPIOs of a [Remote Raspberry Pi](https://www.raspberrypi.org/). diff --git a/source/_components/repetier.markdown b/source/_components/repetier.markdown index 03fb8adb5e8..3728707405f 100644 --- a/source/_components/repetier.markdown +++ b/source/_components/repetier.markdown @@ -23,7 +23,7 @@ There is currently support for the following device types within Home Assistant: - Sensor -## {% linkable_title Configuration %} +## Configuration ```yaml repetier: @@ -100,7 +100,7 @@ camera: mjpeg_url: http://YOUR_REPETIER_HOST_IP:8080/?action=stream ``` -### {% linkable_title Retrieve API-key %} +### Retrieve API-key To generate the needed API-key do the following: diff --git a/source/_components/rest.markdown b/source/_components/rest.markdown index 7e191542a05..9d9ac3eaf66 100644 --- a/source/_components/rest.markdown +++ b/source/_components/rest.markdown @@ -118,11 +118,11 @@ $ curl -X GET http://192.168.1.31/temperature/ {"temperature": 77, "id": "sensor02", "name": "livingroom", "connected": true} ``` -## {% linkable_title Examples %} +## Examples In this section you find some real-life examples of how to use this sensor. -### {% linkable_title External IP address %} +### External IP address You can find your external IP address using the service [JSON Test](http://www.jsontest.com) at their [http://ip.jsontest.com/](http://ip.jsontest.com/) URL. @@ -134,7 +134,7 @@ sensor: value_template: '{% raw %}{{ value_json.ip }}{% endraw %}' ``` -### {% linkable_title Single value from a local Glances instance %} +### Single value from a local Glances instance The [glances](/components/sensor.glances/) sensor is doing the exact same thing for all exposed values. @@ -147,7 +147,7 @@ sensor: unit_of_measurement: MB ``` -### {% linkable_title Value from another Home Assistant instance %} +### Value from another Home Assistant instance The Home Assistant [API](/developers/rest_api/) exposes the data from your attached sensors. If you are running multiple Home Assistant instances which are not [connected](/developers/architecture/#multiple-connected-instances) you can still get information from them. @@ -162,7 +162,7 @@ sensor: unit_of_measurement: "°C" ``` -### {% linkable_title Accessing an HTTP authentication protected endpoint %} +### Accessing an HTTP authentication protected endpoint The REST sensor supports HTTP authentication and customized headers. @@ -205,7 +205,7 @@ Example entry for the `secrets.yaml` file: my_sensor_secret_token: Bearer gh_DHQIXKVf6Pr4H8Yqz8uhApk_mnV6Zje6Pr4H8Yqz8A8nCxz6SBghQdS51 ``` -### {% linkable_title Use GitHub to get the latest release of Home Assistant %} +### Use GitHub to get the latest release of Home Assistant This sample is very similar to the [`updater`](/components/updater/) integration but the information is received from GitHub. @@ -223,7 +223,7 @@ sensor: User-Agent: Home Assistant REST sensor ``` -### {% linkable_title Fetch multiple JSON values and present them as attributes %} +### Fetch multiple JSON values and present them as attributes [JSON Test](http://www.jsontest.com) returns the current time, date and milliseconds since epoch from [http://date.jsontest.com/](http://date.jsontest.com/). diff --git a/source/_components/rest_command.markdown b/source/_components/rest_command.markdown index 2a77a169171..0a1f932f527 100644 --- a/source/_components/rest_command.markdown +++ b/source/_components/rest_command.markdown @@ -75,7 +75,7 @@ service_name: default: true {% endconfiguration %} -## {% linkable_title Examples %} +## Examples The commands can be dynamic, using templates to insert values of other entities. Service call support variables for doing things with templates. diff --git a/source/_components/rflink.markdown b/source/_components/rflink.markdown index 9ff0b8a4f91..5825413ec29 100644 --- a/source/_components/rflink.markdown +++ b/source/_components/rflink.markdown @@ -29,7 +29,7 @@ This integration is tested with the following hardware/software: - Nodo RFLink Gateway V1.4/RFLink R46 -## {% linkable_title Configuration %} +## Configuration To enable RFLink in your installation, add the following to your `configuration.yaml` file: @@ -64,7 +64,7 @@ reconnect_interval: type: integer {% endconfiguration %} -### {% linkable_title Full example %} +### Full example ```yaml # Example configuration.yaml entry rflink: @@ -75,7 +75,7 @@ rflink: - digitech_* ``` -### {% linkable_title TCP mode %} +### TCP mode TCP mode allows you to connect to an RFLink device over a TCP/IP network. This is useful if placing the RFLink device next to the HA server is not optimal or desired (eg: bad reception). @@ -104,7 +104,7 @@ rflink: port: 1234 ``` -### {% linkable_title Adding devices Automatically %} +### Adding devices Automatically In order to have your devices discovered automatically, you need to add the following to the configuration. When pressing the button on the physical remote, RFLink detects the signal and the device should be added automatically to Home Assistant. @@ -122,7 +122,7 @@ sensor: The RFLink integration does not know the difference between a binary sensor, a switch and a light. Therefore all switchable devices are automatically added as light by default. However, once the ID of a switch is known, it can be used to configure it as a switch or a binary sensor type in Home Assistant, for example, to add it to a different group, hide it or configure a nice name. -### {% linkable_title Ignoring devices %} +### Ignoring devices The RFLink platform can be configured to completely ignore a device on a platform level. This is useful when you have neighbors which also use 433 MHz technology. @@ -145,22 +145,22 @@ This configuration will ignore the button `1` of the `newkaku` device with ID `0 Wildcards only work at the end of the ID, not in the middle or front!

-### {% linkable_title Device support %} +### Device support Even though a lot of devices are supported by RFLink, not all have been tested/implemented. If you have a device supported by RFLink but not by this integration please consider testing and adding support yourself. -### {% linkable_title Device Incorrectly Identified %} +### Device Incorrectly Identified If you find a device is recognized differently, with different protocols or the ON OFF is swapped or detected as two ON commands, it can be overcome with the RFLink 'RF Signal Learning' mechanism from RFLink Rev 46 (11 March 2017). [Link to further detail.](http://www.rflink.nl/blog2/faq#RFFind) -### {% linkable_title Technical Overview %} +### Technical Overview - The`rflink` Python module is an asyncio transport/protocol which is setup to fire a callback for every (valid/supported) packet received by the RFLink gateway. - This integration uses this callback to distribute 'rflink packet events' over [Home Assistant's event bus](/docs/configuration/events/) which can be subscribed to by entities/platform implementations. - The platform implementation takes care of creating new devices (if enabled) for unseen incoming packet ID's. - Device entities take care of matching to the packet ID, interpreting and performing actions based on the packet contents. Common entity logic is maintained in this main component. -### {% linkable_title Debug Logging %} +### Debug Logging For debugging purposes or context when investigating issues you can enable debug logging for RFLink with the following config snippet: diff --git a/source/_components/ring.markdown b/source/_components/ring.markdown index 30921308775..709352b2f32 100644 --- a/source/_components/ring.markdown +++ b/source/_components/ring.markdown @@ -31,7 +31,7 @@ There is currently support for the following device types within Home Assistant: Currently only doorbells are supported by this sensor. -## {% linkable_title Configuration %} +## Configuration To enable device linked in your [Ring.com](https://ring.com/) account, add the following to your `configuration.yaml` file: @@ -53,7 +53,7 @@ password: type: string {% endconfiguration %} -## {% linkable_title Binary Sensor %} +## Binary Sensor Once you have enabled the [Ring component](/components/ring), you can start using a binary sensor. Add the following to your `configuration.yaml` file: @@ -77,7 +77,7 @@ monitored_conditions: Currently it supports doorbell, external chimes and stickup cameras. -## {% linkable_title Camera %} +## Camera

Please note that downloading and playing Ring video will require a Ring Protect plan. @@ -107,7 +107,7 @@ scan_interval: Currently it supports doorbell and stickup cameras. -## {% linkable_title Saving the videos captured by your Ring Door Bell %} +## Saving the videos captured by your Ring Door Bell You can save locally the latest video captured by your Ring Door Bell using the [downloader](/components/downloader) along with either an [automation](/components/automation) or [python_script](/components/python_script). First, enable the [downloader](/components/downloader) integration in your configuration by adding the following to your `configuration.yaml`. @@ -155,7 +155,7 @@ data = { hass.services.call('downloader', 'download_file', data) ``` -## {% linkable_title Sensor %} +## Sensor Once you have enabled the [Ring component](/components/ring), you can start using the sensor platform. Add the following to your `configuration.yaml` file: diff --git a/source/_components/ritassist.markdown b/source/_components/ritassist.markdown index 33e4d7e11bc..897bcaee558 100644 --- a/source/_components/ritassist.markdown +++ b/source/_components/ritassist.markdown @@ -18,11 +18,11 @@ redirect_from: The `ritassist` device tracker platform allows you to integrate your vehicles equipped with [RitAssist](https://ritassist.nl/) or [FleetGO](https://fleetgo.com) hardware into Home Assistant. It allows you to see certain details about your vehicle, but also shows your vehicle on the map. -## {% linkable_title Setup %} +## Setup To use this component, you need an **API key** and **API secret**, which can be requested by contacting [info@fleetgo.com](mailto:info@fleetgo.com?subject=API%20Key). -## {% linkable_title Configuration %} +## Configuration To use this device tracker in your installation, add the following to your `configuration.yaml` file: @@ -63,7 +63,7 @@ include: See the [device tracker integration page](/components/device_tracker/) for instructions on how to configure the people to be tracked. -## {% linkable_title Available attributes %} +## Available attributes | Attribute | Description | |---|---| diff --git a/source/_components/rmvtransport.markdown b/source/_components/rmvtransport.markdown index 62be7f2e6bc..d2817cf695b 100644 --- a/source/_components/rmvtransport.markdown +++ b/source/_components/rmvtransport.markdown @@ -18,11 +18,11 @@ redirect_from: The `rvmtransport` sensor will give you the departure time of the next bus, tram, subway or train at the next station or stop in the Rhein-Main area public transport network. Additional details such as the line number and destination are present in the attributes. -## {% linkable_title Setup %} +## Setup Visit the [RMV OpenData web site](https://opendata.rmv.de) to find a list of valid station IDs. -## {% linkable_title Configuration %} +## Configuration To enable this sensor, add the following lines to your `configuration.yaml` file: @@ -83,9 +83,9 @@ next_departure: type: integer {% endconfiguration %} -## {% linkable_title Examples %} +## Examples -### {% linkable_title Full configuration %} +### Full configuration The example below shows a full configuration with three sensors that showcase the various configuration options. diff --git a/source/_components/rocketchat.markdown b/source/_components/rocketchat.markdown index 19c07d7e10a..39ce0259f5c 100644 --- a/source/_components/rocketchat.markdown +++ b/source/_components/rocketchat.markdown @@ -18,7 +18,7 @@ redirect_from: The `rocketchat` notify platform allows you to send messages to your [Rocket.Chat](https://rocket.chat/) instance from Home Assistant. -## {% linkable_title Configuration %} +## Configuration To add Rocket.Chat to your installation, add the following to your `configuration.yaml` file: @@ -39,7 +39,7 @@ notify: - **password** (*Required*): The Rocker.Chat password. - **room** (*Required*): The chat room name to send messages to. -### {% linkable_title script.yaml example %} +### script.yaml example ```yaml rocketchat_notification: @@ -51,7 +51,7 @@ rocketchat_notification: emoji: ":smirk:" ``` -#### {% linkable_title Message variables %} +#### Message variables - **message** (*Required*): Message to be displayed. - **data** (*Optional*): Dictionary containing any of the variables defined in the [Rocket.Chat docs](https://rocket.chat/docs/developer-guides/rest-api/chat/postmessage#message-object-example) diff --git a/source/_components/roku.markdown b/source/_components/roku.markdown index 7d2a95611e1..c4b4e7e3d46 100644 --- a/source/_components/roku.markdown +++ b/source/_components/roku.markdown @@ -41,13 +41,13 @@ host: type: string {% endconfiguration %} -## {% linkable_title Services %} +## Services -### {% linkable_title Service `roku_scan` %} +### Service `roku_scan` Scans the local network for Rokus. All found devices are presented as a persistent notification. -## {% linkable_title Remote %} +## Remote The `roku` remote platform allows you to send remote control buttons to a Roku device. It is automatically set up when a Roku is configured. diff --git a/source/_components/roomba.markdown b/source/_components/roomba.markdown index 1b7dc688825..b18b0a64e14 100644 --- a/source/_components/roomba.markdown +++ b/source/_components/roomba.markdown @@ -21,7 +21,7 @@ The `roomba` integration allows you to control your [iRobot Roomba](http://www.i This platform has only been tested with an iRobot Roomba 980 but should work fine with any Wi-Fi enabled Roomba like the 690, 890 or the 960.

-## {% linkable_title Configuration %} +## Configuration To add your Roomba vacuum to your installation, add the following to your `configuration.yaml` file: @@ -68,6 +68,6 @@ continuous: The Roomba's MQTT server only allows a single connection. Enabling continuous mode will force the App to connect via the cloud to your Roomba. [More info here](https://github.com/NickWaterton/Roomba980-Python#firmware-2xx-notes)

-### {% linkable_title Retrieving your credentials %} +### Retrieving your credentials Please refer to [here](https://github.com/NickWaterton/Roomba980-Python#how-to-get-your-usernameblid-and-password) or [here](https://github.com/koalazak/dorita980#how-to-get-your-usernameblid-and-password) to retrieve both the BLID (username) and the password. diff --git a/source/_components/route53.markdown b/source/_components/route53.markdown index 45b635e93dd..bdf2140d036 100644 --- a/source/_components/route53.markdown +++ b/source/_components/route53.markdown @@ -19,7 +19,7 @@ The integration will run every hour, but can also be started manually by using t Please note that this platform uses the API from [ipify.org](https://www.ipify.org/) to set the public IP address. -## {% linkable_title Setup %} +## Setup You will need to configure your AWS Account with a suitable IAM policy and API keys for this to function. @@ -63,7 +63,7 @@ Here is an IAM Policy sample, don't forget to update your Zone ID on the Resourc 5. Under the security credentials tab for the `homeassistant` user, create a set of access keys for placement in the integration definition YAML. -## {% linkable_title Configuration %} +## Configuration To use the integration in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/rova.markdown b/source/_components/rova.markdown index 1229162f701..4eb1a5dfc16 100644 --- a/source/_components/rova.markdown +++ b/source/_components/rova.markdown @@ -18,7 +18,7 @@ redirect_from: [ROVA](https://rova.nl) is a waste collection company that operates in the center and east of the Netherlands. The `rova` platform uses an unofficial [ROVA](https://rova.nl) API to allow you to get your waste collection schedule and integrate this in your Home Assistant installation. -## {% linkable_title Configuration %} +## Configuration To use the ROVA sensor in your installation, add the following to your configuration.yaml file: @@ -65,7 +65,7 @@ monitored_conditions: If no **monitored_conditions** are specified, only **bio** will be enabled. -### {% linkable_title Full configuration sample %} +### Full configuration sample A full configuration entry would look like the sample below. diff --git a/source/_components/rpi_camera.markdown b/source/_components/rpi_camera.markdown index 5cedd54b3e5..09fcbbe266a 100644 --- a/source/_components/rpi_camera.markdown +++ b/source/_components/rpi_camera.markdown @@ -18,7 +18,7 @@ redirect_from: The `rpi_camera` platform allows you to integrate the Raspberry Pi camera into Home Assistant. This integration uses the application [`raspistill`](https://www.raspberrypi.org/documentation/usage/camera/raspicam/raspistill.md) to store the image from camera. -## {% linkable_title Configuration %} +## Configuration To enable this camera in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/rpi_gpio.markdown b/source/_components/rpi_gpio.markdown index b93ef5ac8ad..a2d38b51761 100644 --- a/source/_components/rpi_gpio.markdown +++ b/source/_components/rpi_gpio.markdown @@ -23,11 +23,11 @@ redirect_from: The `rpi_gpio` integration is the base for all related GPIO platforms in Home Assistant. There is no setup needed for the integration itself, for the platforms please check their corresponding pages. -## {% linkable_title Binary Sensor %} +## Binary Sensor The `rpi_gpio` binary sensor platform allows you to read sensor values of the GPIOs of your [Raspberry Pi](https://www.raspberrypi.org/). -## {% linkable_title Configuration %} +## Configuration To use your Raspberry Pi's GPIO in your installation, add the following to your `configuration.yaml` file: @@ -71,7 +71,7 @@ pull_mode: For more details about the GPIO layout, visit the Wikipedia [article](https://en.wikipedia.org/wiki/Raspberry_Pi#GPIO_connector) about the Raspberry Pi. -## {% linkable_title Cover %} +## Cover The `rpi_gpio` cover platform allows you to use a Raspberry Pi to control your cover such as Garage doors. @@ -82,7 +82,7 @@ It uses two pins on the Raspberry Pi. Although you do not need Andrews Hilliday's software controller when you run Home Assistant, he has written clear instructions on how to hook your garage door and sensors up to your Raspberry Pi, which can be found [here](https://github.com/andrewshilliday/garage-door-controller#hardware-setup). -## {% linkable_title Configuration %} +## Configuration To enable Raspberry Pi Covers in your installation, add the following to your `configuration.yaml` file: @@ -135,7 +135,7 @@ covers: type: string {% endconfiguration %} -## {% linkable_title Full example %} +## Full example ```yaml # Example configuration.yaml entry @@ -153,15 +153,15 @@ cover: name: 'Right door' ``` -## {% linkable_title Remote Raspberry Pi Cover %} +## Remote Raspberry Pi Cover If you don't have Home Assistant running on your Raspberry Pi and you want to use it as a remote cover instead, there is a project called [GarageQTPi](https://github.com/Jerrkawz/GarageQTPi) that will work remotely with the [MQTT Cover Component](/components/cover.mqtt/). Follow the Github instructions to install and configure GarageQTPi and once configured follow the Home Assistant instructions to configure the MQTT Cover. -## {% linkable_title Switch %} +## Switch The `rpi_gpio` switch platform allows you to control the GPIOs of your [Raspberry Pi](https://www.raspberrypi.org/). -## {% linkable_title Configuration %} +## Configuration To use your Raspberry Pi's GPIO in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/rpi_gpio_pwm.markdown b/source/_components/rpi_gpio_pwm.markdown index d84a84c54fe..803c6c02e0a 100644 --- a/source/_components/rpi_gpio_pwm.markdown +++ b/source/_components/rpi_gpio_pwm.markdown @@ -20,7 +20,7 @@ The `rpi_gpio_pwm` platform allows to control multiple lights using pulse-width For controlling the GPIOs, the platform connects to the [pigpio-daemon](http://abyz.co.uk/rpi/pigpio/pigpiod.html), which must be running. On Raspbian Jessie 2016-05-10 or newer the `pigpio` library is already included. On other operating systems it needs to be installed first (see [installation instructions](https://github.com/soldag/python-pwmled#installation)). -## {% linkable_title Configuration %} +## Configuration To enable this platform, add the following lines to your `configuration.yaml`: @@ -69,11 +69,11 @@ leds: type: string {% endconfiguration %} -## {% linkable_title Examples %} +## Examples In this section you find some real-life examples of how to use this sensor. -### {% linkable_title RGB LED connected to PCA9685 controller %} +### RGB LED connected to PCA9685 controller This example uses a [PCA9685 controller](http://www.nxp.com/products/interfaces/ic-bus-portfolio/ic-led-display-control/16-channel-12-bit-pwm-fm-plus-ic-bus-led-controller:PCA9685) to control a RGB LED. @@ -88,7 +88,7 @@ light: type: rgb ``` -### {% linkable_title RGBW LED connected to PCA9685 controller %} +### RGBW LED connected to PCA9685 controller This example uses a [PCA9685 controller](http://www.nxp.com/products/interfaces/ic-bus-portfolio/ic-led-display-control/16-channel-12-bit-pwm-fm-plus-ic-bus-led-controller:PCA9685) to interact with a RGBW LED. diff --git a/source/_components/rpi_pfio.markdown b/source/_components/rpi_pfio.markdown index c56ca851dfa..895822a85bb 100644 --- a/source/_components/rpi_pfio.markdown +++ b/source/_components/rpi_pfio.markdown @@ -28,11 +28,11 @@ There is currently support for the following device types within Home Assistant: Set the jumpers on the PiFace board for address 0 (JP1: 1-2, JP2: 1-2). -## {% linkable_title Use with HassOS %} +## Use with HassOS Note that the PiFace Digital 2 uses the Raspberry Pi SPI port, which is disabled by default when using [HassOS](https://github.com/home-assistant/hassos). When using HassOS, you must mount the SD card on another computer and access the boot partition on the card. Edit the `config.txt` file and add the line `dtparam=spi=on` to the end. This should enable SPI when HassOS is booted and allow Home Assistant to access the PiFace Digital 2 board. -## {% linkable_title Binary Sensor %} +## Binary Sensor The `rpi_pfio` binary sensor platform allows you to read sensor values of the [PiFace Digital I/O](http://www.piface.org.uk/products/piface_digital/) . @@ -78,7 +78,7 @@ ports: default: "`false` (ACTIVE HIGH)" {% endconfiguration %} -## {% linkable_title Switch %} +## Switch The `rpi_pfio` switch platform allows you to control the [PiFace Digital I/O](http://www.piface.org.uk/products/piface_digital/) module. diff --git a/source/_components/rpi_rf.markdown b/source/_components/rpi_rf.markdown index 09873b3b4fe..c5e4841c1dc 100644 --- a/source/_components/rpi_rf.markdown +++ b/source/_components/rpi_rf.markdown @@ -21,7 +21,7 @@ The `rpi_rf` switch platform allows you to control devices over 433/315MHz LPD/S Interoperable with codes sniffed via [the rpi-rf module](https://pypi.python.org/pypi/rpi-rf) or [rc-switch](https://github.com/sui77/rc-switch). For more info see the PyPi module description: [rpi-rf](https://pypi.python.org/pypi/rpi-rf). -## {% linkable_title Configuration %} +## Configuration To enable, add the following to your `configuration.yaml`: diff --git a/source/_components/sabnzbd.markdown b/source/_components/sabnzbd.markdown index f78a3fea200..f94a2c827c1 100644 --- a/source/_components/sabnzbd.markdown +++ b/source/_components/sabnzbd.markdown @@ -80,7 +80,7 @@ Available sensors are: - `month_size`: GB downloaded this month - `total_size`: Total GB downloaded -## {% linkable_title Full examples %} +## Full examples ```yaml # Example configuration.yaml entry @@ -107,13 +107,13 @@ sabnzbd: This will attempt to access your SABnzbd instance at https://192.168.1.32:9090 and will create sensors named `sensor.sab_status`, `sensor.sab_speed`, etc. -## {% linkable_title Services %} +## Services -### {% linkable_title Media control services %} +### Media control services Available services: `pause`, `resume`, `set_speed`. -#### {% linkable_title Service `sabnzbd/set_speed` %} +#### Service `sabnzbd/set_speed` | Service data attribute | Optional | Description | |------------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| diff --git a/source/_components/samsungtv.markdown b/source/_components/samsungtv.markdown index d7fa1015f2c..7b816363e0b 100644 --- a/source/_components/samsungtv.markdown +++ b/source/_components/samsungtv.markdown @@ -18,11 +18,11 @@ redirect_from: The `samsungtv` platform allows you to control a [Samsung Smart TV](http://www.samsung.com/uk/consumer/tv-audio-video/televisions/). -### {% linkable_title Setup %} +### Setup When the TV is first connected, you will need to accept Home Assistant on the TV to allow communication. -### {% linkable_title Configuration %} +### Configuration To add a TV to your installation without relying on the [discovery component](/components/discovery/), add the following to your `configuration.yaml` file: diff --git a/source/_components/satel_integra.markdown b/source/_components/satel_integra.markdown index 85a067b0a38..e5b006dabc8 100644 --- a/source/_components/satel_integra.markdown +++ b/source/_components/satel_integra.markdown @@ -30,7 +30,7 @@ There is currently support for the following device types within Home Assistant: The module communicates via Satel's open TCP protocol published on their website. It subscribes for new events coming from alarm system and reacts to them immediately. -## {% linkable_title Setup %} +## Setup Please note that **ETHM-1 module is currently not supported**: it does not provide functionality used by this extension. At the moment only ETHM-1 Plus module is supported. That might change in the future, but no promisses are given. @@ -40,7 +40,7 @@ A list of all partition, zone and output IDs can be acquired by running DloadX p For the Binary Sensor check the [type/class](/components/binary_sensor/) list for a possible visualization of your zones. Note: If no zones or outputs are specified, Home Assistant will not load any binary_sensor components." -## {% linkable_title Configuration %} +## Configuration A `satel_integra` section must be present in the `configuration.yaml` file: @@ -114,7 +114,7 @@ switchable_outputs: type: string {% endconfiguration %} -## {% linkable_title Full examples %} +## Full examples ```yaml # Example configuration.yaml entry diff --git a/source/_components/scene.knx.markdown b/source/_components/scene.knx.markdown index c700914335e..e1703a23f6f 100644 --- a/source/_components/scene.knx.markdown +++ b/source/_components/scene.knx.markdown @@ -17,7 +17,7 @@ The `knx` scenes platform allows you to trigger [KNX](http://www.knx.org) scenes The `knx` integration must be configured correctly, see [KNX Component](/components/knx). -## {% linkable_title Configuration %} +## Configuration To use your KNX scence in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/scrape.markdown b/source/_components/scrape.markdown index e4e88648cb1..686a955077d 100644 --- a/source/_components/scrape.markdown +++ b/source/_components/scrape.markdown @@ -73,11 +73,11 @@ headers: type: string {% endconfiguration %} -## {% linkable_title Examples %} +## Examples In this section you find some real-life examples of how to use this sensor. There is also a [Jupyter notebook](https://nbviewer.jupyter.org/github/home-assistant/home-assistant-notebooks/blob/master/other/web-scraping.ipynb) available for this example to give you a bit more insight. -### {% linkable_title Home Assistant %} +### Home Assistant The current release Home Assistant is published on [https://www.home-assistant.io/](/) @@ -93,7 +93,7 @@ sensor: ``` {% endraw %} -### {% linkable_title Available implementations %} +### Available implementations Get the counter for all our implementations from the [Component overview](/components/) page. @@ -109,7 +109,7 @@ sensor: ``` {% endraw %} -### {% linkable_title Get a value out of a tag %} +### Get a value out of a tag The German [Federal Office for Radiation protection (Bundesamt für Strahlenschutz)](http://www.bfs.de/) is publishing various details about optical radiation including an UV index. This example is getting the index for a region in Germany. @@ -124,7 +124,7 @@ sensor: unit_of_measurement: 'UV Index' ``` -### {% linkable_title IFTTT status %} +### IFTTT status If you make heavy use of the [IFTTT](/components/ifttt/) web service for your automations and are curious about the [status of IFTTT](http://status.ifttt.com/) then you can display the current state of IFTTT in your frontend. @@ -137,7 +137,7 @@ sensor: select: '.component-status' ``` -### {% linkable_title Get the latest podcast episode file URL %} +### Get the latest podcast episode file URL If you want to get the file URL for the latest episode of your [favorite podcast](https://hasspodcast.io/), so you can pass it on to a compatible media player. @@ -152,7 +152,7 @@ sensor: attribute: url ``` -### {% linkable_title Energy price %} +### Energy price This example tries to retrieve the price for electricity. @@ -169,7 +169,7 @@ sensor: ``` {% endraw %} -### {% linkable_title BOM Weather %} +### BOM Weather The Australian Bureau of Meterology website returns an error if the User Agent header is not sent. diff --git a/source/_components/script.markdown b/source/_components/script.markdown index 7a1af47d4b0..8be598b5c60 100644 --- a/source/_components/script.markdown +++ b/source/_components/script.markdown @@ -59,7 +59,7 @@ script:  entity_id: group.living_room ``` -### {% linkable_title Passing variables to scripts %} +### Passing variables to scripts As part of the service, variables can be passed along to a script so they become available within templates in that script. @@ -115,7 +115,7 @@ script: message: "{% raw %}{{ message }}{% endraw %}" ``` -### {% linkable_title In the Overview %} +### In the Overview Scripts in the Overview panel will be displayed with an **EXECUTE** button if the device has no `delay:` or `wait:` statement, and as a toggle switch if it has either of those. diff --git a/source/_components/scsgate.markdown b/source/_components/scsgate.markdown index fa97b0f1b4a..a880234bbb8 100644 --- a/source/_components/scsgate.markdown +++ b/source/_components/scsgate.markdown @@ -44,7 +44,7 @@ device: type: string {% endconfiguration %} -### {% linkable_title How to find the scs_id for your devices %} +### How to find the scs_id for your devices The SCSGate integration relies on the [scsgate](https://github.com/flavio/scsgate) Python module. @@ -52,7 +52,7 @@ This module provides also a command line tool called `scs-monitor`. This program For more information checkout [this](http://scsgate.readthedocs.org/en/latest/?badge=latest#creation-of-a-home-assistant-configuration-file) section of `scsgate`'s documentation. -### {% linkable_title Cover %} +### Cover The SCSGate devices can control motorized covers connected to the BTicino MyHome system. @@ -93,7 +93,7 @@ devices: **Known limitation:** It is not possible to know the current state of the cover.

-### {% linkable_title Light %} +### Light The SCSGate device can control lights of the BTicino MyHome system. @@ -116,7 +116,7 @@ devices: type: list {% endconfiguration %} -### {% linkable_title Switch %} +### Switch The SCSGate device can control switches of the BTicino MyHome system. diff --git a/source/_components/season.markdown b/source/_components/season.markdown index 8a9ed712437..9d1ed40a7ba 100644 --- a/source/_components/season.markdown +++ b/source/_components/season.markdown @@ -29,7 +29,7 @@ All information about how the seasons work was taken from Wikipedia: - [https://en.wikipedia.org/wiki/Equinox](https://en.wikipedia.org/wiki/Equinox) - [https://en.wikipedia.org/wiki/Solstice](https://en.wikipedia.org/wiki/Solstice) -## {% linkable_title Configuration %} +## Configuration To enable the sensor, add the following lines to your `configuration.yaml` file: diff --git a/source/_components/sendgrid.markdown b/source/_components/sendgrid.markdown index 93d4a98bbf2..893db9b4c3f 100644 --- a/source/_components/sendgrid.markdown +++ b/source/_components/sendgrid.markdown @@ -17,11 +17,11 @@ redirect_from: The `sendgrid` notification platform sends email notifications via [SendGrid](https://sendgrid.com/), a proven cloud-based email platform. -## {% linkable_title Setup %} +## Setup You need an [API key](https://app.sendgrid.com/settings/api_keys) from SendGrid. -## {% linkable_title Configuration %} +## Configuration To enable notification emails via SendGrid in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/sense.markdown b/source/_components/sense.markdown index ea1f4e3b495..02034a66225 100644 --- a/source/_components/sense.markdown +++ b/source/_components/sense.markdown @@ -26,7 +26,7 @@ There is currently support for the following device types within Home Assistant: - Binary Sensor - Sensor -## {% linkable_title Configuration %} +## Configuration To enable this sensor in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/sensehat.markdown b/source/_components/sensehat.markdown index 6a7f2cf99e9..7a25530ed65 100644 --- a/source/_components/sensehat.markdown +++ b/source/_components/sensehat.markdown @@ -24,7 +24,7 @@ There is currently support for the following device types within Home Assistant: - [Light](#light) - [Sensor](#sensor) -## {% linkable_title Light %} +## Light The `sensehat` light platform lets you control the [Sense HAT](https://www.raspberrypi.org/products/sense-hat/) board's 8x8 RGB LED matrix on your Raspberry Pi from within Home Assistant. @@ -36,7 +36,7 @@ light: - platform: sensehat ``` -## {% linkable_title Sensor %} +## Sensor The `sensehat` sensor platform allows you to display information collected by a [Sense HAT](https://www.raspberrypi.org/products/sense-hat/) add-on board for Raspberry Pi. @@ -76,9 +76,9 @@ is_hat_attached: type: boolean {% endconfiguration %} -### {% linkable_title Customizing the Sense HAT data %} +### Customizing the Sense HAT data -#### {% linkable_title Format the sensor values %} +#### Format the sensor values Add the following to your `sensor`: @@ -108,7 +108,7 @@ sensor: {% endraw %} -#### {% linkable_title Give the values friendly names & icons %} +#### Give the values friendly names & icons Add the following to your `customize`: @@ -126,7 +126,7 @@ customize: friendly_name: "Pressure" ``` -#### {% linkable_title Create a group %} +#### Create a group Add the following to your `groups`: @@ -150,11 +150,11 @@ group: - group.sense_hat ``` -### {% linkable_title Directions for installing on Raspberry Pi All-In-One installer and HASSbian: %} +### Directions for installing on Raspberry Pi All-In-One installer and HASSbian: Here are the steps to make the _SenseHAT_ sensor work _successfully_ with the virtual environment versions. -#### {% linkable_title Install SenseHAT package to _homeassistant_venv_ %} +#### Install SenseHAT package to _homeassistant_venv_ ```bash # switch to the homeassistant_venv environment @@ -166,13 +166,13 @@ pip3 install sense-hat # be patient, this will take a long while ``` -#### {% linkable_title Return to `pi` %} +#### Return to `pi` Type `exit` to quit out of the _homeassistant_venv_ back to your `pi` environment. As all of the following steps should be under the `pi` user environment. -#### {% linkable_title Install _RTIMU_ %} +#### Install _RTIMU_ ```bash # pi user environment: Install RTIMU diff --git a/source/_components/sensibo.markdown b/source/_components/sensibo.markdown index 3a91fafc777..3c5b0d2418c 100644 --- a/source/_components/sensibo.markdown +++ b/source/_components/sensibo.markdown @@ -44,7 +44,7 @@ then in the Sensibo app log you will be able to distinguish between actions done in the app and actions done by Home Assistant.

-### {% linkable_title Full config example %} +### Full config example ```yaml climate: - platform: sensibo @@ -54,7 +54,7 @@ climate: - id2 ``` -### {% linkable_title Adding a quick switch example %} +### Adding a quick switch example If you want a "Quick Switch" to turn your AC On / Off, you can do that using the following `Switch Template`: diff --git a/source/_components/sensor.buienradar.markdown b/source/_components/sensor.buienradar.markdown index fe0abde9322..d3a043a6bd5 100644 --- a/source/_components/sensor.buienradar.markdown +++ b/source/_components/sensor.buienradar.markdown @@ -121,7 +121,7 @@ monitored_conditions: description: Symbol and full expected condition (in Dutch). {% endconfiguration %} -## {% linkable_title The `Name` Variable %} +## The `Name` Variable If you specify a name, the sensors will get an entity name of `sensor.[name]_[default sensor display name]`, for example: @@ -133,12 +133,12 @@ If no name is specified the sensors will be called `sensor.br_[default sensor di - `sensor.br_wind_speed`, since no name has been set for the sensor and the default display name for monitored condition `windspeed` is `Wind speed`. - `sensor.br_ground_temperature`, since no name has been set for the sensor and the default display name for monitored condition `groundtemperature` is `Ground Temperature`. -## {% linkable_title Daily forecasts %} +## Daily forecasts Conditions above marked with `1d` are daily forecasts. To get forecast for different day, replace the number in `_1d` part of the sensor name. Valid values are from `1` to `5`. -## {% linkable_title Configuration examples %} +## Configuration examples Full configuration example (excluding forecasted conditions) where location is manually specified: diff --git a/source/_components/sensor.command_line.markdown b/source/_components/sensor.command_line.markdown index 7c3fc82d51b..d8dcd0f897e 100644 --- a/source/_components/sensor.command_line.markdown +++ b/source/_components/sensor.command_line.markdown @@ -17,7 +17,7 @@ ha_iot_class: Local Polling The `command_line` sensor platform that issues specific commands to get data. This might become our most powerful platform as it allows anyone to integrate any type of sensor into Home Assistant that can get data from the command line. -## {% linkable_title Configuration %} +## Configuration To enable it, add the following lines to your `configuration.yaml`: @@ -61,11 +61,11 @@ json_attributes: type: string, list {% endconfiguration %} -## {% linkable_title Examples %} +## Examples In this section you find some real-life examples of how to use this sensor. -### {% linkable_title Hard drive temperature %} +### Hard drive temperature There are several ways to get the temperature of your hard drive. A simple solution is to use [hddtemp](https://savannah.nongnu.org/projects/hddtemp/). @@ -85,7 +85,7 @@ sensor: unit_of_measurement: "°C" ``` -### {% linkable_title CPU temperature %} +### CPU temperature Thanks to the [`proc`](https://en.wikipedia.org/wiki/Procfs) file system, various details about a system can be retrieved. Here the CPU temperature is of interest. Add something similar to your `configuration.yaml` file: @@ -102,7 +102,7 @@ sensor: ``` {% endraw %} -### {% linkable_title Monitoring failed login attempts on Home Assistant %} +### Monitoring failed login attempts on Home Assistant If you'd like to know how many failed login attempts are made to Home Assistant, add the following to your `configuration.yaml` file: @@ -124,7 +124,7 @@ logger: homeassistant.components.http: warning ``` -### {% linkable_title Details about the upstream Home Assistant release %} +### Details about the upstream Home Assistant release You can see directly in the frontend (**Developer tools** -> **About**) what release of Home Assistant you are running. The Home Assistant releases are available on the [Python Package Index](https://pypi.python.org/pypi). This makes it possible to get the current release. @@ -135,7 +135,7 @@ sensor: name: HA release ``` -### {% linkable_title Read value out of a remote text file %} +### Read value out of a remote text file If you own a devices which are storing values in text files which are accessible over HTTP then you can use the same approach as shown in the previous section. Instead of looking at the JSON response we directly grab the sensor's value. @@ -146,7 +146,7 @@ sensor: name: File value ``` -### {% linkable_title Use an external script %} +### Use an external script The example is doing the same as the [aREST sensor](/components/sensor.arest/) but with an external Python script. It should give you an idea about interfacing with devices which are exposing a RESTful API. @@ -175,7 +175,7 @@ sensor: command: "python3 /path/to/script/arest-value.py" ``` -### {% linkable_title Usage of templating in `command:` %} +### Usage of templating in `command:` [Templates](/docs/configuration/templating/) are supported in the `command:` configuration variable. This could be used if you want to include the state of a specific sensor as an argument to your external script. @@ -191,7 +191,7 @@ sensor: {% endraw %} -### {% linkable_title Usage of JSON attributes in command output %} +### Usage of JSON attributes in command output The example shows how you can retrieve multiple values with one sensor (where the additional are attributes) by using `value_json` and `json_attributes`. diff --git a/source/_components/sensor.knx.markdown b/source/_components/sensor.knx.markdown index 509091b5efa..294b6de4741 100644 --- a/source/_components/sensor.knx.markdown +++ b/source/_components/sensor.knx.markdown @@ -18,7 +18,7 @@ The `knx` sensor platform allows you to monitor [KNX](http://www.knx.org) sensor The `knx` integration must be configured correctly, see [KNX Component](/components/knx). -## {% linkable_title Configuration %} +## Configuration To use your KNX sensor in your installation, add the following lines to your `configuration.yaml` file: @@ -78,7 +78,7 @@ type: | DPT-14 | | 14.* | | 4byte_float | | 14.* | -## {% linkable_title Full example %} +## Full example ```yaml # Example configuration.yaml entry diff --git a/source/_components/sensor.markdown b/source/_components/sensor.markdown index e7b677297c3..8817df1e5c3 100644 --- a/source/_components/sensor.markdown +++ b/source/_components/sensor.markdown @@ -18,7 +18,7 @@ Sensors are gathering information about states and conditions. Home Assistant currently supports a wide range of sensors. They are able to display information which are provides by Home Assistant directly, are gathered from web services, and, of course, physical devices. -## {% linkable_title Device Class %} +## Device Class The way these sensors are displayed in the frontend can be modified in the [customize section](/docs/configuration/customizing-devices/). The following device classes are supported for sensors: diff --git a/source/_components/sensor.modbus.markdown b/source/_components/sensor.modbus.markdown index e0218005bdd..e5c0ad26785 100644 --- a/source/_components/sensor.modbus.markdown +++ b/source/_components/sensor.modbus.markdown @@ -16,7 +16,7 @@ ha_iot_class: Local Push The `modbus` sensor allows you to gather data from [Modbus](http://www.modbus.org/) registers. -## {% linkable_title Configuration %} +## Configuration To use your Modbus sensors in your installation, add the following to your `configuration.yaml` file: @@ -116,7 +116,7 @@ registers: It's possible to change the default 30 seconds scan interval for the sensor updates as shown in the [Platform options](/docs/configuration/platform_options/#scan-interval) documentation. -### {% linkable_title Full example %} +### Full example Example a temperature sensor with a 10 seconds scan interval: diff --git a/source/_components/sensor.mqtt.markdown b/source/_components/sensor.mqtt.markdown index f9a79d23cce..1eadc5db55f 100644 --- a/source/_components/sensor.mqtt.markdown +++ b/source/_components/sensor.mqtt.markdown @@ -16,7 +16,7 @@ ha_iot_class: Configurable This `mqtt` sensor platform uses the MQTT message payload as the sensor value. If messages in this `state_topic` are published with *RETAIN* flag, the sensor will receive an instant update with last known value. Otherwise, the initial state will be undefined. -## {% linkable_title Configuration %} +## Configuration To use your MQTT sensor in your installation, add the following to your `configuration.yaml` file: @@ -129,11 +129,11 @@ device: type: string {% endconfiguration %} -## {% linkable_title Examples %} +## Examples In this section you find some real-life examples of how to use this sensor. -### {% linkable_title JSON attributes topic configuration %} +### JSON attributes topic configuration The example sensor below shows a configuration example which uses a JSON dict: `{"ClientName": , "IP": , "MAC": , "RSSI": , "HostName": , "ConnectedSSID": }` in a separate topic `home/sensor1/attributes` to add extra attributes. It also makes use of the `availability` topic. Extra attributes will be displayed in the frontend and can also be extracted in [Templates](/docs/configuration/templating/#attributes). For example, to extract the `ClientName` attribute from the sensor below, use a template similar to: {% raw %}`{{ state_attr('sensor.bs_rssi', 'ClientName') }}`{% endraw %}. @@ -153,7 +153,7 @@ sensor: ``` {% endraw %} -### {% linkable_title JSON attributes template configuration %} +### JSON attributes template configuration The example sensor below shows a configuration example which uses a JSON dict: `{"Timer1":{"Arm": , "Time":