Skip to content

Commit c759ff3

Browse files
committed
Docs for ESP32 DevKitC V4
1 parent 62be35c commit c759ff3

File tree

7 files changed

+161
-20
lines changed

7 files changed

+161
-20
lines changed
62.2 KB
Loading
81.2 KB
Loading
Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
ESP32-DevKitC V2 Getting Started Guide
2+
======================================
3+
4+
This user guide shows how to get started with ESP32-DevKitC development board.
5+
6+
7+
What You Need
8+
-------------
9+
10+
* 1 × :ref:`ESP32-DevKitC V2 board <get-started-esp32-devkitc-v2-board-front>`
11+
* 1 × USB A / micro USB B cable
12+
* 1 × PC loaded with Windows, Linux or Mac OS
13+
14+
15+
Overview
16+
--------
17+
18+
ESP32-DevKitC is a small-sized ESP32-based development board produced by `Espressif <https://espressif.com>`_. Most of the I/O pins are broken out to the pin headers on both sides for easy interfacing. Developers can connect these pins to peripherals as needed. Standard headers also make development easy and convenient when using a breadboard.
19+
20+
21+
Functional Description
22+
----------------------
23+
24+
The following list and figure below describe key components, interfaces and controls of ESP32-DevKitC board.
25+
26+
ESP-WROOM-32
27+
Standard `ESP-WROOM-32 <https://www.espressif.com/sites/default/files/documentation/esp-wroom-32_datasheet_en.pdf>`_ module soldered to the ESP32-DevKitC board.
28+
EN
29+
Reset button: pressing this button resets the system.
30+
Boot
31+
Download button: holding down the **Boot** button and pressing the **EN** button initiates the firmware download mode. Then user can download firmware through the serial port.
32+
USB
33+
USB interface. It functions as the power supply for the board and the communication interface between PC and ESP-WROOM-32.
34+
I/O
35+
Most of the pins on the ESP-WROOM-32 are broken out to the pin headers on the board. Users can program ESP32 to enable multiple functions such as PWM, ADC, DAC, I2C, I2S, SPI, etc.
36+
37+
.. _get-started-esp32-devkitc-v2-board-front:
38+
39+
.. figure:: ../_static/esp32-devkitc-v2-functional-overview.png
40+
:align: center
41+
:alt: ESP32-DevKitC V2 board layout
42+
:figclass: align-center
43+
44+
ESP32-DevKitC V2 board layout
45+
46+
47+
Power Supply Options
48+
--------------------
49+
50+
There following options are available to provide power supply to this board:
51+
52+
1. Micro USB port, this is default power supply connection
53+
2. 5V / GND header pins
54+
3. 3V3 / GND header pins
55+
56+
.. warning::
57+
58+
Above options are mutually exclusive, i.e. the power supply may be provided using only one of the above options. Attempt to power the board using more than one connection at a time may damage the board and/or the power supply source.
59+
60+
61+
Start Application Development
62+
------------------------------
63+
64+
Before powering up the ESP32-DevKitC, please make sure that the board has been received in good condition with no obvious signs of damage.
65+
66+
To start development of applications, proceed to section :doc:`index`, that will walk you through the following steps:
67+
68+
* :ref:`get-started-setup-toolchain` in your PC to develop applications for ESP32 in C language
69+
* :ref:`get-started-connect` the module to the PC and verify if it is accessible
70+
* :ref:`get-started-build-flash` an example application to the ESP32
71+
* :ref:`get-started-build-monitor` instantly what the application is doing
72+
73+
74+
Related Documents
75+
-----------------
76+
77+
* `ESP32-DevKitC schematic <https://dl.espressif.com/dl/schematics/ESP32-Core-Board-V2_sch.pdf>`_ (PDF)
78+
* `ESP32 Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf>`_ (PDF)
79+
* `ESP-WROOM-32 Datasheet <https://espressif.com/sites/default/files/documentation/esp-wroom-32_datasheet_en.pdf>`_ (PDF)

docs/get-started/get-started-devkitc.rst

Lines changed: 46 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@ What You Need
1515
Overview
1616
--------
1717

18-
ESP32-DevKitC is a small-sized ESP32-based development board produced by `Espressif <https://espressif.com>`_. Most of the I/O pins are broken out to the pin headers on both sides for easy interfacing. Developers can connect these pins to peripherals as needed. Standard headers also make development easy and convenient when using a breadboard.
18+
ESP32-DevKitC is a small-sized ESP32-based development board produced by `Espressif <https://espressif.com>`_. Most of the I/O pins are broken out to the pin headers on both sides for easy interfacing. Developers can connect these pins to peripherals as needed. Standard headers also make development easy and convenient when using a breadboard.
19+
20+
The board comes in two versions, either with :ref:`esp-modules-and-boards-esp-wroom-32` or :ref:`esp-modules-and-boards-esp32-wrover` module soldered.
1921

