ESP32-C3-DevKitC-02 用户指南

草帽王子 · 发表于 2021-9-16 21:39:12

有人预言,RISC-V或将是继Intel和Arm之后的第三大主流处理器体系。欢迎访问全球首家只专注于RISC-V单片机行业应用的中文网站

您需要登录才可以下载或查看，没有帐号？立即注册

x

本帖最后由草帽王子于 2021-9-16 21:38 编辑

本指南介绍了搭载 ESP32-C3-WROOM-02 的入门级开发板 ESP32-C3-DevKitC-02。

快速入门

本文档旨在指导用户搭建 ESP32-C3 硬件开发的软件环境，通过一个简单的示例展示如何使用 ESP-IDF (Espressif IoT Development Framework) 配置菜单，并编译、下载固件至 ESP32-C3 开发板等步骤。
注解：
这是ESP-IDF master 分支（最新版本）的文档，该版本在持续开发中。还有 Stable version 的文档，以及其他版本的文档 ESP-IDF 版本简介供参考。

概述

ESP32-C3 SoC 芯片支持以下功能：

2.4 GHz Wi-Fi
低功耗蓝牙
高性能 32 位 RISC-V 单核处理器
多种外设
内置安全硬件

ESP32-C3 采用 40 nm 工艺制成，具有最佳的功耗性能、射频性能、稳定性、通用性和可靠性，适用于各种应用场景和不同功耗需求。

乐鑫为用户提供完整的软、硬件资源，进行 ESP32-C3 硬件设备的开发。其中，乐鑫的软件开发环境 ESP-IDF 旨在协助用户快速开发物联网 (IoT) 应用，可满足用户对 Wi-Fi、蓝牙、低功耗等方面的要求。

准备工作

硬件：

一款 ESP32-C3 开发板
USB 数据线 (A 转 Micro-B)
电脑（Windows、Linux 或 Mac OS）

软件（您可以选择下载并手动安装以下软件）：

设置工具链，用于编译 ESP32-C3 代码；
编译构建工具 —— CMake 和 Ninja 编译构建工具，用于编译 ESP32-C3 应用程序；
获取 ESP-IDF 软件开发框架。该框架已经基本包含 ESP32-C3 使用的 API（软件库和源代码）和运行工具链的脚本；

或者，您也可以通过以下集成开发环境 (IDE) 中的官方插件完成安装流程：

ESP32-C3 单片机芯片-ESP32-C3-DevKitC-02 用户指南risc-v单片机中文社区(1)

ESP32-C3 应用程序开发

开发板简介

请点击下方连接，了解有关开发板的详细信息。

详细安装步骤

请根据下方详细步骤，完成安装过程。

设置开发环境

第一步：安装准备（Windows 、Linux 和 macOS）
第二步：获取 ESP-IDF
第三步：设置工具
第四步：设置环境变量

创建您的第一个工程
第五步：开始创建工程
第六步：连接设备
第七步：配置
第八步：编译工程
第九步：烧录到设备
第十步：监视器

第一步：安装准备

在正式开始创建工程前，请先完成工具的安装，具体步骤见下：

ESP32-C3 单片机芯片-ESP32-C3-DevKitC-02 用户指南risc-v单片机中文社区(2)

ESP32-C3 单片机芯片-ESP32-C3-DevKitC-02 用户指南risc-v单片机中文社区(3)

ESP32-C3 单片机芯片-ESP32-C3-DevKitC-02 用户指南risc-v单片机中文社区(4)

Windows Linux macOS

注解
在本文档中，Linux 和 macOS 操作系统中 ESP-IDF 的默认安装路径为 ~/esp；Windows 操作系统中的默认安装路径为 %userprofile%\esp。您也可以将 ESP-IDF 安装在任何其他路径下，但请注意在使用命令行时进行相应替换。注意，ESP-IDF 不支持带有空格的路径。

第二步：获取 ESP-IDF

在围绕 ESP32-C3 构建应用程序之前，请先获取乐鑫提供的软件库文件 ESP-IDF 仓库。

获取 ESP-IDF 的本地副本：打开终端，切换到您要保存 ESP-IDF 的工作目录，使用 git clone 命令克隆远程仓库。针对不同操作系统的详细步骤，请见下文。

Linux 和 macOS 操作系统

打开终端，后运行以下命令：

mkdir -p ~/esp
cd ~/esp
git clone --recursive https://github.com/espressif/esp-idf.git

复制代码

