2021-07-22 23:57:40 -04:00
Thread
==========
2023-08-22 04:34:41 -04:00
:link_to_translation:`zh_CN:[中文]`
2021-07-22 23:57:40 -04:00
Introduction
------------
2023-08-22 04:34:41 -04:00
`Thread <https://www.threadgroup.org> `_ is an IP-based mesh networking protocol. It is based on the 802.15.4 physical and MAC layer.
2021-07-22 23:57:40 -04:00
Application Examples
--------------------
The :example: `openthread` directory of ESP-IDF examples contains the following applications:
2023-08-22 04:34:41 -04:00
- The OpenThread interactive shell :example: `openthread/ot_cli`
- The Thread Border Router :example: `openthread/ot_br`
- The Thread Radio Co-Processor :example: `openthread/ot_rcp`
2021-07-22 23:57:40 -04:00
API Reference
-------------
2023-08-22 04:34:41 -04:00
For manipulating the Thread network, the OpenThread API shall be used. The OpenThread API docs can be found at the `OpenThread API docs <https://openthread.io/reference> `_ .
2021-07-22 23:57:40 -04:00
2023-07-21 06:51:21 -04:00
ESP-IDF provides extra APIs for launching and managing the OpenThread stack, binding to network interfaces and border routing features.
2021-07-22 23:57:40 -04:00
.. include-build-file :: inc/esp_openthread.inc
.. include-build-file :: inc/esp_openthread_types.inc
.. include-build-file :: inc/esp_openthread_lock.inc
.. include-build-file :: inc/esp_openthread_netif_glue.inc
.. include-build-file :: inc/esp_openthread_border_router.inc