2022

2123
Functional Description
@@ -24,30 +26,45 @@ Functional Description
2426
The following list and figure below describe key components, interfaces and controls of ESP32-DevKitC board.
2527

2628
ESP-WROOM-32
27-
Standard `ESP-WROOM-32 <https://www.espressif.com/sites/default/files/documentation/esp-wroom-32_datasheet_en.pdf>`_ module soldered to the ESP32-DevKitC board.
28-
EN
29-
Reset button: pressing this button resets the system.
29+
:ref:`esp-modules-and-boards-esp-wroom-32` module soldered to the ESP32-DevKitC board.
30+
ESP32-WROVER
31+
Optionally :ref:`esp-modules-and-boards-esp32-wrover` module may be soldered instead of the ESP-WROOM-32.
32+
USB-UART Bridge
33+
A single chip USB-UART bridge provides up to 3 Mbps transfers rates.
3034
Boot
3135
Download button: holding down the **Boot** button and pressing the **EN** button initiates the firmware download mode. Then user can download firmware through the serial port.
32-
USB
33-
USB interface. It functions as the power supply for the board and the communication interface between PC and ESP-WROOM-32.
36+
Micro USB Port
37+
USB interface. It functions as the power supply for the board and the communication interface between PC and the ESP module.
38+
5V Power On LED
39+
This LED lights when the USB or an external 5V power supply is applied to the board. For details see schematic in `Related Documents`_.
40+
EN
41+
Reset button: pressing this button resets the system.
3442
I/O
35-
Most of the pins on the ESP-WROOM-32 are broken out to the pin headers on the board. Users can program ESP32 to enable multiple functions such as PWM,ADC, DAC, I2C, I2S, SPI, etc.
43+
Most of the pins on the ESP module are broken out to the pin headers on the board. Users can program ESP32 to enable multiple functions such as PWM, ADC, DAC, I2C, I2S, SPI, etc.
44+
45+
.. note::
46+
47+
Some of broken out pins are used internally be the ESP32 module to communicate with SPI memory. They are grouped on one side of the board besides the USB connector and labeled D0, D1, D2, D3, CMD and CLK. In general these pins should be left unconnected or access to the SPI flash memory / SPI RAM may be disturbed.
48+
49+
.. note::
50+
51+
GPIO16 and 17 are used internally by the ESP32-WROVER module. They are broken out and avialable for use only for boards that have the ESP-WROOM-32 module installed.
52+
3653

3754
.. _get-started-esp32-devkitc-board-front:
3855

39-
.. figure:: ../_static/esp32-devkitc-functional-overview.png
56+
.. figure:: ../_static/esp32-devkitc-functional-overview.jpg
4057
:align: center
41-
:alt: ESP32-DevKitC board layout
58+
:alt: ESP32-DevKitC with ESP-WROOM-32 module soldered
4259
:figclass: align-center
4360

44-
ESP32-DevKitC board layout
61+
ESP32-DevKitC with ESP-WROOM-32 module soldered
4562

4663

4764
Power Supply Options
4865
--------------------
4966

50-
There following options are available to provide power supply to the ESP32-PICO-KIT V4:
67+
There following options are available to provide power supply to this board:
5168

5269
1. Micro USB port, this is default power supply connection
5370
2. 5V / GND header pins
@@ -71,9 +88,26 @@ To start development of applications, proceed to section :doc:`index`, that will
7188
* :ref:`get-started-build-monitor` instantly what the application is doing
7289

7390

91+
Board Dimensions
92+
----------------
93+
94+
.. figure:: ../_static/esp32-devkitc-dimensions-back.jpg
95+
:align: center
96+
:alt: ESP32 DevKitC board dimensions - back
97+
:figclass: align-center
98+
99+
ESP32 DevKitC board dimensions - back
100+
101+
74102
Related Documents
75103
-----------------
76104

77-
* `ESP32-DevKitC schematic <https://dl.espressif.com/dl/schematics/ESP32-Core-Board-V2_sch.pdf>`_ (PDF)
105+
* `ESP32-DevKitC schematic <https://dl.espressif.com/dl/schematics/esp32_devkitc_v4-sch.pdf>`_ (PDF)
78106
* `ESP32 Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf>`_ (PDF)
79107
* `ESP-WROOM-32 Datasheet <https://espressif.com/sites/default/files/documentation/esp-wroom-32_datasheet_en.pdf>`_ (PDF)
108+
* `ESP32-WROVER Datasheet <https://espressif.com/sites/default/files/documentation/esp32-wrover_datasheet_en.pdf>`_ (PDF)
109+
110+
.. toctree::
111+
:hidden:
112+
113+
get-started-devkitc-v2

