You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
ESP-IDF provides a useful feature for program behavior analysis called `Application Level Tracing <https://docs.espressif.com/projects/esp-idf/en/latest/esp32c3/api-guides/app_trace.html?>`_. The IDF-Eclipse plugin has a UI that allows you to start and stop tracing commands and process the received data. To familiarize yourself with this library, you can use the `app_trace_to_host <https://github.com/espressif/esp-idf/tree/release/v5.0/examples/system/app_trace_to_host>`_ project or the `app_trace_basic <https://github.com/espressif/esp-idf/tree/release/v5.1/examples/system/app_trace_basic>`_ project (if using esp-idf 5.1 and higher). These projects can be created from the plugin itself:
4
+
:link_to_translation:`zh_CN:[中文]`
5
+
6
+
ESP-IDF provides a useful feature for program behavior analysis called `Application Level Tracing <https://docs.espressif.com/projects/esp-idf/en/latest/esp32c3/api-guides/app_trace.html?>`_. The IDF-Eclipse plugin provides a UI that allows you to start and stop tracing commands and process the received data. To get familiar with using this library, you can use the `app_trace_to_host <https://github.com/espressif/esp-idf/tree/release/v5.0/examples/system/app_trace_to_host>`_ project or the `app_trace_basic <https://github.com/espressif/esp-idf/tree/release/v5.1/examples/system/app_trace_basic>`_ project (if you are using ESP-IDF 5.1 or higher). You can create these projects directly from the plugin.
5
7
6
8
.. image:: ../../../media/AppLvlTracing_1.png
7
9
:alt:Application Level Tracing project creation
@@ -11,17 +13,18 @@ Before using application-level tracing, create a debug configuration for the pro
11
13
.. image:: ../../../media/AppLvlTracing_3.png
12
14
:alt:Debug configuration setup
13
15
14
-
After creating the debug configuration, right-click on the project in the Project Explorer and select *ESP-IDF > Application Level Tracing*:
16
+
After creating the debug configuration, right-click on the project in the Project Explorer and select ``ESP-IDF: Application Level Tracing``:
15
17
16
18
.. image:: ../../../media/AppLvlTracing_2.png
17
19
:alt:Application Level Tracing option in the context menu
18
20
19
-
It may take a moment to open the application level tracing dialog, as the OpenOCD server starts first. At the top of the dialog, you will find auto-configured fields that you can adjust for the trace start command.
21
+
It may take a moment to open the application level tracing dialog, as the OpenOCD server starts first. At the top of the dialog, you will find auto-configured fields that you can adjust if needed for the trace start command.
- ``outfile``: Path to the file where data from both CPUs will be saved, with format ``file://path/to/file``.
26
29
- ``poll_period``: Data polling period (in ms). If greater than 0, the command runs in non-blocking mode. Default: 1 ms.
27
30
- ``trace_size``: Maximum data size to collect (in bytes). Tracing stops after the specified amount of data is received. Default: -1 (disabled).
@@ -34,14 +37,14 @@ Additional information can be found `here <https://docs.espressif.com/projects/e
34
37
.. image:: ../../../media/AppLvlTracing_4.png
35
38
:alt:Application Level Tracing dialog
36
39
37
-
The next two fields, *Trace Processing Script* and *Start Parsing Command*, are used to parse the output file.
40
+
The next two fields, ``Trace Processing Script`` and ``Start Parsing Command``, are used to parse the output file.
38
41
39
-
- **Trace Processing Script**: Path to the parsing script, which by default is ``logtrace_proc.py`` from esp-idf.
40
-
- **Start Parsing Command**: Allows you to check and edit the parsing command if necessary. By default, it is configured as: ``$IDF_PATH/tools/esp_app_trace/logtrace_proc.py/path/to/trace/file/path/to/program/elf/file``.
42
+
- ``Trace Processing Script``: Path to the parsing script, which by default is ``logtrace_proc.py`` from ESP-IDF.
43
+
- ``Start Parsing Command``: Allows you to check and edit the parsing command if necessary. By default, it is configured as: ``$IDF_PATH/tools/esp_app_trace/logtrace_proc.py/path/to/trace/file/path/to/program/elf/file``.
41
44
42
-
The *Start parse* button is disabled until a dump file is generated. To generate it, click the *Start* button at the bottom of the dialog box. This button changes to *Stop* once tracing starts, allowing you to stop it.
45
+
The ``Start parse`` button is disabled until a dump file is generated. To generate the dump file, click the ``Start`` button at the bottom of the dialog box. This button changes to ``Stop`` once tracing starts, allowing you to stop tracing.
43
46
44
-
When the output file is available, click *Start parse* to view the parsed script output in the Eclipse console:
47
+
When the output file is available, click ``Start parse`` to view the parsed script output in the Eclipse console.
0 commit comments