Skip to content

Latest commit

 

History

History
693 lines (540 loc) · 21.9 KB

RELEASE_NOTES.md

File metadata and controls

693 lines (540 loc) · 21.9 KB
Raw

Espressif Zigbee SDK Release Notes

30-Apr-2024

1.3.1 version release of ESP-ZIGBEE-SDK is based on esp-idf v5.1.3

Features

  • Updated esp-zboss-lib to v1.3.1
  • Updated esp-zigbee-lib to v1.3.1

Bug Fixes

  • Fixed the movement transition for color control
  • Fixed the jitter of broadcast endpoint handler
  • Fixed the failure in Zigbee flash read or write operations

26-Apr-2024

1.3.0 version release of ESP-ZIGBEE-SDK is based on esp-idf v5.1.3

Features

  • Updated esp-zboss-lib to v1.3.0
  • Updated esp-zigbee-lib to v1.3.0
  • Supported ZCL commissioning cluster
  • Supported devive sleep before join network
  • Supported the parameter of pointer type for scheduler_alarm
  • Supported event fd setting in application

Bug Fixes

  • Fixed the transition id checking for touchlink identify command
  • Fixed the zdo binding user callback
  • Disabled response default command for broadcasted frame
  • Closes: #276
  • Closes: #310
  • Closes: #314
  • Closes: #318
  • Closes: #325

Break Changes

  • Renamed esp_zb_radio_mode_t, esp_zb_host_connection_mode_t, zb_esp_uart_init_mode and esp_zb_serial_mode_t

12-Apr-2024

1.2.3 version release of ESP-ZIGBEE-SDK is based on esp-idf v5.1.3

Features

  • Updated esp-zboss-lib to v1.2.3
  • Updated esp-zigbee-lib to v1.2.3
  • Added flow measurement cluster support
  • Added ZCL manufacturer attribute settings
  • Optimized the accuracy for stack timer
  • Optimized device handler and endpoint handler for code size
  • Optimized ZCL hue and saturation movement method

Bug Fixes

  • Fixed the empty zdo binding table issue
  • Fixed the user callback for writing ZCL attributes
  • Fixed the enumerated member of pressure measurement cluster
  • Closes: #305
  • Closes: #307
  • Closes: #315

29-Mar-2024

1.2.2 version release of ESP-ZIGBEE-SDK is based on esp-idf v5.1.3

Features

  • Updated esp-zboss-lib to v1.2.2
  • Updated esp-zigbee-lib to v1.2.2
  • Added diagnostics cluster support
  • Added meter_identification cluster support
  • Added price cluster support
  • Added Zigbee network size setting API
  • Added Zigbee I/O buffer size setting API
  • Added Zigbee binding table size setting API
  • Added ZB_DEBUG_MODE option for optimizing the code size of release version library
  • Removed ESP_ZB_TRACE_ENABLE option

Bug Fixes

  • Fixed profile id for zcl commands
  • Fixed moving value for color control handler
  • Fixed reuse issue with endpoint, cluster, and attribute lists
  • Fixed issue with Zigbee sleep not waking up via GPIO
  • Closes: #99
  • Closes: #269
  • Closes: #282
  • Closes: #284
  • Closes: #285

Note

  • The default network size is set to 64, please use the esp_zb_overall_network_size_set() to configure it.
  • The default I/O buffer size is set to 80, please use the esp_zb_io_buffer_size_set() to configure it.
  • The default binging table size is changed to 16, please use the API esp_zb_aps_src_binding_table_size_set() and esp_zb_aps_dst_binding_table_size_set() to configure it.

15-Mar-2024

1.2.1 version release of ESP-ZIGBEE-SDK is based on esp-idf v5.1.3

Features

  • Updated esp-zboss-lib to v1.2.1
  • Updated esp-zigbee-lib to v1.2.1
  • Added manufacturer code setting API
  • Supported the large data transmission for zcl commands

Bug Fixes

  • Fixed mfg tool
  • Fixed multiple link key initialization
  • Fixed touchlink nwk update request handler
  • Closes: #202
  • Closes: #244
  • Closes: #254

