Merge branch 'doc/update_CN_translation_for_relase/v4.2' into 'release/v4.2'

update CN translation for index.rst and vscode-setup.rst in get-started folder (v4.2)

See merge request espressif/esp-idf!11522
This commit is contained in:
Krzysztof Budzynski
2020-12-09 19:13:25 +08:00
3 changed files with 221 additions and 90 deletions

View File

@ -136,7 +136,7 @@ Some tools need to be installed on the computer before proceeding to the next st
+-------------------+-------------------+-------------------+ +-------------------+-------------------+-------------------+
| |windows-logo| | |linux-logo| | |macos-logo| | | |windows-logo| | |linux-logo| | |macos-logo| |
+-------------------+-------------------+-------------------+ +-------------------+-------------------+-------------------+
| `Windows`_ | `Linux`_ | `Mac OS`_ | | `Windows`_ | `Linux`_ | `mac OS`_ |
+-------------------+-------------------+-------------------+ +-------------------+-------------------+-------------------+
.. |windows-logo| image:: ../../_static/windows-logo.png .. |windows-logo| image:: ../../_static/windows-logo.png
@ -150,7 +150,7 @@ Some tools need to be installed on the computer before proceeding to the next st
.. _Windows: ../get-started/windows-setup.html .. _Windows: ../get-started/windows-setup.html
.. _Linux: ../get-started/linux-setup.html .. _Linux: ../get-started/linux-setup.html
.. _Mac OS: ../get-started/macos-setup.html .. _mac OS: ../get-started/macos-setup.html
.. _get-started-get-esp-idf: .. _get-started-get-esp-idf:

View File

