ESP32-S3 入门学习笔记（二）：ESP-IDF简介

ESP32-S3 入门学习笔记（二）：ESP-IDF简介

B站学习链接：link

什么是ESP-IDF

ESP-IDF是乐鑫为ESP系列芯片推出的一款自给自足SDK物联网开发框架
（1）ESP-IDF独立于项目以外，通过环境变量引导编译与链接 ESP-IDF与项目工程分离
（2）项目工程编译与链接必须依赖ESP-IDF 项目工程依赖于ESP-IDF

ESP-IDF项目编译流程
虽然ESP-IDF独立于项目之外，但每一个项目工程都依赖于ESP-IDF编译、构造于链接。

从上述图示可见，项目的工程文件通过集成 C 项目、中间组件以及工具链，共同编译生成可执行文件。随后，这个可执行文件被下载到 ESP32 芯片中。 ESP32 芯片能够通过其监控器功能，向开发者提供实时的反馈信息。这一流程使得开发者能够更有效地监控和管理 ESP32 芯片的运行状态，从而优化项目的开发过程。

ESP-IDF开发方式

• 命令式开发：缺少图形化、过程繁琐、配置复杂…
• 集成开发环境开发：具备图形化、过程简单、配置可视化…
  

下载&安装ESP-IDF

为了安装 ESP32的开发环境，我们需要前往官网下载 ESP32-IDF 安装包（link)。
下载成功后， 在安装程序上单击右键选择<以管理员身份运行>运行 esp-idf-tools-setup-espressif-ide-3.1.0-with-esp-idf-5.3.1.exe文件
打开安装程序后选择简体中文安装，如下图所示：

往下走就是许可协议，勾选“我同意此协议”，单击下一步，如下图所示：

点击下一步之后，会跳出安装前系统检查界面，如下图所示：

安装程序会检查你当前系统有没有打开"长路径支持"，因为 GNU 编译器产生的编译文件会有非常深的目录结构，如果不支持长路径，编译可能出现文件不存在，目录不存在等奇怪的错误。这里单击应用修复按钮，可以修复这个问题。 在弹出的确认对话框中，选择是，开始修复。


安装程序默认的安装位置为 C:\Espressif，但这里我是安装在 D 盘，如果全部源码编译后可能产生几十 G 的大小占用，我们在 D 盘下创建 \Espressif 文件夹来保存 ESP32-IDF 库安装过程中生成的文件。注意： 这个安装路径非常重要，因为 VS Code 软件的 IDF 插件需要此路径来获取相关文件，所以开发者务必牢记该路径。
设置安装路径后点击 “下一步”选项， 进入确认安装组件界面，这里全部打勾，默认完全安装时 ESP32C2 是不打勾的（如下图所示），看需要自己选择。然后单击下一步。

我们选择全部安装。点击下一步再次确认安装目录信息，然后单击安装。安装完成，三个全部勾选， 1、 2 用于测试环境安装是否成功， 3 是将 ESP-IDF 工具链加入杀毒工具排除项，以加快编译速度，如下图所示：

安装成功后，桌面自动生成 ESP-IDF 5.3 PowerShell 和 ESP-IDF 5.3 CMD 命令提示符终端，PowerShell 提供了更强大的脚本和自动化功能，适合需要执行复杂任务或管理复杂环境的用户；而CMD则更适合进行基础的命令行操作和简单的脚本执行。用户可以根据自己的需求和偏好选择使用其中一个工具。
打开其中一个终端，如果终端提示“idf.py build” 指令时， 说明我们的环境已经安装成功了。如下图所示：

了让系统能够找到和识别 ESP-IDF 的相关工具和库，从而能够顺利地进行编译、构建和调试 ESP32 或其他 Espressif 芯片的项目，我们必须设置 ESP-IDF 的环境变量，设置方法如下：按照此过程（此电脑→属性→高级系统→环境变量）打开，如下图所示：

如果 ESP-IDF 库安装成功，则系统自动为我们添加上图中的 IDF_TOOLS_PATH 和IDF_PATH 环境变量，否则手动添加这两个环境变量。安装成功时会自动生成IDF_TOOLS_PATH环境变量，IDF_PATH环境变量需要手动添加的

ESP-IDF项目开发命令

ESP-IDF 能够通过命令的形式来构建或编译系统，这一命令被称为 ESP-IDF 的前端工具。此工具旨在简化 ESP32 以及其他 Espressif 芯片系列的开发流程。它提供了诸多实用功能，从而协助开发者更加高效地构建、烧录以及调试项目。

1. 创建新工程（create-project）

