feat(zigbee): Add check, boolean returns, fix Analog, add optional reset on factoryReset #11153

P-R-O-C-H-Y · 2025-03-20T17:12:07Z

Description of Change

Fix memory leak
Updated almost all methods to return a boolean value and print error message with code and string of the error.
factoryReset method now have an optional parameter bool restart, by default its set to TRUE, but if false is passed, the Zigbee will just erase the nvram and the reset or reboot will need to be managed in user sketch. Example of how it can be used is the Temperature Humidity Sleepy example.
Simplified the AnalogSensor Endpoint -> removed AnalogValue, as its not commonly used in any device
Fixed AnalogSensor compilation warning message

Tests scenarios

Related links

github-actions · 2025-03-20T17:12:44Z

	Warnings
⚠️	Some issues found for the commit messages in this PR: the commit message `"fix(zigbee): Fix memory leak, print esp_zb_zcl_status_t error, remove analogValue from analog EP"`: summary appears to be too long the commit message `"fix(zigbee): Hope its finished now.."`: summary should not end with a period (full stop) the commit message `"fix/zigbee): Add missing return in WindowCovering"`: summary looks empty type/action looks empty 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).

	Messages
📖	This PR seems to be quite large (total lines of code: 1266), you might consider splitting it into smaller PRs

👋 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.
- Resolve all warnings (⚠️ ) before requesting a review from human reviewers - they will appreciate it.
- Addressing info messages (📖) is strongly recommended; they're less critical but valuable.
- 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 3bebb79

github-actions · 2025-03-20T17:16:59Z

Test Results

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

Results for commit 3bebb79.

♻️ This comment has been updated with latest results.

github-actions · 2025-03-20T17:24:25Z

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
ESP32S3	💚 -44	0	💚 -0.01	0.00	0	0	0.00	0.00
ESP32S2	💚 -52	0	💚 -0.01	0.00	0	0	0.00	0.00
ESP32C3	💚 -54	0	💚 -0.01	0.00	0	0	0.00	0.00
ESP32C6	💚 -88	⚠️ +432	💚 -0.02	⚠️ +0.08	0	0	0.00	0.00
ESP32H2	💚 -786	⚠️ +448	💚 -0.13	⚠️ +0.08	0	0	0.00	0.00
ESP32	💚 -52	0	💚 -0.01	0.00	0	0	0.00	0.00

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

Target	ESP32S3		ESP32S2		ESP32C3		ESP32C6		ESP32H2		ESP32
Example	FLASH	RAM	FLASH	RAM	FLASH	RAM	FLASH	RAM	FLASH	RAM	FLASH	RAM
libraries/Zigbee/examples/Zigbee_Color_Dimmer_Switch	💚 -44	0	💚 -52	0	💚 -54	0	💚 -54	0	💚 -54	0	💚 -52	0
libraries/Zigbee/examples/Zigbee_Gateway	💚 -4	0	💚 -4	0	💚 -32	0	-	-	-	-	💚 -20	0
libraries/Zigbee/examples/Zigbee_On_Off_Switch	💚 -28	0	💚 -16	0	💚 -30	0	💚 -28	0	💚 -30	0	💚 -28	0
libraries/Zigbee/examples/Zigbee_Range_Extender	💚 -20	0	0	0	💚 -42	0	💚 -42	0	💚 -38	0	💚 -20	0
libraries/Zigbee/examples/Zigbee_Thermostat	💚 -24	0	💚 -20	0	💚 -38	0	💚 -38	0	💚 -38	0	💚 -28	0
libraries/Zigbee/examples/Zigbee_Analog_Input_Output	-	-	-	-	-	-	💚 -88	0	💚 -88	0	-	-
libraries/Zigbee/examples/Zigbee_CarbonDioxide_Sensor	-	-	-	-	-	-	0	0	💚 -2	0	-	-
libraries/Zigbee/examples/Zigbee_Color_Dimmable_Light	-	-	-	-	-	-	💚 -28	0	💚 -28	0	-	-
libraries/Zigbee/examples/Zigbee_Contact_Switch	-	-	-	-	-	-	0	0	💚 -4	0	-	-
libraries/Zigbee/examples/Zigbee_Dimmable_Light	-	-	-	-	-	-	💚 -30	0	💚 -30	0	-	-
libraries/Zigbee/examples/Zigbee_Illuminance_Sensor	-	-	-	-	-	-	⚠️ +28	0	⚠️ +28	0	-	-
libraries/Zigbee/examples/Zigbee_OTA_Client	-	-	-	-	-	-	💚 -24	0	💚 -786	0	-	-
libraries/Zigbee/examples/Zigbee_Occupancy_Sensor	-	-	-	-	-	-	💚 -22	0	💚 -22	0	-	-
libraries/Zigbee/examples/Zigbee_On_Off_Light	-	-	-	-	-	-	💚 -34	0	💚 -30	0	-	-
libraries/Zigbee/examples/Zigbee_Pressure_Flow_Sensor	-	-	-	-	-	-	⚠️ +46	0	⚠️ +46	0	-	-
libraries/Zigbee/examples/Zigbee_Scan_Networks	-	-	-	-	-	-	0	0	0	0	-	-
libraries/Zigbee/examples/Zigbee_Temp_Hum_Sensor_Sleepy	-	-	-	-	-	-	⚠️ +432	0	⚠️ +448	0	-	-
libraries/Zigbee/examples/Zigbee_Temperature_Sensor	-	-	-	-	-	-	⚠️ +30	0	⚠️ +32	0	-	-
libraries/Zigbee/examples/Zigbee_Vibration_Sensor	-	-	-	-	-	-	💚 -26	0	💚 -26	0	-	-
libraries/Zigbee/examples/Zigbee_Wind_Speed_Sensor	-	-	-	-	-	-	⚠️ +2	0	⚠️ +2	0	-	-
libraries/Zigbee/examples/Zigbee_Window_Covering	-	-	-	-	-	-	⚠️ +10	0	⚠️ +10	0	-	-

