esp-zigbee-sdk: release/v1.5.0(6bd34178)

- Updated esp-zboss-lib to v1.5.0
- Updated esp-zigbee-lib to v1.5.0
- Added support for ZCL OTA upgrade optional header setting
- Added support for ZCL OTA upgrade frame fragmentation
- Added support for ZCL light sensor device
- Added support for ZCL pH measurement cluster
- Added support for ZCL electrical conductivity measurement cluster
- Added support for ZCL gateway endpoint without a client cluster to handle report attribute commands
- Added support for NWK maximum children setting
- Optimized ZCL OTA upgrade rate
- Deprecated `esp_zb_main_loop_iteration()`; use `esp_zb_stack_main_loop()` instead
- Unified the MACRO format for the default attributes of carbon dioxide, PM2.5, temperature, flow, and humidity measurement clusters
- Fixed the issue with syncing ZCL diagnostic cluster attributes with the stack
- Fixed the crashing issue caused by the RX queue being busy when enabling ZB_RADIO_SPINEL_UART
- Fixed the unexpected delay in setpoint execution when using the thermostat cluster weekly schedule
- Fixed the incorrect check for the minimum dead band of the thermostat cluster
- Fixed the invalid endpoint ID in some core action messages

- Closes: #401
- Closes: #382
- Closes: #356

RELEASE_NOTES.md

@@ -1,5 +1,40 @@
 # Espressif Zigbee SDK Release Notes
 
+## 27-Aug-2024
+1.5.0 version release of ESP-ZIGBEE-SDK is based on esp-idf v5.1.4
+
+### Features
+- Added support for ZCL OTA upgrade optional header setting
+- Added support for ZCL OTA upgrade frame fragmentation
+- Added support for ZCL light sensor device
+- Added support for ZCL pH measurement cluster
+- Added support for ZCL electrical conductivity measurement cluster
+- Added support for ZCL gateway endpoint without a client cluster to handle report attribute commands
+- Added support for NWK maximum children setting
+
+### Bug Fixes
+- Fixed the issue with syncing ZCL diagnostic cluster attributes with the stack
+- Fixed the crashing issue caused by the RX queue being busy when enabling ZB_RADIO_SPINEL_UART
+- Fixed the unexpected delay in setpoint execution when using the thermostat cluster weekly schedule
+- Fixed the incorrect check for the minimum dead band of the thermostat cluster
+- Fixed the invalid endpoint ID in some core action messages
+
+### Changes
+- Updated esp-zboss-lib to v1.5.0
+- Updated esp-zigbee-lib to v1.5.0
+- Optimized ZCL OTA upgrade rate
+- Deprecated `esp_zb_main_loop_iteration()`; use `esp_zb_stack_main_loop()` instead
+- Unified the MACRO format for the default attributes of carbon dioxide, PM2.5, temperature, flow, and humidity measurement clusters
+
+### Breaking Changes
+- Renamed `esp_zb_window_covering_controller_cluster_create()` to `esp_zb_window_covering_controller_clusters_create()`
+- Renamed `esp_zb_on_off_switch_cfg_cluster_create()` to `esp_zb_on_off_switch_config_cluster_create()`
+- Changed the parameter of `esp_zb_ias_ace_cluster_create()` from `uint8_t` to `esp_zb_ias_ace_cluster_cfg_t *`
+- Changed the parameter of `esp_zb_touchlink_commissioning_cluster_create()` from `void` to `esp_zb_touchlink_commissioning_cfg_t *`
+- Changed the parameter of `esp_zb_diagnostics_cluster_create()` from `void` to `esp_zb_diagnostics_cluster_cfg_t *`
+- Changed the parameter of `esp_zb_price_cluster_create()` from `void` to `esp_zb_price_cluster_cfg_t *`
+
+
 ## 19-Jul-2024
 1.4.1 version release of ESP-ZIGBEE-SDK is based on esp-idf v5.1.4
 

components/esp-zigbee-lib/idf_component.yml

@@ -1,4 +1,4 @@
-version: "1.4.1"
+version: "1.5.0"
 description: esp-zigbee library component
 url: https://github.com/espressif/esp-zigbee-sdk
 dependencies:

