【立创·实战派ESP32-S3】文档教程

第 2 章 安装开发环境

ESP-IDF 开发环境可以安装在 Windows、Linux 和 macOS 上，在乐鑫官方《ESP-IDF 编程指南》文档里对各个系统的安装有详细说明，感兴趣的同学可以去看一下，想节省时间的直接往下看。

乐鑫《ESP-IDF 编程指南》是一个在线文档，链接：https://docs.espressif.com/projects/esp-idf/zh_CN

对于大多数嵌入式工程师，主要使用 Windows 系统的电脑，如果要在 Windows 系统上使用 Linux 开发，需要在系统上安装虚拟机，并在虚拟机里安装 Linux 系统，最后在 Linux 系统上安装 ESP-IDF，这其中，会遇到很多奇怪的问题，可能会直接劝退很多人。

所以我们推荐直接在 Windows 下开发。

有两个免费软件可以使用，一个是 Eclipse，一个是 Visual Studio Code，简称 VSCode。本教程使用的是 VSCode 进行讲解，在 VSCode 软件里面完成代码的编辑、编译、下载、调试等全过程。

我们使用 VSCode 软件进行开发，只需要在 VSCode 软件上安装 ESP-IDF 插件，就可以在 VSCode 软件上编辑、编译、烧录、调试代码。

因为乐鑫官方的 IDF 版本会不定时更新，而且更新速度比较快，使用不同版本的 IDF 编译同一个例程，可能会出现一些小问题，为了避免此类情况发生，建议大家使用和我们的例程相同的 IDF 版本。同时，VSCode 也支持安装多个不同版本的 IDF，在使用的时候，可以自由切换。下面分别介绍如何在 VSCode 上安装 ESP-IDF 插件，以及如何在 VSCode 上安装多个版本的 IDF。

2.1 安装 VSCode 和 ESP-IDF 插件

搭建 VSCode 的 ESP-IDF 开发环境，有多种方式。在实战派 ESP32-C3 的文档教程中，我们介绍了一种最简单的安装方法，就是先安装离线版 IDF 安装程序，然后再在 VSCode 配置 ESP-IDF 插件的时候，加载已经安装的 IDF，这种安装方式，基本上是百分百成功，建议初学者使用这种安装方式。直接点击下面链接可跳转到实战派 ESP32-C3 的文档教程。

ESP32-C3 文档教程：【立创·实战派 ESP32-C3】开发板

这里我们再介绍一种算是“本应如此”的安装方式，就是先安装好 VSCode 软件，再安装 ESP-IDF 插件，最后再配置 ESP-IDF 插件，听上去是不是“本应如此”。这种安装方式成功与否取决于网络好坏。

Visual Studio Code 下载地址链接：https://code.visualstudio.com/

VSCode 是一款功能强大的软件，相信很多人已经安装且使用它开发过其它型号的芯片了。如果你至今还没有使用过它，先进入 VSCode 的下载网址，找到下载按钮后直接点击下载即可。文件下载完以后，直接双击安装就可以。在安装的时候，最好是勾选：将“通过 Code 打开”操作添加到 Windows 资源管理器文件上下文菜单以及目录上下文菜单，如下图所示，这样我们就可以很方便的打开 IDF 工程。

如果你是第一次安装和使用 VSCode，建议你安装中文语言包，这样就会有中文菜单和界面了，在安装 VSCode 软件的时候，一般会提示是否安装中文语言包，同意就可以，如果安装的时候没有同意，或者没有提示安装中文语言包，之后安装也可以。我们在 VSCode 软件左侧点击“插件”图标，在搜索框中输入“中文”，选择“中文(简体)”插件安装，点击“安装”按钮就可以，下图是我已经安装好了，所以没有“安装”按钮了。

接下来安装 ESP-IDF 插件，同样的方法，搜索 ESP-IDF 找到乐鑫 IDF 插件，点击安装。

