provide user guide for ESP32-DevKitM-1

This commit is contained in:
Dai Zi Yan 2021-01-05 12:32:08 +08:00 committed by Krzysztof Budzynski
parent 56cdf4268f
commit 703aef654b
8 changed files with 639 additions and 0 deletions

BIN
docs/_static/esp32-DevKitM-1-front.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.1 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.2 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 162 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 497 KiB

View File

@ -93,6 +93,7 @@ If you have one of {IDF_TARGET_NAME} development boards listed below, you can cl
ESP32-DevKit-S(-R) <../hw-reference/esp32/user-guide-devkits-r-v1.1>
ESP32-PICO-KIT-1 <../hw-reference/esp32/get-started-pico-kit-1>
ESP32-PICO-DevKitM-2 <../hw-reference/esp32/get-started-pico-devkitm-2>
ESP32-DevKitM-1 <../hw-reference/esp32/user-guide-devkitm-1>
.. only:: esp32s2

View File

@ -0,0 +1,319 @@
===================
ESP32-DevKitM-1
===================
:link_to_translation:`zh_CN:[中文]`
This user guide will help you get started with ESP32-DevKitM-1 and will also provide more in-depth information.
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.
+---------------------------+-------------------------------+
| |ESP32-DevKitM-1 - front| | |ESP32-DevKitM-1 - isometric| |
+---------------------------+-------------------------------+
| ESP32-DevKitM-1 - front | ESP32-DevKitM-1 - isometric |
+---------------------------+-------------------------------+
.. |ESP32-DevKitM-1 - front| image:: ../../../_static/esp32-DevKitM-1-front.png
.. |ESP32-DevKitM-1 - isometric| image:: ../../../_static/esp32-DevKitM-1-isometric.png
The document consists of the following major sections:
- `Getting started`_: Provides an overview of the ESP32-DevKitM-1 and hardware/software setup instructions to get started.
- `Hardware reference`_: Provides more detailed information about the ESP32-DevKitM-1's hardware.
- `Related Documents`_: Gives links to related documentaiton.
Getting Started
===================
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.
Overview
-------------
This is a small and convenient development board that features:
- `ESP32-MINI-1 module <https://www.espressif.com/sites/default/files/documentation/esp32-mini-1_datasheet_en.pdf>`_
- 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
Contents and Packaging
--------------------------
Retail orders
^^^^^^^^^^^^^^^^^^^^^^^^^^
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.
For retail orders, please go to https://www.espressif.com/en/company/contact/buy-a-sample.
Wholesale Orders
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you order in bulk, the boards come in large cardboard boxes.
For wholesale orders, please check `Espressif Product Ordering Information <https://www.espressif.com/sites/default/files/documentation/espressif_products_ordering_information_en.pdf>`_ (PDF)
Description of Components
----------------------------
The following figure and the table below describe the key components, interfaces and controls of the ESP32-DevKitM-1 board.
.. figure:: ../../../_static/esp32-devkitm-1-v1-annotated-photo.png
:align: center
:alt: ESP32-DevKitM-1 - front
:figclass: align-center
ESP32-DevKitM-1 - front
.. list-table::
:widths: 25 75
:header-rows: 1
* - Key Component
- Description
* - ESP32-MINI-1
- 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>`_.
* - 5 V to 3.3 V LDO
- Power regulator converts 5 V to 3.3 V.
* - Boot Button
- Download button. Holding down **Boot** and then pressing **Reset** initiates Firmware Download mode for downloading firmware through the serial port.
* - Reset Button
- Reset Button
* - Micro-USB Port
- USB interface. Power supply for the board as well as the communication interface between a computer and the ESP32 chip.
* - USB-to-UART Bridge
- Single USB-UART bridge chip provides transfer rates up to 3 Mbps.
* - 3.3 V Power On LED
- Turns on when the USB is connected to the board. For details, please see the schematics in `Related Documents`_.
* - I/O Connector
- 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.
Start Application Development
----------------------------------
Before powering up your ESP32-DevKitM-1, please make sure that it is in good condition with no obvious signs of damage.
Required Hardware
^^^^^^^^^^^^^^^^^^^^^^
- ESP32-DevKitM-1
- USB 2.0 cable (Standard-A to Micro-B)
- Computer running Windows, Linux, or macOS
Software Setup
^^^^^^^^^^^^^^^^^^^^^
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.
Hardware Reference
======================
Block Diagram
----------------------
A block diagram below shows the components of ESP32-DevKitM-1 and their interconnections.
.. figure:: ../../../_static/esp32-DevKitM-1_v1_SystemBlock.png
:align: center
:alt: ESP32-DevKitM-1
:figclass: align-center
ESP32-DevKitM-1
Power Source Select
----------------------
There are three mutually exclusive ways to provide power to the board:
* Micro USB port, default power supply
* 5V and GND header pins
* 3V3 and GND header pins
.. warning::
- 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.
- Power supply by micro USB port is recommended.
Pin Descriptions
-------------------
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`_.
.. list-table::
:header-rows: 1
:widths: 10 12 12 66
* - No.
- Name
- Type
- Function
* - 1
- GND
- P
- Ground
* - 2
- 3V3
- P
- 3.3 V power supply
* - 3
- I36
- I
- GPIO36, ADC1_CH0, RTC_GPIO0
* - 4
- I37
- I
- GPIO37, ADC1_CH1, RTC_GPIO1
* - 5
- I38
- I
- GPIO38, ADC1_CH2, RTC_GPIO2
* - 6
- I39
- I
- GPIO39, ADC1_CH3, RTC_GPIO3
* - 7
- RST
- I
- Reset; High: enable; Low: powers off
* - 8
- I34
- I
- GPIO34, ADC1_CH6, RTC_GPIO4
* - 9
- I35
- I
- GPIO35, ADC1_CH7, RTC_GPIO5
* - 10
- IO32
- I/O
- GPIO32, XTAL_32K_P (32.768 kHz crystal oscillator input), ADC1_CH4, TOUCH9, RTC_GPIO9
* - 11
- IO33
- I/O
- GPIO33, XTAL_32K_N (32.768 kHz crystal oscillator output), ADC1_CH5, TOUCH8, RTC_GPIO8
* - 12
- IO25
- I/O
- GPIO25, DAC_1, ADC2_CH8, RTC_GPIO6, EMAC_RXD0
* - 13
- IO26
- I/O
- GPIO26, DAC_2, ADC2_CH9, RTC_GPIO7, EMAC_RXD1
* - 14
- IO27
- I/O
- GPIO27, ADC2_CH7, TOUCH7, RTC_GPIO17, EMAC_RX_DV
* - 15
- IO14
- I/O
- GPIO14, ADC2_CH6, TOUCH6, RTC_GPIO16, MTMS, HSPICLK, HS2_CLK, SD_CLK, EMAC_TXD2
* - 16
- 5V
- P
- 5 V power supply
* - 17
- IO12
- I/O
- GPIO12, ADC2_CH5, TOUCH5, RTC_GPIO15, MTDI, HSPIQ, HS2_DATA2, SD_DATA2, EMAC_TXD3
* - 18
- IO13
- I/O
- GPIO13, ADC2_CH4, TOUCH4, RTC_GPIO14, MTCK, HSPID, HS2_DATA3, SD_DATA3, EMAC_RX_ER
* - 19
- IO15
- I/O
- GPIO15, ADC2_CH3, TOUCH3, RTC_GPIO13, MTDO, HSPICS0, HS2_CMD, SD_CMD, EMAC_RXD3
* - 20
- IO2
- I/O
- GPIO2, ADC2_CH2, TOUCH2, RTC_GPIO12, HSPIWP, HS2_DATA0, SD_DATA0
* - 21
- IO0
- I/O
- GPIO0, ADC2_CH1, TOUCH1, RTC_GPIO11, CLK_OUT1, EMAC_TX_CLK
* - 22
- IO4
- I/O
- GPIO4, ADC2_CH0, TOUCH0, RTC_GPIO10, HSPIHD, HS2_DATA1, SD_DATA1, EMAC_TX_ER
* - 23
- IO9
- I/O
- GPIO9, HS1_DATA2, U1RXD, SD_DATA2
* - 24
- IO10
- I/O
- GPIO10, HS1_DATA3, U1TXD, SD_DATA3
* - 25
- IO5
- I/O
- GPIO5, HS1_DATA6, VSPICS0, EMAC_RX_CLK
* - 26
- IO18
- I/O
- GPIO18, HS1_DATA7, VSPICLK
* - 27
- IO23
- I/O
- GPIO23, HS1_STROBE, VSPID
* - 28
- IO19
- I/O
- GPIO19, VSPIQ, U0CTS, EMAC_TXD0
* - 29
- IO22
- I/O
- GPIO22, VSPIWP, U0RTS, EMAC_TXD1
* - 30
- IO21
- I/O
- GPIO21, VSPIHD, EMAC_TX_EN
* - 31
- TXD0
- I/O
- GPIO1, U0TXD, CLK_OUT3, EMAC_RXD2
* - 32
- RXD0
- I/O
- GPIO3, U0RXD, CLK_OUT2
Hardware Revision Details
============================
No previous versions available.
Related Documents
============================
* `ESP32-MINI-1 Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32-mini-1_datasheet_en.pdf>`_ (PDF)
* `ESP32-DevKitM-1 Schematics <https://dl.espressif.com/dl/schematics/SCH_ESP32-DEVKITM-1_V1_20200910A.pdf>`_ (PDF)
* `ESP32-DevKitM-1 PCB layout <https://dl.espressif.com/dl/schematics/PCB_ESP32-DevKitM-1_V1_20200910AE.pdf>`_ (PDF)
* `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
* `Espressif Product Ordering Information <https://www.espressif.com/sites/default/files/documentation/espressif_products_ordering_information_en.pdf>`_ (PDF)
* `ESP32 Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf>`_ (PDF)
For other design documentation for the board, please contact us at sales@espressif.com.

