手把手、简单实现esp32+Windows+vscode环境开发esp-idf项目 定制插件提高开发效率

手把手、简单实现esp32+Windows+vscode环境开发esp-idf项目

这个教程手把手带你简单实现Windows+vscode环境开发esp32(esp-idf)。教程会讲述两个开发实现方式：

• windows下在任意目录下使用命令行开发esp-idf项目；
• 通过定制的VScode插件进行开发。

两种开发方式都是基于esp-idf原本的开发模式进行开发，可以让你后续在其他平台都能自如适应。定制的VScode插件能辅助你在Windows、Linux、MAC平台更高效地进行esp-idf项目的开发。

如果通过看文档教程无法实现效果，请观看此文档教程的视频教程：https://www.bilibili.com/video/BV1YUL1z3Ee2

手把手、简单实现esp32+Windows+vscode环境开发esp-idf项目 定制插件提高开发效率 esp-idf

资料准备

教程所需的资料清单：

• esp-idf-tools-setup-offline-5.4.1.exe
• VSCodeUserSetup-x64-1.99.3.exe
• get_idf.bat

上述所有的资料可以直接在这里下载（任选一种方法）：

• 百度云：链接: https://pan.baidu.com/s/1JTAipnSz0CL6r59wFb4C1Q?pwd=unkx 提取码: unkx
• 前往unkx的官网获取：https://dl.unkx.net
• 进入QQ群获取资料：1012534746

获取到的所有的资料如图所示：

注意：资料提供的软件包后续可能会更新，如果进行了更新，那么文件名称会改变，但是改变的只会是版本号，关键信息不会改变，比如esp-idf-tools-setup-offline-5.4.1.exe，不管版本如何变化都会保留有esp-idf-tools-setup-offline关键字，通过该关键字对应即可。

资料的使用

如果电脑没有安装VScode，那么先双击安装这个软件：VSCodeUserSetup-x64-1.99.3.exe

VScode建议直接使用我们资料包或者下载最新版的重新安装一次，以确保版本是最新的或者和教程的一样。VScode的安装过程有一步骤是需要注意的（其他软件按照默认的选项安装即可），详细请看安装视频或者下图所示：

确定上面的软件都已就绪后，接下来双击这个安装包安装esp-idf：esp-idf-tools-setup-offline-5.4.1.exe，

esp-idf的安装过程（没有列出的界面按照默认配置点击下一步即可）：

检查资料包中的get_idf.bat文件的内容是否需要修改：

1. 通过VScode打开get_idf.bat查看内容，如下所示：

2. 按下键盘上的win按键，然后在弹出的搜索栏中输入ESP-IDF，然后鼠标先移动到得出的选项的上面，然后单机鼠标的右键，在弹出的菜单栏中选择打开文件位置选项，操作过程如下图所示：

3. 然后系统会打开一个文件资源管理器窗口，在其中会看到一个名为 ESP-IDF 5.4 CMD 的快捷方式。鼠标单击选中该快捷方式，在弹出的菜单中选择属性选项，然后在弹出的窗口中选择快捷方式一栏查看目标里面的文本内容，将其文本内容复制vscode编译器中对比，如果esp-idf-xxxxx部分不一样则修改get_idf.bat的内容保持一直，如下图所示：

4.重要，打开esp-idf的安装目录，默认是：C:\Espressif，然后将资料包中get_idf.bat（确保该文件已按照上面的操作检查或修改过了）复制到esp-idf的安装目录，如下图所示：

添加环境变量

按下键盘上的win按键，然后在弹出的搜索栏中输入环境变量，进入系统的环境变量设置，如下图所示：

接着，添加如下路径信息：

• C:\Espressif

添加过程如下图所示：

在VScode中编译、运行工程

在esp-idf的安装目录中有很多官方内置的示例，我们是可以直接复制出来使用的（不能直接在里面打开编译报错，要复制到其他地方使用），示例目录的路径是：C:\Espressif\frameworks\esp-idf-v5.4.1\examples。这里我们用一个入门示例进行测试，示例的路径是：C:\Espressif\frameworks\esp-idf-v5.4.1\examples\get-started。打开之后会复制hello_world目录到D:\unkx-work目录下（如果没有D:\unkx-work目录请自行新建）。操作过程如下图所示：

在D:\unkx-work目录中通过单击鼠标左键选中刚刚复制过来的hello_world目录；然后再按下鼠标右键，在弹出的菜单栏中选择通过VScode打开，操作过程如下图所示：

然后就能在VScode中看到打开的hello_world工程目录了，如下图所示：

在VScode中通过命令行开发

在打开VScode的终端命令行，在命令行中可以进行配置、编译、烧录、打开串口监视器等操作，如下图所示：

esp-idf常用命令及总结：

命令	说明
idf.py set-target esp32c3	设置目标芯片，比如： esp32 esp32s2 esp32c3 esp32s3 esp32p4 …
idf.py menuconfig	配置目标芯片、项目功能组件等
idf.py build	编译工程代码
idf.py clean	会把构建输出的文件从构建目录中删除，从而清理整个项目。 下次构建时会强制“重新完整构建”这个项目。清理时，不会删除 CMake 配置输出及其他文件。
idf.py fullclean	会将整个 build 目录下的内容全部删除，包括所有 CMake 的配置输出文件。 下次构建项目时，CMake 会从头开始配置项目。
idf.py -p PORT flash	将程序下载到目标芯片，其中PORT要改为对应的串口号，比如：COM3，/dev/ttyUSB0
idf.py -p PORT monitor	打开串口监视器，查看LOG日志输出。其中PORT要改为对应的串口号，比如：COM3，/dev/ttyUSB0
idf.py -p PORT flash monitor	一次性实现：编译、烧录、打开串口监视器，查看LOG日志输出。其中PORT要改为对应的串口号，比如：COM3，/dev/ttyUSB0

esp-idf命令编译烧录过程参考：https://docs.espressif.com/projects/esp-idf/zh_CN/latest/esp32/get-started/linux-macos-setup.html#id14

在VScode中通过定制的插件开发

定制的VScode插件是辅助你在进行esp-idf项目的开发。本质上命令行的快速实行，不需要手动在终端控制台中敲写命令进行esp-idf项目的：配置、编译、烧录、打开串口监视器等操作，能在一定程度上提高开发效率。

这个插件的安装很简单，直接在VScode左侧活动栏中的扩展图标，或使用****查看：显示扩展****命令（快捷键：⇧⌘X 或 Ctrl+Shift+X）打开。然后在搜索栏中搜索 ESP-IDF-Tools即可看到安装入口，如下图所示：

ESP-IDF-Tools插件地址：https://marketplace.visualstudio.com/items?itemName=unkx.esp-idf-tools-extension

这个插件安装了之后，如果你在VScode中打开的目录是esp-idf工程，那么会在VScode的底部的状态栏会出现多个图标，根据需要点击使用即可。如下图所示，

注意：ESP-IDF-Tools需要确保在C:\Espressif中存在get_idf.bat文件。
另一方面，在Linux环境下需要确保 shell 配置文件中（.profile、.bashrc、.zprofile 等）添加了：alias get_idf='. $HOME/esp/esp-idf/export.sh'

文档与视频教程

• 文档教程在线观看：https://blog.csdn.net/unkxtech/article/details/147492136
• 视频教程在线观看：https://www.bilibili.com/video/BV1YUL1z3Ee2