esp-idf/docs/en/api-reference/network/esp_openthread.rst

32 lines
1.5 KiB
ReStructuredText
Raw Normal View History

2021-07-22 23:57:40 -04:00
Thread
==========
:link_to_translation:`zh_CN:[中文]`
2021-07-22 23:57:40 -04:00
Introduction
------------
`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
--------------------
- :example:`openthread/ot_br` demonstrates how to set up a Thread border router on {IDF_TARGET_NAME}, enabling functionalities such as bidirectional IPv6 connectivity, service discovery, etc.
2021-07-22 23:57:40 -04:00
- :example:`openthread/ot_cli` demonstrates how to use the OpenThread Command Line Interface with additional features such as TCP, UDP, and Iperf. This requires a board equipped with an IEEE 802.15.4 module. This example provides instructions on how to set up a network using at least two 802.15.4 boards.
2021-07-22 23:57:40 -04:00
- :example:`openthread/ot_rcp` demonstrates how to work with a Host Processor to perform as a Thread border router and function as a Thread sniffer, using a board with an IEEE 802.15.4 module.
2021-07-22 23:57:40 -04:00
API Reference
-------------
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
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