Skip to content

Feat: OTA inhibit sleep #11836

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
Merged
merged 3 commits into from
Sep 16, 2025
Merged

Feat: OTA inhibit sleep #11836

merged 3 commits into from
Sep 16, 2025
+47 −0

Conversation

Rippanda12
Copy link
Contributor

Description of Change

OTA state change callback

Simple callback to the application to tell it that theres an ota, useful on sleepy devices as we don't want them to fall asleep mid update.

Implemented a basic sleep inhibitor example in Temp Hum Sensor Sleepy

Test Scenarios

Please describe on what Hardware and Software combinations you have tested this Pull Request and how.

ESP32-C6 + this PR + other project ive been working on for work but should work with the modified example of Temp Hum Sensor Sleepy

Related links

Please provide links to related issue, PRs etc.

Closes #11646

Additional stuff

Currently don't have the time or a free H2/C6 to test sleepy example so if possible @P-R-O-C-H-Y please test!

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Sep 15, 2025 •
edited
Loading

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "feat(zigbee examples): revert sleepy temp hum sensor instead add example to ota client":
    • scope/component should be lowercase without whitespace, allowed special characters are _ / . , * - .
  • the commit message "fix(zigbee example): copy paste error":
    • scope/component should be lowercase without whitespace, allowed special characters are _ / . , * - .

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

👋 Hello Rippanda12, we appreciate your contribution to this project!

📘 Please review the project's Contributions Guide for key guidelines on code, documentation, testing, and more.
🖊️ Please also make sure you have read and signed the Contributor License Agreement for 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 69e7d9c

@CLAassistant
Copy link

CLAassistant commented Sep 15, 2025 •
edited
Loading

CLA assistant check
All committers have signed the CLA.

@P-R-O-C-H-Y P-R-O-C-H-Y self-assigned this Sep 15, 2025
@P-R-O-C-H-Y P-R-O-C-H-Y added Status: Test needed Issue needs testing Status: Review needed Issue or PR is awaiting review labels Sep 15, 2025
@Rippanda12
Copy link
Contributor Author

Fixed commit message, this seems to be broken tho
image

@lucasssvaz
Copy link
Member

Fixed commit message, this seems to be broken tho image

It is taking a while to load on my PC but after a few minutes it eventually does.

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Sep 15, 2025 •
edited
Loading

Test Results

 76 files   76 suites   13m 9s ⏱️
 38 tests  38 ✅ 0 💤 0 ❌
241 runs  241 ✅ 0 💤 0 ❌

Results for commit 69e7d9c.

♻️ This comment has been updated with latest results.

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Sep 16, 2025 •
edited
Loading

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.

