1
2ESP-WROVER-KIT V3 Getting Started Guide
3=======================================
4:link_to_translation:`zh_CN:[中文]`
5
6This guide shows how to get started with the ESP-WROVER-KIT V3 development board and also provides information about its functionality and configuration options. For the description of other ESP-WROVER-KIT versions, please check :doc:`../../hw-reference/index`.
7
8
9What You Need
10-------------
11
12* :ref:`ESP-WROVER-KIT V3 board <get-started-esp-wrover-kit-v3-board-front>`
13* USB 2.0 cable（A to Micro-B）
14* Computer running Windows, Linux, or macOS
15
16You can skip the introduction sections and go directly to Section `Start Application Development`_.
17
18
19Overview
20--------
21
22ESP-WROVER-KIT is an ESP32-based development board produced by `Espressif <https://espressif.com>`_. This board features an integrated LCD screen and MicroSD card slot.
23
24ESP-WROVER-KIT comes with the following ESP32 modules:
25
26- ESP32-WROOM-32
27- ESP32-WROVER series
28
29Its another distinguishing feature is the embedded FTDI FT2232HL chip - an advanced multi-interface USB bridge. This chip enables to use JTAG for direct debugging of ESP32 through the USB interface without a separate JTAG debugger. ESP-WROVER-KIT makes development convenient, easy, and cost-effective.
30
31Most of the ESP32 I/O pins are broken out to the board's pin headers for easy access.
32
33    .. note::
34
35        The version with the ESP32-WROVER module uses ESP32's GPIO16 and GPIO17 as chip select and clock signals for PSRAM. By default, the two GPIOs are not broken out to the board's pin headers in order to ensure reliable performance.
36
37
38Functionality Overview
39----------------------
40
41The block diagram below shows the main components of ESP-WROVER-KIT and their interconnections.
42
43.. figure:: ../../../_static/esp-wrover-kit-block-diagram.png
44    :align: center
45    :alt: ESP-WROVER-KIT block diagram
46    :figclass: align-center
47
48    ESP-WROVER-KIT block diagram
49
50
51Functional Description
52----------------------
53
54The following two figures and the table below describe the key components, interfaces, and controls of the ESP-WROVER-KIT board.
55
56.. _get-started-esp-wrover-kit-v3-board-front:
57
58.. figure:: ../../../_static/esp-wrover-kit-v3-layout-front.jpg
59    :align: center
60    :alt: ESP-WROVER-KIT board layout - front
61    :figclass: align-center
62
63    ESP-WROVER-KIT board layout - front
64
65.. _get-started-esp-wrover-kit-v3-board-back:
66
67.. figure:: ../../../_static/esp-wrover-kit-v3-layout-back.jpg
68    :align: center
69    :alt: ESP-WROVER-KIT board layout - back
70    :figclass: align-center
71
72    ESP-WROVER-KIT board layout - back
73
74
75The table below provides description in the following manner:
76
77- Starting from the first picture's top right corner and going clockwise
78- Then moving on to the second picture
79
80
81==================  =================================================================================================================================
82Key Component       Description
83==================  =================================================================================================================================
8432.768 kHz          External precision 32.768 kHz crystal oscillator serves as a clock with low-power consumption while the chip is in Deep-sleep mode.
85
860R                  Zero-ohm resistor intended as a placeholder for a current shunt, can be desoldered or replaced with a current shunt to facilitate the measurement of ESP32's current consumption in different modes.
87
88ESP32 Module        Either ESP32-WROOM-32 or ESP32-WROVER with an integrated ESP32. 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.
89
90FT2232              The FT2232 chip serves as a multi-protocol USB-to-serial bridge which can be programmed and controlled via USB to provide communication with ESP32. FT2232 also features USB-to-JTAG interface which is available on channel A of the chip, while USB-to-serial is on channel B. The FT2232 chip enhances user-friendliness in terms of application development and debugging. See `ESP-WROVER-KIT V3 schematic`_.
91
92UART                Serial port. The serial TX/RX signals of FT2232 and ESP32 are broken out to the inward and outward sides of JP11 respectively. By default, these pairs of pins are connected with jumpers. To use ESP32's serial interface, remove the jumpers and connect another external serial device to the respective pins.
93
94SPI                 By default, ESP32 uses its SPI interface to access flash and PSRAM memory inside the module. Use these pins to connect ESP32 to another SPI device. In this case, an extra chip select (CS) signal is needed. Please note that the interface voltage for the version with ESP32-WROVER is 1.8V, while that for the version with ESP32-WROOM-32 is 3.3V.
95
96CTS/RTS             Serial port flow control signals: the pins are not connected to the circuitry by default. To enable them, short the respective pins of JP14 with jumpers.
97
98JTAG                JTAG interface. JTAG signals of FT2232 and ESP32 are broken out to the inward and outward sides of JP8 respectively. By default, these pairs of pins are disconnected. To enable JTAG, short the respective pins with jumpers as shown in Section `Setup Options`_.
99
100EN                  Reset button.
101
102Boot                Download button. Holding down **Boot** and then pressing **EN** initiates Firmware Download mode for downloading firmware through the serial port.
103
104USB                 USB interface. Power supply for the board as well as the communication interface between a computer and the board.
105
106Power Key           Power On/Off Switch. Toggling toward **USB** powers the board on, toggling away from **USB** powers the board off.
107
108Power Select        Power supply selector interface. The board can be powered either via USB or via the 5V Input interface. Select the power source with a jumper. For more details, see Section `Setup Options`_, jumper header JP7.
109
1105V Input            The 5V power supply interface can be more convenient when the board is operating autonomously (not connected to a computer).
111
112LDO                 NCP1117(1A). 5V-to-3.3V LDO. NCP1117 can provide a maximum current of 1A. The LDO on the board has a fixed output voltage. Although, the user can install an LDO with adjustable output voltage. For details, please refer to `ESP-WROVER-KIT V3 schematic`_.
113
114Camera              Camera interface, a standard OV7670 camera module.
115
116RGB LED             Red, green and blue (RGB) light emitting diodes (LEDs), can be controlled by pulse width modulation (PWM).
117
118I/O                 All the pins on the ESP32 module are broken out to pin headers. You can program ESP32 to enable multiple functions, such as PWM, ADC, DAC, I2C, I2S, SPI, etc.
119
120MicroSD Card Slot   Useful for developing applications that access MicroSD card for data storage and retrieval.
121
122LCD                 Support for mounting and interfacing a 3.2” SPI (standard 4-wire Serial Peripheral Interface) LCD, as shown on figure :ref:`get-started-esp-wrover-kit-v3-board-back`.
123==================  =================================================================================================================================
124
125
126.. _get-started-esp-wrover-kit-v3-setup-options:
127
128Setup Options
129-------------
130
131There are five jumper blocks available to set up the board functionality. The most frequently required options are listed in the table below.
132
133=======  ================  =========================================================
134Header   Jumper Setting    Description of Functionality
135=======  ================  =========================================================
136JP7      |jp7-ext_5v|      Power ESP-WROVER-KIT via an external power supply
137JP7      |jp7-usb_5v|      Power ESP-WROVER-KIT via USB
138JP8      |jp8|             Enable JTAG functionality
139JP11     |jp11-tx-rx|      Enable UART communication
140JP14     |jp14|            Enable RTS/CTS flow control for serial communication
141=======  ================  =========================================================
142
143
144Allocation of ESP32 Pins
145------------------------
146
147Some pins / terminals of ESP32 are allocated for use with the onboard or external hardware. If that hardware is not used, e.g., nothing is plugged into the Camera (JP4) header, then these GPIOs can be used for other purposes.
148
149Some of the pins, such as GPIO0 or GPIO2, have multiple functions and some of them are shared among onboard and external peripheral devices. Certain combinations of peripherals cannot work together. For example, it is not possible to do JTAG debugging of an application that is using SD card, because several pins are shared by JTAG and the SD card slot.
150
151In other cases, peripherals can coexist under certain conditions. This is applicable to, for example, LCD screen and SD card that share only a single pin GPIO21. This pin is used to provide D/C (Data / Control) signal for the LCD as well as the CD (Card Detect) signal read from the SD card slot. If the card detect functionality is not essential, then it may be disabled by removing R167, so both LCD and SD may operate together.
152
153For more details on which pins are shared among which peripherals, please refer to the table in the next section.
154
155
156Main I/O Connector / JP1
157^^^^^^^^^^^^^^^^^^^^^^^^
158
159The JP1 connector consists of 14x2 male pins whose functions are shown in the middle two "I/O" columns of the table below. The two "Shared With" columns on both sides describe where else on the board a certain GPIO is used.
160
161=====================  =====  =====  =====================
162Shared With            I/O    I/O    Shared With
163=====================  =====  =====  =====================
164n/a                    3.3V   GND    n/a
165NC/XTAL                IO32   IO33   NC/XTAL
166JTAG, MicroSD          IO12   IO13   JTAG, MicroSD
167JTAG, MicroSD          IO14   IO27   Camera
168Camera                 IO26   IO25   Camera, LCD
169Camera                 IO35   IO34   Camera
170Camera                 IO39   IO36   Camera
171JTAG                   EN     IO23   Camera, LCD
172Camera, LCD            IO22   IO21   Camera, LCD, MicroSD
173Camera, LCD            IO19   IO18   Camera, LCD
174Camera, LCD            IO5    IO17   PSRAM
175PSRAM                  IO16   IO4    LED, Camera, MicroSD
176Camera, LED, Boot      IO0    IO2    LED, MicroSD
177JTAG, MicroSD          IO15   5V
178=====================  =====  =====  =====================
179
180Legend:
181
182* NC/XTAL - :ref:`32.768 kHz Oscillator <get-started-esp-wrover-kit-v3-xtal>`
183* JTAG - :ref:`JTAG / JP8 <get-started-esp-wrover-kit-v3-jtag-header>`
184* Boot - Boot button / SW2
185* Camera - :ref:`Camera / JP4 <get-started-esp-wrover-kit-v3-camera-header>`
186* LED - :ref:`RGB LED <get-started-esp-wrover-kit-v3-rgb-led-connections>`
187* MicroSD - :ref:`MicroSD Card / J4 <get-started-esp-wrover-kit-v3-microsd-card-slot>`
188* LCD - :ref:`LCD / U5 <get-started-esp-wrover-kit-v3-lcd-connector>`
189* PSRAM - only in case ESP32-WROVER is installed
190
191
192.. _get-started-esp-wrover-kit-v3-xtal:
193
19432.768 kHz Oscillator
195^^^^^^^^^^^^^^^^^^^^^
196
197====  ==========
198.     ESP32 Pin
199====  ==========
2001     GPIO32
2012     GPIO33
202====  ==========
203
204.. note::
205
206    Since GPIO32 and GPIO33 are connected to the oscillator by default, they are not connected to the JP1 I/O connector to maintain signal integrity. This allocation may be changed from the oscillator to JP1 by desoldering the zero-ohm resistors from positions R11 / R23 and re-soldering them to positions R12 / R24.
207
208
209.. _get-started-esp-wrover-kit-v3-spi-flash-header:
210
211SPI Flash / JP13
212^^^^^^^^^^^^^^^^
213
214====  =============
215.     ESP32 Pin
216====  =============
2171     CLK / GPIO6
2182     SD0 / GPIO7
2193     SD1 / GPIO8
2204     SD2 / GPIO9
2215     SD3 / GPIO10
2226     CMD / GPIO11
223====  =============
224
225.. important::
226
227    The module's flash bus is connected to the jumper block JP13 through zero-ohm resistors R140 ~ R145. If the flash memory needs to operate at the frequency of 80 MHz, for reasons such as improving the integrity of bus signals, you can desolder these resistors to disconnect the module's flash bus from the pin header JP13.
228
229
230.. _get-started-esp-wrover-kit-v3-jtag-header:
231
232JTAG / JP8
233^^^^^^^^^^
234
235====  ==============  =============
236.     ESP32 Pin       JTAG Signal
237====  ==============  =============
2381     EN              TRST_N
2392     MTMS / GPIO14   TMS
2403     MTDO / GPIO15   TDO
2414     MTDI / GPIO12   TDI
2425     MTCK / GPIO13   TCK
243====  ==============  =============
244
245
246.. _get-started-esp-wrover-kit-v3-camera-header:
247
248Camera / JP4
249^^^^^^^^^^^^
250
251====  ==========  =============================
252.     ESP32 Pin   Camera Signal
253====  ==========  =============================
254 1    n/a         3.3V
255 2    n/a         Ground
256 3    GPIO27      SIO_C / SCCB Clock
257 4    GPIO26      SIO_D / SCCB Data
258 5    GPIO25      VSYNC / Vertical Sync
259 6    GPIO23      HREF / Horizontal Reference
260 7    GPIO22      PCLK / Pixel Clock
261 8    GPIO21      XCLK / System Clock
262 9    GPIO35      D7 / Pixel Data Bit 7
26310    GPIO34      D6 / Pixel Data Bit 6
26411    GPIO39      D5 / Pixel Data Bit 5
26512    GPIO36      D4 / Pixel Data Bit 4
26613    GPIO19      D3 / Pixel Data Bit 3
26714    GPIO18      D2 / Pixel Data Bit 2
26815    GPIO5       D1 / Pixel Data Bit 1
26916    GPIO4       D0 / Pixel Data Bit 0
27017    GPIO0       RESET / Camera Reset
27118    n/a         PWDN / Camera Power Down
272====  ==========  =============================
273
274* Signals D0 .. D7 denote camera data bus
275
276
277.. _get-started-esp-wrover-kit-v3-rgb-led-connections:
278
279RGB LED
280^^^^^^^
281
282====  ==========  =========
283.     ESP32 Pin   RGB LED
284====  ==========  =========
2851     GPIO0       Red
2862     GPIO2       Green
2873     GPIO4       Blue
288====  ==========  =========
289
290
291.. _get-started-esp-wrover-kit-v3-microsd-card-slot:
292
293MicroSD Card
294^^^^^^^^^^^^
295
296====  ==============  ===============
297.     ESP32 Pin       MicroSD Signal
298====  ==============  ===============
2991     MTDI / GPIO12   DATA2
3002     MTCK / GPIO13   CD / DATA3
3013     MTDO / GPIO15   CMD
3024     MTMS / GPIO14   CLK
3035     GPIO2           DATA0
3046     GPIO4           DATA1
3057     GPIO21          CD
306====  ==============  ===============
307
308
309.. _get-started-esp-wrover-kit-v3-lcd-connector:
310
311LCD / U5
312^^^^^^^^
313
314====  ==============  ===============
315.     ESP32 Pin       LCD Signal
316====  ==============  ===============
3171     GPIO18          RESET
3182     GPIO19          SCL
3193     GPIO21          D/C
3204     GPIO22          CS
3215     GPIO23          SDA
3226     GPIO25          SDO
3237     GPIO5           Backlight
324====  ==============  ===============
325
326
327.. _get-started-esp-wrover-kit-v3-start-development:
328
329Start Application Development
330-----------------------------
331
332Before powering up your ESP-WROVER-KIT, please make sure that the board is in good condition with no obvious signs of damage.
333
334
335Initial Setup
336^^^^^^^^^^^^^
337
338Please set only the following jumpers shown in the pictures below:
339
340- Select USB as the power source using the jumper block JP7.
341
342- Enable UART communication using the jumper block JP11.
343
344========================  ==========================
345Power up from USB port    Enable UART communication
346========================  ==========================
347|jp7-usb_5v|              |jp11-tx-rx|
348========================  ==========================
349
350Do not install any other jumpers.
351
352Turn the **Power Switch** to ON, the **5V Power On LED** should light up.
353
354Now to Development
355^^^^^^^^^^^^^^^^^^
356
357Please proceed to :doc:`../../get-started/index`, where Section :ref:`get-started-step-by-step` will quickly help you set up the development environment and then flash an example project onto your board.
358
359
360Related Documents
361-----------------
362
363* `ESP-WROVER-KIT V3 schematic`_ (PDF)
364* `ESP32 Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf>`_ (PDF)
365* `ESP32-WROVER Datasheet <https://espressif.com/sites/default/files/documentation/esp32-wrover_datasheet_en.pdf>`_ (PDF)
366* `ESP32-WROOM-32 Datasheet <https://espressif.com/sites/default/files/documentation/esp32-wroom-32_datasheet_en.pdf>`_ (PDF)
367* :doc:`../../api-guides/jtag-debugging/index`
368* :doc:`../../hw-reference/index`
369
370.. |jp7-ext_5v| image:: ../../../_static/esp-wrover-kit-v3-jp7-ext_5v.png
371.. |jp7-usb_5v| image:: ../../../_static/esp-wrover-kit-v3-jp7-usb_5v.png
372.. |jp8| image:: ../../../_static/esp-wrover-kit-v3-jp8.png
373.. |jp11-tx-rx| image:: ../../../_static/esp-wrover-kit-v3-jp11-tx-rx.png
374.. |jp14| image:: ../../../_static/esp-wrover-kit-v3-jp14.png
375
376.. _ESP-WROVER-KIT V3 schematic: https://dl.espressif.com/dl/schematics/ESP-WROVER-KIT_SCH-3.pdf
377
378.. toctree::
379    :hidden:
380
381    get-started-wrover-kit-v2.rst
382