如何使用 Gitee 快速搭建 ESP-IDF 开发环境（Windows 版本）

我会带着你远行 2023-01-03 04:09 177阅读 0赞

## 前言 ##

为了提高代码仓库的访问速率，更好的满足中文用户沟通需求，我们现已将部分主要仓库镜像到码云（Gitee，中国本土化的基于 Git 的代码托管平台），包括深受用户喜爱的乐鑫物联网开发框架 ESP-IDF，Wi-Fi 自组网开发框架 ESP-MDF ，腾讯、京东、阿里等中国国内云平台连云代码等基于码云的同步机制，各个仓库会按时执行代码镜像操作，确保与 Github 平台保持一致。值得一提的是，我们还将 ESP-IDF 依赖的子仓库（submodule）代码逐一镜像到了码云，确保主仓库和子仓库拥有相同的下载体验。码云仓库主页：https://gitee.com/EspressifSystems

该教程可作为对[官方搭建教程][Link 1]的补充，使用码云进行 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][python3.7.9]；
 *  安装提示：
    
    > 注意，在安装时先勾选 `Add Python 3.7 to PATH`，或手动添加环境变量 >

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2VzcHJlc3NpZg_size_16_color_FFFFFF_t_70_pic_center]

*  修改 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
    
     *  1
     *  2

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2VzcHJlc3NpZg_size_16_color_FFFFFF_t_70_pic_center 1]

### 2. 安装 Git： ###

*  Git 用于拉取 ESP-IDF 源代码，代码版本控制等；
 *  下载链接：[点击下载: git 2.30][git 2.30]
 *  安装提示：直接点击下一步即可

**注意，以上步骤完成以后，请重启电脑使配置生效**

## 二、下载 ESP-IDF 源代码 ##

ESP-IDF 的仓库代码包含一个主仓库和数十个子仓库，使用重定向脚本 esp-gitee-tools ，可以直接将这些仓库的下载路径切换为国内码云仓库，极大的加快代码的下载速度，操作方法如下：

1.  进入 C 盘根目录；
2.  打开一个终端窗口：可在文件管理器空白位置点击鼠标右键，然后选择 `Git Bash Here`；
3.  下载重定向脚本 esp-gitee-tools，运行以下指令：
    
        git clone https://gitee.com/EspressifSystems/esp-gitee-tools.git
    
     *  1
    
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2VzcHJlc3NpZg_size_16_color_FFFFFF_t_70_pic_center 2]
4.  下载主仓库代码：
    
        git clone https://gitee.com/EspressifSystems/esp-idf.git
    
     *  1
5.  使用 esp-gitee-tools 下载子仓库代码，依次执行以下指令：
    
        cd esp-gitee-tools
        export EGT_PATH=$(pwd)
        cd ..
        cd esp-idf
        $EGT_PATH/submodule-update.sh
    
     *  1
     *  2
     *  3
     *  4
     *  5

**后续如果切换了 git 分支，子仓库列表可能会有变化，需要重复执行 步骤 5 的指令**

## 三、安装编译工具链 ##

为了生成最终能在 ESP 芯片上运行的 bin 文件，这里还需要安装芯片对应的编译工具链和构建系统，工具链相关的下载信息一般在 ESP-IDF 中附带，我们这里使用 esp-gitee-tools 进行下载，步骤如下：

1.  进入 C 盘根目录；
2.  同第二步类似，打开一个终端窗口；
3.  使用 esp-gitee-tools 安装编译工具链，执行以下指令：
    
        cd esp-gitee-tools
        export EGT_PATH=$(pwd)
        cd ..
        cd esp-idf
        $EGT_PATH/install.sh
    
     *  1
     *  2
     *  3
     *  4
     *  5

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2VzcHJlc3NpZg_size_16_color_FFFFFF_t_70_pic_center 3]  
**至此环境安装的过程已经完成**

## 四、使用 VS Code 编译运行 Hello world ！ ##

用户可以使用任意编辑器编写源代码，我们这里推荐使用 VS Code，下载链接：点击下载 [VS Code][]。编译、下载、运行过程如下：

