From b101e118f2235c601ff623784851b3574356e208 Mon Sep 17 00:00:00 2001 From: krzychb Date: Sat, 16 Jun 2018 21:46:27 +0200 Subject: [PATCH] Renamed ESP-WROOM-32 to ESP32-WROOM-32/D/U including links to data sheets, reflected upcoming ESP32-SOLO-1 as one of options for ESP32-DevKitC, provided updated schematics and notes on C15. --- docs/_static/esp32-devkitc-c15-location.png | Bin 0 -> 12080 bytes docs/en/api-guides/jtag-debugging/index.rst | 2 +- .../jtag-debugging/tips-and-quirks.rst | 4 +- docs/en/get-started/get-started-devkitc.rst | 45 ++++++---- .../en/get-started/get-started-wrover-kit.rst | 8 +- .../modules-and-boards-previous.rst | 4 +- docs/en/hw-reference/modules-and-boards.rst | 82 +++++++++++------- 7 files changed, 87 insertions(+), 58 deletions(-) create mode 100644 docs/_static/esp32-devkitc-c15-location.png diff --git a/docs/_static/esp32-devkitc-c15-location.png b/docs/_static/esp32-devkitc-c15-location.png new file mode 100644 index 0000000000000000000000000000000000000000..1b3b84441581cab3200837147d8cd11e72c62ad1 GIT binary patch literal 12080 zcmeHtXH=6-*KQP~DWHggfHYA$C>`m&_pTHvp@q;1y{Sl1dJvH&ARvf>fzXRm1VU9b zfe^ZYl+Yn!fSenj=X>ApoORAx=lOAdoV8xoy)tvp?73!U&&KM%F>+j?0;RWUl4D|(bfK`5h_^(mN-;+ny2d+6&bBlx8Oa{R~SHKNqIxW&M*H#FP$ zpj&g?bJ=!%NceI-%L~gr{}8~jxL|3dc;_*)5pIz&%vMDK{)7X9zy zfgY~^2l3OIe~X_szH96e0`{_2_ke=E1ArkYa7)NY{{j1Vt<8U{m6DM7Q+tYZR|o3o z2Db8W33UH=vwv4;gFW2bftmbIO^p0Kz<>@;XRE+{hgp$xHM;iD?!vEP_|54XJ(!f6w{?G3E|4Uso|90-c-hf9J47hG@D-_KE zw~s79RmYr)ifVGsXch$G1nH=&n1^8TQ}X~|jmbr-*o$#$R*<%IWHC)hcNzr_(T(t^iY}VG2h?>8SXqKKt{wNqL(1&5eeojS-XfjBqkaLJvs@R8M++tIV!Xo$ zqrXmyo{R5a4bQW>#0VHn#WvF&VF!^HM-d=~;wrB*EoFGhcJ+Vp^hDrC@wq z!un27GoLM;l0czi%F=j{vottJ+Z4fH-{Fb-FsxuBpRye2%Lwl(_kVG+;XHjk)lf-v zu$)bVx_Mn@<9Wp${SQv#3-?OI9C$?H4Q2C8=%zA}<%EslH*D>Os4x7JKP~f1;zd@` ztwQf9msTaUp^A)hO2&TU?63>S%nFa+ zEn96X@q17$T*KqC7cfNwS)Sdm&9B%T=vu1sU7cK##+~+DKJ2i}eZ2XMR()>V-}=i8 ze|%(Yf){>aplC#YLQK*mMYA4ueqQl4TUmaT3Ej;w4>v}U>z=M+5ZRW=DSzVYX7~7GQMdTx8ICGrG zVo$V+(bYIKifiRUe;uM0gq1~!tfaBoY$Fe}UB=?pwgbGsdol(Ftj_<&L4r)QE$PhY zOpNKSz`GpXZb+VYLk4Aj60QG2F-^dN@uOn4InNu81!yck*K;(A^*S6%uc%7|gOX|v z7?0SBb)-+me&431+`Dt_OYo=N`EY@yzSYNN!?y`{plpO}KQT(HM^ zx>dp|PoGQr-;QHmtfd_4n{vpZrEP54w$?YK;sE9gR)1L|#a6peDx~U_kuQo(Q0=x_ zL2~I!rXI+NCJe8jh6OJ=*Z>Dn!TNHa8-|Y$3l|T^$9J`H(`&Ny89wr&Ps(Uy%P1K$ zvo}0rBba*moa$ORrNr<#`u)Y%cV52Uyhhy&!~A@;%uvB zjyS%r`TFI^=KCbo;L)jb^OVK#&30W&x-q96qcw*&YzO2{7SvTCI;;LNYm-ruOi%1u zFtXdm+P(Q0mF08-7Z*!fPu-4nfGJgcFLyB0yIign!(XUU57PF7$oR*0k0&aXuj^kT zGnu%c!{k^g@RADHk?p>^mlEXNv;!$)zFvGP(RRRf+*7H!&=s({CN%8cKo8yiT}*SM z+&>|-v4rib&Pt8HF9!pNFHsoHK4QOOg6sV3_+oj6Ble9Xt40x0d9UYsL27t?O>;@- zqH-&IU;aWbWwGe!SyU0izmNB#T#2u&g20GtV(ArJ>hh)x>BK2-_eT-;V``4q9Bm!e zzTG>H!~vIg?X?M$4oA*|U9MQpzV$?9-okH?SZ ziu_1R7B9;-&u)Lk68EPPgo=sWql~dx#cZaO+@n*y*=o_gB}^e{Cr6KA{t`}QBKN~{ z+k2lErxmB#$n4pO#1pl$x(r3%WsG!^jQHcJtWJ{e6I{=Gj?Y+1^evgZjGtRxR*Vp> zmcNuRWD;U^siM4`+^IZ*8#eLbR}w#&KSP`}_tMGxXo!h&MSyB#p#pLWIjhQa_^XjX75saueY=#2yxU<_=f(z4hEcY#VY&%3h z6yK)rDtu>Eu#Ys4>h=$@3@D~o=8w;gmDv_UC7AruO|Mv((K+0x4c*)c!eyhr_ss|T zk)HTJYJ?=I!u_eXdj{$_YST4V7H>bn3o*6Abr=ev-#rrOhV|oyLv|pT6Xed6WHTUV(zRqZ!{w!r(x#yZ-tyR ziim;N*FyAlFA*{kN>X9)>uqf9N_OAH+rxHNP>RD?F0}(U0z6Yf`1rOZC+x1OtQR|8 z$)l{5So_@OvDoVKxKqMP=xpxsW-i%e=Itd5juGyg@8%85dB5P!80{-)D%E zFR9tK^FH@k=jo+m+a^9fN)s7Hnn=Gc9+m&1$8)rqK|Z0Se}x&`k6m8|Brrt7;2>uLc9*LDx;@DNv2czf z2Fqq6MeFsv-VI#chIS!#8Eqj&6^JQ&q{bZeuEvBlRq(>4nTeUU@O$vkR8_UHK5{}m zmRdfHSgEL2^G^G*-0~>n_59VIHr~5j)yFh!VvpA3|TfEHT*pO_S5VdvPfWc=50^2a?7@!(CcduGDP%U+gUtBUkER%nGcemi!sM7Bta8dv z4R8}Sll^>>kA_f&()IYqPa4%Uo%acvmC)JS4rGPzj<>yIC%vzqHb4oULB8{R%N;a@C9(4`6s4G6jW#XXZmUy~Ywt-Bt9%z%<_8wt>=(g%-FA4C zbtEF0GbvoMG zuV6X#My8>DX?$6FQ~K8JcWr_brSo9{32hU)qPzXCbsrdLdc;F$4IpC^=N++myxG4~ zI)B}Le_cRMDpgLAej_DZ(5lE|>!K`=n@H9bW(S|Bcc|2_2bweGXhs%HvUm@m1y7IlshPI$AYbhKct!JI#(xl997A3pPLOf|%5 zdN6rG+ZA_&UpVC|o2gfJkJh2x;|uerr8wJY$hq(Jb17NkKk{7oM+f^K2^-6{aea(h z3YDUgdEv-x&HBpgqBP_Y;tUX07)yBM|T`nlXHKIg}hsV(Yp;JMectN1X-gz6N3aE z+B2tE|H{G~8;9vZK(Jy>e4{ye1qZTb1%1R)vp_))peTwMs=SD3{LnOyEhr3n#9GdM z=1*HmEXX>S8vp|`7h|7t%|bv`L*GEg6-cGZu}D?WEYmI)K>4rH{?#7{2#$c~0Tcvu zr>wJQhZ)*kC!5!4y7rJZl=|i?@;xBFy8D-qwpu;`)85hamOmU+mETfvjSU20x&@)2 z{D?hA{5>_$#0r8eZ$LIEj71jh)EG=A2m|^btU>NmSe+@|KXbU4nX!cI3ZGjJUHyn@ zzIh&mR@9ytsBeo73^nPd<#ZFs;j&qraAXd-27(lhx%*gdb)L_EPW}VWxQlHv| zoM0)<`+{p$fLozVnQ(y<-p8QZ<}#%ipMq^RIcZjI^q*F!7o z#I4k5=?)0}_Gc>_MHj%N#p+q1zl68nkX>VU~*A|Ha?@gb^CobSZCgccXtb4O8&-S#7=L z%_~cquh>|Su+8^ zHPlG@6e+LWif<5`h{bDe^o2!O<_v2_-b@=I*PCcNDA=@gXm@K+Pc8OJmhxX{-mi;L zv^sM&fFmRBe&xxLk}a}*F9z}DLCf`Nq14dAhF0^-S=J(Gcdb}NdO(Z9^9ThU9dRDY zUvPx8Bv$ze9(J8|J`Cz!_rZ3lv*0u2YLjtfyfJYb)`o$PBm6QkbcClrW>%Sggx{Urxp?3`7AHzi9tg6{;? z;fDYHYp~j4;nt$NCabRV;*QqLLCerWkiwHymI6BorRzWsth#9A+YvCXf@G zh%b!lq2KQnMIU*V4&8r!N9*g4RKynKSu?Ah+C$t8 zve$G^ka~D3H2av{n9)<-RiPL&kprsGF{ogD?N#fR`jiKxAJ`>!7cQpA3zXODyB2aU zC+b)QMGJrPz#r0G*XkP}2!&cKnMhT7G)PyO!VgN>AsymD=O{Rslstou1GiUxtz_OK zkZ==ItzHd7$()uuTET=~7;!3hqw1vsUXQeZ^sn}tUZ1}qeF!tJzO%7b#w2p>=tVY{ zC*8=mg7>TQ&lL|h$3nix+fE-!ZyBgf&llZQr75aLV5TP&G1AdzIW1eJZsuCdDCtU7o481{H^`%IeBdkk>j!?#ipJ=eBXIoY5nKP1fq zdVs$HZ}XZYYGpHN;6VOm8P_r_3ih*{0n1sZ8D9I4$^K^@4`60GdH{p1SoisaqM=ZFc7cg_67>cT6 z1U^}&+%b$CFn(lUvIlr4EMSvAVzq)%xkD`xBi=cH30`QJoW!;D?t^?qvOVj0o+q3d zXSsVV`OR8}uh-i@f1`dD*T#7OkC6!fynkwyOZPjQRY6sDFYfcRDqms@mD=g8F;qJH z0AG(A!T^(D3!Yh65C>Vec%_mlOE&J%|3wLZ2K*Nh&3^6FRCM@+UsVQRo>Xs=My7x+ zi#)9)2e{7XEax%q%11vsy&r>c6s;%dae9NQ zBI|sEUuHJ~dbwk8*N==ZPUttGgAn6bnz=!+ZD~665{{FN`H8e6;$((O$i(@k2&FHD>PJ9tayW=Fh9@31yLIU zeN9Cc`Ezc+oaa6;R*JDdol^Omx%MNYNo+a!X-Nz1-e0NdDZ$ zGiVC%Wocjb4YiE8N*3s~um!T8$e`^0z2F~Vt3d7WH!L9xHBsw_!8`WoUpq5rdqKt9 zjNA>cYG|9&E`8_hV<-Fjn8M02%2ycge29|5kz1>Q3H+Ey%D+w+Ve!5%2vX@SdotTi zM_Aa~K+q})?BqXWns)Ef+X&`W5)9}F4s8k>*~}OTqy-%~ObO8iX))?Y=(fWb96V*02)#erXDO_5n1{Xf{wP=2&JWfG>AM zQzUQ(0{nIi)Yqm@q1Nu_C6m_^0OyC}Fskb|^WO0fSnL$Cu)ylGMT{~7gySe`SN?La zL3>pB`i6HqtMVtbra?P!gse?rOq&bomkw7dW`@#033}06tuV~Nw}XP(bow@!_8Q)c z$G8YdACek>oebhrbD$E18eMO9s-h)#dh%L33i_h!T1R$EW_I-1@l>O_ zYy-=HUV1@idsb}~QuXA!wdQD3_Vkxr)OnOtt<}>liUf^7`aFz%Hq2E!W@vFNXiE4u zgNT7vuE?9JDCm(7`#302L>sB11`!`b???Z0S z9NsIT6?$M#B==jB<_9+0e3{oP>cO||DuG?)hZ$evPwfrZL|*5{n4JbNNPfzXI3;8b)HU8DcMQR9{ zZhGTl{~7cN2EXJ)#-}m=oVUlCSlCV~Z0`uNtKv}RXK0YuafhmbO0{u2kCA8oN{Sdw zT27lUuoW1Ecqv9cgmoX6crA}xv+}w(C)~Uo?A^ax3(1zPO1`0QN62LeKId0;E5Mp{ z^8827i@`-Ef_H(Jo^rY1Z0-#lw}tysjg)|n-^Q>FPFAbDanKQJo`uHc=QipkYOCaQ zVSnWfp>rBpsnstD4r1S!MR!LwH~NUhBe^0ITNwRjT<9PRvsG;q7w5f01_P#P(3;1> z0)8B~HgW+ZZL>*>q(9PU;NyOekVRa`pr)t9)6u+kW!1YxFaSFLIr#iJ_aE_#Ie1|W zoHWoWNO!&Q6E;Cv+o0YCX?x|b!cl#dj0ZUb9o`MY(%cyP%+2<_Fz5&SmX)C!V^gAL zA2Y5NNVOdv<5fQ!`5Y*WL_e7eom`C6&QM>uTdi00EJJ>*+&1h(+O|PGj+EoL#J0V$ zJ5zF7KKZPvuS5K%r&*l68H0A@Kfrp*I{Iu&MpXnYvx$l21Ic>JxIAZubswk!QkH27iC%T9}BHkidN9xTI-EIDml9sOVoQk$55|-r^)Z$9_;dsMAnX!Pqh!) zZ0M({i3ic{IzJR4f|1o5jq$TM%X862lo8R)X-1SHn8&pH0+B{fNrhK;eh_@|Bez@E z8b@?l#d+RInH6?NCi~uIE$w=Vc3|J?+u7@r9~n+lsy+N#0?8v3GOV5SbS`&{&8px= zYyvH@FStC+an!D|-1XYL@99sbTR1ME&t~wx-Q}*D;^u&Cvj{JgGmqeQHVE-;7=IeE zXulacRGzg*J>=Yb;_4d)h#cckAp|RM_hn(%^xMX=%|>VX9dkWd^(EC3ZCi1(Z#(Dj zVQ1H!y!@)0*nCm^j*3D}-R5`H9;W8^)FD-+%)ixw?`OqZ+2m-~Av8aO7tv;1(6wSWV({by%W0VR~8 z^Q$sRdISEiu5(3ZV!iuVzW0~u!LZ?5l?eKgq?M{4hy8isHXW_@_p6h4o63Yco26?! zz`X3^3mMDHm+>PV!Ln1CkC7(cZ3b`YTurpIBk%3B%F7IFB_tzF+%Fjp3`i)LHX=s! z3xG2LAHQQz&ZcMvTj7fc zmc>ZP)7eb5zI!PmCxkZptv>Zao_?99kO-PNczTw(!8(XWFk{8QO#(XUR`qhAZ2cR` zK1Y_=#^x4H@{R8xKJFKG8%&e9_dJ%vOY|6B#x*uUJDj#|egM^5(m&&r|8N;q#;h7W z6j{=?zE->5kHuTM{<^NC8%SWb1qC>xQ@(;{T!up-?oY_S?2OY$7klLdhzx7i>vfb( zv7h(I|D1J0d7>gy3ovN@{p*mN{j!1QvZZcx5J&@S5ZEjkMg#USWY4L+4BS_MOL(mB zw?N;wp()ZQz9O2}?f;lYsprM(niNuRXf}-Lc0l^QbSMpq4Xt@|aXD%tqdXnh z7K{#2?b`Y~5?KJ1JRGS0WOT-IYo(Vhqx|P37ihQ6ac)@2dTVC+OF)!|KQY&-WW6@C z96ji_$YJ_@uCkESHZ`sA`2B}TRp`LwoJTCHIGXs|Bem)2yfHsST=T^nq;#%jGV$j| zSI5G{h`+uM%aZsf`{Z{mP%7LkbA|2Yl@50flO8R~dx%@K>&hCE`oW~l6rGTsIsJKy}3>%Zx!u#?FrM;*Yb|gH=3yD0yhE51SIRt z`T32kSx;N)>V$S;jg#TR7P_d*Ge8&+RQP-6m~K~tpt<3IxM@Ri_# z@X?P~oS~dq6-tWTv)yfT?$401k0OpY`f&!hx0atHmK{(lj78&pwGFCkD-3r>z z$NEg0lrI7yIW+{sO&(mUqIG$FZ{AxAmpd7OrclOdJq;fjyZ|8!MSjNOfqU!#v3z9g z`kpTC%F}Stp%L&k!K3c$iy2qY6#icE$jSXgIkd%-s^lj!Yb@1{1sqW-kolAlM;Smf zXFberZn%X4s=1{7Lg0&1R6n4bw>fk+BRX$TMp=x7FWdk{a_Us_H20rs^1X;g39rSl zsT7c(7US3W1{cuTeT@7PCdqD=)Fn@{Js=RzdtM1%wUdL8sbsPfN@dPb&5IcVy*~hth@;Xkn*T%!6Kf}>tDn^c!&lJ?S(J#da#i@d z6x2v<)w3|^`sudb%6tIN6rkM1+OUS$B{zFLevR4&*7D<;=aF^N3f3`M%9_>sQz}AD zgi^oA3MC?Fl+q!07D6Vf`yrs3;qhYsc7=aMi1o6#VyskS-P`A;>z!q~WpAcFXts3A zuRL`7zK5OQCw3DQGVbRn0luOrslzxa7HTf^-4s@YQfyp!KZaed41i@PCh6X>#f9g| znZOQ1{a>7Zi%}@LqZj6%QT?_*(;4`XLwPix)Y)_0+ff(>Mk#9IvXz3}MxM{~F4HP+ z#Fomn`ILGzdxNVDvV_rB={Y?lzXn23hQb?9s`7unlwW2~WQ9k%RQ^QzoyCwOUO6lC z{@&@wcsG-FiAuy_rFdIWBOE-^sj^1O(DPJPSi!*?KnZerIO%(aC7=j3BYbp4iUP14qysUO|68M5UbfyCDeHGP;7+yow`y z0jmJWz5uen)#3gSj}AdXK^50$IdRD>4&a&=1$MCtRou^%-v`CV6&dNs8`D!m_2wg~ zGo%Y$gc;00bYbwJJkax7WFGBz!wtM?bOi$`skurF?c`DOYe~sPjFqAm z6{jNU&m%k=nBFr+{33OgdnK^u2!Cl0iY`$#$ve_c(O#MW89K9~*;AwcFqhYB2UiHDl F{{i9BC|&>n literal 0 HcmV?d00001 diff --git a/docs/en/api-guides/jtag-debugging/index.rst b/docs/en/api-guides/jtag-debugging/index.rst index 65f2e15184..16ab37d78a 100644 --- a/docs/en/api-guides/jtag-debugging/index.rst +++ b/docs/en/api-guides/jtag-debugging/index.rst @@ -163,7 +163,7 @@ Open terminal, go to directory where OpenOCD is installed and start it up:: .. note:: - The files provided after ``-f`` above, are specific for ESP-WROVER-KIT with ESP-WROOM-32 module. You may need to provide different files depending on used hardware, For guidance see :ref:`jtag-debugging-tip-openocd-configure-target`. + The files provided after ``-f`` above, are specific for ESP-WROVER-KIT with :ref:`esp-modules-and-boards-esp32-wroom-32` module. You may need to provide different files depending on used hardware, For guidance see :ref:`jtag-debugging-tip-openocd-configure-target`. .. highlight:: none diff --git a/docs/en/api-guides/jtag-debugging/tips-and-quirks.rst b/docs/en/api-guides/jtag-debugging/tips-and-quirks.rst index fb48f6d8b5..17200de065 100644 --- a/docs/en/api-guides/jtag-debugging/tips-and-quirks.rst +++ b/docs/en/api-guides/jtag-debugging/tips-and-quirks.rst @@ -55,7 +55,7 @@ Why to set SPI flash voltage in OpenOCD configuration? The MTDI pin of ESP32, being among four pins used for JTAG communication, is also one of ESP32's bootstrapping pins. On power up ESP32 is sampling binary level on MTDI to set it's internal voltage regulator used to supply power to external SPI flash chip. If binary level on MDTI pin on power up is low, the voltage regulator is set to deliver 3.3V, if it is high, then the voltage is set to 1.8V. The MTDI pin should have a pull-up or may rely on internal weak pull down resistor (see ESP32 Datasheet for details), depending on the type of SPI chip used. Once JTAG is connected, it overrides the pull-up or pull-down resistor that is supposed to do the bootstrapping. -To handle this issue OpenOCD's board configuration file (e.g. ``boards\esp-wroom-32.cfg`` for ESP-WROOM-32 module) provides ``ESP32_FLASH_VOLTAGE`` parameter to set the idle state of the ``TDO`` line to a specified binary level, therefore reducing the chance of a bad bootup of application due to incorrect flash voltage. +To handle this issue OpenOCD's board configuration file (e.g. ``boards\esp-wroom-32.cfg`` for ESP32-WROOM-32 module) provides ``ESP32_FLASH_VOLTAGE`` parameter to set the idle state of the ``TDO`` line to a specified binary level, therefore reducing the chance of a bad bootup of application due to incorrect flash voltage. Check specification of ESP32 module connected to JTAG, what is the power supply voltage of SPI flash chip. Then set ``ESP32_FLASH_VOLTAGE`` accordingly. Most WROOM modules use 3.3V flash, while WROVER modules use 1.8V flash. @@ -93,7 +93,7 @@ Configuration of OpenOCD for specific target OpenOCD needs to be told what JTAG adapter **interface** to use, as well as what type of **board** and processor the JTAG adapter is connected to. To do so, use existing configuration files located in OpenOCD's ``share/openocd/scripts/interface`` and ``share/openocd/scripts/board`` folders. -For example, if you connect to ESP-WROVER-KIT with ESP-WROOM-32 module installed (see section :doc:`ESP32 WROVER KIT <../../hw-reference/modules-and-boards>`), use the following configuration files: +For example, if you connect to ESP-WROVER-KIT with ESP-WROOM-32 module installed (see section :ref:`esp-modules-and-boards-esp-wrover-kit-v1`), use the following configuration files: * ``interface/ftdi/esp32_devkitj_v1.cfg`` * ``board/esp-wroom-32.cfg`` diff --git a/docs/en/get-started/get-started-devkitc.rst b/docs/en/get-started/get-started-devkitc.rst index 9033097627..9898619b82 100644 --- a/docs/en/get-started/get-started-devkitc.rst +++ b/docs/en/get-started/get-started-devkitc.rst @@ -17,7 +17,7 @@ Overview ESP32-DevKitC V4 is a small-sized ESP32-based development board produced by `Espressif `_. Most of the I/O pins are broken out to the pin headers on both sides for easy interfacing. Developers can connect these pins to peripherals as needed. Standard headers also make development easy and convenient when using a breadboard. -The board comes in two versions, either with :ref:`esp-modules-and-boards-esp-wroom-32` or :ref:`esp-modules-and-boards-esp32-wrover` module soldered. +The board supports various ESP32 modules, including :ref:`esp-modules-and-boards-esp32-wroom-32`, :ref:`ESP32-WROOM-32U `, :ref:`ESP32-WROOM-32D ` and :ref:`esp-modules-and-boards-esp32-solo-1`. Functional Description @@ -25,10 +25,8 @@ Functional Description The following list and figure below describe key components, interfaces and controls of ESP32-DevKitC V4 board. -ESP-WROOM-32 - :ref:`esp-modules-and-boards-esp-wroom-32` module soldered to the ESP32-DevKitC V4 board. -ESP32-WROVER - Optionally :ref:`esp-modules-and-boards-esp32-wrover` module may be soldered instead of the ESP-WROOM-32. +ESP32-WROOM-32 + :ref:`esp-modules-and-boards-esp32-wroom-32` module soldered to the ESP32-DevKitC V4 board. Optionally ESP32-WROOM-32D, ESP32-WROOM-32U or ESP32-SOLO-1 module may be soldered instead of the ESP32-WROOM-32. USB-UART Bridge A single chip USB-UART bridge provides up to 3 Mbps transfers rates. Boot @@ -44,21 +42,16 @@ I/O .. note:: - Some of broken out pins are used internally be the ESP32 module to communicate with SPI memory. They are grouped on one side of the board besides the USB connector and labeled D0, D1, D2, D3, CMD and CLK. In general these pins should be left unconnected or access to the SPI flash memory / SPI RAM may be disturbed. - - .. note:: - - GPIO16 and 17 are used internally by the ESP32-WROVER module. They are broken out and avialable for use only for boards that have the ESP-WROOM-32 module installed. - + Some of broken out pins are used internally by the ESP32-WROOM-32, ESP32-WROOM-32D/U and ESP32-SOLO-1 modules to communicate with SPI memory. They are grouped on one side of the board besides the USB connector and labeled CLK, D0, D1, D2, D3 and CMD (GPIO6 - GPIO11). In general these pins should be left unconnected, otherwise access to the SPI flash memory / SPI RAM may be disturbed. .. _get-started-esp32-devkitc-board-front: .. figure:: ../../_static/esp32-devkitc-functional-overview.jpg :align: center - :alt: ESP32-DevKitC V4 with ESP-WROOM-32 module soldered + :alt: ESP32-DevKitC V4 with ESP32-WROOM-32 module soldered :figclass: align-center - ESP32-DevKitC V4 with ESP-WROOM-32 module soldered + ESP32-DevKitC V4 with ESP32-WROOM-32 module soldered Power Supply Options @@ -75,6 +68,25 @@ There following options are available to provide power supply to this board: Above options are mutually exclusive, i.e. the power supply may be provided using only one of the above options. Attempt to power the board using more than one connection at a time may damage the board and/or the power supply source. +Note on C15 +----------- + +The C15, on the board of earlier batches of V4, may bring two issues: + +1. The board may boot into download mode; +2. If users output clock on GPIO0, C15 may impact the clock output. + +As a result, if users believe that C15 will impact their use of the board, they can remove it completely (please refer to the screenshot below for the precise location of C15 that is colored in yellow). Otherwise, users do not need to concern about C15. + +.. figure:: ../../_static/esp32-devkitc-c15-location.png + :align: center + :alt: Location of C15 (colored yellow) on ESP32-DevKitC V4 board + :figclass: align-center + :width: 30% + + Location of C15 (colored yellow) on ESP32-DevKitC V4 board + + Start Application Development ------------------------------ @@ -102,10 +114,11 @@ Board Dimensions Related Documents ----------------- -* `ESP32-DevKitC V4 schematic `_ (PDF) +* `ESP32-DevKitC V4 schematic `_ (PDF) * `ESP32 Datasheet `_ (PDF) -* `ESP-WROOM-32 Datasheet `_ (PDF) -* `ESP32-WROVER Datasheet `_ (PDF) +* `ESP32-WROOM-32 Datasheet `_ (PDF) +* `ESP32-WROOM-32D/U Datasheet `_ (PDF) + .. toctree:: :hidden: diff --git a/docs/en/get-started/get-started-wrover-kit.rst b/docs/en/get-started/get-started-wrover-kit.rst index f3455da92f..74e59cf737 100644 --- a/docs/en/get-started/get-started-wrover-kit.rst +++ b/docs/en/get-started/get-started-wrover-kit.rst @@ -17,7 +17,7 @@ What You Need Overview ^^^^^^^^ -The ESP-WROVER-KIT is a development board produced by `Espressif `_ built around ESP32. This board is compatible with ESP32 modules, including the ESP-WROOM-32 and ESP32-WROVER. The ESP-WROVER-KIT features support for an LCD and MicroSD card. The I/O pins have been broken out from the ESP32 module for easy extension. The board carries an advanced multi-protocol USB bridge (the FTDI FT2232HL), enabling developers to use JTAG directly to debug the ESP32 through the USB interface. The development board makes secondary development easy and cost-effective. +The ESP-WROVER-KIT is a development board produced by `Espressif `_ built around ESP32. This board is compatible with ESP32 modules, including the ESP32-WROOM-32 and ESP32-WROVER. The ESP-WROVER-KIT features support for an LCD and MicroSD card. The I/O pins have been broken out from the ESP32 module for easy extension. The board carries an advanced multi-protocol USB bridge (the FTDI FT2232HL), enabling developers to use JTAG directly to debug the ESP32 through the USB interface. The development board makes secondary development easy and cost-effective. .. note:: @@ -47,7 +47,7 @@ The following list and figures below describe key components, interfaces and con 0R A zero Ohm resistor intended as a placeholder for a current shunt. May be desoldered or replaced with a current shunt to facilitate measurement of current required by ESP32 module depending on power mode. ESP32 Module - ESP-WROVER-KIT is compatible with both ESP-WROOM-32 and ESP32-WROVER. The ESP32-WROVER module features all the functions of ESP-WROOM-32 and integrates an external 32-MBit PSRAM for flexible extended storage and data processing capabilities. + ESP-WROVER-KIT is compatible with both ESP32-WROOM-32 and ESP32-WROVER. The ESP32-WROVER module features all the functions of ESP32-WROOM-32 and integrates an external 32-MBit PSRAM for flexible extended storage and data processing capabilities. .. note:: @@ -58,7 +58,7 @@ FT2232 UART Serial port: the serial TX/RX signals on FT2232HL and ESP32 are broken out to the two sides of JP11. By default, the two signals are connected with jumpers. To use the ESP32 module serial interface only, the jumpers may be removed and the module can be connected to another external serial device. SPI - SPI interface: the SPI interface connects to an external flash (PSRAM). To interface another SPI device, an extra CS signal is needed. The electrical level on the flash of this module is 1.8V. If an ESP-WROOM-32 is being used, please note that the electrical level on the flash of this module is 3.3V. + SPI interface: the SPI interface connects to an external flash (PSRAM). To interface another SPI device, an extra CS signal is needed. The electrical level on the flash of this module is 1.8V. If an ESP32-WROOM-32 is being used, please note that the electrical level on the flash of this module is 3.3V. CTS/RTS Serial port flow control signals: the pins are not connected to the circuitry by default. To enable them, respective pins of JP14 must be shorted with jumpers. JTAG @@ -394,7 +394,7 @@ Related Documents * `ESP-WROVER-KIT V3 schematic`_ (PDF) * `ESP32 Datasheet `_ (PDF) * `ESP32-WROVER Datasheet `_ (PDF) -* `ESP-WROOM-32 Datasheet `_ (PDF) +* `ESP32-WROOM-32 Datasheet `_ (PDF) * :doc:`../api-guides/jtag-debugging/index` * :doc:`../hw-reference/index` diff --git a/docs/en/hw-reference/modules-and-boards-previous.rst b/docs/en/hw-reference/modules-and-boards-previous.rst index 27fefb8a64..92e96257fe 100644 --- a/docs/en/hw-reference/modules-and-boards-previous.rst +++ b/docs/en/hw-reference/modules-and-boards-previous.rst @@ -35,7 +35,7 @@ Documentation ESP32 Core Board V2 / ESP32 DevKitC ----------------------------------- -Small and convenient development board with :ref:`esp-modules-and-boards-esp-wroom-32` module installed, break out pin headers and minimum additional components. Includes USB to serial programming interface, that also provides power supply for the board. Has pushbuttons to reset the board and put it in upload mode. +Small and convenient development board with ESP-WROOM-32 module installed, break out pin headers and minimum additional components. Includes USB to serial programming interface, that also provides power supply for the board. Has pushbuttons to reset the board and put it in upload mode. .. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-core-board-v2.png :align: center @@ -61,7 +61,7 @@ The first version of ESP-WROVER-KIT development board. Shipped with ESP-WROOM-32 ESP-WROVER-KIT has dual port USB to serial converter for programming and JTAG interface for debugging. Power supply is provided by USB interface or from standard 5 mm power supply jack. Power supply selection is done with a jumper and may be put on/off with a separate switch. The board has MicroSD card slot, 3.2” SPI LCD screen and dedicated header to connect a camera. It provides RGB diode for diagnostics. Includes 32.768 kHz XTAL for internal RTC to operate it in low power modes. -All versions of ESP-WROVER-KIT are ready to accommodate an :ref:`esp-modules-and-boards-esp-wroom-32` or :ref:`esp-modules-and-boards-esp32-wrover` module. +All versions of ESP-WROVER-KIT are ready to accommodate an ESP-WROOM-32 or ESP32-WROVER module. .. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-devkitj-v1.jpg diff --git a/docs/en/hw-reference/modules-and-boards.rst b/docs/en/hw-reference/modules-and-boards.rst index 0ab45789ac..47dcf40dd0 100644 --- a/docs/en/hw-reference/modules-and-boards.rst +++ b/docs/en/hw-reference/modules-and-boards.rst @@ -13,8 +13,8 @@ For details please refer to documentation below, provided together with descript This section describes the latest versions of boards. Previous versions of boards, including these not produced anymore, are described in section :ref:`esp-modules-and-boards-previous`. -WROOM and WROVER Modules -======================== +WROOM, SOLO and WROVER Modules +============================== A family of small modules that contain ESP32 chip on board together with some key components including a crystal oscillator and an antenna matching circuit. This makes it easier to provide an ESP32 based solution ready to integrate into final products. Such modules can be also used for evaluation after adding a few extra components like a programming interface, bootstrapping resistors and break out headers. The key characteristics of these modules are summarized in the following table. Some additional details are covered in the following chapters. @@ -23,66 +23,82 @@ A family of small modules that contain ESP32 chip on board together with some ke --------------- ------------------------------- ---------------- Module Chip Flash RAM Ant. L W D =============== ============ ===== ==== ==== ==== ==== ==== -ESP-WROOM-32 ESP32-D0WDQ6 4MB -- MIFA 25.5 18 3.1 -ESP-WROOM-32D ESP32-D0WD 4MB -- MIFA 25.5 18 3.1 +ESP32-WROOM-32 ESP32-D0WDQ6 4MB -- MIFA 25.5 18 3.1 +ESP32-WROOM-32D ESP32-D0WD 4MB -- MIFA 25.5 18 3.1 ESP32-WROOM-32U ESP32-D0WD 4MB -- U.FL 19.2 18 3.2 +ESP32-SOLO-1 ESP32-S0WD 4MB -- MIFA 25.5 18 3.1 ESP32-WROVER ESP32-D0WDQ6 4MB 4MB MIFA 31.4 18 3.2 ESP32-WROVER-I ESP32-D0WDQ6 4MB 4MB U.FL 31.4 18 3.5 =============== ============ ===== ==== ==== ==== ==== ==== +* ESP32-**D**.. denotes dual core, ESP32-**S**.. denotes single core chip * MIFA - Meandered Inverted-F Antenna * U.FL - U.FL / IPEX antenna connector * `ESP32 Chip Datasheet `__ (PDF) +* Note: *ESP32-WROOM-32* was previously called *ESP-WROOM-32* -.. _esp-modules-and-boards-esp-wroom-32: +.. _esp-modules-and-boards-esp32-wroom-32: -ESP-WROOM-32 ------------- +ESP32-WROOM-32 +-------------- A basic and commonly adopted ESP32 module with ESP32-D0WDQ6 chip on board. The first one of the WROOM / WROVER family released to the market. -.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp-wroom-32.jpg +.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-wroom-32-front-back.jpg :align: center - :alt: ESP-WROOM-32 module (front and back) - :width: 40% + :alt: ESP32-WROOM-32 module (front and back) + :width: 45% - ESP-WROOM-32 module (front and back) + ESP32-WROOM-32 module (front and back) Documentation ^^^^^^^^^^^^^ -* `ESP-WROOM-32 Schematic `__ (PDF) -* `ESP-WROOM-32 Datasheet `__ (PDF) -* `ESP32 Module Reference Design `_ (ZIP) containing OrCAD schematic, PCB layout, gerbers and BOM +* `ESP32-WROOM-32 Datasheet `__ (PDF) +* `ESP32-WROOM-32 Reference Design `_ containing OrCAD schematic, PCB layout, gerbers and BOM -.. _esp-modules-and-boards-esp-wroom-32d-and-u: +.. _esp-modules-and-boards-esp32-wroom-32d-and-u: -ESP-WROOM-32D / ESP32-WROOM-32U -------------------------------- +ESP32-WROOM-32D / ESP32-WROOM-32U +--------------------------------- -Both modules have ESP32-D0WD chip on board of a smaller footprint than ESP32-D0WDQ6 installed in :ref:`ESP-WROOM-32 `. Version "D" has a MIFA antenna. Version "U" has just an U.FL / IPEX antenna connector. That makes it 6.3 mm shorter comparing to "D", and also the smallest representative of the whole WROOM / WROVER family of modules. +Both modules have ESP32-D0WD chip on board of a smaller footprint than ESP32-D0WDQ6 installed in :ref:`esp-modules-and-boards-esp32-wroom-32`. Version "D" has a MIFA antenna. Version "U" has just an U.FL / IPEX antenna connector. That makes it 6.3 mm shorter comparing to "D", and also the smallest representative of the whole WROOM / WROVER family of modules. -.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp-wroom-32d-front-back.jpg +.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-wroom-32d-front-back.jpg :align: center - :alt: ESP-WROOM-32D module (back and front) - :width: 40% + :alt: ESP32-WROOM-32D module (front and back) + :width: 45% - ESP-WROOM-32D module (back and front) + ESP32-WROOM-32D module (front and back) .. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-wroom-32u-front-back.jpg :align: center - :alt: ESP32-WROOM-32U module (back and front) - :width: 40% - - ESP32-WROOM-32U module (back and front) + :alt: ESP32-WROOM-32U module (front and back) + :width: 45% + ESP32-WROOM-32U module (front and back) Documentation ^^^^^^^^^^^^^ -* `ESP-WROOM-32D / ESP32-WROOM-32U Datasheet `__ (PDF) +* `ESP32-WROOM-32D / ESP32-WROOM-32U Datasheet `__ (PDF) + + +.. _esp-modules-and-boards-esp32-solo-1: + +ESP32-SOLO-1 +------------ + +Simplified version of ESP32-WROOM-32D module. It contains a single core ESP32 chip that supports clock frequency of up to 160 MHz. + +.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-solo-1-front-back.jpg + :align: center + :alt: ESP32-SOLO-1 module (front and back) + :width: 45% + + ESP32-SOLO-1 module (front and back) .. _esp-modules-and-boards-esp32-wrover: @@ -90,7 +106,7 @@ Documentation ESP32-WROVER ------------ -A step upgrade of :ref:`esp-modules-and-boards-esp-wroom-32` with an additional 4 MB SPI PSRAM (Pseudo static RAM). This module is provided in two versions: 'ESP32-WROVER' with PCB antenna (shown below) and 'ESP32-WROVER-I' with an U.FL / IPEX antenna connector. Because of additional components inside, this module is 5.9 mm longer than :ref:`esp-modules-and-boards-esp-wroom-32`. +A step upgrade of :ref:`esp-modules-and-boards-esp32-wroom-32` with an additional 4 MB SPI PSRAM (Pseudo static RAM). This module is provided in two versions: 'ESP32-WROVER' with PCB antenna (shown below) and 'ESP32-WROVER-I' with an U.FL / IPEX antenna connector. Because of additional components inside, this module is 5.9 mm longer than :ref:`esp-modules-and-boards-esp32-wroom-32`. .. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-wrover.jpg :align: center @@ -104,7 +120,7 @@ Documentation * `ESP32-WROVER Datasheet `__ (PDF) * `ESP-PSRAM32 Datasheet `__ (PDF) -* `ESP32-WROVER Reference Design `_ PDF containing OrCAD schematic, PCB layout, gerbers and BOM +* `ESP32-WROVER Reference Design `_ containing OrCAD schematic, PCB layout, gerbers and BOM .. _esp-modules-and-boards-esp32-pico-pit-v4: @@ -142,7 +158,7 @@ Previous Versions ESP32 DevKitC V4 ================ -Small and convenient development board with :ref:`esp-modules-and-boards-esp-wroom-32` module installed, break out pin headers and minimum additional components. Includes USB to serial programming interface, that also provides power supply for the board. Has pushbuttons to reset the board and put it in upload mode. Comparing to the previous :ref:`esp-modules-and-boards-esp32-devkitc-v2`, instead of ESP-WROOM-32 it can accommodate :ref:`esp-modules-and-boards-esp32-wrover` module and has CP2102N chip that supports faster baud rates. +Small and convenient development board with :ref:`esp-modules-and-boards-esp32-wroom-32` module installed, break out pin headers and minimum additional components. Includes USB to serial programming interface, that also provides power supply for the board. Has pushbuttons to reset the board and put it in upload mode. Comparing to the previous :ref:`esp-modules-and-boards-esp32-devkitc-v2`, instead of ESP32-WROOM-32 it can accommodate :ref:`esp-modules-and-boards-esp32-wrover` module and has CP2102N chip that supports faster baud rates. .. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-devkitc-v4-front.jpg :align: center @@ -155,8 +171,8 @@ Documentation ------------- * :doc:`../get-started/get-started-devkitc` -* `ESP32-DevKitC schematic `_ (PDF) -* `ESP32-DevKitC Reference Design `_ (ZIP) containing OrCAD schematic, PCB layout, gerbers and BOM +* `ESP32-DevKitC schematic `_ (PDF) +* `ESP32-DevKitC Reference Design `_ containing OrCAD schematic, PCB layout, gerbers and BOM * `CP210x USB to UART Bridge VCP Drivers `_ Previous Versions @@ -172,7 +188,7 @@ ESP-WROVER-KIT V3 The ESP-WROVER-KIT V3 development board has dual port USB to serial converter for programming and JTAG interface for debugging. Power supply is provided by USB interface or from standard 5 mm power supply jack. Power supply selection is done with a jumper and may be put on/off with a separate switch. This board has MicroSD card slot, 3.2” SPI LCD screen and dedicated header to connect a camera. It provides RGB diode for diagnostics. Includes 32.768 kHz XTAL for internal RTC to operate it in low power modes. -As all previous version of ESP-WROVER-KIT boards, it is ready to accommodate an :ref:`esp-modules-and-boards-esp-wroom-32` or :ref:`esp-modules-and-boards-esp32-wrover` module. +As all previous version of ESP-WROVER-KIT boards, it is ready to accommodate an :ref:`esp-modules-and-boards-esp32-wroom-32` or :ref:`esp-modules-and-boards-esp32-wrover` module. This is the first release of ESP-WROVER-KIT shipped with :ref:`esp-modules-and-boards-esp32-wrover` module installed by default. This release also introduced several design changes to conditioning and interlocking of signals to the bootstrapping pins. Also, a zero Ohm resistor (R166) has been added between WROVER/WROOM module and VDD33 net, which can be desoldered, or replaced with a shunt resistor, for current measurement. This is intended to facilitate power consumption analysis in various operation modes of ESP32. Refer to schematic - the changes are enclosed in green border.