View File

@ -91,6 +91,7 @@
ESP32-DevKit-S(-R) <../hw-reference/esp32/user-guide-devkits-r-v1.1>
ESP32-PICO-KIT-1 <../hw-reference/esp32/get-started-pico-kit-1>
ESP32-PICO-DevKitM-2 <../hw-reference/esp32/get-started-pico-devkitm-2>
ESP32-DevKitM-1 <../hw-reference/esp32/user-guide-devkitm-1>
.. only:: esp32s2

View File

@ -0,0 +1,318 @@
===================
ESP32-DevKitM-1
===================
:link_to_translation:`en: [English]`
本指南将介绍如何使用 ESP32-DevKitM-1并提供更多关于此开发板的信息。
ESP32-DevKitM-1 是乐鑫推出的一款基于 ESP32-MINI-1 模组的入门级开发板。板上模组大部分管脚均已引出至两侧排针,用户可根据实际需求,通过跳线轻松连接多种外围设备,同时也可将开发板插在面包板上使用。
+------------------------+-------------------------+
| |ESP32-DevKitM-1-正面| | |ESP32-DevKitM-1-侧面| |
+------------------------+-------------------------+
| ESP32-DevKitM-1-正面 | ESP32-DevKitM-1-侧面 |
+------------------------+-------------------------+
.. |ESP32-DevKitM-1-正面| image:: ../../../_static/esp32-DevKitM-1-front.png
.. |ESP32-DevKitM-1-侧面| image:: ../../../_static/esp32-DevKitM-1-isometric.png
本指南包括:
- `快速入门`_:提供 ESP32-DevKitM-1 的简要概述及必要的硬件和软件信息。
- `硬件参考`_:提供 ESP32-DevKitM-1 的详细硬件信息。
- `相关文档`_:提供相关文档的链接。
快速入门
===========
本节介绍如何开始使用 ESP32-DevKitM-1主要包括三大部分首先介绍一些关于 ESP32-DevKitM-1 的基本信息,然后在 `应用程序开发`_ 章节介绍如何进行硬件初始化,最后介绍如何为 ESP32-DevKitM-1 烧录固件。
概述
-------
ESP32-DevKitM-1 开发板是一款小巧实用的开发板,具备以下特色功能:
- 集成了 `ESP32-MINI-1 <https://www.espressif.com/sites/default/files/documentation/esp32-mini-1_datasheet_cn.pdf>`_ 模组
- USB 转串口编程接口同时可为开发板供电
- 设有排针
- 设有重置按钮和固件下载模式激活按钮
- 以及其他组件
内含组件和包装
---------------
零售订单
^^^^^^^^^^^
如购买样品,每个 ESP32-DevKitM-1 底板将以防静电袋或零售商选择的其他方式包装。
零售订单请前往 https://www.espressif.com/zh-hans/company/contact/buy-a-sample。
批量订单
^^^^^^^^^^^
如批量购买ESP32-DevKitM-1 烧录底板将以大纸板箱包装。
批量订单请参考 `乐鑫产品订购信息 <https://www.espressif.com/sites/default/files/documentation/espressif_products_ordering_information_cn.pdf>`__ (PDF)。
组件介绍
-----------
ESP32-DevKitM-1 开发板的主要组件、接口及控制方式见下。
.. figure:: ../../../_static/esp32-devkitm-1-v1-annotated-photo.png
:align: center
:alt: ESP32-DevKitM-1 - 正面
:figclass: align-center
ESP32-DevKitM-1 - 正面
.. list-table::
:widths: 25 75
:header-rows: 1
* - 主要组件
- 基本介绍
* - ESP32-MINI-1
- ESP32-MINI-14MB FlashPCB Antenna模组。更多详情请见 `《ESP32-MINI-1 技术规格书》 <https://www.espressif.com/sites/default/files/documentation/esp32-mini-1_datasheet_cn.pdf>`_
* - 5 V 转 3.3 V LDO
- 电源转换器,输入 5 V输出 3.3 V
* - Boot 键
- 下载按键。按下 **Boot** 键的同时按一下 **Reset** 键进入“固件下载”模式,通过串口下载固件
* - Reset 键
- 复位按键
* - Micro-USB 接口
- USB 接口,可用作开发板的供电电源或 PC 和 ESP32 芯片的通信接口
* - USB 至 UART 桥接器
- 单芯片 USB 至 UART 桥接器,可提供高达 3 Mbps 的传输速率
* - 3.3 V 电源指示灯
- 开发板连接 USB 电源后,该指示灯亮起。更多信息,请见 `相关文档`_ 中的原理图
* - I/O 连接器
- 所有可用 GPIO 管脚(除 Flash 的 SPI 总线)均已引出至开发板的排针。用户可对 ESP32 芯片编程,开发多种功能
应用程序开发
---------------
ESP32-DevKitM-1 上电前,请首先确认开发板完好无损。
硬件准备
^^^^^^^^^^^^
- ESP32-DevKitM-1 开发板
- USB A / micro USB B 数据线
- PCWindows、Linux 或 Mac OS
软件设置
^^^^^^^^^^^
现在,请前往 :doc:`../../get-started/index` 中的 :ref:`get-started-step-by-step` 章节,查看如何设置开发环境,并尝试将示例项目烧录至您的开发板。
硬件参考
===========
功能框图
----------
ESP32-DevKitM-1 的主要组件和连接方式如下图所示。
.. figure:: ../../../_static/esp32-DevKitM-1_v1_SystemBlock.png
:align: center
:alt: ESP32-DevKitM-1
:figclass: align-center
ESP32-DevKitM-1
电源选项
----------
开发板可从以下三种供电方式中任选其一:
* Micro USB 供电(默认)
* 5V / GND 管脚供电
* 3V3 / GND 管脚供电
.. warning::
- 上述供电模式 **不可同时连接**,否则可能会损坏开发板和/或电源。
- 建议选择第一种供电方式Micro USB 端口供电。
管脚描述
----------
开发板两侧 I/O 管脚,其具体名称和功能见下表。外设管脚分配请参考 `《ESP32 技术规格书》`_
.. list-table::
:header-rows: 1
:widths: 10 12 12 66
* - 编号
- 名称
- 类型
- 功能
* - 1
- GND
- P
- 接地
* - 2
- 3V3
- P
- 3.3 V 电源
* - 3
- I36
- I
- GPIO36, ADC1_CH0, RTC_GPIO0
* - 4
- I37
- I
- GPIO37, ADC1_CH1, RTC_GPIO1
* - 5
- I38
- I
- GPIO38, ADC1_CH2, RTC_GPIO2
* - 6
- I39
- I
- GPIO39, ADC1_CH3, RTC_GPIO3
* - 7
- RST
- I
- 复位;高电平:使能;低电平:关闭
* - 8
- I34
- I
- GPIO34, ADC1_CH6, RTC_GPIO4
* - 9
- I35
- I
- GPIO35, ADC1_CH7, RTC_GPIO5
* - 10
- IO32
- I/O
- GPIO32, XTAL_32K_P (32.768 kHz crystal oscillator input), ADC1_CH4, TOUCH9, RTC_GPIO9
* - 11
- IO33
- I/O
- GPIO33, XTAL_32K_N (32.768 kHz crystal oscillator output), ADC1_CH5, TOUCH8, RTC_GPIO8
* - 12
- IO25
- I/O
- GPIO25, DAC_1, ADC2_CH8, RTC_GPIO6, EMAC_RXD0
* - 13
- IO26
- I/O
- GPIO26, DAC_2, ADC2_CH9, RTC_GPIO7, EMAC_RXD1
* - 14
- IO27
- I/O
- GPIO27, ADC2_CH7, TOUCH7, RTC_GPIO17, EMAC_RX_DV
* - 15
- IO14
- I/O
- GPIO14, ADC2_CH6, TOUCH6, RTC_GPIO16, MTMS, HSPICLK, HS2_CLK, SD_CLK, EMAC_TXD2
* - 16
- 5V
- P
- 5 V 电源
* - 17
- IO12
- I/O
- GPIO12, ADC2_CH5, TOUCH5, RTC_GPIO15, MTDI, HSPIQ, HS2_DATA2, SD_DATA2, EMAC_TXD3
* - 18
- IO13
- I/O
- GPIO13, ADC2_CH4, TOUCH4, RTC_GPIO14, MTCK, HSPID, HS2_DATA3, SD_DATA3, EMAC_RX_ER
* - 19
- IO15
- I/O
- GPIO15, ADC2_CH3, TOUCH3, RTC_GPIO13, MTDO, HSPICS0, HS2_CMD, SD_CMD, EMAC_RXD3
* - 20
- IO2
- I/O
- GPIO2, ADC2_CH2, TOUCH2, RTC_GPIO12, HSPIWP, HS2_DATA0, SD_DATA0
* - 21
- IO0
- I/O
- GPIO0, ADC2_CH1, TOUCH1, RTC_GPIO11, CLK_OUT1, EMAC_TX_CLK
* - 22
- IO4
- I/O
- GPIO4, ADC2_CH0, TOUCH0, RTC_GPIO10, HSPIHD, HS2_DATA1, SD_DATA1, EMAC_TX_ER
* - 23
- IO9
- I/O
- GPIO9, HS1_DATA2, U1RXD, SD_DATA2
* - 24
- IO10
- I/O
- GPIO10, HS1_DATA3, U1TXD, SD_DATA3
* - 25
- IO5
- I/O
- GPIO5, HS1_DATA6, VSPICS0, EMAC_RX_CLK
* - 26
- IO18
- I/O
- GPIO18, HS1_DATA7, VSPICLK
* - 27
- IO23
- I/O
- GPIO23, HS1_STROBE, VSPID
* - 28
- IO19
- I/O
- GPIO19, VSPIQ, U0CTS, EMAC_TXD0
* - 29
- IO22
- I/O
- GPIO22, VSPIWP, U0RTS, EMAC_TXD1
* - 30
- IO21
- I/O
- GPIO21, VSPIHD, EMAC_TX_EN
* - 31
- TXD0
- I/O
- GPIO1, U0TXD, CLK_OUT3, EMAC_RXD2
* - 32
- RXD0
- I/O
- GPIO3, U0RXD, CLK_OUT2
硬件修订历史
===============
尚无版本升级历史。
相关文档
============
* `《ESP32-MINI-1 技术规格书》 <https://www.espressif.com/sites/default/files/documentation/esp32-mini-1_datasheet_cn.pdf>`_ (PDF)
* `ESP32-DevKitM-1 原理图 <https://dl.espressif.com/dl/schematics/SCH_ESP32-DEVKITM-1_V1_20200910A.pdf>`_ (PDF)
* `ESP32-DevKitM-1 PCB 布局图 <https://dl.espressif.com/dl/schematics/PCB_ESP32-DevKitM-1_V1_20200910AE.pdf>`_ (PDF)
* `ESP32-DevKitM-1 布局图 <https://dl.espressif.com/dl/schematics/ESP32-DevKitM-1_V1.dxf>`_ (DXF) - 可使用 `Autodesk Viewer <https://viewer.autodesk.com/>`_ 查看
* `乐鑫产品订购信息 <https://www.espressif.com/sites/default/files/documentation/espressif_products_ordering_information_cn.pdf>`_ (PDF)
* `《ESP32 技术规格书》 <https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf>`_ (PDF)
有关本开发板的更多设计文档,请联系我们的商务部门 sales@espressif.com。