feat(zigbee): Add Analog endpoint device (input, output, value clusters)

CMakeLists.txt

@@ -294,6 +294,7 @@ set(ARDUINO_LIBRARY_Zigbee_SRCS
   libraries/Zigbee/src/ep/ZigbeeDoorWindowHandle.cpp
   libraries/Zigbee/src/ep/ZigbeeWindowCovering.cpp
   libraries/Zigbee/src/ep/ZigbeeVibrationSensor.cpp
+  libraries/Zigbee/src/ep/ZigbeeAnalog.cpp
   )
 
 set(ARDUINO_LIBRARY_BLE_SRCS

libraries/Zigbee/examples/Zigbee_Analog_Input_Output/README.md

@@ -0,0 +1,72 @@
+# Arduino-ESP32 Zigbee Analog Input Output Example
+
+This example shows how to configure the Zigbee end device and use it as a Home Automation (HA) analog input/output device.
+
+# Supported Targets
+
+Currently, this example supports the following targets.
+
+| Supported Targets | ESP32-C6 | ESP32-H2 |
+| ----------------- | -------- | -------- |
+
+## Analog Sensor Functions
+
+ * After this board first starts up, it would be configured locally to report an analog input on change or every 30 seconds.
+ * By clicking the button (BOOT) on this board, this board will immediately send a report of the current measured  value to the network.
+
+## Hardware Required
+
+* A USB cable for power supply and programming
+
+### Configure the Project
+
+Set the ADC GPIO by changing the `analogPin` variable. By default, it's the pin `A0`.
+Set the Button GPIO by changing the `button` variable. By default, it's the pin `BOOT_PIN` (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_Analog_Input_Output/Zigbee_Analog_Input_Output.ino

@@ -0,0 +1,120 @@
+// Copyright 2025 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 analog input / output device.
+ *
+ * The example demonstrates how to use Zigbee library to create a end device analog device.
+ * 
+ * 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/)
+ * Modified by Pat Clay
+ */
+
+ #ifndef ZIGBEE_MODE_ED
+ #error "Zigbee end device mode is not selected in Tools->Zigbee mode"
+ #endif
+
+ #include "Zigbee.h"
+
+ /* Zigbee analog device configuration */
+ #define ANALOG_DEVICE_ENDPOINT_NUMBER 1
+
+ uint8_t analogPin = A0;
+ uint8_t button = BOOT_PIN;
+
+ ZigbeeAnalog zbAnalogDevice = ZigbeeAnalog(ANALOG_DEVICE_ENDPOINT_NUMBER);
+
+ void onAnalogOutputChange(float analog_output) {
+   Serial.printf("Received analog output change: %.1f\r\n", analog_output);
+ }
+
+ void setup() {
+   Serial.begin(115200);
+   Serial.println("Starting...");
+
+   // Init button switch
+   pinMode(button, INPUT_PULLUP);
+
+   // Set analog resolution to 10 bits
+   analogReadResolution(10);
+
+   // Optional: set Zigbee device name and model
+   zbAnalogDevice.setManufacturerAndModel("Espressif", "ZigbeeAnalogDevice");
+
+   // Add analog sensor cluster to Zigbee Analog accoding your needs
+   zbAnalogDevice.addAnalogInput();
+   zbAnalogDevice.addAnalogOutput();
+
+   // If analog output cluster is added, set callback function for analog output change
+   zbAnalogDevice.onAnalogOutputChange(onAnalogOutputChange);
+
+   // Add endpoints to Zigbee Core
+   Zigbee.addEndpoint(&zbAnalogDevice);
+
+   Serial.println("Starting Zigbee...");
+   // When all EPs are registered, start Zigbee in End Device mode
+   if (!Zigbee.begin()) {
+     Serial.println("Zigbee failed to start!");
+     Serial.println("Rebooting...");
+     ESP.restart();
+   } else {
+     Serial.println("Zigbee started successfully!");
+   }
+   Serial.println("Connecting to network");
+   while (!Zigbee.connected()) {
+     Serial.print(".");
+     delay(100);
+   }
+   Serial.println("Connected");
+
+   // Optional: Add reporting for analog input
+   zbAnalogDevice.setAnalogInputReporting(0, 30, 10); // report every 30 seconds if value changes by 10
+ }
+
+ void loop() {
+   static uint32_t timeCounter = 0;
+
+   // Read ADC value and update the analog value every 2s
+   if (!(timeCounter++ % 20)) {  // delaying for 100ms x 20 = 2s
+     float analog = (float)analogRead(analogPin);
+     Serial.printf("Updating analog input to %.1f\r\n", analog);
+     zbAnalogDevice.setAnalogInput(analog);
+
+     // Analog input supports reporting
+     zbAnalogDevice.reportAnalogInput();
+   }
+
+   // Checking button for factory reset and reporting
+   if (digitalRead(button) == LOW) {  // Push button pressed
+     // Key debounce handling
+     delay(100);
+     int startTime = millis();
+     while (digitalRead(button) == LOW) {
+       delay(50);
+       if ((millis() - startTime) > 3000) {
+         // If key pressed for more than 3secs, factory reset Zigbee and reboot
+         Serial.println("Resetting Zigbee to factory and rebooting in 1s.");
+         delay(1000);
+         Zigbee.factoryReset();
+       }
+     }
+   }
+   delay(100);
+ }
+

