Skip to content

Commit 90d1203

Browse files
committed
Provide filename of "J-Link GDB Server" for each OS in IDE 2.x debugger J-Link tutorial
Installation of the "SEGGER J-Link GDB Server" software is required in order to use a J-Link debug probe with the Arduino IDE integrated sketch debugger. The user must specify the path to the command line version of the "J-Link GDB Server" tool executable in their debug_custom.json configuration files. The Arduino IDE 2.x debugger tutorial includes a sample debug_custom.json file. This example shows the filename of the tool on Windows, which would likely be sufficient documentation for the readers using that operating system. However, this will not be terribly helpful for the readers using other operating systems, for the following reasons: This installation includes two variants of the "J-Link GDB Server" tool, each executable with a different filename: - GUI: `JLinkGDBServer.exe` (Windows) / `JLinkGDBServerExe` (Linux/macOS) - Command Line: `JLinkGDBServerCL.exe` (Windows) / `JLinkGDBServer` (Linux/macOS) Confusingly, `JLinkGDBServer` is the filename of the GUI variant on Windows, and of the command line variant on the other operating systems Although technically inappropriate for this application, either variant worked fine with the previous version of the debugger extension (0.3.10) used by Arduino IDE 2.0.2 and older. However, I found that the newer version of the debugger extension (1.5.1) used by Arduino IDE 2.0.3 fails on startup when the GUI variant is used (tested on Windows), while the command line variant works fine. For this reason, it is now especially important to clearly document the filename to be used in the configuration file for each operating system.
1 parent 154c713 commit 90d1203

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

content/hardware/01.mkr/01.boards/mkr-wifi-1010/tutorials/mkr-jlink-setup/mkr-jlink.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,12 @@ Now go to the folder where the sketch is located. Add a `.json` file in the same
7878
}
7979
```
8080

81-
The `"serverpath"` needs to be changed to the location where you installed the J-link package in the previous step. When this is done, click on the debugging icon.
81+
The `"serverpath"` field needs to be set to the path of the "J-Link GDB Server CL" tool executable file that is located under the folder of the J-Link package you installed in the previous step. The file is named:
82+
83+
- **If you are using Windows:** `JLinkGDBServerCL.exe`
84+
- **If you are using Linux or macOS:** `JLinkGDBServer`
85+
86+
When you have finished creating the `debug_custom.json` file, click on the debugging icon.
8287

8388
![Start debug feature in Arduino IDE 2.0](assets/mkr_jlink_IDE_debugging_button.png)
8489

0 commit comments

Comments
 (0)