From ed401e60b68611510075e8ea86c18ea1210a9835 Mon Sep 17 00:00:00 2001 From: Thibault Cohen Date: Thu, 23 Feb 2017 05:52:03 -0500 Subject: [PATCH] Add EBox sensor documentation (#2047) --- source/_components/sensor.ebox.markdown | 56 ++++++++++++++++++++++++ source/images/supported_brands/ebox.jpg | Bin 0 -> 10446 bytes 2 files changed, 56 insertions(+) create mode 100644 source/_components/sensor.ebox.markdown create mode 100644 source/images/supported_brands/ebox.jpg diff --git a/source/_components/sensor.ebox.markdown b/source/_components/sensor.ebox.markdown new file mode 100644 index 00000000000..4bb8b381312 --- /dev/null +++ b/source/_components/sensor.ebox.markdown @@ -0,0 +1,56 @@ +--- +layout: page +title: "EBox" +description: "Instructions how to integrate EBox data usage within Home Assistant." +date: 2017-02-15 17:17 +sidebar: true +comments: false +sharing: true +footer: true +logo: ebox.jpg +ha_category: Sensor +ha_release: 0.39 +ha_iot_class: "Cloud Polling" +--- + + +Integrate your [EBox](https://client.ebox.ca/) account information into Home Assistant. + +```yaml +# Example configuration.yaml entry +ensor: + - platform: ebox + username: MYUSERNAME + password: MYPASSWORD + monitored_variables: + - before_offpeak_download + - before_offpeak_upload + - before_offpeak_total + - offpeak_download + - offpeak_upload + - offpeak_total + - download + - upload + - total + - balance + - limit + - usage +``` + +Configuration variables: + +- **username** (*Required*): Your EBox username. +- **password** (*Required*): Your EBox password. +- **monitored_variables** array (*Required*): Variables to monitor. + - **before_offpeak_download**: Download before offpeak usage + - **before_offpeak_upload**: Upload before offpeak usage + - **before_offpeak_total**: Total before offpeak usage + - **offpeak_download**: Download offpeak usage + - **offpeak_upload**: Upload offpeak usage + - **offpeak_total**: Total offpeak usage + - **download**: Download usage + - **upload**: Upload usage + - **total**: Total usage + - **balance**: Account balance + - **limit**: Limit usage + - **usage**: Percent Usage diff --git a/source/images/supported_brands/ebox.jpg b/source/images/supported_brands/ebox.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7100742ce66ded9401130d08a9ebf0802f9dae3d GIT binary patch literal 10446 zcmbt)byOVflkN~KxVr@l88o;{AZT!R4bDt(*Wd(qC%C)I;O_1c26uPce0z8Iw}0Ke zdv5i4yWT!s?^Dm|I^A7e)o+V$e*l;=64DX?7#J9U)ZY#8wgM0Xz`cWog?$J2cL(=Z z;E@pE{|d_c_XtR6C}?PCD5$9Dn7CNz7&sWHsMv(qIC%I31O(_w z{Ie1s9vJ}v86N``1OI<5Z=C?F_W&?VG%O4i;2jnWEEddLFM#YXRlqygfB62VyhlL% z%Mte7Kc`hN0Wh%d{?bN7c@K{Q|JMZO?-2kV0TBzElJ(1b93>-MDmHavyLco#d_rzz zd#9M%X=+guzl7}S85(wt*eMQ9E-_U#NB^3h^REs$-4}mBN&ds-e>(iD;oxBr5dYny z5Z3?kh=A}O5diy-$v^zyu;Bmkr(}eHgKHO)jZfuQJ$25;E~>1e+BJb70r6i9(p)iagB|R_q)Y8osX)x=$vrn6rF34 z>1w_KzEn9bOskii71gR$r=rQU_f#RLmI}U>@}3BGX@*}{jkwr#mmN3S=@paHSANMF zJUJTbI6~%lJ`q+=J91hC&yTDXr)A`Lx=n7=Sr%?J;Ri-S8Af!40&iFZt18NvJ~1ru z^K0YOR-!p>6cUeJ_I$1e8?1S9qps;jCKM4sD+i*e4;ox>);Scntw>lA5w*6&YgDg= zhz!y5oice2F*+aY^`oZiGNm13x?MYKZF+SG-OnM|*jHIo-x;pKSu|Ox5DX*EmTA$T z--l>gk_Y5BH2L9~NCIPk=ImIr%^tD&_bb+W#NbPJm=18nT^&3zeCAXb}Sxv`ly)CPD$u_0tPM0*`lt9HqO zM~;#ShSj_!o(Lp`WnRJsjuvXyDmfls$|dd7m_7FjS7{;ivVjR5RATvHp4>4RrP(Y! z&~ecIR>T#WtZrdlo3N1<^7#^oy#D$%FgKeo5?MX;czIK8B2#Nz9Swg^E>O`Z{HTN! zCFtrA<54}YX2pE1!bXSbGmTsdr4Fh@_>|oMhOu(SZV77eegwUSitFeDec1R;!3f&M zFhld6#P$oWl^3PX462b$(V#5x@wt&U5zC1av{%t57*iEQBri;v_x|kzQF@u(s~dvx*oTk82!3POaPOd^ubO$k2U&W%4_) zMUT=CJJUcuxB8I0ozU<{HTm3A1;el?JBjy6j{j9i(odV}&ZbG5`G*ekB#mft*OEI& zVi>;vdfXdevpg;~fIg!y_`Wv%m7Li=#(BA(6r=2vqU%{R{nh$XF&M;58w;!)07Px6!Ox zC{q*Nb!-5$3|O6ts#K8JoMOP9xudEQcL@55DPW+Fy@sSB$z9Z^_bQ};FKNq)SY z&x8JDRZ-BNKK!?lEg>QQmEJg`*Am~tgvPn4wP z^CBC`&cj!XBSf@=DZSz1&&Fsjr5}UCa{F2+88u?VcYmz$d!>8595&_Koy3{wQgSlW z52w1-HAUp%GMI{Bm8ilW0;5E5VWA<^#nqfd4$h^0EGxsvsvMKL67%Nyo<& z=8d@9r7Bus{BH#JN0zswpX}-p)+Y1CTshf>d+!a%@>o-xcWNCz(6*^r7y*;kHf7PU zXl&=i#P@kp>sr2;&hTdVqLbTi??C4B3RGRD7wsr}^F`nbor@_Y{SbaX4|lteVugR- zY^_Vi82JT}38rPv^Y6^y&U>T>L=G2K91(rAyO!Da!sl?p^~&g{+|QaY*zaacp9|qi8VOZV7pW9s5>(B1IKqIg$H_#!;A) zXa%|zC7Tx+2MdLI=yeow%4dE0j!pisT}?2vxXRFC^c0NE&=+X1j(V{jUA5S8#Vx3k z#Q}iV%W6wbAJ`_{{EaVwKrM#|@k&SJLNRmOZ=>9$nLS=}gS`;WXv9bsx6#Lt?rE<> z%;%xbofuWAdKdO!9wq+7)RjU|hDe(x5T7s4`y)DsibZbENLTyi;8aebX2G60g1DhdkMt1gjR)Hp)N`LP@1D()vWEVa;kPn zJ?9OVt`qqX^Sd{0nyW@OZkVZN!N*I@f*Q~xaRzh6$sdyocJYb3MEXWZ+;?=RxirEm zE~X6-Q$k4(6A_K)>N?bnc%F!$vgY<+Gs@-)1;vbz>dEL;*O2WXZTV0TpEH_=bmh9{ zpOJq4zA4+21lyH3pf>GLEcS>r>0QR5P}moxZ6HmA$7%m!J{e8j^%8vnv&H<1?_OJ^ zq`XY;9WNN?v{}QaX?1rnjZL1)?uS(DVY*!(KGAyqr&z1Na+j$r2JK;+c0FIcB>Nb8 zr6l0xBnYNEpwJX)T~tH_DlNFmV60Zg#1xJQ(tQJ9C-RnTd-{CMz|I>_duUB=BH)HD zRTa?KufdP-v*8Y#u>D~sAcNN~hdY&}AT9R?mdqbcYL{EL?3dq_=yQE<)b`%ncaLjh6Lm)dfKC0VtRgZ6!DU z<2NKnnk0>47?A_Djm}ZZ-TI_k2jQTcKHM61F8hiL6w zZx}Uv^#TO6^m46eBHB$!1I{XC3ll2fAVx*~pS}l*XWD}6!6IVp1v}G|6^9b5*MLjt^-}jj9We(p;ZTzfdaX4K8H}BFuq{Y9lB@r)1 zmif+>^iDw+;rAypG<9LPs>(EVA4BW&Ssuz%b;O$h*YY^r-t$qRqM4SMiu(Fmi79Vn z(tqJ)5!$R?E$I)DoU09-e?xw#H@`*bKodeTGT{oJJ&O+Hetp=;9T)(HI@Gs76`vDLg1$?_9W=c2RP*bN zfSK_te*RDutjlS;+}+=Ei?$usI7iB6|KP_2JMsT*?fAGuSJP*#dK!Hf7n%<9&h#N za0vBLa7}6v*SB;GzJX})h@OpV9VSdYXnu4lgmZ!2jw`=M+|zH}(*}Aj*FM1-1ZDjz zl#v6%PzvF&{J$@>=Qy8%+aiZ8w6shQh9zomWY7PC(V*yJWZ0d{S|onv_!msZzsC>v zzn0bvOzUuEONm7p80n@;ug?~t;g+_lcPpHgH0D;A^^T#UgNMQ>CqnN0C&CEo5?3cN z^D=4a5tS+~+U$!>3P}mok8gD?Ft_^5*NcV^7cH3zm33$L0mSnjr{K0fS-)~Ymft~=s(ZS?rZITjd!CA*4+ENH9Lplr^+B)5!J|hK)NMvdgx$#rD`;~a zJHP#_=gMRb$WuzKb<(H019++fsJ zONC62Ll)ELbyK4r5Ttr;&;keDL&RxH-7W7*dN;1=@tVq1mc_M|^vjv{JWA-ybO)`f zoCo^lq}1iC{rO%oAIo)^+|8|Rg>d`~H#c52`mS=~N}}}YimwG`yGX>lCa{3TRD0X* zIB83-n_Z|}!3!a<(24b99g?v&B1c?jq$U4=>tx2%lt~`n$vRp9`#Vcrxv?*;ZRM&1 zA6E8K-QX|(l&|z!S=G$UjWtH~>6_@0MQT2Q$x7w(bJsU!U2WAOZ0*RPOGed0ZTcT; z(NVcZqS_DZWUz&=L=Y}rke`kDZ*qEqzZ-zBmO{Z{3);tlrF}>{g_itvux>P#iVM=R z+bw3Gv##8mD%)*tt{gF?DfyV!=F>T6bR@FJ)C48vMV&E4!$ro$_<7>bAmQJ;HH?b~ z>=70B^$VYMZo#&6X430=wWa{W*C1D0s%55@#O|#dM@r~2=5w_?Ga3z2^ zHvFoB!P@rHhd1B6N};ZFb;e})?t=UtSk=w~AqC~Zl7`D`@C=DOfh{~iPdI(L*CY|( z9=V!fZA&CE3n>}pnBP()zOd0n*Hf}r^HN)2G)E-0w%5LBjUBHkJ{p`%h5dr;$uy*$)2BRchy(Yq?V26&NydM(C=p z)->}XpKmfapsdqGHd{eGv6ZG+Uf}oJuha(Q7->UTBNeI8NgA0wo02}}SMXcGSb;v- zl0|#wZlU$K?I?~G82kbbPHWi(FX@j&@cayH$R6}>!`e{8t8_4}CP2w?)K3H!eam&$ zg5hpx0gv+7F1q41*s@4?PD2duPVe5Imn(~k=I9hOsZdFR*HiOzm+ITDkhZiZ@HBsD zT3w&yya8z6S+n<*HmxXM0(4Ond6oWORzo1y|YP69lH_T!z$6_4eZLu!`Txa%- zlV+7?A=Aojh-dYY9WNLQVq-Qd1QNP)Ki)Nm=r%}v4cyOLn!P_Cuat8RxqJsfE3aH= zX-PT{qUf^uXl9|i8pW8$l+J3StzqYiRdh55!BTc{)2^(7)msS80n&JqHnI5wI)o>%f^JJ48CtXgFW3HiIl5Wur;2xPOP8b!Z@SDV@gn_;Uq$-VOp zkbg@pM+(<{>sPep;({i<1#xNg4%3RU>_%Omon?rJ#1`WxgA)WgcXA>_9d83(%S#Su zjM9O=%1O24?%R4KFmgsZ{0D5xu2IO*oU(R3ee$I@8rJE8A1^X#>%)bEKFZZDr&+LV z50FZ>v-=X`@ogE>LR{k;5Gm;EJkSI`DifJDl6&18XTO)$Ueyu+kjzTIm_Y_9(Qn|N z=8@@)nFGR-5H?ODK;2J})GK&*q{&)}bq5UQQ;l!6tXqx9`$nSS{nK$|0c=w;GV?O? zPD->gd>L-)Tji9KEbzuQc=6a<#=mqDm$*@K@@vWF(CeA-)1(-rE~SA&z;)gOo%Zt0 zvAOUS4Zhx9(V8y=Q|*Z||1Awwn^A0Rk-U6BJVX$>IqcE7kr~MqUWkNNlmFsv?^oQY zxFa}bUh5lYmxbg0#6EY-Br_WuSJA50^2(3@1~@)6Kl$#%T+c10TioMT9?FvVEKLO+ zQD3xa8~S;vqokaemrG`|bY{P-yNC%mp-7|Hf|Wu_KYgW6^^KA2=tOPc>D%t9aOp%}cpQSyHA z;rGr_X3VO+hBW8<@@g670wyPVuDh@8nji`#>a(@dkGVe_zwHD~-Czs7EC(9gz}viF zy#a=~o1PNUrUp205?m9voYi793^0O{yXuBek1eXo%bnFK%@Uftc|bnqr{41v!{sJZ z)Xbl6O-)eBE3ufZv;tw+h*>GnN-dhOooL7;5<0x;wTxb;LWC{o&Q)d1<_HJW9d+%XN zn+88ge0cet)unZ*;kCJQuBMlp(-ClX`7)wqrXZ6RMAg+uf>(>g3050s+v25N+JP?P z$0p$BQSx8Y$;qES&J$_<{lq5M&8-I4e2W0PiSRqb4yQ#<^A-WMLD4*LN5#imI!7Fj zjGH_>R9g<+ci(Ec-?OGiuh?&V8xyRG&GCo+*%2xjN33N9~GN8K^E~WOGwjRBC1H>`x zQ*7!dn=TB!L>&%pIHs2N2*oAd%|w;>LpE|wEoIbN_AF(TLvqM7J6Mh$b676yYbhK& zp09rSY(jlzPmIGI5iUJcgJPC zsvPwp6RizlyRzzBgXz)F!9-TttlQOI?(z*F*ko&5XgQ$nnkg*>&BtkiX`AJpX6LQc zN^@adIRf3gv!^K;g7$T({VOe-WsXU4MpTM97lYN3<{xzu52j#4oO;D?gsq+g(_iIx zg7m6`J~nR>66$ZdCs9pVYw1e;(l4^fS{HeqbXuA{D5w{|mKx;w6^ux3!okYe7C%_O z@-ueJ6471HMNTwfl-d{Sa!M?Wy~D*m_t%;jbd6p z_*>dOWI})96Ab zBkiSR#?t52XeG`O{g7ovJlOAUO!v9!s+=>X6D0apB`#|y4;TS%C`W&bAv>+g`bd3^ z&$NO=T)c-yY&g~Q>>=oqiIMQ=b>+&{g%%4{Va4T14=H5Tj^yD++tbcPpn2U0mqn2H%bK5ioc<6!1{ zC7VTXWMu8-r+Ly?m&1aAxXN+KGJnn1k7nk93+h5KgmfJD;k3TT{9j1#pIBC_M&k|? zB~>g(L)Jp&pwtGC-QX9g*Ao!w&~RJRI0-#Vj9z4lJyw~=TDc{?f!TT{gRe7#>t<2W z2-`V2LnpTnp!YV(I3boWI*Tln?4*gCLLJKMXRul`imK(yyiOJb9+yB-Wa%@ABA1-8 zITfnT38psCQkT5kBOtf#laz!;hqckmMy{D0W}#)8#4aUyhdqS6bP+nG;P=4x^z5GM zQC2Oesz54PeyD7pU)OEu%+Rx$GhP~xmVMz}JW~i;pZ#^RB&DFTGUpGi6Vzwjl`~X+ z)c+chSg_qjb6NS~-o!c;`QS+5~QKkptqM|I77(t8yeg9f?XXgV_;-uMb$ln+H{CWS!-lTD z%h{hJ<>i#l^Nwpdb6sOXR^0BQd5m5Ci%G;2R^qQvJ*&@4!D#UaIXw!1L@k9dze2;= ztB=(~B-GxK9WH(Hxur#Ag@WHH8`n=9UspV?H!Aw}Bfstn7P3{XjwEEu3yigx`!;_X zV5CwB1tF_MG~}qpV?(+m^_R!#?eEyzC0OW^I!=GQ0iws0>Om;Ka?u$wpo(nB%~WQc z%Gp00qjoMaW>LM4<{W2DPJREZ>V>ekkgnk4x2lzj*_SoqqBm|Ld^T-*LtNN8k3L zI?^jqPY8YwBaLux$#h1Zub~ zZTau%NsT0OoV%NmtdjSbj&AEm(w5a^@Mz-vF^@c7Kxu{Tacr~*AEx73WqoI|T+(=$ zU|H|7t_`E}9WzGr#AQN=cah`5~Uu-Z@0 zm}61gtXZ`(MUFS}VV_3>%Hs$+vwP{+6zR2BR^-sTz?AO5%F5${_KupiqkGCUazHbR#{JhBO8hCdnR$I9M8TL$7y1I_h=2IJ3G7cPxO!?S(@HT6H2U_UW`Z~ z?RoMC|1(l~;U{2agG2VWVN&G)G*z3}PO^>|J(t_Xm_Is;{#beSKsH(Ys0~Hq9G1;xUoB1b=tCq_PpY7pC#CwebBBxhh z&DXMsJL#fI_D6wTd_u^e)x`H0uX;p`pF{q+znESvblgwiVSe+y!=Tp8?ri?;Uwy8C zUuf?96E|X`rMP&5mOWxo=D-!g`H>UVj4!ATC1U{8sH^49Dsz?gN5aCb^cN&d;a=rm zQ`L&~vmRlgKC%69;j|yVFC$Z_8tEJF*u}8r(dBDL z3Dp~bfPwvvTQS$Mufh@7-T>-hvBFLREJTbnPl(2XI3>ot;Ket93RaD0 zJX%)0q?>>n3|~QR3BE^rO)c~LCaudu*Isk3*Mf(oS8h$h>ZlZGZ4mZ z{e$e!!zd*t>N<2}(nRjaiz03=xm^j8(QuBmj7W)*G2fKvj1PiX=CQ$_-9CYZEr_}E zxg||`nh9H3KHMMD4$Yh4?2yy;?X#UAt&IH;C zOx7Lm=VcncZnc-1c+OT1ZaP07>y(3pNFry#lJ$vL1O+2sFrM`TrmNCp2e?tqgB#A0 zjSqrPFQ(y&YAKsmtc3;hi_r2iCx8MNR1Q`R*8YLrdvT)o-&xzN2#7Dhe$EY$AI&|+ z-=&e3oI=q8v%40RU5Ha^2Xe+&qSo2gwsQ@L)Ge7UvQ(HeDa1V>l-(ut8li@fO6Kq^ z7=83b6q$%RA*&t(L;A)WBqa=(*yx_6v zVf0`1!?wpCoa-PvwX2*87Nr{Omv=~8PYS+JYZZGL7*uJ6kY|VGV1$dqKW_fYX3mb_ zzGUHwW~1?1%%!Q4DAkSYri1Gha!m?eigK!wy!=!|^YB%s*C>jfYRxA>6ER&Evf!pu zAw)m=sFCA=5zp-^UJGRtfvd4MfK1Kmih?%3l=LhkM*2_3({kQSGW`4joxAWRk8VPm zvZd|j+z_(xCYMjnwC)sAvr9yK(BZEkr%fZrm6nYpTB0k8yYJWEm%!3IDsC`ls8y2J z?Cb)jsQyfn<4<1q|Ji@STQ9k$H%>QAx9&5FgRksfH|yR=XB#j=!ym zmgCaie@T3ffnX4TcSC>S4&kbQQEOwv$dT)J-&(Kb+(KZ^wyc$K&{!jj;^F4vSI$sd zPtDaxA<{e7*nGS|OZgm~S=uwJOfEg6Un<8p)*&Y6QDQz3nb=r5p=U7?a;o(wL%B3B zAPU9NxglaRd)-N6iZfaaj_SkIwgu9NugxSh(FFcu^_23<8;05O-y<(?;*bHqU)R0V7vw!r^gW$=HuLA)7#(T4DzA0ep{G zUYBz`mG1;!T~xOS$|k*lB2$*teGYmRdu!5f0BF>ieF+_qtp~vrlGoimAGB!K>qljh z6(2_j0h8^`a!75%o8eIrb2VxlsxebfYniqJA?g;ItS;Quc_8Zl{Pq@eh-!|@9;K23ON z&gxSBMz4EKfOJjh@3_oHq!WD$zl17BTy8Ar4A)uh5vUCq7%D-RPSrDd7qaUw(})F{ zDkS22e$*VwkXp{dQ(6jqL9`=p2^A!@KjdIA?r!;}C1%F6XAaxibb80aQrYQ=E;yOs_(AS z^@xK(dP~3slgRPl!3FbHxw(4KBvj<*EDvi+1W^DS#|TpZWnCl;ki_>CkDMOocDTOs zK!?mhc1?k71Fx8kBscT@NJYU8ZMIhjwYbM7YjsU`hv@uyRGyQD7x)85K7C)fHGC?5 cmXZpm*wye+d_GV=5$=Du!2b_1FnC+~H!;aMY5)KL literal 0 HcmV?d00001