docs/Doxyfile

@@ -72,6 +72,9 @@ INPUT = \
     $(PROJECT_PATH)/components/esp-zigbee-lib/include/zcl/esp_zigbee_zcl_commissioning.h               \
     $(PROJECT_PATH)/components/esp-zigbee-lib/include/zcl/esp_zigbee_zcl_ias_ace.h                     \
     $(PROJECT_PATH)/components/esp-zigbee-lib/include/zcl/esp_zigbee_zcl_ias_wd.h                      \
+    $(PROJECT_PATH)/components/esp-zigbee-lib/include/zcl/esp_zigbee_zcl_ec_measurement.h              \
+    $(PROJECT_PATH)/components/esp-zigbee-lib/include/zcl/esp_zigbee_zcl_ph_measurement.h              \
+    $(PROJECT_PATH)/components/esp-zigbee-lib/include/zcl/esp_zigbee_zcl_wind_speed_measurement.h      \
     $(PROJECT_PATH)/components/esp-zigbee-lib/include/zdo/esp_zigbee_zdo_command.h                     \
     $(PROJECT_PATH)/components/esp-zigbee-lib/include/zdo/esp_zigbee_zdo_common.h                      \
     $(PROJECT_PATH)/components/esp-zigbee-lib/include/bdb/esp_zigbee_bdb_touchlink.h                   \

docs/en/api-reference/zcl/esp_zigbee_zcl_ec_measurement.rst

@@ -0,0 +1,7 @@
+ZCL electrical conductivity measurement
+=======================================
+
+Zigbee Cluster Library (ZCL) electrical conductivity measurement cluster usage definition for ESP Zigbee SDK.
+
+
+.. include-build-file:: inc/esp_zigbee_zcl_ec_measurement.inc

docs/en/api-reference/zcl/esp_zigbee_zcl_ph_measurement.rst

@@ -0,0 +1,7 @@
+ZCL pH measurement
+==================
+
+Zigbee Cluster Library (ZCL) pH measurement cluster usage definition for ESP Zigbee SDK.
+
+
+.. include-build-file:: inc/esp_zigbee_zcl_ph_measurement.inc

docs/en/api-reference/zcl/esp_zigbee_zcl_wind_speed_measurement.rst

@@ -0,0 +1,7 @@
+ZCL wind speed measurement
+==========================
+
+Zigbee Cluster Library (ZCL) wind speed measurement cluster usage definition for ESP Zigbee SDK.
+
+
+.. include-build-file:: inc/esp_zigbee_zcl_wind_speed_measurement.inc

docs/en/api-reference/zcl/index.rst

@@ -48,4 +48,7 @@ This section provides the ESP Zigbee SDK's APIs that support different kind of Z
    esp_zigbee_zcl_flow_measurement
    esp_zigbee_zcl_commissioning
    esp_zigbee_zcl_ias_ace
-   esp_zigbee_zcl_ias_wd
+   esp_zigbee_zcl_ias_wd
+   esp_zigbee_zcl_ec_measurement
+   esp_zigbee_zcl_ph_measurement
+   esp_zigbee_zcl_wind_speed_measurement

docs/en/introduction.rst

@@ -74,51 +74,54 @@ The supported features in current ESP Zigbee SDK are listed below:
 .. table:: **ZCL cluster**
    :align: center
 
