feat(zigbee): Add callback option for default response message #11613

P-R-O-C-H-Y · 2025-07-19T16:13:36Z

Description of Change

Added a default response callback mechanism to ZigbeeEP that allows users to receive notifications when ZCL commands complete, eliminating the need for delays in sleepy devices.

Main Feature: Default Response Callback

Users can register a callback function to handle default responses
Provides typed command identifiers (zb_cmd_type_t) for better error handling
Enables confirmation of command completion without blocking delays
Perfect for sleepy devices: No more delay() calls with unknown time

Additional Improvements

Added foundation command enum for type safety
Added status name helper function for better debugging

Usage Example

void onResponse(zb_cmd_type_t command, esp_zb_zcl_status_t status){
  Serial.printf("Response status recieved %s", zbTempSensor.esp_zb_zcl_status_to_name(status));
  if(command == ZB_CMD_REPORT_ATTRIBUTE){ //Check the report attribute default response
    switch (status){
      case ESP_ZB_ZCL_STATUS_SUCCESS: dataToSend--; break; //data reported successfully
      case ESP_ZB_ZCL_STATUS_FAIL: resend = true; break; //data report failed 
      default: break;// can be extended by statuses like ESP_ZB_ZCL_STATUS_INVALID_VALUE, ESP_ZB_ZCL_STATUS_TIMEOUT etc.
    }
  }
}

// Register the callback
zigbee.onDefaultResponse(onResponse);

Benefits for Sleepy Devices

No Delays: Eliminates blocking delay() calls
Immediate Feedback: Get notified when reporting complete
Better Power Management: Device can go sleep right after data successfully reported
Error Handling: Proper status checking for failed commands

Tests scenarios

Tested using updated Temp_Hum_Sleepy example and HA. No data were lost during an 1,5 hour test with reporting data approx. every minute:

Test Results

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

Results for commit b749553.

♻️ This comment has been updated with latest results.

P-R-O-C-H-Y · 2025-07-19T16:15:55Z

@def1149 @michapr @mister-pjr If you have time, please test this PR if it helps to solve the linked issues. Thanks

Copilot

Pull Request Overview

This PR introduces a default response callback mechanism for ZigbeeEP that enables notification when ZCL commands complete, specifically targeting improved power management for sleepy devices by eliminating blocking delays.

Adds callback registration system for default response handling with typed command identifiers
Implements foundation command enum (zb_cmd_type_t) for better type safety and error handling
Updates sleepy device example to demonstrate asynchronous command completion checking

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
libraries/Zigbee/src/ZigbeeHandlers.cpp	Adds endpoint iteration to call default response callbacks
libraries/Zigbee/src/ZigbeeEP.h	Defines command type enum and adds callback registration method
libraries/Zigbee/src/ZigbeeEP.cpp	Implements default response handler with callback invocation
libraries/Zigbee/keywords.txt	Adds new type and method to Arduino IDE syntax highlighting
libraries/Zigbee/examples/Zigbee_Temp_Hum_Sensor_Sleepy/Zigbee_Temp_Hum_Sensor_Sleepy.ino	Demonstrates callback usage replacing blocking delays

libraries/Zigbee/src/ZigbeeEP.cpp

libraries/Zigbee/examples/Zigbee_Temp_Hum_Sensor_Sleepy/Zigbee_Temp_Hum_Sensor_Sleepy.ino

github-actions · 2025-07-19T16:46:59Z

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

P-R-O-C-H-Y · 2025-07-20T12:27:29Z

A small test here, I have set Debug level to Error so only prints from sketch are in Serial Monitor.

