Skip to content

Commit d6b1c03

Browse files
committed
changes in walkthrough and docs
1 parent 63b48d6 commit d6b1c03

33 files changed

+113
-63
lines changed

docs_espressif/en/additionalfeatures/app-tracing.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This feature allows transferring arbitrary data between the host and ESP32 via t
77

88
Developers can use this library to send application-specific state of execution to the host and receive commands or other types of information in the opposite direction at runtime.
99

10-
Let's open an ESP-IDF project. For this tutorial, we will use the `system/app_trace_to_host <https://github.com/espressif/esp-idf/tree/master/examples/system/app_trace_to_host>`_ example.
10+
Let's open an ESP-IDF project. For this tutorial, we will use the `system/app_trace_to_host <https://github.com/espressif/esp-idf/tree/master/examples/system/app_trace_basic>`_ example.
1111

1212
1. Navigate to ``View`` > ``Command Palette``.
1313

@@ -17,7 +17,7 @@ Let's open an ESP-IDF project. For this tutorial, we will use the `system/app_tr
1717

1818
If you don't see the option, please review the setup in :ref:`Install ESP-IDF and Tools <installation>`.
1919

20-
3. A window will open with settings to configure the project. You can later choose from a list of ESP-IDF examples. Go to the ``system`` section and choose ``app_trace_to_host``. You will see a ``Create Project Using Example app_trace_to_host`` button at the top and a description of the project below. Click the button, and the project will open in a new window.
20+
3. A window will open with settings to configure the project. You can later choose from a list of ESP-IDF examples. Go to the ``system`` section and choose ``app_trace_to_host``. You will see a ``Create Project Using Example app_trace_to_host`` button at the top and a description of the project below. Configure the project name and directory, click the ``Create Project`` button, wait for the project to be created and then click on ``Open Project``.
2121

2222
.. image:: ../../../media/tutorials/app_trace/app_tracing.png
2323

docs_espressif/en/additionalfeatures/coverage.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Let's use the ESP-IDF `GCOV Example <https://github.com/espressif/esp-idf/tree/m
2323

2424
If you don't see the option, please review the current ESP-IDF setup in :ref:`Installation <installation>`.
2525

26-
3. A window will open with settings to configure the project. Choose from a list of ESP-IDF examples, go to the ``system`` section, and select ``gcov``. You will see a ``Create Project Using Example GCOV`` button at the top and a project description below. Click ``Create Project Using Example GCOV``.
26+
3. A window will open with settings to configure the project. Choose from a list of ESP-IDF examples, go to the ``system`` section, and select ``gcov``. You will see a ``Create Project Using Example GCOV`` button at the top and a project description below. Configure the project name and directory, click ``Create Project`` button, wait for the project to be created and then click on ``Open Project``.
2727

2828
.. image:: ../../../media/tutorials/coverage/gcov_example.png
2929

docs_espressif/en/additionalfeatures/flash-encryption.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ Flash Encryption secures the device's flash memory contents. Once enabled, the f
77

88
Let's open an ESP-IDF project. For this tutorial, we will use the ``security/flash_encryption`` example.
99

10-
1. Navigate to **View** > **Command Palette** and search for the **ESP-IDF: Show Example Projects** command, then choose ``Use Current ESP-IDF (/path/to/esp-idf)``. If you don't see this option, please review the setup in the :ref:`Install ESP-IDF and Tools <installation>`.
10+
1. Navigate to **View** > **Command Palette** and search for the **ESP-IDF: New Project** command, then choose ``Use Current ESP-IDF (/path/to/esp-idf)``. If you don't see this option, please review the setup in the :ref:`Install ESP-IDF and Tools <installation>`.
1111

12-
2. A window will open with a list of projects. Search for ``flash_encryption``. You will see a **Create project using example flash_encryption** button at the top and a description of the project below. Click the button, and the project will open in a new window.
12+
2. A window will open with a list of projects. Search for ``flash_encryption``. You will see a **Create project using example flash_encryption** button at the top and a description of the project below. Click the button, configure the project, click ``Create Project`` button, wait for the project to be created and then click on ``Open Project``.
1313

1414
.. image:: ../../../media/tutorials/flash_encryption/flash-encryption.png
1515
:alt: Flash Encryption example

docs_espressif/en/additionalfeatures/heap-tracing.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Let's open an ESP-IDF project. For this tutorial, we will use the ``system/sysvi
1515

1616
If you don't see the option, please review the setup in :ref:`Install ESP-IDF and Tools <installation>`.
1717

18-
3. A window will open with settings to configure the project. You can later choose from a list of ESP-IDF examples. Go to the ``system`` section and choose ``sysview_tracing_heap_log``. You will see a ``Create Project Using Example sysview_tracing_heap_log`` button at the top and a description of the project below. Click the button, and the project will open in a new window.
18+
3. A window will open with settings to configure the project. You can later choose from a list of ESP-IDF examples. Go to the ``system`` section and choose ``sysview_tracing_heap_log``. You will see a ``Create Project Using Example sysview_tracing_heap_log`` button at the top and a description of the project below. Click the ``Create Project`` button, wait for the project to be created and then click on ``Open Project``.
1919

