alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-09-20 00:36:01 -04:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

Merge branch 'docs/update_two_c3_devkit_user_guides' into 'master'

Browse Source 
Docs/Update two ESP32-C3 devkit user guides

See merge request espressif/esp-idf!15261
This commit is contained in:
Wang Ning 2021-09-18 11:20:53 +00:00
commit d5877fdf37
6 changed files with 45 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/_static/esp32-c3-devkitc-02-v1-annotated-photo.png vendored
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 311 KiB

After

Width:  |  Height:  |  Size: 377 KiB

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

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 280 KiB

After

Width:  |  Height:  |  Size: 341 KiB

12
docs/en/hw-reference/esp32c3/user-guide-devkitc-02.rst
View File

@ -41,6 +41,8 @@ Description of Components
ESP32-C3-DevKitC-02 - front
The key components of the board are described in a counter-clockwise direction.
.. list-table::
:widths: 30 70
:header-rows: 1
@ -53,7 +55,7 @@ Description of Components
- 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
* - Pin Headers
- 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-devkitc-02-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.
@ -81,7 +83,7 @@ Required Hardware
.. note::
Be sure to use a good quality USB cable. Some cables are for charging only and do not provide the needed data lines nor work for programming the boards.
Be sure to use an appropriate USB cable. Some cables are for charging only and do not provide the needed data lines nor work for programming the boards.
Software Setup
^^^^^^^^^^^^^^
@ -127,11 +129,11 @@ Power Supply Options
There are three mutually exclusive ways to provide power to the board:
- Micro-USB port, default power supply
- Micro-USB Port, default power supply
- 5V and GND pin headers
- 3V3 and GND pin headers
It is recommended to use the first option: micro-USB port.
It is recommended to use the first option: Micro-USB Port.
.. _user-guide-c3-devkitc-02-v1-header-blocks:
@ -185,7 +187,7 @@ No. Name Type [1]_ Function
=== ==== ========== ====================================
.. [1] P: Power supply; I: Input; O: Output; T: High impedance.
.. [2] GPIO2, GPIO8, and GPIO9 are strapping pins of the ESP32-C3 chip. During the chip's system reset, the latches of the strapping pins sample the voltage level as strapping bits, and hold these bits until the chip is powered down or shut down. For description and application of strapping pins, please refer to Section Strapping Pins in `ESP32-C3 Datasheet`_.
.. [2] GPIO2, GPIO8, and GPIO9 are strapping pins of the ESP32-C3 chip. These pins are used to control several chip functions depending on binary voltage values applied to the pins during chip power-up or system reset. For description and application of the strapping pins, please refer to Section Strapping Pins in `ESP32-C3 Datasheet`_.
Pin Layout
^^^^^^^^^^^

18
docs/en/hw-reference/esp32c3/user-guide-devkitm-1.rst
View File

@ -42,6 +42,8 @@ Description of Components
ESP32-C3-DevKitM-1 - front
The key components of the board are described in a counter-clockwise direction.
.. list-table::
:widths: 30 70
:header-rows: 1
@ -54,7 +56,7 @@ Description of Components
- 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
* - Pin Headers
- 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.
@ -62,10 +64,10 @@ Description of Components
- 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
* - 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.
- Addressable RGB LED, driven by GPIO8.
Start Application Development
@ -80,6 +82,10 @@ Required Hardware
- USB 2.0 cable (Standard-A to Micro-B)
- Computer running Windows, Linux, or macOS
.. note::
Be sure to use an appropriate USB cable. Some cables are for charging only and do not provide the needed data lines nor work for programming the boards.
Software Setup
^^^^^^^^^^^^^^
@ -124,11 +130,11 @@ Power Supply Options
There are three mutually exclusive ways to provide power to the board:
- Micro-USB port, default power supply
- Micro-USB Port, default power supply
- 5V and GND pin headers
- 3V3 and GND pin headers
It is recommended to use the first option: micro-USB port.
It is recommended to use the first option: Micro-USB Port.
.. _user-guide-c3-devkitm-1-v1-header-blocks:
@ -182,7 +188,7 @@ No. Name Type [1]_ Function
=== ==== ========== ====================================
.. [1] P: Power supply; I: Input; O: Output; T: High impedance.
.. [2] GPIO2, GPIO8, and GPIO9 are strapping pins of the ESP32-C3FN4 chip. During the chip's system reset, the latches of the strapping pins sample the voltage level as strapping bits, and hold these bits until the chip is powered down or shut down. For description and application of strapping pins, please refer to Section Strapping Pins in `ESP32-C3 Datasheet`_.
.. [2] GPIO2, GPIO8, and GPIO9 are strapping pins of the ESP32-C3FN4 chip. These pins are used to control several chip functions depending on binary voltage values applied to the pins during chip power-up or system reset. For description and application of the strapping pins, please refer to Section Strapping Pins in `ESP32-C3 Datasheet`_.
Pin Layout
^^^^^^^^^^^

