Linux 和 macOS 平台工具链的标准设置(已过时)

[English]

警告

本章节描述了在 Linux 和 macOS 上安装 ESP-IDF v6.0 之前版本的默认方式。

详细安装步骤

请根据下方详细步骤,完成安装过程。

设置开发环境

以下是为 ESP32-S3 设置 ESP-IDF 的具体步骤。

第一步:安装准备

为了在 ESP32-S3 中使用 ESP-IDF,需要根据操作系统安装一些软件包。可以参考以下安装指南,安装 Linux 和 macOS 的系统上所有需要的软件包。

Linux 用户

编译 ESP-IDF 需要以下软件包。请根据使用的 Linux 发行版本,选择合适的安装命令。

  • Ubuntu 和 Debian:

    sudo apt-get install git wget flex bison gperf python3 python3-pip python3-venv cmake ninja-build ccache libffi-dev libssl-dev dfu-util libusb-1.0-0
    
  • CentOS 7 & 8:

    sudo yum -y update && sudo yum install git wget flex bison gperf python3 python3-setuptools cmake ninja-build ccache dfu-util libusbx
    

目前仍然支持 CentOS 7,但为了更好的用户体验,建议使用 CentOS 8。

  • Arch:

    sudo pacman -S --needed gcc git make flex bison gperf python cmake ninja ccache dfu-util libusb python-pip
    

备注

  • 使用 ESP-IDF 需要 CMake 3.22 或以上版本。较早的 Linux 发行版可能需要升级自身的软件源仓库,或开启 backports 套件库,或安装 "cmake3" 软件包(不是安装 "cmake")。

  • 如果上述列表中没有当前所用系统,请参考所用系统的相关文档,查看安装软件包所用的命令。

macOS 用户

ESP-IDF 将使用 macOS 上默认安装的 Python 版本。

  • 安装 CMake 和 Ninja 编译工具:

    • 若有 HomeBrew,可以运行:

      brew install cmake ninja dfu-util
      
    • 若有 MacPorts,可以运行:

      sudo port install cmake ninja dfu-util
      
    • 若以上均不适用,请访问 CMakeNinja 主页,查询有关 macOS 平台的下载安装问题。

  • 强烈建议同时安装 ccache 以获得更快的编译速度。如有 HomeBrew,可通过 MacPorts 上的 brew install ccachesudo port install ccache 完成安装。

备注

如在上述任何步骤中遇到以下错误:

xcrun: error: invalid active developer path (/Library/Developer/CommandLineTools), missing xcrun at: /Library/Developer/CommandLineTools/usr/bin/xcrun

则必须安装 XCode 命令行工具,可运行 xcode-select --install 命令进行安装。

Apple M1 用户

如果使用的是 Apple M1 系列且看到如下错误提示:

WARNING: directory for tool xtensa-esp32-elf version esp-2021r2-patch3-8.4.0 is present, but tool was not found
ERROR: tool xtensa-esp32-elf has no installed versions. Please run 'install.sh' to install it.

或者:

zsh: bad CPU type in executable: ~/.espressif/tools/xtensa-esp32-elf/esp-2021r2-patch3-8.4.0/xtensa-esp32-elf/bin/xtensa-esp32-elf-gcc

运行如下命令,安装 Apple Rosetta 2:

/usr/sbin/softwareupdate --install-rosetta --agree-to-license

安装 Python 3

请确保已安装 Python 3.10 或更高版本。Python 3.10 为 ESP-IDF 支持的最低版本。

请注意,大多数新版 macOS 默认仅包含 Python 3.9(或更低版本),这些版本已不再受支持,请安装 Python 3.10 或更高版本。

请根据以下步骤在 macOS 中安装受支持的 Python 3:

  • 若使用 HomeBrew,请运行:

    brew install python3
    
  • 若使用 MacPorts,请运行:

    sudo port install python313
    

备注

安装过程中,安装脚本 (install.sh) 会检查系统中已安装的 Python 版本,并在所有符合最低要求的版本中,选择最早的版本使用。

第二步:获取 ESP-IDF

在围绕 ESP32-S3 构建应用程序之前,请先获取乐鑫提供的软件库文件 ESP-IDF 仓库

获取 ESP-IDF 的本地副本:打开终端,切换到要保存 ESP-IDF 的工作目录,使用 git clone 命令克隆远程仓库。针对不同操作系统的详细步骤,请见下文。

打开终端,运行以下命令:

mkdir -p ~/esp
cd ~/esp
git clone --single-branch --recursive https://github.com/espressif/esp-idf.git

备注

如果网络连接较慢,可以在 git clone 命令中添加 --depth 1 选项,仅下载最新提交。但这样会导致后续的 git fetch 操作变慢,下载更多不必要的数据。

ESP-IDF 将下载至 ~/esp/esp-idf

请前往 ESP-IDF 版本简介,查看 ESP-IDF 不同版本的具体适用场景。

第三步:设置工具

除了 ESP-IDF 本身,还需要为支持 ESP32-S3 的项目安装 ESP-IDF 使用的各种工具,比如编译器、调试器、Python 包等。

cd ~/esp/esp-idf
./install.sh esp32s3

或使用 Fish shell:

cd ~/esp/esp-idf
./install.fish esp32s3

上述命令仅仅为 ESP32-S3 安装所需工具。如果需要为多个目标芯片开发项目,则可以一次性指定多个目标,如下所示:

cd ~/esp/esp-idf
./install.sh esp32,esp32s2

或使用 Fish shell:

cd ~/esp/esp-idf
./install.fish esp32,esp32s2