1.  启动 VS Code，打开内置终端窗口，快捷键为 `Ctrl` \+ `~`

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2VzcHJlc3NpZg_size_16_color_FFFFFF_t_70_pic_center 4]

1.  这里建议将默认终端切换为命令提示符 `CMD`

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2VzcHJlc3NpZg_size_16_color_FFFFFF_t_70_pic_center 5]

1.  重启 VS Code ，打开工程文件夹，这里打开的是 `C:\esp-idf\examples\get-started\hello_world`

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2VzcHJlc3NpZg_size_16_color_FFFFFF_t_70_pic_center 6]

1.  打开终端，编译、下载、查看输出：  
    4.1. 首先使用命令`C:\esp-idf\export.bat` 添加环境变量到当前终端（开启新终端需要重新执行）：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2VzcHJlc3NpZg_size_16_color_FFFFFF_t_70_pic_center 7]
    
    4.2. 使用命令 `idf.py build` 编译代码：
    
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2VzcHJlc3NpZg_size_16_color_FFFFFF_t_70_pic_center 8]  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2VzcHJlc3NpZg_size_16_color_FFFFFF_t_70_pic_center 9]
    
    4.3. 使用命令 `idf.py -p COMX flash monitor` 下载代码，并查看串口输出：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2VzcHJlc3NpZg_size_16_color_FFFFFF_t_70_pic_center 10]  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2VzcHJlc3NpZg_size_16_color_FFFFFF_t_70_pic_center 11]

**所有配置工作已完成，现在您可以以此为基础开启 ESP 芯片开发之旅！**

[Link 1]: https://docs.espressif.com/projects/esp-idf/zh_CN/latest/esp32/get-started/index.html
[python3.7.9]: https://www.python.org/ftp/python/3.7.9/python-3.7.9-amd64.exe
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2VzcHJlc3NpZg_size_16_color_FFFFFF_t_70_pic_center]: /images/20221119/e27f7041b3384a7299e64ad8edd2be9e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2VzcHJlc3NpZg_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20221119/3287235a62cb4a55a5ebe810e4a8f382.png
[git 2.30]: https://github.com/git-for-windows/git/releases/download/v2.30.0.windows.1/Git-2.30.0-64-bit.exe
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2VzcHJlc3NpZg_size_16_color_FFFFFF_t_70_pic_center 2]: /images/20221119/0417337dbdb44a75b3ccf4b279e747e3.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2VzcHJlc3NpZg_size_16_color_FFFFFF_t_70_pic_center 3]: /images/20221119/dd632c0cffd1454b991b3367de116d5b.png
[VS Code]: https://code.visualstudio.com/
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2VzcHJlc3NpZg_size_16_color_FFFFFF_t_70_pic_center 4]: /images/20221119/61db54c6b7094da19f19baa3d69c3878.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2VzcHJlc3NpZg_size_16_color_FFFFFF_t_70_pic_center 5]: /images/20221119/5232bae4d3b844e094c00d24877f91f3.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2VzcHJlc3NpZg_size_16_color_FFFFFF_t_70_pic_center 6]: /images/20221119/4c9e37c18702426ebd90ff5f7b8d3ac3.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2VzcHJlc3NpZg_size_16_color_FFFFFF_t_70_pic_center 7]: /images/20221119/fe832242e05a420eb76242662162e4dc.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2VzcHJlc3NpZg_size_16_color_FFFFFF_t_70_pic_center 8]: /images/20221119/13ac470054414a50b3722382085ea734.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2VzcHJlc3NpZg_size_16_color_FFFFFF_t_70_pic_center 9]: /images/20221119/54a1d1185e8549a7a2d870b34098473e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2VzcHJlc3NpZg_size_16_color_FFFFFF_t_70_pic_center 10]: /images/20221119/ba99c1015f83411f851feea5fa355d49.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2VzcHJlc3NpZg_size_16_color_FFFFFF_t_70_pic_center 11]: /images/20221119/3367ad7d12a241b2b287faac89d2f27a.png