2021-07-23 03:57:40 +00:00
|
|
|
Thread
|
|
|
|
|
==========
|
|
|
|
|
|
|
|
|
|
Introduction
|
|
|
|
|
------------
|
|
|
|
|
|
|
|
|
|
`Thread <https://www.threadgroup.org>`_ is a IP-based mesh networking protocol. It's based on the 802.15.4 physical and MAC layer.
|
|
|
|
|
|
|
|
|
|
Application Examples
|
|
|
|
|
--------------------
|
|
|
|
|
|
|
|
|
|
The :example:`openthread` directory of ESP-IDF examples contains the following applications:
|
|
|
|
|
|
|
|
|
|
- The OpenThread interactive shell :example:`openthread/ot_cli`.
|
2021-07-28 07:32:59 +00:00
|
|
|
- The Thread border router :example:`openthread/ot_br`.
|
|
|
|
|
- The Thread radio co-processor :example:`openthread/ot_rcp`.
|
2021-07-23 03:57:40 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
API Reference
|
|
|
|
|
-------------
|
|
|
|
|
|
|
|
|
|
For manipulating the Thread network, the OpenThread api shall be used.
|
|
|
|
|
The OpenThread api docs can be found at the `OpenThread official website <https://openthread.io/reference>`_.
|
|
|
|
|
|
|
|
|
|
ESP-IDF provides extra apis for launching and managing the OpenThread stack, binding to network interfaces and border routing features.
|
|
|
|
|
|
|
|
|
|
.. 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
|
