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

docs: update the readme for Thread/Zigbee examples

Browse Source
This commit is contained in:
Shu Chen 2023-04-07 12:20:26 +08:00
parent 990076e5f2
commit 30b7d34f60
8 changed files with 46 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
examples/openthread/ot_br/README.md
View File

@ -18,13 +18,13 @@ The ESP Thread Border Router SDK provides extra components and examples for putt
#### **Wi-Fi based Thread Border Router**
By default, two SoCs are required to run this example:
* An ESP32 series Wi-Fi SoC (ESP32, ESP32-C, ESP32-S, etc) loaded with this ot_br example.
* An ESP32-H4 802.15.4 SoC loaded with [ot_rcp](../ot_rcp) example.
* Another ESP32-H4 SoC loaded with [ot_cli](../ot_cli) example.
* An ESP32-H2 802.15.4 SoC loaded with [ot_rcp](../ot_rcp) example.
* Another ESP32-H2 SoC loaded with [ot_cli](../ot_cli) example.
Connect the two SoCs via UART, below is an example setup with ESP32 DevKitC and ESP32-H4 DevKitC:
![thread_br](image/thread-border-router-esp32-esp32h4.jpg)
Connect the two SoCs via UART, below is an example setup with ESP32 DevKitC and ESP32-H2 DevKitC:
![thread_br](image/thread-border-router-esp32-esp32h2.jpg)
ESP32 pin | ESP32-H4 pin
ESP32 pin | ESP32-H2 pin
----------|-------------
GND | G
GPIO4 | TX

0
examples/openthread/ot_br/image/thread-border-router-esp32-esp32h4.jpg → examples/openthread/ot_br/image/thread-border-router-esp32-esp32h2.jpg
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 331 KiB

After

Width:  |  Height:  |  Size: 331 KiB

4
examples/openthread/ot_cli/README.md
View File