-   =========================== ============ 
-          Cluster Name          Cluster ID  
-   =========================== ============ 
-            basic                 0x0000    
-      power_configuration         0x0001
-           identify               0x0003    
-            groups                0x0004    
-            scenes                0x0005    
-            on_off                0x0006    
-       on_off_switch_cfg          0x0007    
-         level_control            0x0008    
-             time                 0x000a
-         analog_input             0x000c
-         analog_output            0x000d
-         analog_value             0x000e
-         binary_input             0x000f
-       multistate_value           0x0014
-        commissioning             0x0015
-              ota                 0x0019
-         green_power              0x0021    
-         shade_config             0x0100    
-           door_lock              0x0101
-        window_covering           0x0102
-          thermostat              0x0201
-          fan_control             0x0202
-    thermostat_user_interface     0x0204
-         color_control            0x0300
-    illuminance_measurement       0x0400   
-    temperature_measurement       0x0402
-      pressure_measurement        0x0403
-        flow_measurement          0x0404
-      humidity_measurement        0x0405
-       occupancy_sensing          0x0406
-    carbon_dioxide_measurement    0x040d
-       PM2.5_measurement          0x042a
-           ias_zone               0x0500
-           ias_ace                0x0501
-           ias_wd                 0x0502
-            price                 0x0700
-           metering               0x0702
-     meter_identification         0x0b01
-    electrical_measurement        0x0b04
-          diagnostics             0x0b05
-    touchlink_commissioning       0x1000
-   =========================== ============ 
+   =====================================  ============
+               Cluster Name                Cluster ID
+   =====================================  ============
+     basic                                  0x0000
+     power_configuration                    0x0001
+     identify                               0x0003
+     groups                                 0x0004
+     scenes                                 0x0005
+     on_off                                 0x0006
+     on_off_switch_cfg                      0x0007
+     level_control                          0x0008
+     time                                   0x000a
+     analog_input                           0x000c
+     analog_output                          0x000d
+     analog_value                           0x000e
+     binary_input                           0x000f
+     multistate_value                       0x0014
+     commissioning                          0x0015
+     ota                                    0x0019
+     green_power                            0x0021
+     shade_config                           0x0100
+     door_lock                              0x0101
+     window_covering                        0x0102
+     thermostat                             0x0201
+     fan_control                            0x0202
+     thermostat_user_interface              0x0204
+     color_control                          0x0300
+     illuminance_measurement                0x0400
+     temperature_measurement                0x0402
+     pressure_measurement                   0x0403
+     flow_measurement                       0x0404
+     humidity_measurement                   0x0405
+     occupancy_sensing                      0x0406
+     pH_measurement                         0x0409
+     electrical_conductivity_measurement    0x040a
+     wind_speed_measurement                 0x040b
+     carbon_dioxide_measurement             0x040d
+     PM2.5_measurement                      0x042a
+     ias_zone                               0x0500
+     ias_ace                                0x0501
+     ias_wd                                 0x0502
+     price                                  0x0700
+     metering                               0x0702
+     meter_identification                   0x0b01
+     electrical_measurement                 0x0b04
+     diagnostics                            0x0b05
+     touchlink_commissioning                0x1000
+   =====================================  ============
 
 
 1.2.1.1 Attributes and Commands

examples/esp_zigbee_HA_sample/HA_color_dimmable_light/main/idf_component.yml

@@ -1,7 +1,7 @@
 ## IDF Component Manager Manifest File
 dependencies:
-  espressif/esp-zboss-lib: "~1.4.0"
-  espressif/esp-zigbee-lib: "~1.4.0"
+  espressif/esp-zboss-lib: "~1.5.0"
+  espressif/esp-zigbee-lib: "~1.5.0"
   espressif/led_strip: "~2.0.0"
   ## Required IDF version
   idf:

examples/esp_zigbee_HA_sample/HA_color_dimmable_switch/main/idf_component.yml

@@ -1,7 +1,7 @@
 ## IDF Component Manager Manifest File
 dependencies:
-  espressif/esp-zboss-lib: "~1.4.0"
-  espressif/esp-zigbee-lib: "~1.4.0"
+  espressif/esp-zboss-lib: "~1.5.0"
+  espressif/esp-zigbee-lib: "~1.5.0"
   ## Required IDF version
   idf:
     version: ">=5.0.0"

examples/esp_zigbee_HA_sample/HA_on_off_light/main/idf_component.yml

@@ -1,7 +1,7 @@
 ## IDF Component Manager Manifest File
 dependencies:
-  espressif/esp-zboss-lib: "~1.4.0"
-  espressif/esp-zigbee-lib: "~1.4.0"
+  espressif/esp-zboss-lib: "~1.5.0"
+  espressif/esp-zigbee-lib: "~1.5.0"
   espressif/led_strip: "~2.0.0"
   ## Required IDF version
   idf:

examples/esp_zigbee_HA_sample/HA_on_off_switch/main/idf_component.yml

