alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Make "H/W Reference" toctree symmetrical

Browse Source 
Update the toctree of "H/W Reference" to make its contents symmetrical for easier and more intuitive navigation.
This commit is contained in:
Kirill Chalov 2019-10-22 21:27:10 +08:00
parent d3ee6b6225
commit bdaf201bd0
3 changed files with 28 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/en/hw-reference/index.rst
View File

@ -4,7 +4,7 @@ ESP32 Hardware Reference
:link_to_translation:`zh_CN:[中文]` :link_to_translation:`zh_CN:[中文]`
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 3
Technical Reference Manual (PDF) <https://espressif.com/sites/default/files/documentation/esp32_technical_reference_manual_en.pdf> Technical Reference Manual (PDF) <https://espressif.com/sites/default/files/documentation/esp32_technical_reference_manual_en.pdf>
Datasheet (PDF) <https://espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf> Datasheet (PDF) <https://espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf>

40
docs/en/hw-reference/modules-and-boards-previous.rst
View File

@ -4,14 +4,24 @@
Previous Versions of ESP32 Modules and Boards Previous Versions of ESP32 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 several of these boards are still in use and some may still be available for purchase. 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.
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`. To see the latest development boards, please refer to section :ref:`esp-modules-and-boards`.
.. _esp-modules-and-boards-esp32-pico-kit-v4: .. _esp-modules-and-boards-esp32-pico-kit-v4:
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. 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.
@ -25,7 +35,7 @@ The smallest ESP32 development board with all the components required to connect
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. 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 Documentation
------------- ^^^^^^^^^^^^^
* :doc:`../hw-reference/get-started-pico-kit` * :doc:`../hw-reference/get-started-pico-kit`
* `ESP32-PICO-KIT V4 Schematic <https://dl.espressif.com/dl/schematics/esp32-pico-kit-v4_schematic.pdf>`_ (PDF) * `ESP32-PICO-KIT V4 Schematic <https://dl.espressif.com/dl/schematics/esp32-pico-kit-v4_schematic.pdf>`_ (PDF)
@ -34,7 +44,7 @@ Documentation
.. _esp-modules-and-boards-esp32-pico-kit-v3: .. _esp-modules-and-boards-esp32-pico-kit-v3:
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. 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.
@ -46,7 +56,7 @@ The first public release of Espressif's ESP32-PICO-D4 module on a mini developme
ESP32-PICO-KIT V3 board ESP32-PICO-KIT V3 board
Documentation Documentation
------------- ^^^^^^^^^^^^^
* :doc:`../hw-reference/get-started-pico-kit-v3` * :doc:`../hw-reference/get-started-pico-kit-v3`
* `ESP32-PICO-KIT V3 Schematic <https://dl.espressif.com/dl/schematics/esp32-pico-kit-v3_schematic.pdf>`_ (PDF) * `ESP32-PICO-KIT V3 Schematic <https://dl.espressif.com/dl/schematics/esp32-pico-kit-v3_schematic.pdf>`_ (PDF)
@ -56,7 +66,7 @@ Documentation
.. _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.
@ -68,7 +78,7 @@ Small and convenient development board with ESP-WROOM-32 module installed, break
ESP32 Core Board V2 / ESP32 DevKitC board ESP32 Core Board V2 / ESP32 DevKitC board
Documentation Documentation
------------- ^^^^^^^^^^^^^
* :doc:`../hw-reference/get-started-devkitc-v2` * :doc:`../hw-reference/get-started-devkitc-v2`
* `ESP32 DevKitC V2 Schematic <https://dl.espressif.com/dl/schematics/ESP32-Core-Board-V2_sch.pdf>`__ (PDF) * `ESP32 DevKitC V2 Schematic <https://dl.espressif.com/dl/schematics/ESP32-Core-Board-V2_sch.pdf>`__ (PDF)
@ -77,7 +87,7 @@ Documentation
.. _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.
@ -95,7 +105,7 @@ This is the first release of ESP-WROVER-KIT shipped with :ref:`esp-modules-and-b
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` * :doc:`../hw-reference/get-started-wrover-kit-v3`
* `ESP-WROVER-KIT V3 Schematic <https://dl.espressif.com/dl/schematics/ESP-WROVER-KIT_SCH-3.pdf>`__ (PDF) * `ESP-WROVER-KIT V3 Schematic <https://dl.espressif.com/dl/schematics/ESP-WROVER-KIT_SCH-3.pdf>`__ (PDF)
@ -105,7 +115,7 @@ Documentation
.. _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.
@ -119,7 +129,7 @@ This is updated version of ESP32 DevKitJ V1 described above with design improvem
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` * :doc:`../hw-reference/get-started-wrover-kit-v2`
* `ESP-WROVER-KIT V2 Schematic <https://dl.espressif.com/dl/schematics/ESP-WROVER-KIT_SCH-2.pdf>`__ (PDF) * `ESP-WROVER-KIT V2 Schematic <https://dl.espressif.com/dl/schematics/ESP-WROVER-KIT_SCH-2.pdf>`__ (PDF)
@ -129,7 +139,7 @@ Documentation
.. _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.
@ -148,7 +158,7 @@ All versions of ESP-WROVER-KIT are ready to accommodate an ESP-WROOM-32 or ESP32
The board has red soldermask. The board has red soldermask.
Documentation Documentation
------------- ^^^^^^^^^^^^^
* `ESP-WROVER-KIT V1 Schematic <https://dl.espressif.com/dl/schematics/ESP32-DevKitJ-v1_sch.pdf>`__ (PDF) * `ESP-WROVER-KIT V1 Schematic <https://dl.espressif.com/dl/schematics/ESP32-DevKitJ-v1_sch.pdf>`__ (PDF)
* :doc:`../api-guides/jtag-debugging/index` * :doc:`../api-guides/jtag-debugging/index`
@ -157,7 +167,7 @@ Documentation
.. _esp-modules-and-boards-esp32-demo-board: .. _esp-modules-and-boards-esp32-demo-board:
ESP32 Demo Board V2 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. 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.
@ -170,7 +180,7 @@ One of first feature rich evaluation boards that contains several pin headers, d
Production of this board is discontinued. Production of this board is discontinued.
Documentation Documentation
------------- ^^^^^^^^^^^^^
* `ESP32 Demo Board V2 Schematic <https://dl.espressif.com/dl/schematics/ESP32-Demo-Board-V2_sch.pdf>`__ (PDF) * `ESP32 Demo Board V2 Schematic <https://dl.espressif.com/dl/schematics/ESP32-Demo-Board-V2_sch.pdf>`__ (PDF)
* `FTDI Virtual COM Port Drivers`_ * `FTDI Virtual COM Port Drivers`_

4
docs/en/hw-reference/modules-and-boards.rst
View File

@ -16,8 +16,8 @@ This document provides description of modules and development boards currently a
.. _esp-wroom-solo-wrover-modules: .. _esp-wroom-solo-wrover-modules:
WROOM, SOLO, WROVER, and PICO 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. 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.