在安装乐鑫 IDF 插件的同时，会自动安装 C/C++ 插件，安装完成后，我们可以看一下已安装插件列表。把插件的搜索框清空就可以看到已安装插件，如下图所示。如果在安装 ESP-IDF 插件的时候，没有自动安装 C/C++ 插件，你只需要手动在搜索框输入 C/C++，然后再安装就可以了。

安装好 IDF 插件以后，还需要进行配置才能使用。点击 IDF 插件图标，然后点击 Configure ESP-IDF Extension。

然后点击“EXPRESS”，意思是快速安装。

然后分别完成四个选项。第一个选择国内服务器。第二个选择你要安装的 IDF 版本号。第三个选择你要把 IDF 安装到哪里。第四个选择你要把 IDF_TOOLS 安装到哪里。注意，IDF 和 IDF_TOOLS 不能是同一个文件夹，否则安装不成功，例如，下图中，我的 IDF 安装到了 esp 文件夹，而 IDF_TOOLS 安装到了.espressif 文件夹。

配置好以后，在上图中点击 Install 就可以开始了。

安装过程分为三步，如下图所示。第一步安装 ESP-IDF，第二步安装 ESP-IDF Tools，第三步安装 Python 虚拟环境。

下图显示正在进行第一步的安装，ESP-IDF 的安装，正在下载 ESP-IDF 文件，显示已经下载了 61.18%。

到了第二步，如下图所示，开始安装 ESP-IDF Tools，往下拉，这里会看到很多个工具，每一个都有进度条。

下图所示，第二步已经完成，已经进入第三步，Python 环境的安装。

第三步 Python 的安装，是耗时最久的，要耐心等待。而且，第三步的安装，由于受到网络不稳定影响，也许并不是一次就可以安装好，如果安装失败，会回来原来的画面，如下图所示：

这个时候，不要直接点击 Install 按钮，否则，它会提示你 ESP-IDF 已经存在，并停止安装，如下图所示：

这时候，我们需要在选择 ESP-IDF 版本这一栏，选择“在系统中寻找 ESP-IDF”，如下图所示。

然后点击 Install 按钮，就又开始安装过程了。

如果还是没有安装成功，会跳到上图所示画面，直接点击 Install 按钮继续安装。一直不成功，一直重复就可以，直到安装成功。

网络好的情况下，可以一次安装成功。这里说的网络，不仅指你自己的网络，还包括服务器的网络。

安装成功后，会显示如下画面。

2.2 安装多个 IDF 版本

IDF 的版本号为 x.x.x（例如，5.2.2），第一个 x 是主版本号，第二个 x 是次版本号，第 3 个 x 是修订版本号。下面代码位于 esp_idf_version.h 文件中，该文件路径是：esp-idf\components\esp_common\include。

/** Major version number (X.x.x) */
#define ESP_IDF_VERSION_MAJOR   5
/** Minor version number (x.X.x) */
#define ESP_IDF_VERSION_MINOR   2
/** Patch version number (x.x.X) */
#define ESP_IDF_VERSION_PATCH   2

用这个版本写好的代码，用另一个版本号的 IDF 编译，可能会出现问题。如果是“老手”，可以发现并改之，如果是“新手”，就两眼抹黑了。

实战派 ESP32-S3 开发板的例程，使用 5.1.4 制作，实测使用 5.2.2 编译也没有问题。

大家如果是使用 ESP32 做的公司实际产品项目，当时是用哪个版本编译的，之后修改 BUG 维护程序，也需要用同样的版本号编译，换版本会带来灾难性的后果，尤其是大批量的产品。如果之前版本太低，乐鑫已经不维护老版本了，这时候可以把代码移植为新版本，并再次经过严格的测试，才可以正式放到产品上。

VSCode 的 ESP-IDF 插件，支持配置多个 IDF 版本。如果想安装多个版本，按照上面的方法，安装第二个 IDF 版本就可以。

不建议小白安装多个版本的 IDF，还没有开始学习编程，安装开发环境就干废了。

如果你安装了多个版本，使用 VSCode 打开工程后，在左下角，可以点击选择你要使用的版本号。