Skip to content

feat(zigbee): Add stop/start methods + add missing license headers #11791

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 4, 2025
Merged

feat(zigbee): Add stop/start methods + add missing license headers #11791

merged 3 commits into from
Sep 4, 2025

Conversation

P-R-O-C-H-Y
Copy link
Member

Description of Change

This pull request introduces new lifecycle management capabilities to the Zigbee stack, allowing it to be started and stopped programmatically. It also adds standardized Apache 2.0 license headers to all Zigbee source files for improved legal compliance and clarity. The documentation is updated to reflect the new API methods.

  • Added start() and stop() methods to the ZigbeeCore class, enabling the Zigbee stack to be paused and resumed as needed. These methods update the internal state and suspend or resume the main Zigbee task accordingly (libraries/Zigbee/src/ZigbeeCore.cpp, libraries/Zigbee/src/ZigbeeCore.h). [1] [2]
  • Updated documentation to describe the new start() and stop() methods, including example usage and scenarios for stopping the stack (e.g., saving power or freeing the radio for other tasks) (docs/en/zigbee/zigbee_core.rst).

Test Scenarios

Tested using edited Zigbee example and HomeAssistant.
After stopping and starting again, device continue to work normally.

Related links

Closes #10871

@P-R-O-C-H-Y P-R-O-C-H-Y self-assigned this Sep 3, 2025
@P-R-O-C-H-Y P-R-O-C-H-Y added Status: Review needed Issue or PR is awaiting review Area: Zigbee Issues and Feature Request about Zigbee labels Sep 3, 2025
@github-actions GitHub Actions
Copy link
Contributor

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

Messages
📖 🎉 Good Job! All checks are passing!

👋 Hello P-R-O-C-H-Y, 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.
- 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 70ff6a3

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Sep 3, 2025

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
ESP32C5000.000.00000.000.00
ESP32S3000.000.00000.000.00
ESP32S2000.000.00000.000.00
ESP32C3000.000.00000.000.00
ESP32C6000.000.00000.000.00
ESP32H2000.000.00000.000.00
ESP32000.000.00000.000.00
Click to expand the detailed deltas report [usage change in BYTES]
TargetESP32C5ESP32S3ESP32S2ESP32C3ESP32C6ESP32H2ESP32
ExampleFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAM
libraries/Zigbee/examples/Zigbee_Analog_Input_Output--------------
libraries/Zigbee/examples/Zigbee_Binary_Input--------------
libraries/Zigbee/examples/Zigbee_CarbonDioxide_Sensor--------------
libraries/Zigbee/examples/Zigbee_Color_Dimmable_Light--------------
libraries/Zigbee/examples/Zigbee_Color_Dimmer_Switch--------------
libraries/Zigbee/examples/Zigbee_Contact_Switch--------------
libraries/Zigbee/examples/Zigbee_Dimmable_Light--------------
libraries/Zigbee/examples/Zigbee_Electrical_AC_Sensor--------------
libraries/Zigbee/examples/Zigbee_Electrical_AC_Sensor_MultiPhase--------------
libraries/Zigbee/examples/Zigbee_Electrical_DC_Sensor--------------
libraries/Zigbee/examples/Zigbee_Fan_Control--------------
libraries/Zigbee/examples/Zigbee_Gateway--------------
libraries/Zigbee/examples/Zigbee_Illuminance_Sensor--------------
libraries/Zigbee/examples/Zigbee_OTA_Client--------------
libraries/Zigbee/examples/Zigbee_Occupancy_Sensor--------------
libraries/Zigbee/examples/Zigbee_On_Off_Light--------------
libraries/Zigbee/examples/Zigbee_On_Off_MultiSwitch--------------
libraries/Zigbee/examples/Zigbee_On_Off_Switch--------------
libraries/Zigbee/examples/Zigbee_PM25_Sensor--------------
libraries/Zigbee/examples/Zigbee_Power_Outlet--------------
libraries/Zigbee/examples/Zigbee_Pressure_Flow_Sensor--------------
libraries/Zigbee/examples/Zigbee_Range_Extender--------------
libraries/Zigbee/examples/Zigbee_Scan_Networks--------------
libraries/Zigbee/examples/Zigbee_Temp_Hum_Sensor_Sleepy--------------
libraries/Zigbee/examples/Zigbee_Temperature_Sensor--------------
libraries/Zigbee/examples/Zigbee_Thermostat--------------
libraries/Zigbee/examples/Zigbee_Vibration_Sensor--------------
libraries/Zigbee/examples/Zigbee_Wind_Speed_Sensor--------------
libraries/Zigbee/examples/Zigbee_Window_Covering--------------

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Sep 3, 2025

Test Results

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

Results for commit 2a04b1a.

@me-no-dev me-no-dev added Status: Pending Merge Pull Request is ready to be merged and removed Status: Review needed Issue or PR is awaiting review labels Sep 4, 2025
@me-no-dev me-no-dev merged commit adac4c2 into master Sep 4, 2025
46 checks passed
@me-no-dev me-no-dev deleted the feat/zigbee-start-stop branch September 4, 2025 06:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pedrominatel pedrominatel pedrominatel approved these changes

@me-no-dev me-no-dev me-no-dev approved these changes

@lucasssvaz lucasssvaz lucasssvaz approved these changes

@SuGlider SuGlider Awaiting requested review from SuGlider

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
Arduino ESP32 Core Project Roadmap
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

ESP32-C6 Zigbee and wifi AP and STA error
4 participants
@P-R-O-C-H-Y @pedrominatel @me-no-dev @lucasssvaz