2020
.. image:: ../../../media/tutorials/heap_trace/sysview_tracing_heap_log.png
2121

docs_espressif/en/additionalfeatures/wsl.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Install the following tools before starting the project:
1010
1. Windows WSL (see installation steps below)
1111
2. `Visual Studio Code <https://code.visualstudio.com>`_
1212
3. `usbipd-win <https://github.com/dorssel/usbipd-win/releases>`_
13+
4. `Espressif Install Manager prerequisites <https://docs.espressif.com/projects/idf-im-ui/en/latest/prerequisites.html>`_
1314

1415
Installing Ubuntu on Windows (WSL)
1516
----------------------------------

docs_espressif/en/prerequisites.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ Prerequisites
44
:link_to_translation:`zh_CN:[中文]`
55

66
- `Visual Studio Code <https://code.visualstudio.com/>`_
7+
- `Espressif Install Manager prerequisites <https://docs.espressif.com/projects/idf-im-ui/en/latest/prerequisites.html>`_
78

89
.. note::
910

docs_espressif/en/startproject.rst

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -57,11 +57,7 @@ In Visual Studio Code:
5757

5858
- Click the ``Create Project`` button.
5959

60-
- After the project is created, a notification window will appear, asking whether to open the newly created project.
61-
62-
.. image:: ../../media/tutorials/new_project/new_project_confirm.png
63-
:width: 400px
64-
:align: center
60+
- Wait for the project to be created and then click on ``Open Project``.
6561

6662
.. _ESP-IDF Existing ESP-IDF Project:
6763

docs_espressif/zh_CN/additionalfeatures/app-tracing.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,17 +15,17 @@
1515

1616
.. note::
1717

18-
如果未看到该选项,请检查当前的 ESP-IDF 设置,详见 :ref:`安装 ESP-IDF 和相关工具 <installation>`。
18+
如果未看到该选项,请参阅 :ref:`安装 ESP-IDF 和相关工具 <installation>` 中的设置说明
1919

20-
3. 系统将弹出用于配置项目的窗口。 ESP-IDF 示例列表中选择示例,在 ``system`` 部分选择 ``app_trace_to_host``。页面顶部会出现 ``Create Project Using Example app_trace_to_host`` 按钮,页面下方会出现项目描述,点击按钮,项目会在新窗口中打开
20+
3. 系统将弹出用于配置项目的窗口。您可以从 ESP-IDF 示例列表中选择示例。进入 ``system`` 部分并选择 ``app_trace_to_host``。页面顶部会出现 ``Create Project Using Example app_trace_to_host`` 按钮,页面下方会显示项目描述。配置项目名称和目录,点击 ``Create Project`` 按钮,等待项目创建完成后点击 ``Open Project``
2121

2222
.. image:: ../../../media/tutorials/app_trace/app_tracing.png
2323

2424
在此示例中,项目已配置应用程序跟踪。在其他项目中,请使用 ``ESP-IDF:SDK 配置编辑器`` 命令启用 ``CONFIG_APPTRACE_DEST_TRAX`` 和 ``CONFIG_APPTRACE_ENABLE``。
2525

2626
4. 按照 :ref:`构建项目 <build the project>` 中的说明,配置、构建并烧录项目。
2727

28-
5. 首先,点击 `Visual Studio Code 活动栏 <https://code.visualstudio.com/docs/getstarted/userinterface>`_ 中的 ``ESP-IDF Explorer``。其次,在 ``IDF APP TRACER`` ,点击 ``Start App Trace``。这将启动扩展的 OpenOCD 服务器并发送相应的跟踪命令以生成跟踪日志。最后,可以在 ``APP TRACE ARCHIVES`` 中查看生成的日志,名称为 ``Trace Log #1``。
28+
5. 首先,点击 `Visual Studio Code 活动栏 <https://code.visualstudio.com/docs/getstarted/userinterface>`_ 中的 ``ESP-IDF Explorer``。其次,在 ``IDF APP TRACER`` 部分,点击 ``Start App Trace``。这将启动扩展的 OpenOCD 服务器并发送相应的跟踪命令以生成跟踪日志。最后,可以在 ``APP TRACE ARCHIVES`` 中查看生成的日志,名称为 ``Trace Log #1``。
2929

3030
每次执行 ``Start App Trace`` 都会生成一个新的跟踪,显示在归档列表中。也可以通过运行 ``ESP-IDF:应用程序跟踪`` 命令启动跟踪。
3131

@@ -40,4 +40,4 @@
4040

4141
.. image:: ../../../media/tutorials/app_trace/trace_report.png
4242

