mirror of
https://github.com/espressif/esp-idf.git
synced 2025-08-06 14:14:33 +02:00
docs: Review get started docs
This commit is contained in:
mofeifei
Djordje Nedic
@@ -1,15 +1,15 @@
|
||||
Now you have all requirements met, the next topic will guide you on how to start your first project.
|
||||
Now since all requirements are met, the next topic will guide you on how to start your first project.
|
||||
|
||||
This guide will help you on the first steps using ESP-IDF. Follow this guide to start a new project on the {IDF_TARGET_NAME} and build, flash, and monitor the device output.
|
||||
|
||||
.. note::
|
||||
|
||||
If you haven't yet installed the ESP-IDF, please go to :ref:`get-started-step-by-step` and follow the instruction in oder to get all the software needed to use this guide.
|
||||
If you have not yet installed ESP-IDF, please go to :ref:`get-started-step-by-step` and follow the instruction in order to get all the software needed to use this guide.
|
||||
|
||||
Start a Project
|
||||
===================
|
||||
|
||||
Now you are ready to prepare your application for {IDF_TARGET_NAME}. You can start with :example:`get-started/hello_world` project from :idf:`examples` directory in IDF.
|
||||
Now you are ready to prepare your application for {IDF_TARGET_NAME}. You can start with :example:`get-started/hello_world` project from :idf:`examples` directory in ESP-IDF.
|
||||
|
||||
.. important::
|
||||
|
||||
@@ -22,14 +22,14 @@ Copy the project :example:`get-started/hello_world` to ``~/esp`` directory:
|
||||
cd ~/esp
|
||||
cp -r $IDF_PATH/examples/get-started/hello_world .
|
||||
|
||||
.. note:: 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.
|
||||
.. note:: 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.
|
||||
|
||||
Connect Your Device
|
||||
===================
|
||||
|
||||
Now connect your {IDF_TARGET_NAME} board to the computer and check under what serial port the board is visible.
|
||||
Now connect your {IDF_TARGET_NAME} board to the computer and check under which serial port the board is visible.
|
||||
|
||||
Serial ports have the following patterns in their names:
|
||||
Serial ports have the following naming patterns:
|
||||
|
||||
- **Linux**: starting with ``/dev/tty``
|
||||
- **macOS**: starting with ``/dev/cu.``
|
||||
@@ -40,10 +40,10 @@ If you are not sure how to check the serial port name, please refer to :doc:`est
|
||||
|
||||
Keep the port name handy as you will need it in the next steps.
|
||||
|
||||
Configure your Project
|
||||
Configure Your Project
|
||||
======================
|
||||
|
||||
Navigate to your ``hello_world`` directory, set {IDF_TARGET_NAME} chip as the target and run the project configuration utility ``menuconfig``.
|
||||
Navigate to your ``hello_world`` directory, set {IDF_TARGET_NAME} as the target, and run the project configuration utility ``menuconfig``.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
@@ -51,24 +51,23 @@ Navigate to your ``hello_world`` directory, set {IDF_TARGET_NAME} chip as the ta
|
||||
idf.py set-target {IDF_TARGET_PATH_NAME}
|
||||
idf.py menuconfig
|
||||
|
||||
Setting the target with ``idf.py set-target {IDF_TARGET_PATH_NAME}`` should be done once after opening a new project. If the project contains some existing builds and configurations, they will be cleared and initialized. The target may be saved in the environment variable to skip this step at all. See :ref:`selecting-idf-target` for additional information.
|
||||
After opening a new project, you should first set the target with ``idf.py set-target {IDF_TARGET_PATH_NAME}``. Note that existing builds and configurations in the project, if any, will be cleared and initialized in this process. The target may be saved in the environment variable to skip this step at all. See :ref:`selecting-idf-target` for additional information.
|
||||
|
||||
If the previous steps have been done correctly, the following menu appears:
|
||||
|
||||
.. figure:: ../../_static/project-configuration.png
|
||||
:align: center
|
||||
:alt: Project configuration - Home window
|
||||
:figclass: align-center
|
||||
|
||||
Project configuration - Home window
|
||||
|
||||
You are using this menu to set up project specific variables, e.g. Wi-Fi network name and password, the processor speed, etc. Setting up the project with menuconfig may be skipped for "hello_word". This example will run with default configuration.
|
||||
You are using this menu to set up project specific variables, e.g., Wi-Fi network name and password, the processor speed, etc. Setting up the project with menuconfig may be skipped for "hello_word", since this example runs with default configuration.
|
||||
|
||||
.. only:: esp32
|
||||
|
||||
.. attention::
|
||||
|
||||
If you use ESP32-DevKitC board with the **ESP32-SOLO-1** module, or ESP32-DevKitM-1 board with the **ESP32-MIN1-1(1U)** module, enable single core mode (:ref:`CONFIG_FREERTOS_UNICORE`) in menuconfig before flashing examples.
|
||||
If you use ESP32-DevKitC board with the **ESP32-SOLO-1** module, or ESP32-DevKitM-1 board with the **ESP32-MIN1-1(1U)** module, please enable single core mode (:ref:`CONFIG_FREERTOS_UNICORE`) in menuconfig before flashing examples.
|
||||
|
||||
.. note::
|
||||
|
||||
|
||||
@@ -1,15 +1,15 @@
|
||||
Now you have all requirements met, the next topic will guide you on how to start your first project.
|
||||
Now since all requirements are met, the next topic will guide you on how to start your first project.
|
||||
|
||||
This guide will help you on the first steps using ESP-IDF. Follow this guide to start a new project on the {IDF_TARGET_NAME} and build, flash, and monitor the device output.
|
||||
|
||||
.. note::
|
||||
|
||||
If you haven't yet installed the ESP-IDF, please go to :ref:`get-started-step-by-step` and follow the instruction in oder to get all the software needed to use this guide.
|
||||
If you have not yet installed ESP-IDF, please go to :ref:`get-started-step-by-step` and follow the instruction in order to get all the software needed to use this guide.
|
||||
|
||||
Start a Project
|
||||
===================
|
||||
|
||||
Now you are ready to prepare your application for {IDF_TARGET_NAME}. You can start with :example:`get-started/hello_world` project from :idf:`examples` directory in IDF.
|
||||
Now you are ready to prepare your application for {IDF_TARGET_NAME}. You can start with :example:`get-started/hello_world` project from :idf:`examples` directory in ESP-IDF.
|
||||
|
||||
.. important::
|
||||
|
||||
@@ -22,14 +22,14 @@ Copy the project :example:`get-started/hello_world` to ``~/esp`` directory:
|
||||
cd %userprofile%\esp
|
||||
xcopy /e /i %IDF_PATH%\examples\get-started\hello_world hello_world
|
||||
|
||||
.. note:: 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.
|
||||
.. note:: 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.
|
||||
|
||||
Connect Your Device
|
||||
===================
|
||||
|
||||
Now connect your {IDF_TARGET_NAME} board to the computer and check under what serial port the board is visible.
|
||||
Now connect your {IDF_TARGET_NAME} board to the computer and check under which serial port the board is visible.
|
||||
|
||||
Serial ports start with COM in Windows.
|
||||
Serial port names start with ``COM`` in Windows.
|
||||
|
||||
If you are not sure how to check the serial port name, please refer to :doc:`establish-serial-connection` for full details.
|
||||
|
||||
@@ -37,10 +37,10 @@ If you are not sure how to check the serial port name, please refer to :doc:`est
|
||||
|
||||
Keep the port name handy as you will need it in the next steps.
|
||||
|
||||
Configure your Project
|
||||
Configure Your Project
|
||||
======================
|
||||
|
||||
Navigate to your ``hello_world`` directory, set {IDF_TARGET_NAME} chip as the target and run the project configuration utility ``menuconfig``.
|
||||
Navigate to your ``hello_world`` directory, set {IDF_TARGET_NAME} as the target, and run the project configuration utility ``menuconfig``.
|
||||
|
||||
Windows
|
||||
~~~~~~~
|
||||
@@ -51,24 +51,23 @@ Windows
|
||||
idf.py set-target {IDF_TARGET_PATH_NAME}
|
||||
idf.py menuconfig
|
||||
|
||||
Setting the target with ``idf.py set-target {IDF_TARGET_PATH_NAME}`` should be done once after opening a new project. If the project contains some existing builds and configurations, they will be cleared and initialized. The target may be saved in the environment variable to skip this step at all. See :ref:`selecting-idf-target` for additional information.
|
||||
After opening a new project, you should first set the target with ``idf.py set-target {IDF_TARGET_PATH_NAME}``. Note that existing builds and configurations in the project, if any, will be cleared and initialized in this process. The target may be saved in the environment variable to skip this step at all. See :ref:`selecting-idf-target` for additional information.
|
||||
|
||||
If the previous steps have been done correctly, the following menu appears:
|
||||
|
||||
.. figure:: ../../_static/project-configuration.png
|
||||
:align: center
|
||||
:alt: Project configuration - Home window
|
||||
:figclass: align-center
|
||||
|
||||
Project configuration - Home window
|
||||
|
||||
You are using this menu to set up project specific variables, e.g. Wi-Fi network name and password, the processor speed, etc. Setting up the project with menuconfig may be skipped for "hello_word". This example will run with default configuration.
|
||||
You are using this menu to set up project specific variables, e.g., Wi-Fi network name and password, the processor speed, etc. Setting up the project with menuconfig may be skipped for "hello_word", since this example runs with default configuration.
|
||||
|
||||
.. only:: esp32
|
||||
|
||||
.. attention::
|
||||
|
||||
If you use ESP32-DevKitC board with the **ESP32-SOLO-1** module, or ESP32-DevKitM-1 board with the **ESP32-MIN1-1(1U)** module, enable single core mode (:ref:`CONFIG_FREERTOS_UNICORE`) in menuconfig before flashing examples.
|
||||
If you use ESP32-DevKitC board with the **ESP32-SOLO-1** module, or ESP32-DevKitM-1 board with the **ESP32-MIN1-1(1U)** module, please enable single core mode (:ref:`CONFIG_FREERTOS_UNICORE`) in menuconfig before flashing examples.
|
||||
|
||||
.. note::
|
||||
|
||||
|
||||
@@ -1,15 +1,15 @@
|
||||
现在您已经具备了使用 ESP-IDF 的所有条件，接下来将介绍如何开始您的第一个工程。
|
||||
|
||||
本指南将帮助您完成使用 ESP-IDF 的第一步。按照本指南，您将能使用 {IDF_TARGET_NAME} 开始创建第一个工程，并构建、烧录和监控设备输出。
|
||||
本指南将帮助您完成使用 ESP-IDF 的第一步。按照本指南，您将使用 {IDF_TARGET_NAME} 创建第一个工程，并构建、烧录和监控设备输出。
|
||||
|
||||
.. note::
|
||||
|
||||
如果您还没有安装 ESP-IDF，请前往 :ref:`get-started-step-by-step` 并按照说明操作，以获得使用本指南所需的所有软件。
|
||||
如果您还未安装 ESP-IDF，请参照 :ref:`get-started-step-by-step` 中的步骤，获取使用本指南所需的所有软件。
|
||||
|
||||
开始创建工程
|
||||
================
|
||||
|
||||
现在，您可以开始准备开发 {IDF_TARGET_NAME} 应用程序了。您可以从 ESP-IDF 中 :idf:`examples` 目录下的 :example:`get-started/hello_world` 工程开始。
|
||||
现在，您可以准备开发 {IDF_TARGET_NAME} 应用程序了。您可以从 ESP-IDF 中 :idf:`examples` 目录下的 :example:`get-started/hello_world` 工程开始。
|
||||
|
||||
.. important::
|
||||
|
||||
@@ -31,8 +31,8 @@
|
||||
|
||||
通常，串口在不同操作系统下显示的名称有所不同：
|
||||
|
||||
- **Linux 操作系统：** 以 ``/dev/tty`` 开始
|
||||
- **macOS 操作系统：** 以 ``/dev/cu.`` 开始
|
||||
- **Linux 操作系统：** 以 ``/dev/tty`` 开头
|
||||
- **macOS 操作系统：** 以 ``/dev/cu.`` 开头
|
||||
|
||||
有关如何查看串口名称的详细信息，请见 :doc:`establish-serial-connection`。
|
||||
|
||||
@@ -51,18 +51,17 @@
|
||||
idf.py set-target {IDF_TARGET_PATH_NAME}
|
||||
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`。
|
||||
|
||||
如果之前的步骤都正确，则会显示下面的菜单：
|
||||
正确操作上述步骤后，系统将显示以下菜单：
|
||||
|
||||
.. figure:: ../../_static/project-configuration.png
|
||||
:align: center
|
||||
:alt: 工程配置 — 主窗口
|
||||
:figclass: align-center
|
||||
|
||||
工程配置 — 主窗口
|
||||
|
||||
您可以通过此菜单设置项目的具体变量，包括 Wi-Fi 网络名称、密码和处理器速度等。``hello_world`` 示例项目会以默认配置运行，因此可以跳过使用 ``menuconfig`` 进行项目配置这一步骤。
|
||||
您可以通过此菜单设置项目的具体变量，包括 Wi-Fi 网络名称、密码和处理器速度等。``hello_world`` 示例项目会以默认配置运行，因此在这一项目中，可以跳过使用 ``menuconfig`` 进行项目配置这一步骤。
|
||||
|
||||
.. only:: esp32
|
||||
|
||||
|
||||
@@ -1,15 +1,15 @@
|
||||
现在您已经具备了使用 ESP-IDF 的所有条件，接下来将介绍如何开始您的第一个工程。
|
||||
|
||||
本指南将帮助您完成使用 ESP-IDF 的第一步。按照本指南，您将能使用 {IDF_TARGET_NAME} 开始创建第一个工程，并构建、烧录和监控设备输出。
|
||||
本指南将帮助您完成使用 ESP-IDF 的第一步。按照本指南，您将使用 {IDF_TARGET_NAME} 创建第一个工程，并构建、烧录和监控设备输出。
|
||||
|
||||
.. note::
|
||||
|
||||
如果您还没有安装 ESP-IDF，请前往 :ref:`get-started-step-by-step` 并按照说明操作，以获得使用本指南所需的所有软件。
|
||||
如果您还未安装 ESP-IDF，请参照 :ref:`get-started-step-by-step` 中的步骤，获取使用本指南所需的所有软件。
|
||||
|
||||
开始创建工程
|
||||
================
|
||||
|
||||
现在，您可以开始准备开发 {IDF_TARGET_NAME} 应用程序了。您可以从 ESP-IDF 中 :idf:`examples` 目录下的 :example:`get-started/hello_world` 工程开始。
|
||||
现在，您可以准备开发 {IDF_TARGET_NAME} 应用程序了。您可以从 ESP-IDF 中 :idf:`examples` 目录下的 :example:`get-started/hello_world` 工程开始。
|
||||
|
||||
.. important::
|
||||
|
||||
@@ -29,9 +29,7 @@
|
||||
|
||||
现在，请将您的 {IDF_TARGET_NAME} 开发板连接到 PC，并查看开发板使用的串口。
|
||||
|
||||
通常，串口在不同操作系统下显示的名称有所不同：
|
||||
|
||||
- **Windows 操作系统：** ``COM1`` 等
|
||||
在 Windows 操作系统中，串口名称通常以 ``COM`` 开头。
|
||||
|
||||
有关如何查看串口名称的详细信息，请见 :doc:`establish-serial-connection`。
|
||||
|
||||
@@ -50,18 +48,17 @@
|
||||
idf.py set-target {IDF_TARGET_PATH_NAME}
|
||||
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`。
|
||||
|
||||
如果之前的步骤都正确，则会显示下面的菜单：
|
||||
正确操作上述步骤后，系统将显示以下菜单：
|
||||
|
||||
.. figure:: ../../_static/project-configuration.png
|
||||
:align: center
|
||||
:alt: 工程配置 — 主窗口
|
||||
:figclass: align-center
|
||||
|
||||
工程配置 — 主窗口
|
||||
|
||||
您可以通过此菜单设置项目的具体变量，包括 Wi-Fi 网络名称、密码和处理器速度等。``hello_world`` 示例项目会以默认配置运行，因此可以跳过使用 ``menuconfig`` 进行项目配置这一步骤。
|
||||
您可以通过此菜单设置项目的具体变量，包括 Wi-Fi 网络名称、密码和处理器速度等。``hello_world`` 示例项目会以默认配置运行，因此在这一项目中，可以跳过使用 ``menuconfig`` 进行项目配置这一步骤。
|
||||
|
||||
.. only:: esp32
|
||||
|
||||
|
||||
Reference in New Issue
Block a user