ESP-IDF 将下载至 ~/esp/esp-idf。

请前往 ESP-IDF 版本简介，查看 ESP-IDF 不同版本的具体适用场景。

Windows 操作系统

除了安装必要工具外，第一步中介绍的 ESP-IDF 工具安装器也能同时下载 ESP-IDF 本地副本。

请前往 ESP-IDF 版本简介，查看 ESP-IDF 不同版本的具体适用场景。

除了使用 ESP-IDF 工具安装器，您也可以参考指南手动下载 ESP-IDF。

第三步：设置工具

除了 ESP-IDF 本身，您还需要安装 ESP-IDF 使用的各种工具，比如编译器、调试器、Python 包等。

Windows 操作系统

请根据第一步中对 Windows (ESP-IDF 工具安装器) 的介绍，安装所有必需工具。

除了使用 ESP-IDF 工具安装器，您也可以通过命令提示符窗口手动安装这些工具。具体步骤见下：

cd %userprofile%\esp\esp-idf
install.bat esp32c3

复制代码

或使用 Windows PowerShell

cd ~/esp/esp-idf
./install.ps1 esp32c3

复制代码

Linux 和 macOS 操作系统

cd ~/esp/esp-idf
./install.sh esp32c3

复制代码

或使用 Fish shell

cd ~/esp/esp-idf
./install.fish esp32c3

复制代码

注解
通过一次性指定多个目标，可为多个目标芯片同时安装工具，如运行 ./install.sh esp32,esp32c3,esp32s3。通过运行 ./install.sh 或 ./install.sh all 可一次性为所有支持的目标芯片安装工具。

下载工具备选方案

ESP-IDF 工具安装器会下载 Github 发布版本中附带的一些工具，如果访问 Github 较为缓慢，则可以设置一个环境变量，实现优先选择 Espressif 的下载服务器进行 Github 资源下载。
注解
该设置只影响从 Github 发布版本中下载的单个工具，它并不会改变访问任何 Git 仓库的 URL。

Windows 操作系统

如果希望在运行 ESP-IDF 工具安装器时优先选择 Espressif 下载服务器，请在 Select Components 窗口中的 Optimization 部分勾选 Use Espressif download mirror instead of GitHub 选项。

Linux 和 macOS 操作系统

要在安装工具时优先选择 Espressif 下载服务器，请在运行 install.sh 时使用以下命令：

cd ~/esp/esp-idf
export IDF_GITHUB_ASSETS="dl.espressif.com/github_assets"
./install.sh

复制代码

自定义工具安装路径

本步骤中介绍的脚本将 ESP-IDF 所需的编译工具默认安装在用户的根目录中，即 Linux 和 macOS 系统中的 $HOME/.espressif 和 Windows 系统的 %USERPROFILE%\.espressif。此外，您可以将工具安装到其他目录中，但请在运行安装脚本前，重新设置环境变量 IDF_TOOLS_PATH。注意，请确保您的用户已经具备了读写该路径的权限。

如果修改了 IDF_TOOLS_PATH 变量，请确保该变量在每次执行安装脚本 (install.bat、install.ps1 或 install.sh) 和导出脚本 (export.bat、export.ps1 或 export.sh) 均保持一致。

第四步：设置环境变量

此时，您刚刚安装的工具尚未添加至 PATH 环境变量，无法通过“命令窗口”使用这些工具。因此，必须设置一些环境变量，这可以通过 ESP-IDF 提供的另一个脚本完成。

Windows 操作系统

Windows 安装器（ESP-IDF 工具安装器）可在“开始”菜单创建一个 “ESP-IDF Command Prompt” 快捷方式。该快捷方式可以打开命令提示符窗口，并设置所有环境变量。您可以点击该快捷方式，然后继续下一步。

此外，如果您希望在当下命令提示符窗口使用 ESP-IDF，请使用下方代码：

%userprofile%\esp\esp-idf\export.bat

复制代码

或使用 Windows PowerShell

.$HOME/esp/esp-idf/export.ps1

复制代码

Linux 和 macOS 操作系统

请在需要运行 ESP-IDF 的终端窗口运行以下命令：

. $HOME/esp/esp-idf/export.sh

复制代码

对于 fish shell（仅支持 fish 3.0.0 及以上版本），请运行以下命令：

. $HOME/esp/esp-idf/export.fish

复制代码

注意，命令开始的 “.” 与路径之间应有一个空格！

