mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
docs: update CN translation and keep line number consistent for all documents in get-started section
This commit is contained in:
daiziyan
parent
61d5e5a93e
commit
65540b991e
@ -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
|
||||
---------------------
|
||||
|
||||
@ -42,7 +40,7 @@ Figures below show serial port for ESP32 DevKitC and ESP32 WROVER KIT
|
||||
Two USB Serial Ports of ESP-WROVER-KIT in Windows Device Manager
|
||||
|
||||
|
||||
Check port on Linux and MacOS
|
||||
Check port on Linux and macOS
|
||||
-----------------------------
|
||||
|
||||
To check the device name for the serial port of your {IDF_TARGET_NAME} board (or external converter dongle), run this command two times, first with the board / dongle unplugged, then with plugged in. The port which appears the second time is the one you need:
|
||||
@ -51,14 +49,13 @@ Linux ::
|
||||
|
||||
ls /dev/tty*
|
||||
|
||||
MacOS ::
|
||||
macOS ::
|
||||
|
||||
ls /dev/cu.*
|
||||
|
||||
.. note::
|
||||
|
||||
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.
|
||||
|
||||
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:
|
||||
|
||||
|
||||
@ -6,9 +6,7 @@ Get Started
|
||||
|
||||
.. 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
|
||||
|
||||
@ -25,7 +23,6 @@ Introduction
|
||||
* Ultra Low Power co-processor
|
||||
* Multiple peripherals
|
||||
|
||||
|
||||
.. only:: esp32s2
|
||||
|
||||
* Wi-Fi (2.4 GHz band)
|
||||
@ -343,9 +340,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::
|
||||
|
||||
@ -417,8 +412,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:
|
||||
|
||||
|
||||
@ -77,9 +77,7 @@ Toolchain will be built in ``~/esp/crosstool-NG/builds/xtensa-{IDF_TARGET_TOOLCH
|
||||
Add Toolchain to PATH
|
||||
=====================
|
||||
|
||||
The custom toolchain needs to be copied to a binary directory and added to the ``PATH``.
|
||||
|
||||
Choose a directory, for example ``~/esp/xtensa-{IDF_TARGET_TOOLCHAIN_NAME}-elf/``, and copy the build output to this directory.
|
||||
The custom toolchain needs to be copied to a binary directory and added to the ``PATH``. Choose a directory, for example ``~/esp/xtensa-{IDF_TARGET_TOOLCHAIN_NAME}-elf/``, and copy the build output to this directory.
|
||||
|
||||
To use it, you will need to update your ``PATH`` environment variable in ``~/.profile`` file. To make ``xtensa-{IDF_TARGET_TOOLCHAIN_NAME}-elf`` available for all terminal sessions, add the following line to your ``~/.profile`` file::
|
||||
|
||||
|
||||
@ -37,8 +37,7 @@ With some Linux distributions you may get the ``Failed to open port /dev/ttyUSB0
|
||||
Fixing broken pip on Ubuntu 16.04
|
||||
=================================
|
||||
|
||||
Package ``python3-pip`` could be broken without possibility to upgrade it.
|
||||
Package has to be removed and installed manually using script `get-pip.py <https://bootstrap.pypa.io/get-pip.py>`_.::
|
||||
Package ``python3-pip`` could be broken without possibility to upgrade it. Package has to be removed and installed manually using script `get-pip.py <https://bootstrap.pypa.io/get-pip.py>`_.::
|
||||
|
||||
apt remove python3-pip python3-virtualenv; rm -r ~/.local
|
||||
rm -r ~/.espressif/python_env && python get-pip.py
|
||||
@ -53,5 +52,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 @@
|
||||
***********************************************
|
||||
Setup Toolchain for Mac OS from Scratch
|
||||
Setup Toolchain for macOS from Scratch
|
||||
***********************************************
|
||||
|
||||
:link_to_translation:`zh_CN:[中文]`
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
**********************************************
|
||||
Standard Setup of Toolchain for Mac OS
|
||||
Standard Setup of Toolchain for macOS
|
||||
**********************************************
|
||||
|
||||
:link_to_translation:`zh_CN:[中文]`
|
||||
@ -45,7 +45,7 @@ If the output is like ``Python 2.7.17``, your default interpreter is Python 2.7.
|
||||
|
||||
python3 --version
|
||||
|
||||
If above command returns an error, it means Python 3 is not installed.
|
||||
If above command returns an error, it means Python 3 is not installed.
|
||||
|
||||
Below is an overview of steps to install Python 3.
|
||||
|
||||
@ -62,7 +62,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 macOS are listed above.
|
||||
|
||||
|
||||
Next Steps
|
||||
==========
|
||||
|
||||
|
||||
@ -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
|
||||
|
||||
|
||||
@ -2,6 +2,7 @@
|
||||
Getting Started with VS Code IDE
|
||||
********************************
|
||||
|
||||
:link_to_translation:`zh_CN:[中文]`
|
||||
|
||||
We have official support for VS Code and we aim to provide complete end to end support for all actions related to ESP-IDF namely build, flash, monitor, debug, tracing, core-dump, System Trace Viewer, etc.
|
||||
|
||||
@ -33,4 +34,4 @@ Bugs & Feature Requests
|
||||
|
||||
If you face an issue with certain feature of VS Code or VS Code in general we recommend to ask your question in the `forum <http://esp32.com/viewforum.php?f=40>`_, or open a `github issue <https://github.com/espressif/vscode-esp-idf-extension/issues/new/choose>`_ for our dev teams to review.
|
||||
|
||||
We also welcome new feature request, most of the features we have today is result of people asking it to implement, or improve certain aspect of the extension, `raise your feature request on github <http://github.com/espressif/vscode-esp-idf-extension/issues/new/choose>`_.
|
||||
We also welcome new feature request, most of the features we have today is result of people asking it to implement, or improve certain aspect of the extension, `raise your feature request on github <http://github.com/espressif/vscode-esp-idf-extension/issues/new/choose>`_.
|
||||
|
||||
@ -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
|
||||
|
||||
|
||||
@ -16,6 +16,7 @@ For Powershell, change to the directory where ESP-IDF is installed. Then run::
|
||||
install.ps1
|
||||
|
||||
This will download and install the tools necessary to use ESP-IDF. If the specific version of the tool is already installed, no action will be taken.
|
||||
|
||||
The tools are downloaded and installed into a directory specified during ESP-IDF Tools Installer process. By default, this is ``C:\Users\username\.espressif``.
|
||||
|
||||
.. _get-started-export_bat-windows:
|
||||
|
||||
@ -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:
|
||||
|
||||
@ -125,4 +124,4 @@ For advanced users who want to customize the install process:
|
||||
.. _Ninja: https://ninja-build.org/
|
||||
.. _Python: https://www.python.org/downloads/windows/
|
||||
.. _Git for Windows: https://gitforwindows.org/
|
||||
.. _Github Desktop: https://desktop.github.com/
|
||||
.. _Github Desktop: https://desktop.github.com/
|
||||
|
||||
@ -40,7 +40,7 @@
|
||||
Windows 设备管理器中 ESP-WROVER-KIT 的两个 USB 串行端口
|
||||
|
||||
|
||||
在 Linux 和 MacOS 上查看端口
|
||||
在 Linux 和 macOS 上查看端口
|
||||
-----------------------------
|
||||
|
||||
查看 {IDF_TARGET_NAME} 开发板（或外部转串口适配器）的串口设备名称，请运行两次以下命令。首先，断开开发板或适配器，第一次运行命令；然后，连接开发板或适配器，第二次运行命令。其中，第二次运行命令后出现的端口即是 {IDF_TARGET_NAME} 对应的串口：
|
||||
@ -49,13 +49,13 @@ Linux ::
|
||||
|
||||
ls /dev/tty*
|
||||
|
||||
MacOS ::
|
||||
macOS ::
|
||||
|
||||
ls /dev/cu.*
|
||||
|
||||
.. note::
|
||||
|
||||
对于 MacOS 用户：若你没有看到串口，请检查你是否已按照《入门指南》安装了适用于你特定开发板的 USB/串口驱动程序。对于 MacOS High Sierra (10.13) 的用户，你可能还需要手动允许驱动程序的加载，具体可打开 ``系统偏好设置`` -> ``安全和隐私`` -> ``通用``，检查是否有信息显示：“来自开发人员的系统软件...”，其中开发人员的名称为 Silicon Labs 或 FTDI。
|
||||
对于 macOS 用户：若你没有看到串口，请检查你是否已按照《入门指南》安装了适用于你特定开发板的 USB/串口驱动程序。对于 macOS High Sierra (10.13) 的用户，你可能还需要手动允许驱动程序的加载，具体可打开 ``系统偏好设置`` -> ``安全和隐私`` -> ``通用``，检查是否有信息显示：“来自开发人员的系统软件...”，其中开发人员的名称为 Silicon Labs 或 FTDI。
|
||||
|
||||
.. _linux-dialout-group:
|
||||
|
||||
@ -132,6 +132,4 @@ MacOS ::
|
||||
|
||||
如你在安装 {IDF_TARGET_NAME} 硬件开发的软件环境时，从 :ref:`get-started-connect` 跳转到了这里，请从 :ref:`get-started-configure` 继续阅读。
|
||||
|
||||
|
||||
.. _esptool 文档: https://github.com/espressif/esptool/wiki/ESP32-Boot-Mode-Selection#automatic-bootloader
|
||||
|
||||
|
||||
@ -13,9 +13,9 @@
|
||||
概述
|
||||
============
|
||||
|
||||
.. only:: esp32
|
||||
{IDF_TARGET_NAME} SoC 芯片支持以下功能：
|
||||
|
||||
ESP32 SoC 芯片支持以下功能：
|
||||
.. only:: esp32
|
||||
|
||||
* 2.4 GHz Wi-Fi
|
||||
* 蓝牙 4.2
|
||||
@ -25,8 +25,6 @@
|
||||
|
||||
.. only:: esp32s2
|
||||
|
||||
ESP32-S2 SoC 芯片支持以下功能：
|
||||
|
||||
* 2.4 GHz Wi-Fi
|
||||
* 高性能单核
|
||||
* 运行 RISC-V 或 FSM 内核的超低功耗协处理器
|
||||
@ -60,7 +58,6 @@
|
||||
* `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/tutorial/install.md>`__)
|
||||
|
||||
|
||||
.. figure:: ../../_static/what-you-need.png
|
||||
:align: center
|
||||
:alt: {IDF_TARGET_NAME} 应用程序开发
|
||||
@ -156,7 +153,6 @@
|
||||
|
||||
.. _get-started-get-esp-idf:
|
||||
|
||||
|
||||
第二步：获取 ESP-IDF
|
||||
=================================
|
||||
|
||||
@ -205,14 +201,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 操作系统
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
@ -220,8 +216,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`` 可一次性为所有支持的目标芯片安装工具。
|
||||
|
||||
下载工具备选方案
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
@ -252,7 +258,6 @@ Linux 和 macOS 操作系统
|
||||
export IDF_GITHUB_ASSETS="dl.espressif.com/github_assets"
|
||||
./install.sh
|
||||
|
||||
|
||||
自定义工具安装路径
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
@ -262,6 +267,7 @@ Linux 和 macOS 操作系统
|
||||
|
||||
.. _get-started-set-up-env:
|
||||
|
||||
|
||||
第四步：设置环境变量
|
||||
=======================================
|
||||
|
||||
@ -298,7 +304,7 @@ Linux 和 macOS 操作系统
|
||||
如果您需要经常运行 ESP-IDF，您可以为执行 ``export.sh`` 创建一个别名，具体步骤如下：
|
||||
|
||||
1. 复制并粘贴以下命令到 shell 配置文件中（``.profile``， ``.bashrc``， ``.zprofile`` 等）
|
||||
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
alias get_idf='. $HOME/esp/esp-idf/export.sh'
|
||||
@ -394,7 +400,7 @@ Windows 操作系统
|
||||
:alt: 工程配置 — 主窗口
|
||||
:figclass: align-center
|
||||
|
||||
工程配置 — 主窗口
|
||||
工程配置 — 主窗口
|
||||
|
||||
您可以通过此菜单设置项目的具体变量，包括 Wi-Fi 网络名称、密码和处理器速度等. ``hello_world`` 示例项目会以默认配置运行，因此可以跳过使用 ``menuconfig`` 进行项目配置这一步骤。
|
||||
|
||||
@ -413,7 +419,9 @@ Windows 操作系统
|
||||
第八步：编译工程
|
||||
=========================
|
||||
|
||||
请使用以下命令，编译烧录工程：::
|
||||
请使用以下命令，编译烧录工程：
|
||||
|
||||
.. code-block:: batch
|
||||
|
||||
idf.py build
|
||||
|
||||
@ -449,7 +457,9 @@ Windows 操作系统
|
||||
|
||||
请使用以下命令，将刚刚生成的二进制文件烧录（bootloader.bin, partition-table.bin 和 hello-world.bin）至您的 {IDF_TARGET_NAME} 开发板：
|
||||
|
||||
``idf.py -p PORT [-b BAUD] flash``
|
||||
.. code-block:: bash
|
||||
|
||||
idf.py -p PORT [-b BAUD] flash
|
||||
|
||||
请将 PORT 替换为 {IDF_TARGET_NAME} 开发板的串口名称，具体可见 :ref:`get-started-connect`。
|
||||
|
||||
@ -642,6 +652,7 @@ Windows 操作系统
|
||||
|
||||
在编译示例程序前请查看 README 文件中 ``Supported Targets`` 表格。如果表格中包含 {IDF_TARGET_NAME}， 或者不存在这个表格，那么即表示 {IDF_TARGET_NAME} 支持这个示例程序。
|
||||
|
||||
|
||||
更新 ESP-IDF
|
||||
================
|
||||
|
||||
@ -667,4 +678,4 @@ Windows 操作系统
|
||||
:esp32: ../get-started-legacy/index
|
||||
|
||||
.. _Stable version: https://docs.espressif.com/projects/esp-idf/zh_CN/stable/
|
||||
.. _Releases page: https://github.com/espressif/esp-idf/releases
|
||||
.. _Releases page: https://github.com/espressif/esp-idf/releases
|
||||
|
||||
@ -64,7 +64,7 @@
|
||||
|
||||
.. include-build-file:: inc/scratch-build-code.inc
|
||||
|
||||
.. 注解:: 在设置支持 64 位 time_t 的工具链时，您需要将 ``crosstool-NG/samples/xtensa-esp32-elf/crosstool.config`` 文件中第 33 和 43 行的可选参数 ``--enable-newlib-long-time_t`` 删除。
|
||||
.. 注解:: 在设置支持 64 位 time_t 的工具链时，您需要将 ``crosstool-NG/samples/xtensa-esp32-elf/crosstool.config`` 文件中第 33 和 43 行的可选参数 ``--enable-newlib-long-time_t`` 删除。
|
||||
|
||||
编译工具链::
|
||||
|
||||
@ -74,7 +74,6 @@
|
||||
|
||||
编译得到的工具链会被保存至 ``~/esp/crosstool-NG/builds/xtensa-{IDF_TARGET_TOOLCHAIN_NAME}-elf``。
|
||||
|
||||
|
||||
添加工具链到 PATH 环境变量
|
||||
===========================
|
||||
|
||||
@ -85,7 +84,7 @@
|
||||
export PATH="$HOME/esp/xtensa-{IDF_TARGET_TOOLCHAIN_NAME}-elf/bin:$PATH"
|
||||
|
||||
.. 注解::
|
||||
|
||||
|
||||
如果您已将 ``/bin/bash`` 设置为登录 shell，且同时存在 ``.bash_profile`` 和 ``.profile`` 两个文件，则请更新 ``.bash_profile``。在 CentOS 环境下, ``alias`` 需要添加到 ``.bashrc`` 文件中。
|
||||
|
||||
退出并重新登录以使 ``.profile`` 的更改生效。运行以下命令来检查 ``PATH`` 设置是否正确::
|
||||
@ -99,8 +98,7 @@
|
||||
|
||||
注意这里的 ``/home/user-name`` 应该替换成您安装的主路径。
|
||||
|
||||
|
||||
停用 Python 2
|
||||
停用 Python 2
|
||||
====================
|
||||
|
||||
Python 2 已经 `结束生命周期 <https://www.python.org/doc/sunset-python-2/>`_，ESP-IDF 很快将不再支持 Python 2。请安装 Python 3.6 或以上版本。可参考上面列出的目前主流 Linux 发行版的安装说明。
|
||||
@ -109,4 +107,4 @@ Python 2 已经 `结束生命周期 <https://www.python.org/doc/sunset-python-2/
|
||||
后续步骤
|
||||
==========
|
||||
|
||||
继续设置开发环境，请前往 :ref:`get-started-get-esp-idf` 章节。
|
||||
继续设置开发环境，请前往 :ref:`get-started-get-esp-idf` 章节。
|
||||
|
||||
@ -34,7 +34,7 @@ Linux 平台工具链的标准设置
|
||||
|
||||
使用某些 Linux 版本向 {IDF_TARGET_NAME} 烧录固件时，可能会出现 ``Failed to open port /dev/ttyUSB0`` 错误消息。此时可以将用户添加至 :ref:`Linux Dialout 组<linux-dialout-group>`。
|
||||
|
||||
修复 Ubuntu 16.04 损坏的 pip
|
||||
修复 Ubuntu 16.04 损坏的 pip
|
||||
=================================
|
||||
|
||||
``python3-pip`` 包可能已损坏无法升级。需使用脚本 `get-pip.py <https://bootstrap.pypa.io/get-pip.py>`_ 手动删除并安装该包::
|
||||
@ -42,17 +42,14 @@ Linux 平台工具链的标准设置
|
||||
apt remove python3-pip python3-virtualenv; rm -r ~/.local
|
||||
rm -r ~/.espressif/python_env && python get-pip.py
|
||||
|
||||
停用 Python 2
|
||||
停用 Python 2
|
||||
====================
|
||||
|
||||
Python 2 已经 `结束生命周期 <https://www.python.org/doc/sunset-python-2/>`_，ESP-IDF 很快将不再支持 Python 2。请安装 Python 3.6 或以上版本。可参考上面列出的目前主流 Linux 发行版的安装说明。
|
||||
|
||||
|
||||
后续步骤
|
||||
==========
|
||||
|
||||
继续设置开发环境，请前往 :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/xtensa-{IDF_TARGET_TOOLCHAIN_NAME}-elf``。使用工具链前，请将 ``~/esp/ctng-volume/crosstool-NG/builds/xtensa-{IDF_TARGET_TOOLCHAIN_NAME}-elf/bin`` 添加至 ``PATH`` 环境变量。
|
||||
|
||||
|
||||
停用 Python 2
|
||||
停用 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` 章节。
|
||||
|
||||
|
||||
@ -7,7 +7,7 @@ MacOS 平台工具链的标准设置
|
||||
安装准备
|
||||
=====================
|
||||
|
||||
ESP-IDF 将使用 Mac OS 上默认安装的 Python 版本。
|
||||
ESP-IDF 将使用 macOS 上默认安装的 Python 版本。
|
||||
|
||||
- 安装 pip::
|
||||
|
||||
@ -23,11 +23,11 @@ ESP-IDF 将使用 Mac OS 上默认安装的 Python 版本。
|
||||
|
||||
sudo port install cmake ninja dfu-util
|
||||
|
||||
- 若以上均不适用，请访问 CMake_ 和 Ninja_ 主页，查询有关 Mac OS 平台的下载安装问题。
|
||||
- 若以上均不适用，请访问 CMake_ 和 Ninja_ 主页，查询有关 macOS 平台的下载安装问题。
|
||||
|
||||
- 强烈建议同时安装 ccache_ 以获得更快的编译速度。如有 HomeBrew_，可通过 MacPorts_ 上的 ``brew install ccache`` 或 ``sudo port install ccache`` 完成安装。
|
||||
|
||||
.. note::
|
||||
.. note::
|
||||
如您在上述任何步骤中遇到以下错误::
|
||||
|
||||
``xcrun: error: invalid active developer path (/Library/Developer/CommandLineTools), missing xcrun at:/Library/Developer/CommandLineTools/usr/bin/xcrun``
|
||||
@ -57,7 +57,7 @@ ESP-IDF 将使用 Mac OS 上默认安装的 Python 版本。
|
||||
|
||||
sudo port install python38
|
||||
|
||||
停用 Python 2
|
||||
停用 Python 2
|
||||
====================
|
||||
|
||||
Python 2 已经 `结束生命周期 <https://www.python.org/doc/sunset-python-2/>`_，ESP-IDF 很快将不再支持 Python 2。请安装 Python 3.6 或以上版本。可参考上面列出的 macOS 安装说明。
|
||||
|
||||
@ -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、以及系统追踪查看器等操作。
|
||||
|
||||
|
||||
快速安装指南
|
||||
===============
|
||||
|
||||
@ -35,4 +34,4 @@ 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>`__ 上提出功能请求。
|
||||
我们也欢迎您提出新的功能需求，正是由于用户要求新功能或是建议对现有功能进行改善，才成就我们今天所具备的大多数功能。欢迎您在 `github <http://github.com/espressif/vscode-esp-idf-extension/issues/new/choose>`__ 上提出功能请求。
|
||||
|
||||
@ -72,13 +72,6 @@ Python 安装完成后，从 Windows 开始菜单中打开“命令提示符”
|
||||
|
||||
pip install --user pyserial
|
||||
|
||||
适用于 IDF 的 MConf
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
从 `kconfig-frontends releases page`_ 下载配置工具 mconf-idf。此为 ``mconf`` 配置工具，可针对 ESP-IDF 进行少量自定义操作。
|
||||
|
||||
请将此工具解压到目录，并 :ref:`添加到您的路径 <add-directory-windows-path>`。
|
||||
|
||||
工具链设置
|
||||
===============
|
||||
|
||||
@ -122,4 +115,3 @@ Python 安装完成后，从 Windows 开始菜单中打开“命令提示符”
|
||||
.. 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/zh_CN/stable/
|
||||
.. _Releases page: https://github.com/espressif/esp-idf/releases
|
||||
|
||||
|
||||
@ -16,6 +16,7 @@
|
||||
install.ps1
|
||||
|
||||
该命令可下载安装 ESP-IDF 所需的工具。如您已经安装了某个版本的工具，则该命令将无效。
|
||||
|
||||
该工具的下载安装位置由 ESP-IDF 工具安装器的设置决定，默认情况下为： ``C:\Users\username\.espressif``。
|
||||
|
||||
.. _get-started-export_bat-windows:
|
||||
@ -38,4 +39,3 @@ ESP-IDF 工具安装器将在“开始菜单”为 “ESP-IDF 命令提示符”
|
||||
export.ps1
|
||||
|
||||
运行完成后，您就可以通过命令提示符使用 ESP-IDF 工具了。
|
||||
|
||||
|
||||
@ -28,7 +28,6 @@ ESP-IDF 需要安装一些必备工具，才能围绕 {IDF_TARGET_NAME} 构建
|
||||
|
||||
.. _get-started-windows-tools-installer:
|
||||
|
||||
|
||||
ESP-IDF 工具安装器
|
||||
=======================
|
||||
|
||||
@ -125,4 +124,4 @@ ESP-IDF 工具安装器可在“开始”菜单中，创建一个打开 ESP-IDF
|
||||
.. _Ninja: https://ninja-build.org/
|
||||
.. _Python: https://www.python.org/downloads/windows/
|
||||
.. _Git for Windows: https://gitforwindows.org/
|
||||
.. _Github Desktop: https://desktop.github.com/
|
||||
.. _Github Desktop: https://desktop.github.com/
|
||||
|
||||
Loading…
Reference in New Issue
Block a user