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.

Sign up for GitHub

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

Jump to bottom

Old/incorrect info in examples/system/deep_sleep/README.md (IDFGH-12305) #13340

Closed
3 tasks done
prabbit237 opened this issue Mar 8, 2024 · 1 comment
Closed
3 tasks done

Old/incorrect info in examples/system/deep_sleep/README.md (IDFGH-12305) #13340

prabbit237 opened this issue Mar 8, 2024 · 1 comment
Assignees
@ESP-Marius
Labels
Resolution: NA Issue resolution is unavailable Status: Done Issue is done internally

Comments

@prabbit237
Copy link

Answers checklist.

  • I have read the documentation ESP-IDF Programming Guide and the issue is not addressed there.
  • I have updated my IDF branch (master or release) to the latest version and checked that the issue is present there.
  • I have searched the issue tracker for a similar issue and not found a similar issue.

General issue report

The README.md in examples/system/deep_sleep has the following:

ULP: Ultra Low Power Coprocessor which can continue to run during deep sleep. This example utilizes the ULP and constantly sample the chip's temperature and trigger a wake up if the chips temperature exceeds ~5 degrees Celsius.

But the actual code in the example files does not have anything about the ULP and waking from deep sleep. That seems to have been removed sometime around release/v5.0.
@espressif-bot espressif-bot added the Status: Opened Issue is new label Mar 8, 2024
@github-actions github-actions bot changed the title Old/incorrect info in examples/system/deep_sleep/README.md Old/incorrect info in examples/system/deep_sleep/README.md (IDFGH-12305) Mar 8, 2024
@ESP-Marius
Copy link
Collaborator

You're right, seems like we missed this. We'll update the docs to reflect this!

@espressif-bot espressif-bot assigned 0xjakob and ESP-Marius and unassigned 0xjakob Mar 11, 2024
@espressif-bot espressif-bot added Status: Reviewing Issue is being reviewed Status: Done Issue is done internally Resolution: NA Issue resolution is unavailable and removed Status: Opened Issue is new Status: Reviewing Issue is being reviewed labels Mar 11, 2024
espressif-bot pushed a commit that referenced this issue Mar 15, 2024
@ESP-Marius
docs(deep_sleep): removed mentions of ULP in deep sleep example readme
3814288 
Updated readme to reflect that ULP is no longer a part of this examples
functionality.

Closes #13340
espressif-bot pushed a commit that referenced this issue Mar 15, 2024
@ESP-Marius
docs(deep_sleep): removed mentions of ULP in deep sleep example readme
af31783 
Updated readme to reflect that ULP is no longer a part of this examples
functionality.

Closes #13340
DarkZeros pushed a commit to DarkZeros/esp-idf that referenced this issue May 3, 2024
@ESP-Marius @DarkZeros
docs(deep_sleep): removed mentions of ULP in deep sleep example readme
0d90a63 
Updated readme to reflect that ULP is no longer a part of this examples
functionality.

Closes espressif#13340
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ESP-Marius ESP-Marius

Labels
Resolution: NA Issue resolution is unavailable Status: Done Issue is done internally
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@0xjakob @prabbit237 @ESP-Marius @espressif-bot