TDLOGY / esp-zigbee-sdk

Espressif Zigbee SDK

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

esp-zigbee-sdk

Introduction

ESP-Zigbee-SDK is the official Zigbee development framework for Esspresif's ESP32-H2 and 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. More details of the sdk see the esp-zigbee-sdk components

Get esp-zigbee-sdk

Please clone this repository using the below command:

git clone --recursive https://github.com/espressif/esp-zigbee-sdk.git

Note the --recursive option. This is required to pull in the various dependencies into esp-matter. In case you have already cloned the repository without this option, execute this to pull in the submodules: git submodule update --init --recursive

Simple user guide

Pre-requisite Environment

  • Refer ESP-IDF to get the more info about the Espressif IoT Development Framework. Official development framework for Espressif SoCs.
  • Check IDF Get Started to know how to install the ESP-IDF environment.

Zigbee Examples

  • Check the HA examples if you want to know more about Zigbee Home automation devices
  • Check the Customized device if you want to know more about customized Zigbee devices
  • Check the Gateway if you want to know the Zigbee Gateway
  • Check the CLI if you want to know the Zigbee CLI command example
  • Check the OTA if you want to know the Zigbee OTA Upgrade example

More new details see examples's Readme

esp-zigbee components

  • Check the component (esp-zboss-lib) should be downloaded automatically from managment component under each esp-zigbee-sdk example, it includes Zigbee stack static library for supporting Esspresif's ESP32-H2 and ESP32 series SOCs.
  • Check the component esp-zigbee-lib that includes SDK's API to build own projects. More details see the Readme under esp-zigbee-lib component.

Documentation

Refer ESP Zigbee SDK Guide for the latest version of the documentation.

Tools

Refer mfg_tool for user to configure Zigbee manufacture related binary file to Zigbee product.

Copyright Notes

  • All original content of this repository is Copyright (c) 2022 Espressif Systems (Shanghai) Co. Ltd and licensed under Apache 2.0 license, as described in file LICENSE.
  • Example applications supplied in this repository depend on esp-zboss-lib library, which is distributed under a different license, found here LICENSE.

Users developing applications based on this SDK have to comply with the terms of both licenses, the license conditions do not prevent development of commercial products.

About

Espressif Zigbee SDK

License:Apache License 2.0


Languages

Language:C 89.2%Language:Python 10.4%Language:CMake 0.4%