mirror of
https://github.com/espressif/esp-idf.git
synced 2025-08-02 20:24:32 +02:00
docs: update CN translation and keep line number consistent for all documents in get-started section
This commit is contained in:
@@ -1,6 +1,7 @@
|
|||||||
********************************
|
********************************
|
||||||
Build and Flash with Eclipse IDE
|
Build and Flash with Eclipse IDE
|
||||||
********************************
|
********************************
|
||||||
|
|
||||||
:link_to_translation:`zh_CN:[中文]`
|
:link_to_translation:`zh_CN:[中文]`
|
||||||
|
|
||||||
ESP-IDF V4.0 has a new CMake-based build system as the default build system.
|
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.
|
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:
|
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>`_
|
* 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.
|
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
|
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
|
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:
|
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*
|
ls /dev/tty*
|
||||||
|
|
||||||
MacOS ::
|
macOS ::
|
||||||
|
|
||||||
ls /dev/cu.*
|
ls /dev/cu.*
|
||||||
|
|
||||||
.. note::
|
.. 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:
|
.. _linux-dialout-group:
|
||||||
|
|
||||||
|
@@ -6,9 +6,7 @@ Get Started
|
|||||||
|
|
||||||
.. Please keep README.md in sync with these instructions.
|
.. 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.
|
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.
|
||||||
|
|
||||||
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
|
.. include-build-file:: inc/version-note.inc
|
||||||
|
|
||||||
@@ -25,7 +23,6 @@ Introduction
|
|||||||
* Ultra Low Power co-processor
|
* Ultra Low Power co-processor
|
||||||
* Multiple peripherals
|
* Multiple peripherals
|
||||||
|
|
||||||
|
|
||||||
.. only:: esp32s2
|
.. only:: esp32s2
|
||||||
|
|
||||||
* Wi-Fi (2.4 GHz band)
|
* Wi-Fi (2.4 GHz band)
|
||||||
@@ -343,9 +340,7 @@ Windows
|
|||||||
cd %userprofile%\esp
|
cd %userprofile%\esp
|
||||||
xcopy /e /i %IDF_PATH%\examples\get-started\hello_world hello_world
|
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.
|
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.
|
||||||
|
|
||||||
It is also possible to build examples in-place, without copying them first.
|
|
||||||
|
|
||||||
.. important::
|
.. important::
|
||||||
|
|
||||||
@@ -417,8 +412,7 @@ You are using this menu to set up project specific variables, e.g. Wi-Fi network
|
|||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
|
|
||||||
The colors of the menu could be different in your terminal. You can change the appearance with the option
|
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.
|
||||||
``--style``. Please run ``idf.py menuconfig --help`` for further information.
|
|
||||||
|
|
||||||
.. _get-started-build:
|
.. _get-started-build:
|
||||||
|
|
||||||
|
@@ -77,9 +77,7 @@ Toolchain will be built in ``~/esp/crosstool-NG/builds/xtensa-{IDF_TARGET_TOOLCH
|
|||||||
Add Toolchain to PATH
|
Add Toolchain to PATH
|
||||||
=====================
|
=====================
|
||||||
|
|
||||||
The custom toolchain needs to be copied to a binary directory and added to the ``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.
|
||||||
|
|
||||||
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::
|
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
|
Fixing broken pip on Ubuntu 16.04
|
||||||
=================================
|
=================================
|
||||||
|
|
||||||
Package ``python3-pip`` could be broken without possibility to upgrade it.
|
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 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
|
apt remove python3-pip python3-virtualenv; rm -r ~/.local
|
||||||
rm -r ~/.espressif/python_env && python get-pip.py
|
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`.
|
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
|
.. _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:[中文]`
|
: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:[中文]`
|
:link_to_translation:`zh_CN:[中文]`
|
||||||
@@ -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.
|
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
|
Next Steps
|
||||||
==========
|
==========
|
||||||
|
|
||||||
|
@@ -24,4 +24,3 @@ In any case, here are the instructions to compile the toolchain yourself.
|
|||||||
windows-setup-scratch
|
windows-setup-scratch
|
||||||
linux-setup-scratch
|
linux-setup-scratch
|
||||||
macos-setup-scratch
|
macos-setup-scratch
|
||||||
|
|
||||||
|
@@ -2,6 +2,7 @@
|
|||||||
Getting Started with VS Code IDE
|
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.
|
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.
|
||||||
|
|
||||||
|
@@ -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
|
.. 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/
|
.. _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
|
||||||
|
|
||||||
|
@@ -16,6 +16,7 @@ For Powershell, change to the directory where ESP-IDF is installed. Then run::
|
|||||||
install.ps1
|
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.
|
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``.
|
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:
|
.. _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::
|
.. 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 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.
|
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.
|
||||||
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:
|
.. _get-started-windows-tools-installer:
|
||||||
|
|
||||||
|
@@ -40,7 +40,7 @@
|
|||||||
Windows 设备管理器中 ESP-WROVER-KIT 的两个 USB 串行端口
|
Windows 设备管理器中 ESP-WROVER-KIT 的两个 USB 串行端口
|
||||||
|
|
||||||
|
|
||||||
在 Linux 和 MacOS 上查看端口
|
在 Linux 和 macOS 上查看端口
|
||||||
-----------------------------
|
-----------------------------
|
||||||
|
|
||||||
查看 {IDF_TARGET_NAME} 开发板(或外部转串口适配器)的串口设备名称,请运行两次以下命令。首先,断开开发板或适配器,第一次运行命令;然后,连接开发板或适配器,第二次运行命令。其中,第二次运行命令后出现的端口即是 {IDF_TARGET_NAME} 对应的串口:
|
查看 {IDF_TARGET_NAME} 开发板(或外部转串口适配器)的串口设备名称,请运行两次以下命令。首先,断开开发板或适配器,第一次运行命令;然后,连接开发板或适配器,第二次运行命令。其中,第二次运行命令后出现的端口即是 {IDF_TARGET_NAME} 对应的串口:
|
||||||
@@ -49,13 +49,13 @@ Linux ::
|
|||||||
|
|
||||||
ls /dev/tty*
|
ls /dev/tty*
|
||||||
|
|
||||||
MacOS ::
|
macOS ::
|
||||||
|
|
||||||
ls /dev/cu.*
|
ls /dev/cu.*
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
|
|
||||||
对于 MacOS 用户:若你没有看到串口,请检查你是否已按照《入门指南》安装了适用于你特定开发板的 USB/串口驱动程序。对于 MacOS High Sierra (10.13) 的用户,你可能还需要手动允许驱动程序的加载,具体可打开 ``系统偏好设置`` -> ``安全和隐私`` -> ``通用``,检查是否有信息显示:“来自开发人员的系统软件...”,其中开发人员的名称为 Silicon Labs 或 FTDI。
|
对于 macOS 用户:若你没有看到串口,请检查你是否已按照《入门指南》安装了适用于你特定开发板的 USB/串口驱动程序。对于 macOS High Sierra (10.13) 的用户,你可能还需要手动允许驱动程序的加载,具体可打开 ``系统偏好设置`` -> ``安全和隐私`` -> ``通用``,检查是否有信息显示:“来自开发人员的系统软件...”,其中开发人员的名称为 Silicon Labs 或 FTDI。
|
||||||
|
|
||||||
.. _linux-dialout-group:
|
.. _linux-dialout-group:
|
||||||
|
|
||||||
@@ -132,6 +132,4 @@ MacOS ::
|
|||||||
|
|
||||||
如你在安装 {IDF_TARGET_NAME} 硬件开发的软件环境时,从 :ref:`get-started-connect` 跳转到了这里,请从 :ref:`get-started-configure` 继续阅读。
|
如你在安装 {IDF_TARGET_NAME} 硬件开发的软件环境时,从 :ref:`get-started-connect` 跳转到了这里,请从 :ref:`get-started-configure` 继续阅读。
|
||||||
|
|
||||||
|
|
||||||
.. _esptool 文档: https://github.com/espressif/esptool/wiki/ESP32-Boot-Mode-Selection#automatic-bootloader
|
.. _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
|
* 2.4 GHz Wi-Fi
|
||||||
* 蓝牙 4.2
|
* 蓝牙 4.2
|
||||||
@@ -25,8 +25,6 @@
|
|||||||
|
|
||||||
.. only:: esp32s2
|
.. only:: esp32s2
|
||||||
|
|
||||||
ESP32-S2 SoC 芯片支持以下功能:
|
|
||||||
|
|
||||||
* 2.4 GHz Wi-Fi
|
* 2.4 GHz Wi-Fi
|
||||||
* 高性能单核
|
* 高性能单核
|
||||||
* 运行 RISC-V 或 FSM 内核的超低功耗协处理器
|
* 运行 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>`__)
|
* `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>`__)
|
* `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
|
.. figure:: ../../_static/what-you-need.png
|
||||||
:align: center
|
:align: center
|
||||||
:alt: {IDF_TARGET_NAME} 应用程序开发
|
:alt: {IDF_TARGET_NAME} 应用程序开发
|
||||||
@@ -156,7 +153,6 @@
|
|||||||
|
|
||||||
.. _get-started-get-esp-idf:
|
.. _get-started-get-esp-idf:
|
||||||
|
|
||||||
|
|
||||||
第二步:获取 ESP-IDF
|
第二步:获取 ESP-IDF
|
||||||
=================================
|
=================================
|
||||||
|
|
||||||
@@ -205,14 +201,14 @@ Windows 操作系统
|
|||||||
.. code-block:: batch
|
.. code-block:: batch
|
||||||
|
|
||||||
cd %userprofile%\esp\esp-idf
|
cd %userprofile%\esp\esp-idf
|
||||||
install.bat
|
install.bat {IDF_TARGET_PATH_NAME}
|
||||||
|
|
||||||
或使用 Windows PowerShell
|
或使用 Windows PowerShell
|
||||||
|
|
||||||
.. code-block:: powershell
|
.. code-block:: powershell
|
||||||
|
|
||||||
cd ~/esp/esp-idf
|
cd ~/esp/esp-idf
|
||||||
./install.ps1
|
./install.ps1 {IDF_TARGET_PATH_NAME}
|
||||||
|
|
||||||
Linux 和 macOS 操作系统
|
Linux 和 macOS 操作系统
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
@@ -220,8 +216,18 @@ Linux 和 macOS 操作系统
|
|||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
cd ~/esp/esp-idf
|
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"
|
export IDF_GITHUB_ASSETS="dl.espressif.com/github_assets"
|
||||||
./install.sh
|
./install.sh
|
||||||
|
|
||||||
|
|
||||||
自定义工具安装路径
|
自定义工具安装路径
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
@@ -262,6 +267,7 @@ Linux 和 macOS 操作系统
|
|||||||
|
|
||||||
.. _get-started-set-up-env:
|
.. _get-started-set-up-env:
|
||||||
|
|
||||||
|
|
||||||
第四步:设置环境变量
|
第四步:设置环境变量
|
||||||
=======================================
|
=======================================
|
||||||
|
|
||||||
@@ -394,7 +400,7 @@ Windows 操作系统
|
|||||||
:alt: 工程配置 — 主窗口
|
:alt: 工程配置 — 主窗口
|
||||||
:figclass: align-center
|
:figclass: align-center
|
||||||
|
|
||||||
工程配置 — 主窗口
|
工程配置 — 主窗口
|
||||||
|
|
||||||
您可以通过此菜单设置项目的具体变量,包括 Wi-Fi 网络名称、密码和处理器速度等. ``hello_world`` 示例项目会以默认配置运行,因此可以跳过使用 ``menuconfig`` 进行项目配置这一步骤。
|
您可以通过此菜单设置项目的具体变量,包括 Wi-Fi 网络名称、密码和处理器速度等. ``hello_world`` 示例项目会以默认配置运行,因此可以跳过使用 ``menuconfig`` 进行项目配置这一步骤。
|
||||||
|
|
||||||
@@ -413,7 +419,9 @@ Windows 操作系统
|
|||||||
第八步:编译工程
|
第八步:编译工程
|
||||||
=========================
|
=========================
|
||||||
|
|
||||||
请使用以下命令,编译烧录工程:::
|
请使用以下命令,编译烧录工程:
|
||||||
|
|
||||||
|
.. code-block:: batch
|
||||||
|
|
||||||
idf.py build
|
idf.py build
|
||||||
|
|
||||||
@@ -449,7 +457,9 @@ 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``
|
.. code-block:: bash
|
||||||
|
|
||||||
|
idf.py -p PORT [-b BAUD] flash
|
||||||
|
|
||||||
请将 PORT 替换为 {IDF_TARGET_NAME} 开发板的串口名称,具体可见 :ref:`get-started-connect`。
|
请将 PORT 替换为 {IDF_TARGET_NAME} 开发板的串口名称,具体可见 :ref:`get-started-connect`。
|
||||||
|
|
||||||
@@ -642,6 +652,7 @@ Windows 操作系统
|
|||||||
|
|
||||||
在编译示例程序前请查看 README 文件中 ``Supported Targets`` 表格。如果表格中包含 {IDF_TARGET_NAME}, 或者不存在这个表格,那么即表示 {IDF_TARGET_NAME} 支持这个示例程序。
|
在编译示例程序前请查看 README 文件中 ``Supported Targets`` 表格。如果表格中包含 {IDF_TARGET_NAME}, 或者不存在这个表格,那么即表示 {IDF_TARGET_NAME} 支持这个示例程序。
|
||||||
|
|
||||||
|
|
||||||
更新 ESP-IDF
|
更新 ESP-IDF
|
||||||
================
|
================
|
||||||
|
|
||||||
|
@@ -74,7 +74,6 @@
|
|||||||
|
|
||||||
编译得到的工具链会被保存至 ``~/esp/crosstool-NG/builds/xtensa-{IDF_TARGET_TOOLCHAIN_NAME}-elf``。
|
编译得到的工具链会被保存至 ``~/esp/crosstool-NG/builds/xtensa-{IDF_TARGET_TOOLCHAIN_NAME}-elf``。
|
||||||
|
|
||||||
|
|
||||||
添加工具链到 PATH 环境变量
|
添加工具链到 PATH 环境变量
|
||||||
===========================
|
===========================
|
||||||
|
|
||||||
@@ -99,7 +98,6 @@
|
|||||||
|
|
||||||
注意这里的 ``/home/user-name`` 应该替换成您安装的主路径。
|
注意这里的 ``/home/user-name`` 应该替换成您安装的主路径。
|
||||||
|
|
||||||
|
|
||||||
停用 Python 2
|
停用 Python 2
|
||||||
====================
|
====================
|
||||||
|
|
||||||
|
@@ -47,12 +47,9 @@ Linux 平台工具链的标准设置
|
|||||||
|
|
||||||
Python 2 已经 `结束生命周期 <https://www.python.org/doc/sunset-python-2/>`_,ESP-IDF 很快将不再支持 Python 2。请安装 Python 3.6 或以上版本。可参考上面列出的目前主流 Linux 发行版的安装说明。
|
Python 2 已经 `结束生命周期 <https://www.python.org/doc/sunset-python-2/>`_,ESP-IDF 很快将不再支持 Python 2。请安装 Python 3.6 或以上版本。可参考上面列出的目前主流 Linux 发行版的安装说明。
|
||||||
|
|
||||||
|
|
||||||
后续步骤
|
后续步骤
|
||||||
==========
|
==========
|
||||||
|
|
||||||
继续设置开发环境,请前往 :ref:`get-started-get-esp-idf` 章节。
|
继续设置开发环境,请前往 :ref:`get-started-get-esp-idf` 章节。
|
||||||
|
|
||||||
|
|
||||||
.. _AUR: https://wiki.archlinux.org/index.php/Arch_User_Repository
|
.. _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`` 环境变量。
|
编译得到的工具链会被保存到 ``~/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 安装说明。
|
Python 2 已经 `结束生命周期 <https://www.python.org/doc/sunset-python-2/>`_,ESP-IDF 很快将不再支持 Python 2。请安装 Python 3.6 或以上版本。可参考上面列出的 macOS 安装说明。
|
||||||
|
|
||||||
|
|
||||||
后续步骤
|
后续步骤
|
||||||
==========
|
==========
|
||||||
|
|
||||||
继续设置开发环境,请前往 :ref:`get-started-get-esp-idf` 章节。
|
继续设置开发环境,请前往 :ref:`get-started-get-esp-idf` 章节。
|
||||||
|
|
||||||
|
@@ -7,7 +7,7 @@ MacOS 平台工具链的标准设置
|
|||||||
安装准备
|
安装准备
|
||||||
=====================
|
=====================
|
||||||
|
|
||||||
ESP-IDF 将使用 Mac OS 上默认安装的 Python 版本。
|
ESP-IDF 将使用 macOS 上默认安装的 Python 版本。
|
||||||
|
|
||||||
- 安装 pip::
|
- 安装 pip::
|
||||||
|
|
||||||
@@ -23,7 +23,7 @@ ESP-IDF 将使用 Mac OS 上默认安装的 Python 版本。
|
|||||||
|
|
||||||
sudo port install cmake ninja dfu-util
|
sudo port install cmake ninja dfu-util
|
||||||
|
|
||||||
- 若以上均不适用,请访问 CMake_ 和 Ninja_ 主页,查询有关 Mac OS 平台的下载安装问题。
|
- 若以上均不适用,请访问 CMake_ 和 Ninja_ 主页,查询有关 macOS 平台的下载安装问题。
|
||||||
|
|
||||||
- 强烈建议同时安装 ccache_ 以获得更快的编译速度。如有 HomeBrew_,可通过 MacPorts_ 上的 ``brew install ccache`` 或 ``sudo port install ccache`` 完成安装。
|
- 强烈建议同时安装 ccache_ 以获得更快的编译速度。如有 HomeBrew_,可通过 MacPorts_ 上的 ``brew install ccache`` 或 ``sudo port install ccache`` 完成安装。
|
||||||
|
|
||||||
|
@@ -24,5 +24,3 @@
|
|||||||
windows-setup-scratch
|
windows-setup-scratch
|
||||||
linux-setup-scratch
|
linux-setup-scratch
|
||||||
macos-setup-scratch
|
macos-setup-scratch
|
||||||
|
|
||||||
|
|
||||||
|
@@ -6,7 +6,6 @@ VS Code IDE 快速入门
|
|||||||
|
|
||||||
我们支持 VS Code,并且致力于为所有与 ESP-IDF 相关的操作提供完善的端到端支持,包括构建、烧录、监控、调试、追踪、core-dump、以及系统追踪查看器等操作。
|
我们支持 VS Code,并且致力于为所有与 ESP-IDF 相关的操作提供完善的端到端支持,包括构建、烧录、监控、调试、追踪、core-dump、以及系统追踪查看器等操作。
|
||||||
|
|
||||||
|
|
||||||
快速安装指南
|
快速安装指南
|
||||||
===============
|
===============
|
||||||
|
|
||||||
|
@@ -72,13 +72,6 @@ Python 安装完成后,从 Windows 开始菜单中打开“命令提示符”
|
|||||||
|
|
||||||
pip install --user pyserial
|
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
|
.. 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/
|
.. _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
|
||||||
|
|
||||||
|
@@ -16,6 +16,7 @@
|
|||||||
install.ps1
|
install.ps1
|
||||||
|
|
||||||
该命令可下载安装 ESP-IDF 所需的工具。如您已经安装了某个版本的工具,则该命令将无效。
|
该命令可下载安装 ESP-IDF 所需的工具。如您已经安装了某个版本的工具,则该命令将无效。
|
||||||
|
|
||||||
该工具的下载安装位置由 ESP-IDF 工具安装器的设置决定,默认情况下为: ``C:\Users\username\.espressif``。
|
该工具的下载安装位置由 ESP-IDF 工具安装器的设置决定,默认情况下为: ``C:\Users\username\.espressif``。
|
||||||
|
|
||||||
.. _get-started-export_bat-windows:
|
.. _get-started-export_bat-windows:
|
||||||
@@ -38,4 +39,3 @@ ESP-IDF 工具安装器将在“开始菜单”为 “ESP-IDF 命令提示符”
|
|||||||
export.ps1
|
export.ps1
|
||||||
|
|
||||||
运行完成后,您就可以通过命令提示符使用 ESP-IDF 工具了。
|
运行完成后,您就可以通过命令提示符使用 ESP-IDF 工具了。
|
||||||
|
|
||||||
|
@@ -28,7 +28,6 @@ ESP-IDF 需要安装一些必备工具,才能围绕 {IDF_TARGET_NAME} 构建
|
|||||||
|
|
||||||
.. _get-started-windows-tools-installer:
|
.. _get-started-windows-tools-installer:
|
||||||
|
|
||||||
|
|
||||||
ESP-IDF 工具安装器
|
ESP-IDF 工具安装器
|
||||||
=======================
|
=======================
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user