8-Mar-2024

1.2.0 version release of ESP-ZIGBEE-SDK is based on esp-idf v5.1.3

Features

  • Updated esp-zboss-lib to v1.2.0
  • Updated esp-zigbee-lib to v1.2.0
  • Supported to report the level value at each step upon receiving the level change command
  • Supported cli to configure green power functionality
  • Supported to print assert location
  • Supported 64-bit timer for stack
  • Supported to configure the multiple pre-configured link key for centralized and distributed network
  • Added more optional attributes support for color control

Bug Fixes

  • Fixed the group membership response
  • Fixed optional hue attribute for color control
  • Fixed the parameters for esp_zb_ep_list_add_ep()
  • Closes: #83
  • Closes: #251
  • Closes: #256

Break Changes

  • The esp_zb_ep_list_add_ep() function now utilizes an endpoint configuration structure，instead of multi parameters.

22-Feb-2024

1.1.2 version release of ESP-ZIGBEE-SDK

Features

  • Updated esp-zboss-lib to v1.1.2
  • Updated esp-zigbee-lib to v1.1.2
  • Added on/off off_with_effect, on_with_recall_global_scene and on_with_timed_off command
  • Added zcl custom cluster handler update API
  • Added device joining network minimum lqi setting API
  • Added beacon scan duration setting API
  • Changed the minimum custom cluster value to 0x8000

Bug Fixes

  • Fixed green power attribute setting
  • Fixed green power device type
  • Fixed assert of zcl malformed packet
  • Fixed distributed router formation capability, when it reboots
  • Closes: #212
  • Closes: #209
  • Closes: #193

6-Feb-2024

1.1.1 version release of ESP-ZIGBEE-SDK

Features

  • Updated esp-zboss-lib to v1.1.1
  • Updated esp-zigbee-lib to v1.1.1
  • Support touchlink commissioning cluster get group id command and response
  • Support touchlink commissioning cluster get endpoint list command and response
  • Support touchlink commissioning cluster endpoint information command

Bug Fixes

  • Fixed the color control step loop handler, when step value less than time transition.

2-Feb-2024

1.1.0 version release of ESP-ZIGBEE-SDK

Features

  • Updated esp-zboss-lib to v1.1.0
  • Updated esp-zigbee-lib to v1.1.0
  • Added more commands support for cli example
  • Added zigbee stack lock support
  • Added reset factory to default APIs
  • Added zll identify callback
  • Added zigbee device announcement APIs
  • Replaced the macsplit of the gateway with Radio Spinel
  • Replaced zigbee rcp example with ot-rcp example

Bug Fixes

  • Fixed the error trigger the zcl identify timer upon write_req
  • Fixed Zigbee color control downward movement failure
  • Fixed Zigbee color control step color failure
  • Fixed the scan_response for touchlink scan req handler
  • Fixed touchlink transaction id
  • Corrected the check for clearing touchlink factory new
  • Rectified the logic of touchlink set network key
  • Fixed touchlink target does not not send join router response with failure status
  • Fixed the erase-NVRAM operation of device leave network for touchlink
  • Fixed esp_zigbee_gateway build error on Win11
  • Closes: #231

19-Jan-2024

1.0.9 version release of ESP-ZIGBEE-SDK

Features

  • Updated esp-zboss-lib to v1.0.9
  • Updated esp-zigbee-lib to v1.0.9
  • Added bdb open network API
  • Added apsde user APIs
  • Added color control remaining_time(0x0002) attribute support
  • Added set and bag data type for custom cluster

Bug Fixes

  • Fixed the effect of fragment for broadcast frame
  • Fixed crashing for touchlink initiator device with multi-endpoint
  • Fixed data type of esp_zb_zcl_color_move_color_cmd_t
  • Fixed data type of esp_zb_ias_zone_cluster_cfg_t
  • Fixed rcp failure
  • Closes: #216
  • Closes: #221
  • Closes: #223

12-Jan-2024

1.0.8 version release of ESP-ZIGBEE-SDK

