前言
为更好地服务国内用户,构建中文需求沟通平台,帮助用户快速下载乐鑫开源代码,乐鑫将 GitHub 中的主要仓库(包含 ESP-IDF、ESP-ADF、ESP-MDF 以及阿里、腾讯、京东等国内云平台的连云代码等)镜像到了Gitee(码云,国内基于 Git 的代码托管平台),并进行每日同步,确保与 GitHub 代码一致。值得一提的是,我们还将 ESP-IDF 依赖的子仓库 (submodule) 代码逐一镜像到了码云,确保主仓库和子仓库拥有相同的下载体验。使用 Gitee 可大幅缩短代码下载时间,点此观看视频教程 。
未来,乐鑫将会持续维护国内 Gitee 平台,加入更多开源项目,推动国内开源社区和生态的繁荣发展。
此文档教程可作为对官方搭建教程的补充,使用码云进行 ESP-IDF 环境安装,预计可大幅缩短环境搭建的等待时间。
适用系统:Windows 10 64 位版本、Windows 7 SP2 级以上 x64 版本
安装版本:ESP-IDF 4.0 及以上版本
构建系统:CMake
一、安装依赖工具
在环境搭建之前,我们需要在 Windows 系统中安装一些开发必备的工具,这些工具包括 Python 环境,版本控制工具 Git。
1. 安装 Python 3.7:
- Python 主要用于执行一些自动化脚本,例如执行
idf.py
等; - 下载链接:点击下载: python3.7.9;
- 安装提示:
注意,在安装时先勾选
Add Python 3.7 to PATH
,或手动添加环境变量 >
- 修改 Python pip 源:
为了加快后续 Python 包的下载速度,可将 pip 源切换到国内,例如切换为国内阿里的源
- 管理员模式打开命令提示符窗口( CMD) ,执行以下指令:
pip config set global.index-url http://mirrors.aliyun.com/pypi/simple
pip config set global.trusted-host mirrors.aliyun.com
2. 安装 Git:
- Git 用于拉取 ESP-IDF 源代码,代码版本控制等;
- 下载链接:点击下载: git 2.30
- 安装提示:直接点击下一步即可
注意,以上步骤完成以后,请重启电脑使配置生效
二、下载 ESP-IDF 源代码
ESP-IDF 的仓库代码包含一个主仓库和数十个子仓库,使用重定向脚本 esp-gitee-tools ,可以直接将这些仓库的下载路径切换为国内码云仓库,极大的加快代码的下载速度,操作方法如下:
- 进入 C 盘根目录;
- 打开一个终端窗口:可在文件管理器空白位置点击鼠标右键,然后选择
Git Bash Here
; - 下载重定向脚本 esp-gitee-tools,运行以下指令:
git clone https://gitee.com/EspressifSystems/esp-gitee-tools.git
- 下载主仓库代码:
git clone https://gitee.com/EspressifSystems/esp-idf.git
- 使用 esp-gitee-tools 下载子仓库代码,依次执行以下指令:
cd esp-gitee-tools
export EGT_PATH=$(pwd)
cd ..
cd esp-idf
$EGT_PATH/submodule-update.sh
后续如果切换了 git 分支,子仓库列表可能会有变化,需要重复执行 步骤 5 的指令
三、安装编译工具链
为了生成最终能在 ESP 芯片上运行的 bin 文件,这里还需要安装芯片对应的编译工具链和构建系统,工具链相关的下载信息一般在 ESP-IDF 中附带,我们这里使用 esp-gitee-tools 进行下载,步骤如下:
- 进入 C 盘根目录;
- 同第二步类似,打开一个终端窗口;
- 使用 esp-gitee-tools 安装编译工具链,执行以下指令:
cd esp-gitee-tools
export EGT_PATH=$(pwd)
cd ..
cd esp-idf
$EGT_PATH/install.sh
至此环境安装的过程已经完成
四、使用 VS Code 编译运行 Hello world !
用户可以使用任意编辑器编写源代码,我们这里推荐使用 VS Code,下载链接:点击下载 VS Code。编译、下载、运行过程如下:
- 启动 VS Code,打开内置终端窗口,快捷键为
Ctrl
+~
- 这里建议将默认终端切换为命令提示符
CMD
- 重启 VS Code ,打开工程文件夹,这里打开的是
C:\esp-idf\examples\get-started\hello_world
- 打开终端,编译、下载、查看输出:
4.1. 首先使用命令C:\esp-idf\export.bat
添加环境变量到当前终端(开启新终端需要重新执行):
4.2. 使用命令idf.py build
编译代码:
4.3. 使用命令 idf.py -p COMX flash monitor
下载代码,并查看串口输出:
所有配置工作已完成,现在您可以以此为基础开启 ESP 芯片开发之旅!