me-no-dev · 2025-03-20T19:57:02Z

Please format errors like this:

  esp_err_t err = esp_wifi_set_max_tx_power(power);
  if (err != ESP_OK) {
    log_e("Failed to set TX Power: 0x%x: %s", err, esp_err_to_name(err));
  }

libraries/Zigbee/src/ZigbeeEP.cpp

SuGlider · 2025-03-27T02:53:11Z

@P-R-O-C-H-Y - please review the code in ZigbeeEP.cpp :: void ZigbeeEP::zbReadBasicCluster(const esp_zb_zcl_attribute_t *attribute). It has 2 malloc() with no correspondent free(). This will certainly cause memory leak.

Better think and review the whole zigbee code whenever using new or malloc.

SuGlider

From a fast code read, I understand that ZigbeeEP.cpp can cause memory leaks.
It may happen in other code files as well.

I recommend reviewing all places where new or malloc is used.

P-R-O-C-H-Y · 2025-03-27T11:26:00Z

Thanks @SuGlider, will take a look.

… analogValue from analog EP

lucasssvaz

LGTM

P-R-O-C-H-Y · 2025-03-27T16:29:50Z

All done now.

This reverts commit 8cf38c5.

feat(zigbee): Add checks on setting attrs and commands

508b6fa

P-R-O-C-H-Y added this to the 3.3.0 milestone Mar 20, 2025

P-R-O-C-H-Y added the Area: Zigbee Issues and Feature Request about Zigbee label Mar 20, 2025

P-R-O-C-H-Y self-assigned this Mar 20, 2025

Merge branch 'master' into feat/zigbee-commands-return-check

52b0e3a

P-R-O-C-H-Y added the Status: In Progress ⚠️ Issue is in progress label Mar 20, 2025

feat(zigbee): Add error info in the logs

80eba94

P-R-O-C-H-Y force-pushed the feat/zigbee-commands-return-check branch from 104a381 to 80eba94 Compare March 21, 2025 11:43

P-R-O-C-H-Y added Status: Review needed Issue or PR is awaiting review and removed Status: In Progress ⚠️ Issue is in progress labels Mar 24, 2025

P-R-O-C-H-Y marked this pull request as ready for review March 24, 2025 13:10

SuGlider reviewed Mar 27, 2025

View reviewed changes

libraries/Zigbee/src/ZigbeeEP.cpp Outdated Show resolved Hide resolved

SuGlider self-requested a review March 27, 2025 02:55

SuGlider requested changes Mar 27, 2025

View reviewed changes

me-no-dev marked this pull request as draft March 27, 2025 10:32

P-R-O-C-H-Y added Status: In Progress ⚠️ Issue is in progress and removed Status: Review needed Issue or PR is awaiting review labels Mar 27, 2025

P-R-O-C-H-Y added 4 commits March 27, 2025 15:07

fix(zigbee): Fix memory leak, print esp_zb_zcl_status_t error, remove…

