PowerManagement support #9083

tshcherban · 2024-01-09T11:28:33Z

Description of Change

Enables Power Management support for arduino sketches.

API changes

Extended WiFi.setSleep function to accept listenInterval
Added setAutomaticLightSleep function to enable/disable automatic LightSleep (without changing the CPU frequency)

Tests scenarios

Tested WiFi connectivity, BLE scanning, OneWire, TwoWire, SPI, Serial on ESP32, ESP32-S3, ESP32-C3 boards.

Related links

Solves #6563 partially

github-actions · 2024-01-09T11:29:09Z

	Warnings
⚠️	Please consider squashing your 28 commits (simplifying branch history).

👋 Hello tshcherban, 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 07046f8

tshcherban · 2024-01-09T11:45:13Z

@SuGlider @VojtechBartoska is it possible to migrate from patching SDK-Config in github actions to just copy corresponding sdkconfig.defaults.target? that would be a bit more easy editing defaults, separate them for different targets and reuse for some other purposes (i.e. copy for examples, use in CMake build checks).

CLAassistant · 2024-01-09T12:10:27Z

All committers have signed the CLA.

SuGlider · 2024-01-09T20:14:04Z

@SuGlider @VojtechBartoska is it possible to migrate from patching SDK-Config in github actions to just copy corresponding sdkconfig.defaults.target? that would be a bit more easy editing defaults, separate them for different targets and reuse for some other purposes (i.e. copy for examples, use in CMake build checks).

Actually we need to add this IDF sdkconfig changes to the Lib Builder scripts.
sdkconfig is used by Lib Builder to compile and build all IDF libraries, therefore, when using Arduino, all settings from sdkconfig are setled in the static IDF libs.

The only way to changed sdkconfig and test it is by using Arduino as IDF Component and then build some examples that will verify how PM and light sleep will work.

tshcherban · 2024-01-10T18:11:12Z

Found an issue IDFGH-11870 with IDF's UART implementation , it prevents UART usage with automatic llight sleep in some cases.
It would work if we have WiFi/BLE active or some other tasks, which prevents CPU for sleeping too long, however that not seems reliable.
Also I might have a fix for it, so waiting for the IDF maintainers response.

tshcherban · 2024-02-02T10:56:55Z

@igrr @VojtechBartoska @SuGlider for a BLE PowerManagement - i dont have ESP32 board with an external crystal, so for that part I would need your help in testing. On an ESP32S3 I'm planning to use Main XTAL as low power source by default.

SuGlider · 2024-02-14T16:32:26Z

@tshcherban -
On top of this PR, I'd like to work on an API that will allow the user to set the source clock too.

This is part of another Task which also wants to add Power Management feature based on automatic Dynamic Frequency Scaling (DFS). The proposal is that the user will be able to set the Clock Source for each peripheral and also set it in a Global way whenever necessary in order to increase DFS applicability.

This should be ready for Arduino 3.0.0 final release.
Is that OK for you?

tshcherban · 2024-02-14T16:50:11Z

Yes, for sure.
Do i need to grant you an access to my repository? so all the changes come from the one codebase.
P.S. however i didnt noticed too much gain from DFS enabled, while just changing modem sleep pattern to the MAX_MODEM and enabling automatic light sleep improved the things significantly.
Also please beware we still have a bug coming from IDF uart implementation, which can lead sometimes to a dedlock (workaroundable via Serial.Flush call).

github-actions · 2024-06-06T08:50:59Z

Test Results

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

Results for commit 205db45.

♻️ This comment has been updated with latest results.

atanisoft · 2024-08-01T12:27:03Z

libraries/WiFi/src/WiFiGeneric.h

