mirror of
https://github.com/espressif/esp-idf.git
synced 2026-05-05 12:25:03 +02:00
docs: update all documents in get started section and keep line number consistent
This commit is contained in:
daiziyan
@@ -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
|
||||
---------------------
|
||||
|
||||
@@ -134,6 +132,7 @@ To spare you the trouble of installing a serial terminal program, macOS offers t
|
||||
|
||||
Do not forget to **exit the screen session** after verifying that the communication is working. If you fail to do it and just close the terminal window, the serial port will be inaccessible for uploading firmware later.
|
||||
|
||||
|
||||
Example Output
|
||||
^^^^^^^^^^^^^^
|
||||
|
||||
@@ -170,4 +169,4 @@ If you can see readable log output, it means serial connection is working and yo
|
||||
|
||||
If you got here from :ref:`get-started-connect` when installing s/w for {IDF_TARGET_NAME} development, then you can continue with :ref:`get-started-configure`.
|
||||
|
||||
.. _esptool documentation: https://github.com/espressif/esptool/wiki/ESP32-Boot-Mode-Selection#automatic-bootloader
|
||||
.. _esptool documentation: https://github.com/espressif/esptool/wiki/ESP32-Boot-Mode-Selection#automatic-bootloader
|
||||
@@ -13,9 +13,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
|
||||
|
||||
@@ -32,7 +30,6 @@ Introduction
|
||||
* Ultra Low Power co-processor
|
||||
* Multiple peripherals
|
||||
|
||||
|
||||
.. only:: esp32s2
|
||||
|
||||
* Wi-Fi (2.4 GHz band)
|
||||
@@ -141,7 +138,6 @@ If you have one of {IDF_TARGET_NAME} development boards listed below, you can cl
|
||||
ESP32-S3-DevKitC-1 <../hw-reference/esp32s3/user-guide-devkitc-1>
|
||||
|
||||
|
||||
|
||||
.. _get-started-step-by-step:
|
||||
|
||||
Installation Step by Step
|
||||
@@ -399,9 +395,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::
|
||||
|
||||
@@ -473,8 +467,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/{IDF_TARGET_TOOLCHAIN_PRE
|
||||
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/{IDF_TARGET_TOOLCHAIN_PREFIX}/``, 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/{IDF_TARGET_TOOLCHAIN_PREFIX}/``, 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 ``{IDF_TARGET_TOOLCHAIN_PREFIX}`` available for all terminal sessions, add the following line to your ``~/.profile`` file::
|
||||
|
||||
|
||||
@@ -38,10 +38,7 @@ With some Linux distributions you may get the ``Failed to open port /dev/ttyUSB0
|
||||
Python compatibility
|
||||
====================
|
||||
|
||||
ESP-IDF supports Python 3.6 or newer. It is recommended to upgrade your operating system to a recent version
|
||||
satisfying this requirement. Other options include the installation of Python from
|
||||
`sources <https://www.python.org/downloads/>`_ or the use of a Python version management system such as
|
||||
`pyenv <https://github.com/pyenv/pyenv>`_.
|
||||
ESP-IDF supports Python 3.6 or newer. It is recommended to upgrade your operating system to a recent version satisfying this requirement. Other options include the installation of Python from `sources <https://www.python.org/downloads/>`_ or the use of a Python version management system such as `pyenv <https://github.com/pyenv/pyenv>`_.
|
||||
|
||||
Next Steps
|
||||
==========
|
||||
|
||||
@@ -40,7 +40,7 @@ Install Prerequisites
|
||||
Compile the Toolchain from Source
|
||||
=================================
|
||||
|
||||
- Install dependencies:
|
||||
Install dependencies:
|
||||
|
||||
- with MacPorts::
|
||||
|
||||
@@ -82,4 +82,4 @@ Toolchain will be built in ``~/esp/ctng-volume/crosstool-NG/builds/{IDF_TARGET_T
|
||||
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`.
|
||||
@@ -57,13 +57,11 @@ Below is an overview of steps to install Python 3.
|
||||
|
||||
sudo port install python38
|
||||
|
||||
|
||||
Next Steps
|
||||
==========
|
||||
|
||||
To carry on with development environment setup, proceed to :ref:`get-started-get-esp-idf`.
|
||||
|
||||
|
||||
.. _cmake: https://cmake.org/
|
||||
.. _ninja: https://ninja-build.org/
|
||||
.. _ccache: https://ccache.samba.org/
|
||||
|
||||
@@ -23,5 +23,4 @@ In any case, here are the instructions to compile the toolchain yourself.
|
||||
|
||||
windows-setup-scratch
|
||||
linux-setup-scratch
|
||||
macos-setup-scratch
|
||||
|
||||
macos-setup-scratch
|
||||
@@ -28,7 +28,6 @@ Supported Features
|
||||
* `Rainmaker Cloud <https://rainmaker.espressif.com/>`_, we have inbuilt Rainmaker Cloud support where you can edit/read state of your connected IoT devices easily.
|
||||
* **Code Coverage**, we have inbuilt code coverage support which shall highlight in color which line have been covered. We also render the existing HTML report directly inside the IDE.
|
||||
|
||||
|
||||
Bugs & Feature Requests
|
||||
=======================
|
||||
|
||||
|
||||
@@ -114,5 +114,4 @@ To carry on with development environment setup, proceed to :ref:`get-started-set
|
||||
.. _kconfig-frontends releases page: https://github.com/espressif/kconfig-frontends/releases
|
||||
.. 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
|
||||
|
||||
.. _Releases page: https://github.com/espressif/esp-idf/releases
|
||||
@@ -17,8 +17,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``.
|
||||
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:
|
||||
|
||||
@@ -39,4 +38,4 @@ Alternatively in the Powershell where you need to use ESP-IDF, change to the dir
|
||||
cd ~/esp/esp-idf
|
||||
export.ps1
|
||||
|
||||
When this is done, the tools will be available in this command prompt.
|
||||
When this is done, the tools will be available in this command prompt.
|
||||
@@ -22,11 +22,11 @@ For this Getting Started we're going to use the Command Prompt, but after ESP-ID
|
||||
Previous versions of ESP-IDF used the :doc:`Legacy GNU Make Build System<../get-started-legacy/windows-setup>` and MSYS2_ Unix compatibility environment. This is no longer required, ESP-IDF can be used from the Windows Command Prompt.
|
||||
|
||||
.. note::
|
||||
Limitation: the installation path of ESP-IDF and ESP-IDF Tools must not be longer than 90 characters. Too long installation paths might result in a failed build.
|
||||
|
||||
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.
|
||||
Limitations:
|
||||
- The installation path of ESP-IDF and ESP-IDF Tools must not be longer than 90 characters. Too long installation paths might result in a failed build.
|
||||
- The installation path of Python or ESP-IDF must not contain white spaces or parentheses.
|
||||
- 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:
|
||||
|
||||
Reference in New Issue
Block a user