Features

  • Updated esp-zboss-lib to v1.0.8
  • Updated esp-zigbee-lib to v1.0.8
  • Supported Zigbee APS frame fragment
  • Supported Zigbee Green Power feature and examples
  • Supported nvram 16 bytes alignment
  • Added bdb commissioning cancelled APIs
  • Refined the mfg tool
  • Enabled the 802.15.4 receive done handler feature
  • Removed esp32h4 target support

Bug Fixes

  • Maintained the zcl scene table for every endpoint
  • Fixed zcl command send status callback
  • Fixed the user callback of zcl color control
  • Closes: #191
  • Closes: #190
  • Closes: #82

21-Dec-2023

1.0.7 version release of ESP-ZIGBEE-SDK

Features

  • Updated esp-zboss-lib to v1.0.7
  • Updated esp-zigbee-lib to v1.0.7
  • Supported zcl color mode callback
  • Supported set starting value before on command
  • Supported zcl send_command_status callback
  • Supported zcl default response callback
  • Closes: #135
  • Closes: #141
  • Closes: #142

Bug Fixes

  • Fixed zcl level transition time callback
  • Fixed zigbee touchlink device information request
  • Fixed zigbee broadcast table size

08-Dec-2023

1.0.6 version release of ESP-ZIGBEE-SDK

Features

  • Updated esp-zboss-lib to v1.0.6
  • Updated esp-zigbee-lib to v1.0.6
  • Supported the touchink and steering mode
  • Supported more APIs for touchlink feature
  • Supported the dual-communication for custom cluster
  • Supported the 16-bit and 32-bit array for custom attribute

Bug Fixes

  • Fixed zigbee gets group membership crash
  • Fixed zigbee gets scene membership crash
  • Fixed zigbee touchlink initiator scanning
  • Fixed the response of time cluster
  • Fixed the valid range for move_to_level command
  • Closes: #156
  • Closes: #158

23-Nov-2023

1.0.5 version release of ESP-ZIGBEE-SDK

Features

  • Updated esp-zboss-lib to v1.0.5
  • Updated esp-zigbee-lib to v1.0.5
  • Increased the maximum number of records in the group table to 32
  • Increased the maximum number of records in the binding table to 64
  • Increased the maximum number of endpoints per device to 64

Bug Fixes

  • Fixed the invalid endpoint ID in the door lock response
  • Fixed the effect of the OFF command for the level control cluster
  • Fixed the zdo binding table response callback
  • Fixed the touchlink primary channel reset
  • Closes: #150
  • Closes: #65

21-Nov-2023

1.0.4 version release of ESP-ZIGBEE-SDK

Features

  • Update esp-zboss-lib to v1.0.3
  • Support Zigbee touchlink and steering switch
  • Support the command with on/off of level control cluster
  • Add the identify_effect device id callback for user
  • Add the identify_effect command
  • Add block mechanism for zb osif iteration
  • Update example partition table

Bug Fixes

  • Fix the payload of custom cluster
  • Fix the data type of zb keep alive

10-Nov-2023

1.0.3 version release of ESP-ZIGBEE-SDK

Features

  • Add ZCL door lock cluster callback support
  • Add ZCL local report configuration support
  • Add the close Zigbee network API
  • Closes: #137
  • Closes: #128

Bug Fixes

  • Fix zb nvram bug
  • Fix off_with_effect of on/off cluster

03-Nov-2023

1.0.2 version release of ESP-ZIGBEE-SDK

Features

  • Update esp-zboss-lib to v1.0.2
  • Support the ZCL metering cluster
  • Support ZCL custom profile
  • Support the ON/OFF command affects the level control cluster
  • Update the SDK document for ZCL metering cluster
  • Update the esp-idf CI tool

Bug Fixes

  • Fix esp mac issue
  • Fix the data type for analog value/input
  • Fix zcl custom cluster data type
  • Fix zcl general response multiple time
  • Closes: #36
  • Closes: #106
  • Closes: #126

20-Oct-2023

1.0.1 version release of ESP-ZIGBEE-SDK