如果需要一次性为所有支持的目标芯片安装工具,可以运行如下命令:

cd ~/esp/esp-idf
./install.sh all

或使用 Fish shell:

cd ~/esp/esp-idf
./install.fish all

备注

对于 macOS 用户,如在上述任何步骤中遇到以下错误:

<urlopen error [SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed: unable to get local issuer certificate (_ssl.c:xxx)

可运行电脑 Python 文件夹中的 Install Certificates.command 安装证书。了解更多信息,请参考 安装 ESP-IDF 工具时出现的下载错误

下载工具备选方案

ESP-IDF 工具安装器会下载 Github 发布版本中附带的一些工具,如果访问 Github 较为缓慢,可以设置一个环境变量,从而优先选择 Espressif 的下载服务器进行 Github 资源下载。

备注

该设置只影响从 Github 发布版本中下载的单个工具,它并不会改变访问任何 Git 仓库的 URL。

要在安装工具时优先选择 Espressif 下载服务器,请在运行 install.sh 时使用以下命令:

cd ~/esp/esp-idf
export IDF_GITHUB_ASSETS="dl.espressif.com/github_assets"
./install.sh

备注

推荐国内用户使用国内的下载服务器,以加快下载速度。

cd ~/esp/esp-idf
export IDF_GITHUB_ASSETS="dl.espressif.cn/github_assets"
./install.sh

自定义工具安装路径

本步骤中介绍的脚本将 ESP-IDF 所需的编译工具默认安装在用户的根目录中,即 Linux 系统中的 $HOME/.espressif 目录。可以选择将工具安装到其他目录中,但请在运行安装脚本前,导出环境变量 IDF_TOOLS_PATH。注意,请确保用户账号已经具备了读写该路径的权限。

export IDF_TOOLS_PATH="$HOME/required_idf_tools_path"
./install.sh

. ./export.sh

如果修改了 IDF_TOOLS_PATH 变量,请在运行任意 ESP-IDF 工具或脚本前,将该变量导出到环境变量中。

备注

如未导出环境变量,大多数 shell 将不支持在变量赋值中使用 IDF_TOOLS_PATH,例如 IDF_TOOLS_PATH="$HOME/required_idf_tools_path" ./install.sh。因为即便在源脚本中导出或修改了该变量,当前的执行环境也不受变量赋值影响。

第四步:设置环境变量

此时,刚刚安装的工具尚未添加至 PATH 环境变量,无法通过“命令窗口”使用这些工具。因此,必须设置一些环境变量。这可以通过 ESP-IDF 提供的另一个脚本进行设置。

请在需要运行 ESP-IDF 的终端窗口运行以下命令:

. $HOME/esp/esp-idf/export.sh

对于 fish shell(仅支持 fish 3.0.0 及以上版本),请运行以下命令:

. $HOME/esp/esp-idf/export.fish

注意,命令开始的 "." 与路径之间应有一个空格!

如果需要经常运行 ESP-IDF,可以为执行 export.sh 创建一个别名,具体步骤如下:

  1. 复制并粘贴以下命令到 shell 配置文件中(.profile.bashrc.zprofile 等)

    alias get_idf='. $HOME/esp/esp-idf/export.sh'
    
  2. 通过重启终端窗口或运行 source [path to profile],如 source ~/.bashrc 来刷新配置文件。

现在可以在任何终端窗口中运行 get_idf 来设置或刷新 ESP-IDF 环境。

不建议直接将 export.sh 添加到 shell 的配置文件。这样做会导致在每个终端会话中都激活 IDF 虚拟环境(包括无需使用 ESP-IDF 的会话)。这违背了使用虚拟环境的目的,还可能影响其他软件的使用。

ESP-IDF 环境更新:升级 ESP-IDF 与 Python 软件包

乐鑫会不时推出新版本的 ESP-IDF,修复 bug 或提供新的功能。请注意,ESP-IDF 的每个主要版本和次要版本都有相应的支持期限。支持期限满后,版本停止更新维护,用户可将项目升级到最新的 ESP-IDF 版本。更多关于支持期限的信息,请参考 ESP-IDF 版本

因此,在使用时,也应注意更新本地版本。最简单的方法是:直接删除本地的 esp-idf 文件夹,然后按照 第二步:获取 ESP-IDF 中的指示,重新完成克隆。

另一种方法是仅更新变更的部分,具体方式请参阅 更新 ESP-IDF 章节。

为确保工具版本符合新 ESP-IDF 的要求,在更新 ESP-IDF 版本后,请在 $IDF_PATH 目录下重新运行 ./install.sh 脚本。详细说明请参阅 第三步:设置工具

所有新工具安装完成后,请参考 第四步:设置环境变量,运行导出脚本并进入 ESP-IDF 开发环境。

ESP-IDF 环境更新:只升级 Python 软件包

ESP-IDF 的部分功能并非直接包含在主代码库中,而是由 esp-idf-monitoresptool 等 Python 软件包提供。这些软件包由安装脚本自动部署在 ESP-IDF 环境中,无需升级 ESP-IDF 即可更新,只需重新运行安装脚本(在 $IDF_PATH 目录下执行 ./install.sh)。若 ESP-IDF 环境已存在,则该脚本会在保持 ESP-IDF 版本不变的前提下,将所有 Python 软件包更新至与当前 ESP-IDF 版本兼容的最新版本。

备注

高级用户如需更灵活地控制更新流程,可参考 idf_tools.py 脚本 工具及 install-python-env 命令。此命令被安装脚本调用,专门用于创建或更新 ESP-IDF 环境。


此文档对您有帮助吗?