如果您需要经常运行 ESP-IDF，您可以为执行 export.sh 创建一个别名，具体步骤如下：
1.复制并粘贴以下命令到 shell 配置文件中（.profile， .bashrc， .zprofile 等）

alias get_idf='. $HOME/esp/esp-idf/export.sh'

复制代码

2.通过重启终端窗口或运行 source [path to profile]，如 source ~/.bashrc 来刷新配置文件。

现在您可以在任何终端窗口中运行 get_idf 来设置或刷新 esp-idf 环境。

这里不建议您直接将 export.sh 添加到 shell 的配置文件。因为这会导致在每个终端会话中都激活 IDF 虚拟环境（包括无需使用 IDF 的情况），从而破坏使用虚拟环境的目的，并可能影响其他软件的使用。

第五步：开始创建工程

现在，您可以开始准备开发 ESP32-C3 应用程序了。您可以从 ESP-IDF 中 examples目录下的 get-started/hello_world 工程开始。

将 get-started/hello_world 工程复制至您本地的 ~/esp 目录下：

Linux 和 macOS 操作系统

cd ~/esp
cp -r $IDF_PATH/examples/get-started/hello_world .

复制代码

Windows 操作系统

cd %userprofile%\esp
xcopy /e /i %IDF_PATH%\examples\get-started\hello_world hello_world

复制代码

ESP-IDF 的 examples 目录下有一系列示例工程，都可以按照上面的方法进行创建。您可以按照上述方法复制并运行其中的任何示例，也可以直接编译示例，无需进行复制。

重要
ESP-IDF 编译系统不支持带有空格的路径。

第六步：连接设备

现在，请将您的 ESP32-C3 开发板连接到 PC，并查看开发板使用的串口。

通常，串口在不同操作系统下显示的名称有所不同：

Windows 操作系统： COM1 等
Linux 操作系统：以 /dev/tty 开始
macOS 操作系统：以 /dev/cu. 开始

有关如何查看串口名称的详细信息，请见与 ESP32-C3 创建串口连接。
注解
请记住串口名，您会在下面的步骤中用到。

第七步：配置

请进入本文第五步：开始创建工程中提到的 hello_world 目录，并运行工程配置工具 menuconfig。

Linux 和 macOS 操作系统

cd ~/esp/hello_world
idf.py set-target esp32c3
idf.py menuconfig

复制代码

Windows 操作系统

cd %userprofile%\esp\hello_world
idf.py set-target esp32c3
idf.py menuconfig

复制代码

打开一个新项目后，应首先设置“目标”芯片 idf.py set-target esp32c3。注意，此操作将清除并初始化项目之前的编译和配置（如有）。您也可以直接将“目标”配置为环境变量（此时可跳过该步骤）。更多信息，请见选择目标芯片（文章构建系统（CMake 版）章节选择目标芯片）。

如果之前的步骤都正确，则会显示下面的菜单：

ESP32-C3 单片机芯片-ESP32-C3-DevKitC-02 用户指南risc-v单片机中文社区(5)

工程配置 — 主窗口

您可以通过此菜单设置项目的具体变量，包括 Wi-Fi 网络名称、密码和处理器速度等. hello_world 示例项目会以默认配置运行，因此可以跳过使用 menuconfig 进行项目配置这一步骤。
注解
您终端窗口中显示出的菜单颜色可能会与上图不同。您可以通过选项 --style 来改变外观。更多信息，请运行 idf.py menuconfig --help 命令。

第八步：编译工程

请使用以下命令，编译烧录工程：

idf.py build

复制代码

运行以上命令可以编译应用程序和所有 ESP-IDF 组件，接着生成 bootloader、分区表和应用程序二进制文件。

$ idf.py build
Running cmake in directory /path/to/hello_world/build
Executing "cmake -G Ninja --warn-uninitialized /path/to/hello_world"...
Warn about uninitialized values.
-- Found Git:/usr/bin/git (found version "2.17.0")
-- Building empty aws_iot component due to configuration
-- Component names: ...
-- Component paths: ...
... (more lines of build system output)
[527/527] Generating hello-world.bin
esptool.py v2.3.1
Project build complete. To flash, run this command:
../../../components/esptool_py/esptool/esptool.py -p (PORT) -b 921600 write_flash --flash_mode dio --flash_size detect --flash_freq 40m 0x10000 build/hello-world.bin build 0x1000 build/bootloader/bootloader.bin 0x8000 build/partition_table/partition-table.bin
or run 'idf.py -p PORT flash'

