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.

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

PowerManagement support #9083

Draft
wants to merge 28 commits into
base: master
Choose a base branch
from

Conversation

tshcherban
Copy link

@tshcherban tshcherban commented Jan 9, 2024

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

Copy link
Contributor

github-actions bot commented Jan 9, 2024

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

@VojtechBartoska VojtechBartoska added the Status: Review needed Issue or PR is awaiting review label Jan 9, 2024
@tshcherban
Copy link
Author

tshcherban commented Jan 9, 2024

@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
Copy link

CLAassistant commented Jan 9, 2024

CLA assistant check
All committers have signed the CLA.

@SuGlider
Copy link
Collaborator

SuGlider commented Jan 9, 2024

@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
Copy link
Author

tshcherban commented Jan 10, 2024

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.

@SuGlider SuGlider self-assigned this Jan 13, 2024
@VojtechBartoska VojtechBartoska added this to the 3.1.0 milestone Jan 30, 2024
@tshcherban
Copy link
Author

tshcherban commented Feb 2, 2024

@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
Copy link
Collaborator

@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
Copy link
Author

tshcherban commented Feb 14, 2024

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).

@VojtechBartoska VojtechBartoska added Status: In Progress Issue is in progress and removed Status: Review needed Issue or PR is awaiting review labels Feb 19, 2024
@me-no-dev me-no-dev added the Status: Blocked upstream 🛑 PR is waiting on upstream changes to be merged first label Apr 15, 2024
Copy link
Contributor

github-actions bot commented Jun 6, 2024

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.

/**
* @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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Contributor

safocl commented Sep 24, 2024

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])

return false;

wifi_config_t current_conf;
if(esp_wifi_get_config((wifi_interface_t)ESP_IF_WIFI_STA, &current_conf) != ESP_OK){
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

from
(wifi_interface_t)ESP_IF_WIFI_STA
to
wifi_interface_t::WIFI_IF_STA
?


bool setAutomaticLightSleep(bool enabled)
{
uint32_t cpuFreq = getCpuFrequencyMhz();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

from

uint32_t cpuFreq = getCpuFrequencyMhz();

to

const uint32_t cpuFreq = getCpuFrequencyMhz();

?


current_conf.sta.listen_interval = listenInterval;

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

from
(wifi_interface_t)ESP_IF_WIFI_STA
to
wifi_interface_t::WIFI_IF_STA
?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Blocked upstream 🛑 PR is waiting on upstream changes to be merged first Status: In Progress Issue is in progress
Projects
Status: Under investigation
Development

Successfully merging this pull request may close these issues.

8 participants