Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add dispose sdk config process in docs #849

Merged
merged 3 commits into from
Nov 29, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/DEBUGGING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The Visual Studio Code uses `.vscode/launch.json` to configure debug as specifie

We recommend using our ESP-IDF Debug Adapter to debug your ESP-IDF projects, but you can also just configure launch.json for the [Microsoft C/C++ Extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools).

Our extension implements a `ESP Peripheral View` tree view in the `Run and debug` view which will use the SVD file defined in the `IDF Svd File Path (idf.svdFilePath)` configuration setting to populate a set of peripherals registers values for the active debug session target. You could find Espressif SVD files from [Espressif SVD](https://github.com/espressif/svd).
Our extension implements a `ESP Peripheral View` tree view in the `Run and debug` view which will use the SVD file defined in the `IDF Svd File Path (idf.svdFilePath)` configuration setting to be defined in the [settings.json](../SETTINGS.md) to populate a set of peripherals registers values for the active debug session target. You could find Espressif SVD files from [Espressif SVD](https://github.com/espressif/svd).

## Use the ESP-IDF Debug Adapter

Expand Down
6 changes: 4 additions & 2 deletions docs/FEATURES.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,15 +93,17 @@ Click the`ESP-IDF Explorer` in the [activity bar](https://code.visualstudio.com/

## SDK Configuration editor

This extension includes a GUI menuconfig that reads your current project folder's sdkconfig file (if available, otherwise it would take default values) and start the [ESP-IDF JSON configuration server](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/build-system.html?highlight=confserver#json-configuration-server) process (confserver.py in **\${IDF_PATH}**/tools) that enables the user to redefine ESP-IDF project and board configuration.
This extension includes a GUI menuconfig using the `ESP-IDF: SDK Configuration editor` command that reads your current project folder's `sdkconfig` file (if available, otherwise it would take default values) and start the [ESP-IDF JSON configuration server](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/build-system.html?highlight=confserver#json-configuration-server) process (confserver.py in **\${IDF_PATH}**/tools) that enables the user to redefine ESP-IDF project and board configuration.

When the user modify a parameter value, the value is send to the `confserver.py` process, which return the new value and other values modified to GUI menuconfig and then update the values in the UI.

Values are not automatically saved to the sdkconfig file until you click save changes. You can cancel any changes and load the values from the sdkconfig file by clicking cancel changes. If you click set default the current sdkconfig file is replaced by a template sdkconfig file and then loaded into the GUI menuconfig rendered values.

The search functionality allows to find a parameter by description, i.e the name that appears in the sdkconfig file.

An IDF GUI Menuconfig log in Output (Menu View -> Output) is created to print all communications with `${idf.espIdfPath}\tools\confserver.py`. It can be be used to track any errors.
An IDF GUI Menuconfig log in `ESP-IDF` Output (Menu View -> Output) is created to print all communications with `${idf.espIdfPath}\tools\confserver.py`. It can be be used to track any errors.

> **NOTE:** The ESP-IDF JSON Configuration server is built from the project's `build/config/kconfig_menus.json` which is generated by the build system from ESP-IDF and user defined components Kconfig files on the first run of SDK Configuration editor. This process takes a bit of time so we keep the process running in the background to speed things up. If you are making changes to any Kconfig files or you want to re-run the SDK Configuration editor from scratch, you need to dispose the current process with the `ESP-IDF: Dispose current SDK Configuration editor server process` and run the `ESP-IDF: SDK Configuration editor` again.

## Set Espressif device target

Expand Down
2 changes: 2 additions & 0 deletions docs/tutorial/basic_use.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ You have several options to create a project:

5. Next configure your project using menuconfig. Use the **ESP-IDF: SDK Configuration editor** command (<kbd>CTRL</kbd> <kbd>E</kbd> <kbd>G</kbd> keyboard shortcut ) where the user can modify the ESP-IDF project settings. After all changes are made, click save and close this window.

> **NOTE:** The **SDK Configuration editor** is built from the project's `build/config/kconfig_menus.json` which is generated by the build system from ESP-IDF and user defined components `Kconfig` files on the first run of `SDK Configuration editor`. This process takes a bit of time so we keep the process running in the background to speed things up. If you are making changes to any Kconfig file or you want to re-run the SDK Configuration editor from scratch, you need to dispose the current process with the `ESP-IDF: Dispose current SDK Configuration editor server process` and run the `ESP-IDF: SDK Configuration editor` again.

<p>
<img src="../../media/tutorials/basic_use/gui_menuconfig.png" alt="GUI Menuconfig" height="500">
</p>
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorial/debugging.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ You can send any GDB commands in the Debug console with `--exec COMMAND`. You ne

More about [command line debugging](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/jtag-debugging/debugging-examples.html#command-line).

Our extension implements a `ESP Peripheral View` tree view in the `Run and debug` view which will use the SVD file defined in the `IDF Svd File Path (idf.svdFilePath)` configuration setting to populate a set of peripherals registers values for the active debug session target. You could find Espressif SVD files from [Espressif SVD](https://github.com/espressif/svd).
Our extension implements a `ESP Peripheral View` tree view in the `Run and debug` view which will use the SVD file defined in the `IDF Svd File Path (idf.svdFilePath)` configuration setting in [settings.json](../SETTINGS.md) to populate a set of peripherals registers values for the active debug session target. You could find Espressif SVD files from [Espressif SVD](https://github.com/espressif/svd).

You can start a monitor session that can capture fatal error events with `ESP-IDF: Launch IDF Monitor for CoreDump / GDB-Stub Mode` command and, if configured in your project's sdkconfig, trigger the start of a debug session for GDB remote protocol server (GDBStub) or [ESP-IDF Core Dump](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/core_dump.html#core-dump) when an error is found. Read more in the [panic handler documentation](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/fatal-errors.html#panic-handler).

Expand Down
2 changes: 1 addition & 1 deletion esp_debug_adapter