@ -11,7 +11,7 @@
概述 概述
============ ============
.. only:esp32 .. only:: esp32
ESP32 SoC 芯片支持以下功能: ESP32 SoC 芯片支持以下功能:
@ -21,13 +21,16 @@
* 超低功耗协处理器 * 超低功耗协处理器
* 多种外设 * 多种外设
.. only:esp32s2 .. only:: esp32s2
ESP32-S2 SoC 芯片支持以下功能: ESP32-S2 SoC 芯片支持以下功能:
* 2.4 GHz Wi-Fi * 2.4 GHz Wi-Fi
* 超低功耗协处理器 * 高性能单核
* 运行 RISC-V 或 FSM 内核的超低功耗协处理器
* 多种外设 * 多种外设
* 内置安全硬件
* USB OTG 接口
{IDF_TARGET_NAME} 采用 40 nm 工艺制成,具有最佳的功耗性能、射频性能、稳定性、通用性和可靠性,适用于各种应用场景和不同功耗需求。 {IDF_TARGET_NAME} 采用 40 nm 工艺制成,具有最佳的功耗性能、射频性能、稳定性、通用性和可靠性,适用于各种应用场景和不同功耗需求。
@ -39,15 +42,21 @@
硬件: 硬件:
* 一款 **{IDF_TARGET_NAME}** 开发板 * 一款 **{IDF_TARGET_NAME}** 开发板
* **USB 数据线** (A 转 Micro-B) * **USB 数据线** A 转 Micro-B
* PCWindows、Linux 或 Mac OS * 电脑Windows、Linux 或 mac OS
软件: 软件:
您可以选择下载并手动安装以下软件:
* 设置 **工具链**,用于编译 {IDF_TARGET_NAME} 代码; * 设置 **工具链**,用于编译 {IDF_TARGET_NAME} 代码;
* **编译工具** —— CMake 和 Ninja 编译工具,用于编译 {IDF_TARGET_NAME} **应用程序** * **编译构建工具** —— CMake 和 Ninja 编译构建工具,用于编译 {IDF_TARGET_NAME} **应用程序**
* 获取 **ESP-IDF** 软件开发框架。该框架已经基本包含 {IDF_TARGET_NAME} 使用的 API软件库和源代码和运行 **工具链** 的脚本; * 获取 **ESP-IDF** 软件开发框架。该框架已经基本包含 {IDF_TARGET_NAME} 使用的 API软件库和源代码和运行 **工具链** 的脚本;
* 安装 C 语言编程(**工程**)的 **文本编辑器**,例如 `Eclipse <https://www.eclipse.org/>`_
或者,您也可以通过以下集成开发环境 (IDE) 中的官方插件完成安装流程:
* `Eclipse 插件 <https://github.com/espressif/idf-eclipse-plugin>`_ (`安装 <https://github.com/espressif/idf-eclipse-plugin#installing-idf-plugin-using-update-site-url>`__)
* `VS Code 插件 <https://github.com/espressif/vscode-esp-idf-extension>`_ (`安装 <https://github.com/espressif/vscode-esp-idf-extension/blob/master/docs/ONBOARDING.md>`__)
.. figure:: ../../_static/what-you-need.png .. figure:: ../../_static/what-you-need.png
@ -120,12 +129,12 @@
Windows <windows-setup> Windows <windows-setup>
Linux <linux-setup> Linux <linux-setup>
MacOS <macos-setup> macOS <macos-setup>
+-------------------+-------------------+-------------------+ +-------------------+-------------------+-------------------+
| |windows-logo| | |linux-logo| | |macos-logo| | | |windows-logo| | |linux-logo| | |macos-logo| |
+-------------------+-------------------+-------------------+ +-------------------+-------------------+-------------------+
| `Windows`_ | `Linux`_ | `Mac OS`_ | | `Windows`_ | `Linux`_ | `mac OS`_ |
+-------------------+-------------------+-------------------+ +-------------------+-------------------+-------------------+
.. |windows-logo| image:: ../../_static/windows-logo.png .. |windows-logo| image:: ../../_static/windows-logo.png
@ -139,7 +148,7 @@
.. _Windows: ../get-started/windows-setup.html .. _Windows: ../get-started/windows-setup.html
.. _Linux: ../get-started/linux-setup.html .. _Linux: ../get-started/linux-setup.html
.. _Mac OS: ../get-started/macos-setup.html .. _mac OS: ../get-started/macos-setup.html
.. _get-started-get-esp-idf: .. _get-started-get-esp-idf:
@ -153,12 +162,12 @@
.. note:: .. note::
在本文档中Linux 和 MacOS 操作系统中 ESP-IDF 的默认安装路径为 ``~/esp``Windows 操作系统的默认路径为 ``%userprofile%\esp``。您也可以将 ESP-IDF 安装在任何其他路径下但请注意在使用命令行时进行相应替换。注意ESP-IDF 不支持带有空格的路径。 在本文档中Linux 和 macOS 操作系统中 ESP-IDF 的默认安装路径为 ``~/esp``Windows 操作系统的默认路径为 ``%userprofile%\esp``。您也可以将 ESP-IDF 安装在任何其他路径下但请注意在使用命令行时进行相应替换。注意ESP-IDF 不支持带有空格的路径。
Linux 和 MacOS 操作系统 Linux 和 macOS 操作系统
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
打开终端后运行以下命令: 打开终端后运行以下命令:
.. include-build-file:: inc/git-clone-bash.inc .. include-build-file:: inc/git-clone-bash.inc
@ -201,7 +210,7 @@ Windows 操作系统
cd ~/esp/esp-idf cd ~/esp/esp-idf
./install.ps1 ./install.ps1
Linux 和 MacOS 操作系统 Linux 和 macOS 操作系统
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code-block:: bash .. code-block:: bash
@ -212,9 +221,9 @@ Linux 和 MacOS 操作系统
自定义工具安装路径 自定义工具安装路径
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
本步骤中介绍的脚本将 ESP-IDF 所需的编译工具默认安装在用户根文件夹中,即 Linux 和 MacOS 系统中的 ``$HOME/.espressif`` 和 Windows 系统的 ``%USERPROFILE%\.espressif``此外,您可以可以将工具安装到其他目录中,但请在运行安装脚本前,重新设置环境变量 ``IDF_TOOLS_PATH``。注意,请确保您的用户已经具备了读写该路径的权限。 本步骤中介绍的脚本将 ESP-IDF 所需的编译工具默认安装在用户根文件夹中,即 Linux 和 macOS 系统中的 ``$HOME/.espressif`` 和 Windows 系统的 ``%USERPROFILE%\.espressif``您也可以选择将工具安装到其他目录中,但请在运行安装脚本前,重新设置环境变量 ``IDF_TOOLS_PATH``。注意,请确保您的用户已经具备了读写该路径的权限。
如果修改了 ``IDF_TOOLS_PATH`` 变量,请确保该变量在每次执行“安装脚本” (``install.bat````install.ps1````install.sh``) 和导出脚本 (``export.bat````export.ps1````export.sh``) 均保持一致。 如果修改了 ``IDF_TOOLS_PATH`` 变量,请确保该变量在每次执行“安装脚本” ``install.bat````install.ps1````install.sh``)和导出脚本 ``export.bat````export.ps1````export.sh``)时均保持一致。
.. _get-started-set-up-env: .. _get-started-set-up-env:
@ -240,7 +249,7 @@ Windows 安装器(:ref:`get-started-windows-tools-installer` )可在“开
.$HOME/esp/esp-idf/export.ps1 .$HOME/esp/esp-idf/export.ps1
Linux 和 MacOS 操作系统 Linux 和 macOS 操作系统
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
请在您需要运行 ESP-IDF 的“命令提示符”窗口运行以下命令: 请在您需要运行 ESP-IDF 的“命令提示符”窗口运行以下命令:
@ -251,7 +260,19 @@ Linux 和 MacOS 操作系统
注意,命令开始的 "." 与路径之间应有一个空格! 注意,命令开始的 "." 与路径之间应有一个空格!
此外,您可以将这行代码增加至您的 ``.profile````.bash_profile`` 脚本中,这样您就可以在任何命令窗口使用 ESP-IDF 工具了。 如果您需要经常运行 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 虚拟环境(包括无需使用 IDF 的情况),从而破坏使用虚拟环境的目的,并可能影响其他软件的使用。
.. _get-started-start-project: .. _get-started-start-project:
@ -262,7 +283,7 @@ Linux 和 MacOS 操作系统
:example:`get-started/hello_world` 复制至您本地的 ``~/esp`` 目录下: :example:`get-started/hello_world` 复制至您本地的 ``~/esp`` 目录下:
Linux 和 MacOS 操作系统 Linux 和 macOS 操作系统
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code-block:: bash .. code-block:: bash
@ -295,7 +316,7 @@ ESP-IDF 的 :idf:`examples` 目录下有一系列示例工程,都可以按照
- **Windows 操作系统:** ``COM1`` - **Windows 操作系统:** ``COM1``
- **Linux 操作系统:**``/dev/tty`` 开始 - **Linux 操作系统:**``/dev/tty`` 开始
- **MacOS 操作系统:**``/dev/cu.`` 开始 - **macOS 操作系统:**``/dev/cu.`` 开始
有关如何查看串口名称的详细信息,请见 :doc:`establish-serial-connection` 有关如何查看串口名称的详细信息,请见 :doc:`establish-serial-connection`
@ -311,7 +332,7 @@ ESP-IDF 的 :idf:`examples` 目录下有一系列示例工程,都可以按照
请进入 :ref:`get-started-start-project` 中提到的 ``hello_world`` 目录,并运行工程配置工具 ``menuconfig`` 请进入 :ref:`get-started-start-project` 中提到的 ``hello_world`` 目录,并运行工程配置工具 ``menuconfig``
Linux 和 MacOS 操作系统 Linux 和 macOS 操作系统
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code-block:: bash .. code-block:: bash
@ -329,7 +350,7 @@ Windows 操作系统
idf.py set-target {IDF_TARGET_PATH_NAME} idf.py set-target {IDF_TARGET_PATH_NAME}
idf.py menuconfig idf.py menuconfig
打开一个新项目后,应首先设置“目标”芯片 ``idf.py set-target {IDF_TARGET_PATH_NAME}``。注意,此操作将清除并初始化项目之前的编译和配置(如有)。 您也可以直接将“目标”配置为环境变量(此时可跳过该步骤)。更多信息,请见 :ref:`selecting-idf-target` 打开一个新项目后,应首先设置“目标”芯片 ``idf.py set-target {IDF_TARGET_PATH_NAME}``。注意,此操作将清除并初始化项目之前的编译和配置(如有)。 您也可以直接将“目标”配置为环境变量(可跳过该步骤)。更多信息,请见 :ref:`selecting-idf-target`
如果之前的步骤都正确,则会显示下面的菜单: 如果之前的步骤都正确,则会显示下面的菜单:
@ -340,15 +361,7 @@ Windows 操作系统
工程配置 — 主窗口 工程配置 — 主窗口
``menuconfig`` 工具的常见操作见下 您可以通过此菜单设置项目的具体变量,包括 Wi-Fi 网络名称、密码和处理器速度等. ``hello_world`` 示例项目会以默认配置运行,因此可以跳过使用 ``menuconfig`` 进行项目配置这一步骤
* 上下箭头:移动
* ``回车``:进入子菜单
* ``ESC 键``:返回上级菜单或退出
* ``英文问号``:调出帮助菜单(退出帮助菜单,请按回车键)。
* ``空格````Y 键``:选择 ``[*]`` 配置选项;``N 键``:禁用 ``[*]`` 配置选项
* ``英文问号`` (查询配置选项):调出有关该选项的帮助菜单
* ``/ 键``:寻找配置工程
.. only:: esp32 .. only:: esp32
@ -356,6 +369,10 @@ Windows 操作系统
如果您使用的是 ESP32-DevKitC板载 ESP32-SOLO-1 模组),请在烧写示例程序前,前往 ``menuconfig`` 中使能单核模式(:ref:`CONFIG_FREERTOS_UNICORE`)。 如果您使用的是 ESP32-DevKitC板载 ESP32-SOLO-1 模组),请在烧写示例程序前,前往 ``menuconfig`` 中使能单核模式(:ref:`CONFIG_FREERTOS_UNICORE`)。
.. 注解::
您终端窗口中显示出的菜单颜色可能会与上图不同。您可以通过选项 ``--style`` 来改变外观。更多信息,请运行 ``idf.py menuconfig --help`` 命令。
.. _get-started-build: .. _get-started-build:
第八步:编译工程 第八步:编译工程
@ -395,7 +412,7 @@ Windows 操作系统
第九步:烧录到设备 第九步:烧录到设备
============================= =============================
请使用以下命令,将刚刚生成的二进制文件烧录 (bootloader.bin, partition-table.bin 和 hello-world.bin) 至您的 {IDF_TARGET_NAME} 开发板: 请使用以下命令,将刚刚生成的二进制文件烧录bootloader.bin, partition-table.bin 和 hello-world.bin至您的 {IDF_TARGET_NAME} 开发板:
``idf.py -p PORT [-b BAUD] flash`` ``idf.py -p PORT [-b BAUD] flash``
@ -409,42 +426,114 @@ Windows 操作系统
勾选 ``flash`` 选项将自动编译并烧录工程,因此无需再运行 ``idf.py build`` 勾选 ``flash`` 选项将自动编译并烧录工程,因此无需再运行 ``idf.py build``
烧录过程中可能遇到的问题
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
如果在运行给定命令时出现如“连接失败”这样的错误,原因之一则可能是运行 ``esptool.py`` 出现错误。``esptool.py`` 是编译系统调用的程序,用于重置芯片、与 ROM 引导加载器交互以及烧录固件的工具。解决该问题的一个简单的方法就是按照以下步骤进行手动复位。如果问题仍未解决,请参考 `Troubleshooting <https://github.com/espressif/esptool#bootloader-wont-respond>`_ 获取更多信息。
``esptool.py`` 通过使 USB 转串口转接器芯片(如 FTDI 或 CP210x的 DTR 和 RTS 控制线生效来自动复位 {IDF_TARGET_NAME}(请参考 :doc:`establish-serial-connection` 获取更多详细信息)。DTR 和 RTS 控制线又连接到 {IDF_TARGET_NAME} 的 ``GPIO0````CHIP_PU`` (EN) 管脚上,因此 DTR 和 RTS 的电压水平变化会使 {IDF_TARGET_NAME} 进入固件下载模式。相关示例可查看 ESP32 DevKitC 开发板的 `原理图 <https://dl.espressif.com/dl/schematics/esp32_devkitc_v4-sch-20180607a.pdf>`_
一般来说,使用官方的 esp-idf 开发板不会出现问题。但是,``esptool.py`` 在以下情况下不能自动重置硬件。
- 您的硬件没有连接到 ``GPIO0````CIHP_PU`` 的 DTR 和 RTS 控制线。
- DTR 和 RTS 控制线的配置方式不同
- 根本没有这样的串行控制线路
根据您硬件的种类,也可以将您 {IDF_TARGET_NAME} 开发板手动设置成固件下载模式(复位)。
- 对于 Espressif 的开发板,您可以参考对应开发板的入门指南或用户指南。例如,可以通过按住 **Boot** 按钮 (``GPIO0``) 再按住 **EN** 按钮(``CHIP_PU``) 来手动复位 esp-idf 开发板。
- 对于其他类型的硬件,可以尝试将 ``GPIO0`` 拉低。
常规操作
~~~~~~~~~~~~~~~~
在烧录过程中,您会看到类似如下的输出日志:
.. only:: esp32
.. code-block:: none .. code-block:: none
Running esptool.py in directory [...]/esp/hello_world ...
Executing "python [...]/esp-idf/components/esptool_py/esptool/esptool.py -b 460800 write_flash @flash_project_args"... esptool.py --chip esp32 -p /dev/ttyUSB0 -b 460800 --before=default_reset --after=hard_reset write_flash --flash_mode dio --flash_freq 40m --flash_size 2MB 0x8000 partition_table/partition-table.bin 0x1000 bootloader/bootloader.bin 0x10000 hello-world.bin
esptool.py -b 460800 write_flash --flash_mode dio --flash_size detect --flash_freq 40m 0x1000 bootloader/bootloader.bin 0x8000 partition_table/partition-table.bin 0x10000 hello-world.bin esptool.py v3.0-dev
esptool.py v2.3.1 Serial port /dev/ttyUSB0
Connecting.... Connecting........_
Detecting chip type... {IDF_TARGET_NAME} Chip is ESP32D0WDQ6 (revision 0)
Chip is {IDF_TARGET_NAME}D0WDQ6 (revision 1) Features: WiFi, BT, Dual Core, Coding Scheme None
Features: WiFi, BT, Dual Core Crystal is 40MHz
MAC: 24:0a:c4:05:b9:14
Uploading stub... Uploading stub...
Running stub... Running stub...
Stub running... Stub running...
Changing baud rate to 460800 Changing baud rate to 460800
Changed. Changed.
Configuring flash size... Configuring flash size...
Auto-detected Flash size: 4MB Compressed 3072 bytes to 103...
Flash params set to 0x0220 Writing at 0x00008000... (100 %)
Compressed 22992 bytes to 13019... Wrote 3072 bytes (103 compressed) at 0x00008000 in 0.0 seconds (effective 5962.8 kbit/s)...
Wrote 22992 bytes (13019 compressed) at 0x00001000 in 0.3 seconds (effective 558.9 kbit/s)...
Hash of data verified. Hash of data verified.
Compressed 3072 bytes to 82... Compressed 26096 bytes to 15408...
Wrote 3072 bytes (82 compressed) at 0x00008000 in 0.0 seconds (effective 5789.3 kbit/s)... Writing at 0x00001000... (100 %)
Wrote 26096 bytes (15408 compressed) at 0x00001000 in 0.4 seconds (effective 546.7 kbit/s)...
Hash of data verified. Hash of data verified.
Compressed 136672 bytes to 67544... Compressed 147104 bytes to 77364...
Wrote 136672 bytes (67544 compressed) at 0x00010000 in 1.9 seconds (effective 567.5 kbit/s)... Writing at 0x00010000... (20 %)
Writing at 0x00014000... (40 %)
Writing at 0x00018000... (60 %)
Writing at 0x0001c000... (80 %)
Writing at 0x00020000... (100 %)
Wrote 147104 bytes (77364 compressed) at 0x00010000 in 1.9 seconds (effective 615.5 kbit/s)...
Hash of data verified. Hash of data verified.
Leaving... Leaving...
Hard resetting via RTS pin... Hard resetting via RTS pin...
Done
.. only:: esp32s2
.. code-block:: none
...
esptool.py --chip esp32s2 -p /dev/ttyUSB0 -b 460800 --before=default_reset --after=hard_reset write_flash --flash_mode dio --flash_freq 40m --flash_size 2MB 0x8000 partition_table/partition-table.bin 0x1000 bootloader/bootloader.bin 0x10000 hello-world.bin
esptool.py v3.0-dev
Serial port /dev/ttyUSB0
Connecting....
Chip is ESP32-S2
Features: WiFi
Crystal is 40MHz
MAC: 18:fe:34:72:50:e3
Uploading stub...
Running stub...
Stub running...
Changing baud rate to 460800
Changed.
Configuring flash size...
Compressed 3072 bytes to 103...
Writing at 0x00008000... (100 %)
Wrote 3072 bytes (103 compressed) at 0x00008000 in 0.0 seconds (effective 3851.6 kbit/s)...
Hash of data verified.
Compressed 22592 bytes to 13483...
Writing at 0x00001000... (100 %)
Wrote 22592 bytes (13483 compressed) at 0x00001000 in 0.3 seconds (effective 595.1 kbit/s)...
Hash of data verified.
Compressed 140048 bytes to 70298...
Writing at 0x00010000... (20 %)
Writing at 0x00014000... (40 %)
Writing at 0x00018000... (60 %)
Writing at 0x0001c000... (80 %)
Writing at 0x00020000... (100 %)
Wrote 140048 bytes (70298 compressed) at 0x00010000 in 1.7 seconds (effective 662.5 kbit/s)...
Hash of data verified.
Leaving...
Hard resetting via RTS pin...
Done
如果一切顺利,烧录完成后,开发板将会复位,应用程序 "hello_world" 开始运行。 如果一切顺利,烧录完成后,开发板将会复位,应用程序 "hello_world" 开始运行。
.. note:: 如果您希望使用 Eclipse 或是 VS Code IDE而非 ``idf.py``,请参考 :doc:`Eclipse 指南 <eclipse-setup>`,以及 :doc:`VS Code 指南 <vscode-setup>`
(目前不支持)如果您希望使用 Eclipse IDE而非 ``idf.py``,请参考 :doc:`Eclipse 指南 <eclipse-setup>`
.. _get-started-build-monitor: .. _get-started-build-monitor:
@ -454,7 +543,7 @@ Windows 操作系统
您可以使用 ``idf.py -p PORT monitor`` 命令,监视 “hello_world” 的运行情况。注意,不要忘记将 PORT 替换为您的串口名称。 您可以使用 ``idf.py -p PORT monitor`` 命令,监视 “hello_world” 的运行情况。注意,不要忘记将 PORT 替换为您的串口名称。
运行该命令后,:doc:`IDF 监视器 <../api-guides/tools/idf-monitor>` 应用程序将启动:: 运行该命令后,:doc:`IDF 监视器 <../api-guides/tools/idf-monitor>` 应用程序将启动::
$ idf.py -p /dev/ttyUSB0 monitor $ idf.py -p /dev/ttyUSB0 monitor
Running idf_monitor in directory [...]/esp/hello_world/build Running idf_monitor in directory [...]/esp/hello_world/build
@ -474,7 +563,7 @@ Windows 操作系统
... ...
Hello world! Hello world!
Restarting in 10 seconds... Restarting in 10 seconds...
I (211) cpu_start: Starting scheduler on APP CPU. This is esp32 chip with 2 CPU cores, WiFi/BT/BLE, silicon revision 1, 2MB external flash
Restarting in 9 seconds... Restarting in 9 seconds...
Restarting in 8 seconds... Restarting in 8 seconds...
Restarting in 7 seconds... Restarting in 7 seconds...
@ -512,16 +601,22 @@ Windows 操作系统
现在,您可以尝试一些其他 :idf:`examples`,或者直接开发自己的应用程序。 现在,您可以尝试一些其他 :idf:`examples`,或者直接开发自己的应用程序。
.. 重要::
一些示例程序不支持 {IDF_TARGET_NAME},因为 {IDF_TARGET_NAME} 中不包含所需的硬件。
在编译示例程序前请查看 README 文件中 ``Supported Targets`` 表格。如果表格中包含 {IDF_TARGET_NAME} 或者不存在这个表格,那么即表示 {IDF_TARGET_NAME} 支持这个示例程序。
更新 ESP-IDF 更新 ESP-IDF
================ ================
乐鑫会不推出更新版本的 ESP-IDF修复 bug 或提新的特性。因此,您在使用时,也应注意更新您本地的版本。最简单的方法是:直接删除您本地的 ``esp-idf`` 文件夹,然后按照 :ref:`get-started-get-esp-idf` 中的指示,重新完成克隆。 乐鑫会不定期推出更新版本的 ESP-IDF修复 bug 或提新的功能。因此,您在使用时,也应注意更新您本地的版本。最简单的方法是:直接删除您本地的 ``esp-idf`` 文件夹,然后按照 :ref:`get-started-get-esp-idf` 中的指示,重新完成克隆。
此外,您可以仅更新变更部分。具体方式,请前往 :ref:`更新 <updating>` 章节查看。 此外,您可以仅更新变更部分。具体方式,请前往 :ref:`更新 <updating>` 章节查看。
注意,更新完成后,请执行 ``install.sh`` Windows 系统中为 ``install.bat``脚本,避免新版 ESP-IDF 所需的工具也有所更新。具体请参考 :ref:`get-started-set-up-tools` 注意,更新完成后,请再次运行安装脚本,以防新版 ESP-IDF 所需的工具也有所更新。具体请参考 :ref:`get-started-set-up-tools`
一旦重新安装好工具,请使用导出脚本更新环境,具体请参考 :ref:`get-started-set-up-env` 一旦重新安装好工具,请使用导出脚本更新环境,具体请参考 :ref:`get-started-set-up-env`
相关文档 相关文档
================= =================

View File

@ -1 +1,37 @@
.. include:: ../../en/get-started/vscode-setup.rst ********************************
VS Code IDE 快速入门
********************************
:link_to_translation:`en:[English]`
我们支持 VS Code并且致力于为所有与 ESP-IDF 相关的操作提供完善的端到端支持包括构建、烧录、监控、调试、追踪、core-dump、以及系统追踪查看器等操作。
快速安装指南
===============
推荐您从 `VS Code 插件市场 <https://marketplace.visualstudio.com/items?itemName=espressif.esp-idf-extension>`_ 中下载 ESP-IDF VS Code 插件,或根据 `快速安装指南 <https://github.com/espressif/vscode-esp-idf-extension/#quick-installation-guide>`_ 安装 ESP-IDF VS Code 插件。
支持如下功能
==================
* **安装**:帮助您迅速安装 ESP-IDF 及其相关工具链。
* **构建**:通过一键构建和多目标构建,轻松构建并部署您的应用程序。
* **烧录**UART 和 JTAG 均可完成烧录。
* **监控**:内置终端带有监控功能,您可以在 VS Code 中启用 IDF 监控命令,操作方法和传统终端一样。
* **调试**:提供立即可用的硬件调试功能,同时支持事后剖析调试如 core-dump 功能,分析 bug 更加方便。
* **GUI 菜单配置**:提供简化的用户界面,用于配置您的芯片。
* **应用程序追踪 & 堆追踪**:支持从应用程序中收集跟踪,并提供简化的用户界面分析跟踪。
* **系统视图查看器**:读取并显示 *.svdat* 文件到用户追踪界面,同时支持多个内核追踪视图。
* **IDF 二进制大小分析**:为分析二进制文件大小提供用户界面。
* `Rainmaker Cloud <https://rainmaker.espressif.com/>`_:我们有内置的 Rainmaker Cloud 支持,您可以轻松编辑/读取连接的物联网设备的状态。
* **代码覆盖**:我们有内置的代码覆盖支持,将用颜色突出显示已经覆盖的行。我们也会在 IDE 内部直接渲染现有的 HTML 报告。
Bugs 问题 & 功能请求
=======================
如果您在使用 VS Code 或其某些功能上遇到问题,建议您在 `论坛 <http://esp32.com/viewforum.php?f=40>`_ 或是 `github <https://github.com/espressif/vscode-esp-idf-extension/issues/new/choose>`__ 上提出您的问题,我们开发团队会对问题进行解答。
我们也欢迎您提出新的功能需求,正是由于用户要求新功能或是建议对现有功能进行改善,才成就我们今天所具备的大多数功能。欢迎您在 `github <http://github.com/espressif/vscode-esp-idf-extension/issues/new/choose>`__ 上提出功能请求。