@@ -1,7 +1,7 @@
 ## IDF Component Manager Manifest File
 dependencies:
-  espressif/esp-zboss-lib: "~1.4.0"
-  espressif/esp-zigbee-lib: "~1.4.0"
+  espressif/esp-zboss-lib: "~1.5.0"
+  espressif/esp-zigbee-lib: "~1.5.0"
   ## Required IDF version
   idf:
     version: ">=5.0.0"

examples/esp_zigbee_HA_sample/HA_temperature_sensor/main/idf_component.yml

@@ -1,7 +1,7 @@
 ## IDF Component Manager Manifest File
 dependencies:
-  espressif/esp-zboss-lib: "~1.4.0"
-  espressif/esp-zigbee-lib: "~1.4.0"
+  espressif/esp-zboss-lib: "~1.5.0"
+  espressif/esp-zigbee-lib: "~1.5.0"
   ## Required IDF version
   idf:
     version: ">=5.0.0"

examples/esp_zigbee_HA_sample/HA_thermostat/main/idf_component.yml

@@ -1,7 +1,7 @@
 ## IDF Component Manager Manifest File
 dependencies:
-  espressif/esp-zboss-lib: "~1.4.0"
-  espressif/esp-zigbee-lib: "~1.4.0"
+  espressif/esp-zboss-lib: "~1.5.0"
+  espressif/esp-zigbee-lib: "~1.5.0"
   ## Required IDF version
   idf:
     version: ">=5.0.0"

examples/esp_zigbee_cli/main/idf_component.yml

@@ -1,7 +1,7 @@
 ## IDF Component Manager Manifest File
 dependencies:
-  espressif/esp-zboss-lib: "~1.4.0"
-  espressif/esp-zigbee-lib: "~1.4.0"
+  espressif/esp-zboss-lib: "~1.5.0"
+  espressif/esp-zigbee-lib: "~1.5.0"
   ## Required IDF version
   idf:
     version: ">=5.0.0"

examples/esp_zigbee_customized_devices/customized_client/main/idf_component.yml

@@ -1,7 +1,7 @@
 ## IDF Component Manager Manifest File
 dependencies:
-  espressif/esp-zboss-lib: "~1.4.0"
-  espressif/esp-zigbee-lib: "~1.4.0"
+  espressif/esp-zboss-lib: "~1.5.0"
+  espressif/esp-zigbee-lib: "~1.5.0"
   ## Required IDF version
   idf:
     version: ">=5.0.0"

examples/esp_zigbee_customized_devices/customized_server/main/idf_component.yml

@@ -1,7 +1,7 @@
 ## IDF Component Manager Manifest File
 dependencies:
-  espressif/esp-zboss-lib: "~1.4.0"
-  espressif/esp-zigbee-lib: "~1.4.0"
+  espressif/esp-zboss-lib: "~1.5.0"
+  espressif/esp-zigbee-lib: "~1.5.0"
   espressif/led_strip: "~2.0.0"
   ## Required IDF version
   idf:

examples/esp_zigbee_gateway/main/idf_component.yml

@@ -1,7 +1,7 @@
 ## IDF Component Manager Manifest File
 dependencies:
-  espressif/esp-zboss-lib: "~1.4.0"
-  espressif/esp-zigbee-lib: "~1.4.0"
+  espressif/esp-zboss-lib: "~1.5.0"
+  espressif/esp-zigbee-lib: "~1.5.0"
   espressif/esp_rcp_update: "~0.3.0"
   espressif/esp-serial-flasher: "~0.0.4"
   ## Required IDF version

examples/esp_zigbee_greenpower/esp_zigbee_gpc/main/idf_component.yml

@@ -1,7 +1,7 @@
 ## IDF Component Manager Manifest File
 dependencies:
-  espressif/esp-zboss-lib: "~1.4.0"
-  espressif/esp-zigbee-lib: "~1.4.0"
+  espressif/esp-zboss-lib: "~1.5.0"
+  espressif/esp-zigbee-lib: "~1.5.0"
   espressif/led_strip: "~2.0.0"
   ## Required IDF version
   idf:

