esp_openthread.rst 1.1 KB

12345678910111213141516171819202122232425262728293031
  1. Thread
  2. ==========
  3. Introduction
  4. ------------
  5. `Thread <https://www.threadgroup.org>`_ is a IP-based mesh networking protocol. It's based on the 802.15.4 physical and MAC layer.
  6. Application Examples
  7. --------------------
  8. The :example:`openthread` directory of ESP-IDF examples contains the following applications:
  9. - The OpenThread interactive shell :example:`openthread/ot_cli`.
  10. - The Thread border router :example:`openthread/ot_br`.
  11. - The Thread radio co-processor :example:`openthread/ot_rcp`.
  12. API Reference
  13. -------------
  14. For manipulating the Thread network, the OpenThread api shall be used.
  15. The OpenThread api docs can be found at the `OpenThread official website <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