feat(zigbee): Add power source and battery level

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

libraries/Zigbee/examples/Zigbee_Temperature_Sensor_Sleepy/README.md

@@ -0,0 +1,79 @@
+# Arduino-ESP32 Zigbee Temperature Sensor Example
+
+This example shows how to configure the Zigbee end device and use it as a Home Automation (HA) temperature sensor.
+
+# Supported Targets
+
+Currently, this example supports the following targets.
+
+| Supported Targets | ESP32-C6 | ESP32-H2 |
+| ----------------- | -------- | -------- |
+
+## Temperature Sensor Functions
+
+Note:
+ * This board means the board (e.g. ESP32-H2 / C6) loaded with `Zigbee_Temperature_Sensor` example.
+ * The remote board means the board (e.g. ESP32-H2 / C6) loaded with `Zigbee_Thermostat` example.
+
+Functions:
+ * After this board first starts up, it would be configured locally to report the temperature on 1 degree change and no periodic reporting to the remote board.
+ * By clicking the button (BOOT) on this board, this board will immediately send a report of the current measured temperature to the remote board.
+
+## Hardware Required
+
+* One development board (ESP32-H2 or ESP32-C6) acting as Zigbee coordinator (loaded with `Zigbee_Thermostat` example)
+* A USB cable for power supply and programming
+* Choose another board (ESP32-H2 or ESP32-C6) as Zigbee end device and upload the `Zigbee_Temperature_Sensor` example
+
+### Configure the Project
+
+In this example, the internal temperature sensor task is reading the chip temperature.
+Set the Button GPIO by changing the `BUTTON_PIN` definition. By default, it's the pin `9` (BOOT button on ESP32-C6 and ESP32-H2).
+
+#### Using Arduino IDE
+
+To get more information about the Espressif boards see [Espressif Development Kits](https://www.espressif.com/en/products/devkits).
+
+* Before Compile/Verify, select the correct board: `Tools -> Board`.
+* Select the End device Zigbee mode: `Tools -> Zigbee mode: Zigbee ED (end device)`
+* Select Partition Scheme for Zigbee: `Tools -> Partition Scheme: Zigbee 4MB with spiffs`
+* Select the COM port: `Tools -> Port: xxx` where the `xxx` is the detected COM port.
+* Optional: Set debug level to verbose to see all logs from Zigbee stack: `Tools -> Core Debug Level: Verbose`.
+
+## Troubleshooting
+
+If the End device flashed with this example is not connecting to the coordinator, erase the flash of the End device before flashing the example to the board. It is recommended to do this if you re-flash the coordinator.
+You can do the following:
+
+* In the Arduino IDE go to the Tools menu and set `Erase All Flash Before Sketch Upload` to `Enabled`.
+* Add to the sketch `Zigbee.factoryReset();` to reset the device and Zigbee stack.
+
+By default, the coordinator network is closed after rebooting or flashing new firmware.
+To open the network you have 2 options:
+
+* Open network after reboot by setting `Zigbee.setRebootOpenNetwork(time);` before calling `Zigbee.begin();`.
+* In application you can anytime call `Zigbee.openNetwork(time);` to open the network for devices to join.
+
+***Important: Make sure you are using a good quality USB cable and that you have a reliable power source***
+
+* **LED not blinking:** Check the wiring connection and the IO selection.
+* **Programming Fail:** If the programming/flash procedure fails, try reducing the serial connection speed.
+* **COM port not detected:** Check the USB cable and the USB to Serial driver installation.
+
+If the error persists, you can ask for help at the official [ESP32 forum](https://esp32.com) or see [Contribute](#contribute).
+
+## Contribute
+
+To know how to contribute to this project, see [How to contribute.](https://github.com/espressif/arduino-esp32/blob/master/CONTRIBUTING.rst)
+
+If you have any **feedback** or **issue** to report on this example/library, please open an issue or fix it by creating a new PR. Contributions are more than welcome!
+
+Before creating a new issue, be sure to try Troubleshooting and check if the same issue was already created by someone else.
+
+## Resources
+
+* Official ESP32 Forum: [Link](https://esp32.com)
+* Arduino-ESP32 Official Repository: [espressif/arduino-esp32](https://github.com/espressif/arduino-esp32)
+* ESP32-C6 Datasheet: [Link to datasheet](https://www.espressif.com/sites/default/files/documentation/esp32-c6_datasheet_en.pdf)
+* ESP32-H2 Datasheet: [Link to datasheet](https://www.espressif.com/sites/default/files/documentation/esp32-h2_datasheet_en.pdf)
+* Official ESP-IDF documentation: [ESP-IDF](https://idf.espressif.com)

libraries/Zigbee/examples/Zigbee_Temperature_Sensor_Sleepy/Zigbee_Temperature_Sensor_Sleepy.ino

@@ -0,0 +1,132 @@
+// Copyright 2024 Espressif Systems (Shanghai) PTE LTD
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+/**
+ * @brief This example demonstrates Zigbee temperature sensor Sleepy device.
+ *
+ * The example demonstrates how to use Zigbee library to create a end device temperature sensor.
+ * The temperature sensor is a Zigbee end device, which is controlled by a Zigbee coordinator.
+ *
+ * Proper Zigbee mode must be selected in Tools->Zigbee mode
+ * and also the correct partition scheme must be selected in Tools->Partition Scheme.
+ *
+ * Please check the README.md for instructions and more detailed description.
+ *
+ * Created by Jan Procházka (https://github.com/P-R-O-C-H-Y/)
+ */
+
+#ifndef ZIGBEE_MODE_ED
+#error "Zigbee coordinator mode is not selected in Tools->Zigbee mode"
+#endif
+
+#include "ZigbeeCore.h"
+#include "ep/ZigbeeTempSensor.h"
+#include <ctime>
+
+#define BUTTON_PIN                  9  //Boot button for C6/H2
+#define TEMP_SENSOR_ENDPOINT_NUMBER 10
+
+#define uS_TO_S_FACTOR 1000000ULL /* Conversion factor for micro seconds to seconds */
+#define TIME_TO_SLEEP  30         /* Time ESP32 will go to sleep (in seconds) */
+
+ZigbeeTempSensor zbTempSensor = ZigbeeTempSensor(TEMP_SENSOR_ENDPOINT_NUMBER);
+
+/************************ Temp sensor *****************************/
+void meausureAndSleep(){
+  // Measure temperature sensor value
+  float tsens_value = temperatureRead();
+
+  // Initialize random seed
+  std::srand(static_cast<unsigned int>(std::time(0)));
+
+  // Calculate the 1% fluctuation range
+  float fluctuation = tsens_value * 0.01f;
+
+  // Generate a random number between -1% and +1%
+  float randomFactor = (static_cast<float>(std::rand()) / RAND_MAX) * 2.0f - 1.0f;
+
+  // Apply the fluctuation to the original temperature
+  tsens_value = tsens_value + randomFactor * fluctuation;
+
+  // Update temperature value in Temperature sensor EP
+  zbTempSensor.setTemperature(tsens_value);
+
+  // Report temperature value
+  zbTempSensor.reportTemperature();
+
+  // Set battery percentage to 80% and report it
+  zbTempSensor.setBatteryPercentage(80);
+  zbTempSensor.reportBatteryPercentage();
+
+  // Put device to deep sleep
+  esp_deep_sleep_start();
+}
+
+/********************* Arduino functions **************************/
+void setup() {
+  // Init button switch
+  pinMode(BUTTON_PIN, INPUT_PULLUP);
+
+  // Optional: set Zigbee device name and model
+  zbTempSensor.setManufacturerAndModel("Espressif", "SleepyZigbeeTempSensor");
+
+  // Set minimum and maximum temperature measurement value (10-50°C is default range for chip temperature measurement)
+  zbTempSensor.setMinMaxValue(10, 50);
+
+  // Set tolerance for temperature measurement in °C (lowest possible value is 0.01°C)
+  zbTempSensor.setTolerance(1);
+
+  // Set power source to battery and battery percentage to 100%
+  zbTempSensor.setPowerSource(ZB_POWER_SOURCE_BATTERY, 100);
+
+  // Add endpoint to Zigbee Core
+  Zigbee.addEndpoint(&zbTempSensor);
+
+  // Configure the wake up source and set to wake up every 5 seconds
+  esp_sleep_enable_timer_wakeup(TIME_TO_SLEEP * uS_TO_S_FACTOR);
+
+  // Create a custom Zigbee configuration for End Device
+  esp_zb_cfg_t zigbeeConfig = ZIGBEE_DEFAULT_ED_CONFIG();
+  zigbeeConfig.nwk_cfg.zed_cfg.keep_alive = 10000;
+
+  // When all EPs are registered, start Zigbee in End Device mode
+  Zigbee.begin(&zigbeeConfig, false);
+
+  // Wait for Zigbee to start
+  while(!Zigbee.isStarted()){
+    delay(100);
+  }
+
+  // Delay 5s to allow establishing connection with coordinator, needed for sleepy devices
+  delay(5000);
+}
+
+void loop() {
+  // Checking button for factory reset
+  if (digitalRead(BUTTON_PIN) == LOW) {  // Push button pressed
+    // Key debounce handling
+    delay(100);
+    int startTime = millis();
+    while (digitalRead(BUTTON_PIN) == LOW) {
+      delay(50);
+      if ((millis() - startTime) > 3000) {
+        // If key pressed for more than 3secs, factory reset Zigbee and reboot
+        Zigbee.factoryReset();
+      }
+    }
+  }
+
+  // Call the function to measure temperature and put the device to sleep
+  meausureAndSleep();
+}

libraries/Zigbee/examples/Zigbee_Temperature_Sensor_Sleepy/ci.json

@@ -0,0 +1,6 @@
+{
+  "fqbn_append": "PartitionScheme=zigbee,ZigbeeMode=ed",
+  "requires": [
+    "CONFIG_SOC_IEEE802154_SUPPORTED=y"
+  ]
+}

libraries/Zigbee/src/ZigbeeCore.cpp

@@ -155,7 +155,7 @@ void ZigbeeCore::setRebootOpenNetwork(uint8_t time) {
 }
 
 void ZigbeeCore::openNetwork(uint8_t time) {
-  if (_started) {
+  if (isStarted()) {
     log_v("Opening network for joining for %d seconds", time);
     esp_zb_bdb_open_network(time);
   }
@@ -201,10 +201,15 @@ void esp_zb_app_signal_handler(esp_zb_app_signal_t *signal_struct) {
             log_i("Opening network for joining for %d seconds", Zigbee._open_network);
             esp_zb_bdb_open_network(Zigbee._open_network);
           }
+          if(Zigbee._sleepy_device) {
+            log_i("Device is a sleepy end device");
+            Zigbee._can_sleep = true;
+          }
         }
       } else {
         /* commissioning failed */
         log_e("Failed to initialize Zigbee stack (status: %s)", esp_err_to_name(err_status));
+        esp_restart();
       }
       break;
     case ESP_ZB_BDB_SIGNAL_FORMATION:  // Coordinator
@@ -225,11 +230,11 @@ void esp_zb_app_signal_handler(esp_zb_app_signal_t *signal_struct) {
       }
       break;
     case ESP_ZB_BDB_SIGNAL_STEERING:  // Router and End Device
-      Zigbee._started = true;
       if ((zigbee_role_t)Zigbee.getRole() == ZIGBEE_COORDINATOR) {
         if (err_status == ESP_OK) {
           log_i("Network steering started");
         }
+        Zigbee._started = true;
       } else {
         if (err_status == ESP_OK) {
           esp_zb_ieee_addr_t extended_pan_id;
@@ -239,6 +244,7 @@ void esp_zb_app_signal_handler(esp_zb_app_signal_t *signal_struct) {
             extended_pan_id[7], extended_pan_id[6], extended_pan_id[5], extended_pan_id[4], extended_pan_id[3], extended_pan_id[2], extended_pan_id[1],
             extended_pan_id[0], esp_zb_get_pan_id(), esp_zb_get_current_channel(), esp_zb_get_short_address()
           );
+          Zigbee._started = true;
         } else {
           log_i("Network steering was not successful (status: %s)", esp_err_to_name(err_status));
           esp_zb_scheduler_alarm((esp_zb_callback_t)bdb_start_top_level_commissioning_cb, ESP_ZB_BDB_MODE_NETWORK_STEERING, 1000);
@@ -321,7 +327,7 @@ void ZigbeeCore::scanCompleteCallback(esp_zb_zdp_status_t zdo_status, uint8_t co
 }
 
 void ZigbeeCore::scanNetworks(u_int32_t channel_mask, u_int8_t scan_duration) {
-  if (!_started) {
+  if (!isStarted()) {
     log_e("Zigbee stack is not started, cannot scan networks");
     return;
   }

libraries/Zigbee/src/ZigbeeEP.cpp

@@ -5,6 +5,7 @@
 #if SOC_IEEE802154_SUPPORTED
 
 #include "esp_zigbee_cluster.h"
+#include "zcl/esp_zigbee_zcl_power_config.h"
 
 uint8_t ZigbeeEP::_endpoint = 0;
 bool ZigbeeEP::_is_bound = false;
@@ -65,6 +66,45 @@ void ZigbeeEP::setManufacturerAndModel(const char *name, const char *model) {
   esp_zb_basic_cluster_add_attr(basic_cluster, ESP_ZB_ZCL_ATTR_BASIC_MODEL_IDENTIFIER_ID, (void *)zb_model);
 }
 
+void ZigbeeEP::setPowerSource(zb_power_source_t power_source, uint8_t percentage) {
+  esp_zb_attribute_list_t *basic_cluster = esp_zb_cluster_list_get_cluster(_cluster_list, ESP_ZB_ZCL_CLUSTER_ID_BASIC, ESP_ZB_ZCL_CLUSTER_SERVER_ROLE);
+  esp_zb_cluster_update_attr(basic_cluster, ESP_ZB_ZCL_ATTR_BASIC_POWER_SOURCE_ID, (void *)&power_source);
+
+  if(power_source == ZB_POWER_SOURCE_BATTERY){
+    //TODO:
+      //UPDATE MAC CAPABILITIES TO SET POWER SOURCE TO BATTERY
+      //currently its not possible to update mac capabilities
+    // Add power config cluster and battery percentage attribute
+    esp_zb_attribute_list_t *power_config_cluster = esp_zb_zcl_attr_list_create(ESP_ZB_ZCL_CLUSTER_ID_POWER_CONFIG);
+    esp_zb_power_config_cluster_add_attr(power_config_cluster, ESP_ZB_ZCL_ATTR_POWER_CONFIG_BATTERY_PERCENTAGE_REMAINING_ID, (void *)&percentage);
+    esp_zb_cluster_list_add_power_config_cluster(_cluster_list, power_config_cluster, ESP_ZB_ZCL_CLUSTER_SERVER_ROLE);
+  }
+}
+
+void ZigbeeEP::setBatteryPercentage(uint8_t percentage) {
+  esp_zb_lock_acquire(portMAX_DELAY);
+  esp_zb_zcl_set_attribute_val(
+    _endpoint, ESP_ZB_ZCL_CLUSTER_ID_POWER_CONFIG, ESP_ZB_ZCL_CLUSTER_SERVER_ROLE, ESP_ZB_ZCL_ATTR_POWER_CONFIG_BATTERY_PERCENTAGE_REMAINING_ID, &percentage, false
+  );
+  esp_zb_lock_release();
+  log_v("Battery percentage updated");
+}
+
+void ZigbeeEP::reportBatteryPercentage() {
+    /* Send report attributes command */
+  esp_zb_zcl_report_attr_cmd_t report_attr_cmd;
+  report_attr_cmd.address_mode = ESP_ZB_APS_ADDR_MODE_DST_ADDR_ENDP_NOT_PRESENT;
+  report_attr_cmd.attributeID = ESP_ZB_ZCL_ATTR_POWER_CONFIG_BATTERY_PERCENTAGE_REMAINING_ID;
+  report_attr_cmd.cluster_role = ESP_ZB_ZCL_CLUSTER_SERVER_ROLE;
+  report_attr_cmd.clusterID = ESP_ZB_ZCL_CLUSTER_ID_POWER_CONFIG;
+  report_attr_cmd.zcl_basic_cmd.src_endpoint = _endpoint;
+
+  esp_zb_lock_acquire(portMAX_DELAY);
+  esp_zb_zcl_report_attr_cmd_req(&report_attr_cmd);
+  esp_zb_lock_release();
+  log_v("Battery percentage reported");
+}
+
 char *ZigbeeEP::readManufacturer(uint8_t endpoint, uint16_t short_addr) {
   /* Read peer Manufacture Name & Model Identifier */
   esp_zb_zcl_read_attr_cmd_t read_req;

libraries/Zigbee/src/ZigbeeEP.h

@@ -46,9 +46,10 @@ typedef struct zb_device_params_s {
 } zb_device_params_t;
 
 typedef enum {
-  SINGLE_COLOR = 0,
-  RGB = 1
-} zb_identify_led_type_t;
+  ZB_POWER_SOURCE_UNKNOWN = 0x00,
+  ZB_POWER_SOURCE_MAINS = 0x01,
+  ZB_POWER_SOURCE_BATTERY = 0x03,
+} zb_power_source_t;
 
 /* Zigbee End Device Class */
 class ZigbeeEP {
@@ -81,6 +82,9 @@ class ZigbeeEP {
 
   // Manufacturer name and model implemented
   void setManufacturerAndModel(const char *name, const char *model);
+  void setPowerSource(zb_power_source_t power_source, uint8_t percentage = 255);
+  void setBatteryPercentage(uint8_t percentage);
+  void reportBatteryPercentage();
 
   // Methods to read manufacturer and model name from selected endpoint and short address
   char *readManufacturer(uint8_t endpoint, uint16_t short_addr);