Deep Sleep Example Fix #9904

SuGlider · 2024-06-19T14:20:22Z

Description of Change

IDF 5.1 has changed the way how RTC IO shall be configured in order to make it work as Wakeup source.
This PR fixes the example to work within Arduino Core 3.0.x that uses IDF 5.1.

Tests scenarios

Using ESP32 + the example provided. Tested using EXT0 and EXT1.

Test Results

56 files 56 suites 5m 18s ⏱️
21 tests 21 ✅ 0 💤 0 ❌
135 runs 135 ✅ 0 💤 0 ❌

Results for commit d367d39.

♻️ This comment has been updated with latest results.

github-actions · 2024-06-19T14:21:03Z

	Warnings
⚠️	Some issues found for the commit messages in this PR: the commit message `"fix(example): EXT0 and EXT1 wakeup"`: body's lines must not be longer than 100 characters 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).

	Messages
📖	You might consider squashing your 4 commits (simplifying branch history).

👋 Hello SuGlider, 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.
- Addressing info messages (📖) is strongly recommended; they're less critical but valuable.
- 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 d367d39

libraries/ESP32/examples/DeepSleep/ExternalWakeUp/ExternalWakeUp.ino

Fixes the commentary to the correct IDF terms.

github-actions · 2024-06-19T14:26:14Z

Memory usage test (comparing PR against master branch)

The table below shows the summary of memory usage change (decrease - increase) in bytes and percentage for each target.

Memory	FLASH [bytes]		FLASH [%]		RAM [bytes]		RAM [%]
Target	DEC	INC	DEC	INC	DEC	INC	DEC	INC
ESP32S3	0	⚠️ +368	0.00	⚠️ +0.13	0	0	0.00	0.00
ESP32S2	0	⚠️ +320	0.00	⚠️ +0.12	0	0	0.00	0.00
ESP32	0	⚠️ +12	0.00	0.00	0	0	0.00	0.00

Click to expand the detailed deltas report [usage change in BYTES]

Target	ESP32S3		ESP32S2		ESP32
Example	FLASH	RAM	FLASH	RAM	FLASH	RAM
ESP32/examples/DeepSleep/ExternalWakeUp	⚠️ +368	0	⚠️ +320	0	⚠️ +12	0

pfeerick · 2024-07-18T09:46:09Z

Is that actually correct?

With ESP-IDF 5.0.4, it is still esp_sleep_enable_ext1_wakeup()

With ESP-IDF 5.1.4, it is still esp_sleep_enable_ext1_wakeup()

Whereas ESP-IDF 5.2.x introduces esp_sleep_enable_ext1_wakeup_io(), but esp_sleep_enable_ext1_wakeup() is nonetheless still present, but with a depreciation notice for v6. This is also the case for the "release-v5.1" documentation.

SuGlider · 2024-08-02T00:15:27Z

Arduino 3.0.x is based on IDF 5.1.x exclusively.
No support for IDF 5.0.x or 5.2.x.

pfeerick · 2024-08-02T01:04:33Z

Exactly... which is why this PR seems incorrect... 🤦 it is using 5.2.x syntax, not 5.1.x syntax. esp_sleep_enable_ext1_wakeup_io() is not correct for 5.1, hence my comment.

P-R-O-C-H-Y · 2024-08-02T08:15:03Z

Exactly... which is why this PR seems incorrect... 🤦 it is using 5.2.x syntax, not 5.1.x syntax. esp_sleep_enable_ext1_wakeup_io() is not correct for 5.1, hence my comment.

@pfeerick Take a look at the IDF docs, where esp_sleep_enable_ext1_wakeup_io() is already available for release/v5.1.

pfeerick · 2024-08-02T09:22:16Z

Ok, thanks for pointing that out. Any idea what is actually different between the two, as I was expecting 5.1.4 to be the latest release for 5.1, not this release/v5.1. What is the release structure here?

SuGlider · 2024-08-02T18:51:01Z

Maybe the documentation for 5.1.4 is incomplete.
5.1 is the major and latest version, which also is, at this time, 5.1.4.
Arduino Core 3.0.0 .. 3.0.4 are all based on IDF 5.1.4.

pfeerick · 2024-08-03T10:21:42Z

