fix(zigbee): Add lock in scanNetworks to avoid race condition #11792

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

Jump to bottom

Merged

me-no-dev merged 1 commit into master from fix/zigbee-network-scan

Sep 4, 2025

Merged

fix(zigbee): Add lock in scanNetworks to avoid race condition #11792

me-no-dev merged 1 commit into master from fix/zigbee-network-scan

Sep 4, 2025

+6 −0

Conversation

P-R-O-C-H-Y

Copy link

Member

@P-R-O-C-H-Y P-R-O-C-H-Y commented Sep 3, 2025

Description of Change

Improvements to scan management and thread safety:

Added a check to prevent initiating a new scan if one is already in progress, logging a warning and returning early in ZigbeeCore::scanNetworks (ZigbeeCore.cpp).
Wrapped the scan request call with esp_zb_lock_acquire and esp_zb_lock_release to ensure thread safety when starting a Zigbee network scan (ZigbeeCore.cpp).

Test Scenarios

Tested using the ScanNetworks example.

Related links

Closes #10879

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


 fix(zigbee): Add lock in scanNetworks to avoid race condition

91ba3b5

@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 Type: Bug 🐛 Status: Review needed labels

Sep 3, 2025

@P-R-O-C-H-Y P-R-O-C-H-Y added this to Arduino ESP32 Core Project Roadmap

Sep 3, 2025

@P-R-O-C-H-Y P-R-O-C-H-Y added the Area: Zigbee label

Sep 3, 2025

@github-project-automation github-project-automation bot moved this to Todo in Arduino ESP32 Core Project Roadmap

Sep 3, 2025

@P-R-O-C-H-Y P-R-O-C-H-Y requested review from me-no-dev and lucasssvaz

September 3, 2025 14:01

@github-actions GitHub Actions

Copy link

Contributor

github-actions bot commented Sep 3, 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 91ba3b5

@github-actions GitHub Actions

Copy link

Contributor

github-actions bot commented Sep 3, 2025 •

edited

Loading

Test Results

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

Results for commit 91ba3b5.

♻️ This comment has been updated with latest results.

lucasssvaz

lucasssvaz approved these changes

Sep 3, 2025

View reviewed changes

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

Memory	FLASH [bytes]		FLASH [%]		RAM [bytes]		RAM [%]
Target	DEC	INC	DEC	INC	DEC	INC	DEC	INC
ESP32C5	0	0	0.00	0.00	0	0	0.00	0.00
ESP32S3	0	0	0.00	0.00	0	0	0.00	0.00
ESP32S2	0	0	0.00	0.00	0	0	0.00	0.00
ESP32C3	0	0	0.00	0.00	0	0	0.00	0.00
ESP32C6	0	0	0.00	0.00	0	0	0.00	0.00
ESP32H2	0	0	0.00	0.00	0	0	0.00	0.00
ESP32	0	0	0.00	0.00	0	0	0.00	0.00

Click to expand the detailed deltas report [usage change in BYTES]

Target	ESP32C5		ESP32S3		ESP32S2		ESP32C3		ESP32C6		ESP32H2		ESP32
Example	FLASH	RAM	FLASH	RAM	FLASH	RAM	FLASH	RAM	FLASH	RAM	FLASH	RAM	FLASH	RAM
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	-	-	-	-	-	-	-	-	-	-	-	-	-	-