Merge branch 'docs/updated_DevBoards_based_on_feedbacks' into 'master'

docs:updates based on feedbacks

Closes DOC-3376, DOC-3375, DOC-3180, and DOC-3353

See merge request espressif/esp-idf!19154
pull/9491/head
Zhang Xiao Yan 2022-07-22 17:57:36 +08:00
commit a1b5dae782
7 zmienionych plików z 107 dodań i 121 usunięć

Wyświetl plik

@ -76,13 +76,6 @@ The following figure and the table below describe the key components, interfaces
* - 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
@ -101,63 +94,63 @@ There are three mutually exclusive ways to provide power to the board:
Header Block
------------
The two tables below provide the **Name** and **Function** of I/O header pins on both sides of the board, as shown in :ref:`get-started-esp32-devkitc-board-front`. The numbering and names are the same as in the `ESP32-DevKitC V4 schematics`_ (PDF).
The two tables below provide the **Name** and **Function** of I/O header pins on both sides of the board, as shown in :ref:`get-started-esp32-devkitc-board-front`.
J1
J2
^^^
=== ==== ===== ===================================
No. Name Type Function
=== ==== ===== ===================================
1 3V3 P 3.3 V power supply
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 Ground
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 power supply
=== ==== ===== ===================================
=== ==== ========== ===============================================
No. Name Type [1]_ Function
=== ==== ========== ===============================================
1 3V3 P 3.3 V power supply
2 EN I CHIP_PU, Reset
3 VP I GPIO36, ADC1_CH0, S_VP
4 VN 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 Ground
15 IO13 I/O GPIO13, ADC2_CH4, TOUCH_CH4, MTCK
16 D2 I/O GPIO9, D2 [2]_
17 D3 I/O GPIO10, D3 [2]_
18 CMD I/O GPIO11, CMD [2]_
19 5V P 5 V power supply
=== ==== ========== ===============================================
J3
^^^
=== ==== ===== ====================================
No. Name Type Function
=== ==== ===== ====================================
1 GND G Ground
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 Ground
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
=== ==== ===== ====================================
=== ==== ========== ===============================================
No. Name Type [1]_ Function
=== ==== ========== ===============================================
1 GND G Ground
2 IO23 I/O GPIO23
3 IO22 I/O GPIO22
4 TX I/O GPIO1, U0TXD
5 RX I/O GPIO3, U0RXD
6 IO21 I/O GPIO21
7 GND G Ground
8 IO19 I/O GPIO19
9 IO18 I/O GPIO18
10 IO5 I/O GPIO5
11 IO17 I/O GPIO17 [3]_
12 IO16 I/O GPIO16 [3]_
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 D1 I/O GPIO8, D1 [2]_
18 D0 I/O GPIO7, D0 [2]_
19 CLK I/O GPIO6, CLK [2]_
=== ==== ========== ===============================================
P: Power supply;
I: Input;
O: Output.
.. [1] P: Power supply; I: Input; O: Output.
.. [2] 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.
.. [3] 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.
Pin Layout
^^^^^^^^^^^

Wyświetl plik

@ -123,7 +123,7 @@ Please proceed to :doc:`../../get-started/index`, where Section :ref:`get-starte
.. attention::
ESP32-DevKitM-1 is a board with a single core module, please enable single core mode (:ref:`CONFIG_FREERTOS_UNICORE`) in :ref:`menuconfig <get-started-configure>` before flashing your applications.
ESP32-DevKitM-1 boards manufactured before December 2, 2021 have a single core module installed. To verify what module you have, please check module marking information in `PCN-2021-021 <https://www.espressif.com/sites/default/files/pcn_downloads/PCN-2021-021%20ESP32-U4WDH%20%E5%8D%87%E7%BA%A7%E4%B8%BA%E5%8F%8C%E6%A0%B8%E5%A4%84%E7%90%86%E5%99%A8%E4%BA%A7%E5%93%81.pdf>`_ . If your board has a single core module installed, please enable single core mode (:ref:`CONFIG_FREERTOS_UNICORE`) in :ref:`menuconfig <get-started-configure>` before flashing your applications.
Hardware Reference
======================

Wyświetl plik

@ -1,5 +1,5 @@
************************************
{IDF_TARGET_NAME} Hardware Reference
Hardware Reference
************************************
:link_to_translation:`zh_CN:[中文]`

Wyświetl plik

