From fd58a833d20fa2f7895ebfa4a224f5dfa0b32c13 Mon Sep 17 00:00:00 2001 From: buxtronix Date: Mon, 5 Jul 2021 09:59:18 +1000 Subject: [PATCH] Anova component docs (#1140) Co-authored-by: Jesse Hills <3060199+jesserockz@users.noreply.github.com> --- components/climate/anova.rst | 53 +++++++++++++++++++++++++++++++++++ images/anova.png | Bin 0 -> 6194 bytes index.rst | 1 + 3 files changed, 54 insertions(+) create mode 100644 components/climate/anova.rst create mode 100644 images/anova.png diff --git a/components/climate/anova.rst b/components/climate/anova.rst new file mode 100644 index 000000000..e907479d1 --- /dev/null +++ b/components/climate/anova.rst @@ -0,0 +1,53 @@ +Anova Cooker +============= + +.. seo:: + :description: Instructions for setting up an Anova sous-vide cooker. + :image: anova.png + +The ``anova`` climate platform creates a climate device which can be used +to control a BLE Anova sous-vide stick. Whilst not strictly a climate +device, the concept of keeping something to a set temperature applies +equally here. + +This component supports the following functionality: + +- Turn the stick on or off +- Set the desired temperature +- Show the current temperature + +The timer is not currently supported, you can use automations to achieve +similar functionality. + +This platform uses the BLE peripheral on an ESP32, so you also need to enable +this component. Please see the BLE Client docs for how to discover the MAC +address of your Anova device. +You cannot use the Anova app over BLE whilst this component is connected, you +should disconnect it first. To setup a (dis-)connect switch, see :doc:`/components/switch/ble_client`. + +.. code-block:: yaml + + ble_client: + - mac_address: 11:22:33:aa:bb:cc + id: my_anova + + climate: + - platform: anova + name: "My Anova stick" + ble_client_id: my_anova + +Configuration variables: +------------------------ + +- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. +- **name** (**Required**, string): The name of the climate device. +- **ble_client_id** (**Required**, :ref:`config-id`): The ID of the BLE Client. +- All other options from :ref:`Climate `. + +See Also +-------- + +- :doc:`/components/ble_client` +- :doc:`/components/climate/index` +- :apiref:`anova/anova.h` +- :ghedit:`Edit` diff --git a/images/anova.png b/images/anova.png new file mode 100644 index 0000000000000000000000000000000000000000..87ac67c7472eb83593de0300bbd1a1b6b80c94b2 GIT binary patch literal 6194 zcmb_g^;Z<$)7}LnTpDE+kXWUcmXKOfsYOJVF6r)Ofki}8x*L^Rkd!5)y9K3NL27}e zJHCAWhW9=9%$_2}-B$U_;fNVG}}A|iSc>+{wpj> z=oE%%`Yfu4cXHC9A9!SCFfMW*ntItJY5z!JydT_a&vTGv=I@6t9Qy}(AZ!k-8qxlZ z)*4v&f!-0@Q+}oz!3$8ilYG7a>(DT8L9%H0y zA^12WGgH16Ui91Y)0{>pUjTu#L0bLchL&MbJ+Bh9!PAPm;C09 z@T2=391_XD$F+Q-B2*D3gu($E7JIymPQh)rA2y4do3lqo)C=L6YoIVG)V0FuVL3Ji z=!O3=sip-zi;qkiwp!xvX(DVQmBfjS^k{K)|Lu-?ENu6{I@?n_H=xU`YDcT~4I-An z@4{wsv(brrFC5$W@Ul-emABx>4+$2?C-lW|OOFmhM`1SjQuRy(s{dW7DX{4DWgeQY z28w;Wyk1*di&!rOnwu{AOwqiV$qi=IQ6S3t8ub!0ponWS2-QQCkK97IJsgy@&-lD0z1Bx5AVkhF~Ya8HvTiAq9xg8!J_VD!FdD7Mdm;-*A2rnVM zkFR>b8Y@}@Bk$c`Nc3n=6HlKA=4I>vn12YDOi?d-b)NB#8IK38e{_0`ow`&L>U!k< zWbdizB{14tHwR^47M*S$9RYS1)+`y1f*jNrbzgQEw^ga8K&w)C3??i3ADb(&C6?({ zeWp!&cqW)~998{XM#NuPsogt6z^Z;l3{jAa7OET>q{xTwSGC!`OAnvVR0ixW4KbUF zBCg@$*^Fcw%1k`W#lP5df^K~E_4WUv{Wx71Lx_OofRSC*`UT|SaHx~4M%>1gE>y(r zV732Yx}ml8`g7(!j~}ebD%ZkL^Yfiwn@2WO=kNMTwn?(?Ybb-?wLR9g^6#o>D3O6H zVPe0`2zl(Q%Uh5Y&%EO&K4wNZiuP=ePfz!$@-;s%rt`Tt+6?b&hq!U(l0%h>e*ZXq znMK2W>~%#YIE0Y{(>5h;B6%-H1+J)fE3A@TuBQ@c}|(*Q@ho_yX`e#MYfik3#^V|;Q2oUh0@Wz zIgE1A?_6L{GS>r@b8h@Z?K0grb90QlUzHP)JWYf?tV+7{=IZq;F%o_c3EzFM5GWk+ zT&Uq}IgPf|6J<;6kIg|I^p6JkJB{B@~Jhz zIGmFo<@m0?3SHShOJ=!fq~3Tf*BjAx19Z%BH#!xd`cv6S4%)74ZhrE!V-2ARux)!UpiaE; zSyh3z+R*7!F2H{&t8AJir0@x=I^E(_q)sE(>eEsd4V>dW#CUE$v<=2wizX8!bvvS^@xA) zz{|km!p-e!f3vvssaJ^tYefGDWVrJ3Pbnw?s>ro~t&*YvM)t)1N{>xVIyySz=-!n? z#b+GE2oK{N+8ZT>_YUSjUf$;hcT+I8NGTyYtQEiRf!$=>lDWjs_Y9M<|1Mo?Z3^v3 zp*0Uaypuuae*FQ)wY*@I5&A-y85~w>C!Vd&g!$xaAWY*&ue=DB)|{9F{s#j2VT}4G zl6Re~Jv=iyy2n*1xE#L_H5=RitVD~;T5nRHYUa`CRDMrdCs4cG@Uhqw1|t$Jkb=%( z?0^N#x@NJ1gzfu0XYkJgVX5BH0&7DmztxTdOp~9rKNe_r^^Jc4Nbs{BMO21IYfeaf z63E?W-MRyTQY$%s{W4x=u|vT#1hnMRNtSC&I62rH zlo=5`LN43bdXMu4I4-4;S@z}dx(D5znTdi?Lkh;8e!sj@i1m>)o^Z%?5HSFcuJTZw zS0ZG@$<$C(w0^mYU!wT0)KU)|sYFROg$I_A=3IX} z*e19j!N*J|srpAheWC$4Uub&sPa_+AYiA77VfA4I$4>>jqrh^~hh)q<>rLd4`8X@X z7cIWUA++7guZpo)tY}1^Bg@)Wu^rso+dFrSM}{|5l{%|_Utf~3weu9$*>)O_@Kg_9 z6D`y%0iz~@$H`xvg^3Q#;L64EornE%z_5GsQcSUZq*dXUABd@ijsyZ<{baB3J%xp|)Fla~4-uHE$uQvn-lcXN9~=IBq!(Myaz_T!y%d|j-?U}B z1M}V0iF+o^ldX=^F2U)aGfy_1u`q`b#o1H1WDaf2AMIne#1F>C&3;P(sF%t_s%kNq z1eF3~f)PFz)bH)aU5ng}i^R0spOJWMja&+c74+sY+i>P`y_&+82zJV*&VBCXPn8`4 z@k(ddpl9cJq_RrAW&++5XhaKT3ok)413AO^UD)w99^H?0*V#vXNkDGB!7*f}%hnMT z0nE<*)=CM1i0 zP-GA{^YAqo4i0jjuKeS&+=sG;0Vc&`Xc~DFgCbQBKk>XsZ31C?^GTd<#V)sN_L1Ax z@&q*+6D4G1WKE}w{<#pcEcf8;k+u)06g?MQe3WSOdDZ0Ng@J^|6`&HEBjdd;?WT-D ze^|S$!8n?*L%?B3D7oQ3Yx_{Lj4ST;YD~iXU&@Sq`#`f-{{9koywLLe;Gb|?|7sNI zL1$1@pL|Y((LiHRyXS)Wd)qXLJH~d2k!}gUf+$F?D3}km1j1`%txcQ7KN=?Bui6I} zhIK7k4^<7qHYF}^w`khiq4y$mq++Z1cZM-Lv@l&NJP9BuT7b1cK42h3_n|yj^1-qX8b;F7~JD=`Ocezf)0Z<+k*(T>i|+xBfpB zjCAX`QM_d(TxooyzRl3jY3=mX&gXGhiC^e3_P>*5{331Myz6Ly~&1Z0RlHJMt)lF(^$KczcPqTd1_LTp5La20T4$Lt$u|;SNlCF+1bow_idq<}H2bBzX zTq`>wz;;(`BopFBSIM&a<<;@gks*$CL1*woIZGb3A}lWN{(29He0+(xiD~qzv@?w2 zwh`M11C1T4%wd)|yOB8}j&wa~&05F)vT`EvN<+a{B^8Uyms{uyf^&vVvqzu6M?0IF zk9`PJ(gTefC7!y(vwG22WlVkN{5V89om^#yK@rZt@EU~1w=1*Na4$2l=z+FC@jP#i z%N<>)mlkoyA-n*GwhPj9ey{mB?CmODyqiWGLL_?mdNScp>h~(gOHR3Yr7GXUH3USE zZO=T)5JAhcez+VmJFjPAa(h6+o<-@iHHg`1#j7Lo&;vya^^o$NKG2&XEjzq+tE!Sh zGO?lvQw2M=;`JK%-^;R`Qnq*Zo|vijmH-6JP46%H-Wy31v>dR9xJh=$&OQuWpLK(8 zRGIfWk?;$_xFJuuuXAqp9=u5U`%fh`6kE~C_;Z}B)8nb!_l7~w1z4&+uSjD5_Gh$p znCWs5QT@@czw7MxhyK+1r0aLjLk~plNul_IYORK4{)Dn5|IDON<5Ew-DH(G)tS_bc zUzGJVE%DXe9*#)-yv;c+*#bRGJ8+}wPu4$|Llk|iG@UHjI^6WgFpuGEfg8pVAC-km zQZpmNfGeK_g#VQp-6EHLx7AwGbgRrv^pbv9tgVfPF(2QLE1@43l6}9M`Xa^fRGO3@ z3Asx>??G7YhWxds(1EM7#wuA}5sub7vM zQ7?n6renNQ$8qYuI_$aAEWmc?lZe6oSuHS=4ciHvzt?pZalB<`YfABx;7a2V>6Xoh{by*v^jFrZe4U3-`S7Jk2e=TfmE=A3kqgQhE7-KS}z zIX*tl$9kUcILrmkSC{2Ej{RvNF;QveO#;I$XIccS(BU z&ptT)@++#Jsh#WdzlDAqOaXPFLy5jvwz~UoxaipQ^x0eUAsbUo;U4OE33&_VosGs_ zaq}UjJ}`ffqJlKB#0T^)F)|)0d$}M#f?bq*&qKtmU6xl`S~^!U<@gfSdbX=Q zEfL*}kvE!p0%rbd_*%??!&CF-x-G?W*wyGX7`0ZTZ(sl(pPEY5s`?BigH8cxf5`GO z+jq~(eRiTkmGge%DrzlwRGb!V^^)R?47q%52fe?K^O zb_O{Ye*;1s&&CCDqt0cdfT3IWhpp!@x!X9=ro9f3a)BlqZ6B;T7|XTyVMXjG?SGUV z$@IPscFP87<@#RV(Gd$3eg0gMgW5v5+MYL6qHf$(#mdxZ3^( zUR;ez>>HazSTkkB6JudsTc6C}m-6!R`I|zYmUluD)NJ@nCs`n%vj?&Yytvr&d5|&w zE=NePfeOpj9V?ifoi$tKn*&8U!A$2)aG(`NR>cYF7PGY?mW*42l9i;PHaAyxzw2o+ zr@eXk=6!>IRDDpsUs85O{voxMNZH{HkIKdK>#wAN@Vw*Pjd z)bZiR_2bCt5dL-dn`Cb;hFi7y!$ViZD)3X2OjUG1&cL^hbBmgrG1#rGNqoMPy}o3C z{bU)ZEyI*2dwn^*7Vn94udDIVx3U}NcqOF5O})cdS`weu78YA)hl}K|6#4i2q32+Q z49Od9zShlaS3iq%tJyM!i$Sq)f0)g_gtXChq?Ol|II7T_>A}E>bNOlco>-`hH)-fd zs29V!*8y0!RX}Oz@|EdloV&LE89d{;Ey#r)*s#KA?8>n2gxX)}4P)%(Ml!8cpEJqd zIyLUatFakT`J%4gbeWx13#<{N?!==30sfR!yE(T>f>8nBmW9;kpIgEa17!}<+Bd+; z&u8`es=bBJP}4!?l^ShbuM>ZIlFj2&dc+KDn1HI+mn z!wVs#P$5iSl-D=bpdfhLNusBe(C*w&+yH;&&>}cP=O3uF% zA#AM7=45Nz?wUo^_sT0O*{e!Rc+Y$W(=2SdDmD_biX~-IZ2`=$5Fms&7np*WbSZ`a zF}2XrG1shhT3$mX@$7P4%Wga#MR#|hehat6a011{C93$^(ETvxGpkDU2-(;b9g0Ps zE0Hj#-y%)Yx7yD&gn4Qu><(2sv6#^ejR$pJkc`ru%-}M{`LkTb7I=5n^$FkTgy%DK z=LWYFysJC%x}dI$gX)C|!h2&!Z?L+$N_TrgMSY4d!Afs(p&YxbdNUe)k{@79!u{yi z=5zEGlQZ&pwmNK=HDNrWkAtcNA38Nm1T?RjW`B+p$y7x6OF3EVrLa+x)Ya6~$Sa7T z?drmhrZGDgR!)wNJc;bD%Of-ROw+jgn9guKQ?u0Zr_e#aA4vfwC`76D#D7e==-25c z4^@0wc#{_8-j?W9?V}fNt2B4tNJ(A90?t=EkolMcH0-|2O$N$oGmV Y{D*S_?X_~yow^TDR#aCgmot6;Kb;H@MF0Q* literal 0 HcmV?d00001 diff --git a/index.rst b/index.rst index 298369206..3b2593fe3 100644 --- a/index.rst +++ b/index.rst @@ -398,6 +398,7 @@ Climate Components IR Remote Climate, components/climate/ir_climate, air-conditioner-ir.svg Tuya Climate, components/climate/tuya, tuya.png Midea Air Conditioner, components/climate/midea_ac, midea.svg + Anova Cooker, components/climate/anova, anova.png Misc Components ---------------