43-
更多关于本功能的信息,请参阅 `应用层跟踪库 <https://docs.espressif.com/projects/esp-idf/zh_CN/latest/esp32/api-guides/app_trace.html>`_。
43+
更多信息请参阅 `应用层跟踪库 <https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/app_trace.html>`_。

docs_espressif/zh_CN/additionalfeatures/coverage.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
使用 ``gcov``,配置 ESP-IDF 项目生成 ``gcda/gcno`` 覆盖率文件。请参阅 `GCOV 代码覆盖率 <https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/app_trace.html#gcov-source-code-coverage>`_,以详细了解如何在 ESP-IDF 项目中使用 GCOV 的代码覆盖率功能。
99

10-
可使用 ``ESP-IDF:配置 SDKConfig 文件以启用代码覆盖率`` 命令在 SDK 配置编辑器中设置所需配置。
10+
可使用 ``ESP-IDF: Configure Project SDKConfig for Coverage`` SDK 配置编辑器中设置所需配置。
1111

1212

1313
代码覆盖率示例
@@ -21,9 +21,9 @@
2121

2222
.. note::
2323

24-
如果未看到该选项,请检查当前的 ESP-IDF 设置,详见 :ref:`Installation <installation>`。
24+
如果未看到该选项,请参阅 :ref:`安装 <installation>` 中的当前 ESP-IDF 设置说明
2525

26-
3. 系统将弹出用于配置项目的窗口。从 ESP-IDF 示例列表中选择示例, ``system`` 部分选择 ``gcov``。页面顶部会出现 ``Create Project Using Example GCOV`` 按钮,页面下方会出现项目描述。点击 ``Create Project Using Example GCOV``。
26+
3. 系统将弹出用于配置项目的窗口。从 ESP-IDF 示例列表中选择示例,进入 ``system`` 部分并选择 ``gcov``。页面顶部会出现 ``Create Project Using Example GCOV`` 按钮,页面下方会显示项目描述。配置项目名称和目录,点击 ``Create Project`` 按钮,等待项目创建完成后点击 ``Open Project``。
2727

2828
.. image:: ../../../media/tutorials/coverage/gcov_example.png
2929

Lines changed: 43 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,43 @@
1-
.. include:: ../../en/additionalfeatures/flash-encryption.rst
1+
.. _flash_encryption:
2+
3+
闪存加密
4+
========================
5+
6+
:link_to_translation:`en:[English]`
7+
8+
闪存加密可保护设备闪存中的内容。启用后,固件首次以明文烧录,在首次启动时被加密,从而防止未经授权的闪存读取。更多详情请参阅 `ESP-IDF 闪存加密文档 <https://docs.espressif.com/projects/esp-idf/en/latest/esp32/security/flash-encryption.html>`_。
9+
10+
本教程将打开一个 ESP-IDF 项目,使用 ``security/flash_encryption`` 示例。
11+
12+
1. 前往 **查看** > **命令面板**,搜索 **ESP-IDF: New Project** 命令,然后选择 ``Use Current ESP-IDF (/path/to/esp-idf)``。若未看到该选项,请参阅 :ref:`安装 ESP-IDF 和相关工具 <installation>` 中的设置说明。
13+
14+
2. 将弹出项目列表窗口。搜索 ``flash_encryption``。页面顶部会出现 **Create project using example flash_encryption** 按钮,下方会显示项目描述。点击该按钮,配置项目,点击 ``Create Project`` 按钮,等待项目创建完成后点击 ``Open Project``。
15+
16+
.. image:: ../../../media/tutorials/flash_encryption/flash-encryption.png
17+
:alt: 闪存加密示例
18+
19+
3. 通过以下步骤配置项目:
20+
21+
- 选择要使用的串口
22+
- 设置乐鑫设备目标
23+
- 设置烧录方式为 UART
24+
25+
.. note::
26+
若该步骤不清楚,请参阅 :ref:`构建项目 <build the project>`。
27+
28+
4. 在命令面板中执行 ``ESP-IDF: SDK Configuration editor (Menuconfig)`` 打开 SDK 配置菜单。搜索 **flash encryption** 并启用相应选项:
29+
30+
.. image:: ../../../media/tutorials/flash_encryption/flash-encryption2.png
31+
:alt: 闪存加密配置
32+
33+
.. important::
34+
启用闪存加密会限制 ESP32 的后续更新方式。使用此功能前,请阅读文档并充分理解其影响。`ESP-IDF 闪存加密文档 <https://docs.espressif.com/projects/esp-idf/en/latest/esp32/security/flash-encryption.html>`_
35+
36+
5. 构建项目。
37+
38+
6. 烧录项目。
39+
40+
.. note::
41+
首次烧录时固件将不会使用 ``--encrypt`` 参数。烧录完成后,需按开发板上的复位键重启设备。(按键可能标为 "RESET"、"RST" 或 "EN")
42+
43+
7. 再次烧录固件;若前述步骤均正确完成,此次将自动添加 ``--encrypt`` 参数。

0 commit comments

Comments
 (0)