+  /**
+  * @brief Set modem sleep state
+  * @param sleepType Modem sleep type, one of WIFI_PS_NONE, WIFI_PS_MIN_MODEM, WIFI_PS_MAX_MODEM
+  * @param listenInterval Listen interval for ESP32 station to receive beacon when WIFI_PS_MAX_MODEM is set. Units: AP beacon intervals. Defaults to 3 if set to 0.


it would be good to indicate the units of this parameter. As written it could be interpreted as milliseconds, seconds, minutes, etc.

Unit is specified here (AP beacon intervals). It is determined by the access point parameters, I've often seen a 102400us value during testing with different routers, however it can differ.

safocl · 2024-09-24T20:34:46Z

API and its comments are incompatible:

bool setAutomaticLightSleep(bool enabled);

and

/**
 * @brief Set automatic light sleep state. CPU will go into light sleep if no ongoing activity (active task, peripheral activity etc.)
 * @param enabled true to enable automatic lightSleep
 * @return
 *      - ESP_OK on success
 *      - ESP_ERR_NOT_SUPPORTED if CONFIG_PM_ENABLE is not enabled in sdkconfig
 */

return type is bool (not [esp_return_type])

safocl · 2024-09-24T21:01:34Z

libraries/WiFi/src/WiFiGeneric.cpp

