Merge branch 'feature/esp-wrover-kit-v4_1' into 'master'
Included ESP-WROVER-KIT V4.1 in documenation: Added 'Get Started' guide and updated 'HW Reference'. Closes https://github.com/espressif/esp-idf/issues/2363. Closes https://github.com/espressif/esp-idf/issues/2365. See merge request idf/esp-idf!3161
BIN
docs/_static/esp-wrover-kit-v4.1-jp14.jpg
vendored
Normal file
After Width: | Height: | Size: 42 KiB |
BIN
docs/_static/esp-wrover-kit-v4.1-jp2-jtag.jpg
vendored
Normal file
After Width: | Height: | Size: 37 KiB |
BIN
docs/_static/esp-wrover-kit-v4.1-jp2-tx-rx.jpg
vendored
Normal file
After Width: | Height: | Size: 34 KiB |
BIN
docs/_static/esp-wrover-kit-v4.1-jp7-ext_5v.jpg
vendored
Normal file
After Width: | Height: | Size: 32 KiB |
BIN
docs/_static/esp-wrover-kit-v4.1-jp7-usb_5v.jpg
vendored
Normal file
After Width: | Height: | Size: 32 KiB |
BIN
docs/_static/esp-wrover-kit-v4.1-layout-back.png
vendored
Normal file
After Width: | Height: | Size: 191 KiB |
BIN
docs/_static/esp-wrover-kit-v4.1-layout-front.png
vendored
Normal file
After Width: | Height: | Size: 323 KiB |
418
docs/en/get-started/get-started-wrover-kit-v3.rst
Normal file
|
@ -0,0 +1,418 @@
|
|||
ESP-WROVER-KIT V3 Getting Started Guide
|
||||
=======================================
|
||||
|
||||
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.
|
||||
|
||||
|
||||
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
|
||||
|
||||
|
||||
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.
|
||||
|
||||
.. note::
|
||||
|
||||
ESP-WROVER-KIT V3 integrates the ESP32-WROVER module by default.
|
||||
|
||||
|
||||
Functionality Overview
|
||||
----------------------
|
||||
|
||||
The block diagram below illustrates the ESP-WROVER-KIT's main components and their interconnections.
|
||||
|
||||
.. figure:: ../../_static/esp32-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 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`.
|
||||
|
||||
.. _get-started-esp-wrover-kit-v3-board-front:
|
||||
|
||||
.. 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-v3-board-back:
|
||||
|
||||
.. 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-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.
|
||||
|
||||
+--------+------------------+--------------------------------------------------+
|
||||
| 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 |
|
||||
+----------------------+------+------+----------------------+
|
||||
| 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's PSRAM, if ESP32-WROVER is installed
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-kit-v3-xtal:
|
||||
|
||||
32.768 kHz Oscillator
|
||||
^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
+---+-----------+
|
||||
| | 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.
|
||||
|
||||
|
||||
.. _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 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.
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-kit-v3-jtag-header:
|
||||
|
||||
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-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 |
|
||||
+----+--------------+------------------------------+
|
||||
|
||||
|
||||
.. _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-v3-start-development:
|
||||
|
||||
Start Application Development
|
||||
-----------------------------
|
||||
|
||||
Before powering up the ESP-WROVER-KIT, please make sure that the board has been received 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
|
||||
^^^^^^^^^^^^^^^^^^
|
||||
|
||||
To start development of applications for ESP-WROVER-KIT, proceed to the :doc:`index` section which will walk you through the following steps:
|
||||
|
||||
* :ref:`get-started-setup-toolchain` in your PC to develop applications for ESP32 in C language
|
||||
* :ref:`get-started-connect` the module to the PC and verify if it is accessible
|
||||
* :ref:`get-started-build-flash` an example application to the ESP32
|
||||
* :ref:`get-started-build-monitor` instantly what the application is doing
|
||||
|
||||
|
||||
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-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
|
|
@ -1,33 +1,29 @@
|
|||
ESP-WROVER-KIT V3 Getting Started Guide
|
||||
=======================================
|
||||
ESP-WROVER-KIT V4.1 Getting Started Guide
|
||||
=========================================
|
||||
|
||||
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`.
|
||||
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 like to start using this board right now, go directly to section :ref:`get-started-esp-wrover-kit-start-development`.
|
||||
If you would like to start using this board right now, go directly to the :ref:`get-started-esp-wrover-kit-start-development` section.
|
||||
|
||||
|
||||
What You Need
|
||||
-------------
|
||||
|
||||
* 1 × :ref:`ESP-WROVER-KIT V3 board <get-started-esp-wrover-kit-board-front>`
|
||||
* 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
|
||||
|
||||
|
||||
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 ESP32-WROOM-32 and ESP32-WROVER. The ESP-WROVER-KIT features support for an LCD and MicroSD card. The I/O pins have been broken out from the ESP32 module for easy extension. The board carries an advanced multi-protocol USB bridge (the FTDI FT2232HL), enabling developers to use JTAG directly to debug the ESP32 through the USB interface. The development board makes secondary development easy and cost-effective.
|
||||
|
||||
.. note::
|
||||
|
||||
ESP-WROVER-KIT V3 integrates the ESP32-WROVER module by default.
|
||||
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.
|
||||
|
||||
|
||||
Functionality Overview
|
||||
^^^^^^^^^^^^^^^^^^^^^^
|
||||
----------------------
|
||||
|
||||
Block diagram below presents main components of ESP-WROVER-KIT and interconnections between components.
|
||||
The block diagram below illustrates the ESP-WROVER-KIT's main components and their interconnections.
|
||||
|
||||
.. figure:: ../../_static/esp32-wrover-kit-block-diagram.png
|
||||
:align: center
|
||||
|
@ -38,68 +34,72 @@ 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 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 the chip with a clock of low-power consumption during the Deep-sleep mode.
|
||||
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 Module
|
||||
ESP-WROVER-KIT is compatible with both ESP32-WROOM-32 and ESP32-WROVER. The ESP32-WROVER module features all the functions of ESP32-WROOM-32 and integrates an external 32-MBit PSRAM for flexible extended storage and data processing capabilities.
|
||||
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.
|
||||
|
||||
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`_.
|
||||
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 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.
|
||||
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: the SPI interface connects to an external flash (PSRAM). To interface another SPI device, an extra CS signal is needed. The electrical level on the flash of this module is 1.8V. If an ESP32-WROOM-32 is being used, please note that the electrical level on the flash of this module is 3.3V.
|
||||
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 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
|
||||
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.
|
||||
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`, jumper header JP7.
|
||||
Power Key
|
||||
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 V3 schematic`_.
|
||||
Camera
|
||||
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
|
||||
RGB LED
|
||||
Red, green and blue (RGB) light emitting diodes (LEDs), which may be controlled by pulse width modulation (PWM).
|
||||
I/O
|
||||
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
|
||||
Micro SD card slot for data storage.
|
||||
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-board-back`.
|
||||
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`.
|
||||
|
||||
.. _get-started-esp-wrover-kit-board-front:
|
||||
.. _get-started-esp-wrover-kit-v4.1-board-front:
|
||||
|
||||
.. figure:: ../../_static/esp32-wrover-kit-layout-front.jpg
|
||||
.. 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-board-back:
|
||||
.. _get-started-esp-wrover-kit-v4.1-board-back:
|
||||
|
||||
.. figure:: ../../_static/esp32-wrover-kit-layout-back.jpg
|
||||
.. figure:: ../../_static/esp-wrover-kit-v4.1-layout-back.png
|
||||
:align: center
|
||||
:alt: ESP-WROVER-KIT board layout - back
|
||||
:figclass: align-center
|
||||
|
@ -110,9 +110,9 @@ LCD
|
|||
.. _get-started-esp-wrover-kit-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 three 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 |
|
||||
|
@ -122,9 +122,9 @@ There are five jumper headers available to set up the board functionality. Typic
|
|||
+--------+------------------+--------------------------------------------------+
|
||||
| JP7 | |jp7-usb_5v| | Power ESP-WROVER-KIT board from an USB port |
|
||||
+--------+------------------+--------------------------------------------------+
|
||||
| JP8 | |jp8| | Enable JTAG functionality |
|
||||
| JP2 | |jp2-jtag| | Enable JTAG functionality |
|
||||
+--------+------------------+--------------------------------------------------+
|
||||
| JP11 | |jp11-rx-tx| | Enable UART communication |
|
||||
| JP2 | |jp2-tx-rx| | Enable UART communication |
|
||||
+--------+------------------+--------------------------------------------------+
|
||||
| JP14 | |jp14| | Enable RTS/CTS flow control for serial |
|
||||
| | | communication |
|
||||
|
@ -132,13 +132,13 @@ There are five jumper headers available to set up the board functionality. Typic
|
|||
|
||||
|
||||
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.
|
||||
|
||||
|
@ -176,20 +176,20 @@ The JP1 connector is shown in two columns in the middle under "I/O" headers. The
|
|||
|
||||
Legend:
|
||||
|
||||
* NC/XTAL - :ref:`32.768 kHz Oscillator <get-started-esp-wrover-kit-xtal>`
|
||||
* JTAG - :ref:`JTAG / JP8 <get-started-esp-wrover-jtag-header>`
|
||||
* NC/XTAL - :ref:`32.768 kHz Oscillator <get-started-esp-wrover-kit-v4.1-xtal>`
|
||||
* JTAG - :ref:`JTAG / JP8 <get-started-esp-wrover-kit-v4.1-jtag-header>`
|
||||
* Boot - Boot button / SW2
|
||||
* Camera - :ref:`Camera / JP4 <get-started-esp-wrover-camera-header>`
|
||||
* LED - :ref:`RGB LED <get-started-esp-wrover-rgb-led-connections>`
|
||||
* MicroSD - :ref:`MicroSD Card / J4 <get-started-esp-wrover-microsd-card-slot>`
|
||||
* LCD - :ref:`LCD / U5 <get-started-esp-wrover-lcd-connector>`
|
||||
* Camera - :ref:`Camera / JP4 <get-started-esp-wrover-kit-v4.1-camera-header>`
|
||||
* 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
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-kit-xtal:
|
||||
.. _get-started-esp-wrover-kit-v4.1-xtal:
|
||||
|
||||
32.768 kHz Oscillator
|
||||
"""""""""""""""""""""
|
||||
^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
+---+-----------+
|
||||
| | ESP32 Pin |
|
||||
|
@ -201,13 +201,13 @@ Legend:
|
|||
|
||||
.. 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.
|
||||
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.
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-spi-flash-header:
|
||||
.. _get-started-esp-wrover-kit-v4.1-spi-flash-header:
|
||||
|
||||
SPI Flash / JP13
|
||||
""""""""""""""""
|
||||
SPI Flash / JP2
|
||||
^^^^^^^^^^^^^^^
|
||||
|
||||
+---+--------------+
|
||||
| | ESP32 Pin |
|
||||
|
@ -227,33 +227,33 @@ SPI Flash / JP13
|
|||
|
||||
.. 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.
|
||||
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.
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-jtag-header:
|
||||
.. _get-started-esp-wrover-kit-v4.1-jtag-header:
|
||||
|
||||
JTAG / JP8
|
||||
""""""""""
|
||||
JTAG / JP2
|
||||
^^^^^^^^^^
|
||||
|
||||
+---+---------------+-------------+
|
||||
| | ESP32 Pin | JTAG Signal |
|
||||
+===+===============+=============+
|
||||
| 1 | EN | TRST_N |
|
||||
+---+---------------+-------------+
|
||||
| 2 | MTDO / GPIO15 | TDO |
|
||||
| 2 | MTMS / GPIO14 | TMS |
|
||||
+---+---------------+-------------+
|
||||
| 3 | MTDI / GPIO12 | TDI |
|
||||
| 3 | MTDO / GPIO15 | TDO |
|
||||
+---+---------------+-------------+
|
||||
| 4 | MTCK / GPIO13 | TCK |
|
||||
| 4 | MTDI / GPIO12 | TDI |
|
||||
+---+---------------+-------------+
|
||||
| 5 | MTMS / GPIO14 | TMS |
|
||||
| 5 | MTCK / GPIO13 | TCK |
|
||||
+---+---------------+-------------+
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-camera-header:
|
||||
.. _get-started-esp-wrover-kit-v4.1-camera-header:
|
||||
|
||||
Camera / JP4
|
||||
""""""""""""
|
||||
^^^^^^^^^^^^
|
||||
|
||||
+----+--------------+------------------------------+
|
||||
| | ESP32 Pin | Camera Signal |
|
||||
|
@ -295,27 +295,29 @@ Camera / JP4
|
|||
| 18 | n/a | PWDN / Camera Power Down |
|
||||
+----+--------------+------------------------------+
|
||||
|
||||
* Signals D0 .. D7 denote camera data bus
|
||||
|
||||
.. _get-started-esp-wrover-rgb-led-connections:
|
||||
|
||||
.. _get-started-esp-wrover-kit-v4.1-rgb-led-connections:
|
||||
|
||||
RGB LED
|
||||
"""""""
|
||||
^^^^^^^
|
||||
|
||||
+---+-----------+---------+
|
||||
| | ESP32 Pin | RGB LED |
|
||||
+===+===========+=========+
|
||||
| 1 | GPIO0 | Red |
|
||||
+---+-----------+---------+
|
||||
| 2 | GPIO2 | Blue |
|
||||
| 2 | GPIO2 | Green |
|
||||
+---+-----------+---------+
|
||||
| 3 | GPIO4 | Green |
|
||||
| 3 | GPIO4 | Blue |
|
||||
+---+-----------+---------+
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-microsd-card-slot:
|
||||
.. _get-started-esp-wrover-kit-v4.1-microsd-card-slot:
|
||||
|
||||
MicroSD Card / J4
|
||||
"""""""""""""""""
|
||||
^^^^^^^^^^^^^^^^^
|
||||
|
||||
+---+---------------+----------------+
|
||||
| | ESP32 Pin | MicroSD Signal |
|
||||
|
@ -336,10 +338,10 @@ MicroSD Card / J4
|
|||
+---+---------------+----------------+
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-lcd-connector:
|
||||
.. _get-started-esp-wrover-kit-v4.1-lcd-connector:
|
||||
|
||||
LCD / U5
|
||||
""""""""
|
||||
^^^^^^^^
|
||||
|
||||
+---+-----------+------------+
|
||||
| | ESP32 Pin | LCD Signal |
|
||||
|
@ -371,22 +373,23 @@ Before powering up the ESP-WROVER-KIT, please make sure that the board has been
|
|||
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.
|
||||
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.
|
||||
|
||||
+----------------------+----------------------+
|
||||
| Power up | Enable UART |
|
||||
| from USB port | communication |
|
||||
+----------------------+----------------------+
|
||||
| |jp7-usb_5v| | |jp11-rx-tx| |
|
||||
| |jp7-usb_5v| | |jp2-tx-rx| |
|
||||
+----------------------+----------------------+
|
||||
|
||||
Do not install any other jumpers.
|
||||
|
||||
Turn the **Power Switch** on. The **5V Power On LED** should turn on.
|
||||
|
||||
Now to Development
|
||||
^^^^^^^^^^^^^^^^^^
|
||||
|
||||
To start development of applications for ESP-WROVER-KIT, proceed to section :doc:`index`, that will walk you through the following steps:
|
||||
To start development of applications for ESP-WROVER-KIT, proceed to the :doc:`index` section which will walk you through the following steps:
|
||||
|
||||
* :ref:`get-started-setup-toolchain` in your PC to develop applications for ESP32 in C language
|
||||
* :ref:`get-started-connect` the module to the PC and verify if it is accessible
|
||||
|
@ -397,22 +400,22 @@ To start development of applications for ESP-WROVER-KIT, proceed to section :doc
|
|||
Related Documents
|
||||
-----------------
|
||||
|
||||
* `ESP-WROVER-KIT V3 schematic`_ (PDF)
|
||||
* `ESP-WROVER-KIT V4.1 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)
|
||||
* `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.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
|
||||
.. |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 V3 schematic: https://dl.espressif.com/dl/schematics/ESP-WROVER-KIT_SCH-3.pdf
|
||||
.. _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
|
||||
|
|
|
@ -74,6 +74,57 @@ Documentation
|
|||
* `ESP32 DevKitC V2 Schematic <https://dl.espressif.com/dl/schematics/ESP32-Core-Board-V2_sch.pdf>`__ (PDF)
|
||||
* `CP210x USB to UART Bridge VCP Drivers <https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers>`_
|
||||
|
||||
.. _esp-modules-and-boards-esp-wrover-kit-v3:
|
||||
|
||||
ESP-WROVER-KIT V3
|
||||
=================
|
||||
|
||||
The ESP-WROVER-KIT V3 development board has dual port USB to serial converter for programming and JTAG interface for debugging. Power supply is provided by USB interface or from standard 5 mm power supply jack. Power supply selection is done with a jumper and may be put on/off with a separate switch. This board has MicroSD card slot, 3.2” SPI LCD screen and dedicated header to connect a camera. It provides RGB diode for diagnostics. Includes 32.768 kHz XTAL for internal RTC to operate it in low power modes.
|
||||
|
||||
As all previous versions of ESP-WROVER-KIT boards, it is ready to accommodate an :ref:`esp-modules-and-boards-esp32-wroom-32` or :ref:`esp-modules-and-boards-esp32-wrover` module.
|
||||
|
||||
This is the first release of ESP-WROVER-KIT shipped with :ref:`esp-modules-and-boards-esp32-wrover` module installed by default. This release also introduced several design changes to conditioning and interlocking of signals to the bootstrapping pins. Also, a zero Ohm resistor (R166) has been added between WROVER/WROOM module and VDD33 net, which can be desoldered, or replaced with a shunt resistor, for current measurement. This is intended to facilitate power consumption analysis in various operation modes of ESP32. Refer to schematic - the changes are enclosed in green border.
|
||||
|
||||
.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp-wrover-kit-v3.jpg
|
||||
:align: center
|
||||
:alt: ESP-WROVER-KIT V3 board
|
||||
:width: 90%
|
||||
|
||||
ESP-WROVER-KIT V3 board
|
||||
|
||||
The camera header has been changed from male back to female. The board soldermask is matte black. The board on picture above has :ref:`esp-modules-and-boards-esp32-wrover` is installed.
|
||||
|
||||
Documentation
|
||||
-------------
|
||||
|
||||
* :doc:`../get-started/get-started-wrover-kit-v3`
|
||||
* `ESP-WROVER-KIT V3 Schematic <https://dl.espressif.com/dl/schematics/ESP-WROVER-KIT_SCH-3.pdf>`__ (PDF)
|
||||
* :doc:`../api-guides/jtag-debugging/index`
|
||||
* `FTDI Virtual COM Port Drivers`_
|
||||
|
||||
.. _esp-modules-and-boards-esp-wrover-kit-v2:
|
||||
|
||||
ESP-WROVER-KIT V2
|
||||
=================
|
||||
|
||||
This is updated version of ESP32 DevKitJ V1 described above with design improvements identified when DevKitJ was in use, e.g. improved support for SD card. By default board has ESP-WROOM-32 module installed.
|
||||
|
||||
.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp-wrover-kit-v2.jpg
|
||||
:align: center
|
||||
:alt: ESP-WROVER-KIT V2 board
|
||||
:width: 90%
|
||||
|
||||
ESP-WROVER-KIT V2 board
|
||||
|
||||
Comparing to previous version, this board has a shiny black finish and a male camera header.
|
||||
|
||||
Documentation
|
||||
-------------
|
||||
|
||||
* :doc:`../get-started/get-started-wrover-kit-v2`
|
||||
* `ESP-WROVER-KIT V2 Schematic <https://dl.espressif.com/dl/schematics/ESP-WROVER-KIT_SCH-2.pdf>`__ (PDF)
|
||||
* :doc:`../api-guides/jtag-debugging/index`
|
||||
* `FTDI Virtual COM Port Drivers`_
|
||||
|
||||
.. _esp-modules-and-boards-esp-wrover-kit-v1:
|
||||
|
||||
|
@ -103,32 +154,6 @@ Documentation
|
|||
* :doc:`../api-guides/jtag-debugging/index`
|
||||
* `FTDI Virtual COM Port Drivers`_
|
||||
|
||||
|
||||
.. _esp-modules-and-boards-esp-wrover-kit-v2:
|
||||
|
||||
ESP-WROVER-KIT V2
|
||||
=================
|
||||
|
||||
This is updated version of ESP32 DevKitJ V1 described above with design improvements identified when DevKitJ was in use, e.g. improved support for SD card. By default board has ESP-WROOM-32 module installed.
|
||||
|
||||
.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp-wrover-kit-v2.jpg
|
||||
:align: center
|
||||
:alt: ESP-WROVER-KIT V2 board
|
||||
:width: 90%
|
||||
|
||||
ESP-WROVER-KIT V2 board
|
||||
|
||||
Comparing to previous version, this board has a shiny black finish and a male camera header.
|
||||
|
||||
Documentation
|
||||
-------------
|
||||
|
||||
* :doc:`../get-started/get-started-wrover-kit-v2`
|
||||
* `ESP-WROVER-KIT V2 Schematic <https://dl.espressif.com/dl/schematics/ESP-WROVER-KIT_SCH-2.pdf>`__ (PDF)
|
||||
* :doc:`../api-guides/jtag-debugging/index`
|
||||
* `FTDI Virtual COM Port Drivers`_
|
||||
|
||||
|
||||
.. _esp-modules-and-boards-esp32-demo-board:
|
||||
|
||||
ESP32 Demo Board V2
|
||||
|
|
|
@ -12,30 +12,35 @@ For details please refer to documentation below, provided together with descript
|
|||
|
||||
This section describes the latest versions of boards. Previous versions of boards, including these not produced anymore, are described in section :ref:`esp-modules-and-boards-previous`.
|
||||
|
||||
.. _esp-wroom-solo-wrover-modules:
|
||||
|
||||
WROOM, SOLO and WROVER Modules
|
||||
==============================
|
||||
|
||||
A family of small modules that contain ESP32 chip on board together with some key components including a crystal oscillator and an antenna matching circuit. This makes it easier to provide an ESP32 based solution ready to integrate into final products. Such modules can be also used for evaluation after adding a few extra components like a programming interface, bootstrapping resistors and break out headers. The key characteristics of these modules are summarized in the following table. Some additional details are covered in the following chapters.
|
||||
|
||||
=============== ============ ===== ==== ==== ==== ==== ====
|
||||
-- Key Components Dimensions [mm]
|
||||
--------------- ------------------------------- ----------------
|
||||
Module Chip Flash RAM Ant. L W D
|
||||
=============== ============ ===== ==== ==== ==== ==== ====
|
||||
ESP32-WROOM-32 ESP32-D0WDQ6 4MB -- MIFA 25.5 18 3.1
|
||||
ESP32-WROOM-32D ESP32-D0WD 4MB -- MIFA 25.5 18 3.1
|
||||
ESP32-WROOM-32U ESP32-D0WD 4MB -- U.FL 19.2 18 3.2
|
||||
ESP32-SOLO-1 ESP32-S0WD 4MB -- MIFA 25.5 18 3.1
|
||||
ESP32-WROVER ESP32-D0WDQ6 4MB 4MB MIFA 31.4 18 3.2
|
||||
ESP32-WROVER-I ESP32-D0WDQ6 4MB 4MB U.FL 31.4 18 3.5
|
||||
=============== ============ ===== ==== ==== ==== ==== ====
|
||||
=============== ============ ===== ====== ====
|
||||
-- Key Components
|
||||
--------------- ---------------------------------
|
||||
Module Chip Flash PSRAM Ant.
|
||||
=============== ============ ===== ====== ====
|
||||
ESP32-WROOM-32 ESP32-D0WDQ6 4MB -- MIFA
|
||||
ESP32-WROOM-32D ESP32-D0WD 4MB -- MIFA
|
||||
ESP32-WROOM-32U ESP32-D0WD 4MB -- U.FL
|
||||
ESP32-SOLO-1 ESP32-S0WD 4MB -- MIFA
|
||||
ESP32-WROVER ESP32-D0WDQ6 4MB 8MB MIFA
|
||||
ESP32-WROVER-I ESP32-D0WDQ6 4MB 8MB U.FL
|
||||
ESP32-WROVER-B ESP32-D0WD 4MB 8MB MIFA
|
||||
ESP32-WROVER-IB ESP32-D0WD 4MB 8MB U.FL
|
||||
=============== ============ ===== ====== ====
|
||||
|
||||
* ESP32-**D**.. denotes dual core, ESP32-**S**.. denotes single core chip
|
||||
* MIFA - Meandered Inverted-F Antenna
|
||||
* U.FL - U.FL / IPEX antenna connector
|
||||
* ESP32-WROOM-x and ESP32-WROVER-x modules are also available with custom flash sizes of 8MB or 16MB, see `Espressif Products Ordering Information`_ (PDF)
|
||||
* `ESP32 Chip Datasheet <https://espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf>`__ (PDF)
|
||||
* Note: *ESP32-WROOM-32* was previously called *ESP-WROOM-32*
|
||||
* Initial release of ESP32-WROVER module had 4MB of PSRAM
|
||||
* *ESP32-WROOM-32* was previously called *ESP-WROOM-32*
|
||||
|
||||
|
||||
.. _esp-modules-and-boards-esp32-wroom-32:
|
||||
|
@ -43,7 +48,7 @@ ESP32-WROVER-I ESP32-D0WDQ6 4MB 4MB U.FL 31.4 18 3.5
|
|||
ESP32-WROOM-32
|
||||
--------------
|
||||
|
||||
A basic and commonly adopted ESP32 module with ESP32-D0WDQ6 chip on board. The first one of the WROOM / WROVER family released to the market.
|
||||
A basic and commonly adopted ESP32 module with ESP32-D0WDQ6 chip on board. The first one of the WROOM / WROVER family released to the market. By default the module has 4MB flash and may be also ordered with custom flash size of 8 or 16MB, see `Espressif Products Ordering Information`_.
|
||||
|
||||
.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-wroom-32-front-back.jpg
|
||||
:align: center
|
||||
|
@ -64,7 +69,7 @@ Documentation
|
|||
ESP32-WROOM-32D / ESP32-WROOM-32U
|
||||
---------------------------------
|
||||
|
||||
Both modules have ESP32-D0WD chip on board of a smaller footprint than ESP32-D0WDQ6 installed in :ref:`esp-modules-and-boards-esp32-wroom-32`. Version "D" has a MIFA antenna. Version "U" has just an U.FL / IPEX antenna connector. That makes it 6.3 mm shorter comparing to "D", and also the smallest representative of the whole WROOM / WROVER family of modules.
|
||||
Both modules have ESP32-D0WD chip on board of a smaller footprint than ESP32-D0WDQ6 installed in :ref:`esp-modules-and-boards-esp32-wroom-32`. By default the module has 4MB flash and may be also ordered with custom flash size of 8 or 16MB, see `Espressif Products Ordering Information`_. Version "D" has a MIFA antenna. Version "U" has just an U.FL / IPEX antenna connector. That makes it 6.3 mm shorter comparing to "D", and also the smallest representative of the whole WROOM / WROVER family of modules.
|
||||
|
||||
.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-wroom-32d-front-back.jpg
|
||||
:align: center
|
||||
|
@ -101,12 +106,24 @@ Simplified version of ESP32-WROOM-32D module. It contains a single core ESP32 ch
|
|||
ESP32-SOLO-1 module (front and back)
|
||||
|
||||
|
||||
Documentation
|
||||
^^^^^^^^^^^^^
|
||||
|
||||
* `ESP32-SOLO-1 Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32-solo-1_datasheet_en.pdf>`__ (PDF)
|
||||
|
||||
|
||||
.. _esp-modules-and-boards-esp32-wrover:
|
||||
|
||||
ESP32-WROVER
|
||||
------------
|
||||
|
||||
A step upgrade of :ref:`esp-modules-and-boards-esp32-wroom-32` with an additional 4 MB SPI PSRAM (Pseudo static RAM). This module is provided in two versions: 'ESP32-WROVER' with PCB antenna (shown below) and 'ESP32-WROVER-I' with an U.FL / IPEX antenna connector. Because of additional components inside, this module is 5.9 mm longer than :ref:`esp-modules-and-boards-esp32-wroom-32`.
|
||||
A step upgrade of ESP32-WROOM-32x modules with an additional 8MB SPI PSRAM (Pseudo static RAM).
|
||||
|
||||
The module comes in couple of versions listed in section :ref:`esp-wroom-solo-wrover-modules`. ESP32-WROVER and ESP32-WROVER-I have PSRAM that operates at 1.8V and can support up to 144 MHz clock rate. ESP32-WROVER-B and ESP32-WROVER-IB have PSRAM that operates at 3.3V and can support up to 133 MHz clock rate.
|
||||
|
||||
By default the module has 4MB flash and may be also ordered with custom flash size of 8 or 16MB, see `Espressif Products Ordering Information`_.
|
||||
|
||||
Depending on version the module has PCB antenna (shown below) or an U.FL / IPEX antenna connector. Because of additional components inside, this module is 5.9 mm longer than :ref:`esp-modules-and-boards-esp32-wroom-32`.
|
||||
|
||||
.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-wrover.jpg
|
||||
:align: center
|
||||
|
@ -119,7 +136,7 @@ Documentation
|
|||
^^^^^^^^^^^^^
|
||||
|
||||
* `ESP32-WROVER Datasheet <https://espressif.com/sites/default/files/documentation/esp32-wrover_datasheet_en.pdf>`__ (PDF)
|
||||
* `ESP-PSRAM32 Datasheet <https://espressif.com/sites/default/files/documentation/esp-psram32_datasheet_en.pdf>`__ (PDF)
|
||||
* `ESP-PSRAM64 & ESP-PSRAM64H Datasheet <https://www.espressif.com/sites/default/files/documentation/esp-psram64_esp-psram64h_datasheet_en.pdf>`__ (PDF)
|
||||
* `ESP32-WROVER Reference Design <https://www.espressif.com/en/support/download/documents?keys=ESP32-WROVER+Reference+Design>`_ containing OrCAD schematic, PCB layout, gerbers and BOM
|
||||
|
||||
|
||||
|
@ -184,37 +201,43 @@ Previous Versions
|
|||
|
||||
.. _esp-modules-and-boards-esp-wrover-kit:
|
||||
|
||||
ESP-WROVER-KIT V3
|
||||
=================
|
||||
ESP-WROVER-KIT V4.1
|
||||
===================
|
||||
|
||||
The ESP-WROVER-KIT V3 development board has dual port USB to serial converter for programming and JTAG interface for debugging. Power supply is provided by USB interface or from standard 5 mm power supply jack. Power supply selection is done with a jumper and may be put on/off with a separate switch. This board has MicroSD card slot, 3.2” SPI LCD screen and dedicated header to connect a camera. It provides RGB diode for diagnostics. Includes 32.768 kHz XTAL for internal RTC to operate it in low power modes.
|
||||
The ESP-WROVER-KIT V4.1 development board has dual port USB to serial converter for programming and JTAG interface for debugging. Power supply is provided by USB interface or from standard 5 mm power supply jack. Power supply selection is done with a jumper and may be put on/off with a separate switch. This board has MicroSD card slot, 3.2” SPI LCD screen and dedicated header to connect a camera. It provides RGB diode for diagnostics. Includes 32.768 kHz XTAL for internal RTC to operate it in low power modes.
|
||||
|
||||
As all previous version of ESP-WROVER-KIT boards, it is ready to accommodate an :ref:`esp-modules-and-boards-esp32-wroom-32` or :ref:`esp-modules-and-boards-esp32-wrover` module.
|
||||
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`.
|
||||
|
||||
This is the first release of ESP-WROVER-KIT shipped with :ref:`esp-modules-and-boards-esp32-wrover` module installed by default. This release also introduced several design changes to conditioning and interlocking of signals to the bootstrapping pins. Also, a zero Ohm resistor (R166) has been added between WROVER/WROOM module and VDD33 net, which can be desoldered, or replaced with a shunt resistor, for current measurement. This is intended to facilitate power consumption analysis in various operation modes of ESP32. Refer to schematic - the changes are enclosed in green border.
|
||||
Comparing to :ref:`esp-modules-and-boards-esp-wrover-kit-v3`, this board has the following design changes:
|
||||
|
||||
.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp-wrover-kit-v3.jpg
|
||||
* JP8, JP11 and JP13 have been combined into a single JP2
|
||||
* USB connector has been changed to DIP type and moved to the lower right corner of the board
|
||||
* R61 has been changed to 0R
|
||||
* Some other components, e.g. EN and Boot buttons, have been replaced with functional equivalents basing on test results and sourcing options
|
||||
|
||||
.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp-wrover-kit-v4.1-front.jpg
|
||||
:align: center
|
||||
:alt: ESP-WROVER-KIT V3 board
|
||||
:alt: ESP-WROVER-KIT V4.1 board
|
||||
:width: 90%
|
||||
|
||||
ESP-WROVER-KIT V3 board
|
||||
ESP-WROVER-KIT V4.1 board
|
||||
|
||||
The camera header has been changed from male back to female. The board soldermask is matte black. The board on picture above has :ref:`esp-modules-and-boards-esp32-wrover` is installed.
|
||||
The board on picture above has ESP32-WROVER-B module is installed.
|
||||
|
||||
Documentation
|
||||
-------------
|
||||
|
||||
* :doc:`../get-started/get-started-wrover-kit`
|
||||
* `ESP-WROVER-KIT V3 Schematic <https://dl.espressif.com/dl/schematics/ESP-WROVER-KIT_SCH-3.pdf>`__ (PDF)
|
||||
* `ESP-WROVER-KIT V4.1 Schematic <https://dl.espressif.com/dl/schematics/ESP-WROVER-KIT_V4_1.pdf>`__ (PDF)
|
||||
* :doc:`../api-guides/jtag-debugging/index`
|
||||
* `FTDI Virtual COM Port Drivers`_
|
||||
|
||||
Previous Versions
|
||||
-----------------
|
||||
|
||||
* :ref:`esp-modules-and-boards-esp-wrover-kit-v1`
|
||||
* :ref:`esp-modules-and-boards-esp-wrover-kit-v3`
|
||||
* :ref:`esp-modules-and-boards-esp-wrover-kit-v2`
|
||||
* :ref:`esp-modules-and-boards-esp-wrover-kit-v1`
|
||||
|
||||
|
||||
Related Documents
|
||||
|
@ -224,3 +247,4 @@ Related Documents
|
|||
|
||||
|
||||
.. _FTDI Virtual COM Port Drivers: http://www.ftdichip.com/Drivers/VCP.htm
|
||||
.. _Espressif Products Ordering Information: https://www.espressif.com/sites/default/files/documentation/espressif_products_ordering_information_en.pdf
|
1
docs/zh_CN/get-started/get-started-wrover-kit-v3.rst
Normal file
|
@ -0,0 +1 @@
|
|||
.. include:: ../../en/get-started/get-started-wrover-kit-v3.rst
|