Features

  • Update esp-zboss-lib to v1.0.1
  • Support the effect of level control and on/off cluster
  • Support to scan all touchlink channels
  • Optimize the Zigbee OTA examples
  • Update the Zigbee OTA README.md
  • Closes: #100
  • Closes: #72

Bug Fixes

  • Fix the panid setting
  • Fix the reading attribute of zcl timer cluster
  • Increase the endpoint number in the ZCL group table from 4 to 32

10-Oct-2023

1.0.0 version release of ESP-ZIGBEE-SDK

Features

  • Update esp-zboss-lib to v1.0.0
  • Update examples README.md
  • Add trace log user API
  • Add NWK_AGGRESSIVE_ROUTE_ADD_TIME to vendor configuration
  • Add ZCL thermostat cluster
  • Add ZCL fan control cluster
  • Add ZCL thermostat ui config cluster
  • Add ZCL analog input cluster
  • Add ZCL analog output cluster
  • Add ZCL analog value cluster
  • Add ZCL carbon dioxide measurement cluster
  • Add ZCL pm2.5 measurement cluster
  • Add ZCL multistate value cluster
  • Closes: #36
  • Closes: #59
  • Closes: #96

Bug Fixes

  • Fix Zigbee light sleep
  • Fix Zigbee ZCL general(read/write/report_config) command
  • Closes: #102
  • Closes: #106

12-Sep-2023

0.9.5 version release of ESP-ZIGBEE-SDK

Features

  • Add zigbee trace support
  • Add zigbee assert support

8-Sep-2023

0.9.4 version release of ESP-ZIGBEE-SDK

Features

  • Update esp-zboss-lib to v0.7.0
  • Add zigbee discover attribtues support

Bug Fixes

30-Aug-2023

0.9.3 version release of ESP-ZIGBEE-SDK

Features

  • Add zigbee action event mechanism.
  • Add more support for Zigbee zcl common command.
  • Add zigbee zcl scene response support.
  • Optimize the Zigbee endpoint handler implementation.
  • Optimize the custom cluster implementation.
  • Move the active_scan_complete_req to zdo layer

Bug Fixes

29-Aug-2023

0.9.2 version release of ESP-ZIGBEE-SDK

Features

  • Add zigbee sleep feature support
  • Add zigbee sleepy end device example

25-Aug-2023

0.9.1 version release of ESP-ZIGBEE-SDK

Features

  • Add the Zigbee device sends command to itself support in non-network state.
  • Add the short address maps ieee address API.

Bug Fixes

  • Fix the custom cluster request command without size field.
  • Fix the wrong printing of IEEE address for CLI
  • Fix the byte order for long address

11-Aug-2023

0.9.0 version release of ESP-ZIGBEE-SDK

Features

  • Fix Zigbee zdo simple desc list
  • Add more Zigbee parameters configuration option
  • Add distribute network support
  • Optimize the zcl device cb id implementation
  • Add non-volatile scene table

Bug Fixes

2-Aug-2023

0.8.0 version release of ESP-ZIGBEE-SDK

Features

  • Add touchlink feature support
  • Add touchlink example

28-July-2023

0.7.2 version release of ESP-ZIGBEE-SDK

Features

  • Add security network key getting API
  • Add zdo bind table request command
  • Add more zcl color control command support
  • Enlarge mac rx queue size
  • Support more endpoints on Zigbee device
  • Support more types of custom cluster
  • Add scene cluster view command response
  • Add scene cluster for prompts
  • Optimize the scene cluster implementation

Bug Fixes

14-July-2023

0.7.1 version release of ESP-ZIGBEE-SDK

Features

  • Fix the process of privilege command handler
  • Add ias zone cluster request, response and notification handler
  • Add method to match common cluster
  • Fix compile warnings

Bug Fixes

30-June-2023

0.7.0 version release of ESP-ZIGBEE-SDK

Features

  • add zb privilege command support
  • add ESP-Thread-Border/Zigbee-Gateway Board V1.2 support
  • use ESP_ZB_TRANSCEIVER_ALL_CHANNELS_MASK as zb end device primary channel mask
  • Examples support the ESP-Thread-Border/Zigbee-Gateway Board V1.2

