alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
36ac4631ae
esp-idf/examples/zigbee/light_sample/HA_on_off_light/README.md

64 lines
3.0 KiB
Markdown
Raw Normal View History

docs: update the readme for Thread/Zigbee examples
2023-04-07 00:20:26 -04:00
| Supported Targets | ESP32-C6 | ESP32-H2 |
| ----------------- | -------- | -------- |
Zigbee: Add light example * provide light example for acting as zigbee coordinator, router and end-device * remove unused componenent for example usage * remove unused variable * clean up unused header include for example * update the license header * update copyright * Add readme for instruction adding esp-zboss-lib component * esp-idf:update copy_right_check ignore file * CI: fix the ci check error from pipeline * sdkconfig: default set change for better user use * use Button (BOOT) as switch input * update the statemachine for debouncing * esp-zboss-lib: support lib 0.0.2 * fix warning issue from example
2021-10-20 06:45:55 -04:00
esp32h2: renaming esp32h2 to esp32h4
2022-10-19 03:57:24 -04:00
# Light Bulb Example
Zigbee: Add light example * provide light example for acting as zigbee coordinator, router and end-device * remove unused componenent for example usage * remove unused variable * clean up unused header include for example * update the license header * update copyright * Add readme for instruction adding esp-zboss-lib component * esp-idf:update copy_right_check ignore file * CI: fix the ci check error from pipeline * sdkconfig: default set change for better user use * use Button (BOOT) as switch input * update the statemachine for debouncing * esp-zboss-lib: support lib 0.0.2 * fix warning issue from example
2021-10-20 06:45:55 -04:00
docs: update the readme for Thread/Zigbee examples
2023-04-07 00:20:26 -04:00
This test code shows how to configure Zigbee end device and use it as HA on/off light bulb.
The ESP Zigbee SDK provides more examples and tools for productization:
* [ESP Zigbee SDK Docs](https://docs.espressif.com/projects/esp-zigbee-sdk)
* [ESP Zigbee SDK Repo](https://github.com/espressif/esp-zigbee-sdk)
Zigbee: Add light example * provide light example for acting as zigbee coordinator, router and end-device * remove unused componenent for example usage * remove unused variable * clean up unused header include for example * update the license header * update copyright * Add readme for instruction adding esp-zboss-lib component * esp-idf:update copy_right_check ignore file * CI: fix the ci check error from pipeline * sdkconfig: default set change for better user use * use Button (BOOT) as switch input * update the statemachine for debouncing * esp-zboss-lib: support lib 0.0.2 * fix warning issue from example
2021-10-20 06:45:55 -04:00
## Hardware Required
feat(zigbee): Updated Zigbee examples to align with esp-zigbee-lib v1.0.9
2024-01-25 01:03:10 -05:00
* One development board with ESP32-H2 SoC acting as Zigbee end-device (loaded with HA_on_off_light example)
Zigbee: Add light example * provide light example for acting as zigbee coordinator, router and end-device * remove unused componenent for example usage * remove unused variable * clean up unused header include for example * update the license header * update copyright * Add readme for instruction adding esp-zboss-lib component * esp-idf:update copy_right_check ignore file * CI: fix the ci check error from pipeline * sdkconfig: default set change for better user use * use Button (BOOT) as switch input * update the statemachine for debouncing * esp-zboss-lib: support lib 0.0.2 * fix warning issue from example
2021-10-20 06:45:55 -04:00
* A USB cable for power supply and programming
docs: update the readme for Thread/Zigbee examples
2023-04-07 00:20:26 -04:00
* Choose another ESP32-H2 as Zigbee coordinator (see [HA_on_off_switch example](../HA_on_off_switch))
Zigbee: Add light example * provide light example for acting as zigbee coordinator, router and end-device * remove unused componenent for example usage * remove unused variable * clean up unused header include for example * update the license header * update copyright * Add readme for instruction adding esp-zboss-lib component * esp-idf:update copy_right_check ignore file * CI: fix the ci check error from pipeline * sdkconfig: default set change for better user use * use Button (BOOT) as switch input * update the statemachine for debouncing * esp-zboss-lib: support lib 0.0.2 * fix warning issue from example
2021-10-20 06:45:55 -04:00
## Configure the project
zigbee: Update examples to support esp32c6
2022-12-29 23:02:41 -05:00
Before project configuration and build, make sure to set the correct chip target using `idf.py --preview set-target TARGET` command.
Zigbee: Add light example * provide light example for acting as zigbee coordinator, router and end-device * remove unused componenent for example usage * remove unused variable * clean up unused header include for example * update the license header * update copyright * Add readme for instruction adding esp-zboss-lib component * esp-idf:update copy_right_check ignore file * CI: fix the ci check error from pipeline * sdkconfig: default set change for better user use * use Button (BOOT) as switch input * update the statemachine for debouncing * esp-zboss-lib: support lib 0.0.2 * fix warning issue from example
2021-10-20 06:45:55 -04:00
esp32h2: renaming esp32h2 to esp32h4
2022-10-19 03:57:24 -04:00
## Erase the NVRAM
Zigbee: Update Zigbee examples for the latest library * support new API function * support esp-zboss-lib>=0.1.2, support esp-zigbee-lib>=0.2.0
2022-09-22 02:51:30 -04:00
Before flash it to the board, it is recommended to erase NVRAM if user doesn't want to keep the previous examples or other projects stored info using `idf.py -p PORT erase-flash`
Zigbee: Add light example * provide light example for acting as zigbee coordinator, router and end-device * remove unused componenent for example usage * remove unused variable * clean up unused header include for example * update the license header * update copyright * Add readme for instruction adding esp-zboss-lib component * esp-idf:update copy_right_check ignore file * CI: fix the ci check error from pipeline * sdkconfig: default set change for better user use * use Button (BOOT) as switch input * update the statemachine for debouncing * esp-zboss-lib: support lib 0.0.2 * fix warning issue from example
2021-10-20 06:45:55 -04:00
## Build and Flash
Build the project, flash it to the board, and start the monitor tool to view the serial output by running `idf.py -p PORT flash monitor`.
(To exit the serial monitor, type ``Ctrl-]``.)
## Example Output
As you run the example, you will see the following log:
zigbee: update Zigbee example signal handler API * update API for new esp-zigbee-lib * enable ci test
2022-10-26 02:40:02 -04:00
```
feat(zigbee): Updated Zigbee examples to align with esp-zigbee-lib v1.0.9
2024-01-25 01:03:10 -05:00
I (394) main_task: Calling app_main()
I (404) gpio: GPIO[8]| InputEn: 0| OutputEn: 1| OpenDrain: 0| Pullup: 1| Pulldown: 0| Intr:0
I (404) phy_init: phy_version 220,2dbbbe7,Sep 25 2023,20:39:25
I (464) phy: libbtbb version: 90c587c, Sep 25 2023, 20:39:57
I (474) ESP_ZB_COLOR_DIMM_LIGHT: ZDO signal: ZDO Config Ready (0x17), status: ESP_FAIL
I (474) ESP_ZB_COLOR_DIMM_LIGHT: Zigbee stack initialized
I (484) ESP_ZB_COLOR_DIMM_LIGHT: Start network steering
I (484) main_task: Returned from app_main()
I (9614) ESP_ZB_COLOR_DIMM_LIGHT: ZDO signal: NWK Permit Join (0x36), status: ESP_OK
I (9834) ESP_ZB_COLOR_DIMM_LIGHT: ZDO signal: NWK Permit Join (0x36), status: ESP_OK
I (9834) ESP_ZB_COLOR_DIMM_LIGHT: Joined network successfully (Extended PAN ID: 60:55:f9:00:00:f6:07:b4, PAN ID: 0x2a74, Channel:13)
I (32944) ESP_ZB_COLOR_DIMM_LIGHT: Received message: endpoint(10), cluster(0x6), attribute(0x0), data size(1)
I (32944) ESP_ZB_COLOR_DIMM_LIGHT: Light sets to On
I (33984) ESP_ZB_COLOR_DIMM_LIGHT: Received message: endpoint(10), cluster(0x6), attribute(0x0), data size(1)
I (33984) ESP_ZB_COLOR_DIMM_LIGHT: Light sets to Off
I (35304) ESP_ZB_COLOR_DIMM_LIGHT: ZDO signal: NLME Status Indication (0x32), status: ESP_OK
I (35534) ESP_ZB_COLOR_DIMM_LIGHT: Received message: endpoint(10), cluster(0x6), attribute(0x0), data size(1)
I (35534) ESP_ZB_COLOR_DIMM_LIGHT: Light sets to On
zigbee: update Zigbee example signal handler API * update API for new esp-zigbee-lib * enable ci test
2022-10-26 02:40:02 -04:00
```
Zigbee: Add light example * provide light example for acting as zigbee coordinator, router and end-device * remove unused componenent for example usage * remove unused variable * clean up unused header include for example * update the license header * update copyright * Add readme for instruction adding esp-zboss-lib component * esp-idf:update copy_right_check ignore file * CI: fix the ci check error from pipeline * sdkconfig: default set change for better user use * use Button (BOOT) as switch input * update the statemachine for debouncing * esp-zboss-lib: support lib 0.0.2 * fix warning issue from example
2021-10-20 06:45:55 -04:00
## Light Control Functions
docs: update the readme for Thread/Zigbee examples
2023-04-07 00:20:26 -04:00
* By toggling the switch button (BOOT) on the ESP32-H2 board loaded with the `HA_on_off_switch` example, the LED on this board loaded with `HA_on_off_light` example will be on and off.
Zigbee: Add light example * provide light example for acting as zigbee coordinator, router and end-device * remove unused componenent for example usage * remove unused variable * clean up unused header include for example * update the license header * update copyright * Add readme for instruction adding esp-zboss-lib component * esp-idf:update copy_right_check ignore file * CI: fix the ci check error from pipeline * sdkconfig: default set change for better user use * use Button (BOOT) as switch input * update the statemachine for debouncing * esp-zboss-lib: support lib 0.0.2 * fix warning issue from example
2021-10-20 06:45:55 -04:00
## Troubleshooting
For any technical queries, please open an [issue](https://github.com/espressif/esp-idf/issues) on GitHub. We will get back to you soon.
Reference in New Issue Copy Permalink