feat(zigbee): Add global default response cb option

Author: P-R-O-C-H-Y

libraries/Zigbee/examples/Zigbee_Temp_Hum_Sensor_Sleepy/Zigbee_Temp_Hum_Sensor_Sleepy.ino

@@ -32,6 +32,8 @@
 
 #include "Zigbee.h"
 
+#define USE_GLOBAL_ON_RESPONSE_CALLBACK 1 // Set to 0 to use local callback specified directly for the endpoint.
+
 /* Zigbee temperature + humidity sensor configuration */
 #define TEMP_SENSOR_ENDPOINT_NUMBER 10
 
@@ -46,6 +48,31 @@ ZigbeeTempSensor zbTempSensor = ZigbeeTempSensor(TEMP_SENSOR_ENDPOINT_NUMBER);
 uint8_t dataToSend = 2; // Temperature and humidity values are reported in same endpoint, so 2 values are reported
 bool resend = false; 
 
+/************************ Callbacks *****************************/
+#if USE_GLOBAL_ON_RESPONSE_CALLBACK
+void onGlobalResponse(zb_cmd_type_t command, esp_zb_zcl_status_t status, uint8_t endpoint, uint16_t cluster){
+  Serial.printf("Global response command: %d, status: %s, endpoint: %d, cluster: 0x%04x\r\n", command, esp_zb_zcl_status_to_name(status), endpoint, cluster); 
+  if((command == ZB_CMD_REPORT_ATTRIBUTE) && (endpoint == TEMP_SENSOR_ENDPOINT_NUMBER)){
+    switch (status){
+      case ESP_ZB_ZCL_STATUS_SUCCESS: dataToSend--; break;
+      case ESP_ZB_ZCL_STATUS_FAIL: resend = true; break;
+      default: break;// add more statuses like ESP_ZB_ZCL_STATUS_INVALID_VALUE, ESP_ZB_ZCL_STATUS_TIMEOUT etc.
+    }
+  }
+}
+#else
+void onResponse(zb_cmd_type_t command, esp_zb_zcl_status_t status){
+  Serial.printf("Response command: %d, status: %s\r\n", command, esp_zb_zcl_status_to_name(status));
+  if(command == ZB_CMD_REPORT_ATTRIBUTE){
+    switch (status){
+      case ESP_ZB_ZCL_STATUS_SUCCESS: dataToSend--; break;
+      case ESP_ZB_ZCL_STATUS_FAIL: resend = true; break;
+      default: break;// add more statuses like ESP_ZB_ZCL_STATUS_INVALID_VALUE, ESP_ZB_ZCL_STATUS_TIMEOUT etc.
+    }
+  }
+}
+#endif
+
 /************************ Temp sensor *****************************/
 void meausureAndSleep() {
   // Measure temperature sensor value
@@ -85,16 +112,6 @@ void meausureAndSleep() {
   esp_deep_sleep_start();
 }
 
-void onResponse(zb_cmd_type_t command, esp_zb_zcl_status_t status){
-  Serial.printf("Response status received %s\r\n", zbTempSensor.esp_zb_zcl_status_to_name(status));
-  if(command == ZB_CMD_REPORT_ATTRIBUTE){
-    switch (status){
-      case ESP_ZB_ZCL_STATUS_SUCCESS: dataToSend--; break;
-      case ESP_ZB_ZCL_STATUS_FAIL: resend = true; break;
-      default: break;// add more statuses like ESP_ZB_ZCL_STATUS_INVALID_VALUE, ESP_ZB_ZCL_STATUS_TIMEOUT etc.
-    }
-  }
-}
 /********************* Arduino functions **************************/
 void setup() {
   Serial.begin(115200);
@@ -121,8 +138,15 @@ void setup() {
   // Add humidity cluster to the temperature sensor device with min, max and tolerance values
   zbTempSensor.addHumiditySensor(0, 100, 1);
 
-  // Set callback for default response to handle status of reported data
+  // Set callback for default response to handle status of reported data, there are 2 options.
+
+#if USE_GLOBAL_ON_RESPONSE_CALLBACK
+  // Global callback for all endpoints with more params to determine the endpoint and cluster in the callback function.
+  Zigbee.onGlobalDefaultResponse(onGlobalResponse);
+#else
+  // Callback specified for endpoint
   zbTempSensor.onDefaultResponse(onResponse);
+#endif
 
   // Add endpoint to Zigbee Core
   Zigbee.addEndpoint(&zbTempSensor);

libraries/Zigbee/src/Zigbee.h

@@ -2,6 +2,9 @@
 
 #pragma once
 
+// Common types and functions
+#include "ZigbeeTypes.h"
+
 // Core
 #include "ZigbeeCore.h"
 #include "ZigbeeEP.h"

libraries/Zigbee/src/ZigbeeCore.cpp

@@ -32,6 +32,7 @@ ZigbeeCore::ZigbeeCore() {
   _scan_duration = 3;  // default scan duration
   _rx_on_when_idle = true;
   _debug = false;
+  _global_default_response_cb = nullptr;  // Initialize global callback to nullptr
   if (!lock) {
     lock = xSemaphoreCreateBinary();
     if (lock == NULL) {
@@ -792,6 +793,17 @@ const char *ZigbeeCore::getDeviceTypeString(esp_zb_ha_standard_devices_t deviceI
   }
 }
 
+void ZigbeeCore::callDefaultResponseCallback(zb_cmd_type_t resp_to_cmd, esp_zb_zcl_status_t status, uint8_t endpoint, uint16_t cluster) {
+  log_v("Global callback called: cmd=%d, status=%s, ep=%d, cluster=0x%04x", resp_to_cmd, esp_zb_zcl_status_to_name(status), endpoint, cluster);
+  if (_global_default_response_cb) {
+    log_v("Global callback is set, calling it");
+    _global_default_response_cb(resp_to_cmd, status, endpoint, cluster);
+    log_v("Global callback completed");
+  } else {
+    log_v("Global callback is NOT set");
+  }
+}
+
 ZigbeeCore Zigbee = ZigbeeCore();
 
 #endif  // CONFIG_ZB_ENABLED

libraries/Zigbee/src/ZigbeeCore.h

@@ -11,6 +11,7 @@
 #include "aps/esp_zigbee_aps.h"
 #include <esp32-hal-log.h>
 #include <list>
+#include "ZigbeeTypes.h"
 #include "ZigbeeEP.h"
 class ZigbeeEP;
 
@@ -103,6 +104,9 @@ class ZigbeeCore {
   SemaphoreHandle_t lock;
   bool _debug;
 
+  // Global default response callback
+  void (*_global_default_response_cb)(zb_cmd_type_t resp_to_cmd, esp_zb_zcl_status_t status, uint8_t endpoint, uint16_t cluster);
+
   bool zigbeeInit(esp_zb_cfg_t *zb_cfg, bool erase_nvs);
   static void scanCompleteCallback(esp_zb_zdp_status_t zdo_status, uint8_t count, esp_zb_network_descriptor_t *nwk_descriptor);
   const char *getDeviceTypeString(esp_zb_ha_standard_devices_t deviceId);
@@ -176,6 +180,14 @@ class ZigbeeCore {
     return _debug;
   }
 
+  // Set global default response callback
+  void onGlobalDefaultResponse(void (*callback)(zb_cmd_type_t resp_to_cmd, esp_zb_zcl_status_t status, uint8_t endpoint, uint16_t cluster)) {
+    _global_default_response_cb = callback;
+  }
+
+  // Call global default response callback (for internal use)
+  void callDefaultResponseCallback(zb_cmd_type_t resp_to_cmd, esp_zb_zcl_status_t status, uint8_t endpoint, uint16_t cluster);
+
   // Friend function declaration to allow access to private members
   friend void esp_zb_app_signal_handler(esp_zb_app_signal_t *signal_struct);
   friend bool zb_apsde_data_indication_handler(esp_zb_apsde_data_ind_t ind);

libraries/Zigbee/src/ZigbeeEP.cpp

@@ -617,7 +617,8 @@ void ZigbeeEP::zbDefaultResponse(const esp_zb_zcl_cmd_default_resp_message_t *me
   }
 }
 
-const char *ZigbeeEP::esp_zb_zcl_status_to_name(esp_zb_zcl_status_t status) {
+// Global function implementation
+const char *esp_zb_zcl_status_to_name(esp_zb_zcl_status_t status) {
   switch (status) {
     case ESP_ZB_ZCL_STATUS_SUCCESS:               return "Success";
     case ESP_ZB_ZCL_STATUS_FAIL:                  return "Fail";

libraries/Zigbee/src/ZigbeeEP.h

@@ -12,32 +12,6 @@
 #define ZB_CMD_TIMEOUT             10000     // 10 seconds
 #define OTA_UPGRADE_QUERY_INTERVAL (1 * 60)  // 1 hour = 60 minutes
 
-typedef enum {
-  ZB_CMD_READ_ATTRIBUTE                = 0x00U, /*!< Read attributes command */
-  ZB_CMD_READ_ATTRIBUTE_RESPONSE       = 0x01U, /*!< Read attributes response command */
-  ZB_CMD_WRITE_ATTRIBUTE               = 0x02U, /*!< Write attributes foundation command */
-  ZB_CMD_WRITE_ATTRIBUTE_UNDIVIDED     = 0x03U, /*!< Write attributes undivided command */
-  ZB_CMD_WRITE_ATTRIBUTE_RESPONSE      = 0x04U, /*!< Write attributes response command */
-  ZB_CMD_WRITE_ATTRIBUTE_NO_RESPONSE   = 0x05U, /*!< Write attributes no response command */
-  ZB_CMD_CONFIGURE_REPORTING           = 0x06U, /*!< Configure reporting command */
-  ZB_CMD_CONFIGURE_REPORTING_RESPONSE  = 0x07U, /*!< Configure reporting response command */
-  ZB_CMD_READ_REPORTING_CONFIG         = 0x08U, /*!< Read reporting config command */
-  ZB_CMD_READ_REPORTING_CONFIG_RESPONSE= 0x09U, /*!< Read reporting config response command */
-  ZB_CMD_REPORT_ATTRIBUTE              = 0x0aU, /*!< Report attribute command */
-  ZB_CMD_DEFAULT_RESPONSE              = 0x0bU, /*!< Default response command */
-  ZB_CMD_DISCOVER_ATTRIBUTES           = 0x0cU, /*!< Discover attributes command */
-  ZB_CMD_DISCOVER_ATTRIBUTES_RESPONSE  = 0x0dU, /*!< Discover attributes response command */
-  ZB_CMD_READ_ATTRIBUTE_STRUCTURED     = 0x0eU, /*!< Read attributes structured */
-  ZB_CMD_WRITE_ATTRIBUTE_STRUCTURED    = 0x0fU, /*!< Write attributes structured */
-  ZB_CMD_WRITE_ATTRIBUTE_STRUCTURED_RESPONSE = 0x10U, /*!< Write attributes structured response */
-  ZB_CMD_DISCOVER_COMMANDS_RECEIVED    = 0x11U, /*!< Discover Commands Received command */
-  ZB_CMD_DISCOVER_COMMANDS_RECEIVED_RESPONSE = 0x12U, /*!< Discover Commands Received response command */
-  ZB_CMD_DISCOVER_COMMANDS_GENERATED   = 0x13U, /*!< Discover Commands Generated command */
-  ZB_CMD_DISCOVER_COMMANDS_GENERATED_RESPONSE = 0x14U, /*!< Discover Commands Generated response command */
-  ZB_CMD_DISCOVER_ATTRIBUTES_EXTENDED  = 0x15U, /*!< Discover attributes extended command */
-  ZB_CMD_DISCOVER_ATTRIBUTES_EXTENDED_RESPONSE = 0x16U, /*!< Discover attributes extended response command */
-} zb_cmd_type_t;
-
 #define ZB_ARRAY_LENGHT(arr) (sizeof(arr) / sizeof(arr[0]))
 
 #define RGB_TO_XYZ(r, g, b, X, Y, Z)                               \
@@ -64,6 +38,9 @@ typedef enum {
   ZB_POWER_SOURCE_BATTERY = 0x03,
 } zb_power_source_t;
 
+// Global function for converting ZCL status to name
+const char *esp_zb_zcl_status_to_name(esp_zb_zcl_status_t status);
+
 /* Zigbee End Device Class */
 class ZigbeeEP {
 public:
@@ -188,7 +165,6 @@ class ZigbeeEP {
   }
 
   // Convert ZCL status to name
-  const char *esp_zb_zcl_status_to_name(esp_zb_zcl_status_t status);
 
 private:
   char *_read_manufacturer;
@@ -212,6 +188,7 @@ class ZigbeeEP {
   zb_power_source_t _power_source;
   uint8_t _time_status;
 
+  // Friend class declaration to allow access to protected members
   friend class ZigbeeCore;
 };
 

libraries/Zigbee/src/ZigbeeHandlers.cpp

@@ -399,6 +399,9 @@ static esp_err_t zb_cmd_default_resp_handler(const esp_zb_zcl_cmd_default_resp_m
     message->info.src_address.u.short_addr, message->info.src_endpoint, message->info.dst_endpoint, message->info.cluster, message->status_code
   );
 
+  // Call global callback if set
+  Zigbee.callDefaultResponseCallback((zb_cmd_type_t)message->resp_to_cmd, message->status_code, message->info.dst_endpoint, message->info.cluster);
+
   // List through all Zigbee EPs and call the callback function, with the message
   for (std::list<ZigbeeEP *>::iterator it = Zigbee.ep_objects.begin(); it != Zigbee.ep_objects.end(); ++it) {
     if (message->info.dst_endpoint == (*it)->getEndpoint()) {

libraries/Zigbee/src/ZigbeeTypes.h

@@ -0,0 +1,30 @@
+#pragma once
+
+#include "esp_zigbee_core.h"
+
+// Foundation Command Types
+typedef enum {
+  ZB_CMD_READ_ATTRIBUTE                = 0x00U, /*!< Read attributes command */
+  ZB_CMD_READ_ATTRIBUTE_RESPONSE       = 0x01U, /*!< Read attributes response command */
+  ZB_CMD_WRITE_ATTRIBUTE               = 0x02U, /*!< Write attributes foundation command */
+  ZB_CMD_WRITE_ATTRIBUTE_UNDIVIDED     = 0x03U, /*!< Write attributes undivided command */
+  ZB_CMD_WRITE_ATTRIBUTE_RESPONSE      = 0x04U, /*!< Write attributes response command */
+  ZB_CMD_WRITE_ATTRIBUTE_NO_RESPONSE   = 0x05U, /*!< Write attributes no response command */
+  ZB_CMD_CONFIGURE_REPORTING           = 0x06U, /*!< Configure reporting command */
+  ZB_CMD_CONFIGURE_REPORTING_RESPONSE  = 0x07U, /*!< Configure reporting response command */
+  ZB_CMD_READ_REPORTING_CONFIG         = 0x08U, /*!< Read reporting config command */
+  ZB_CMD_READ_REPORTING_CONFIG_RESPONSE= 0x09U, /*!< Read reporting config response command */
+  ZB_CMD_REPORT_ATTRIBUTE              = 0x0aU, /*!< Report attribute command */
+  ZB_CMD_DEFAULT_RESPONSE              = 0x0bU, /*!< Default response command */
+  ZB_CMD_DISCOVER_ATTRIBUTES           = 0x0cU, /*!< Discover attributes command */
+  ZB_CMD_DISCOVER_ATTRIBUTES_RESPONSE  = 0x0dU, /*!< Discover attributes response command */
+  ZB_CMD_READ_ATTRIBUTE_STRUCTURED     = 0x0eU, /*!< Read attributes structured */
+  ZB_CMD_WRITE_ATTRIBUTE_STRUCTURED    = 0x0fU, /*!< Write attributes structured */
+  ZB_CMD_WRITE_ATTRIBUTE_STRUCTURED_RESPONSE = 0x10U, /*!< Write attributes structured response */
+  ZB_CMD_DISCOVER_COMMANDS_RECEIVED    = 0x11U, /*!< Discover Commands Received command */
+  ZB_CMD_DISCOVER_COMMANDS_RECEIVED_RESPONSE = 0x12U, /*!< Discover Commands Received response command */
+  ZB_CMD_DISCOVER_COMMANDS_GENERATED   = 0x13U, /*!< Discover Commands Generated command */
+  ZB_CMD_DISCOVER_COMMANDS_GENERATED_RESPONSE = 0x14U, /*!< Discover Commands Generated response command */
+  ZB_CMD_DISCOVER_ATTRIBUTES_EXTENDED  = 0x15U, /*!< Discover attributes extended command */
+  ZB_CMD_DISCOVER_ATTRIBUTES_EXTENDED_RESPONSE = 0x16U, /*!< Discover attributes extended response command */
+} zb_cmd_type_t;