14:24:23.977 -> ESP-ROM:esp32c6-20220919
14:24:23.977 -> Build:Sep 19 2022
14:24:23.977 -> rst:0x1 (POWERON),boot:0xc (SPI_FAST_FLASH_BOOT)
14:24:23.977 -> SPIWP:0xee
14:24:23.977 -> mode:DIO, clock div:2
14:24:23.977 -> load:0x40875720,len:0x1260
14:24:23.977 -> load:0x4086c110,len:0xdd0
14:24:23.977 -> load:0x4086e610,len:0x3030
14:24:23.977 -> entry 0x4086c110
14:24:24.470 -> Connecting to network
14:24:24.470 -> 
14:24:24.470 -> Successfully connected to Zigbee network
14:24:24.470 -> Reported temperature: 27.40°C, Humidity: 27.40%
14:24:24.470 -> Waiting for data report to be confirmed 
14:24:24.470 -> ..Global response command: 10, status: Success, endpoint: 10, cluster: 0x0402
14:24:24.569 -> .Global response command: 10, status: Success, endpoint: 10, cluster: 0x0405
14:24:24.634 -> Going to sleep now

From that you can see that device was alive only for 657 ms before going to sleep again.

feat(zigbee): Add cb option for default response message

e0d18a1

P-R-O-C-H-Y self-assigned this Jul 19, 2025

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

P-R-O-C-H-Y added this to Arduino ESP32 Core Project Roadmap Jul 19, 2025

github-project-automation bot moved this to Todo in Arduino ESP32 Core Project Roadmap Jul 19, 2025

P-R-O-C-H-Y moved this from Todo to In Review in Arduino ESP32 Core Project Roadmap Jul 19, 2025

P-R-O-C-H-Y changed the title ~~feat(zigbee): Add cb option for default response message~~ feat(zigbee): Add callback option for default response message Jul 19, 2025

P-R-O-C-H-Y requested review from me-no-dev, lucasssvaz, SuGlider and Copilot July 19, 2025 16:20

Copilot AI reviewed Jul 19, 2025

View reviewed changes

fix(example): Add timeout and fix spelling

4cbdb44

feat(zigbee): Add global default response cb option

f10ca9f

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 Jul 19, 2025

P-R-O-C-H-Y moved this from In Review to In Progress in Arduino ESP32 Core Project Roadmap Jul 19, 2025

P-R-O-C-H-Y added 2 commits July 20, 2025 14:20

fix(example): Use task for measure and sleep

2e57aa4

fix(zigbee): Remove debug logs

68e253f

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 Jul 20, 2025

me-no-dev approved these changes Jul 20, 2025

View reviewed changes

lucasssvaz approved these changes Jul 21, 2025

View reviewed changes

me-no-dev removed the Status: Review needed Issue or PR is awaiting review label Jul 21, 2025

me-no-dev added the Status: Pending Merge Pull Request is ready to be merged label Jul 21, 2025

pre-commit-ci-lite bot and others added 3 commits July 21, 2025 12:12

ci(pre-commit): Apply automatic fixes

fa7d6a4

fix(example): Add retry and fix typo

ef1b19e

ci(pre-commit): Apply automatic fixes

b749553

me-no-dev merged commit cb3329b into master Jul 21, 2025
56 checks passed

github-project-automation bot moved this from In Progress to Done in Arduino ESP32 Core Project Roadmap Jul 21, 2025

me-no-dev deleted the feat/zigbee-default-response-cb branch July 21, 2025 12:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(zigbee): Add callback option for default response message #11613

feat(zigbee): Add callback option for default response message #11613

Uh oh!

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

edited

Loading

Uh oh!

github-actions bot commented Jul 19, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Jul 19, 2025 •

edited

Loading

Uh oh!

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

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Jul 19, 2025

Uh oh!

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

edited

Loading

Uh oh!

Uh oh!

Uh oh!

feat(zigbee): Add callback option for default response message #11613

feat(zigbee): Add callback option for default response message #11613

Uh oh!

Conversation

P-R-O-C-H-Y commented Jul 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description of Change

Main Feature: Default Response Callback

Additional Improvements

Usage Example

Benefits for Sleepy Devices

Tests scenarios

Related links

Uh oh!

github-actions bot commented Jul 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Jul 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Test Results

Uh oh!

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

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Jul 19, 2025

Memory usage test (comparing PR against master branch)

Uh oh!

P-R-O-C-H-Y commented Jul 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

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

edited

Loading

github-actions bot commented Jul 19, 2025 •

edited

Loading

github-actions bot commented Jul 19, 2025 •

edited

Loading

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

edited

Loading