mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
Doc/review get st wrover kit
This commit is contained in:
Kirill Chalov
Krzysztof Budzynski
parent
54c6bf0b9b
commit
a1c39e4a53
|
Before Width: | Height: | Size: 34 KiB After Width: | Height: | Size: 34 KiB |
|
Before Width: | Height: | Size: 112 KiB After Width: | Height: | Size: 112 KiB |
@ -2,13 +2,13 @@ Configure WROVER JTAG Interface
|
||||
===============================
|
||||
:link_to_translation:`zh_CN:[中文]`
|
||||
|
||||
All versions of ESP-WROVER-KIT boards have JTAG functionality build in. Putting it to work requires setting jumpers to enable JTAG functionality, setting SPI flash voltage and configuring USB drivers. Please refer to step by step instructions below.
|
||||
All versions of ESP-WROVER-KIT boards have built-in JTAG functionality. Putting it to work requires setting jumpers to enable JTAG functionality, setting SPI flash voltage and configuring USB drivers. Please refer to step by step instructions below.
|
||||
|
||||
|
||||
Configure Hardware
|
||||
^^^^^^^^^^^^^^^^^^
|
||||
|
||||
1. Enable on-board JTAG functionality by setting JP8 according to :doc:`../../get-started/get-started-wrover-kit`, section :ref:`get-started-esp-wrover-kit-setup-options`.
|
||||
1. Enable on-board JTAG functionality by setting JP8 according to :doc:`../../get-started/get-started-wrover-kit`, Section :ref:`get-started-esp-wrover-kit-v4.1-setup-options`.
|
||||
|
||||
2. Verify if ESP32 pins used for JTAG communication are not connected to some other h/w that may disturb JTAG operation:
|
||||
|
||||
|
||||
@ -1,33 +1,43 @@
|
||||
ESP-WROVER-KIT V2 Getting Started Guide (CMake)
|
||||
===============================================
|
||||
:link_to_translation:`zh_CN:[中文]`
|
||||
|
||||
This user guide shows how to get started with ESP-WROVER-KIT V2 development board including description of its functionality and configuration options. For description of other versions of the ESP-WROVER-KIT check :doc:`../hw-reference/index`.
|
||||
|
||||
If you want to start using this board right now, go directly to Section :ref:`esp-wrover-kit-v2-start-development-cmake`.
|
||||
This guide shows how to get started with the ESP-WROVER-KIT V2 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`.
|
||||
|
||||
|
||||
What You Need
|
||||
-------------
|
||||
|
||||
* 1 × ESP-WROVER-KIT V2 board
|
||||
* 1 x Micro USB 2.0 Cable, Type A to Micro B
|
||||
* 1 × PC loaded with Windows, Linux or Mac OS
|
||||
* ESP-WROVER-KIT V2 board
|
||||
* USB 2.0 A to Micro B Cable
|
||||
* Computer running Windows, Linux, or macOS
|
||||
|
||||
You can skip the introduction sections and go directly to Section `Start Application Development`_.
|
||||
|
||||
|
||||
Overview
|
||||
^^^^^^^^
|
||||
--------
|
||||
|
||||
The ESP-WROVER-KIT is a development board produced by `Espressif <https://espressif.com>`_ 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.
|
||||
ESP-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.
|
||||
|
||||
.. note::
|
||||
ESP-WROVER-KIT comes with the following ESP32 modules:
|
||||
|
||||
ESP-WROVER-KIT V2 integrates the ESP-WROOM-32 module by default.
|
||||
- :ref:`esp-modules-and-boards-esp32-wroom-32`
|
||||
- :ref:`ESP32-WROVER <esp-modules-and-boards-esp32-wrover>`
|
||||
|
||||
Its 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.
|
||||
|
||||
Most of the ESP32 I/O pins are broken out to the board's pin headers for easy access.
|
||||
|
||||
.. note::
|
||||
|
||||
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.
|
||||
|
||||
|
||||
Functionality Overview
|
||||
^^^^^^^^^^^^^^^^^^^^^^
|
||||
----------------------
|
||||
|
||||
Block diagram below presents main components of ESP-WROVER-KIT and interconnections between components.
|
||||
The block diagram below shows the main components of ESP-WROVER-KIT and their interconnections.
|
||||
|
||||
.. figure:: ../../_static/esp-wrover-kit-block-diagram.png
|
||||
:align: center
|
||||
@ -38,56 +48,11 @@ Block diagram below presents main components of ESP-WROVER-KIT and interconnecti
|
||||
|
||||
|
||||
Functional Description
|
||||
^^^^^^^^^^^^^^^^^^^^^^
|
||||
----------------------
|
||||
|
||||
The following list and figures below describe key components, interfaces and controls of ESP-WROVER-KIT board.
|
||||
The following two figures and the table below describe the key components, interfaces, and controls of the ESP-WROVER-KIT board.
|
||||
|
||||
32.768 kHz
|
||||
An external precision 32.768 kHz crystal oscillator provides the chip with a clock of low-power consumption during the Deep-sleep 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.
|
||||
|
||||
.. note::
|
||||
|
||||
GPIO16 and GPIO17 are used as the CS and clock signal for PSRAM. To ensure reliable performance, the two GPIOs are not broken out.
|
||||
|
||||
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.
|
||||
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. If an ESP32-WROVER is being used, please note that the electrical level on the flash and SRAM is 1.8V.
|
||||
JTAG
|
||||
JTAG interface: the JTAG signals on FT2232HL and ESP32 are broken out to the two sides of JP8. By default, the two signals are disconnected. To enable JTAG, shorting jumpers are required on the signals.
|
||||
FT2232
|
||||
FT2232 chip is a multi-protocol USB-to-serial bridge. The FT2232 chip features USB-to-UART and USB-to-JTAG functionalities. Users can control and program the FT2232 chip through the USB interface to establish communication with ESP32.
|
||||
|
||||
The embedded FT2232 chip is one of the distinguishing features of the ESP-WROVER-KIT. It enhances users’ convenience in terms of application development and debugging. In addition, uses do not need to buy a JTAG debugger separately, which reduces the development cost, see `ESP-WROVER-KIT V2 schematic`_.
|
||||
EN
|
||||
Reset button: pressing this button resets the system.
|
||||
Boot
|
||||
Download button: holding down the **Boot** button and pressing the **EN** button initiates the firmware download mode. Then user can download firmware through the serial port.
|
||||
USB
|
||||
USB interface. It functions as the power supply for the board and the communication interface between PC and ESP32 module.
|
||||
Power Select
|
||||
Power supply selection interface: the ESP-WROVER-KIT can be powered through the USB interface or the 5V Input interface. The user can select the power supply with a jumper. More details can be found in Section :ref:`esp-wrover-kit-v2-setup-options-cmake`, jumper header JP7.
|
||||
Power Key
|
||||
Power on/off button: toggling to the right powers the board on; toggling to the left powers the board off.
|
||||
5V Input
|
||||
The 5V power supply interface is used as a backup power supply in case of full-load operation.
|
||||
LDO
|
||||
NCP1117(1A). 5V-to-3.3V LDO. (There is an alternative pin-compatible LDO — LM317DCY, with an output current of up to 1.5A). NCP1117 can provide a maximum current of 1A. The LDO solutions are available with both fixed output voltage and variable output voltage. For details please refer to `ESP-WROVER-KIT V2 schematic`_.
|
||||
Camera
|
||||
Camera interface: a standard OV7670 camera module is supported.
|
||||
RGB
|
||||
Red, green and blue (RGB) light emitting diodes (LEDs), which may be controlled by pulse width modulation (PWM).
|
||||
I/O
|
||||
All the pins on the ESP32 module are led out to the pin headers on the ESPWROVER-KIT. Users can program ESP32 to enable multiple functions such as PWM, ADC, DAC, I2C, I2S, SPI, etc.
|
||||
|
||||
Micro SD Card
|
||||
Micro SD card slot for data storage: when ESP32 enters the download mode, GPIO2 cannot be held high. However, a pull-up resistor is required on GPIO2 to enable the Micro SD Card. By default, GPIO2 and the pull-up resistor R153 are disconnected. To enable the SD Card, use jumpers on JP1 as shown in Section :ref:`esp-wrover-kit-v2-setup-options-cmake`.
|
||||
LCD
|
||||
ESP-WROVER-KIT supports mounting and interfacing a 3.2” SPI (standard 4-wire Serial Peripheral Interface) LCD, as shown on figure :ref:`esp-wrover-kit-v2-board-back-cmake`.
|
||||
.. _get-started-esp-wrover-kit-v2-board-front-cmake:
|
||||
|
||||
.. figure:: ../../_static/esp-wrover-kit-v2-layout-front.png
|
||||
:align: center
|
||||
@ -96,7 +61,7 @@ LCD
|
||||
|
||||
ESP-WROVER-KIT board layout - front
|
||||
|
||||
.. _esp-wrover-kit-v2-board-back-cmake:
|
||||
.. _get-started-esp-wrover-kit-v2-board-back-cmake:
|
||||
|
||||
.. figure:: ../../_static/esp-wrover-kit-v2-layout-back.png
|
||||
:align: center
|
||||
@ -106,57 +71,101 @@ LCD
|
||||
ESP-WROVER-KIT board layout - back
|
||||
|
||||
|
||||
.. _esp-wrover-kit-v2-setup-options-cmake:
|
||||
The table below provides description in the following manner:
|
||||
|
||||
- Starting from the first picture's top right corner and going clockwise
|
||||
- Then moving on to the second picture
|
||||
|
||||
|
||||
================== =================================================================================================================================
|
||||
Key Component Description
|
||||
================== =================================================================================================================================
|
||||
32.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.
|
||||
|
||||
ESP32 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.
|
||||
|
||||
CTS/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.
|
||||
|
||||
UART 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.
|
||||
|
||||
SPI 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.
|
||||
|
||||
JTAG 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`_.
|
||||
|
||||
FT2232 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 features USB-to-UART and USB-to-JTAG functionalities.
|
||||
|
||||
EN Reset button.
|
||||
|
||||
Boot Download button. Holding down **Boot** and then pressing **EN** initiates Firmware Download mode for downloading firmware through the serial port.
|
||||
|
||||
USB USB interface. Power supply for the board as well as the communication interface between a computer and the board.
|
||||
|
||||
Power 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.
|
||||
|
||||
Power Key Power On/Off Switch. Toggling toward **USB** powers the board on, toggling away from **USB** powers the board off.
|
||||
|
||||
5V Input The 5V power supply interface can be more convenient when the board is operating autonomously (not connected to a computer).
|
||||
|
||||
LDO 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 V2 schematic`_.
|
||||
|
||||
Camera Camera interface, a standard OV7670 camera module.
|
||||
|
||||
RGB Red, green and blue (RGB) light emitting diodes (LEDs), can be controlled by pulse width modulation (PWM).
|
||||
|
||||
I/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.
|
||||
|
||||
Micro SD Card Micro SD card slot for data storage: when ESP32 enters the download mode, GPIO2 cannot be held high. However, a pull-up resistor is required on GPIO2 to enable the Micro SD Card. By default, GPIO2 and the pull-up resistor R153 are disconnected. To enable the SD Card, use jumpers on JP1 as shown in Section `Setup Options`_.
|
||||
|
||||
LCD 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-v2-board-back-cmake`.
|
||||
================== =================================================================================================================================
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-kit-v2-setup-options-cmake:
|
||||
|
||||
Setup Options
|
||||
^^^^^^^^^^^^^
|
||||
-------------
|
||||
|
||||
There are five jumper headers available to set up the board functionality. Typical options to select from are listed in table below.
|
||||
There are five jumper blocks available to set up the board functionality. The most frequently required options are listed in the table below.
|
||||
|
||||
+--------+----------------------+-------------------------------------------------+
|
||||
| Header | Jumper Setting | Description of Functionality |
|
||||
+--------+----------------------+-------------------------------------------------+
|
||||
| JP1 | |jp1-sd_io2| | Enable pull up for the Micro SD Card |
|
||||
+--------+----------------------+-------------------------------------------------+
|
||||
| JP1 | |jp1-both| | Assert GPIO2 low during each download |
|
||||
| | | (by jumping it to GPIO0) |
|
||||
+--------+----------------------+-------------------------------------------------+
|
||||
| JP7 | |jp7-ext_5v| | Power ESP-WROVER-KIT board from an external |
|
||||
| | | power supply |
|
||||
+--------+----------------------+-------------------------------------------------+
|
||||
| JP7 | |jp7-usb_5v| | Power ESP-WROVER-KIT board from an USB port |
|
||||
+--------+----------------------+-------------------------------------------------+
|
||||
| JP8 | |jp8| | Enable JTAG functionality |
|
||||
+--------+----------------------+-------------------------------------------------+
|
||||
| JP11 | |jp11-rx-tx| | Enable UART communication |
|
||||
+--------+----------------------+-------------------------------------------------+
|
||||
| JP14 | |jp14| | Enable RTS/CTS flow control for serial |
|
||||
| | | communication |
|
||||
+--------+----------------------+-------------------------------------------------+
|
||||
======= ================ =========================================================
|
||||
Header Jumper Setting Description of Functionality
|
||||
======= ================ =========================================================
|
||||
JP1 |jp1-sd_io2| Enable pull up for the Micro SD Card
|
||||
JP1 |jp1-both| Assert GPIO2 low during each download (by jumping it to GPIO0)
|
||||
JP7 |jp7-ext_5v| Power ESP-WROVER-KIT via an external power supply
|
||||
JP7 |jp7-usb_5v| Power ESP-WROVER-KIT via USB
|
||||
JP8 |jp8| Enable JTAG functionality
|
||||
JP11 |jp11-tx-rx| Enable UART communication
|
||||
JP14 |jp14| Enable RTS/CTS flow control for serial communication
|
||||
======= ================ =========================================================
|
||||
|
||||
|
||||
.. _esp-wrover-kit-v2-start-development-cmake:
|
||||
.. _get-started-esp-wrover-kit-v2-start-development-cmake:
|
||||
|
||||
Start Application Development
|
||||
-----------------------------
|
||||
|
||||
Before powering up your ESP-WROVER-KIT V2, please make sure that the board is in good condition with no obvious signs of damage.
|
||||
Before powering up your ESP-WROVER-KIT, please make sure that the board is in good condition with no obvious signs of damage.
|
||||
|
||||
|
||||
Initial Setup
|
||||
^^^^^^^^^^^^^
|
||||
|
||||
Select the source of power supply for the board by setting jumper JP7. The options are either USB port or an external power supply. For this application selection of USB port is sufficient. Enable UART communication by installing jumpers on JP11. Both selections are shown in table below.
|
||||
Please set only the following jumpers shown in the pictures below:
|
||||
|
||||
+----------------------+----------------------+
|
||||
| Power up | Enable UART |
|
||||
| from USB port | communication |
|
||||
+----------------------+----------------------+
|
||||
| |jp7-usb_5v| | |jp11-rx-tx| |
|
||||
+----------------------+----------------------+
|
||||
- Select USB as the power source using the jumper block JP7.
|
||||
|
||||
- Enable UART communication using the jumper block JP11.
|
||||
|
||||
======================== ==========================
|
||||
Power up from USB port Enable UART communication
|
||||
======================== ==========================
|
||||
|jp7-usb_5v| |jp11-tx-rx|
|
||||
======================== ==========================
|
||||
|
||||
Do not install any other jumpers.
|
||||
|
||||
Turn the **Power Switch** to ON, the **5V Power On LED** should light up.
|
||||
|
||||
Now to Development
|
||||
^^^^^^^^^^^^^^^^^^
|
||||
@ -169,8 +178,8 @@ Related Documents
|
||||
|
||||
* `ESP-WROVER-KIT V2 schematic`_ (PDF)
|
||||
* `ESP32 Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf>`_ (PDF)
|
||||
* `ESP-WROOM-32 Datasheet <https://www.espressif.com/sites/default/files/documentation/esp-wroom-32_datasheet_en.pdf>`_ (PDF)
|
||||
* `ESP32-WROVER Datasheet <https://espressif.com/sites/default/files/documentation/esp32-wrover_datasheet_en.pdf>`_ (PDF)
|
||||
* `ESP32-WROOM-32 Datasheet <https://espressif.com/sites/default/files/documentation/esp32-wroom-32_datasheet_en.pdf>`_ (PDF)
|
||||
* :doc:`../api-guides/jtag-debugging/index`
|
||||
* :doc:`../hw-reference/index`
|
||||
|
||||
@ -180,7 +189,7 @@ Related Documents
|
||||
.. |jp7-ext_5v| image:: ../../_static/wrover-jp7-ext_5v.png
|
||||
.. |jp7-usb_5v| image:: ../../_static/wrover-jp7-usb_5v.png
|
||||
.. |jp8| image:: ../../_static/wrover-jp8.png
|
||||
.. |jp11-rx-tx| image:: ../../_static/wrover-jp11-tx-rx.png
|
||||
.. |jp11-tx-rx| image:: ../../_static/wrover-jp11-tx-rx.png
|
||||
.. |jp14| image:: ../../_static/wrover-jp14.png
|
||||
|
||||
.. _ESP-WROVER-KIT V2 schematic: https://dl.espressif.com/dl/schematics/ESP-WROVER-KIT_SCH-2.pdf
|
||||
|
||||
380
docs/en/get-started-cmake/get-started-wrover-kit-v3.rst
Normal file
380
docs/en/get-started-cmake/get-started-wrover-kit-v3.rst
Normal file
@ -0,0 +1,380 @@
|
||||
ESP-WROVER-KIT V3 Getting Started Guide (CMake)
|
||||
===============================================
|
||||
:link_to_translation:`zh_CN:[中文]`
|
||||
|
||||
This 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`.
|
||||
|
||||
|
||||
What You Need
|
||||
-------------
|
||||
|
||||
* :ref:`ESP-WROVER-KIT V3 board <get-started-esp-wrover-kit-v3-board-front-cmake>`
|
||||
* USB 2.0 A to Micro B Cable
|
||||
* Computer running Windows, Linux, or macOS
|
||||
|
||||
You can skip the introduction sections and go directly to Section `Start Application Development`_.
|
||||
|
||||
|
||||
Overview
|
||||
--------
|
||||
|
||||
ESP-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.
|
||||
|
||||
ESP-WROVER-KIT comes with the following ESP32 modules:
|
||||
|
||||
- :ref:`esp-modules-and-boards-esp32-wroom-32`
|
||||
- :ref:`ESP32-WROVER <esp-modules-and-boards-esp32-wrover>`
|
||||
|
||||
Its 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.
|
||||
|
||||
Most of the ESP32 I/O pins are broken out to the board's pin headers for easy access.
|
||||
|
||||
.. note::
|
||||
|
||||
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.
|
||||
|
||||
|
||||
Functionality Overview
|
||||
----------------------
|
||||
|
||||
The block diagram below shows the main components of ESP-WROVER-KIT and their interconnections.
|
||||
|
||||
.. figure:: ../../_static/esp-wrover-kit-block-diagram.png
|
||||
:align: center
|
||||
:alt: ESP-WROVER-KIT block diagram
|
||||
:figclass: align-center
|
||||
|
||||
ESP-WROVER-KIT block diagram
|
||||
|
||||
|
||||
Functional Description
|
||||
----------------------
|
||||
|
||||
The following two figures and the table below describe the key components, interfaces, and controls of the ESP-WROVER-KIT board.
|
||||
|
||||
.. _get-started-esp-wrover-kit-v3-board-front-cmake:
|
||||
|
||||
.. figure:: ../../_static/esp-wrover-kit-v3-layout-front.jpg
|
||||
:align: center
|
||||
:alt: ESP-WROVER-KIT board layout - front
|
||||
:figclass: align-center
|
||||
|
||||
ESP-WROVER-KIT board layout - front
|
||||
|
||||
.. _get-started-esp-wrover-kit-v3-board-back-cmake:
|
||||
|
||||
.. figure:: ../../_static/esp-wrover-kit-v3-layout-back.jpg
|
||||
:align: center
|
||||
:alt: ESP-WROVER-KIT board layout - back
|
||||
:figclass: align-center
|
||||
|
||||
ESP-WROVER-KIT board layout - back
|
||||
|
||||
|
||||
The table below provides description in the following manner:
|
||||
|
||||
- Starting from the first picture's top right corner and going clockwise
|
||||
- Then moving on to the second picture
|
||||
|
||||
|
||||
================== =================================================================================================================================
|
||||
Key Component Description
|
||||
================== =================================================================================================================================
|
||||
32.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.
|
||||
|
||||
0R 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.
|
||||
|
||||
ESP32 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.
|
||||
|
||||
FT2232 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`_.
|
||||
|
||||
UART 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.
|
||||
|
||||
SPI 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.
|
||||
|
||||
CTS/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.
|
||||
|
||||
JTAG 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`_.
|
||||
|
||||
EN Reset button.
|
||||
|
||||
Boot Download button. Holding down **Boot** and then pressing **EN** initiates Firmware Download mode for downloading firmware through the serial port.
|
||||
|
||||
USB USB interface. Power supply for the board as well as the communication interface between a computer and the board.
|
||||
|
||||
Power Key Power On/Off Switch. Toggling toward **USB** powers the board on, toggling away from **USB** powers the board off.
|
||||
|
||||
Power 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.
|
||||
|
||||
5V Input The 5V power supply interface can be more convenient when the board is operating autonomously (not connected to a computer).
|
||||
|
||||
LDO 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`_.
|
||||
|
||||
Camera Camera interface, a standard OV7670 camera module.
|
||||
|
||||
RGB LED Red, green and blue (RGB) light emitting diodes (LEDs), can be controlled by pulse width modulation (PWM).
|
||||
|
||||
I/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.
|
||||
|
||||
Micro SD Card Slot Useful for developing applications that access Micro SD card for data storage and retrieval.
|
||||
|
||||
LCD 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-cmake`.
|
||||
================== =================================================================================================================================
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-kit-v3-setup-options-cmake:
|
||||
|
||||
Setup Options
|
||||
-------------
|
||||
|
||||
There are five jumper blocks available to set up the board functionality. The most frequently required options are listed in the table below.
|
||||
|
||||
======= ================ =========================================================
|
||||
Header Jumper Setting Description of Functionality
|
||||
======= ================ =========================================================
|
||||
JP7 |jp7-ext_5v| Power ESP-WROVER-KIT via an external power supply
|
||||
JP7 |jp7-usb_5v| Power ESP-WROVER-KIT via USB
|
||||
JP8 |jp8| Enable JTAG functionality
|
||||
JP11 |jp11-tx-rx| Enable UART communication
|
||||
JP14 |jp14| Enable RTS/CTS flow control for serial communication
|
||||
======= ================ =========================================================
|
||||
|
||||
|
||||
Allocation of ESP32 Pins
|
||||
------------------------
|
||||
|
||||
Some 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.
|
||||
|
||||
Some 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.
|
||||
|
||||
In 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.
|
||||
|
||||
For more details on which pins are shared among which peripherals, please refer to the table in the next section.
|
||||
|
||||
|
||||
Main I/O Connector / JP1
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
The 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.
|
||||
|
||||
===================== ===== ===== =====================
|
||||
Shared With I/O I/O Shared With
|
||||
===================== ===== ===== =====================
|
||||
n/a 3.3V GND n/a
|
||||
NC/XTAL IO32 IO33 NC/XTAL
|
||||
JTAG, MicroSD IO12 IO13 JTAG, MicroSD
|
||||
JTAG, MicroSD IO14 IO27 Camera
|
||||
Camera IO26 IO25 Camera, LCD
|
||||
Camera IO35 IO34 Camera
|
||||
Camera IO39 IO36 Camera
|
||||
JTAG EN IO23 Camera, LCD
|
||||
Camera, LCD IO22 IO21 Camera, LCD, MicroSD
|
||||
Camera, LCD IO19 IO18 Camera, LCD
|
||||
Camera, LCD IO5 IO17 PSRAM
|
||||
PSRAM IO16 IO4 LED, Camera, MicroSD
|
||||
Camera, LED, Boot IO0 IO2 LED, MicroSD
|
||||
JTAG, MicroSD IO15 5V
|
||||
===================== ===== ===== =====================
|
||||
|
||||
Legend:
|
||||
|
||||
* NC/XTAL - :ref:`32.768 kHz Oscillator <get-started-esp-wrover-kit-v3-xtal-cmake>`
|
||||
* JTAG - :ref:`JTAG / JP8 <get-started-esp-wrover-kit-v3-jtag-header-cmake>`
|
||||
* Boot - Boot button / SW2
|
||||
* Camera - :ref:`Camera / JP4 <get-started-esp-wrover-kit-v3-camera-header-cmake>`
|
||||
* LED - :ref:`RGB LED <get-started-esp-wrover-kit-v3-rgb-led-connections-cmake>`
|
||||
* MicroSD - :ref:`MicroSD Card / J4 <get-started-esp-wrover-kit-v3-microsd-card-slot-cmake>`
|
||||
* LCD - :ref:`LCD / U5 <get-started-esp-wrover-kit-v3-lcd-connector-cmake>`
|
||||
* PSRAM - only in case ESP32-WROVER is installed
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-kit-v3-xtal-cmake:
|
||||
|
||||
32.768 kHz Oscillator
|
||||
^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
==== ==========
|
||||
. ESP32 Pin
|
||||
==== ==========
|
||||
1 GPIO32
|
||||
2 GPIO33
|
||||
==== ==========
|
||||
|
||||
.. note::
|
||||
|
||||
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.
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-kit-v3-spi-flash-header-cmake:
|
||||
|
||||
SPI Flash / JP13
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
==== =============
|
||||
. ESP32 Pin
|
||||
==== =============
|
||||
1 CLK / GPIO6
|
||||
2 SD0 / GPIO7
|
||||
3 SD1 / GPIO8
|
||||
4 SD2 / GPIO9
|
||||
5 SD3 / GPIO10
|
||||
6 CMD / GPIO11
|
||||
==== =============
|
||||
|
||||
.. important::
|
||||
|
||||
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 disolder these resistors to disconnect the module's flash bus from the pin header JP13.
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-kit-v3-jtag-header-cmake:
|
||||
|
||||
JTAG / JP8
|
||||
^^^^^^^^^^
|
||||
|
||||
==== ============== =============
|
||||
. ESP32 Pin JTAG Signal
|
||||
==== ============== =============
|
||||
1 EN TRST_N
|
||||
2 MTMS / GPIO14 TMS
|
||||
3 MTDO / GPIO15 TDO
|
||||
4 MTDI / GPIO12 TDI
|
||||
5 MTCK / GPIO13 TCK
|
||||
==== ============== =============
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-kit-v3-camera-header-cmake:
|
||||
|
||||
Camera / JP4
|
||||
^^^^^^^^^^^^
|
||||
|
||||
==== ========== =============================
|
||||
. ESP32 Pin Camera Signal
|
||||
==== ========== =============================
|
||||
1 n/a 3.3V
|
||||
2 n/a Ground
|
||||
3 GPIO27 SIO_C / SCCB Clock
|
||||
4 GPIO26 SIO_D / SCCB Data
|
||||
5 GPIO25 VSYNC / Vertical Sync
|
||||
6 GPIO23 HREF / Horizontal Reference
|
||||
7 GPIO22 PCLK / Pixel Clock
|
||||
8 GPIO21 XCLK / System Clock
|
||||
9 GPIO35 D7 / Pixel Data Bit 7
|
||||
10 GPIO34 D6 / Pixel Data Bit 6
|
||||
11 GPIO39 D5 / Pixel Data Bit 5
|
||||
12 GPIO36 D4 / Pixel Data Bit 4
|
||||
13 GPIO19 D3 / Pixel Data Bit 3
|
||||
14 GPIO18 D2 / Pixel Data Bit 2
|
||||
15 GPIO5 D1 / Pixel Data Bit 1
|
||||
16 GPIO4 D0 / Pixel Data Bit 0
|
||||
17 GPIO0 RESET / Camera Reset
|
||||
18 n/a PWDN / Camera Power Down
|
||||
==== ========== =============================
|
||||
|
||||
* Signals D0 .. D7 denote camera data bus
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-kit-v3-rgb-led-connections-cmake:
|
||||
|
||||
RGB LED
|
||||
^^^^^^^
|
||||
|
||||
==== ========== =========
|
||||
. ESP32 Pin RGB LED
|
||||
==== ========== =========
|
||||
1 GPIO0 Red
|
||||
2 GPIO2 Green
|
||||
3 GPIO4 Blue
|
||||
==== ========== =========
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-kit-v3-microsd-card-slot-cmake:
|
||||
|
||||
MicroSD Card
|
||||
^^^^^^^^^^^^
|
||||
|
||||
==== ============== ===============
|
||||
. ESP32 Pin MicroSD Signal
|
||||
==== ============== ===============
|
||||
1 MTDI / GPIO12 DATA2
|
||||
2 MTCK / GPIO13 CD / DATA3
|
||||
3 MTDO / GPIO15 CMD
|
||||
4 MTMS / GPIO14 CLK
|
||||
5 GPIO2 DATA0
|
||||
6 GPIO4 DATA1
|
||||
7 GPIO21 CD
|
||||
==== ============== ===============
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-kit-v3-lcd-connector-cmake:
|
||||
|
||||
LCD / U5
|
||||
^^^^^^^^
|
||||
|
||||
==== ============== ===============
|
||||
. ESP32 Pin LCD Signal
|
||||
==== ============== ===============
|
||||
1 GPIO18 RESET
|
||||
2 GPIO19 SCL
|
||||
3 GPIO21 D/C
|
||||
4 GPIO22 CS
|
||||
5 GPIO23 SDA
|
||||
6 GPIO25 SDO
|
||||
7 GPIO5 Backlight
|
||||
==== ============== ===============
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-kit-v3-start-development-cmake:
|
||||
|
||||
Start Application Development
|
||||
-----------------------------
|
||||
|
||||
Before powering up your ESP-WROVER-KIT, please make sure that the board is in good condition with no obvious signs of damage.
|
||||
|
||||
|
||||
Initial Setup
|
||||
^^^^^^^^^^^^^
|
||||
|
||||
Please set only the following jumpers shown in the pictures below:
|
||||
|
||||
- Select USB as the power source using the jumper block JP7.
|
||||
|
||||
- Enable UART communication using the jumper block JP11.
|
||||
|
||||
======================== ==========================
|
||||
Power up from USB port Enable UART communication
|
||||
======================== ==========================
|
||||
|jp7-usb_5v| |jp11-tx-rx|
|
||||
======================== ==========================
|
||||
|
||||
Do not install any other jumpers.
|
||||
|
||||
Turn the **Power Switch** to ON, the **5V Power On LED** should light up.
|
||||
|
||||
Now to Development
|
||||
^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Please proceed to :doc:`index`, where Section :ref:`get-started-step-by-step-cmake` will quickly help you set up the development environment and then flash an example project onto your board.
|
||||
|
||||
|
||||
Related Documents
|
||||
-----------------
|
||||
|
||||
* `ESP-WROVER-KIT V3 schematic`_ (PDF)
|
||||
* `ESP32 Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf>`_ (PDF)
|
||||
* `ESP32-WROVER Datasheet <https://espressif.com/sites/default/files/documentation/esp32-wrover_datasheet_en.pdf>`_ (PDF)
|
||||
* `ESP32-WROOM-32 Datasheet <https://espressif.com/sites/default/files/documentation/esp32-wroom-32_datasheet_en.pdf>`_ (PDF)
|
||||
* :doc:`../api-guides/jtag-debugging/index`
|
||||
* :doc:`../hw-reference/index`
|
||||
|
||||
.. |jp7-ext_5v| image:: ../../_static/esp-wrover-kit-v3-jp7-ext_5v.png
|
||||
.. |jp7-usb_5v| image:: ../../_static/esp-wrover-kit-v3-jp7-usb_5v.png
|
||||
.. |jp8| image:: ../../_static/esp-wrover-kit-v3-jp8.png
|
||||
.. |jp11-tx-rx| image:: ../../_static/esp-wrover-kit-v3-jp11-tx-rx.png
|
||||
.. |jp14| image:: ../../_static/esp-wrover-kit-v3-jp14.png
|
||||
|
||||
.. _ESP-WROVER-KIT V3 schematic: https://dl.espressif.com/dl/schematics/ESP-WROVER-KIT_SCH-3.pdf
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
|
||||
get-started-wrover-kit-v2.rst
|
||||
@ -1,405 +1,385 @@
|
||||
ESP-WROVER-KIT V3 Getting Started Guide (CMake)
|
||||
===============================================
|
||||
|
||||
This user guide shows how to get started with ESP-WROVER-KIT V3 development board including description of its functionality and configuration options. For description of other versions of the ESP-WROVER-KIT check :doc:`../hw-reference/index`.
|
||||
|
||||
|
||||
What You Need
|
||||
-------------
|
||||
|
||||
* 1 × :ref:`ESP-WROVER-KIT V3 board <get-started-esp-wrover-kit-board-front-cmake>`
|
||||
* 1 x Micro USB 2.0 Cable, Type A to Micro B
|
||||
* 1 × PC loaded with Windows, Linux or Mac OS
|
||||
|
||||
If you want to start using this board right now, go directly to Section `Start Application Development`_.
|
||||
|
||||
|
||||
Overview
|
||||
^^^^^^^^
|
||||
|
||||
The ESP-WROVER-KIT is a development board produced by `Espressif <https://espressif.com>`_ 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.
|
||||
|
||||
.. note::
|
||||
|
||||
ESP-WROVER-KIT V3 integrates the ESP32-WROVER module by default.
|
||||
|
||||
|
||||
Functionality Overview
|
||||
^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Block diagram below presents main components of ESP-WROVER-KIT and interconnections between components.
|
||||
|
||||
.. figure:: ../../_static/esp-wrover-kit-block-diagram.png
|
||||
:align: center
|
||||
:alt: ESP-WROVER-KIT block diagram
|
||||
:figclass: align-center
|
||||
|
||||
ESP-WROVER-KIT block diagram
|
||||
|
||||
|
||||
Functional Description
|
||||
^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
The following list and figures below describe key components, interfaces and controls of ESP-WROVER-KIT board.
|
||||
|
||||
32.768 kHz
|
||||
An external precision 32.768 kHz crystal oscillator provides the chip with a clock of low-power consumption during the Deep-sleep mode.
|
||||
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.
|
||||
|
||||
.. note::
|
||||
|
||||
GPIO16 and GPIO17 are used as the CS and clock signal for PSRAM. To ensure reliable performance, the two GPIOs are not broken out.
|
||||
|
||||
FT2232
|
||||
The FT2232 chip is a multi-protocol USB-to-serial bridge. Users can control and program the FT2232 chip through the USB interface to establish communication with ESP32. The FT2232 chip also features USB-to-JTAG interface. USB-to-JTAG is available on channel A of FT2232, USB-to-serial on channel B. The embedded FT2232 chip is one of the distinguishing features of the ESPWROVER-KIT. It enhances users’ convenience in terms of application development and debugging. In addition, users do not need to buy a JTAG debugger separately, which reduces the development cost, see `ESP-WROVER-KIT V3 schematic`_.
|
||||
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.
|
||||
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
|
||||
JTAG interface: the JTAG signals on FT2232HL and ESP32 are broken out to the two sides of JP8. By default, the two signals are disconnected. To enable JTAG, shorting jumpers are required on the signals.
|
||||
EN
|
||||
Reset button: pressing this button resets the system.
|
||||
Boot
|
||||
Download button: holding down the **Boot** button and pressing the **EN** button initiates the firmware download mode. Then user can download firmware through the serial port.
|
||||
USB
|
||||
USB interface. It functions as the power supply for the board and the communication interface between PC and ESP32 module.
|
||||
Power Select
|
||||
Power supply selection interface: the ESP-WROVER-KIT can be powered through the USB interface or the 5V Input interface. The user can select the power supply with a jumper. More details can be found in Section :ref:`get-started-esp-wrover-kit-setup-options-cmake`, jumper header JP7.
|
||||
Power Key
|
||||
Power on/off button: toggling to the right powers the board on; toggling to the left powers the board off.
|
||||
5V Input
|
||||
The 5V power supply interface is used as a backup power supply in case of full-load operation.
|
||||
LDO
|
||||
NCP1117(1A). 5V-to-3.3V LDO. (There is an alternative pin-compatible LDO — LM317DCY, with an output current of up to 1.5A). NCP1117 can provide a maximum current of 1A. The LDO solutions are available with both fixed output voltage and variable output voltage. For details please refer to `ESP-WROVER-KIT V3 schematic`_.
|
||||
Camera
|
||||
Camera interface: a standard OV7670 camera module is supported.
|
||||
RGB
|
||||
Red, green and blue (RGB) light emitting diodes (LEDs), which may be controlled by pulse width modulation (PWM).
|
||||
I/O
|
||||
All the pins on the ESP32 module are led out to the pin headers on the ESP-WROVER-KIT. Users can program ESP32 to enable multiple functions such as PWM, ADC, DAC, I2C, I2S, SPI, etc.
|
||||
Micro SD Card
|
||||
Micro SD card slot for data storage.
|
||||
LCD
|
||||
ESP-WROVER-KIT supports mounting and interfacing a 3.2” SPI (standard 4-wire Serial Peripheral Interface) LCD, as shown on figure :ref:`get-started-esp-wrover-kit-board-back-cmake`.
|
||||
|
||||
.. _get-started-esp-wrover-kit-board-front-cmake:
|
||||
|
||||
.. figure:: ../../_static/esp32-wrover-kit-layout-front.jpg
|
||||
:align: center
|
||||
:alt: ESP-WROVER-KIT board layout - front
|
||||
:figclass: align-center
|
||||
|
||||
ESP-WROVER-KIT board layout - front
|
||||
|
||||
.. _get-started-esp-wrover-kit-board-back-cmake:
|
||||
|
||||
.. figure:: ../../_static/esp32-wrover-kit-layout-back.jpg
|
||||
:align: center
|
||||
:alt: ESP-WROVER-KIT board layout - back
|
||||
:figclass: align-center
|
||||
|
||||
ESP-WROVER-KIT board layout - back
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-kit-setup-options-cmake:
|
||||
|
||||
Setup Options
|
||||
^^^^^^^^^^^^^
|
||||
|
||||
There are five jumper headers available to set up the board functionality. Typical options to select from are listed in table below.
|
||||
|
||||
+--------+------------------+--------------------------------------------------+
|
||||
| Header | Jumper Setting | Description of Functionality |
|
||||
+--------+------------------+--------------------------------------------------+
|
||||
| JP7 | |jp7-ext_5v| | Power ESP-WROVER-KIT board from an external |
|
||||
| | | power supply |
|
||||
+--------+------------------+--------------------------------------------------+
|
||||
| JP7 | |jp7-usb_5v| | Power ESP-WROVER-KIT board from an USB port |
|
||||
+--------+------------------+--------------------------------------------------+
|
||||
| JP8 | |jp8| | Enable JTAG functionality |
|
||||
+--------+------------------+--------------------------------------------------+
|
||||
| JP11 | |jp11-rx-tx| | Enable UART communication |
|
||||
+--------+------------------+--------------------------------------------------+
|
||||
| JP14 | |jp14| | Enable RTS/CTS flow control for serial |
|
||||
| | | communication |
|
||||
+--------+------------------+--------------------------------------------------+
|
||||
|
||||
|
||||
Allocation of ESP32 Pins
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Several pins / terminals of ESP32 module are allocated to the on board hardware. Some of them, like GPIO0 or GPIO2, have multiple functions. If certain hardware is not installed, e.g. nothing is plugged in to the Camera / JP4 header, then selected GPIOs may be used for other purposes.
|
||||
|
||||
|
||||
Main I/O Connector / JP1
|
||||
""""""""""""""""""""""""
|
||||
|
||||
The JP1 connector is shown in two columns in the middle under "I/O" headers. The two columns "Shared With" outside, describe where else on the board certain GPIO is used.
|
||||
|
||||
+----------------------+------+------+----------------------+
|
||||
| Shared With | I/O | I/O | Shared With |
|
||||
+======================+======+======+======================+
|
||||
| | 3.3V | GND | |
|
||||
+----------------------+------+------+----------------------+
|
||||
| NC/XTAL | IO32 | IO33 | NC/XTAL |
|
||||
+----------------------+------+------+----------------------+
|
||||
| JTAG, MicroSD | IO12 | IO13 | JTAG, MicroSD |
|
||||
+----------------------+------+------+----------------------+
|
||||
| JTAG, MicroSD | IO14 | IO27 | Camera |
|
||||
+----------------------+------+------+----------------------+
|
||||
| Camera | IO26 | IO25 | Camera, LCD |
|
||||
+----------------------+------+------+----------------------+
|
||||
| Camera | IO35 | IO34 | Camera |
|
||||
+----------------------+------+------+----------------------+
|
||||
| Camera | IO39 | IO36 | Camera |
|
||||
+----------------------+------+------+----------------------+
|
||||
| JTAG | EN | IO23 | Camera, LCD |
|
||||
+----------------------+------+------+----------------------+
|
||||
| Camera, LCD | IO22 | IO21 | Camera, LCD, MicroSD |
|
||||
+----------------------+------+------+----------------------+
|
||||
| Camera, LCD | IO19 | IO18 | Camera, LCD |
|
||||
+----------------------+------+------+----------------------+
|
||||
| Camera, LCD | IO5 | IO17 | PSRAM |
|
||||
+----------------------+------+------+----------------------+
|
||||
| PSRAM | IO16 | IO4 | LED, Camera, MicroSD |
|
||||
+----------------------+------+------+----------------------+
|
||||
| LED, Boot | IO0 | IO2 | LED, Camera, MicroSD |
|
||||
+----------------------+------+------+----------------------+
|
||||
| JTAG, MicroSD | IO15 | 5V | |
|
||||
+----------------------+------+------+----------------------+
|
||||
|
||||
Legend:
|
||||
|
||||
* NC/XTAL - :ref:`32.768 kHz Oscillator <get-started-esp-wrover-kit-xtal-cmake>`
|
||||
* JTAG - :ref:`JTAG / JP8 <get-started-esp-wrover-jtag-header-cmake>`
|
||||
* Boot - Boot button / SW2
|
||||
* Camera - :ref:`Camera / JP4 <get-started-esp-wrover-camera-header-cmake>`
|
||||
* LED - :ref:`RGB LED <get-started-esp-wrover-rgb-led-connections-cmake>`
|
||||
* MicroSD - :ref:`MicroSD Card / J4 <get-started-esp-wrover-microsd-card-slot-cmake>`
|
||||
* LCD - :ref:`LCD / U5 <get-started-esp-wrover-lcd-connector-cmake>`
|
||||
* PSRAM - ESP32-WROVER's PSRAM, if ESP32-WROVER is installed
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-kit-xtal-cmake:
|
||||
|
||||
32.768 kHz Oscillator
|
||||
"""""""""""""""""""""
|
||||
|
||||
+---+-----------+
|
||||
| | ESP32 Pin |
|
||||
+===+===========+
|
||||
| 1 | GPIO32 |
|
||||
+---+-----------+
|
||||
| 2 | GPIO33 |
|
||||
+---+-----------+
|
||||
|
||||
.. note::
|
||||
|
||||
As GPIO32 and GPIO33 are connected to the oscillator, to maintain signal integrity, they are not connected to JP1 I/O expansion connector. This allocation may be changed from oscillator to JP1 by desoldering 0R resistors from positions R11 / R23 and installing them in positions R12 / R24.
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-spi-flash-header-cmake:
|
||||
|
||||
SPI Flash / JP13
|
||||
""""""""""""""""
|
||||
|
||||
+---+--------------+
|
||||
| | ESP32 Pin |
|
||||
+===+==============+
|
||||
| 1 | CLK / GPIO6 |
|
||||
+---+--------------+
|
||||
| 2 | SD0 / GPIO7 |
|
||||
+---+--------------+
|
||||
| 3 | SD1 / GPIO8 |
|
||||
+---+--------------+
|
||||
| 4 | SD2 / GPIO9 |
|
||||
+---+--------------+
|
||||
| 5 | SD3 / GPIO10 |
|
||||
+---+--------------+
|
||||
| 6 | CMD / GPIO11 |
|
||||
+---+--------------+
|
||||
|
||||
.. important::
|
||||
|
||||
The module's flash bus is connected to the pin header JP13 through 0-Ohm resistors R140 ~ R145. If the flash frequency needs to operate at 80 MHz, to improve integrity of the bus signals, it is recommended to desolder resistors R140 ~ R145. At this point, the module's flash bus is disconnected with the pin header JP13.
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-jtag-header-cmake:
|
||||
|
||||
JTAG / JP8
|
||||
""""""""""
|
||||
|
||||
+---+---------------+-------------+
|
||||
| | ESP32 Pin | JTAG Signal |
|
||||
+===+===============+=============+
|
||||
| 1 | EN | TRST_N |
|
||||
+---+---------------+-------------+
|
||||
| 2 | MTDO / GPIO15 | TDO |
|
||||
+---+---------------+-------------+
|
||||
| 3 | MTDI / GPIO12 | TDI |
|
||||
+---+---------------+-------------+
|
||||
| 4 | MTCK / GPIO13 | TCK |
|
||||
+---+---------------+-------------+
|
||||
| 5 | MTMS / GPIO14 | TMS |
|
||||
+---+---------------+-------------+
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-camera-header-cmake:
|
||||
|
||||
Camera / JP4
|
||||
""""""""""""
|
||||
|
||||
+----+--------------+----------------------+
|
||||
| | ESP32 Pin | Camera Signal |
|
||||
+====+==============+======================+
|
||||
| 1 | GPIO27 | SCCB Clock |
|
||||
+----+--------------+----------------------+
|
||||
| 2 | GPIO26 | SCCB Data |
|
||||
+----+--------------+----------------------+
|
||||
| 3 | GPIO21 | System Clock |
|
||||
+----+--------------+----------------------+
|
||||
| 4 | GPIO25 | Vertical Sync |
|
||||
+----+--------------+----------------------+
|
||||
| 5 | GPIO23 | Horizontal Reference |
|
||||
+----+--------------+----------------------+
|
||||
| 6 | GPIO22 | Pixel Clock |
|
||||
+----+--------------+----------------------+
|
||||
| 7 | GPIO4 | Pixel Data Bit 0 |
|
||||
+----+--------------+----------------------+
|
||||
| 8 | GPIO5 | Pixel Data Bit 1 |
|
||||
+----+--------------+----------------------+
|
||||
| 9 | GPIO18 | Pixel Data Bit 2 |
|
||||
+----+--------------+----------------------+
|
||||
| 10 | GPIO19 | Pixel Data Bit 3 |
|
||||
+----+--------------+----------------------+
|
||||
| 11 | GPIO36 | Pixel Data Bit 4 |
|
||||
+----+--------------+----------------------+
|
||||
| 11 | GPIO39 | Pixel Data Bit 5 |
|
||||
+----+--------------+----------------------+
|
||||
| 11 | GPIO34 | Pixel Data Bit 6 |
|
||||
+----+--------------+----------------------+
|
||||
| 11 | GPIO35 | Pixel Data Bit 7 |
|
||||
+----+--------------+----------------------+
|
||||
| 11 | GPIO2 | Camera Reset |
|
||||
+----+--------------+----------------------+
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-rgb-led-connections-cmake:
|
||||
|
||||
RGB LED
|
||||
"""""""
|
||||
|
||||
+---+-----------+---------+
|
||||
| | ESP32 Pin | RGB LED |
|
||||
+===+===========+=========+
|
||||
| 1 | GPIO0 | Red |
|
||||
+---+-----------+---------+
|
||||
| 2 | GPIO2 | Blue |
|
||||
+---+-----------+---------+
|
||||
| 3 | GPIO4 | Green |
|
||||
+---+-----------+---------+
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-microsd-card-slot-cmake:
|
||||
|
||||
MicroSD Card / J4
|
||||
"""""""""""""""""
|
||||
|
||||
+---+---------------+----------------+
|
||||
| | ESP32 Pin | MicroSD Signal |
|
||||
+===+===============+================+
|
||||
| 1 | MTDI / GPIO12 | DATA2 |
|
||||
+---+---------------+----------------+
|
||||
| 2 | MTCK / GPIO13 | CD / DATA3 |
|
||||
+---+---------------+----------------+
|
||||
| 3 | MTDO / GPIO15 | CMD |
|
||||
+---+---------------+----------------+
|
||||
| 4 | MTMS / GPIO14 | CLK |
|
||||
+---+---------------+----------------+
|
||||
| 5 | GPIO2 | DATA0 |
|
||||
+---+---------------+----------------+
|
||||
| 6 | GPIO4 | DATA1 |
|
||||
+---+---------------+----------------+
|
||||
| 7 | GPIO21 | CD |
|
||||
+---+---------------+----------------+
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-lcd-connector-cmake:
|
||||
|
||||
LCD / U5
|
||||
""""""""
|
||||
|
||||
+---+-----------+------------+
|
||||
| | ESP32 Pin | LCD Signal |
|
||||
+===+===========+============+
|
||||
| 1 | GPIO18 | RESET |
|
||||
+---+-----------+------------+
|
||||
| 2 | GPIO19 | SCL |
|
||||
+---+-----------+------------+
|
||||
| 3 | GPIO21 | D/C |
|
||||
+---+-----------+------------+
|
||||
| 4 | GPIO22 | CS |
|
||||
+---+-----------+------------+
|
||||
| 5 | GPIO23 | SDA |
|
||||
+---+-----------+------------+
|
||||
| 6 | GPIO25 | SDO |
|
||||
+---+-----------+------------+
|
||||
| 7 | GPIO5 | Backlight |
|
||||
+---+-----------+------------+
|
||||
|
||||
|
||||
Start Application Development
|
||||
-----------------------------
|
||||
|
||||
Before powering up your ESP-WROVER-KIT V3, please make sure that the board is in good condition with no obvious signs of damage.
|
||||
|
||||
|
||||
Initial Setup
|
||||
^^^^^^^^^^^^^
|
||||
|
||||
Select the source of power supply for the board by setting jumper JP7. The options are either USB port or an external power supply. For this application selection of USB port is sufficient. Enable UART communication by installing jumpers on JP11. Both selections are shown in table below.
|
||||
|
||||
+----------------------+----------------------+
|
||||
| Power up | Enable UART |
|
||||
| from USB port | communication |
|
||||
+----------------------+----------------------+
|
||||
| |jp7-usb_5v| | |jp11-rx-tx| |
|
||||
+----------------------+----------------------+
|
||||
|
||||
Do not install any other jumpers.
|
||||
|
||||
|
||||
Now to Development
|
||||
^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Please proceed to :doc:`index`, where Section :ref:`get-started-step-by-step-cmake` will quickly help you set up the development environment and then flash an example project onto your board.
|
||||
|
||||
|
||||
Related Documents
|
||||
-----------------
|
||||
|
||||
* `ESP-WROVER-KIT V3 schematic`_ (PDF)
|
||||
* `ESP32 Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf>`_ (PDF)
|
||||
* `ESP32-WROVER Datasheet <https://espressif.com/sites/default/files/documentation/esp32-wrover_datasheet_en.pdf>`_ (PDF)
|
||||
* `ESP-WROOM-32 Datasheet <https://espressif.com/sites/default/files/documentation/esp-wroom-32_datasheet_en.pdf>`_ (PDF)
|
||||
* :doc:`../api-guides/jtag-debugging/index`
|
||||
* :doc:`../hw-reference/index`
|
||||
|
||||
.. |jp7-ext_5v| image:: ../../_static/esp-wrover-kit-v3-jp7-ext_5v.png
|
||||
.. |jp7-usb_5v| image:: ../../_static/esp-wrover-kit-v3-jp7-usb_5v.png
|
||||
.. |jp8| image:: ../../_static/esp-wrover-kit-v3-jp8.png
|
||||
.. |jp11-rx-tx| image:: ../../_static/esp-wrover-kit-v3-jp11-tx-rx.png
|
||||
.. |jp14| image:: ../../_static/esp-wrover-kit-v3-jp14.png
|
||||
|
||||
.. _ESP-WROVER-KIT V3 schematic: https://dl.espressif.com/dl/schematics/ESP-WROVER-KIT_SCH-3.pdf
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
|
||||
get-started-wrover-kit-v2.rst
|
||||
ESP-WROVER-KIT V4.1 Getting Started Guide (CMake)
|
||||
=================================================
|
||||
:link_to_translation:`zh_CN:[中文]`
|
||||
|
||||
This guide shows how to get started with the ESP-WROVER-KIT V4.1 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`.
|
||||
|
||||
|
||||
What You Need
|
||||
-------------
|
||||
|
||||
* :ref:`ESP-WROVER-KIT V4.1 board <get-started-esp-wrover-kit-v4.1-board-front-cmake>`
|
||||
* USB 2.0 A to Micro B Cable
|
||||
* Computer running Windows, Linux, or macOS
|
||||
|
||||
You can skip the introduction sections and go directly to Section `Start Application Development`_.
|
||||
|
||||
|
||||
Overview
|
||||
--------
|
||||
|
||||
ESP-WROVER-KIT is an ESP32-based development board produced by `Espressif <https://espressif.com>`_.
|
||||
|
||||
ESP-WROVER-KIT features the following integrated components:
|
||||
|
||||
- ESP32-WROVER-B module
|
||||
- LCD screen
|
||||
- MicroSD card slot
|
||||
|
||||
Its 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.
|
||||
|
||||
Most of the ESP32 I/O pins are broken out to the board's pin headers for easy access.
|
||||
|
||||
.. note::
|
||||
|
||||
ESP32's GPIO16 and GPIO17 are used 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.
|
||||
|
||||
|
||||
Functionality Overview
|
||||
----------------------
|
||||
|
||||
The block diagram below shows the main components of ESP-WROVER-KIT and their interconnections.
|
||||
|
||||
.. figure:: ../../_static/esp-wrover-kit-block-diagram.png
|
||||
:align: center
|
||||
:alt: ESP-WROVER-KIT block diagram
|
||||
:figclass: align-center
|
||||
|
||||
ESP-WROVER-KIT block diagram
|
||||
|
||||
|
||||
Functional Description
|
||||
----------------------
|
||||
|
||||
The following two figures and the table below describe the key components, interfaces and controls of the ESP-WROVER-KIT board.
|
||||
|
||||
.. _get-started-esp-wrover-kit-v4.1-board-front-cmake:
|
||||
|
||||
.. figure:: ../../_static/esp-wrover-kit-v4.1-layout-front.png
|
||||
:align: center
|
||||
:alt: ESP-WROVER-KIT board layout - front
|
||||
:figclass: align-center
|
||||
|
||||
ESP-WROVER-KIT board layout - front
|
||||
|
||||
.. _get-started-esp-wrover-kit-v4.1-board-back-cmake:
|
||||
|
||||
.. figure:: ../../_static/esp-wrover-kit-v4.1-layout-back.png
|
||||
:align: center
|
||||
:alt: ESP-WROVER-KIT board layout - back
|
||||
:figclass: align-center
|
||||
|
||||
ESP-WROVER-KIT board layout - back
|
||||
|
||||
|
||||
The table below provides description in the following manner:
|
||||
|
||||
- Starting from the first picture's top right corner and going clockwise
|
||||
- Then moving on to the second picture
|
||||
|
||||
|
||||
================== =================================================================================================================================
|
||||
Key Component Description
|
||||
================== =================================================================================================================================
|
||||
FT2232 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 V4.1 schematic`_.
|
||||
|
||||
32.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.
|
||||
|
||||
0R 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.
|
||||
|
||||
ESP32-WROVER This EPS32 module features 64-Mbit PSRAM for flexible extended storage and data processing capabilities.
|
||||
|
||||
Diagnostic LEDs Four red LEDs connected to the GPIO pins of FT2232. Intended for future use.
|
||||
|
||||
UART Serial port. The serial TX/RX signals of FT2232 and ESP32 are broken out to the inward and outward sides of JP2 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.
|
||||
|
||||
SPI 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 voltage of this interface is 3.3V.
|
||||
|
||||
CTS/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.
|
||||
|
||||
JTAG JTAG interface. JTAG signals of FT2232 and ESP32 are broken out to the inward and outward sides of JP2 respectively. By default, these pairs of pins are disconnected. To enable JTAG, short the respective pins with jumpers as shown in Section `Setup Options`_.
|
||||
|
||||
USB Port USB interface. Power supply for the board as well as the communication interface between a computer and the board.
|
||||
|
||||
EN Button Reset button.
|
||||
|
||||
Boot Button Download button. Holding down **Boot** and then pressing **EN** initiates Firmware Download mode for downloading firmware through the serial port.
|
||||
|
||||
Power Switch Power On/Off Switch. Toggling toward the **Boot** button powers the board on, toggling away from **Boot** powers the board off.
|
||||
|
||||
Power Selector 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.
|
||||
|
||||
5V Input The 5V power supply interface can be more convenient when the board is operating autonomously (not connected to a computer).
|
||||
|
||||
5V Power On LED This red LED turns on when power is supplied to the board, either from **USB** or **5V Input**.
|
||||
|
||||
LDO 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 V4.1 schematic`_.
|
||||
|
||||
Camera Connector Camera interface, a standard OV7670 camera module.
|
||||
|
||||
RGB LED Red, green and blue (RGB) light emitting diodes (LEDs), can be controlled by pulse width modulation (PWM).
|
||||
|
||||
I/O Connector 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.
|
||||
|
||||
Micro SD Card Slot Useful for developing applications that access Micro SD card for data storage and retrieval.
|
||||
|
||||
LCD 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-v4.1-board-back`.
|
||||
================== =================================================================================================================================
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-kit-v4.1-setup-options-cmake:
|
||||
|
||||
Setup Options
|
||||
-------------
|
||||
|
||||
There are three jumper blocks available to set up the board functionality. The most frequently required options are listed in the table below.
|
||||
|
||||
======= ================ =========================================================
|
||||
Header Jumper Setting Description of Functionality
|
||||
======= ================ =========================================================
|
||||
JP7 |jp7-ext_5v| Power ESP-WROVER-KIT via an external power supply
|
||||
JP7 |jp7-usb_5v| Power ESP-WROVER-KIT via USB
|
||||
JP2 |jp2-jtag| Enable JTAG functionality
|
||||
JP2 |jp2-tx-rx| Enable UART communication
|
||||
JP14 |jp14| Enable RTS/CTS flow control for serial communication
|
||||
======= ================ =========================================================
|
||||
|
||||
|
||||
Allocation of ESP32 Pins
|
||||
------------------------
|
||||
|
||||
Some 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.
|
||||
|
||||
Some 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.
|
||||
|
||||
In 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.
|
||||
|
||||
For more details on which pins are shared among which peripherals, please refer to the table in the next section.
|
||||
|
||||
|
||||
Main I/O Connector / JP1
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
The 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.
|
||||
|
||||
===================== ===== ===== =====================
|
||||
Shared With I/O I/O Shared With
|
||||
===================== ===== ===== =====================
|
||||
n/a 3.3V GND n/a
|
||||
NC/XTAL IO32 IO33 NC/XTAL
|
||||
JTAG, MicroSD IO12 IO13 JTAG, MicroSD
|
||||
JTAG, MicroSD IO14 IO27 Camera
|
||||
Camera IO26 IO25 Camera, LCD
|
||||
Camera IO35 IO34 Camera
|
||||
Camera IO39 IO36 Camera
|
||||
JTAG EN IO23 Camera, LCD
|
||||
Camera, LCD IO22 IO21 Camera, LCD, MicroSD
|
||||
Camera, LCD IO19 IO18 Camera, LCD
|
||||
Camera, LCD IO5 IO17 PSRAM
|
||||
PSRAM IO16 IO4 LED, Camera, MicroSD
|
||||
Camera, LED, Boot IO0 IO2 LED, MicroSD
|
||||
JTAG, MicroSD IO15 5V
|
||||
===================== ===== ===== =====================
|
||||
|
||||
Legend:
|
||||
|
||||
* NC/XTAL - :ref:`32.768 kHz Oscillator <get-started-esp-wrover-kit-v4.1-xtal-cmake>`
|
||||
* JTAG - :ref:`JTAG / JP8 <get-started-esp-wrover-kit-v4.1-jtag-header-cmake>`
|
||||
* Boot - Boot button / SW2
|
||||
* Camera - :ref:`Camera / JP4 <get-started-esp-wrover-kit-v4.1-camera-header-cmake>`
|
||||
* LED - :ref:`RGB LED <get-started-esp-wrover-kit-v4.1-rgb-led-connections-cmake>`
|
||||
* MicroSD - :ref:`MicroSD Card / J4 <get-started-esp-wrover-kit-v4.1-microsd-card-slot-cmake>`
|
||||
* LCD - :ref:`LCD / U5 <get-started-esp-wrover-kit-v4.1-lcd-connector-cmake>`
|
||||
* PSRAM - ESP32-WROVER-B's PSRAM
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-kit-v4.1-xtal-cmake:
|
||||
|
||||
32.768 kHz Oscillator
|
||||
^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
==== ==========
|
||||
. ESP32 Pin
|
||||
==== ==========
|
||||
1 GPIO32
|
||||
2 GPIO33
|
||||
==== ==========
|
||||
|
||||
.. note::
|
||||
|
||||
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.
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-kit-v4.1-spi-flash-header-cmake:
|
||||
|
||||
SPI Flash / JP2
|
||||
^^^^^^^^^^^^^^^
|
||||
|
||||
==== =============
|
||||
. ESP32 Pin
|
||||
==== =============
|
||||
1 CLK / GPIO6
|
||||
2 SD0 / GPIO7
|
||||
3 SD1 / GPIO8
|
||||
4 SD2 / GPIO9
|
||||
5 SD3 / GPIO10
|
||||
6 CMD / GPIO11
|
||||
==== =============
|
||||
|
||||
.. important::
|
||||
|
||||
The module's flash bus is connected to the jumper block JP2 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 JP2.
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-kit-v4.1-jtag-header-cmake:
|
||||
|
||||
JTAG / JP2
|
||||
^^^^^^^^^^
|
||||
|
||||
==== ============== =============
|
||||
. ESP32 Pin JTAG Signal
|
||||
==== ============== =============
|
||||
1 EN TRST_N
|
||||
2 MTMS / GPIO14 TMS
|
||||
3 MTDO / GPIO15 TDO
|
||||
4 MTDI / GPIO12 TDI
|
||||
5 MTCK / GPIO13 TCK
|
||||
==== ============== =============
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-kit-v4.1-camera-header-cmake:
|
||||
|
||||
Camera / JP4
|
||||
^^^^^^^^^^^^
|
||||
|
||||
==== ========== =============================
|
||||
. ESP32 Pin Camera Signal
|
||||
==== ========== =============================
|
||||
1 n/a 3.3V
|
||||
2 n/a Ground
|
||||
3 GPIO27 SIO_C / SCCB Clock
|
||||
4 GPIO26 SIO_D / SCCB Data
|
||||
5 GPIO25 VSYNC / Vertical Sync
|
||||
6 GPIO23 HREF / Horizontal Reference
|
||||
7 GPIO22 PCLK / Pixel Clock
|
||||
8 GPIO21 XCLK / System Clock
|
||||
9 GPIO35 D7 / Pixel Data Bit 7
|
||||
10 GPIO34 D6 / Pixel Data Bit 6
|
||||
11 GPIO39 D5 / Pixel Data Bit 5
|
||||
12 GPIO36 D4 / Pixel Data Bit 4
|
||||
13 GPIO19 D3 / Pixel Data Bit 3
|
||||
14 GPIO18 D2 / Pixel Data Bit 2
|
||||
15 GPIO5 D1 / Pixel Data Bit 1
|
||||
16 GPIO4 D0 / Pixel Data Bit 0
|
||||
17 GPIO0 RESET / Camera Reset
|
||||
18 n/a PWDN / Camera Power Down
|
||||
==== ========== =============================
|
||||
|
||||
* Signals D0 .. D7 denote camera data bus
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-kit-v4.1-rgb-led-connections-cmake:
|
||||
|
||||
RGB LED
|
||||
^^^^^^^
|
||||
|
||||
==== ========== =========
|
||||
. ESP32 Pin RGB LED
|
||||
==== ========== =========
|
||||
1 GPIO0 Red
|
||||
2 GPIO2 Green
|
||||
3 GPIO4 Blue
|
||||
==== ========== =========
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-kit-v4.1-microsd-card-slot-cmake:
|
||||
|
||||
MicroSD Card
|
||||
^^^^^^^^^^^^
|
||||
|
||||
==== ============== ===============
|
||||
. ESP32 Pin MicroSD Signal
|
||||
==== ============== ===============
|
||||
1 MTDI / GPIO12 DATA2
|
||||
2 MTCK / GPIO13 CD / DATA3
|
||||
3 MTDO / GPIO15 CMD
|
||||
4 MTMS / GPIO14 CLK
|
||||
5 GPIO2 DATA0
|
||||
6 GPIO4 DATA1
|
||||
7 GPIO21 CD
|
||||
==== ============== ===============
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-kit-v4.1-lcd-connector-cmake:
|
||||
|
||||
LCD / U5
|
||||
^^^^^^^^
|
||||
|
||||
==== ============== ===============
|
||||
. ESP32 Pin LCD Signal
|
||||
==== ============== ===============
|
||||
1 GPIO18 RESET
|
||||
2 GPIO19 SCL
|
||||
3 GPIO21 D/C
|
||||
4 GPIO22 CS
|
||||
5 GPIO23 SDA
|
||||
6 GPIO25 SDO
|
||||
7 GPIO5 Backlight
|
||||
==== ============== ===============
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-kit-start-development-cmake:
|
||||
|
||||
Start Application Development
|
||||
-----------------------------
|
||||
|
||||
Before powering up your ESP-WROVER-KIT, please make sure that the board is in good condition with no obvious signs of damage.
|
||||
|
||||
|
||||
Initial Setup
|
||||
^^^^^^^^^^^^^
|
||||
|
||||
Please set only the following jumpers shown in the pictures below:
|
||||
|
||||
- Select USB as the power source using the jumper block JP7.
|
||||
|
||||
- Enable UART communication using the jumper block JP2.
|
||||
|
||||
======================== ==========================
|
||||
Power up from USB port Enable UART communication
|
||||
======================== ==========================
|
||||
|jp7-usb_5v| |jp2-tx-rx|
|
||||
======================== ==========================
|
||||
|
||||
Do not install any other jumpers.
|
||||
|
||||
Turn the **Power Switch** to ON, the **5V Power On LED** should light up.
|
||||
|
||||
Now to Development
|
||||
^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Please proceed to :doc:`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.
|
||||
|
||||
|
||||
Related Documents
|
||||
-----------------
|
||||
|
||||
* `ESP-WROVER-KIT V4.1 schematic`_ (PDF)
|
||||
* `ESP32 Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf>`_ (PDF)
|
||||
* `ESP32-WROVER-B Datasheet <https://espressif.com/sites/default/files/documentation/esp32-wrover-b_datasheet_en.pdf>`_ (PDF)
|
||||
* :doc:`../api-guides/jtag-debugging/index`
|
||||
* :doc:`../hw-reference/index`
|
||||
|
||||
.. |jp7-ext_5v| image:: ../../_static/esp-wrover-kit-v4.1-jp7-ext_5v.jpg
|
||||
.. |jp7-usb_5v| image:: ../../_static/esp-wrover-kit-v4.1-jp7-usb_5v.jpg
|
||||
.. |jp2-jtag| image:: ../../_static/esp-wrover-kit-v4.1-jp2-jtag.jpg
|
||||
.. |jp2-tx-rx| image:: ../../_static/esp-wrover-kit-v4.1-jp2-tx-rx.jpg
|
||||
.. |jp14| image:: ../../_static/esp-wrover-kit-v4.1-jp14.jpg
|
||||
|
||||
.. _ESP-WROVER-KIT V4.1 schematic: https://dl.espressif.com/dl/schematics/ESP-WROVER-KIT_V4_1.pdf
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
|
||||
get-started-wrover-kit-v3.rst
|
||||
get-started-wrover-kit-v2.rst
|
||||
|
||||
@ -1,33 +1,43 @@
|
||||
ESP-WROVER-KIT V2 Getting Started Guide
|
||||
=======================================
|
||||
ESP-WROVER-KIT V2 Getting Started Guide (CMake)
|
||||
===============================================
|
||||
:link_to_translation:`zh_CN:[中文]`
|
||||
|
||||
This user guide shows how to get started with ESP-WROVER-KIT V2 development board including description of its functionality and configuration options. For description of other versions of the ESP-WROVER-KIT check :doc:`../hw-reference/index`.
|
||||
|
||||
If you like to start using this board right now, go directly to section :ref:`esp-wrover-kit-v2-start-development`.
|
||||
This guide shows how to get started with the ESP-WROVER-KIT V2 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`.
|
||||
|
||||
|
||||
What You Need
|
||||
-------------
|
||||
|
||||
* 1 × ESP-WROVER-KIT V2 board
|
||||
* 1 x Micro USB 2.0 Cable, Type A to Micro B
|
||||
* 1 × PC loaded with Windows, Linux or Mac OS
|
||||
* ESP-WROVER-KIT V2 board
|
||||
* USB 2.0 A to Micro B Cable
|
||||
* Computer running Windows, Linux, or macOS
|
||||
|
||||
You can skip the introduction sections and go directly to Section `Start Application Development`_.
|
||||
|
||||
|
||||
Overview
|
||||
^^^^^^^^
|
||||
--------
|
||||
|
||||
The ESP-WROVER-KIT is a development board produced by `Espressif <https://espressif.com>`_ 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.
|
||||
ESP-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.
|
||||
|
||||
.. note::
|
||||
ESP-WROVER-KIT comes with the following ESP32 modules:
|
||||
|
||||
ESP-WROVER-KIT V2 integrates the ESP-WROOM-32 module by default.
|
||||
- :ref:`esp-modules-and-boards-esp32-wroom-32`
|
||||
- :ref:`ESP32-WROVER <esp-modules-and-boards-esp32-wrover>`
|
||||
|
||||
Its 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.
|
||||
|
||||
Most of the ESP32 I/O pins are broken out to the board's pin headers for easy access.
|
||||
|
||||
.. note::
|
||||
|
||||
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.
|
||||
|
||||
|
||||
Functionality Overview
|
||||
^^^^^^^^^^^^^^^^^^^^^^
|
||||
----------------------
|
||||
|
||||
Block diagram below presents main components of ESP-WROVER-KIT and interconnections between components.
|
||||
The block diagram below shows the main components of ESP-WROVER-KIT and their interconnections.
|
||||
|
||||
.. figure:: ../../_static/esp-wrover-kit-block-diagram.png
|
||||
:align: center
|
||||
@ -38,56 +48,11 @@ Block diagram below presents main components of ESP-WROVER-KIT and interconnecti
|
||||
|
||||
|
||||
Functional Description
|
||||
^^^^^^^^^^^^^^^^^^^^^^
|
||||
----------------------
|
||||
|
||||
The following list and figures below describe key components, interfaces and controls of ESP-WROVER-KIT board.
|
||||
The following two figures and the table below describe the key components, interfaces, and controls of the ESP-WROVER-KIT board.
|
||||
|
||||
32.768 kHz
|
||||
An external precision 32.768 kHz crystal oscillator provides the chip with a clock of low-power consumption during the Deep-sleep 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.
|
||||
|
||||
.. note::
|
||||
|
||||
GPIO16 and GPIO17 are used as the CS and clock signal for PSRAM. To ensure reliable performance, the two GPIOs are not broken out.
|
||||
|
||||
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.
|
||||
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. If an ESP32-WROVER is being used, please note that the electrical level on the flash and SRAM is 1.8V.
|
||||
JTAG
|
||||
JTAG interface: the JTAG signals on FT2232HL and ESP32 are broken out to the two sides of JP8. By default, the two signals are disconnected. To enable JTAG, shorting jumpers are required on the signals.
|
||||
FT2232
|
||||
FT2232 chip is a multi-protocol USB-to-serial bridge. The FT2232 chip features USB-to-UART and USB-to-JTAG functionalities. Users can control and program the FT2232 chip through the USB interface to establish communication with ESP32.
|
||||
|
||||
The embedded FT2232 chip is one of the distinguishing features of the ESP-WROVER-KIT. It enhances users’ convenience in terms of application development and debugging. In addition, uses do not need to buy a JTAG debugger separately, which reduces the development cost, see `ESP-WROVER-KIT V2 schematic`_.
|
||||
EN
|
||||
Reset button: pressing this button resets the system.
|
||||
Boot
|
||||
Download button: holding down the **Boot** button and pressing the **EN** button initiates the firmware download mode. Then user can download firmware through the serial port.
|
||||
USB
|
||||
USB interface. It functions as the power supply for the board and the communication interface between PC and ESP32 module.
|
||||
Power Select
|
||||
Power supply selection interface: the ESP-WROVER-KIT can be powered through the USB interface or the 5V Input interface. The user can select the power supply with a jumper. More details can be found in section :ref:`esp-wrover-kit-v2-setup-options`, jumper header JP7.
|
||||
Power Key
|
||||
Power on/off button: toggling to the right powers the board on; toggling to the left powers the board off.
|
||||
5V Input
|
||||
The 5V power supply interface is used as a backup power supply in case of full-load operation.
|
||||
LDO
|
||||
NCP1117(1A). 5V-to-3.3V LDO. (There is an alternative pin-compatible LDO — LM317DCY, with an output current of up to 1.5A). NCP1117 can provide a maximum current of 1A. The LDO solutions are available with both fixed output voltage and variable output voltage. For details please refer to `ESP-WROVER-KIT V2 schematic`_.
|
||||
Camera
|
||||
Camera interface: a standard OV7670 camera module is supported.
|
||||
RGB
|
||||
Red, green and blue (RGB) light emitting diodes (LEDs), which may be controlled by pulse width modulation (PWM).
|
||||
I/O
|
||||
All the pins on the ESP32 module are led out to the pin headers on the ESPWROVER-KIT. Users can program ESP32 to enable multiple functions such as PWM, ADC, DAC, I2C, I2S, SPI, etc.
|
||||
|
||||
Micro SD Card
|
||||
Micro SD card slot for data storage: when ESP32 enters the download mode, GPIO2 cannot be held high. However, a pull-up resistor is required on GPIO2 to enable the Micro SD Card. By default, GPIO2 and the pull-up resistor R153 are disconnected. To enable the SD Card, use jumpers on JP1 as shown in section :ref:`esp-wrover-kit-v2-setup-options`.
|
||||
LCD
|
||||
ESP-WROVER-KIT supports mounting and interfacing a 3.2” SPI (standard 4-wire Serial Peripheral Interface) LCD, as shown on figure :ref:`esp-wrover-kit-v2-board-back`.
|
||||
.. _get-started-esp-wrover-kit-v2-board-front:
|
||||
|
||||
.. figure:: ../../_static/esp-wrover-kit-v2-layout-front.png
|
||||
:align: center
|
||||
@ -96,7 +61,7 @@ LCD
|
||||
|
||||
ESP-WROVER-KIT board layout - front
|
||||
|
||||
.. _esp-wrover-kit-v2-board-back:
|
||||
.. _get-started-esp-wrover-kit-v2-board-back:
|
||||
|
||||
.. figure:: ../../_static/esp-wrover-kit-v2-layout-back.png
|
||||
:align: center
|
||||
@ -106,57 +71,101 @@ LCD
|
||||
ESP-WROVER-KIT board layout - back
|
||||
|
||||
|
||||
.. _esp-wrover-kit-v2-setup-options:
|
||||
The table below provides description in the following manner:
|
||||
|
||||
- Starting from the first picture's top right corner and going clockwise
|
||||
- Then moving on to the second picture
|
||||
|
||||
|
||||
================== =================================================================================================================================
|
||||
Key Component Description
|
||||
================== =================================================================================================================================
|
||||
32.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.
|
||||
|
||||
ESP32 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.
|
||||
|
||||
CTS/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.
|
||||
|
||||
UART 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.
|
||||
|
||||
SPI 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.
|
||||
|
||||
JTAG 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`_.
|
||||
|
||||
FT2232 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 features USB-to-UART and USB-to-JTAG functionalities.
|
||||
|
||||
EN Reset button.
|
||||
|
||||
Boot Download button. Holding down **Boot** and then pressing **EN** initiates Firmware Download mode for downloading firmware through the serial port.
|
||||
|
||||
USB USB interface. Power supply for the board as well as the communication interface between a computer and the board.
|
||||
|
||||
Power 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.
|
||||
|
||||
Power Key Power On/Off Switch. Toggling toward **USB** powers the board on, toggling away from **USB** powers the board off.
|
||||
|
||||
5V Input The 5V power supply interface can be more convenient when the board is operating autonomously (not connected to a computer).
|
||||
|
||||
LDO 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 V2 schematic`_.
|
||||
|
||||
Camera Camera interface, a standard OV7670 camera module.
|
||||
|
||||
RGB Red, green and blue (RGB) light emitting diodes (LEDs), can be controlled by pulse width modulation (PWM).
|
||||
|
||||
I/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.
|
||||
|
||||
Micro SD Card Micro SD card slot for data storage: when ESP32 enters the download mode, GPIO2 cannot be held high. However, a pull-up resistor is required on GPIO2 to enable the Micro SD Card. By default, GPIO2 and the pull-up resistor R153 are disconnected. To enable the SD Card, use jumpers on JP1 as shown in Section `Setup Options`_.
|
||||
|
||||
LCD 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-v2-board-back`.
|
||||
================== =================================================================================================================================
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-kit-v2-setup-options:
|
||||
|
||||
Setup Options
|
||||
^^^^^^^^^^^^^
|
||||
-------------
|
||||
|
||||
There are five jumper headers available to set up the board functionality. Typical options to select from are listed in table below.
|
||||
There are five jumper blocks available to set up the board functionality. The most frequently required options are listed in the table below.
|
||||
|
||||
+--------+----------------------+-------------------------------------------------+
|
||||
| Header | Jumper Setting | Description of Functionality |
|
||||
+--------+----------------------+-------------------------------------------------+
|
||||
| JP1 | |jp1-sd_io2| | Enable pull up for the Micro SD Card |
|
||||
+--------+----------------------+-------------------------------------------------+
|
||||
| JP1 | |jp1-both| | Assert GPIO2 low during each download |
|
||||
| | | (by jumping it to GPIO0) |
|
||||
+--------+----------------------+-------------------------------------------------+
|
||||
| JP7 | |jp7-ext_5v| | Power ESP-WROVER-KIT board from an external |
|
||||
| | | power supply |
|
||||
+--------+----------------------+-------------------------------------------------+
|
||||
| JP7 | |jp7-usb_5v| | Power ESP-WROVER-KIT board from an USB port |
|
||||
+--------+----------------------+-------------------------------------------------+
|
||||
| JP8 | |jp8| | Enable JTAG functionality |
|
||||
+--------+----------------------+-------------------------------------------------+
|
||||
| JP11 | |jp11-rx-tx| | Enable UART communication |
|
||||
+--------+----------------------+-------------------------------------------------+
|
||||
| JP14 | |jp14| | Enable RTS/CTS flow control for serial |
|
||||
| | | communication |
|
||||
+--------+----------------------+-------------------------------------------------+
|
||||
======= ================ =========================================================
|
||||
Header Jumper Setting Description of Functionality
|
||||
======= ================ =========================================================
|
||||
JP1 |jp1-sd_io2| Enable pull up for the Micro SD Card
|
||||
JP1 |jp1-both| Assert GPIO2 low during each download (by jumping it to GPIO0)
|
||||
JP7 |jp7-ext_5v| Power ESP-WROVER-KIT via an external power supply
|
||||
JP7 |jp7-usb_5v| Power ESP-WROVER-KIT via USB
|
||||
JP8 |jp8| Enable JTAG functionality
|
||||
JP11 |jp11-tx-rx| Enable UART communication
|
||||
JP14 |jp14| Enable RTS/CTS flow control for serial communication
|
||||
======= ================ =========================================================
|
||||
|
||||
|
||||
.. _esp-wrover-kit-v2-start-development:
|
||||
.. _get-started-esp-wrover-kit-v2-start-development:
|
||||
|
||||
Start Application Development
|
||||
-----------------------------
|
||||
|
||||
Before powering up your ESP-WROVER-KIT V2, please make sure that the board is in good condition with no obvious signs of damage.
|
||||
Before powering up your ESP-WROVER-KIT, please make sure that the board is in good condition with no obvious signs of damage.
|
||||
|
||||
|
||||
Initial Setup
|
||||
^^^^^^^^^^^^^
|
||||
|
||||
Select the source of power supply for the board by setting jumper JP7. The options are either USB port or an external power supply. For this application selection of USB port is sufficient. Enable UART communication by installing jumpers on JP11. Both selections are shown in table below.
|
||||
Please set only the following jumpers shown in the pictures below:
|
||||
|
||||
+----------------------+----------------------+
|
||||
| Power up | Enable UART |
|
||||
| from USB port | communication |
|
||||
+----------------------+----------------------+
|
||||
| |jp7-usb_5v| | |jp11-rx-tx| |
|
||||
+----------------------+----------------------+
|
||||
- Select USB as the power source using the jumper block JP7.
|
||||
|
||||
- Enable UART communication using the jumper block JP11.
|
||||
|
||||
======================== ==========================
|
||||
Power up from USB port Enable UART communication
|
||||
======================== ==========================
|
||||
|jp7-usb_5v| |jp11-tx-rx|
|
||||
======================== ==========================
|
||||
|
||||
Do not install any other jumpers.
|
||||
|
||||
Turn the **Power Switch** to ON, the **5V Power On LED** should light up.
|
||||
|
||||
Now to Development
|
||||
^^^^^^^^^^^^^^^^^^
|
||||
@ -169,8 +178,8 @@ Related Documents
|
||||
|
||||
* `ESP-WROVER-KIT V2 schematic`_ (PDF)
|
||||
* `ESP32 Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf>`_ (PDF)
|
||||
* `ESP-WROOM-32 Datasheet <https://www.espressif.com/sites/default/files/documentation/esp-wroom-32_datasheet_en.pdf>`_ (PDF)
|
||||
* `ESP32-WROVER Datasheet <https://espressif.com/sites/default/files/documentation/esp32-wrover_datasheet_en.pdf>`_ (PDF)
|
||||
* `ESP32-WROOM-32 Datasheet <https://espressif.com/sites/default/files/documentation/esp32-wroom-32_datasheet_en.pdf>`_ (PDF)
|
||||
* :doc:`../api-guides/jtag-debugging/index`
|
||||
* :doc:`../hw-reference/index`
|
||||
|
||||
@ -180,7 +189,7 @@ Related Documents
|
||||
.. |jp7-ext_5v| image:: ../../_static/wrover-jp7-ext_5v.png
|
||||
.. |jp7-usb_5v| image:: ../../_static/wrover-jp7-usb_5v.png
|
||||
.. |jp8| image:: ../../_static/wrover-jp8.png
|
||||
.. |jp11-rx-tx| image:: ../../_static/wrover-jp11-tx-rx.png
|
||||
.. |jp11-tx-rx| image:: ../../_static/wrover-jp11-tx-rx.png
|
||||
.. |jp14| image:: ../../_static/wrover-jp14.png
|
||||
|
||||
.. _ESP-WROVER-KIT V2 schematic: https://dl.espressif.com/dl/schematics/ESP-WROVER-KIT_SCH-2.pdf
|
||||
|
||||
@ -1,33 +1,43 @@
|
||||
ESP-WROVER-KIT V3 Getting Started Guide
|
||||
=======================================
|
||||
:link_to_translation:`zh_CN:[中文]`
|
||||
|
||||
This user guide shows how to get started with the ESP-WROVER-KIT V3 development board including description of its functionality and configuration options. For descriptions of other versions of the ESP-WROVER-KIT check :doc:`../hw-reference/index`.
|
||||
|
||||
If you would like to start using this board right now, go directly to the :ref:`get-started-esp-wrover-kit-start-development` section.
|
||||
This 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`.
|
||||
|
||||
|
||||
What You Need
|
||||
-------------
|
||||
|
||||
* 1 × :ref:`ESP-WROVER-KIT V3 board <get-started-esp-wrover-kit-v3-board-front>`
|
||||
* 1 x Micro USB 2.0 Cable, Type A to Micro B
|
||||
* 1 × PC loaded with Windows, Linux or Mac OS
|
||||
* :ref:`ESP-WROVER-KIT V3 board <get-started-esp-wrover-kit-v3-board-front>`
|
||||
* USB 2.0 A to Micro B Cable
|
||||
* Computer running Windows, Linux, or macOS
|
||||
|
||||
You can skip the introduction sections and go directly to Section `Start Application Development`_.
|
||||
|
||||
|
||||
Overview
|
||||
--------
|
||||
|
||||
The ESP-WROVER-KIT is a development board built around the ESP32 and produced by `Espressif <https://espressif.com>`_. This board is compatible with multiple 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.
|
||||
ESP-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.
|
||||
|
||||
.. note::
|
||||
ESP-WROVER-KIT comes with the following ESP32 modules:
|
||||
|
||||
ESP-WROVER-KIT V3 integrates the ESP32-WROVER module by default.
|
||||
- :ref:`esp-modules-and-boards-esp32-wroom-32`
|
||||
- :ref:`ESP32-WROVER <esp-modules-and-boards-esp32-wrover>`
|
||||
|
||||
Its 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.
|
||||
|
||||
Most of the ESP32 I/O pins are broken out to the board's pin headers for easy access.
|
||||
|
||||
.. note::
|
||||
|
||||
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.
|
||||
|
||||
|
||||
Functionality Overview
|
||||
----------------------
|
||||
|
||||
The block diagram below illustrates the ESP-WROVER-KIT's main components and their interconnections.
|
||||
The block diagram below shows the main components of ESP-WROVER-KIT and their interconnections.
|
||||
|
||||
.. figure:: ../../_static/esp-wrover-kit-block-diagram.png
|
||||
:align: center
|
||||
@ -40,57 +50,11 @@ The block diagram below illustrates the ESP-WROVER-KIT's main components and the
|
||||
Functional Description
|
||||
----------------------
|
||||
|
||||
The following lists and figures describe the key components, interfaces, and controls of ESP-WROVER-KIT board.
|
||||
|
||||
32.768 kHz
|
||||
An external precision 32.768 kHz crystal oscillator provides a low-power consumption clock used during Deep-Sleep mode.
|
||||
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 the ESP32-WROOM-32 and the 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::
|
||||
|
||||
GPIO16 and GPIO17 are used as the CS and clock signal for PSRAM. To ensure reliable performance, the two GPIOs are not broken out.
|
||||
|
||||
FT2232
|
||||
The FT2232 chip is a multi-protocol USB-to-serial bridge. Users can control and program the FT2232 chip through the USB interface to establish communication with ESP32. The FT2232 chip also features USB-to-JTAG interface. USB-to-JTAG is available on channel A of the FT2232, whilst USB-to-serial is on channel B. The embedded FT2232 chip is one of the distinguishing features of the ESP-WROVER-KIT. It enhances users’ convenience in terms of application development and debugging. In addition, users need not purchase a JTAG debugger separately, which reduces the development cost, see `ESP-WROVER-KIT V3 schematic`_.
|
||||
UART
|
||||
Serial port: the serial TX/RX signals on the FT2232HL and the ESP32 are broken out to each side 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
|
||||
The SPI interface is used by the ESP32 to access flash and PSRAM memories within the module itself. To interface with another SPI device, an extra CS signal is needed. Please note that the voltage level on this interface depends on the module used (e.g 1.8V and 3.3V for the ESP32-WROVER and ESP32-WROOM-32 respectively).
|
||||
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
|
||||
JTAG interface: the JTAG signals on FT2232HL and ESP32 are broken out to the two sides of JP8. By default, the two signals are disconnected. To enable JTAG, shorting jumpers are required on the signals.
|
||||
EN
|
||||
Reset button: pressing this button resets the system.
|
||||
Boot
|
||||
Download button: holding down the **Boot** button and pressing the **EN** button initiates the firmware download mode. Then user can download firmware through the serial port.
|
||||
USB
|
||||
USB interface. It functions as the power supply for the board and the communication interface between PC and ESP32 module.
|
||||
Power Select
|
||||
Power supply selection interface: the ESP-WROVER-KIT can be powered through the USB interface or the 5V Input interface. The user can select the power supply with a jumper. More details can be found in section :ref:`get-started-esp-wrover-kit-v3-setup-options`, jumper header JP7.
|
||||
Power Key
|
||||
Power on/off button: toggling to the right powers the board on; toggling to the left powers the board off.
|
||||
5V Input
|
||||
The 5V power supply interface is used as a backup power supply in case of full-load operation.
|
||||
LDO
|
||||
NCP1117(1A). 5V-to-3.3V LDO. (There is an alternative pin-compatible LDO — LM317DCY, with an output current of up to 1.5A). NCP1117 can provide a maximum current of 1A. The LDO solutions are available with both fixed output voltage and variable output voltage. For details please refer to `ESP-WROVER-KIT V3 schematic`_.
|
||||
Camera
|
||||
Camera interface: a standard OV7670 camera module is supported.
|
||||
RGB
|
||||
Red, green and blue (RGB) light emitting diodes (LEDs), which may be controlled by pulse width modulation (PWM).
|
||||
I/O
|
||||
All the pins on the ESP32 module are led out to the pin headers on the ESP-WROVER-KIT. Users can program ESP32 to enable multiple functions such as PWM, ADC, DAC, I2C, I2S, SPI, etc.
|
||||
Micro SD Card
|
||||
Develop applications that access Micro SD card for data storage and retrieval.
|
||||
LCD
|
||||
ESP-WROVER-KIT supports 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`.
|
||||
The following two figures and the table below describe the key components, interfaces, and controls of the ESP-WROVER-KIT board.
|
||||
|
||||
.. _get-started-esp-wrover-kit-v3-board-front:
|
||||
|
||||
.. figure:: ../../_static/esp32-wrover-kit-layout-front.jpg
|
||||
.. figure:: ../../_static/esp-wrover-kit-v3-layout-front.jpg
|
||||
:align: center
|
||||
:alt: ESP-WROVER-KIT board layout - front
|
||||
:figclass: align-center
|
||||
@ -99,7 +63,7 @@ LCD
|
||||
|
||||
.. _get-started-esp-wrover-kit-v3-board-back:
|
||||
|
||||
.. figure:: ../../_static/esp32-wrover-kit-layout-back.jpg
|
||||
.. figure:: ../../_static/esp-wrover-kit-v3-layout-back.jpg
|
||||
:align: center
|
||||
:alt: ESP-WROVER-KIT board layout - back
|
||||
:figclass: align-center
|
||||
@ -107,72 +71,110 @@ LCD
|
||||
ESP-WROVER-KIT board layout - back
|
||||
|
||||
|
||||
The table below provides description in the following manner:
|
||||
|
||||
- Starting from the first picture's top right corner and going clockwise
|
||||
- Then moving on to the second picture
|
||||
|
||||
|
||||
================== =================================================================================================================================
|
||||
Key Component Description
|
||||
================== =================================================================================================================================
|
||||
32.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.
|
||||
|
||||
0R 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.
|
||||
|
||||
ESP32 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.
|
||||
|
||||
FT2232 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`_.
|
||||
|
||||
UART 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.
|
||||
|
||||
SPI 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.
|
||||
|
||||
CTS/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.
|
||||
|
||||
JTAG 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`_.
|
||||
|
||||
EN Reset button.
|
||||
|
||||
Boot Download button. Holding down **Boot** and then pressing **EN** initiates Firmware Download mode for downloading firmware through the serial port.
|
||||
|
||||
USB USB interface. Power supply for the board as well as the communication interface between a computer and the board.
|
||||
|
||||
Power Key Power On/Off Switch. Toggling toward **USB** powers the board on, toggling away from **USB** powers the board off.
|
||||
|
||||
Power 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.
|
||||
|
||||
5V Input The 5V power supply interface can be more convenient when the board is operating autonomously (not connected to a computer).
|
||||
|
||||
LDO 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`_.
|
||||
|
||||
Camera Camera interface, a standard OV7670 camera module.
|
||||
|
||||
RGB LED Red, green and blue (RGB) light emitting diodes (LEDs), can be controlled by pulse width modulation (PWM).
|
||||
|
||||
I/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.
|
||||
|
||||
Micro SD Card Slot Useful for developing applications that access Micro SD card for data storage and retrieval.
|
||||
|
||||
LCD 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`.
|
||||
================== =================================================================================================================================
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-kit-v3-setup-options:
|
||||
|
||||
Setup Options
|
||||
-------------
|
||||
|
||||
There are five jumper headers available to set up the board functionality. Typical options to select from are listed in table below.
|
||||
There are five jumper blocks available to set up the board functionality. The most frequently required options are listed in the table below.
|
||||
|
||||
+--------+------------------+--------------------------------------------------+
|
||||
| Header | Jumper Setting | Description of Functionality |
|
||||
+--------+------------------+--------------------------------------------------+
|
||||
| JP7 | |jp7-ext_5v| | Power ESP-WROVER-KIT board from an external |
|
||||
| | | power supply |
|
||||
+--------+------------------+--------------------------------------------------+
|
||||
| JP7 | |jp7-usb_5v| | Power ESP-WROVER-KIT board from an USB port |
|
||||
+--------+------------------+--------------------------------------------------+
|
||||
| JP8 | |jp8| | Enable JTAG functionality |
|
||||
+--------+------------------+--------------------------------------------------+
|
||||
| JP11 | |jp11-rx-tx| | Enable UART communication |
|
||||
+--------+------------------+--------------------------------------------------+
|
||||
| JP14 | |jp14| | Enable RTS/CTS flow control for serial |
|
||||
| | | communication |
|
||||
+--------+------------------+--------------------------------------------------+
|
||||
======= ================ =========================================================
|
||||
Header Jumper Setting Description of Functionality
|
||||
======= ================ =========================================================
|
||||
JP7 |jp7-ext_5v| Power ESP-WROVER-KIT via an external power supply
|
||||
JP7 |jp7-usb_5v| Power ESP-WROVER-KIT via USB
|
||||
JP8 |jp8| Enable JTAG functionality
|
||||
JP11 |jp11-tx-rx| Enable UART communication
|
||||
JP14 |jp14| Enable RTS/CTS flow control for serial communication
|
||||
======= ================ =========================================================
|
||||
|
||||
|
||||
Allocation of ESP32 Pins
|
||||
------------------------
|
||||
|
||||
Several pins / terminals of ESP32 module are allocated to the on board hardware. Some of them, like GPIO0 or GPIO2, have multiple functions. If certain hardware is not installed, e.g. nothing is plugged in to the Camera / JP4 header, then selected GPIOs may be used for other purposes.
|
||||
Some 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.
|
||||
|
||||
Some 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.
|
||||
|
||||
In 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.
|
||||
|
||||
For more details on which pins are shared among which peripherals, please refer to the table in the next section.
|
||||
|
||||
|
||||
Main I/O Connector / JP1
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
The JP1 connector is shown in two columns in the middle under "I/O" headers. The two columns "Shared With" outside, describe where else on the board certain GPIO is used.
|
||||
The 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.
|
||||
|
||||
+----------------------+------+------+----------------------+
|
||||
| Shared With | I/O | I/O | Shared With |
|
||||
+======================+======+======+======================+
|
||||
| | 3.3V | GND | |
|
||||
+----------------------+------+------+----------------------+
|
||||
| NC/XTAL | IO32 | IO33 | NC/XTAL |
|
||||
+----------------------+------+------+----------------------+
|
||||
| JTAG, MicroSD | IO12 | IO13 | JTAG, MicroSD |
|
||||
+----------------------+------+------+----------------------+
|
||||
| JTAG, MicroSD | IO14 | IO27 | Camera |
|
||||
+----------------------+------+------+----------------------+
|
||||
| Camera | IO26 | IO25 | Camera, LCD |
|
||||
+----------------------+------+------+----------------------+
|
||||
| Camera | IO35 | IO34 | Camera |
|
||||
+----------------------+------+------+----------------------+
|
||||
| Camera | IO39 | IO36 | Camera |
|
||||
+----------------------+------+------+----------------------+
|
||||
| JTAG | EN | IO23 | Camera, LCD |
|
||||
+----------------------+------+------+----------------------+
|
||||
| Camera, LCD | IO22 | IO21 | Camera, LCD, MicroSD |
|
||||
+----------------------+------+------+----------------------+
|
||||
| Camera, LCD | IO19 | IO18 | Camera, LCD |
|
||||
+----------------------+------+------+----------------------+
|
||||
| Camera, LCD | IO5 | IO17 | PSRAM |
|
||||
+----------------------+------+------+----------------------+
|
||||
| PSRAM | IO16 | IO4 | LED, Camera, MicroSD |
|
||||
+----------------------+------+------+----------------------+
|
||||
| Camera, LED, Boot | IO0 | IO2 | LED, MicroSD |
|
||||
+----------------------+------+------+----------------------+
|
||||
| JTAG, MicroSD | IO15 | 5V | |
|
||||
+----------------------+------+------+----------------------+
|
||||
===================== ===== ===== =====================
|
||||
Shared With I/O I/O Shared With
|
||||
===================== ===== ===== =====================
|
||||
n/a 3.3V GND n/a
|
||||
NC/XTAL IO32 IO33 NC/XTAL
|
||||
JTAG, MicroSD IO12 IO13 JTAG, MicroSD
|
||||
JTAG, MicroSD IO14 IO27 Camera
|
||||
Camera IO26 IO25 Camera, LCD
|
||||
Camera IO35 IO34 Camera
|
||||
Camera IO39 IO36 Camera
|
||||
JTAG EN IO23 Camera, LCD
|
||||
Camera, LCD IO22 IO21 Camera, LCD, MicroSD
|
||||
Camera, LCD IO19 IO18 Camera, LCD
|
||||
Camera, LCD IO5 IO17 PSRAM
|
||||
PSRAM IO16 IO4 LED, Camera, MicroSD
|
||||
Camera, LED, Boot IO0 IO2 LED, MicroSD
|
||||
JTAG, MicroSD IO15 5V
|
||||
===================== ===== ===== =====================
|
||||
|
||||
Legend:
|
||||
|
||||
@ -183,7 +185,7 @@ Legend:
|
||||
* LED - :ref:`RGB LED <get-started-esp-wrover-kit-v3-rgb-led-connections>`
|
||||
* MicroSD - :ref:`MicroSD Card / J4 <get-started-esp-wrover-kit-v3-microsd-card-slot>`
|
||||
* LCD - :ref:`LCD / U5 <get-started-esp-wrover-kit-v3-lcd-connector>`
|
||||
* PSRAM - ESP32-WROVER's PSRAM, if ESP32-WROVER is installed
|
||||
* PSRAM - only in case ESP32-WROVER is installed
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-kit-v3-xtal:
|
||||
@ -191,17 +193,16 @@ Legend:
|
||||
32.768 kHz Oscillator
|
||||
^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
+---+-----------+
|
||||
| | ESP32 Pin |
|
||||
+===+===========+
|
||||
| 1 | GPIO32 |
|
||||
+---+-----------+
|
||||
| 2 | GPIO33 |
|
||||
+---+-----------+
|
||||
==== ==========
|
||||
. ESP32 Pin
|
||||
==== ==========
|
||||
1 GPIO32
|
||||
2 GPIO33
|
||||
==== ==========
|
||||
|
||||
.. note::
|
||||
|
||||
As GPIO32 and GPIO33 are connected to the oscillator, they are not connected to JP1 I/O expansion connector to maintain signal integrity. This allocation may be changed from oscillator to JP1 by desoldering the 0R resistors from positions R11 / R23 and installing them in positions R12 / R24.
|
||||
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.
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-kit-v3-spi-flash-header:
|
||||
@ -209,25 +210,20 @@ Legend:
|
||||
SPI Flash / JP13
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
+---+--------------+
|
||||
| | ESP32 Pin |
|
||||
+===+==============+
|
||||
| 1 | CLK / GPIO6 |
|
||||
+---+--------------+
|
||||
| 2 | SD0 / GPIO7 |
|
||||
+---+--------------+
|
||||
| 3 | SD1 / GPIO8 |
|
||||
+---+--------------+
|
||||
| 4 | SD2 / GPIO9 |
|
||||
+---+--------------+
|
||||
| 5 | SD3 / GPIO10 |
|
||||
+---+--------------+
|
||||
| 6 | CMD / GPIO11 |
|
||||
+---+--------------+
|
||||
==== =============
|
||||
. ESP32 Pin
|
||||
==== =============
|
||||
1 CLK / GPIO6
|
||||
2 SD0 / GPIO7
|
||||
3 SD1 / GPIO8
|
||||
4 SD2 / GPIO9
|
||||
5 SD3 / GPIO10
|
||||
6 CMD / GPIO11
|
||||
==== =============
|
||||
|
||||
.. important::
|
||||
|
||||
The module's flash bus is connected to the pin header JP13 through 0-Ohm resistors R140 ~ R145. If the flash frequency needs to operate at 80 MHz for reasons such as improving the integrity of bus signals, it is recommended that resistors R140 ~ R145 be desoldered. At this point, the module's flash bus is disconnected with the pin header JP13.
|
||||
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.
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-kit-v3-jtag-header:
|
||||
@ -235,19 +231,15 @@ SPI Flash / JP13
|
||||
JTAG / JP8
|
||||
^^^^^^^^^^
|
||||
|
||||
+---+---------------+-------------+
|
||||
| | ESP32 Pin | JTAG Signal |
|
||||
+===+===============+=============+
|
||||
| 1 | EN | TRST_N |
|
||||
+---+---------------+-------------+
|
||||
| 2 | MTDO / GPIO15 | TDO |
|
||||
+---+---------------+-------------+
|
||||
| 3 | MTDI / GPIO12 | TDI |
|
||||
+---+---------------+-------------+
|
||||
| 4 | MTCK / GPIO13 | TCK |
|
||||
+---+---------------+-------------+
|
||||
| 5 | MTMS / GPIO14 | TMS |
|
||||
+---+---------------+-------------+
|
||||
==== ============== =============
|
||||
. ESP32 Pin JTAG Signal
|
||||
==== ============== =============
|
||||
1 EN TRST_N
|
||||
2 MTMS / GPIO14 TMS
|
||||
3 MTDO / GPIO15 TDO
|
||||
4 MTDI / GPIO12 TDI
|
||||
5 MTCK / GPIO13 TCK
|
||||
==== ============== =============
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-kit-v3-camera-header:
|
||||
@ -255,45 +247,30 @@ JTAG / JP8
|
||||
Camera / JP4
|
||||
^^^^^^^^^^^^
|
||||
|
||||
+----+--------------+------------------------------+
|
||||
| | ESP32 Pin | Camera Signal |
|
||||
+====+==============+==============================+
|
||||
| 1 | n/a | 3.3V |
|
||||
+----+--------------+------------------------------+
|
||||
| 2 | n/a | Ground |
|
||||
+----+--------------+------------------------------+
|
||||
| 3 | GPIO27 | SIO_C / SCCB Clock |
|
||||
+----+--------------+------------------------------+
|
||||
| 4 | GPIO26 | SIO_D / SCCB Data |
|
||||
+----+--------------+------------------------------+
|
||||
| 5 | GPIO25 | VSYNC / Vertical Sync |
|
||||
+----+--------------+------------------------------+
|
||||
| 6 | GPIO23 | HREF / Horizontal Reference |
|
||||
+----+--------------+------------------------------+
|
||||
| 7 | GPIO22 | PCLK / Pixel Clock |
|
||||
+----+--------------+------------------------------+
|
||||
| 8 | GPIO21 | XCLK / System Clock |
|
||||
+----+--------------+------------------------------+
|
||||
| 9 | GPIO35 | D7 / Pixel Data Bit 7 |
|
||||
+----+--------------+------------------------------+
|
||||
| 10 | GPIO34 | D6 / Pixel Data Bit 6 |
|
||||
+----+--------------+------------------------------+
|
||||
| 11 | GPIO39 | D5 / Pixel Data Bit 5 |
|
||||
+----+--------------+------------------------------+
|
||||
| 12 | GPIO36 | D4 / Pixel Data Bit 4 |
|
||||
+----+--------------+------------------------------+
|
||||
| 13 | GPIO19 | D3 / Pixel Data Bit 3 |
|
||||
+----+--------------+------------------------------+
|
||||
| 14 | GPIO18 | D2 / Pixel Data Bit 2 |
|
||||
+----+--------------+------------------------------+
|
||||
| 15 | GPIO5 | D1 / Pixel Data Bit 1 |
|
||||
+----+--------------+------------------------------+
|
||||
| 16 | GPIO4 | D0 / Pixel Data Bit 0 |
|
||||
+----+--------------+------------------------------+
|
||||
| 17 | GPIO0 | RESET / Camera Reset |
|
||||
+----+--------------+------------------------------+
|
||||
| 18 | n/a | PWDN / Camera Power Down |
|
||||
+----+--------------+------------------------------+
|
||||
==== ========== =============================
|
||||
. ESP32 Pin Camera Signal
|
||||
==== ========== =============================
|
||||
1 n/a 3.3V
|
||||
2 n/a Ground
|
||||
3 GPIO27 SIO_C / SCCB Clock
|
||||
4 GPIO26 SIO_D / SCCB Data
|
||||
5 GPIO25 VSYNC / Vertical Sync
|
||||
6 GPIO23 HREF / Horizontal Reference
|
||||
7 GPIO22 PCLK / Pixel Clock
|
||||
8 GPIO21 XCLK / System Clock
|
||||
9 GPIO35 D7 / Pixel Data Bit 7
|
||||
10 GPIO34 D6 / Pixel Data Bit 6
|
||||
11 GPIO39 D5 / Pixel Data Bit 5
|
||||
12 GPIO36 D4 / Pixel Data Bit 4
|
||||
13 GPIO19 D3 / Pixel Data Bit 3
|
||||
14 GPIO18 D2 / Pixel Data Bit 2
|
||||
15 GPIO5 D1 / Pixel Data Bit 1
|
||||
16 GPIO4 D0 / Pixel Data Bit 0
|
||||
17 GPIO0 RESET / Camera Reset
|
||||
18 n/a PWDN / Camera Power Down
|
||||
==== ========== =============================
|
||||
|
||||
* Signals D0 .. D7 denote camera data bus
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-kit-v3-rgb-led-connections:
|
||||
@ -301,39 +278,31 @@ Camera / JP4
|
||||
RGB LED
|
||||
^^^^^^^
|
||||
|
||||
+---+-----------+---------+
|
||||
| | ESP32 Pin | RGB LED |
|
||||
+===+===========+=========+
|
||||
| 1 | GPIO0 | Red |
|
||||
+---+-----------+---------+
|
||||
| 2 | GPIO2 | Green |
|
||||
+---+-----------+---------+
|
||||
| 3 | GPIO4 | Blue |
|
||||
+---+-----------+---------+
|
||||
==== ========== =========
|
||||
. ESP32 Pin RGB LED
|
||||
==== ========== =========
|
||||
1 GPIO0 Red
|
||||
2 GPIO2 Green
|
||||
3 GPIO4 Blue
|
||||
==== ========== =========
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-kit-v3-microsd-card-slot:
|
||||
|
||||
MicroSD Card / J4
|
||||
^^^^^^^^^^^^^^^^^
|
||||
MicroSD Card
|
||||
^^^^^^^^^^^^
|
||||
|
||||
+---+---------------+----------------+
|
||||
| | ESP32 Pin | MicroSD Signal |
|
||||
+===+===============+================+
|
||||
| 1 | MTDI / GPIO12 | DATA2 |
|
||||
+---+---------------+----------------+
|
||||
| 2 | MTCK / GPIO13 | CD / DATA3 |
|
||||
+---+---------------+----------------+
|
||||
| 3 | MTDO / GPIO15 | CMD |
|
||||
+---+---------------+----------------+
|
||||
| 4 | MTMS / GPIO14 | CLK |
|
||||
+---+---------------+----------------+
|
||||
| 5 | GPIO2 | DATA0 |
|
||||
+---+---------------+----------------+
|
||||
| 6 | GPIO4 | DATA1 |
|
||||
+---+---------------+----------------+
|
||||
| 7 | GPIO21 | CD |
|
||||
+---+---------------+----------------+
|
||||
==== ============== ===============
|
||||
. ESP32 Pin MicroSD Signal
|
||||
==== ============== ===============
|
||||
1 MTDI / GPIO12 DATA2
|
||||
2 MTCK / GPIO13 CD / DATA3
|
||||
3 MTDO / GPIO15 CMD
|
||||
4 MTMS / GPIO14 CLK
|
||||
5 GPIO2 DATA0
|
||||
6 GPIO4 DATA1
|
||||
7 GPIO21 CD
|
||||
==== ============== ===============
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-kit-v3-lcd-connector:
|
||||
@ -341,23 +310,17 @@ MicroSD Card / J4
|
||||
LCD / U5
|
||||
^^^^^^^^
|
||||
|
||||
+---+-----------+------------+
|
||||
| | ESP32 Pin | LCD Signal |
|
||||
+===+===========+============+
|
||||
| 1 | GPIO18 | RESET |
|
||||
+---+-----------+------------+
|
||||
| 2 | GPIO19 | SCL |
|
||||
+---+-----------+------------+
|
||||
| 3 | GPIO21 | D/C |
|
||||
+---+-----------+------------+
|
||||
| 4 | GPIO22 | CS |
|
||||
+---+-----------+------------+
|
||||
| 5 | GPIO23 | SDA |
|
||||
+---+-----------+------------+
|
||||
| 6 | GPIO25 | SDO |
|
||||
+---+-----------+------------+
|
||||
| 7 | GPIO5 | Backlight |
|
||||
+---+-----------+------------+
|
||||
==== ============== ===============
|
||||
. ESP32 Pin LCD Signal
|
||||
==== ============== ===============
|
||||
1 GPIO18 RESET
|
||||
2 GPIO19 SCL
|
||||
3 GPIO21 D/C
|
||||
4 GPIO22 CS
|
||||
5 GPIO23 SDA
|
||||
6 GPIO25 SDO
|
||||
7 GPIO5 Backlight
|
||||
==== ============== ===============
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-kit-v3-start-development:
|
||||
@ -365,23 +328,27 @@ LCD / U5
|
||||
Start Application Development
|
||||
-----------------------------
|
||||
|
||||
Before powering up your ESP-WROVER-KIT V3, please make sure that the board is in good condition with no obvious signs of damage.
|
||||
Before powering up your ESP-WROVER-KIT, please make sure that the board is in good condition with no obvious signs of damage.
|
||||
|
||||
|
||||
Initial Setup
|
||||
^^^^^^^^^^^^^
|
||||
|
||||
Select the source of power supply for the board by setting jumper JP7. The options are either USB port or an external power supply. For this application selection of USB port is sufficient. Enable UART communication by installing jumpers on JP11. Both selections are shown in table below.
|
||||
Please set only the following jumpers shown in the pictures below:
|
||||
|
||||
+----------------------+----------------------+
|
||||
| Power up | Enable UART |
|
||||
| from USB port | communication |
|
||||
+----------------------+----------------------+
|
||||
| |jp7-usb_5v| | |jp11-rx-tx| |
|
||||
+----------------------+----------------------+
|
||||
- Select USB as the power source using the jumper block JP7.
|
||||
|
||||
- Enable UART communication using the jumper block JP11.
|
||||
|
||||
======================== ==========================
|
||||
Power up from USB port Enable UART communication
|
||||
======================== ==========================
|
||||
|jp7-usb_5v| |jp11-tx-rx|
|
||||
======================== ==========================
|
||||
|
||||
Do not install any other jumpers.
|
||||
|
||||
Turn the **Power Switch** to ON, the **5V Power On LED** should light up.
|
||||
|
||||
Now to Development
|
||||
^^^^^^^^^^^^^^^^^^
|
||||
@ -402,7 +369,7 @@ Related Documents
|
||||
.. |jp7-ext_5v| image:: ../../_static/esp-wrover-kit-v3-jp7-ext_5v.png
|
||||
.. |jp7-usb_5v| image:: ../../_static/esp-wrover-kit-v3-jp7-usb_5v.png
|
||||
.. |jp8| image:: ../../_static/esp-wrover-kit-v3-jp8.png
|
||||
.. |jp11-rx-tx| image:: ../../_static/esp-wrover-kit-v3-jp11-tx-rx.png
|
||||
.. |jp11-tx-rx| image:: ../../_static/esp-wrover-kit-v3-jp11-tx-rx.png
|
||||
.. |jp14| image:: ../../_static/esp-wrover-kit-v3-jp14.png
|
||||
|
||||
.. _ESP-WROVER-KIT V3 schematic: https://dl.espressif.com/dl/schematics/ESP-WROVER-KIT_SCH-3.pdf
|
||||
|
||||
@ -2,29 +2,43 @@ ESP-WROVER-KIT V4.1 Getting Started Guide
|
||||
=========================================
|
||||
:link_to_translation:`zh_CN:[中文]`
|
||||
|
||||
This user guide shows how to get started with the ESP-WROVER-KIT V4.1 development board including description of its functionality and configuration options. For descriptions of other versions of the ESP-WROVER-KIT check :doc:`../hw-reference/index`.
|
||||
|
||||
If you would like to start using this board right now, go directly to the :ref:`get-started-esp-wrover-kit-start-development` section.
|
||||
This guide shows how to get started with the ESP-WROVER-KIT V4.1 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`.
|
||||
|
||||
|
||||
What You Need
|
||||
-------------
|
||||
|
||||
* 1 × :ref:`ESP-WROVER-KIT V4.1 board <get-started-esp-wrover-kit-v4.1-board-front>`
|
||||
* 1 x Micro USB 2.0 Cable, Type A to Micro B
|
||||
* 1 × PC loaded with Windows, Linux or Mac OS
|
||||
* :ref:`ESP-WROVER-KIT V4.1 board <get-started-esp-wrover-kit-v4.1-board-front>`
|
||||
* USB 2.0 A to Micro B Cable
|
||||
* Computer running Windows, Linux, or macOS
|
||||
|
||||
You can skip the introduction sections and go directly to Section `Start Application Development`_.
|
||||
|
||||
|
||||
Overview
|
||||
--------
|
||||
|
||||
The ESP-WROVER-KIT is a development board built around the ESP32 and produced by `Espressif <https://espressif.com>`_. This board is compatible with multiple ESP32 modules, including the ESP32-WROOM-32, ESP32-WROVER and ESP32-WROVER-B. The ESP-WROVER-KIT features support for an LCD and a 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.
|
||||
ESP-WROVER-KIT is an ESP32-based development board produced by `Espressif <https://espressif.com>`_.
|
||||
|
||||
ESP-WROVER-KIT features the following integrated components:
|
||||
|
||||
- ESP32-WROVER-B module
|
||||
- LCD screen
|
||||
- MicroSD card slot
|
||||
|
||||
Its 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.
|
||||
|
||||
Most of the ESP32 I/O pins are broken out to the board's pin headers for easy access.
|
||||
|
||||
.. note::
|
||||
|
||||
ESP32's GPIO16 and GPIO17 are used 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.
|
||||
|
||||
|
||||
Functionality Overview
|
||||
----------------------
|
||||
|
||||
The block diagram below illustrates the ESP-WROVER-KIT's main components and their interconnections.
|
||||
The block diagram below shows the main components of ESP-WROVER-KIT and their interconnections.
|
||||
|
||||
.. figure:: ../../_static/esp-wrover-kit-block-diagram.png
|
||||
:align: center
|
||||
@ -37,57 +51,7 @@ The block diagram below illustrates the ESP-WROVER-KIT's main components and the
|
||||
Functional Description
|
||||
----------------------
|
||||
|
||||
The following lists and figures describe the key components, interfaces, and controls of ESP-WROVER-KIT board.
|
||||
|
||||
32.768 kHz
|
||||
An external precision 32.768 kHz crystal oscillator provides a low-power consumption clock used during Deep-Sleep mode.
|
||||
FT2232
|
||||
The FT2232 chip is a multi-protocol USB-to-serial bridge. Users can control and program the FT2232 chip through the USB interface to establish communication with ESP32. The FT2232 chip also features USB-to-JTAG interface. USB-to-JTAG is available on channel A of the FT2232, whilst USB-to-serial is on channel B. The embedded FT2232 chip is one of the distinguishing features of the ESP-WROVER-KIT. It enhances users’ convenience in terms of application development and debugging. In addition, users need not purchase a JTAG debugger separately, which reduces the development cost, see `ESP-WROVER-KIT V4.1 schematic`_.
|
||||
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-WROVER
|
||||
This version of ESP-WROVER-KIT board has ESP-WROVER-B module installed that integrates 64-Mbit PSRAM for flexible extended storage and data processing capabilities. The board can accommodate other versions of ESP modules described under :ref:`esp-wroom-solo-wrover-modules`.
|
||||
|
||||
.. note::
|
||||
|
||||
GPIO16 and GPIO17 are used as the CS and clock signal for PSRAM. To ensure reliable performance, the two GPIOs are not broken out.
|
||||
|
||||
Diagnostic LEDs
|
||||
Four red LEDs connected to GPIO pins of the FT2232 chip. Intended for future use.
|
||||
UART
|
||||
Serial port: the serial TX/RX signals on the FT2232HL and the ESP32 are broken out to each side of JP2. 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 used by ESP32 to access flash and PSRAM memories inside the module. Please note that the voltage level on this interface depends on the module used.
|
||||
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
|
||||
JTAG interface: the JTAG signals on FT2232HL and ESP32 are broken out to the two sides of JP2. By default, the two signals are disconnected. To enable JTAG, shorting jumpers are required on the signals as shown in section :ref:`get-started-esp-wrover-kit-setup-options`.
|
||||
USB Port
|
||||
USB interface. It functions as the power supply for the board and the communication interface between PC and ESP32 module.
|
||||
EN Button
|
||||
Reset button: pressing this button resets the system.
|
||||
Boot Button
|
||||
Download button: holding down the **Boot** button and pressing the **EN** button initiates the firmware download mode. Then user can download firmware through the serial port.
|
||||
Power Switch
|
||||
Power on/off button: toggling to the right powers the board on; toggling to the left powers the board off.
|
||||
Power Selector
|
||||
Power supply selection interface: the ESP-WROVER-KIT can be powered through the USB interface or the 5V Input interface. The user can select the power supply with a jumper. More details can be found in section :ref:`get-started-esp-wrover-kit-setup-options`, jumper header JP7.
|
||||
5V Input
|
||||
The 5V power supply interface is used as a backup power supply in case of full-load operation.
|
||||
5V Power On LED
|
||||
This red LED indicates that a power supply (either from **USB** or **5V Input**) is applied to the board.
|
||||
LDO
|
||||
NCP1117(1A). 5V-to-3.3V LDO. (There is an alternative pin-compatible LDO — LM317DCY, with an output current of up to 1.5A). NCP1117 can provide a maximum current of 1A. The LDO solutions are available with both fixed output voltage and variable output voltage. For details please refer to `ESP-WROVER-KIT V4.1 schematic`_.
|
||||
Camera Connector
|
||||
Camera interface: a standard OV7670 camera module is supported.
|
||||
RGB LED
|
||||
Red, green and blue (RGB) light emitting diodes (LEDs), which may be controlled by pulse width modulation (PWM).
|
||||
I/O Connector
|
||||
All the pins on the ESP32 module are led out to the pin headers on the ESP-WROVER-KIT. Users can program ESP32 to enable multiple functions such as PWM, ADC, DAC, I2C, I2S, SPI, etc.
|
||||
Micro SD Card Slot
|
||||
Develop applications that access Micro SD card for data storage and retrieval.
|
||||
LCD
|
||||
ESP-WROVER-KIT supports mounting and interfacing a 3.2” SPI (standard 4-wire Serial Peripheral Interface) LCD, as shown on figure :ref:`get-started-esp-wrover-kit-v4.1-board-back`.
|
||||
The following two figures and the table below describe the key components, interfaces, and controls of the ESP-WROVER-KIT board.
|
||||
|
||||
.. _get-started-esp-wrover-kit-v4.1-board-front:
|
||||
|
||||
@ -108,18 +72,73 @@ LCD
|
||||
ESP-WROVER-KIT board layout - back
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-kit-setup-options:
|
||||
The table below provides description in the following manner:
|
||||
|
||||
- Starting from the first picture's top right corner and going clockwise
|
||||
- Then moving on to the second picture
|
||||
|
||||
|
||||
================== =================================================================================================================================
|
||||
Key Component Description
|
||||
================== =================================================================================================================================
|
||||
FT2232 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 V4.1 schematic`_.
|
||||
|
||||
32.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.
|
||||
|
||||
0R 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.
|
||||
|
||||
ESP32-WROVER This EPS32 module features 64-Mbit PSRAM for flexible extended storage and data processing capabilities.
|
||||
|
||||
Diagnostic LEDs Four red LEDs connected to the GPIO pins of FT2232. Intended for future use.
|
||||
|
||||
UART Serial port. The serial TX/RX signals of FT2232 and ESP32 are broken out to the inward and outward sides of JP2 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.
|
||||
|
||||
SPI 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 voltage of this interface is 3.3V.
|
||||
|
||||
CTS/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.
|
||||
|
||||
JTAG JTAG interface. JTAG signals of FT2232 and ESP32 are broken out to the inward and outward sides of JP2 respectively. By default, these pairs of pins are disconnected. To enable JTAG, short the respective pins with jumpers as shown in Section `Setup Options`_.
|
||||
|
||||
USB Port USB interface. Power supply for the board as well as the communication interface between a computer and the board.
|
||||
|
||||
EN Button Reset button.
|
||||
|
||||
Boot Button Download button. Holding down **Boot** and then pressing **EN** initiates Firmware Download mode for downloading firmware through the serial port.
|
||||
|
||||
Power Switch Power On/Off Switch. Toggling toward the **Boot** button powers the board on, toggling away from **Boot** powers the board off.
|
||||
|
||||
Power Selector 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.
|
||||
|
||||
5V Input The 5V power supply interface can be more convenient when the board is operating autonomously (not connected to a computer).
|
||||
|
||||
5V Power On LED This red LED turns on when power is supplied to the board, either from **USB** or **5V Input**.
|
||||
|
||||
LDO 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 V4.1 schematic`_.
|
||||
|
||||
Camera Connector Camera interface, a standard OV7670 camera module.
|
||||
|
||||
RGB LED Red, green and blue (RGB) light emitting diodes (LEDs), can be controlled by pulse width modulation (PWM).
|
||||
|
||||
I/O Connector 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.
|
||||
|
||||
Micro SD Card Slot Useful for developing applications that access Micro SD card for data storage and retrieval.
|
||||
|
||||
LCD 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-v4.1-board-back`.
|
||||
================== =================================================================================================================================
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-kit-v4.1-setup-options:
|
||||
|
||||
Setup Options
|
||||
-------------
|
||||
|
||||
There are three jumper headers available to set up the board functionality. Typical options to select from are listed in table below.
|
||||
There are three jumper blocks available to set up the board functionality. The most frequently required options are listed in the table below.
|
||||
|
||||
======= ================ =========================================================
|
||||
Header Jumper Setting Description of Functionality
|
||||
======= ================ =========================================================
|
||||
JP7 |jp7-ext_5v| Power ESP-WROVER-KIT board from an external power supply
|
||||
JP7 |jp7-usb_5v| Power ESP-WROVER-KIT board from an USB port
|
||||
JP7 |jp7-ext_5v| Power ESP-WROVER-KIT via an external power supply
|
||||
JP7 |jp7-usb_5v| Power ESP-WROVER-KIT via USB
|
||||
JP2 |jp2-jtag| Enable JTAG functionality
|
||||
JP2 |jp2-tx-rx| Enable UART communication
|
||||
JP14 |jp14| Enable RTS/CTS flow control for serial communication
|
||||
@ -129,24 +148,24 @@ JP14 |jp14| Enable RTS/CTS flow control for serial communication
|
||||
Allocation of ESP32 Pins
|
||||
------------------------
|
||||
|
||||
Several pins / terminals of ESP32 module are allocated to the on board hardware. If certain hardware is not installed, e.g. nothing is plugged in to the Camera / JP4 header, then selected GPIOs may be used for other purposes.
|
||||
Some 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.
|
||||
|
||||
Some of pins, like GPIO0 or GPIO2, have multiple functions and some of them are shared among on board and optional 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.
|
||||
Some 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.
|
||||
|
||||
In other cases peripherals can coexist under certain conditions. This is applicable to e.g. 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 and 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.
|
||||
In 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.
|
||||
|
||||
For more details what pins are shared among peripherals please refer to the table below.
|
||||
For more details on which pins are shared among which peripherals, please refer to the table in the next section.
|
||||
|
||||
|
||||
Main I/O Connector / JP1
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
The JP1 connector is shown in two columns in the middle under "I/O" headers. The two columns "Shared With" outside, describe where else on the board certain GPIO is used.
|
||||
The 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.
|
||||
|
||||
===================== ===== ===== =====================
|
||||
Shared With I/O I/O Shared With
|
||||
===================== ===== ===== =====================
|
||||
3.3V GND
|
||||
n/a 3.3V GND n/a
|
||||
NC/XTAL IO32 IO33 NC/XTAL
|
||||
JTAG, MicroSD IO12 IO13 JTAG, MicroSD
|
||||
JTAG, MicroSD IO14 IO27 Camera
|
||||
@ -171,7 +190,7 @@ Legend:
|
||||
* LED - :ref:`RGB LED <get-started-esp-wrover-kit-v4.1-rgb-led-connections>`
|
||||
* MicroSD - :ref:`MicroSD Card / J4 <get-started-esp-wrover-kit-v4.1-microsd-card-slot>`
|
||||
* LCD - :ref:`LCD / U5 <get-started-esp-wrover-kit-v4.1-lcd-connector>`
|
||||
* PSRAM - ESP32-WROVER's PSRAM, if ESP32-WROVER is installed
|
||||
* PSRAM - ESP32-WROVER-B's PSRAM
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-kit-v4.1-xtal:
|
||||
@ -188,7 +207,7 @@ Legend:
|
||||
|
||||
.. note::
|
||||
|
||||
As GPIO32 and GPIO33 are connected to the oscillator, they are not connected to JP1 I/O expansion connector to maintain signal integrity. This allocation may be changed from oscillator to JP1 by desoldering the 0R resistors from positions R11 / R23 and installing them in positions R12 / R24.
|
||||
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.
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-kit-v4.1-spi-flash-header:
|
||||
@ -209,7 +228,7 @@ SPI Flash / JP2
|
||||
|
||||
.. important::
|
||||
|
||||
The module's flash bus is connected to the pin header JP2 through 0-Ohm resistors R140 ~ R145. If the flash frequency needs to operate at 80 MHz for reasons such as improving the integrity of bus signals, it is recommended that resistors R140 ~ R145 be desoldered. At this point, the module's flash bus is disconnected with the pin header JP2.
|
||||
The module's flash bus is connected to the jumper block JP2 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 JP2.
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-kit-v4.1-jtag-header:
|
||||
@ -275,8 +294,8 @@ RGB LED
|
||||
|
||||
.. _get-started-esp-wrover-kit-v4.1-microsd-card-slot:
|
||||
|
||||
MicroSD Card / J4
|
||||
^^^^^^^^^^^^^^^^^
|
||||
MicroSD Card
|
||||
^^^^^^^^^^^^
|
||||
|
||||
==== ============== ===============
|
||||
. ESP32 Pin MicroSD Signal
|
||||
@ -320,7 +339,11 @@ Before powering up your ESP-WROVER-KIT, please make sure that the board is in go
|
||||
Initial Setup
|
||||
^^^^^^^^^^^^^
|
||||
|
||||
Select the source of power supply for the board by setting jumper JP7. The options are either **USB** port or an external **5V Input**. For this application, the selection of the USB port is sufficient. Enable UART communication by installing jumpers on JP2. Both selections are shown in table below.
|
||||
Please set only the following jumpers shown in the pictures below:
|
||||
|
||||
- Select USB as the power source using the jumper block JP7.
|
||||
|
||||
- Enable UART communication using the jumper block JP2.
|
||||
|
||||
======================== ==========================
|
||||
Power up from USB port Enable UART communication
|
||||
@ -330,7 +353,7 @@ Power up from USB port Enable UART communication
|
||||
|
||||
Do not install any other jumpers.
|
||||
|
||||
Turn the **Power Switch** on. The **5V Power On LED** should turn on.
|
||||
Turn the **Power Switch** to ON, the **5V Power On LED** should light up.
|
||||
|
||||
Now to Development
|
||||
^^^^^^^^^^^^^^^^^^
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
配置硬件
|
||||
^^^^^^^^
|
||||
|
||||
1. 根据 :doc:`../../get-started/get-started-wrover-kit` 文档中 :ref:`get-started-esp-wrover-kit-setup-options` 章节所描述的信息，设置 JP8 便可以启用 JTAG 功能。
|
||||
1. 根据 :doc:`../../get-started/get-started-wrover-kit` 文档中 :ref:`get-started-esp-wrover-kit-v4.1-setup-options` 章节所描述的信息，设置 JP8 便可以启用 JTAG 功能。
|
||||
|
||||
2. 检查 ESP32 上用于 JTAG 通信的引脚是否被接到了其它硬件上，这可能会影响 JTAG 的工作。
|
||||
|
||||
|
||||
@ -0,0 +1 @@
|
||||
.. include:: ../../en/get-started-cmake/get-started-wrover-kit-v3.rst
|
||||
@ -4,7 +4,7 @@ ESP-WROVER-KIT V4.1 入门指南
|
||||
|
||||
本指南介绍了如何开始使用 ESP-WROVER-KIT V4.1 开发板。有关 ESP-WROVER-KIT 其他版本的介绍，请见：:doc:`../hw-reference/index`。
|
||||
|
||||
如果你希望开始 ESP-WROVER-KIT V4.1 的应用开发，请直接前往章节 :ref:`应用程序开发 <get-started-esp-wrover-kit-start-development>`。
|
||||
如果你希望开始 ESP-WROVER-KIT V4.1 的应用开发，请直接前往章节 :ref:`应用程序开发 <get-started-esp-wrover-kit-v4.1-start-development>`。
|
||||
|
||||
|
||||
准备工作
|
||||
@ -67,7 +67,7 @@ CTS/RTS
|
||||
串口流控信号。管脚默认不连接至电路。为了使能该功能，必须用跳线帽断路掉 JP14 连接器的相应管脚。
|
||||
|
||||
JTAG
|
||||
FT2232HL 和 ESP32 的串口 JTAG 信号已引出至 JP2 连接器的两端。默认情况下，这两路信号不连接。如需使能 JTAG，请按照 :ref:`设置选项 <get-started-esp-wrover-kit-setup-options>` 中的介绍，连接跳线帽。
|
||||
FT2232HL 和 ESP32 的串口 JTAG 信号已引出至 JP2 连接器的两端。默认情况下，这两路信号不连接。如需使能 JTAG，请按照 :ref:`设置选项 <get-started-esp-wrover-kit-v4.1-setup-options>` 中的介绍，连接跳线帽。
|
||||
|
||||
USB 端口
|
||||
USB 端口，可用作电路板的供电电源或连接 PC 端的通信接口。
|
||||
@ -82,7 +82,7 @@ Boot 按键
|
||||
拨置右侧，开发板上电；拨置左侧，开发板掉电。
|
||||
|
||||
电源选择开关
|
||||
ESP-WROVER-KIT 开发板可通过 USB 端口或 5V 输入端口供电。用户可使用跳线帽在两种供电模式中进行选择。更多详细信息，请见章节 :ref:`设置选项 <get-started-esp-wrover-kit-setup-options>` 中有关 JP7 连接器的描述。
|
||||
ESP-WROVER-KIT 开发板可通过 USB 端口或 5V 输入端口供电。用户可使用跳线帽在两种供电模式中进行选择。更多详细信息，请见章节 :ref:`设置选项 <get-started-esp-wrover-kit-v4.1-setup-options>` 中有关 JP7 连接器的描述。
|
||||
|
||||
5V 输入
|
||||
5V 电源接口仅用于全负荷工作下的后备电源。
|
||||
@ -126,7 +126,7 @@ LCD 显示器
|
||||
ESP-WROVER-KIT 开发板 - 背面
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-kit-setup-options:
|
||||
.. _get-started-esp-wrover-kit-v4.1-setup-options:
|
||||
|
||||
设置选项
|
||||
-------------
|
||||
@ -316,7 +316,7 @@ No. ESP32 管脚 LCD 信号
|
||||
=== ============== =============
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-kit-start-development:
|
||||
.. _get-started-esp-wrover-kit-v4.1-start-development:
|
||||
|
||||
应用程序开发
|
||||
-----------------------------
|
||||
|
||||
379
get-started-wrover-kit-v3.rst
Normal file
379
get-started-wrover-kit-v3.rst
Normal file
@ -0,0 +1,379 @@
|
||||
ESP-WROVER-KIT V3 Getting Started Guide
|
||||
=========================================
|
||||
:link_to_translation:`zh_CN:[中文]`
|
||||
|
||||
This 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 description of other ESP-WROVER-KIT versions, please check :doc:`../hw-reference/index`.
|
||||
|
||||
|
||||
What You Need
|
||||
-------------
|
||||
|
||||
* :ref:`ESP-WROVER-KIT V3 board <get-started-esp-wrover-kit-v3-board-front>`
|
||||
* USB 2.0 A to Micro B Cable
|
||||
* Computer running Windows, Linux, or macOS
|
||||
|
||||
You can skip the introduction sections and go directly to Section `Start Application Development`_.
|
||||
|
||||
|
||||
Overview
|
||||
--------
|
||||
|
||||
ESP-WROVER-KIT is an ESP32-based development board produced by `Espressif <https://espressif.com>`_. This development board features an integrated LCD screen and MicroSD card slot.
|
||||
|
||||
ESP-WROVER-KIT comes with the following ESP32 modules:
|
||||
|
||||
- :ref:`esp-modules-and-boards-esp32-wroom-32`
|
||||
- :ref:`ESP32-WROVER <esp-modules-and-boards-esp32-wrover>`
|
||||
|
||||
Another board's distinguishing feature is its 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 secondary development easy and cost-effective.
|
||||
|
||||
Most of the ESP32 I/O pins are broken out to the board's pin headers for easy access.
|
||||
|
||||
.. note::
|
||||
|
||||
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.
|
||||
|
||||
|
||||
Functionality Overview
|
||||
----------------------
|
||||
|
||||
The block diagram below shows the main components of ESP-WROVER-KIT and their interconnections.
|
||||
|
||||
.. figure:: ../../_static/esp-wrover-kit-block-diagram.png
|
||||
:align: center
|
||||
:alt: ESP-WROVER-KIT block diagram
|
||||
:figclass: align-center
|
||||
|
||||
ESP-WROVER-KIT block diagram
|
||||
|
||||
|
||||
Functional Description
|
||||
----------------------
|
||||
|
||||
The following two figures and the table below describe the key components, interfaces and controls of the ESP-WROVER-KIT board.
|
||||
|
||||
.. _get-started-esp-wrover-kit-v3-board-front:
|
||||
|
||||
.. figure:: ../../_static/esp-wrover-kit-v3-layout-front.png
|
||||
:align: center
|
||||
:alt: ESP-WROVER-KIT board layout - front
|
||||
:figclass: align-center
|
||||
|
||||
ESP-WROVER-KIT board layout - front
|
||||
|
||||
.. _get-started-esp-wrover-kit-v3-board-back:
|
||||
|
||||
.. figure:: ../../_static/esp-wrover-kit-v3-layout-back.png
|
||||
:align: center
|
||||
:alt: ESP-WROVER-KIT board layout - back
|
||||
:figclass: align-center
|
||||
|
||||
ESP-WROVER-KIT board layout - back
|
||||
|
||||
|
||||
The table below provides description in the following manner:
|
||||
|
||||
- Starting from the the first picture's top right corner and going clockwise
|
||||
- Then moving on to the second picture
|
||||
|
||||
|
||||
================== =================================================================================================================================
|
||||
Key Component Description
|
||||
================== =================================================================================================================================
|
||||
32.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.
|
||||
|
||||
0R Zero-ohm resistor intended as a placeholder for a current shunt, may be desoldered or replaced with a current shunt to facilitate the measurement of ESP32's current consumption in different modes.
|
||||
|
||||
ESP32 Module Either ESP32-WROOM-32 or ESP32-WROVER with an integrated ESP32.
|
||||
|
||||
FT2232 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`_.
|
||||
|
||||
UART 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.
|
||||
|
||||
SPI SPI interface is used by ESP32 to access flash and PSRAM memory inside the module. To interface another SPI device, 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.
|
||||
|
||||
CTS/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.
|
||||
|
||||
JTAG 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 :ref:`get-started-esp-wrover-kit-v3-setup-options`.
|
||||
|
||||
EN Button Reset button.
|
||||
|
||||
Boot Button Download button. Holding down **Boot** and then pressing **EN** initiates Firmware Download mode for downloading firmware through the serial port.
|
||||
|
||||
USB Port USB interface. Power supply for the board as well as the communication interface between a computer and the board.
|
||||
|
||||
Power Key Power On/Off Switch. Toggling toward **USB** powers the board on, toggling away from **USB** powers the board off.
|
||||
|
||||
Power Select Power supply selector interface. The board can be powered either via USB or via the 5V Input interface. Select the power supply with a jumper. For more details, see Section :ref:`get-started-esp-wrover-kit-v3-setup-options`, jumper header JP7.
|
||||
|
||||
5V Input The 5V power supply interface can be more convenient when the board is operating autonomously (not connected to a computer).
|
||||
|
||||
LDO NCP1117(1A). 5V-to-3.3V LDO. NCP1117 can provide a maximum current of 1A. The LDO solution is available with both fixed and adjustable output voltages. For details please refer to `ESP-WROVER-KIT V3 schematic`_.
|
||||
|
||||
Camera Camera interface, a standard OV7670 camera module.
|
||||
|
||||
RGB LED Red, green and blue (RGB) light emitting diodes (LEDs), can be controlled by pulse width modulation (PWM).
|
||||
|
||||
I/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.
|
||||
|
||||
Micro SD Card Slot Useful for developing applications that access Micro SD card for data storage and retrieval.
|
||||
|
||||
LCD 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`.
|
||||
================== =================================================================================================================================
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-kit-v3-setup-options:
|
||||
|
||||
Setup Options
|
||||
-------------
|
||||
|
||||
There are three jumper blocks available to set up the board functionality. The most frequently required options are listed in the table below.
|
||||
|
||||
======= ================ =========================================================
|
||||
Header Jumper Setting Description of Functionality
|
||||
======= ================ =========================================================
|
||||
JP7 |jp7-ext_5v| Power ESP-WROVER-KIT via an external power supply
|
||||
JP7 |jp7-usb_5v| Power ESP-WROVER-KIT via USB
|
||||
JP8 |jp8-jtag| Enable JTAG functionality
|
||||
JP11 |jp11-tx-rx| Enable UART communication
|
||||
JP14 |jp14| Enable RTS/CTS flow control for serial communication
|
||||
======= ================ =========================================================
|
||||
|
||||
|
||||
Allocation of ESP32 Pins
|
||||
------------------------
|
||||
|
||||
Some 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.
|
||||
|
||||
Some 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.
|
||||
|
||||
In 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.
|
||||
|
||||
For more details on which pins are shared among which peripherals please refer to the table in the next section.
|
||||
|
||||
|
||||
Main I/O Connector / JP1
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
The 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.
|
||||
|
||||
===================== ===== ===== =====================
|
||||
Shared With I/O I/O Shared With
|
||||
===================== ===== ===== =====================
|
||||
n/a 3.3V GND n/a
|
||||
NC/XTAL IO32 IO33 NC/XTAL
|
||||
JTAG, MicroSD IO12 IO13 JTAG, MicroSD
|
||||
JTAG, MicroSD IO14 IO27 Camera
|
||||
Camera IO26 IO25 Camera, LCD
|
||||
Camera IO35 IO34 Camera
|
||||
Camera IO39 IO36 Camera
|
||||
JTAG EN IO23 Camera, LCD
|
||||
Camera, LCD IO22 IO21 Camera, LCD, MicroSD
|
||||
Camera, LCD IO19 IO18 Camera, LCD
|
||||
Camera, LCD IO5 IO17 PSRAM
|
||||
PSRAM IO16 IO4 LED, Camera, MicroSD
|
||||
Camera, LED, Boot IO0 IO2 LED, MicroSD
|
||||
JTAG, MicroSD IO15 5V
|
||||
===================== ===== ===== =====================
|
||||
|
||||
Legend:
|
||||
|
||||
* NC/XTAL - :ref:`32.768 kHz Oscillator <get-started-esp-wrover-kit-v3-xtal>`
|
||||
* JTAG - :ref:`JTAG / JP8 <get-started-esp-wrover-kit-v3-jtag-header>`
|
||||
* Boot - Boot button / SW2
|
||||
* Camera - :ref:`Camera / JP4 <get-started-esp-wrover-kit-v3-camera-header>`
|
||||
* LED - :ref:`RGB LED <get-started-esp-wrover-kit-v3-rgb-led-connections>`
|
||||
* MicroSD - :ref:`MicroSD Card / J4 <get-started-esp-wrover-kit-v3-microsd-card-slot>`
|
||||
* LCD - :ref:`LCD / U5 <get-started-esp-wrover-kit-v3-lcd-connector>`
|
||||
* PSRAM - ESP32-WROVER-B's PSRAM
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-kit-v3-xtal:
|
||||
|
||||
32.768 kHz Oscillator
|
||||
^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
==== ==========
|
||||
. ESP32 Pin
|
||||
==== ==========
|
||||
1 GPIO32
|
||||
2 GPIO33
|
||||
==== ==========
|
||||
|
||||
.. note::
|
||||
|
||||
Since GPIO32 and GPIO33 are connected to the oscillator by default, they are not connected to 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 then soldering the resistors in positions R12 / R24.
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-kit-v3-spi-flash-header:
|
||||
|
||||
SPI Flash / JP13
|
||||
^^^^^^^^^^^^^^^
|
||||
|
||||
==== =============
|
||||
. ESP32 Pin
|
||||
==== =============
|
||||
1 CLK / GPIO6
|
||||
2 SD0 / GPIO7
|
||||
3 SD1 / GPIO8
|
||||
4 SD2 / GPIO9
|
||||
5 SD3 / GPIO10
|
||||
6 CMD / GPIO11
|
||||
==== =============
|
||||
|
||||
.. important::
|
||||
|
||||
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 disolder these resistors to disconnect the module's flash bus from the pin header JP13.
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-kit-v3-jtag-header:
|
||||
|
||||
JTAG / JP8
|
||||
^^^^^^^^^^
|
||||
|
||||
==== ============== =============
|
||||
. ESP32 Pin JTAG Signal
|
||||
==== ============== =============
|
||||
1 EN TRST_N
|
||||
2 MTMS / GPIO14 TMS
|
||||
3 MTDO / GPIO15 TDO
|
||||
4 MTDI / GPIO12 TDI
|
||||
5 MTCK / GPIO13 TCK
|
||||
==== ============== =============
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-kit-v3-camera-header:
|
||||
|
||||
Camera / JP4
|
||||
^^^^^^^^^^^^
|
||||
|
||||
==== ========== =============================
|
||||
. ESP32 Pin Camera Signal
|
||||
==== ========== =============================
|
||||
1 n/a 3.3V
|
||||
2 n/a Ground
|
||||
3 GPIO27 SIO_C / SCCB Clock
|
||||
4 GPIO26 SIO_D / SCCB Data
|
||||
5 GPIO25 VSYNC / Vertical Sync
|
||||
6 GPIO23 HREF / Horizontal Reference
|
||||
7 GPIO22 PCLK / Pixel Clock
|
||||
8 GPIO21 XCLK / System Clock
|
||||
9 GPIO35 D7 / Pixel Data Bit 7
|
||||
10 GPIO34 D6 / Pixel Data Bit 6
|
||||
11 GPIO39 D5 / Pixel Data Bit 5
|
||||
12 GPIO36 D4 / Pixel Data Bit 4
|
||||
13 GPIO19 D3 / Pixel Data Bit 3
|
||||
14 GPIO18 D2 / Pixel Data Bit 2
|
||||
15 GPIO5 D1 / Pixel Data Bit 1
|
||||
16 GPIO4 D0 / Pixel Data Bit 0
|
||||
17 GPIO0 RESET / Camera Reset
|
||||
18 n/a PWDN / Camera Power Down
|
||||
==== ========== =============================
|
||||
|
||||
* Signals D0 .. D7 denote camera data bus
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-kit-v3-rgb-led-connections:
|
||||
|
||||
RGB LED
|
||||
^^^^^^^
|
||||
|
||||
==== ========== =========
|
||||
. ESP32 Pin RGB LED
|
||||
==== ========== =========
|
||||
1 GPIO0 Red
|
||||
2 GPIO2 Green
|
||||
3 GPIO4 Blue
|
||||
==== ========== =========
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-kit-v3-microsd-card-slot:
|
||||
|
||||
MicroSD Card / J4
|
||||
^^^^^^^^^^^^^^^^^
|
||||
|
||||
==== ============== ===============
|
||||
. ESP32 Pin MicroSD Signal
|
||||
==== ============== ===============
|
||||
1 MTDI / GPIO12 DATA2
|
||||
2 MTCK / GPIO13 CD / DATA3
|
||||
3 MTDO / GPIO15 CMD
|
||||
4 MTMS / GPIO14 CLK
|
||||
5 GPIO2 DATA0
|
||||
6 GPIO4 DATA1
|
||||
7 GPIO21 CD
|
||||
==== ============== ===============
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-kit-v3-lcd-connector:
|
||||
|
||||
LCD / U5
|
||||
^^^^^^^^
|
||||
|
||||
==== ============== ===============
|
||||
. ESP32 Pin LCD Signal
|
||||
==== ============== ===============
|
||||
1 GPIO18 RESET
|
||||
2 GPIO19 SCL
|
||||
3 GPIO21 D/C
|
||||
4 GPIO22 CS
|
||||
5 GPIO23 SDA
|
||||
6 GPIO25 SDO
|
||||
7 GPIO5 Backlight
|
||||
==== ============== ===============
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-kit-start-development:
|
||||
|
||||
Start Application Development
|
||||
-----------------------------
|
||||
|
||||
Before powering up your ESP-WROVER-KIT, please make sure that the board is in good condition with no obvious signs of damage.
|
||||
|
||||
|
||||
Initial Setup
|
||||
^^^^^^^^^^^^^
|
||||
|
||||
Please set only the following jumpers shown in the pictures below:
|
||||
|
||||
- Select USB as the source of power supply using the jumper block JP7.
|
||||
|
||||
- Enable UART communication using the jumper block JP11.
|
||||
|
||||
======================== ==========================
|
||||
Power up from USB port Enable UART communication
|
||||
======================== ==========================
|
||||
|jp7-usb_5v| |jp11-tx-rx|
|
||||
======================== ==========================
|
||||
|
||||
Do not install any other jumpers.
|
||||
|
||||
Turn the **Power Switch** to ON, the **5V Power On LED** should light up.
|
||||
|
||||
Now to Development
|
||||
^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Please proceed to :doc:`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.
|
||||
|
||||
|
||||
Related Documents
|
||||
-----------------
|
||||
|
||||
* `ESP-WROVER-KIT V3 schematic`_ (PDF)
|
||||
* `ESP32 Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf>`_ (PDF)
|
||||
* `ESP32-WROVER-B Datasheet <https://espressif.com/sites/default/files/documentation/esp32-wrover-b_datasheet_en.pdf>`_ (PDF)
|
||||
* :doc:`../api-guides/jtag-debugging/index`
|
||||
* :doc:`../hw-reference/index`
|
||||
|
||||
.. |jp7-ext_5v| image:: ../../_static/esp-wrover-kit-v3-jp7-ext_5v.jpg
|
||||
.. |jp7-usb_5v| image:: ../../_static/esp-wrover-kit-v3-jp7-usb_5v.jpg
|
||||
.. |jp8-jtag| image:: ../../_static/esp-wrover-kit-v3-jp8-jtag.jpg
|
||||
.. |jp11-tx-rx| image:: ../../_static/esp-wrover-kit-v3-jp11-tx-rx.jpg
|
||||
.. |jp14| image:: ../../_static/esp-wrover-kit-v3-jp14.jpg
|
||||
|
||||
.. _ESP-WROVER-KIT V3 schematic: https://dl.espressif.com/dl/schematics/ESP-WROVER-KIT_V4_1.pdf
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
|
||||
get-started-wrover-kit-v2.rst
|
||||
Loading…
Reference in New Issue
Block a user