Skip to content

fix(zigbee): Replace assert with error log to solve immediate crash #11614

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

Merged
merged 2 commits into from
Jul 21, 2025

Conversation

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

@P-R-O-C-H-Y P-R-O-C-H-Y commented Jul 19, 2025

Description of Change

Replace ESP_ERROR_CHECK with proper error handling to prevent system crashes when esp_zb_bdb_start_top_level_commissioning() returns ESP_FAIL due to invalid commissioning state (can be in progress). This allows the existing retry mechanism to continue working while providing better error logging instead of assertion failures.

Same way its now done in esp-zigbee-sdk examples:

static void bdb_start_top_level_commissioning_cb(uint8_t mode_mask)
{
    ESP_RETURN_ON_FALSE(esp_zb_bdb_start_top_level_commissioning(mode_mask) == ESP_OK, , TAG, "Failed to start Zigbee commissioning");
}

Tests scenarios

Tested using some Zigbee example with rebooting many times.

Related links

Closes #11554

@P-R-O-C-H-Y P-R-O-C-H-Y added this to the 3.3.0 milestone Jul 19, 2025
@P-R-O-C-H-Y P-R-O-C-H-Y self-assigned this Jul 19, 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 Jul 19, 2025
Copy link
Contributor

github-actions bot commented Jul 19, 2025

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 c60654c

Copy link
Contributor

github-actions bot commented Jul 19, 2025

Test Results

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

Results for commit c60654c.

♻️ This comment has been updated with latest results.

Copy link
Contributor

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
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]
TargetESP32S3ESP32S2ESP32C3ESP32C6ESP32H2ESP32
ExampleFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAM
libraries/Zigbee/examples/Zigbee_Analog_Input_Output------------
libraries/Zigbee/examples/Zigbee_Color_Dimmer_Switch------------
libraries/Zigbee/examples/Zigbee_Electrical_AC_Sensor------------
libraries/Zigbee/examples/Zigbee_Electrical_AC_Sensor_MultiPhase------------
libraries/Zigbee/examples/Zigbee_Fan_Control------------
libraries/Zigbee/examples/Zigbee_Gateway------------
libraries/Zigbee/examples/Zigbee_On_Off_Switch------------
libraries/Zigbee/examples/Zigbee_Range_Extender------------
libraries/Zigbee/examples/Zigbee_Thermostat------------
libraries/Zigbee/examples/Zigbee_Binary_Input------------
libraries/Zigbee/examples/Zigbee_CarbonDioxide_Sensor------------
libraries/Zigbee/examples/Zigbee_Color_Dimmable_Light------------
libraries/Zigbee/examples/Zigbee_Contact_Switch------------
libraries/Zigbee/examples/Zigbee_Dimmable_Light------------
libraries/Zigbee/examples/Zigbee_Electrical_DC_Sensor------------
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_PM25_Sensor------------
libraries/Zigbee/examples/Zigbee_Power_Outlet------------
libraries/Zigbee/examples/Zigbee_Pressure_Flow_Sensor------------
libraries/Zigbee/examples/Zigbee_Scan_Networks------------
libraries/Zigbee/examples/Zigbee_Temp_Hum_Sensor_Sleepy------------
libraries/Zigbee/examples/Zigbee_Temperature_Sensor------------
libraries/Zigbee/examples/Zigbee_Vibration_Sensor------------
libraries/Zigbee/examples/Zigbee_Wind_Speed_Sensor------------
libraries/Zigbee/examples/Zigbee_Window_Covering------------

Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR replaces an assertion-based error check with graceful error handling in the Zigbee commissioning callback to prevent system crashes when commissioning is already in progress.

  • Replaces ESP_ERROR_CHECK with conditional error logging to allow retry mechanisms to function
  • Prevents immediate crashes when esp_zb_bdb_start_top_level_commissioning() returns ESP_FAIL
  • Aligns implementation with current esp-zigbee-sdk examples

@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 Jul 21, 2025
@me-no-dev me-no-dev merged commit 995e603 into master Jul 21, 2025
56 checks passed
@me-no-dev me-no-dev deleted the fix/zigbee-crash-on-commisioning branch July 21, 2025 12:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Zigbee Issues and Feature Request about Zigbee Status: Pending Merge Pull Request is ready to be merged
Projects
Development

Successfully merging this pull request may close these issues.

Zigee Error - Crash
3 participants