20
docs/zh_CN/hw-reference/esp32c3/user-guide-devkitc-02.rst
View File

@ -41,6 +41,8 @@ ESP32-C3-DevKitC-02 是一款入门级开发板，使用配置 4 MB SPI flash
ESP32-C3-DevKitC-02 - 正面
以下按照逆时针的顺序依次介绍开发板上的主要组件。
.. list-table::
:widths: 30 70
:header-rows: 1
@ -49,19 +51,19 @@ ESP32-C3-DevKitC-02 是一款入门级开发板，使用配置 4 MB SPI flash
- 介绍
* - ESP32-C3-WROOM-02
- ESP32-C3-WROOM-02 是乐鑫推出的一款通用型 Wi-Fi 和低功耗蓝牙双模模组，功能强大。该模组采用 PCB 板载天线，配置了 4 MB SPI flash。
* - 5 V 转 3.3 V LDO
* - 5 V to 3.3 V LDO（5 V 转 3.3 V LDO）
- 电源转换器，输入 5 V，输出 3.3 V。
* - 5 V 电源指示灯
* - 5 V Power On LED（5 V 电源指示灯）
- 开发板连接 USB 电源后，该指示灯亮起。
* - I/O 连接器
* - Pin Headers（排针）
- 所有可用 GPIO 管脚（除 Flash 的 SPI 总线）均已引出至开发板的排针。请查看 :ref:`user-guide-c3-devkitc-02-v1-header-blocks` 获取更多信息。
* - Boot 键
* - Boot Button（Boot 键）
- 下载按键。按住 **Boot** 键的同时按一下 **Reset** 键进入“固件下载”模式，通过串口下载固件。
* - Micro-USB 接口
* - Micro-USB Port（Micro-USB 接口）
- USB 接口。可用作开发板的供电电源或 PC 和 ESP32-C3 芯片的通信接口。
* - Reset 键
* - Reset Button（Reset 键）
- 复位按键。
* - USB 至 UART 桥接器
* - USB-to-UART Bridge（USB 至 UART 桥接器）
- 单芯片 USB 至 UART 桥接器，可提供高达 3 Mbps 的传输速率。
* - RGB LED
- 可寻址 RGB 发光二极管，由 GPIO8 驱动。
@ -80,7 +82,7 @@ ESP32-C3-DevKitC-02 是一款入门级开发板，使用配置 4 MB SPI flash
.. 注解::
请确保使用优质 USB 数据线。部分数据线仅可用于充电，无法用于数据传输和编程。
请确保使用适当的 USB 数据线。部分数据线仅可用于充电，无法用于数据传输和编程。
软件设置
^^^^^^^^
@ -184,7 +186,7 @@ J3
.. [1] P：电源；I：输入；O：输出；T：可设置为高阻。
.. [2] GPIO2、GPIO8、GPIO9 为 ESP32-C3 芯片的 Strapping 管脚。在芯片的系统复位过程中，Strapping 管脚对自己管脚上的电平采样并存储到锁存器中，并一直保持到芯片掉电或关闭。具体描述和应用，请参考 `ESP32-C3 技术规格书`_ 的 Strapping 管脚章节。
.. [2] GPIO2、GPIO8、GPIO9 为 ESP32-C3 芯片的 Strapping 管脚。在芯片上电和系统复位过程中，Strapping 管脚根据管脚的二进制电压值控制芯片功能。Strapping 管脚的具体描述和应用，请参考 `ESP32-C3 技术规格书`_ 的 Strapping 管脚章节。
管脚布局