Bug Fixes

  • fix zb zcl ias zone cmd crash
  • fix node des callback issue
  • Closes: #34
  • Closes: #38

16-June-2023

0.6.2 version release of ESP-ZIGBEE-SDK

Features

  • support active scan available PAN
  • add illuminance measurement cluster
  • add pressure measurement cluster
  • add electrical measurement cluster
  • add window covering cluster
  • add occupancy sensing cluster

Bug Fixes

9-June-2023

0.6.1 version release of ESP-ZIGBEE-SDK

Features

  • stringify zigbee app signal
  • register attribute from local variable to static

Bug Fixes

  • fix callback for custom cluster
  • fix end device distributed key setting
  • Closes: #25
  • Closes: #27

26-May-2023

0.6.0 version release of ESP-ZIGBEE-SDK

Features

  • add TC standard distributed and pre-configured key settings
  • add TC link key exchange setting
  • add zb tx power setting
  • add destination endpoint to report callback
  • enable write callback for custom cluster

New Changes

  • Examples under esp-zigbee-sdk would use management component registry to download both esp-zigbee-lib and esp-zboss-lib.

Bug Fixes

6-April-2023

0.5.4 version release of ESP-ZIGBEE-SDK

Features

  • provide set PANID api
  • provide humidity, power config cluster, with docs update
  • support group bind
  • support zigbee gateway (wifi, zigbee coexist) on single chip C6 solution

Bug Fixes

  • fix the ZCL report command source address alignment issue
  • Closes: #7
  • Closes: #10
  • Closes: #8
  • Closes: #11

17-Mar-2023

0.5.3 version release of ESP-ZIGBEE-SDK

Features

  • Add More cluster (ias zone, on_off_switch_configuration binary_input) support
  • support ESP32-H2 MP chip

Bug Fixes

  • Closes: #6

28-Feb-2023

0.5.2 version release of ESP-ZIGBEE-SDK

Features

  • add the API for hue/saturation command and attribute callback support
  • add the API for report attribute

Bug Fixes

  • fix the issue #4
  • fix the issue #5

10-Feb-2023

0.5.1 version release of ESP-ZIGBEE-SDK

Features

  • Add new API for ZDO and ZCL
  • Delete the API esp_zb_set_network_channel
  • Add the API for esp_zb_set_primary_network_channel_set/ esp_zb_set_secondary_network_channel_set
  • Add the API for get current channel
  • Add the API for set ZCL attribute
  • Add more clusters for cli example to support dimmable light example for pytest

Bug Fixes

1-Feb-2023

0.5.0 version release of ESP-ZIGBEE-SDK

Features

  • Add timeout handler mechanism for user
  • Minor type name updates
  • Partition table adjustment for examples
  • ZDO related API requests and callbacks update with new argument

23-Dec-2022

0.4.1 version release of ESP-ZIGBEE-SDK

Features

  • esp-zigbee-lib version updated to 0.4.1
  • Add support for esp32c6
  • Update examples to support esp32c6
  • Add esp32c6 target in CI test

Bug Fixes

  • Bug fixed for rcp_incompatible_switch_port

14-Dec-2022

0.4.0 version release of ESP-ZIGBEE-SDK

Features

  • esp-zigbee-lib version updated to 0.4.0
  • Add example for ota upgrade process
  • Add README.md for ota upgrade process
  • Add docs for ota api-reference
  • Add ota example in CI test
  • Add scene cluster commands
  • Update the template file for MR process
  • Add APIs for ota upgrade cluster to ensure the ota upgrade process

Bug Fixes

  • Bug fixed for buffer length issue on customized cluster command

28-July-2022

Initial version release of ESP-ZIGBEE-SDK

Features

  • HA standard: Standard Home Automation devices setting and build up
  • ZCL: Provide the ZCL common and cluster specific command
  • ZDO: Varieties of the ZDO command
  • Security: Zigbee security support to install code related function
  • NWK: Zigbee stack related function to support ZC, ZR and ZED
  • CORE: Zigbee device hardware platform configuration setting related function, customized attribute, cluster and endpoint API