160e286

… analogValue from analog EP

feat(example): Update factoryResetoption in sleepy example

8e55674

Merge branch 'master' into feat/zigbee-commands-return-check

382073a

fix(zigbee): Add error checks to Illuminance EP

65b9383

P-R-O-C-H-Y marked this pull request as ready for review March 27, 2025 14:13

P-R-O-C-H-Y changed the title ~~feat(zigbee): Add checks on set attributes and commands~~ feat(zigbee): Add check, boolean returns, fix Analog, add optional reset on factoryReset Mar 27, 2025

P-R-O-C-H-Y requested a review from SuGlider March 27, 2025 14:22

P-R-O-C-H-Y requested review from me-no-dev and lucasssvaz March 27, 2025 14:22

P-R-O-C-H-Y added Status: Review needed Issue or PR is awaiting review and removed Status: In Progress ⚠️ Issue is in progress labels Mar 27, 2025

P-R-O-C-H-Y modified the milestones: 3.3.0, 3.2.0 Mar 27, 2025

lucasssvaz approved these changes Mar 27, 2025

View reviewed changes

fix(zigbee): Return false on first error hit

f5e28e1

P-R-O-C-H-Y force-pushed the feat/zigbee-commands-return-check branch from 909606a to f5e28e1 Compare March 27, 2025 16:02

P-R-O-C-H-Y added 2 commits March 27, 2025 17:17

fix(zigbee): Apply same formatting on all returns

51f1454

fix(zigbee): Add check when adding a OTA cluster

282ccc5

P-R-O-C-H-Y added 6 commits March 27, 2025 19:16

fix(zigbee): release locks before returning

b6bf3c2

fix(zigbee): use correct return in doorWindowHandle

8cf38c5

fix/zigbee): Add missing return in WindowCovering

253066c

Revert "fix(zigbee): use correct return in doorWindowHandle"

cdd131b

This reverts commit 8cf38c5.

fix(zigbee): Added a note of future task

1f60c92

fix(zigbee): Hope its finished now..

8560ff3

P-R-O-C-H-Y added Status: Pending Merge Pull Request is ready to be merged and removed Status: Review needed Issue or PR is awaiting review labels Mar 27, 2025

ci(pre-commit): Apply automatic fixes

3bebb79

me-no-dev approved these changes Mar 27, 2025

View reviewed changes

me-no-dev merged commit a3b6fe6 into espressif:master Mar 27, 2025
56 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(zigbee): Add check, boolean returns, fix Analog, add optional reset on factoryReset #11153

feat(zigbee): Add check, boolean returns, fix Analog, add optional reset on factoryReset #11153

P-R-O-C-H-Y commented Mar 20, 2025 •

edited

Loading

github-actions bot commented Mar 20, 2025 •

edited

Loading

github-actions bot commented Mar 20, 2025 •

edited

Loading

github-actions bot commented Mar 20, 2025 •

edited

Loading

me-no-dev commented Mar 20, 2025

SuGlider commented Mar 27, 2025 •

edited

Loading

SuGlider left a comment

P-R-O-C-H-Y commented Mar 27, 2025

lucasssvaz left a comment

P-R-O-C-H-Y commented Mar 27, 2025

feat(zigbee): Add check, boolean returns, fix Analog, add optional reset on factoryReset #11153

feat(zigbee): Add check, boolean returns, fix Analog, add optional reset on factoryReset #11153

Conversation

P-R-O-C-H-Y commented Mar 20, 2025 • edited Loading

Description of Change

Tests scenarios

Related links

github-actions bot commented Mar 20, 2025 • edited Loading

github-actions bot commented Mar 20, 2025 • edited Loading

Test Results

github-actions bot commented Mar 20, 2025 • edited Loading

Memory usage test (comparing PR against master branch)

me-no-dev commented Mar 20, 2025

SuGlider commented Mar 27, 2025 • edited Loading

SuGlider left a comment

Choose a reason for hiding this comment

P-R-O-C-H-Y commented Mar 27, 2025

lucasssvaz left a comment

Choose a reason for hiding this comment

P-R-O-C-H-Y commented Mar 27, 2025

P-R-O-C-H-Y commented Mar 20, 2025 •

edited

Loading

github-actions bot commented Mar 20, 2025 •

edited

Loading

github-actions bot commented Mar 20, 2025 •

edited

Loading

github-actions bot commented Mar 20, 2025 •

edited

Loading

SuGlider commented Mar 27, 2025 •

edited

Loading