Skip to content

Conversation

@SuGlider
Copy link
Collaborator

@SuGlider SuGlider commented Nov 7, 2025

Description of Change

Adds README.md file for each Arduino OpenThread Library example.

Test Scenarios

CI Only

Related links

None

@SuGlider SuGlider added this to the 3.3.0 milestone Nov 7, 2025
@SuGlider SuGlider self-assigned this Nov 7, 2025
@SuGlider SuGlider added the Type: Documentation Issue pertains to Documentation of Arduino ESP32 label Nov 7, 2025
@SuGlider SuGlider added the Area: OpenThread Issues and Feature Request about OpenThread Protocol label Nov 7, 2025
@SuGlider SuGlider moved this from Todo to In Progress in Arduino ESP32 Core Project Roadmap Nov 7, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Nov 7, 2025

Messages
📖 This PR seems to be quite large (total lines of code: 1748), you might consider splitting it into smaller PRs

👋 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 ...


This automated output is generated by the PR linter DangerJS, which checks if your Pull Request meets the project's requirements and helps you fix potential issues.

DangerJS is triggered with each push event to a Pull Request and modify the contents of this comment.

Please consider the following:
- Danger mainly focuses on the PR structure and formatting and can't understand the meaning behind your code or changes.
- Danger is not a substitute for human code reviews; it's still important to request a code review from your colleagues.
- Addressing info messages (📖) is strongly recommended; they're less critical but valuable.
- To manually retry these Danger checks, please navigate to the Actions tab and re-run last Danger workflow.

Review and merge process you can expect ...


We do welcome contributions in the form of bug reports, feature requests and pull requests.

1. An internal issue has been created for the PR, we assign it to the relevant engineer.
2. They review the PR and either approve it or ask you for changes or clarifications.
3. Once the GitHub PR is approved we do the final review, collect approvals from core owners and make sure all the automated tests are passing.
- At this point we may do some adjustments to the proposed change, or extend it by adding tests or documentation.
4. If the change is approved and passes the tests it is merged into the default branch.

Generated by 🚫 dangerJS against 465ebc4

@SuGlider SuGlider moved this from In Progress to In Review in Arduino ESP32 Core Project Roadmap Nov 7, 2025
@SuGlider SuGlider added the Status: Review needed Issue or PR is awaiting review label Nov 7, 2025
@lucasssvaz lucasssvaz requested a review from Copilot November 7, 2025 11:55
Copy link
Contributor

Copilot AI left a 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"
Copy link

Copilot AI Nov 7, 2025

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"

Suggested change
#define CLI_NETWORK_CHANEL "dataset channel 24"
#define CLI_NETWORK_CHANNEL "dataset channel 24"

Copilot uses AI. Check for mistakes.

```cpp
#define CLI_NETWORK_KEY "dataset networkkey 00112233445566778899aabbccddeeff"
#define CLI_NETWORK_CHANEL "dataset channel 24"
Copy link

Copilot AI Nov 7, 2025

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"

Suggested change
#define CLI_NETWORK_CHANEL "dataset channel 24"
#define CLI_NETWORK_CHANNEL "dataset channel 24"

Copilot uses AI. Check for mistakes.

```cpp
#define CLI_NETWORK_KEY "00112233445566778899aabbccddeeff"
#define CLI_NETWORK_CHANEL "24"
Copy link

Copilot AI Nov 7, 2025

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"

Suggested change
#define CLI_NETWORK_CHANEL "24"
#define CLI_NETWORK_CHANNEL "24"

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Area: OpenThread Issues and Feature Request about OpenThread Protocol Status: Review needed Issue or PR is awaiting review Type: Documentation Issue pertains to Documentation of Arduino ESP32

Projects

Status: In Review

Development

Successfully merging this pull request may close these issues.

4 participants