Implement official Arduino IDE debugger API #9116

pillo79 · 2024-01-16T11:57:49Z

Description of Change

This PR replaces the current experimental sketch debugging description with a full implementation according to the finalized Arduino Platform Debug Specification.

The current experimental debug configuration will no longer be supported with the release of Arduino IDE 2.3.0.

The biggest improvement is that now the contents of launch.json can be fully customized from entries in platform.txt, so there is no need to copy files in the sketch folder and advanced customizations become possible.

In particular, debug_custom.json is not used anymore.

Tests scenarios

Tested on Arduino Nano ESP32 with current nightly IDE, available from here in the Nightly Builds section, or 2.3.0+ when it becomes public.

github-actions · 2024-01-16T11:58:33Z

	Warnings
⚠️	Some issues found for the commit messages in this PR: the commit message `"feat(platform)!: use new Arduino Debug API"`: body's lines must not be longer than 100 characters summary looks empty type/action looks empty the commit message `"on_release: allow single board packages"`: type/action should be one of [`change`, `ci`, `docs`, `feat`, `fix`, `refactor`, `remove`, `revert`, `test`] Please fix these commit messages - here are some basic tips: follow Conventional Commits style correct format of commit message should be: `<type/action>(<scope/component>): <summary>`, for example `fix(esp32): Fixed startup timeout issue` allowed types are: `change,ci,docs,feat,fix,refactor,remove,revert,test` sufficiently descriptive message summary should be between 20 to 72 characters and start with upper case letter avoid Jira references in commit messages (unavailable/irrelevant for our customers) `TIP:` Install pre-commit hooks and run this check when committing (uses the Conventional Precommit Linter).
⚠️	Please consider squashing your 6 commits (simplifying branch history).

👋 Hello pillo79, we appreciate your contribution to this project!

Click to see more instructions ...

This automated output is generated by the PR linter DangerJS, which checks if your Pull Request meets the project's requirements and helps you fix potential issues.

DangerJS is triggered with each push event to a Pull Request and modify the contents of this comment.

Please consider the following:
- Danger mainly focuses on the PR structure and formatting and can't understand the meaning behind your code or changes.
- Danger is not a substitute for human code reviews; it's still important to request a code review from your colleagues.
- Resolve all warnings (⚠️ ) before requesting a review from human reviewers - they will appreciate it.
- To manually retry these Danger checks, please navigate to the Actions tab and re-run last Danger workflow.

Review and merge process you can expect ...

We do welcome contributions in the form of bug reports, feature requests and pull requests.

1. An internal issue has been created for the PR, we assign it to the relevant engineer.
2. They review the PR and either approve it or ask you for changes or clarifications.
3. Once the GitHub PR is approved we do the final review, collect approvals from core owners and make sure all the automated tests are passing.
- At this point we may do some adjustments to the proposed change, or extend it by adding tests or documentation.
4. If the change is approved and passes the tests it is merged into the default branch.

Generated by 🚫 dangerJS against 246a6d1

me-no-dev · 2024-01-16T12:35:02Z

Nice!

me-no-dev · 2024-01-16T13:14:14Z

@pillo79 could you also backport this to release/2.x? We will probably have to release 2.0.15 soon with some security fixes (and more)

pillo79 · 2024-01-16T13:49:12Z

@me-no-dev thanks for looking. Sure, will do! 👍

pillo79 · 2024-01-16T14:31:21Z

I edited descriptions only, but rebasing to current master (60395ed) I apparently picked up something that causes a build error. I will revert to the previous branch point for the CI to complete.

Use regexs to replace all occurrences of `{runtime.platform.path}` with the correct `{runtime.tools.*.path}`, regardless of directory separator, and remove dependency on specific text around each path. Note that the order has been changed to ensure that the longest paths are replaced first, to avoid replacing parts of other paths.

Ensure Windows paths properly use a backslash as folder separator.

Implement sketch debugging according to the official Arduino Platform Debug Specification [1]. The biggest improvement is that now `launch.json` can be fully customized by the core (including the type of each entry), so there is no need to copy files in the sketch folder. In particular, `debug_custom.json` is not used anymore. [1] https://arduino.github.io/arduino-cli/latest/platform-specification/#sketch-debugging-configuration BREAKING CHANGE: This commit requires Arduino IDE 2.3.0 or later to use the debugging features. Older versions will no longer be able to start a debug session successfully.

Cortex-debug requires objdump to be in the same folder as gdb, or needs the full path to the executable in the `launch.json` file. This is now possible with the new debugging API.

If the `debug.executable` variable is null or unset, the Debug button appears grayed out. The new IDE also takes current parameters into account, allowing to conditionally enable the Debug button only when some conditions are met.

pillo79 · 2024-01-16T15:43:11Z

Fixed a quote-related escaping issue (my personal favs 😅) and also included a small addition to on-release that was present on 2.x but I missed when preparing the 3.x porting. I will test tomorrow with the IDE team then release for actual review/merge.

