From 6b7c18a9194805201988d0c26ec388264fb916e6 Mon Sep 17 00:00:00 2001 From: Jesse Hills <3060199+jesserockz@users.noreply.github.com> Date: Sun, 12 Jul 2020 08:50:17 +1200 Subject: [PATCH] Split the Tuya component documentation (#631) * Split the Tuya component documentation * Optimize image Co-authored-by: Guillermo Ruffino --- components/fan/tuya.rst | 33 ++------------------ components/light/tuya.rst | 32 ++------------------ components/tuya.rst | 62 ++++++++++++++++++++++++++++++++++++++ images/tuya.png | Bin 0 -> 8266 bytes index.rst | 1 + 5 files changed, 68 insertions(+), 60 deletions(-) create mode 100644 components/tuya.rst create mode 100644 images/tuya.png diff --git a/components/fan/tuya.rst b/components/fan/tuya.rst index 186dfb770..65bb611ae 100644 --- a/components/fan/tuya.rst +++ b/components/fan/tuya.rst @@ -6,7 +6,7 @@ Tuya Fan :image: fan.svg The ``tuya`` fan platform creates a variable speed fan from a -tuya serial component. +tuya component. .. figure:: images/tuyafan.jpg :align: center @@ -14,35 +14,7 @@ tuya serial component. A Tuya based fan controller wall plate. -There are two components, the Tuya bus and the fan that uses it. The ``tuya`` -component requires a :ref:`UART bus ` to be configured. Put the ``tuya`` component in -the config and it will list the possible devices for you in the config log. - -.. code-block:: yaml - - # Example configuration entry - # Make sure your wifi will connect - wifi: - ssid: "ssid" - password: "password" - - # Make sure logging is not using the serial port - logger: - baud_rate: 0 - - # Enable Home Assistant API - api: - - # Make sure you can upload new firmware OTA - ota: - - uart: - rx_pin: GPIO3 - tx_pin: GPIO1 - baud_rate: 9600 - - # Register the Tuya MCU connection - tuya: +The Tuya fan requires a :doc:`/components/tuya` to be configured. Here is an example output for a Tuya fan controller: @@ -93,6 +65,7 @@ Configuration variables: See Also -------- +- :doc:`/components/tuya` - :doc:`/components/fan/index` - :apiref:`tuya/fan/tuya_fan.h` - :ghedit:`Edit` diff --git a/components/light/tuya.rst b/components/light/tuya.rst index db61d388d..e39a38a40 100644 --- a/components/light/tuya.rst +++ b/components/light/tuya.rst @@ -16,36 +16,7 @@ tuya serial component. The dimmer switch I got would hang if the logger was configured to use the serial port which meant it was bricked until I cut it open. -There are two components, the Tuya bus and the dimmer that uses it. The ``tuya`` -component requires a :ref:`UART bus ` to be configured. Put the ``tuya`` component in -the config and it will list the possible devices for you in the config log. - -.. code-block:: yaml - - # Example configuration entry - # Make sure your wifi will connect - wifi: - ssid: "ssid" - password: "password" - - # Make sure logging is not using the serial port - logger: - baud_rate: 0 - - # Enable Home Assistant API - api: - - # Make sure you can upload new firmware OTA - ota: - - # My dimmer used the hardware serial port on the alternate pins - uart: - rx_pin: GPIO13 - tx_pin: GPIO15 - baud_rate: 9600 - - # Register the Tuya MCU connection - tuya: +The Tuya dimmer requires a :doc:`/components/tuya` to be configured. Here is an example output for a Tuya dimmer: @@ -92,6 +63,7 @@ Configuration variables: See Also -------- +- :doc:`/components/tuya` - :doc:`/components/light/index` - :apiref:`tuya/light/tuya_light.h` - :ghedit:`Edit` diff --git a/components/tuya.rst b/components/tuya.rst new file mode 100644 index 000000000..8826b8281 --- /dev/null +++ b/components/tuya.rst @@ -0,0 +1,62 @@ +Tuya MCU +======== + +.. seo:: + :description: Instructions for setting up the Tuya component. + :image: tuya.png + +The ``tuya`` component creates a serial connection to the Tuya MCU for platforms to use. + +.. figure:: /images/tuya.png + :align: center + :width: 40% + +The ``tuya`` serial component requires a :ref:`UART bus ` to be configured. +Put the ``tuya`` component in the config and it will list the possible devices for you in the config log. + +.. code-block:: yaml + + # Example configuration entry + # Make sure your wifi will connect + wifi: + ssid: "ssid" + password: "password" + + # Make sure logging is not using the serial port + logger: + baud_rate: 0 + + # Enable Home Assistant API + api: + + # Make sure you can upload new firmware OTA + ota: + + uart: + rx_pin: GPIO3 + tx_pin: GPIO1 + baud_rate: 9600 + + # Register the Tuya MCU connection + tuya: + +Here is an example output for a Tuya fan controller: + +.. code-block:: text + + [12:39:45][C][tuya:023]: Tuya: + [12:39:45][C][tuya:032]: Datapoint 1: switch (value: ON) + [12:39:45][C][tuya:036]: Datapoint 3: enum (value: 1) + [12:39:45][C][tuya:036]: Datapoint 6: enum (value: 0) + [12:39:45][C][tuya:034]: Datapoint 7: int value (value: 0) + [12:39:45][C][tuya:032]: Datapoint 9: switch (value: OFF) + [12:39:45][C][tuya:046]: Product: '{"p":"hqq73kftvzh8c92u","v":"1.0.0","m":0}' + + +See Also +-------- + +- :doc:`/components/fan/tuya` +- :doc:`/components/light/tuya` +- :apiref:`tuya/tuya.h` +- :ghedit:`Edit` diff --git a/images/tuya.png b/images/tuya.png new file mode 100644 index 0000000000000000000000000000000000000000..72a6f2bb038ab4de16faa51eeacc214e29eeae73 GIT binary patch literal 8266 zcmXY#1ymfr*M=90Y;kX)6qZ79mtsX0Deex1;_gsf7uVua+})*6thhVHr7Z5w;`{CI zJO4RP-rSkwCYdC2=AJ|-D@tKwkYNA-0Bjj)2~_|9DGp)J0AC?gE!3O^k)c?C6~F*M zU98WeN+RMOWFoDq004yH0szs7^o(!{6a@f$Jpq7&C;;H|4gf$p=JGkj9RR>!vl16q zmJt^RDLXruTiKcc0Mdh5Demg(3nXEa9qwLv8DP!{R5?vAh^;@rFtg-F!Zf&*H%$LuJ8VX;s{Y;D-_sK6 z8Sw_FY8M^D#l;oVLY@-elG}CUFYtuzdm%)9;ntNJb~+MahLMQk>a?cKAj2RgEF_dX z44uM;f9`|xo!4AxlMO}eob!KHktnqsX=&$EY4fzL4#?;!aPfqfMZnpQm2@+0;^}X4 z06Zf=>9t(s?LFaud^{uqPvzB{jmO;}TvTYrn__`FK3ERw^JBGR#9jPE%p>_8!CQHY z*Y~7RHc*?_Qvm=PB;ui0#JNbWfmH0TH2;wBA@kNE-vt`t;mjkGgrg4!;Btal7qKuz z@fT5VA+pM^4#CuxNOYp;eAui3qyGe2UY`b_8=^!9?HQuABVFO47*TOb1a4DlNMmva zjDgThaa+N{${->fNpUAUTmrGyDUwnkV+doOZYll)i2$m8K(*MbDIrUupAf&0^+68l{**5d2i(4b8oNAgUxy+8NoiY>_1K|i`r&Qb3Ke9$QZb9x(qqTxVn6>%(l zG$`bb3SXMJN9q$OM4DeUtP!Ly&E||r3NDU!r^kwfQVvTifU} z$7UMJn1DRTE})p$g@P-9w0F$7PTR8*X&&b&%*+^d5&78fnB$oL801F&NFvo&1|4%e zZ2^+wriL*M@@!5((VPfdJlly3Fdc$my$u&jcLY8{otXZwL}GL3qzPStZo!6P$VOaw zkSVbi2@h!xNg9H`5%Yb352-B?+ThQM?PBB~JE@1`u4PyYr4!;B6J3K{vt55&N6ORM zB)%WUH%0QKYmN7be@c7OgnTff+5Fg@vPiG;ahjEb{z8m^t?c6gO{*rSRQ=b>!fotf zD~9%@=A(p!1TbN2&0u?fLCFSyy zrxd3`EzeTv*_?EHbm~oHMiaU}x;RHV$2ya@inVIC3Ob+d99-I8MqIY-2yRm{pUne6c&ojK&JXHIsp{a7Ktf;YGRKdQrd|HDq{zCUGofS9qoPQsR%T8_m69-iwCrHbI8rsG1GCzMb=SZ_qu1PFa2zF_w%0dR{i=;I}`M9Q+I#) zjCP9zs(Em`sJ|vO(Xr$^(A#5@HR!3-Sn_Mne$t4|j4eg0U||fSg7`@5+9R<&sGX@J z=WhS;-1oPS(FSp+w-06YobIsR(kA*-`_t{6(B;B~(iL17K=_YRnfRQ0ikqFcmN%S$ zh7LCfFr-Cip?a zN)z(2iFPZYAW`YU)FYxjn`~$2RynhfQXu$AiZsGW>_QhMC5_J3iXVX>~fk6hGBfQRro0(qP=7_O96e`fDp? zw`YI0Vbo~?k5vje?y-@imE4h}jMV90=;VAZhgO7S)d@bzG0Wkc_8db`$d*rPA1%vV ztrQOyDK>;o%&zNu>KD8VZVgzzX&N;As8wolDC{Z8cj?-F(SHP{is`I-L{7SV=d3o0I@8V+NocatFFJ?wbtRzL-easPW7E35gQ&r=9{?@;i^ScIzg0A-ho4)yv zG+U;l?z$Tqzf_hnR`PC-Z_{J%V&f;yCj!-&6u-MKxi$GZTtCOpT9;Hz3}rL$%kgFS zyKR1*XkEH0+bdz~(|>yud+6ur^tXRS2ubKUwVh4B_1N#;xJK=)mB~#@@mo`?*CE-K z?%?;)qZ3~eUpo=)r>S{|r47H{!!LUZM;ZFBM$sp51h5QRcD#-*?P^vQ&MMov*oin@ z-T9n7wpkxfw>t{G+0HChbNp)$s2+?qsmr8xek4;YJeR^uj>30_(p46wJL$km6w!49 z+3=*7*|3YJlI@Zm!g9ixMDxUwlGPG>VZCSDC(pyH`vXW$k$<&c-XpZ_8@c~Mh7J$c zO9I?^a{;P#SrglCaQoYP-v9O@W1IKNCB$K8gTi;vW8qQw__@z#7yURa@`o2?o3N+9 zS4&)b?fE-c@YN$P3Ihcq%)C;TSC@qUcfsH=1ZVIw1iSFFb@(oVdH6bl3HW+He0~Bx zkI)YI1cD~mL=(IpK^45e2!_xO1V!+UOc+9>}{0u%=8{Qxd!iK{UK77>3ZIV0e)? ztSA^(x{ z06=&!^DE-@Upq?cxBvjG)c++Uk0KE_#6v1qNo`kgXEP&LD+ha!x|N+7fRmk*U4Wfe zfP(|X!7IScBf!m_?R>Ec01)ZONPyKn3{J9qT|WFu8Q@6kSMKH8W=*cO+0diOUWWWm zT?$z(A~3f&!NVe56@Gjc8FvfXPjRIvE3*Id_WF^I^!IoaMMoxY8B?Gr2oH#Y{J#uI zs#>sv^3`MB!gKXnrIzF<3ADVc@DGKj@4d?f->Ey9R({BH3)!Fp{vz8uqxmbR8Y$W!Err(c3o+!8=vZL za_9H2OXTQOq7yao3PD8AFXu?fk8}26Q43F+F<2^9AZaQ~9_x$>pYp5&fg1gTs1_Y+ zplYyXoYuxH`Hqa3hdwTZ$k47ap5|xb&~o!Ny}kNt$elQD{)O}Y*hvf~H9Z*5U$dH+ zrYX-ZZc2T%7!Tzl)DPcoPt@JaYJ-Q-8Vlkf4yRh42+5#xdDUCS283cii#KKwE^wJ( z&XQ|Sfbkp*1%H+)#wbK*_JYDi;;kw4e+hIvK0dCWVB?f$5QAMb@%kur3*)=3A7@j| z8nN#>J3mi8lnT_{_D>C6)11ZuAw&VYE3LccwaU~H64QjGt~D9AK9#M#lqd|ylCzJe z&#u_e-x3u_iG@uhT0Ek6G(gqp6Pl2`j}_Ogy|5YOuak&{1mu?qzu63VAM6tZLJv&& zl^=*2liZSDZyKtDx6MAK%M{j|VMDEnM})#pq#I~V9O`%A?Zp2P=*<4%Z!m;K0S2{} z#Vcff=YmP9->BK%$3$elZLX;Tp5kp04Nqz4)`vCE9{t#hpZ|dH#(jPH4QedQ0jB?{ z^re8U0&^jFK2b5Hvb(-7u|WTtZy-|`#GVrnS~-NDk`Kigyjj+?Q~5uAv)WBtt) z8M+aP)bU1T-mqBXx_%?k^q%oXF008Bq$^s&vNLT(Yp@E~W!^3K#_UO8O!ev{B!z*S ziWco@+&5x9RPx(FOuo7EPD#5@97KBqt_}TSq*6B`{S~A|s7U=1yUZ^-y#*Acy^S)K ztToH4yv%Gsks1@%JjnUiFOjaynFPX5J^=7t_Ijn@R}v<*G};sX;Ho1U=e?y( zWgKFXRNCsAd|5@&Er>Ao`{Y(!qpG=J+UaElHfWkN9Yd8;YOZs?=yH*auW4H_`}R4R zp{O0S`p~J|kecU(QdUOoV89muirj1MS5I~K9BLT+F-QrU>P5*cLB{S zVOD-hYj8SpR!(>)7!>&u_w^>@&4u*{5(*f+<6>eWweuohbfVYxW+(F>(%3qW9J2c4 z!}Xm+*v;V&`18Zf(Gx#EfA6KqflR&QEdGZ_s`s}G{V2nosC9-8Ma|ruA@@gn?!2f+ zCyzdC$=mUS1#NBx%?I~dO#@-;|E9l6=gRA}HJ7w{Pz9DSMgqk~C*8At=-GGQqn_wF zsq8iLN)*t!<)=iUmXi-o9a-0DZ_YB_-W!k&yI`N%-%VDz57H`VsvZ?rKSY_LIpKDH z!_$T7yCc0Scej0-%HJs0*Lb&9=4;XspxNv8T&~+CDMdZy12eFeCl#wI7FljDzmn}~ zDMqzQ>ZQ@Uj~pt?{8?R%#d3CIj5nZx>*MJ~H2%FLI%IM<^x8&Pr|%9U|HOe=LaSX1 zxlB(-UNFkdvP4#&$u9Tr1ms>cP&neyD4_}o4B%M1+@Fu#(XowsoX5D4v}r|znx#G zR{x~TvmbpWJ+Ozvt^b8}@@sr6V>;Un(RNqA{>~7J(TZAS6wp%Q;OKH`juGf^fbQo# z0lp7Ui1fhdiQK`A|B|1K5zW$^Kw%$qCpaQa*}dnRk&NtRYYv7FGqZbBfPNvS4MPe2zX40Y?}jf0%a+Z$ z*cpSCxJWwZB-_dPP8s7kv2)8g-?m|?E}GP(CX^+W@n8 zg@}G-0lh9;@vcR|n{}EkHt7$;&{13T9M{u+;)zrX7V<-#dSj+zG**H|we&#MNvJC1 z!U%O^GGE`2{pHNd`X`(4&M)f1a1h6ZJHDfm@ufeMK0(Ei|b5`Cwh4gEbA96HYHo5W)P zB~t08H?aag9n)a5JA96k!+S9*^R>dRaCA-~_ZVnGKUDnSY@Lg(tiGtB}RP*Ig`Kb>Sh~t-9oQ`>*e4_G@!|MlgD+@O@OtBp9G8s*C9j{4szcc3-*MQI)>a-Ha9>(puh3 zV=MT}2nO`sj9P9D)PeJOB6FwrYtI3}zX&wdOZ>_i{x5`ldxgL87TW2Vfc_~FgT`p8 z_1P0&d9c-yDf`KW;X12H@htp?G`d|{SilD2DE1WM;K^n;K^dgJC}C~X%|nazrW|nz ze?nd}(?`?pSsdE}79@>#+t1jAg`n%>HzpcL5F%JLi!jEYlx|evVxfc_z!!~_ii_Mz zP_|nFhKHuI`Jtn7u+Vd@khxt`7|#OQwW1|2@F_|9=P6HKIy2qw941|Qy3Q>ioRW}$g9VZoUR6yzVPzo# zF3|cp@94J`TL6335(*Nl0*Mho*r0P3yLiJNW-Z(OA{9QFKOq(V9s9ll@j-RG2lh535K!XO?^CJqi${5--U zD$?XCNfbP8O}_17fI{McvrW-Z9U!adoPjEBD;Gz~zyS1WZu34QkoO>YMcA0gP1ags zuM^Sjk-*jB^U(XFHy#P{wAM;RGlGE(srbtRPzU@f(LyQlSRS!b(Of1nS~6`b>St3! zP+Bo5M9CmNS{?6gRM`>>OILJJJfcs?i3DYwW|ywT1`x*Y2Ao>bC@mL%k5p>$r{ww1YndimQ3=aepSvvN z@@Oz}+d-uYObfBS#7kVstbFQHLakD{l?}BPjjb(~_HxQ!c*tQKH-QJ|eCKcOsfawyMFP%(GuSDY?%Wjt^Nz2&e!m3Ci;hWEDXF2D4`YuI*uItIxM@4!T&gcP>On1g z$yiV#XqwGt7(_@ z%4Ce51w7bT*;pq^UX#?uoOc1tX-UCkAjF*B`4pfSJ^hPZkV>E4W4}<@&)Naf_ib$r zbLs?F*E8K}o*HVUDvz&5Wq)nhggk5XC)AUJ+QuK!XVSN{Z+g{~^MQ9Bgdc;+V9eZC zlx{~QBc5;_HlJ`u9{cr{PI@(cjDv{S!0s^5yvR;b);8ClL`Q1udrsp71tf2F#FlG3 zUY#=R--Ix#XHl7+8YqX=!g{D>)c0dHhk6t&nT2K<*AKsKdPu8_#N4@JUz)&_~1!tNAGAXVq zH1=ou(xW_MOdqOCyjn-%62}-N~wzcULhVo({DuP8+Hnp_Z1TOaZ$Whl`NNNC{6lAVB=tvh={fs zutJ z?JTStVNod&2K8z2*Bca|q4c{${wS}uscH5wbfB|WiWF7l%8LEK)92(_z-wn(2K=jo zw^h?J6PoYhKo*=9q@UFO{#M(;hti=DYzK3W73F@@KJIvV-fy+dS}+QPNQZsyvawtr zN0X^qdO!9w610I#kLV+`?nC2S*xA`*(Db#{eS)d85(V>+XUm7zE74vMkIlJm2$7&N zS1mdgBy$qa)8Q=&e@^?RcQ1`}x7}G_eHsdXV%phbFMarCz`>tD4h&VRP?;kZc1+cS z2tDM%z7IoI8rS+5pTOmN1Yl34MU=9+o*qBfN{IU5p4$GSK`kZ$5x)RGB-8X@MkkR@ zy2y*-Bkoz~S1@Dp<7^d>Pn;a3tWjwW4VU>URWaN0+im7LB20Is1hez zbaW|QCTgWw4N))epo5FAA!i4m_olTT$~Q~ZqvC{~6?`CrWzf|`bm1Jo?+PQfv%IE_ z8aLVR(?hup-%`}bvToo_8`p|g4<%VdXM)p}nW`U+udF}!8uF2&-u`jqYj;`Jq5R+R eAN`l2OZXtB;x)KD!5?uV36POgl&BUng!~_*iu2L{ literal 0 HcmV?d00001 diff --git a/index.rst b/index.rst index 06eff1e18..2a68faee5 100644 --- a/index.rst +++ b/index.rst @@ -343,6 +343,7 @@ Misc Components Debug Component, components/debug, bug-report.svg TM1651 Battery Display, components/tm1651, tm1651_battery_display.jpg RF Bridge, components/rf_bridge, rf_bridge.jpg + Tuya MCU, components/tuya, tuya.png Additional Custom Components ----------------------------