1===================
2 ESP32-DevKitM-1
3===================
4
5:link_to_translation:`zh_CN:[中文]`
6
7This user guide will help you get started with ESP32-DevKitM-1 and will also provide more in-depth information.
8
9ESP32-DevKitM-1 is an ESP32-MINI-1(1U)-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. Users can either connect peripherals with jumper wires or mount ESP32-DevKitM-1 on a breadboard.
10
11
12+---------------------------+-------------------------------+
13| |ESP32-DevKitM-1 - front| | |ESP32-DevKitM-1 - isometric| |
14+---------------------------+-------------------------------+
15|  ESP32-DevKitM-1 - front  |  ESP32-DevKitM-1 - isometric  |
16+---------------------------+-------------------------------+
17
18.. |ESP32-DevKitM-1 - front| image:: ../../../_static/esp32-DevKitM-1-front.png
19
20.. |ESP32-DevKitM-1 - isometric| image:: ../../../_static/esp32-DevKitM-1-isometric.png
21
22
23
24The document consists of the following major sections:
25
26- `Getting started`_: Provides an overview of the ESP32-DevKitM-1 and hardware/software setup instructions to get started.
27- `Hardware reference`_: Provides more detailed information about the ESP32-DevKitM-1's hardware.
28- `Related Documents`_: Gives links to related documentaiton.
29
30Getting Started
31===================
32
33This section describes how to get started with ESP32-DevKitM-1. It begins with a few introductory sections about the ESP32-DevKitM-1, then Section `Start Application Development`_ provides instructions on how to do the initial hardware setup and then how to flash firmware onto the ESP32-DevKitM-1.
34
35
36Overview
37-------------
38
39
40This is a small and convenient development board that features:
41
42- `ESP32-MINI-1, or ESP32-MINI-1U module <https://www.espressif.com/sites/default/files/documentation/esp32-mini-1_datasheet_en.pdf>`_
43- USB-to-serial programming interface that also provides power supply for the board
44- pin headers
45- pushbuttons for reset and activation of Firmware Download mode
46- a few other components
47
48
49Contents and Packaging
50--------------------------
51
52Retail orders
53^^^^^^^^^^^^^^^^^^^^^^^^^^
54
55If you order a few samples, each ESP32-DevKitM-1 comes in an individual package in either antistatic bag or any packaging depending on your retailer.
56
57For retail orders, please go to https://www.espressif.com/en/company/contact/buy-a-sample.
58
59
60Wholesale Orders
61^^^^^^^^^^^^^^^^^^^^^^^^^^^^
62
63If you order in bulk, the boards come in large cardboard boxes.
64
65For wholesale orders, please go to https://www.espressif.com/en/contact-us/sales-questions.
66
67Description of Components
68----------------------------
69
70The following figure and the table below describe the key components, interfaces and controls of the ESP32-DevKitM-1 board. We take the board with a ESP32-MINI-1 module as an example in the following sections.
71
72
73.. figure:: ../../../_static/esp32-devkitm-1-v1-annotated-photo.png
74    :align: center
75    :alt: ESP32-DevKitM-1 - front
76    :figclass: align-center
77
78    ESP32-DevKitM-1 - front
79
80
81.. list-table::
82    :widths: 25 75
83    :header-rows: 1
84
85    * - Key Component
86      - Description
87    * - On-board module
88      - ESP32-MINI-1 module or ESP32-MINI-1U module. ESP32-MINI-1 comes with an on-board PCB antenna. ESP32-MINI-1U comes with an external antenna connector. The two modules both have a 4 MB flash in chip package. For details, please see `ESP32-MINI-1 & ESP32-MINI-1U Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32-mini-1_datasheet_en.pdf>`_.
89    * - 5 V to 3.3 V LDO
90      - Power regulator converts 5 V to 3.3 V.
91    * - Boot Button
92      - Download button. Holding down **Boot** and then pressing **Reset** initiates Firmware Download mode for downloading firmware through the serial port.
93    * - Reset Button
94      - Reset Button
95    * - Micro-USB Port
96      - USB interface. Power supply for the board as well as the communication interface between a computer and the ESP32 chip.
97    * - USB-to-UART Bridge
98      - Single USB-UART bridge chip provides transfer rates up to 3 Mbps.
99    * - 3.3 V Power On LED
100      - Turns on when the USB is connected to the board. For details, please see the schematics in `Related Documents`_.
101    * - I/O Connector
102      - All available GPIO pins (except for the SPI bus for flash) are broken out to the pin headers on the board. Users can program ESP32 chip to enable multiple functions.
103
104
105
106Start Application Development
107----------------------------------
108
109Before powering up your ESP32-DevKitM-1, please make sure that it is in good condition with no obvious signs of damage.
110
111
112Required Hardware
113^^^^^^^^^^^^^^^^^^^^^^
114
115- ESP32-DevKitM-1
116- USB 2.0 cable (Standard-A to Micro-B)
117- Computer running Windows, Linux, or macOS
118
119
120Software Setup
121^^^^^^^^^^^^^^^^^^^^^
122
123Please 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 application example onto your ESP32-DevKitM-1.
124
125.. attention::
126
127    ESP32-DevKitM-1 is a board with a single core module, please enable single core mode (:ref:`CONFIG_FREERTOS_UNICORE`) in :ref:`menuconfig <get-started-configure>` before flashing your applications.
128
129Hardware Reference
130======================
131
132Block Diagram
133----------------------
134
135A block diagram below shows the components of ESP32-DevKitM-1 and their interconnections.
136
137.. figure:: ../../../_static/esp32-DevKitM-1_v1_SystemBlock.png
138    :align: center
139    :alt: ESP32-DevKitM-1
140    :figclass: align-center
141
142    ESP32-DevKitM-1
143
144
145Power Source Select
146----------------------
147
148There are three mutually exclusive ways to provide power to the board:
149
150* Micro USB port, default power supply
151* 5V and GND header pins
152* 3V3 and GND header pins
153
154.. warning::
155
156    - The power supply must be provided using **one and only one of the options above**, otherwise the board and/or the power supply source can be damaged.
157    - Power supply by micro USB port is recommended.
158
159
160Pin Descriptions
161-------------------
162
163The table below provides the Name and Function of pins on both sides of the board. For peripheral pin configurations, please refer to `ESP32 Datasheet`_.
164
165
166.. list-table::
167   :header-rows: 1
168   :widths: 10 12 12 66
169
170
171   * - No.
172     - Name
173     - Type
174     - Function
175   * - 1
176     - GND
177     - P
178     - Ground
179   * - 2
180     - 3V3
181     - P
182     - 3.3 V power supply
183   * - 3
184     - I36
185     - I
186     - GPIO36, ADC1_CH0, RTC_GPIO0
187   * - 4
188     - I37
189     - I
190     - GPIO37, ADC1_CH1, RTC_GPIO1
191   * - 5
192     - I38
193     - I
194     - GPIO38, ADC1_CH2, RTC_GPIO2
195   * - 6
196     - I39
197     - I
198     - GPIO39, ADC1_CH3, RTC_GPIO3
199   * - 7
200     - RST
201     - I
202     - Reset; High: enable; Low: powers off
203   * - 8
204     - I34
205     - I
206     - GPIO34, ADC1_CH6, RTC_GPIO4
207   * - 9
208     - I35
209     - I
210     - GPIO35, ADC1_CH7, RTC_GPIO5
211   * - 10
212     - IO32
213     - I/O
214     - GPIO32, XTAL_32K_P (32.768 kHz crystal oscillator input), ADC1_CH4, TOUCH9, RTC_GPIO9
215   * - 11
216     - IO33
217     - I/O
218     - GPIO33, XTAL_32K_N (32.768 kHz crystal oscillator output), ADC1_CH5, TOUCH8, RTC_GPIO8
219   * - 12
220     - IO25
221     - I/O
222     - GPIO25, DAC_1, ADC2_CH8, RTC_GPIO6, EMAC_RXD0
223   * - 13
224     - IO26
225     - I/O
226     - GPIO26, DAC_2, ADC2_CH9, RTC_GPIO7, EMAC_RXD1
227   * - 14
228     - IO27
229     - I/O
230     - GPIO27, ADC2_CH7, TOUCH7, RTC_GPIO17, EMAC_RX_DV
231   * - 15
232     - IO14
233     - I/O
234     - GPIO14, ADC2_CH6, TOUCH6, RTC_GPIO16, MTMS, HSPICLK, HS2_CLK, SD_CLK, EMAC_TXD2
235   * - 16
236     - 5V
237     - P
238     - 5 V power supply
239   * - 17
240     - IO12
241     - I/O
242     - GPIO12, ADC2_CH5, TOUCH5, RTC_GPIO15, MTDI, HSPIQ, HS2_DATA2, SD_DATA2, EMAC_TXD3
243   * - 18
244     - IO13
245     - I/O
246     - GPIO13, ADC2_CH4, TOUCH4, RTC_GPIO14, MTCK, HSPID, HS2_DATA3, SD_DATA3, EMAC_RX_ER
247   * - 19
248     - IO15
249     - I/O
250     - GPIO15, ADC2_CH3, TOUCH3, RTC_GPIO13, MTDO, HSPICS0, HS2_CMD, SD_CMD, EMAC_RXD3
251   * - 20
252     - IO2
253     - I/O
254     - GPIO2, ADC2_CH2, TOUCH2, RTC_GPIO12, HSPIWP, HS2_DATA0, SD_DATA0
255   * - 21
256     - IO0
257     - I/O
258     - GPIO0, ADC2_CH1, TOUCH1, RTC_GPIO11, CLK_OUT1, EMAC_TX_CLK
259   * - 22
260     - IO4
261     - I/O
262     - GPIO4, ADC2_CH0, TOUCH0, RTC_GPIO10, HSPIHD, HS2_DATA1, SD_DATA1, EMAC_TX_ER
263   * - 23
264     - IO9
265     - I/O
266     - GPIO9, HS1_DATA2, U1RXD, SD_DATA2
267   * - 24
268     - IO10
269     - I/O
270     - GPIO10, HS1_DATA3, U1TXD, SD_DATA3
271   * - 25
272     - IO5
273     - I/O
274     - GPIO5, HS1_DATA6, VSPICS0, EMAC_RX_CLK
275   * - 26
276     - IO18
277     - I/O
278     - GPIO18, HS1_DATA7, VSPICLK
279   * - 27
280     - IO23
281     - I/O
282     - GPIO23, HS1_STROBE, VSPID
283   * - 28
284     - IO19
285     - I/O
286     - GPIO19, VSPIQ, U0CTS, EMAC_TXD0
287   * - 29
288     - IO22
289     - I/O
290     - GPIO22, VSPIWP, U0RTS, EMAC_TXD1
291   * - 30
292     - IO21
293     - I/O
294     - GPIO21, VSPIHD, EMAC_TX_EN
295   * - 31
296     - TXD0
297     - I/O
298     - GPIO1, U0TXD, CLK_OUT3, EMAC_RXD2
299   * - 32
300     - RXD0
301     - I/O
302     - GPIO3, U0RXD, CLK_OUT2
303
304
305Hardware Revision Details
306============================
307
308No previous versions available.
309
310
311Related Documents
312============================
313
314* `ESP32-MINI-1 & ESP32-MINI-1U Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32-mini-1_datasheet_en.pdf>`_ (PDF)
315* `ESP32-DevKitM-1 Schematics <https://dl.espressif.com/dl/schematics/SCH_ESP32-DEVKITM-1_V1_20200910A.pdf>`_ (PDF)
316* `ESP32-DevKitM-1 PCB layout <https://dl.espressif.com/dl/schematics/PCB_ESP32-DevKitM-1_V1_20200910AE.pdf>`_ (PDF)
317* `ESP32-DevKitM-1 layout <https://dl.espressif.com/dl/schematics/ESP32-DevKitM-1_V1.dxf>`_ (DXF) - You can view it with `Autodesk Viewer <https://viewer.autodesk.com/>`_ online
318* `ESP32 Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf>`_ (PDF)
319* `ESP Product Selector <https://products.espressif.com/#/product-selector?names=>`_
320
321For other design documentation for the board, please contact us at sales@espressif.com.