Update documentation with info about light sleep#2088
Conversation
UncleGrumpy
left a comment
UncleGrumpy
left a comment
There was a problem hiding this comment.
I hadn’t noticed before, but since there are no build configuration options for sleep, this section seems better suited for the Programmers Guide. What do you think?
doc/src/build-instructions.md
Outdated
| The higher the speed, the faster the PSRAM will be, at the cost of higher power usage, but not all PSRAM chips support higher speeds. | ||
|
|
||
| #### Sleep mode - Deep sleep | ||
| #### Sleep mode - Deep sleep and Light sleep |
There was a problem hiding this comment.
It doesn’t seem as if there are any build configuration settings required for the sleep modes… this whole section seems more appropriate for the Programmers guide than the Build Instructions. I had not caught on to this befnow.
There was a problem hiding this comment.
I did a more extensive reorganization.
bettio
force-pushed
the
doc-update-esp32-sleep
branch
from
45187f9 to
dd12033
Compare
After atomvm#1789 (and the subsequent forward port from release-0.6), light sleep has been merged in main. Update newer documentation accordingly. Signed-off-by: Davide Bettio <davide@uninstall.it>
bettio
force-pushed
the
doc-update-esp32-sleep
branch
from
dd12033 to
f9c767e
Compare
UncleGrumpy
left a comment
UncleGrumpy
left a comment
There was a problem hiding this comment.
This is much better organized. Just one out of date link to Espressifs docs.
| * `error` (unknown other reason) | ||
|
|
||
| The values matches the semantics of [`esp_sleep_get_wakeup_cause`](https://docs.espressif.com/projects/esp-idf/en/release-v4.4/esp32/api-reference/system/sleep_modes.html#_CPPv426esp_sleep_get_wakeup_causev). | ||
| The values match the semantics of [`esp_sleep_get_wakeup_cause`](https://docs.espressif.com/projects/esp-idf/en/release-v4.4/esp32/api-reference/system/sleep_modes.html#_CPPv426esp_sleep_get_wakeup_causev). |
There was a problem hiding this comment.
We should update the link to a currently supported IDF docs version. 4.4 > 5.5
|
Since we always stay up to date with the latest ESP-IDF, we might consider linking to “latest” in the IDF docs, so we aren’t constantly chasing down dead/old links in our docs. |
Sounds right, I will run a find & replace on the entire codebase. |
3 participants
After #1789 (and the subsequent forward port from release-0.6), light sleep has been introduced in main.
Update newer documentation accordingly.
These changes are made under both the "Apache 2.0" and the "GNU Lesser General
Public License 2.1 or later" license terms (dual license).
SPDX-License-Identifier: Apache-2.0 OR LGPL-2.1-or-later