docs/hw-reference/modules-and-boards-previous.rst

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,28 @@ Documentation
3030
* `ESP32-PICO-D4 Datasheet <http://espressif.com/sites/default/files/documentation/esp32-pico-d4_datasheet_en.pdf>`_ (PDF)
3131

3232

33+
.. _esp-modules-and-boards-esp32-devkitc-v2:
34+
35+
ESP32 Core Board V2 / ESP32 DevKitC
36+
-----------------------------------
37+
38+
Small and convenient development board with :ref:`esp-modules-and-boards-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.
39+
40+
.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-core-board-v2.png
41+
:align: center
42+
:alt: ESP32 Core Board V2 / ESP32 DevKitC board
43+
:width: 50%
44+
45+
ESP32 Core Board V2 / ESP32 DevKitC board
46+
47+
Documentation
48+
"""""""""""""
49+
50+
* :doc:`../get-started/get-started-devkitc-v2`
51+
* `ESP32 DevKitC V2 Schematic <https://dl.espressif.com/dl/schematics/ESP32-Core-Board-V2_sch.pdf>`__ (PDF)
52+
* `CP210x USB to UART Bridge VCP Drivers <https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers>`_
53+
54+
3355
.. _esp-modules-and-boards-esp-wrover-kit-v1:
3456

3557
ESP-WROVER-KIT V1 / ESP32 DevKitJ V1

docs/hw-reference/modules-and-boards.rst

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,7 @@ Documentation
104104

105105
* `ESP32-WROVER Datasheet <https://espressif.com/sites/default/files/documentation/esp32-wrover_datasheet_en.pdf>`__ (PDF)
106106
* `ESP-PSRAM32 Datasheet <https://espressif.com/sites/default/files/documentation/esp-psram32_datasheet_en.pdf>`__ (PDF)
107+
* `ESP32-WROVER Reference Design <http://www.espressif.com/sites/default/files/documentation/esp32-wrover_reference_design.zip>`_ PDF containing OrCAD schematic, PCB layout, gerbers and BOM
107108

108109

109110
.. _esp-modules-and-boards-esp32-pico-pit-v4:
@@ -138,26 +139,31 @@ Previous Versions
138139

139140
.. _esp-modules-and-boards-esp32-devkitc:
140141

141-
ESP32 Core Board V2 / ESP32 DevKitC
142-
===================================
142+
ESP32 DevKitC V4
143+
================
143144

144-
Small and convenient development board with :ref:`esp-modules-and-boards-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.
145+
Small and convenient development board with :ref:`esp-modules-and-boards-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. Comparing to the previous :ref:`esp-modules-and-boards-esp32-devkitc-v2`, instead of ESP-WROOM-32 it can accommodate :ref:`esp-modules-and-boards-esp32-wrover` module and has CP2102N chip that supports faster baud rates.
145146

146-
.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-core-board-v2.png
147+
.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-devkitc-v4-front.jpg
147148
:align: center
148-
:alt: ESP32 Core Board V2 / ESP32 DevKitC board
149+
:alt: ESP32 DevKitC V4 board
149150
:width: 50%
150151

151-
ESP32 Core Board V2 / ESP32 DevKitC board
152+
ESP32 DevKitC V4 board
152153

153154
Documentation
154155
-------------
155156

156157
* :doc:`../get-started/get-started-devkitc`
157-
* `ESP32 DevKitC Schematic <https://dl.espressif.com/dl/schematics/ESP32-Core-Board-V2_sch.pdf>`__ (PDF)
158-
* `ESP32 Development Board Reference Design <https://espressif.com/sites/default/files/documentation/esp32_development_board_reference_design.zip>`_ (ZIP) containing OrCAD schematic, PCB layout, gerbers and BOM
158+
* `ESP32-DevKitC schematic <https://dl.espressif.com/dl/schematics/esp32_devkitc_v4-sch.pdf>`_ (PDF)
159+
* `ESP32-DevKitC Reference Design <http://www.espressif.com/sites/default/files/documentation/esp32-devkitc-v4_reference_design_0.zip>`_ (ZIP) containing OrCAD schematic, PCB layout, gerbers and BOM
159160
* `CP210x USB to UART Bridge VCP Drivers <https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers>`_
160161

162+
Previous Versions
163+
-----------------
164+
165+
* :ref:`esp-modules-and-boards-esp32-devkitc-v2`
166+
161167

162168
.. _esp-modules-and-boards-esp-wrover-kit-v3:
163169

0 commit comments

Comments
 (0)