Skip to content

Commit

Permalink
monitor cmd name update
Browse files Browse the repository at this point in the history
  • Loading branch information
brianignacio5 committed Apr 22, 2024
1 parent 2230893 commit 3326290
Show file tree
Hide file tree
Showing 11 changed files with 13 additions and 13 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ Install ESP-IDF and ESP-IDF Tools by following the [install tutorial](./docs/tut
- When you are ready, build your project by pressing <kbd>F1</kbd> and typing **ESP-IDF: Build your Project**.
- Flash to your device by pressing <kbd>F1</kbd> and typing **ESP-IDF: Select Flash Method and Flash** to select either UART or JTAG. You can also use the **ESP-IDF: Flash (UART) your Project** or **ESP-IDF: Flash (with JTag)** directly.
> **NOTE:** When using the **ESP-IDF: Select Flash Method and Flash** command, your choice will be saved in the `idf.flashType` configuration setting in the current workspace folder's settings.json.
- You can later start a monitor by pressing <kbd>F1</kbd> and typing **ESP-IDF: Monitor your Device** which will log the device activity in a Visual Studio Code terminal.
- You can later start a monitor by pressing <kbd>F1</kbd> and typing **ESP-IDF: Monitor Device** which will log the device activity in a Visual Studio Code terminal.
- To make sure you can debug your device, select the your board by pressing <kbd>F1</kbd> and typing **ESP-IDF: Select OpenOCD Board Configuration** or manually define the openOCD configuration files with `idf.openOcdConfigs` configuration in your settings.json.
- If you want to start a debug session, just press F5 (make sure you had at least build and flash once before so the debugger works correctly). Check the [Troubleshooting](./README.md#Troubleshooting) section if you have any issues.

Expand Down Expand Up @@ -135,7 +135,7 @@ Click <kbd>F1</kbd> to show Visual studio code actions, then type **ESP-IDF** to
| Launch IDF Monitor for CoreDump / GDB-Stub Mode | | |
| Launch QEMU Server | | |
| Launch QEMU Debug Session | | |
| Monitor your device | <kbd>⌘</kbd> <kbd>I</kbd> <kbd>M</kbd> | <kbd>Ctrl</kbd> <kbd>E</kbd> <kbd>M</kbd> |
| Monitor device | <kbd>⌘</kbd> <kbd>I</kbd> <kbd>M</kbd> | <kbd>Ctrl</kbd> <kbd>E</kbd> <kbd>M</kbd> |
| Monitor QEMU Device | | |
| New Project | <kbd>⌘</kbd> <kbd>I</kbd> <kbd>N</kbd> | <kbd>Ctrl</kbd> <kbd>E</kbd> <kbd>N</kbd> |
| Open ESP-IDF Terminal | <kbd>⌘</kbd> <kbd>I</kbd> <kbd>T</kbd> | <kbd>Ctrl</kbd> <kbd>E</kbd> <kbd>T</kbd> |
Expand Down
4 changes: 2 additions & 2 deletions docs/FEATURES.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,9 @@ You can follow [this](./HEAP_TRACING.md) quick step-by-step guide for Heap Traci

## Monitor

**ESP-IDF: Monitor your Device** is provided by this extension to start `idf.py monitor` terminal program in Visual Studio Code. Please take a look at the [IDF Monitor Documentation](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/tools/idf-monitor.html?highlight=monitor).
**ESP-IDF: Monitor Device** is provided by this extension to start `idf.py monitor` terminal program in Visual Studio Code. Please take a look at the [IDF Monitor Documentation](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/tools/idf-monitor.html?highlight=monitor).

In Visual Studio Code, for **ESP-IDF: Monitor your Device** we use the shell executable given in `vscode.env.shell` which is override by `terminal.integrated.shell.*` in your Visual Studio Code Settings when using the `Terminal: Select Default Shell` command to update the shell or updating `terminal.integrated.shell.windows` for Windows, `terminal.integrated.shell.osx` for MacOS and `terminal.integrated.shell.linux` for Linux in VSCode Settings Preference menu (F1 -> Preferences: Open Settings (JSON)).
In Visual Studio Code, for **ESP-IDF: Monitor Device** we use the shell executable given in `vscode.env.shell` which is override by `terminal.integrated.shell.*` in your Visual Studio Code Settings when using the `Terminal: Select Default Shell` command to update the shell or updating `terminal.integrated.shell.windows` for Windows, `terminal.integrated.shell.osx` for MacOS and `terminal.integrated.shell.linux` for Linux in VSCode Settings Preference menu (F1 -> Preferences: Open Settings (JSON)).

## OpenOCD Server

Expand Down
2 changes: 1 addition & 1 deletion docs/MANUAL_TESTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ _Steps:_

1. Press menu **View**, click on **Command Palette** and type **ESP-IDF: Select port to use** and select it.
2. Choose the serial port to connect and the workspace folder where to save the `idf.port` configuration setting.
3. Press menu **View**, click on **Command Palette** and type **ESP-IDF: Monitor your Device** and select it.
3. Press menu **View**, click on **Command Palette** and type **ESP-IDF: Monitor Device** and select it.
4. ESP-IDF Monitor should begin after.

_Expected Results:_
Expand Down
2 changes: 1 addition & 1 deletion docs/POSTMORTEM.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
The `ESP-IDF: Launch IDF Monitor for CoreDump / GDB-Stub Mode` command launches a ESP-IDF Monitor terminal listening for core-dump/gdbstub events on which will launch a debug session where you can send gdb commands to
the chip (without continue, pause or other debug steps).

> **NOTE:** The `ESP-IDF: Monitor your Device` command will not launch a debug session.
> **NOTE:** The `ESP-IDF: Monitor Device` command will not launch a debug session.
# Using Core Dump

Expand Down
2 changes: 1 addition & 1 deletion docs/tutorial/basic_use.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ The user will see a new terminal being launched with the flash output and a noti
<img src="../../media/tutorials/basic_use/flash.png" alt="Flashing" width="975">
</p>

10. Now to start monitoring your device, use the **ESP-IDF: Monitor your Device** command (<kbd>CTRL</kbd> <kbd>E</kbd> <kbd>M</kbd> keyboard shortcut). The user will see a new terminal being launched with the `idf.py monitor` output.
10. Now to start monitoring your device, use the **ESP-IDF: Monitor Device** command (<kbd>CTRL</kbd> <kbd>E</kbd> <kbd>M</kbd> keyboard shortcut). The user will see a new terminal being launched with the `idf.py monitor` output.

> **NOTE** The ESP-IDF Monitor baud rate value is taken from `idf.monitorBaudRate` with fallback on your project's SDKConfig `CONFIG_ESPTOOLPY_MONITOR_BAUD` (idf.py monitor' baud rate). This value can also be override by setting the environment variable `IDF_MONITOR_BAUD` or `MONITORBAUD` in your system environment variables or this extension's `idf.customExtraVars` configuration setting. Please review [ESP-IDF Settings](../SETTINGS.md)) to see how to modify `idf.customExtraVars`.
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorial/code_coverage.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ The example will enable the following options by default:

> **NOTE:** For any project that you want to generate code coverage, you should enable these settings in your sdkconfig.
6. Now to build the project, flash your device and start the ESP-IDF Monitor you can use the **ESP-IDF: Build your Project**, **ESP-IDF: Flash your Project** and **ESP-IDF: Monitor your Device** commands as explained in the [Basic use tutorial](./basic_use.md). If everything is executed correctly, there will be a message in ESP-IDF Monitor saying `Ready to dump GCOV data...`
6. Now to build the project, flash your device and start the ESP-IDF Monitor you can use the **ESP-IDF: Build your Project**, **ESP-IDF: Flash your Project** and **ESP-IDF: Monitor Device** commands as explained in the [Basic use tutorial](./basic_use.md). If everything is executed correctly, there will be a message in ESP-IDF Monitor saying `Ready to dump GCOV data...`

> **NOTE:** There is also a **ESP-IDF: Build, Flash and Start a Monitor on your Device** command (<kbd>CTRL</kbd> <kbd>E</kbd> <kbd>D</kbd> keyboard shortcut).
Expand Down
2 changes: 1 addition & 1 deletion package.nls.es.json
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
"espIdf.launchQemu.title": "Iniciar servidor QEMU",
"espIdf.launchWSServerAndMonitor.title": "Lanzar monitor IDF para CoreDump / GDB-Stub Mode",
"espIdf.menuconfig.start.title": "Editor de Configuración del SDK (Menuconfig)",
"espIdf.monitorDevice.title": "Monitorear su Dispositivo",
"espIdf.monitorDevice.title": "Monitorear Dispositivo",
"espIdf.monitorQemu.title": "Monitorear Dispositivo QEMU",
"espIdf.newProject.start.title": "Nuevo Proyecto",
"espIdf.ninja.summary.title": "Mostrar Resumen de Compilación Ninja",
Expand Down
2 changes: 1 addition & 1 deletion package.nls.json
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
"espIdf.launchQemu.title": "Launch QEMU Server",
"espIdf.launchWSServerAndMonitor.title": "Launch IDF Monitor for CoreDump / GDB-Stub Mode",
"espIdf.menuconfig.start.title": "SDK Configuration Editor (Menuconfig)",
"espIdf.monitorDevice.title": "Monitor your Device",
"espIdf.monitorDevice.title": "Monitor Device",
"espIdf.monitorQemu.title": "Monitor QEMU Device",
"espIdf.newProject.start.title": "New Project",
"espIdf.ninja.summary.title": "Show Ninja Build Summary",
Expand Down
2 changes: 1 addition & 1 deletion package.nls.pt.json
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
"espIdf.launchQemu.title": "Inicie o servidor QEMU",
"espIdf.launchWSServerAndMonitor.title": "Inicie o IDF Monitor para modo CoreDump / GDB-Stub",
"espIdf.menuconfig.start.title": "Editor de configuração do SDK (Menuconfig)",
"espIdf.monitorDevice.title": "Monitore seu dispositivo",
"espIdf.monitorDevice.title": "Monitore dispositivo",
"espIdf.monitorQemu.title": "Monitorar dispositivo QEMU",
"espIdf.newProject.start.title": "Novo projeto",
"espIdf.ninja.summary.title": "Mostrar resumo da versão Ninja",
Expand Down
2 changes: 1 addition & 1 deletion package.nls.ru.json
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
"espIdf.launchQemu.title": "Запустить сервер QEMU",
"espIdf.launchWSServerAndMonitor.title": "Запустите IDF Monitor для режима CoreDump/GDB-Stub.",
"espIdf.menuconfig.start.title": "Редактор конфигурации SDK (Menuconfig)",
"espIdf.monitorDevice.title": "Контролируйте свое устройство",
"espIdf.monitorDevice.title": "Мониторное устройство",
"espIdf.monitorQemu.title": "Мониторинг устройства QEMU",
"espIdf.newProject.start.title": "Новый проект",
"espIdf.ninja.summary.title": "Показать сводку сборки ниндзя",
Expand Down
2 changes: 1 addition & 1 deletion package.nls.zh-CN.json
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
"espIdf.launchQemu.title": "启动 QEMU 服务器",
"espIdf.launchWSServerAndMonitor.title": "启动 IDF 监视器以进行 CoreDump / GDB-Stub 模式",
"espIdf.menuconfig.start.title": "SDK 配置编辑器 (Menuconfig)",
"espIdf.monitorDevice.title": "监视您的设备",
"espIdf.monitorDevice.title": "监控装置",
"espIdf.monitorQemu.title": "监视 QEMU 设备",
"espIdf.newProject.start.title": "新项目",
"espIdf.ninja.summary.title": "显示 Ninja 构建摘要",
Expand Down

0 comments on commit 3326290

Please sign in to comment.