mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
Merge branch 'docs/update_CN_trans_getstarted_V4.3' into 'release/v4.3'
docs: update CN translation and keep line number consistent for all documents... See merge request espressif/esp-idf!15309
This commit is contained in:
Dai Zi Yan
commit
6d09d5e2f7
@ -1,6 +1,7 @@
|
||||
********************************
|
||||
Build and Flash with Eclipse IDE
|
||||
********************************
|
||||
|
||||
:link_to_translation:`zh_CN:[中文]`
|
||||
|
||||
ESP-IDF V4.0 has a new CMake-based build system as the default build system.
|
||||
|
||||
@ -11,7 +11,6 @@ Connect {IDF_TARGET_NAME} to PC
|
||||
|
||||
Connect the {IDF_TARGET_NAME} board to the PC using the USB cable. If device driver does not install automatically, identify USB to serial converter chip on your {IDF_TARGET_NAME} board (or external converter dongle), search for drivers in internet and install them.
|
||||
|
||||
|
||||
Below is the list of USB to serial converter chips installed on most of the {IDF_TARGET_NAME} boards produced by Espressif together with links to the drivers:
|
||||
|
||||
* CP210x: `CP210x USB to UART Bridge VCP Drivers <https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers>`_
|
||||
@ -19,7 +18,6 @@ Below is the list of USB to serial converter chips installed on most of the {IDF
|
||||
|
||||
Please check the board user guide for specific USB to serial converter chip used. The drivers above are primarily for reference. Under normal circumstances, the drivers should be bundled with an operating system and automatically installed upon connecting the board to the PC.
|
||||
|
||||
|
||||
Check port on Windows
|
||||
---------------------
|
||||
|
||||
@ -59,7 +57,6 @@ macOS ::
|
||||
|
||||
macOS users: if you don't see the serial port then check you have the USB/serial drivers installed as shown in the Getting Started guide for your particular development board. For macOS High Sierra (10.13), you may also have to explicitly allow the drivers to load. Open System Preferences -> Security & Privacy -> General and check if there is a message shown here about "System Software from developer ..." where the developer name is Silicon Labs or FTDI.
|
||||
|
||||
|
||||
.. _linux-dialout-group:
|
||||
|
||||
Adding user to ``dialout`` on Linux
|
||||
|
||||
@ -8,14 +8,11 @@ Get Started
|
||||
|
||||
{IDF_TARGET_HEAP_SIZE:default="298968", esp32="298968", esp32s2="253900", esp32c3="337332"}
|
||||
|
||||
|
||||
:link_to_translation:`zh_CN:[中文]`
|
||||
|
||||
.. Please keep README.md in sync with these instructions.
|
||||
|
||||
This document is intended to help you set up the software development environment for the hardware based on the {IDF_TARGET_NAME} chip by Espressif.
|
||||
|
||||
After that, a simple example will show you how to use ESP-IDF (Espressif IoT Development Framework) for menu configuration, then for building and flashing firmware onto an {IDF_TARGET_NAME} board.
|
||||
This document is intended to help you set up the software development environment for the hardware based on the {IDF_TARGET_NAME} chip by Espressif. After that, a simple example will show you how to use ESP-IDF (Espressif IoT Development Framework) for menu configuration, then for building and flashing firmware onto an {IDF_TARGET_NAME} board.
|
||||
|
||||
.. include-build-file:: inc/version-note.inc
|
||||
|
||||
@ -32,7 +29,6 @@ Introduction
|
||||
* Ultra Low Power co-processor
|
||||
* Multiple peripherals
|
||||
|
||||
|
||||
.. only:: esp32s2
|
||||
|
||||
* Wi-Fi (2.4 GHz band)
|
||||
@ -377,9 +373,7 @@ Windows
|
||||
cd %userprofile%\esp
|
||||
xcopy /e /i %IDF_PATH%\examples\get-started\hello_world hello_world
|
||||
|
||||
There is a range of example projects in the :idf:`examples` directory in ESP-IDF. You can copy any project in the same way as presented above and run it.
|
||||
|
||||
It is also possible to build examples in-place, without copying them first.
|
||||
There is a range of example projects in the :idf:`examples` directory in ESP-IDF. You can copy any project in the same way as presented above and run it. It is also possible to build examples in-place, without copying them first.
|
||||
|
||||
.. important::
|
||||
|
||||
@ -451,8 +445,7 @@ You are using this menu to set up project specific variables, e.g. Wi-Fi network
|
||||
|
||||
.. note::
|
||||
|
||||
The colors of the menu could be different in your terminal. You can change the appearance with the option
|
||||
``--style``. Please run ``idf.py menuconfig --help`` for further information.
|
||||
The colors of the menu could be different in your terminal. You can change the appearance with the option ``--style``. Please run ``idf.py menuconfig --help`` for further information.
|
||||
|
||||
.. _get-started-build:
|
||||
|
||||
|
||||
@ -105,7 +105,6 @@ Python 2 deprecation
|
||||
|
||||
Python 2 reached its `end of life <https://www.python.org/doc/sunset-python-2/>`_ and support for it in ESP-IDF will be removed soon. Please install Python 3.6 or higher. Instructions for popular Linux distributions are listed above.
|
||||
|
||||
|
||||
Next Steps
|
||||
==========
|
||||
|
||||
|
||||
@ -54,5 +54,4 @@ Next Steps
|
||||
|
||||
To carry on with development environment setup, proceed to :ref:`get-started-get-esp-idf`.
|
||||
|
||||
|
||||
.. _AUR: https://wiki.archlinux.org/index.php/Arch_User_Repository
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
**********************************************
|
||||
Standard Setup of Toolchain for Mac OS
|
||||
Standard Setup of Toolchain for macOS
|
||||
**********************************************
|
||||
|
||||
:link_to_translation:`zh_CN:[中文]`
|
||||
|
||||
@ -24,4 +24,3 @@ In any case, here are the instructions to compile the toolchain yourself.
|
||||
windows-setup-scratch
|
||||
linux-setup-scratch
|
||||
macos-setup-scratch
|
||||
|
||||
|
||||
@ -115,4 +115,3 @@ To carry on with development environment setup, proceed to :ref:`get-started-set
|
||||
.. Note: These two targets may be used from git-clone-notes.inc depending on version, don't remove
|
||||
.. _Stable version: https://docs.espressif.com/projects/esp-idf/en/stable/
|
||||
.. _Releases page: https://github.com/espressif/esp-idf/releases
|
||||
|
||||
|
||||
@ -24,8 +24,7 @@ For this Getting Started we're going to use the Command Prompt, but after ESP-ID
|
||||
.. note::
|
||||
Limitation: the installation path of Python or ESP-IDF must not contain white spaces or parentheses.
|
||||
|
||||
Limitation: the installation path of Python or ESP-IDF should not contain special characters (non-ASCII) unless the operating system is configured with "Unicode UTF-8" support.
|
||||
System Administrator can enable the support via Control Panel - Change date, time, or number formats - Administrative tab - Change system locale - check the option "Beta: Use Unicode UTF-8 for worldwide language support" - Ok and reboot the computer.
|
||||
Limitation: the installation path of Python or ESP-IDF should not contain special characters (non-ASCII) unless the operating system is configured with "Unicode UTF-8" support. System Administrator can enable the support via Control Panel - Change date, time, or number formats - Administrative tab - Change system locale - check the option "Beta: Use Unicode UTF-8 for worldwide language support" - Ok and reboot the computer.
|
||||
|
||||
.. _get-started-windows-tools-installer:
|
||||
|
||||
@ -119,7 +118,6 @@ For advanced users who want to customize the install process:
|
||||
|
||||
windows-setup-update
|
||||
|
||||
|
||||
.. _MSYS2: https://www.msys2.org/
|
||||
.. _CMake: https://cmake.org/download/
|
||||
.. _Ninja: https://ninja-build.org/
|
||||
|
||||
@ -78,7 +78,6 @@ macOS::
|
||||
|
||||
现在，请使用串口终端程序，查看重置 {IDF_TARGET_NAME} 后终端上是否有输出，从而验证串口连接是否可用。
|
||||
|
||||
|
||||
Windows 和 Linux 操作系统
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
@ -103,12 +102,10 @@ Windows 和 Linux 操作系统
|
||||
|
||||
然后，请检查 {IDF_TARGET_NAME} 是否有打印日志。如有，请在终端打开串口进行查看。这里的日志内容取决于加载到 {IDF_TARGET_NAME} 的应用程序，请参考 `输出示例`_。
|
||||
|
||||
|
||||
.. 注解::
|
||||
|
||||
请在验证完串口通信正常后，关闭串口终端。如果您让终端一直保持打开的状态，之后上传固件时将无法访问串口。
|
||||
|
||||
|
||||
macOS 操作系统
|
||||
^^^^^^^^^^^^^^^^^
|
||||
|
||||
@ -134,13 +131,11 @@ macOS 提供了 **屏幕** 命令，因此您不用安装串口终端程序。
|
||||
|
||||
请在验证完串口通信正常后，关闭 **屏幕** 会话。如果直接关闭终端窗口而没有关闭 **屏幕**，之后上传固件时将无法访问串口。
|
||||
|
||||
|
||||
输出示例
|
||||
^^^^^^^^^^^
|
||||
|
||||
以下是 {IDF_TARGET_NAME} 的一个日志示例。如果没看到任何输出，请尝试重置开发板。
|
||||
|
||||
|
||||
.. highlight:: none
|
||||
|
||||
::
|
||||
@ -170,9 +165,6 @@ macOS 提供了 **屏幕** 命令，因此您不用安装串口终端程序。
|
||||
|
||||
在某些串口接线方式下，在 {IDF_TARGET_NAME} 启动并开始打印串口日志前，需要在终端程序中禁用串口 RTS ＆ DTR 管脚。该问题仅存在于将 RTS ＆ DTR 管脚直接连接到 EN ＆ GPIO0 管脚上的情况，绝大多数开发板（包括乐鑫所有的开发板）都没有这个问题。更多详细信息，请参考 `esptool 文档`_。
|
||||
|
||||
|
||||
如您在安装 {IDF_TARGET_NAME} 硬件开发的软件环境时，从 :ref:`get-started-connect` 跳转到了这里，请从 :ref:`get-started-configure` 继续阅读。
|
||||
|
||||
|
||||
.. _esptool 文档: https://github.com/espressif/esptool/wiki/ESP32-Boot-Mode-Selection#automatic-bootloader
|
||||
|
||||
|
||||
@ -19,9 +19,9 @@
|
||||
概述
|
||||
============
|
||||
|
||||
.. only:: esp32
|
||||
{IDF_TARGET_NAME} SoC 芯片支持以下功能：
|
||||
|
||||
ESP32 SoC 芯片支持以下功能：
|
||||
.. only:: esp32
|
||||
|
||||
* 2.4 GHz Wi-Fi
|
||||
* 蓝牙
|
||||
@ -31,8 +31,6 @@
|
||||
|
||||
.. only:: esp32s2
|
||||
|
||||
ESP32-S2 SoC 芯片支持以下功能：
|
||||
|
||||
* 2.4 GHz Wi-Fi
|
||||
* 高性能 Xtensa® 32 位 LX7 单核处理器
|
||||
* 运行 RISC-V 或 FSM 内核的超低功耗协处理器
|
||||
@ -42,8 +40,6 @@
|
||||
|
||||
.. only:: esp32c3
|
||||
|
||||
ESP32-C3 SoC 芯片支持以下功能：
|
||||
|
||||
* 2.4 GHz Wi-Fi
|
||||
* 低能耗蓝牙
|
||||
* 高性能 32 位 RISC-V 单核处理器
|
||||
@ -230,14 +226,14 @@ Windows 操作系统
|
||||
.. code-block:: batch
|
||||
|
||||
cd %userprofile%\esp\esp-idf
|
||||
install.bat
|
||||
install.bat {IDF_TARGET_PATH_NAME}
|
||||
|
||||
或使用 Windows PowerShell
|
||||
|
||||
.. code-block:: powershell
|
||||
|
||||
cd ~/esp/esp-idf
|
||||
./install.ps1
|
||||
./install.ps1 {IDF_TARGET_PATH_NAME}
|
||||
|
||||
Linux 和 macOS 操作系统
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
@ -245,7 +241,18 @@ Linux 和 macOS 操作系统
|
||||
.. code-block:: bash
|
||||
|
||||
cd ~/esp/esp-idf
|
||||
./install.sh
|
||||
./install.sh {IDF_TARGET_PATH_NAME}
|
||||
|
||||
或使用 Fish shell
|
||||
|
||||
.. code-block:: fish
|
||||
|
||||
cd ~/esp/esp-idf
|
||||
./install.fish {IDF_TARGET_PATH_NAME}
|
||||
|
||||
.. note::
|
||||
通过一次性指定多个目标，可为多个目标芯片同时安装工具，如运行 ``./install.sh esp32,esp32c3,esp32s3``。
|
||||
通过运行 ``./install.sh`` 或 ``./install.sh all`` 可一次性为所有支持的目标芯片安装工具。
|
||||
|
||||
下载工具备选方案
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
@ -372,8 +379,6 @@ ESP-IDF 的 :idf:`examples` 目录下有一系列示例工程，都可以按照
|
||||
|
||||
ESP-IDF 编译系统不支持带有空格的路径。
|
||||
|
||||
|
||||
|
||||
.. _get-started-connect:
|
||||
|
||||
第六步：连接设备
|
||||
@ -444,7 +449,6 @@ Windows 操作系统
|
||||
|
||||
.. _get-started-build:
|
||||
|
||||
|
||||
第八步：编译工程
|
||||
=========================
|
||||
|
||||
|
||||
@ -105,7 +105,6 @@
|
||||
|
||||
Python 2 已经 `结束生命周期 <https://www.python.org/doc/sunset-python-2/>`_，ESP-IDF 很快将不再支持 Python 2。请安装 Python 3.6 或以上版本。可参考上面列出的目前主流 Linux 发行版的安装说明。
|
||||
|
||||
|
||||
后续步骤
|
||||
==========
|
||||
|
||||
|
||||
@ -54,5 +54,4 @@ Python 2 已经 `结束生命周期 <https://www.python.org/doc/sunset-python-2/
|
||||
|
||||
继续设置开发环境，请前往 :ref:`get-started-get-esp-idf` 章节。
|
||||
|
||||
|
||||
.. _AUR: https://wiki.archlinux.org/index.php/Arch_User_Repository
|
||||
|
||||
@ -79,15 +79,12 @@ MacPorts 需要完整的 XCode 软件，而 Homebrew 只需要安装 XCode 命
|
||||
|
||||
编译得到的工具链会被保存到 ``~/esp/ctng-volume/crosstool-NG/builds/{IDF_TARGET_TOOLCHAIN_PREFIX}``。使用工具链前，请将 ``~/esp/ctng-volume/crosstool-NG/builds/{IDF_TARGET_TOOLCHAIN_PREFIX}/bin`` 添加至 ``PATH`` 环境变量。
|
||||
|
||||
|
||||
停用 Python 2
|
||||
====================
|
||||
|
||||
Python 2 已经 `结束生命周期 <https://www.python.org/doc/sunset-python-2/>`_，ESP-IDF 很快将不再支持 Python 2。请安装 Python 3.6 或以上版本。可参考上面列出的 macOS 安装说明。
|
||||
|
||||
|
||||
后续步骤
|
||||
==========
|
||||
|
||||
请前往 :ref:`get-started-get-esp-idf` 章节继续设置开发环境。
|
||||
|
||||
|
||||
@ -75,4 +75,3 @@ Python 2 已经 `结束生命周期 <https://www.python.org/doc/sunset-python-2/
|
||||
.. _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
|
||||
|
||||
|
||||
@ -24,5 +24,3 @@
|
||||
windows-setup-scratch
|
||||
linux-setup-scratch
|
||||
macos-setup-scratch
|
||||
|
||||
|
||||
|
||||
@ -6,7 +6,6 @@ VS Code IDE 快速入门
|
||||
|
||||
我们支持 VS code，并且致力于为所有与 ESP-IDF 相关的操作提供完善的端到端支持，包括构建、烧录、监控、调试、追踪、core-dump、以及系统追踪查看器等操作。
|
||||
|
||||
|
||||
快速安装指南
|
||||
===============
|
||||
|
||||
|
||||
@ -72,7 +72,6 @@ Python 安装完成后，从 Windows 开始菜单中打开“命令提示符”
|
||||
|
||||
pip install --user pyserial
|
||||
|
||||
|
||||
工具链设置
|
||||
===============
|
||||
|
||||
|
||||
@ -28,7 +28,6 @@ ESP-IDF 需要安装一些必备工具，才能围绕 {IDF_TARGET_NAME} 构建
|
||||
|
||||
.. _get-started-windows-tools-installer:
|
||||
|
||||
|
||||
ESP-IDF 工具安装器
|
||||
=======================
|
||||
|
||||
@ -119,7 +118,6 @@ ESP-IDF 工具安装器可在“开始”菜单中，创建一个打开 ESP-IDF
|
||||
|
||||
windows-setup-update
|
||||
|
||||
|
||||
.. _MSYS2: https://www.msys2.org/
|
||||
.. _CMake: https://cmake.org/download/
|
||||
.. _Ninja: https://ninja-build.org/
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user