[English]

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

以下是为 ESP32 设置 ESP-IDF 的具体步骤。

第一步：安装准备

第二步：获取 ESP-IDF

第三步：设置工具

第四步：设置环境变量

第五步：开始使用 ESP-IDF 吧

为了在 ESP32 中使用 ESP-IDF，需要根据操作系统安装一些软件包。以下安装指南可协助您安装 Linux 和 macOS 的系统上所有需要的软件包。

编译 ESP-IDF 需要以下软件包。请根据使用的 Linux 发行版本，选择合适的安装命令。

Ubuntu 和 Debian:

CentOS 7 & 8:

目前仍然支持 CentOS 7，但为了更好的用户体验，建议使用 CentOS 8。

Arch:

备注

使用 ESP-IDF 需要 CMake 3.16 或以上版本。较早的 Linux 发行版可能需要升级自身的软件源仓库，或开启 backports 套件库，或安装 “cmake3” 软件包（不是安装 “cmake”）。

如果上述列表中没有您使用的系统，请参考您所用系统的相关文档，查看安装软件包所用的命令。

ESP-IDF 将使用 macOS 上默认安装的 Python 版本。

安装 CMake 和 Ninja 编译工具：

若有 HomeBrew，您可以运行:

若有 MacPorts，您可以运行:

若以上均不适用，请访问 CMake 和 Ninja 主页，查询有关 macOS 平台的下载安装问题。

强烈建议同时安装 ccache 以获得更快的编译速度。如有 HomeBrew，可通过 MacPorts 上的 brew install ccache 或 sudo port install ccache 完成安装。

备注

如您在上述任何步骤中遇到以下错误:

则必须安装 XCode 命令行工具，可运行 xcode-select --install 命令进行安装。

如果您使用的是 Apple M1 系列且看到如下错误提示:

或者:

您需要运行如下命令来安装 Apple Rosetta 2：

Catalina 10.15 发布说明 中表示不推荐使用 Python 2.7 版本，在未来的 macOS 版本中也不会默认包含 Python 2.7。执行以下命令来检查您当前使用的 Python 版本:

如果输出结果是 Python 2.7.17，则代表您的默认解析器是 Python 2.7。这时需要您运行以下命令检查电脑上是否已经安装过 Python 3:

如果运行上述命令出现错误，则代表电脑上没有安装 Python 3。

请根据以下步骤安装 Python 3：

使用 HomeBrew 进行安装的方法如下:

使用 MacPorts 进行安装的方法如下:

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

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

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

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

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

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

或使用 Fish shell：

上述命令仅仅为 ESP32 安装所需工具。如果需要为多个目标芯片开发项目，则可以一次性指定多个目标，如下所示：

或使用 Fish shell：

如果需要一次性为所有支持的目标芯片安装工具，可以运行如下命令：

或使用 Fish shell：

备注

对于 macOS 用户，如您在上述任何步骤中遇到以下错误:

重新 编译和烧录 应用程序。

在当前的 ESP-IDF 版本中，ESP32 支持的主晶振频率如下：

26 MHz

40 MHz

备注

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

idf.py -p PORT flash monitor

此外，

请前往 IDF 监视器，了解更多使用 IDF 监视器的快捷键和其他详情。

请前往 idf.py，查看更多 idf.py 命令和选项。

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

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

重要

一些示例程序不支持 ESP32，因为 ESP32 中不包含所需的硬件。

在编译示例程序前请查看 README 文件中 Supported Targets 表格。如果表格中包含 ESP32， 或者不存在这个表格，那么即表示 ESP32 支持这个示例程序。

使用某些 Linux 版本向 ESP32 烧录固件时，可能会出现 Failed to open port /dev/ttyUSB0 错误消息。此时可以将用户添加至 Linux Dialout 组。

ESP-IDF 支持 Python 3.7 及以上版本，建议升级操作系统到最新版本从而更新 Python。也可选择从 sources 安装最新版 Python，或使用 Python 管理系统如 pyenv 对版本进行升级管理。

您可以使用 板级支持包 (BSP)，协助您在开发板上的原型开发。仅需要调用几个函数，便可以完成对特定开发板的初始化。

一般来说，BSP 支持开发板上所有硬件组件。除了管脚定义和初始化功能外，BSP 还附带如传感器、显示器、音频编解码器等外部元件的驱动程序。

BSP 通过 IDF 组件管理器 发布，您可以前往 IDF 组件注册器 进行下载。

以下示例演示了如何将 ESP-WROVER-KIT BSP 添加到项目中：

更多有关使用 BSP 的示例，请前往 BSP 示例文件夹。

ESP-IDF 支持擦除 flash。请运行以下命令，擦除整个 flash：

若存在需要擦除的 OTA 数据，请运行以下命令：

擦除 flash 需要一段时间，在擦除过程中，请勿断开设备连接。

乐鑫会不时推出新版本的 ESP-IDF，修复 bug 或提供新的功能。请注意，EESP-IDF 的每个主要版本和次要版本都有相应的支持期限。支持期限满后，版本停止更新维护，用户可将项目升级到最新的 ESP-IDF 版本。更多关于支持期限的信息，请参考 ESP-IDF 版本。

因此，您在使用时，也应注意更新您本地的版本。最简单的方法是：直接删除您本地的 esp-idf 文件夹，然后按照 第二步：获取 ESP-IDF 中的指示，重新完成克隆。

另一种方法是仅更新变更的部分。具体方式，请前往 更新 ESP-IDF 章节查看。具体更新步骤会根据您使用的 ESP-IDF 版本有所不同。

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

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

与 ESP32 创建串口连接

Eclipse Plugin

VSCode Extension

IDF 监视器