Crash_Override/OVMS3-idf
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Merge make-related documents:

Browse source 
1. Moved get-started files, 7 documents in total, from get-started-cmake folder to hw-reference folder;
2. Deleted get-started files, 7 documents in total, in get-started folder;
3. Updated links in get-started-cmake/index.rst and in get-started/index.rst;
4. Modified descriptions for build system in these files.
This commit is contained in:
Wang Fang 2019-07-04 13:16:18 +08:00 committed by Krzysztof Budzynski
parent b293518ec7
commit b24341a664
37 changed files with 85 additions and 3054 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/conf_common.py
View file

@ -247,7 +247,13 @@ html_redirect_pages = [('api-reference/ethernet/index', 'api-reference/network/i
('api-reference/wifi/esp_wifi', 'api-reference/network/esp_wifi'),
('api-reference/system/tcpip_adapter', 'api-reference/network/tcpip_adapter'),
('get-started/idf-monitor', 'api-guides/tools/idf-monitor'),
('get-started-cmake/idf-monitor', 'api-guides/tools/idf-monitor'),]
('get-started-cmake/idf-monitor', 'api-guides/tools/idf-monitor'),
('get-started/get-started-devkitc', 'hw-reference/get-started-devkitc'),
('get-started/get-started-wrover-kit', 'hw-reference/get-started-wrover-kit'),
('get-started/get-started-pico-kit', 'hw-reference/get-started-pico-kit'),
('get-started-cmake/get-started-devkitc', 'hw-reference/get-started-devkitc'),
('get-started-cmake/get-started-wrover-kit', 'hw-reference/get-started-wrover-kit'),
('get-started-cmake/get-started-pico-kit', 'hw-reference/get-started-pico-kit')]
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.

2
docs/en/api-guides/jtag-debugging/configure-wrover.rst
View file

@ -8,7 +8,7 @@ All versions of ESP-WROVER-KIT boards have built-in JTAG functionality. Putting
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-v4.1-setup-options`.
1. Enable on-board JTAG functionality by setting JP8 according to :doc:`../../hw-reference/get-started-wrover-kit`, Section :ref:`get-started-esp-wrover-kit-v4.1-setup-options-cmake`.
2. Verify if ESP32 pins used for JTAG communication are not connected to some other h/w that may disturb JTAG operation:

6
docs/en/get-started-cmake/index.rst
View file

@ -62,9 +62,9 @@ If you have one of ESP32 development boards listed below, you can click on the l
.. toctree::
:maxdepth: 1
ESP32-DevKitC <get-started-devkitc>
ESP-WROVER-KIT <get-started-wrover-kit>
ESP32-PICO-KIT <get-started-pico-kit>
ESP32-DevKitC <../hw-reference/get-started-devkitc>
ESP-WROVER-KIT <../hw-reference/get-started-wrover-kit>
ESP32-PICO-KIT <../hw-reference/get-started-pico-kit>
ESP32-Ethernet-Kit <../hw-reference/get-started-ethernet-kit>

82
docs/en/get-started/get-started-devkitc-v2.rst
View file

@ -1,82 +0,0 @@
ESP32-DevKitC V2 Getting Started Guide (CMake)
==============================================
:link_to_translation:`zh_CN:[中文]`
This guide shows how to start using the ESP32-DevKitC V2 development board.
What You Need
-------------
* ESP32-DevKitC V2 board
* USB A / micro USB B cable
* Computer running Windows, Linux, or macOS
You can skip the introduction sections and go directly to Section `Start Application Development`_.
Overview
--------
ESP32-DevKitC V2 is a small-sized ESP32-based development board produced by `Espressif <https://espressif.com>`_. Most of the I/O pins are broken out to the pin headers on both sides for easy interfacing. Developers can either connect peripherals with jumper wires or mount ESP32-DevKitC V4 on a breadboard.
Functional Description
----------------------
The following figure and the table below describe the key components, interfaces and controls of the ESP32-DevKitC V2 board.
.. _get-started-esp32-devkitc-v2-board-front-make:
.. figure:: ../../_static/esp32-devkitc-v2-functional-overview.png
:align: center
:alt: ESP32-DevKitC V2 board layout
:figclass: align-center
ESP32-DevKitC V2 board layout
+---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Key Component | Description |
+=====================+=========================================================================================================================================================================================+
| ESP32-WROOM-32 | Standard module with ESP32 at its core. For more information, see `ESP32-WROOM-32 Datasheet <https://espressif.com/sites/default/files/documentation/esp32-wroom-32_datasheet_en.pdf>`_ |
+---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| EN | Reset button. |
+---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Boot | Download button. Holding down **Boot** and then pressing **EN** initiates Firmware Download mode for downloading firmware through the serial port. |
+---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Micro USB Port | USB interface. Power supply for the board as well as the communication interface between a computer and ESP32-WROOM-32. |
+---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| I/O | Most of the pins on the ESP module are broken out to the pin headers on the board. You can program ESP32 to enable multiple functions such as PWM, ADC, DAC, I2C, I2S, SPI, etc. |
+---------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Power Supply Options
--------------------
There are three mutually exclusive ways to provide power to the board:
* Micro USB port, default power supply
* 5V / GND header pins
* 3V3 / GND header pins
.. warning::
The power supply must be provided using **one and only one of the options above**, otherwise the board and/or the power supply source can be damaged.
Start Application Development
------------------------------
Before powering up your ESP32-DevKitC V2, please make sure that the board is in good condition with no obvious signs of damage.
After that, 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
-----------------
* `ESP32-DevKitC schematics <https://dl.espressif.com/dl/schematics/ESP32-Core-Board-V2_sch.pdf>`_ (PDF)
* `ESP32 Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf>`_ (PDF)
* `ESP32-WROOM-32 Datasheet <https://espressif.com/sites/default/files/documentation/esp32-wroom-32_datasheet_en.pdf>`_ (PDF)

153
docs/en/get-started/get-started-devkitc.rst
View file

@ -1,153 +0,0 @@
ESP32-DevKitC V4 Getting Started Guide
======================================
:link_to_translation:`zh_CN:[中文]`
This guide shows how to start using the ESP32-DevKitC V4 development board. For description of other versions of ESP32-DevKitC check :doc:`../hw-reference/index`.
What You Need
-------------
* ESP32-DevKitC V4 board
* USB A / micro USB B cable
* Computer running Windows, Linux, or macOS
You can skip the introduction sections and go directly to Section `Start Application Development`_.
.. _DevKitC-Overview:
Overview
--------
ESP32-DevKitC V4 is a small-sized ESP32-based development board produced by `Espressif <https://espressif.com>`_. Most of the I/O pins are broken out to the pin headers on both sides for easy interfacing. Developers can either connect peripherals with jumper wires or mount ESP32-DevKitC V4 on a breadboard.
To cover a wide range of user requirements, the following versions of ESP32-DevKitC V4 are available:
- different ESP32 modules
- :ref:`esp-modules-and-boards-esp32-wroom-32`
- :ref:`ESP32-WROOM-32D <esp-modules-and-boards-esp32-wroom-32d-and-u>`
- :ref:`ESP32-WROOM-32U <esp-modules-and-boards-esp32-wroom-32d-and-u>`
- :ref:`esp-modules-and-boards-esp32-solo-1`
- :ref:`ESP32-WROVER <esp-modules-and-boards-esp32-wrover>`
- :ref:`ESP32-WROVER-B <esp-modules-and-boards-esp32-wrover>`
- :ref:`ESP32-WROVER-I <esp-modules-and-boards-esp32-wrover>`
- :ref:`ESP32-WROVER-B (IPEX) <esp-modules-and-boards-esp32-wrover>`
- male or female pin headers.
For details please refer to `Espressif Product Ordering Information`_.
Functional Description
----------------------
The following figure and the table below describe the key components, interfaces and controls of the ESP32-DevKitC V4 board.
.. _get-started-esp32-devkitc-board-front:
.. figure:: ../../_static/esp32-devkitc-functional-overview.jpg
:align: center
:alt: ESP32-DevKitC V4 with ESP-WROOM-32 module soldered
:figclass: align-center
ESP32-DevKitC V4 with ESP32-WROOM-32 module soldered
+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Key Component | Description |
+====================+======================================================================================================================================================================================+
| ESP32-WROOM-32 | A module with ESP32 at its core. |
+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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-to-UART Bridge | Single USB-UART bridge chip provides transfer rates of up to 3 Mbps. |
+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Micro USB Port | USB interface. Power supply for the board as well as the communication interface between a computer and the ESP32 module. |
+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 5V Power On LED | Turns on when the USB or an external 5V power supply is connected to the board. For details see the schematics in `Related Documents`_. |
+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| I/O | Most of the pins on the ESP module are broken out to the pin headers on the board. You can program ESP32 to enable multiple functions such as PWM, ADC, DAC, I2C, I2S, SPI, etc. |
+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. note::
The pins D0, D1, D2, D3, CMD and CLK are used internally for communication between ESP32 and SPI flash memory. They are grouped on both sides near the USB connector. Avoid using these pins, as it may disrupt access to the SPI flash memory / SPI RAM.
.. note::
The pins GPIO16 and GPIO17 are available for use only on the boards with the modules ESP32-WROOM and ESP32-SOLO-1. The boards with ESP32-WROVER modules have the pins reserved for internal use.
Power Supply Options
--------------------
There are three mutually exclusive ways to provide power to the board:
* Micro USB port, default power supply
* 5V / GND header pins
* 3V3 / GND header pins
.. warning::
The power supply must be provided using **one and only one of the options above**, otherwise the board and/or the power supply source can be damaged.
Note on C15
-----------
The component C15 may cause the following issues on earlier ESP32-DevKitC V4 boards:
* The board may boot into Download mode
* If you output clock on GPIO0, C15 may impact the signal
In case these issues occur, please remove the component. The figure below shows C15 highlighted in yellow.
.. figure:: ../../_static/esp32-devkitc-c15-location.png
:align: center
:alt: Location of C15 (colored yellow) on ESP32-DevKitC V4 board
:figclass: align-center
:width: 30%
Location of C15 (yellow) on ESP32-DevKitC V4 board
Start Application Development
------------------------------
Before powering up your ESP32-DevKitC V4, please make sure that the board is in good condition with no obvious signs of damage.
After that, 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.
Board Dimensions
----------------
.. figure:: ../../_static/esp32-devkitc-dimensions-back.jpg
:align: center
:alt: ESP32 DevKitC board dimensions - back
:figclass: align-center
ESP32 DevKitC board dimensions - back
Related Documents
-----------------
* `ESP32-DevKitC V4 schematics <https://dl.espressif.com/dl/schematics/esp32_devkitc_v4-sch.pdf>`_ (PDF)
* `ESP32 Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf>`_ (PDF)
* `ESP32-WROOM-32 Datasheet <https://espressif.com/sites/default/files/documentation/esp32-wroom-32_datasheet_en.pdf>`_ (PDF)
* `ESP32-WROOM-32D & ESP32-WROOM-32U Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32-wroom-32d_esp32-wroom-32u_datasheet_en.pdf>`_ (PDF)
* `ESP32-WROVER Datasheet <https://espressif.com/sites/default/files/documentation/esp32-wrover_datasheet_en.pdf>`_ (PDF)
* `ESP32-WROVER-B Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32-wrover-b_datasheet_en.pdf>`_ (PDF)
* `Espressif Product Ordering Information <https://www.espressif.com/sites/default/files/documentation/espressif_products_ordering_information_en.pdf>`_ (PDF)
.. toctree::
:hidden:
get-started-devkitc-v2

77
docs/en/get-started/get-started-pico-kit-v3.rst
View file

@ -1,77 +0,0 @@
ESP32-PICO-KIT V3 Getting Started Guide
=======================================
:link_to_translation:`zh_CN:[中文]`
This guide shows how to get started with the ESP32-PICO-KIT V3 mini development board. For the description of other ESP32-PICO-KIT versions, please check :doc:`../hw-reference/index`.
What You Need
-------------
* ESP32-PICO-KIT V3 mini development 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
--------
ESP32-PICO-KIT V3 is an ESP32-based mini development board produced by `Espressif <https://espressif.com>`_. The core of this board is ESP32-PICO-D4 - a System-in-Package (SiP) module.
The development board features a USB-UART Bridge circuit, which allows developers to connect the board to a computer's USB port for flashing and debugging.
All the IO signals and system power on ESP32-PICO-D4 are led out to two rows of 20 x 0.1" header pads on both sides of the development board for easy access.
Functional Description
----------------------
The following figure and the table below describe the key components, interfaces, and controls of the ESP32-PICO-KIT V3 board.
.. figure:: ../../_static/esp32-pico-kit-v3-layout.jpg
:align: center
:alt: ESP32-PICO-KIT V3 board layout
:figclass: align-center
ESP32-PICO-KIT V3 board layout
Below is the description of the items identified in the figure starting from the top left corner and going clockwise.
================== =================================================================================================================================
Key Component Description
================== =================================================================================================================================
ESP32-PICO-D4 Standard ESP32-PICO-D4 module soldered to the ESP32-PICO-KIT V3 board. The complete ESP32 system on a chip (ESP32 SoC) has been integrated into the SiP module, requiring only an external antenna with LC matching network, decoupling capacitors, and a pull-up resistor for EN signals to function properly.
LDO 5V-to-3.3V Low dropout voltage regulator (LDO).
USB-UART bridge Single-chip USB-UART bridge provides up to 1 Mbps transfers rates.
Micro USB Port USB interface. Power supply for the board as well as the communication interface between a computer and the board.
Power On LED This red LED turns on when power is supplied to the board.
I/O All the pins on ESP32-PICO-D4 are broken out to pin headers. You can program ESP32 to enable multiple functions, such as PWM, ADC, DAC, I2C, I2S, SPI, etc.
BOOT Button Download button. Holding down **Boot** and then pressing **EN** initiates Firmware Download mode for downloading firmware through the serial port.
EN Button Reset button.
================== =================================================================================================================================
Start Application Development
-----------------------------
Before powering up your ESP32-PICO-KIT V3, please make sure that the board is in good condition with no obvious signs of damage.
After that, 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
-----------------
* `ESP32-PICO-KIT V3 schematic <https://dl.espressif.com/dl/schematics/esp32-pico-kit-v3_schematic.pdf>`_ (PDF)
* `ESP32-PICO-D4 Datasheet <http://espressif.com/sites/default/files/documentation/esp32-pico-d4_datasheet_en.pdf>`_ (PDF)
* :doc:`../hw-reference/index`

