user-guide-devkitm-1.rst 9.7 KB

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