examples/esp_zigbee_greenpower/esp_zigbee_gpd/main/idf_component.yml

@@ -1,7 +1,7 @@
 ## IDF Component Manager Manifest File
 dependencies:
-  espressif/esp-zboss-lib: "~1.4.0"
-  espressif/esp-zigbee-lib: "~1.4.0"
+  espressif/esp-zboss-lib: "~1.5.0"
+  espressif/esp-zigbee-lib: "~1.5.0"
   ## Required IDF version
   idf:
     version: ">=5.0.0"

examples/esp_zigbee_ncp/main/idf_component.yml

@@ -1,7 +1,7 @@
 ## IDF Component Manager Manifest File
 dependencies:
-  espressif/esp-zboss-lib: "~1.4.0"
-  espressif/esp-zigbee-lib: "~1.4.0"
+  espressif/esp-zboss-lib: "~1.5.0"
+  espressif/esp-zigbee-lib: "~1.5.0"
   espressif/esp-zigbee-ncp:
     version: "1.*"
     override_path: "../../../components/esp-zigbee-ncp"

examples/esp_zigbee_ota/ota_client/main/idf_component.yml

@@ -1,7 +1,7 @@
 ## IDF Component Manager Manifest File
 dependencies:
-  espressif/esp-zboss-lib: "~1.4.0"
-  espressif/esp-zigbee-lib: "~1.4.0"
+  espressif/esp-zboss-lib: "~1.5.0"
+  espressif/esp-zigbee-lib: "~1.5.0"
   ## Required IDF version
   idf:
     version: ">=5.0.0"

examples/esp_zigbee_ota/ota_server/main/idf_component.yml

@@ -1,7 +1,7 @@
 ## IDF Component Manager Manifest File
 dependencies:
-  espressif/esp-zboss-lib: "~1.4.0"
-  espressif/esp-zigbee-lib: "~1.4.0"
+  espressif/esp-zboss-lib: "~1.5.0"
+  espressif/esp-zigbee-lib: "~1.5.0"
   ## Required IDF version
   idf:
     version: ">=5.0.0"

examples/esp_zigbee_sleep/deep_sleep/main/idf_component.yml

@@ -1,7 +1,7 @@
 ## IDF Component Manager Manifest File
 dependencies:
-  espressif/esp-zboss-lib: "~1.4.0"
-  espressif/esp-zigbee-lib: "~1.4.0"
+  espressif/esp-zboss-lib: "~1.5.0"
+  espressif/esp-zigbee-lib: "~1.5.0"
   # Required IDF version
   idf:
     version: ">=5.0.0"

examples/esp_zigbee_sleep/light_sleep/main/idf_component.yml

@@ -1,7 +1,7 @@
 ## IDF Component Manager Manifest File
 dependencies:
-  espressif/esp-zboss-lib: "~1.4.0"
-  espressif/esp-zigbee-lib: "~1.4.0"
+  espressif/esp-zboss-lib: "~1.5.0"
+  espressif/esp-zigbee-lib: "~1.5.0"
   # Required IDF version
   idf:
     version: ">=5.0.0"

examples/esp_zigbee_touchlink/touchlink_light/main/idf_component.yml

@@ -1,7 +1,7 @@
 ## IDF Component Manager Manifest File
 dependencies:
-  espressif/esp-zboss-lib: "~1.4.0"
-  espressif/esp-zigbee-lib: "~1.4.0"
+  espressif/esp-zboss-lib: "~1.5.0"
+  espressif/esp-zigbee-lib: "~1.5.0"
   espressif/led_strip: "~2.0.0"
   ## Required IDF version
   idf:

examples/esp_zigbee_touchlink/touchlink_switch/main/idf_component.yml

@@ -1,7 +1,7 @@
 ## IDF Component Manager Manifest File
 dependencies:
-  espressif/esp-zboss-lib: "~1.4.0"
-  espressif/esp-zigbee-lib: "~1.4.0"
+  espressif/esp-zboss-lib: "~1.5.0"
+  espressif/esp-zigbee-lib: "~1.5.0"
   ## Required IDF version
   idf:
     version: ">=5.0.0"