MemoryFLASH [bytes]FLASH [%]RAM [bytes]RAM [%]
TargetDECINCDECINCDECINCDECINC
ESP32C50⚠️ +2760.00⚠️ +0.04000.000.00
ESP32S30⚠️ +2360.00⚠️ +0.04000.000.00
ESP32S20⚠️ +2320.00⚠️ +0.04000.000.00
ESP32C30⚠️ +1120.00⚠️ +0.02000.000.00
ESP32C60⚠️ +2680.00⚠️ +0.04000.000.00
ESP32H20⚠️ +2760.00⚠️ +0.04000.000.00
ESP320⚠️ +2160.00⚠️ +0.03000.000.00
Click to expand the detailed deltas report [usage change in BYTES]
TargetESP32C5ESP32S3ESP32S2ESP32C3ESP32C6ESP32H2ESP32
ExampleFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAM
libraries/Zigbee/examples/Zigbee_Analog_Input_Output⚠️ +1120⚠️ +2360⚠️ +2160⚠️ +1120⚠️ +1120⚠️ +1120⚠️ +1880
libraries/Zigbee/examples/Zigbee_Binary_Input_Output⚠️ +1120------⚠️ +1120⚠️ +1120--
libraries/Zigbee/examples/Zigbee_CarbonDioxide_Sensor⚠️ +1120------⚠️ +1120⚠️ +1120--
libraries/Zigbee/examples/Zigbee_Color_Dimmable_Light⚠️ +1120------⚠️ +1120⚠️ +1120--
libraries/Zigbee/examples/Zigbee_Color_Dimmer_Switch⚠️ +1120⚠️ +2120⚠️ +2200⚠️ +1120⚠️ +1120⚠️ +1120⚠️ +2000
libraries/Zigbee/examples/Zigbee_Contact_Switch⚠️ +1120------⚠️ +1120⚠️ +1120--
libraries/Zigbee/examples/Zigbee_Dimmable_Light⚠️ +1120------⚠️ +1120⚠️ +1120--
libraries/Zigbee/examples/Zigbee_Electrical_AC_Sensor⚠️ +1120⚠️ +2160⚠️ +2320⚠️ +1120⚠️ +1120⚠️ +1120⚠️ +2160
libraries/Zigbee/examples/Zigbee_Electrical_AC_Sensor_MultiPhase⚠️ +1120⚠️ +2200⚠️ +2240⚠️ +1120⚠️ +1120⚠️ +1120⚠️ +2160
libraries/Zigbee/examples/Zigbee_Electrical_DC_Sensor⚠️ +1120------⚠️ +1120⚠️ +1120--
libraries/Zigbee/examples/Zigbee_Fan_Control⚠️ +1120⚠️ +2320⚠️ +2080⚠️ +1120⚠️ +1120⚠️ +1120⚠️ +1880
libraries/Zigbee/examples/Zigbee_Gateway⚠️ +1120⚠️ +2000⚠️ +2320⚠️ +1120----⚠️ +2120
libraries/Zigbee/examples/Zigbee_Illuminance_Sensor⚠️ +1120------⚠️ +1120⚠️ +1120--
libraries/Zigbee/examples/Zigbee_Multistate_Input_Output⚠️ +1120⚠️ +2080⚠️ +2200⚠️ +1120⚠️ +1120⚠️ +1120⚠️ +2000
libraries/Zigbee/examples/Zigbee_OTA_Client⚠️ +2760------⚠️ +2680⚠️ +2760--
libraries/Zigbee/examples/Zigbee_Occupancy_Sensor⚠️ +1120------⚠️ +1120⚠️ +1120--
libraries/Zigbee/examples/Zigbee_On_Off_Light⚠️ +1120------⚠️ +1120⚠️ +1120--
libraries/Zigbee/examples/Zigbee_On_Off_MultiSwitch⚠️ +1120⚠️ +2160⚠️ +2200⚠️ +1120⚠️ +1120⚠️ +1120⚠️ +2120
libraries/Zigbee/examples/Zigbee_On_Off_Switch⚠️ +1120⚠️ +2240⚠️ +2160⚠️ +1120⚠️ +1120⚠️ +1120⚠️ +1960
libraries/Zigbee/examples/Zigbee_PM25_Sensor⚠️ +1120------⚠️ +1120⚠️ +1120--
libraries/Zigbee/examples/Zigbee_Power_Outlet⚠️ +1120⚠️ +2240⚠️ +2120⚠️ +1120⚠️ +1120⚠️ +1120⚠️ +2040
libraries/Zigbee/examples/Zigbee_Pressure_Flow_Sensor⚠️ +1120------⚠️ +1200⚠️ +1120--
libraries/Zigbee/examples/Zigbee_Range_Extender⚠️ +1120⚠️ +2120⚠️ +2240⚠️ +1120⚠️ +1120⚠️ +1120⚠️ +2120
libraries/Zigbee/examples/Zigbee_Scan_Networks⚠️ +700------⚠️ +700⚠️ +700--
libraries/Zigbee/examples/Zigbee_Temp_Hum_Sensor_Sleepy⚠️ +1120------⚠️ +1120⚠️ +1120--
libraries/Zigbee/examples/Zigbee_Temperature_Sensor⚠️ +1120------⚠️ +1120⚠️ +1120--
libraries/Zigbee/examples/Zigbee_Thermostat⚠️ +1120⚠️ +2280⚠️ +2200⚠️ +1120⚠️ +1120⚠️ +1120⚠️ +2160
libraries/Zigbee/examples/Zigbee_Vibration_Sensor⚠️ +1120------⚠️ +1120⚠️ +1120--
libraries/Zigbee/examples/Zigbee_Wind_Speed_Sensor⚠️ +1120------⚠️ +1120⚠️ +1120--
libraries/Zigbee/examples/Zigbee_Window_Covering⚠️ +1120------⚠️ +1120⚠️ +1120--

@lucasssvaz lucasssvaz added Status: Pending Merge Pull Request is ready to be merged and removed Status: Review needed Issue or PR is awaiting review labels Sep 16, 2025
@P-R-O-C-H-Y P-R-O-C-H-Y added Area: Zigbee Issues and Feature Request about Zigbee Status: Pending Merge Pull Request is ready to be merged and removed Status: Pending Merge Pull Request is ready to be merged Status: Test needed Issue needs testing labels Sep 16, 2025
@me-no-dev me-no-dev merged commit 4361875 into espressif:master Sep 16, 2025
80 of 82 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lucasssvaz lucasssvaz lucasssvaz approved these changes

@P-R-O-C-H-Y P-R-O-C-H-Y P-R-O-C-H-Y approved these changes

+1 more reviewer

@Jason2866 Jason2866 Jason2866 left review comments

Reviewers whose approvals may not affect merge requirements
Assignees

@P-R-O-C-H-Y P-R-O-C-H-Y

Labels
Area: Zigbee Issues and Feature Request about Zigbee Status: Pending Merge Pull Request is ready to be merged
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Zigbee OTA status/state callback
6 participants
@Rippanda12 @CLAassistant @lucasssvaz @Jason2866 @P-R-O-C-H-Y @me-no-dev