+        return false;
+
+    wifi_config_t current_conf;
+    if(esp_wifi_get_config((wifi_interface_t)ESP_IF_WIFI_STA, &current_conf) != ESP_OK){


from
(wifi_interface_t)ESP_IF_WIFI_STA
to
wifi_interface_t::WIFI_IF_STA
?

safocl · 2024-09-24T21:05:21Z

cores/esp32/esp32-hal-cpu.c

+
+bool setAutomaticLightSleep(bool enabled)
+{
+    uint32_t cpuFreq = getCpuFrequencyMhz();


from

uint32_t cpuFreq = getCpuFrequencyMhz();

to

const uint32_t cpuFreq = getCpuFrequencyMhz();

?

safocl · 2024-09-24T21:07:28Z

libraries/WiFi/src/WiFiGeneric.cpp

+
+    current_conf.sta.listen_interval = listenInterval;
+
+    if(esp_wifi_set_config((wifi_interface_t)ESP_IF_WIFI_STA, &current_conf) != ESP_OK){


from
(wifi_interface_t)ESP_IF_WIFI_STA
to
wifi_interface_t::WIFI_IF_STA
?

tshcherban added 2 commits January 9, 2024 13:17

ci(esp32): Added PM_ENABLE to sdkconfig.defaults

298b7a3

ci(esp32): Added CONFIG_FREERTOS_USE_TICKLESS_IDLE to sdkconfig.defaults

8e5c957

VojtechBartoska requested a review from SuGlider January 9, 2024 11:33

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

feat(esp32): Add automatic lightSleep and WiFi listenInterval APIs

1511552

tshcherban added 3 commits January 11, 2024 15:45

feat(wifi): Add WiFi automatic LightSleep example

3277229

feat(wifi): wifi credentials remove

1518743

feat(esp32): add GPIO interrupts with automatic LightSleep enabled

c2af5fd

SuGlider self-assigned this Jan 13, 2024

tshcherban added 6 commits January 15, 2024 15:46

Merge branch 'master' into power-management

82eb3d5

Merge branch 'master' into power-management

ffae7e9

Merge branch 'master' into power-management

9374554

Merge branch 'master' into power-management

5a7576f

Merge branch 'master' into power-management

eb86e50

Merge branch 'master' into power-management

25fd651

VojtechBartoska added this to the 3.1.0 milestone Jan 30, 2024

tshcherban added 2 commits February 1, 2024 10:23

Merge branch 'master' into power-management

1575558

Merge branch 'master' into power-management

4375f4c

tshcherban and others added 5 commits February 6, 2024 09:31

Merge branch 'master' into power-management

1b9474a

Merge branch 'master' into power-management

0b0698a

Merge branch 'master' into power-management

1ea4eea

Merge branch 'master' into power-management

d3c132b

Merge branch 'master' into power-management

ea7400f

VojtechBartoska added Status: In Progress Issue is in progress and removed Status: Review needed Issue or PR is awaiting review labels Feb 19, 2024

lucasssvaz and others added 4 commits February 23, 2024 08:58

Merge branch 'master' into power-management

096e5cb

Merge branch 'master' into power-management

45577bd

Merge branch 'master' into power-management

c58bc28

Merge branch 'master' into power-management

9166bc0

me-no-dev added the Status: Blocked upstream 🛑 PR is waiting on upstream changes to be merged first label Apr 15, 2024

tshcherban added 2 commits April 17, 2024 10:43

Merge branch 'master' into power-management

40702b2

Merge branch 'master' into power-management

80bcb52

Merge branch 'master' into power-management

205db45

atanisoft reviewed Aug 1, 2024

View reviewed changes

tshcherban added 2 commits August 2, 2024 08:12

Merge branch 'master' into power-management

9b93762

Merge branch 'master' into power-management

07046f8

tshcherban mentioned this pull request Aug 13, 2024

Investigate supporting power management in arduino-esp32 (DFS + tickless idle) #6563

Open

3 tasks

safocl reviewed Sep 24, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

PowerManagement support #9083

PowerManagement support #9083

tshcherban commented Jan 9, 2024 •

edited

Loading

github-actions bot commented Jan 9, 2024 •

edited

Loading

tshcherban commented Jan 9, 2024 •

edited

Loading

CLAassistant commented Jan 9, 2024 •

edited

Loading

SuGlider commented Jan 9, 2024

tshcherban commented Jan 10, 2024 •

edited

Loading

tshcherban commented Feb 2, 2024 •

edited

Loading

SuGlider commented Feb 14, 2024

tshcherban commented Feb 14, 2024 •

edited

Loading

github-actions bot commented Jun 6, 2024 •

edited

Loading

atanisoft Aug 1, 2024

tshcherban Sep 25, 2024

safocl commented Sep 24, 2024 •

edited

Loading

safocl Sep 24, 2024

safocl Sep 24, 2024

safocl Sep 24, 2024


		current_conf.sta.listen_interval = listenInterval;

		if(esp_wifi_set_config((wifi_interface_t)ESP_IF_WIFI_STA, &current_conf) != ESP_OK){

PowerManagement support #9083

Are you sure you want to change the base?

PowerManagement support #9083

Conversation

tshcherban commented Jan 9, 2024 • edited Loading

Description of Change

API changes

Tests scenarios

Related links

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

tshcherban commented Jan 9, 2024 • edited Loading

CLAassistant commented Jan 9, 2024 • edited Loading

SuGlider commented Jan 9, 2024

tshcherban commented Jan 10, 2024 • edited Loading

tshcherban commented Feb 2, 2024 • edited Loading

SuGlider commented Feb 14, 2024

tshcherban commented Feb 14, 2024 • edited Loading

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

Test Results

atanisoft Aug 1, 2024

Choose a reason for hiding this comment

tshcherban Sep 25, 2024

Choose a reason for hiding this comment

safocl commented Sep 24, 2024 • edited Loading

safocl Sep 24, 2024

Choose a reason for hiding this comment

safocl Sep 24, 2024

Choose a reason for hiding this comment

safocl Sep 24, 2024

Choose a reason for hiding this comment

tshcherban commented Jan 9, 2024 •

edited

Loading

github-actions bot commented Jan 9, 2024 •

edited

Loading

tshcherban commented Jan 9, 2024 •

edited

Loading

CLAassistant commented Jan 9, 2024 •

edited

Loading

tshcherban commented Jan 10, 2024 •

edited

Loading

tshcherban commented Feb 2, 2024 •

edited

Loading

tshcherban commented Feb 14, 2024 •

edited

Loading

github-actions bot commented Jun 6, 2024 •

edited

Loading

safocl commented Sep 24, 2024 •

edited

Loading