“idf.py create-project --path ” 是 ESP-IDF 提供的一个命令，用于创建一个新的项目目录结构，并将必要的文件和模板复制到该目录中。这个命令的目的是帮助开发者快速设置一个新的 IoT 项目，而无需手动创建所有必要的文件和目录。
下面是这个命令的参数解析和使用方法。
①：参数解析
–path：指定创建工程的位置（必须在文件夹路径下）。
：项目工程名称。
②：使用方法
在桌面新建 test_1 文件夹，用来保存 ESP-IDF 新建的工程，然后打开 ESP-IDF CMD 终端输入“idf.py create-project --path C:\Users???\Desktop\test_1 led”命令创建项目工程，如下图所示：

此时桌面会创建 test_1 项目，而工程名称为 led。如下图所示：

2. 创建新组件（create-component）

“idf.py create-component ” 创建一个新的组件，包含构建所需的最基本文件集。一般存放第三方组件，如编写的驱动程序等。
下面是这个命令的参数解析和使用方法。
①： 参数解析
：组件名称
②：使用方法
首先使用“cd”命令进入新建工程路径，然后在此路径下新建组件文件夹，如下图所示：


component 文件夹一般用来存储第三方组件或者用户的程序驱动代码。

3. 设置目标芯片

“idf.py set-target ” 命令用于设置工程的目标芯片。由于 ESP-IDF 支持多款乐鑫SoC 芯片，新建工程时默认会选择 ESP32 类型的芯片。因此，如果我们希望创建一个针对ESP32-S3 类型的工程，就必须使用此命令来指定该工程的目标芯片为 ESP32-S3。
下面是这个命令的参数解析和使用方法。
①：参数解析
< target >：目标芯片，可使用“idf.py --list-targets”命令查看支持的芯片类型。
②：使用方法
首先输入“idf.py --list-targets” 命令查看支持的芯片类型，然后输入“idf.py set-target esp32s3”命令设置工程的目标芯片，如下图所示：

注意： “idf.py set-target”命令将清除构建目录，并从头开始重新生成 sdkconfig 文件。旧的 sdkconfig 文件将保存为 sdkconfig.old。

4. 编译工程

“idf.py build”命令用来编译当前项目工程。如下图所示：

5. 监控项目

“idf.py monitor”命令用来监控当前项目。监控之前必须安装 USB 虚拟串口驱动以及开发板上的 USB 串口接入到电脑当中，才能监控当前项目工程。
注意：请按“Ctrl + ]”快捷键退出监控器。

6. 配置项目

“idf.py menuconfig” 这个命令会启动一个文本用户界面，允许开发者为他们的 ESP32 或其他 Espressif SoC 芯片系列的项目配置各种选项。如下图所示：

7. 下载代码

“idf.py -p COM12 flash” 这个命令用来把编译出来的可执行文件烧录到 ESP32-S3 芯片当中。注意：烧录之前必须调用“idf.py build”命令编译项目工程，编译完成后方能烧录代码。 如下图所示：

上述 COM12 端口需要根据自己的开发板识别出来的虚拟串口端口

8. 清除编译文件

“idf.py clean”和“idf.py fullclean” 是 ESP-IDF（Espressif IoT Development Framework）中用于清理构建目录和输出文件的两个命令，它们的主要区别在于清理的彻底程度和范围。
①“idf.py clean”命令：
这个命令主要用于清理构建目录中的构建输出文件。它会删除 build 文件夹中的某些文件，但不会删除 CMake 的配置输出和其他相关文件。这意味着下次构建时， CMake 将基于现有的配置信息重新生成所需的构建输出，但不需要从头开始配置整个项目。这通常用于在不需要更改项目配置的情况下，重新构建项目以解决可能存在的构建问题或更新代码。
②“idf.py fullclean”命令：
这个命令则更为彻底，它会删除整个 build 目录下的所有内容，包括所有的 CMake 配置输出文件。这意味着下次构建项目时， CMake 将需要从头开始配置项目，重新生成所有的构建输出和配置文件。这个命令通常用于在需要完全重置项目构建环境的情况下使用，例如在更改了
项目的硬件配置或需要确保从头开始全新构建。

上述提到的命令是 IDF 前端工具中极为常用的指令，掌握了这些命令，就可以开始着手开发 ESP32 项目了。
不过命令式开发难以轻松调试和编写代码，更何况在大型项目中，开发效率会大大降低。因此建议开发者选择基于集成开发环境（IDE）的开发方式。这种方式能更好地支持代码的调试和编写。至于 IDE的选择，特别推荐 VS Code IDE，因为它是一款免费且开源的 IDE软件，非常适合用于 ESP-IDF 的开发工作。