234
docs/en/get-started/get-started-pico-kit.rst
View file

@ -1,234 +0,0 @@
ESP32-PICO-KIT V4 / V4.1 Getting Started Guide
==============================================
:link_to_translation:`zh_CN:[中文]`
This guide shows how to get started with the ESP32-PICO-KIT V4 / V4.1 mini development board. For the description of other ESP32-PICO-KIT versions, please check :doc:`../hw-reference/index`.
This particular description covers ESP32-PICO-KIT V4 and V4.1. The difference is the upgraded USB-UART bridge from CP2102 in V4 with up to 1 Mbps transfer rates to CP2102N in V4.1 with up to 3 Mbps transfer rates.
What You Need
-------------
* :ref:`ESP32-PICO-KIT mini development board <get-started-pico-kit-v4-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
--------
ESP32-PICO-KIT is an ESP32-based mini development board produced by `Espressif <https://espressif.com>`_.
The core of this board is ESP32-PICO-D4 - a System-in-Package (SiP) module with complete Wi-Fi and Bluetooth functionalities. Compared to other ESP32 modules, ESP32-PICO-D4 integrates the following peripheral components in one single package, which otherwise would need to be installed separately:
- 40 MHz crystal oscillator
- 4 MB flash
- Filter capacitors
- RF matching links
This setup reduces the costs of additional external components as well as the cost of assembly and testing and also increases the overall usability of the product.
The development board features a USB-UART Bridge circuit which allows developers to connect the board to a computer's USB port for flashing and debugging.
All the IO signals and system power on ESP32-PICO-D4 are led out to two rows of 20 x 0.1" header pads on both sides of the development board for easy access. For compatibility with Dupont wires, 2 x 17 header pads are populated with two rows of male pin headers. The remaining 2 x 3 header pads beside the antenna are not populated. These pads may be populated later by the user if required.
.. note::
1. The 2 x 3 pads not populated with pin headers are connected to the flash memory embedded in the ESP32-PICO-D4 SiP module. For more details see module's datasheet in `Related Documents`_.
2. ESP32-PICO-KIT comes with male headers by default.
Functionality Overview
----------------------
The block diagram below shows the main components of ESP32-PICO-KIT and their interconnections.
.. figure:: ../../_static/esp32-pico-kit-v4-functional-block-diagram.png
:align: center
:alt: ESP32-PICO-KIT functional block diagram
:figclass: align-center
ESP32-PICO-KIT block diagram
Functional Description
----------------------
The following figure and the table below describe the key components, interfaces, and controls of the ESP32-PICO-KIT board.
.. _get-started-pico-kit-v4-board-front:
.. figure:: ../../_static/esp32-pico-kit-v4.1-f-layout.jpeg
:align: center
:alt: ESP32-PICO-KIT board layout
:figclass: align-center
ESP32-PICO-KIT board layout
Below is the description of the items identified in the figure starting from the top left corner and going clockwise.
================== =================================================================================================================================
Key Component Description
================== =================================================================================================================================
ESP32-PICO-D4 Standard ESP32-PICO-D4 module soldered to the ESP32-PICO-KIT board. The complete ESP32 system on a chip (ESP32 SoC) has been integrated into the SiP module, requiring only an external antenna with LC matching network, decoupling capacitors, and a pull-up resistor for EN signals to function properly.
LDO 5V-to-3.3V Low dropout voltage regulator (LDO).
USB-UART bridge Single-chip USB-UART bridge: CP2102 in V4 provides up to 1 Mbps transfer rates and CP2102N in V4.1 offers up to 3 Mbps transfers rates.
Micro USB Port USB interface. Power supply for the board as well as the communication interface between a computer and the board.
5V Power On LED This red LED turns on when power is supplied to the board. For details, see the schematics in `Related Documents`_.
I/O All the pins on ESP32-PICO-D4 are broken out to pin headers. You can program ESP32 to enable multiple functions, such as PWM, ADC, DAC, I2C, I2S, SPI, etc. For details, please see Section `Pin Descriptions`_.
BOOT Button Download button. Holding down **Boot** and then pressing **EN** initiates Firmware Download mode for downloading firmware through the serial port.
EN Button Reset button.
================== =================================================================================================================================
Power Supply Options
--------------------
There are three mutually exclusive ways to provide power to the board:
* Micro USB port, default power supply
* 5V / GND header pins
* 3V3 / GND header pins
.. warning::
The power supply must be provided using **one and only one of the options above**, otherwise the board and/or the power supply source can be damaged.
Pin Descriptions
----------------
The two tables below provide the **Name** and **Function** of I/O header pins on both sides of the board, see :ref:`get-started-pico-kit-v4-board-front`. The pin numbering and header names are the same as in the schematic given in `Related Documents`_.
Header J2
"""""""""
====== ================= ====== ======================================================
No. Name Type Function
====== ================= ====== ======================================================
1 FLASH_SD1 (FSD1) I/O | GPIO8, SD_DATA1, SPID, HS1_DATA1 :ref:`(See 1) <get-started-pico-kit-v4-pin-notes>` , U2CTS
2 FLASH_SD3 (FSD3) I/O | GPIO7, SD_DATA0, SPIQ, HS1_DATA0 :ref:`(See 1) <get-started-pico-kit-v4-pin-notes>` , U2RTS
3 FLASH_CLK (FCLK) I/O | GPIO6, SD_CLK, SPICLK, HS1_CLK :ref:`(See 1) <get-started-pico-kit-v4-pin-notes>` , U1CTS
4 IO21 I/O | GPIO21, VSPIHD, EMAC_TX_EN
5 IO22 I/O | GPIO22, VSPIWP, U0RTS, EMAC_TXD1
6 IO19 I/O | GPIO19, VSPIQ, U0CTS, EMAC_TXD0
7 IO23 I/O | GPIO23, VSPID, HS1_STROBE
8 IO18 I/O | GPIO18, VSPICLK, HS1_DATA7
9 IO5 I/O | GPIO5, VSPICS0, HS1_DATA6, EMAC_RX_CLK
10 IO10 I/O | GPIO10, SD_DATA3, SPIWP, HS1_DATA3, U1TXD
11 IO9 I/O | GPIO9, SD_DATA2, SPIHD, HS1_DATA2, U1RXD
12 RXD0 I/O | GPIO3, U0RXD :ref:`(See 3) <get-started-pico-kit-v4-pin-notes>` , CLK_OUT2
13 TXD0 I/O | GPIO1, U0TXD :ref:`(See 3) <get-started-pico-kit-v4-pin-notes>` , CLK_OUT3, EMAC_RXD2
14 IO35 I | ADC1_CH7, RTC_GPIO5
15 IO34 I | ADC1_CH6, RTC_GPIO4
16 IO38 I | GPIO38, ADC1_CH2, RTC_GPIO2
17 IO37 I | GPIO37, ADC1_CH1, RTC_GPIO1
18 EN I | CHIP_PU
19 GND P | Ground
20 VDD33 (3V3) P | 3.3V power supply
====== ================= ====== ======================================================
Header J3
"""""""""
====== ================= ====== ======================================================
No. Name Type Function
====== ================= ====== ======================================================
1 FLASH_CS (FCS) I/O | GPIO16, HS1_DATA4 :ref:`(See 1) <get-started-pico-kit-v4-pin-notes>` , U2RXD, EMAC_CLK_OUT
2 FLASH_SD0 (FSD0) I/O | GPIO17, HS1_DATA5 :ref:`(See 1) <get-started-pico-kit-v4-pin-notes>` , U2TXD, EMAC_CLK_OUT_180
3 FLASH_SD2 (FSD2) I/O | GPIO11, SD_CMD, SPICS0, HS1_CMD :ref:`(See 1) <get-started-pico-kit-v4-pin-notes>` , U1RTS
4 SENSOR_VP (FSVP) I | GPIO36, ADC1_CH0, RTC_GPIO0
5 SENSOR_VN (FSVN) I | GPIO39, ADC1_CH3, RTC_GPIO3
6 IO25 I/O | GPIO25, DAC_1, ADC2_CH8, RTC_GPIO6, EMAC_RXD0
7 IO26 I/O | GPIO26, DAC_2, ADC2_CH9, RTC_GPIO7, EMAC_RXD1
8 IO32 I/O | 32K_XP :ref:`(See 2a) <get-started-pico-kit-v4-pin-notes>` , ADC1_CH4, TOUCH9, RTC_GPIO9
9 IO33 I/O | 32K_XN :ref:`(See 2b) <get-started-pico-kit-v4-pin-notes>` , ADC1_CH5, TOUCH8, RTC_GPIO8
10 IO27 I/O | GPIO27, ADC2_CH7, TOUCH7, RTC_GPIO17
| EMAC_RX_DV
11 IO14 I/O | ADC2_CH6, TOUCH6, RTC_GPIO16, MTMS, HSPICLK,
| HS2_CLK, SD_CLK, EMAC_TXD2
12 IO12 I/O | ADC2_CH5, TOUCH5, RTC_GPIO15, MTDI :ref:`(See 4) <get-started-pico-kit-v4-pin-notes>` , HSPIQ,
| HS2_DATA2, SD_DATA2, EMAC_TXD3
13 IO13 I/O | ADC2_CH4, TOUCH4, RTC_GPIO14, MTCK, HSPID,
| HS2_DATA3, SD_DATA3, EMAC_RX_ER
14 IO15 I/O | ADC2_CH3, TOUCH3, RTC_GPIO13, MTDO, HSPICS0
| HS2_CMD, SD_CMD, EMAC_RXD3
15 IO2 I/O | ADC2_CH2, TOUCH2, RTC_GPIO12, HSPIWP,
| HS2_DATA0, SD_DATA0
16 IO4 I/O | ADC2_CH0, TOUCH0, RTC_GPIO10, HSPIHD,
| HS2_DATA1, SD_DATA1, EMAC_TX_ER
17 IO0 I/O | ADC2_CH1, TOUCH1, RTC_GPIO11, CLK_OUT1
| EMAC_TX_CLK
18 VDD33 (3V3) P | 3.3V power supply
19 GND P | Ground
20 EXT_5V (5V) P | 5V power supply
====== ================= ====== ======================================================
.. _get-started-pico-kit-v4-pin-notes:
The following notes give more information about the items in the tables above.
1. This pin is connected to the flash pin of ESP32-PICO-D4.
2. 32.768 kHz crystal oscillator:
a) input
b) output
3. This pin is connected to the pin of the USB bridge chip on the board.
4. The operating voltage of ESP32-PICO-KIT’s embedded SPI flash is 3.3V. Therefore, the strapping pin MTDI should hold bit zero during the module power-on reset. If connected, please make sure that this pin is not held up on reset.
Start Application Development
-----------------------------
Before powering up your ESP32-PICO-KIT, please make sure that the board is in good condition with no obvious signs of damage.
After that, 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.
Board Dimensions
----------------
The dimensions are 52 x 20.3 x 10 mm (2.1" x 0.8" x 0.4").
.. figure:: ../../_static/esp32-pico-kit-v4.1-dimensions-back.jpg
:align: center
:alt: ESP32-PICO-KIT dimensions - back
:figclass: align-center
ESP32-PICO-KIT dimensions - back
.. figure:: ../../_static/esp32-pico-kit-v4-dimensions-side.jpg
:align: center
:alt: ESP32-PICO-KIT V4 dimensions - side
:figclass: align-center
ESP32-PICO-KIT dimensions - side
For the board physical construction details, please refer to its Reference Design listed below.
Related Documents
-----------------
* `ESP32-PICO-KIT V4 schematic <https://dl.espressif.com/dl/schematics/esp32-pico-kit-v4_schematic.pdf>`_ (PDF)
* `ESP32-PICO-KIT V4.1 schematic <https://dl.espressif.com/dl/schematics/esp32-pico-kit-v4.1_schematic.pdf>`_ (PDF)
* `ESP32-PICO-KIT Reference Design <https://www.espressif.com/en/support/download/documents?keys=ESP32-PICO-KIT+Reference+Design>`_ containing OrCAD schematic, PCB layout, gerbers and BOM
* `ESP32-PICO-D4 Datasheet <http://espressif.com/sites/default/files/documentation/esp32-pico-d4_datasheet_en.pdf>`_ (PDF)
* :doc:`../hw-reference/index`
.. toctree::
:hidden:
get-started-pico-kit-v3

195
docs/en/get-started/get-started-wrover-kit-v2.rst
View file

@ -1,195 +0,0 @@
ESP-WROVER-KIT V2 Getting Started Guide
=======================================
:link_to_translation:`zh_CN:[中文]`
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
-------------
* ESP-WROVER-KIT V2 board
* USB 2.0 cable（A to Micro-B）
* 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-v2-board-front:
.. figure:: ../../_static/esp-wrover-kit-v2-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-v2-board-back:
.. figure:: ../../_static/esp-wrover-kit-v2-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
================== =================================================================================================================================
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.
MicroSD Card MicroSD 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 MicroSD 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 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 MicroSD 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
======= ================ =========================================================
.. _get-started-esp-wrover-kit-v2-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 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` will quickly help you set up the development environment and then flash an example project onto your board.
Related Documents
-----------------
* `ESP-WROVER-KIT V2 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`
.. |jp1-sd_io2| image:: ../../_static/wrover-jp1-sd_io2.png
.. |jp1-both| image:: ../../_static/wrover-jp1-both.png
.. |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-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

381
docs/en/get-started/get-started-wrover-kit-v3.rst
View file

@ -1,381 +0,0 @@
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 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>`
* USB 2.0 cable（A to Micro-B）
* 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:
.. 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:
.. 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.
MicroSD Card Slot Useful for developing applications that access MicroSD 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 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>`
* 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 - only in case ESP32-WROVER is installed
.. _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 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:
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 desolder 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
^^^^^^^^^^^^
==== ============== ===============
. 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 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` 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

385
docs/en/get-started/get-started-wrover-kit.rst
View file

@ -1,385 +0,0 @@
ESP-WROVER-KIT V4.1 Getting Started Guide
=========================================
: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>`
* USB 2.0 cable（A to Micro-B）
* 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:
.. 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:
.. 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-B 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.
MicroSD Card Slot Useful for developing applications that access MicroSD 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 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>`
* 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-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-B's PSRAM
.. _get-started-esp-wrover-kit-v4.1-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 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:
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:
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:
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:
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:
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:
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 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

6
docs/en/get-started/index.rst
View file

@ -57,9 +57,9 @@ If you have one of ESP32 development boards listed below, you can click on the l
.. toctree::
:maxdepth: 1
ESP32-DevKitC <get-started-devkitc>
ESP-WROVER-KIT <get-started-wrover-kit>
ESP32-PICO-KIT <get-started-pico-kit>
ESP32-DevKitC <../hw-reference/get-started-devkitc>
ESP-WROVER-KIT <../hw-reference/get-started-wrover-kit>
ESP32-PICO-KIT <../hw-reference/get-started-pico-kit>
ESP32-Ethernet-Kit <../hw-reference/get-started-ethernet-kit>

6
docs/en/get-started-cmake/get-started-devkitc-v2.rst → docs/en/hw-reference/get-started-devkitc-v2.rst
View file

@ -1,4 +1,4 @@
ESP32-DevKitC V2 Getting Started Guide (CMake)
ESP32-DevKitC V2 Getting Started Guide
==============================================
:link_to_translation:`zh_CN:[中文]`
@ -71,7 +71,9 @@ Start Application Development
Before powering up your ESP32-DevKitC V2, please make sure that the board is in good condition with no obvious signs of damage.
After that, 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.
After that, proceed to :doc:`../get-started-cmake/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.
If you prefer using an older GNU Make build system, then proceed to respective :ref:`get-started-step-by-step` for the GNU Make.
Related Documents

6
docs/en/get-started-cmake/get-started-devkitc.rst → docs/en/hw-reference/get-started-devkitc.rst
View file

@ -1,4 +1,4 @@
ESP32-DevKitC V4 Getting Started Guide (CMake)
ESP32-DevKitC V4 Getting Started Guide
==============================================
:link_to_translation:`zh_CN:[中文]`
@ -121,7 +121,9 @@ Start Application Development
Before powering up your ESP32-DevKitC V4, please make sure that the board is in good condition with no obvious signs of damage.
After that, 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.
After that, proceed to :doc:`../get-started-cmake/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.
If you prefer using an older GNU Make build system, then proceed to respective :ref:`get-started-step-by-step` for the GNU Make.
Board Dimensions

6
docs/en/get-started-cmake/get-started-pico-kit-v3.rst → docs/en/hw-reference/get-started-pico-kit-v3.rst
View file

@ -1,4 +1,4 @@
ESP32-PICO-KIT V3 Getting Started Guide (CMake)
ESP32-PICO-KIT V3 Getting Started Guide
===============================================
:link_to_translation:`zh_CN:[中文]`
@ -65,7 +65,9 @@ Start Application Development
Before powering up your ESP32-PICO-KIT V3, please make sure that the board is in good condition with no obvious signs of damage.
After that, 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.
After that, proceed to :doc:`../get-started-cmake/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.
If you prefer using an older GNU Make build system, then proceed to respective :ref:`get-started-step-by-step` for the GNU Make.
Related Documents

4
docs/en/get-started-cmake/get-started-pico-kit.rst → docs/en/hw-reference/get-started-pico-kit.rst
View file

@ -193,7 +193,9 @@ Start Application Development
Before powering up your ESP32-PICO-KIT, please make sure that the board is in good condition with no obvious signs of damage.
After that, 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.
After that, proceed to :doc:`../get-started-cmake/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.
If you prefer using an older GNU Make build system, then proceed to respective :ref:`get-started-step-by-step` for the GNU Make.
Board Dimensions

6
docs/en/get-started-cmake/get-started-wrover-kit-v2.rst → docs/en/hw-reference/get-started-wrover-kit-v2.rst
View file

@ -1,4 +1,4 @@
ESP-WROVER-KIT V2 Getting Started Guide (CMake)
ESP-WROVER-KIT V2 Getting Started Guide
===============================================
:link_to_translation:`zh_CN:[中文]`
@ -170,7 +170,9 @@ 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.
Proceed to :doc:`../get-started-cmake/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.
If you prefer using an older GNU Make build system, then proceed to respective :ref:`get-started-step-by-step` for the GNU Make.
Related Documents

6
docs/en/get-started-cmake/get-started-wrover-kit-v3.rst → docs/en/hw-reference/get-started-wrover-kit-v3.rst
View file

@ -1,4 +1,4 @@
ESP-WROVER-KIT V3 Getting Started Guide (CMake)
ESP-WROVER-KIT V3 Getting Started Guide
===============================================
:link_to_translation:`zh_CN:[中文]`
@ -353,7 +353,9 @@ 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.
Proceed to :doc:`../get-started-cmake/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.
If you prefer using an older GNU Make build system, then proceed to respective :ref:`get-started-step-by-step` for the GNU Make.
Related Documents

6
docs/en/get-started-cmake/get-started-wrover-kit.rst → docs/en/hw-reference/get-started-wrover-kit.rst
View file

@ -1,4 +1,4 @@
ESP-WROVER-KIT V4.1 Getting Started Guide (CMake)
ESP-WROVER-KIT V4.1 Getting Started Guide
=================================================
:link_to_translation:`zh_CN:[中文]`
@ -358,7 +358,9 @@ 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.
Proceed to :doc:`../get-started-cmake/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.
If you prefer using an older GNU Make build system, then proceed to respective :ref:`get-started-step-by-step` for the GNU Make.
Related Documents

10
docs/en/hw-reference/modules-and-boards-previous.rst
View file

@ -27,7 +27,7 @@ Comparing to ESP32-PICO-KIT V3, this version has revised printout and reduced nu
Documentation
-------------
* :doc:`../get-started/get-started-pico-kit`
* :doc:`../hw-reference/get-started-pico-kit`
* `ESP32-PICO-KIT V4 Schematic <https://dl.espressif.com/dl/schematics/esp32-pico-kit-v4_schematic.pdf>`_ (PDF)
* `ESP32-PICO-D4 Datasheet <http://espressif.com/sites/default/files/documentation/esp32-pico-d4_datasheet_en.pdf>`_ (PDF)
@ -48,7 +48,7 @@ The first public release of Espressif's ESP32-PICO-D4 module on a mini developme
Documentation
-------------
* :doc:`../get-started/get-started-pico-kit-v3`
* :doc:`../hw-reference/get-started-pico-kit-v3`
* `ESP32-PICO-KIT V3 Schematic <https://dl.espressif.com/dl/schematics/esp32-pico-kit-v3_schematic.pdf>`_ (PDF)
* `ESP32-PICO-D4 Datasheet <http://espressif.com/sites/default/files/documentation/esp32-pico-d4_datasheet_en.pdf>`_ (PDF)
@ -70,7 +70,7 @@ Small and convenient development board with ESP-WROOM-32 module installed, break
Documentation
-------------
* :doc:`../get-started/get-started-devkitc-v2`
* :doc:`../hw-reference/get-started-devkitc-v2`
* `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>`_
@ -97,7 +97,7 @@ The camera header has been changed from male back to female. The board soldermas
Documentation
-------------
* :doc:`../get-started/get-started-wrover-kit-v3`
* :doc:`../hw-reference/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`_
@ -121,7 +121,7 @@ Comparing to previous version, this board has a shiny black finish and a male ca
Documentation
-------------
* :doc:`../get-started/get-started-wrover-kit-v2`
* :doc:`../hw-reference/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`_

6
docs/en/hw-reference/modules-and-boards.rst
View file

@ -202,7 +202,7 @@ Comparing to ESP32-PICO-KIT V4, this version features the CP2102N USB-UART bridg
Documentation
^^^^^^^^^^^^^
* :doc:`../get-started-cmake/get-started-pico-kit`
* :doc:`../hw-reference/get-started-pico-kit`
* `ESP32-PICO-KIT V4.1 Schematic <https://dl.espressif.com/dl/schematics/esp32-pico-kit-v4.1_schematic.pdf>`_ (PDF)
* `ESP32-PICO-KIT Reference Design <https://www.espressif.com/en/support/download/documents?keys=ESP32-PICO-KIT+Reference+Design>`_ containing OrCAD schematic, PCB layout, gerber and BOM files
* `ESP32-PICO-D4 Datasheet <http://espressif.com/sites/default/files/documentation/esp32-pico-d4_datasheet_en.pdf>`_ (PDF)
@ -239,7 +239,7 @@ Comparing to the previous :ref:`esp-modules-and-boards-esp32-devkitc-v2`, this v
Documentation
^^^^^^^^^^^^^
* :doc:`../get-started-cmake/get-started-devkitc`
* :doc:`../hw-reference/get-started-devkitc`
* `ESP32-DevKitC schematic <https://dl.espressif.com/dl/schematics/esp32_devkitc_v4-sch-20180607a.pdf>`_ (PDF)
* `ESP32-DevKitC Reference Design <https://www.espressif.com/en/support/download/documents?keys=ESP32-DevKitC-V4+Reference+Design>`_ containing OrCAD schematic, PCB layout, gerber and BOM files
* `CP210x USB to UART Bridge VCP Drivers <https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers>`_
@ -288,7 +288,7 @@ The board in the picture above integrates the ESP32-WROVER-B module.
Documentation
^^^^^^^^^^^^^
* :doc:`../get-started-cmake/get-started-wrover-kit`
* :doc:`../hw-reference/get-started-wrover-kit`
* `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`_

2
docs/zh_CN/api-guides/jtag-debugging/configure-wrover.rst
View file

@ -8,7 +8,7 @@
配置硬件
^^^^^^^^
1. 根据 :doc:`../../get-started/get-started-wrover-kit` 文档中 :ref:`get-started-esp-wrover-kit-v4.1-setup-options` 章节所描述的信息，设置 JP8 便可以启用 JTAG 功能。
1. 根据 :doc:`../../hw-reference/get-started-wrover-kit` 文档中 :ref:`get-started-esp-wrover-kit-v4.1-setup-options-cmake` 章节所描述的信息，设置 JP8 便可以启用 JTAG 功能。
2. 检查 ESP32 上用于 JTAG 通信的引脚是否被接到了其它硬件上，这可能会影响 JTAG 的工作。

6
docs/zh_CN/get-started-cmake/index.rst
View file

@ -62,9 +62,9 @@ ESP32 采用 40 nm 工艺制成，具有最佳的功耗性能、射频性能、
.. toctree::
:maxdepth: 1
ESP32-DevKitC <get-started-devkitc>
ESP-WROVER-KIT <get-started-wrover-kit>
ESP32-PICO-KIT <get-started-pico-kit>
ESP32-DevKitC <../hw-reference/get-started-devkitc>
ESP-WROVER-KIT <../hw-reference/get-started-wrover-kit>
ESP32-PICO-KIT <../hw-reference/get-started-pico-kit>
ESP32-Ethernet-Kit <../hw-reference/get-started-ethernet-kit>

81
docs/zh_CN/get-started/get-started-devkitc-v2.rst
View file

@ -1,81 +0,0 @@
ESP32-DevKitC V2 入门指南
=========================================
:link_to_translation:`en: [English]`
本指南介绍了如何开始使用 ESP32-DevKitC V2 开发板。
准备工作
-------------
* ESP32-DevKitC V2 开发板
* USB A / micro USB B 数据线
* PC（Windows、Linux 或 Mac OS）
您可以跳过介绍部分，直接前往 `应用程序开发`_ 章节。
概述
--------
ESP32-DevKitC V2 是 `乐鑫 <https://espressif.com>`_ 一款基于 ESP32 的小型开发板，板上模组的绝大部分管脚均已引出，开发人员可根据实际需求，轻松通过跳线连接多种外围器件，或将开发板插在面包板上使用。
功能说明
----------------------
ESP32-DevKitC V2 开发板的主要组件、接口及控制方式见下。
.. _get-started-esp32-devkitc-v2-board-front-make:
.. figure:: ../../_static/esp32-devkitc-v2-functional-overview.png
:align: center
:alt: ESP32-DevKitC V2 开发板
:figclass: align-center
ESP32-DevKitC V2 开发板
+----------------+--------------------------------------------------------------------------------------------------------------------------+
| 主要组件 | 基本介绍 |
+----------------+--------------------------------------------------------------------------------------------------------------------------+
| ESP32-WROOM-32 | 基于 ESP32 的模组。更多详情，请见 `《ESP32-WROOM-32 技术规格书》`_。 |
+----------------+--------------------------------------------------------------------------------------------------------------------------+
| EN | 复位按键。 |
+----------------+--------------------------------------------------------------------------------------------------------------------------+
| Boot | 下载按键。按下 **Boot** 键并保持，同时按一下 **EN** 键（此时不要松开 **Boot** 键）进入“固件下载”模式，通过串口下载固件。 |
+----------------+--------------------------------------------------------------------------------------------------------------------------+
| Micro USB 端口 | USB 接口。可用作电路板的供电电源，或连接 PC 和 ESP32-WROOM-32 模组的通信接口。 |
+----------------+--------------------------------------------------------------------------------------------------------------------------+
| I/O | 板上模组的绝大部分管脚均已引出至开发板的排针。用户可以对 ESP32 进行编程，实现 PWM、ADC、DAC、I2C、I2S、SPI 等多种功能。 |
+----------------+--------------------------------------------------------------------------------------------------------------------------+
电源选项
--------------------
开发板可任一选用以下三种供电方式：
* Micro USB 供电（默认）
* 5V / GND 管脚供电
* 3V3 / GND 管脚供电
.. warning::
上述供电模式 **不可同时连接**，否则可能会损坏开发板和/或电源。
应用程序开发
------------------------------
ESP32-DevKitC V2 上电前，请首先确认开发板完好无损。
之后，请前往 :doc:`index` 的 :ref:`get-started-step-by-step` 章节，查看如何设置开发环境，并尝试将示例项目烧录至您的开发板。
相关文档
-----------------
* `ESP32-DevKitC 原理图 <https://dl.espressif.com/dl/schematics/ESP32-Core-Board-V2_sch.pdf>`_ (PDF)
* `《ESP32 技术规格书》 <https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf>`_ (PDF)
* `《ESP32-WROOM-32 技术规格书》 <https://espressif.com/sites/default/files/documentation/esp32-wroom-32_datasheet_cn.pdf>`_ (PDF)

153
docs/zh_CN/get-started/get-started-devkitc.rst
View file

@ -1,153 +0,0 @@
ESP32-DevKitC V4 入门指南
===========================
:link_to_translation:`en: [English]`
本指南介绍了如何开始使用 ESP32-DevKitC V4 开发板。有关 ESP32-DevKitC 其他版本的介绍，请见：:doc:`../hw-reference/index`。
准备工作
--------
* ESP32-DevKitC V4 开发板
* USB A / micro USB B 数据线
* PC（Windows、Linux 或 Mac OS）
您可以跳过介绍部分，直接前往 `应用程序开发`_ 章节。
.. _DevKitC-Overview:
概述
----
ESP32-DevKitC V4 是 `乐鑫 <https://espressif.com>`_ 一款基于 ESP32 的小型开发板，板上模组的绝大部分管脚均已引出，开发人员可根据实际需求，轻松通过跳线连接多种外围器件，或将开发板插在面包板上使用。
为了更好地满足不同用户需求，ESP32-DevKitC V4 还支持以下不同配置：
- 可选多款 ESP32 模组
- :ref:`esp-modules-and-boards-esp32-wroom-32`
- :ref:`ESP32-WROOM-32D <esp-modules-and-boards-esp32-wroom-32d-and-u>`
- :ref:`ESP32-WROOM-32U <esp-modules-and-boards-esp32-wroom-32d-and-u>`
- :ref:`esp-modules-and-boards-esp32-solo-1`
- :ref:`ESP32-WROVER <esp-modules-and-boards-esp32-wrover>`
- :ref:`ESP32-WROVER-B <esp-modules-and-boards-esp32-wrover>`
- :ref:`ESP32-WROVER-I <esp-modules-and-boards-esp32-wrover>`
- :ref:`ESP32-WROVER-I (IPEX) <esp-modules-and-boards-esp32-wrover>`
- 可选排针或排母
详情请见 `《乐鑫产品订购信息》 <https://www.espressif.com/sites/default/files/documentation/espressif_products_ordering_information_cn.pdf>`_。
功能说明
--------
ESP32-DevKitC V4 开发板的主要组件、接口及控制方式见下。
.. _get-started-esp32-devkitc-board-front:
.. figure:: ../../_static/esp32-devkitc-functional-overview.jpg
:align: center
:alt: ESP32-DevKitC V4（板载 ESP32-WROOM-32）
:figclass: align-center
ESP32-DevKitC V4（板载 ESP32-WROOM-32）
+--------------------+--------------------------------------------------------------------------------------------------------------------------+
| 主要组件 | 基本介绍 |
+--------------------+--------------------------------------------------------------------------------------------------------------------------+
| ESP32-WROOM-32 | 基于 ESP32 的模组。更多详情，请见 `《ESP32-WROOM-32 技术规格书》`_。 |
+--------------------+--------------------------------------------------------------------------------------------------------------------------+
| EN | 复位按键。 |
+--------------------+--------------------------------------------------------------------------------------------------------------------------+
| Boot | 下载按键。按下 **Boot** 键并保持，同时按一下 **EN** 键（此时不要松开 **Boot** 键）进入“固件下载”模式，通过串口下载固件。 |
+--------------------+--------------------------------------------------------------------------------------------------------------------------+
| USB-to-UART 桥接器 | 单芯片 USB-UART 桥接器，可提供高达 3 Mbps 的传输速率。 |
+--------------------+--------------------------------------------------------------------------------------------------------------------------+
| Micro USB 端口 | USB 接口。可用作电路板的供电电源，或连接 PC 和 ESP32-WROOM-32 模组的通信接口。 |
+--------------------+--------------------------------------------------------------------------------------------------------------------------+
| 5V Power On LED | 开发板通电后（USB 或外部 5 V），该指示灯将亮起。更多信息，请见 `相关文档`_ 中的原理图。 |
+--------------------+--------------------------------------------------------------------------------------------------------------------------+
| I/O | 板上模组的绝大部分管脚均已引出至开发板的排针。用户可以对 ESP32 进行编程，实现 PWM、ADC、DAC、I2C、I2S、SPI 等多种功能。 |
+--------------------+--------------------------------------------------------------------------------------------------------------------------+
.. note::
管脚 D0、D1、D2、D3、CMD 和 CLK 用于 ESP32 芯片与 SPI flash 间的内部通信，集中分布在开发板两侧靠近 USB 端口的位置。通常而言，这些管脚最好不连，否则可能影响 SPI flash / SPI RAM 的工作。
.. note::
管脚 GPIO16 和 GPIO17 仅适用于板载 ESP32-WROOM 系列和 ESP32-SOLO-1 的开发板，保留内部使用。
电源选项
--------
开发板可任一选用以下三种供电方式：
* Micro USB 供电（默认）
* 5V / GND 管脚供电
* 3V3 / GND 管脚供电
.. warning::
上述供电模式 **不可同时连接**，否则可能会损坏开发板和/或电源。
有关 C15 的提示
-----------------
较早版本 ESP32-DevKitC 开发板上的 C15 可能存在以下问题：
* 开发板上电后可能进入下载模式；
* 如果用户通过 GPIO0 输出时钟，C15 可能会影响信号。
用户如果认为 C15 可能影响开发板的使用，则可以将 C15 完全移除。C15 在开发板上的具体位置见下图黄色部分。
.. figure:: ../../_static/esp32-devkitc-c15-location.png
:align: center
:alt: C15（黄色）在 ESP32-DevKitC V4 开发板上的位置
:figclass: align-center
:width: 30%
C15（黄色）在 ESP32-DevKitC V4 开发板上的位置
应用程序开发
------------
ESP32-DevKitC V4 上电前，请首先确认开发板完好无损。
之后，请前往 :doc:`index` 的 :ref:`get-started-step-by-step` 章节，查看如何设置开发环境，并尝试将示例项目烧录至您的开发板。
开发板尺寸
-----------
.. figure:: ../../_static/esp32-devkitc-dimensions-back.jpg
:align: center
:alt: ESP32-DevKitC 开发板尺寸 -- 仰视图
:figclass: align-center
ESP32-DevKitC 开发板尺寸 -- 仰视图
相关文档
--------
* `ESP32-DevKitC V4 原理图 <https://dl.espressif.com/dl/schematics/esp32_devkitc_v4-sch.pdf>`_ (PDF)
* `《ESP32 技术规格书》 <https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf>`_ (PDF)
* `《ESP32-WROOM-32 技术规格书》 <https://espressif.com/sites/default/files/documentation/esp32-wroom-32_datasheet_cn.pdf>`_ (PDF)
* `《ESP32-WROOM-32D & ESP32-WROOM-32U 技术规格书》 <https://www.espressif.com/sites/default/files/documentation/esp32-wroom-32d_esp32-wroom-32u_datasheet_cn.pdf>`_ (PDF)
* `《ESP32-WROVER 技术规格书》 <https://espressif.com/sites/default/files/documentation/esp32_wrover_datasheet_cn.pdf>`_ (PDF)
* `《ESP32-WROVER-B 技术规格书》 <https://www.espressif.com/sites/default/files/documentation/esp32-wrover-b_datasheet_cn.pdf>`_ (PDF)
* `《乐鑫产品订购信息》 <https://www.espressif.com/sites/default/files/documentation/espressif_products_ordering_information_cn.pdf>`_ (PDF)
.. toctree::
:hidden:
get-started-devkitc-v2

78
docs/zh_CN/get-started/get-started-pico-kit-v3.rst
View file

@ -1,78 +0,0 @@
ESP32-PICO-KIT V3 入门指南
=======================================
:link_to_translation:`en:[English]`
本指南介绍了如何开始使用 ESP32-PICO-KIT V3 迷你开发板。有关 ESP32-PICO-KIT 其他版本的介绍，请见：:doc:`../hw-reference/index`。
准备工作
--------
* ESP32-PICO-KIT V3 迷你开发板
* USB 2.0 线（A 型转 Micro-B 型）
* PC（Windows、Linux 或 Mac OS）
您可以跳过介绍部分，直接前往 `应用程序开发`_ 章节。
概述
----
ESP32-PICO-KIT V3 是一款来自 `乐鑫 <https://espressif.com>`_ 的迷你开发板，其核心是具有完整 Wi-Fi 和蓝牙功能的 ESP32 系列 SiP 模组 ESP32-PICO-D4。
ESP32-PICO-KIT 集成了 USB 转 UART 桥接电路，允许开发人员直接通过 PC 的 USB 端口进行下载和调试。
为了便于连接，ESP32-PICO-D4 上的所有 IO 信号和系统电源管脚均通过开发板两侧焊盘（每侧 20 个 x 0.1 英寸间隔）引出。
功能说明
--------
ESP32-PICO-KIT V3 开发板的主要组件、接口及控制方式见下。
.. figure:: ../../_static/esp32-pico-kit-v3-layout.jpg
:align: center
:alt: ESP32-PICO-KIT V3 开发板布局
:figclass: align-center
ESP32-PICO-KIT V3 开发板布局
ESP32-PICO-KIT 开发板的主要组件描述见下表。
================== =======================================================================================================================================================================================================================================================================
主要组件 基本介绍
================== =======================================================================================================================================================================================================================================================================
ESP32-PICO-D4 ESP32-PICO-KIT V3 开发板上焊接的标准 ESP32-PICO-D4 模组，集成了 ESP32 芯片的完整系统，仅需连接天线、LC 匹配电路、退耦电容和一个 EN 信号上拉电阻即可正常工作。
LDO 5V-to-3.3V 低压差稳压器。
USB-to-UART 桥接器 单芯片 USB-to-UART 桥接器，可提供高达 1 Mbps 的传输速率。
Micro USB 端口 USB 接口。可用作开发板的供电电源，或连接 PC 和开发板的通信接口。
Power On LED 开发板通电后，该红色指示灯将亮起。
I/O ESP32-PICO-D4 的所有管脚均已引出至开发板的排针。用户可以对 ESP32 进行编程，实现 PWM、ADC、DAC、I2C、I2S、SPI 等多种功能。
BOOT 下载按键。按下 **Boot** 键并保持，同时按一下 **EN** 键（此时不要松开 **Boot** 键）进入“固件下载”模式，通过串口下载固件。
EN 复位按键。
================== =======================================================================================================================================================================================================================================================================
应用程序开发
------------
ESP32-PICO-KIT V3 上电前，请首先确认开发板完好无损。
之后，请前往 :doc:`index` 中的 :ref:`get-started-step-by-step` 章节，查看如何设置开发环境，并尝试将示例项目烧录至您的开发板。
相关文档
-----------------
* `ESP32-PICO-KIT V3 原理图 <https://dl.espressif.com/dl/schematics/esp32-pico-kit-v3_schematic.pdf>`_ (PDF)
* `《ESP32-PICO-D4 技术规格书》 <http://espressif.com/sites/default/files/documentation/esp32-pico-d4_datasheet_cn.pdf>`_ (PDF)
* :doc:`../hw-reference/index`

235
docs/zh_CN/get-started/get-started-pico-kit.rst
View file

@ -1,235 +0,0 @@
ESP32-PICO-KIT V4/V4.1 入门指南
======================================
:link_to_translation:`en:[English]`
本指南介绍了如何开始使用 ESP32-PICO-KIT V4 / V4.1 迷你开发板。有关 ESP32-PICO-KIT 其他版本的介绍，请见：:doc:`../hw-reference/index`。
本指南仅适用于 ESP32-PICO-KIT V4 和 V4.1。ESP32-PICO-KIT V4.1 与 V4 的最大差别在于桥接器，其中 V4 搭载的 CP2102 USB-to-UART 桥接器最高速率为 1 Mbps，V4.1 搭载的 CP2102N 桥接器最高传输速率 3 Mbps。
准备工作
--------
* :ref:`ESP32-PICO-KIT 迷你开发板 <get-started-pico-kit-v4-board-front>`
* USB 2.0 线（A 型转 Micro-B 型）
* PC（Windows、Linux 或 Mac OS）
您可以跳过介绍部分，直接前往 `应用程序开发`_ 章节。
概述
----
ESP32-PICO-KIT 是一款来自 `乐鑫 <https://espressif.com>`_ 的迷你开发板，其核心是具有完整 Wi-Fi 和蓝牙功能的 ESP32 系列 SiP 模组 ESP32-PICO-D4。与其他 ESP32 系列模组相比，ESP32-PICO-D4 模组已完整集成以下外围器件：
- 40 MHz 晶体振荡器
- 4 MB flash
- 滤波电容
- 射频匹配网络等
这大大降低了用户额外采购和安装这些元器件的数量和成本，及额外组装测试的复杂度，并增加了可用性。
ESP32-PICO-KIT 集成了 USB 转 UART 桥接电路，允许开发人员直接通过 PC 的 USB 端口进行下载和调试。
为了便于连接，ESP32-PICO-D4 上的所有 IO 信号和系统电源管脚均通过开发板两侧焊盘（每侧 20 个 x 0.1 英寸间隔）引出。为了方便杜邦线的使用，ESP32-PICO-KIT 开发板每侧的 20 个焊盘中，有 17 个引出至排针，另外 3 个靠近天线的焊盘未引出，可供用户日后焊接使用。
.. note::
1. 每排未引出至排针的 3 个管脚已连接至 ESP32-PICO-D4 SiP 模组的内置 flash 模块。更多信息，请见 `相关文档`_ 中的模组技术规格书。
2. ESP32-PICO-D4 开发板默认采用排针。
功能概述
--------
ESP32-PICO-KIT 开发板的主要组件和连接方式见下。
.. figure:: ../../_static/esp32-pico-kit-v4-functional-block-diagram.png
:align: center
:alt: ESP32-PICO-KIT 功能框图
:figclass: align-center
ESP32-PICO-KIT 框图
功能说明
--------
ESP32-PICO-KIT 开发板的主要组件、接口及控制方式见下。
.. _get-started-pico-kit-v4-board-front:
.. figure:: ../../_static/esp32-pico-kit-v4.1-f-layout.jpeg
:align: center
:alt: ESP32-PICO-KIT 开发板布局
:figclass: align-center
ESP32-PICO-KIT 开发板布局
ESP32-PICO-KIT 开发板的主要组件描述见下表（从左上角起顺时针顺序）。
================== =============================================================================================================================================
主要组件 基本介绍
================== =============================================================================================================================================
ESP32-PICO-D4 ESP32-PICO-KIT 开发板上焊接的标准 ESP32-PICO-D4 模组，集成了 ESP32 芯片的完整系统，仅需连接天线、LC 匹配电路、退耦电容和一个 EN 信号上拉电阻即可正常工作。
LDO 5V-to-3.3V 低压差稳压器
USB-to-UART 桥接器 单芯片 USB-to-UART 桥接器。V4 版本搭载的 CP2102 可提供高达 1 Mbps 的传输速率，V4.1 版本搭载的 CP2102N 可提供高达 3 Mbps 的传输速率。
Micro USB 端口 USB 接口。可用作开发板的供电电源，或连接 PC 和开发板的通信接口。
5V Power On LED 开发板通电后，该红色指示灯将亮起。更多信息，请见 `相关文档`_ 中的原理图。
I/O ESP32-PICO-D4 的所有管脚均已引出至开发板的排针。用户可以对 ESP32 进行编程，实现 PWM、ADC、DAC、I2C、I2S、SPI 等多种功能。更多详情，请见章节 `管脚说明`_。
BOOT 下载按键。按下 **Boot** 键并保持，同时按一下 **EN** 键（此时不要松开 **Boot** 键）进入“固件下载”模式，通过串口下载固件。
EN 复位按键。
================== =============================================================================================================================================
电源选项
--------
开发板可任一选用以下三种供电方式：
* Micro USB 供电（默认）
* 5V / GND 管脚供电
* 3V3 / GND 管脚供电
.. warning::
上述供电模式 **不可同时连接**，否则可能会损坏开发板和/或电源。
管脚说明
----------
下表介绍了开发板 I/O 管脚的 **名称** 和 **功能**，具体布局请见 `相关文档`_ 中的原理图。请参考 :ref:`get-started-pico-kit-v4-board-front`。
Header J2
"""""""""
====== ================= ====== ======================================================
编号 名称 类型 功能
====== ================= ====== ======================================================
1 FLASH_SD1 (FSD1) I/O | GPIO8, SD_DATA1, SPID, HS1_DATA1 :ref:`（见说明 1） <get-started-pico-kit-v4-pin-notes>` , U2CTS
2 FLASH_SD3 (FSD3) I/O | GPIO7, SD_DATA0, SPIQ, HS1_DATA0 :ref:`（见说明 1） <get-started-pico-kit-v4-pin-notes>` , U2RTS
3 FLASH_CLK (FCLK) I/O | GPIO6, SD_CLK, SPICLK, HS1_CLK :ref:`（见说明 1） <get-started-pico-kit-v4-pin-notes>` , U1CTS
4 IO21 I/O | GPIO21, VSPIHD, EMAC_TX_EN
5 IO22 I/O | GPIO22, VSPIWP, U0RTS, EMAC_TXD1
6 IO19 I/O | GPIO19, VSPIQ, U0CTS, EMAC_TXD0
7 IO23 I/O | GPIO23, VSPID, HS1_STROBE
8 IO18 I/O | GPIO18, VSPICLK, HS1_DATA7
9 IO5 I/O | GPIO5, VSPICS0, HS1_DATA6, EMAC_RX_CLK
10 IO10 I/O | GPIO10, SD_DATA3, SPIWP, HS1_DATA3, U1TXD
11 IO9 I/O | GPIO9, SD_DATA2, SPIHD, HS1_DATA2, U1RXD
12 RXD0 I/O | GPIO3, U0RXD :ref:`（见说明 3） <get-started-pico-kit-v4-pin-notes>` , CLK_OUT2
13 TXD0 I/O | GPIO1, U0TXD :ref:`（见说明 3） <get-started-pico-kit-v4-pin-notes>` , CLK_OUT3, EMAC_RXD2
14 IO35 I | ADC1_CH7, RTC_GPIO5
15 IO34 I | ADC1_CH6, RTC_GPIO4
16 IO38 I | GPIO38, ADC1_CH2, RTC_GPIO2
17 IO37 I | GPIO37, ADC1_CH1, RTC_GPIO1
18 EN I | CHIP_PU
19 GND P | Ground
20 VDD33 (3V3) P | 3.3V 电源
====== ================= ====== ======================================================
Header J3
"""""""""
====== ================= ====== ======================================================
编号 名称 类型 功能
====== ================= ====== ======================================================
1 FLASH_CS (FCS) I/O | GPIO16, HS1_DATA4 :ref:`（见说明 1） <get-started-pico-kit-v4-pin-notes>` , U2RXD, EMAC_CLK_OUT
2 FLASH_SD0 (FSD0) I/O | GPIO17, HS1_DATA5 :ref:`（见说明 1） <get-started-pico-kit-v4-pin-notes>` , U2TXD, EMAC_CLK_OUT_180
3 FLASH_SD2 (FSD2) I/O | GPIO11, SD_CMD, SPICS0, HS1_CMD :ref:`（见说明 1） <get-started-pico-kit-v4-pin-notes>` , U1RTS
4 SENSOR_VP (FSVP) I | GPIO36, ADC1_CH0, RTC_GPIO0
5 SENSOR_VN (FSVN) I | GPIO39, ADC1_CH3, RTC_GPIO3
6 IO25 I/O | GPIO25, DAC_1, ADC2_CH8, RTC_GPIO6, EMAC_RXD0
7 IO26 I/O | GPIO26, DAC_2, ADC2_CH9, RTC_GPIO7, EMAC_RXD1
8 IO32 I/O | 32K_XP :ref:`（见说明 2a） <get-started-pico-kit-v4-pin-notes>` , ADC1_CH4, TOUCH9, RTC_GPIO9
9 IO33 I/O | 32K_XN :ref:`（见说明 2b） <get-started-pico-kit-v4-pin-notes>` , ADC1_CH5, TOUCH8, RTC_GPIO8
10 IO27 I/O | GPIO27, ADC2_CH7, TOUCH7, RTC_GPIO17
| EMAC_RX_DV
11 IO14 I/O | ADC2_CH6, TOUCH6, RTC_GPIO16, MTMS, HSPICLK,
| HS2_CLK, SD_CLK, EMAC_TXD2
12 IO12 I/O | ADC2_CH5, TOUCH5, RTC_GPIO15, MTDI :ref:`（见说明 4） <get-started-pico-kit-v4-pin-notes>` , HSPIQ,
| HS2_DATA2, SD_DATA2, EMAC_TXD3
13 IO13 I/O | ADC2_CH4, TOUCH4, RTC_GPIO14, MTCK, HSPID,
| HS2_DATA3, SD_DATA3, EMAC_RX_ER
14 IO15 I/O | ADC2_CH3, TOUCH3, RTC_GPIO13, MTDO, HSPICS0
| HS2_CMD, SD_CMD, EMAC_RXD3
15 IO2 I/O | ADC2_CH2, TOUCH2, RTC_GPIO12, HSPIWP,
| HS2_DATA0, SD_DATA0
16 IO4 I/O | ADC2_CH0, TOUCH0, RTC_GPIO10, HSPIHD,
| HS2_DATA1, SD_DATA1, EMAC_TX_ER
17 IO0 I/O | ADC2_CH1, TOUCH1, RTC_GPIO11, CLK_OUT1
| EMAC_TX_CLK
18 VDD33 (3V3) P | 3.3V 电源
19 GND P | Ground
20 EXT_5V (5V) P | 5V 电源
====== ================= ====== ======================================================
.. _get-started-pico-kit-v4-pin-notes:
有关上表的说明：
1. 该管脚已连接至 ESP32-PICO-D4 的内置 flash 管脚。
2. 32.768 kHz 晶振：(a) 输入；(b) 输出。
3. 该管脚已连接至开发板的 USB 桥接器芯片。
4. ESP32-PICO-KIT 内置 SPI flash 的工作电压为 3.3V。因此，strapping 管脚 MTDI 在模组上电复位过程中应保持低电平。如连接该管脚，请确保该管脚在复位中不要保持高电平。
应用程序开发
------------
ESP32-PICO-KIT 上电前，请首先确认开发板完好无损。
之后，请前往 :doc:`index` 中的 :ref:`get-started-step-by-step` 章节，查看如何设置开发环境，并尝试将示例项目烧录至您的开发板。
开发板尺寸
----------
ESP32-PICO-KIT 的尺寸为 52 x 20.3 x 10 mm (2.1" x 0.8" x 0.4")。
.. figure:: ../../_static/esp32-pico-kit-v4.1-dimensions-back.jpg
:align: center
:alt: ESP32-PICO-KIT 尺寸图 -- 背面
:figclass: align-center
ESP32-PICO-KIT 尺寸图 -- 背面
.. figure:: ../../_static/esp32-pico-kit-v4-dimensions-side.jpg
:align: center
:alt: ESP32-PICO-KIT V4 尺寸图 -- 侧面
:figclass: align-center
ESP32-PICO-KIT 尺寸图 -- 侧面
有关开发板的物理结构细节，请见下方参考设计。
相关文档
-----------------
* `ESP32-PICO-KIT V4 原理图 <https://dl.espressif.com/dl/schematics/esp32-pico-kit-v4_schematic.pdf>`_ (PDF)
* `ESP32-PICO-KIT V4.1 原理图 <https://dl.espressif.com/dl/schematics/esp32-pico-kit-v4.1_schematic.pdf>`_ (PDF)
* `ESP32-PICO-KIT 参考设计 <https://www.espressif.com/zh-hans/support/download/documents/development-board?keys=esp32-pico-kit+参考设计>`_ ，内含 OrCAD 原理图、PCB 布局、Gerbers 和 BOM 表。
* `《ESP32-PICO-D4 技术规格书》 <http://espressif.com/sites/default/files/documentation/esp32-pico-d4_datasheet_cn.pdf>`_ (PDF)
* :doc:`../hw-reference/index`
.. toctree::
:hidden:
get-started-pico-kit-v3

191
docs/zh_CN/get-started/get-started-wrover-kit-v2.rst
View file

@ -1,191 +0,0 @@
ESP-WROVER-KIT V2 入门指南
===========================================
:link_to_translation:`en:[English]`
本指南介绍了如何开始使用 ESP-WROVER-KIT V2 开发板及其功能和相关配置。有关 ESP-WROVER-KIT 其他版本的介绍，请见：:doc:`../hw-reference/index`。
准备工作
-------------
* ESP-WROVER-KIT V2 开发板
* USB 数据线（A 转 Micro-B）
* PC（Windows、Linux 或 macOS）
您可以跳过介绍部分，直接前往 `应用程序开发`_ 章节。
概述
--------
ESP-WROVER-KIT 是 `乐鑫 <https://espressif.com>`_ 一款基于 ESP32 的开发板，集成了 LCD 屏幕和 MicroSD 卡槽。
ESP-WROVER-KIT 可选贴以下 ESP32 模组：
- :ref:`esp-modules-and-boards-esp32-wroom-32`
- :ref:`ESP32-WROVER <esp-modules-and-boards-esp32-wrover>`
此外，ESP-WROVER-KIT 的独特之处在于集成了一款先进多协议 USB 桥接器 (FTDI FT2232HL)，允许开发人员直接通过 USB 接口，使用 JTAG 对 ESP32 进行调试，无需额外的 JTAG 调试器。ESP-WROVER-KIT 可为开发人员提供简单、便捷且极具成本效益的开发体验。
为了便于使用，板上模组的绝大部分管脚均已引出至开发板的引脚。
.. note::
ESP-WROVER-KIT V2 板载 ESP32-WROVER 模组的 GPIO16 和 GPIO17 管脚用作 PSRAM 的片选和时钟信号。 默认情况下，为了给用户提供可靠的性能，这两个 GPIO 管脚不引出至开发板引脚。
功能概述
----------------------
ESP-WROVER-KIT 开发板的主要组件和连接方式如下图所示。
.. figure:: ../../_static/esp-wrover-kit-block-diagram.png
:align: center
:alt: ESP-WROVER-KIT 功能框图
:figclass: align-center
ESP-WROVER-KIT 功能框图
功能说明
----------------------
ESP-WROVER-KIT 开发板的主要组件、接口及控制方式见下。
.. _get-started-esp-wrover-kit-v2-board-front:
.. figure:: ../../_static/esp-wrover-kit-v2-layout-front.png
:align: center
:alt: ESP-WROVER-KIT 开发板布局 -- 俯视图
:figclass: align-center
ESP-WROVER-KIT 开发板布局 -- 俯视图
.. _get-started-esp-wrover-kit-v2-board-back:
.. figure:: ../../_static/esp-wrover-kit-v2-layout-back.png
:align: center
:alt: ESP-WROVER-KIT 开发板布局 -- 仰视图
:figclass: align-center
ESP-WROVER-KIT 开发板布局 -- 仰视图
下表从图片右上角开始，以顺时针顺序介绍了图 1 中的主要组件，然后以同样的顺序介绍了图 2 中的主要组件。
==================== ======================================================================================================================================================================================================================================================================================================================================
主要组件 基本介绍
==================== ======================================================================================================================================================================================================================================================================================================================================
32.768 kHz 外接 32.768 kHz 晶振，可提供 Deep-sleep 下使用的低功耗时钟。
ESP32 模组 可选贴 ESP32-WROOM-32 或 ESP32-WROVER。ESP32-WROVER 模组完整集成了 ESP32-WROOM-32 的所有功能，且内置 32-Mbit PSRAM，可提供灵活的额外存储空间和数据处理能力。
CTS/RTS 串口流控信号。管脚默认不连接至电路。为了使能该功能，必须用跳线帽短路掉 JP14 的相应管脚。
UART 串口。FT2232HL 和 ESP32 的串行 TX/RX 信号已引出至 JP11 的两端。默认情况下，这两路信号由跳线帽连接。如果要跳过 FT2232 使用 ESP32 模组串口，则可移除相关跳线帽，将模组连接至其他外部串口设备。
SPI 默认情况下，ESP32 使用 SPI 接口访问内置 flash 和 PSRAM。使用这些引脚连接 ESP32 和其他 SPI 设备。这种情况下，需增加额外的片选 (CS) 信号。注意，选贴 ESP32-WROVER 模组时，该接口的工作电压为 1.8 V；选贴 ESP32-WROOM-32 时，该接口的工作电压为 3.3V。
JTAG JTAG 接口。FT2232HL 和 ESP32 的 JTAG 信号已引出至 JP8 的两端。默认情况下，这两路信号不连接。如需使能 JTAG，请按照 `设置选项`_ 的介绍，连接跳线帽。
FT2232 FT2232 多协议 USB 转串口桥接器。开发人员可通过 USB 接口对 FT2232 芯片进行控制和编程，与 ESP32 建立连接。FT2232 具有 USB-to-UART 和 USB-to-JTAG 功能。
EN 复位按键。
Boot 下载按键。按下 **Boot** 键并保持，同时按一下 **EN** 键（此时不要松开 **Boot** 键）进入“固件下载”模式，通过串口下载固件。
USB USB 接口。可用作开发板的供电电源，或连接 PC 和开发板的通信接口。
电源选择开关 ESP-WROVER-KIT 开发板可通过 USB 端口或 5V 输入接口供电。用户可使用跳线帽在两种供电模式中进行选择。更多详细信息，请见章节 `设置选项`_ 中有关 JP7 连接器的描述。
电源开关 拨向 **USB** 按键一侧，开发板上电；拨离 **USB** 按键一侧，开发板掉电。
5V Input 5V 电源接口建议仅在开发板自动运行（未连接 PC）时使用。仅用于全负荷工作下的后备电源。
LDO 5V-to-3.3V 低压差线型稳压器 NCP1117(1A)。NCP1117 最大电流输出为 1 A。板上 LDO 为固定输出电压，但用户也可以选用具有可变输出电压的 LDO。更多信息，请见 `ESP-WROVER-KIT V2 原理图`_。
摄像头 摄像头接口，支持标准 OV7670 摄像头模块。
RGB LED 红绿蓝发光二极管，可由 PWM（脉冲宽度调制）控制。
I/O 板上模组的所有管脚均已引出至开发板的排针。用户可以对 ESP32 进行编程，实现 PWM、ADC、DAC、I2C、I2S、SPI 等多种功能。
MicroSD 卡槽 MicroSD 卡槽，可扩充存储空间：当 ESP32 进入下载模式时，GPIO2 不可处于高电平。然而，为了使能 MicroSD 卡功能，需为 GPIO2 增加一个上拉电阻。默认情况下，GPIO2 和上拉电阻 R153 处于断开状态。为了使能 MicroSD 卡，请按照 `设置选项`_ 章节的要求，连接 JP1 连接器。
LCD 显示屏 支持贴装一款 3.2” 的 SPI（标准四线串行外设接口）LCD 显示器，请见 :ref:`get-started-esp-wrover-kit-v2-board-back`。
==================== ======================================================================================================================================================================================================================================================================================================================================
.. _get-started-esp-wrover-kit-v2-setup-options:
设置选项
-------------
用户可通过 5 组排针，设置开发板功能，其中常见功能见下表：
======= ================ =====================================================================================
排针 跳线设置 功能描述
======= ================ =====================================================================================
JP1 |jp1-sd_io2| 使能 MicroSD Card 功能的上拉电阻
JP1 |jp1-both| 确保开发板处于下载模式时，GPIO2 时钟处于低位（将 JP1 连接至 GPIO0）
JP7 |jp7-ext_5v| 使用外部电源为 ESP-WROVER-KIT 开发板供电
JP7 |jp7-usb_5v| 使用 USB 端口为 ESP-WROVER-KIT 开发板供电
JP8 |jp8| 使能 JTAG 功能
JP11 |jp11-tx-rx| 使能 UART 通信
JP14 |jp14| 使能 RTS/CTS 串口流控
======= ================ =====================================================================================
.. _get-started-esp-wrover-kit-v2-start-development:
应用程序开发
-----------------------------
ESP-WROVER-KIT 上电前，请首先确认开发板完好无损。
初始设置
^^^^^^^^^^^^^
请严格按照下图所示连接跳线帽，注意不要额外连接其他跳线帽。
- 使用 JP7 连接器，选择 USB 为开发板供电。
- 使用 JP11 连接器，使能 UART 通信。
======================== ==========================
USB 供电 使能 UART 通信
======================== ==========================
|jp7-usb_5v| |jp11-tx-rx|
======================== ==========================
注意不要连接其他跳线帽。
打开 **电源开关**，**5V Power On LED** 应点亮。
正式开始开发
^^^^^^^^^^^^^^^^^^
现在，请前往 :doc:`index` 中的 :ref:`get-started-step-by-step` 章节，查看如何设置开发环境，并尝试将示例项目烧录至您的开发板。
相关文档
-----------------
* `ESP-WROVER-KIT V2 原理图`_ (PDF)
* `《ESP32 技术规格书》 <https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf>`_ (PDF)
* `《ESP32-WROVER 技术规格书》 <https://espressif.com/sites/default/files/documentation/esp32_wrover_datasheet_cn.pdf>`_ (PDF)
* `《ESP32-WROOM-32 技术规格书》 <https://espressif.com/sites/default/files/documentation/esp32-wroom-32_datasheet_cn.pdf>`_ (PDF)
* :doc:`../api-guides/jtag-debugging/index`
* :doc:`../hw-reference/index`
.. |jp1-sd_io2| image:: ../../_static/wrover-jp1-sd_io2.png
.. |jp1-both| image:: ../../_static/wrover-jp1-both.png
.. |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-tx-rx| image:: ../../_static/wrover-jp11-tx-rx.png
.. |jp14| image:: ../../_static/wrover-jp14.png
.. _ESP-WROVER-KIT V2 原理图: https://dl.espressif.com/dl/schematics/ESP-WROVER-KIT_SCH-2.pdf

377
docs/zh_CN/get-started/get-started-wrover-kit-v3.rst
View file

@ -1,377 +0,0 @@
ESP-WROVER-KIT V3 入门指南
=======================================
:link_to_translation:`en:[Engish]`
本指南介绍了如何开始使用 ESP-WROVER-KIT V3 开发板及其功能和相关配置。有关 ESP-WROVER-KIT 其他版本的介绍，请见：:doc:`../hw-reference/index`。
准备工作
-------------
* :ref:`ESP-WROVER-KIT V3 开发板 <get-started-esp-wrover-kit-v3-board-front>`
* USB 数据线（A 转 Micro-B）
* PC（Windows、Linux 或 macOS）
您可以跳过介绍部分，直接前往 `应用程序开发`_ 章节。
概述
--------
ESP-WROVER-KIT 是 `乐鑫 <https://espressif.com>`_ 一款基于 ESP32 的开发板，集成了 LCD 屏幕和 MicroSD 卡槽。
ESP-WROVER-KIT 可选贴以下 ESP32 模组：
- :ref:`esp-modules-and-boards-esp32-wroom-32`
- :ref:`ESP32-WROVER <esp-modules-and-boards-esp32-wrover>`
此外，ESP-WROVER-KIT 的独特之处在于集成了一款先进多协议 USB 桥接器 (FTDI FT2232HL)，允许开发人员直接通过 USB 接口，使用 JTAG 对 ESP32 进行调试，无需额外的 JTAG 调试器。ESP-WROVER-KIT 可为开发人员提供简单、便捷且极具成本效益的开发体验。
为了便于使用，板上模组的绝大部分管脚均已引出至开发板的引脚。
.. note::
该版本 ESP32-WROVER 模组 的 GPIO16 和 GPIO17 管脚用作 PSRAM 的片选和时钟信号。默认情况下，为了给用户提供可靠的性能，这两个 GPIO 管脚不引出至开发板引脚。
功能概述
----------------------
ESP-WROVER-KIT 开发板的主要组件和连接方式如下图所示。
.. figure:: ../../_static/esp-wrover-kit-block-diagram.png
:align: center
:alt: ESP-WROVER-KIT 功能框图
:figclass: align-center
ESP-WROVER-KIT 功能框图
功能说明
----------------------
ESP-WROVER-KIT 开发板的主要组件、接口及控制方式见下。
.. _get-started-esp-wrover-kit-v3-board-front:
.. figure:: ../../_static/esp-wrover-kit-v3-layout-front.jpg
:align: center
:alt: ESP-WROVER-KIT 开发板布局 -- 俯视图
:figclass: align-center
ESP-WROVER-KIT 开发板布局 -- 俯视图
.. _get-started-esp-wrover-kit-v3-board-back:
.. figure:: ../../_static/esp-wrover-kit-v3-layout-back.jpg
:align: center
:alt: ESP-WROVER-KIT 开发板布局 -- 仰视图
:figclass: align-center
ESP-WROVER-KIT 开发板布局 -- 仰视图
下表从图片右上角开始，以顺时针顺序介绍了图 1 中的主要组件，然后以同样的顺序介绍图 2 中的主要组件。
==================== ======================================================================================================================================================================================================================================================================================================================================
主要组件 基本介绍
==================== ======================================================================================================================================================================================================================================================================================================================================
32.768 kHz 外接 32.768 kHz 晶振，可提供 Deep-sleep 下使用的低功耗时钟。
0 欧电阻 ESP-WROVER-KIT 开发板设计了一个 0 欧电阻，可在测量 ESP32 系列模组在不同功耗模式下的电流时，直接移除或替换为分流器。
ESP32 模组 可选贴 ESP32-WROOM-32 或 ESP32-WROVER。ESP32-WROVER 模组完整集成了 ESP32-WROOM-32 的所有功能，且内置 32-Mbit PSRAM，可提供灵活的额外存储空间和数据处理能力。
FT2232 FT2232 多协议 USB 转串口桥接器。开发人员可通过 USB 接口对 FT2232 芯片进行控制和编程，与 ESP32 建立连接。FT2232 芯片可在通道 A 提供 USB-to-JTAG 接口功能，并在通道 B 提供 USB-to-Serial 接口功能，便利开发人员的应用开发与调试。见 `ESP-WROVER-KIT V3 原理图`_。
UART 串口。FT2232HL 和 ESP32 的串行 TX/RX 信号已引出至 JP11 的两端。默认情况下，这两路信号由跳线帽连接。如果要跳过 FT2232 使用 ESP32 模组串口，则可移除相关跳线帽，将模组连接至其他外部串口设备。
SPI 默认情况下，ESP32 使用 SPI 接口访问内置 flash 和 PSRAM。使用这些引脚连接 ESP32 和其他 SPI 设备。这种情况下，需增加额外的片选 (CS) 信号。注意，选贴 ESP32-WROVER 模组时，该接口的工作电压为 1.8 V；选贴 ESP32-WROOM-32 时，该接口的工作电压为 3.3V。
CTS/RTS 串口流控信号。管脚默认不连接至电路。为了使能该功能，必须用跳线帽短路掉 JP14 的相应管脚。
JTAG JTAG 接口。FT2232HL 和 ESP32 的 JTAG 信号已引出至 JP8 的两端。默认情况下，这两路信号不连接。如需使能 JTAG，请按照 `设置选项`_ 的介绍，连接跳线帽。
EN 复位按键。
Boot 下载按键。按下 **Boot** 键并保持，同时按一下 **EN** 键（此时不要松开 **Boot** 键）进入“固件下载”模式，通过串口下载固件。
USB USB 接口。可用作开发板的供电电源，或连接 PC 和开发板的通信接口。
电源开关 拨向 **USB** 按键一侧，开发板上电；拨离 **USB** 按键一侧，开发板掉电。
电源选择开关 ESP-WROVER-KIT 开发板可通过 USB 端口或 5V 输入接口供电。用户可使用跳线帽在两种供电模式中进行选择。更多详细信息，请见章节 `设置选项`_ 中有关 JP7 连接器的描述。
5V Input 5V 电源接口建议仅在开发板自动运行（未连接 PC）时使用。仅用于全负荷工作下的后备电源。
LDO 5V-to-3.3V 低压差线型稳压器 NCP1117(1A)。NCP1117 最大电流输出为 1 A。板上 LDO 为固定输出电压，但用户也可以选用具有可变输出电压的 LDO。更多信息，请见 `ESP-WROVER-KIT V3 原理图`_。
摄像头 摄像头接口，支持标准 OV7670 摄像头模块。
RGB LED 红绿蓝发光二极管，可由 PWM（脉冲宽度调制）控制。
I/O 板上模组的所有管脚均已引出至开发板的排针。用户可以对 ESP32 进行编程，实现 PWM、ADC、DAC、I2C、I2S、SPI 等多种功能。
MicroSD 卡槽 适用于需要扩充数据存储空间或进行备份的应用开发场景。
LCD 显示屏 支持贴装一款 3.2” 的 SPI（标准四线串行外设接口）LCD 显示器，请见 :ref:`get-started-esp-wrover-kit-v3-board-back`。
==================== ======================================================================================================================================================================================================================================================================================================================================
.. _get-started-esp-wrover-kit-v3-setup-options:
设置选项
-------------
用户可通过 5 组排针，设置开发板功能，其中常见功能见下表：
======= ================ =========================================================================
排针 跳线设置 功能描述
======= ================ =========================================================================
JP7 |jp7-ext_5v| 使用外部电源为 ESP-WROVER-KIT 开发板供电
JP7 |jp7-usb_5v| 使用 USB 端口为 ESP-WROVER-KIT 开发板供电
JP8 |jp8| 使能 JTAG 功能
JP11 |jp11-tx-rx| 使能 UART 通信
JP14 |jp14| 使能 RTS/CTS 串口流控
======= ================ =========================================================================
ESP32 管脚分配
------------------------
ESP32 模组的部分管脚/终端已被板上组件占用或用于外部硬件设备。如果某管脚对应的特定硬件未连接，则该管脚可用作他用。比如，摄像头/JP4 排针未连接相应硬件，则这些 GPIO 可用于其他用途。
部分管脚具备多个功能，可供板上组件或外部硬件设备同时使用，比如 GPIO0 和 GPIO2。由于管脚限制，一些外围设备不可同时使用，比如，由于 JTAG 和 SD 卡槽需共用部分管脚，因此一些使用 SD 卡功能的应用无法同时进行 JTAG 调试。
其他情况下，不同外设可同时使用。比如，LCD 屏幕和 SD 卡仅共用一个 GPIO21 管脚，可以同时使用。该管脚可为 LCD 屏幕提供 D/C（数据/控制）信号，并用于读取来自 SD 卡槽的 CD 信号（卡检测信号）。如无需使用卡检测功能，开发人员还可以通过移除 R167 来禁用该功能。此时，LCD 和 SD 卡槽可同时使用。
更多外设共享管脚的介绍，请见下一章节中的表格。
主要 I/O 连接器 / JP1
^^^^^^^^^^^^^^^^^^^^^^^^
JP1 连接器包括 14 x 2 个排针，具体功能可见下表中间 “I/O” 列的介绍。两侧的“共用”列则介绍了这些管脚在板上的其他用途。
===================== ===== ===== =====================
共用 I/O I/O 共用
===================== ===== ===== =====================
n/a 3.3V GND n/a
NC/XTAL IO32 IO33 NC/XTAL
JTAG, MicroSD IO12 IO13 JTAG, MicroSD
JTAG, MicroSD IO14 IO27 摄像头
摄像头 IO26 IO25 摄像头，LCD
摄像头 IO35 IO34 摄像头
摄像头 IO39 IO36 摄像头
JTAG EN IO23 摄像头，LCD
摄像头，LCD IO22 IO21 摄像头，LCD，MicroSD
摄像头，LCD IO19 IO18 摄像头，LCD
摄像头，LCD IO5 IO17 PSRAM
PSRAM IO16 IO4 LED，摄像头，MicroSD
摄像头，LED，Boot IO0 IO2 LED，MicroSD
JTAG，MicroSD IO15 5V
===================== ===== ===== =====================
说明：
* 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 按键 / SW2
* 摄像头 - :ref:`摄像头 / 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 的情况。
.. _get-started-esp-wrover-kit-v3-xtal:
32.768 kHz 晶振
^^^^^^^^^^^^^^^^^^^^^
==== ==========
. ESP32 管脚
==== ==========
1. GPIO32
2. GPIO33
==== ==========
.. note::
默认情况下，管脚 GPIO32 和 GPIO33 已连接至晶振。因此，为了保证信号的完整性，这两个管脚并未连接至 JP1 I/O 连接器。用户可通过将 R11/R23 处的 0 欧电阻移至 R12/R24 处，以将 GP1O32 和 GPIO33 的连接从晶振移至 JP1。
.. _get-started-esp-wrover-kit-v3-spi-flash-header:
SPI Flash / JP13
^^^^^^^^^^^^^^^^
==== =============
. ESP32 管脚
==== =============
1. CLK / GPIO6
2. SD0 / GPIO7
3. SD1 / GPIO8
4. SD2 / GPIO9
5. SD3 / GPIO10
6. CMD / GPIO11
==== =============
.. important::
模组的 flash 总线已通过 0 欧电阻 R140 ~ R145 连接至排针 JP13。如果需要将 flash 的工作频率控制在 80 MHz，为了达到保证总线信号完整性等目的，建议移除 R140 ~ R145 电阻，将模组的 flash 总线与排针 JP2 断开。
.. _get-started-esp-wrover-kit-v3-jtag-header:
JTAG / JP8
^^^^^^^^^^
==== ============== =============
. ESP32 管脚 JTAG 信号
==== ============== =============
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:
摄像头 / JP4
^^^^^^^^^^^^
==== ========== =============================
. ESP32 管脚 摄像头信号
==== ========== =============================
1. n/a 3.3V
2. n/a 地
3. GPIO27 SIO_C / SCCB 时钟
4. GPIO26 SIO_D / SCCB 数据
5. GPIO25 VSYNC / 垂直同步
6. GPIO23 HREF / 水平参考
7. GPIO22 PCLK / 像素时钟
8. GPIO21 XCLK / 系统时钟
9. GPIO35 D7 / 像素数据 Bit 7
10. GPIO34 D6 / 像素数据 Bit 6
11. GPIO39 D5 / 像素数据 Bit 5
12. GPIO36 D4 / 像素数据 Bit 4
13. GPIO19 D3 / 像素数据 Bit 3
14. GPIO18 D2 / 像素数据 Bit 2
15. GPIO5 D1 / 像素数据 Bit 1
16. GPIO4 D0 / 像素数据 Bit 0
17. GPIO0 RESET / 摄像头复位
18. n/a PWDN / 摄像头断电
==== ========== =============================
* D0 到 D7 为摄像头的数据总线
.. _get-started-esp-wrover-kit-v3-rgb-led-connections:
RGB LED
^^^^^^^
==== ========== =========
. ESP32 管脚 RGB LED
==== ========== =========
1. GPIO0 红色
2. GPIO2 绿色
3. GPIO4 蓝色
==== ========== =========
.. _get-started-esp-wrover-kit-v3-microsd-card-slot:
MicroSD 卡
^^^^^^^^^^^^
==== ============== ===============
. ESP32 管脚 MicroSD 信号
==== ============== ===============
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 管脚 LCD 信号
==== ============== ===============
1. GPIO18 复位
2. GPIO19 SCL
3. GPIO21 D/C
4. GPIO22 CS
5. GPIO23 SDA
6. GPIO25 SDO
7. GPIO5 背光
==== ============== ===============
.. _get-started-esp-wrover-kit-v3-start-development:
应用程序开发
-----------------------------
ESP-WROVER-KIT 上电前，请首先确认开发板完好无损。
初始设置
^^^^^^^^^^^^^
请严格按照下图所示连接跳线帽，注意不要额外连接其他跳线帽。
- 使用 JP7 连接器，选择 USB 为开发板供电。
- 使用 JP11 连接器，使能 UART 通信。
======================== ==========================
USB 供电 使能 UART 通信
======================== ==========================
|jp7-usb_5v| |jp11-tx-rx|
======================== ==========================
注意不要连接其他跳线帽。
打开 **电源开关**，**5V Power On LED** 应点亮。
正式开始开发
^^^^^^^^^^^^^^^^^^
现在，请前往 :doc:`index` 中的 :ref:`get-started-step-by-step` 章节，查看如何设置开发环境，并尝试将示例项目烧录至您的开发板。
相关文档
-----------------
* `ESP-WROVER-KIT V3 原理图`_ (PDF)
* `《ESP32 技术规格书》 <https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf>`_ (PDF)
* `《ESP32-WROVER 技术规格书》 <https://espressif.com/sites/default/files/documentation/esp32_wrover_datasheet_cn.pdf>`_ (PDF)
* `《ESP32-WROOM-32 技术规格书》 <https://espressif.com/sites/default/files/documentation/esp32-wroom-32_datasheet_cn.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 原理图: https://dl.espressif.com/dl/schematics/ESP-WROVER-KIT_SCH-3.pdf
.. toctree::
:hidden:
get-started-wrover-kit-v2.rst

382
docs/zh_CN/get-started/get-started-wrover-kit.rst
View file

@ -1,382 +0,0 @@
ESP-WROVER-KIT V4.1 入门指南
=========================================
:link_to_translation:`en:[English]`
本指南介绍了如何开始使用 ESP-WROVER-KIT V4.1 开发板及其功能和相关配置。有关 ESP-WROVER-KIT 其他版本的介绍，请见：:doc:`../hw-reference/index`。
准备工作
-------------
* :ref:`ESP-WROVER-KIT V4.1 开发板 <get-started-esp-wrover-kit-v4.1-board-front>`
* USB 数据线（A 转 Micro-B）
* PC（Windows、Linux 或 macOS）
您可以跳过介绍部分，直接前往 `应用程序开发`_ 章节。
概述
--------
ESP-WROVER-KIT 是 `乐鑫 <https://espressif.com>`_ 一款基于 ESP32 的开发板。
ESP-WROVER-KIT 开发板已集成了如下组件：
- ESP32-WROVER-B 模组
- LCD 屏
- MicroSD 卡槽
此外，ESP-WROVER-KIT 的独特之处在于集成了一款先进多协议 USB 桥接器 (FTDI FT2232HL)，允许开发人员直接通过 USB 接口，使用 JTAG 对 ESP32 进行调试，无需额外的 JTAG 调试器。ESP-WROVER-KIT 可为开发人员提供简单、便捷且极具成本效益的开发体验。
为了便于使用，板上模组的绝大部分管脚均已引出至开发板的引脚。
.. note::
ESP32 的 GPIO16 和 GPIO17 管脚用作 PSRAM 的片选和时钟信号。默认情况下，为了给用户提供可靠的性能，这两个 GPIO 管脚不引出至开发板引脚。
功能概述
----------------------
ESP-WROVER-KIT 开发板的主要组件和连接方式如下图所示。
.. figure:: ../../_static/esp-wrover-kit-block-diagram.png
:align: center
:alt: ESP-WROVER-KIT 功能框图
:figclass: align-center
ESP-WROVER-KIT 功能框图
功能说明
----------------------
ESP-WROVER-KIT 开发板的主要组件、接口及控制方式见下。
.. _get-started-esp-wrover-kit-v4.1-board-front:
.. figure:: ../../_static/esp-wrover-kit-v4.1-layout-front.png
:align: center
:alt: ESP-WROVER-KIT 开发板布局 -- 俯视图
:figclass: align-center
ESP-WROVER-KIT 开发板布局 -- 俯视图
.. _get-started-esp-wrover-kit-v4.1-board-back:
.. figure:: ../../_static/esp-wrover-kit-v4.1-layout-back.png
:align: center
:alt: ESP-WROVER-KIT 开发板布局 -- 仰视图
:figclass: align-center
ESP-WROVER-KIT 开发板布局 -- 仰视图
下表将从图片右上角开始，以顺时针顺序介绍图 1 中的主要组件，然后按同样顺序介绍图 2 中的主要组件。
==================== ======================================================================================================================================================================================================================================================================================================================================
主要组件 基本介绍
==================== ======================================================================================================================================================================================================================================================================================================================================
FT2232 FT2232 多协议 USB 转串口桥接器。开发人员可通过 USB 接口对 FT2232 芯片进行控制和编程，与 ESP32 建立连接。FT2232 芯片可在通道 A 提供 USB-to-JTAG 接口功能，并在通道 B 提供 USB-to-Serial 接口功能，便利开发人员的应用开发与调试。详见 `ESP-WROVER-KIT V4.1 原理图`_。
32.768 kHz 外接 32.768 kHz 晶振，可提供 Deep-sleep 下使用的低功耗时钟。
0 欧电阻. ESP-WROVER-KIT 开发板设计了一个 0 欧电阻，可在测量 ESP32 系列模组在不同功耗模式下的电流时，直接移除或替换为分流器。
ESP32-WROVER-B 模组 ESP-WROVER 模组内置 64-Mbit PSRAM，可提供灵活的额外存储空间和数据处理能力。
诊断 LED 信号灯 本开发板 FT2232 芯片的 GPIO 管脚连接了 4 个红色 LED 信号灯，以备后用。
UART 串口。FT2232HL 和 ESP32 的串行 TX/RX 信号已引出至 JP11 的两端。默认情况下，这两路信号由跳线帽连接。如果要跳过 FT2232 使用 ESP32 模组串口，则可移除相关跳线帽，将模组连接至其他外部串口设备。
SPI 默认情况下，ESP32 使用 SPI 接口访问内置 flash 和 PSRAM。使用这些引脚连接 ESP32 和其他 SPI 设备。这种情况下，需增加额外的片选 (CS) 信号。注意，本接口的工作电压为 3.3 V。
CTS/RTS 串口流控信号。管脚默认不连接至电路。为了使能该功能，必须用跳线帽短路掉 JP14 的相应管脚。
JTAG JTAG 接口。FT2232HL 和 ESP32 的 JTAG 信号已引出至 JP2 的两端。默认情况下，这两路信号不连接。如需使能 JTAG，请按照 `设置选项`_ 的介绍，连接跳线帽。
USB 端口 USB 接口。可用作开发板的供电电源，或连接 PC 和开发板的通信接口。
EN 复位按键。
Boot 按键 下载按键。按下 **Boot** 键并保持，同时按一下 **EN** 键（此时不要松开 **Boot** 键）进入“固件下载”模式，通过串口下载固件。
电源开关 拨向 **Boot** 按键一侧，开发板上电；拨离 **Boot** 按键一侧，开发板掉电。
电源选择开关 ESP-WROVER-KIT 开发板可通过 USB 端口或 5V 输入接口供电。用户可使用跳线帽在两种供电模式中进行选择。更多详细信息，请见章节 `设置选项`_ 中有关 JP7 连接器的描述。
5V Input 5V 电源接口建议仅在开发板自动运行（未连接 PC）时使用。仅用于全负荷工作下的后备电源。
5V Power On LED 当开发板通电后（USB 或外部 5V 供电），该红色指示灯将亮起。
LDO 5V-to-3.3V 低压差线型稳压器 NCP1117(1A)。NCP1117 最大电流输出为 1 A。板上 LDO 为固定输出电压，但用户也可以选用具有可变输出电压的 LDO。更多信息，请见 `ESP-WROVER-KIT V4.1 原理图`_。
摄像头连接器 摄像头接口，支持标准 OV7670 摄像头模块。
RGB LED 红绿蓝发光二极管，可由 PWM（脉冲宽度调制）控制。
I/O 连接器 板上模组的所有管脚均已引出至开发板的排针。用户可以对 ESP32 进行编程，实现 PWM、ADC、DAC、I2C、I2S、SPI 等多种功能。
MicroSD 卡槽 适用于需要扩充数据存储空间或进行备份的应用开发场景。
LCD 显示屏 支持贴装一款 3.2” 的 SPI（标准四线串行外设接口）LCD 显示器，请见 :ref:`get-started-esp-wrover-kit-v4.1-board-back`。
==================== ======================================================================================================================================================================================================================================================================================================================================
.. _get-started-esp-wrover-kit-v4.1-setup-options:
设置选项
-------------
用户可通过 3 组排针，设置开发板功能，其中常见功能见下表：
======= ================ =========================================================================
排针 跳线设置 功能描述
======= ================ =========================================================================
JP7 |jp7-ext_5v| 使用外部电源为 ESP-WROVER-KIT 开发板供电
JP7 |jp7-usb_5v| 使用 USB 端口为 ESP-WROVER-KIT 开发板供电
JP2 |jp2-jtag| 使能 JTAG 功能
JP2 |jp2-tx-rx| 使能 UART 通信
JP14 |jp14| 使能 RTS/CTS 串口流控
======= ================ =========================================================================
ESP32 管脚分配
------------------------
ESP32 模组的部分管脚/终端已被板上组件占用或用于外部硬件设备。如果某管脚对应的特定硬件未连接，则该管脚可用作他用。比如，摄像头/JP4 排针未连接相应硬件，则这些 GPIO 可用于其他用途。
部分管脚具备多个功能，可供板上组件或外部硬件设备同时使用，比如 GPIO0 和 GPIO2。由于管脚限制，一些外围设备不可同时使用，比如，由于 JTAG 和 SD 卡槽需共用部分管脚，因此一些使用 SD 卡功能的应用无法同时进行 JTAG 调试。
其他情况下，不同外设可同时使用。比如，LCD 屏幕和 SD 卡仅共用一个 GPIO21 管脚，可以同时使用。该管脚可为 LCD 屏幕提供 D/C（数据/控制）信号，并用于读取来自 SD 卡槽的 CD 信号（卡检测信号）。如无需使用卡检测功能，开发人员还可以通过移除 R167 来禁用该功能。此时，LCD 和 SD 卡槽可同时使用。
更多外设共享管脚的介绍，请见下一章节中的表格。
主要 I/O 连接器 / JP1
^^^^^^^^^^^^^^^^^^^^^^^^
JP1 连接器包括 14 x 2 个排针，具体功能可见下表中间 “I/O” 列的介绍。两侧的“共用”列则介绍了这些管脚在板上的其他用途。
===================== ===== ===== =====================
共用 I/O I/O 共用
===================== ===== ===== =====================
n/a 3.3V GND n/a
NC/XTAL IO32 IO33 NC/XTAL
JTAG，MicroSD IO12 IO13 JTAG，MicroSD
JTAG，MicroSD IO14 IO27 摄像头
摄像头 IO26 IO25 摄像头，LCD
摄像头 IO35 IO34 摄像头
摄像头 IO39 IO36 摄像头
JTAG EN IO23 摄像头，LCD
摄像头，LCD IO22 IO21 摄像头，LCD，MicroSD
摄像头，LCD IO19 IO18 摄像头，LCD
摄像头，LCD IO5 IO17 PSRAM
PSRAM IO16 IO4 LED，摄像头，MicroSD
摄像头，LED，Boot IO0 IO2 LED，MicroSD
JTAG，MicroSD IO15 5V
===================== ===== ===== =====================
说明：
* NC/XTAL - :ref:`32.768 kHz 晶振 <get-started-esp-wrover-kit-v4.1-xtal>`
* JTAG - :ref:`JTAG / JP8 <get-started-esp-wrover-kit-v4.1-jtag-header>`
* Boot - Boot 按键 / SW2
* 摄像头 - :ref:`摄像头 / 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-B 的 PSRAM
.. _get-started-esp-wrover-kit-v4.1-xtal:
32.768 kHz 晶振
^^^^^^^^^^^^^^^^^^^^^
==== ==========
. ESP32 管脚
==== ==========
1. GPIO32
2. GPIO33
==== ==========
.. note::
默认情况下，管脚 GPIO32 和 GPIO33 已连接至晶振。因此，为了保证信号的完整性，这两个管脚并未连接至 JP1 I/O 连接器。用户可通过将 R11/R23 处的 0 欧电阻移至 R12/R24 处，以将 GP1O32 和 GPIO33 的连接从晶振移至 JP1。
.. _get-started-esp-wrover-kit-v4.1-spi-flash-header:
SPI Flash / JP2
^^^^^^^^^^^^^^^
==== =============
. ESP32 管脚
==== =============
1. CLK / GPIO6
2. SD0 / GPIO7
3. SD1 / GPIO8
4. SD2 / GPIO9
5. SD3 / GPIO10
6. CMD / GPIO11
==== =============
.. important::
模组的 flash 总线已通过 0 欧电阻 R140 ~ R145 连接至排针 JP2。如果需要将 flash 的工作频率控制在 80 MHz，以达到保证总线信号完整性等目的，建议移除 R140 ~ R145 电阻，将模组的 flash 总线与排针 JP2 断开。
.. _get-started-esp-wrover-kit-v4.1-jtag-header:
JTAG / JP2
^^^^^^^^^^
==== ============== =============
. ESP32 管脚 JTAG 信号
==== ============== =============
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:
摄像头 / JP4
^^^^^^^^^^^^
==== ========== =============================
. ESP32 管脚 摄像头信号
==== ========== =============================
1. n/a 3.3V
2. n/a 地
3. GPIO27 SIO_C / SCCB 时钟
4. GPIO26 SIO_D / SCCB 数据
5. GPIO25 VSYNC / 垂直同步
6. GPIO23 HREF / 水平参考
7. GPIO22 PCLK / 像素时钟
8. GPIO21 XCLK / 系统时钟
9. GPIO35 D7 / 像素数据 Bit 7
10. GPIO34 D6 / 像素数据 Bit 6
11. GPIO39 D5 / 像素数据 Bit 5
12. GPIO36 D4 / 像素数据 Bit 4
13. GPIO19 D3 / 像素数据 Bit 3
14. GPIO18 D2 / 像素数据 Bit 2
15. GPIO5 D1 / 像素数据 Bit 1
16. GPIO4 D0 / 像素数据 Bit 0
17. GPIO0 RESET / 摄像头复位
18. n/a PWDN / 摄像头断电
==== ========== =============================
* D0 到 D7 为摄像头的数据总线
.. _get-started-esp-wrover-kit-v4.1-rgb-led-connections:
RGB LED
^^^^^^^
==== ========== =========
. ESP32 管脚 RGB LED
==== ========== =========
1. GPIO0 红色
2. GPIO2 绿色
3. GPIO4 蓝色
==== ========== =========
.. _get-started-esp-wrover-kit-v4.1-microsd-card-slot:
MicroSD 卡
^^^^^^^^^^^^
==== ============== ===============
. ESP32 管脚 MicroSD 信号
==== ============== ===============
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:
LCD / U5
^^^^^^^^
==== ============== ===============
. ESP32 管脚 LCD 信号
==== ============== ===============
1. GPIO18 复位
2. GPIO19 SCL
3. GPIO21 D/C
4. GPIO22 CS
5. GPIO23 SDA
6. GPIO25 SDO
7. GPIO5 背光
==== ============== ===============
.. _get-started-esp-wrover-kit-start-development:
应用程序开发
-----------------------------
ESP-WROVER-KIT 上电前，请首先确认开发板完好无损。
初始设置
^^^^^^^^^^^^^
请严格按照下图所示连接跳线帽，注意不要额外连接其他跳线帽。
- 使用 JP7 连接器，选择 USB 为开发板供电。
- 使用 JP2 连接器，使能 UART 通信。
======================== ==========================
USB 供电 使能 UART 通信
======================== ==========================
|jp7-usb_5v| |jp2-tx-rx|
======================== ==========================
注意不要连接其他跳线帽。
打开 **电源开关**，**5V Power On LED** 应点亮。
正式开始开发
^^^^^^^^^^^^^^^^^^
现在，请前往 :doc:`index` 中的 :ref:`get-started-step-by-step` 章节，查看如何设置开发环境，并尝试将示例项目烧录至您的开发板。
相关文档
-----------------
* `ESP-WROVER-KIT V4.1 原理图`_ (PDF)
* `《ESP32 技术规格书》 <https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf>`_ (PDF)
* `《ESP32-WROVER-B 技术规格书》 <https://espressif.com/sites/default/files/documentation/esp32-wrover-b_datasheet_cn.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 原理图: 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

6
docs/zh_CN/get-started/index.rst
View file

@ -57,9 +57,9 @@ ESP32 采用 40 nm 工艺制成，具有最佳的功耗性能、射频性能、
.. toctree::
:maxdepth: 1
ESP32-DevKitC <get-started-devkitc>
ESP-WROVER-KIT <get-started-wrover-kit>
ESP32-PICO-KIT <get-started-pico-kit>
ESP32-DevKitC <../hw-reference/get-started-devkitc>
ESP-WROVER-KIT <../hw-reference/get-started-wrover-kit>
ESP32-PICO-KIT <../hw-reference/get-started-pico-kit>
ESP32-Ethernet-Kit <../hw-reference/get-started-ethernet-kit>

7
docs/zh_CN/get-started-cmake/get-started-devkitc-v2.rst → docs/zh_CN/hw-reference/get-started-devkitc-v2.rst
View file

@ -1,4 +1,4 @@
ESP32-DevKitC V2 入门指南 (CMake)
ESP32-DevKitC V2 入门指南
==================================
:link_to_translation:`en: [English]`
@ -71,7 +71,10 @@ ESP32-DevKitC V2 开发板
ESP32-DevKitC V2 上电前，请首先确认开发板完好无损。
之后，请前往 :doc:`index` 的 :ref:`get-started-step-by-step-cmake` 章节，查看如何设置开发环境，并尝试将示例项目烧录至您的开发板。
之后，请前往 :doc:`../get-started-cmake/index` 中的 :ref:`get-started-step-by-step-cmake` 章节，查看如何设置开发环境，并尝试将示例项目烧录至您的开发板。
如需使用较早 GNU Make 编译系统，则请参考 :ref:`get-started-step-by-step` 章节。
相关文档
--------

6
docs/zh_CN/get-started-cmake/get-started-devkitc.rst → docs/zh_CN/hw-reference/get-started-devkitc.rst
View file

@ -1,4 +1,4 @@
ESP32-DevKitC V4 入门指南 (CMake)
ESP32-DevKitC V4 入门指南
=============================================
:link_to_translation:`en: [English]`
@ -121,7 +121,9 @@ C15（黄色）在 ESP32-DevKitC V4 开发板上的位置
ESP32-DevKitC V4 上电前，请首先确认开发板完好无损。
之后，请前往 :doc:`index` 的 :ref:`get-started-step-by-step-cmake` 章节，查看如何设置开发环境，并尝试将示例项目烧录至您的开发板。
之后，请前往 :doc:`../get-started-cmake/index` 中的 :ref:`get-started-step-by-step-cmake` 章节，查看如何设置开发环境，并尝试将示例项目烧录至您的开发板。
如需使用较早 GNU Make 编译系统，则请参考 :ref:`get-started-step-by-step` 章节。
开发板尺寸

6
docs/zh_CN/get-started-cmake/get-started-pico-kit-v3.rst → docs/zh_CN/hw-reference/get-started-pico-kit-v3.rst
View file

@ -1,4 +1,4 @@
ESP32-PICO-KIT V3 入门指南（CMake）
ESP32-PICO-KIT V3 入门指南
=======================================
:link_to_translation:`en:[English]`
@ -65,7 +65,9 @@ EN 复位按键。
ESP32-PICO-KIT V3 上电前，请首先确认开发板完好无损。
之后，请前往 :doc:`index` 中的 :ref:`get-started-step-by-step-cmake` 章节，查看如何设置开发环境，并尝试将示例项目烧录至您的开发板。
之后，请前往 :doc:`../get-started-cmake/index` 中的 :ref:`get-started-step-by-step-cmake` 章节，查看如何设置开发环境，并尝试将示例项目烧录至您的开发板。
如需使用较早 GNU Make 编译系统，则请参考 :ref:`get-started-step-by-step` 章节。
相关文档

6
docs/zh_CN/get-started-cmake/get-started-pico-kit.rst → docs/zh_CN/hw-reference/get-started-pico-kit.rst
View file

@ -1,4 +1,4 @@
ESP32-PICO-KIT V4/V4.1 入门指南（CMake）
ESP32-PICO-KIT V4/V4.1 入门指南
=======================================================
:link_to_translation:`en:[English]`
@ -190,7 +190,9 @@ No. Name Type Function
ESP32-PICO-KIT 上电前，请首先确认开发板完好无损。
之后，请前往 :doc:`index` 中的 :ref:`get-started-step-by-step-cmake` 章节，查看如何设置开发环境，并尝试将示例目烧录至您的开发板。
之后，请前往 :doc:`../get-started-cmake/index` 中的 :ref:`get-started-step-by-step-cmake` 章节，查看如何设置开发环境，并尝试将示例项目烧录至您的开发板。
如需使用较早 GNU Make 编译系统，则请参考 :ref:`get-started-step-by-step` 章节。
开发板尺寸

6
docs/zh_CN/get-started-cmake/get-started-wrover-kit-v2.rst → docs/zh_CN/hw-reference/get-started-wrover-kit-v2.rst
View file

@ -1,4 +1,4 @@
ESP-WROVER-KIT V2 入门指南（CMake）
ESP-WROVER-KIT V2 入门指南
===========================================
:link_to_translation:`en:[English]`
@ -167,7 +167,9 @@ USB 供电 使能 UART 通信
正式开始开发
^^^^^^^^^^^^^^^^^^
现在，请前往 :doc:`index` 中的 :ref:`get-started-step-by-step-cmake` 章节，查看如何设置开发环境，并尝试将示例项目烧录至您的开发板。
请前往 :doc:`../get-started-cmake/index` 中的 :ref:`get-started-step-by-step-cmake` 章节，查看如何设置开发环境，并尝试将示例项目烧录至您的开发板。
如需使用较早 GNU Make 编译系统，则请参考 :ref:`get-started-step-by-step` 章节。
相关文档

6
docs/zh_CN/get-started-cmake/get-started-wrover-kit-v3.rst → docs/zh_CN/hw-reference/get-started-wrover-kit-v3.rst
View file

@ -1,4 +1,4 @@
ESP-WROVER-KIT V3 入门指南（CMake）
ESP-WROVER-KIT V3 入门指南
=======================================
:link_to_translation:`en:[English]`
@ -351,7 +351,9 @@ USB 供电 使能 UART 通信
正式开始开发
^^^^^^^^^^^^^^^^^^
现在，请前往 :doc:`index` 中的 :ref:`get-started-step-by-step-cmake` 章节，查看如何设置开发环境，并尝试将示例项目烧录至您的开发板。
请前往 :doc:`../get-started-cmake/index` 中的 :ref:`get-started-step-by-step-cmake` 章节，查看如何设置开发环境，并尝试将示例项目烧录至您的开发板。
如需使用较早 GNU Make 编译系统，则请参考 :ref:`get-started-step-by-step` 章节。
相关文档

6
docs/zh_CN/get-started-cmake/get-started-wrover-kit.rst → docs/zh_CN/hw-reference/get-started-wrover-kit.rst
View file

@ -1,4 +1,4 @@
ESP-WROVER-KIT V4.1 入门指南（CMake）
ESP-WROVER-KIT V4.1 入门指南
=========================================
:link_to_translation:`en:[English]`
@ -356,7 +356,9 @@ USB 供电 使能 UART 通信
正式开始开发
^^^^^^^^^^^^^^^^^^
现在，请前往 :doc:`index` 中的 :ref:`get-started-step-by-step-cmake` 章节，查看如何设置开发环境，并尝试将示例项目烧录至您的开发板。
请前往 :doc:`../get-started-cmake/index` 中的 :ref:`get-started-step-by-step-cmake` 章节，查看如何设置开发环境，并尝试将示例项目烧录至您的开发板。
如需使用较早 GNU Make 编译系统，则请参考 :ref:`get-started-step-by-step` 章节。
相关文档