From 1a90470f02394a737e68957330c82dd1d592c4ec Mon Sep 17 00:00:00 2001 From: Marius Vikhammer Date: Wed, 11 Dec 2019 15:45:30 +0800 Subject: [PATCH] doc: Split HW-Reference into seperate files/folders for different chips --- docs/conf_common.py | 20 +- .../api-guides/esp-ble-mesh/ble-mesh-faq.rst | 2 +- docs/en/api-guides/external-ram.rst | 5 +- .../jtag-debugging/configure-wrover.rst | 4 +- docs/en/api-guides/jtag-debugging/index.rst | 18 +- .../establish-serial-connection.rst | 8 +- docs/en/get-started-legacy/index.rst | 18 +- docs/en/get-started/index.rst | 8 +- .../{ => esp32}/get-started-devkitc-v2.rst | 4 +- .../{ => esp32}/get-started-devkitc.rst | 16 +- .../get-started-ethernet-kit-v1.0.rst | 26 +- .../{ => esp32}/get-started-ethernet-kit.rst | 32 +- .../{ => esp32}/get-started-pico-kit-v3.rst | 8 +- .../{ => esp32}/get-started-pico-kit.rst | 18 +- .../{ => esp32}/get-started-wrover-kit-v2.rst | 28 +- .../{ => esp32}/get-started-wrover-kit-v3.rst | 26 +- .../{ => esp32}/get-started-wrover-kit.rst | 26 +- .../esp32/inc/modules-and-boards-esp32.rst | 289 +++++++++++++ .../inc/modules-and-boards-previous-esp32.rst | 179 ++++++++ .../inc/modules-and-boards-esp32s2.rst | 21 + .../modules-and-boards-previous-esp32s2.rst | 12 + docs/en/hw-reference/index.rst | 2 +- .../modules-and-boards-previous.rst | 179 +------- docs/en/hw-reference/modules-and-boards.rst | 291 +------------ docs/zh_CN/api-guides/external-ram.rst | 2 +- .../jtag-debugging/configure-wrover.rst | 6 +- .../zh_CN/api-guides/jtag-debugging/index.rst | 4 +- .../jtag-debugging/tips-and-quirks.rst | 2 +- .../api-reference/system/power_management.rst | 2 +- docs/zh_CN/get-started-legacy/index.rst | 12 +- docs/zh_CN/get-started/index.rst | 8 +- .../{ => esp32}/get-started-devkitc-v2.rst | 6 +- .../{ => esp32}/get-started-devkitc.rst | 14 +- .../get-started-ethernet-kit-v1.0.rst | 18 +- .../esp32/get-started-ethernet-kit.rst | 1 + .../{ => esp32}/get-started-pico-kit-v3.rst | 12 +- .../{ => esp32}/get-started-pico-kit.rst | 20 +- .../{ => esp32}/get-started-wrover-kit-v2.rst | 32 +- .../{ => esp32}/get-started-wrover-kit-v3.rst | 28 +- .../{ => esp32}/get-started-wrover-kit.rst | 54 +-- .../esp32/inc/modules-and-boards-esp32.rst | 294 +++++++++++++ .../inc/modules-and-boards-previous-esp32.rst | 1 + .../inc/modules-and-boards-esp32s2.rst | 1 + .../modules-and-boards-previous-esp32s2.rst | 1 + .../hw-reference/get-started-ethernet-kit.rst | 409 ------------------ docs/zh_CN/hw-reference/index.rst | 2 +- .../modules-and-boards-previous.rst | 25 +- .../zh_CN/hw-reference/modules-and-boards.rst | 297 +------------ 48 files changed, 1077 insertions(+), 1414 deletions(-) rename docs/en/hw-reference/{ => esp32}/get-started-devkitc-v2.rst (92%) rename docs/en/hw-reference/{ => esp32}/get-started-devkitc.rst (92%) rename docs/en/hw-reference/{ => esp32}/get-started-ethernet-kit-v1.0.rst (95%) rename docs/en/hw-reference/{ => esp32}/get-started-ethernet-kit.rst (95%) rename docs/en/hw-reference/{ => esp32}/get-started-pico-kit-v3.rst (88%) rename docs/en/hw-reference/{ => esp32}/get-started-pico-kit.rst (94%) rename docs/en/hw-reference/{ => esp32}/get-started-wrover-kit-v2.rst (90%) rename docs/en/hw-reference/{ => esp32}/get-started-wrover-kit-v3.rst (94%) rename docs/en/hw-reference/{ => esp32}/get-started-wrover-kit.rst (94%) create mode 100644 docs/en/hw-reference/esp32/inc/modules-and-boards-esp32.rst create mode 100644 docs/en/hw-reference/esp32/inc/modules-and-boards-previous-esp32.rst create mode 100644 docs/en/hw-reference/esp32s2/inc/modules-and-boards-esp32s2.rst create mode 100644 docs/en/hw-reference/esp32s2/inc/modules-and-boards-previous-esp32s2.rst rename docs/zh_CN/hw-reference/{ => esp32}/get-started-devkitc-v2.rst (87%) rename docs/zh_CN/hw-reference/{ => esp32}/get-started-devkitc.rst (89%) rename docs/zh_CN/hw-reference/{ => esp32}/get-started-ethernet-kit-v1.0.rst (94%) create mode 100644 docs/zh_CN/hw-reference/esp32/get-started-ethernet-kit.rst rename docs/zh_CN/hw-reference/{ => esp32}/get-started-pico-kit-v3.rst (89%) rename docs/zh_CN/hw-reference/{ => esp32}/get-started-pico-kit.rst (94%) rename docs/zh_CN/hw-reference/{ => esp32}/get-started-wrover-kit-v2.rst (89%) rename docs/zh_CN/hw-reference/{ => esp32}/get-started-wrover-kit-v3.rst (94%) rename docs/zh_CN/hw-reference/{ => esp32}/get-started-wrover-kit.rst (92%) create mode 100644 docs/zh_CN/hw-reference/esp32/inc/modules-and-boards-esp32.rst create mode 100644 docs/zh_CN/hw-reference/esp32/inc/modules-and-boards-previous-esp32.rst create mode 100644 docs/zh_CN/hw-reference/esp32s2/inc/modules-and-boards-esp32s2.rst create mode 100644 docs/zh_CN/hw-reference/esp32s2/inc/modules-and-boards-previous-esp32s2.rst delete mode 100644 docs/zh_CN/hw-reference/get-started-ethernet-kit.rst diff --git a/docs/conf_common.py b/docs/conf_common.py index 7fd6b83a6..6d4e94b0e 100644 --- a/docs/conf_common.py +++ b/docs/conf_common.py @@ -136,19 +136,18 @@ def update_exclude_patterns(tags): 'api-reference/system/himem.rst', 'api-reference/bluetooth/**', 'api-reference/system/ipc.rst', - 'hw-reference/get-started-devkitc-v2.rst', - 'hw-reference/get-started-devkitc.rst', - 'hw-reference/get-started-ethernet-kit-v1.0.rst', - 'hw-reference/get-started-ethernet-kit.rst', - 'hw-reference/get-started-pico-kit-v3.rst', - 'hw-reference/get-started-pico-kit.rst', - 'hw-reference/get-started-wrover-kit-v2.rst', - 'hw-reference/get-started-wrover-kit-v3.rst', - 'hw-reference/get-started-wrover-kit.rst', 'get-started-legacy/**', - 'gnu-make-legacy.rst']: + 'gnu-make-legacy.rst', + 'hw-reference/esp32/**']: exclude_patterns.append(e) + if "esp32s2" not in tags: + # Exclude ESP32-only document pages so they aren't found in the initial search for .rst files + # note: in toctrees, these also need to be marked with a :esp32: filter + for e in ['hw-reference/esp32s2/**']: + exclude_patterns.append(e) + + # The reST default role (used for this markup: `text`) to use for all # documents. # default_role = None @@ -349,7 +348,6 @@ texinfo_documents = [ # texinfo_no_detailmenu = False - # Override RTD CSS theme to introduce the theme corrections # https://github.com/rtfd/sphinx_rtd_theme/pull/432 def setup(app): diff --git a/docs/en/api-guides/esp-ble-mesh/ble-mesh-faq.rst b/docs/en/api-guides/esp-ble-mesh/ble-mesh-faq.rst index 55eaddca7..4dc2cfd4a 100644 --- a/docs/en/api-guides/esp-ble-mesh/ble-mesh-faq.rst +++ b/docs/en/api-guides/esp-ble-mesh/ble-mesh-faq.rst @@ -527,7 +527,7 @@ Generally, a Provisioner is used to provision unprovisioned devices and form a m 3.2 Why is the Wi-Fi throughput so low when Wi-Fi and ESP-BLE-MESH coexist? ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - The `ESP32-DevKitC <../../hw-reference/get-started-devkitc>`_ board without PSRAM can run properly but the throughput of it is low since it has no PSRAM. When Bluetooth and Wi-Fi coexist, the throughput of ESP32-DevKitC with PSRAM can be stabilized to more than 1Mbps. + The `ESP32-DevKitC <../../hw-reference/esp32/get-started-devkitc>`_ board without PSRAM can run properly but the throughput of it is low since it has no PSRAM. When Bluetooth and Wi-Fi coexist, the throughput of ESP32-DevKitC with PSRAM can be stabilized to more than 1Mbps. And some configurations in menuconfig shall be enabled to support PSRAM. diff --git a/docs/en/api-guides/external-ram.rst b/docs/en/api-guides/external-ram.rst index 1c05be4a5..182e167e5 100644 --- a/docs/en/api-guides/external-ram.rst +++ b/docs/en/api-guides/external-ram.rst @@ -33,8 +33,9 @@ The ESP-PSRAM32 chip is a 1.8 V device which can only be used in parallel with a Connections for ESP32D2W* chips are TBD. - .. NOTE:: - Espressif produces the line of ESP32-WROVER modules which contain ESP32, 1.8 V flash, and ESP-PSRAM32. These modules are ready to be mounted on an end product PCB. + .. note:: + + Espressif produces the line of ESP32-WROVER modules which contain ESP32, 1.8 V flash, and ESP-PSRAM32. These modules are ready to be mounted on an end product PCB. .. _external_ram_config: diff --git a/docs/en/api-guides/jtag-debugging/configure-wrover.rst b/docs/en/api-guides/jtag-debugging/configure-wrover.rst index d80001694..93d08179a 100644 --- a/docs/en/api-guides/jtag-debugging/configure-wrover.rst +++ b/docs/en/api-guides/jtag-debugging/configure-wrover.rst @@ -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:`../../hw-reference/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/esp32/get-started-wrover-kit`, Section :ref:`get-started-esp-wrover-kit-v4.1-setup-options`. 2. Verify if ESP32 pins used for JTAG communication are not connected to some other h/w that may disturb JTAG operation: @@ -104,7 +104,7 @@ On macOS, using FT2232 for JTAG and serial port at the same time needs some addi 1. Manually unload the FTDI serial port driver before starting OpenOCD, start OpenOCD, then load the serial port driver. -2. Modify FTDI driver configuration so that it doesn't load itself for channel B of FT2232 chip, which is the channel used for JTAG on WROVER KIT. +2. Modify FTDI driver configuration so that it doesn't load itself for channel B of FT2232 chip, which is the channel used for JTAG on WROVER KIT. Manually unloading the driver ............................. diff --git a/docs/en/api-guides/jtag-debugging/index.rst b/docs/en/api-guides/jtag-debugging/index.rst index 44eff3595..475279da4 100644 --- a/docs/en/api-guides/jtag-debugging/index.rst +++ b/docs/en/api-guides/jtag-debugging/index.rst @@ -279,20 +279,10 @@ Tips and Quirks This section provides collection of links to all tips and quirks referred to from various parts of this guide. -* :ref:`jtag-debugging-tip-breakpoints` -* :ref:`jtag-debugging-tip-where-breakpoints` -* :ref:`jtag-debugging-tip-flash-mappings` -* :ref:`jtag-debugging-tip-why-next-works-as-step` -* :ref:`jtag-debugging-tip-code-options` -* :ref:`jtag-debugging-tip-freertos-support` -* :ref:`jtag-debugging-tip-code-flash-voltage` -* :ref:`jtag-debugging-tip-optimize-jtag-speed` -* :ref:`jtag-debugging-tip-debugger-startup-commands` -* :ref:`jtag-debugging-tip-openocd-configure-target` -* :ref:`jtag-debugging-tip-reset-by-debugger` -* :ref:`jtag-debugging-tip-jtag-pins-reconfigured` -* :ref:`jtag-debugging-tip-at-firmware-issue` -* :ref:`jtag-debugging-tip-reporting-issues` +.. toctree:: + :maxdepth: 2 + + tips-and-quirks Related Documents diff --git a/docs/en/get-started-legacy/establish-serial-connection.rst b/docs/en/get-started-legacy/establish-serial-connection.rst index 83a4f933b..d52ab57b0 100644 --- a/docs/en/get-started-legacy/establish-serial-connection.rst +++ b/docs/en/get-started-legacy/establish-serial-connection.rst @@ -3,7 +3,7 @@ Establish Serial Connection with ESP32 (Legacy GNU Make) :link_to_translation:`zh_CN:[中文]` .. include:: ../gnu-make-legacy.rst - + This section provides guidance how to establish serial connection between ESP32 and PC. @@ -30,10 +30,10 @@ Below are the links to drivers for ESP32 and other boards produced by Espressif: `ESP32-Sense Kit `_, n/a, Use with `ESP-Prog`_ .. _CP210x: https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers -.. _FTDI: http://www.ftdichip.com/Drivers/VCP.htm +.. _FTDI: http://www.ftdichip.com/Drivers/VCP.htm .. _ESP-Prog: https://github.com/espressif/esp-iot-solution/blob/master/documents/evaluation_boards/ESP-Prog_guide_en.md#introduction-to-the-esp-prog-board -* CP210x: `CP210x USB to UART Bridge VCP Drivers `_ +* CP210x: `CP210x USB to UART Bridge VCP Drivers `_ * FTDI: `FTDI Virtual COM Port Drivers `_ The drivers above are primarily for reference. Under normal circumstances, the drivers should be bundled with and operating system and automatically installed upon connecting one of the listed boards to the PC. @@ -88,7 +88,7 @@ on Arch Linux this is done by adding the user to ``uucp`` group with the followi sudo usermod -a -G uucp $USER -Make sure you re-login to enable read and write permissions for the serial port. +Make sure you re-login to enable read and write permissions for the serial port. Verify serial connection diff --git a/docs/en/get-started-legacy/index.rst b/docs/en/get-started-legacy/index.rst index e3294a418..0ea89b44c 100644 --- a/docs/en/get-started-legacy/index.rst +++ b/docs/en/get-started-legacy/index.rst @@ -59,10 +59,10 @@ If you have one of ESP32 development boards listed below, you can click on the l .. toctree:: :maxdepth: 1 - 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> + ESP32-DevKitC <../hw-reference/esp32/get-started-devkitc> + ESP-WROVER-KIT <../hw-reference/esp32/get-started-wrover-kit> + ESP32-PICO-KIT <../hw-reference/esp32/get-started-pico-kit> + ESP32-Ethernet-Kit <../hw-reference/esp32/get-started-ethernet-kit> .. _get-started-step-by-step-legacy: @@ -96,7 +96,7 @@ Step 1. Set up the Toolchain The toolchain is a set of programs for compiling code and building applications. -The quickest way to start development with ESP32 is by installing a prebuilt toolchain. Pick up your OS below and follow the provided instructions. +The quickest way to start development with ESP32 is by installing a prebuilt toolchain. Pick up your OS below and follow the provided instructions. .. toctree:: :hidden: @@ -179,7 +179,7 @@ The python packages required by ESP-IDF are located in ``IDF_PATH/requirements.t .. note:: - Please check the version of the Python interpreter that you will be using with ESP-IDF. For this, run + Please check the version of the Python interpreter that you will be using with ESP-IDF. For this, run the command ``python --version`` and depending on the result, you might want to use ``python2``, ``python2.7`` or similar instead of just ``python``, e.g.:: @@ -226,7 +226,7 @@ Step 6. Connect Your Device Now connect your ESP32 board to the computer and check under what serial port the board is visible. -Serial ports have the following patterns in their names: +Serial ports have the following patterns in their names: - **Windows**: names like ``COM1`` - **Linux**: starting with ``/dev/tty`` @@ -421,9 +421,9 @@ Some environment variables can be specified whilst calling ``make`` allowing use +-----------------+--------------------------------------------------------------+ .. note:: - + You can export environment variables (e.g. ``export ESPPORT=/dev/ttyUSB1``). - All subsequent calls of ``make`` within the same terminal session will use + All subsequent calls of ``make`` within the same terminal session will use the exported value given that the variable is not simultaneously overridden. diff --git a/docs/en/get-started/index.rst b/docs/en/get-started/index.rst index e3ea9c76c..4580acbd6 100644 --- a/docs/en/get-started/index.rst +++ b/docs/en/get-started/index.rst @@ -70,10 +70,10 @@ If you have one of {IDF_TARGET_NAME} development boards listed below, you can cl .. toctree:: :maxdepth: 1 - 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> + ESP32-DevKitC <../hw-reference/esp32/get-started-devkitc> + ESP-WROVER-KIT <../hw-reference/esp32/get-started-wrover-kit> + ESP32-PICO-KIT <../hw-reference/esp32/get-started-pico-kit> + ESP32-Ethernet-Kit <../hw-reference/esp32/get-started-ethernet-kit> .. _get-started-step-by-step: diff --git a/docs/en/hw-reference/get-started-devkitc-v2.rst b/docs/en/hw-reference/esp32/get-started-devkitc-v2.rst similarity index 92% rename from docs/en/hw-reference/get-started-devkitc-v2.rst rename to docs/en/hw-reference/esp32/get-started-devkitc-v2.rst index bef33a278..f0d2e2594 100644 --- a/docs/en/hw-reference/get-started-devkitc-v2.rst +++ b/docs/en/hw-reference/esp32/get-started-devkitc-v2.rst @@ -29,7 +29,7 @@ The following figure and the table below describe the key components, interfaces .. _get-started-esp32-devkitc-v2-board-front-make: -.. figure:: ../../_static/esp32-devkitc-v2-functional-overview.png +.. figure:: ../../../_static/esp32-devkitc-v2-functional-overview.png :align: center :alt: ESP32-DevKitC V2 board layout :figclass: align-center @@ -71,7 +71,7 @@ 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. +After that, proceed to :doc:`../../get-started/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 diff --git a/docs/en/hw-reference/get-started-devkitc.rst b/docs/en/hw-reference/esp32/get-started-devkitc.rst similarity index 92% rename from docs/en/hw-reference/get-started-devkitc.rst rename to docs/en/hw-reference/esp32/get-started-devkitc.rst index 3d1064025..c083da775 100644 --- a/docs/en/hw-reference/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. For description of other versions of ESP32-DevKitC check :doc:`../../hw-reference/index`. What You Need @@ -21,7 +21,7 @@ You can skip the introduction sections and go directly to Section `Start Applica Overview -------- -ESP32-DevKitC V4 is a small-sized ESP32-based development board produced by `Espressif `_. 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. +ESP32-DevKitC V4 is a small-sized ESP32-based development board produced by `Espressif `_. 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: @@ -48,7 +48,7 @@ The following figure and the table below describe the key components, interfaces .. _get-started-esp32-devkitc-board-front: -.. figure:: ../../_static/esp32-devkitc-functional-overview.jpg +.. figure:: ../../../_static/esp32-devkitc-functional-overview.jpg :align: center :alt: ESP32-DevKitC V4 with ESP-WROOM-32 module soldered :figclass: align-center @@ -76,7 +76,7 @@ The following figure and the table below describe the key components, interfaces .. 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 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:: @@ -108,7 +108,7 @@ The component C15 may cause the following issues on earlier ESP32-DevKitC V4 boa In case these issues occur, please remove the component. The figure below shows C15 highlighted in yellow. -.. figure:: ../../_static/esp32-devkitc-c15-location.png +.. figure:: ../../../_static/esp32-devkitc-c15-location.png :align: center :alt: Location of C15 (colored yellow) on ESP32-DevKitC V4 board :figclass: align-center @@ -122,13 +122,13 @@ 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. +After that, proceed to :doc:`../../get-started/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 +.. figure:: ../../../_static/esp32-devkitc-dimensions-back.jpg :align: center :alt: ESP32 DevKitC board dimensions - back :figclass: align-center @@ -145,7 +145,7 @@ Related Documents * `ESP32-WROOM-32D & ESP32-WROOM-32U Datasheet `_ (PDF) * `ESP32-WROVER Datasheet `_ (PDF) * `ESP32-WROVER-B Datasheet `_ (PDF) -* `Espressif Product Ordering Information `_ (PDF) +* `Espressif Product Ordering Information `_ (PDF) .. toctree:: :hidden: diff --git a/docs/en/hw-reference/get-started-ethernet-kit-v1.0.rst b/docs/en/hw-reference/esp32/get-started-ethernet-kit-v1.0.rst similarity index 95% rename from docs/en/hw-reference/get-started-ethernet-kit-v1.0.rst rename to docs/en/hw-reference/esp32/get-started-ethernet-kit-v1.0.rst index 5bb64ae8e..296531993 100644 --- a/docs/en/hw-reference/get-started-ethernet-kit-v1.0.rst +++ b/docs/en/hw-reference/esp32/get-started-ethernet-kit-v1.0.rst @@ -25,7 +25,7 @@ It consists of two development boards, the Ethernet board A and the PoE board B, .. _get-started-esp32-ethernet-kit-b-v1.0: -.. figure:: ../../_static/esp32-ethernet-kit-v1.0.png +.. figure:: ../../../_static/esp32-ethernet-kit-v1.0.png :align: center :alt: ESP32-Ethernet-Kit V1.0 :figclass: align-center @@ -40,7 +40,7 @@ Functionality Overview The block diagram below shows the main components of ESP32-Ethernet-Kit and their interconnections. -.. figure:: ../../_static/esp32-ethernet-kit-block-diagram.png +.. figure:: ../../../_static/esp32-ethernet-kit-block-diagram.png :align: center :scale: 50% :alt: ESP32-Ethernet-Kit block diagram (click to enlarge) @@ -60,7 +60,7 @@ The following two figures and tables describe the key components, interfaces, an Ethernet Board (A) ^^^^^^^^^^^^^^^^^^ -.. figure:: ../../_static/esp32-ethernet-kit-a-v1.0-layout.png +.. figure:: ../../../_static/esp32-ethernet-kit-a-v1.0-layout.png :align: center :scale: 80% :alt: ESP32-Ethernet-Kit - Ethernet board (A) layout @@ -121,7 +121,7 @@ GPIO Header 1 This header provides six unpopulated through-hole solder pad PoE Board (B) ^^^^^^^^^^^^^ -This board coverts power delivered over the Ethernet cable (PoE) to provide a power supply for the Ethernet board (A). The main components of the PoE board (B) are shown on the block diagram under `Functionality Overview`_. +This board coverts power delivered over the Ethernet cable (PoE) to provide a power supply for the Ethernet board (A). The main components of the PoE board (B) are shown on the block diagram under `Functionality Overview`_. The PoE board (B) has the following features: @@ -130,7 +130,7 @@ The PoE board (B) has the following features: To take advantage of the PoE functionality the **RJ45 Port** of the Ethernet board (A) should be connected with an Ethernet cable to a switch that supports PoE. When the Ethernet board (A) detects 5 V power output from the PoE board (B), the USB power will be automatically cut off. -.. figure:: ../../_static/esp32-ethernet-kit-b-v1.0-layout.png +.. figure:: ../../../_static/esp32-ethernet-kit-b-v1.0-layout.png :align: center :scale: 80% :alt: ESP32-Ethernet-Kit - PoE board (B) @@ -171,7 +171,7 @@ DIP SW GPIO Pin Pin Functionality if DIP SW is ON 5 GPIO4 Connected to FT2232H to provide JTAG functionality 6 GPIO2 Connected to on-board 25 MHz oscillator 7 GPIO5 Connected to RESET_N input of IP101GRI - 8 n/a + 8 n/a ======= ================ ================================================================ You can make a certain GPIO pin available for other purposes by putting its DIP SW to the Off position. @@ -195,7 +195,7 @@ This is a 2 x 2 jumper pin header intended for the UART flow control. GPIO Allocation --------------- -This section describes allocation of ESP32 GPIOs to specific interfaces or functions of the ESP32-Ethernet-Kit. +This section describes allocation of ESP32 GPIOs to specific interfaces or functions of the ESP32-Ethernet-Kit. IP101GRI (PHY) Interface @@ -234,7 +234,7 @@ The allocation of the ESP32 (MAC) pins to IP101GRI (PHY) is shown in the table b GPIO Header 1 ^^^^^^^^^^^^^ -This header exposes some GPIOs that are not used elsewhere on the ESP32-Ethernet-Kit. +This header exposes some GPIOs that are not used elsewhere on the ESP32-Ethernet-Kit. ==== ================ . ESP32 Pin @@ -258,7 +258,7 @@ This header contains the GPIOs with specific MII functionality (except GPIO2), a ==== ========== ================= ================== 1 GPIO17 EMAC_CLK_180 See note 1 2 GPIO16 EMAC_CLK_OUT See note 1 - 3 GPIO4 EMAC_TX_ER + 3 GPIO4 EMAC_TX_ER 4 GPIO2 n/a See note 2 5 GPIO5 EMAC_RX_CLK See note 2 ==== ========== ================= ================== @@ -346,7 +346,7 @@ Initial Setup Now to Development ^^^^^^^^^^^^^^^^^^ -Proceed to :doc:`../get-started/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. +Proceed to :doc:`../../get-started/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. Move on to the next section only if you have successfully completed all the above steps. @@ -354,7 +354,7 @@ Move on to the next section only if you have successfully completed all the abov Configure and Load the Ethernet Example ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -After setting up the development environment and testing the board, you can configure and flash the :example:`ethernet/ethernet` example. This example has been created for testing Ethernet functionality. It supports different PHY, including **IP101GRI** installed on :ref:`ESP32-Ethernet-Kit V1.0 board `. +After setting up the development environment and testing the board, you can configure and flash the :example:`ethernet/ethernet` example. This example has been created for testing Ethernet functionality. It supports different PHY, including **IP101GRI** installed on :ref:`ESP32-Ethernet-Kit V1.0 board `. Related Documents @@ -364,8 +364,8 @@ Related Documents * `ESP32-Ethernet-Kit V1.0 PoE board (B) schematic`_ (PDF) * `ESP32 Datasheet `_ (PDF) * `ESP32-WROVER-B Datasheet `_ (PDF) -* :doc:`../api-guides/jtag-debugging/index` -* :doc:`../hw-reference/index` +* :doc:`../../api-guides/jtag-debugging/index` +* :doc:`../../hw-reference/index` .. _ESP32-Ethernet-Kit V1.0 Ethernet board (A) schematic: https://dl.espressif.com/dl/schematics/SCH_ESP32-ETHERNET-KIT_A_V1.0_20190517.pdf .. _ESP32-Ethernet-Kit V1.0 PoE board (B) schematic: https://dl.espressif.com/dl/schematics/SCH_ESP32-ETHERNET-KIT_B_V1.0_20190517.pdf diff --git a/docs/en/hw-reference/get-started-ethernet-kit.rst b/docs/en/hw-reference/esp32/get-started-ethernet-kit.rst similarity index 95% rename from docs/en/hw-reference/get-started-ethernet-kit.rst rename to docs/en/hw-reference/esp32/get-started-ethernet-kit.rst index cb8bfb31a..c0d149f76 100644 --- a/docs/en/hw-reference/get-started-ethernet-kit.rst +++ b/docs/en/hw-reference/esp32/get-started-ethernet-kit.rst @@ -25,7 +25,7 @@ It consists of two development boards, the Ethernet board A and the PoE board B. .. _get-started-esp32-ethernet-kit-v1.1: -.. figure:: ../../_static/esp32-ethernet-kit-v1.1.png +.. figure:: ../../../_static/esp32-ethernet-kit-v1.1.png :align: center :alt: ESP32-Ethernet-Kit V1.1 :figclass: align-center @@ -40,7 +40,7 @@ Functionality Overview The block diagram below shows the main components of ESP32-Ethernet-Kit and their interconnections. -.. figure:: ../../_static/esp32-ethernet-kit-v1.1-block-diagram.png +.. figure:: ../../../_static/esp32-ethernet-kit-v1.1-block-diagram.png :align: center :scale: 60% :alt: ESP32-Ethernet-Kit block diagram (click to enlarge) @@ -60,7 +60,7 @@ The following figures and tables describe the key components, interfaces, and co Ethernet Board (A) ^^^^^^^^^^^^^^^^^^ -.. figure:: ../../_static/esp32-ethernet-kit-a-v1.1-layout.png +.. figure:: ../../../_static/esp32-ethernet-kit-a-v1.1-layout.png :align: center :scale: 80% :alt: ESP32-Ethernet-Kit - Ethernet board (A) layout @@ -114,7 +114,7 @@ GPIO Header 1 This header provides six unpopulated through-hole solder pad PoE Board (B) ^^^^^^^^^^^^^ -This board coverts power delivered over the Ethernet cable (PoE) to provide a power supply for the Ethernet board (A). The main components of the PoE board (B) are shown on the block diagram under `Functionality Overview`_. +This board coverts power delivered over the Ethernet cable (PoE) to provide a power supply for the Ethernet board (A). The main components of the PoE board (B) are shown on the block diagram under `Functionality Overview`_. The PoE board (B) has the following features: @@ -123,7 +123,7 @@ The PoE board (B) has the following features: To take advantage of the PoE functionality the **RJ45 Port** of the Ethernet board (A) should be connected with an Ethernet cable to a switch that supports PoE. When the Ethernet board (A) detects 5 V power output from the PoE board (B), the USB power will be automatically cut off. -.. figure:: ../../_static/esp32-ethernet-kit-b-v1.0-layout.png +.. figure:: ../../../_static/esp32-ethernet-kit-b-v1.0-layout.png :align: center :scale: 80% :alt: ESP32-Ethernet-Kit - PoE board (B) @@ -153,7 +153,7 @@ This section describes options to configure the ESP32-Ethernet-Kit hardware. Function Switch ^^^^^^^^^^^^^^^ -When in On position, this DIP switch is routing listed GPIOs to FT2232H to provide JTAG functionality. When in Off position, the GPIOs may be used for other purposes. +When in On position, this DIP switch is routing listed GPIOs to FT2232H to provide JTAG functionality. When in Off position, the GPIOs may be used for other purposes. ======= ================ DIP SW GPIO Pin @@ -183,7 +183,7 @@ RMII Clock Sourced Externally by PHY By default, the ESP32-Ethernet-Kit is configured to provide RMII clock for the IP101GRI PHY's 50M_CLKO output. The clock signal is generated by the frequency multiplication of 25 MHz crystal connected to the PHY. For details, please see the figure below. -.. figure:: ../../_static/esp32-ethernet-kit-rmii-clk-from-phy.png +.. figure:: ../../../_static/esp32-ethernet-kit-rmii-clk-from-phy.png :align: center :scale: 80% :alt: RMII Clock from IP101GRI PHY @@ -196,10 +196,10 @@ Please note that the PHY is reset on power up by pulling the RESET_N signal down RMII Clock Sourced Internally from ESP32's APLL """"""""""""""""""""""""""""""""""""""""""""""" -Another option is to source the RMII Clock from internal ESP32 APLL, see figure below. The clock signal coming from GPIO0 is first inverted, to account for transmission line delay, and then supplied to the PHY. +Another option is to source the RMII Clock from internal ESP32 APLL, see figure below. The clock signal coming from GPIO0 is first inverted, to account for transmission line delay, and then supplied to the PHY. -.. figure:: ../../_static/esp32-ethernet-kit-rmii-clk-to-phy.png +.. figure:: ../../../_static/esp32-ethernet-kit-rmii-clk-to-phy.png :align: center :scale: 80% :alt: RMII Clock from ESP Internal APLL @@ -213,7 +213,7 @@ To implement this option, users need to remove or add some RC components on the GPIO Allocation --------------- -This section describes allocation of ESP32 GPIOs to specific interfaces or functions of the ESP32-Ethernet-Kit. +This section describes allocation of ESP32 GPIOs to specific interfaces or functions of the ESP32-Ethernet-Kit. IP101GRI (PHY) Interface @@ -252,7 +252,7 @@ The allocation of the ESP32 (MAC) pins to IP101GRI (PHY) is shown in the table b GPIO Header 1 ^^^^^^^^^^^^^ -This header exposes some GPIOs that are not used elsewhere on the ESP32-Ethernet-Kit. +This header exposes some GPIOs that are not used elsewhere on the ESP32-Ethernet-Kit. ==== ================ . ESP32 Pin @@ -329,7 +329,7 @@ GPIO Allocation Summary .. note:: 1. To prevent the power-on state of the GPIO0 from being affected by the clock output on the PHY side, the RESET_N signal to PHY defaults to low, turning the clock output off. After power-on you can control RESET_N with GPIO5 to turn the clock output on. See also `RMII Clock Sourced Externally by PHY`_. For PHYs that cannot turn off the clock output through RESET_N, it is recommended to use a crystal module that can be disabled / enabled externally. Similarly like when using RESET_N, the oscillator module should be disabled by default and turned on by ESP32 after power-up. For a reference design please see `ESP32-Ethernet-Kit V1.1 Ethernet board (A) schematic`_. - + 2. The ESP32 pins GPIO16 and GPIO17 are not broken out to the ESP32-WROVER-B module and therefore not available for use. If you need to use these pins, please solder a module without PSRAM memory inside, e.g. the ESP32-WROOM-32D or ESP32-SOLO-1. @@ -351,7 +351,7 @@ Initial Setup Now to Development ^^^^^^^^^^^^^^^^^^ -Proceed to :doc:`../get-started/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. +Proceed to :doc:`../../get-started/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. Move on to the next section only if you have successfully completed all the above steps. @@ -359,7 +359,7 @@ Move on to the next section only if you have successfully completed all the abov Configure and Load the Ethernet Example ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -After setting up the development environment and testing the board, you can configure and flash the :example:`ethernet/ethernet` example. This example has been created for testing Ethernet functionality. It supports different PHY, including **IP101GRI** installed on :ref:`get-started-esp32-ethernet-kit-v1.1`. +After setting up the development environment and testing the board, you can configure and flash the :example:`ethernet/ethernet` example. This example has been created for testing Ethernet functionality. It supports different PHY, including **IP101GRI** installed on :ref:`get-started-esp32-ethernet-kit-v1.1`. Summary of Changes from ESP32-Ethernet-Kit V1.0 @@ -387,8 +387,8 @@ Related Documents * `ESP32-Ethernet-Kit V1.0 PoE board (B) schematic`_ (PDF) * `ESP32 Datasheet `_ (PDF) * `ESP32-WROVER-B Datasheet `_ (PDF) -* :doc:`../api-guides/jtag-debugging/index` -* :doc:`../hw-reference/index` +* :doc:`../../api-guides/jtag-debugging/index` +* :doc:`../../hw-reference/index` .. _ESP32-Ethernet-Kit V1.1 Ethernet board (A) schematic: https://dl.espressif.com/dl/schematics/SCH_ESP32-ETHERNET-KIT_A_V1.1_20190711.pdf .. _ESP32-Ethernet-Kit V1.0 PoE board (B) schematic: https://dl.espressif.com/dl/schematics/SCH_ESP32-ETHERNET-KIT_B_V1.0_20190517.pdf diff --git a/docs/en/hw-reference/get-started-pico-kit-v3.rst b/docs/en/hw-reference/esp32/get-started-pico-kit-v3.rst similarity index 88% rename from docs/en/hw-reference/get-started-pico-kit-v3.rst rename to docs/en/hw-reference/esp32/get-started-pico-kit-v3.rst index b8b2366f6..d96ab3523 100644 --- a/docs/en/hw-reference/get-started-pico-kit-v3.rst +++ b/docs/en/hw-reference/esp32/get-started-pico-kit-v3.rst @@ -2,7 +2,7 @@ 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`. +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 @@ -30,7 +30,7 @@ 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 +.. figure:: ../../../_static/esp32-pico-kit-v3-layout.jpg :align: center :alt: ESP32-PICO-KIT V3 board layout :figclass: align-center @@ -65,7 +65,7 @@ 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. +After that, proceed to :doc:`../../get-started/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 @@ -73,5 +73,5 @@ Related Documents * `ESP32-PICO-KIT V3 schematic `_ (PDF) * `ESP32-PICO-D4 Datasheet `_ (PDF) -* :doc:`../hw-reference/index` +* :doc:`../../hw-reference/index` diff --git a/docs/en/hw-reference/get-started-pico-kit.rst b/docs/en/hw-reference/esp32/get-started-pico-kit.rst similarity index 94% rename from docs/en/hw-reference/get-started-pico-kit.rst rename to docs/en/hw-reference/esp32/get-started-pico-kit.rst index 73c4b5ef6..0273a7223 100644 --- a/docs/en/hw-reference/get-started-pico-kit.rst +++ b/docs/en/hw-reference/esp32/get-started-pico-kit.rst @@ -2,7 +2,7 @@ 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 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. @@ -33,7 +33,7 @@ This setup reduces the costs of additional external components as well as the co 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. +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:: @@ -45,7 +45,7 @@ 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 +.. figure:: ../../../_static/esp32-pico-kit-v4-functional-block-diagram.png :align: center :alt: ESP32-PICO-KIT functional block diagram :figclass: align-center @@ -60,7 +60,7 @@ The following figure and the table below describe the key components, interfaces .. _get-started-pico-kit-v4-board-front: -.. figure:: ../../_static/esp32-pico-kit-v4.1-f-layout.jpeg +.. figure:: ../../../_static/esp32-pico-kit-v4.1-f-layout.jpeg :align: center :alt: ESP32-PICO-KIT board layout :figclass: align-center @@ -118,7 +118,7 @@ No. Name Type Function ====== ================= ====== ====================================================== 1 FLASH_SD1 (FSD1) I/O | GPIO8, SD_DATA1, SPID, HS1_DATA1 :ref:`(See 1) ` , U2CTS 2 FLASH_SD3 (FSD3) I/O | GPIO7, SD_DATA0, SPIQ, HS1_DATA0 :ref:`(See 1) ` , U2RTS -3 FLASH_CLK (FCLK) I/O | GPIO6, SD_CLK, SPICLK, HS1_CLK :ref:`(See 1) ` , U1CTS +3 FLASH_CLK (FCLK) I/O | GPIO6, SD_CLK, SPICLK, HS1_CLK :ref:`(See 1) ` , 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 @@ -193,7 +193,7 @@ 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. +After that, proceed to :doc:`../../get-started/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 @@ -201,14 +201,14 @@ 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 +.. 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 +.. figure:: ../../../_static/esp32-pico-kit-v4-dimensions-side.jpg :align: center :alt: ESP32-PICO-KIT V4 dimensions - side :figclass: align-center @@ -225,7 +225,7 @@ Related Documents * `ESP32-PICO-KIT V4.1 schematic `_ (PDF) * `ESP32-PICO-KIT Reference Design `_ containing OrCAD schematic, PCB layout, gerbers and BOM * `ESP32-PICO-D4 Datasheet `_ (PDF) -* :doc:`../hw-reference/index` +* :doc:`../../hw-reference/index` .. toctree:: diff --git a/docs/en/hw-reference/get-started-wrover-kit-v2.rst b/docs/en/hw-reference/esp32/get-started-wrover-kit-v2.rst similarity index 90% rename from docs/en/hw-reference/get-started-wrover-kit-v2.rst rename to docs/en/hw-reference/esp32/get-started-wrover-kit-v2.rst index 1aa0c6b59..75fbba8c1 100644 --- a/docs/en/hw-reference/get-started-wrover-kit-v2.rst +++ b/docs/en/hw-reference/esp32/get-started-wrover-kit-v2.rst @@ -2,7 +2,7 @@ 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`. +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 @@ -39,7 +39,7 @@ 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 +.. figure:: ../../../_static/esp-wrover-kit-block-diagram.png :align: center :alt: ESP-WROVER-KIT block diagram :figclass: align-center @@ -54,7 +54,7 @@ The following two figures and the table below describe the key components, inter .. _get-started-esp-wrover-kit-v2-board-front: -.. figure:: ../../_static/esp-wrover-kit-v2-layout-front.png +.. figure:: ../../../_static/esp-wrover-kit-v2-layout-front.png :align: center :alt: ESP-WROVER-KIT board layout - front :figclass: align-center @@ -63,7 +63,7 @@ The following two figures and the table below describe the key components, inter .. _get-started-esp-wrover-kit-v2-board-back: -.. figure:: ../../_static/esp-wrover-kit-v2-layout-back.png +.. figure:: ../../../_static/esp-wrover-kit-v2-layout-back.png :align: center :alt: ESP-WROVER-KIT board layout - back :figclass: align-center @@ -170,7 +170,7 @@ 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. +Please proceed to :doc:`../../get-started/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 @@ -180,16 +180,16 @@ Related Documents * `ESP32 Datasheet `_ (PDF) * `ESP32-WROVER Datasheet `_ (PDF) * `ESP32-WROOM-32 Datasheet `_ (PDF) -* :doc:`../api-guides/jtag-debugging/index` -* :doc:`../hw-reference/index` +* :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 +.. |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 diff --git a/docs/en/hw-reference/get-started-wrover-kit-v3.rst b/docs/en/hw-reference/esp32/get-started-wrover-kit-v3.rst similarity index 94% rename from docs/en/hw-reference/get-started-wrover-kit-v3.rst rename to docs/en/hw-reference/esp32/get-started-wrover-kit-v3.rst index 276c6877b..cb2c1cf36 100644 --- a/docs/en/hw-reference/get-started-wrover-kit-v3.rst +++ b/docs/en/hw-reference/esp32/get-started-wrover-kit-v3.rst @@ -3,7 +3,7 @@ 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`. +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 @@ -40,7 +40,7 @@ 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 +.. figure:: ../../../_static/esp-wrover-kit-block-diagram.png :align: center :alt: ESP-WROVER-KIT block diagram :figclass: align-center @@ -55,7 +55,7 @@ The following two figures and the table below describe the key components, inter .. _get-started-esp-wrover-kit-v3-board-front: -.. figure:: ../../_static/esp-wrover-kit-v3-layout-front.jpg +.. figure:: ../../../_static/esp-wrover-kit-v3-layout-front.jpg :align: center :alt: ESP-WROVER-KIT board layout - front :figclass: align-center @@ -64,7 +64,7 @@ The following two figures and the table below describe the key components, inter .. _get-started-esp-wrover-kit-v3-board-back: -.. figure:: ../../_static/esp-wrover-kit-v3-layout-back.jpg +.. figure:: ../../../_static/esp-wrover-kit-v3-layout-back.jpg :align: center :alt: ESP-WROVER-KIT board layout - back :figclass: align-center @@ -280,7 +280,7 @@ RGB LED ^^^^^^^ ==== ========== ========= -. ESP32 Pin RGB LED +. ESP32 Pin RGB LED ==== ========== ========= 1 GPIO0 Red 2 GPIO2 Green @@ -354,7 +354,7 @@ 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. +Please proceed to :doc:`../../get-started/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 @@ -364,14 +364,14 @@ Related Documents * `ESP32 Datasheet `_ (PDF) * `ESP32-WROVER Datasheet `_ (PDF) * `ESP32-WROOM-32 Datasheet `_ (PDF) -* :doc:`../api-guides/jtag-debugging/index` -* :doc:`../hw-reference/index` +* :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 +.. |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 diff --git a/docs/en/hw-reference/get-started-wrover-kit.rst b/docs/en/hw-reference/esp32/get-started-wrover-kit.rst similarity index 94% rename from docs/en/hw-reference/get-started-wrover-kit.rst rename to docs/en/hw-reference/esp32/get-started-wrover-kit.rst index b10f62688..93b6acfe9 100644 --- a/docs/en/hw-reference/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. For the description of other ESP-WROVER-KIT versions, please check :doc:`../../hw-reference/index`. What You Need @@ -40,7 +40,7 @@ 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 +.. figure:: ../../../_static/esp-wrover-kit-block-diagram.png :align: center :alt: ESP-WROVER-KIT block diagram :figclass: align-center @@ -55,7 +55,7 @@ The following two figures and the table below describe the key components, inter .. _get-started-esp-wrover-kit-v4.1-board-front: -.. figure:: ../../_static/esp-wrover-kit-v4.1-layout-front.png +.. figure:: ../../../_static/esp-wrover-kit-v4.1-layout-front.png :align: center :alt: ESP-WROVER-KIT board layout - front :figclass: align-center @@ -64,7 +64,7 @@ The following two figures and the table below describe the key components, inter .. _get-started-esp-wrover-kit-v4.1-board-back: -.. figure:: ../../_static/esp-wrover-kit-v4.1-layout-back.png +.. figure:: ../../../_static/esp-wrover-kit-v4.1-layout-back.png :align: center :alt: ESP-WROVER-KIT board layout - back :figclass: align-center @@ -284,7 +284,7 @@ RGB LED ^^^^^^^ ==== ========== ========= -. ESP32 Pin RGB LED +. ESP32 Pin RGB LED ==== ========== ========= 1 GPIO0 Red 2 GPIO2 Green @@ -358,7 +358,7 @@ 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. +Please proceed to :doc:`../../get-started/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 @@ -367,14 +367,14 @@ Related Documents * `ESP-WROVER-KIT V4.1 schematic`_ (PDF) * `ESP32 Datasheet `_ (PDF) * `ESP32-WROVER-B Datasheet `_ (PDF) -* :doc:`../api-guides/jtag-debugging/index` -* :doc:`../hw-reference/index` +* :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 +.. |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 diff --git a/docs/en/hw-reference/esp32/inc/modules-and-boards-esp32.rst b/docs/en/hw-reference/esp32/inc/modules-and-boards-esp32.rst new file mode 100644 index 000000000..fc18de334 --- /dev/null +++ b/docs/en/hw-reference/esp32/inc/modules-and-boards-esp32.rst @@ -0,0 +1,289 @@ +.. _esp-wroom-solo-wrover-modules: + +Modules +======= + +This is a family of ESP32-based modules with some integrated key components, including a crystal oscillator and an antenna matching circuit. The modules constitute ready-made solutions for integration into final products. If combined with a few extra components, such as a programming interface, bootstrapping resistors, and pin headers, these modules can also be used for evaluation of ESP32's functionality. + +The key characteristics of these modules are summarized in the table below. Some additional details are covered in the following sections. + +=================== ============ =========== ========= ==== =============== +Module Chip Flash, MB PSRAM, MB Ant. Dimensions, mm +=================== ============ =========== ========= ==== =============== +ESP32-WROOM-32 ESP32-D0WDQ6 4 -- MIFA 18 × 25.5 × 3.1 +ESP32-WROOM-32D ESP32-D0WD 4, 8, or 16 -- MIFA 18 × 25.5 × 3.1 +ESP32-WROOM-32U ESP32-D0WD 4, 8, or 16 -- U.FL 18 × 19.2 × 3.1 +ESP32-SOLO-1 ESP32-S0WD 4 -- MIFA 18 × 25.5 × 3.1 +ESP32-WROVER (PCB) ESP32-D0WDQ6 4 8 MIFA 18 × 31.4 × 3.3 +ESP32-WROVER (IPEX) ESP32-D0WDQ6 4 8 U.FL 18 × 31.4 × 3.3 +ESP32-WROVER-B ESP32-D0WD 4, 8, or 16 8 MIFA 18 × 31.4 × 3.3 +ESP32-WROVER-IB ESP32-D0WD 4, 8, or 16 8 U.FL 18 × 31.4 × 3.3 +=================== ============ =========== ========= ==== =============== + +* ESP32-**D**.. identifies a dual-core chip, ESP32-**S**.. identifies a single-core chip +* MIFA - Meandered Inverted-F Antenna +* U.FL - U.FL / IPEX antenna connector +* ESP32-WROOM-32x, ESP32-WROVER-B and ESP32-WROVER-IB modules come with 4 MB flash by default but also available with custom flash sizes of 8 MB and 16 MB, see `Espressif Products Ordering Information`_ (PDF) +* `ESP32 Chip Datasheet `__ (PDF) +* Initial release of the ESP32-WROVER module had 4 MB of PSRAM +* *ESP32-WROOM-32* was previously called *ESP-WROOM-32* + + +.. _esp-modules-and-boards-esp32-wroom-32: + +ESP32-WROOM-32 +-------------- + +This is a basic and commonly adopted ESP32 module with the ESP32-D0WDQ6 chip on board. It was the first module of the WROOM / WROVER family released to the market. + +For key characteristics, see the table in Section :ref:`esp-wroom-solo-wrover-modules`, `Espressif Products Ordering Information`_. + + +.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-wroom-32-front-back.jpg + :align: center + :alt: ESP32-WROOM-32 module (front and back) + :width: 45% + + ESP32-WROOM-32 module (front and back) + +Documentation +^^^^^^^^^^^^^ + +* `ESP32-WROOM-32 Datasheet `__ (PDF) +* `ESP32-WROOM-32 Reference Design `_ containing OrCAD schematic, PCB layout, gerber and BOM files + + +.. _esp-modules-and-boards-esp32-wroom-32d-and-u: + +ESP32-WROOM-32D / ESP32-WROOM-32U +--------------------------------- + +Both modules integrate the ESP32-D0WD chip which has a smaller footprint than the chip ESP32-D0WDQ6 installed in :ref:`esp-modules-and-boards-esp32-wroom-32`. + +For key characteristics, see the table in Section :ref:`esp-wroom-solo-wrover-modules` and `Espressif Products Ordering Information`_. + +ESP32-WROOM-32U is the smallest representative of the whole WROOM / WROVER family of modules. + +.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-wroom-32d-front-back.jpg + :align: center + :alt: ESP32-WROOM-32D module (front and back) + :width: 45% + + ESP32-WROOM-32D module (front and back) + +.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-wroom-32u-front-back.jpg + :align: center + :alt: ESP32-WROOM-32U module (front and back) + :width: 45% + + ESP32-WROOM-32U module (front and back) + +Documentation +^^^^^^^^^^^^^ + +* `ESP32-WROOM-32D / ESP32-WROOM-32U Datasheet `__ (PDF) + + +.. _esp-modules-and-boards-esp32-solo-1: + +ESP32-SOLO-1 +------------ + +This is a simplified version of the ESP32-WROOM-32D module. It contains a single-core ESP32 chip that supports a clock frequency of up to 160 MHz. + +For key characteristics, see the table in Section :ref:`esp-wroom-solo-wrover-modules` and `Espressif Products Ordering Information`_. + +.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-solo-1-front-back.jpg + :align: center + :alt: ESP32-SOLO-1 module (front and back) + :width: 45% + + ESP32-SOLO-1 module (front and back) + + +Documentation +^^^^^^^^^^^^^ + +* `ESP32-SOLO-1 Datasheet `__ (PDF) + + +.. _esp-modules-and-boards-esp32-wrover: + +ESP32-WROVER series +------------------- + +This series consists of a few modifications of ESP32-WROOM-32x modules, which among other upgrades include additional 8 MB SPI PSRAM (pseudo static RAM). + +For details, see the table in Section :ref:`esp-wroom-solo-wrover-modules` and `Espressif Products Ordering Information`_. + +* **ESP32-WROVER (PCB)** and **ESP32-WROVER (IPEX)** have PSRAM that operates at 1.8 V and supports up to 144 MHz clock rate. +* **ESP32-WROVER-B** and **ESP32-WROVER-IB** have PSRAM that operates at 3.3 V and supports up to 133 MHz clock rate. + +The picture below shows an ESP32-WROVER module with a PCB antenna. + +.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-wrover.jpg + :align: center + :alt: ESP32-WROVER module (front and back) + :width: 40% + + ESP32-WROVER module (front and back) + +Documentation +^^^^^^^^^^^^^ + +* `ESP32-WROVER Datasheet `__ (PDF) +* `ESP32-WROVER-B Datasheet `__ (PDF) +* `ESP-PSRAM64 & ESP-PSRAM64H Datasheet `__ (PDF) +* `ESP32-WROVER Reference Design `_ containing OrCAD schematic, PCB layout, gerber and BOM files + + +ESP32-PICO-D4 +------------- + +ESP32-PICO-D4 is a System-in-Package (SiP) module, integrating all peripheral components seamlessly, including the following: + +- 4 MB flash memory +- crystal oscillator +- filter capacitors +- RF matching circuit + +For key characteristics, see `Espressif Products Ordering Information`_. + + +Documentation +^^^^^^^^^^^^^ + +* `ESP32-PICO-D4 Datasheet `__ (PDF) + + +Development Boards +================== + +Depending on the intended functionality, different development boards feature: + +- Access to different ESP32 GPIO pins. +- Different interfaces: USB, JTAG. +- Different peripherals: touchpads, LCD screens, SD card slots, female headers for camera modules, etc. + +.. _esp-modules-and-boards-esp32-pico-kit: + +ESP32-PICO-KIT V4.1 +------------------- + +This is the smallest available ESP32-based development board. It features all the components for direct connection to a computer's USB port as well as pin headers for plugging into a mini breadboard. + +The board is equipped with the `ESP32-PICO-D4`_ module. With such a module, the creation of a fully functional development board required only a few external components that fit on a PCB as small as 20 x 52 mm. The external components include antenna, LDO, USB-UART bridge, and two buttons for reset and activation of Firmware Download mode. + +.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-pico-kit-v4.1.jpg + :align: center + :alt: ESP32-PICO-KIT V4.1 board + :width: 50% + + ESP32-PICO-KIT V4.1 board + +Comparing to ESP32-PICO-KIT V4, this version features the CP2102N USB-UART bridge that provides faster transfer rates of up to 3 Mbps. + +Documentation +^^^^^^^^^^^^^ + +* :doc:`esp32/get-started-pico-kit` +* `ESP32-PICO-KIT V4.1 Schematic `_ (PDF) +* `ESP32-PICO-KIT Reference Design `_ containing OrCAD schematic, PCB layout, gerber and BOM files +* `ESP32-PICO-D4 Datasheet `_ (PDF) + +Previous Versions +^^^^^^^^^^^^^^^^^ + +* :ref:`esp-modules-and-boards-esp32-pico-kit-v4` +* :ref:`esp-modules-and-boards-esp32-pico-kit-v3` + + +.. _esp-modules-and-boards-esp32-devkitc: + +ESP32 DevKitC V4 +---------------- + +This is a small and convenient development board that features: + +- :ref:`esp-modules-and-boards-esp32-wroom-32` module +- USB-to-serial programming interface that also provides power supply for the board +- pin headers +- pushbuttons for reset and activation of Firmware Download mode +- a few other components + +Comparing to the previous :ref:`esp-modules-and-boards-esp32-devkitc-v2`, this version can integrate :ref:`esp-modules-and-boards-esp32-wrover` module instead of ESP32-WROOM-32 and has the CP2102N chip that supports faster baud rates. + +.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-devkitc-v4-front.jpg + :align: center + :alt: ESP32 DevKitC V4 board + :width: 50% + + ESP32 DevKitC V4 board + +Documentation +^^^^^^^^^^^^^ + +* :doc:`esp32/get-started-devkitc` +* `ESP32-DevKitC schematic `_ (PDF) +* `ESP32-DevKitC Reference Design `_ containing OrCAD schematic, PCB layout, gerber and BOM files +* `CP210x USB to UART Bridge VCP Drivers `_ + +Previous Versions +^^^^^^^^^^^^^^^^^ + +* :ref:`esp-modules-and-boards-esp32-devkitc-v2` + + +.. _esp-modules-and-boards-esp-wrover-kit: + +ESP-WROVER-KIT V4.1 +------------------- + +This board features: + +- Dual port USB-to-serial converter for programming +- JTAG interface for debugging +- MicroSD card slot +- 3.2” SPI LCD screen +- Female headers for a camera module +- RGB LED for diagnostics +- 32.768 kHz XTAL for internal RTC to operate it in low power modes + +Power can be supplied either via USB or via a standard 5 mm power supply jack. A power source can be selected with a jumper and can be turned on/off with a separate switch. + +This version of the ESP-WROVER-KIT board integrates the ESP-WROVER-B module that has 8 MB PSRAM for flexible extended storage and data processing capabilities. The board can accommodate other versions of ESP modules described in :ref:`esp-wroom-solo-wrover-modules`. + +Comparing to :ref:`esp-modules-and-boards-esp-wrover-kit-v3`, this board has the following design changes: + +- JP8, JP11, and JP13 have been combined into a single JP2. +- USB connector has been changed to DIP type and moved to the lower right corner of the board. +- R61 has been changed to a Zero-ohm resistor. +- Some components have been replaced with functional equivalents based on test results and sourcing options, e.g., the EN and Boot buttons. + +.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp-wrover-kit-v4.1-front.jpg + :align: center + :alt: ESP-WROVER-KIT V4.1 board + :width: 90% + + ESP-WROVER-KIT V4.1 board + +The board in the picture above integrates the ESP32-WROVER-B module. + +Documentation +^^^^^^^^^^^^^ + +* :doc:`esp32/get-started-wrover-kit` +* `ESP-WROVER-KIT V4.1 Schematic `__ (PDF) +* :doc:`../api-guides/jtag-debugging/index` +* `FTDI Virtual COM Port Drivers`_ + +Previous Versions +^^^^^^^^^^^^^^^^^ + +* :ref:`esp-modules-and-boards-esp-wrover-kit-v3` +* :ref:`esp-modules-and-boards-esp-wrover-kit-v2` +* :ref:`esp-modules-and-boards-esp-wrover-kit-v1` + + +.. _FTDI Virtual COM Port Drivers: http://www.ftdichip.com/Drivers/VCP.htm +.. _Espressif Products Ordering Information: https://www.espressif.com/sites/default/files/documentation/espressif_products_ordering_information_en.pdf \ No newline at end of file diff --git a/docs/en/hw-reference/esp32/inc/modules-and-boards-previous-esp32.rst b/docs/en/hw-reference/esp32/inc/modules-and-boards-previous-esp32.rst new file mode 100644 index 000000000..8b8e8afac --- /dev/null +++ b/docs/en/hw-reference/esp32/inc/modules-and-boards-previous-esp32.rst @@ -0,0 +1,179 @@ +.. _esp-modules-and-boards-previous_esp32: + +Modules (No updated or discontinued modules) +============================================ + +So far, no modules have been updated or discontinued. + + +Development Boards +================== + +To see the latest development boards, please refer to section :ref:`esp-modules-and-boards`. + +.. _esp-modules-and-boards-esp32-pico-kit-v4: + +ESP32-PICO-KIT V4 +----------------- + +The smallest ESP32 development board with all the components required to connect it directly to a PC USB port, and pin headers to plug into a mini breadboard. It is equipped with ESP32-PICO-D4 module that integrates 4 MB flash memory, a crystal oscillator, filter capacitors and RF matching circuit in one single package. As result, the fully functional development board requires only a few external components that can easy fit on a 20 x 52 mm PCB including antenna, LDO, USB-UART bridge and two buttons to reset it and put into download mode. + +.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-pico-kit-v4.jpeg + :align: center + :alt: ESP32-PICO-KIT V4 board + :width: 50% + + ESP32-PICO-KIT V4 board + +Comparing to ESP32-PICO-KIT V3, this version has revised printout and reduced number of exposed pins. Instead of 20, only 17 header pins are populated, so V4 can fit into a mini breadboard. + +Documentation +^^^^^^^^^^^^^ + +* :doc:`esp32/get-started-pico-kit` +* `ESP32-PICO-KIT V4 Schematic `_ (PDF) +* `ESP32-PICO-D4 Datasheet `_ (PDF) + +.. _esp-modules-and-boards-esp32-pico-kit-v3: + +ESP32-PICO-KIT V3 +----------------- + +The first public release of Espressif's ESP32-PICO-D4 module on a mini development board. The board has a USB port for programming and debugging and two rows of 20 pin headers to plug into a breadboard. The ESP32-PICO-D4 module itself is small and requires only a few external components. Besides two core CPUs it integrates 4MB flash memory, a crystal oscillator and antenna matching components in one single 7 x 7 mm package. As a result the module and all the components making the complete development board fit into 20 x 52 mm PCB. + +.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-pico-kit-v3.jpeg + :align: center + :alt: ESP32-PICO-KIT V3 board + :width: 50% + + ESP32-PICO-KIT V3 board + +Documentation +^^^^^^^^^^^^^ + +* :doc:`esp32/get-started-pico-kit-v3` +* `ESP32-PICO-KIT V3 Schematic `_ (PDF) +* `ESP32-PICO-D4 Datasheet `_ (PDF) + + +.. _esp-modules-and-boards-esp32-devkitc-v2: + +ESP32 Core Board V2 / ESP32 DevKitC +----------------------------------- + +Small and convenient development board with ESP-WROOM-32 module installed, break out pin headers and minimum additional components. Includes USB to serial programming interface, that also provides power supply for the board. Has pushbuttons to reset the board and put it in upload mode. + +.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-core-board-v2.png + :align: center + :alt: ESP32 Core Board V2 / ESP32 DevKitC board + :width: 50% + + ESP32 Core Board V2 / ESP32 DevKitC board + +Documentation +^^^^^^^^^^^^^ + +* :doc:`esp32/get-started-devkitc-v2` +* `ESP32 DevKitC V2 Schematic `__ (PDF) +* `CP210x USB to UART Bridge VCP Drivers `_ + +.. _esp-modules-and-boards-esp-wrover-kit-v3: + +ESP-WROVER-KIT V3 +----------------- + +The ESP-WROVER-KIT V3 development board has dual port USB to serial converter for programming and JTAG interface for debugging. Power supply is provided by USB interface or from standard 5 mm power supply jack. Power supply selection is done with a jumper and may be put on/off with a separate switch. This board has MicroSD card slot, 3.2” SPI LCD screen and dedicated header to connect a camera. It provides RGB diode for diagnostics. Includes 32.768 kHz XTAL for internal RTC to operate it in low power modes. + +As all previous versions of ESP-WROVER-KIT boards, it is ready to accommodate an :ref:`esp-modules-and-boards-esp32-wroom-32` or :ref:`esp-modules-and-boards-esp32-wrover` module. + +This is the first release of ESP-WROVER-KIT shipped with :ref:`esp-modules-and-boards-esp32-wrover` module installed by default. This release also introduced several design changes to conditioning and interlocking of signals to the bootstrapping pins. Also, a zero Ohm resistor (R166) has been added between WROVER/WROOM module and VDD33 net, which can be desoldered, or replaced with a shunt resistor, for current measurement. This is intended to facilitate power consumption analysis in various operation modes of ESP32. Refer to schematic - the changes are enclosed in green border. + +.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp-wrover-kit-v3.jpg + :align: center + :alt: ESP-WROVER-KIT V3 board + :width: 90% + + ESP-WROVER-KIT V3 board + +The camera header has been changed from male back to female. The board soldermask is matte black. The board on picture above has :ref:`esp-modules-and-boards-esp32-wrover` is installed. + +Documentation +^^^^^^^^^^^^^ + +* :doc:`esp32/get-started-wrover-kit-v3` +* `ESP-WROVER-KIT V3 Schematic `__ (PDF) +* :doc:`../api-guides/jtag-debugging/index` +* `FTDI Virtual COM Port Drivers`_ + +.. _esp-modules-and-boards-esp-wrover-kit-v2: + +ESP-WROVER-KIT V2 +----------------- + +This is updated version of ESP32 DevKitJ V1 described above with design improvements identified when DevKitJ was in use, e.g. improved support for SD card. By default board has ESP-WROOM-32 module installed. + +.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp-wrover-kit-v2.jpg + :align: center + :alt: ESP-WROVER-KIT V2 board + :width: 90% + + ESP-WROVER-KIT V2 board + +Comparing to previous version, this board has a shiny black finish and a male camera header. + +Documentation +^^^^^^^^^^^^^ + +* :doc:`esp32/get-started-wrover-kit-v2` +* `ESP-WROVER-KIT V2 Schematic `__ (PDF) +* :doc:`../api-guides/jtag-debugging/index` +* `FTDI Virtual COM Port Drivers`_ + +.. _esp-modules-and-boards-esp-wrover-kit-v1: + +ESP-WROVER-KIT V1 / ESP32 DevKitJ V1 +------------------------------------ + +The first version of ESP-WROVER-KIT development board. Shipped with ESP-WROOM-32 on board. + +ESP-WROVER-KIT has dual port USB to serial converter for programming and JTAG interface for debugging. Power supply is provided by USB interface or from standard 5 mm power supply jack. Power supply selection is done with a jumper and may be put on/off with a separate switch. The board has MicroSD card slot, 3.2” SPI LCD screen and dedicated header to connect a camera. It provides RGB diode for diagnostics. Includes 32.768 kHz XTAL for internal RTC to operate it in low power modes. + +All versions of ESP-WROVER-KIT are ready to accommodate an ESP-WROOM-32 or ESP32-WROVER module. + + +.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-devkitj-v1.jpg + :align: center + :alt: ESP-WROVER-KIT V1 / ESP32 DevKitJ V1 board + :width: 90% + + ESP-WROVER-KIT V1 / ESP32 DevKitJ V1 board + +The board has red soldermask. + +Documentation +^^^^^^^^^^^^^ + +* `ESP-WROVER-KIT V1 Schematic `__ (PDF) +* :doc:`../api-guides/jtag-debugging/index` +* `FTDI Virtual COM Port Drivers`_ + +.. _esp-modules-and-boards-esp32-demo-board: + +ESP32 Demo Board V2 +------------------- + +One of first feature rich evaluation boards that contains several pin headers, dip switches, USB to serial programming interface, reset and boot mode press buttons, power switch, 10 touch pads and separate header to connect LCD screen. + +.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-demo-board-v2.jpg + :align: center + :alt: ESP32 Demo Board V2 + + ESP32 Demo Board V2 + +Production of this board is discontinued. + +Documentation +^^^^^^^^^^^^^ + +* `ESP32 Demo Board V2 Schematic `__ (PDF) +* `FTDI Virtual COM Port Drivers`_ diff --git a/docs/en/hw-reference/esp32s2/inc/modules-and-boards-esp32s2.rst b/docs/en/hw-reference/esp32s2/inc/modules-and-boards-esp32s2.rst new file mode 100644 index 000000000..c5e67936a --- /dev/null +++ b/docs/en/hw-reference/esp32s2/inc/modules-and-boards-esp32s2.rst @@ -0,0 +1,21 @@ +.. _esp-s2-modules: + +Modules +======= + +This is a family of ESP32-S2-based modules with some integrated key components, including a crystal oscillator and an antenna matching circuit. The modules constitute ready-made solutions for integration into final products. If combined with a few extra components, such as a programming interface, bootstrapping resistors, and pin headers, these modules can also be used for evaluation of ESP32-S2's functionality. + +The key characteristics of these modules are summarized in the table below. Some additional details are covered in the following sections. + +=================== ============ =========== ========= ==== =============== +Module Chip Flash, MB PSRAM, MB Ant. Dimensions, mm +=================== ============ =========== ========= ==== =============== +ESP32-S2-WROOM-32 ESP32-S2 2 N/A MIFA 16 x 23 x 3 +=================== ============ =========== ========= ==== =============== + +* MIFA - Meandered Inverted-F Antenna +* U.FL - U.FL / IPEX antenna connector + + +.. _FTDI Virtual COM Port Drivers: http://www.ftdichip.com/Drivers/VCP.htm +.. _Espressif Products Ordering Information: https://www.espressif.com/sites/default/files/documentation/espressif_products_ordering_information_en.pdf \ No newline at end of file diff --git a/docs/en/hw-reference/esp32s2/inc/modules-and-boards-previous-esp32s2.rst b/docs/en/hw-reference/esp32s2/inc/modules-and-boards-previous-esp32s2.rst new file mode 100644 index 000000000..011a5ce8f --- /dev/null +++ b/docs/en/hw-reference/esp32s2/inc/modules-and-boards-previous-esp32s2.rst @@ -0,0 +1,12 @@ +.. _esp-modules-and-boards-previous_esp32s2: + +Modules (No updated or discontinued modules) +============================================ + +So far, no modules have been updated or discontinued. + + +Development Boards +================== + +So far, no development boards have been updated or discontinued. diff --git a/docs/en/hw-reference/index.rst b/docs/en/hw-reference/index.rst index 9978049ee..7524a0202 100644 --- a/docs/en/hw-reference/index.rst +++ b/docs/en/hw-reference/index.rst @@ -9,7 +9,7 @@ :esp32: Technical Reference Manual (PDF) :esp32s2beta: Technical Reference Manual (PDF) :esp32: Datasheet (PDF) - :esp32s2beta: Datasheet (PDF) + :esp32s2: Datasheet (PDF) :esp32: Hardware Design Guidelines (PDF) :esp32: Silicon Errata (PDF) Modules and Boards diff --git a/docs/en/hw-reference/modules-and-boards-previous.rst b/docs/en/hw-reference/modules-and-boards-previous.rst index 7128bf5c7..ce44b57f4 100644 --- a/docs/en/hw-reference/modules-and-boards-previous.rst +++ b/docs/en/hw-reference/modules-and-boards-previous.rst @@ -7,186 +7,13 @@ Previous Versions of {IDF_TARGET_NAME} Modules and Boards This sections contains overview and links to documentation of previous version {IDF_TARGET_NAME} Modules and Boards that have been replaced with newer versions or discontinued. It is maintained for convenience of users as previous versions of some modules and boards are still in use and some may still be available for purchase. -Modules (No updated or discontinued modules) -============================================ - -So far, no modules have been updated or discontinued. - - -Development Boards -================== - -To see the latest development boards, please refer to section :ref:`esp-modules-and-boards`. - .. only:: esp32 - .. _esp-modules-and-boards-esp32-pico-kit-v4: + .. include:: esp32/inc/modules-and-boards-previous-esp32.rst - ESP32-PICO-KIT V4 - ----------------- - - The smallest ESP32 development board with all the components required to connect it directly to a PC USB port, and pin headers to plug into a mini breadboard. It is equipped with ESP32-PICO-D4 module that integrates 4 MB flash memory, a crystal oscillator, filter capacitors and RF matching circuit in one single package. As result, the fully functional development board requires only a few external components that can easy fit on a 20 x 52 mm PCB including antenna, LDO, USB-UART bridge and two buttons to reset it and put into download mode. - - .. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-pico-kit-v4.jpeg - :align: center - :alt: ESP32-PICO-KIT V4 board - :width: 50% - - ESP32-PICO-KIT V4 board - - Comparing to ESP32-PICO-KIT V3, this version has revised printout and reduced number of exposed pins. Instead of 20, only 17 header pins are populated, so V4 can fit into a mini breadboard. - - Documentation - ^^^^^^^^^^^^^ - - * :doc:`../hw-reference/get-started-pico-kit` - * `ESP32-PICO-KIT V4 Schematic `_ (PDF) - * `ESP32-PICO-D4 Datasheet `_ (PDF) - - .. _esp-modules-and-boards-esp32-pico-kit-v3: - - ESP32-PICO-KIT V3 - ----------------- - - The first public release of Espressif's ESP32-PICO-D4 module on a mini development board. The board has a USB port for programming and debugging and two rows of 20 pin headers to plug into a breadboard. The ESP32-PICO-D4 module itself is small and requires only a few external components. Besides two core CPUs it integrates 4MB flash memory, a crystal oscillator and antenna matching components in one single 7 x 7 mm package. As a result the module and all the components making the complete development board fit into 20 x 52 mm PCB. - - .. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-pico-kit-v3.jpeg - :align: center - :alt: ESP32-PICO-KIT V3 board - :width: 50% - - ESP32-PICO-KIT V3 board - - Documentation - ^^^^^^^^^^^^^ - - * :doc:`../hw-reference/get-started-pico-kit-v3` - * `ESP32-PICO-KIT V3 Schematic `_ (PDF) - * `ESP32-PICO-D4 Datasheet `_ (PDF) - - - .. _esp-modules-and-boards-esp32-devkitc-v2: - - ESP32 Core Board V2 / ESP32 DevKitC - ----------------------------------- - - Small and convenient development board with ESP-WROOM-32 module installed, break out pin headers and minimum additional components. Includes USB to serial programming interface, that also provides power supply for the board. Has pushbuttons to reset the board and put it in upload mode. - - .. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-core-board-v2.png - :align: center - :alt: ESP32 Core Board V2 / ESP32 DevKitC board - :width: 50% - - ESP32 Core Board V2 / ESP32 DevKitC board - - Documentation - ^^^^^^^^^^^^^ - - * :doc:`../hw-reference/get-started-devkitc-v2` - * `ESP32 DevKitC V2 Schematic `__ (PDF) - * `CP210x USB to UART Bridge VCP Drivers `_ - - .. _esp-modules-and-boards-esp-wrover-kit-v3: - - ESP-WROVER-KIT V3 - ----------------- - - The ESP-WROVER-KIT V3 development board has dual port USB to serial converter for programming and JTAG interface for debugging. Power supply is provided by USB interface or from standard 5 mm power supply jack. Power supply selection is done with a jumper and may be put on/off with a separate switch. This board has MicroSD card slot, 3.2” SPI LCD screen and dedicated header to connect a camera. It provides RGB diode for diagnostics. Includes 32.768 kHz XTAL for internal RTC to operate it in low power modes. - - As all previous versions of ESP-WROVER-KIT boards, it is ready to accommodate an :ref:`esp-modules-and-boards-esp32-wroom-32` or :ref:`esp-modules-and-boards-esp32-wrover` module. - - This is the first release of ESP-WROVER-KIT shipped with :ref:`esp-modules-and-boards-esp32-wrover` module installed by default. This release also introduced several design changes to conditioning and interlocking of signals to the bootstrapping pins. Also, a zero Ohm resistor (R166) has been added between WROVER/WROOM module and VDD33 net, which can be desoldered, or replaced with a shunt resistor, for current measurement. This is intended to facilitate power consumption analysis in various operation modes of ESP32. Refer to schematic - the changes are enclosed in green border. - - .. figure:: https://dl.espressif.com/dl/schematics/pictures/esp-wrover-kit-v3.jpg - :align: center - :alt: ESP-WROVER-KIT V3 board - :width: 90% - - ESP-WROVER-KIT V3 board - - The camera header has been changed from male back to female. The board soldermask is matte black. The board on picture above has :ref:`esp-modules-and-boards-esp32-wrover` is installed. - - Documentation - ^^^^^^^^^^^^^ - - * :doc:`../hw-reference/get-started-wrover-kit-v3` - * `ESP-WROVER-KIT V3 Schematic `__ (PDF) - * :doc:`../api-guides/jtag-debugging/index` - * `FTDI Virtual COM Port Drivers`_ - - .. _esp-modules-and-boards-esp-wrover-kit-v2: - - ESP-WROVER-KIT V2 - ----------------- - - This is updated version of ESP32 DevKitJ V1 described above with design improvements identified when DevKitJ was in use, e.g. improved support for SD card. By default board has ESP-WROOM-32 module installed. - - .. figure:: https://dl.espressif.com/dl/schematics/pictures/esp-wrover-kit-v2.jpg - :align: center - :alt: ESP-WROVER-KIT V2 board - :width: 90% - - ESP-WROVER-KIT V2 board - - Comparing to previous version, this board has a shiny black finish and a male camera header. - - Documentation - ^^^^^^^^^^^^^ - - * :doc:`../hw-reference/get-started-wrover-kit-v2` - * `ESP-WROVER-KIT V2 Schematic `__ (PDF) - * :doc:`../api-guides/jtag-debugging/index` - * `FTDI Virtual COM Port Drivers`_ - - .. _esp-modules-and-boards-esp-wrover-kit-v1: - - ESP-WROVER-KIT V1 / ESP32 DevKitJ V1 - ------------------------------------ - - The first version of ESP-WROVER-KIT development board. Shipped with ESP-WROOM-32 on board. - - ESP-WROVER-KIT has dual port USB to serial converter for programming and JTAG interface for debugging. Power supply is provided by USB interface or from standard 5 mm power supply jack. Power supply selection is done with a jumper and may be put on/off with a separate switch. The board has MicroSD card slot, 3.2” SPI LCD screen and dedicated header to connect a camera. It provides RGB diode for diagnostics. Includes 32.768 kHz XTAL for internal RTC to operate it in low power modes. - - All versions of ESP-WROVER-KIT are ready to accommodate an ESP-WROOM-32 or ESP32-WROVER module. - - - .. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-devkitj-v1.jpg - :align: center - :alt: ESP-WROVER-KIT V1 / ESP32 DevKitJ V1 board - :width: 90% - - ESP-WROVER-KIT V1 / ESP32 DevKitJ V1 board - - The board has red soldermask. - - Documentation - ^^^^^^^^^^^^^ - - * `ESP-WROVER-KIT V1 Schematic `__ (PDF) - * :doc:`../api-guides/jtag-debugging/index` - * `FTDI Virtual COM Port Drivers`_ - - .. _esp-modules-and-boards-esp32-demo-board: - - ESP32 Demo Board V2 - ------------------- - - One of first feature rich evaluation boards that contains several pin headers, dip switches, USB to serial programming interface, reset and boot mode press buttons, power switch, 10 touch pads and separate header to connect LCD screen. - - .. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-demo-board-v2.jpg - :align: center - :alt: ESP32 Demo Board V2 - - ESP32 Demo Board V2 - - Production of this board is discontinued. - - Documentation - ^^^^^^^^^^^^^ - - * `ESP32 Demo Board V2 Schematic `__ (PDF) - * `FTDI Virtual COM Port Drivers`_ +.. only:: esp32s2 + .. include:: esp32s2/inc/modules-and-boards-previous-esp32s2.rst Related Documents ================= diff --git a/docs/en/hw-reference/modules-and-boards.rst b/docs/en/hw-reference/modules-and-boards.rst index e784f387b..4e3d00065 100644 --- a/docs/en/hw-reference/modules-and-boards.rst +++ b/docs/en/hw-reference/modules-and-boards.rst @@ -14,300 +14,15 @@ This document provides description of modules and development boards currently a For description of previous versions of modules and development boards as well as for description of discontinued ones, please go to Section :ref:`esp-modules-and-boards-previous`. -.. _esp-wroom-solo-wrover-modules: - -Modules -======= - -This is a family of {IDF_TARGET_NAME}-based modules with some integrated key components, including a crystal oscillator and an antenna matching circuit. The modules constitute ready-made solutions for integration into final products. If combined with a few extra components, such as a programming interface, bootstrapping resistors, and pin headers, these modules can also be used for evaluation of {IDF_TARGET_NAME}'s functionality. - -The key characteristics of these modules are summarized in the table below. Some additional details are covered in the following sections. - .. only:: esp32 - =================== ============ =========== ========= ==== =============== - Module Chip Flash, MB PSRAM, MB Ant. Dimensions, mm - =================== ============ =========== ========= ==== =============== - ESP32-WROOM-32 ESP32-D0WDQ6 4 -- MIFA 18 × 25.5 × 3.1 - ESP32-WROOM-32D ESP32-D0WD 4, 8, or 16 -- MIFA 18 × 25.5 × 3.1 - ESP32-WROOM-32U ESP32-D0WD 4, 8, or 16 -- U.FL 18 × 19.2 × 3.1 - ESP32-SOLO-1 ESP32-S0WD 4 -- MIFA 18 × 25.5 × 3.1 - ESP32-WROVER (PCB) ESP32-D0WDQ6 4 8 MIFA 18 × 31.4 × 3.3 - ESP32-WROVER (IPEX) ESP32-D0WDQ6 4 8 U.FL 18 × 31.4 × 3.3 - ESP32-WROVER-B ESP32-D0WD 4, 8, or 16 8 MIFA 18 × 31.4 × 3.3 - ESP32-WROVER-IB ESP32-D0WD 4, 8, or 16 8 U.FL 18 × 31.4 × 3.3 - =================== ============ =========== ========= ==== =============== + .. include:: esp32/inc/modules-and-boards-esp32.rst - * ESP32-**D**.. identifies a dual-core chip, ESP32-**S**.. identifies a single-core chip - * MIFA - Meandered Inverted-F Antenna - * U.FL - U.FL / IPEX antenna connector - * ESP32-WROOM-32x, ESP32-WROVER-B and ESP32-WROVER-IB modules come with 4 MB flash by default but also available with custom flash sizes of 8 MB and 16 MB, see `Espressif Products Ordering Information`_ (PDF) - * `ESP32 Chip Datasheet `__ (PDF) - * Initial release of the ESP32-WROVER module had 4 MB of PSRAM - * *ESP32-WROOM-32* was previously called *ESP-WROOM-32* - - - .. _esp-modules-and-boards-esp32-wroom-32: - - ESP32-WROOM-32 - -------------- - - This is a basic and commonly adopted ESP32 module with the ESP32-D0WDQ6 chip on board. It was the first module of the WROOM / WROVER family released to the market. - - For key characteristics, see the table in Section :ref:`esp-wroom-solo-wrover-modules`, `Espressif Products Ordering Information`_. - - - .. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-wroom-32-front-back.jpg - :align: center - :alt: ESP32-WROOM-32 module (front and back) - :width: 45% - - ESP32-WROOM-32 module (front and back) - - Documentation - ^^^^^^^^^^^^^ - - * `ESP32-WROOM-32 Datasheet `__ (PDF) - * `ESP32-WROOM-32 Reference Design `_ containing OrCAD schematic, PCB layout, gerber and BOM files - - - .. _esp-modules-and-boards-esp32-wroom-32d-and-u: - - ESP32-WROOM-32D / ESP32-WROOM-32U - --------------------------------- - - Both modules integrate the ESP32-D0WD chip which has a smaller footprint than the chip ESP32-D0WDQ6 installed in :ref:`esp-modules-and-boards-esp32-wroom-32`. - - For key characteristics, see the table in Section :ref:`esp-wroom-solo-wrover-modules` and `Espressif Products Ordering Information`_. - - ESP32-WROOM-32U is the smallest representative of the whole WROOM / WROVER family of modules. - - .. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-wroom-32d-front-back.jpg - :align: center - :alt: ESP32-WROOM-32D module (front and back) - :width: 45% - - ESP32-WROOM-32D module (front and back) - - .. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-wroom-32u-front-back.jpg - :align: center - :alt: ESP32-WROOM-32U module (front and back) - :width: 45% - - ESP32-WROOM-32U module (front and back) - - Documentation - ^^^^^^^^^^^^^ - - * `ESP32-WROOM-32D / ESP32-WROOM-32U Datasheet `__ (PDF) - - - .. _esp-modules-and-boards-esp32-solo-1: - - ESP32-SOLO-1 - ------------ - - This is a simplified version of the ESP32-WROOM-32D module. It contains a single-core ESP32 chip that supports a clock frequency of up to 160 MHz. - - For key characteristics, see the table in Section :ref:`esp-wroom-solo-wrover-modules` and `Espressif Products Ordering Information`_. - - .. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-solo-1-front-back.jpg - :align: center - :alt: ESP32-SOLO-1 module (front and back) - :width: 45% - - ESP32-SOLO-1 module (front and back) - - - Documentation - ^^^^^^^^^^^^^ - - * `ESP32-SOLO-1 Datasheet `__ (PDF) - - - .. _esp-modules-and-boards-esp32-wrover: - - ESP32-WROVER series - ------------------- - - This series consists of a few modifications of ESP32-WROOM-32x modules, which among other upgrades include additional 8 MB SPI PSRAM (pseudo static RAM). - - For details, see the table in Section :ref:`esp-wroom-solo-wrover-modules` and `Espressif Products Ordering Information`_. - - * **ESP32-WROVER (PCB)** and **ESP32-WROVER (IPEX)** have PSRAM that operates at 1.8 V and supports up to 144 MHz clock rate. - * **ESP32-WROVER-B** and **ESP32-WROVER-IB** have PSRAM that operates at 3.3 V and supports up to 133 MHz clock rate. - - The picture below shows an ESP32-WROVER module with a PCB antenna. - - .. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-wrover.jpg - :align: center - :alt: ESP32-WROVER module (front and back) - :width: 40% - - ESP32-WROVER module (front and back) - - Documentation - ^^^^^^^^^^^^^ - - * `ESP32-WROVER Datasheet `__ (PDF) - * `ESP32-WROVER-B Datasheet `__ (PDF) - * `ESP-PSRAM64 & ESP-PSRAM64H Datasheet `__ (PDF) - * `ESP32-WROVER Reference Design `_ containing OrCAD schematic, PCB layout, gerber and BOM files - - - ESP32-PICO-D4 - ------------- - - ESP32-PICO-D4 is a System-in-Package (SiP) module, integrating all peripheral components seamlessly, including the following: - - - 4 MB flash memory - - crystal oscillator - - filter capacitors - - RF matching circuit - - For key characteristics, see `Espressif Products Ordering Information`_. - - - Documentation - ^^^^^^^^^^^^^ - - * `ESP32-PICO-D4 Datasheet `__ (PDF) - - - Development Boards - ================== - - Depending on the intended functionality, different development boards feature: - - - Access to different ESP32 GPIO pins. - - Different interfaces: USB, JTAG. - - Different peripherals: touchpads, LCD screens, SD card slots, female headers for camera modules, etc. - - .. _esp-modules-and-boards-esp32-pico-kit: - - ESP32-PICO-KIT V4.1 - ------------------- - - This is the smallest available ESP32-based development board. It features all the components for direct connection to a computer's USB port as well as pin headers for plugging into a mini breadboard. - - The board is equipped with the `ESP32-PICO-D4`_ module. With such a module, the creation of a fully functional development board required only a few external components that fit on a PCB as small as 20 x 52 mm. The external components include antenna, LDO, USB-UART bridge, and two buttons for reset and activation of Firmware Download mode. - - .. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-pico-kit-v4.1.jpg - :align: center - :alt: ESP32-PICO-KIT V4.1 board - :width: 50% - - ESP32-PICO-KIT V4.1 board - - Comparing to ESP32-PICO-KIT V4, this version features the CP2102N USB-UART bridge that provides faster transfer rates of up to 3 Mbps. - - Documentation - ^^^^^^^^^^^^^ - - * :doc:`../hw-reference/get-started-pico-kit` - * `ESP32-PICO-KIT V4.1 Schematic `_ (PDF) - * `ESP32-PICO-KIT Reference Design `_ containing OrCAD schematic, PCB layout, gerber and BOM files - * `ESP32-PICO-D4 Datasheet `_ (PDF) - - Previous Versions - ^^^^^^^^^^^^^^^^^ - - * :ref:`esp-modules-and-boards-esp32-pico-kit-v4` - * :ref:`esp-modules-and-boards-esp32-pico-kit-v3` - - - .. _esp-modules-and-boards-esp32-devkitc: - - ESP32 DevKitC V4 - ---------------- - - This is a small and convenient development board that features: - - - :ref:`esp-modules-and-boards-esp32-wroom-32` module - - USB-to-serial programming interface that also provides power supply for the board - - pin headers - - pushbuttons for reset and activation of Firmware Download mode - - a few other components - - Comparing to the previous :ref:`esp-modules-and-boards-esp32-devkitc-v2`, this version can integrate :ref:`esp-modules-and-boards-esp32-wrover` module instead of ESP32-WROOM-32 and has the CP2102N chip that supports faster baud rates. - - .. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-devkitc-v4-front.jpg - :align: center - :alt: ESP32 DevKitC V4 board - :width: 50% - - ESP32 DevKitC V4 board - - Documentation - ^^^^^^^^^^^^^ - - * :doc:`../hw-reference/get-started-devkitc` - * `ESP32-DevKitC schematic `_ (PDF) - * `ESP32-DevKitC Reference Design `_ containing OrCAD schematic, PCB layout, gerber and BOM files - * `CP210x USB to UART Bridge VCP Drivers `_ - - Previous Versions - ^^^^^^^^^^^^^^^^^ - - * :ref:`esp-modules-and-boards-esp32-devkitc-v2` - - - .. _esp-modules-and-boards-esp-wrover-kit: - - ESP-WROVER-KIT V4.1 - ------------------- - - This board features: - - - Dual port USB-to-serial converter for programming - - JTAG interface for debugging - - MicroSD card slot - - 3.2” SPI LCD screen - - Female headers for a camera module - - RGB LED for diagnostics - - 32.768 kHz XTAL for internal RTC to operate it in low power modes - - Power can be supplied either via USB or via a standard 5 mm power supply jack. A power source can be selected with a jumper and can be turned on/off with a separate switch. - - This version of the ESP-WROVER-KIT board integrates the ESP-WROVER-B module that has 8 MB PSRAM for flexible extended storage and data processing capabilities. The board can accommodate other versions of ESP modules described in :ref:`esp-wroom-solo-wrover-modules`. - - Comparing to :ref:`esp-modules-and-boards-esp-wrover-kit-v3`, this board has the following design changes: - - - JP8, JP11, and JP13 have been combined into a single JP2. - - USB connector has been changed to DIP type and moved to the lower right corner of the board. - - R61 has been changed to a Zero-ohm resistor. - - Some components have been replaced with functional equivalents based on test results and sourcing options, e.g., the EN and Boot buttons. - - .. figure:: https://dl.espressif.com/dl/schematics/pictures/esp-wrover-kit-v4.1-front.jpg - :align: center - :alt: ESP-WROVER-KIT V4.1 board - :width: 90% - - ESP-WROVER-KIT V4.1 board - - The board in the picture above integrates the ESP32-WROVER-B module. - - Documentation - ^^^^^^^^^^^^^ - - * :doc:`../hw-reference/get-started-wrover-kit` - * `ESP-WROVER-KIT V4.1 Schematic `__ (PDF) - * :doc:`../api-guides/jtag-debugging/index` - * `FTDI Virtual COM Port Drivers`_ - - Previous Versions - ^^^^^^^^^^^^^^^^^ - - * :ref:`esp-modules-and-boards-esp-wrover-kit-v3` - * :ref:`esp-modules-and-boards-esp-wrover-kit-v2` - * :ref:`esp-modules-and-boards-esp-wrover-kit-v1` +.. only:: esp32s2 + .. include:: esp32s2/inc/modules-and-boards-esp32s2.rst Related Documents ================= * :doc:`modules-and-boards-previous` - - -.. _FTDI Virtual COM Port Drivers: http://www.ftdichip.com/Drivers/VCP.htm -.. _Espressif Products Ordering Information: https://www.espressif.com/sites/default/files/documentation/espressif_products_ordering_information_en.pdf \ No newline at end of file diff --git a/docs/zh_CN/api-guides/external-ram.rst b/docs/zh_CN/api-guides/external-ram.rst index d6148a0cc..1e9da6276 100644 --- a/docs/zh_CN/api-guides/external-ram.rst +++ b/docs/zh_CN/api-guides/external-ram.rst @@ -114,7 +114,7 @@ ESP-IDF 启动过程中，片外 RAM 被映射到以 0x3F800000 起始的数据 * 片外 RAM 与片外 flash 使用相同的 cache 区域，即频繁在片外 RAM 访问的变量可以像在片上 RAM 中一样快速读取和修改。但访问大块数据时（大于 32 KB），cache 空间可能会不足，访问速度将回落到片外 RAM 访问速度。此外，访问大块数据可以“挤出” flash cache，可能会降低代码执行速度。 - * 片外 RAM 不可用作任务堆栈存储器。因此 :cpp:func:`xTaskCreate` 及类似函数将始终为堆栈和任务 TCB 分配片上储存器，而 :cpp:func:`xTaskCreateStatic` 类型的函数将检查传递的 Buffer 是否属于片上存储器。但对于不以任何方式直接或间接调用 ROM 中代码的任务，menuconfig 选项 :ref:`CONFIG_SPIRAM_ALLOW_STACK_EXTERNAL_MEMORY` 将消除 `xTaskCreateStatic` 中的检查，从而允许任务堆栈存储在外部 RAM 中。但是，不建议使用此方法。 + * 片外 RAM 不可用作任务堆栈存储器。因此 :cpp:func:`xTaskCreate` 及类似函数将始终为堆栈和任务 TCB 分配片上储存器，而 :cpp:func:`xTaskCreateStatic` 类型的函数将检查传递的 Buffer 是否属于片上存储器。 * 默认情况下，片外 RAM 初始化失败将终止 ESP-IDF 启动。如果想禁用此功能，可启用 :ref:`CONFIG_SPIRAM_IGNORE_NOTFOUND` 配置选项。如果启用 :ref:`CONFIG_SPIRAM_ALLOW_BSS_SEG_EXTERNAL_MEMORY`，:ref:`CONFIG_SPIRAM_IGNORE_NOTFOUND` 选项将不能使用，这是因为在链接时，链接器已经向片外 RAM 分配符号。 diff --git a/docs/zh_CN/api-guides/jtag-debugging/configure-wrover.rst b/docs/zh_CN/api-guides/jtag-debugging/configure-wrover.rst index 7dbc6fdd0..7553bd23a 100644 --- a/docs/zh_CN/api-guides/jtag-debugging/configure-wrover.rst +++ b/docs/zh_CN/api-guides/jtag-debugging/configure-wrover.rst @@ -8,7 +8,7 @@ 配置硬件 ^^^^^^^^ -1. 根据 :doc:`../../hw-reference/get-started-wrover-kit` 文档中 :ref:`get-started-esp-wrover-kit-v4.1-setup-options` 章节所描述的信息，设置 JP8 便可以启用 JTAG 功能。 +1. 根据 :doc:`../../hw-reference/esp32/get-started-wrover-kit` 文档中 :ref:`get-started-esp-wrover-kit-v4.1-setup-options` 章节所描述的信息，设置 JP8 便可以启用 JTAG 功能。 2. 检查 ESP32 上用于 JTAG 通信的引脚是否被接到了其它硬件上，这可能会影响 JTAG 的工作。 @@ -100,11 +100,11 @@ Linux MacOS """"" -在 macOS 上，同时使用 FT2232 的 JTAG 接口和串口还需另外进行其它操作。当操作系统加载 FTDI 串口驱动的时候，它会对 FT2232 芯片的两个通道做相同的操作。但是，这两个通道中只有一个是被用作串口，而另一个用于 JTAG，如果操作系统已经为用于 JTAG 的通道加载了 FTDI 串口驱动的话，OpenOCD 将无法连接到芯片。有两个方法可以解决这个问题： +在 macOS 上，同时使用 FT2232 的 JTAG 接口和串口还需另外进行其它操作。当操作系统加载 FTDI 串口驱动的时候，它会对 FT2232 芯片的两个通道做相同的操作。但是，这两个通道中只有一个是被用作串口，而另一个用于 JTAG，如果操作系统已经为用于 JTAG 的通道加载了 FTDI 串口驱动的话，OpenOCD 将无法连接到芯片。有两个方法可以解决这个问题： 1. 在启动 OpenOCD 之前手动卸载 FTDI 串口驱动程序，然后启动 OpenOCD，再加载串口驱动程序。 -2. 修改 FTDI 驱动程序的配置，使其不会为 FT2232 芯片的通道 B 进行自我加载，该通道用于 ESP-WROVER-KIT 板上的 JTAG 通道。 +2. 修改 FTDI 驱动程序的配置，使其不会为 FT2232 芯片的通道 B 进行自我加载，该通道用于 ESP-WROVER-KIT 板上的 JTAG 通道。 手动卸载驱动程序 ................ diff --git a/docs/zh_CN/api-guides/jtag-debugging/index.rst b/docs/zh_CN/api-guides/jtag-debugging/index.rst index e6222327a..345639693 100644 --- a/docs/zh_CN/api-guides/jtag-debugging/index.rst +++ b/docs/zh_CN/api-guides/jtag-debugging/index.rst @@ -127,7 +127,7 @@ JTAG 正常工作至少需要连接的信号线有：TDI，TDO，TCK，TMS 和 G .. toctree:: :maxdepth: 1 - configure-wrover + :esp32: configure-wrover configure-other-jtag @@ -146,7 +146,7 @@ JTAG 正常工作至少需要连接的信号线有：TDI，TDO，TCK，TMS 和 G .. note:: - 上述命令中 ``-f`` 选项后跟的配置文件专用于板载 :ref:`ESP-WROOM-32 ` 模组的 ESP-WROVER-KIT 开发板。您可能需要根据具体使用的硬件而选择或修改不同的配置文件，相关指导请参阅 :ref:`jtag-debugging-tip-openocd-configure-target`。 + 上述命令中 ``-f`` 选项后跟的配置文件专用于板载 esp32-wroom-32 模组的 ESP-WROVER-KIT 开发板。您可能需要根据具体使用的硬件而选择或修改不同的配置文件，相关指导请参阅 :ref:`jtag-debugging-tip-openocd-configure-target`。 .. highlight:: none diff --git a/docs/zh_CN/api-guides/jtag-debugging/tips-and-quirks.rst b/docs/zh_CN/api-guides/jtag-debugging/tips-and-quirks.rst index 55fe4c461..e73ccf83f 100644 --- a/docs/zh_CN/api-guides/jtag-debugging/tips-and-quirks.rst +++ b/docs/zh_CN/api-guides/jtag-debugging/tips-and-quirks.rst @@ -116,7 +116,7 @@ OpenOCD 完全支持 ESP-IDF 自带的 FreeRTOS 操作系统，GDB 会将 FreeRT OpenOCD 需要知道当前使用的 JTAG 适配器的类型，以及其连接的目标板和处理器的类型。为此，请使用位于 OpenOCD 安装目录下 ``share/openocd/scripts/interface`` 和 ``share/openocd/scripts/board`` 文件夹中现有的配置文件。 -例如，如果使用板载 ESP-WROOM-32 模组的 ESP-WROVER-KIT 开发板（详见 :ref:`esp-modules-and-boards-esp-wrover-kit-v1`），请使用以下配置文件： +例如，如果使用板载 ESP-WROOM-32 模组的 ESP-WROVER-KIT 开发板，请使用以下配置文件： * ``board/esp32-wrover-kit-3.3v.cfg`` diff --git a/docs/zh_CN/api-reference/system/power_management.rst b/docs/zh_CN/api-reference/system/power_management.rst index 7e5487982..86a02ca0d 100644 --- a/docs/zh_CN/api-reference/system/power_management.rst +++ b/docs/zh_CN/api-reference/system/power_management.rst @@ -67,7 +67,7 @@ ESP32 支持下表中所述的三种电源管理锁。 .. only:: esp32 - .. include:: ../../en/inc/power_management_esp32.rst + .. include:: ../../../en/api-reference/system/inc/power_management_esp32.rst 动态调频和外设驱动 ------------------------------------------------ diff --git a/docs/zh_CN/get-started-legacy/index.rst b/docs/zh_CN/get-started-legacy/index.rst index b7c7aa449..4a474fae6 100644 --- a/docs/zh_CN/get-started-legacy/index.rst +++ b/docs/zh_CN/get-started-legacy/index.rst @@ -57,10 +57,10 @@ ESP32 采用 40 nm 工艺制成，具有最佳的功耗性能、射频性能、 .. toctree:: :maxdepth: 1 - 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> + ESP32-DevKitC <../hw-reference/esp32/get-started-devkitc> + ESP-WROVER-KIT <../hw-reference/esp32/get-started-wrover-kit> + ESP32-PICO-KIT <../hw-reference/esp32/get-started-pico-kit> + ESP32-Ethernet-Kit <../hw-reference/esp32/get-started-ethernet-kit> .. _get-started-step-by-step-legacy: @@ -399,7 +399,7 @@ Windows 操作系统 用户可以在使用 ``make`` 命令时 **直接设置** 部分环境变量，而无需进入 ``make menuconfig`` 进行重新配置。这些变量包括： -.. list-table:: +.. list-table:: :widths: 25 75 :header-rows: 1 @@ -420,7 +420,7 @@ Windows 操作系统 更新 ESP-IDF ============= -乐鑫会不时推出更新版本的 ESP-IDF，修复 bug 或推出新的特性。因此，您在使用时，也应注意更新您本地的版本。最简单的方法是：直接删除您本地的 ``esp-idf`` 文件夹，然后按照 :ref:`get-started-get-esp-idf-legacy` 中的指示，重新完成克隆。 +乐鑫会不时推出更新版本的 ESP-IDF，修复 bug 或推出新的特性。因此，您在使用时，也应注意更新您本地的版本。最简单的方法是：直接删除您本地的 ``esp-idf`` 文件夹，然后按照 :ref:`get-started-get-esp-idf-legacy` 中的指示，重新完成克隆。 如果您希望将 ESP-IDF 克隆到新的路径下，请务必 :doc:`重新设置 IDF_PATH `。否则，工具链将无法找到 ESP-IDF。 diff --git a/docs/zh_CN/get-started/index.rst b/docs/zh_CN/get-started/index.rst index 907638154..c0f55bc17 100644 --- a/docs/zh_CN/get-started/index.rst +++ b/docs/zh_CN/get-started/index.rst @@ -68,10 +68,10 @@ .. toctree:: :maxdepth: 1 - 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> + ESP32-DevKitC <../hw-reference/esp32/get-started-devkitc> + ESP-WROVER-KIT <../hw-reference/esp32/get-started-wrover-kit> + ESP32-PICO-KIT <../hw-reference/esp32/get-started-pico-kit> + ESP32-Ethernet-Kit <../hw-reference/esp32/get-started-ethernet-kit> .. _get-started-step-by-step: diff --git a/docs/zh_CN/hw-reference/get-started-devkitc-v2.rst b/docs/zh_CN/hw-reference/esp32/get-started-devkitc-v2.rst similarity index 87% rename from docs/zh_CN/hw-reference/get-started-devkitc-v2.rst rename to docs/zh_CN/hw-reference/esp32/get-started-devkitc-v2.rst index 298a2245d..5978b8710 100644 --- a/docs/zh_CN/hw-reference/get-started-devkitc-v2.rst +++ b/docs/zh_CN/hw-reference/esp32/get-started-devkitc-v2.rst @@ -29,7 +29,7 @@ ESP32-DevKitC V2 开发板的主要组件、接口及控制方式见下。 .. _get-started-esp32-devkitc-v2-board-front: -.. figure:: ../../_static/esp32-devkitc-v2-functional-overview.png +.. figure:: ../../../_static/esp32-devkitc-v2-functional-overview.png :align: center :alt: ESP32-DevKitC V2 开发板 :figclass: align-center @@ -38,7 +38,7 @@ ESP32-DevKitC V2 开发板的主要组件、接口及控制方式见下。 ESP32-DevKitC V2 开发板 -.. list-table:: +.. list-table:: :widths: 25 75 :header-rows: 1 @@ -74,7 +74,7 @@ ESP32-DevKitC V2 开发板 ESP32-DevKitC V2 上电前，请首先确认开发板完好无损。 -现在，请前往 :doc:`index` 中的 :ref:`get-started-step-by-step` 章节，查看如何设置开发环境，并尝试将示例项目烧录至您的开发板。 +现在，请前往 :doc:`../../get-started/index` 中的 :ref:`get-started-step-by-step` 章节，查看如何设置开发环境，并尝试将示例项目烧录至您的开发板。 相关文档 diff --git a/docs/zh_CN/hw-reference/get-started-devkitc.rst b/docs/zh_CN/hw-reference/esp32/get-started-devkitc.rst similarity index 89% rename from docs/zh_CN/hw-reference/get-started-devkitc.rst rename to docs/zh_CN/hw-reference/esp32/get-started-devkitc.rst index 107c55d90..7ec6a669d 100644 --- a/docs/zh_CN/hw-reference/get-started-devkitc.rst +++ b/docs/zh_CN/hw-reference/esp32/get-started-devkitc.rst @@ -3,7 +3,7 @@ ESP32-DevKitC V4 入门指南 :link_to_translation:`en: [English]` -本指南介绍了如何开始使用 ESP32-DevKitC V4 开发板。有关 ESP32-DevKitC 其他版本的介绍，请见：:doc:`../hw-reference/index`。 +本指南介绍了如何开始使用 ESP32-DevKitC V4 开发板。有关 ESP32-DevKitC 其他版本的介绍，请见：:doc:`../../hw-reference/index`。 准备工作 @@ -48,7 +48,7 @@ ESP32-DevKitC V4 开发板的主要组件、接口及控制方式见下。 .. _get-started-esp32-devkitc-board-front: -.. figure:: ../../_static/esp32-devkitc-functional-overview.jpg +.. figure:: ../../../_static/esp32-devkitc-functional-overview.jpg :align: center :alt: ESP32-DevKitC V4（板载 ESP32-WROOM-32） :figclass: align-center @@ -56,7 +56,7 @@ ESP32-DevKitC V4 开发板的主要组件、接口及控制方式见下。 ESP32-DevKitC V4（板载 ESP32-WROOM-32） -.. list-table:: +.. list-table:: :widths: 25 75 :header-rows: 1 @@ -79,7 +79,7 @@ ESP32-DevKitC V4（板载 ESP32-WROOM-32） .. note:: - 管脚 D0、D1、D2、D3、CMD 和 CLK 用于 ESP32 芯片与 SPI flash 间的内部通信，集中分布在开发板两侧靠近 USB 端口的位置。通常而言，这些管脚最好不连，否则可能影响 SPI flash / SPI RAM 的工作。 + 管脚 D0、D1、D2、D3、CMD 和 CLK 用于 ESP32 芯片与 SPI flash 间的内部通信，集中分布在开发板两侧靠近 USB 端口的位置。通常而言，这些管脚最好不连，否则可能影响 SPI flash / SPI RAM 的工作。 .. note:: @@ -110,7 +110,7 @@ ESP32-DevKitC V4（板载 ESP32-WROOM-32） 用户如果认为 C15 可能影响开发板的使用，则可以将 C15 完全移除。C15 在开发板上的具体位置见下图黄色部分。 -.. figure:: ../../_static/esp32-devkitc-c15-location.png +.. figure:: ../../../_static/esp32-devkitc-c15-location.png :align: center :alt: C15（黄色）在 ESP32-DevKitC V4 开发板上的位置 :figclass: align-center @@ -124,12 +124,12 @@ C15（黄色）在 ESP32-DevKitC V4 开发板上的位置 ESP32-DevKitC V4 上电前，请首先确认开发板完好无损。 -现在，请前往 :doc:`index` 中的 :ref:`get-started-step-by-step` 章节，查看如何设置开发环境，并尝试将示例项目烧录至您的开发板。 +现在，请前往 :doc:`../../get-started/index` 中的 :ref:`get-started-step-by-step` 章节，查看如何设置开发环境，并尝试将示例项目烧录至您的开发板。 开发板尺寸 ------------- -.. figure:: ../../_static/esp32-devkitc-dimensions-back.jpg +.. figure:: ../../../_static/esp32-devkitc-dimensions-back.jpg :align: center :alt: ESP32-DevKitC 开发板尺寸 -- 仰视图 :figclass: align-center diff --git a/docs/zh_CN/hw-reference/get-started-ethernet-kit-v1.0.rst b/docs/zh_CN/hw-reference/esp32/get-started-ethernet-kit-v1.0.rst similarity index 94% rename from docs/zh_CN/hw-reference/get-started-ethernet-kit-v1.0.rst rename to docs/zh_CN/hw-reference/esp32/get-started-ethernet-kit-v1.0.rst index 3d86e5130..01731a327 100644 --- a/docs/zh_CN/hw-reference/get-started-ethernet-kit-v1.0.rst +++ b/docs/zh_CN/hw-reference/esp32/get-started-ethernet-kit-v1.0.rst @@ -24,7 +24,7 @@ ESP32-Ethernet-Kit 是一款来自 `乐鑫 `_ 的开发 .. _get-started-esp32-ethernet-kit-b-v1.0: -.. figure:: ../../_static/esp32-ethernet-kit-v1.0.png +.. figure:: ../../../_static/esp32-ethernet-kit-v1.0.png :align: center :alt: ESP32-Ethernet-Kit V1.0 :figclass: align-center @@ -39,7 +39,7 @@ ESP32-Ethernet-Kit 是一款来自 `乐鑫 `_ 的开发 ESP32-Ethernet-Kit 开发板的主要组件和连接方式见下。 -.. figure:: ../../_static/esp32-ethernet-kit-block-diagram.png +.. figure:: ../../../_static/esp32-ethernet-kit-block-diagram.png :align: center :scale: 50% :alt: ESP32-Ethernet-Kit 功能框图（点击放大） @@ -59,7 +59,7 @@ ESP32-Ethernet-Kit 开发板的主要组件、接口及控制方式见下。 以太网子板（A 板） ^^^^^^^^^^^^^^^^^^ -.. figure:: ../../_static/esp32-ethernet-kit-a-v1.0-layout.png +.. figure:: ../../../_static/esp32-ethernet-kit-a-v1.0-layout.png :align: center :scale: 80% :alt: ESP32-Ethernet-Kit - 以太网子板（A 板）布局 @@ -87,7 +87,7 @@ GPIO Header 3 可连接至 ESP32 的部分 GPIO，根据 `功能选 FT2232H FT2232H 多协议 USB 转串口桥接器。开发人员可通过 USB 接口对 FT2232H 芯片进行控制和编程，与 ESP32 建立连接。FT2232H 芯片可在通道 A 提供 USB-to-JTAG 接口功能，并在通道 B 提供 USB-to-Serial 接口功能，便利开发人员的应用开发与调试。见 `ESP32-Ethernet-Kit V1.0 以太网子板（A 板）原理图`_。 USB 端口 USB 接口。可用作开发板的供电电源，或连接 PC 和开发板的通信接口。 - + 电源开关 电源开关。拨向 **Boot** 按键一侧，开发板上电；拨离 **Boot** 按键一侧，开发板掉电。 5V Input 5V 电源接口建议仅在开发板自动运行（未连接 PC）时使用。仅用于全负荷工作下的后备电源。 @@ -127,7 +127,7 @@ PoE 子板（B 板）具有以下特性： 如需使用 PoE 功能，请用以太网线缆将以太网子板（A 板）上的 **RJ45 端口** 连接至 PoE 的交换机。太网子板（A 板）检测到来自 PoE 子板（B 板）的 5 V 供电后，将从 USB 供电自动切换至 PoE 供电。 -.. figure:: ../../_static/esp32-ethernet-kit-b-v1.0-layout.png +.. figure:: ../../../_static/esp32-ethernet-kit-b-v1.0-layout.png :align: center :scale: 80% :alt: ESP32-Ethernet-Kit - PoE 子板（B 板） @@ -136,7 +136,7 @@ PoE 子板（B 板）具有以下特性： ESP32-Ethernet-Kit - PoE 子板（B 板）布局（点击放大） ========================== ================================================================================================================================= -主要组件 基本介绍 +主要组件 基本介绍 ========================== ================================================================================================================================= A 板连接器 1 个 4 针排母，用于将 B 板连接至 :ref:`以太网子板（A 板）`。 外部电源终端 PoE 子板（B 板）备用电源。 @@ -340,7 +340,7 @@ ESP32-Ethernet-Kit 上电前，请首先确认开发板完好无损。 正式开始开发 ^^^^^^^^^^^^^^^^^^ -现在，请前往 :doc:`../get-started/index` 中的 :ref:`get-started-step-by-step` 章节，查看如何设置开发环境，并尝试将示例项目烧录至您的开发板。 +现在，请前往 :doc:`../../get-started/index` 中的 :ref:`get-started-step-by-step` 章节，查看如何设置开发环境，并尝试将示例项目烧录至您的开发板。 如需使用较早 GNU Make 编译系统，则请参考 :ref:`get-started-step-by-step` 章节。 @@ -360,8 +360,8 @@ ESP32-Ethernet-Kit 上电前，请首先确认开发板完好无损。 * `ESP32-Ethernet-Kit V1.0 PoE 子板（B 板）原理图`_ (PDF) * `《ESP32 技术规格书》 `_ (PDF) * `《ESP32-WROVER-B 技术规格书》 `_ (PDF) -* :doc:`../api-guides/jtag-debugging/index` -* :doc:`../hw-reference/index` +* :doc:`../../api-guides/jtag-debugging/index` +* :doc:`../../hw-reference/index` .. _ESP32-Ethernet-Kit V1.0 以太网子板（A 板）原理图: https://dl.espressif.com/dl/schematics/SCH_ESP32-ETHERNET-KIT_A_V1.0_20190517.pdf .. _ESP32-Ethernet-Kit V1.0 PoE 子板（B 板）原理图: https://dl.espressif.com/dl/schematics/SCH_ESP32-ETHERNET-KIT_B_V1.0_20190517.pdf diff --git a/docs/zh_CN/hw-reference/esp32/get-started-ethernet-kit.rst b/docs/zh_CN/hw-reference/esp32/get-started-ethernet-kit.rst new file mode 100644 index 000000000..3932cfb3c --- /dev/null +++ b/docs/zh_CN/hw-reference/esp32/get-started-ethernet-kit.rst @@ -0,0 +1 @@ +.. include:: ../../../en/hw-reference/esp32/get-started-ethernet-kit.rst diff --git a/docs/zh_CN/hw-reference/get-started-pico-kit-v3.rst b/docs/zh_CN/hw-reference/esp32/get-started-pico-kit-v3.rst similarity index 89% rename from docs/zh_CN/hw-reference/get-started-pico-kit-v3.rst rename to docs/zh_CN/hw-reference/esp32/get-started-pico-kit-v3.rst index d662f1bd8..92b9dd680 100644 --- a/docs/zh_CN/hw-reference/get-started-pico-kit-v3.rst +++ b/docs/zh_CN/hw-reference/esp32/get-started-pico-kit-v3.rst @@ -2,7 +2,7 @@ ESP32-PICO-KIT V3 入门指南 ======================================= :link_to_translation:`en:[English]` -本指南介绍了如何开始使用 ESP32-PICO-KIT V3 迷你开发板。有关 ESP32-PICO-KIT 其他版本的介绍，请见：:doc:`../hw-reference/index`。 +本指南介绍了如何开始使用 ESP32-PICO-KIT V3 迷你开发板。有关 ESP32-PICO-KIT 其他版本的介绍，请见：:doc:`../../hw-reference/index`。 准备工作 @@ -30,7 +30,7 @@ ESP32-PICO-KIT 集成了 USB 转 UART 桥接电路，允许开发人员直接通 ESP32-PICO-KIT V3 开发板的主要组件、接口及控制方式见下。 -.. figure:: ../../_static/esp32-pico-kit-v3-layout.jpg +.. figure:: ../../../_static/esp32-pico-kit-v3-layout.jpg :align: center :alt: ESP32-PICO-KIT V3 开发板布局 :figclass: align-center @@ -39,10 +39,10 @@ ESP32-PICO-KIT V3 开发板的主要组件、接口及控制方式见下。 ESP32-PICO-KIT 开发板的主要组件描述见下表。 -.. list-table:: +.. list-table:: :widths: 25 75 :header-rows: 1 - + * - 主要组件 - 基本介绍 * - ESP32-PICO-D4 @@ -68,7 +68,7 @@ ESP32-PICO-KIT 开发板的主要组件描述见下表。 ESP32-PICO-KIT V3 上电前，请首先确认开发板完好无损。 -现在，请前往 :doc:`index` 中的 :ref:`get-started-step-by-step` 章节，查看如何设置开发环境，并尝试将示例项目烧录至您的开发板。 +现在，请前往 :doc:`../../get-started/index` 中的 :ref:`get-started-step-by-step` 章节，查看如何设置开发环境，并尝试将示例项目烧录至您的开发板。 相关文档 @@ -76,6 +76,6 @@ ESP32-PICO-KIT V3 上电前，请首先确认开发板完好无损。 * `ESP32-PICO-KIT V3 原理图 `_ (PDF) * `《ESP32-PICO-D4 技术规格书》 `_ (PDF) -* :doc:`../hw-reference/index` +* :doc:`../../hw-reference/index` diff --git a/docs/zh_CN/hw-reference/get-started-pico-kit.rst b/docs/zh_CN/hw-reference/esp32/get-started-pico-kit.rst similarity index 94% rename from docs/zh_CN/hw-reference/get-started-pico-kit.rst rename to docs/zh_CN/hw-reference/esp32/get-started-pico-kit.rst index a7c88cd39..054fc63e3 100644 --- a/docs/zh_CN/hw-reference/get-started-pico-kit.rst +++ b/docs/zh_CN/hw-reference/esp32/get-started-pico-kit.rst @@ -2,7 +2,7 @@ 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 其他版本的介绍，请见：: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。 @@ -43,7 +43,7 @@ ESP32-PICO-KIT 集成了 USB 转 UART 桥接电路，允许开发人员直接通 ESP32-PICO-KIT 开发板的主要组件和连接方式见下。 -.. figure:: ../../_static/esp32-pico-kit-v4-functional-block-diagram.png +.. figure:: ../../../_static/esp32-pico-kit-v4-functional-block-diagram.png :align: center :alt: ESP32-PICO-KIT 功能框图 :figclass: align-center @@ -58,7 +58,7 @@ ESP32-PICO-KIT 开发板的主要组件、接口及控制方式见下。 .. _get-started-pico-kit-v4-board-front: -.. figure:: ../../_static/esp32-pico-kit-v4.1-f-layout.jpeg +.. figure:: ../../../_static/esp32-pico-kit-v4.1-f-layout.jpeg :align: center :alt: ESP32-PICO-KIT 开发板布局 :figclass: align-center @@ -67,7 +67,7 @@ ESP32-PICO-KIT 开发板的主要组件、接口及控制方式见下。 ESP32-PICO-KIT 开发板的主要组件描述见下表（从左上角起顺时针顺序）。 -.. list-table:: +.. list-table:: :widths: 25 75 :header-rows: 1 @@ -79,7 +79,7 @@ ESP32-PICO-KIT 开发板的主要组件描述见下表（从左上角起顺时 - 5V-to-3.3V 低压差稳压器 * - USB-to-UART 桥接器 - 单芯片 USB-to-UART 桥接器。V4 版本搭载的 CP2102 可提供高达 1 Mbps 的传输速率，V4.1 版本搭载的 CP2102N 可提供高达 3 Mbps 的传输速率。 - * - Micro USB 端口 + * - Micro USB 端口 - USB 接口。可用作开发板的供电电源，或连接 PC 和开发板的通信接口。 * - 5V Power On LED - 开发板通电后，该红色指示灯将亮起。更多信息，请见 `相关文档`_ 中的原理图。 @@ -119,7 +119,7 @@ Header J2 ====== ================= ====== ====================================================== 1 FLASH_SD1 (FSD1) I/O | GPIO8, SD_DATA1, SPID, HS1_DATA1 :ref:`（见说明 1） ` , U2CTS 2 FLASH_SD3 (FSD3) I/O | GPIO7, SD_DATA0, SPIQ, HS1_DATA0 :ref:`（见说明 1） ` , U2RTS -3 FLASH_CLK (FCLK) I/O | GPIO6, SD_CLK, SPICLK, HS1_CLK :ref:`（见说明 1） ` , U1CTS +3 FLASH_CLK (FCLK) I/O | GPIO6, SD_CLK, SPICLK, HS1_CLK :ref:`（见说明 1） ` , 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 @@ -192,7 +192,7 @@ No. Name Type Function ESP32-PICO-KIT 上电前，请首先确认开发板完好无损。 -现在，请前往 :doc:`index` 中的 :ref:`get-started-step-by-step` 章节，查看如何设置开发环境，并尝试将示例项目烧录至您的开发板。 +现在，请前往 :doc:`../../get-started/index` 中的 :ref:`get-started-step-by-step` 章节，查看如何设置开发环境，并尝试将示例项目烧录至您的开发板。 开发板尺寸 @@ -200,14 +200,14 @@ ESP32-PICO-KIT 上电前，请首先确认开发板完好无损。 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 +.. 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 +.. figure:: ../../../_static/esp32-pico-kit-v4-dimensions-side.jpg :align: center :alt: ESP32-PICO-KIT V4 尺寸图 -- 侧面 :figclass: align-center @@ -224,7 +224,7 @@ ESP32-PICO-KIT 的尺寸为 52 x 20.3 x 10 mm (2.1" x 0.8" x 0.4")。 * `ESP32-PICO-KIT V4.1 原理图 `_ (PDF) * `ESP32-PICO-KIT 参考设计 `_ ，内含 OrCAD 原理图、PCB 布局、Gerbers 和 BOM 表。 * `《ESP32-PICO-D4 技术规格书》 `_ (PDF) -* :doc:`../hw-reference/index` +* :doc:`../../hw-reference/index` .. toctree:: diff --git a/docs/zh_CN/hw-reference/get-started-wrover-kit-v2.rst b/docs/zh_CN/hw-reference/esp32/get-started-wrover-kit-v2.rst similarity index 89% rename from docs/zh_CN/hw-reference/get-started-wrover-kit-v2.rst rename to docs/zh_CN/hw-reference/esp32/get-started-wrover-kit-v2.rst index b606dccf9..8793dc974 100644 --- a/docs/zh_CN/hw-reference/get-started-wrover-kit-v2.rst +++ b/docs/zh_CN/hw-reference/esp32/get-started-wrover-kit-v2.rst @@ -2,7 +2,7 @@ ESP-WROVER-KIT V2 入门指南 =========================================== :link_to_translation:`en:[English]` -本指南介绍了如何开始使用 ESP-WROVER-KIT V2 开发板及其功能和相关配置。有关 ESP-WROVER-KIT 其他版本的介绍，请见：:doc:`../hw-reference/index`。 +本指南介绍了如何开始使用 ESP-WROVER-KIT V2 开发板及其功能和相关配置。有关 ESP-WROVER-KIT 其他版本的介绍，请见：:doc:`../../hw-reference/index`。 准备工作 @@ -39,7 +39,7 @@ ESP-WROVER-KIT 可选贴以下 ESP32 模组： ESP-WROVER-KIT 开发板的主要组件和连接方式如下图所示。 -.. figure:: ../../_static/esp-wrover-kit-block-diagram.png +.. figure:: ../../../_static/esp-wrover-kit-block-diagram.png :align: center :alt: ESP-WROVER-KIT 功能框图 :figclass: align-center @@ -54,7 +54,7 @@ ESP-WROVER-KIT 开发板的主要组件、接口及控制方式见下。 .. _get-started-esp-wrover-kit-v2-board-front: -.. figure:: ../../_static/esp-wrover-kit-v2-layout-front.png +.. figure:: ../../../_static/esp-wrover-kit-v2-layout-front.png :align: center :alt: ESP-WROVER-KIT 开发板布局 -- 俯视图 :figclass: align-center @@ -63,7 +63,7 @@ ESP-WROVER-KIT 开发板的主要组件、接口及控制方式见下。 .. _get-started-esp-wrover-kit-v2-board-back: -.. figure:: ../../_static/esp-wrover-kit-v2-layout-back.png +.. figure:: ../../../_static/esp-wrover-kit-v2-layout-back.png :align: center :alt: ESP-WROVER-KIT 开发板布局 -- 仰视图 :figclass: align-center @@ -73,7 +73,7 @@ ESP-WROVER-KIT 开发板的主要组件、接口及控制方式见下。 下表从图片右上角开始，以顺时针顺序介绍了图 1 中的主要组件，然后以同样的顺序介绍了图 2 中的主要组件。 -.. list-table:: +.. list-table:: :widths: 25 75 :header-rows: 1 @@ -112,7 +112,7 @@ ESP-WROVER-KIT 开发板的主要组件、接口及控制方式见下。 * - RGB LED - 红绿蓝发光二极管，可由 PWM（脉冲宽度调制）控制。 * - I/O - - 板上模组的所有管脚均已引出至开发板的排针。用户可以对 ESP32 进行编程，实现 PWM、ADC、DAC、I2C、I2S、SPI 等多种功能。 + - 板上模组的所有管脚均已引出至开发板的排针。用户可以对 ESP32 进行编程，实现 PWM、ADC、DAC、I2C、I2S、SPI 等多种功能。 * - MicroSD 卡槽 - MicroSD 卡槽，可扩充存储空间：当 ESP32 进入下载模式时，GPIO2 不可处于高电平。然而，为了使能 MicroSD 卡功能，需为 GPIO2 增加一个上拉电阻。默认情况下，GPIO2 和上拉电阻 R153 处于断开状态。为了使能 MicroSD 卡，请按照 `设置选项`_ 章节的要求，连接 JP1 连接器。 * - LCD 显示屏 @@ -169,7 +169,7 @@ USB 供电 使能 UART 通信 正式开始开发 ^^^^^^^^^^^^^^^^^^ -现在，请前往 :doc:`index` 中的 :ref:`get-started-step-by-step` 章节，查看如何设置开发环境，并尝试将示例项目烧录至您的开发板。 +现在，请前往 :doc:`../../get-started/index` 中的 :ref:`get-started-step-by-step` 章节，查看如何设置开发环境，并尝试将示例项目烧录至您的开发板。 相关文档 @@ -179,16 +179,16 @@ USB 供电 使能 UART 通信 * `《ESP32 技术规格书》 `_ (PDF) * `《ESP32-WROVER 技术规格书》 `_ (PDF) * `《ESP32-WROOM-32 技术规格书》 `_ (PDF) -* :doc:`../api-guides/jtag-debugging/index` -* :doc:`../hw-reference/index` +* :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 +.. |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 diff --git a/docs/zh_CN/hw-reference/get-started-wrover-kit-v3.rst b/docs/zh_CN/hw-reference/esp32/get-started-wrover-kit-v3.rst similarity index 94% rename from docs/zh_CN/hw-reference/get-started-wrover-kit-v3.rst rename to docs/zh_CN/hw-reference/esp32/get-started-wrover-kit-v3.rst index ab8e8f753..50f1b7aa9 100644 --- a/docs/zh_CN/hw-reference/get-started-wrover-kit-v3.rst +++ b/docs/zh_CN/hw-reference/esp32/get-started-wrover-kit-v3.rst @@ -2,7 +2,7 @@ ESP-WROVER-KIT V3 入门指南 ======================================= :link_to_translation:`en:[English]` -本指南介绍了如何开始使用 ESP-WROVER-KIT V3 开发板及其功能和相关配置。有关 ESP-WROVER-KIT 其他版本的介绍，请见：:doc:`../hw-reference/index`。 +本指南介绍了如何开始使用 ESP-WROVER-KIT V3 开发板及其功能和相关配置。有关 ESP-WROVER-KIT 其他版本的介绍，请见：:doc:`../../hw-reference/index`。 准备工作 @@ -39,7 +39,7 @@ ESP-WROVER-KIT 可选贴以下 ESP32 模组： ESP-WROVER-KIT 开发板的主要组件和连接方式如下图所示。 -.. figure:: ../../_static/esp-wrover-kit-block-diagram.png +.. figure:: ../../../_static/esp-wrover-kit-block-diagram.png :align: center :alt: ESP-WROVER-KIT 功能框图 :figclass: align-center @@ -54,7 +54,7 @@ ESP-WROVER-KIT 开发板的主要组件、接口及控制方式见下。 .. _get-started-esp-wrover-kit-v3-board-front: -.. figure:: ../../_static/esp-wrover-kit-v3-layout-front.jpg +.. figure:: ../../../_static/esp-wrover-kit-v3-layout-front.jpg :align: center :alt: ESP-WROVER-KIT 开发板布局 -- 俯视图 :figclass: align-center @@ -63,7 +63,7 @@ ESP-WROVER-KIT 开发板的主要组件、接口及控制方式见下。 .. _get-started-esp-wrover-kit-v3-board-back: -.. figure:: ../../_static/esp-wrover-kit-v3-layout-back.jpg +.. figure:: ../../../_static/esp-wrover-kit-v3-layout-back.jpg :align: center :alt: ESP-WROVER-KIT 开发板布局 -- 仰视图 :figclass: align-center @@ -73,7 +73,7 @@ ESP-WROVER-KIT 开发板的主要组件、接口及控制方式见下。 下表从图片右上角开始，以顺时针顺序介绍了图 1 中的主要组件，然后以同样的顺序介绍图 2 中的主要组件。 -.. list-table:: +.. list-table:: :widths: 25 75 :header-rows: 1 @@ -114,7 +114,7 @@ ESP-WROVER-KIT 开发板的主要组件、接口及控制方式见下。 * - RGB LED - 红绿蓝发光二极管，可由 PWM（脉冲宽度调制）控制。 * - I/O - - 板上模组的所有管脚均已引出至开发板的排针。用户可以对 ESP32 进行编程，实现 PWM、ADC、DAC、I2C、I2S、SPI 等多种功能。 + - 板上模组的所有管脚均已引出至开发板的排针。用户可以对 ESP32 进行编程，实现 PWM、ADC、DAC、I2C、I2S、SPI 等多种功能。 * - MicroSD 卡槽 - 适用于需要扩充数据存储空间或进行备份的应用开发场景。 * - LCD 显示屏 @@ -352,7 +352,7 @@ USB 供电 使能 UART 通信 正式开始开发 ^^^^^^^^^^^^^^^^^^ -现在，请前往 :doc:`index` 中的 :ref:`get-started-step-by-step` 章节，查看如何设置开发环境，并尝试将示例项目烧录至您的开发板。 +现在，请前往 :doc:`../../get-started/index` 中的 :ref:`get-started-step-by-step` 章节，查看如何设置开发环境，并尝试将示例项目烧录至您的开发板。 相关文档 ----------------- @@ -361,14 +361,14 @@ USB 供电 使能 UART 通信 * `《ESP32 技术规格书》 `_ (PDF) * `《ESP32-WROVER 技术规格书》 `_ (PDF) * `《ESP32-WROOM-32 技术规格书》 `_ (PDF) -* :doc:`../api-guides/jtag-debugging/index` -* :doc:`../hw-reference/index` +* :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 +.. |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 diff --git a/docs/zh_CN/hw-reference/get-started-wrover-kit.rst b/docs/zh_CN/hw-reference/esp32/get-started-wrover-kit.rst similarity index 92% rename from docs/zh_CN/hw-reference/get-started-wrover-kit.rst rename to docs/zh_CN/hw-reference/esp32/get-started-wrover-kit.rst index 9b4785b3b..0171b676f 100644 --- a/docs/zh_CN/hw-reference/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 开发板及其功能和相关配置。有关 ESP-WROVER-KIT 其他版本的介绍，请见：:doc:`../../hw-reference/index`。 准备工作 @@ -40,7 +40,7 @@ ESP-WROVER-KIT 开发板已集成了如下组件： ESP-WROVER-KIT 开发板的主要组件和连接方式如下图所示。 -.. figure:: ../../_static/esp-wrover-kit-block-diagram.png +.. figure:: ../../../_static/esp-wrover-kit-block-diagram.png :align: center :alt: ESP-WROVER-KIT 功能框图 :figclass: align-center @@ -55,7 +55,7 @@ ESP-WROVER-KIT 开发板的主要组件、接口及控制方式见下。 .. _get-started-esp-wrover-kit-v4.1-board-front: -.. figure:: ../../_static/esp-wrover-kit-v4.1-layout-front.png +.. figure:: ../../../_static/esp-wrover-kit-v4.1-layout-front.png :align: center :alt: ESP-WROVER-KIT 开发板布局 -- 俯视图 :figclass: align-center @@ -64,7 +64,7 @@ ESP-WROVER-KIT 开发板的主要组件、接口及控制方式见下。 .. _get-started-esp-wrover-kit-v4.1-board-back: -.. figure:: ../../_static/esp-wrover-kit-v4.1-layout-back.png +.. figure:: ../../../_static/esp-wrover-kit-v4.1-layout-back.png :align: center :alt: ESP-WROVER-KIT 开发板布局 -- 仰视图 :figclass: align-center @@ -74,7 +74,7 @@ ESP-WROVER-KIT 开发板的主要组件、接口及控制方式见下。 下表将从图片右上角开始，以顺时针顺序介绍图 1 中的主要组件，然后按同样顺序介绍图 2 中的主要组件。 -.. list-table:: +.. list-table:: :widths: 25 75 :header-rows: 1 @@ -90,9 +90,9 @@ ESP-WROVER-KIT 开发板的主要组件、接口及控制方式见下。 - 这款 ESP32 模组内置 64-Mbit PSRAM，可提供灵活的额外存储空间和数据处理能力。 * - 诊断 LED 信号灯 - 本开发板 FT2232 芯片的 GPIO 管脚连接了 4 个红色 LED 信号灯，以备后用。 - * - UART + * - UART - 串口。FT2232 和 ESP32 的串行 TX/RX 信号已引出至 JP2 的两端。默认情况下，这两路信号由跳线帽连接。如果仅需使用 ESP32 模组串口，则可移除相关跳线帽，将模组连接至其他外部串口设备。 - * - SPI + * - SPI - 默认情况下，ESP32 使用 SPI 接口访问内置 flash 和 PSRAM。使用这些引脚连接 ESP32 和其他 SPI 设备。这种情况下，需增加额外的片选 (CS) 信号。注意，本接口的工作电压为 3.3 V。 * - CTS/RTS - 串口流控信号。管脚默认不连接至电路。为了使能该功能，必须用跳线帽断路掉 JP14 的相应管脚。 @@ -119,7 +119,7 @@ ESP-WROVER-KIT 开发板的主要组件、接口及控制方式见下。 * - RGB LED - 红绿蓝发光二极管，可由 PMW 控制。 * - I/O 连接器 - - 板上模组的所有管脚均已引出至开发板的排针。用户可以对 ESP32 进行编程，实现 PWM、ADC、DAC、I2C、I2S、SPI 等多种功能。 + - 板上模组的所有管脚均已引出至开发板的排针。用户可以对 ESP32 进行编程，实现 PWM、ADC、DAC、I2C、I2S、SPI 等多种功能。 * - Micro SD 卡槽 - 适用于需要扩充数据存储空间或进行备份的应用开发场景。 * - LCD 显示器 @@ -134,7 +134,7 @@ ESP-WROVER-KIT 开发板的主要组件、接口及控制方式见下。 用户可通过 3 组排针，设置开发板功能，其中常见功能见下表： -.. list-table:: +.. list-table:: :widths: 25 35 40 :header-rows: 1 @@ -145,15 +145,15 @@ ESP-WROVER-KIT 开发板的主要组件、接口及控制方式见下。 - |jp7-ext_5v| - 使用外部电源为 ESP-WROVER-KIT 开发板供电 * - JP7 - - |jp7-usb_5v| + - |jp7-usb_5v| - 使用 USB 端口为 ESP-WROVER-KIT 开发板供电 - * - JP2 - - |jp2-jtag| + * - JP2 + - |jp2-jtag| - 使能 JTAG 功能 - * - JP2 + * - JP2 - |jp2-tx-rx| - 使能 UART 通信 - * - JP14 + * - JP14 - |jp14| - 使能 RTS/CTS 串口流控 @@ -163,7 +163,7 @@ ESP32 管脚分配 ESP32 模组的部分管脚/终端已被板上组件占用或用于外部硬件设备。如果某管脚对应的特定硬件未连接，则该管脚可用作他用。比如，摄像头/JP4 排针未连接相应硬件，则这些 GPIO 可用于其他用途。 -部分管脚具备多个功能，可供板上组件或外部硬件设备同时使用，比如 GPIO0 和 GPIO2。由于管脚限制，一些外围设备不可同时使用，比如，由于 JTAG 和 SD 卡槽需共用部分管脚，因此一些使用 SD 卡功能的应用无法同时进行 JTAG 调试。 +部分管脚具备多个功能，可供板上组件或外部硬件设备同时使用，比如 GPIO0 和 GPIO2。由于管脚限制，一些外围设备不可同时使用，比如，由于 JTAG 和 SD 卡槽需共用部分管脚，因此一些使用 SD 卡功能的应用无法同时进行 JTAG 调试。 其他情况下，不同外设可同时使用。比如，LCD 屏幕和 SD 卡仅共用一个 GPIO21 管脚，可以同时使用。该管脚可为 LCD 屏幕提供 D/C（数据/控制）信号，并用于读取来自 SD 卡槽的 CD 信号（卡检测信号）。如无需使用卡检测功能，开发人员还可以通过移除 R167 来禁用该功能。此时，LCD 和 SD 卡槽可同时使用。 @@ -176,7 +176,7 @@ ESP32 模组的部分管脚/终端已被板上组件占用或用于外部硬件 JP1 连接器包括 14 x 2 个排针，具体功能可见下表中间 “I/O” 列的介绍。两侧的“共用”列则介绍了这些管脚在板上的其他用途。 -.. list-table:: +.. list-table:: :widths: 30 20 20 30 :header-rows: 1 @@ -209,7 +209,7 @@ JP1 连接器包括 14 x 2 个排针，具体功能可见下表中间 “I/O” - IO35 - IO34 - 摄像头 - * - 摄像头 + * - 摄像头 - IO39 - IO36 - 摄像头 @@ -236,11 +236,11 @@ JP1 连接器包括 14 x 2 个排针，具体功能可见下表中间 “I/O” * - 摄像头，LED，Boot - IO0 - IO2 - - LED，MicroSD + - LED，MicroSD * - JTAG，MicroSD - IO15 - 5V - - + - 说明： @@ -420,7 +420,7 @@ USB 供电 使能 UART 通信 正式开始开发 ^^^^^^^^^^^^^^^^^^ -现在，请前往 :doc:`index` 中的 :ref:`get-started-step-by-step` 章节，查看如何设置开发环境，并尝试将示例项目烧录至您的开发板。 +现在，请前往 :doc:`../../get-started/index` 中的 :ref:`get-started-step-by-step` 章节，查看如何设置开发环境，并尝试将示例项目烧录至您的开发板。 相关文档 @@ -429,14 +429,14 @@ USB 供电 使能 UART 通信 * `ESP-WROVER-KIT V4.1 原理图`_ (PDF) * `《ESP32 技术规格书》 `_ (PDF) * `《ESP32-WROVER-B 技术规格书》 `_ (PDF) -* :doc:`../api-guides/jtag-debugging/index` -* :doc:`../hw-reference/index` +* :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 +.. |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 diff --git a/docs/zh_CN/hw-reference/esp32/inc/modules-and-boards-esp32.rst b/docs/zh_CN/hw-reference/esp32/inc/modules-and-boards-esp32.rst new file mode 100644 index 000000000..e5c5b56bb --- /dev/null +++ b/docs/zh_CN/hw-reference/esp32/inc/modules-and-boards-esp32.rst @@ -0,0 +1,294 @@ +.. _esp-wroom-solo-wrover-modules: + +WROOM、SOLO、WROVER 和 PICO 系列模组 +===================================== + +WROOM、SOLO、WROVER 和 PICO 系列模组内置 ESP32 芯片并集成了晶振、天线匹配电路等重要组件，可直接集成到终端产品中。如果再结合一些其他组件，例如编程接口、Bootstrapping 电阻和排针，您就可以体验 ESP32 的强大功能了。 + +下表总结了上述系列模组的主要特点，详细信息见后续章节。 + ++---------------------+--------------+-------------+-------------+------+-----------------+ +| 模组 | 芯片 | Flash (MB) | PSRAM (MB) | 天线 | 尺寸 (mm) | ++---------------------+--------------+-------------+-------------+------+-----------------+ +| ESP32-WROOM-32 | ESP32-D0WDQ6 | 4 | – | MIFA | 18 × 25.5 × 3.1 | ++---------------------+--------------+-------------+-------------+------+-----------------+ +| ESP32-WROOM-32D | ESP32-D0WD | 4、8 或 16 | – | MIFA | 18 × 25.5 × 3.1 | ++---------------------+--------------+-------------+-------------+------+-----------------+ +| ESP32-WROOM-32U | ESP32-D0WD | 4、8 或 16 | – | U.FL | 18 × 19.2 × 3.1 | ++---------------------+--------------+-------------+-------------+------+-----------------+ +| ESP32-SOLO-1 | ESP32-S0WD | 4 | – | MIFA | 18 × 25.5 × 3.1 | ++---------------------+--------------+-------------+-------------+------+-----------------+ +| ESP32-WROVER (PCB) | ESP32-D0WDQ6 | 4 | 8 | MIFA | 18 × 31.4 × 3.3 | ++---------------------+--------------+-------------+-------------+------+-----------------+ +| ESP32-WROVER (IPEX) | ESP32-D0WDQ6 | 4 | 8 | U.FL | 18 × 31.4 × 3.3 | ++---------------------+--------------+-------------+-------------+------+-----------------+ +| ESP32-WROVER-B | ESP32-D0WD | 4、8 或 16 | 8 | MIFA | 18 × 31.4 × 3.3 | ++---------------------+--------------+-------------+-------------+------+-----------------+ +| ESP32-WROVER-IB | ESP32-D0WD | 4、8 或 16 | 8 | U.FL | 18 × 31.4 × 3.3 | ++---------------------+--------------+-------------+-------------+------+-----------------+ + + +* ESP32-**D**.. 代表双核芯片，ESP32-**S**.. 代表单核芯片； +* MIFA - 蛇形倒 F 天线； +* U.FL - U.FL/IPEX 天线连接器； +* ESP32-WROOM-32x、ESP32-WROVER-B 和 ESP32-WROVER-IB 模组默认内置 4 MB flash，客户可定制 8 MB 和 16 MB flash，详情见 `乐鑫产品订购信息`_ (PDF) 和《`ESP32 技术规格书 `_》(PDF)； +* 最初发布的 ESP32-WROVER 模组内置 4 MB PSRAM； +* *ESP-WROOM-32* 是 *ESP32-WROOM-32* 的曾用名。 + +.. _esp-modules-and-boards-esp32-wroom-32: + +ESP32-WROOM-32 模组 +-------------------- + +ESP32-WROOM-32 模组是 WROOM/WROVER 系列最先发布的模组，内置 ESP32-D0WDQ6 芯片，是一款基础且常用的 ESP32 模组。 + +有关该模组的详细信息，请查看 :ref:`esp-wroom-solo-wrover-modules` 章节中的表格。 + +.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-wroom-32-front-back.jpg + :align: center + :alt: ESP32-WROOM-32 module (front and back) + :width: 45% + + ESP32-WROOM-32 模组（正反面图） + +相关文档 +^^^^^^^^^^^^^ + +* 《`ESP32-WROOM-32 技术规格书 `_》(PDF)； +* `ESP32-WROOM-32 参考设计 `_，包括原理图（由 OrCAD Capture 绘制）、PCB 布局（由 Mentor PADS 绘制）、GERBER 文件和 BOM 清单。 + +.. _esp-modules-and-boards-esp32-wroom-32d-and-u: + +ESP32-WROOM-32D/ESP32-WROOM-32U 模组 +-------------------------------------- + +两款模组均集成了 ESP32-D0WD 芯片，与 :ref:`esp-modules-and-boards-esp32-wroom-32` 集成的 ESP32-D0WDQ6 相比，ESP32-D0WD 芯片的封装更小，在 PCB 上占用的面积更小。 + +有关这两款模组的详细信息，请查看 :ref:`esp-wroom-solo-wrover-modules` 中的表格和 `乐鑫产品订购信息`_。 + +ESP32-WROOM-32U 是整个 WROOM/WROVER 模组系列中最小的模组。 + +.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-wroom-32d-front-back.jpg + :align: center + :alt: ESP32-WROOM-32D module (front and back) + :width: 45% + + ESP32-WROOM-32D 模组（正反面图） + +.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-wroom-32u-front-back.jpg + :align: center + :alt: ESP32-WROOM-32U module (front and back) + :width: 45% + + ESP32-WROOM-32U 模组（正反面图） + +相关文档 +^^^^^^^^^^^^^ + +* 《`ESP32-WROOM-32D/ESP32-WROOM-32U 技术规格书 `_》(PDF) + + +.. _esp-modules-and-boards-esp32-solo-1: + +ESP32-SOLO-1 模组 +----------------- + +ESP32-SOLO-1 模组是 ESP32-WROOM-32D 模组的简化版本，内置一个 ESP32 单核芯片，支持高达 160 MHz 的时钟频率。 + +有关此模组的详细信息，请查看 :ref:`esp-wroom-solo-wrover-modules` 章节中的表格和 `乐鑫产品订购信息`_。 + +.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-solo-1-front-back.jpg + :align: center + :alt: ESP32-SOLO-1 module (front and back) + :width: 45% + + ESP32-SOLO-1 模组（正反面图） + +相关文档 +^^^^^^^^^^^^^ + +* 《`ESP32-SOLO-1 技术规格书 `__》(PDF) + +.. _esp-modules-and-boards-esp32-wrover: + +ESP32-WROVER 系列模组 +------------------------- + +ESP32-WROVER 系列模组在 ESP32-WROOM-32x 模组的基础上进行了一些修改，其中包含一些功能升级，并新增 8 MB SPI PSRAM（伪静态 RAM）。 + +有关该模组的详细信息，请查看 :ref:`esp-wroom-solo-wrover-modules` 章节中的表格和 `乐鑫产品订购信息`_。 + +* **ESP32-WROVER (PCB)** 模组和 **ESP32-WROVER (IPEX)** 模组内置 1.8 V PSRAM，支持 144 MHz 时钟频率。 +* **ESP32-WROVER-B** 模组和 **ESP32-WROVER-IB** 模组内置 3.3 V PSRAM，支持 133 MHz 时钟频率。 + +下图为配备有 PCB 天线的 ESP32-WROVER 模组： + +.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-wrover.jpg + :align: center + :alt: ESP32-WROVER module (front and back) + :width: 40% + + ESP32-WROVER 模组（正反面图） + +相关文档 +^^^^^^^^^^^^^ + +* 《`ESP32-WROVER 技术规格书 `__》(PDF) +* 《`ESP32-WROVER-B 技术规格书 `__》(PDF) +* 《`ESP-PSRAM64 & ESP-PSRAM64H 技术规格书 `__》(PDF) +* `ESP32-WROVER 参考设计 `_ 包含原理图（由 OrCAD Capture 绘制）、PCB 布局（由 Mentor PADS 绘制）、GERBER 文件和 BOM 清单。 + +ESP32-PICO-D4 模组 +------------------ + +ESP32-PICO-D4 模组是一款 SiP 模组，无缝集成了所有外设，包括： + +- 4 MB flash +- 晶振 +- 滤波电容 +- RF 匹配电路 + +有关该模组的详细信息，请查看 `乐鑫产品订购信息`_。 + +相关文档 +^^^^^^^^^^^^^ + +* 《`ESP32-PICO-D4 技术规格书 `__》(PDF) + +ESP32 开发板 +================== + +ESP32 系列开发板功能各异，具体有以下不同点： + +- 访问的 ESP32 GPIO 管脚不同； +- 接口不同，包括 USB 和 JTAG； +- 外设不同，包括 TouchPad、LCD 显示屏、SD 卡槽和相机模组排母等。 + +.. _esp-modules-and-boards-esp32-pico-kit: + +ESP32-PICO-KIT V4.1 开发板 +--------------------------- +ESP32-PICO-KIT V4.1 开发板是基于 ESP32 的最小开发板，内置连接至电脑 USB 端口所需的所有组件，同时设有排针，可直接将此开发板插接于迷你面包板。 + +ESP32-PICO-KIT V4.1 开发板集成了 `ESP32-PICO-D4 模组`_，只需在 PCB (20 x 52 mm) 上添加少许外部组件即可构成一个功能齐全的开发板。这部分外部组件包括天线、LDO、USB 至 UART 桥接器、一个重置按钮和一个固件下载模式激活按钮。 + + +.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-pico-kit-v4.1.jpg + :align: center + :alt: ESP32-PICO-KIT V4.1 board + :width: 50% + + ESP32-PICO-KIT V4.1 开发板 + +与 ESP32-PICO-KIT V4 相比，ESP32-PICO-KIT V4.1 开发板支持 CP2102N USB 至 UART 桥接器，可提供高达 3 Mbps 的传输速率。 + +相关文档 +^^^^^^^^^^^^^ + +* :doc:`../../hw-reference/esp32/get-started-pico-kit` +* `ESP32-PICO-KIT V4.1 原理图 `_ (PDF) +* `ESP32-PICO-KIT 参考设计 `_，包含原理图（由 OrCAD Capture 绘制）、PCB 布局（由 Mentor PADS 绘制）、GERBER 文件和 BOM 清单。 +* 《`ESP32-PICO-D4 技术规格书 `_》(PDF) + +较早版本开发板 +^^^^^^^^^^^^^^^^^ + +* :ref:`esp-modules-and-boards-esp32-pico-kit-v4` +* :ref:`esp-modules-and-boards-esp32-pico-kit-v3` + + +.. _esp-modules-and-boards-esp32-devkitc: + +ESP32 DevKitC V4 开发板 +------------------------------ + +ESP32 DevKitC V4 开发板是一款小巧实用的开发板，具备以下特色功能： + +- 集成了 :ref:`esp-modules-and-boards-esp32-wroom-32` +- USB 转串口编程接口同时可为开发板供电 +- 设有排针 +- 设有重置按钮和固件下载模式激活按钮 +- 以及其他组件 + +与较早版本的 :ref:`esp-modules-and-boards-esp32-devkitc-v2` 相比，ESP32 DevKitC V4 开发板集成了 :ref:`esp-modules-and-boards-esp32-wrover` （而非 ESP32-WROOM-32 模组），同时内置 CP2102N 芯片，支持更高波特率。 + +.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-devkitc-v4-front.jpg + :align: center + :alt: ESP32 DevKitC V4 board + :width: 50% + + ESP32 DevKitC V4 开发板 + +相关文档 +^^^^^^^^^^^^^ + +* :doc:`../../hw-reference/esp32/get-started-devkitc` +* `ESP32-DevKitC 原理图 `_ (PDF) +* `ESP32-DevKitC 参考设计 `_，包含原理图（由 OrCAD Capture 绘制）、PCB 布局（由 Mentor PADS 绘制）、GERBER 文件和 BOM 清单。 +* `CP210x USB 至 UART 桥 VCP 驱动器 `_ + +较早版本开发板 +^^^^^^^^^^^^^^^^^ + +* :ref:`esp-modules-and-boards-esp32-devkitc-v2` + + +.. _esp-modules-and-boards-esp-wrover-kit: + +ESP-WROVER-KIT V4.1 开发板 +------------------------------- + +ESP-WROVER-KIT V4.1 开发板具备以下特色功能： + +- USB 转双串口转换器（用于后续编程） +- JTAG 调试接口 +- MicroSD 卡槽 +- 3.2” SPI LCD 显示屏 +- 相机模组排母 +- RGB 发光二极管 +- 支持 32.768 kHz 晶振输入用于 RTC 及低功耗模式操作 + +ESP-WROVER-KIT V4.1 开发板支持 USB 供电或标准的 5 毫米电源插座供电，可使用跳线选择电源，或使用独立的开关控制电源。 + +ESP-WROVER-KIT V4.1 开发板集成了 ESP-WROVER-B 模组，该模组集成了 8 MB PSRAM，方便用户灵活扩展存储空间，增强数据处理能力。ESP-WROVER-KIT V4.1 开发板还可以集成 :ref:`esp-wroom-solo-wrover-modules` 中所述的 ESP 其他版本模组。 + +与 :ref:`esp-modules-and-boards-esp-wrover-kit-v3` 相比，ESP-WROVER-KIT V4.1 开发板在设计上有以下改动： + +- JP8、JP11 和 JP13 合并成了一个 JP2。 +- USB 连接器的固定脚改为直插式，并移至板子右下角。 +- R61 已变更为零欧姆电阻。 +- 基于测试结果和采购选择，部分组件已由功能对等组件替代，例如 EN 和 Boot 按钮。 + +.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp-wrover-kit-v4.1-front.jpg + :align: center + :alt: ESP-WROVER-KIT V4.1 board + :width: 90% + + ESP-WROVER-KIT V4.1 开发板 + +上图所示开发板集成了 ESP32-WROVER-B 模组。 + +相关文档 +^^^^^^^^^^^^^ + +* :doc:`../../hw-reference/esp32/get-started-wrover-kit` +* `ESP-WROVER-KIT V4.1 原理图 `__ (PDF) +* :doc:`../../../api-guides/jtag-debugging/index` +* `FTDI 虚拟 COM 端口驱动`_ + +较早版本开发板 +^^^^^^^^^^^^^^^^^ + +* :ref:`esp-modules-and-boards-esp-wrover-kit-v3` +* :ref:`esp-modules-and-boards-esp-wrover-kit-v2` +* :ref:`esp-modules-and-boards-esp-wrover-kit-v1` + + +相关文档 +================= + +* :doc:`modules-and-boards-previous` + + +.. _FTDI 虚拟 COM 端口驱动: http://www.ftdichip.com/Drivers/VCP.htm +.. _乐鑫产品订购信息: https://www.espressif.com/sites/default/files/documentation/espressif_products_ordering_information_cn.pdf diff --git a/docs/zh_CN/hw-reference/esp32/inc/modules-and-boards-previous-esp32.rst b/docs/zh_CN/hw-reference/esp32/inc/modules-and-boards-previous-esp32.rst new file mode 100644 index 000000000..362c2fa3f --- /dev/null +++ b/docs/zh_CN/hw-reference/esp32/inc/modules-and-boards-previous-esp32.rst @@ -0,0 +1 @@ +.. include:: ../../en/hw-reference/esp32/inc/modules-and-boards-previous-esp32.rst \ No newline at end of file diff --git a/docs/zh_CN/hw-reference/esp32s2/inc/modules-and-boards-esp32s2.rst b/docs/zh_CN/hw-reference/esp32s2/inc/modules-and-boards-esp32s2.rst new file mode 100644 index 000000000..06ea340f4 --- /dev/null +++ b/docs/zh_CN/hw-reference/esp32s2/inc/modules-and-boards-esp32s2.rst @@ -0,0 +1 @@ +.. include:: ../../en/hw-reference/esp32s2/inc/modules-and-boards-esp32s2.rst \ No newline at end of file diff --git a/docs/zh_CN/hw-reference/esp32s2/inc/modules-and-boards-previous-esp32s2.rst b/docs/zh_CN/hw-reference/esp32s2/inc/modules-and-boards-previous-esp32s2.rst new file mode 100644 index 000000000..5a84a53e6 --- /dev/null +++ b/docs/zh_CN/hw-reference/esp32s2/inc/modules-and-boards-previous-esp32s2.rst @@ -0,0 +1 @@ +.. include:: ../../en/hw-reference/esp32s2/inc/modules-and-boards-previous-esp32s2.rst diff --git a/docs/zh_CN/hw-reference/get-started-ethernet-kit.rst b/docs/zh_CN/hw-reference/get-started-ethernet-kit.rst deleted file mode 100644 index ab479d4f9..000000000 --- a/docs/zh_CN/hw-reference/get-started-ethernet-kit.rst +++ /dev/null @@ -1,409 +0,0 @@ -ESP32-Ethernet-Kit V1.1 入门指南 -================================= - -:link_to_translation:`en:[English]` - -本指南将介绍 ESP32-Ethernet-Kit 开发板的配置以及相关功能的使用。 - -:ref:`ESP32-Ethernet-Kit ` 是一款以太网转 Wi-Fi 开发板，可为以太网设备赋予 Wi-Fi 连接功能。为了提供更灵活的电源选项，ESP32-Ethernet-Kit 同时也支持以太网供电 (PoE)。 - - -准备工作 --------- - -* :ref:`ESP32-Ethernet-Kit V1.1 开发板 ` -* USB 数据线（A 转 Micro-B） -* PC（Windows、Linux 或 Mac OS） - -您可以跳过介绍部分，直接前往 `应用程序开发`_ 章节。 - - -概述 ----- - -ESP32-Ethernet-Kit 是一款来自 `乐鑫 `_ 的开发板。 - -它由 :ref:`以太网母板（A板）` 和 `PoE 子板（B 板）`_ 两部分组成。其中 :ref:`以太网母板（A板）` 集成蓝牙 / Wi-Fi 双模 ESP32-WROVER-B 模组和单端口 10/100 Mbps 快速以太网收发器 (PHY) IP101GRI。`PoE 子板（B 板）`_ 提供以太网供电功能。ESP32-Ethernet-Kit 的 A 板可在不连接 B 板的情况下独立工作。 - -.. _get-started-esp32-ethernet-kit-v1.1: - -.. figure:: ../../_static/esp32-ethernet-kit-v1.1.png - :align: center - :alt: ESP32-Ethernet-Kit V1.1 - :figclass: align-center - - ESP32-Ethernet-Kit V1.1 - -为了实现程序下载和监控，A 板还集成了一款先进多协议 USB 桥接器（FTDI FT2232H 芯片）。FTDI FT2232H 芯片使得开发人员无需额外的 JTAG 适配器，通过 USB 桥接器使用 JTAG 接口便可对 ESP32 直接进行调试。 - - -功能概述 ---------- - -ESP32-Ethernet-Kit 开发板的主要组件和连接方式如下。 - -.. figure:: ../../_static/esp32-ethernet-kit-v1.1-block-diagram.png - :align: center - :scale: 60% - :alt: ESP32-Ethernet-Kit 功能框图（点击放大） - :figclass: align-center - - ESP32-Ethernet-Kit 功能框图（点击放大） - - -功能说明 --------- - -有关 ESP32-Ethernet-Kit 开发板的主要组件、接口及控制方式，请见下方的图片和表格。 - -.. _get-started-esp32-ethernet-kit-a-v1.1-layout: - - -以太网母板（A 板） -^^^^^^^^^^^^^^^^^^^^^ - -.. figure:: ../../_static/esp32-ethernet-kit-a-v1.1-layout.png - :align: center - :scale: 80% - :alt: ESP32-Ethernet-Kit - Ethernet board (A) layout - :figclass: align-center - - ESP32-Ethernet-Kit - 以太网母板（A 板）布局（点击放大）（请更新图片） - -下表将从图片右上角开始，以顺时针顺序介绍图中的主要组件。 - -.. list-table:: 表格1 组件介绍 - :widths: 40 150 - :header-rows: 1 - - * - 主要组件 - - 基本介绍 - * - ESP32-WROVER-B 模组 - - 这款 ESP32 模组内置 64-Mbit PSRAM，可提供灵活的额外存储空间和数据处理能力。 - * - GPIO Header 2 - - 由 5 个未引出通孔组成，可连接至 ESP32 的部分 GPIO。具体介绍，请见 `GPIO Header 2`_。 - * - 功能选择开关 - - 一个 4 位拨码开关，可配置 ESP32 部分 GPIO 的功能。请注意，拨码开关旁边开发板的丝印层上的 GPIO 管脚标记的位置是不正确的。有关详细信息和正确的管脚分配，请见 `功能选择开关`_。 - * - Tx/Rx LEDs - - 2 个 LED，可显示 UART 传输的状态。 - * - FT2232H - - FT2232H 多协议 USB 转串口桥接器。开发人员可通过 USB 接口对 FT2232H 芯片进行控制和编程，与 ESP32 建立连接。FT2232H 芯片可在通道 A 提供 USB-to-JTAG 接口功能，并在通道 B 提供 USB-to-Serial 接口功能，便利开发人员的应用开发与调试。见 `ESP32-Ethernet-Kit V1.1 以太网母板（A 板）原理图`_。 - * - USB 端口 - - USB 接口。可用作开发板的供电电源，或连接 PC 和开发板的通信接口。 - * - 电源开关 - - 电源开关。拨向 **5V0** 按键侧，开发板上电；拨向 **GND** 按键一侧，开发板掉电。 - * - 5V Input - - 5V 电源接口建议仅在开发板自动运行（未连接 PC）时使用。 - * - 5V Power On LED - - 当开发板通电后（USB 或外部 5V 供电），该红色指示灯将亮起。 - * - DC/DC 转换器 - - 直流 5 V 转 3.3 V，输出电流最高可达 2 A。 - * - Board B 连接器 - - 1 对 排针和排母，用于连接 `PoE 子板（B 板）`_。 - * - IP101GRI (PHY) - - 物理层 (PHY) 单端口 10/100 快速以太网收发器 `IP101GRI `_ 芯片，允许开发人员实现与以太网线缆的物理层连接。PHY 与 ESP32 通过简化媒体独立接口 (RMII) 实现连接。RMII 是 `媒体独立接口 (MII) `_ 的标准简化版本。PHY 可在 10/100 Mbps 速率下支持 IEEE 802.3 / 802.3u 标准。 - * - RJ45 端口 - - 以太网数据传输端口。 - * - 网络变压器 - - 网络变压器属于以太网物理层的一部分，可保护电路，使其免受故障和电压瞬变影响，包括防止收发器芯片和线缆之间产生共模信号。同时它也可以在收发器与以太网设备之间提供电流隔绝。 - * - Link/Activity LED - - 2 个 LED（绿色和红色），可分别显示 PHY 处于 “Link” 状态或 “Activity” 状态。 - * - BOOT Button - - 下载按键。按下 **BOOT** 键并保持，同时按一下 **EN** 键（此时不要松开 **BOOT** 键）进入“固件下载”模式，通过串口下载固件。 - * - EN 按键 - - 复位按键。 - * - GPIO Header 1 - - 由 6 个未引出通孔组成，可连接至 ESP32 的备用 GPIO。具体介绍，请见 `GPIO Header 1`_。 - - -PoE 子板（B 板） -^^^^^^^^^^^^^^^^^^^ - -PoE 子板转换以太网电缆传输的电能 (PoE)，为以太网母板（A 板）提供电源。PoE 子板（B 板）的主要组件见 `功能概述`_ 中的功能框图。 - -PoE 子板（B 板）具有以下特性： - -* 支持 IEEE 802.3at 标准 -* 电源输出：5 V，1.4 A - -如需使用 PoE 功能，请用以太网线缆将以太网母板（A 板）上的 **RJ45 Port** 连接至 PoE 的交换机。以太网母板（A 板）检测到来自 PoE 子板（B 板）的 5 V 供电后，将从 USB 供电自动切换至 PoE 供电。 - -.. figure:: ../../_static/esp32-ethernet-kit-b-v1.0-layout.png - :align: center - :scale: 80% - :alt: ESP32-Ethernet-Kit - PoE board (B) - :figclass: align-center - - ESP32-Ethernet-Kit - PoE 子板（B 板）布局（点击放大） - -.. list-table:: 表格2 PoE 子板（B 板） - :widths: 40 150 - :header-rows: 1 - - * - 主要组件 - - 基本介绍 - * - A 板连接器 - - 4 个排针（左侧）和排母（右侧），用于将 PoE 子板（B 板）连接至 :ref:`Ethernet board (A) `。左侧的管脚接受来自 PoE 交换机的电源。右侧的管脚为 以太网母板（A 板）提供 5 V 电源。 - * - 外部电源终端 - - PoE 子板（B 板）可选电源 (26.6 ~ 54 V)。 - -.. _get-started-esp32-ethernet-kit-v1.1-setup-options: - - -设置选项 --------- - -本节介绍用于 ESP32-Ethernet-Kit 开发板的硬件配置选项。 - - -功能选择开关 -^^^^^^^^^^^^^^ - -拨码开关打开时，拨码开关将列出的 GPIO 路由到 FT2232H 以提供JTAG功能。拨码开关关闭时，GPIO 可以用于其他目的。 - -========= ========== -拨码开关 GPIO 管脚 -========= ========== - 1 GPIO13 - 2 GPIO12 - 3 GPIO15 - 4 GPIO14 -========= ========== - -.. note:: - - 拨码开关旁边开发板的丝印层上的 GPIO 管脚标记的位置是不正确的。请以表格中的顺序为准。 - - -RMII 时钟源选择 -^^^^^^^^^^^^^^^^ - -RMII 工作模式下的以太网 MAC 和 PHY 需要一个公共的 50MHz 同步时钟（即 RMII 时钟），它既可以由外部提供，也可以由内部的 ESP32 APLL 产生。 - -.. note:: - - 有关 RMII 时钟源选择的更多信息，请参见 `ESP32-Ethernet-Kit V1.1 以太网母板（A 板）原理图`_，第 2 页的位置 D2。 - - -PHY 侧提供 RMII 时钟 -""""""""""""""""""""""""""""" - -ESP32-Ethernet-Kit 默认配置为 IP101GRI 的 50M_CLKO 信号线提供 RMII 时钟，该时钟信号由 PHY 外侧连接的 25MHz 无源晶振经过倍频产生。详情请参见下图。 - -.. figure:: ../../_static/esp32-ethernet-kit-rmii-clk-from-phy.png - :align: center - :scale: 80% - :alt: RMII Clock from IP101GRI PHY - :figclass: align-center - - PHY 侧提供 RMII 时钟 - -请注意，系统上电时 RESET_N 旁的下拉电阻会将 PHY 置于复位状态，ESP32 需要通过 GPIO5 将 RESET_N 拉高才能启动 PHY，只有这样才能保证系统的正常上电，否则 ESP32 会存在一定几率进入下载模式（当 REF_CLK_50M 时钟信号在 GPIO0 上电采样阶段刚好处于高电平）。 - - -ESP32 APLL 内部提供的 RMII 时钟 -"""""""""""""""""""""""""""""""""""" - -另一种选择是从 ESP32 APLL 内部获取 RMII 时钟，请参见下图。来自 GPIO0 的时钟信号首先被反相，以解决传输线延迟的问题，然后提供给 PHY。 - -.. figure:: ../../_static/esp32-ethernet-kit-rmii-clk-to-phy.png - :align: center - :scale: 80% - :alt: RMII Clock from ESP Internal APLL - :figclass: align-center - - ESP32 APLL 内部提供的 RMII 时钟 - -要实现此选项，用户需要在板子上移除或添加一些阻容元器件。有关详细信息，请参见 `ESP32-Ethernet-Kit V1.1 以太网母板（A 板）原理图`_，第 2 页，位置 D2。请注意，如果 APLL 已经用于其他用途（如 I2S 外设），那么只能使用外部 RMII 时钟。 - - -GPIO 分配 ---------- - -本节介绍了 ESP32-Ethernet-Kit 开发板特定接口或功能的 GPIO 分配情况。 - - -IP101GRI (PHY) 接口 -^^^^^^^^^^^^^^^^^^^^^^^^^ - -下表显示了 ESP32 (MAC) 与 IP101GRI (PHY) 的管脚对应关系。ESP32-Ethernet-Kit 的实现默认设置为简化媒体独立接口。 - -==== ================ =============== -. ESP32 管脚 (MAC) IP101GRI (PHY) -==== ================ =============== -*RMII 接口* ---------------------------------------- - 1 GPIO21 TX_EN - 2 GPIO19 TXD[0] - 3 GPIO22 TXD[1] - 4 GPIO25 RXD[0] - 5 GPIO26 RXD[1] - 6 GPIO27 CRS_DV - 7 GPIO0 REF_CLK ----- ---------------- --------------- -*串行管理接口* ---------------------------------------- - 8 GPIO23 MDC - 9 GPIO18 MDIO ----- ---------------- --------------- -*PHY 复位* ---------------------------------------- -10 GPIO5 Reset_N -==== ================ =============== - -.. Note:: - - 除了 REF_CLK 之外，ESP32 的 *RMII 接口* 下的所有管脚分配都是固定的，不能通过 IOMUX 或 GPIO 矩阵进行更改。 - - -GPIO Header 1 -^^^^^^^^^^^^^ - -本连接器包括 ESP32-Ethernet-Kit 开发板上部分不用做他用的 GPIO。 - -==== ================ -. ESP32 管脚 -==== ================ - 1 GPIO32 - 2 GPIO33 - 3 GPIO34 - 4 GPIO35 - 5 GPIO36 - 6 GPIO39 -==== ================ - - -GPIO Header 2 -^^^^^^^^^^^^^ - -根据“说明"描述的不同情形，本连接器包含可用做他用的 GPIO。 - -==== ========== ==================== -. ESP32 管脚 说明 -==== ========== ==================== - 1 GPIO17 见下方说明 1 - 2 GPIO16 见下方说明 1 - 3 GPIO4 - 4 GPIO2 - 5 GPIO13 见下方说明 2 - 6 GPIO12 见下方说明 2 - 7 GPIO15 见下方说明 2 - 8 GPIO14 见下方说明 2 - 9 GND Ground -10 3V3 3.3 V 电源 -==== ========== ==================== - -.. note:: - - 1. ESP32 芯片的 GPIO16 和 GPIO17 管脚没有引出至 ESP32-WROVER-B 模组的管脚，因此无法使用。如需使用 ESP32 的 GP1016 和 GPIO17 管脚，建议更换其他不含 PSRAM 的模组，比如 ESP32-WROOM-32D 或 ESP32-SOLO-1。 - - - 2. 具体功能取决与 `功能选择开关`_ 的设置。 - - -GPIO 管脚分配总结 -^^^^^^^^^^^^^^^^^^^ - -.. csv-table:: - :header: ESP32-WROVER-B,IP101GRI,UART,JTAG,GPIO,Comments - - S_VP,,,,IO36, - S_VN,,,,IO39, - IO34,,,,IO34, - IO35,,,,IO35, - IO32,,,,IO32, - IO33,,,,IO33, - IO25,RXD[0],,,, - IO26,RXD[1],,,, - IO27,CRS_DV,,,, - IO14,,,TMS,IO14, - IO12,,,TDI,IO12, - IO13,,RTS,TCK,IO13, - IO15,,CTS,TDO,IO15, - IO2,,,,IO2, - IO0,REF_CLK,,,,See note 1 - IO4,,,,IO4, - IO16,,,,IO16 (NC),See note 2 - IO17,,,,IO17 (NC),See note 2 - IO5,Reset_N,,,,See note 1 - IO18,MDIO,,,, - IO19,TXD[0],,,, - IO21,TX_EN,,,, - RXD0,,RXD,,, - TXD0,,TXD,,, - IO22,TXD[1],,,, - IO23,MDC,,,, - -.. note:: - - 1. 为防止 ESP32 侧 GPIO0 的上电状态受 PHY 侧时钟输出的影响，PHY 侧 RESET_N 默认为低，以关闭 PHY 侧时钟输出。上电后，您可通过 GPIO5 控制 RESET_N 以打开该时钟输出。参见 `PHY 侧提供 RMII 时钟`_。对于无法通过 RESET_N 关闭时钟输出的 PHY，PHY 侧建议使用可在外部禁用/使能的有源晶振。与使用 RESET_N 类似，默认情况下晶振模块应禁用，并在上电后由 ESP32 开启。有关参考设计，请参见 `ESP32-Ethernet-Kit V1.1 以太网母板（A 板）原理图`_。 - - - 2. ESP32 芯片的 GPIO16 和 GPIO17 管脚没有引出至 ESP32-WROVER-B 模组的管脚，因此无法使用。如需使用 ESP32 的 GP1016 和 GPIO17 管脚，建议更换其他不含 PSRAM 的模组，比如 ESP32-WROOM-32D 或 ESP32-SOLO-1。 - - -应用程序开发 -------------- - -ESP32-Ethernet-Kit 上电前，请首先确认开发板完好无损。 - - -初始设置 -^^^^^^^^^^ - -1. 首先，请将 :ref:`以太网母板（A 板）` 上的所有开关均拨至 **ON** 状态，使 **功能选择开关** 处于默认状态。 -2. 为了方便应用程序的下载和测试，不要为开发板输入任何信号。 -3. 此时可以连接 `PoE 子板（B 板）`_ ，但不要向 B 板连接任何外部电源。 -4. 使用 USB 数据线将 :ref:`以太网母板（A 板）` 连接至 PC。 -5. 将 **电源开关** 从 GND 拨至 5V0 一侧。此时，**5V Power On LED** 应点亮。 - - -正式开始开发 -^^^^^^^^^^^^^ - -现在，请前往 :doc:`../get-started/index` 中的 :ref:`get-started-step-by-step` 章节，查看如何设置开发环境，并尝试将示例项目烧录至您的开发板。 - -请务必在进入下一步前，确保您已完成上述所有步骤。 - - -配置与加载以太网示例 -^^^^^^^^^^^^^^^^^^^^^^^ - -在完成开发环境设置和开发板测试后，您可以配置并烧录 :example:`ethernet/ethernet` 示例。本示例专门用于测试以太网功能，支持不同 PHY，包括 :ref:`get-started-esp32-ethernet-kit-v1.1` 开发板使用的 **IP101GRI** 。 - - -针对 ESP32-Ethernet-Kit V1.0 的主要修改： ------------------------------------------ - -* 原 GPIO0 反相后时钟提供给 PHY 方案改为由 PHY 侧外接无源晶振，提供时钟给 GPIO0。原用于控制有源晶振的 OSC_EN 的 IO2 释放，可用作其他用途。 -* 为防止 ESP32 侧 GPIO0 的上电状态受到 PHY 侧时钟输出的影响，PHY 侧 RESET_N 默认为低，关闭 PHY 侧时钟输出。而后可通过 GPIO5 控制 RESET_N 打开该时钟输出。 -* 移除 FT2232H 芯片的外部 SPI Flash U6。 -* 移除流控的测试排针 J4。 -* 移除 nTRST JTAG信号，相应的 GPIO4 可用作其他用途。 -* GPIO15 线上的上拉电阻 R68 移至 JTAG 的 MTDO 侧。 -* 为了加强 A 板和 B 板连接间的防呆设计（减少反向插入 B 板的机会），将原先 A 板上的 2 排 4 针排针改为 1 排 4 针排母和 1 排 4 针排针。相应的 4 针排针排和排母排则安装在 B 板上。 - -ESP32-Ethernet-Kit 的其他版本 -------------------------------- - -* :doc:`get-started-ethernet-kit-v1.0` - - -相关文档 ----------- - -* `ESP32-Ethernet-Kit V1.1 以太网母板（A 板）原理图`_ (PDF) -* `ESP32-Ethernet-Kit V1.0 PoE 子板（B 板）原理图`_ (PDF) -* `ESP32 技术规格书 `_ (PDF) -* `ESP32-WROVER-B 技术规格书 `_ (PDF) -* :doc:`../api-guides/jtag-debugging/index` -* :doc:`../hw-reference/index` - -.. _ESP32-Ethernet-Kit V1.1 以太网母板（A 板）原理图: https://dl.espressif.com/dl/schematics/SCH_ESP32-ETHERNET-KIT_A_V1.1_20190711.pdf -.. _ESP32-Ethernet-Kit V1.0 PoE 子板（B 板）原理图: https://dl.espressif.com/dl/schematics/SCH_ESP32-ETHERNET-KIT_B_V1.0_20190517.pdf -.. _ESP32-Ethernet-Kit V1.0 以太网母板（A 板）原理图: https://dl.espressif.com/dl/schematics/SCH_ESP32-ETHERNET-KIT_A_V1.0_20190517.pdf - -.. toctree:: - :hidden: - - get-started-ethernet-kit-v1.0.rst \ No newline at end of file diff --git a/docs/zh_CN/hw-reference/index.rst b/docs/zh_CN/hw-reference/index.rst index 5aab701a2..4f22477b9 100644 --- a/docs/zh_CN/hw-reference/index.rst +++ b/docs/zh_CN/hw-reference/index.rst @@ -9,7 +9,7 @@ ESP32 H/W 硬件参考 :esp32: ESP32 技术参考手册 (PDF) :esp32s2beta: ESP32-S2 技术参考手册 (PDF) :esp32: ESP32 技术规格书 (PDF) - :esp32s2beta: ESP32-S2 技术规格书 (PDF) + :esp32s2: ESP32-S2 技术规格书 (PDF) :esp32: ESP32 硬件设计指南 (PDF) :esp32: ESP32 勘误表及解决方法 (PDF) 模组与开发板 diff --git a/docs/zh_CN/hw-reference/modules-and-boards-previous.rst b/docs/zh_CN/hw-reference/modules-and-boards-previous.rst index 30e33d94c..844cdaa9c 100644 --- a/docs/zh_CN/hw-reference/modules-and-boards-previous.rst +++ b/docs/zh_CN/hw-reference/modules-and-boards-previous.rst @@ -1 +1,24 @@ -.. include:: ../../en/hw-reference/modules-and-boards-previous.rst \ No newline at end of file +.. _esp-modules-and-boards-previous: + +************************************** +{IDF_TARGET_NAME} 模组与开发板（历史版本） +************************************** + +This sections contains overview and links to documentation of previous version {IDF_TARGET_NAME} Modules and Boards that have been replaced with newer versions or discontinued. It is maintained for convenience of users as previous versions of some modules and boards are still in use and some may still be available for purchase. + + +.. only:: esp32 + + .. include:: esp32/inc/modules-and-boards-previous-esp32.rst + +.. only:: esp32s2 + + .. include:: esp32s2/inc/modules-and-boards-previous-esp32s2.rst + +相关文档 +================= + +* :doc:`modules-and-boards` + + +.. _FTDI Virtual COM Port Drivers: http://www.ftdichip.com/Drivers/VCP.htm \ No newline at end of file diff --git a/docs/zh_CN/hw-reference/modules-and-boards.rst b/docs/zh_CN/hw-reference/modules-and-boards.rst index b1843052e..0e3972777 100644 --- a/docs/zh_CN/hw-reference/modules-and-boards.rst +++ b/docs/zh_CN/hw-reference/modules-and-boards.rst @@ -1,12 +1,12 @@ .. _esp-modules-and-boards: -***************************** -ESP32 系列模组和开发板 -***************************** +******************************** +{IDF_TARGET_NAME} 系列模组和开发板 +******************************** :link_to_translation:`en:[English]` -乐鑫设计并提供多种模组和开发板以供用户体验 ESP32 系列芯片的强大功能。 +乐鑫设计并提供多种模组和开发板以供用户体验 {IDF_TARGET_NAME} 系列芯片的强大功能。 本文档主要介绍了当前乐鑫所提供的各种模组和开发板。 @@ -14,297 +14,16 @@ ESP32 系列模组和开发板 如需了解较早版本或已停产的模组和开发板，请参考 :ref:`esp-modules-and-boards-previous`。 -.. _esp-wroom-solo-wrover-modules: +.. only:: esp32 -WROOM、SOLO、WROVER 和 PICO 系列模组 -===================================== + .. include:: esp32/inc/modules-and-boards-esp32.rst -WROOM、SOLO、WROVER 和 PICO 系列模组内置 ESP32 芯片并集成了晶振、天线匹配电路等重要组件，可直接集成到终端产品中。如果再结合一些其他组件，例如编程接口、Bootstrapping 电阻和排针，您就可以体验 ESP32 的强大功能了。 +.. only:: esp32s2 -下表总结了上述系列模组的主要特点，详细信息见后续章节。 - -+---------------------+--------------+-------------+-------------+------+-----------------+ -| 模组 | 芯片 | Flash (MB) | PSRAM (MB) | 天线 | 尺寸 (mm) | -+---------------------+--------------+-------------+-------------+------+-----------------+ -| ESP32-WROOM-32 | ESP32-D0WDQ6 | 4 | – | MIFA | 18 × 25.5 × 3.1 | -+---------------------+--------------+-------------+-------------+------+-----------------+ -| ESP32-WROOM-32D | ESP32-D0WD | 4、8 或 16 | – | MIFA | 18 × 25.5 × 3.1 | -+---------------------+--------------+-------------+-------------+------+-----------------+ -| ESP32-WROOM-32U | ESP32-D0WD | 4、8 或 16 | – | U.FL | 18 × 19.2 × 3.1 | -+---------------------+--------------+-------------+-------------+------+-----------------+ -| ESP32-SOLO-1 | ESP32-S0WD | 4 | – | MIFA | 18 × 25.5 × 3.1 | -+---------------------+--------------+-------------+-------------+------+-----------------+ -| ESP32-WROVER (PCB) | ESP32-D0WDQ6 | 4 | 8 | MIFA | 18 × 31.4 × 3.3 | -+---------------------+--------------+-------------+-------------+------+-----------------+ -| ESP32-WROVER (IPEX) | ESP32-D0WDQ6 | 4 | 8 | U.FL | 18 × 31.4 × 3.3 | -+---------------------+--------------+-------------+-------------+------+-----------------+ -| ESP32-WROVER-B | ESP32-D0WD | 4、8 或 16 | 8 | MIFA | 18 × 31.4 × 3.3 | -+---------------------+--------------+-------------+-------------+------+-----------------+ -| ESP32-WROVER-IB | ESP32-D0WD | 4、8 或 16 | 8 | U.FL | 18 × 31.4 × 3.3 | -+---------------------+--------------+-------------+-------------+------+-----------------+ - - -* ESP32-**D**.. 代表双核芯片，ESP32-**S**.. 代表单核芯片； -* MIFA - 蛇形倒 F 天线； -* U.FL - U.FL/IPEX 天线连接器； -* ESP32-WROOM-32x、ESP32-WROVER-B 和 ESP32-WROVER-IB 模组默认内置 4 MB flash，客户可定制 8 MB 和 16 MB flash，详情见 `乐鑫产品订购信息`_ (PDF) 和《`ESP32 技术规格书 `_》(PDF)； -* 最初发布的 ESP32-WROVER 模组内置 4 MB PSRAM； -* *ESP-WROOM-32* 是 *ESP32-WROOM-32* 的曾用名。 - -.. _esp-modules-and-boards-esp32-wroom-32: - -ESP32-WROOM-32 模组 --------------------- - -ESP32-WROOM-32 模组是 WROOM/WROVER 系列最先发布的模组，内置 ESP32-D0WDQ6 芯片，是一款基础且常用的 ESP32 模组。 - -有关该模组的详细信息，请查看 :ref:`esp-wroom-solo-wrover-modules` 章节中的表格。 - -.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-wroom-32-front-back.jpg - :align: center - :alt: ESP32-WROOM-32 module (front and back) - :width: 45% - - ESP32-WROOM-32 模组（正反面图） - -相关文档 -^^^^^^^^^^^^^ - -* 《`ESP32-WROOM-32 技术规格书 `_》(PDF)； -* `ESP32-WROOM-32 参考设计 `_，包括原理图（由 OrCAD Capture 绘制）、PCB 布局（由 Mentor PADS 绘制）、GERBER 文件和 BOM 清单。 - -.. _esp-modules-and-boards-esp32-wroom-32d-and-u: - -ESP32-WROOM-32D/ESP32-WROOM-32U 模组 --------------------------------------- - -两款模组均集成了 ESP32-D0WD 芯片，与 :ref:`esp-modules-and-boards-esp32-wroom-32` 集成的 ESP32-D0WDQ6 相比，ESP32-D0WD 芯片的封装更小，在 PCB 上占用的面积更小。 - -有关这两款模组的详细信息，请查看 :ref:`esp-wroom-solo-wrover-modules` 中的表格和 `乐鑫产品订购信息`_。 - -ESP32-WROOM-32U 是整个 WROOM/WROVER 模组系列中最小的模组。 - -.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-wroom-32d-front-back.jpg - :align: center - :alt: ESP32-WROOM-32D module (front and back) - :width: 45% - - ESP32-WROOM-32D 模组（正反面图） - -.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-wroom-32u-front-back.jpg - :align: center - :alt: ESP32-WROOM-32U module (front and back) - :width: 45% - - ESP32-WROOM-32U 模组（正反面图） - -相关文档 -^^^^^^^^^^^^^ - -* 《`ESP32-WROOM-32D/ESP32-WROOM-32U 技术规格书 `_》(PDF) - - -.. _esp-modules-and-boards-esp32-solo-1: - -ESP32-SOLO-1 模组 ------------------ - -ESP32-SOLO-1 模组是 ESP32-WROOM-32D 模组的简化版本，内置一个 ESP32 单核芯片，支持高达 160 MHz 的时钟频率。 - -有关此模组的详细信息，请查看 :ref:`esp-wroom-solo-wrover-modules` 章节中的表格和 `乐鑫产品订购信息`_。 - -.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-solo-1-front-back.jpg - :align: center - :alt: ESP32-SOLO-1 module (front and back) - :width: 45% - - ESP32-SOLO-1 模组（正反面图） - -相关文档 -^^^^^^^^^^^^^ - -* 《`ESP32-SOLO-1 技术规格书 `__》(PDF) - -.. _esp-modules-and-boards-esp32-wrover: - -ESP32-WROVER 系列模组 -------------------------- - -ESP32-WROVER 系列模组在 ESP32-WROOM-32x 模组的基础上进行了一些修改，其中包含一些功能升级，并新增 8 MB SPI PSRAM（伪静态 RAM）。 - -有关该模组的详细信息，请查看 :ref:`esp-wroom-solo-wrover-modules` 章节中的表格和 `乐鑫产品订购信息`_。 - -* **ESP32-WROVER (PCB)** 模组和 **ESP32-WROVER (IPEX)** 模组内置 1.8 V PSRAM，支持 144 MHz 时钟频率。 -* **ESP32-WROVER-B** 模组和 **ESP32-WROVER-IB** 模组内置 3.3 V PSRAM，支持 133 MHz 时钟频率。 - -下图为配备有 PCB 天线的 ESP32-WROVER 模组： - -.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-wrover.jpg - :align: center - :alt: ESP32-WROVER module (front and back) - :width: 40% - - ESP32-WROVER 模组（正反面图） - -相关文档 -^^^^^^^^^^^^^ - -* 《`ESP32-WROVER 技术规格书 `__》(PDF) -* 《`ESP32-WROVER-B 技术规格书 `__》(PDF) -* 《`ESP-PSRAM64 & ESP-PSRAM64H 技术规格书 `__》(PDF) -* `ESP32-WROVER 参考设计 `_ 包含原理图（由 OrCAD Capture 绘制）、PCB 布局（由 Mentor PADS 绘制）、GERBER 文件和 BOM 清单。 - -ESP32-PICO-D4 模组 ------------------- - -ESP32-PICO-D4 模组是一款 SiP 模组，无缝集成了所有外设，包括： - -- 4 MB flash -- 晶振 -- 滤波电容 -- RF 匹配电路 - -有关该模组的详细信息，请查看 `乐鑫产品订购信息`_。 - -相关文档 -^^^^^^^^^^^^^ - -* 《`ESP32-PICO-D4 技术规格书 `__》(PDF) - -ESP32 开发板 -================== - -ESP32 系列开发板功能各异，具体有以下不同点： - -- 访问的 ESP32 GPIO 管脚不同； -- 接口不同，包括 USB 和 JTAG； -- 外设不同，包括 TouchPad、LCD 显示屏、SD 卡槽和相机模组排母等。 - -.. _esp-modules-and-boards-esp32-pico-kit: - -ESP32-PICO-KIT V4.1 开发板 ---------------------------- -ESP32-PICO-KIT V4.1 开发板是基于 ESP32 的最小开发板，内置连接至电脑 USB 端口所需的所有组件，同时设有排针，可直接将此开发板插接于迷你面包板。 - -ESP32-PICO-KIT V4.1 开发板集成了 `ESP32-PICO-D4 模组`_，只需在 PCB (20 x 52 mm) 上添加少许外部组件即可构成一个功能齐全的开发板。这部分外部组件包括天线、LDO、USB 至 UART 桥接器、一个重置按钮和一个固件下载模式激活按钮。 - - -.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-pico-kit-v4.1.jpg - :align: center - :alt: ESP32-PICO-KIT V4.1 board - :width: 50% - - ESP32-PICO-KIT V4.1 开发板 - -与 ESP32-PICO-KIT V4 相比，ESP32-PICO-KIT V4.1 开发板支持 CP2102N USB 至 UART 桥接器，可提供高达 3 Mbps 的传输速率。 - -相关文档 -^^^^^^^^^^^^^ - -* :doc:`../hw-reference/get-started-pico-kit` -* `ESP32-PICO-KIT V4.1 原理图 `_ (PDF) -* `ESP32-PICO-KIT 参考设计 `_，包含原理图（由 OrCAD Capture 绘制）、PCB 布局（由 Mentor PADS 绘制）、GERBER 文件和 BOM 清单。 -* 《`ESP32-PICO-D4 技术规格书 `_》(PDF) - -较早版本开发板 -^^^^^^^^^^^^^^^^^ - -* :ref:`esp-modules-and-boards-esp32-pico-kit-v4` -* :ref:`esp-modules-and-boards-esp32-pico-kit-v3` - - -.. _esp-modules-and-boards-esp32-devkitc: - -ESP32 DevKitC V4 开发板 ------------------------------- - -ESP32 DevKitC V4 开发板是一款小巧实用的开发板，具备以下特色功能： - -- 集成了 :ref:`esp-modules-and-boards-esp32-wroom-32` -- USB 转串口编程接口同时可为开发板供电 -- 设有排针 -- 设有重置按钮和固件下载模式激活按钮 -- 以及其他组件 - -与较早版本的 :ref:`esp-modules-and-boards-esp32-devkitc-v2` 相比，ESP32 DevKitC V4 开发板集成了 :ref:`esp-modules-and-boards-esp32-wrover` （而非 ESP32-WROOM-32 模组），同时内置 CP2102N 芯片，支持更高波特率。 - -.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-devkitc-v4-front.jpg - :align: center - :alt: ESP32 DevKitC V4 board - :width: 50% - - ESP32 DevKitC V4 开发板 - -相关文档 -^^^^^^^^^^^^^ - -* :doc:`../hw-reference/get-started-devkitc` -* `ESP32-DevKitC 原理图 `_ (PDF) -* `ESP32-DevKitC 参考设计 `_，包含原理图（由 OrCAD Capture 绘制）、PCB 布局（由 Mentor PADS 绘制）、GERBER 文件和 BOM 清单。 -* `CP210x USB 至 UART 桥 VCP 驱动器 `_ - -较早版本开发板 -^^^^^^^^^^^^^^^^^ - -* :ref:`esp-modules-and-boards-esp32-devkitc-v2` - - -.. _esp-modules-and-boards-esp-wrover-kit: - -ESP-WROVER-KIT V4.1 开发板 -------------------------------- - -ESP-WROVER-KIT V4.1 开发板具备以下特色功能： - -- USB 转双串口转换器（用于后续编程） -- JTAG 调试接口 -- MicroSD 卡槽 -- 3.2” SPI LCD 显示屏 -- 相机模组排母 -- RGB 发光二极管 -- 支持 32.768 kHz 晶振输入用于 RTC 及低功耗模式操作 - -ESP-WROVER-KIT V4.1 开发板支持 USB 供电或标准的 5 毫米电源插座供电，可使用跳线选择电源，或使用独立的开关控制电源。 - -ESP-WROVER-KIT V4.1 开发板集成了 ESP-WROVER-B 模组，该模组集成了 8 MB PSRAM，方便用户灵活扩展存储空间，增强数据处理能力。ESP-WROVER-KIT V4.1 开发板还可以集成 :ref:`esp-wroom-solo-wrover-modules` 中所述的 ESP 其他版本模组。 - -与 :ref:`esp-modules-and-boards-esp-wrover-kit-v3` 相比，ESP-WROVER-KIT V4.1 开发板在设计上有以下改动： - -- JP8、JP11 和 JP13 合并成了一个 JP2。 -- USB 连接器的固定脚改为直插式，并移至板子右下角。 -- R61 已变更为零欧姆电阻。 -- 基于测试结果和采购选择，部分组件已由功能对等组件替代，例如 EN 和 Boot 按钮。 - -.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp-wrover-kit-v4.1-front.jpg - :align: center - :alt: ESP-WROVER-KIT V4.1 board - :width: 90% - - ESP-WROVER-KIT V4.1 开发板 - -上图所示开发板集成了 ESP32-WROVER-B 模组。 - -相关文档 -^^^^^^^^^^^^^ - -* :doc:`../hw-reference/get-started-wrover-kit` -* `ESP-WROVER-KIT V4.1 原理图 `__ (PDF) -* :doc:`../api-guides/jtag-debugging/index` -* `FTDI 虚拟 COM 端口驱动`_ - -较早版本开发板 -^^^^^^^^^^^^^^^^^ - -* :ref:`esp-modules-and-boards-esp-wrover-kit-v3` -* :ref:`esp-modules-and-boards-esp-wrover-kit-v2` -* :ref:`esp-modules-and-boards-esp-wrover-kit-v1` + .. include:: esp32s2/inc/modules-and-boards-esp32s2.rst 相关文档 ================= * :doc:`modules-and-boards-previous` - - -.. _FTDI 虚拟 COM 端口驱动: http://www.ftdichip.com/Drivers/VCP.htm -.. _乐鑫产品订购信息: https://www.espressif.com/sites/default/files/documentation/espressif_products_ordering_information_cn.pdf