Ok, I see the problem I think... 5.1.4 was released 3 months ago... whereas this is relying on changes made to 5.1 branch since then which haven't made it to a tagged release. I was clearly mistaken expecting the changes made here to be based on a tagged release, not a moving target release branch 😢 This all started as I was trying to build using actual 5.1.4, and the compiler said no. The documentation is correct, simply 5.1.4 is the wrong version! 😆

i.e. tagged 5.1.4

vs release/5.1 (which displays as 5.1.4 since the version number hasn't been bumped)

SuGlider · 2024-08-03T23:17:46Z

Thanks @pfeerick for and investigation. I guess we can keep the PR. Please let me know if you have any other disagreement.

SuGlider added 2 commits June 19, 2024 11:12

fix(example): EXT0 and EXT1 wakeup

cd26220

Fixes the Deep Sleep wakup example to run with IDF5.1. The API has changed and a adjustment was necessary.

feat(wakeup): Use Macro for GPIO_NUM

8899c36

Changed the example to use a #define for the RTC IO Pin (GPIO) used in the example.

SuGlider added the Type: Example Issue is related to specific example. label Jun 19, 2024

SuGlider added this to the 3.0.2 milestone Jun 19, 2024

SuGlider self-assigned this Jun 19, 2024

SuGlider commented Jun 19, 2024

View reviewed changes

libraries/ESP32/examples/DeepSleep/ExternalWakeUp/ExternalWakeUp.ino Outdated Show resolved Hide resolved

fix(typo): typo and commentaries

d1a8bf6

Fixes the commentary to the correct IDF terms.

SuGlider mentioned this pull request Jun 19, 2024

External wake up ext1 problem #9809

Closed

1 task

me-no-dev approved these changes Jun 19, 2024

View reviewed changes

me-no-dev added the Status: Pending Merge Pull Request is ready to be merged label Jun 19, 2024

SuGlider requested review from lucasssvaz and P-R-O-C-H-Y June 19, 2024 14:32

ci(pre-commit): Apply automatic fixes

d367d39

P-R-O-C-H-Y approved these changes Jun 19, 2024

View reviewed changes

lucasssvaz approved these changes Jun 19, 2024

View reviewed changes

me-no-dev merged commit 206c0c7 into master Jun 19, 2024
39 checks passed

me-no-dev deleted the deepsleep branch June 19, 2024 16:19

This was referenced Dec 19, 2024

error: 'esp_sleep_enable_ext1_wakeup_io' was not declared in this scope #10761

Closed

error: 'esp_sleep_enable_ext1_wakeup_io' was not declared in this scope platformio/platform-espressif32#1521

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Deep Sleep Example Fix #9904

Deep Sleep Example Fix #9904

SuGlider commented Jun 19, 2024

github-actions bot commented Jun 19, 2024 •

edited

Loading

github-actions bot commented Jun 19, 2024 •

edited

Loading

github-actions bot commented Jun 19, 2024

pfeerick commented Jul 18, 2024 •

edited

Loading

SuGlider commented Aug 2, 2024

pfeerick commented Aug 2, 2024 •

edited

Loading

P-R-O-C-H-Y commented Aug 2, 2024

pfeerick commented Aug 2, 2024

SuGlider commented Aug 2, 2024

pfeerick commented Aug 3, 2024 •

edited

Loading

SuGlider commented Aug 3, 2024

Deep Sleep Example Fix #9904

Deep Sleep Example Fix #9904

Conversation

SuGlider commented Jun 19, 2024

Description of Change

Tests scenarios

Related links

github-actions bot commented Jun 19, 2024 • edited Loading

Test Results

github-actions bot commented Jun 19, 2024 • edited Loading

github-actions bot commented Jun 19, 2024

Memory usage test (comparing PR against master branch)

pfeerick commented Jul 18, 2024 • edited Loading

SuGlider commented Aug 2, 2024

pfeerick commented Aug 2, 2024 • edited Loading

P-R-O-C-H-Y commented Aug 2, 2024

pfeerick commented Aug 2, 2024

SuGlider commented Aug 2, 2024

pfeerick commented Aug 3, 2024 • edited Loading

SuGlider commented Aug 3, 2024

github-actions bot commented Jun 19, 2024 •

edited

Loading

github-actions bot commented Jun 19, 2024 •

edited

Loading

pfeerick commented Jul 18, 2024 •

edited

Loading

pfeerick commented Aug 2, 2024 •

edited

Loading

pfeerick commented Aug 3, 2024 •

edited

Loading