@ -303,7 +303,7 @@ How To Enable Secure Boot V2
8. When you're ready to flash the bootloader, run the specified command (you have to enter it yourself, this step is not performed by the build system) and then wait for flashing to complete.
9. Run ``idf.py flash`` to build and flash the partition table and the just-built app image. The app image will be signed using the signing key you generated in step 4.
9. Run ``idf.py flash`` to build and flash the partition table and the just-built app image. The app image will be signed using the signing key you generated in step 6.
.. note:: ``idf.py flash`` doesn't flash the bootloader if Secure Boot is enabled.

Wyświetl plik

@ -76,13 +76,6 @@ ESP32-DevKitC V4 开发板的主要组件、接口及控制方式见下。
* - 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 的开发板,板载 ESP32-WROVER 系列开发板的管脚 GPIO16 和 GPIO17 保留内部使用。
电源选项
@ -101,63 +94,63 @@ ESP32-DevKitC V4 开发板的主要组件、接口及控制方式见下。
排针
------------
下表列出了开发板两侧排针J1 和 J3的名称和功能排针名称如图 :ref:`get-started-esp32-devkitc-board-front` 中所示,排针编号与 `ESP32-DevKitC V4 原理图`_ (PDF) 一致
下表列出了开发板两侧排针J1 和 J3的名称和功能排针名称如图 :ref:`get-started-esp32-devkitc-board-front` 中所示。
J1
J2
^^^
==== ==== ===== ===================================
编号 名称 类型 功能
==== ==== ===== ===================================
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 电源
==== ==== ===== ===================================
==== ==== ========== ===========================================
编号 名称 类型 [1]_ 功能
==== ==== ========== ===========================================
1 3V3 P 3.3 V 电源
2 EN I CHIP_PU, Reset
3 VP I GPIO36, ADC1_CH0, S_VP
4 VN 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 D2 I/O GPIO9, D2 [2]_
17 D3 I/O GPIO10, D3 [2]_
18 CMD I/O GPIO11, CMD [2]_
19 5V 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
==== ==== ===== ===================================
==== ==== ========== ===========================================
编号 名称 类型 [1]_ 功能
==== ==== ========== ===========================================
1 GND G 接地
2 IO23 I/O GPIO23
3 IO22 I/O GPIO22
4 TX I/O GPIO1, U0TXD
5 RX 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 [3]_
12 IO16 I/O GPIO16 [3]_
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 D1 I/O GPIO8, D1 [2]_
18 D0 I/O GPIO7, D0 [2]_
19 CLK I/O GPIO6, CLK [2]_
==== ==== ========== ===========================================
P电源
I输入
O输出
.. [1] P电源I输入O输出。
.. [2] 管脚 D0、D1、D2、D3、CMD 和 CLK 用于 ESP32 芯片与 SPI flash 间的内部通信,集中分布在开发板两侧靠近 USB 端口的位置。通常而言,这些管脚最好不连,否则可能影响 SPI flash / SPI RAM 的工作。
.. [3] 管脚 GPIO16 和 GPIO17 仅适用于板载 ESP32-WROOM 系列和 ESP32-SOLO-1 的开发板,板载 ESP32-WROVER 系列开发板的管脚 GPIO16 和 GPIO17 保留内部使用
管脚布局
^^^^^^^^^^^

Wyświetl plik

@ -123,7 +123,7 @@ ESP32-DevKitM-1 上电前,请首先确认开发板完好无损。
.. attention::
ESP32-DevKitM-1 搭载的模组为单核 MCU 模组,烧录应用程序前,需要在 :ref:`menuconfig <get-started-configure>` 中使能单核模式 (:ref:`CONFIG_FREERTOS_UNICORE`)。
对于2021年12月2日之前生产的ESP32-DevKitM-1 搭载的模组为单核 MCU 模组。请查看 `PCN-2021-021 <https://www.espressif.com/sites/default/files/pcn_downloads/PCN-2021-021%20ESP32-U4WDH%20%E5%8D%87%E7%BA%A7%E4%B8%BA%E5%8F%8C%E6%A0%B8%E5%A4%84%E7%90%86%E5%99%A8%E4%BA%A7%E5%93%81.pdf>`_ 以确定开发板上搭载的模组是否为单核模组。对于搭载单核模组的开发板,烧录应用程序前,需要在 :ref:`menuconfig <get-started-configure>` 中使能单核模式 (:ref:`CONFIG_FREERTOS_UNICORE`)。
硬件参考
===========

Wyświetl plik

@ -1,5 +1,5 @@
*******************************
{IDF_TARGET_NAME} H/W 硬件参考
H/W 硬件参考
*******************************
:link_to_translation:`en:[English]`