Refactor classes methods + implement Identify command

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

libraries/Zigbee/examples/Zigbee_Color_Dimmable_Light/Zigbee_Color_Dimmable_Light.ino

@@ -36,53 +36,28 @@
 
 #define LED_PIN RGB_BUILTIN
 #define BUTTON_PIN 9  // C6/H2 Boot button
-#define ZIGBEE_LIGHT_ENDPOINT       10                                   /* esp light bulb device endpoint, used to process light controlling commands */
+#define ZIGBEE_LIGHT_ENDPOINT 10 
 
-class MyZigbeeColorLight : public ZigbeeColorDimmableLight {
-public:
-    // Constructor that passes parameters to the base class constructor
-    MyZigbeeColorLight(uint8_t endpoint) : ZigbeeColorDimmableLight(endpoint) {}
+ZigbeeColorDimmableLight zbColorLight = ZigbeeColorDimmableLight(ZIGBEE_LIGHT_ENDPOINT);
 
-    // Override the set_on_off function
-    void setOnOff(bool value) override {
-      if (value == false) {
-        rgbLedWrite(LED_PIN, 0, 0, 0);  // Turn off light
-      } else {
-        updateLight(); // Turn on light on last color and level
-      }
-    }
-
-    // Override the set_level function
-    void setLevel(uint8_t level) override {
-      if (level == 0) {
-        rgbLedWrite(LED_PIN, 0, 0, 0);  // Turn off light and dont update ratio
-        return;
-      }
-      _ratio = (float)level / 255;
-      updateLight();
-    }
-
-    // Override the set_color function
-    void setColor(uint8_t red, uint8_t green, uint8_t blue) override {
-      _red = red;
-      _green = green;
-      _blue = blue;
-      updateLight();
-    }
-
-    void updateLight() {
-      rgbLedWrite(LED_PIN, _red * _ratio, _green * _ratio, _blue * _ratio);  // Update light
-    }
-private:
-    // Add your custom attributes and methods here
-    float _ratio = 1.0;
-    uint8_t _red = 255;
-    uint8_t _green = 255;
-    uint8_t _blue = 255;
-
-};
+/********************* RGB LED functions **************************/
+void setRGBLight(bool state, uint8_t red, uint8_t green, uint8_t blue, uint8_t level) {
+  float brightness = (float)level / 255;
+  rgbLedWrite(LED_PIN, red * brightness, green * brightness, blue * brightness);
+}
 
