From ba42c46cb3634066247683616ca1306f899a3b41 Mon Sep 17 00:00:00 2001 From: krzychb Date: Fri, 1 Sep 2017 23:39:27 +0200 Subject: [PATCH] Touch Pad driver overview --- components/driver/include/driver/touch_pad.h | 33 +++-- .../touch_pad-measurement-parameters.jpg | Bin 0 -> 29098 bytes docs/api-reference/peripherals/index.rst | 2 +- docs/api-reference/peripherals/touch_pad.rst | 130 +++++++++++++++++- 4 files changed, 146 insertions(+), 19 deletions(-) create mode 100644 docs/_static/touch_pad-measurement-parameters.jpg diff --git a/components/driver/include/driver/touch_pad.h b/components/driver/include/driver/touch_pad.h index 548edbcf5..cc8f85204 100644 --- a/components/driver/include/driver/touch_pad.h +++ b/components/driver/include/driver/touch_pad.h @@ -101,11 +101,11 @@ typedef enum { typedef intr_handle_t touch_isr_handle_t; -#define TOUCH_PAD_SLEEP_CYCLE_DEFAULT (0x1000) /*!N$xJem%o)BdecJ?p<)!7M0YD%SU<~;IzO4cz0PwJ|aIi4& zaBy%42=Iu=SSZLyNXYmYm}pqU1f(Ry1Vlt+R4lY)6ik#vM07m#Oss62oSdYzd_uhJ zf-D@I?Ds-|2nYzsNXU37D0uATMC9!M@%612fDRAbgn9)9qyT`>fl%ncZ~Xv501yBL zu@(sUbwR_xLV4fjIyGa6KgX3m5!3WzyeE0zrQRB<3`vt_*QwUm*ejmI6(%zWMl90ah!(JnR1k zxP8$07GlM(Yr^`#EM&!Bs#uwWVTPcDdZ;G#fj`M%<>;Pv?@o?L@sLkwUdFA0O=^qi zJ&*R1_7VU9>o1l!^-IK0VDcTupG4o|NrXb4e$fX_#-pAshH7WEwobfDz=GfrZxC-F z5rpN-J=vcw{I9S+_tHUy3k_qJf6BT~0C(QF?2id>jE7pNmRk%Kq!WZ0$WED`Ai;Rm zX-EI(0rJ;S@+!;0#B2g-dmH@vVwDLdJa03}>%VHg*A5blIKPhp0MYr7j}m!G9r^l| zF#iZ%q(6EYFcJXCkEh@xgG7J1+(OF?quQSnVmsGsBS8Y6o7pxx0Oe3T*>_UxE9~19 zvza$Cn|sf1OePuOsuOYhH(W?l)3Itknw{@$Td}m6SS_X->34DrK{%kFpb!5=2Lyr2 z)uQ?GF_q(k4v)dq$=t3x3C%LEhUP7&Px~8YQ%Is9)W@o1qXtWe9|NB2{1)7Ck6Ezq zJx8<{Dm94uN3fxV(!N-YvsexD^p*DaVAfVzK!*Qs%Lp878EKu^70))BtlD@cq;H-u5F^sf$bD zBa1PERpYz*DG#-Tsp8Fc)_GUst)_n}Lf@64`U(Gt#j_D9`qMYFd!LV|b!ysq-8{r~ zyZ8d>hm?y3J;K^+GIY;h%2MiR4+|7U!f%W7%05q!mH8}F-*bdO!dOW)by@H!jK_&` zcIfh4NN@`G<@p;W#-W6`<(v=~a+0R@i_BfSL|+W_{`(}o#SRl!)HO5&CX$WYd?<5| z_j{fH)1*o1(1>S7!vh=39HmZ4hef;lSz4}{JTXTY#~nNS(vblhi>Ph-@C#z&H;vje zLANjvM$pUNm#-k!LK+tokHBK^z!d#4jBl9dgmbKqC4T@&rg40M*La&&wgJ^N zj6U)nhwnl(nhw&$eScU*|6&=@<5fi}t3NKilwsxy$7Ohy)c z2HMXJMq~LW+noiXfE-8!;jCA5WJ7T@3w8Y|04V0&*Z%HTHT?sC44Jc8VFtGNF69;j z@mZt2J&%~MxBv5?SJ02Tp;L!(KxvV`QFbyGl%{HYd!wcQ4^6*A_tpG+`W^<7NVlD~tXtQqP606-@3zvtAru5gfkx-pB7_+KHSt;X*i zn_r_<9wz`w;C(*F5nyuB-VNeeq$b|+g0mpGFvM^DMS(^S9pEM?VZkb-|fzRrh8fsv}Q$oy*qgnHev zGnwIOm5sO|6?ETxf;zR|vAd2V334)>PBr!&2U9%Dd;$mA3n69xl|42+J=!O5k< zDoRO3%_eEg&Mgg_0GYGGL+F4opl^Wvyu+Daux{QE&OPsw!>jk|-Kn)w> zO2RsHJ9_#<&UneJfGrBc5Tpqlc!QXP6AN4p=K|;CQvF1H3m+wbPUObH`lXQnr3kUp zo4dQd)Ls5?fWjklUWP2NAQI9dtoR&^cI+K}C#gxG-9vOJsR3(NucYSd89qsda}WLj zU+ykB=~2Y~3PF4ACI$-(a2er-7NmZ@0SZ1J`kkEVn{~-qE0K2iN+uiKb?^ud8?Xs+Yt;77ko;JLKVIY06aDg~+Be9Nz)Ti2-i`GWQ#0Fs>3$sO$~aw%uH!%3JTOENi+Z32>D&diMK}Vy{@qM`w9zj!7k+w9E%@dQ!xl-S)M*M#X}U}ey5`wehj%hdgtrUm zN6v8yF+!at>^n$iTA0$tfuwf!p)NhFGB{6nyk6OJOMKUx_8={1I_6rj%;sk4VqheC zpr)svqTZYE>X51oV|k8CtcLqz5nO`i5W_CED`Gp0K~SxjHd)p0hzey_zw6q6`733k zSor@`O|XB#xbUNSLz~(q0Z7f9tAItR zs??)4;IzVj31os~ekY{Sfgaf_(9Uo-sD<5JHbzJWC}x1nUt!V!GFhRA18B6O9~Ge~ zriSR9&5Q$sR9{gCC;-yFv&Roq)6KKw$Couzp>ic`LUjJfQing^#H1E;3c`C~?NAAAaa>E>2=@5Dp-5Mm(B2x$9?6j5g_p>hio;IwxmoJ29c@JTmpR7DE z(Y<`Z^xQ88luho6zITHBh=0YB%fOYmB^7 zK>;_za(9fU)hQcz846pwVi?h!taaSVzZ1#%g?H1x%6s+84Wx~&y3W}SrV0}C!0?x$ zQ*rGD*!4-&M1&DqwMe4%B0S1$=}HksXNDOKKwqWz}?sCO2h*d{~g; zSV@3B^{F^A6%fP8fISS|9#0zQOKVs6eK$)(Lwr^A$ceJ>D%OQ9HPZ!l)p@{YR{>Trg6PfQy zY{!<47+bkS>}&DtYX~+o_6O%K7t#gZImTV3Jd)dJ54ESsJ#jibx$S*?Y{C<{a_DJg zg>bnH`_U{4h1qh^Fv=~k$`<&odW~HwZpxRpwS{Mu2_Htn5~!hYg&!EkBClL6O#S zLhO2~Neicbp*gaPP_;yy@Np3a3uiY`Qp zE_QVjRy)>r3?6=umafk_>R)~=4>ot{`2KrQM%dxUlI+ zSfnNH6q}yCdQ$;daX-|T`UK($VSt7rcC{_o^kA66>P^LHnn%{mR-1y(GgSHP>lfBBh)^h(H1-+kWo zYG{I8%041;B;n((?!Kr_-m2e&%Km`)FCS&nABVD^mOjE7?ah2t!I1iei+Psk7e>E| z!I#@`N2>(+qac0y543DfWU1$RN`WYWr{3K?pO-rQ`)rev5%pPbE}YByTzO*C{tK73>)KM?GG*RQ($Pmk9q}!*mxd+h?s>K! z+K)Hn-z0(hjb4h-L)yX4UC(00buPhV{=4qOr(8~qg&Re)U9Ck@SI^$atlE5GnYreF z*z9TW$*IKN+;!m1&N)Yp3?Z&0c(G#vbY8?$3!Y<7vCGL9CK17uV3-BBi<%O{wU- zopIIAnX$&ITE#C`!Dfy{I3~^W?*^po*{W1+YgV4$bI!Hzb^m1f)9hN8rGB!8S@Z7k zH7T(O&lefUV#?3y8-VYA?Z$+D{~iGb4jSs$su2i6$5e&Fz)~@xU}a+$3pfRni58GM z_k3TrK^Ax-z@zT6#>wiB{xU*~YBZD*=mil|{nn+OJ1Y`bF9>OdVWYb=q_!0t5F84ao2XktTBg!gFjf_lHZo)hsW4qX z8OkOvgnTRzvVN$Cc@KyvmMmBwQ>7*8$=Oi9h;|f%(Lf)fh}fkFH;5Gy{PGzwk%c>S zaH?$umr#7i+Q0!Rwru?3`XEO+@yg@Glr%YVf6=WQQdZXcvO)uqp#D)CPS7ZK&YPGukd&&(kfF(1Y4sx25k*6(cm;CXkQc8awW^}I@R4Z0q=~%5 zux@x(!0jDpE1;GE{$MOoABZ{#Er9m}?4@dlkWsbeiI&feWed3&JOO;mHe zRtv+zfZl4#OQc7QYFYS7$faTG5?AbbEnF5&GuH89L_vJKS+We{Rzq_;d;J$Tw=j~1 zrI<`6?1R4r%-1hH^GY~Q1y3%F0y^RaMnB^V9-SINsz?E{lm~&J;gAsSo5cNE9#TU9 zbZ886PE0m2)x_j2G73sob`CC+q=I^|xQd#Kt6Sg<43?;SkFjY`a6|7jm4x~!c0%Fy zk3~ML2xO7J_!eEK6wd#sSM{)#&}~6hq~$jGa2PPLIb0$)&Q^f z8$q$#=bxU6d^maQ|1ckCq(VF2d(O9k*(tUY77ssNU0OnS+e!Bup0R5n-Z+ zIN{BUW(AMR6RY@D7&RJQXydun*jja<8IcLA^5&r?V`>nRNh^_>T9YoeI*Z5fMKway$EdxUvtP|Fifl$l^uXL>q*5o#_u7ZFLede) z{#DW4#GTdU7nUwnJ+-_9a^(U>-Xu+X^2A_9?boS z00C)uxe=lq0cqy>ib(Z6|K+~1uwBCbiu1OAl6vOuPTtJKlsTfCkB>g*3#DY6@Qm0_ zBM_&GvoMTkZxhAIAt5n$&h)A;Lv4FSu=0Q*OjV+|?anGKeA9tR8dIhT*WL#k1rR}mfBMJR&Ha+ zCX}3)0yCy$7_vi$_U8w9!6j2tVdz%(agihOE?5rboppVO>J z`u6~LT|q$$u{y~jjpg0Khv*Kj7Zk^_jzces^c(&!L`3a4aHbYERk4^(6Gf5wxYGHa z4HbNPO%cBF&q+pi)4VrSc=zQLnQh6>M1rZ9CF0<87CJQDP$qpmeYBeQ;Dg*Jw=V#f zpWq#e0ON_$@G~E(je~Z_HO_kG^-?RZ~h; z*WUvvwH2!C1hB#DWp7YI8B$AlQ6F3)ArL3H*P z)sIr+U+KOSzP(HFRsHvbl6T*U+>31>?DEnO`u{oj;D2tGIMz6EKSO8hyy7L^hHsw8 zouEl41*_#MBbq`U#p8JklSBOcw%Jq!C3VgThEOMG9bPGq0!^kw$8pTC%IXEh{yxq6 zkMOc?DL7h;G*2bbsq_yho?|&&xICOby8X)HQ&l+|R*|OYyhX33U}`J(nsB!QRO76f zA}Z!!P0bZ*Kb3pXt39mR@6#q_im?r!mz@_eNQoC?%J$djR^4AjA&+78`G}#tq4Q~$ zG&cKsp{QuJJxYo$f?8CRS`dwX1wtC4+(6Gs)3vy-2M~qtkcxO2^TO?T@W6Zs`K4Si z8#IW9?b_1CkF7heWDl?33_V7g?N`LCjF6U~k^QuQnKCIyzk&Ac{#xq&;H0Rd@!SLY z)wzXG_DZ;onT)zl@dJ9NxcUdMZA(gWOtCyjjS6mi z_4@6l+MATU2#;546{am3#sfwdSUD6#&fIS~X_LsQQFz~}JUbOPN;*i@OsRndv7(uv zG*i(secohl*yc4}UhiF2P_D57WaUdJ$f})oh7{|W^h4J$IBEukgFDfalhz0DI4umc zja0@<32ab8u_p;i=p~Ea=zZiHzltbkSmsfy(S{$*!kLW?p(i867NAHxo!{z57vaJB zghDwk%0lY+aBaut;D z7hI3hS5G-3X+zKiYmIc0Ro$6pAv(Co(;qhA^-iC@Qy}M};i(Ma)&q(sJ}T!1@}iZH zn<&lER|8K%>8SJ-o|_Ew7V}D<$tlLD8k8fhGQwboHb$9+k|`GJSS3fgSm&(qxr!6F zSm(TS;pE>|Q!)*tmk3F9PPIA@6>>05$SC&V@)FC!v_BWiwrQ* zNKyEN_r)K$qCHrpQeU%5l{@^>{=^8h6gQjc^QhyHm|m@HYRvL1O5ySA;q#!B1=L;l z%*@{M%dn&@1+Nc#$m;0hWilgtP4D6y_$mJo4@m^}lundmJ>>wdC`$$oUkzg9bR2xd zG?heT+@x=IW66U8DM1J@9Jm#z5V*6clR59hB&Hu}{(QNn<#~k7pj^SQ8D>^or38F@ z$5%r2pTbsiu}0zJ)vLudLW-lQq%$Ce`K3BO2V(OD#0+7V5O*rtyNv1szZ03El_&C} z_J~p_?I9PjPy23r4ISv|wY3dy&9aq$;}|cKgm4qBxQp{dwzv%ttvDP&B$16btPA5mhcL?*@FWCQQ)D8$|nd``LC%!LS}Egt}!mr1(KX#LWP; zj-J?PqVOccBlG#D`lVqBI5$Q^p1NhaCiRnkJtT5~OXX&aH>5_}MfyzD$eiTluxB za|mm<5YbbaX5vF1Md6u>n`lAJ$APon5wXW=X5-p4u!`07LcLd5;&QS$ijpk~p|NSH zR#gz!JcPOXm}$~sD#4t}Pffr0`k9Ly3l)Q`WZ*y=(x}LReCwd+gjdlKX-ND6T^rUs zBO>D0L-w90R$t|`K2I!9;wCOy3ZJG{R$K(;CWTj#his}b(!Y`$NLr3xmDE{LE-1<`zpy!uVZO9jZx_qqy2m_kDYB~qUPLElchlDef7a+ z%MmfOBYebcQ&&bPQL)xY?xjrVHWY|VCZjw-B7Ltfi19GT*P%x~WX7IC`0W;T=mjI6 z$YWPL6JB}wdRiXckPaIp&M}j*;7Z*BrH-tWuxsnD{sgSC1+D`+%GAM?GtX5g2@uh#UE)Ha1vDGYV;{#(`L{Q0?o0g(|R>ypmze~C1)ev23143@s6w7 zV?#&1#t$l~=_no>uAuv}1@gui`=sa97*KY}P8GRT%a%mIXF z$ixnrlI;IEX6&CU4ial?#X}3ZHZ1A5gKAk}B?jWP4ki!AKK!hzC+T~>zHGP(YnMrhk z3yPHF@HL%(8Y~E#-Os-NX3p6oh%KT=y+$Tm7BrayC-z*gANqO_Tdvrtg2n9XbjB0H z>ucc~DI&6c^uzcI1dm3}XXNxWQaT;q0PtV*{feCQ3e+qK44-VS^lZOI+M+5v#%4&T z>V4xo)p4{rB5qEN@NgaIz{l$OK0MZD3)g5Fphd5yWL|F0x}y2B2z1@1QPk|ipU443BL7`DaZTxc~w}D zi4pw1_M2yX^PjBZJbb4oo_9b%8UB~=AXsP0j@z z;S$1Va1nojyMfF+KvVg}Ig*Y6E*yy&EouRY5l^+gPr$IVHMQg;VvJrRd`f9c8x@8+fNGFHNS@2Trb5S8IE6Qz0eY;zCF;mRJq z$eTV|&ZGUl9v6DSvHLYpy$qZV_T7+awe-oWBPZ$DN*6MRdLevLwAv{Aa0wS{n-OQK z@L4%Z3squ-6H81nvgufQIqOmHTY6}E zqqH!HjWwdn6|f=DUdT@DQnx)s4J(87Pc(g~6zTFB>+sc8v{ zxzR^F`nW5OEf1RB*xz&6D5$E{G(GF;JCI8XLXP3wDxIY%4xSje%C7lIisg5sROdg6 zOmEAeiZ_`SGGnOjak!G>RrD{)@w0rU9TiUeLYjHcbyEr55GG>!2DM`iL7YN6c99`YT;h+j)-ld?_sMOcPL2_j)6fmOPlKI$suN zXQzS`B_69r0FAQv0}zC zw1re#s^n;ji>qhA<7p+dKON3NJR;Y0QQ|EuoJyr-1FI28#<6J=fz)VnWH@m#RzMS6 zKqq3^&$g%A*w;?S+jJrs%KM*ZciQuPB(~a%?o0^N?+7|6;!g+n^0vg8~wbYnnBzqzCCA!}ou`MdHeMG->ygk8`BSLPrvIBaogmw-M~9wLZ@M6RudOx9xSk(hkiCpz$L6jaMOehe z`B?Abr2m(wZorlTgV6aw&R>P}l*UCaz~wCenFq_GHYy}6RoL|}%E;@o_-VpH*JB%W zZLKxY(NC9tMEd@&PCiL|OE!gl-gBe5-z}p!UT-!3X?#K&3_4Rd)7kR*qjxtgi=7eK3BXCbF&gfQd_nqwi#Oik~>8!y>*Lu^>G|#g&(JhoZkh z7FZ4cc9%SXBEaHZro=Qm4GY`G(YYK|(!alD>A;&vZQf@?{qR9}ti`vw0Pc6mwXpJu z>4hdoJ1ZZ&f#L01S$oq8@^z9*y_kh$E0%A@9`nM4nZMg)FpUNWo9e~cm=BI7iLuFM zK18=Ok=t6!H3QQh>(Lr2)p^ z&U~~xsq!AMJz*hz4m{3?l`#{sspk~F0U>3I=NPtP83r=Igt%Jv&J4|oWYKJiYc3H- z^of`)l&CA8(&U+=N_pgW{pFL9Ydz}!KV{Ob&41)4x_gs zs=x|+ux1)>$VUy(qRLJIMiKRw=X{LnzhME;#FG7kJ)YS1(916f?M@ z7+@vIgJr#f)9Yda>2|GhKQanKS%>Ek-UQD@lW#Wo98Xly;5*g6_oxv#gercSAX21m~&SwN1nZ4`l)*1p}evA0e3D$y~_7gaFn1b~=JA8v~G5h!v9646J z6E6Qq=AEiZ6f6bKGWquh%WV}|I=7zQ3Ih_rcuY&oUnTI6$>2~JjB%i23gwm59$Nv| z2Dm=Q>uLK?0;@;DwtGU7Y&$wt%%Ovz6{w*#nl}wZr;xY+b_aMA!8YNim7?Zyk85g_ zPE|6A12jt4aRb?M3pH{RXCOu&9(L4nk077OOjK|K5?PMi$ z?Zi$5D8`^Xh>(sk-G$Uw;Nb1V6>5DZPiM*`>Y+-t1%-Bn&)u_0da-L&rR@)AKsH#T zX?Dm|yz|TA^x<|Zt;_%bp{*?Ac(4m1oYNyaHbowg^-!J3= zfbtLmiUNWRX9-nJ&8i)s-C(h4j{GA&?P@@f^-`~juAIR`(Gj{N&z#JABVfan#wKuf zj`rfm*!M@*0}!a*ik7oilRE{`Jp^_16BYvsyon33_Yx3rWb9Fbp;&!7;d`^Vx6l-S&?6=*-?*LN1fw1v0oo7!2ru^nJoWMxU)u zd!1A80Wl}tkHjk?0p*b6~G*=9+PHzCXGv9W>y}E8?+XQ86*Gl*&zHf|=|RqthHiHiwt!%Mp%| z?kWcUT5XUTyhZaIe~0oa^`-O8IUq?b(DfC{+k~o#BFy?LyRB(2w(P2Tw7Mi12`j(= z4*5X<_d99XlthG>8GL|b#4C5LS61NnRUjU#k^FwwX!_qt%C|H#7BJoSU(L&_X zmJEHNP72&(6aE6JiYmS2B zMJtTH){=r24ZCXO#ihcCL66DM=64R1KfsDMsboafvEL0C;$7;8LEO^V7~_*grGR}W zr#xknA}VEuxVDH#MKb>9GpqAr(M)1*O?AMkzY8FE#S^#P8>3}H2L1fS_SFyKR&F?#1zLblY% zjUg;)thi)GSOEws3eMy+2|xw}M`(UE0JRwNt8jVIAkaM)5kRL4mM93VpRb2O14g2W z0^V)XL;JCo*f`X=r+^F0wXRdZ^@;j#Rm6K6;b<(NnHaI#Ilu)bIyDz`;0gRzq{`h)y>kwvL!FSu8V#O^wj)ssX~l;WMR?J$Y%FyXspSwV~V zq-2{=rpY?t>`7B|035ECQ{&ci#YlFll1AOz@$l$-6zD-uhFSZKM$Au8{`6vIvkQ zGC?AU&R$N>l$!VafNnTc@d5wY#xocYwsyTR?yc&I{SQ82o;4}u)CXncAWjX-vFu)gOLaxhd@`^Ya!E#zv_R2 zEv%B)h=ET{=+$n#E*Uk0+EZ6bmxj~d7(A+|*E(uBi4;RdH7HFewF8%y(d?8qo(#`# zIQTX%7P6shPw;9xejXiB2(zhVLJcc=$Q?7WiE}Z6B;w1PRi1nvkk)nI$&gv|_~bbu z##mm_$fgR*0tHQm@il{}MrT~tN}t(K|6|{w53F3dPrm`u6SZdrJf$p9{Io81H811F z>yMzvdv|sz@nGe80ZYcbCpA97w~ROxKrFOs;m%4UPqQiTU=NEnXb8-dv4N7e+O9)C z0f;ED(bwOnqp70B40)Gxu>lVamVgDoMnjv(?~erNb0I}6p${|BJ3x7f`>cmPrs03A zHlPDtKn5z&?bV}YCA4ZqaKwU^M-to;b`pP)kQO-xyL{C5iVg=96Tj9BT1p($`&{=J zWL9NEu|i&exap6k|HASTc2jtXWrz5h-zp*@J3#4tpU^$nZtm&N<55_;+=%X ztH|*Sz$_9Jtxo~Lz-D{^vM7LE8T?9mZ~qF7>ydctZ5i~#@Xa$}QLBiho8Vgp9H^1` zg@|@z$rg{sGdL6Im-^5qwQokxt@~Jf@{JugeN>60%~-K5@|`obycMDM*{1q5Lzx(HCyo!Sf)>+&XIRJ=pr)UExD zDen#=z9B^iUqEi7Z9mgFX}Er5+993HH|wtJZoS?-t&Yp)g@u9~ zp}hjVE=RFm*SKOkYI+nm*XiDI!P%9l{J%T|!?PM@pBQC3PfWo{@oii&~ zxz&nJf}IyG^uD?}84)>2E+ZVhf)g)+w+(QR52&eq9kN$$+b{E^MVUJKA6Nwr#6A4CHpSdASw(6lcuz^GBQvYpgZ_!>wPD!rUi ztOE?B+hbtrkrhZ*8`G{cZS&hQ&n(_W7*joF579!(-r*MudDTQLy_zY3eoM|*r z%Yn1bPYk|@5^v}Abe9}LhhUT-nK`uA1ZrP^N{A3wrCO-7hm-`j*-XzMkT8ENHto6E zWBb{z6^lOiGRSw`gk}DjdwuRFZh~!&xp!9SD3A?$o6a`JkQ2MP^DX?mc5Pi}=iF&0 z*XJx4=X9ZDqd))09usTj_pNsLZ$encU+7GHAa{)RtUvALE`3w&!qtOI`Mh8Z8VF( zp5J_?%Z9+$FoVYvpD0G-uGe>UT{f7nk|3ay*;K>MOGGcm0*gUjaE2@aQ`}C6U7R^yK%M!X=fdGgrJbI6>G(ESydJt?Rg&lmO` zFKW+GpRN7r|LI5F5v(B6OI(M>JgObRR8x80f zaj!Nu#PUz4Ie3j$2b<-088Wx-s0h$dFgZfMb`4e-gsKaQyjn+bq(bW!)$y_(v_kso z?Tx0^j#%pDA814n;Ea8nx=_sXocEmz{xgwB>wR;zHTNt5CekhsuEG1&@&BCj3F2no zxsIKExw_KEp0BhD|5y7P0xdRWrO&dS+PwcB(PY;1f58-A=?rkmO+WWE8eaCNwYUv7 z!_Hvv>2i%S_zfA0Of`fsI^rp1&dPu#2%~Bh@}WDq;ZAwON-8uG?HWtKa z`KJ};f@K!B-+70?wdBVIPo;8`)wkJ}xpk0dXCEpFabEt23PNNbc<|u`Lc9@HUNjl( z8w`(E!)olgt2_l$U2vwWdmpZZXay|&9!+OGHt6iKO7s*ga~$6NfUmq`b9V5O^caWU zSx{7r{fg6}5P<}ms~Uzb(8!Nv3m}1^auL98%@R_ZN{jCHDa8H$7lm>#k<14M zwt4CWI?++{BSwyC=;>7BNa7BXdttPrP9t$v#Zi#B5xWH=L-iuo)ro5p49K_e_pxtk z@|*T^Z5i<-U=h^xExGP;Z4o&;4h8Zexy7HicUG|6?AaM0kuiuDM5;Hjh#NjA4J}9c z{OVCb-X#>C!-2iZyc4=c09kNUK!X5O)l=2Ax`Ov-_fx2F@k`=pr}W09%bcUkYj0_r zH?HR&pGhs9=f0p#hD`Ni%U)N0_HVoG6Ng165+zJoD`B$LNqwmkj3vFx4t}o`Kt2Km zg9M#=-fPt${$fl#Fv%(>J_JgVFnNl(CxjS8c?UQkhSLBdv|`^{15s*UC&+@@7qs~u5c(Hrl(h*v%F3@ zS{BR=reAXq7Sir}A2J-QQj1u!RLM7x7{CzEwx;G3&qP#Ea#;+S>`T2c%Zv$ z7*D_2@I(Msy=}$k>GSYePB&hFBnFmyh`8}^DYyDsq!T$AnIbtG=%^!z@RSEgM*yRj z{2sE%ktleII?y`0{Nbsx=h$sm5$AFHlc$puAD$?`NgiHe&mElInfDRCRmUWQmQ& zA+cn@R{o%o3j;Zso*@*{L}XD|N65Cd>e2t;8?*l6A(-_ALNk1_y2wc`G*4l0Qh23@c+bn>_4>X^?#MVyj$?%-x8nS^unE;iiW%Y*Q;gf zlI!0R|4k+5#|mDI|DDa_tp85bL^ouo{Kv2JUlKlid2{kBmuXIKi*4ZVRDFN)XErn@ z13nj{MEBB0(eCNK0d67T>EAVsGuw)?MW1`pJjlPHAoYL!cSQHuzwYmKy-n<4;S1Cppj1m}c)w!TCM>DexZipWi>r^55b8Z>amua{nId`|&_nm_N>f z-5(JI0wCKUr(&umE(OyniS<2OVAjAhGSL9z?+3o_j|YP99N;+_=8(2c#;>GRDkvzm z7d7xEzT(CmS51oT;gdcKZ1&J|DJQ7`-Wlq_C{_`&gqtHJYeDrQ4;nQ&m*<9yoU!ke z`X&nx=b2A7SS@pW$h=a*ZKI8u&uY}NCD}Iwz(+*|GlZwu!*IVdnCAzKXZeg2?IfA7 z>WRJDH4i9zor~^L75-Qfc(8#G4^4fHVtmEDY7YR0LnS74DsD1N(uLsW<)?SiQzeih zV7T|_Fv1w$V4?$#bJO4{kQ92s0D`0dm&fLMmgN+NYw$_{CX}5H*GV06{dZqbYf` zMlQOCD9K$c?O=7FGpb&=_%W4)z)k`2h}p$nM~9b?e!Vudg%$-3o8t>cl1liV;qq1w zYi}RN!uhx%@GfF&B;G`^H-$o%(wAx>#w>4NWXoF3Mc3@pab3cV+T$1r&1}0@F|s0q zttmvHtNE*W1cHS*{$L?JEk=ZjhE%JT0-cYRcd12%j5N~bE&_xRnK9kgTdD%6{=I*^ zu>9j3C_L!fE)skvD!^IDW?M;D=Md-09EDjk zGE!;5m%^0d&8}yv9HE?+-jk57vdUX(5!LhmhfM4EI#5KuZKAwYsk@4XkL zDpC}YUZtymAW}s@Fo1N>H$MNF=X<}I=X>98=FaSIes|B#x##ZP**$0XT>W4f{1X=4 zMxGn-0`UPT)TV8zKJnY{EkDT)=d;KWs!(_PsJ{;dV5c>q-CPClG#^yX-1|ARs17=bISf)q)039 zdwnGHL}~l4t5I7y1lH0tX5G|+MDeW-5qSrxJG9cSwD|vsHRU5 z9;mscxBD!9AX}3^CW72@EY;06gv&fYDxSJS5-f&L@t;#CdWSZC-wZO;30z+CH|HGe zdf|yecx(IQLM;l&Gp|d~6q49|goTTk)<<8Xsk--3!xIr(7r(QQJ;Q9^th z^f%uVA(InfRG{Yu5Te_EgWLa#ZI|rBo4TD=rv6WKn_%U`0~WEwq7w$2Fjr2*<+8ea zbRXBr?Y%+;WoX^u@oy~-^6&KDbpHTQCwoQk>lnxR zcMZRiS`UQg%9=P`pI)73GC6CpIpsa;@Z_Im&Gbx-Q=;V-oU;V!R~WTyz6&}BmLSD( zTxqQfUn5Wcmn$ms(F66CW|>;&8*Mb+e` z&Sh91d?-T{*zM`SUifel0I;~xL$eW9Z?bFdazyMKFQ#=^p7Iv;+LOB8d{I@86y#=_cFBn(`!M#njQ1XQ zs-6@Sr;Estjq`Kc11(l2W3mn!`qfOJ!kFq_M~ z_7rr`4?`0-`j8?Ef_O3w(`_Sf3xJWhBMpUp`*yKUqQK$xN2Fq;!e%0Pj1(~@=v+!|XvF~g*g1x;zA?Dp z<6+jsPWXvQ$!XGC(PZzU`bu3ydXH)|qM`y;kbaT8qbD_ZgS8F#zE;rOC5Bb3k64AV zdfq_dpI5bGWlCq5*Teuw7jeINEHR6`B}DO6o{h~$@uQ4$q$GDtI_4H&^i{|e&EFpX z#pZP6IzrEt{_E~)f?(qy*va{CfRCp53ba~z^h()W$y+t1wHtp& zk@iEx7h<+uoE$j=MvK3!*=b=L$t*-llbjtS8@6YMyOBsHO~{?Vhydh#bZLk1nWjlC zwsj=*cdRC-|MiM2)6>srp7 zl+f|;A2q4azx(J+byR~d*Dh4RUsJ|V+93;lJ1L1ud;_kTY$8U^_QEg*67fDz+MvAv zrFAlV9wVhW;S;B)O-9S02??$l!0JFzL{9U{h$m_!DG4ErybId{!$*=@9?8<<$Y#&Gn2=i2Xd)FgQ z0sbO+I!~T*z@>YWWQu|Wn%(dudNPd*&VfD3tqrTfHWUm!*dB;VDJu8af}CsrM^GFs zq=vB5Q6XI#i~M?+^y9R8*WZlH2Rskkpq!r!G!Pfk zot985sDHu@8&*VLdZn1n-QL-D>la>vzRNkgU=G-SPL>;zaP|jqmapZ>6O5)AZI&#RjaAUt{QLW4!sW?X8gl979o9erc}X|P@*d)Q>GMhH~&L8+&qLl61OSzTSgfEAmrY%7xJ*{ zUYd02%3>erTj=6p=LyCGKiAM7>bW#Zrbr~c|uIJaGX@X z3?KQG3+K+}HCqpH)WdRA`Z~GSRw4ReJLjMyq?DIXVB3+$gYEIPj|GFz6_c!jIcxWn zZ5P8{5@--Pd%sP0H-qy0Vpt=;+xFS}#tL0x8ECHwsG)+gak*7f`Zx-6w(1tu`v+io zTwEb_y-xr`P5x_(j5j2OHf>x}^ZhjOL%}RocTe8{%rG&A^g;5Kw!$w!)2+`L{~Vy@rDn{8^7sgh8*>Oz4^ z1ii7bnCOO*dWUFb_t+(5rSN3{TI-dc@rV{MO9ZOefOBA)>hw}#g+;`)RYBUxMOd<~ z@gKL?)T5wuaisEb(&hVr2&uPsX@r#E%1^GBFR_`2Aj4T%)mo&#?E{V_mqO7iN60r2 zg?g;}u!EW#M$4`3fMnrFAclp{*65}?0Wcf}xTd*2AbM0wM$}p7d#4rA4Dp`ZEBx7S zW8sbYPIB+Gl@u6gSUvpusN3qUj*~B(9lHW(5Fl$t5{0M*JT5z;>2H}EkDoz~yKgBjr$076#nElP>GKQ>Aj zP1ju~rr$m`ZWFEIOcwU;NiLfw3%*9kxoEJ(r`T?yq(;zsU;ZEM_vNf;6D%aYf4xSE zoE9=;sj3TM1@USL!%prWFo#j(7H?e6e&xyxbMHw^C@WmA6J6Hl*8|fwhVUEOW1eDH zL<Zgz|>)KOA z2`s&ojD3P>_rCnL+3qC5t+)v{L~((}HHn=*>wlo-7Ro`t8%xJHtd+C=6f5-$aI?XOxaAwtxw(ei>0WR`}hd`4D0)Q#Ml&p-h<-Bk|5zT<3Saj!@JeGgt4lRP}J|xc$PO}Fzy@7U*9mcO* zYO`gjyLAXYN^4b%Pj<475EY>T-V&lW9=;pOo`}#y=OF!&r1HJo5(-NG(?r^aFShut zJDv^-!MY8*y3!anX2Gt)XjR;8=pQDor^Jyd3qi4 z&}9y;zr*C$6OA-Oti74WNcz!gnH{iyM`hHWwH@Od~RQb z>T>Msq0bR?fW!ihldlbEUtC>LkCPh@OOa(wf3F1_7R*-qNz};ApgC~H_gUAB5|Q7y z@iNwyJi{uyO>XNN>I?Zq_jxLsODXvr`T{)anql+C;&C=un9r4cy>|*#GD78Jz*sYs ziOuNBv;|CQgp8V$qWMiT$;?x^G_R>cd{Upo>|oYFTUTN&noBykn>lQRkUD0g3LVCK zFfrk;4Wtt#ubO#e4{r9W6fjG%+(!PENbI-h@Sb=kmvFl935-`8Y4+gH(!hO>v-*jP za!uuM`ySuBpWiO`OPogC=_wDM++0AUi_l3s1&pSyM@id+H}FPOojn!|k1R29TJCce zu)9%2fj8LJ2lzT_)d&a~Izf$31>|KWintV(m zOXt>xc98?l?sU1Q9JiTV&Y;O{s?T-G(xTZNO~ZZ#oA@!AgNv5Ou-$tQ?*D^@5-`$&t+8O2i} z7;H;yNTjh(jvfzkS3TIeA<$NIFC+S_Y%?tTWy1 z@97YswE`*fh1o6?w-&;e=$nST0OmIIAMz!i=r)$`UVmSIe2+gkp7|O7Gxbe9!EXW7 zCss!(2_1CsEEGJz=5lr@yUQyKOpCM&_^gG!c7}`SsgA&7jsrw!h!)JLjB=AM zFi6iSb2?x5z%Z zmed+dlxozQW<|!5=bh|C(T#cIgrZ>nR4C|L-Gq0P9T~B1=e0s9$67VM7&F)3MqhRyvRLjXN*q4?GGU7#K9s@ zzUY3`PQO5I=<()WhmB{>jNYaBv4bGuFF+K0@e?FbVl%FvE-1V`)b$B%tKg^x>eG7> z5L2zuh}|WBWSfaM*+%oCgLr~;N93f5r^(^F;GBvaKanueW(rOwj!d@>D>kKO3dU)4 zh;8OR>-LK|27wAPx115<$2U;0Fw;l2xe0L<%4k@ar7{6#R;Yk9JDLB&xc>_>5m>1f z_tKIY6F9ao!^FzH#Q0A296+e6rr@OvSwJEsAVi4Y*F7Ni`6!%TSx6uw2Pzy^+f2mC zRPf2QRy>!o8K~H&SUYS3kdX_5DIyq0-e(|nOyiyDKPT_K-knfdP5kG4%4CNHBc-Db{| z^Uj}B2vqzfZGcjm7N1pRu9%UxN^kuGe0BIIuPn1X^t*h0GADPJUhJ`nfOi;==0a=B zP+%(=3`D=%R%=Gxf>Yzem`oJK$f|Bt?oWV~|jRW06<0 zoLMi7{Bd?+dIlW~BZRWUxf8^kZ4;X%2x5)*59X}y)=~S@vxq&(yEp6xZ&oI%+emtt z+3l_{c}yO+KkpMTC$wL29i$QJP?Ck?GcqMINOMse2b0|2&#Yd_Vk+#u8CTWeHV0$x zp{p{i$U}Z1!`MOVS`Fo! zxBmcMeT*cRyYR^p{}It2|17it3#H`d43IR$DaTt2uu{Z*h#5YF0H5yjIaLUa6ufQ* z>kFUQUTooLtyiJ^OS-JQEu@vh-@)jXf}~bPh2ATyYKqeAkQ<7U*Esu3`qonP3}JQ8 zDy8S(CFXkdQ)6a|$%dh#Tp^M;QEn|!G5d@Gh}3=~R^xa->!y8sz{cqRT1>9Znafu= z6?3>P;OhttOz=xiWk>_h!w}Ku@F3G7bXj5 zOb>agCz3sWlLaLypx^QHQV0iATuzKsRHY-HO|^h zW|b7LpAVpYAK=_^f_J-C8J@33aWnP~6jiBi;N(&GL_p}@7zay(E*lMy?g8$d0ofAdr>-{#Q3 zhhq_MyeQyPN`x&4P*9^#lG4=#SNq!ETIdyhGfYMc@{G059O$1!E0-M(5Ejr2{HF!{ zE=sEpy)s-p+Mc;o1QF})(pEn!3?-IS$eS z8OA6#N^)cRER2_}-n{D;w|*OR{_XXNN<&_JXHX=EL+|VX{=~TUa&yjQ0?+r@^HbZ{ zD65AcW2#4McXNL|c|&bdf~L>Q^S;ZyB4C0dC09O=blPF-4OEVpb;9ol=(jsnvof>o zM-hw4hh^Wlk2&9E#lL>&v8mE~4g4A0r31pYg8;a>%*x}n|)=^Nd7#MyiMP!u9>vlyvMa84&asvY?TX)e_ijQU%-F9T53L! z2%};D**W*j_spha-%d`*r01g~$Y(5}MRMG_?B?M|xO4Hk5 zodaDDMLNpTMSMS3cpKlav9ecSdp1#b?f>6XuZsSEo9vR>4jJb91)B^ixh)ag zl-NPkq-%UOG&$Y9RP&r_E9NcQR1IoRuUBwI98Y^)&VS93xmZ95anFq7H?o&nyqCJ_ zc2#3sxtP=2PIE#9QFW^K{>TTj8?4T8mHo#8>gd9x5&xCm$A-6kL`|s{&mzjG#rtF7 zA~47N@I;I-j|QFfhMfP(p!V_w@)8vXdHh%l$S=PH758FzQhZ0@9d~a$5QaX&_Iifi zahp<(;-NlOrpG6@(OWlE659QjPRmdj*-bcm4mQrPc46UVm}@LI6{*_(#U@I&r0zSG uFw~8Q##Fi SPI Slave Timer - Touch pad + Touch Sensor UART Example code for this API section is provided in :example:`peripherals` directory of ESP-IDF examples. diff --git a/docs/api-reference/peripherals/touch_pad.rst b/docs/api-reference/peripherals/touch_pad.rst index a4ee4950e..ae459e1f9 100644 --- a/docs/api-reference/peripherals/touch_pad.rst +++ b/docs/api-reference/peripherals/touch_pad.rst @@ -1,12 +1,133 @@ Touch Sensor ============ -Overview --------- +Introduction +------------ A touch-sensor system is built on a substrate which carries electrodes and relevant connections under a protective flat surface. When a user touches the surface, the capacitance variation is triggered and a binary signal is generated to indicate whether the touch is valid. -ESP32 can provide up to 10 capacitive touch pads / GPIOs. The sensing pads can be arranged in different combinations, so that a larger area or more points can be detected. The touch pad sensing process is under the control of a hardware-implemented finite-state machine (FSM) which is initiated by software or a dedicated hardware timer. +ESP32 can provide up to 10 capacitive touch pads / GPIOs. The sensing pads can be arranged in different combinations (e.g. matrix, slider), so that a larger area or more points can be detected. The touch pad sensing process is under the control of a hardware-implemented finite-state machine (FSM) which is initiated by software or a dedicated hardware timer. + +Design, operation and control registers of touch sensor are discussed in `ESP32 Technical Reference Manual `_ (PDF). Please refer to it for additional details how this subsystem works. + + +Functionality Overview +---------------------- + +Description of API is broken down into groups of functions to provide quick overview of features like: + +- Initialization of touch pad driver +- Configuration of touch pad GPIO pins +- Taking measurements +- Adjusting parameters of measurements +- Filtering measurements +- Setting up interrupts to report touch detection +- Waking up from sleep mode on interrupt + +For detailed description of particular function please go to section :ref:`touch_pad-api-reference`. Practical implementation of this API is covered in section :ref:`touch_pad-api-examples`. + + +Initialization +^^^^^^^^^^^^^^ + +Touch pad driver should be initialized before use by calling function :cpp:func:`touch_pad_init`. This function sets several ``.._DEFAULT`` driver parameters listed in :ref:`touch_pad-api-reference` under "Macros". It also clears information what pads have been touched before (if any) and disables interrupts. + +If not required anymore, driver can be disabled by calling :cpp:func:`touch_pad_deinit`. + + +Configuration +^^^^^^^^^^^^^ + +Enabling of touch sensor functionality for particular GPIO is done with :cpp:func:`touch_pad_config`. + +The function :cpp:func:`touch_pad_set_fsm_mode` is used to select whether touch pad measurement (operated by FSM) is started automatically by hardware timer, or by software. If software mode is selected, then use :cpp:func:`touch_pad_sw_start` to start of the FSM. + + +Touch State Measurements +^^^^^^^^^^^^^^^^^^^^^^^^ + +The following two functions come handy to read raw or filtered measurements from the sensor: + +* :cpp:func:`touch_pad_read` +* :cpp:func:`touch_pad_read_filtered` + +They may be used to characterize particular touch pad design by checking the range of sensor readings when a pad is touched or released. This information is then used to establish the touch threshold. + +.. note:: + + Start and configure filter before using :cpp:func:`touch_pad_read_filtered` by calling specific filter functions described down below. + +To see how to use both read functions check :example:`peripherals/touch_pad_read` application example. + + +Optimization of Measurements +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Touch sensor has several configurable parameters to match characteristics of particular touch pad design. For instance, to sense smaller capacity changes, it is possible to narrow the reference voltage range within which the touch pads are charged / discharged. The high and low reference voltages are set using function :cpp:func:`touch_pad_set_voltage`. A positive side effect, besides ability to discern smaller capacity changes, will be reduction of power consumption for low power applications. A likely negative effect will be increase of measurement noise. If dynamic rage of obtained readings is still satisfactory, then further reduction of power consumption may be done by lowering the measurement time with :cpp:func:`touch_pad_set_meas_time`. + +The following summarizes available measurement parameters and corresponding 'set' functions: + +* Touch pad charge / discharge parameters: + + * voltage range: :cpp:func:`touch_pad_set_voltage` + * speed (slope): :cpp:func:`touch_pad_set_cnt_mode` + +* Measure time: :cpp:func:`touch_pad_set_meas_time` + +Relationship between voltage range (high / low reference voltages), speed (slope) and measure time is shown on figure below. + +.. figure:: ../../_static/touch_pad-measurement-parameters.jpg + :align: center + :alt: Touch Pad - relationship between measurement parameters + :figclass: align-center + + Touch Pad - relationship between measurement parameters + +The last chart "Output" represents the touch sensor reading, i.e. the count of pulses collected within measure time. + +All functions are provided in pairs to 'set' specific parameter and to 'get' the current parameter's value, e.g. :cpp:func:`touch_pad_set_voltage` and :cpp:func:`touch_pad_get_voltage`. + + +Filtering of Measurements +^^^^^^^^^^^^^^^^^^^^^^^^^ + +To avoid false touch detection you may filter noisy measurements. The filter should be started before first use by calling :cpp:func:`touch_pad_filter_start`. + +The filter type is IIR (Infinite Impulse Response) and it has configurable period that can be set with function :cpp:func:`touch_pad_set_filter_period`. + +You can stop the filter with :cpp:func:`touch_pad_filter_stop`. If not required anymore, the filter may be deleted by invoking :cpp:func:`touch_pad_filter_delete`. + + +Touch Triggered Interrupts +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Before enabling an interrupt on touch detection, user should establish touch detection threshold. Use functions described above to read and display sensor measurements when pad is touched and released. Apply a filter when measurements are noisy and relative changes are small. Depending on your application and environmental conditions, test the influence of temperature and power supply voltage changes on measured values. + +Once detection threshold is established, it may be set on initialization with :cpp:func:`touch_pad_config` or at the runtime with :cpp:func:`touch_pad_set_thresh`. + +In next step configure how interrupts are triggered. They may be triggered below or above threshold and this is set –with function :cpp:func:`touch_pad_set_trigger_mode`. + +Finally configure and manage interrupt calls using the following functions: + +* :cpp:func:`touch_pad_isr_handler_register` +* :cpp:func:`touch_pad_isr_register` / :cpp:func:`touch_pad_isr_deregister` +* :cpp:func:`touch_pad_intr_enable` / :cpp:func:`touch_pad_intr_disable` + +When interrupts are operational, you can obtain information what particular pad triggered interrupt by invoking :cpp:func:`touch_pad_get_status` and clear pad status with :cpp:func:`touch_pad_clear_status`. + + +Wakeup from Sleep Mode +^^^^^^^^^^^^^^^^^^^^^^ + +If touch pad interrupts are used to wakeup the chip from a sleep mode, then user can select certain configuration of pads (SET1 or both SET1 and SET2), that should be touched to trigger the interrupt and cause subsequent wakeup. To do so, use function :cpp:func:`touch_pad_set_trigger_source`. + +Configuration of required bit patterns of pads may be managed for each 'SET' with: + +* :cpp:func:`touch_pad_set_group_mask` / :cpp:func:`touch_pad_get_group_mask` +* :cpp:func:`touch_pad_clear_group_mask` + + +.. _touch_pad-api-examples: Application Examples -------------------- @@ -14,6 +135,9 @@ Application Examples - Touch sensor read example: :example:`peripherals/touch_pad_read`. - Touch sensor interrupt example: :example:`peripherals/touch_pad_interrupt`. + +.. _touch_pad-api-reference: + API Reference -------------