esp-idf/docs/zh_CN/get-started/windows-setup.rst

142 lines
6.0 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.

***********************************************
Windows 平台工具链的标准设置
***********************************************
:link_to_translation:`en:[English]`
概述
============
ESP-IDF 需要安装一些必备工具,才能围绕 {IDF_TARGET_NAME} 构建固件,包括 Python、Git、交叉编译器、CMake 和 Ninja 编译工具等。
本入门指南介绍了如何通过 **命令提示符** 进行有关操作。不过,安装 ESP-IDF 后,还可以使用 `Eclipse Plugin <https://github.com/espressif/idf-eclipse-plugin/blob/master/README_CN.md>`_ 或其他支持 CMake 的图形化工具 IDE。
.. note::
限定条件:
- 请注意 ESP-IDF 和 ESP-IDF 工具的安装路径不能超过 90 个字符,安装路径过长可能会导致构建失败。
- Python 或 ESP-IDF 的安装路径中一定不能包含空格或括号。
- 除非操作系统配置为支持 Unicode UTF-8否则 Python 或 ESP-IDF 的安装路径中也不能包括特殊字符(非 ASCII 码字符)
系统管理员可以通过如下方式将操作系统配置为支持 Unicode UTF-8``Control Panel`` > 更改 ``date````time``、或 ``number`` 格式 > ``Administrative tab`` > 更改 ``system locale`` > 勾选选项 ``Beta: Use Unicode UTF-8 for worldwide language support`` > ``Ok`` > 重启电脑。
.. _get-started-windows-tools-installer:
ESP-IDF 工具安装器
=======================
安装 ESP-IDF 必备工具最简易的方式是下载一个 ESP-IDF 工具安装器。
+-------------------+--------------------------------+
| |download-logo| | `Windows Installer Download`_ |
+-------------------+--------------------------------+
.. |download-logo| image:: ../../_static/logo_windows_install.png
:target: https://dl.espressif.com/dl/esp-idf/?idf=4.4
.. _Windows Installer Download: https://dl.espressif.com/dl/esp-idf/?idf=4.4
在线安装与离线安装的区别
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
在线安装程序非常小,可以安装 ESP-IDF 的所有版本。在安装过程中,安装程序只下载必要的依赖文件,包括 `Git For Windows`_ 安装器。在线安装程序会将下载的文件存储在缓存目录 ``%userprofile%/espressif`` 中。
离线安装程序不需要任何网络连接。安装程序中包含了所有需要的依赖文件,包括 `Git For Windows`_ 安装器。
安装内容
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
安装程序会安装以下组件:
- 内置的 Python
- 交叉编译器
- OpenOCD
- CMake_ 和 Ninja_ 编译工具
- ESP-IDF
安装程序允许将程序下载到现有的 ESP-IDF 目录。推荐将 ESP-IDF 下载到 ``%userprofile%\Desktop\esp-idf`` 目录下,其中 ``%userprofile%`` 代表家目录。
启动 ESP-IDF 环境
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
安装结束时,如果勾选了 ``Run ESP-IDF PowerShell Environment````Run ESP-IDF Command Prompt (cmd.exe)``,安装程序会在选定的提示符窗口启动 ESP-IDF。
``Run ESP-IDF PowerShell Environment``:
.. figure:: ../../_static/esp-idf-installer-screenshot-powershell.png
:align: center
:alt: 完成 ESP-IDF 工具安装向导时运行 Run ESP-IDF PowerShell Environment
:figclass: align-center
完成 ESP-IDF 工具安装向导时运行 Run ESP-IDF PowerShell Environment
.. figure:: ../../_static/esp-idf-installer-powershell.png
:align: center
:alt: ESP-IDF PowerShell
:figclass: align-center
ESP-IDF PowerShell
``Run ESP-IDF Command Prompt (cmd.exe)``:
.. figure:: ../../_static/esp-idf-installer-screenshot.png
:align: center
:alt: 完成 ESP-IDF 工具安装向导时运行 Run ESP-IDF Command Prompt (cmd.exe)
:figclass: align-center
完成 ESP-IDF 工具安装向导时运行 Run ESP-IDF Command Prompt (cmd.exe)
.. figure:: ../../_static/esp-idf-installer-command-prompt.png
:align: center
:alt: ESP-IDF 命令提示符窗口
:figclass: align-center
ESP-IDF 命令提示符窗口
使用命令提示符
========================
在后续步骤中,将介绍如何使用 Windows 的命令提示符进行操作。
ESP-IDF 工具安装器可在“开始”菜单中,创建一个打开 ESP-IDF 命令提示符窗口的快捷方式。本快捷方式可以打开 Windows 命令提示符(即 cmd.exe并运行 ``export.bat`` 脚本以设置各环境变量(比如 ``PATH````IDF_PATH`` 等)。此外,还可以通过 Windows 命令提示符使用各种已经安装的工具。
注意,本快捷方式仅适用 ESP-IDF 工具安装器中指定的 ESP-IDF 路径。如果电脑上存在多个 ESP-IDF 路径(比如需要不同版本的 ESP-IDF有以下两种解决方法
1. 为 ESP-IDF 工具安装器创建的快捷方式创建一个副本,并将新快捷方式的 ESP-IDF 工作路径指定为希望使用的 ESP-IDF 路径。
2. 或者,可以运行 ``cmd.exe``,并切换至希望使用的 ESP-IDF 目录,然后运行 ``export.bat``。注意,这种方法要求 ``PATH`` 中存在 Python 和 Git。如果在使用时遇到有关“找不到 Python 或 Git”的错误信息请使用第一种方法。
开始使用 ESP-IDF
========================
.. _get-started-windows-first-steps:
.. include:: windows-start-project.rst
.. include:: start-project.rst
相关文档
=================
想要自定义安装流程的高阶用户可参照:
* :doc:`windows-setup-update`
* :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
windows-setup-update
establish-serial-connection
flashing-troubleshooting
../api-guides/tools/idf-monitor
.. _CMake: https://cmake.org/download/
.. _Ninja: https://ninja-build.org/
.. _Python: https://www.python.org/downloads/windows/
.. _Git for Windows: https://gitforwindows.org/
.. _Github Desktop: https://desktop.github.com/