kittaakos · 2024-01-16T16:38:07Z

available from here in the Nightly Builds section,

Direct link: https://www.arduino.cc/en/software#nightly-builds

pillo79 · 2024-02-01T17:04:51Z

Internal tests have completed successfully so marking it ready for review.

pillo79 · 2024-02-09T10:51:13Z

IDE 2.3 has been released yesterday 👍

cristiancardosodexcom · 2024-03-28T04:31:11Z

Does not work debugger for esp32-dev module.
embedded:startup.tcl:28: Error: Can't find debug.cfg Arduino IDE 2.3.2

pillo79 · 2024-03-28T08:26:17Z

Does not work debugger for esp32-dev module. embedded:startup.tcl:28: Error: Can't find debug.cfg Arduino IDE 2.3.2

Hello @cristiancardosodexcom, what is the version of the core you are using? Is that on a Mac?

cristiancardosodexcom · 2024-03-28T16:38:30Z

Does not work debugger for esp32-dev module. embedded:startup.tcl:28: Error: Can't find debug.cfg Arduino IDE 2.3.2

Version: 2.3.2
Date: 2024-02-20T09:53:59.281Z (1 month ago)
CLI Version: 0.35.3

Yes it's a MAC.

pillo79 · 2024-03-29T20:52:22Z

I was referring to the version of the Arduino-ESP32 core, not the IDE 🙂
What does the IDE report here?

(If you are using a local Git copy, please provide the commit). Thanks

pillo79 force-pushed the new_debug_api branch from 981c171 to 16d4c61 Compare January 16, 2024 14:04

pillo79 force-pushed the new_debug_api branch from 16d4c61 to 2664825 Compare January 16, 2024 14:39

pillo79 added 5 commits January 16, 2024 16:02

fix(platform): Windows backslash cleanups

6244b46

Ensure Windows paths properly use a backslash as folder separator.

feat(debug): pass objdump path to resolve globals

db104af

Cortex-debug requires objdump to be in the same folder as gdb, or needs the full path to the executable in the `launch.json` file. This is now possible with the new debugging API.

pillo79 force-pushed the new_debug_api branch from 2664825 to 272a0a5 Compare January 16, 2024 15:05

on_release: allow single board packages

246a6d1

pillo79 mentioned this pull request Jan 16, 2024

Implement official Arduino IDE debugger API on 2.x #9118

Merged

VojtechBartoska added the IDE: Arduino IDE Issue relates to Arduino IDE label Feb 1, 2024

pillo79 marked this pull request as ready for review February 1, 2024 17:03

VojtechBartoska added the Status: Review needed Issue or PR is awaiting review label Feb 2, 2024

VojtechBartoska requested review from me-no-dev and P-R-O-C-H-Y February 2, 2024 10:29

me-no-dev merged commit 7a22d64 into espressif:master Feb 9, 2024
53 checks passed

kittaakos mentioned this pull request Feb 13, 2024

Feature Request - Update the core to support debugging with Arduino IDE 2.3 and Arduino CLI 0.35.0 earlephilhower/arduino-pico#2003

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement official Arduino IDE debugger API #9116

Implement official Arduino IDE debugger API #9116

pillo79 commented Jan 16, 2024

github-actions bot commented Jan 16, 2024 •

edited

Loading

me-no-dev commented Jan 16, 2024

me-no-dev commented Jan 16, 2024

pillo79 commented Jan 16, 2024

pillo79 commented Jan 16, 2024

pillo79 commented Jan 16, 2024

kittaakos commented Jan 16, 2024

pillo79 commented Feb 1, 2024

pillo79 commented Feb 9, 2024

cristiancardosodexcom commented Mar 28, 2024 •

edited

Loading

pillo79 commented Mar 28, 2024

cristiancardosodexcom commented Mar 28, 2024 •

edited

Loading

pillo79 commented Mar 29, 2024 •

edited

Loading

Implement official Arduino IDE debugger API #9116

Implement official Arduino IDE debugger API #9116

Conversation

pillo79 commented Jan 16, 2024

Description of Change

Tests scenarios

github-actions bot commented Jan 16, 2024 • edited Loading

me-no-dev commented Jan 16, 2024

me-no-dev commented Jan 16, 2024

pillo79 commented Jan 16, 2024

pillo79 commented Jan 16, 2024

pillo79 commented Jan 16, 2024

kittaakos commented Jan 16, 2024

pillo79 commented Feb 1, 2024

pillo79 commented Feb 9, 2024

cristiancardosodexcom commented Mar 28, 2024 • edited Loading

pillo79 commented Mar 28, 2024

cristiancardosodexcom commented Mar 28, 2024 • edited Loading

pillo79 commented Mar 29, 2024 • edited Loading

github-actions bot commented Jan 16, 2024 •

edited

Loading

cristiancardosodexcom commented Mar 28, 2024 •

edited

Loading

cristiancardosodexcom commented Mar 28, 2024 •

edited

Loading

pillo79 commented Mar 29, 2024 •

edited

Loading