-
Notifications
You must be signed in to change notification settings - Fork 7.8k
feat(openthread): adds examples README.md files #11996
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 README documentation for all OpenThread library examples in the ESP32 Arduino Core. The documentation covers both Native API and CLI-based examples, providing users with detailed setup instructions, configuration guidance, and troubleshooting information.
Key Changes
- Added README files for Native API examples (LeaderNode, RouterNode)
- Added README files for CLI examples (SimpleCLI, SimpleNode, ThreadScan, onReceive, Leader/Router/ExtendedRouter nodes)
- Added README files for CoAP examples (coap_lamp, coap_switch)
Reviewed Changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| libraries/OpenThread/examples/Native/SimpleThreadNetwork/RouterNode/README.md | Documentation for Router/Child node using Native Classes API |
| libraries/OpenThread/examples/Native/SimpleThreadNetwork/LeaderNode/README.md | Documentation for Leader node using Native Classes API |
| libraries/OpenThread/examples/CLI/onReceive/README.md | Documentation for CLI callback mechanism demonstration |
| libraries/OpenThread/examples/CLI/ThreadScan/README.md | Documentation for IEEE 802.15.4 and Thread network scanning |
| libraries/OpenThread/examples/CLI/SimpleThreadNetwork/RouterNode/README.md | Documentation for Router/Child node using CLI Helper Functions |
| libraries/OpenThread/examples/CLI/SimpleThreadNetwork/LeaderNode/README.md | Documentation for Leader node using CLI Helper Functions |
| libraries/OpenThread/examples/CLI/SimpleThreadNetwork/ExtendedRouterNode/README.md | Documentation for extended Router node with dual API demonstration |
| libraries/OpenThread/examples/CLI/SimpleNode/README.md | Documentation for automatic Thread network initialization |
| libraries/OpenThread/examples/CLI/SimpleCLI/README.md | Documentation for interactive OpenThread CLI console |
| libraries/OpenThread/examples/CLI/COAP/coap_switch/README.md | Documentation for CoAP client (switch) implementation |
| libraries/OpenThread/examples/CLI/COAP/coap_lamp/README.md | Documentation for CoAP server (lamp) implementation |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| ```cpp | ||
| #define CLI_NETWORK_KEY "dataset networkkey 00112233445566778899aabbccddeeff" | ||
| #define CLI_NETWORK_CHANEL "dataset channel 24" |
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: "CHANEL" should be "CHANNEL"
| #define CLI_NETWORK_CHANEL "dataset channel 24" | |
| #define CLI_NETWORK_CHANNEL "dataset channel 24" |
|
|
||
| ```cpp | ||
| #define CLI_NETWORK_KEY "dataset networkkey 00112233445566778899aabbccddeeff" | ||
| #define CLI_NETWORK_CHANEL "dataset channel 24" |
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: "CHANEL" should be "CHANNEL"
| #define CLI_NETWORK_CHANEL "dataset channel 24" | |
| #define CLI_NETWORK_CHANNEL "dataset channel 24" |
|
|
||
| ```cpp | ||
| #define CLI_NETWORK_KEY "00112233445566778899aabbccddeeff" | ||
| #define CLI_NETWORK_CHANEL "24" |
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: "CHANEL" should be "CHANNEL"
| #define CLI_NETWORK_CHANEL "24" | |
| #define CLI_NETWORK_CHANNEL "24" |
Description of Change
Adds README.md file for each Arduino OpenThread Library example.
Test Scenarios
CI Only
Related links
None