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

Add ESP32-C3-DevKitM-1 User Guide and updated ESP32C3_DOCS

Browse Source
This commit is contained in:
Wang Ning 2021-02-05 12:00:40 +08:00
parent fe0c81f67c
commit aa2b3e1b01
9 changed files with 430 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/_static/esp32-c3-devkitm-1-v1-annotated-photo.png vendored Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 280 KiB

BIN
docs/_static/esp32-c3-devkitm-1-v1-block-diagram.png vendored Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 75 KiB

BIN
docs/_static/esp32-c3-devkitm-1-v1-isometric.png vendored Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 231 KiB

BIN
docs/_static/esp32-c3-devkitm-1-v1-pinout.png vendored Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 415 KiB

2
docs/conf_common.py
View File

@ -193,7 +193,7 @@ ESP32S2_DOCS = ['hw-reference/esp32s2/**',
'api-reference/system/async_memcpy.rst',
'api-reference/peripherals/dac.rst']
ESP32C3_DOCS = []
ESP32C3_DOCS = ['hw-reference/esp32c3/**']
# format: {tag needed to include: documents to included}, tags are parsed from sdkconfig and peripheral_caps.h headers
conditional_include_dict = {'SOC_BT_SUPPORTED':BT_DOCS,

7
docs/en/get-started/index.rst
View File

@ -114,10 +114,11 @@ If you have one of {IDF_TARGET_NAME} development boards listed below, you can cl
.. only:: esp32c3
.. note::
No hardware guides for ESP32-C3 published yet.
.. toctree::
:maxdepth: 1
ESP32-C3-DevKitM-1 <../hw-reference/esp32c3/user-guide-devkitm-1>
.. _get-started-step-by-step:
Installation Step by Step

212
docs/en/hw-reference/esp32c3/user-guide-devkitm-1.rst Normal file
View File

@ -0,0 +1,212 @@
==================
ESP32-C3-DevKitM-1
==================
:link_to_translation:`zh_CN:[中文]`
This user guide will help you get started with ESP32-C3-DevKitM-1 and will also provide more in-depth information.
ESP32-C3-DevKitM-1 is an entry-level development board based on `ESP32-C3-MINI-1 <https://www.espressif.com/en/products/modules>`_, a module named for its small size. This board integrates complete Wi-Fi and Bluetooth LE functions.
Most of the I/O pins on the ESP32-C3-MINI-1 module are broken out to the pin headers on both sides of this board for easy interfacing. Developers can either connect peripherals with jumper wires or mount ESP32-C3-DevKitM-1 on a breadboard.
.. figure:: ../../../_static/esp32-c3-devkitm-1-v1-isometric.png
:align: center
:alt: ESP32-C3-DevKitM-1
:figclass: align-center
ESP32-C3-DevKitM-1
The document consists of the following major sections:
- `Getting Started`_: Overview of ESP32-C3-DevKitM-1 and hardware/software setup instructions to get started.
- `Hardware Reference`_: More detailed information about the ESP32-C3-DevKitM-1's hardware.
- `Hardware Revision Details`_: Revision history, known issues, and links to user guides for previous versions (if any) of ESP32-C3-DevKitM-1.
- `Related Documents`_: Links to related documentation.
Getting Started
===============
This section provides a brief introduction of ESP32-C3-DevKitM-1, instructions on how to do the initial hardware setup and how to flash firmware onto it.
Description of Components
-------------------------
.. _user-guide-c3-devkitm-1-v1-board-front:
.. figure:: ../../../_static/esp32-c3-devkitm-1-v1-annotated-photo.png
:align: center
:alt: ESP32-C3-DevKitM-1 - front
:figclass: align-center
ESP32-C3-DevKitM-1 - front
.. list-table::
:widths: 30 70
:header-rows: 1
* - Key Component
- Description
* - ESP32-C3-MINI-1
- ESP32-C3-MINI-1 is a general-purpose Wi-Fi and Bluetooth LE combo module that comes with a PCB antenna. At the core of this module is `ESP32-C3FN4 <https://www.espressif.com/en/products/socs/esp32-c3>`_, a chip that has an embedded flash of 4 MB. Since flash is packaged in the ESP32-C3FN4 chip, rather than integrated into the module, ESP32-C3-MINI-1 has a smaller package size.
* - 5 V to 3.3 V LDO
- Power regulator that converts a 5 V supply into a 3.3 V output.
* - 5 V Power On LED
- Turns on when the USB power is connected to the board.
* - I/O Connector
- All available GPIO pins (except for the SPI bus for flash) are broken out to the pin headers on the board. For details, please see :ref:`user-guide-c3-devkitm-1-v1-header-blocks`.
* - Boot Button
- Download button. Holding down **Boot** and then pressing **Reset** initiates Firmware Download mode for downloading firmware through the serial port.
* - Micro-USB Port
- USB interface. Power supply for the board as well as the communication interface between a computer and the ESP32-C3FN4 chip.
* - Reset Button
- Press this button to restart the system.
* - USB to UART Bridge
- Single USB-UART bridge chip provides transfer rates up to 3 Mbps.
* - RGB LED
- Addressable RGB LED (WS2812), driven by GPIO8.
Start Application Development
-----------------------------
Before powering up your ESP32-C3-DevKitM-1, please make sure that it is in good condition with no obvious signs of damage.
Required Hardware
^^^^^^^^^^^^^^^^^
- ESP32-C3-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-C3-DevKitM-1.
Contents and Packaging
----------------------
Retail Orders
^^^^^^^^^^^^^
If you order one or several samples, each ESP32-C3-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).
Hardware Reference
==================
Block Diagram
-------------
The block diagram below shows the components of ESP32-C3-DevKitM-1 and their interconnections.
.. figure:: ../../../_static/esp32-c3-devkitm-1-v1-block-diagram.png
:align: center
:scale: 70%
:alt: ESP32-C3-DevKitM-1 (click to enlarge)
:figclass: align-center
ESP32-C3-DevKitM-1 (click to enlarge)
Power Supply Options
^^^^^^^^^^^^^^^^^^^^
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
It is recommended to use the first option: micro USB port.
.. _user-guide-c3-devkitm-1-v1-header-blocks:
Header Block
------------
The two tables below provide the **Name** and **Function** of I/O header pins on both sides of the board, as shown in :ref:`user-guide-c3-devkitm-1-v1-board-front`. The numbering and names are the same as in the `ESP32-C3-DevKitM-1 Schematic <https://dl.espressif.com/dl/schematics/SCH_ESP32-C3-DEVKITM-1_V1_20200915A.pdf>`_ (PDF).
J1
^^^
=== ==== ===== ===================================
No. Name Type Function
=== ==== ===== ===================================
1 GND G Ground
2 3V3 P 3.3 V power supply
3 3V3 P 3.3 V power supply
4 IO2 I/O/T GPIO2, ADC1_CH2, FSPIQ
5 IO3 I/O/T GPIO3, ADC1_CH3
6 GND G Ground
7 RST I CHIP_PU
8 GND G Ground
9 IO0 I/O/T GPIO0, ADC1_CH0, XTAL_32K_P
10 IO1 I/O/T GPIO1, ADC1_CH1, XTAL_32K_N
11 IO10 I/O/T GPIO10, FSPICS0
12 GND G Ground
13 5V P 5 V power supply
14 5V P 5 V power supply
15 GND G Ground
=== ==== ===== ===================================
J3
^^^
=== ==== ===== ====================================
No. Name Type Function
=== ==== ===== ====================================
1 GND G Ground
2 TX I/O/T GPIO21, U0TXD
3 RX I/O/T GPIO20, U0RXD
4 GND G Ground
5 IO9 I/O/T GPIO9
6 IO8 I/O/T GPIO8
7 GND G Ground
8 IO7 I/O/T GPIO7, FSPID, MTDO
9 IO6 I/O/T GPIO6, FSPICLK, MTCK
10 IO5 I/O/T GPIO5, ADC2_CH0, FSPIWP, MTDI
11 IO4 I/O/T GPIO4, ADC1_CH4, FSPIHD, MTMS
12 GND G Ground
13 IO18 I/O/T GPIO18
14 IO19 I/O/T GPIO19
15 GND G Ground
=== ==== ===== ====================================
P: Power supply;
I: Input;
O: Output;
T: High impedance.
Pin Layout
^^^^^^^^^^^
.. figure:: ../../../_static/esp32-c3-devkitm-1-v1-pinout.png
:align: center
:alt: ESP32-C3-DevKitM-1
:figclass: align-center
ESP32-C3-DevKitM-1 Pin Layout
Hardware Revision Details
=========================
No previous versions available.
Related Documents
=================
* `ESP32-C3 Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32-c3_datasheet_en.pdf>`_ (PDF)
* `ESP32-C3-MINI-1 Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32-c3-mini-1_datasheet_en.pdf>`_ (PDF)
* `ESP32-C3-DevKitM-1 Schematic <https://dl.espressif.com/dl/schematics/SCH_ESP32-C3-DEVKITM-1_V1_20200915A.pdf>`_ (PDF)
* `ESP32-C3-DevKitM-1 PCB Layout <https://dl.espressif.com/dl/schematics/PCB_ESP32-C3-DEVKITM-1_V1_20200915AA.pdf>`_ (PDF)
* `ESP32-C3-DevKitM-1 Dimensions <https://dl.espressif.com/dl/schematics/DIMENSION_ESP32-C3-DEVKITM-1_V1_20200915AA.pdf>`_ (PDF)
* `ESP32-C3-DevKitM-1 Dimensions source file <https://dl.espressif.com/dl/schematics/DIMENSION_ESP32-C3-DEVKITM-1_V1_20200915AA.dxf>`_ (DXF) - You can view it with `Autodesk Viewer <https://viewer.autodesk.com/>`_ online
For further design documentation for the board, please contact us at `sales@espressif.com <sales@espressif.com>`_.