-MyZigbeeColorLight zbColorLight = MyZigbeeColorLight(ZIGBEE_LIGHT_ENDPOINT);
+// Create a task on identify call to handle the identify function
+void identify(uint16_t time) {
+  static uint8_t blink = 1;
+  log_d("Identify called for %d seconds", time);
+  if (time == 0) {
+    // If identify time is 0, stop blinking and restore light as it was used for identify
+      zbColorLight.restoreLight();
+    return;
+  }
+  rgbLedWrite(LED_PIN, 255 * blink, 255 * blink, 255 * blink);
+  blink = !blink;
+}
 
 /********************* Arduino functions **************************/
 void setup() {
@@ -92,10 +67,16 @@ void setup() {
   // Init button for factory reset
   pinMode(BUTTON_PIN, INPUT);
 
-  //Optional: set Zigbee device name and model
+  // Set callback function for light change
+  zbColorLight.onLightChange(setRGBLight);
+
+  // Optional: Set callback function for device identify
+  zbColorLight.onIdentify(identify);
+
+  // Optional: Set Zigbee device name and model
   zbColorLight.setManufacturerAndModel("Espressif", "ZBColorLightBulb");
 
-  //Add endpoint to Zigbee Core
+  // Add endpoint to Zigbee Core
   log_d("Adding ZigbeeLight endpoint to Zigbee Core");
   Zigbee.addEndpoint(&zbColorLight);
 

libraries/Zigbee/examples/Zigbee_Color_Dimmer_Switch/Zigbee_Color_Dimmer_Switch.ino

@@ -39,7 +39,7 @@
 #include "ep/ZigbeeColorDimmerSwitch.h"
 
 /* Switch configuration */
-#define SWITCH_PIN 9 //Boot button for C6/H2
+#define SWITCH_PIN 9 // ESP32-C6/H2 Boot button
 #define SWITCH_ENDPOINT_NUMBER 5
 
 /* Zigbee switch */

libraries/Zigbee/examples/Zigbee_On_Off_Light/Zigbee_On_Off_Light.ino

@@ -34,21 +34,15 @@
 #include "ep/ZigbeeLight.h"
 
 #define LED_PIN RGB_BUILTIN
-#define BUTTON_PIN 9  // C6/H2 Boot button
-#define ZIGBEE_LIGHT_ENDPOINT       10         /* esp light bulb device endpoint, used to process light controlling commands */
+#define BUTTON_PIN 9  // ESP32-C6/H2 Boot button
+#define ZIGBEE_LIGHT_ENDPOINT 10
 
-class MyZigbeeLight : public ZigbeeLight {
-public:
-    // Constructor that passes parameters to the base class constructor
-    MyZigbeeLight(uint8_t endpoint) : ZigbeeLight(endpoint) {}
+ZigbeeLight zbLight = ZigbeeLight(ZIGBEE_LIGHT_ENDPOINT);
 
-    // Override the set_on_off function
-    void setOnOff(bool value) override {
-      rgbLedWrite(LED_PIN, 255 * value, 255 * value, 255 * value);  // Toggle light
-    }
-};
-
-MyZigbeeLight zbLight = MyZigbeeLight(ZIGBEE_LIGHT_ENDPOINT);
+/********************* RGB LED functions **************************/
+void setLED(bool value) {
+  rgbLedWrite(LED_PIN, 255 * value, 255 * value, 255 * value);
+}
 
 /********************* Arduino functions **************************/
 void setup() {
@@ -61,6 +55,9 @@ void setup() {
   //Optional: set Zigbee device name and model
   zbLight.setManufacturerAndModel("Espressif", "ZBLightBulb");
 
+  // Set callback function for light change
+  zbLight.onLightChange(setLED);
+
   //Add endpoint to Zigbee Core
   log_d("Adding ZigbeeLight endpoint to Zigbee Core");
   Zigbee.addEndpoint(&zbLight);

libraries/Zigbee/examples/Zigbee_On_Off_Switch/Zigbee_On_Off_Switch.ino

@@ -65,24 +65,7 @@ typedef enum {
 
 static SwitchData buttonFunctionPair[] = {{GPIO_INPUT_IO_TOGGLE_SWITCH, SWITCH_ONOFF_TOGGLE_CONTROL}};
 
-/* Zigbee switch */
-class MyZigbeeSwitch : public ZigbeeSwitch {
-public:
-    // Constructor that passes parameters to the base class constructor
-    MyZigbeeSwitch(uint8_t endpoint) : ZigbeeSwitch(endpoint) {}
-
-    // Override the set_on_off function
-    void readManufacturer(char* manufacturer) override {
-      //Do what you want with the manufacturer string
-      Serial.printf("Manufacturer: %s\n", manufacturer);
-    }
-    void readModel(char* model) override {
-      //Do what you want with the model string
-      Serial.printf("Model: %s\n", model);
-    }
-};
-
-MyZigbeeSwitch zbSwitch = MyZigbeeSwitch(SWITCH_ENDPOINT_NUMBER);
+ZigbeeSwitch zbSwitch = ZigbeeSwitch(SWITCH_ENDPOINT_NUMBER);
 
 /********************* Zigbee functions **************************/
 static void onZbButton(SwitchData *button_func_pair) {
@@ -127,7 +110,6 @@ void setup() {
   //Open network for 180 seconds after boot
   Zigbee.setRebootOpenNetwork(180);
 
-
   // Init button switch
   for (int i = 0; i < PAIR_SIZE(buttonFunctionPair); i++) {
     pinMode(buttonFunctionPair[i].pin, INPUT_PULLUP);
@@ -151,6 +133,17 @@ void setup() {
     Serial.printf(".");
     delay(500);
   }
+
+  // Optional: read manufacturer and model name from the bound light
+  std::list<zb_device_params_t*> boundLights = zbSwitch.getBoundDevices();
+  //List all bound lights
+  for (const auto& device : boundLights) {
+    Serial.printf("Device on endpoint %d, short address: 0x%x\n", device->endpoint, device->short_addr);
+    Serial.printf("IEEE Address: %02X:%02X:%02X:%02X:%02X:%02X:%02X:%02X\n", device->ieee_addr[0], device->ieee_addr[1], device->ieee_addr[2], device->ieee_addr[3], device->ieee_addr[4], device->ieee_addr[5], device->ieee_addr[6], device->ieee_addr[7]);
+    Serial.printf("Light manufacturer: %s", zbSwitch.readManufacturer(device->endpoint, device->short_addr));
+    Serial.printf("Light model: %s", zbSwitch.readModel(device->endpoint, device->short_addr));
+  }
+
   Serial.println();
 }
 

libraries/Zigbee/examples/Zigbee_Thermostat/Zigbee_Thermostat.ino

@@ -37,50 +37,37 @@
 #define BUTTON_PIN 9 // Boot button for C6/H2
 #define THERMOSTAT_ENDPOINT_NUMBER 5
 
-class MyZigbeeThermostat : public ZigbeeThermostat {
-  public:
-    // Constructor that passes parameters to the base class constructor
-    MyZigbeeThermostat(uint8_t endpoint) : ZigbeeThermostat(endpoint) {}
-
-    // Override virtual functions from ZigbeeThermostat to handle temperature sensor data
-    void temperatureRead(float temp) override {
-      if (temperature != temp) {
-        Serial.printf("Temperature sensor value changed to: %.2f°C\n", temp);
-        temperature = temp;
-      }
-    }
-
-    void temperatureMin(float temp) override {
-      Serial.printf("Temperature sensor min value: %.2f°C\n", temp);
-      min_temperature = temp;
-    }
-
-    void temperatureMax(float temp) override {
-      Serial.printf("Temperature sensor max value: %.2f°C\n", temp);
-      max_temperature = temp;
-    }
-
-    void temperatureTolerance(float tolerance) override {
-      Serial.printf("Temperature sensor tolerance: %.2f°C\n", tolerance);
-      temp_tolerance = tolerance;
-    }
-
-    float temperature;
-    float max_temperature;
-    float min_temperature;
-    float temp_tolerance;
-};
-
-MyZigbeeThermostat zbThermostat = MyZigbeeThermostat(THERMOSTAT_ENDPOINT_NUMBER);
+ZigbeeThermostat zbThermostat = ZigbeeThermostat(THERMOSTAT_ENDPOINT_NUMBER);
+
+// Save temperature sensor data
+float sensor_temp;
+float sensor_max_temp;
+float sensor_min_temp;
+float sensor_tolerance;
+
+/****************** Temperature sensor handling *******************/
+void recieveSensorTemp(float temperature) {
+  Serial.printf("Temperature sensor value: %.2f°C\n", temperature);
+  sensor_temp = temperature;
+}
 
+void recieveSensorConfig(float min_temp, float max_temp, float tolerance) {
+  Serial.printf("Temperature sensor settings: min %.2f°C, max %.2f°C, tolerance %.2f°C\n", min_temp, max_temp, tolerance);
+  sensor_min_temp = min_temp;
+  sensor_max_temp = max_temp;
+  sensor_tolerance = tolerance;
+}
 /********************* Arduino functions **************************/
 void setup() {
-  
   Serial.begin(115200);
 
   // Init button switch
   pinMode(BUTTON_PIN, INPUT);
 
+  // Set callback functions for temperature and configuration recieve
+  zbThermostat.onTempRecieve(recieveSensorTemp);
+  zbThermostat.onConfigRecieve(recieveSensorConfig);
+
   //Optional: set Zigbee device name and model
   zbThermostat.setManufacturerAndModel("Espressif", "ZigbeeThermostat");
 
@@ -94,16 +81,16 @@ void setup() {
   Zigbee.begin(ZIGBEE_COORDINATOR);
 
   Serial.println("Waiting for Temperature sensor to bound to the switch");
+
   //Wait for switch to bound to a light:
   while(!zbThermostat.isBound()) 
   {
     Serial.printf(".");
     delay(500);
   }
 
-  // Get temperature sensor value to update min and max values
-  zbThermostat.getTemperature();
-
+  // Get temperature sensor configuration
+  zbThermostat.getSensorSettings();
   Serial.println();
 }
 
@@ -124,7 +111,7 @@ void loop() {
   static uint32_t last_print = 0;
   if (millis() - last_print > 10000) {
     last_print = millis();
-    int temp_percent = (int)((zbThermostat.temperature - zbThermostat.min_temperature) / (zbThermostat.max_temperature - zbThermostat.min_temperature) * 100);
-    Serial.printf("Temperature: %.2f°C (%d %%)\n", zbThermostat.temperature, temp_percent);
+    int temp_percent = (int)((sensor_temp - sensor_min_temp) / (sensor_max_temp - sensor_min_temp) * 100);
+    Serial.printf("Loop temperature info: %.2f°C (%d %%)\n", sensor_temp, temp_percent);
   }
 }