esp-idf/examples/openthread/ot_rcp/README.md

39 lines
1.3 KiB
Markdown
Raw Normal View History

| Supported Targets | ESP32-C6 | ESP32-H2 | ESP32-H4 |
| ----------------- | -------- | -------- | -------- |
2021-07-28 03:32:59 -04:00
# OpenThread Radio Co-Processor (RCP) Example
2021-07-28 03:32:59 -04:00
This example demonstrates an [OpenThread Radio Co-Processor](https://openthread.io/platforms/co-processor).
2021-07-28 03:32:59 -04:00
OpenThread RCP doesn't function alone, it needs to work together with a Host and this example covers two common user scenarios:
- Work with a Host Processor to perform a [Thread Border Router](https://openthread.io/guides/border-router).
- Work as a [Thread Sniffer](https://openthread.io/guides/pyspinel/sniffer).
2021-07-28 03:32:59 -04:00
## How to use example
2021-07-28 03:32:59 -04:00
### Hardware Required
2021-07-28 03:32:59 -04:00
2022-10-19 03:57:24 -04:00
To run this example, an ESP32-H4 board is required.
2021-07-28 03:32:59 -04:00
### Configure the project
2021-07-28 03:32:59 -04:00
2022-10-19 03:57:24 -04:00
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.
2021-07-28 03:32:59 -04:00
### Build and Flash
Build the project and flash it to the board:
2021-07-28 03:32:59 -04:00
```
idf.py -p <PORT> build flash
```
Now you'll get an OpenThread RCP, you can try the following use cases:
2021-07-28 03:32:59 -04:00
#### Thread Border Router
2021-07-28 03:32:59 -04:00
Please refer to [ot_br](../ot_br) example for the setup steps.
2021-07-28 03:32:59 -04:00
#### Thread Sniffer
2021-07-28 03:32:59 -04:00
Please refer to [Thread Sniffer](https://openthread.io/guides/pyspinel/sniffer) for the detailed instructions.