在 Windows 上配置 ESP IDF 开发工具链
ESP-IDF 是 Espressif 的官方 IoT 开发框架,用于 ESP32、ESP32-S、ESP32-C 和 ESP32-H 系列 SoC 的开发。然后咱最近在 Clion 官网 看到 Clion 直接支持了ESP-IDF,于是乎水一篇文章记录一下 ESP-IDF 的安装过程。
ESP-IDF 其中最简易的安装方式是下载他们的离线安装器:
- https://docs.espressif.com/projects/esp-idf/zh_CN/latest/esp32c3/get-started/windows-setup.html#esp-idf
- https://dl.espressif.com/dl/esp-idf/
但 espressif/esp-idf 作为他们的官方仓库,可以使用 Git 以实现便捷的更新,所以更推荐使用 Git 的方式安装。
当然这也有一些问题,比如 Github 速度慢、Github 速度慢、Github 速度慢,所以咱还是需要文明上网的环境。
注意
由于 Windows 较新版均已自带 Windows PowerShell 且为默认 Shell,所以咱们下面的操作均是基于 PowerShell 的,另外,本文均是安装至默认文件夹(C盘),本人觉得默认目录与其他目录的区别不大,没有任何影响,反正重装也是重新配环境 (
首先选取一个目录,例如 C:\esp
,然后在这个目录下执行以下命令:
1 | git clone --recursive https://github.com/espressif/esp-idf.git |
其中 --recursive
参数是为了将 esp-idf
仓库中的子模块也一并下载下来,因为 esp-idf
仓库中的子模块也是必须的。
接着请在 设置-开发者选项 中开启如下设置
然后进入 esp-idf
目录,执行以下命令:
1 | ./install.ps1 |
如果你不使用 PowerShell 的话,那么你可以使用 install.bat
或 install.sh
甚至是 install.fish
来代替。
这个命令会自动安装一些必要的工具,包括 Python、CMake、Ninja、GCC、OpenOCD 等等,所以请耐心等待。
安装完成后,在 esp-idf
有 export.ps1
文件,这个文件是用来配置环境变量的,它每次都会将 esp-idf
目录下的 tools
目录添加到 PATH
环境变量的最前,以便我们可以在任意目录下执行 idf.py
命令。
但是,如果我们直接将这些环境变量添加到系统环境变量中,那么这将会一团糟,因为这些环境变量是针对 esp-idf
的,如果我们在其他项目中也使用这些环境变量,那么可能会出现一些意想不到的 FEATURE。所以 ESP 对于 export.ps1
的设计逻辑是使用时才配置环境变量,不使用时就不配置环境变量,这样就不会影响其他项目的编译了。
但如果这样的话,每次都要手动执行 export.ps1
,那岂不是很麻烦,所以我们可以将 export.ps1
添加到 PATH
环境变量中,这样我们就可以在任意目录下执行 export.ps1
了。
对于 Powershell , 我们可以设置一个 alias
,这样就可以在任意目录下执行 export
命令了。
1 | notepad $profile |
然后在打开的文件中添加如下内容:
1 | Set-Alias -Name idf32 -Value C:\esp\esp-idf\export.ps1 |
对于新的 ESP32 项目,我们只需要在项目目录下执行 idf32
命令即可配置环境变量,然后就可以使用 idf.py
命令了。
可以按照官网的教程来使用 Clion 导入项目后,配置环境变量:https://www.jetbrains.com/help/clion/esp-idf.html#env-vars
另外还可以在环境变量中添加 IDF_TARGET
来指定编译的目标芯片,比如 esp32c3
。
添加后需要删除 build
目录,然后清空 sdkconfig
文件,然后重新加载 CMake。
后续还有更多细节等我使用一段时间再慢慢补充(
参考:https://yuanze.wang/posts/esp-idf-vscode-tutorial/