24
docs/zh_CN/hw-reference/esp32c3/user-guide-devkitm-1.rst
View File

@ -41,6 +41,8 @@ ESP32-C3-DevKitM-1 是一款入门级开发板，使用以尺寸小而得名的
ESP32-C3-DevKitM-1 - 正面
以下按照逆时针的顺序依次介绍开发板上的主要组件。
.. list-table::
:widths: 30 70
:header-rows: 1
@ -49,22 +51,22 @@ ESP32-C3-DevKitM-1 是一款入门级开发板，使用以尺寸小而得名的
- 介绍
* - ESP32-C3-MINI-1
- ESP32-C3-MINI-1 是一款通用型 Wi-Fi 和低功耗蓝牙双模模组，采用 PCB 板载天线。该款模组集成配置 4 MB 嵌入式 flash 的 `ESP32-C3FN4 <https://www.espressif.com/sites/default/files/documentation/esp32-c3_datasheet_cn.pdf>`_ 芯片。由于 flash 直接封装在芯片中，ESP32-C3-MINI-1 模组具有更小的封装尺寸。
* - 5 V 转 3.3 V LDO
* - 5 V to 3.3 V LDO（5 V 转 3.3 V LDO）
- 电源转换器，输入 5 V，输出 3.3 V。
* - 5 V 电源指示灯
* - 5 V Power On LED（5 V 电源指示灯）
- 开发板连接 USB 电源后，该指示灯亮起。
* - I/O 连接器
* - Pin Headers（排针）
- 所有可用 GPIO 管脚（除 flash 的 SPI 总线）均已引出至开发板的排针。请查看 :ref:`user-guide-c3-devkitm-1-v1-header-blocks` 获取更多信息。
* - Boot 键
* - Boot Button（Boot 键）
- 下载按键。按住 **Boot** 键的同时按一下 **Reset** 键进入“固件下载”模式，通过串口下载固件。
* - Micro-USB 接口
* - Micro-USB Port（Micro-USB 接口）
- USB 接口。可用作开发板的供电电源或 PC 和 ESP32-C3FN4 芯片的通信接口。
* - Reset 键
* - Reset Button（Reset 键）
- 复位按键。
* - USB 至 UART 桥接器
* - USB-to-UART Bridge（USB 至 UART 桥接器）
- 单芯片 USB 至 UART 桥接器，可提供高达 3 Mbps 的传输速率。
* - RGB LED
- 可寻址 RGB 发光二极管 (WS2812)，由 GPIO8 驱动。
- 可寻址 RGB 发光二极管，由 GPIO8 驱动。
开始开发应用
------------
@ -78,6 +80,10 @@ ESP32-C3-DevKitM-1 是一款入门级开发板，使用以尺寸小而得名的
- USB 2.0 数据线（标准 A 型转 Micro-B 型）
- 电脑 （Windows、Linux 或 macOS）
.. 注解::
请确保使用适当的 USB 数据线。部分数据线仅可用于充电，无法用于数据传输和编程。
软件设置
^^^^^^^^
@ -179,7 +185,7 @@ J3
==== ==== ========== ================================
.. [1] P：电源；I：输入；O：输出；T：可设置为高阻。
.. [2] GPIO2、GPIO8、GPIO9 为 ESP32-C3FN4 芯片的 Strapping 管脚。在芯片的系统复位过程中，Strapping 管脚对自己管脚上的电平采样并存储到锁存器中，并一直保持到芯片掉电或关闭。Strapping 管脚的具体描述和应用，请参考 `ESP32-C3 技术规格书`_ 的 Strapping 管脚章节。
.. [2] GPIO2、GPIO8、GPIO9 为 ESP32-C3FN4 芯片的 Strapping 管脚。在芯片上电和系统复位过程中，Strapping 管脚根据管脚的二进制电压值控制芯片功能。Strapping 管脚的具体描述和应用，请参考 `ESP32-C3 技术规格书`_ 的 Strapping 管脚章节。
管脚布局
^^^^^^^^