libraries/Zigbee/examples/Zigbee_Analog_Input_Output/ci.json

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

libraries/Zigbee/src/Zigbee.h

@@ -15,6 +15,7 @@
 #include "ep/ZigbeeTempSensor.h"
 #include "ep/ZigbeeThermostat.h"
 #include "ep/ZigbeePressureSensor.h"
+#include "ep/ZigbeeAnalog.h"
 #include "ep/ZigbeeFlowSensor.h"
 #include "ep/ZigbeeOccupancySensor.h"
 #include "ep/ZigbeeCarbonDioxideSensor.h"

libraries/Zigbee/src/ep/ZigbeeAnalog.cpp

@@ -0,0 +1,133 @@
+#include "ZigbeeAnalog.h"
+#if SOC_IEEE802154_SUPPORTED && CONFIG_ZB_ENABLED
+
+esp_zb_cluster_list_t *zigbee_analog_clusters_create(zigbee_analog_cfg_t *analog_sensor) {
+  esp_zb_basic_cluster_cfg_t *basic_cfg = analog_sensor ? &(analog_sensor->basic_cfg) : NULL;
+  esp_zb_identify_cluster_cfg_t *identify_cfg = analog_sensor ? &(analog_sensor->identify_cfg) : NULL;
+  esp_zb_cluster_list_t *cluster_list = esp_zb_zcl_cluster_list_create();
+  esp_zb_cluster_list_add_basic_cluster(cluster_list, esp_zb_basic_cluster_create(basic_cfg), ESP_ZB_ZCL_CLUSTER_SERVER_ROLE);
+  esp_zb_cluster_list_add_identify_cluster(cluster_list, esp_zb_identify_cluster_create(identify_cfg), ESP_ZB_ZCL_CLUSTER_SERVER_ROLE);
+  return cluster_list;
+}
+
+ZigbeeAnalog::ZigbeeAnalog(uint8_t endpoint) : ZigbeeEP(endpoint) {
+  _device_id = ESP_ZB_HA_SIMPLE_SENSOR_DEVICE_ID;
+
+  //Create custom analog sensor configuration
+  zigbee_analog_cfg_t analog_cfg = ZIGBEE_DEFAULT_ANALOG_CONFIG();
+  _cluster_list = zigbee_analog_clusters_create(&analog_cfg);
+
+  _ep_config = {.endpoint = _endpoint, .app_profile_id = ESP_ZB_AF_HA_PROFILE_ID, .app_device_id = ESP_ZB_HA_SIMPLE_SENSOR_DEVICE_ID, .app_device_version = 0};
+}
+
+void ZigbeeAnalog::addAnalogValue() {
+  esp_zb_cluster_list_add_analog_value_cluster(
+    _cluster_list, esp_zb_analog_value_cluster_create(NULL), ESP_ZB_ZCL_CLUSTER_SERVER_ROLE
+  );
+  _analog_clusters |= ANALOG_VALUE;
+}
+
+void ZigbeeAnalog::addAnalogInput() {
+  esp_zb_cluster_list_add_analog_input_cluster(
+    _cluster_list, esp_zb_analog_input_cluster_create(NULL), ESP_ZB_ZCL_CLUSTER_SERVER_ROLE
+  );
+  _analog_clusters |= ANALOG_INPUT;
+}
+
+void ZigbeeAnalog::addAnalogOutput() {
+  esp_zb_cluster_list_add_analog_output_cluster(
+    _cluster_list, esp_zb_analog_output_cluster_create(NULL), ESP_ZB_ZCL_CLUSTER_SERVER_ROLE
+  );
+  _analog_clusters |= ANALOG_OUTPUT;
+}
+
+//set attribute method -> method overridden in child class
+void ZigbeeAnalog::zbAttributeSet(const esp_zb_zcl_set_attr_value_message_t *message) {
+  if (message->info.cluster == ESP_ZB_ZCL_CLUSTER_ID_ANALOG_OUTPUT) {
+    if (message->attribute.id == ESP_ZB_ZCL_ATTR_ANALOG_OUTPUT_PRESENT_VALUE_ID && message->attribute.data.type == ESP_ZB_ZCL_ATTR_TYPE_SINGLE) {
+      float analog_output = *(float *)message->attribute.data.value;
+      analogOutputChanged(analog_output);
+    } else {
+      log_w("Received message ignored. Attribute ID: %d not supported for Analog Output", message->attribute.id);
+    }
+  } else {
+    log_w("Received message ignored. Cluster ID: %d not supported for Analog endpoint", message->info.cluster);
+  }
+}
+
+void ZigbeeAnalog::analogOutputChanged(float analog_output) {
+  if (_on_analog_output_change) {
+    _on_analog_output_change(analog_output);
+  } else {
+    log_w("No callback function set for analog output change");
+  }
+}
+
+void ZigbeeAnalog::setAnalogValue(float analog) {
+  if(!(_analog_clusters & ANALOG_VALUE)) {
+    log_e("Analog Value cluster not added");
+    return;
+  }
+  // float zb_analog = analog;
+  log_d("Setting analog value to %.1f", analog);
+  esp_zb_lock_acquire(portMAX_DELAY);
+  esp_zb_zcl_set_attribute_val(
+    _endpoint, ESP_ZB_ZCL_CLUSTER_ID_ANALOG_VALUE, ESP_ZB_ZCL_CLUSTER_SERVER_ROLE, ESP_ZB_ZCL_ATTR_ANALOG_VALUE_PRESENT_VALUE_ID,
+    &analog, false
+  );
+  esp_zb_lock_release();
+}
+
+void ZigbeeAnalog::setAnalogInput(float analog) {
+  if(!(_analog_clusters & ANALOG_INPUT)) {
+    log_e("Analog Input cluster not added");
+    return;
+  }
+  // float zb_analog = analog;
+  log_d("Setting analog input to %.1f", analog);
+  esp_zb_lock_acquire(portMAX_DELAY);
+  esp_zb_zcl_set_attribute_val(
+    _endpoint, ESP_ZB_ZCL_CLUSTER_ID_ANALOG_INPUT, ESP_ZB_ZCL_CLUSTER_SERVER_ROLE, ESP_ZB_ZCL_ATTR_ANALOG_INPUT_PRESENT_VALUE_ID,
+    &analog, false
+  );
+  esp_zb_lock_release();
+}
+
+void ZigbeeAnalog::reportAnalogInput() {
+  /* 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_ANALOG_INPUT_PRESENT_VALUE_ID;
+  report_attr_cmd.direction = ESP_ZB_ZCL_CMD_DIRECTION_TO_CLI;
+  report_attr_cmd.clusterID = ESP_ZB_ZCL_CLUSTER_ID_ANALOG_INPUT;
+  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("Analog Input report sent");
+}
+
+void ZigbeeAnalog::setAnalogInputReporting(uint16_t min_interval, uint16_t max_interval, float delta) {
+  esp_zb_zcl_reporting_info_t reporting_info;
+  memset(&reporting_info, 0, sizeof(esp_zb_zcl_reporting_info_t));
+  reporting_info.direction = ESP_ZB_ZCL_CMD_DIRECTION_TO_SRV;
+  reporting_info.ep = _endpoint;
+  reporting_info.cluster_id = ESP_ZB_ZCL_CLUSTER_ID_TEMP_MEASUREMENT;
+  reporting_info.cluster_role = ESP_ZB_ZCL_CLUSTER_SERVER_ROLE;
+  reporting_info.attr_id = ESP_ZB_ZCL_ATTR_TEMP_MEASUREMENT_VALUE_ID;
+  reporting_info.u.send_info.min_interval = min_interval;
+  reporting_info.u.send_info.max_interval = max_interval;
+  reporting_info.u.send_info.def_min_interval = min_interval;
+  reporting_info.u.send_info.def_max_interval = max_interval;
+  reporting_info.u.send_info.delta.s32 = delta;
+  reporting_info.dst.profile_id = ESP_ZB_AF_HA_PROFILE_ID;
+  reporting_info.manuf_code = ESP_ZB_ZCL_ATTR_NON_MANUFACTURER_SPECIFIC;
+
+  esp_zb_lock_acquire(portMAX_DELAY);
+  esp_zb_zcl_update_reporting_info(&reporting_info);
+  esp_zb_lock_release();
+}
+
+
+#endif  //SOC_IEEE802154_SUPPORTED && CONFIG_ZB_ENABLED