复制代码

如果一切正常，编译完成后将生成 .bin 文件。

第九步：烧录到设备

请使用以下命令，将刚刚生成的二进制文件 (bootloader.bin, partition-table.bin 和 hello-world.bin) 烧录至您的 ESP32-C3 开发板：

idf.py -p PORT [-b BAUD] flash

复制代码

请将 PORT 替换为 ESP32-C3 开发板的串口名称，具体可见本文第六步：连接设备。

您还可以将 BAUD 替换为您希望的烧录波特率。默认波特率为 460800。

更多有关 idf.py 参数的详情，请见 idf.py（文章构建系统（CMake 版）章节 idf.py）。
注解
勾选 flash 选项将自动编译并烧录工程，因此无需再运行 idf.py build。

烧录过程中可能遇到的问题

如果在运行给定命令时出现如“连接失败”这样的错误，原因之一则可能是运行 esptool.py 出现错误。esptool.py 是构建系统调用的程序，用于重置芯片、与 ROM 引导加载器交互以及烧录固件的工具。解决该问题的一个简单的方法就是按照以下步骤进行手动复位。如果问题仍未解决，请参考 Troubleshooting 获取更多信息。

esptool.py 通过使 USB 转串口转接器芯片（如 FTDI 或 CP210x）的 DTR 和 RTS 控制线生效来自动复位 ESP32-C3（请参考与ESP32-C3 创建串口连接获取更多详细信息)。DTR 和 RTS 控制线又连接到 ESP32-C3 的 GPIO9 和 CHIP_PU (EN) 管脚上，因此 DTR 和 RTS 的电压电平变化会使 ESP32-C3 进入固件下载模式。相关示例可查看 ESP32 DevKitC 开发板的原理图 ESP32-C3 单片机芯片-ESP32-C3-DevKitC-02 用户指南risc-v单片机中文社区(6)

ESP32-C3 单片机芯片-ESP32-C3-DevKitC-02 用户指南risc-v单片机中文社区(6)

esp32_devkitc_v4-sch-20180607a.pdf (72.19 KB, 下载次数: 0) 。

一般来说，使用官方的 esp-idf 开发板不会出现问题。但是，esptool.py 在以下情况下不能自动重置硬件。

您的硬件没有连接到 GPIO9 和 CIHP_PU 的 DTR 和 RTS 控制线。
DTR 和 RTS 控制线的配置方式不同
根本没有这样的串行控制线路

根据您硬件的种类，也可以将您 ESP32-C3 开发板手动设置成固件下载模式（复位）。

对于 Espressif 的开发板，您可以参考对应开发板的入门指南或用户指南。例如，可以通过按住 Boot 按钮 (GPIO9) 再按住 EN 按钮(CHIP_PU) 来手动复位 esp-idf 开发板。
对于其他类型的硬件，可以尝试将 GPIO9 拉低。

常规操作

在烧录过程中，您会看到类似如下的输出日志：

...
esptool.py --chip esp32c3 -p /dev/ttyUSB0 -b 460800 --before=default_reset --after=hard_reset write_flash --flash_mode dio --flash_freq 80m --flash_size 2MB 0x8000 partition_table/partition-table.bin 0x0 bootloader/bootloader.bin 0x10000 hello-world.bin
esptool.py v3.0
Serial port /dev/ttyUSB0
Connecting....
Chip is ESP32-C3
Features: Wi-Fi
Crystal is 40MHz
MAC: 7c:df:a1:40:02:a4
Uploading stub...
Running stub...
Stub running...
Changing baud rate to 460800
Changed.
Configuring flash size...
Compressed 3072 bytes to 103...
Writing at 0x00008000... (100 %)
Wrote 3072 bytes (103 compressed) at 0x00008000 in 0.0 seconds (effective 4238.1 kbit/s)...
Hash of data verified.
Compressed 18960 bytes to 11311...
Writing at 0x00000000... (100 %)
Wrote 18960 bytes (11311 compressed) at 0x00000000 in 0.3 seconds (effective 584.9 kbit/s)...
Hash of data verified.
Compressed 145520 bytes to 71984...
Writing at 0x00010000... (20 %)
Writing at 0x00014000... (40 %)
Writing at 0x00018000... (60 %)
Writing at 0x0001c000... (80 %)
Writing at 0x00020000... (100 %)
Wrote 145520 bytes (71984 compressed) at 0x00010000 in 2.3 seconds (effective 504.4 kbit/s)...
Hash of data verified.
Leaving...
Hard resetting via RTS pin...
Done

