ESP-Zigbee-SDK is the official Zigbee development framework for Espressif's ESP32 series SoCs. It provides varieties of APIs aimed to simplify the development process of Zigbee products and enable the users to go to production in the shortest possible time.
Refer ESP Zigbee SDK Guide for the latest version of the documentation.
The SDK is built on top of ESP-IDF and a core implementation of Zigbee protocol.
| SDK Version | Description | Zigbee Core Stack |
|---|---|---|
| v1.x | LTS version under maintenance (bug fixes only, no new features) | ZBOSS |
| v2.x | Latest version, recommended for new designs and production | Espressif proprietary Zigbee stack |
If you are going to migrate from v1.x to v2.x, please refer to our Migration Guide.
The Espressif Zigbee SDK is provided as pre-built library inside esp-zigbee-lib component.
Note: The library component is hosted by ESP Registry, which can be downloaded automatically by specifying the dependency in idf_component.yml file. An example: idf_component.yml. You can also use the command in you project:
idf.py add-dependency "espressif/esp-zigbee-lib^2.0.0"
Some of the reference hardware used in development examples are listed below:
Note: The SDK can not be used with ESP-IDF v6.0+ yet.
The SDK is recommended to be used with ESP-IDF v5.5.4. Please check Compatibility file on ESP-IDF master for the support status of the SoCs.
Please clone this repository using the below command:
git clone https://github.com/espressif/esp-zigbee-sdk.git
Find our Zigbee console example under examples/all_device_types_app directory and follow the instructions in the
README of the example to build and flash the example.
Have fun playing with your Zigbee device.