From 88851079c236d5251e6565c17f61ea7db7e81901 Mon Sep 17 00:00:00 2001 From: Joe Lu Date: Sun, 10 Dec 2017 03:28:28 -0800 Subject: [PATCH] Added documentation for Canary (#4162) * Added documentation for Canary * Addresses PR comments * Addressed PR comments * Addressed PR comments --- .../alarm_control_panel.canary.markdown | 18 ++++++ source/_components/camera.canary.markdown | 18 ++++++ source/_components/canary.markdown | 53 ++++++++++++++++++ source/_components/sensor.canary.markdown | 24 ++++++++ source/images/supported_brands/canary.png | Bin 0 -> 11216 bytes 5 files changed, 113 insertions(+) create mode 100644 source/_components/alarm_control_panel.canary.markdown create mode 100644 source/_components/camera.canary.markdown create mode 100644 source/_components/canary.markdown create mode 100644 source/_components/sensor.canary.markdown create mode 100644 source/images/supported_brands/canary.png diff --git a/source/_components/alarm_control_panel.canary.markdown b/source/_components/alarm_control_panel.canary.markdown new file mode 100644 index 00000000000..59125f8746a --- /dev/null +++ b/source/_components/alarm_control_panel.canary.markdown @@ -0,0 +1,18 @@ +--- +layout: page +title: "Canary Alarm Control Panel" +description: "Instructions on how to integrate your Canary devices into Home Assistant." +date: 2017-12-07 22:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: canary.png +ha_category: Alarm +ha_release: "0.60" +ha_iot_class: "Cloud Polling" +--- + +The `canary` alarm control panel platform allows you to integrate your [Canary](https://canary.is) alarm system in Home Assistant. + +To add `canary` alarm control panel to your installation, follow instructions in [Canary component](/components/canary/). diff --git a/source/_components/camera.canary.markdown b/source/_components/camera.canary.markdown new file mode 100644 index 00000000000..bf7c029bc73 --- /dev/null +++ b/source/_components/camera.canary.markdown @@ -0,0 +1,18 @@ +--- +layout: page +title: "Canary Camera" +description: "Instructions on how to integrate your Canary devices into Home Assistant." +date: 2017-12-07 22:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: canary.png +ha_category: Camera +ha_release: "0.60" +ha_iot_class: "Cloud Polling" +--- + +The `canary` camera platform allows you to view the latest camera image (triggered by motion) by your [Canary](https://canary.is) device in Home Assistant. + +To add `canary` camera to your installation, follow instructions in [Canary component](/components/canary/). diff --git a/source/_components/canary.markdown b/source/_components/canary.markdown new file mode 100644 index 00000000000..425055f48a4 --- /dev/null +++ b/source/_components/canary.markdown @@ -0,0 +1,53 @@ +--- +layout: page +title: "Canary" +description: "Instructions on how to integrate your Canary devices into Home Assistant." +date: 2017-12-07 22:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: canary.png +ha_category: Hub +ha_release: "0.60" +ha_iot_class: "Cloud Polling" +--- + +The `canary` component allows you to integrate your [Canary](https://canary.is) devices in Home Assistant. + +You will need your Canary login information (username, usually your email address, and password) to use this module. + +To set it up, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +canary: + username: you@example.com + password: secret +``` + +{% configuration %} + username: + description: The username for accessing your Canary account. + required: true + type: string + password: + description: The password for accessing your Canary account. + required: true + type: string + timeout: + description: Timeout to wait for connections. + required: false + type: int + default: 10 +{% endconfiguration %} + + + +Once loaded, your front end will have the following components: + +* A camera image triggered by motion for each camera. +* An alarm control panel for each location. +* A sensor per camera that reports temperature. +* A sensor per camera that reports humidity. +* A sensor per camera that reports air quality. diff --git a/source/_components/sensor.canary.markdown b/source/_components/sensor.canary.markdown new file mode 100644 index 00000000000..25efd713e39 --- /dev/null +++ b/source/_components/sensor.canary.markdown @@ -0,0 +1,24 @@ +--- +layout: page +title: "Canary Sensor" +description: "Instructions on how to integrate your Canary devices into Home Assistant." +date: 2017-12-07 22:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: canary.png +ha_category: Sensor +ha_release: "0.60" +ha_iot_class: "Cloud Polling" +--- + +The `canary` sensor platform allows you to integrate the sensors of your [Canary](https://canary.is) devices in Home Assistant. + +To add `canary` sensors to your installation, follow instructions in [Canary component](/components/canary/). + +Once loaded, you will see following sensors: + +* A sensor per camera that reports temperature. +* A sensor per camera that reports humidity. +* A sensor per camera that reports air quality. diff --git a/source/images/supported_brands/canary.png b/source/images/supported_brands/canary.png new file mode 100644 index 0000000000000000000000000000000000000000..26e8c26e825aaa509c900d79a14abaabe3bab84f GIT binary patch literal 11216 zcmdsdWmFtZ(Cz|@yE`l%Y$3QVZ1CVg0>N$ZKwyIfTb$s*9Rfju26s8Y-&=joa=)!h@Wp{9U~MTG?b0C1HQWnTaQNV~u5kr-&duX_HP z0{{RP)K*4DLrF#kq~YQOvvsfn02FaEliann=E*`wTZLQ4h!{aE=Tu&ppb2qBQlMtI zlD`IWND!-=EUG*SA-k@nb_bF|D5HfO33gzB`7GusfyTE^O<+S@= z{gwIc`q_EwBcItOfX1%?U>95u$zLE>kK}N#(~yXGu;&Vyf&d9m52<4f1_LTw%OX$x zYL!e)EmHheeR&A>w`^YIYS&&55+mmXo8}p}}3Eiq|VIC@@=QTLdyyX5BPDye|Ec%YAHgN}KGzSOz zGg~${?ei;izFPN^eO`AuC#?IUS)klBbxN)TB-UG z2yluDs9DZ9qYH5`{?PLShYdSof8W6sDcc^*xg&g+9pE(39wK^`I(T@eD_%e@gCGnygrWe2V^Hjcl7G*(Eb zGB46H!WJXon1J*n^m8m(K7Q)683O887@jgv4G|KQuQK7W1Rtbt##oCeI08TC%4kTQ zGr_5vFpL6kbI`{?0%-S0K0$;j$dhKcbAUSk`ATsb427=2Rap1~<0iVpLzZB@Pl}fo`3K6D9arfw& z#+VvZCVxShGus!Z!Rzgy{6XXF+dyH+_gb(VSdTv&+3dg9jl0Hr;?csfOmY-}-|2d6 z?#2j_Xe-$<8nH^Uwlc)`i&-kTQ0Pk=tCurpgG^ZPKS*gL zJYgkKe@-L!Y+g&P@`HSwqUiuORFH9e>WMw`}LfDr}Z4u zip9!c^T{U7Ce>#3zzei4Uejy-7nGkO<0G3RW6lJ&8b{Yh7lkTpjUQXs6K^URo-}(S3!mN)yLF4|k%FbI+OlHq6}R>SAMrG! z$|bU9wdT=Fyi3MA*1MZ&Qt88;2!Vyo`HUQUBq}{K)R85F!Q%heSb$+uYhpe0Z+S?vd}^ zZkNtxkGF4U@6>@Jz*5W|tbCw6P!}D7&4)>Z`WD#TiPYH~K+iK_!fZH2hWzZ8j9ah- zrXY?H>8&dTm`k9Pb>Fi=$HUjd9ms7iCo9v_tQgZb(Wej*MW#&VF5j>4Rc=~ARqmZ! zvYc|V9+!UghJ56!NKkiq?m+Rfs@(ehZ6 zPW?9=bky{;D+G_>#9hUkD&^-UjqaPk+4$zryARvnIJcutjIOPI#Q~Fps)EL4lY5N9 zEtJZYNR`%+)uFYkZ>vmB5gWw`u?czX{KezN!?r;+*EN&RSj^s6avJeVvbFMb3*_<2 zG!58JAL$dE%-MYfg!NP`OZyWKL%Z)W@#2t6H{Ju*x3L93tF0-$>hdJxJSs z)_>2@X#KwEO@5eaIsO%-Keu^?V@cj#u4PGIDb4SKNw|2z4H3~ z@|0$dW@VeHP4&^%w`YydG}l_WM-1>BzB-UP94x`A%j_1D8I8v;%m;tG|Dn$E{lngh zzR$~>rJ>89gVs-%pYGgO-7wt0FYPv+>7|S~=)I;t%EFPD_k8d3d6(@z`?7BA)%#buGv8;z>+*$c z->JM?+4Y~yq#dEC<`;avwEA*PNAPvhQoVTYKc#y6aqh zpR`^U-G=J3eQR{bvwYd)vl;!ENsSVLc6$hJd-rJkU2@lF`FseTF>-m1ptm$ZVm~~7@gAC7O;!TBmH|l8dD5rdl{7;24h0(~H z$R)2Y=UaG&UOR|04?^>$`W;(tygKw1XH@04@UR$C9Qr>Y`m;p7N5vve}I0(&?*|CR;-Bs|1^R~@b3W*`qo zhu5xR9+HfIB*cE#|7qr71pN_#+eTSw=>z^loyZu4+*OGi>AQ*@|gk(TrA=~wIlJ#>|K@DlHR&ST@1g%Hkus95(y86= z(f9|%-BAI<-+E;6w3#WE>buyqFN68rq`H*O0a=^A0Du%Ueg}=$D5<}N3b*3ml!(>fElm6sGmY-pUq6JKdLAqd9&sK zWWl9hx^n;e7uepQlKt8Ug>`;Z>M?^Ub5n7}p%%e}zLaS4O!w&;!u=~Q4%s(0{JOX2 zu55RHeT~ATnm_u4+B@G2IA)3bJb-lHuw|oU#V5)}5H0ZmGwc1kS2G&x;xgGRm!Xi% zDmb@Pf`pLn&Mk^~3_reC|MsLdRYmGrYuw7kW&Y>9zyx8N_Os;)Hz2Q##cCU3zquIb zP;X?_v=fLPxj68S-GIAEXb z z1^m*rkI>4PhP{5$V60b%uWqGQtJ4;vgq8EjI?>k9LJE*>RP9sfiYsd-y<&avGCqce zaKq@O)VHV-i6hO*&D<^oB0yj*MeX$d@W~c|2>q-krQwU_=M7(8c2Wve5j#wq(w@DF zVbNpTa6jsRuQy}`g!6Z%W*X6{>}tsg6_sW!Q+-d2?_AdorvciQn5!5%rowFQW<~TD zutTHU0?*Y$NeW#uqo}L9Dk`^yVE(N5d5>g??&{4R+=;l6x|MsJ4wecO{L;kzAL>lo zRXfNQCcTu$jvy094d0iWc;E2zrhLz1Y7V9JG}Ib_IneK`n@%!TaT`sap;p?@jY8hc z>x8X)C+#I8-EI?;7zV3^I}Je7m{JXd4(B>=l(;`u=NdV1HINH}sx&)_+n9+m+%@M- zCG+v(e6ODBw0BSZNGAF9y8h!;<|2aWaP#i4w+VI|Z#RZQU8Uz%GmYJD$m`J|%(J+K z8%JljeXc(94#S5IuI)&_8Ma(8JD6k{D^#7r!wc6J7OEX};KGUhA|K;`<3Qp-Q~afP zz8i`o-V-Bo>RLs8ADs!pF=V!9#^Lu(J}ph-nV&;g3_Q_aF{xxTS^?;(>N%^l;eM$a zr*B2qD$ihETDC1&+P6gC?!S5F0;P(&Bg)ixUu|uW9TV-`7l|NJYxIV9A7N5+Q?_1} zd@DYe8$uc`{@~mp(=O8lg>%uQbRHd|+%2(3T33cvw@#r)U$|7ZNu^DP-(F}#Tz`uh z7MN?uh+n6;5FCUfr8$QCcy?EzswQd2%CEPfJ^>5jylKWA9~%yf8Og@SC89=Paw$dW zMy<5cQ>o7l0*HH#(kh{a-r?}Tl!Jq$&=TU~!2AHL#oG=viI_?kP^wo>9THVYH8)G+ zC!+k4R0a(0`24A{CzE4N)T~aKLt-SE?Qgf>e3eg~Z{DT)EAhh_O-vQA>fqnj7LU>> zU}$18w5E%Uto(NtcdPznAuQAqTs0QG2`IG(>RQ$r&thQ;O4dU$I+y;3Csyp+2(Kr2 z(;u^5Gok++I6{N07O!9aaDR&$3ZeEhp=*-L-(v@oPJ-t`am1t-z1XzqeLg0xoQQP4 z97Fr^lUP!*`c!^O^OfJ51+!>gX#=%!WI^U4bC+*8Qx1EeAKtOq zfX!e^Z)Vfy7tPeOMcZ7M7HSlPf{N+m(?5cuWLjHgL3*ORSxjx?k)N-Q8-!>lvkZK} zQE*cmv+*PFLHH<>xDmMaZi-M@2&Hy6J0MkqIud=7Qjd^6bO?FR`(yOVkB+aK@zmkQ zVPyI99i2gUHo^jMU((!J5b#E-s+)qFSzsY{bXf&p5S_x-j_kTLd!%+kc@kM+d@dK3 z42|mQkcLV=z=PZ`o6+PdQA*I1LNj|>61F8PJ05T5c<Sps3Mw7im|0i{d5vKM%Rt^8Ht#X?UWin~Oddvtj^Mt{m;5Aui!X^vWYa zfsrfX)Z!`4+RJ9IEuU<{97>e}A`LENCltCTeXGe@RFMV+VnWOW0*bDw?>^(%4rB@z zlY?E=d2_UFno7ko%m>EL^h}(^blle6%VCHF{!i0kV#bi{kv(!l?~r!36TZZVD#Z|b zWN4rOEL6*ruED@yy4|Jw>%n1^Ng(0GkF)(5ib-ciJd}!-17*Nc{F!d*;D~dVuR?;G z!4Dajx)|Nf5k{eehs63%vW4v`rgpY@R)~jpmkjwOu}9lu)m_O`8X_@z-dmor-N)ed zKyK2Jo6t-^b3ES@+)aK%JT91!;jvZ;#nc%)O@vToLNB3Lx{Bi{gjCcwgUzPRCcdEK4 zn^CD*6dm!q`0iWQq@XbO%Ika&&Ap+4*&MNP7PRYzyg6DF}S37u8f3IY;_NQdKGzpn*m>iPs zA2Y(8-CXdf8!OV^Z@mXhn3(#7OUO-nOHOQV-JNI3<&@%_w+Y`aiLbj0Yv>AT>jki* zySCn!=eF?^52dj_#*J*G-#4u8qWn4yk?8wGm!n>^7;uk!!?c8Yc@TaMetmUOf+N2H z#t~)6lU`~?o}8T{%~9`oe&H4d8vfRLj0woxK*<<`TpfIVALS!gSkRL6OlaRQh5n|F z`%JfgxEfq_+E_N9T5A}vQd=miKT4V6=F|WQE%QNhw`_zvY8e?1AHDuLYv5acXEe{} zw76jus66Yfda%BKlhH{@DOO9*5nxh2k9YEAwXv5wbicI3yF3RzyeL4w$hK%3(W$02 z{+v9;{|XefS}mPAXLh?Fv@{Oa>^^AXPSKPVO zeu+vY7 zlu(V%nX}XV&PE|Q{cw$iQbW1Zu+^t8xMzK@mp56hOH&3rGayWrboa4*2cKeV6jD7E zBf=oeKZ~xT9frxT;*7P`eeMoAR-nazkxskvCo|~`-MW|r^In$w^a~H#?i2Vp8U-G7 zg+jj_E#JgCS{`1Azr00kG3|pIIurdpDDw#IwZrN}94&_P%!rk!+t?zjkdP`0ZM(4Q zA}g)<6APzwhqB3lK{Trd+srReG+<&2v`RtAYp9LBf8L#F;3#Ktumk-f0V;G=V6ZG; zmJUB2E+Ifdedxa2t7%WZ9LReO#57z1{o3{(EiaGANY$rA{Czm z2ZMo1#BqCq5RKYf=9H$8rJ`|p%xu_bFkfQs!1dczpQUqC7wUEo z2#ZU56oHTTJ=4i1J1WJCX8)K|TX+P!&crm_>#p)qx4qemq`KA3ZzV^@X$ln!Gj>ySLiWCw>QNt})Mt znZ6%x;SD&n9F^KhH$Oen@vwYw-87_V#!weEqDcn~n{?+A@}?KpK1rru?2OkmpV}}k z(QqNLL8YxeGo7kc^C5|T4oadYr}^HAbW=ei$R9i?4pojH+^+4>_RFq8=d}~ zq9hYNnGCX>!8EYZBB5$Gs|B*3cI)(6?wJv?1)U-74hnfDxak3#&}<>@4;bi;SK|zH zG8F9BH2lT0l5n~aYB0{iIp1dm*mch~-TW0SIHp#=E$e`E;^>D^2UAQdS=UNLtFV_L za8w==+BD={ytXtvr+^)B#?YwNb$_w<>gl68RN6v z2n;cw5;&dq80G!$;*QMe8a;mK;YGu83ZdArC%$B8)$Nl>2BYR#Wy85cW1KgK763Z? zN*UuP>O)@n4`7}&+A_PE`X4sPOEeOQZ%`_PXa6dW!aMpeQ&zG|ftm;G8bTa?`P)%Z z4tr@&+_v$W^U#vZzh7=}UK(P%v2U$TzhoF+er{65B8-d7_J~cE>{`h@XgzW^$C?*+ zPr8V@&Jh z3=wAf670ZKArt+o`3#y97qhA8IVA?>9wKK+P&SnJ>IwBN{tb-eG$!%eK9l)nR1CX- zls##Fl-`5HkN2Ha+v!`MZwrB|I4>GvU^1z6hU91$@y$u|+H?bX)6oT$6YAUFg~y@W zaqlGqm-U*MNE_Q<(cfzgK^S2xbG1TEzb9oSvN^uEtKP;&3lVKGdR4EkX9!g~5LoS`za z*)RlS68Wzx){hA*$h7xvze|a21QT2OxpBvzg03dES3kn|Gau{R%460+tDD&`2yhp5 zFl1pfS)pTs=Cr|uRpaO_=xUdUeQe3Z&SpIx=)$Wg=~ko+^mm7+iaRzt%E^50R;g%h zMMm2@N1Pn@RI?ePa89fu$2|zsLBe2|vNi(BY?9OxQU<<79+jiZ@NkO9kooviYp(vB zr5h3*C~)cNWA!OkN;Y;&O8k)^rxF|Z91N|K0(u*r}EvB z26@K4pPYWOBk30;h80P477JT|Bc;ky$zNaJ-33d%@w~euRLNnz2>mb>0NyV zs`+%N#C+BI@mbjZZ?ly#yF{hCDEo_Zy->qNidY9pG|Y*jRY42~6pd9Pf#lH#{5u8R zg^%jPC@NlMF;r_c)`8VWAww%Ou&z1Y{m_t?|~ z6Pt6js$qckGQ3_LsjG8c$GzPTL`!{v6SamtR^OXk+r@fK3+ zZ)2#%vEAsLC_K_1K2uC~vJYxR%S#p|E6;h^Qe>{R^xTkLZHb&_Fd6zz37H`uBRH?0 z(GfuLGCj-gU%W+R`u1Ob;^sw~`bu>#TM7Ao4)xBkxpPix=n!SI(0S~^wm8ZQ7|O>a zBJ~dJPReF-beQurT@t0)p^F~Y^qr9v4mg*Khqq01+*Es^9Dh=936<->5s2v1-5wit zE9J&R5Z%w~&`e9!xEu>Tz7ay;cLoUP@kzI*115ds3>h`fJr^#BHW!Es-%*>KKVJDj=4zko9WY$R4^ba(>JxF8BE!qM?F9u@u_?1zSc!UX;GK z%oi`x(U2hNGp5|8MnK#NE^=4`InrSA`_J5HPof5g$=^;9yeJl%*JJ}oZ2>-%m@lwC z?-(kG2q%;B_!5Y|8;%BYbFfNZkdx6<^_b4Z<@kiF?9W5mhF9`p;RTZ^D=k$iYEjDX zS+bQmpewfn66`o^^#DdiWpfL$!!TN9j}b;Typ+#rJ1LM32$jwWip%h}Ia2{WkAFWI-D1_(txn6IC#VA#h@^91=teceh3D%G9sQwb_78jfuVUrL z>pUQmTd6U6AGVbx}t=OlHD-eLCu*(1kHuVQ~%uG~`stSaP{{9E~5kQAH%r_XvSD@>xak1#zH+HJ5io_L^ac7hlIr0|X-El}% zZs?d9HW>CJb5D7n^3Di|(rpZ<3P)z5WAD<)ONQK_i zdUlU%CJGQ+BvWYp!jgS2B$)SE8;oJv(G-BsEF89Bm+U<$hnt`5xo4^&vx17zC_&sBf-!Dx-i83bYSHXSJ-iMWA zfr8?3HD+EBFLdOLF`GSU&^*X--~}T_8;qdKb3E4@Qgu9=G-CFWkKbpKp-o^g@(Yzr zCp6;7`V_*U&DTm;gcf&>ZS$nXRur7_Nbtkx`N2g)<9c%hVm#^uadG{8yIr;zefK>e zkbvVx!lkmV^Csi+x+3k8YK%hH0S9MhZt#*wY_l>Gg#O|S8b&70%K}rN$XwllJFN;Q z8rs<1dnjX$TJeIqf6P;!IjOZvFF&I8m#WzfCnaB7&!IqD0|)BT#{Bp8_WNyt$d9Sg zf>@Sp@pjI2-a~Ot^W~M*PYq44HWQ}XOD*!W*c!A@#FmshYF0kyT}s6MdYTi$uxV@o ze@cdgH@AcGh`n#;V z&NL5LuaHEu(TEc8$tZEnqSC)xZv?H=&$(t<9M#0(^DQH;sCpgQ7zPC1BD4ImM#U&0 z=P@2yD@=5{bZ9^Sifj2Dw{=OaM^q%W0jl39w0G4;gP zvVILyHS(Sfu7d+eS`XpigG#wB&H?zm4<9qTnr>)>df8#xDPNv;*%fQz&@QX41*3BjT+ zI!Ef4n#aK|4o6=l_=BgQKw0U3ioB|SpfvFOU2}|J6sqj|krDI!T9?Tg_~;|7L8b8Y9dfBdp^IX3EO@ltwTOY}?p+;ub4u zk1Af`PmYe*zyK+pmAq`U?>@dGG+r-)O_bZKoc;yyfwALAp&N8qUf)&QVdRN5(JTuG z|4I6JIgmX{?iLgf*PPanjTtMB|6!~M!<5V?%2e!1^U1G;Ics{CJ-*iRPqU=Ef1UBi z2x9i%9#h_FzW78un)iq@Z)`#{sj~3$K&kwXx6%U0Z72d*b)AQT(!^N-0_--#f7qhH zMFPLc<6VZ0p-mMMbkuyO4XA?u1J57BgRP^!;pRh1h4ol1^6|>!@9pI@t?#Ys zVH02alq>!+IRPAU-I;wFHKiiP>a+Vd=oAw>$fVM`0JOhE;k01^@XQcM#2*sF0Lc8t zB;t>k2a7Te6j&2q?4@tz{si(1##j}9Rua_R1Vfp+zkJFvby$xT59M$JTSZ_>J5T;{ zXoc(@aVL0LG@9eiDb2rY#3)AoXXsK$kj^A`TuH==0mIM7RJ>l47j?b=V^j|r=6T0B zgP*7;9!)D450O{6`peiiMbp7~{-in+-^Yhm#YX=$r9wmTD%C$UbO<79Z`|WQ*>^%V z*cI<`I8y(p%?RW+X*TEmlf#%ARlmz<-qH5e;(zM8`&jX>u}+( hkN+>OjKtS|L2>Q{_+ly!|NJJQB&Q}@{>(JsKLFMZm~H?7 literal 0 HcmV?d00001