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

Merge branch 'backport/update_docs_for_openthread' into 'release/v5.1'

Browse Source 
docs(openthread): update openthread README for H2 and C6 (Backport v5.1)

See merge request espressif/esp-idf!24750
This commit is contained in:
Shu Chen 2023-07-13 17:10:36 +08:00
commit d8db9235ff
6 changed files with 7 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/docs_not_updated/esp32c6.txt
View File

@ -1,4 +0,0 @@
api-guides/openthread
api-reference/network
api-reference/network/esp_openthread
api-reference/network/index

2
docs/docs_not_updated/esp32h2.txt
View File

@ -6,7 +6,6 @@ api-guides/cplusplus
api-guides/dfu
api-guides/wifi-security
api-guides/index
api-guides/openthread
api-reference/peripherals/i2s
api-reference/peripherals/spi_features
api-reference/peripherals/sdio_slave
@ -15,7 +14,6 @@ api-reference/peripherals/dedic_gpio
api-reference/peripherals/sd_pullup_requirements
api-reference/peripherals/index
api-reference/peripherals/sdmmc_host
api-reference/network/esp_openthread
api-reference/network/esp_dpp
api-reference/network/esp_now
api-reference/network/esp-wifi-mesh

6
docs/en/api-guides/openthread.rst
View File

@ -1,7 +1,7 @@
OpenThread
==========
`OpenThread <https://github.com/openthread/openthread>`_ is a IP stack running on the 802.15.4 MAC layer which features mesh network and low power consumption.
`OpenThread <https://github.com/openthread/openthread>`_ is an IP stack running on the 802.15.4 MAC layer which features mesh network and low power consumption.
Mode of the OpenThread stack
----------------------------
@ -11,12 +11,12 @@ OpenThread can run under the following modes on Espressif chips:
Standalone node
+++++++++++++++
The full OpenThread stack and the application layer runs on the same chip. This mode is available on chips with 15.4 radio such as {IDF_TARGET}.
The full OpenThread stack and the application layer runs on the same chip. This mode is available on chips with 15.4 radio such as ESP32-H2, ESP32-C6.
Radio Co-Processor (RCP)
++++++++++++++++++++++++
The chip will be connected to another host running the OpenThread IP stack. It will send and received 15.4 packets on behalf of the host. This mode is available on chips with 15.4 radio such as {IDF_TARGET}. The underlying transport between the chip and the host can be SPI or UART. For sake of latency, we recommend to use SPI as the underlying transport.
The chip will be connected to another host running the OpenThread IP stack. It will send and received 15.4 packets on behalf of the host. This mode is available on chips with 15.4 radio such as ESP32-H2, ESP32-C6. The underlying transport between the chip and the host can be SPI or UART. For sake of latency, we recommend to use SPI as the underlying transport.
OpenThread host
+++++++++++++++

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

@ -18,8 +18,8 @@ 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-H2 802.15.4 SoC loaded with [ot_rcp](../ot_rcp) example.
* Another ESP32-H2 SoC loaded with [ot_cli](../ot_cli) example.
* An IEEE 802.15.4 SoC (ESP32-H2) loaded with [ot_rcp](../ot_rcp) example.
* Another IEEE 802.15.4 SoC (ESP32-H2) loaded with [ot_cli](../ot_cli) example.
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)

2
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-H2 board is required.
To run this example, a board with IEEE 802.15.4 module (for example ESP32-H2) is required.
### Configure the project

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

@ -13,7 +13,7 @@ OpenThread RCP doesn't function alone, it needs to work together with a Host and
### Hardware Required
To run this example, an ESP32-H2 board is required.
To run this example, a board with IEEE 802.15.4 module (for example ESP32-H2) is required.
### Configure the project