From 781d7608731c6dde6d786eba963cbb63791aec82 Mon Sep 17 00:00:00 2001 From: Wang Fang Date: Wed, 25 Aug 2021 16:38:45 +0800 Subject: [PATCH] docs: udpate devkitc and wrover-kit boards --- .../esp32/get-started-devkitc.rst | 58 ++++---- .../esp32/get-started-wrover-kit.rst | 107 +++++++-------- .../esp32/get-started-devkitc.rst | 126 ++++++++++++++---- .../esp32/get-started-wrover-kit.rst | 17 ++- 4 files changed, 197 insertions(+), 111 deletions(-) diff --git a/docs/en/hw-reference/esp32/get-started-devkitc.rst b/docs/en/hw-reference/esp32/get-started-devkitc.rst index 4263c8701c..c325ef5ca0 100644 --- a/docs/en/hw-reference/esp32/get-started-devkitc.rst +++ b/docs/en/hw-reference/esp32/get-started-devkitc.rst @@ -3,7 +3,7 @@ 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`. +This guide shows how to start using the ESP32-DevKitC V4 development board. What You Need @@ -27,6 +27,7 @@ To cover a wide range of user requirements, the following versions of ESP32-DevK - different ESP32 modules + - `ESP32-WROOM-DA `_ - `ESP32-WROOM-32E `_ - `ESP32-WROOM-32UE `_ - `ESP32-WROOM-32D `_ @@ -55,31 +56,34 @@ The following figure and the table below describe the key components, interfaces 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. | -+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +.. list-table:: + :widths: 25 75 + :header-rows: 1 - .. note:: + * - Key Component + - Description + * - ESP32-WROOM-32 + - A module with ESP32 at its core. For more information, see `ESP32-WROOM-32 Datasheet`_. + * - 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-WROOM-32 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. - 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:: - .. 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. - 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. +.. 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 @@ -154,8 +158,7 @@ No. Name Type Function P: Power supply; I: Input; - O: Output; - T: High impedance. + O: Output. Pin Layout ^^^^^^^^^^^ @@ -201,10 +204,10 @@ Board Dimensions .. figure:: ../../../_static/esp32-devkitc-dimensions-back.jpg :align: center - :alt: ESP32 DevKitC board dimensions - back + :alt: Dimensions of ESP32-DevKitC board with ESP32-WROOM-32 module soldered - back :figclass: align-center - ESP32 DevKitC board dimensions - back + Dimensions of ESP32-DevKitC board with ESP32-WROOM-32 module soldered - back Related Documents @@ -212,6 +215,7 @@ Related Documents * `ESP32-DevKitC V4 schematics`_ (PDF) * `ESP32 Datasheet`_ (PDF) +* `ESP32-WROOM-DA Datasheet`_ (PDF) * `ESP32-WROOM-32 Datasheet`_ (PDF) * `ESP32-WROOM-32D and ESP32-WROOM-32U Datasheet`_ (PDF) * `ESP32-WROVER Datasheet`_ (PDF) @@ -226,8 +230,10 @@ For further design documentation for the board, please contact us at `sales@espr .. _ESP32-WROOM-32D and ESP32-WROOM-32U Datasheet: https://www.espressif.com/sites/default/files/documentation/esp32-wroom-32d_esp32-wroom-32u_datasheet_en.pdf .. _ESP32-WROVER Datasheet: https://espressif.com/sites/default/files/documentation/esp32-wrover_datasheet_en.pdf .. _ESP32-WROVER-B Datasheet: https://www.espressif.com/sites/default/files/documentation/esp32-wrover-b_datasheet_en.pdf +.. _ESP32-WROOM-DA Datasheet: https://www.espressif.com/sites/default/files/documentation/esp32-wroom-da_datasheet_en.pdf .. _ESP Product Selector: https://products.espressif.com/#/product-selector?names= + .. toctree:: :hidden: diff --git a/docs/en/hw-reference/esp32/get-started-wrover-kit.rst b/docs/en/hw-reference/esp32/get-started-wrover-kit.rst index 1055794c3d..19b17d9e4d 100644 --- a/docs/en/hw-reference/esp32/get-started-wrover-kit.rst +++ b/docs/en/hw-reference/esp32/get-started-wrover-kit.rst @@ -2,7 +2,7 @@ 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`. +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. What You Need @@ -22,7 +22,7 @@ ESP-WROVER-KIT is an ESP32-based development board produced by `Espressif ` * MicroSD - :ref:`MicroSD Card / J4 ` * LCD - :ref:`LCD / U5 ` -* PSRAM - ESP32-WROVER-B's PSRAM +* PSRAM - ESP32-WROVER-E's PSRAM .. _get-started-esp-wrover-kit-v4.1-xtal: @@ -306,7 +309,7 @@ MicroSD Card 4 MTMS / GPIO14 CLK 5 GPIO2 DATA0 6 GPIO4 DATA1 -7 GPIO21 CD +7 GPIO21 Card Detect ==== ============== =============== @@ -367,7 +370,7 @@ Related Documents * `ESP-WROVER-KIT V4.1 schematic`_ (PDF) * `ESP-WROVER-KIT V4.1 layout `_ (DXF) may be opened online with `Autodesk Viewer `_ * `ESP32 Datasheet `_ (PDF) -* `ESP32-WROVER-B Datasheet `_ (PDF) +* `ESP32-WROVER-E Datasheet `_ (PDF) * :doc:`../../api-guides/jtag-debugging/index` * :doc:`../../hw-reference/index` diff --git a/docs/zh_CN/hw-reference/esp32/get-started-devkitc.rst b/docs/zh_CN/hw-reference/esp32/get-started-devkitc.rst index 271e23d320..a1e70ed725 100644 --- a/docs/zh_CN/hw-reference/esp32/get-started-devkitc.rst +++ b/docs/zh_CN/hw-reference/esp32/get-started-devkitc.rst @@ -3,8 +3,7 @@ ESP32-DevKitC V4 入门指南 :link_to_translation:`en: [English]` -本指南介绍了如何开始使用 ESP32-DevKitC V4 开发板。有关 ESP32-DevKitC 其他版本的介绍,请见::doc:`../../hw-reference/index`。 - +本指南介绍了如何开始使用 ESP32-DevKitC V4 开发板。 准备工作 ----------- @@ -27,13 +26,14 @@ ESP32-DevKitC V4 是 `乐鑫 `_ 一款基于 ESP32 的小 - 可选多款 ESP32 模组 - - `ESP32-WROOM-32E `_ - - `ESP32-WROOM-32UE `_ - - `ESP32-WROOM-32D `_ - - `ESP32-WROOM-32U `_ + - `ESP32-WROOM-32E `_ + - `ESP32-WROOM-32UE `_ + - `ESP32-WROOM-32D `_ + - `ESP32-WROOM-32U `_ - `ESP32-SOLO-1 `_ - - `ESP32-WROVER-E `_ - - `ESP32-WROVER-IE `_ + - `ESP32-WROVER-E `_ + - `ESP32-WROVER-IE `_ + - `ESP32-WROOM-DA `_ - 可选排针或排母 @@ -49,11 +49,11 @@ 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 + :align: center + :alt: ESP32-DevKitC V4(板载 ESP32-WROOM-32) + :figclass: align-center -ESP32-DevKitC V4(板载 ESP32-WROOM-32) + ESP32-DevKitC V4(板载 ESP32-WROOM-32) .. list-table:: @@ -68,10 +68,10 @@ ESP32-DevKitC V4(板载 ESP32-WROOM-32) - 复位按键。 * - Boot - 下载按键。按下 **Boot** 键并保持,同时按一下 **EN** 键(此时不要松开 **Boot** 键)进入“固件下载”模式,通过串口下载固件。 - * - USB-to-UART 桥接器 | 单芯片 USB-UART 桥接器,可提供高达 3 Mbps 的传输速率。 - - Micro USB 端口 - * - USB 接口。 - - 可用作电路板的供电电源,或连接 PC 和 ESP32-WROOM-32 模组的通信接口。 + * - USB-to-UART 桥接器 + - 单芯片 USB-UART 桥接器,可提供高达 3 Mbps 的传输速率。 + * - Micro USB 接口。 + - USB 接口,可用作电路板的供电电源,或连接 PC 和 ESP32-WROOM-32 模组的通信接口。 * - 5V Power On LED - 开发板通电后(USB 或外部 5 V),该指示灯将亮起。更多信息,请见 `相关文档`_ 中的原理图。 * - I/O @@ -99,6 +99,77 @@ ESP32-DevKitC V4(板载 ESP32-WROOM-32) 上述供电模式 **不可同时连接**,否则可能会损坏开发板和/或电源。 +排针 +------------ + +下表列出了开发板两侧排针(J1 和 J3)的名称和功能,排针名称如图 :ref:`get-started-esp32-devkitc-board-front` 中所示,排针编号与 `ESP32-DevKitC V4 原理图`_ (PDF) 一致。 + +J1 +^^^ +==== ==== ===== =================================== +编号 名称 类型 功能 +==== ==== ===== =================================== +1 3V3 P 3.3 V 电源 +2 EN I CHIP_PU, Reset +3 IO36 I GPIO36, ADC1_CH0, S_VP +4 IO39 I GPIO39, ADC1_CH3, S_VN +5 IO34 I GPIO34, ADC1_CH6, VDET_1 +6 IO35 I GPIO35, ADC1_CH7, VDET_2 +7 IO32 I/O GPIO32, ADC1_CH4, TOUCH_CH9, XTAL_32K_P +8 IO33 I/O GPIO33, ADC1_CH5, TOUCH_CH8, XTAL_32K_N +9 IO25 I/O GPIO25, ADC1_CH8, DAC_1 +10 IO26 I/O GPIO26, ADC2_CH9, DAC_2 +11 IO27 I/O GPIO27, ADC2_CH7, TOUCH_CH7 +12 IO14 I/O GPIO14, ADC2_CH6, TOUCH_CH6, MTMS +13 IO12 I/O GPIO12, ADC2_CH5, TOUCH_CH5, MTDI +14 GND G 接地 +15 IO13 I/O GPIO13, ADC2_CH4, TOUCH_CH4, MTCK +16 IO9 I/O GPIO9, D2 +17 IO10 I/O GPIO10, D3 +18 IO11 I/O GPIO11, CMD +19 5V0 P 5 V 电源 +==== ==== ===== =================================== + +J3 +^^^ +==== ==== ===== =================================== +编号 名称 类型 功能 +==== ==== ===== =================================== +1 GND G 接地 +2 IO23 I/O GPIO23 +3 IO22 I/O GPIO22 +4 IO1 I/O GPIO1, U0TXD +5 IO3 I/O GPIO3, U0RXD +6 IO21 I/O GPIO21 +7 GND G 接地 +8 IO19 I/O GPIO19 +9 IO18 I/O GPIO18 +10 IO5 I/O GPIO5 +11 IO17 I/O GPIO17 +12 IO16 I/O GPIO16 +13 IO4 I/O GPIO4, ADC2_CH0, TOUCH_CH0 +14 IO0 I/O GPIO0, ADC2_CH1, TOUCH_CH1, Boot +16 IO2 I/O GPIO2, ADC2_CH2, TOUCH_CH2 +17 IO15 I/O GPIO15, ADC2_CH3, TOUCH_CH3, MTDO +17 IO8 I/O GPIO8, D1 +18 IO7 I/O GPIO7, D0 +19 IO6 I/O GPIO6, SCK +==== ==== ===== =================================== + + P:电源; + I:输入; + O:输出。 + +管脚布局 +^^^^^^^^^^^ +.. figure:: ../../../_static/esp32-devkitC-v4-pinout.jpg + :align: center + :scale: 45% + :alt: ESP32-DevKitC 管脚布局(点击放大) + :figclass: align-center + + ESP32-DevKitC 管脚布局(点击放大) + 有关 C15 的提示 -------------------- @@ -110,13 +181,14 @@ ESP32-DevKitC V4(板载 ESP32-WROOM-32) 用户如果认为 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 开发板上的位置 +.. figure:: ../../../_static/esp32-devkitc-c15-location.png + :align: center + :alt: C15(黄色)在 ESP32-DevKitC V4 开发板上的位置 + :figclass: align-center + :width: 30% + + C15(黄色)在 ESP32-DevKitC V4 开发板上的位置 应用程序开发 @@ -130,11 +202,12 @@ ESP32-DevKitC V4 上电前,请首先确认开发板完好无损。 ------------- .. figure:: ../../../_static/esp32-devkitc-dimensions-back.jpg - :align: center - :alt: ESP32-DevKitC 开发板尺寸 -- 仰视图 - :figclass: align-center + :align: center + :alt: ESP32-DevKitC 开发板尺寸(板载 ESP32-WROOM-32 模组)-- 仰视图 + :figclass: align-center + :width: 30% -ESP32-DevKitC 开发板尺寸 -- 仰视图 + ESP32-DevKitC 开发板尺寸(板载 ESP32-WROOM-32 模组)-- 仰视图 相关文档 @@ -146,6 +219,7 @@ ESP32-DevKitC 开发板尺寸 -- 仰视图 * `《ESP32-WROOM-32D & ESP32-WROOM-32U 技术规格书》 `_ (PDF) * `《ESP32-WROVER 技术规格书》 `_ (PDF) * `《ESP32-WROVER-B 技术规格书》 `_ (PDF) +* `《ESP32-WROOM-DA 技术规格书》 `_ (PDF) * `乐鑫产品选型工具 `__ .. toctree:: diff --git a/docs/zh_CN/hw-reference/esp32/get-started-wrover-kit.rst b/docs/zh_CN/hw-reference/esp32/get-started-wrover-kit.rst index deb5dd54c1..f63132374a 100644 --- a/docs/zh_CN/hw-reference/esp32/get-started-wrover-kit.rst +++ b/docs/zh_CN/hw-reference/esp32/get-started-wrover-kit.rst @@ -2,7 +2,7 @@ ESP-WROVER-KIT V4.1 入门指南 ========================================= :link_to_translation:`en:[English]` -本指南介绍了如何开始使用 ESP-WROVER-KIT V4.1 开发板及其功能和相关配置。有关 ESP-WROVER-KIT 其他版本的介绍,请见::doc:`../../hw-reference/index`。 +本指南介绍了如何开始使用 ESP-WROVER-KIT V4.1 开发板及其功能和相关配置。 准备工作 @@ -22,7 +22,7 @@ ESP-WROVER-KIT 是 `乐鑫 `_ 一款基于 ESP32 的开 ESP-WROVER-KIT 开发板已集成了如下组件: -- ESP32-WROVER-B 模组 +- ESP32-WROVER-E 模组 - LCD 屏 - MicroSD 卡槽 @@ -74,6 +74,9 @@ ESP-WROVER-KIT 开发板的主要组件、接口及控制方式见下。 下表将从图片右上角开始,以顺时针顺序介绍图 1 中的主要组件,然后按同样顺序介绍图 2 中的主要组件。 + + + .. list-table:: :widths: 25 75 :header-rows: 1 @@ -86,7 +89,7 @@ ESP-WROVER-KIT 开发板的主要组件、接口及控制方式见下。 - 32.768 kHz 晶振,可提供 Deep-sleep 下使用的低功耗时钟。 * - 0 欧电阻 - ESP-WROVER-KIT 开发板设计了一个 0 欧电阻,可在测量 ESP32 系列模组在不同功耗模式下的电流时,直接移除或替换为分流器。 - * - ESP32-WROVER-B 模组 + * - ESP32-WROVER-E 模组 - 这款 ESP32 模组内置 64-Mbit PSRAM,可提供灵活的额外存储空间和数据处理能力。 * - 诊断 LED 信号灯 - 本开发板 FT2232 芯片的 GPIO 管脚连接了 4 个红色 LED 信号灯,以备后用。 @@ -165,7 +168,7 @@ ESP32 模组的部分管脚/终端已被板上组件占用或用于外部硬件 部分管脚具备多个功能,可供板上组件或外部硬件设备同时使用,比如 GPIO0 和 GPIO2。由于管脚限制,一些外围设备不可同时使用,比如,由于 JTAG 和 SD 卡槽需共用部分管脚,因此一些使用 SD 卡功能的应用无法同时进行 JTAG 调试。 -其他情况下,不同外设可同时使用。比如,LCD 屏幕和 SD 卡仅共用一个 GPIO21 管脚,可以同时使用。该管脚可为 LCD 屏幕提供 D/C(数据/控制)信号,并用于读取来自 SD 卡槽的 CD 信号(卡检测信号)。如无需使用卡检测功能,开发人员还可以通过移除 R167 来禁用该功能。此时,LCD 和 SD 卡槽可同时使用。 +其他情况下,不同外设可同时使用。比如,LCD 屏幕和 SD 卡仅共用一个 GPIO21 管脚,可以同时使用。该管脚可为 LCD 屏幕提供 D/C(数据/控制)信号,并用于读取来自 SD 卡槽的卡检测信号。如无需使用卡检测功能,开发人员还可以通过移除 R167 来禁用该功能。此时,LCD 和 SD 卡槽可同时使用。 更多外设共享管脚的介绍,请见下一章节中的表格。 @@ -251,7 +254,7 @@ JP1 连接器包括 14 x 2 个排针,具体功能可见下表中间 “I/O” * LED - :ref:`RGB LED ` * MicroSD - :ref:`MicroSD Card / J4 ` * LCD - :ref:`LCD / U5 ` -* PSRAM - ESP32-WROVER-B 的 PSRAM +* PSRAM - ESP32-WROVER-E 的 PSRAM .. _get-started-esp-wrover-kit-v4.1-xtal: @@ -368,7 +371,7 @@ MicroSD 卡 4. MTMS / GPIO14 CLK 5. GPIO2 DATA0 6. GPIO4 DATA1 -7. GPIO21 CD +7. GPIO21 Card Detect ==== ============== =============== @@ -429,7 +432,7 @@ USB 供电 使能 UART 通信 * `ESP-WROVER-KIT V4.1 原理图`_ (PDF) * `ESP-WROVER-KIT V4.1 布局 `_ (DXF) * `《ESP32 技术规格书》 `_ (PDF) -* `《ESP32-WROVER-B 技术规格书》 `_ (PDF) +* `《ESP32-WROVER-E 技术规格书》 `_ (PDF) * :doc:`../../api-guides/jtag-debugging/index` * :doc:`../../hw-reference/index`