esp_openthread.rst 1.1 KB

1234567891011121314151617181920212223242526272829303132
  1. Thread
  2. ==========
  3. :link_to_translation:`zh_CN:[中文]`
  4. Introduction
  5. ------------
  6. `Thread <https://www.threadgroup.org>`_ is an IP-based mesh networking protocol. It is based on the 802.15.4 physical and MAC layer.
  7. Application Examples
  8. --------------------
  9. The :example:`openthread` directory of ESP-IDF examples contains the following applications:
  10. - The OpenThread interactive shell :example:`openthread/ot_cli`
  11. - The Thread Border Router :example:`openthread/ot_br`
  12. - The Thread Radio Co-Processor :example:`openthread/ot_rcp`
  13. API Reference
  14. -------------
  15. 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>`_.
  16. ESP-IDF provides extra APIs for launching and managing the OpenThread stack, binding to network interfaces and border routing features.
  17. .. include-build-file:: inc/esp_openthread.inc
  18. .. include-build-file:: inc/esp_openthread_types.inc
  19. .. include-build-file:: inc/esp_openthread_lock.inc
  20. .. include-build-file:: inc/esp_openthread_netif_glue.inc
  21. .. include-build-file:: inc/esp_openthread_border_router.inc