From d56ea52ea1b336170d5f14a0ac6487d40f7345da Mon Sep 17 00:00:00 2001 From: Marius Vikhammer Date: Tue, 10 Dec 2019 11:58:00 +0800 Subject: [PATCH] doc: EN doc update and fixed warnings --- docs/conf_common.py | 3 +- docs/en/api-guides/external-ram.rst | 24 +- docs/en/api-guides/freertos-smp.rst | 4 +- docs/en/api-guides/jtag-debugging/index.rst | 2 +- .../jtag-debugging/tips-and-quirks.rst | 15 +- docs/en/api-reference/peripherals/adc.rst | 2 +- docs/en/api-reference/peripherals/rmt.rst | 2 +- docs/en/api-reference/system/mem_alloc.rst | 2 +- docs/en/contribute/add-ons-reference.rst | 2 +- docs/en/get-started/index.rst | 2 +- docs/en/hw-reference/index.rst | 34 +- .../modules-and-boards-previous.rst | 228 +++++------ docs/en/hw-reference/modules-and-boards.rst | 376 +++++++++--------- 13 files changed, 345 insertions(+), 351 deletions(-) diff --git a/docs/conf_common.py b/docs/conf_common.py index 0425b077b9..7fd6b83a64 100644 --- a/docs/conf_common.py +++ b/docs/conf_common.py @@ -133,8 +133,8 @@ def update_exclude_patterns(tags): 'api-guides/ulp-legacy.rst', 'api-guides/unit-tests-legacy.rst', 'api-guides/jtag-debugging/configure-wrover.rst', - 'api-reference/bluetooth/**', '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', @@ -149,7 +149,6 @@ def update_exclude_patterns(tags): 'gnu-make-legacy.rst']: exclude_patterns.append(e) - # The reST default role (used for this markup: `text`) to use for all # documents. # default_role = None diff --git a/docs/en/api-guides/external-ram.rst b/docs/en/api-guides/external-ram.rst index 2771ded682..1c05be4a5f 100644 --- a/docs/en/api-guides/external-ram.rst +++ b/docs/en/api-guides/external-ram.rst @@ -19,20 +19,22 @@ Hardware The ESP-PSRAM32 chip is a 1.8 V device which can only be used in parallel with a 1.8 V flash component. Make sure to either set the MTDI pin to a high signal level on bootup, or program {IDF_TARGET_NAME} eFuses to always use the VDD_SIO level of 1.8 V. Not doing this can damage the PSRAM and/or flash chip. -To connect the ESP-PSRAM32 chip to ESP32D0W*, connect the following signals: +.. only:: esp32 - * PSRAM /CE (pin 1) > ESP32 GPIO 16 - * PSRAM SO (pin 2) > flash DO - * PSRAM SIO[2] (pin 3) > flash WP - * PSRAM SI (pin 5) > flash DI - * PSRAM SCLK (pin 6) > ESP32 GPIO 17 - * PSRAM SIO[3] (pin 7) > flash HOLD - * PSRAM Vcc (pin 8) > ESP32 VCC_SDIO + To connect the ESP-PSRAM32 chip to ESP32D0W*, connect the following signals: -Connections for ESP32D2W* chips are TBD. + * PSRAM /CE (pin 1) > ESP32 GPIO 16 + * PSRAM SO (pin 2) > flash DO + * PSRAM SIO[2] (pin 3) > flash WP + * PSRAM SI (pin 5) > flash DI + * PSRAM SCLK (pin 6) > ESP32 GPIO 17 + * PSRAM SIO[3] (pin 7) > flash HOLD + * PSRAM Vcc (pin 8) > ESP32 VCC_SDIO -.. 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. + 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. .. _external_ram_config: diff --git a/docs/en/api-guides/freertos-smp.rst b/docs/en/api-guides/freertos-smp.rst index 5f99a88a02..1c01774715 100644 --- a/docs/en/api-guides/freertos-smp.rst +++ b/docs/en/api-guides/freertos-smp.rst @@ -64,7 +64,7 @@ to ESP-IDF. not done so already. Furthermore, ``float`` cannot be used in interrupt service routines. -:ref:`task-deletion`: Task deletion behavior has been backported from FreeRTOS +`Task Deletion`_: Task deletion behavior has been backported from FreeRTOS v9.0.0 and modified to be SMP compatible. Task memory will be freed immediately when :cpp:func:`vTaskDelete` is called to delete a task that is not currently running and not pinned to the other core. Otherwise, freeing of task memory will still @@ -461,7 +461,7 @@ occur. ESP-IDF FreeRTOS provides the added feature of Deletion Callbacks. Deletion Callbacks are called automatically during task deletion to free memory pointed to by TLSP. Each TLSP can have its own Deletion Callback. Note that due to the -to :ref:`task-deletion` behavior, there can be instances where Deletion +to `Task Deletion`_ behavior, there can be instances where Deletion Callbacks are called in the context of the Idle Tasks. Therefore Deletion Callbacks **should never attempt to block** and critical sections should be kept as short as possible to minimize priority inversion. diff --git a/docs/en/api-guides/jtag-debugging/index.rst b/docs/en/api-guides/jtag-debugging/index.rst index 8e32b02467..44eff3595c 100644 --- a/docs/en/api-guides/jtag-debugging/index.rst +++ b/docs/en/api-guides/jtag-debugging/index.rst @@ -150,7 +150,7 @@ Open a terminal and set it up for using the ESP-IDF as described in the :ref:`se .. note:: - The files provided after ``-f`` above are specific for ESP-WROVER-KIT with :ref:`esp-modules-and-boards-esp32-wroom-32` module. You may need to provide different files depending on used hardware. For guidance see :ref:`jtag-debugging-tip-openocd-configure-target`. + The files provided after ``-f`` above are specific for ESP-WROVER-KIT with esp32-wroom-32 module. You may need to provide different files depending on used hardware. For guidance see :ref:`jtag-debugging-tip-openocd-configure-target`. .. highlight:: none diff --git a/docs/en/api-guides/jtag-debugging/tips-and-quirks.rst b/docs/en/api-guides/jtag-debugging/tips-and-quirks.rst index 88a56e75d0..c95ad6e2df 100644 --- a/docs/en/api-guides/jtag-debugging/tips-and-quirks.rst +++ b/docs/en/api-guides/jtag-debugging/tips-and-quirks.rst @@ -103,7 +103,7 @@ What is the meaning of debugger's startup commands? On startup, debugger is issuing sequence of commands to reset the chip and halt it at specific line of code. This sequence (shown below) is user defined to pick up at most convenient / appropriate line and start debugging. -* ``set remote hardware-watchpoint-limit 2`` — Restrict GDB to using two hardware watchpoints supported by the chip, 2 for ESP32. For more information see https://sourceware.org/gdb/onlinedocs/gdb/Remote-Configuration.html. +* ``set remote hardware-watchpoint-limit 2`` — Restrict GDB to using two hardware watchpoints supported by the chip, 2 for {IDF_TARGET_NAME}. For more information see https://sourceware.org/gdb/onlinedocs/gdb/Remote-Configuration.html. * ``mon reset halt`` — reset the chip and keep the CPUs halted * ``flushregs`` — monitor (``mon``) command can not inform GDB that the target state has changed. GDB will assume that whatever stack the target had before ``mon reset halt`` will still be valid. In fact, after reset the target state will change, and executing ``flushregs`` is a way to force GDB to get new state from the target. * ``thb app_main`` — insert a temporary hardware breakpoint at ``app_main``, put here another function name if required @@ -117,7 +117,7 @@ Configuration of OpenOCD for specific target OpenOCD needs to be told what JTAG adapter to use and processor the JTAG adapter is connected to. To do so, use existing **board** configuration files located in OpenOCD's ``share/openocd/scripts/board`` folder. -For example, if you connect to ESP-WROVER-KIT with ESP-WROOM-32 module installed (see section :ref:`esp-modules-and-boards-esp-wrover-kit-v1`), use the following configuration files: +For example, if you connect to ESP-WROVER-KIT with ESP-WROOM-32 module installed, use the following configuration files: * ``board/esp32-wrover-kit-3.3v.cfg`` @@ -135,15 +135,16 @@ Adapter's clock speed See :ref:`jtag-debugging-tip-optimize-jtag-speed` for guidance how to set this value. +.. only:: esp32 -Single core debugging -""""""""""""""""""""" + Single core debugging + """"""""""""""""""""" -:: + :: - set ESP32_ONLYCPU 1 + set ESP32_ONLYCPU 1 -Comment out this line for dual core debugging. + Comment out this line for dual core debugging. Disable RTOS support diff --git a/docs/en/api-reference/peripherals/adc.rst b/docs/en/api-reference/peripherals/adc.rst index 0dba625dc0..3fc65869b7 100644 --- a/docs/en/api-reference/peripherals/adc.rst +++ b/docs/en/api-reference/peripherals/adc.rst @@ -7,7 +7,7 @@ Overview The {IDF_TARGET_NAME} integrates two 12-bit SAR (`Successive Approximation Register `_) ADCs supporting a total of 18 measurement channels (analog enabled pins). -..only:: esp32 +.. only:: esp32 The ADC driver API supports ADC1 (8 channels, attached to GPIOs 32 - 39), and ADC2 (10 channels, attached to GPIOs 0, 2, 4, 12 - 15 and 25 - 27). However, the usage of ADC2 has some restrictions for the application: diff --git a/docs/en/api-reference/peripherals/rmt.rst b/docs/en/api-reference/peripherals/rmt.rst index 005333a01d..9c6534cbf8 100644 --- a/docs/en/api-reference/peripherals/rmt.rst +++ b/docs/en/api-reference/peripherals/rmt.rst @@ -242,7 +242,7 @@ The RMT controller triggers interrupts on four specific events describes below. Setting or clearing an interrupt enable mask for specific channels and events may be also done by calling :cpp:func:`rmt_set_intr_enable_mask` or :cpp:func:`rmt_clr_intr_enable_mask`. -When servicing an interrupt within an ISR, the interrupt need to explicitly cleared. To do so, set specific bits described as ``RMT.int_clr.val.chN_event_name`` and defined as a ``volatile struct`` in :component_file:`soc/{IDT_TARGET_PATH_NAME}/include/soc/rmt_struct.h`, where N is the RMT channel number [0, 7] and the ``event_name`` is one of four events described above. +When servicing an interrupt within an ISR, the interrupt need to explicitly cleared. To do so, set specific bits described as ``RMT.int_clr.val.chN_event_name`` and defined as a ``volatile struct`` in :component_file:`soc/{IDF_TARGET_PATH_NAME}/include/soc/rmt_struct.h`, where N is the RMT channel number [0, 7] and the ``event_name`` is one of four events described above. If you do not need an ISR anymore, you can deregister it by calling a function :cpp:func:`rmt_isr_deregister`. diff --git a/docs/en/api-reference/system/mem_alloc.rst b/docs/en/api-reference/system/mem_alloc.rst index 44512aa2c9..a288834d0a 100644 --- a/docs/en/api-reference/system/mem_alloc.rst +++ b/docs/en/api-reference/system/mem_alloc.rst @@ -105,7 +105,7 @@ External SPI Memory When :doc:`external RAM ` is enabled, external SPI RAM under 4MiB in size can be allocated using standard ``malloc`` calls, or via ``heap_caps_malloc(MALLOC_CAP_SPIRAM)``, depending on configuration. See :ref:`external_ram_config` for more details. -..only:: esp32 +.. only:: esp32 To use the region above the 4MiB limit, you can use the :doc:`himem API`. diff --git a/docs/en/contribute/add-ons-reference.rst b/docs/en/contribute/add-ons-reference.rst index d715c41701..2e3a1bcbe4 100644 --- a/docs/en/contribute/add-ons-reference.rst +++ b/docs/en/contribute/add-ons-reference.rst @@ -148,7 +148,7 @@ Other Extensions :idf_file:`docs/idf_extensions/format_idf_target.py` An extension for replacing generic target related names with the idf_target passed to the Sphinx command line. - This is a {\IDF_TARGET_NAME}, with /{\IDF_TARGET_PATH_NAME}/soc.c, compiled with `xtensa-{\IDF_TARGET_TOOLCHAIN_NAME}-elf-gcc` with `CONFIG{\IDF_TARGET_CFG_PREFIX}_MULTI_DOC` will, if the backspaces are removed, render as This is a {IDF_TARGET_NAME}, with /{IDF_TARGET_PATH_NAME}/soc.c, compiled with `xtensa-{IDF_TARGET_TOOLCHAIN_NAME}-elf-gcc` with `CONFIG{IDF_TARGET_CFG_PREFIX}_MULTI_DOC`. + This is a {\IDF_TARGET_NAME}, with /{\IDF_TARGET_PATH_NAME}/soc.c, compiled with `xtensa-{\IDF_TARGET_TOOLCHAIN_NAME}-elf-gcc` with `CONFIG_{\IDF_TARGET_CFG_PREFIX}_MULTI_DOC` will, if the backspaces are removed, render as This is a {IDF_TARGET_NAME}, with /{IDF_TARGET_PATH_NAME}/soc.c, compiled with `xtensa-{IDF_TARGET_TOOLCHAIN_NAME}-elf-gcc` with `CONFIG_{IDF_TARGET_CFG_PREFIX}_MULTI_DOC`. This cannot be used inside tables. diff --git a/docs/en/get-started/index.rst b/docs/en/get-started/index.rst index 6adb9dc4c7..e3ea9c76c3 100644 --- a/docs/en/get-started/index.rst +++ b/docs/en/get-started/index.rst @@ -13,7 +13,7 @@ After that, a simple example will show you how to use ESP-IDF (Espressif IoT Dev Introduction ============ -..only:: esp32 +.. only:: esp32 {IDF_TARGET_NAME} is a system on a chip that integrates the following features: diff --git a/docs/en/hw-reference/index.rst b/docs/en/hw-reference/index.rst index 2cf714b69b..9978049ee8 100644 --- a/docs/en/hw-reference/index.rst +++ b/docs/en/hw-reference/index.rst @@ -3,28 +3,16 @@ ************************************ :link_to_translation:`zh_CN:[中文]` -.. only:: esp32 - - .. toctree:: +.. toctree:: :maxdepth: 3 - Technical Reference Manual (PDF) - Datasheet (PDF) - Hardware Design Guidelines (PDF) - Silicon Errata (PDF) - Modules and Boards - Previous Versions of Modules and Boards - Espressif Products Ordering Information (PDF) - Regulatory Certificates - -.. only:: esp32s2beta - - .. toctree:: - :maxdepth: 3 - - Technical Reference Manual (PDF) - Datasheet (PDF) - Modules and Boards - Previous Versions of Modules and Boards - Espressif Products Ordering Information (PDF) - Regulatory Certificates \ No newline at end of file + :esp32: Technical Reference Manual (PDF) + :esp32s2beta: Technical Reference Manual (PDF) + :esp32: Datasheet (PDF) + :esp32s2beta: Datasheet (PDF) + :esp32: Hardware Design Guidelines (PDF) + :esp32: Silicon Errata (PDF) + Modules and Boards + Previous Versions of Modules and Boards + Espressif Products Ordering Information (PDF) + Regulatory Certificates diff --git a/docs/en/hw-reference/modules-and-boards-previous.rst b/docs/en/hw-reference/modules-and-boards-previous.rst index 7ac3d1571a..7128bf5c73 100644 --- a/docs/en/hw-reference/modules-and-boards-previous.rst +++ b/docs/en/hw-reference/modules-and-boards-previous.rst @@ -1,10 +1,10 @@ .. _esp-modules-and-boards-previous: -********************************************* -Previous Versions of ESP32 Modules and Boards -********************************************* +********************************************************* +Previous Versions of {IDF_TARGET_NAME} Modules and Boards +********************************************************* -This sections contains overview and links to documentation of previous version ESP32 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. +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) @@ -18,172 +18,174 @@ 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: +.. only:: esp32 -ESP32-PICO-KIT V4 ------------------ + .. _esp-modules-and-boards-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. + ESP32-PICO-KIT V4 + ----------------- -.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-pico-kit-v4.jpeg - :align: center - :alt: ESP32-PICO-KIT V4 board - :width: 50% + 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. - ESP32-PICO-KIT V4 board + .. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-pico-kit-v4.jpeg + :align: center + :alt: ESP32-PICO-KIT V4 board + :width: 50% -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. + ESP32-PICO-KIT V4 board -Documentation -^^^^^^^^^^^^^ + 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. -* :doc:`../hw-reference/get-started-pico-kit` -* `ESP32-PICO-KIT V4 Schematic `_ (PDF) -* `ESP32-PICO-D4 Datasheet `_ (PDF) + Documentation + ^^^^^^^^^^^^^ -.. _esp-modules-and-boards-esp32-pico-kit-v3: + * :doc:`../hw-reference/get-started-pico-kit` + * `ESP32-PICO-KIT V4 Schematic `_ (PDF) + * `ESP32-PICO-D4 Datasheet `_ (PDF) -ESP32-PICO-KIT V3 ------------------ + .. _esp-modules-and-boards-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. + ESP32-PICO-KIT V3 + ----------------- -.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-pico-kit-v3.jpeg - :align: center - :alt: ESP32-PICO-KIT V3 board - :width: 50% + 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. - ESP32-PICO-KIT V3 board + .. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-pico-kit-v3.jpeg + :align: center + :alt: ESP32-PICO-KIT V3 board + :width: 50% -Documentation -^^^^^^^^^^^^^ + ESP32-PICO-KIT V3 board -* :doc:`../hw-reference/get-started-pico-kit-v3` -* `ESP32-PICO-KIT V3 Schematic `_ (PDF) -* `ESP32-PICO-D4 Datasheet `_ (PDF) + 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: + .. _esp-modules-and-boards-esp32-devkitc-v2: -ESP32 Core Board V2 / ESP32 DevKitC ------------------------------------ + 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. + 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% + .. 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 + ESP32 Core Board V2 / ESP32 DevKitC board -Documentation -^^^^^^^^^^^^^ + Documentation + ^^^^^^^^^^^^^ -* :doc:`../hw-reference/get-started-devkitc-v2` -* `ESP32 DevKitC V2 Schematic `__ (PDF) -* `CP210x USB to UART Bridge VCP Drivers `_ + * :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-modules-and-boards-esp-wrover-kit-v3: -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. + 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. + 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. + 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% + .. 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 + 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. + 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 -^^^^^^^^^^^^^ + 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`_ + * :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-modules-and-boards-esp-wrover-kit-v2: -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. + 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% + .. 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 + ESP-WROVER-KIT V2 board -Comparing to previous version, this board has a shiny black finish and a male camera header. + Comparing to previous version, this board has a shiny black finish and a male camera header. -Documentation -^^^^^^^^^^^^^ + 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`_ + * :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-modules-and-boards-esp-wrover-kit-v1: -ESP-WROVER-KIT V1 / ESP32 DevKitJ V1 ------------------------------------- + ESP-WROVER-KIT V1 / ESP32 DevKitJ V1 + ------------------------------------ -The first version of ESP-WROVER-KIT development board. Shipped with ESP-WROOM-32 on board. + 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. + 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. + 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% + .. 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 + ESP-WROVER-KIT V1 / ESP32 DevKitJ V1 board -The board has red soldermask. + The board has red soldermask. -Documentation -^^^^^^^^^^^^^ + Documentation + ^^^^^^^^^^^^^ -* `ESP-WROVER-KIT V1 Schematic `__ (PDF) -* :doc:`../api-guides/jtag-debugging/index` -* `FTDI Virtual COM Port Drivers`_ + * `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 + .. _esp-modules-and-boards-esp32-demo-board: ESP32 Demo Board V2 + ------------------- -Production of this board is discontinued. + 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. -Documentation -^^^^^^^^^^^^^ + .. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-demo-board-v2.jpg + :align: center + :alt: ESP32 Demo Board V2 -* `ESP32 Demo Board V2 Schematic `__ (PDF) -* `FTDI Virtual COM Port Drivers`_ + ESP32 Demo Board V2 + + Production of this board is discontinued. + + Documentation + ^^^^^^^^^^^^^ + + * `ESP32 Demo Board V2 Schematic `__ (PDF) + * `FTDI Virtual COM Port Drivers`_ Related Documents diff --git a/docs/en/hw-reference/modules-and-boards.rst b/docs/en/hw-reference/modules-and-boards.rst index 788b7a38a1..e784f387bd 100644 --- a/docs/en/hw-reference/modules-and-boards.rst +++ b/docs/en/hw-reference/modules-and-boards.rst @@ -1,12 +1,12 @@ .. _esp-modules-and-boards: -************************ -ESP32 Modules and Boards -************************ +************************************ +{IDF_TARGET_NAME} Modules and Boards +************************************ :link_to_translation:`zh_CN:[中文]` -Espressif designs and manufactures different modules and development boards to help users evaluate the potential of the ESP32 family of chips. +Espressif designs and manufactures different modules and development boards to help users evaluate the potential of the {IDF_TARGET_NAME} family of chips. This document provides description of modules and development boards currently available from Espressif. @@ -19,286 +19,288 @@ This document provides description of modules and development boards currently a 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. +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. -=================== ============ =========== ========= ==== =============== -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 -=================== ============ =========== ========= ==== =============== +.. only:: esp32 -* 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* + =================== ============ =========== ========= ==== =============== + 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 --------------- + .. _esp-modules-and-boards-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. + ESP32-WROOM-32 + -------------- -For key characteristics, see the table in Section :ref:`esp-wroom-solo-wrover-modules`, `Espressif Products Ordering Information`_. + 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) + .. 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% -Documentation -^^^^^^^^^^^^^ + ESP32-WROOM-32 module (front and back) -* `ESP32-WROOM-32 Datasheet `__ (PDF) -* `ESP32-WROOM-32 Reference Design `_ containing OrCAD schematic, PCB layout, gerber and BOM files + 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 ---------------------------------- + .. _esp-modules-and-boards-esp32-wroom-32d-and-u: -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`. + ESP32-WROOM-32D / ESP32-WROOM-32U + --------------------------------- -For key characteristics, see the table in Section :ref:`esp-wroom-solo-wrover-modules` and `Espressif Products Ordering Information`_. + 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`. -ESP32-WROOM-32U is the smallest representative of the whole WROOM / WROVER family of modules. + 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-wroom-32d-front-back.jpg - :align: center - :alt: ESP32-WROOM-32D module (front and back) - :width: 45% + ESP32-WROOM-32U is the smallest representative of the whole WROOM / WROVER family of modules. - ESP32-WROOM-32D module (front and back) + .. 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% -.. 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-32D module (front and back) - ESP32-WROOM-32U 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% -Documentation -^^^^^^^^^^^^^ + ESP32-WROOM-32U module (front and back) -* `ESP32-WROOM-32D / ESP32-WROOM-32U Datasheet `__ (PDF) + Documentation + ^^^^^^^^^^^^^ + * `ESP32-WROOM-32D / ESP32-WROOM-32U Datasheet `__ (PDF) -.. _esp-modules-and-boards-esp32-solo-1: -ESP32-SOLO-1 ------------- + .. _esp-modules-and-boards-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. + ESP32-SOLO-1 + ------------ -For key characteristics, see the table in Section :ref:`esp-wroom-solo-wrover-modules` and `Espressif Products Ordering Information`_. + 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. -.. 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% + For key characteristics, see the table in Section :ref:`esp-wroom-solo-wrover-modules` and `Espressif Products Ordering Information`_. - ESP32-SOLO-1 module (front and back) + .. 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) + Documentation + ^^^^^^^^^^^^^ + * `ESP32-SOLO-1 Datasheet `__ (PDF) -.. _esp-modules-and-boards-esp32-wrover: -ESP32-WROVER series -------------------- + .. _esp-modules-and-boards-esp32-wrover: -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). + ESP32-WROVER series + ------------------- -For details, see the table in Section :ref:`esp-wroom-solo-wrover-modules` and `Espressif Products Ordering Information`_. + 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). -* **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. + For details, see the table in Section :ref:`esp-wroom-solo-wrover-modules` and `Espressif Products Ordering Information`_. -The picture below shows an ESP32-WROVER module with a PCB antenna. + * **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. -.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-wrover.jpg - :align: center - :alt: ESP32-WROVER module (front and back) - :width: 40% + The picture below shows an ESP32-WROVER module with a PCB antenna. - ESP32-WROVER module (front and back) + .. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-wrover.jpg + :align: center + :alt: ESP32-WROVER module (front and back) + :width: 40% -Documentation -^^^^^^^^^^^^^ + ESP32-WROVER module (front and back) -* `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 + 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: + ESP32-PICO-D4 + ------------- -- 4 MB flash memory -- crystal oscillator -- filter capacitors -- RF matching circuit + ESP32-PICO-D4 is a System-in-Package (SiP) module, integrating all peripheral components seamlessly, including the following: -For key characteristics, see `Espressif Products Ordering Information`_. + - 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) + Documentation + ^^^^^^^^^^^^^ + * `ESP32-PICO-D4 Datasheet `__ (PDF) -Development Boards -================== -Depending on the intended functionality, different development boards feature: + Development Boards + ================== -- Access to different ESP32 GPIO pins. -- Different interfaces: USB, JTAG. -- Different peripherals: touchpads, LCD screens, SD card slots, female headers for camera modules, etc. + Depending on the intended functionality, different development boards feature: -.. _esp-modules-and-boards-esp32-pico-kit: + - Access to different ESP32 GPIO pins. + - Different interfaces: USB, JTAG. + - Different peripherals: touchpads, LCD screens, SD card slots, female headers for camera modules, etc. -ESP32-PICO-KIT V4.1 -------------------- + .. _esp-modules-and-boards-esp32-pico-kit: -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. + ESP32-PICO-KIT V4.1 + ------------------- -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. + 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. -.. 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% + 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. - ESP32-PICO-KIT V4.1 board + .. 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% -Comparing to ESP32-PICO-KIT V4, this version features the CP2102N USB-UART bridge that provides faster transfer rates of up to 3 Mbps. + ESP32-PICO-KIT V4.1 board -Documentation -^^^^^^^^^^^^^ + Comparing to ESP32-PICO-KIT V4, this version features the CP2102N USB-UART bridge that provides faster transfer rates of up to 3 Mbps. -* :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) + Documentation + ^^^^^^^^^^^^^ -Previous Versions -^^^^^^^^^^^^^^^^^ + * :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) -* :ref:`esp-modules-and-boards-esp32-pico-kit-v4` -* :ref:`esp-modules-and-boards-esp32-pico-kit-v3` + 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: + .. _esp-modules-and-boards-esp32-devkitc: -- :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 + ESP32 DevKitC V4 + ---------------- -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. + This is a small and convenient development board that features: -.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-devkitc-v4-front.jpg - :align: center - :alt: ESP32 DevKitC V4 board - :width: 50% + - :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 - ESP32 DevKitC V4 board + 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. -Documentation -^^^^^^^^^^^^^ + .. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-devkitc-v4-front.jpg + :align: center + :alt: ESP32 DevKitC V4 board + :width: 50% -* :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 `_ + ESP32 DevKitC V4 board -Previous Versions -^^^^^^^^^^^^^^^^^ + Documentation + ^^^^^^^^^^^^^ -* :ref:`esp-modules-and-boards-esp32-devkitc-v2` + * :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 + ^^^^^^^^^^^^^^^^^ -.. _esp-modules-and-boards-esp-wrover-kit: + * :ref:`esp-modules-and-boards-esp32-devkitc-v2` -ESP-WROVER-KIT V4.1 -------------------- -This board features: + .. _esp-modules-and-boards-esp-wrover-kit: -- 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 + ESP-WROVER-KIT V4.1 + ------------------- -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 board features: -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`. + - 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 -Comparing to :ref:`esp-modules-and-boards-esp-wrover-kit-v3`, this board has the following design changes: + 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. -- 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. + 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`. -.. 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% + Comparing to :ref:`esp-modules-and-boards-esp-wrover-kit-v3`, this board has the following design changes: - ESP-WROVER-KIT V4.1 board + - 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. -The board in the picture above integrates the ESP32-WROVER-B module. + .. 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% -Documentation -^^^^^^^^^^^^^ + ESP-WROVER-KIT V4.1 board -* :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`_ + The board in the picture above integrates the ESP32-WROVER-B module. -Previous Versions -^^^^^^^^^^^^^^^^^ + Documentation + ^^^^^^^^^^^^^ -* :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:`../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` Related Documents