From 22529d403210467053ecc3b28e0f3002254c4f3a Mon Sep 17 00:00:00 2001 From: Sean Dague Date: Sun, 21 Jan 2018 03:40:27 -0500 Subject: [PATCH] Add docs for waterfurnace component (#4467) * Add docs for waterfurnace component * address changes from review * add further review comments --- source/_components/waterfurnace.markdown | 68 ++++++++++++++++++ .../images/supported_brands/waterfurnace.png | Bin 0 -> 6985 bytes 2 files changed, 68 insertions(+) create mode 100644 source/_components/waterfurnace.markdown create mode 100644 source/images/supported_brands/waterfurnace.png diff --git a/source/_components/waterfurnace.markdown b/source/_components/waterfurnace.markdown new file mode 100644 index 00000000000..b747ff597a2 --- /dev/null +++ b/source/_components/waterfurnace.markdown @@ -0,0 +1,68 @@ +--- +layout: page +title: "WaterFurnace" +description: "Instructions on how to integrate WaterFurnace Geothermal System into Home Assistant." +date: 2018-01-19 17:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: waterfurnace.png +ha_category: Hub +ha_release: 0.62 +ha_iot_class: "Cloud Polling" +--- + +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 sensors provided include: + - Thermostat Setpoint + - Thermostat Current Temp + - Leaving Air Temp + - Entering Water Loop Temp + - Current Humidity + - Current Humidity Setpoint + - Total system power (in Watts) + - Furnace Mode + +To use Waterfurnace in your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +waterfurnace: + username: you@example.com + password: secr3tpassword + unit: 0123456789AB +``` + +{% configuration %} +username: + description: The email address for your Symphony WaterFurnace account + required: true + type: string +password: + description: The password for your Symphony WaterFurnace account + required: true + type: string +unit: + description: The unit serial number for your WaterFurnace + required: true + type: string +{% endconfiguration %} + + +#### {% linkable_title Limitations %} + +The WebSocket interface used by this module requires active polling, +otherwise the server side shuts down the connection. By default, this +polling is happening every 10 seconds. All sensors are updated during +every polling cycle. + +While this is communicating with a thermostat, geothermal systems +operate most efficiently when setbacks are not used, and the home is +kept at a constant temperature. It remains useful to collect the data +from the system to understand it's performance, but a full climate +interface won't be implemented. diff --git a/source/images/supported_brands/waterfurnace.png b/source/images/supported_brands/waterfurnace.png new file mode 100644 index 0000000000000000000000000000000000000000..0d2f560a1e52e5d1acc3d3d14187a06e789b9da6 GIT binary patch literal 6985 zcmV-P8@A+$P)s^|NoNz|NnKo|Ns6SMxW1dPjG8E000_zNklk8 zyyc0Szs}M=&gkkpsEe+sn;Wb7C#eu*Am$%uO7$V^70LvEB!1sCFJaw_HBWw@A#T>N z(R5u~zoLz3JRxqmuu--3M?~NWajS$~*3qBRA}{{jBzVKVovq1@!cYL74Iu%Ao%es( z*=JH;+_L3EWBTH7nLYVS;vl8H@FZ#{gs0z^J=`bLGT*VD>uI?bNmeVOyY`*SUVN)ZOJ%fek&vKn~i*xL`U*T?eu z!sRXN!aA}krR@Y+pkzx<3AXhMmtksB zfD)^qtbn#fpRlEDE@6=$C|^B;w$&Jv=gVqEWw+jYMt`v;w4Ey}7RNZsj@TBZ?M&HR zP+8e~AG58rohYjXyByzSdw;>UM%!t!bx78+g*yRl@$<8jXHnU4+ah1;4Mf@8dq1<4 z8@8FYpKyLdW%WX~_ifzvtIZrK>)1Bn5kyN!6dwiQOH!Haf$)pLIEMG&LZ_(hus zS3Q$#ZS=b3MJr`=)ic!=zixTaHhgRxI`|?;*^-Cau}za5UlwGx6E&x}QoGD+b@i?4ccTkOxkvJDii zfUBMbw#Kr(RkVh!dY0H`mhFwA&G^{(L0gtBP_%88EVL|8mTkCbb)76?+gP?h(au@* zptkeNmPM-*Wr0Od<47tvJ#K4dfv*TsPLe|_A6*~|EP}kUrKP{8wF#@9*#qSq2vQ7D z8CVD`x3xf!Vu-T!vVg5z1}TOpnX&4bzX&o0DI`PztDeV)j^#2)u^$&`)wAAKFM<^N zaRydB>uuSQ1O3>*vGICaVMj*$@hn+jpv;a8^kZEwi`ur+j?8(5!KZ4S}C+=`CVCcAUlGDVfBEI`{sv?)xRG=AAKMTxTzSX{Mn zTjR^tNm1&^F1~Byw#~^=Oi|_)0g#Yia}%;-8_Q8lQI_t~ZqK}H{ef~0(K1DqkB$YW zQM=D4H?HCQrugA;a+DX5nWFsD&S=H2%O%^;kJ1Vw@<(rwIVJFlcA z?Y9Umuo0R_OIrQ3sugtEH%{9)j>3jfU!S)8!QOqPOLBuy0GTGHAEb5@;_?yFP0d?wJB@0d4(;oPQD-wDrfepsk@j^mBfwTG!9{LC^HR z*fnV}Yx7f2i>l2J)+o?|7PL6gSU+p)Pc-7nPdzPeX}l(_+g{pFpMy*BKc5PHj-H7( zWtn1I{W?tlMSeaLJcb$2?h0#5mO@*joIF8G+oLU6A_MKd+-QHiB}?R>eQR26$`aWw z+6SHm*zJ2D0y#M#}?IoLH&EvDz>Q3u&tu4AGH{^u5vPTik9VE z)OLJ)wKP#!rf7ek4|@MqMnx6 z=MH@^Y^f_-PusbYApJuh9R6s&ENLn&dtyIEM^;*ir_vH1Q4H5=!#rb$912PP{YcP{ zr#iA^w_`c7X~S_#=*J&*Wd8734VIC3SYm_W4}V$|`|-yeS^GsRepE!c|ELM0A2)J8 zd8op6R7HAaYv{+#bS9Zb`J;rwci#x2<*ZMLi|3|i!oXlv=RX@eH46!{Wuwru90g{`g7UQ-sU z)Vi(Z%VLE}T%}0oY4^z1uTZe{G+5_L$-?&fvapp}S^G{l@vsM9+!HU9Rf6nBTduPe z$nNOL^#j)-yWdvo-w1{cYLhKnbu-SFg>6k!cE%_EH=c7W+@_QuyV3SpR=CD5{=h#z zDbHFkWnUr-TM~cyVvK{H&CAs1$adJGF^hq_b>zAbnsH%MCf5D1Ma>w6y93vRsJ-%~xM`*9F)T{9tZ<1_N>_!5Fl8$zZWvZypRg#|@?+d=T@`M@qGSuY zauk+fUW@y1O)o}n0qz8^s|vOAEZ>WP8~dvFYgL%&`mn%_!z`kI#?0K^O#h4orf&xe z+&J$Ai*p$3x&Bs+(nZ0dbWyO^&n-pwfr9-%>OL>+irgP_ynnD$2bc~+K@^7X$sK^e zWdD18@)T5y&_)yAXI3yjrrgn{ zoh4j&I5x!8`#)z7A@0JPt#VED`jbYviVY%*k1d2ONLTiE(MMmI6!Y!?`}eqVJv~7- z^_odK!2SpF+3;vEjw;!B@qRkM{&leTo_!>1y$06XeII1UyX@Zz#rBu+N&=Rebh1u* zZZhnh7EkYY*z~Q@uAvUm7Y06BooyHRjk3sp&|~qQU=OtX-e{9ovz-pXazL#F%G;g6 z9%u;;8yO366d5J}XZL;2CEZ!Nd=^JLgHQEBi_E*g=0IOgeSBeg8 zvI%4Hfp%{Th=ZA50ItXmvdqXb(<1Bb{;~K#%S1c$4O_5WZnF_)8f4>D$#$9@XrHkY z&!KokE@nMKze-jdO7`Y8`vdKhqK$pa7C5AYC^ZUyH5hXlKG`XCpyk%cp(xs+;?^V^ z8+X~zXuLSk?w3PBKu(bOHpmVQPTiAa547CW97;$UwOG{U9El$c#=G8V540d!#OTv+ zUalHa@e#6YztF03iock{i{V+cvtoeuo99rHiq3@HFQdkeuJyz=SrW-T?(;O-f3Jod zHaV0pcSabu+RZd!as`tO{dMH35Lk^MdxfPtF9h!RK-(cLuiZF>kcITh>REMYJylz_ zTh%+eE?-%wL7m+ntzzS?EgtGdBVHRw{#Ma?C3bq? z1oR-|Nzagt_lw>6R@DECXfbR)E&cO&&Ht^U9UvBWfvFJbVd8ABk+m-UGPfXE8x6-k zE@r{OpylpEh1`|>PBq$`=he^eIVfAaZ^q_}U8a@cSpzZ8Ie)s##mFW(t1f1AKiw!= zf#%VUJ)$Ngi_uf`XWb}&a9gfV>4`A6Xd`x_F%?QJEfGAeULk8^g-sG7 zK?NfA!Lw!G#IFJ;)xha~w6lt~xI(lU3esz^cyNL?<5UF~W+mSkle+~WbfN_&3s(ot zhy)@hYjK=!r7tr%&sUKKVV6O|i{_=OH9bQM{tf2>Cb$WAF^fJqwngiq6OG zwUjIegNS(T7%wkykH?JsDg2eHoqK|oSvmF6H_;k>8p#6NhHOu)ONEBWR3|zEo@P(U zN;N1kDru6ik~6t7q}~xP64&>8s@B|!)=+E>c3}D1tZB-&qa|3DvHBWb@*uLv$U5X$ zV4yxDY{uW-l#*OCv}t=KrPrwz%sh?_@@;i?hFOzymNoc>Y*Dfo+`vj~MK&ftF;KE( zkoMGA7NgOrr1h2w!mn&2hrBvN*3pVF20R0{JkN7B8?*xO$|eR>Z}6fM_5j5D%uYZy zA%j?f1{9V+q#7F9IaJ~$wgdDs!#(f5_9Bn|!YT-E9nn(hb31h=TFK=8H+_2T` zp3s?pd{OTf)dE>Wn>kwLpm~KhqhtQ3aU)%rAkaX@q}GUqlMf^#BRe1rE@b2#+oJV$ z!`^CSyXm#6eSZY4+<-RUk2dRQPo%|=m!U+@mHUAgl33`qLVMwa?XHS87L1-f2!{^7 zn(|uJny-PjL&<6{PrHgztfvKj&QM0FqtCNL8VNB&f%lp`&PePpZL@$#Wp&c={Vr{z$fg_Se)1XfFgrL;K!F+j{uP zk39UyU41m{Ym2mY3{rz~uj@GjjJ-+vwrD-yAJAH!Lxs0z(Xw?kgwaO(e96L?SwBP@ zZ3tS*oO;~`gl17)JPY!oHO35Fw3vinY!F)qg#@B~9BnT%l6?wozN^qE^QtQ&lbc1c zT!B7sF*e@Tqn41o_dtu3f4Mo{zm90}nsFZg2#;l#`_L8~1%WZrzXmP1Hd$XDAe$`0 zCB@9y@FL^&@4~jAL}Y*zk5M)~|BWb5edQMA%?dmimmi+X*=S(9@v z7oI>4HO|@OdA#qvcwlGSWYx_;h&GYcJf}4@3tt;j8dqzYrM|;bfu6bxF9v*!r zvy4qw(duMrkq94XJFW9ntjF7L!o!IdOs~jca9Mzd<2Kqixc%*b7Qj8wKx1w}JLZoy ztlVcsx1bgq|(NDo_LU!HRHV-EQoD_<6PdjM^jB+GWMM61IU-i1zD%th%jpWZHL zmjli1TP-82i#isvr(V}F8Hn348wd&m|8e}{%rX1*SXLEkX;hw1+5v|XgOIPuRZICe8ReW zUA#Sv7N`GX#{W9i8!Q%)QwOC+MeXQ%W^g6%?yiUs? zjKZey!7rS=*~W=l9nQv=(#0#N;r(3w0Zf!*H9d{zNBH(U)|2*E>?M; zsNMEusN%4VmCF{``s&@xg}nb#WDkRzTa@LkxcU~@ZA2XpvS08&>RFPgKw(haLG}yT zNq=m-6#io=6&_^2HrtMf+6@q_5Bo|nnSrBEm4|)7e>)wzmZ(n$*{?=dtq}y!^f$5t z`{@Atoi+WtSoo8jIuHN=0002;e{F;aE3T@ls;WvmW|$khuR`&BwwD0F{&)ElJp6>} zP8Ch>n@Ii7k?t*tZGZ#D&in{bRe6gc^Xc|aOoe+~kM3WFXYSh7%O*F-iQ_JW&l4W6 zE!POSI&~(F*C7$QB%f2SM@M+Shs-%MVEl+p25LUc zby$%H!9PQZj_`hqnA4vmdVWKN*vYXShrK&T| zyc5P*K~36Bh>rX_GUM|Bs~94Cqt6A;ZNFfgL7oF>W|;M9KjBhs*4L~Wi38w7X080x zKIA7FlZAXlAK;gF@Zm#80Pr|G`$7%%oT++(`-3}!zYMxECXWRcI0dG z%)M4hod0rMj<-TadZInk6}M##rtf0MxZn{d}L?nZEtzauj7KD>JLqz&|qY&2L zk$)FGLsNUpj_8~tH5~qM&)LICW1pTLr67r1H&e4^?z-t5k+u&rGg1*JEwWm96ZfkM0Tp*527MP-HMwnUYJ}<|wO+HR@qDL5$ZqdY zNb#<`>!H1QKe4wv3+|=h`5&bh8|{+eQIxIiq6=3_z>|Co++bc`+d{w>?B9&2K7*^# zDn2s%g);OQ=^5UH9Hyq7@F zr|m~=lNl$7dqD%kczlx6n}ahp$ow$=xlz?vtWQ0 zg4P^o;@8Ktf@RrG2wY*D(z+d0&&2Sx;X%1?@i3wQ4#B?V$R{QLtY?6>aARHz%%;5X zoP;8wm8yyT^Lu4XCXP|+whY1de z