esp-idf/docs/zh_CN/get-started/linux-macos-setup.rst

316 lines
12 KiB
ReStructuredText
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

*********************************************
Linux 和 macOS 平台工具链的标准设置
*********************************************
:link_to_translation:`en:[English]`
详细安装步骤
=========================
请根据下方详细步骤,完成安装过程。
设置开发环境
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
以下是为 {IDF_TARGET_NAME} 设置 ESP-IDF 的具体步骤。
* :ref:`get-started-prerequisites`
* :ref:`get-started-get-esp-idf`
* :ref:`get-started-set-up-tools`
* :ref:`get-started-set-up-env`
* :ref:`get-started-start-a-project`
.. _get-started-prerequisites:
第一步:安装准备
=============================
为了在 {IDF_TARGET_NAME} 中使用 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
.. note::
- 使用 ESP-IDF 需要 CMake 3.16 或以上版本。较早的 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
- 若以上均不适用,请访问 CMake_ 和 Ninja_ 主页,查询有关 macOS 平台的下载安装问题。
- 强烈建议同时安装 ccache_ 以获得更快的编译速度。如有 HomeBrew_可通过 MacPorts_ 上的 ``brew install ccache````sudo port install ccache`` 完成安装。
.. note::
如在上述任何步骤中遇到以下错误::
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
.. code-block:: bash
/usr/sbin/softwareupdate --install-rosetta --agree-to-license
安装 Python 3
---------------------------------------------
`Catalina 10.15 发布说明`_ 中表示不推荐使用 Python 2.7 版本,在未来的 macOS 版本中也不会默认包含 Python 2.7。执行以下命令来检查当前使用的 Python 版本::
python --version
如果输出结果是 ``Python 2.7.17``,则代表默认解析器是 Python 2.7。这时需要运行以下命令检查电脑上是否已经安装过 Python 3::
python3 --version
如果运行上述命令出现错误,则代表电脑上没有安装 Python 3。
请根据以下步骤安装 Python 3
- 使用 HomeBrew_ 进行安装的方法如下::
brew install python3
- 使用 MacPorts_ 进行安装的方法如下::
sudo port install python38
.. _get-started-get-esp-idf:
第二步:获取 ESP-IDF
=================================
在围绕 {IDF_TARGET_NAME} 构建应用程序之前,请先获取乐鑫提供的软件库文件 `ESP-IDF 仓库 <https://github.com/espressif/esp-idf>`_。
获取 ESP-IDF 的本地副本:打开终端,切换到要保存 ESP-IDF 的工作目录,使用 ``git clone`` 命令克隆远程仓库。针对不同操作系统的详细步骤,请见下文。
打开终端,运行以下命令:
.. include-build-file:: inc/git-clone-bash.inc
ESP-IDF 将下载至 ``~/esp/esp-idf``
请前往 :doc:`/versions`,查看 ESP-IDF 不同版本的具体适用场景。
.. _get-started-set-up-tools:
第三步:设置工具
=================================
除了 ESP-IDF 本身,还需要为支持 {IDF_TARGET_NAME} 的项目安装 ESP-IDF 使用的各种工具比如编译器、调试器、Python 包等。
.. code-block:: bash
cd ~/esp/esp-idf
./install.sh {IDF_TARGET_PATH_NAME}
或使用 Fish shell
.. code-block:: fish
cd ~/esp/esp-idf
./install.fish {IDF_TARGET_PATH_NAME}
上述命令仅仅为 {IDF_TARGET_NAME} 安装所需工具。如果需要为多个目标芯片开发项目,则可以一次性指定多个目标,如下所示:
.. code-block:: bash
cd ~/esp/esp-idf
./install.sh esp32,esp32s2
或使用 Fish shell
.. code-block:: fish
cd ~/esp/esp-idf
./install.fish esp32,esp32s2
如果需要一次性为所有支持的目标芯片安装工具,可以运行如下命令:
.. code-block:: bash
cd ~/esp/esp-idf
./install.sh all
或使用 Fish shell
.. code-block:: fish
cd ~/esp/esp-idf
./install.fish all
.. note::
对于 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 工具时出现的下载错误 <https://github.com/espressif/esp-idf/issues/4775>`_
下载工具备选方案
~~~~~~~~~~~~~~~~~~~~~~~~~~
ESP-IDF 工具安装器会下载 Github 发布版本中附带的一些工具,如果访问 Github 较为缓慢,可以设置一个环境变量,从而优先选择 Espressif 的下载服务器进行 Github 资源下载。
.. 注解:: 该设置只影响从 Github 发布版本中下载的单个工具,它并不会改变访问任何 Git 仓库的 URL。
要在安装工具时优先选择 Espressif 下载服务器,请在运行 ``install.sh`` 时使用以下命令:
.. code-block:: bash
cd ~/esp/esp-idf
export IDF_GITHUB_ASSETS="dl.espressif.com/github_assets"
./install.sh
.. note::
推荐国内用户使用国内的下载服务器,以加快下载速度。
.. code-block:: bash
cd ~/esp/esp-idf
export IDF_GITHUB_ASSETS="dl.espressif.cn/github_assets"
./install.sh
自定义工具安装路径
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
本步骤中介绍的脚本将 ESP-IDF 所需的编译工具默认安装在用户的根目录中,即 Linux 系统中的 ``$HOME/.espressif`` 目录。可以选择将工具安装到其他目录中,**但请在运行安装脚本前,导出环境变量 IDF_TOOLS_PATH**。注意,请确保用户账号已经具备了读写该路径的权限。
.. code-block:: bash
export IDF_TOOLS_PATH="$HOME/required_idf_tools_path"
./install.sh
. ./export.sh
如果修改了 ``IDF_TOOLS_PATH`` 变量,请在运行任意 ESP-IDF 工具或脚本前,将该变量导出到环境变量中。
.. note::
如未导出环境变量,大多数 shell 将不支持在变量赋值中使用 ``IDF_TOOLS_PATH``,例如 ``IDF_TOOLS_PATH="$HOME/required_idf_tools_path" ./install.sh``。因为即便在源脚本中导出或修改了该变量,当前的执行环境也不受变量赋值影响。
.. _get-started-set-up-env:
第四步:设置环境变量
=======================================
此时,刚刚安装的工具尚未添加至 PATH 环境变量,无法通过“命令窗口”使用这些工具。因此,必须设置一些环境变量。这可以通过 ESP-IDF 提供的另一个脚本进行设置。
请在需要运行 ESP-IDF 的终端窗口运行以下命令:
.. code-block:: bash
. $HOME/esp/esp-idf/export.sh
对于 fish shell仅支持 fish 3.0.0 及以上版本),请运行以下命令:
.. code-block:: bash
. $HOME/esp/esp-idf/export.fish
注意,命令开始的 "." 与路径之间应有一个空格!
如果需要经常运行 ESP-IDF可以为执行 ``export.sh`` 创建一个别名,具体步骤如下:
1. 复制并粘贴以下命令到 shell 配置文件中(``.profile````.bashrc````.zprofile`` 等)
.. code-block:: bash
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 的会话)。这违背了使用虚拟环境的目的,还可能影响其他软件的使用。
.. _get-started-start-a-project:
.. _get-started-build:
.. _get-started-configure:
.. _get-started-connect:
.. _get-started-linux-macos-first-steps:
第五步:开始使用 ESP-IDF 吧
========================================
.. include:: linux-macos-start-project.rst
.. include:: start-project.rst
建议:更新 ESP-IDF
======================
乐鑫会不时推出新版本的 ESP-IDF修复 bug 或提供新的功能。请注意ESP-IDF 的每个主要版本和次要版本都有相应的支持期限。支持期限满后,版本停止更新维护,用户可将项目升级到最新的 ESP-IDF 版本。更多关于支持期限的信息,请参考 :doc:`ESP-IDF 版本 <../versions>`
因此,在使用时,也应注意更新本地版本。最简单的方法是:直接删除本地的 ``esp-idf`` 文件夹,然后按照 :ref:`get-started-get-esp-idf` 中的指示,重新完成克隆。
另一种方法是仅更新变更的部分,具体方式请前往 :ref:`更新 ESP-IDF <updating>` 章节查看。具体更新步骤会根据使用的 ESP-IDF 版本有所不同。
注意,更新完成后,请再次运行安装脚本,以防新版 ESP-IDF 所需的工具也有所更新。具体请参考 :ref:`get-started-set-up-tools`
一旦重新安装好工具,请使用导出脚本更新环境,具体请参考 :ref:`get-started-set-up-env`
相关文档
=================
* :doc:`establish-serial-connection`
* `Eclipse Plugin <https://github.com/espressif/idf-eclipse-plugin/blob/master/README_CN.md>`_
* `VSCode Extension <https://github.com/espressif/vscode-esp-idf-extension/blob/master/docs/tutorial/install.md>`_
* :doc:`../api-guides/tools/idf-monitor`
.. toctree::
:hidden:
:maxdepth: 1
establish-serial-connection
flashing-troubleshooting
.. _AUR: https://wiki.archlinux.org/index.php/Arch_User_Repository
.. _First Steps on ESP-IDF: ../get-started/first-steps.html
.. _cmake: https://cmake.org/
.. _ninja: https://ninja-build.org/
.. _ccache: https://ccache.samba.org/
.. _homebrew: https://brew.sh/
.. _MacPorts: https://www.macports.org/install.php
.. _Catalina 10.15 发布说明: https://developer.apple.com/documentation/macos-release-notes/macos-catalina-10_15-release-notes