@ -9,7 +9,7 @@ This example demonstrates an [OpenThread CLI](https://github.com/openthread/open
### Hardware Required
To run this example, an ESP32-H4 board is required.
To run this example, an ESP32-H2 board is required.
### Configure the project
@ -63,7 +63,7 @@ factoryreset
## Set Up Network
To run this example, at least two ESP32-H4 boards flashed with this ot_cli example are required.
To run this example, at least two ESP32-H2 boards flashed with this ot_cli example are required.
On the first device, run the following commands:
```bash

4
examples/openthread/ot_rcp/README.md
View File

@ -13,11 +13,11 @@ OpenThread RCP doesn't function alone, it needs to work together with a Host and
### Hardware Required
To run this example, an ESP32-H4 board is required.
To run this example, an ESP32-H2 board is required.
### Configure the project
The default communication interface is port 0 of ESP32-H4 UART running at 115200 baud, change the configuration in [esp_ot_config.h](main/esp_ot_config.h) if you want to use another interface or need different communication parameters.
The default communication interface is port 0 of ESP32-H2 UART running at 460800 baud, change the configuration in [esp_ot_config.h](main/esp_ot_config.h) if you want to use another interface or need different communication parameters.
### Build and Flash

25
examples/zigbee/esp_zigbee_gateway/README.md
View File

@ -3,19 +3,20 @@
# Gateway Example
This example demonstrates how to build a Zigbee Gateway device. It runs on a Wi-Fi SoC such as ESP32, ESP32-C3 and ESP32-S3, with an 802.15.4 SoC like ESP32-H2 running [esp_zigbee_rcp](../esp_zigbee_rcp) to provide 802.15.4 radio.
This example demonstrates how to build a Zigbee Gateway device.
The example could also run on a single SoC which supports both Wi-Fi and Zigbee (e.g., ESP32-C6), but since there is only one RF path in ESP32-C6, which means Wi-Fi and Zigbee can't receive simultaneously, it has a significant impact on performance. Hence the two SoCs solution is recommended.
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)
## Hardware Required
* One development board with ESP32 or ESP32-S3 SoC acting as Zigbee gateway (loaded with esp_zigbee_gateway example)
* A USB cable for power supply and programming
* Three jumper wires for UART (TX, RX and GND)
* Gateway doesn't function alone. Choose ESP32-H2 as Zigbee rcp (see [esp_zigbee_rcp example](../esp_zigbee_rcp))
* **Flash** Zigbee rcp on the ESP32-H2 DevKitC first **before** connecting to Zigbee gateway
* Connect the two SoCs via UART, below is an example setup with ESP32-DevKitC and ESP32-H2-DevKitC:
![Zigbee_gateway](../../openthread/ot_br/image/thread-border-router-esp32-esp32h4.jpg)
By default, two SoCs are required to run this example:
* An ESP32 series Wi-Fi SoC (ESP32, ESP32-C, ESP32-S, etc) loaded with this esp_zigbee_gateway example.
* An ESP32-H2 802.15.4 SoC loaded with [esp_zigbee_rcp](../esp_zigbee_rcp) example
Connect the two SoCs via UART, below is an example setup with ESP32-DevKitC and ESP32-H2-DevKitC:
![Zigbee_gateway](../../openthread/ot_br/image/thread-border-router-esp32-esp32h2.jpg)
ESP32 pin | ESP32-H2 pin
------------- |-------------
@ -25,9 +26,13 @@ ESP32 pin | ESP32-H2 pin
* TX, RX pin can be also configured by user in esp_zigbee_gateway.h
The example could also run on a single SoC which supports both Wi-Fi and Zigbee (e.g., ESP32-C6), but since there is only one RF path in ESP32-C6, which means Wi-Fi and Zigbee can't receive simultaneously, it has a significant impact on performance. Hence the two SoCs solution is recommended.
## Configure the project
Before project configuration and build, make sure to set the correct chip target using `idf.py set-target esp32` or `idf.py set-target esp32s3`
Before project configuration and build, make sure to set the correct chip target using `idf.py set-target <chip_name>`.
In order to run the example on single SoC which supports both Wi-Fi and Thread, the option `CONFIG_ESP_COEX_SW_COEXIST_ENABLE` and option `CONFIG_ZB_RADIO_NATIVE` should be enabled. The two options are enabled by default for ESP32-C6 target.
## Erase the NVRAM

6
examples/zigbee/esp_zigbee_rcp/README.md
View File

@ -1,5 +1,5 @@
| Supported Targets | ESP32-C6 | ESP32-H2 | ESP32-H4 |
| ----------------- | -------- | -------- | -------- |
| Supported Targets | ESP32-C6 | ESP32-H2 |
| ----------------- | -------- | -------- |
# Rcp Example
@ -7,7 +7,7 @@ This test code shows how to configure Zigbee rcp (radio co-processor) device. Rc
## Hardware Required
* One development board with ESP32-H4 SoC acting as Zigbee rcp (loaded with esp_zigbee_rcp example)
* One development board with ESP32-H2 SoC acting as Zigbee rcp (loaded with esp_zigbee_rcp example)
* A USB cable for power supply and programming
* Choose ESP32 or ESP32-S3 as Zigbee gateway. The connection and setup refer to the Zigbee gateway example for setup details (see [esp_zigbee_gateway example](../esp_zigbee_gateway))
* TX, RX pin can be also configured by user in esp_zigbee_rcp.h

16
examples/zigbee/light_sample/HA_on_off_light/README.md
View File

@ -1,15 +1,19 @@
| Supported Targets | ESP32-C6 | ESP32-H2 | ESP32-H4 |
| ----------------- | -------- | -------- | -------- |
| Supported Targets | ESP32-C6 | ESP32-H2 |
| ----------------- | -------- | -------- |
# Light Bulb Example
This test code shows how to configure Zigbee end device and use it as HA on/off light bulb
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)
## Hardware Required
* One development board with ESP32-H4 SoC acting as Zigbee end device (loaded with HA_on_off_light example)
* One development board with ESP32-H2 SoC acting as Zigbee end device (loaded with HA_on_off_light example)
* A USB cable for power supply and programming
* Choose another ESP32-H4 as Zigbee coordinator (see [HA_on_off_switch example](../HA_on_off_switch))
* Choose another ESP32-H2 as Zigbee coordinator (see [HA_on_off_switch example](../HA_on_off_switch))
## Configure the project
@ -45,7 +49,7 @@ I (9671) ESP_ZB_LIGHT: on/off light set to 0
## Light Control Functions
* By toggling the switch button (BOOT) on the ESP32-H4 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.
* 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.
## Troubleshooting

14
examples/zigbee/light_sample/HA_on_off_switch/README.md
View File

@ -1,15 +1,19 @@
| Supported Targets | ESP32-C6 | ESP32-H2 | ESP32-H4 |
| ----------------- | -------- | -------- | -------- |
| Supported Targets | ESP32-C6 | ESP32-H2 |
| ----------------- | -------- | -------- |
# Light Switch Example
This test code shows how to configure Zigbee Coordinator and use it as an HA on/off_switch
This test code shows how to configure Zigbee Coordinator and use it as an HA on/off_switch.
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)
## Hardware Required
* One development board with ESP32-H4 SoC acting as Zigbee Coordinator (loaded with HA_on_off_switch)
* One development board with ESP32-H2 SoC acting as Zigbee Coordinator (loaded with HA_on_off_switch)
* A USB cable for power supply and programming
* Choose another ESP32-H4 as Zigbee end-device (see [HA_on_off_light](../HA_on_off_light/))
* Choose another ESP32-H2 as Zigbee end-device (see [HA_on_off_light](../HA_on_off_light/))
## Configure the project