5
docs/zh_CN/get-started/index.rst
View File

@ -114,9 +114,10 @@
.. only:: esp32c3
.. note::
.. toctree::
:maxdepth: 1
有关 ESP32-C3 的硬件指南尚未发布。
ESP32-C3-DevKitM-1 <../hw-reference/esp32c3/user-guide-devkitm-1>
.. _get-started-step-by-step:

210
docs/zh_CN/hw-reference/esp32c3/user-guide-devkitm-1.rst Normal file
View File

@ -0,0 +1,210 @@
==================
ESP32-C3-DevKitM-1
==================
:link_to_translation:`en: [English]`
本指南将帮助您快速上手 ESP32-C3-DevKitM-1，并提供该款开发板的详细信息。
ESP32-C3-DevKitM-1 是一款入门级开发板，使用以尺寸小而得名的 `ESP32-C3-MINI-1 <https://www.espressif.com/zh-hans/products/modules>`_ 模组。该款开发板具备完整的 Wi-Fi 和低功耗蓝牙功能。
板上模组大部分管脚均已引出至两侧排针，开发人员可根据实际需求，轻松通过跳线连接多种外围设备，同时也可将开发板插在面包板上使用。
.. figure:: ../../../_static/esp32-c3-devkitm-1-v1-isometric.png
:align: center
:alt: ESP32-C3-DevKitM-1
:figclass: align-center
ESP32-C3-DevKitM-1
本指南包括如下内容：
- `入门指南`_: 简要介绍了 ESP32-C3-DevKitM-1 和硬件、软件设置指南。
- `硬件参考`_: 详细介绍了 ESP32-C3-DevKitM-1 的硬件。
- `硬件版本`_：介绍硬件历史版本和已知问题，并提供链接至历史版本开发板的入门指南（如有）。
- `相关文档`_: 列出了相关文档的链接。
入门指南
========
本小节将简要介绍 ESP32-C3-DevKitM-1，说明如何在 ESP32-C3-DevKitM-1 上烧录固件及相关准备工作。
组件介绍
--------
.. _user-guide-c3-devkitm-1-v1-board-front:
.. figure:: ../../../_static/esp32-c3-devkitm-1-v1-annotated-photo.png
:align: center
:alt: ESP32-C3-DevKitM-1 - 正面
:figclass: align-center
ESP32-C3-DevKitM-1 - 正面
.. list-table::
:widths: 30 70
:header-rows: 1
* - 主要组件
- 介绍
* - ESP32-C3-MINI-1
- ESP32-C3-MINI-1 是一款通用型 Wi-Fi 和低功耗蓝牙双模模组，采用 PCB 板载天线。该款模组集成配置 4 MB 嵌入式 flash 的 `ESP32-C3FN4 <https://www.espressif.com/zh-hans/products/socs/esp32-c3>`_ 芯片。由于 flash 直接封装在芯片中，ESP32-C3-MINI-1 模组具有更小的封装尺寸。
* - 5 V 转 3.3 V LDO
- 电源转换器，输入 5 V，输出 3.3 V。
* - 5 V 电源指示灯
- 开发板连接 USB 电源后，该指示灯亮起。
* - I/O 连接器
- 所有可用 GPIO 管脚（除 flash 的 SPI 总线）均已引出至开发板的排针。请查看 :ref:`user-guide-c3-devkitm-1-v1-header-blocks` 获取更多信息。
* - Boot 键
- 下载按键。按住 **Boot** 键的同时按一下 **Reset** 键进入“固件下载”模式，通过串口下载固件。
* - Micro-USB 接口
- USB 接口。可用作开发板的供电电源或 PC 和 ESP32-C3FN4 芯片的通信接口。
* - Reset 键
- 复位按键。
* - USB 至 UART 桥接器
- 单芯片 USB 至 UART 桥接器，可提供高达 3 Mbps 的传输速率。
* - RGB LED
- 可寻址 RGB 发光二极管 (WS2812)，由 GPIO8 驱动。
开始开发应用
------------
通电前，请确保 ESP32-C3-DevKitM-1 完好无损。
必备硬件
^^^^^^^^
- ESP32-C3-DevKitM-1
- USB 2.0 数据线（标准 A 型转 Micro-B型）
- 电脑 （Windows、Linux 或 macOS）
软件设置
^^^^^^^^
请前往 :doc:`../../get-started/index`，在 :ref:`get-started-step-by-step` 小节查看如何快速设置开发环境，将应用程序烧录至 ESP32-C3-DevKitM-1。
内含组件和包装
--------------
零售订单
^^^^^^^^
如购买样品，每个 ESP32-C3-DevKitM-1 底板将以防静电袋或零售商选择的其他方式包装。
零售订单请前往 https://www.espressif.com/zh-hans/company/contact/buy-a-sample。
批量订单
^^^^^^^^
如批量购买，ESP32-C3-DevKitM-1 烧录底板将以大纸板箱包装。
批量订单请参考 `乐鑫产品订购信息 <https://www.espressif.com/sites/default/files/documentation/espressif_products_ordering_information_cn.pdf>`__ (PDF)。
硬件参考
========
功能框图
--------
ESP32-C3-DevKitM-1 的主要组件和连接方式如下图所示。
.. figure:: ../../../_static/esp32-c3-devkitm-1-v1-block-diagram.png
:align: center
:scale: 70%
:alt: ESP32-C3-DevKitM-1 （点击放大）
:figclass: align-center
ESP32-C3-DevKitM-1 （点击放大）
电源选项
^^^^^^^^
您可从以下三种供电方式中任选其一给 ESP32-C3-DevKitM-1 供电：
- Micro USB 端口供电（默认）
- 5V 和 GND 管脚供电
- 3V3 和 GND 管脚供电
建议选择第一种供电方式：Micro USB 端口供电。
.. _user-guide-c3-devkitm-1-v1-header-blocks:
排针
----
下表列出了开发板两侧排针的 **名称** 和 **功能**，开发板排针图可前往 :ref:`user-guide-c3-devkitm-1-v1-board-front` 查看。表格中的序号和名称与 `ESP32-C3-DevKitM-1 原理图 <https://dl.espressif.com/dl/schematics/SCH_ESP32-C3-DEVKITM-1_V1_20200915A.pdf>`_ (PDF)一致。
J1
^^^
==== ==== ===== ================================
序号 名称 类型 功能
==== ==== ===== ================================
1 GND G 接地
2 3V3 P 3.3 V 电源
3 3V3 P 3.3 V 电源
4 IO2 I/O/T GPIO2, ADC1_CH2, FSPIQ
5 IO3 I/O/T GPIO3, ADC1_CH3
6 GND G 接地
7 RST I CHIP_PU
8 GND G 接地
9 IO1 I/O/T GPIO1, ADC1_CH1, XTAL_32K_N
11 IO10 I/O/T GPIO10, FSPICS0
12 GND G 接地
13 5V P 5 V 电源
14 5V P 5 V 电源
15 GND G 接地
==== ==== ===== ================================
J3
^^^
==== ==== ===== ================================
序号 名称 类型 功能
==== ==== ===== ================================
1 GND G 接地
2 TX I/O/T GPIO21, U0TXD
3 RX I/O/T GPIO20, U0RXD
4 GND G 接地
5 IO9 I/O/T GPIO9
6 IO8 I/O/T GPIO8
7 GND G 接地
8 IO7 I/O/T GPIO7, FSPID, MTDO
9 IO6 I/O/T GPIO6, FSPICLK, MTCK
10 IO5 I/O/T GPIO5, ADC2_CH0, FSPIWP, MTDI
11 IO4 I/O/T GPIO4, ADC1_CH4, FSPIHD, MTMS
12 GND G 接地
13 IO18 I/O/T GPIO18
14 IO19 I/O/T GPIO19
15 GND G 接地
==== ==== ===== ================================
P：电源；
I：输入：
O：输出；
T：可设置为高阻。
管脚布局
^^^^^^^^
.. figure:: ../../../_static/esp32-c3-devkitm-1-v1-pinout.png
:align: center
:alt: ESP32-C3-DevKitM-1 管脚布局
:figclass: align-center
ESP32-C3-DevKitM-1 管脚布局
硬件版本
==========
该开发板为最新硬件，尚未有历史版本。
相关文档
========
* `ESP32-C3 技术规格书 <https://www.espressif.com/sites/default/files/documentation/esp32-c3_datasheet_cn.pdf>`_ (PDF)
* `ESP32-C3-MINI-1 规格书 <https://www.espressif.com/sites/default/files/documentation/esp32-c3-mini-1_datasheet_cn.pdf>`_ (PDF)
* `ESP32-C3-DevKitM-1 原理图 <https://dl.espressif.com/dl/schematics/SCH_ESP32-C3-DEVKITM-1_V1_20200915A.pdf>`_ (PDF)
* `ESP32-C3-DevKitM-1 PCB 布局图 <https://dl.espressif.com/dl/schematics/PCB_ESP32-C3-DEVKITM-1_V1_20200915AA.pdf>`_ (PDF)
* `ESP32-C3-DevKitM-1 尺寸图 <https://dl.espressif.com/dl/schematics/DIMENSION_ESP32-C3-DEVKITM-1_V1_20200915AA.dxf>`_ (PDF)
* `ESP32-C3-DevKitM-1 尺寸图源文件 <https://dl.espressif.com/dl/schematics/DIMENSION_ESP32-C3-DEVKITM-1_V1_20200915AA.dxf>`_ (DXF) - 可使用 `Autodesk Viewer <https://viewer.autodesk.com/>`_ 查看
有关本开发板的更多设计文档，请联系我们的商务部门 `sales@espressif.com <sales@espressif.com>`_。