乐鑫代理启明云端分享|ESP32 系列教程之四： Windows 搭建 esp-idf 环境

提示：
本文档为 ESP32 教程系列，旨在为客户进行 ESP32 系列芯片开 发提供环境搭建、工程示例演示等方面的参考文档及视频演示，降低 ESP32 系列芯片、模组开发的入门难度。

ESP32 教程系列文档主要参考于乐鑫官网提供的 ESP32 入门教 程：https://docs.espressif.com/projects/esp-idf/zh_CN/latest/esp32/get-started/index.html。

---

1、 工具链设置

1.1 安装 git

1.1.1.

git 下载地址：https://git-scm.com/downloads

1.1.2 安装

（1）下载

（2）设置安装路径

（3）一直NEXT，直至完成安装

1.2 安装python（版本3.8以上，建议3.8）

1.2.1 下载

python下载地址：https://www.python.org/downloads/

1.2.2 安装

（1）下载

（2）安装



1.3 获取ESP-IDF

方式一：在文件夹下打开git，使用下方命令下载esp-idf（下载的esp-idf位置在当前文件夹）：

git clone -b release/v4.3 --recursive https://github.com.cnpmjs.org/espressif/esp-idf.git

（注：-b release/v4.3表示当前下载版本为release/4.3,需要下载其它版本或版本介绍请移至乐鑫官网查看具体介绍

出现如下错误：

进入esp-idf目录下执行：git submodule update --init --recursive

方式二：前往乐鑫官网下载esp-idf压缩包，解压后改名为esp-idf,下载地址：
https://www.espressif.com/zh-hans/support/download/sdks-demos?keys=&field_type_tid%5B%5D=13

1.4 安装ESP-IDF工具安装器（版本2.5）

1.4.1 下载

ESP-IDF工具安装器下载地址：https://dl.espressif.com/dl/esp-idf/?idf=4.4

1.4.2 安装

（1）下载


（2）自动检测的git路径

（3）选择自己下载的esp-idf

（4）选择安装路径

（5）使用Espressif作为下载服务器

（6）选择创建快捷方式

（7）完成安装

---

2、运行hello_world示例

2.1 克隆工程

使用命令克隆hello_world工程:

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

2.2 工程配置

进入hello_world示例，进行工程配置：

cd hello_world

idf.py set-target esp32 (使用其它芯片请选择对应芯片类型，如：esp32c3)

(打开一个新项目后，应首先设置“目标”芯片 idf.py set-target esp32。

注意：此操作将清除并初始化项目之 前的编译和配置（如有）。 您也可以直接将“目标”配置为环境变量（此时可跳过该步骤）)

idf.py menuconfig

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

您可以通过此菜单设置项目的具体变量，包括 Wi-Fi 网络名称、密码和处理器速度等. hello_world 示例项目 会以默认配置运行，因此可以跳过使用 menuconfig 进行项目配置这一步骤。

2.3 编译工程

idf.py build

2.4 硬件连接

用USB线将ESP32模组与电脑连接

2.5 查看端口

在开始菜单中选择设备管理器查看当前端口号：

2.6 工程烧录

进行烧录：

idf.py -p COM21 flash

烧录成功！

2.7 监视工程

查看监视器：

idf.py -p COM21 monitor

成功打印hello_world.

---

3、VS Code的使用

3.1 VS Code的下载与安装

3.1.1 下载VS Code

官网下载地址：https://code.visualstudio.com/Download#

3.1.2 安装VS Code

勾选这两项可将VS Code添加至右键菜单

3.2 VS Code的使用

3.2.1 移植脚本

（1）创建一个文本文档，将下列内容复制粘贴（需适当修改）

@echo off
Set home=%cd%
cd D:\ESP_IDF\esp-idf

C:\Windows\system32\cmd.exe /k
““D:\ESP_IDF\esp-idf-tool.espressif\idf_cmd_init.bat”
“D:\ESP_IDF\esp-idf-tool.espressif\python_env\idf_py3.8_env\Scripts”
“D:\ESP_IDF\Git\Git\cmd””

/*
home 为储存当前路径的变量名，可改可不改。
cd 后的路径为esp-idf路径

C:\Windows\s… 这一句指令替换为ESP-IDF Command Prompt (cmd.exe)的目标

右键点击ESP-IDF Command Prompt (cmd.exe)，选择属性，将目标中语句进行复制替换。

完成后将文档改名为get_idf.bat,将其放入ESP-IDF Command Prompt (cmd.exe)所在位置。

*/

（2）创建另一个文本文档，复制粘贴以下内容：

@echo off
cd %home%

/* home 变量应与第一个脚本保持一致 */

将文档改名为go_home.bat,将其放入ESP-IDF Command Prompt (cmd.exe)所在位置。

3.2.2 运行hello_world示例

(1)使用VS Code打开hello_world工程文件夹,打开一个新终端，运行get_idf:

(2)运行go_home,返回hello_world目录下：

（3）工程编译

（4）工程烧录与监视


成功打印hello_world.

---

注意事项

4.1 注意事项

（1）git版本没有具体要求

（2）python版本建议为3.8（至少在3.8之上），因为esp-idf工具所使用的python版本似乎为3.8

（3）ESP-IDF工具安装器的版本建议使用2.5，虽然已经更新到2.9，但新版本总会在最后安装时出现一些错误（也有可能是我网络问题）

（4）脚本移植时要进行相应的替换，命令间的空格最好重新设置，防止因字符格式的转变而插入其它字符

---

相关建议

本文档使用ESP-IDF工具安装器的方式在Windows下构建esp-idf环境，同时为了更方便于编写代码而通过移植脚本的方式引入VS Code的使用，将代码编写与编译一体化，消除频繁切换界面的麻烦，该方式适用于习惯在Windows环境下使用命令行进行开发的开发者。

---

启明云端

深圳市启明云端科技有限公司（简称“启明云端”）是国内领先的物联网通讯产品和整体解决方案提供商，为全球企业客户提供无线通讯产品及场景智能化服务。

公司作为Espressif（乐鑫科技）大中华区合作伙伴，Sigmastar（晨星）A级方案商；得天独厚的上游芯片厂商资源及严格的质量控制体系为公司发展提供强大的实力保证，总能在第一时间为客户带来极具竞争力的产品。

公司主要提供物联网无线通讯芯片、模组、人机界面（HMI）、人工智能及工业控制嵌入式产品等，方案已服务全球超过1000+企业，特别是在智能家电、智能家居、智慧工业、医疗、农业监测等领域积累了丰富的产品和项目经验。