复制代码

如果一切顺利，烧录完成后，开发板将会复位，应用程序 “hello_world” 开始运行。

如果您希望使用 Eclipse 或是 VS Code IDE，而非 idf.py，请参考 Eclipse 指南，以及 VS Code 指南。

第十步：监视器

您可以使用 idf.py -p PORT monitor 命令，监视 “hello_world” 工程的运行情况。注意，不要忘记将 PORT 替换为您的串口名称。

运行该命令后，IDF 监视器应用程序将启动：:

$ idf.py -p /dev/ttyUSB0 monitor
Running idf_monitor in directory [...]/esp/hello_world/build
Executing "python [...]/esp-idf/tools/idf_monitor.py -b 115200 [...]/esp/hello_world/build/hello-world.elf"...
--- idf_monitor on /dev/ttyUSB0 115200 ---
--- Quit: Ctrl+] | Menu: Ctrl+T | Help: Ctrl+T followed by Ctrl+H ---
ets Jun 8 2016 00:22:57
rst:0x1 (POWERON_RESET),boot:0x13 (SPI_FAST_FLASH_BOOT)
ets Jun 8 2016 00:22:57
...

复制代码

此时，您就可以在启动日志和诊断日志之后，看到打印的 “Hello world!” 了。

...
Hello world!
Restarting in 10 seconds...
This is esp32c3 chip with 1 CPU core(s), WiFi/BLE, silicon revision 0, 2MB external flash
Minimum free heap size: 337332 bytes
Restarting in 9 seconds...
Restarting in 8 seconds...
Restarting in 7 seconds...

复制代码

您可使用快捷键 Ctrl+]，退出 IDF 监视器。

注解
您也可以运行以下命令，一次性执行构建、烧录和监视过程：

idf.py -p PORT flash monitor

复制代码

此外，

请前往IDF 监视器，了解更多使用 IDF 监视器的快捷键和其他详情。
请前往 idf.py（文章构建系统（CMake 版）章节idf.py），查看更多 idf.py 命令和选项。

恭喜，您已完成 ESP32-C3 的入门学习！

现在，您可以尝试一些其他examples，或者直接开发自己的应用程序。

重要
一些示例程序不支持 ESP32-C3，因为 ESP32-C3 中不包含所需的硬件。
在编译示例程序前请查看 README 文件中 Supported Targets 表格。如果表格中包含 ESP32-C3，或者不存在这个表格，那么即表示 ESP32-C3 支持这个示例程序。

更新 ESP-IDF

乐鑫会不时推出更新版本的 ESP-IDF，修复 bug 或提供新的功能。因此，您在使用时，也应注意更新您本地的版本。最简单的方法是：直接删除您本地的 esp-idf 文件夹，然后按照本文第二步：获取 ESP-IDF 中的指示，重新完成克隆。

此外，您可以仅更新变更部分。具体方式，请前往更新章节（文章ESP-IDF 版本简介章节更新 ESP-IDF）查看。

注意，更新完成后，请再次运行安装脚本，以防新版 ESP-IDF 所需的工具也有所更新。具体请参考本文第三步：设置工具。

一旦重新安装好工具，请使用导出脚本更新环境，具体请参考本文第四步：设置环境变量。

相关文档

与 ESP32-C3 创建串口连接
Eclipse IDE 创建和烧录指南
VS Code IDE 快速入门
IDF 监视器
工具链的自定义设置
完

RISC-V单片机技术交流群

ESP32-C3-DevKitC-02 用户指南

有人预言,RISC-V或将是继Intel和Arm之后的第三大主流处理器体系。欢迎访问全球首家只专注于RISC-V单片机行业应用的中文网站

相关帖子

RISC-V单片机中文网 /2

RISC-V单片机技术交流群

ESP32-C3-DevKitC-02 用户指南

有人预言,RISC-V或将是继Intel和Arm之后的第三大主流处理器体系。欢迎访问全球首家只专注于RISC-V单片机行业应用的中文网站

相关帖子

RISC-V单片机中文网 /2 document.write(unescape("%3Cspan id='cnzz_stat_icon_1278870330'%3E%3C/span%3E%3Cscript src='https://s4.cnzz.com/z_stat.php%3Fid%3D1278870330%26show%3Dpic1' type='text/javascript'%3E%3C/script%3E"));

RISC-V单片机中文网 /2