-
Notifications
You must be signed in to change notification settings - Fork 7.7k
feat(openthread): adds arduino openthread library documentation #11991
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Conversation
👋 Hello SuGlider, we appreciate your contribution to this project! 📘 Please review the project's Contributions Guide for key guidelines on code, documentation, testing, and more. 🖊️ Please also make sure you have read and signed the Contributor License Agreement for this project. Click to see more instructions ...
Review and merge process you can expect ...
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds comprehensive OpenThread API documentation for ESP32 Arduino, introducing support for Thread networking on ESP32-H2, ESP32-C6, and ESP32-C5 devices. The documentation covers two distinct programming interfaces: a Stream-based CLI Helper Functions API and an object-oriented Classes API.
Key Changes:
- Documentation for Thread network protocol and topology
- Complete API reference for OpenThread, DataSet, and OpenThreadCLI classes
- CLI Helper Functions API documentation for command-line interface interaction
- Practical code examples covering common Thread networking scenarios
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/en/libraries.rst | Adds OpenThread APIs section with links to four new documentation files |
| docs/en/openthread/openthread.rst | Main OpenThread documentation covering Thread protocol overview, library structure, device roles, supported hardware, and troubleshooting |
| docs/en/openthread/openthread_core.rst | Complete API reference for the OpenThread class including network control, dataset management, address management, and device role monitoring |
| docs/en/openthread/openthread_dataset.rst | Documentation for the DataSet class covering creation, configuration, and management of Thread operational datasets |
| docs/en/openthread/openthread_cli.rst | Documentation for OpenThreadCLI class and CLI Helper Functions API for command-line interface interaction |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| * **Router**: Extends network range, routes messages, maintains network topology. This device shall be powered by a wall adapter. | ||
| * **Child**: End device that can sleep for extended periods (battery-powered devices). It can be powered by a battery or a wall adapter. | ||
| * **Detached**: Device not currently participating in a Thread network. | ||
| * **Disabled**: The Thread stack and interface is disabled. |
Copilot
AI
Nov 7, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Spelling error: "interface" should not have an extra space before "is". The phrase "The Thread stack and interface is disabled" should be "The Thread stack and interface is disabled" (or better yet, "The Thread stack and interface are disabled" for grammatical correctness).
| * **Disabled**: The Thread stack and interface is disabled. | |
| * **Disabled**: The Thread stack and interface are disabled. |
|
|
||
| **Other Thread Network Devices:** | ||
|
|
||
| * **Thread Border Router**: A device that connects a Thread network to other IP-based networks in the extrenal world. The Thread Border Router is connected to both the Thread network and external IP networks (like Wi-Fi router), enabling Thread devices to communicate with devices on other networks and the Internet. A Border Router can be implemented on a device with any Thread device role (Leader, Router, or Child). It can also act as gateway to other protocols such as MQTT or Zigbee. |
Copilot
AI
Nov 7, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Multiple spelling and grammar errors in this line:
- "extrenal" should be "external"
- "like Wi-Fi router" should be "like a Wi-Fi router"
- "act as gateway" should be "act as a gateway"
| * **Thread Border Router**: A device that connects a Thread network to other IP-based networks in the extrenal world. The Thread Border Router is connected to both the Thread network and external IP networks (like Wi-Fi router), enabling Thread devices to communicate with devices on other networks and the Internet. A Border Router can be implemented on a device with any Thread device role (Leader, Router, or Child). It can also act as gateway to other protocols such as MQTT or Zigbee. | |
| * **Thread Border Router**: A device that connects a Thread network to other IP-based networks in the external world. The Thread Border Router is connected to both the Thread network and external IP networks (like a Wi-Fi router), enabling Thread devices to communicate with devices on other networks and the Internet. A Border Router can be implemented on a device with any Thread device role (Leader, Router, or Child). It can also act as a gateway to other protocols such as MQTT or Zigbee. |
Description of Change
This PR adds the Arduino OpenThread Documentation.
Test Scenarios
CI Only
Related links
None.