toolchain-setup-scratch
.. _Stable version: https://docs.espressif.com/projects/esp-idf/en/stable/
-.. _Releases page: https://github.com/espressif/esp-idf/releases
+.. _Releases page: https://github.com/espressif/esp-idf/releases
\ No newline at end of file
-***********
+***********
Get Started
***********
Project configuration - Home window
-In the menu, navigate to ``Serial flasher config`` > ``Default serial port`` to configure the serial port, where project will be loaded to. Confirm selection by pressing enter, save configuration by selecting ``< Save >`` and then exit menuconfig by selecting ``< Exit >``.
+In the menu, navigate to ``Serial flasher config`` > ``Default serial port`` to configure the serial port, where project will be loaded to. Confirm selection by pressing enter, save configuration by selecting ``< Save >`` and then exit ``menuconfig`` by selecting ``< Exit >``.
To navigate and use ``menuconfig``, press the following keys:
This command will compile the application and all ESP-IDF components, then it will generate the bootloader, partition table, and application binaries. After that, these binaries will be flashed onto your ESP32 board.
+If there are no issues by the end of the flash process, you will see messages (below) describing progress of the loading process. Then the board will be reset and the "hello_world" application will start up.
+
.. highlight:: none
::
Leaving...
Hard resetting...
-If there are no issues by the end of the flash process, you will see messages describing progress of the loading process. Then the module will be reset and the “hello_world” application will start up.
If you'd like to use the Eclipse IDE instead of running ``make``, check out the :doc:`Eclipse guide <eclipse-setup>`.
To exit IDF monitor use the shortcut ``Ctrl+]``.
-If IDF monitor fails shortly after the upload, of if instead of the messages above you see a random garbage similar to what is given below, your board is likely using a 26MHz crystal. Most development board designs use 40MHz, so ESP-IDF uses this frequency as a default value.
+If IDF monitor fails shortly after the upload, or if instead of the messages above you see a random garbage similar to what is given below, your board is likely using a 26MHz crystal. Most development board designs use 40MHz, so ESP-IDF uses this frequency as a default value.
.. code-block:: none
-.. include:: ../../en/get-started-cmake/get-started-devkitc-v2.rst
+ESP32-DevKitC V2 入门指南 (CMake)\r
+==================================\r
+\r
+:link_to_translation:`en: [English]`\r
+\r
+本指南介绍了如何开始使用 ESP32-DevKitC V2 开发板。\r
+\r
+\r
+准备工作\r
+--------\r
+\r
+* :ref:`ESP32-DevKitC V2 开发板 <get-started-esp32-devkitc-v2-board-front-cmake>`\r
+* USB A / micro USB B 数据线\r
+* PC（Windows、Linux 或 Mac OS）\r
+\r
+您可以跳过介绍部分，直接前往 `应用程序开发`_ 章节。\r
+\r
+\r
+概述\r
+----\r
+\r
+ESP32-DevKitC V2 是 `乐鑫 <https://espressif.com>`_ 一款基于 ESP32 的小型开发板，板上模组的绝大部分管脚均已引出，开发人员可根据实际需求，轻松通过跳线连接多种外围器件，或将开发板插在面包板上使用。\r
+\r
+\r
+功能说明\r
+--------\r
+\r
+ESP32-DevKitC V2 开发板的主要组件、接口及控制方式见下。\r
+\r
+.. _get-started-esp32-devkitc-v2-board-front-cmake:\r
+\r
+.. figure:: ../../_static/esp32-devkitc-v2-functional-overview.png\r
+ :align: center\r
+ :alt: ESP32-DevKitC V2 开发板\r
+ :figclass: align-center\r
+\r
+\r
+\r
+ESP32-DevKitC V2 开发板\r
+\r
++----------------+--------------------------------------------------------------------------------------------------------------------------+\r
+| 主要组件 | 基本介绍 |\r
++----------------+--------------------------------------------------------------------------------------------------------------------------+\r
+| ESP32-WROOM-32 | 基于 ESP32 的模组。更多详情，请见 `《ESP32-WROOM-32 技术规格书》`_。 |\r
++----------------+--------------------------------------------------------------------------------------------------------------------------+\r
+| EN | 复位按键。 |\r
++----------------+--------------------------------------------------------------------------------------------------------------------------+\r
+| Boot | 下载按键。按下 **Boot** 键并保持，同时按一下 **EN** 键（此时不要松开 **Boot** 键）进入“固件下载”模式，通过串口下载固件。 |\r
++----------------+--------------------------------------------------------------------------------------------------------------------------+\r
+| Micro USB 端口 | USB 接口。可用作电路板的供电电源，或连接 PC 和 ESP32-WROOM-32 模组的通信接口。 |\r
++----------------+--------------------------------------------------------------------------------------------------------------------------+\r
+| I/O | 板上模组的绝大部分管脚均已引出至开发板的排针。用户可以对 ESP32 进行编程，实现 PWM、ADC、DAC、I2C、I2S、SPI 等多种功能。 |\r
++----------------+--------------------------------------------------------------------------------------------------------------------------+\r
+\r
+电源选项\r
+--------\r
+\r
+开发板可任一选用以下三种供电方式：\r
+\r
+* Micro USB 供电（默认）\r
+* 5V / GND 管脚供电\r
+* 3V3 / GND 管脚供电\r
+\r
+.. warning::\r
+\r
+ 上述供电模式 **不可同时连接**，否则可能会损坏开发板和/或电源。\r
+\r
+\r
+应用程序开发\r
+------------\r
+\r
+ESP32-DevKitC V2 上电前，请首先确认开发板完好无损。\r
+\r
+之后，请前往 :doc:`index` 的 :ref:`get-started-step-by-step-cmake` 章节，查看如何设置开发环境，并尝试将示例项目烧录至您的开发板。\r
+\r
+相关文档\r
+--------\r
+\r
+* `ESP32-DevKitC 原理图 <https://dl.espressif.com/dl/schematics/ESP32-Core-Board-V2_sch.pdf>`_ (PDF)\r
+* `《ESP32 技术规格书》 <https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf>`_ (PDF)\r
+* `《ESP32-WROOM-32 技术规格书》 <https://espressif.com/sites/default/files/documentation/esp32-wroom-32_datasheet_cn.pdf>`_ (PDF)\r
+\r
-.. include:: ../../en/get-started-cmake/get-started-devkitc.rst
+ESP32-DevKitC V4 入门指南 (CMake)\r
+=============================================\r
+\r
+:link_to_translation:`en: [English]`\r
+\r
+本指南介绍了如何开始使用 ESP32-DevKitC V4 开发板。有关 ESP32-DevKitC 其他版本的介绍，请见：:doc:`../hw-reference/index`。\r
+\r
+\r
+准备工作\r
+-----------\r
+\r
+* :ref:`ESP32-DevKitC V4 开发板 <get-started-esp32-devkitc-board-front-cmake>`\r
+* USB A / micro USB B 数据线\r
+* PC（Windows、Linux 或 Mac OS）\r
+\r
+您可以跳过介绍部分，直接前往 `应用程序开发`_ 章节。\r
+\r
+\r
+.. _DevKitC-Overview-cmake:\r
+\r
+概述\r
+----\r
+\r
+ESP32-DevKitC V4 是 `乐鑫 <https://espressif.com>`_ 一款基于 ESP32 的小型开发板，板上模组的绝大部分管脚均已引出，开发人员可根据实际需求，轻松通过跳线连接多种外围器件，或将开发板插在面包板上使用。\r
+\r
+为了更好地满足不同用户需求，ESP32-DevKitC V4 还支持以下不同配置：\r
+\r
+- 可选多款 ESP32 模组\r
+\r
+ - :ref:`esp-modules-and-boards-esp32-wroom-32`\r
+ - :ref:`ESP32-WROOM-32D <esp-modules-and-boards-esp32-wroom-32d-and-u>`\r
+ - :ref:`ESP32-WROOM-32U <esp-modules-and-boards-esp32-wroom-32d-and-u>`\r
+ - :ref:`esp-modules-and-boards-esp32-solo-1`\r
+ - :ref:`ESP32-WROVER <esp-modules-and-boards-esp32-wrover>`\r
+ - :ref:`ESP32-WROVER-B <esp-modules-and-boards-esp32-wrover>`\r
+ - :ref:`ESP32-WROVER-I <esp-modules-and-boards-esp32-wrover>`\r
+ - :ref:`ESP32-WROVER-I (IPEX) <esp-modules-and-boards-esp32-wrover>`\r
+\r
+- 可选排针或排母\r
+\r
+详情请见 `《乐鑫产品订购信息》 <https://www.espressif.com/sites/default/files/documentation/espressif_products_ordering_information_cn.pdf>`_。\r
+\r
+\r
+功能说明\r
+---------\r
+\r
+ESP32-DevKitC V4 开发板的主要组件、接口及控制方式见下。\r
+\r
+.. _get-started-esp32-devkitc-board-front-cmake:\r
+\r
+.. figure:: ../../_static/esp32-devkitc-functional-overview.jpg\r
+ :align: center\r
+ :alt: ESP32-DevKitC V4（板载 ESP32-WROOM-32）\r
+ :figclass: align-center\r
+\r
+ESP32-DevKitC V4（板载 ESP32-WROOM-32）\r
+\r
+\r
++--------------------+--------------------------------------------------------------------------------------------------------------------------+\r
+| 主要组件 | 基本介绍 |\r
++--------------------+--------------------------------------------------------------------------------------------------------------------------+\r
+| ESP32-WROOM-32 | 基于 ESP32 的模组。更多详情，请见 `《ESP32-WROOM-32 技术规格书》`_。 |\r
++--------------------+--------------------------------------------------------------------------------------------------------------------------+\r
+| EN | 复位按键。 |\r
++--------------------+--------------------------------------------------------------------------------------------------------------------------+\r
+| Boot | 下载按键。按下 **Boot** 键并保持，同时按一下 **EN** 键（此时不要松开 **Boot** 键）进入“固件下载”模式，通过串口下载固件。 |\r
++--------------------+--------------------------------------------------------------------------------------------------------------------------+\r
+| USB-to-UART 桥接器 | 单芯片 USB-UART 桥接器，可提供高达 3 Mbps 的传输速率。 |\r
++--------------------+--------------------------------------------------------------------------------------------------------------------------+\r
+| Micro USB 端口 | USB 接口。可用作电路板的供电电源，或连接 PC 和 ESP32-WROOM-32 模组的通信接口。 |\r
++--------------------+--------------------------------------------------------------------------------------------------------------------------+\r
+| 5V Power On LED | 开发板通电后（USB 或外部 5 V），该指示灯将亮起。更多信息，请见 `相关文档`_ 中的原理图。 |\r
++--------------------+--------------------------------------------------------------------------------------------------------------------------+\r
+| I/O | 板上模组的绝大部分管脚均已引出至开发板的排针。用户可以对 ESP32 进行编程，实现 PWM、ADC、DAC、I2C、I2S、SPI 等多种功能。 |\r
++--------------------+--------------------------------------------------------------------------------------------------------------------------+\r
+\r
+.. note::\r
+\r
+ 管脚 D0、D1、D2、D3、CMD 和 CLK 用于 ESP32 芯片与 SPI flash 间的内部通信，集中分布在开发板两侧靠近 USB 端口的位置。通常而言，这些管脚最好不连，否则可能影响 SPI flash / SPI RAM 的工作。 \r
+\r
+.. note::\r
+\r
+ 管脚 GPIO16 和 GPIO17 仅适用于板载 ESP32-WROOM 系列和 ESP32-SOLO-1 的开发板，保留内部使用。\r
+\r
+\r
+电源选项\r
+--------\r
+\r
+开发板可任一选用以下三种供电方式：\r
+\r
+* Micro USB 供电（默认）\r
+* 5V / GND 管脚供电\r
+* 3V3 / GND 管脚供电\r
+\r
+.. warning::\r
+\r
+ 上述供电模式 **不可同时连接**，否则可能会损坏开发板和/或电源。\r
+\r
+\r
+有关 C15 的提示\r
+--------------------\r
+\r
+较早版本 ESP32-DevKitC 开发板上的 C15 可能存在以下问题：\r
+\r
+* 开发板上电后可能进入下载模式；\r
+* 如果用户通过 GPIO0 输出时钟，C15 可能会影响信号。\r
+\r
+用户如果认为 C15 可能影响开发板的使用，则可以将 C15 完全移除。C15 在开发板上的具体位置见下图黄色部分。\r
+\r
+.. figure:: ../../_static/esp32-devkitc-c15-location.png\r
+ :align: center\r
+ :alt: C15（黄色）在 ESP32-DevKitC V4 开发板上的位置\r
+ :figclass: align-center\r
+ :width: 30%\r
+\r
+C15（黄色）在 ESP32-DevKitC V4 开发板上的位置\r
+\r
+\r
+应用程序开发\r
+-----------------\r
+\r
+ESP32-DevKitC V4 上电前，请首先确认开发板完好无损。\r
+\r
+之后，请前往 之后，请前往 :doc:`index` 的 :ref:`get-started-step-by-step-cmake` 章节，查看如何设置开发环境，并尝试将示例项目烧录至您的开发板。\r
+\r
+\r
+开发板尺寸\r
+-------------\r
+\r
+.. figure:: ../../_static/esp32-devkitc-dimensions-back.jpg\r
+ :align: center\r
+ :alt: ESP32-DevKitC 开发板尺寸 -- 仰视图\r
+ :figclass: align-center\r
+\r
+ESP32-DevKitC 开发板尺寸 -- 仰视图\r
+\r
+\r
+相关文档\r
+-----------\r
+\r
+* `ESP32-DevKitC V4 原理图 <https://dl.espressif.com/dl/schematics/esp32_devkitc_v4-sch.pdf>`_ (PDF)\r
+* `《ESP32 技术规格书》 <https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf>`_ (PDF)\r
+* `《ESP32-WROOM-32 技术规格书》 <https://espressif.com/sites/default/files/documentation/esp32-wroom-32_datasheet_cn.pdf>`_ (PDF)\r
+* `《ESP32-WROOM-32D & ESP32-WROOM-32U 技术规格书》 <https://www.espressif.com/sites/default/files/documentation/esp32-wroom-32d_esp32-wroom-32u_datasheet_cn.pdf>`_ (PDF)\r
+* `《ESP32-WROVER 技术规格书》 <https://espressif.com/sites/default/files/documentation/esp32_wrover_datasheet_cn.pdf>`_ (PDF)\r
+* `《ESP32-WROVER-B 技术规格书》 <https://www.espressif.com/sites/default/files/documentation/esp32-wrover-b_datasheet_cn.pdf>`_ (PDF)\r
+* `《乐鑫产品订购信息》 <https://www.espressif.com/sites/default/files/documentation/espressif_products_ordering_information_cn.pdf>`_ (PDF)\r
+\r
+.. toctree::\r
+ :hidden:\r
+\r
+ get-started-devkitc-v2
\ No newline at end of file
-********************************\r
-快速入门 (CMake)\r
-********************************\r
+*******************\r
+快速入门（CMake）\r
+*******************\r
\r
-:link_to_translation:`en:[英文]`\r
+:link_to_translation:`en:[English]`\r
\r
.. include:: ../cmake-warning.rst\r
\r
.. include:: ../cmake-pending-features.rst\r
\r
-本文档旨在指导用户创建 ESP32 的软件环境。本文将通过一个简单的例子，说明 ESP-IDF (Espressif IoT Development Framework) 的使用方法，包括配置、编译、下载固件到开发板等步骤。\r
+本文档旨在指导用户搭建 ESP32 硬件开发的软件环境，\r
+\r
+通过一个简单的示例展示如何使用 ESP-IDF (Espressif IoT Development Framework) 配置菜单，并编译、下载固件至 ESP32 开发板等步骤。\r
\r
.. include:: /_build/inc/version-note.inc\r
\r
概述\r
-============\r
+====\r
+\r
+ESP32 SoC 芯片支持以下功能：\r
\r
-ESP32 是一套 Wi-Fi (2.4 GHz) 和蓝牙 (4.2) 双模解决方案，集成了高性能的 CPU 内核、超低功耗协处理器和丰富的外设。ESP32 采用 40 nm 工艺制成，具有最佳的功耗性能、射频性能、稳定性、通用性和可靠性，适用于各种应用和不同功耗需求。\r
+* 2.4 GHz Wi-Fi\r
+* 蓝牙 4.2 标准\r
+* 高性能双核\r
+* 超低功耗协处理器\r
+* 多种外设\r
\r
-乐鑫为用户提供完整的软、硬件资源，支持 ESP32 设备的开发。我们的软件开发环境 ESP-IDF 能够帮助用户快速开发物联网 (IoT) 应用，满足用户对于 Wi-Fi、蓝牙、低功耗等性能的需求。\r
+ESP32 采用 40 nm 工艺制成，具有最佳的功耗性能、射频性能、稳定性、通用性和可靠性，适用于各种应用场景和不同功耗需求。\r
\r
+乐鑫为用户提供完整的软、硬件资源，进行 ESP32 硬件设备的开发。其中，乐鑫的软件开发环境 ESP-IDF 旨在协助用户快速开发物联网 (IoT) 应用，可满足用户对 Wi-Fi、蓝牙、低功耗等方面的要求。\r
\r
准备工作\r
-====================\r
+========\r
+\r
+硬件：\r
+\r
+* 一款 **ESP32** 开发板\r
+* **USB 数据线** （USB A/Micro USB B）\r
+* PC（Windows、Linux 或 Mac OS）\r
\r
-开发 ESP32 应用程序需要准备：\r
+软件：\r
+\r
+* 设置 **工具链**，用于编译 ESP32 代码；\r
+* **编译工具** —— CMake 和 Ninja 编译工具，用于编译 ESP32 **应用程序**；\r
+* 获取 **ESP-IDF** 软件开发框架。该框架已经基本包含 ESP32 使用的 API（软件库和源代码）和运行 **工具链** 的脚本；\r
+* 安装 C 语言编程（**工程**）的 **文本编辑器**，例如 `Eclipse <https://www.eclipse.org/>`_。\r
\r
-* **电脑**：安装 Windows、Linux 或者 Mac 操作系统\r
-* **工具链**：用于编译 ESP32 代码\r
-* **编译工具**：用于编译 ESP32 完整**应用程序**的 CMake 和 Ninja\r
-* **ESP-IDF**：包含 ESP32 API 和用于操作 **工具链** 的脚本\r
-* **文本编辑器**：编写 C 语言程序，例如 `Eclipse <https://www.eclipse.org/>`_\r
-* **ESP32 开发板** 和将其连接到 **电脑** 的 **USB 线**\r
\r
.. figure:: ../../_static/what-you-need-cmake.png\r
:align: center\r
- :alt: Development of applications for ESP32\r
+ :alt: ESP32 应用程序开发\r
:figclass: align-center\r
\r
- 开发应用程序\r
+ ESP32 应用程序开发\r
\r
-开发环境的准备工作包括以下两部分：\r
\r
-1. 设置 **工具链**\r
-2. 从 GitHub 上获取 **ESP-IDF** \r
+开发板简介\r
+==========\r
\r
-开发环境设置完成后，遵循以下步骤创建 ESP-IDF 应用程序：\r
+请点击下方连接，了解有关具体开发板的详细信息。\r
\r
-1. 配置**工程** 并编写代码\r
-2. 编译**工程** 并链接成一个**应用程序**\r
-3. 通过 USB/串口连接，烧录（上传）预编译的**应用程序**到 **ESP32**\r
-4. 通过 USB/串口，监视/调试**应用程序**输出 \r
+.. toctree::\r
+ :maxdepth: 1\r
\r
+ ESP32-DevKitC <get-started-devkitc>\r
+ ESP-WROVER-KIT <get-started-wrover-kit>\r
+ ESP32-PICO-KIT <get-started-pico-kit>\r
\r
-.. The label below is placeholder to link a new section "Installation Step by Step"\r
\r
.. _get-started-step-by-step-cmake:\r
\r
-开发板指南\r
-========================\r
+详细安装步骤\r
+==============\r
\r
-如果你有下列任一 ESP32 开发板，请点击对应的链接进行硬件设置：\r
+请根据下方详细步骤，完成安装过程。\r
\r
-.. toctree::\r
- :maxdepth: 1\r
+设置开发环境\r
+~~~~~~~~~~~~~~~~\r
\r
- ESP32 DevKitC <get-started-devkitc>\r
- ESP-WROVER-KIT <get-started-wrover-kit>\r
- ESP32-PICO-KIT <get-started-pico-kit>\r
+* :ref:`get-started-setup-toolchain-cmake`\r
+* :ref:`get-started-get-esp-idf-cmake`\r
+* :ref:`get-started-setup-path-cmake`\r
+* :ref:`get-started-get-packages-cmake`\r
\r
-如果你使用其它开发板，请查看下面的内容。\r
+创建您的第一个工程\r
+~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
+\r
+* :ref:`get-started-start-project-cmake`\r
+* :ref:`get-started-connect-cmake`\r
+* :ref:`get-started-configure-cmake`\r
+* :ref:`get-started-build-cmake`\r
+* :ref:`get-started-flash-cmake`\r
+* :ref:`get-started-build-monitor-cmake`\r
\r
\r
.. _get-started-setup-toolchain-cmake:\r
\r
-设置工具链\r
-======================\r
+第一步：设置工具链\r
+====================\r
+\r
+工具链指一套用于编译代码和应用程序的程序。\r
\r
-用 ESP32 进行开发最快的方法是安装预编译的工具链。请根据你的操作系，点击对应的链接，并按照链接中的指导进行安装。\r
+为了加快开发进度，您可以直接使用乐鑫提供的预制工具链。请根据您的操作系统，点击下方对应的链接，并按照链接中的指导进行安装。\r
\r
.. toctree::\r
:hidden:\r
\r
Windows <windows-setup>\r
- Linux <linux-setup> \r
- MacOS <macos-setup> \r
+ Linux <linux-setup>\r
+ MacOS <macos-setup>\r
\r
+-------------------+-------------------+-------------------+\r
| |windows-logo| | |linux-logo| | |macos-logo| |\r
\r
.. note::\r
\r
- 我们使用用户名主目录下的 ``esp`` 子目录（Linux 和 MacOS 为 ``~/esp``，Windows 为 ``%userprofile%\esp``）来进行一切有关 ESP-IDF 的安装操作。你也可以使用其他目录，但是需要注意调整相应的指令。\r
+ 在本文档中，Linux 和 MacOS 操作系统中 ESP-IDF 的默认安装路径为 ``~/esp``；Windows 操作系统的默认路径为 ``%userprofile%\esp``。您也可以将 ESP-IDF 安装在任何其他路径下，但请注意在使用命令行时进行相应替换。注意，ESP-IDF 不支持带有空格的路径。\r
\r
-你可以安装预编译的工具链或者自定义你的环境，这完全取决于个人经验和偏好。如果你要自定义环境，请参考 :ref:`get-started-customized-setup-cmake`。\r
+此外， 您也可以根据自身经验和实际需求，对环境进行个性化设置，而非使用预制工具链。此时，请前往 :ref:`工具链的个性化设置<get-started-customized-setup-cmake>` 章节获取更多信息。\r
\r
-工具链设置完成后，继续阅读 :ref:`get-started-get-esp-idf-cmake` 一节。\r
\r
.. _get-started-get-esp-idf-cmake:\r
\r
-获取 ESP-IDF\r
-==================\r
+第二步：获取 ESP-IDF\r
+===========================\r
\r
-工具链（包括用于编译和构建应用程序的程序）安装完成后，你还需要 ESP32 相关的 API/库。你可在乐鑫提供的 `ESP-IDF 仓库 <https://github.com/espressif/esp-idf>`_ 中获取 API/库本地副本。打开终端，切换到你要存放 ESP-IDF 的目录，然后使用 ``git clone`` 命令克隆远程仓库。\r
+除了工具链，您还需要供 ESP32 使用的 API（软件库和源代码），具体请见 `ESP-IDF 仓库 <https://github.com/espressif/esp-idf>`_。\r
\r
-Linux 和 MacOS\r
-~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
+请将 ESP-IDF 下载到您的本地。\r
\r
-获取本地副本：打开终端，切换到你要存放 ESP-IDF 的工作目录，使用 ``git clone`` 命令克隆远程仓库:\r
+获取本地副本：打开终端，切换到你要存放 ESP-IDF 的工作目录，使用 ``git clone`` 命令克隆远程仓库。\r
+\r
+Linux 和 MacOS 操作系统\r
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
+\r
+打开终端，后运行以下命令：\r
\r
.. include:: /_build/inc/git-clone-bash.inc\r
\r
-ESP-IDF 将会被下载到 ``~/esp/esp-idf`` 目录下。\r
+ESP-IDF 将下载至 ``~/esp/esp-idf``。\r
+\r
+请前往 :doc:`/versions`，查看 ESP-IDF 不同版本的具体适用场景。\r
+\r
+Windows 操作系统\r
+~~~~~~~~~~~~~~~~~~\r
+\r
+.. note::\r
+\r
+ 较早版本 ESP-IDF 使用了 **MSYS2 bash 终端** 命令行。目前，基于 CMake 的编译系统可使用常见的 **Windows 命令窗口**，即本指南中使用的终端。\r
\r
-有关在给定情况下使用哪个 ESP-IDF 版本的信息，请参阅 :doc:`/versions` 。\r
+请注意，如果您使用基于 bash 的终端或 PowerShell 终端，一些命令语法将与下面描述有所不同。\r
\r
-Windows Command Prompt\r
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
+打开命令提示符，后运行以下命令：\r
\r
.. include:: /_build/inc/git-clone-windows.inc\r
\r
-ESP-IDF å°\86ä¼\9a被ä¸\8bè½½å\88°ç\94¨æ\88·ç\9a\84 ``esp\esp-idf`` ç\9b®å½\95ä¸\8b。\r
+ESP-IDF å°\86ä¸\8bè½½è\87³ ``%userprofile%\esp\esp-idf``。\r
\r
-有关在给定情况下使用哪个 ESP-IDF 版本的信息，请参阅 :doc:`/versions` 。\r
+请前往 :doc:`/versions`，查看 ESP-IDF 不同版本的具体适用场景。\r
\r
.. include:: /_build/inc/git-clone-notes.inc\r
\r
-.. highlight:: bash\r
.. note::\r
\r
- 注意这里有个 ``--recursive`` 选项。如果你克隆 ESP-IDF 时没有带这个选项，你还需要运行额外的命令来获取子模块::\r
+ 在克隆远程仓库时，不要忘记加上 ``--recursive`` 选项。否则，请接着运行以下命令，获取所有子模块： :: \r
\r
cd esp-idf\r
git submodule update --init\r
\r
.. _get-started-setup-path-cmake:\r
\r
-设置环境变量\r
+第三步：设置环境变量\r
===========================\r
\r
-ESP-IDF 的正常运行需要设置两个环境变量：\r
+请在您的 PC 上设置以下环境变量，否则无法编译工程。\r
\r
- ``IDF_PATH`` 应设置为 ESP-IDF 根目录的路径。\r
-- ``PATH`` 应包括同一 ``IDF_PATH`` 目录下的 ``tools`` 目录路径。 \r
+- ``PATH`` 应包括同一 ``IDF_PATH`` 目录下的 ``tools`` 目录路径。\r
+\r
+您可以在每次重启会话时手动设置，也可以在用户配置中进行永久设置，具体请前往 :doc:`add-idf_path-to-profile` 章节，查看 :ref:`Windows <add-paths-to-profile-windows-cmake>` 、:ref:`Linux 及 MacOS <add-idf_path-to-profile-linux-macos-cmake>` 操作系统的具体设置方式。\r
+\r
+\r
+.. _get-started-get-packages-cmake:\r
+\r
+第四步：安装 Python 软件包\r
+=================================\r
+\r
+ESP-IDF 所需的 Python 软件包位于 ``IDF_PATH/requirements.txt`` 中。您可以运行以下命令进行安装： ::\r
+\r
+ python -m pip install --user -r $IDF_PATH/requirements.txt\r
+\r
+.. note::\r
\r
-你需在你的电脑中设置这两个变量，否则工程将不能编译。\r
+ 请注意查询您所使用的 Python 解释器的版本（运行命令 ``python --version``），并根据查询结果将上方命令中的 ``python`` 替换为 ``python2``, ``python2.7``，例如：\r
\r
-你可以在每次 PC 重启时手动设置，你也可以在用户配置中进行永久设置，具体请参照 :doc:`add-idf_path-to-profile` 小节中的 :ref:`Windows <add-paths-to-profile-windows-cmake>`，:ref:`Linux 和 MacOS <add-idf_path-to-profile-linux-macos-cmake>` 相关指导进行操作。\r
+ ``python2.7 -m pip install --user -r $IDF_PATH/requirements.txt``\r
\r
.. _get-started-start-project-cmake:\r
\r
-创建一个工程\r
-======================\r
+第五步：开始创建工程\r
+=======================\r
\r
-现在可以开始创建 ESP32 应用程序了。为了快速开始，我们这里以 IDF 的 :idf:`examples` 目录下的 :example:`get-started/hello_world` 工程为例进行说明。\r
+现在，您可以开始准备开发 ESP32 应用程序了。您可以从 ESP-IDF 中 :idf:`examples` 目录下的 :example:`get-started/hello_world` 工程开始。\r
\r
-将 :example:`get-started/hello_world` 拷贝到 ``~/esp`` 目录：\r
+将 :example:`get-started/hello_world` 复制至您本地的 ``~/esp`` 目录下：\r
\r
-Linux 和 MacOS\r
-~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
+Linux 和 MacOS 操作系统\r
+~~~~~~~~~~~~~~~~~~~~~~~~~~\r
\r
.. code-block:: bash\r
\r
cd ~/esp\r
cp -r $IDF_PATH/examples/get-started/hello_world .\r
\r
-Windows Command Prompt\r
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
+Windows 操作系统\r
+~~~~~~~~~~~~~~~~~~~~~~\r
\r
.. code-block:: batch\r
\r
cd %userprofile%\esp\r
xcopy /e /i %IDF_PATH%\examples\get-started\hello_world hello_world\r
\r
-ESP-IDF 的 :idf:`examples` 目录下有一系列示例工程，都可以按照上面的方法进行创建。\r
-\r
-你也可以在原有位置创建示例，无需事先拷贝这些示例。\r
+ESP-IDF 的 :idf:`examples` 目录下有一系列示例工程，都可以按照上面的方法进行创建。您可以按照上述方法复制并运行其中的任何示例，也可以直接编译示例，无需进行复制。\r
\r
.. important::\r
\r
- esp-idf 构建系统不支持在路径中存在空格。\r
+ ESP-IDF 编译系统不支持带有空格的路径。\r
\r
.. _get-started-connect-cmake:\r
\r
-连接\r
-=======\r
+第六步：连接设备\r
+======================\r
+\r
+现在，请将您的 ESP32 开发板连接到 PC，并查看开发板使用的串口。\r
+\r
+通常，串口在不同操作系统下显示的名称有所不同：\r
+\r
+- **Windows 操作系统：** ``COM1`` 等\r
+- **Linux 操作系统：** 以 ``/dev/tty`` 开始\r
+- **MacOS 操作系统：** 以 ``/dev/cu.`` 开始\r
+\r
+有关如何查看串口名称的详细信息，请见 :doc:`establish-serial-connection`。\r
+\r
+.. note::\r
+\r
+ 请记住串口名，您会在下面的步骤中用到。\r
\r
-还有几个步骤就完成了。在继续后续操作前，先将 ESP32 开发板连接到 PC，然后检查串口号，看看它能否正常通信。如果你不知道如何操作，请查看 :doc:`establish-serial-connection` 中的相关指导。请注意一下端口号，我们在下一步中会用到。\r
\r
.. _get-started-configure-cmake:\r
\r
-配置\r
-=========\r
+第七步：配置\r
+=================\r
\r
-è¿\9bå\85¥ ``hello_world`` åº\94ç\94¨ç¨\8båº\8få\89¯æ\9c¬ç\9b®å½\95ï¼\8cè¿\90è¡\8c ``menuconfig`` å·¥ç¨\8bé\85\8d置工å\85·ï¼\9a\r
+请è¿\9bå\85¥ :ref:`get-started-start-project-cmake` ä¸æ\8f\90å\88°ç\9a\84 ``hello_world`` ç\9b®å½\95ï¼\8c并è¿\90è¡\8cå·¥ç¨\8bé\85\8d置工å\85· ``menuconfig``ã\80\82\r
\r
-Linux 和 MacOS\r
-~~~~~~~~~~~~~~~~~~~~~\r
+Linux 和 MacOS 操作系统\r
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
\r
.. code-block:: bash\r
\r
cd ~/esp/hello_world\r
idf.py menuconfig\r
\r
-Windows Command Prompt\r
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
+如果您的默认 Python 版本为 3.0 以上，可能需要运行 ``python2 idf.py`` 。\r
+\r
+Windows 操作系统\r
+~~~~~~~~~~~~~~~~~~~~~\r
\r
.. code-block:: batch\r
\r
cd %userprofile%\esp\hello_world\r
idf.py menuconfig\r
\r
-.. note:: 如果你收到未发现 ``idf.py`` 的报错信息，查看是否如上 :ref:`get-started-setup-path-cmake` 所述将 ``tools`` 目录添加到你的路径中。如果 ``tools`` 目录中没有 ``idf.py``，查看 :ref:`get-started-get-esp-idf-cmake` 中 CMake 预览所处的分支是否正确。 \r
+Python 2.7 安装程序将尝试配置 Windows，将 ``.py`` 文件与 Python 2 关联起来。如果其他程序（比如 Visual Studio Python 工具）曾关联了其他版本 Python，则 ``idf.py`` 可能无法正常运行（文件将在 Visual Studio 中打开）。这种情况下，您可以选择每次都运行一遍 ``C:\Python27\python idf.py``，或更改 Windows 的 ``.py`` 关联文件设置。\r
\r
-.. note:: 对于 Windows 用户而言，Python 2.7 安装器会尝试配置 Windows，关联扩展名为 ``.py`` 的 Python 2 文件。如果单独安装的程序（如 Visual Studio Python 工具）关联到其他 Python 版本，``idf.py`` 可能无法运行（而仅是在 Visual Studio 中打开此文件）。你可以每次运行 ``C:\Python27\python idf.py`` 或更改 Windows 中有关``.py`` 文件的关联设置。\r
+.. note::\r
\r
-.. note:: 对于 Linux 用户而言，如果默认为 Python 3.x 版本，你需要运行 ``python2 idf.py``。\r
+ 如果出现 ``idf.py not found（无法找到 idf.py）`` 错误，请确保 ``PATH`` 环境变量设置无误，具体请参考 :ref:`get-started-setup-path-cmake`。如果 ``tools`` 目录下没有 ``idf.py`` 文件，请确保 CMake 预览的分支正确无误，具体请参考 :ref:`get-started-get-esp-idf-cmake`。\r
\r
如果之前的步骤都正确，则会显示下面的菜单：\r
\r
.. figure:: ../../_static/project-configuration.png\r
:align: center\r
- :alt: Project configuration - Home window\r
+ :alt: 工程配置 — 主窗口\r
:figclass: align-center\r
\r
- 工程配置 - 主窗口\r
+ 工程配置 — 主窗口\r
\r
-下面是一些使用 ``menuconfig`` 的小技巧：\r
+``menuconfig`` 工具的常见操作见下。\r
\r
-* 使用 up & down 组合键在菜单中上下移动\r
-* 使用 Enter 键进入一个子菜单，Escape 键进入上一层菜单或退出整个菜单\r
-* 输入 ``?`` 查看帮助信息，Enter 键退出帮助屏幕\r
-* 使用空格键或 ``Y`` 和 ``N`` 键来使能 (Yes) 和禁止 (No) 带有复选框 "``[*]``" 的配置项\r
-* 当光标在某个配置项上面高亮时，输入 ``?`` 可以直接查看该项的帮助信息\r
-* 输入 ``/`` 搜索配置项\r
+* ``上下箭头``：移动\r
+* ``回车``：进入子菜单\r
+* ``ESC 键``：返回上级菜单或退出\r
+* ``英文问号``：调出帮助菜单（退出帮助菜单，请按回车键）。\r
+* ``空格``、``Y 键``或``N 键``：使能/禁用 ``[*]`` 配置选项\r
+* ``英文问号``：调出有关高亮选项的帮助菜单\r
+* ``/ 键``：寻找配置项目\r
\r
.. attention::\r
\r
- 如果 ESP32-DevKitC 板载的是 ESP32-SOLO-1 模组，请务必在烧写示例程序之前在 menuconfig 中使能单核模式（:ref:`CONFIG_FREERTOS_UNICORE`）。\r
+ 如果您使用的是 ESP32-DevKitC（板载 ESP32-SOLO-1 模组），请在烧写示例程序前，前往 ``menuconfig`` 中使能单核模式（:ref:`CONFIG_FREERTOS_UNICORE`）。\r
\r
.. _get-started-build-cmake:\r
\r
-创建一个工程\r
-==========================\r
-\r
-.. highlight:: bash\r
+第八步：编译工程\r
+==================\r
\r
-现在可以编译工程了，执行指令::\r
+请使用以下命令，编译烧录工程：::\r
\r
idf.py build\r
\r
-è¿\99æ\9d¡å\91½ä»¤ä¼\9aç¼\96è¯\91åº\94ç\94¨ç¨\8båº\8få\92\8cæ\89\80æ\9c\89ç\9a\84 ESP-IDF ç»\84件ï¼\8cç\94\9fæ\88\90 bootloaderã\80\81å\8cºå\88\86表å\92\8cåº\94ç\94¨ç¨\8båº\8f bin 文件。\r
+è¿\90è¡\8c以ä¸\8aå\91½ä»¤å\8f¯ä»¥ç¼\96è¯\91åº\94ç\94¨ç¨\8båº\8få\92\8cæ\89\80æ\9c\89 ESP-IDF ç»\84件ï¼\8cæ\8e¥ç\9d\80ç\94\9fæ\88\90 bootloaderã\80\81å\88\86å\8cºè¡¨å\92\8cåº\94ç\94¨ç¨\8båº\8fäº\8cè¿\9bå\88¶文件。\r
\r
.. code-block:: none\r
\r
../../../components/esptool_py/esptool/esptool.py -p (PORT) -b 921600 write_flash --flash_mode dio --flash_size detect --flash_freq 40m 0x10000 build/hello-world.bin build 0x1000 build/bootloader/bootloader.bin 0x8000 build/partition_table/partition-table.bin\r
or run 'idf.py -p PORT flash'\r
\r
-如果没有任何报错，将会生成 bin 文件，至此编译完成。\r
+如果一切正常，编译完成后将生成 .bin 文件。\r
+\r
\r
.. _get-started-flash-cmake:\r
\r
-烧录到设备\r
-==========================\r
+第ä¹\9dæ¥ï¼\9aç\83§å½\95å\88°è®¾å¤\87\r
+====================\r
\r
-现在可以将应用程序烧录到 ESP32 板子上，执行指令::\r
+请使用以下命令，将刚刚生成的二进制文件烧录至您的 ESP32 开发板： ::\r
\r
- idf.py -p PORT flash\r
+ idf.py -p PORT [-b BAUD] flash\r
\r
-将端口改为 ESP32 板子的串口名称。Windows 平台的端口名称类似 ``COM1``，而 MacOS 则以 ``/dev/cu.`` 开头，Linux 则是 ``/dev/tty``。详情请参照 :doc:`establish-serial-connection`。\r
+请将 PORT 替换为 ESP32 开发板的串口名称，具体可见 :ref:`get-started-connect-cmake`。\r
\r
-该步骤旨在将此前编译的 bin 文件烧录到 ESP32 板子上。\r
+您还可以将 BAUD 替换为您希望的烧录波特率。默认波特率为 ``460800``。\r
\r
-.. note:: 无需在 ``idf.py flash`` 之前运行 ``idf.py build``，烧录这一步会按照烧录前编写的要求（如有）自动编写工程。\r
+更多有关 idf.py 参数的详情，请见 :ref:`idf.py`。\r
+\r
+.. note::\r
+\r
+ 勾选 ``flash`` 选项将自动编译并烧录工程，因此无需再运行 ``idf.py build``。\r
\r
.. code-block:: none\r
\r
Compressed 136672 bytes to 67544...\r
Wrote 136672 bytes (67544 compressed) at 0x00010000 in 1.9 seconds (effective 567.5 kbit/s)...\r
Hash of data verified.\r
- \r
+\r
Leaving...\r
Hard resetting via RTS pin...\r
\r
-如果没有任何问题，在烧录的最后阶段，板子将会复位，应用程序 "hello_world" 开始运行。\r
+如果一切顺利，烧录完成后，开发板将会复位，应用程序 "hello_world" 开始运行。\r
+\r
+.. note::\r
\r
-.. （目前暂不支持）如果你想使用 Eclipse IDE 而不是运行 ``idf.py``，请参考 :doc:`Eclipse guide <eclipse-setup>`。\r
+ （目前不支持）如果您希望使用 Eclipse IDE，而非 ``idf.py``，请参考 :doc:`Eclipse 指南 <eclipse-setup>`。\r
\r
\r
.. _get-started-build-monitor-cmake:\r
\r
-监视器\r
-================\r
+第十步：监视器\r
+==================\r
+\r
+您可以使用 ``make monitor`` 命令，监视 “hello_world” 的运行情况。注意，不要忘记将 PORT 替换为您的串口名称。\r
\r
-如果要查看 "hello_world" 程序是否真的在运行，输入命令 ``idf.py -p PORT monitor``。这个命令会启动 :doc:`IDF Monitor <../api-guides/tools/idf-monitor>` 程序::\r
+运行该命令后，:doc:`IDF 监视器 <../api-guides/tools/idf-monitor>` 应用程序将启动： ::\r
\r
$ idf.py -p /dev/ttyUSB0 monitor\r
Running idf_monitor in directory [...]/esp/hello_world/build\r
ets Jun 8 2016 00:22:57\r
...\r
\r
-在启动消息和诊断消息后，你就能看到 "Hello world!" 程序所打印的消息：\r
+此时，您就可以在启动日志和诊断日志之后，看到打印的 “Hello world!” 了。\r
\r
.. code-block:: none\r
\r
Restarting in 8 seconds...\r
Restarting in 7 seconds...\r
\r
-要退出监视器，请使用快捷键 ``Ctrl+]``。\r
+您可使用快捷键 ``Ctrl+]``，退出 IDF 监视器。\r
\r
-.. note::\r
+如果 IDF 监视器在烧录后很快发生错误，或打印信息全是乱码（见下），很有可能是因为您的开发板选用了 26 MHz 晶振，而 ESP-IDF 默认支持大多数开发板使用的 40 MHz 晶振。\r
\r
- 如果串口打印的不是上面显示的消息而是类似下面的乱码::\r
+.. code-block:: none\r
\r
- e���)(Xn@�y.!��(�PW+)��Hn9a/9�!�t5��P�~�k��e�ea�5�jA\r
- ~zY��Y(1�,1\15�� e���)(Xn@�y.!Dr�zY(�\ 6jpi�|�+z5Ymvp\r
+ e���)(Xn@�y.!��(�PW+)��Hn9a/9�!�t5��P�~�k��e�ea�5�jA\r
+ ~zY��Y(1�,1\15�� e���)(Xn@�y.!Dr�zY(�\ 6jpi�|�+z5Ymvp\r
\r
- 或者监视器程序启动失败，那么可能你的开发板用的是 26 MHz 晶振，而大多数开发板用的是 40 MHz 晶振，并且 ESP-IDF 默认的也是这一数值。请退出监视器，回到 :ref:`menuconfig <get-started-configure-cmake>`，将 :ref:`CONFIG_ESP32_XTAL_FREQ_SEL` 改为 26 MHz，然后再次 :ref:`编写和烧录 <get-started-flash-cmake>` 程序。请在 ``idf.py menuconfig`` 的 Component config --> ESP32-specific --> Main XTAL frequency 中配置。\r
+此时，请您：\r
\r
-.. note::\r
+1. 退出监视器。\r
+2. 打开 :ref:`menuconfig <get-started-configure-cmake>`，\r
+3. 进入 ``Component config`` --> ``ESP32-specific`` --> ``Main XTAL frequency`` 进行配置，将 :ref:`CONFIG_ESP32_XTAL_FREQ_SEL` 设置为 26 MHz。\r
+4. 然后，请重新 :ref:`编译和烧录 <get-started-flash-cmake>` 应用程序。\r
\r
- 你可以将编写、烧录和监视整合到一步当中，如下所示::\r
+.. note::\r
\r
- idf.py -p PORT flash monitor\r
+ 您也可以运行以下命令，一次性执行构建、烧录和监视过程：\r
\r
-有关监视器使用的快捷键和其他详情，请参阅 :doc:`IDF Monitor <../api-guides/tools/idf-monitor>`。\r
+ ``idf.py -p PORT flash monitor``\r
\r
-æ\9c\89å\85³ ``idf.py`` ç\9a\84å\85¨é\83¨å\91½ä»¤å\92\8cé\80\89项ï¼\8c请å\8f\82é\98\85 :ref:`idf.py`ã\80\82\r
+æ¤å¤\96ï¼\8c\r
\r
-你已完成 ESP32 的入门！\r
+- 请前往 :doc:`IDF 监视器 <../api-guides/tools/idf-monitor>`，了解更多使用 IDF 监视器的快捷键和其他详情。\r
+- 请前往 :ref:`idf.py`，查看更多 ``idf.py`` 命令和选项。\r
\r
-现在你可以尝试其他的示例工程 :idf:`examples`，或者直接开发自己的应用程序。\r
+**恭喜，您已完成 ESP32 的入门学习！**\r
\r
+现在，您可以尝试一些其他 :idf:`examples`，或者直接开发自己的应用程序。\r
\r
更新 ESP-IDF\r
-=============\r
+=================\r
\r
-使ç\94¨ ESP-IDF ä¸\80段æ\97¶é\97´å\90\8eï¼\8cæ\82¨å\8f¯è\83½æ\83³é\80\9aè¿\87å\8d\87级æ\9d¥è\8e·å\8f\96æ\96°ç\9a\84å\8a\9fè\83½æ\88\96è\80\85ä¿®å¤\8d bugï¼\8cæ\9c\80ç®\80å\8d\95ç\9a\84å\8d\87级æ\96¹å¼\8få°±æ\98¯å\88 é\99¤å·²æ\9c\89ç\9a\84 ``esp-idf`` æ\96\87件夹ç\84¶å\90\8eé\87\8dæ\96°å\85\8bé\9a\86ä¸\80个ï¼\8cå\8d³é\87\8då¤\8d :ref:`get-started-get-esp-idf` é\87\8cç\9a\84æ\93\8dä½\9cã\80\82\r
+ä¹\90é\91«ä¼\9aä¸\8dæ\97¶æ\8e¨å\87ºæ\9b´æ\96°ç\89\88æ\9c¬ç\9a\84 ESP-IDFï¼\8cä¿®å¤\8d bug æ\88\96æ\8f\90å\87ºæ\96°ç\9a\84ç\89¹æ\80§ã\80\82å\9b æ¤ï¼\8cæ\82¨å\9c¨ä½¿ç\94¨æ\97¶ï¼\8cä¹\9fåº\94注æ\84\8fæ\9b´æ\96°æ\82¨æ\9c¬å\9c°ç\9a\84ç\89\88æ\9c¬ã\80\82æ\9c\80ç®\80å\8d\95ç\9a\84æ\96¹æ³\95æ\98¯ï¼\9aç\9b´æ\8e¥å\88 é\99¤æ\82¨æ\9c¬å\9c°ç\9a\84 ``esp-idf`` æ\96\87件夹ï¼\8cç\84¶å\90\8eæ\8c\89ç\85§ :ref:`get-started-get-esp-idf-cmake` ä¸ç\9a\84æ\8c\87示ï¼\8cé\87\8dæ\96°å®\8cæ\88\90å\85\8bé\9a\86ã\80\82 \r
\r
-然后 :doc:`添加 IDF 到工作路径 <add-idf_path-to-profile>`，这样工具链脚本就能够知道这一版本的 ESP-IDF 的具体位置。\r
+如果您希望将 ESP-IDF 克隆到新的路径下，请务必 :doc:`重新设置 IDF_PATH <add-idf_path-to-profile>`。否则，工具链将无法找到 ESP-IDF。\r
\r
-另外一种方法是只更新有改动的部分。:ref:`更新步骤取决于现在用的ESP-IDF版本 <updating>`。\r
+此外，您可以仅更新变更部分。具体方式，请前往 :ref:`更新 <updating>` 章节查看。\r
\r
相关文档\r
-=================\r
+===========\r
\r
.. toctree::\r
:maxdepth: 1\r
../api-guides/tools/idf-monitor\r
toolchain-setup-scratch\r
\r
-.. _Stable version: https://docs.espressif.com/projects/esp-idf/en/stable/\r
-.. _Releases page: https://github.com/espressif/esp-idf/releases\r
+.. _Stable version: https://docs.espressif.com/projects/esp-idf/zh_CN/stable/\r
+.. _Releases page: https://github.com/espressif/esp-idf/releases
\ No newline at end of file
-.. include:: ../../en/get-started/get-started-devkitc-v2.rst
\ No newline at end of file
+ESP32-DevKitC V2 入门指南 (CMake)\r
+==============================================\r
+\r
+:link_to_translation:`en: [English]`\r
+\r
+本指南介绍了如何开始使用 ESP32-DevKitC V2 开发板。\r
+\r
+\r
+准备工作\r
+-------------\r
+\r
+* ESP32-DevKitC V2 开发板\r
+* USB A / micro USB B 数据线\r
+* PC（Windows、Linux 或 Mac OS）\r
+\r
+您可以跳过介绍部分，直接前往 `应用程序开发`_ 章节。\r
+\r
+\r
+概述\r
+--------\r
+\r
+ESP32-DevKitC V2 是 `乐鑫 <https://espressif.com>`_ 一款基于 ESP32 的小型开发板，板上模组的绝大部分管脚均已引出，开发人员可根据实际需求，轻松通过跳线连接多种外围器件，或将开发板插在面包板上使用。\r
+\r
+\r
+功能说明\r
+----------------------\r
+\r
+ESP32-DevKitC V2 开发板的主要组件、接口及控制方式见下。\r
+\r
+.. _get-started-esp32-devkitc-v2-board-front-make:\r
+\r
+.. figure:: ../../_static/esp32-devkitc-v2-functional-overview.png\r
+ :align: center\r
+ :alt: ESP32-DevKitC V2 开发板\r
+ :figclass: align-center\r
+\r
+ESP32-DevKitC V2 开发板\r
+\r
++----------------+--------------------------------------------------------------------------------------------------------------------------+\r
+| 主要组件 | 基本介绍 |\r
++----------------+--------------------------------------------------------------------------------------------------------------------------+\r
+| ESP32-WROOM-32 | 基于 ESP32 的模组。更多详情，请见 `《ESP32-WROOM-32 技术规格书》`_。 |\r
++----------------+--------------------------------------------------------------------------------------------------------------------------+\r
+| EN | 复位按键。 |\r
++----------------+--------------------------------------------------------------------------------------------------------------------------+\r
+| Boot | 下载按键。按下 **Boot** 键并保持，同时按一下 **EN** 键（此时不要松开 **Boot** 键）进入“固件下载”模式，通过串口下载固件。 |\r
++----------------+--------------------------------------------------------------------------------------------------------------------------+\r
+| Micro USB 端口 | USB 接口。可用作电路板的供电电源，或连接 PC 和 ESP32-WROOM-32 模组的通信接口。 |\r
++----------------+--------------------------------------------------------------------------------------------------------------------------+\r
+| I/O | 板上模组的绝大部分管脚均已引出至开发板的排针。用户可以对 ESP32 进行编程，实现 PWM、ADC、DAC、I2C、I2S、SPI 等多种功能。 |\r
++----------------+--------------------------------------------------------------------------------------------------------------------------+\r
+\r
+\r
+电源选项\r
+--------------------\r
+\r
+开发板可任一选用以下三种供电方式：\r
+\r
+* Micro USB 供电（默认）\r
+* 5V / GND 管脚供电\r
+* 3V3 / GND 管脚供电\r
+\r
+.. warning::\r
+\r
+ 上述供电模式 **不可同时连接**，否则可能会损坏开发板和/或电源。\r
+\r
+\r
+应用程序开发\r
+------------------------------\r
+\r
+ESP32-DevKitC V2 上电前，请首先确认开发板完好无损。\r
+\r
+之后，请前往 :doc:`index` 的 :ref:`get-started-step-by-step` 章节，查看如何设置开发环境，并尝试将示例项目烧录至您的开发板。\r
+\r
+\r
+相关文档\r
+-----------------\r
+\r
+* `ESP32-DevKitC 原理图 <https://dl.espressif.com/dl/schematics/ESP32-Core-Board-V2_sch.pdf>`_ (PDF)\r
+* `《ESP32 技术规格书》 <https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf>`_ (PDF)\r
+* `《ESP32-WROOM-32 技术规格书》 <https://espressif.com/sites/default/files/documentation/esp32-wroom-32_datasheet_cn.pdf>`_ (PDF)
\ No newline at end of file
-ESP32-DevKitC V4 入门指南
-======================================
-:link_to_translation:`en:[English]`
-
-本指南介绍了如何开始使用 ESP32-DevKitC V4 开发板。有关 ESP32-DevKitC 其他版本的介绍，请见：`../hw-reference/index`。
-
-准备工作
--------------
-
-* 1 × :ref:`ESP32-DevKitC V4 开发板 <get-started-esp32-devkitc-board-front>`
-* 1 × USB A / micro USB B 电缆
-* 1 × PC（Windows、Linux 或 Mac OS）
-
-
-简介
---------
-
-ESP32-DevKitC V4 是一款来自 `乐鑫 <https://espressif.com>`_ 的迷你开发板，板上模组的绝大部分管脚均已引出，可根据用户需求，轻松连接多种外围器件。此外，本开发板还采用了标准排母，可便利杜邦线的使用。
-
-本开发板可支持多款 ESP32 模组，包括 :ref:`esp-modules-and-boards-esp32-wroom-32`，:ref:`ESP32-WROOM-32U <esp-modules-and-boards-esp32-wroom-32d-and-u>`，:ref:`ESP32-WROOM-32D <esp-modules-and-boards-esp32-wroom-32d-and-u>`，:ref:`esp-modules-and-boards-esp32-solo-1` 及 :ref:`esp-modules-and-boards-esp32-wrover` 系列。
-
- .. note::
-
- 乐鑫还同时提供多种 ESP32-DevKitC 型号，采用不同模组或排针/排母设计，用户可按需选择。更多详情，请见 `乐鑫产品订购信息`_ 。
-
-功能说明
-----------------------
-ESP32-DevKitC V4 开发板的主要组件、接口及控制方式如下文所示。
-
-ESP32-WROOM-32D
- ESP32-DevKitC V4 开发板上焊接的标准 :ref:`ESP32-WROOM-32D <esp-modules-and-boards-esp32-wroom-32d-and-u>` 模组。
-
-额外空间
- 本开发板的还预留了部分额外空间，用于焊接其他 ESP32-WROOM-32 之外的较长模组，比如 :ref:`esp-modules-and-boards-esp32-wrover` 模组。
-
-USB-UART 桥接器
- 单芯片 USB-UART 桥接器，可提供高达 3 Mbps 的传输速率。
-
-Boot 按键
- 按下 **Boot** 键并保持，同时按一下 **EN** 键（此时不要松开 **Boot** 键）进入固件下载模式，通过串口下载固件。
-
-EN 按键
- 复位键，可重置系统。
-
-Micro USB 端口
- USB 接口，可用作电路板的供电电源，或连接 PC 端的通信接口。
-
-LED 电源指示灯
- 开发板通电后（USB 或外部 5 V），该指示灯将亮起。更多信息，请见 `相关文档`_ 中的原理图。
-
-I/O 连接器
- ESP32-DevKitC V4 迷你开发板，板上模组的绝大部分管脚均已引出。用户可以对 ESP32 进行编程，实现 PWM、ADC、DAC、I2C、I2S、SPI 等多种功能。
-
- .. note::
-
- 引脚 CLK、D0、D1、D2、D3 和 CMD (GPIO6 - GPIO11) 用于 ESP32-WROOM-32、ESP32-WROOM-32D/U 和 ESP32-SOLO-1 模组的内部 SPI 通信，集中分布在 USB 接口一侧。通常而言，这些引脚最好不连，否则可能影响 SPI flash 内存 / SPI RAM 的工作。
-
-.. _get-started-esp32-devkitc-board-front:
-
-.. figure:: ../../_static/esp32-devkitc-functional-overview-f.jpeg
- :align: center
- :alt: ESP32-DevKitC V4 with ESP32-WROOM-32 module soldered
- :figclass: align-center
-
- 图为 ESP32-DevKitC V4（贴 ESP32-WROOM-32D）
-
-
-电源选项
---------------------
-
-ESP32-DevKitC V4 支持以下几种供电模式：
-
-1. Micro USB 接口供电（默认）
-2. 5V / GND 管脚供电
-3. 3V3 / GND 管脚供电
-
-.. warning::
-
- 上述供电模式不可同时连接，否则可能会损坏电路板和/或电源。
-
-C15 相关说明
---------------
-
-较早版本 ESP32-DevKitC 上的 C15 可能带来两个问题：
-
-1. 开发板上电后可能进入下载模式；
-2. 如果用户通过 GPIO0 输出时钟，C15 可能会影响时钟输出。
-
-用户如果认为 C15 可能影响开发板的使用，则可以将 C15 完全移除（C15 在开发板上的具体位置见下图黄色部分）。否则，则无需处理 C15。
-
-.. figure:: ../../_static/esp32-devkitc-c15-location.png
- :align: center
- :alt: Location of C15 (colored yellow) on ESP32-DevKitC V4 board
- :figclass: align-center
- :width: 30%
-
- C15（黄色部分）在 ESP32-DevKitC V4 开发板上的具体位置
-
-
-应用程序开发
-------------------------------
-
-ESP32-DevKitC 上电前，请首先确认电路板完好无损。
-
-有关应用程序开发的具体步骤，请见章节 :doc:`index`：
-
-* :ref:`设置 Toolchain <get-started-setup-toolchain>`，以便用 C 语言开发应用
-* :ref:`连接 <get-started-connect>` 模组至 PC，并确认访问状态
-* :ref:`构建并向 ESP32 烧录 example <get-started-build-and-flash>`
-* :ref:`即刻监测 <get-started-monitor>` 应用程序的动作
-
-开发板尺寸
-----------------
-
-.. figure:: ../../_static/esp32-devkitc-dimensions-back.jpg
- :align: center
- :alt: ESP32-DevKitC board dimensions - back
- :figclass: align-center
-
- ESP32-DevKitC 开发板尺寸 - 背面
-
-
-相关文档
------------------
-
-* `ESP32-DevKitC V4 原理图 <https://dl.espressif.com/dl/schematics/esp32_devkitc_v4-sch-20180607a.pdf>`_ (PDF)
-* `ESP32 技术规格书 <https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf>`_ (PDF)
-* `ESP32-WROOM-32 技术规格书 <https://espressif.com/sites/default/files/documentation/esp32-wroom-32_datasheet_cn.pdf>`_ (PDF)
-* `ESP32-WROOM-32D/U 技术规格书 <https://www.espressif.com/sites/default/files/documentation/esp32-wroom-32d_esp32-wroom-32u_datasheet_cn.pdf>`_ (PDF)
-* `乐鑫产品订购信息 <https://www.espressif.com/sites/default/files/documentation/espressif_products_ordering_information_cn.pdf>`_ (PDF)
-
-
-.. toctree::
- :hidden:
-
- get-started-devkitc-v2
\ No newline at end of file
+ESP32-DevKitC V4 入门指南\r
+===========================\r
+\r
+:link_to_translation:`en: [English]`\r
+\r
+本指南介绍了如何开始使用 ESP32-DevKitC V4 开发板。有关 ESP32-DevKitC 其他版本的介绍，请见：:doc:`../hw-reference/index`。\r
+\r
+\r
+准备工作\r
+--------\r
+\r
+* ESP32-DevKitC V4 开发板\r
+* USB A / micro USB B 数据线\r
+* PC（Windows、Linux 或 Mac OS）\r
+\r
+您可以跳过介绍部分，直接前往 `应用程序开发`_ 章节。\r
+\r
+\r
+.. _DevKitC-Overview:\r
+\r
+概述\r
+----\r
+\r
+ESP32-DevKitC V4 是 `乐鑫 <https://espressif.com>`_ 一款基于 ESP32 的小型开发板，板上模组的绝大部分管脚均已引出，开发人员可根据实际需求，轻松通过跳线连接多种外围器件，或将开发板插在面包板上使用。\r
+\r
+为了更好地满足不同用户需求，ESP32-DevKitC V4 还支持以下不同配置：\r
+\r
+- 可选多款 ESP32 模组\r
+\r
+ - :ref:`esp-modules-and-boards-esp32-wroom-32`\r
+ - :ref:`ESP32-WROOM-32D <esp-modules-and-boards-esp32-wroom-32d-and-u>`\r
+ - :ref:`ESP32-WROOM-32U <esp-modules-and-boards-esp32-wroom-32d-and-u>`\r
+ - :ref:`esp-modules-and-boards-esp32-solo-1`\r
+ - :ref:`ESP32-WROVER <esp-modules-and-boards-esp32-wrover>`\r
+ - :ref:`ESP32-WROVER-B <esp-modules-and-boards-esp32-wrover>`\r
+ - :ref:`ESP32-WROVER-I <esp-modules-and-boards-esp32-wrover>`\r
+ - :ref:`ESP32-WROVER-I (IPEX) <esp-modules-and-boards-esp32-wrover>`\r
+\r
+- 可选排针或排母\r
+\r
+详情请见 `《乐鑫产品订购信息》 <https://www.espressif.com/sites/default/files/documentation/espressif_products_ordering_information_cn.pdf>`_。\r
+\r
+\r
+功能说明\r
+--------\r
+\r
+ESP32-DevKitC V4 开发板的主要组件、接口及控制方式见下。\r
+\r
+.. _get-started-esp32-devkitc-board-front:\r
+\r
+.. figure:: ../../_static/esp32-devkitc-functional-overview.jpg\r
+ :align: center\r
+ :alt: ESP32-DevKitC V4（板载 ESP32-WROOM-32）\r
+ :figclass: align-center\r
+\r
+ESP32-DevKitC V4（板载 ESP32-WROOM-32）\r
+\r
+\r
++--------------------+--------------------------------------------------------------------------------------------------------------------------+\r
+| 主要组件 | 基本介绍 |\r
++--------------------+--------------------------------------------------------------------------------------------------------------------------+\r
+| ESP32-WROOM-32 | 基于 ESP32 的模组。更多详情，请见 `《ESP32-WROOM-32 技术规格书》`_。 |\r
++--------------------+--------------------------------------------------------------------------------------------------------------------------+\r
+| EN | 复位按键。 |\r
++--------------------+--------------------------------------------------------------------------------------------------------------------------+\r
+| Boot | 下载按键。按下 **Boot** 键并保持，同时按一下 **EN** 键（此时不要松开 **Boot** 键）进入“固件下载”模式，通过串口下载固件。 |\r
++--------------------+--------------------------------------------------------------------------------------------------------------------------+\r
+| USB-to-UART 桥接器 | 单芯片 USB-UART 桥接器，可提供高达 3 Mbps 的传输速率。 |\r
++--------------------+--------------------------------------------------------------------------------------------------------------------------+\r
+| Micro USB 端口 | USB 接口。可用作电路板的供电电源，或连接 PC 和 ESP32-WROOM-32 模组的通信接口。 |\r
++--------------------+--------------------------------------------------------------------------------------------------------------------------+\r
+| 5V Power On LED | 开发板通电后（USB 或外部 5 V），该指示灯将亮起。更多信息，请见 `相关文档`_ 中的原理图。 |\r
++--------------------+--------------------------------------------------------------------------------------------------------------------------+\r
+| I/O | 板上模组的绝大部分管脚均已引出至开发板的排针。用户可以对 ESP32 进行编程，实现 PWM、ADC、DAC、I2C、I2S、SPI 等多种功能。 |\r
++--------------------+--------------------------------------------------------------------------------------------------------------------------+\r
+\r
+.. note::\r
+\r
+ 管脚 D0、D1、D2、D3、CMD 和 CLK 用于 ESP32 芯片与 SPI flash 间的内部通信，集中分布在开发板两侧靠近 USB 端口的位置。通常而言，这些管脚最好不连，否则可能影响 SPI flash / SPI RAM 的工作。 \r
+\r
+.. note::\r
+\r
+ 管脚 GPIO16 和 GPIO17 仅适用于板载 ESP32-WROOM 系列和 ESP32-SOLO-1 的开发板，保留内部使用。\r
+\r
+\r
+电源选项\r
+--------\r
+\r
+开发板可任一选用以下三种供电方式：\r
+\r
+* Micro USB 供电（默认）\r
+* 5V / GND 管脚供电\r
+* 3V3 / GND 管脚供电\r
+\r
+.. warning::\r
+\r
+ 上述供电模式 **不可同时连接**，否则可能会损坏开发板和/或电源。\r
+\r
+\r
+有关 C15 的提示\r
+-----------------\r
+\r
+较早版本 ESP32-DevKitC 开发板上的 C15 可能存在以下问题：\r
+\r
+* 开发板上电后可能进入下载模式；\r
+* 如果用户通过 GPIO0 输出时钟，C15 可能会影响信号。\r
+\r
+用户如果认为 C15 可能影响开发板的使用，则可以将 C15 完全移除。C15 在开发板上的具体位置见下图黄色部分。\r
+\r
+\r
+.. figure:: ../../_static/esp32-devkitc-c15-location.png\r
+ :align: center\r
+ :alt: C15（黄色）在 ESP32-DevKitC V4 开发板上的位置\r
+ :figclass: align-center\r
+ :width: 30%\r
+\r
+C15（黄色）在 ESP32-DevKitC V4 开发板上的位置\r
+\r
+\r
+应用程序开发\r
+------------\r
+\r
+ESP32-DevKitC V4 上电前，请首先确认开发板完好无损。\r
+\r
+之后，请前往 :doc:`index` 的 :ref:`get-started-step-by-step` 章节，查看如何设置开发环境，并尝试将示例项目烧录至您的开发板。\r
+\r
+开发板尺寸\r
+-----------\r
+\r
+.. figure:: ../../_static/esp32-devkitc-dimensions-back.jpg\r
+ :align: center\r
+ :alt: ESP32-DevKitC 开发板尺寸 -- 仰视图\r
+ :figclass: align-center\r
+\r
+ESP32-DevKitC 开发板尺寸 -- 仰视图\r
+\r
+\r
+相关文档\r
+--------\r
+\r
+* `ESP32-DevKitC V4 原理图 <https://dl.espressif.com/dl/schematics/esp32_devkitc_v4-sch.pdf>`_ (PDF)\r
+* `《ESP32 技术规格书》 <https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf>`_ (PDF)\r
+* `《ESP32-WROOM-32 技术规格书》 <https://espressif.com/sites/default/files/documentation/esp32-wroom-32_datasheet_cn.pdf>`_ (PDF)\r
+* `《ESP32-WROOM-32D & ESP32-WROOM-32U 技术规格书》 <https://www.espressif.com/sites/default/files/documentation/esp32-wroom-32d_esp32-wroom-32u_datasheet_cn.pdf>`_ (PDF)\r
+* `《ESP32-WROVER 技术规格书》 <https://espressif.com/sites/default/files/documentation/esp32_wrover_datasheet_cn.pdf>`_ (PDF)\r
+* `《ESP32-WROVER-B 技术规格书》 <https://www.espressif.com/sites/default/files/documentation/esp32-wrover-b_datasheet_cn.pdf>`_ (PDF)\r
+* `《乐鑫产品订购信息》 <https://www.espressif.com/sites/default/files/documentation/espressif_products_ordering_information_cn.pdf>`_ (PDF)\r
+\r
+.. toctree::\r
+ :hidden:\r
+\r
+ get-started-devkitc-v2\r
+\r
-***********
-快速入门
-***********
-:link_to_translation:`en:[English]`
-
-本文档旨在指导用户创建 ESP32 的软件环境。本文将通过一个简单的例子来说明如何使用 ESP-IDF (Espressif IoT Development Framework)，包括配置、编译、下载固件到开发板等步骤。
-
-.. include:: /_build/inc/version-note.inc
-
-概述
-======
-
-ESP32 是一套 Wi-Fi (2.4 GHz) 和蓝牙 (4.2) 双模解决方案，集成了高性能的 CPU 内核、超低功耗协处理器和丰富的外设。ESP32 采用 40 nm 工艺制成，具有最佳的功耗性能、射频性能、稳定性、通用性和可靠性，适用于各种应用和不同功耗需求。
-
-乐鑫为用户提供完整的软、硬件资源进行 ESP32 设备的开发。乐鑫所研发的软件开发环境 ESP-IDF 能够帮助用户快速开发物联网 (IoT) 应用，满足用户对于 Wi-Fi、蓝牙、低功耗等性能的需求。
-
-准备工作
-=========
-
-开发 ESP32 应用程序需要准备：
-
-
-* **电脑**：安装 Windows、Linux 或者 Mac 操作系统
-* **工具链**：用于编译 ESP32 **应用程序**
-* **ESP-IDF**：包含 ESP32 API 和用于操作 **工具链** 的脚本
-* **文本编辑器**：编写 C 语言程序，例如 `Eclipse <http://www.eclipse.org/>`_
-* **ESP32 开发板** 和将其连接到 **电脑** 的 **USB 线**
-
-.. figure:: ../../_static/what-you-need.png
- :align: center
- :alt: Development of applications for ESP32
- :figclass: align-center
-
- 开发应用程序
-
-开发环境的准备工作包括以下三部分：
-
-1. 设置 **工具链**
-2. 从 GitHub 上获取 **ESP-IDF**
-3. 安装和配置 **Eclipse**
-
-如果你偏好使用其它编辑器，可以跳过最后一步。
-
-环境设置好后，就可以开始开发应用程序了。整个过程可以概括为如下四步：
-
-1. 配置 **工程** 并编写代码
-2. 编译 **工程** 并链接成一个 **应用程序**
-3. 烧写 **应用程序** 到 **ESP32**
-4. 监视/调试 **应用程序**
-
-下文将全程指导你操作完成这些步骤。
-
-开发板指南
-==========
-
-如果你有下列任一 ESP32 开发板，请点击对应的链接，对照指南进行操作就可以让你的板子跑起来。
-
-.. toctree::
- :maxdepth: 1
-
- ESP32 DevKitC <../get-started/get-started-devkitc>
- ESP-WROVER-KIT <../get-started/get-started-wrover-kit>
- ESP32-PICO-KIT <../get-started/get-started-pico-kit>
-
-如果你使用其它开发板，请查看下面的内容。
-
-.. _get-started-step-by-step:
-
-.. _get-started-setup-toolchain:
-
-设置工具链
-===============
-
-用 ESP32 进行开发最快的方法是安装预编译的工具链。请根据你的操作系点击对应的链接，并按照链接中的指导进行安装。
-
-.. toctree::
- :hidden:
-
- Windows <windows-setup>
- Linux <linux-setup>
- MacOS <macos-setup>
-
-+-------------------+-------------------+-------------------+
-| |windows-logo| | |linux-logo| | |macos-logo| |
-+-------------------+-------------------+-------------------+
-| `Windows`_ | `Linux`_ | `Mac OS`_ |
-+-------------------+-------------------+-------------------+
-
-.. |windows-logo| image:: ../../_static/windows-logo.png
- :target: windows-setup.html
-
-.. |linux-logo| image:: ../../_static/linux-logo.png
- :target: linux-setup.html
-
-.. |macos-logo| image:: ../../_static/macos-logo.png
- :target: macos-setup.html
-
-.. _Windows: windows-setup.html
-.. _Linux: linux-setup.html
-.. _Mac OS: macos-setup.html
-
-.. note::
-
- 我们使用 ``~/esp`` 目录来安装预编译的工具链、ESP-IDF 和示例程序。你也可以使用其它目录，但是需要注意调整相应的指令。
-
-你可以安装预编译的工具链或者自定义你的环境，这完全取决于个人经验和偏好。如果你要自定义环境，请参考 :ref:`get-started-customized-setup`。
-
-工具链设置完成后，就可以 :ref:`get-started-get-esp-idf` 了。
-
-.. _get-started-get-esp-idf:
-
-获取 ESP-IDF
-=================
-
-.. highlight:: bash
-
-工具链（包括用于编译和构建应用程序的程序）安装完后，你还需要 ESP32 相关的 API/库。API/库在 `ESP-IDF 仓库 <https://github.com/espressif/esp-idf>`_ 中。
-
-获取本地副本：打开终端，切换到你要存放 ESP-IDF 的工作目录，使用 ``git clone`` 命令克隆远程仓库:
-
-.. include:: /_build/inc/git-clone-bash.inc
-
-ESP-IDF 将会被下载到 ``~/esp/esp-idf`` 目录下。
-
-有关在给定情况下使用哪个 ESP-IDF 版本的信息，请参阅 :doc:`/versions` 。
-
-.. note::
-
- 注意这里有个 ``--recursive`` 选项。如果你克隆 ESP-IDF 时没有带这个选项，你还需要运行额外的命令来获取子模块： ::
-
- cd esp-idf
- git submodule update --init
-
-.. include:: /_build/inc/git-clone-notes.inc
-
-.. _get-started-setup-path:
-
-设置 ESP-IDF 路径
-=====================
-
-工具链程序使用环境变量 ``IDF_PATH`` 来访问 ESP-IDF。这个变量应该设置在你的 PC 中，否则工程将不能编译。你可以在每次 PC 重启时手工设置，也可以通过在用户配置文件中定义 ``IDF_PATH`` 变量来永久性设置。要永久性设置，请参考 :doc:`add-idf_path-to-profile` 文档中 :ref:`Windows <add-idf_path-to-profile-windows>` 或 :ref:`Linux and MacOS <add-idf_path-to-profile-linux-macos>` 相关的指导进行操作。
-
-.. _get-started-get-packages:
-
-安装依赖的 Python 软件包
-====================================
-
-ESP-IDF 所依赖的 Python 软件包位于 ``$IDF_PATH/requirements.txt`` 文件中，您可以通过运行以下命令来安装它们：
-
-.. code:: bash
-
- python -m pip install --user -r $IDF_PATH/requirements.txt
-
-.. note::
-
- 请调用 ESP-IDF 使用的相同版本的 Python 解释器，解释器的版本号可以通过运行命令 ``python --version`` 来获得，根据结果，您可能要使用 ``python2``, ``python2.7`` 或者类似的名字而不是 ``python``,例如::
-
- python2.7 -m pip install --user -r $IDF_PATH/requirements.txt
-
-.. _get-started-start-project:
-
-创建一个工程
-===============
-
-现在可以开始创建 ESP32 应用程序了。为了快速开始，我们这里以 IDF 的 :idf:`examples` 目录下的 :example:`get-started/hello_world` 工程为例进行说明。
-
-将 :example:`get-started/hello_world` 拷贝到 ``~/esp`` 目录： ::
-
- cd ~/esp
- cp -r $IDF_PATH/examples/get-started/hello_world .
-
-ESP-IDF 的 :idf:`examples` 目录下有一系列示例工程，都可以按照上面的方法进行创建。
-
-.. important::
-
- esp-idf 构建系统不支持在路径中存在空格。
-
-.. _get-started-connect:
-
-连接
-=======
-
-还有几个步骤就完成了。在继续后续操作前，先将 ESP32 开发板连接到 PC，然后检查串口号，看看它能否正常通信。如果你不知道如何操作，请查看 Establish Serial Connection with ESP32 中的相关指导。请注意一下端口号，我们在下一步中会用到。
-
-.. _get-started-configure:
-
-配置
-=========
-
-在终端窗口中，输入 ``cd ~/esp/hello_world`` 进入 ``hello_world`` 所在目录，然后启动工程配置工具 ``menuconfig``： ::
-
- cd ~/esp/hello_world
- make menuconfig
-
-如果之前的步骤都正确，则会显示下面的菜单：
-
-.. figure:: ../../_static/project-configuration.png
- :align: center
- :alt: Project configuration - Home window
- :figclass: align-center
-
- 工程配置 - 主窗口
-
-在菜单中，进入 ``Serial flasher config`` > ``Default serial port`` 配置串口（工程将会加载到该串口上）。输入回车确认选择，选择 ``< Save >`` 保存配置，然后选择 ``< Exit >`` 退出应用程序。
-
-.. note::
-
- 在 Windows 系统中，端口号的名称类似 COM1，在 MacOS 中以 ``/dev/cu.`` 开始，而在 Linux 系统中，以 ``/dev/tty`` 开始。
- （详细内容可以参考章节 :doc:`establish-serial-connection`。）
-
-下面是一些使用 ``menuconfig`` 的小技巧：
-
-* 使用 up & down 组合键在菜单中上下移动
-* 使用 Enter 键进入一个子菜单，Escape 键退出子菜单或退出整个菜单
-* 输入 ``?`` 查看帮助信息，Enter 键退出帮助屏幕
-* 使用空格键或 ``Y`` 和 ``N`` 键来使能 (Yes) 和禁止 (No) 带有复选框 "``[*]``" 的配置项
-* 当光标在某个配置项上面高亮时，输入 ``?`` 可以直接查看该项的帮助信息
-* 输入 ``/`` 搜索配置项
-
-.. attention::
-
- 如果 ESP32-DevKitC 板载的是 ESP32-SOLO-1 模组，请务必在烧写示例程序之前在 menuconfig 中使能单核模式（:ref:`CONFIG_FREERTOS_UNICORE`）。
-
-
-.. _get-started-build-and-flash:
-
-编译和烧写
-===============
-
-现在可以编译和烧写应用程序了，执行指令： ::
-
- make flash
-
-这条命令会编译应用程序和所有的 ESP-IDF 组件，生成 bootloader、分区表和应用程序 bin 文件，并将这些 bin 文件烧写到 ESP32 板子上。
-
-.. highlight:: none
-
-::
-
- esptool.py v2.0-beta2
- Flashing binaries to serial port /dev/ttyUSB0 (app at offset 0x10000)...
- esptool.py v2.0-beta2
- Connecting........___
- Uploading stub...
- Running stub...
- Stub running...
- Changing baud rate to 921600
- Changed.
- Attaching SPI flash...
- Configuring flash size...
- Auto-detected Flash size: 4MB
- Flash params set to 0x0220
- Compressed 11616 bytes to 6695...
- Wrote 11616 bytes (6695 compressed) at 0x00001000 in 0.1 seconds (effective 920.5 kbit/s)...
- Hash of data verified.
- Compressed 408096 bytes to 171625...
- Wrote 408096 bytes (171625 compressed) at 0x00010000 in 3.9 seconds (effective 847.3 kbit/s)...
- Hash of data verified.
- Compressed 3072 bytes to 82...
- Wrote 3072 bytes (82 compressed) at 0x00008000 in 0.0 seconds (effective 8297.4 kbit/s)...
- Hash of data verified.
-
- Leaving...
- Hard resetting...
-
-如果没有任何问题，在编译过程结束后将能看到类似上面的消息。最后，板子将会复位，应用程序 "hello_world" 开始启动。
-
-如果你想使用 Eclipse IDE 而不是运行 ``make``，请参考 :doc:`Eclipse guide <eclipse-setup>`。
-
-.. _get-started-monitor:
-
-监视器
-=======
-
-如果要查看 "hello_world" 程序是否真的在运行，输入命令 ``make monitor``。这个命令会启动 IDF Monitor 程序： ::
-
- $ make monitor
- MONITOR
- --- idf_monitor on /dev/ttyUSB0 115200 ---
- --- Quit: Ctrl+] | Menu: Ctrl+T | Help: Ctrl+T followed by Ctrl+H ---
- ets Jun 8 2016 00:22:57
-
- rst:0x1 (POWERON_RESET),boot:0x13 (SPI_FAST_FLASH_BOOT)
- ets Jun 8 2016 00:22:57
- ...
-
-在启动消息和诊断消息后，你就能看到 "Hello world!" 程序所打印的消息： ::
-
- ...
- Hello world!
- Restarting in 10 seconds...
- I (211) cpu_start: Starting scheduler on APP CPU.
- Restarting in 9 seconds...
- Restarting in 8 seconds...
- Restarting in 7 seconds...
-
-要退出监视器，请使用快捷键 ``Ctrl+]``。
-
-.. note::
-
- 如果串口打印的不是上面显示的消息而是类似下面的乱码： ::
-
- e���)(Xn@�y.!��(�PW+)��Hn9a/9�!�t5��P�~�k��e�ea�5�jA
- ~zY��Y(1�,1\15�� e���)(Xn@�y.!Dr�zY(�\ 6jpi�|�+z5Ymvp
-
- 或者监视器程序启动失败，那么可能你的开发板用的是 26 MHz 晶振，而 ESP-IDF 默认的是 40 MHz 晶振。请退出监视器，回到 :ref:`配置 <get-started-configure>`，将 :ref:`CONFIG_ESP32_XTAL_FREQ_SEL` 改为 26 MHz，然后再次 :ref:`编译和烧写 <get-started-build-and-flash>`。请在 ``make menuconfig`` 的 Component config --> ESP32-specific --> Main XTAL frequency 中配置。
-
-要一次性执行 ``make flash`` 和 ``make monitor``，输入 ``make flash monitor``。参考文档 :doc:`IDF Monitor <../api-guides/tools/idf-monitor>` 里的快捷键和更多内容。
-
-你已完成 ESP32 的入门！
-
-现在你可以尝试其他的示例工程 :idf:`examples`，或者直接开发自己的应用程序。
-
-更新 ESP-IDF
-=============
-
-使用 ESP-IDF 一段时间后，你可能想要进行升级来获得新的性能或者对 bug 进行修复。最简单的更新方式是删除已有的 ``esp-idf`` 文件夹然后再克隆一个，即重复 :ref:`get-started-get-esp-idf` 里的操作。
-
-然后 :doc:`add-idf_path-to-profile`，这样工具链脚本就能够知道这一版本的 ESP-IDF 的具体位置。
-
-另外一种方法是只更新有改动的部分。:ref:`更新步骤取决于现在用的ESP-IDF版本 <updating>`。
-
-
-相关文档
-=================
-
-.. toctree::
- :maxdepth: 1
-
- add-idf_path-to-profile
- establish-serial-connection
- make-project
- eclipse-setup
- ../api-guides/tools/idf-monitor
- toolchain-setup-scratch
-
-.. _Stable version: https://docs.espressif.com/projects/esp-idf/zh_CN/stable/
-.. _Releases page: https://github.com/espressif/esp-idf/releases
+********\r
+快速入门\r
+********\r
+\r
+:link_to_translation:`en:[English]`\r
+\r
+本文档旨在指导用户搭建 ESP32 硬件开发的软件环境，\r
+\r
+通过一个简单的示例展示如何使用 ESP-IDF (Espressif IoT Development Framework) 配置菜单，并编译、下载固件至 ESP32 开发板等步骤。\r
+\r
+.. include:: /_build/inc/version-note.inc\r
+\r
+概述\r
+====\r
+\r
+ESP32 SoC 芯片支持以下功能：\r
+\r
+* 2.4 GHz Wi-Fi\r
+* 蓝牙 4.2 标准\r
+* 高性能双核\r
+* 超低功耗协处理器\r
+* 多种外设\r
+\r
+ESP32 采用 40 nm 工艺制成，具有最佳的功耗性能、射频性能、稳定性、通用性和可靠性，适用于各种应用场景和不同功耗需求。\r
+\r
+乐鑫为用户提供完整的软、硬件资源，进行 ESP32 硬件设备的开发。其中，乐鑫的软件开发环境 ESP-IDF 旨在协助用户快速开发物联网 (IoT) 应用，可满足用户对 Wi-Fi、蓝牙、低功耗等方面的要求。\r
+\r
+准备工作\r
+========\r
+\r
+硬件：\r
+\r
+* 一款 **ESP32** 开发板\r
+* **USB 数据线** （USB A/Micro USB B）\r
+* PC（Windows、Linux 或 Mac OS）\r
+\r
+软件：\r
+\r
+* 设置 **工具链**，用于编译 ESP32 **应用程序**；\r
+* 获取 **ESP-IDF** 软件开发框架。该框架已经基本包含 ESP32 使用的 API（软件库和源代码）和运行 **工具链** 的脚本；\r
+* 安装 C 语言编程（**工程**）的 **文本编辑器**，例如 `Eclipse <https://www.eclipse.org/>`_。\r
+\r
+\r
+.. figure:: ../../_static/what-you-need.png\r
+ :align: center\r
+ :alt: ESP32 应用程序开发\r
+ :figclass: align-center\r
+\r
+ ESP32 应用程序开发\r
+\r
+\r
+开发板简介\r
+==========\r
+\r
+请点击下方连接，了解有关具体开发板的详细信息。\r
+\r
+.. toctree::\r
+ :maxdepth: 1\r
+\r
+ ESP32-DevKitC <get-started-devkitc>\r
+ ESP-WROVER-KIT <get-started-wrover-kit>\r
+ ESP32-PICO-KIT <get-started-pico-kit>\r
+\r
+\r
+.. _get-started-step-by-step:\r
+\r
+详细安装步骤\r
+============\r
+\r
+请根据下方详细步骤，完成安装过程。\r
+\r
+设置开发环境\r
+~~~~~~~~~~~~\r
+\r
+* :ref:`get-started-setup-toolchain`\r
+* :ref:`get-started-get-esp-idf`\r
+* :ref:`get-started-setup-path`\r
+* :ref:`get-started-get-packages`\r
+\r
+创建您的第一个工程\r
+~~~~~~~~~~~~~~~~~~\r
+\r
+* :ref:`get-started-start-project`\r
+* :ref:`get-started-connect`\r
+* :ref:`get-started-configure`\r
+* :ref:`get-started-build-and-flash`\r
+* :ref:`get-started-monitor`\r
+\r
+\r
+.. _get-started-setup-toolchain:\r
+\r
+第一步：设置工具链\r
+==================\r
+\r
+工具链指一套用于编译代码和应用程序的程序。\r
+\r
+为了加快开发进度，您可以直接使用乐鑫提供的预制工具链。请根据您的操作系统，点击下方对应的链接，并按照链接中的指导进行安装。\r
+\r
+.. toctree::\r
+ :hidden:\r
+\r
+ Windows <windows-setup>\r
+ Linux <linux-setup> \r
+ MacOS <macos-setup> \r
+\r
++-------------------+-------------------+-------------------+\r
+| |windows-logo| | |linux-logo| | |macos-logo| |\r
++-------------------+-------------------+-------------------+\r
+| `Windows`_ | `Linux`_ | `Mac OS`_ |\r
++-------------------+-------------------+-------------------+\r
+\r
+.. |windows-logo| image:: ../../_static/windows-logo.png\r
+ :target: ../get-started/windows-setup.html\r
+\r
+.. |linux-logo| image:: ../../_static/linux-logo.png\r
+ :target: ../get-started/linux-setup.html\r
+\r
+.. |macos-logo| image:: ../../_static/macos-logo.png\r
+ :target: ../get-started/macos-setup.html\r
+\r
+.. _Windows: ../get-started/windows-setup.html\r
+.. _Linux: ../get-started/linux-setup.html\r
+.. _Mac OS: ../get-started/macos-setup.html\r
+\r
+.. note::\r
+\r
+ 在本文档中，Linux 和 MacOS 操作系统中 ESP-IDF 的默认安装路径为 ``~/esp``；Windows 操作系统的默认路径为 ``%userprofile%\esp``。您也可以将 ESP-IDF 安装在任何其他路径下，但请注意在使用命令行时进行相应替换。注意，ESP-IDF 不支持带有空格的路径。\r
+\r
+此外， 您也可以根据自身经验和实际需求，对环境进行个性化设置，而非使用预制工具链。此时，请前往 :ref:`工具链的个性化设置<get-started-customized-setup>` 章节获取更多信息。\r
+\r
+\r
+.. _get-started-get-esp-idf:\r
+\r
+第二步：获取 ESP-IDF\r
+=====================\r
+\r
+除了工具链，您还需要供 ESP32 使用的 API（软件库和源代码），具体请见 `ESP-IDF 仓库 <https://github.com/espressif/esp-idf>`_。\r
+\r
+获取本地副本：打开终端，切换到你要存放 ESP-IDF 的工作目录，使用 ``git clone`` 命令克隆远程仓库。\r
+\r
+打开终端，后运行以下命令：\r
+\r
+.. include:: /_build/inc/git-clone-bash.inc\r
+\r
+ESP-IDF 将下载至 ``~/esp/esp-idf``。\r
+\r
+请前往 :doc:`/versions`，查看 ESP-IDF 不同版本的具体适用场景。\r
+\r
+.. include:: /_build/inc/git-clone-notes.inc\r
+\r
+.. note::\r
+\r
+ 在克隆远程仓库时，不要忘记加上 ``--recursive`` 选项。否则，请接着运行以下命令，获取所有子模块： :: \r
+\r
+ cd esp-idf\r
+ git submodule update --init\r
+\r
+\r
+.. _get-started-setup-path:\r
+\r
+第三步：设置环境变量\r
+=====================\r
+\r
+工具链通过环境变量 ``IDF_PATH`` 获得 ESP-IDF 的目录。因此，您需要在 PC 中设置该环境变量，否则无法编译工程。\r
+\r
+您可以在每次重启会话时手动设置，也可以在用户配置中进行永久设置，具体请前往 :doc:`add-idf_path-to-profile` 章节，查看 :ref:`Windows <add-idf_path-to-profile-windows>` 、:ref:`Linux 及 MacOS <add-idf_path-to-profile-linux-macos>` 操作系统的具体设置方式。\r
+\r
+\r
+.. _get-started-get-packages:\r
+\r
+第四步：安装 Phthon 软件包\r
+==========================\r
+\r
+ESP-IDF 所需 Python 软件包位于 ``IDF_PATH/requirements.txt`` 中。您可以运行以下命令进行安装： :: \r
+ \r
+ python -m pip install --user -r $IDF_PATH/requirements.txt\r
+\r
+.. note::\r
+\r
+ 请注意查询您所使用的 Python 解释器的版本（运行命令 ``python --version``），并根据查询结果将上方命令中的 ``python`` 替换为 ``python2``, ``python2.7``，例如： :: \r
+\r
+ python2.7 -m pip install --user -r $IDF_PATH/requirements.txt\r
+\r
+\r
+.. _get-started-start-project:\r
+\r
+第五步：开始创建工程\r
+=====================\r
+\r
+现在，您可以开始准备开发 ESP32 应用程序了。您可以从 ESP-IDF 中 :idf:`examples` 目录下的 :example:`get-started/hello_world` 工程开始。\r
+\r
+将 :example:`get-started/hello_world` 复制至您本地的 ``~/esp`` 目录下：\r
+\r
+Linux 和 MacOS 操作系统\r
+~~~~~~~~~~~~~~~~~~~~~~~~~\r
+\r
+.. code-block:: bash\r
+\r
+ cd ~/esp\r
+ cp -r $IDF_PATH/examples/get-started/hello_world .\r
+\r
+Windows 操作系统\r
+~~~~~~~~~~~~~~~~~~\r
+\r
+.. code-block:: batch\r
+\r
+ cd %userprofile%\esp\r
+ xcopy /e /i %IDF_PATH%\examples\get-started\hello_world hello_world\r
+\r
+ESP-IDF 的 :idf:`examples` 目录下有一系列示例工程，都可以按照上面的方法进行创建。您可以按照上述方法复制并运行其中的任何示例，也可以直接编译示例，无需进行复制。\r
+\r
+.. important::\r
+\r
+ ESP-IDF 编译系统不支持带有空格的路径。\r
+\r
+.. _get-started-connect:\r
+ \r
+第六步：连接设备\r
+==================\r
+\r
+现在，请将您的 ESP32 开发板连接到 PC，并查看开发板使用的串口。\r
+\r
+通常，串口在不同操作系统下显示的名称有所不同：\r
+\r
+- **Windows 操作系统：** ``COM1`` 等\r
+- **Linux 操作系统：** 以 ``/dev/tty`` 开始\r
+- **MacOS 操作系统：** 以 ``/dev/cu.`` 开始\r
+\r
+有关如何查看串口名称的详细信息，请见 :doc:`establish-serial-connection`。\r
+\r
+.. note::\r
+\r
+ 请记住串口名，您会在下面的步骤中用到。\r
+\r
+\r
+.. _get-started-configure:\r
+\r
+第七步：配置\r
+=============\r
+\r
+请进入 :ref:`get-started-start-project` 中提到的 ``hello_world`` 目录，并运行工程配置工具 ``menuconfig``。\r
+\r
+Linux 和 MacOS 操作系统\r
+~~~~~~~~~~~~~~~~~~~~~~~~\r
+\r
+.. code-block:: bash\r
+\r
+ cd ~/esp/hello_world\r
+ make menuconfig\r
+\r
+Windows 操作系统\r
+~~~~~~~~~~~~~~~~~~~\r
+\r
+.. code-block:: batch\r
+\r
+ cd %userprofile%\esp\hello_world\r
+ make menuconfig\r
+\r
+如果之前的步骤都正确，则会显示下面的菜单：\r
+\r
+.. figure:: ../../_static/project-configuration.png\r
+ :align: center\r
+ :alt: 工程配置 — 主窗口\r
+ :figclass: align-center\r
+\r
+ 工程配置 — 主窗口\r
+\r
+进入菜单后，选择 ``Serial flasher config`` > ``Default serial port`` 配置串口（设备将通过该串口加载工程）。按回车键确认选择，点击 ``< Save >`` 保存配置，然后点击 ``< Exit >`` 退出 ``menuconfig``。\r
+\r
+``menuconfig`` 工具的常见操作见下。\r
+\r
+* ``上下箭头``：移动\r
+* ``回车``：进入子菜单\r
+* ``ESC 键``：返回上级菜单或退出\r
+* ``英文问号``：调出帮助菜单（退出帮助菜单，请按回车键）。\r
+* ``空格``、``Y 键``或``N 键``：使能/禁用 ``[*]`` 配置选项\r
+* ``英文问号`` ：调出有关高亮选项的帮助菜单\r
+* ``/ 键``：寻找配置项目\r
+\r
+.. note::\r
+\r
+ 如果您是 **Arch Linux** 用户，请前往 ``SDK tool configuration``，并将 ``Python 2 interpreter`` 的名称从 ``python`` 替换为 ``python2``。\r
+\r
+.. attention::\r
+\r
+ 如果您使用的是 ESP32-DevKitC（板载 ESP32-SOLO-1 模组），请在烧写示例程序前，前往 ``menuconfig`` 中使能单核模式（:ref:`CONFIG_FREERTOS_UNICORE`）。\r
+\r
+.. _get-started-build-and-flash:\r
+\r
+第八步：编译和烧录\r
+====================\r
+\r
+请使用以下命令，编译烧录工程： :: \r
+\r
+ make flash\r
+\r
+运行以上命令可以编译应用程序和所有 ESP-IDF 组件，接着生成 bootloader、分区表和应用程序二进制文件。接着，这些二进制文件将被烧录至 ESP32 开发板。\r
+\r
+如果一切顺利，您可在烧录完成后看到类似下方的打印信息（代表加载进程）。接着，开发板将会复位，应用程序 "hello_world" 开始启动。\r
+\r
+.. highlight:: none\r
+\r
+::\r
+\r
+ esptool.py v2.0-beta2\r
+ Flashing binaries to serial port /dev/ttyUSB0 (app at offset 0x10000)...\r
+ esptool.py v2.0-beta2\r
+ Connecting........___\r
+ Uploading stub...\r
+ Running stub...\r
+ Stub running...\r
+ Changing baud rate to 921600\r
+ Changed.\r
+ Attaching SPI flash...\r
+ Configuring flash size...\r
+ Auto-detected Flash size:4MB\r
+ Flash params set to 0x0220\r
+ Compressed 11616 bytes to 6695...\r
+ Wrote 11616 bytes (6695 compressed) at 0x00001000 in 0.1 seconds (effective 920.5 kbit/s)...\r
+ Hash of data verified.\r
+ Compressed 408096 bytes to 171625...\r
+ Wrote 408096 bytes (171625 compressed) at 0x00010000 in 3.9 seconds (effective 847.3 kbit/s)...\r
+ Hash of data verified.\r
+ Compressed 3072 bytes to 82...\r
+ Wrote 3072 bytes (82 compressed) at 0x00008000 in 0.0 seconds (effective 8297.4 kbit/s)...\r
+ Hash of data verified.\r
+ \r
+ Leaving...\r
+ Hard resetting...\r
+\r
+\r
+如果您希望使用 Eclipse IDE，而非 ``make`` 编译系统，请参考 :doc:`Eclipse 指南 <eclipse-setup>`。\r
+\r
+\r
+.. _get-started-monitor:\r
+\r
+第九步：监视器\r
+===============\r
+\r
+您可以使用 ``make monitor`` 命令，监视 “hello_world” 的运行情况。\r
+\r
+运行该命令后，:doc:`IDF 监视器 <../api-guides/tools/idf-monitor>` 应用程序将启动： ::\r
+\r
+ $ make monitor\r
+ MONITOR\r
+ --- idf_monitor on /dev/ttyUSB0 115200 ---\r
+ --- Quit:Ctrl+] | Menu:Ctrl+T | Help:Ctrl+T followed by Ctrl+H ---\r
+ ets Jun 8 2016 00:22:57\r
+\r
+ rst:0x1 (POWERON_RESET),boot:0x13 (SPI_FAST_FLASH_BOOT)\r
+ ets Jun 8 2016 00:22:57\r
+ ...\r
+\r
+此时，您就可以在启动日志和诊断日志之后，看到打印的 “Hello world!” 了。\r
+\r
+.. code-block:: none\r
+\r
+ ...\r
+ Hello world!\r
+ Restarting in 10 seconds...\r
+ I (211) cpu_start:Starting scheduler on APP CPU.\r
+ Restarting in 9 seconds...\r
+ Restarting in 8 seconds...\r
+ Restarting in 7 seconds...\r
+\r
+您可使用快捷键 ``Ctrl+]``，退出 IDF 监视器。\r
+\r
+如果 IDF 监视器在烧录后很快发生错误，或打印信息全是乱码（见下），很有可能是因为您的开发板选用了 26 MHz 晶振，而 ESP-IDF 默认支持大多数开发板使用的 40 MHz 晶振。\r
+\r
+.. code-block:: none\r
+\r
+ e���)(Xn@�y.!��(�PW+)��Hn9a/9�!�t5��P�~�k��e�ea�5�jA\r
+ ~zY��Y(1�,1\15�� e���)(Xn@�y.!Dr�zY(�\ 6jpi�|�+z5Ymvp\r
+\r
+此时，请您：\r
+\r
+1. 退出监视器。\r
+2. 打开 :ref:`menuconfig <get-started-configure>`，\r
+3. 进入 ``Component config`` --> ``ESP32-specific`` --> ``Main XTAL frequency`` 进行配置，将 :ref:`CONFIG_ESP32_XTAL_FREQ_SEL` 设置为 26 MHz。\r
+4. 然后，请重新 :ref:`编译和烧录 <get-started-build-and-flash>` 应用程序。\r
+\r
+.. note::\r
+\r
+ 您也可以运行以下命令，一次性执行构建、烧录和监视过程： :: \r
+\r
+ make flash monitor\r
+\r
+此外，请前往 :doc:`IDF 监视器 <../api-guides/tools/idf-monitor>`，了解更多使用 IDF 监视器的快捷键和其他详情。\r
+\r
+**恭喜，您已完成 ESP32 的入门学习！**\r
+\r
+现在，您可以尝试一些其他 :idf:`examples`，或者直接开发自己的应用程序。\r
+\r
+\r
+环境变量\r
+=========\r
+\r
+用户可以在使用 ``make`` 命令时 **直接设置** 部分环境变量，而无需进入 ``make menuconfig`` 进行重新配置。这些变量包括：\r
+\r
++-----------------+-----------------------------------------------------------------------+\r
+| 变量 | 描述与使用方式 |\r
++-----------------+-----------------------------------------------------------------------+\r
+| ``ESPPORT`` | 覆盖 ``flash`` 和 ``monitor`` 命令使用的串口。 |\r
++ +-----------------------------------------------------------------------+\r
+| | 例：``make flash ESPPORT=/dev/ttyUSB1``, ``make monitor ESPPORT=COM1``|\r
++-----------------+-----------------------------------------------------------------------+\r
+| ``ESPBAUD`` | 覆盖烧录 ESP32 时使用的串口速率。 |\r
++ +-----------------------------------------------------------------------+\r
+| | 例：``make flash ESPBAUD=9600`` |\r
++-----------------+-----------------------------------------------------------------------+\r
+| ``MONITORBAUD`` | 覆盖监控时使用的串口速率。 |\r
++ +-----------------------------------------------------------------------+\r
+| | 例：``make monitor MONITORBAUD=9600`` |\r
++-----------------+-----------------------------------------------------------------------+\r
+\r
+.. note::\r
+\r
+ 您可导出环境变量（例：``export ESPPORT=/dev/ttyUSB1``）。\r
+ 在同一会话窗口中，如果未被同步覆盖，所有 ``make`` 命令均会使用导出的环境变量值。\r
+\r
+\r
+更新 ESP-IDF\r
+=============\r
+\r
+乐鑫会不时推出更新版本的 ESP-IDF，修复 bug 或提出新的特性。因此，在使用时，您也应注意更新您本地的版本。最简单的方法是：直接删除您本地的 ``esp-idf`` 文件夹，然后按照 :ref:`get-started-get-esp-idf` 中的指示，重新完成克隆。 \r
+\r
+如果您希望将 ESP-IDF 克隆到新的路径下，请务必 :doc:`重新设置 IDF_PATH <add-idf_path-to-profile>`。否则，工具链将无法找到 ESP-IDF。\r
+\r
+此外，您可以仅更新变更部分。具体方式，请前往 :ref:`更新 <updating>` 章节查看。\r
+\r
+相关文档\r
+=========\r
+\r
+.. toctree::\r
+ :maxdepth: 1\r
+\r
+ add-idf_path-to-profile\r
+ establish-serial-connection\r
+ make-project\r
+ eclipse-setup\r
+ ../api-guides/tools/idf-monitor\r
+ toolchain-setup-scratch\r
+\r
+.. _Stable version: https://docs.espressif.com/projects/esp-idf/zh_CN/stable/\r
+.. _Releases page: https://github.com/espressif/esp-idf/releases
\ No newline at end of file
projects / esp-idf / commitdiff