NotificationsYou must be signed in to change notification settings
Fork7.8k
Star15.9k

feat(openthread): native API extension#11598

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Merged

me-no-dev merged 9 commits intoespressif:masterfromSuGlider:openthread_native_get_information

Jul 16, 2025

Merged

feat(openthread): native API extension#11598

me-no-dev merged 9 commits intoespressif:masterfromSuGlider:openthread_native_get_information

Jul 16, 2025

Conversation

Copy link

Collaborator

SuGlider commentedJul 14, 2025

Description of Change

This pull request introduces enhancements to the OpenThread library, focusing on improved network information retrieval, including caching mechanisms for unicast and multicast list of addresses.
It also adds new methods for accessing and managing Thread network data directly from node operational dataset.

Arduino Keywords are updated to cover all changes.
Current Native API examples were updated to demonstrate the new API application.

Tests scenarios

Using ESP32-C6 and ESP32-H2 with the provided examples.

Related links

None.

feat(openthread): native API extension

a89fcea

SuGlider added this to the3.2.1 milestone

Jul 14, 2025

SuGlider self-assigned this

Jul 14, 2025

SuGlider added the Area: OpenThreadIssues and Feature Request about OpenThread Protocol label

Jul 14, 2025

SuGlider added this toArduino ESP32 Core Project Roadmap

Jul 14, 2025

github-project-automationbot moved this toTodo inArduino ESP32 Core Project Roadmap

Jul 14, 2025

SuGlider marked this pull request as draft

July 14, 2025 17:52

Copy link

Contributor

github-actionsbot commentedJul 14, 2025•
edited
Loading

	Warnings
⚠️	Some issues found for the commit messages in this PR: the commit message`"fix(openthread): CR/LF fix"`: summary looks too short Please fix these commit messages - here are some basic tips: followConventional Commits style correct format of commit message should be:`<type/action>(<scope/component>): <summary>`, for example`fix(esp32): Fixed startup timeout issue` allowed types are:`change,ci,docs,feat,fix,refactor,remove,revert,test` sufficiently descriptive message summary should be between 10 to 72 characters and start with upper case letter avoid Jira references in commit messages (unavailable/irrelevant for our customers) `TIP:` Install pre-commit hooks and run this check when committing (uses theConventional Precommit Linter).

👋Hello SuGlider, we appreciate your contribution to this project!

📘 Please review the project'sContributions Guide for key guidelines on code, documentation, testing, and more.

🖊️ Please also make sure you haveread and signed theContributor License Agreement for this project.

Click to see more instructions ...

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

DangerJS is triggered with eachpush 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 isnot a substitute for human code reviews; it's still important to request a code review from your colleagues.
-Resolve all warnings (⚠️ ) before requesting a review from human reviewers - they will appreciate it.
- To manuallyretry these Danger checks, please navigate to theActions 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 againstcc145c7

Copy link

Contributor

github-actionsbot commentedJul 14, 2025•
edited
Loading

Test Results

76 files 76 suites 13m 9s ⏱️
38 tests 38 ✅ 0 💤 0 ❌
241 runs 241 ✅ 0 💤 0 ❌

Results for commitcc145c7.

♻️ This comment has been updated with latest results.

SuGlider added3 commits

July 14, 2025 15:10

fix(openthread): wrong return type and parameter

dcb09f3

Merge branch 'master' into openthread_native_get_information

6e0507c

fix(openthread): wrong field reference

637402f

Copy link

Contributor

github-actionsbot commentedJul 14, 2025

Memory usage test (comparing PR against master branch)

The table below shows the summary of memory usage change (decrease - increase) in bytes and percentage for each target.

Memory	FLASH [bytes]		FLASH [%]		RAM [bytes]		RAM [%]
Target	DEC	INC	DEC	INC	DEC	INC	DEC	INC
ESP32C6	0	0	0.00	0.00	0	0	0.00	0.00
ESP32H2	0	0	0.00	0.00	0	0	0.00	0.00

Click to expand the detailed deltas report [usage change in BYTES]

Target	ESP32C6		ESP32H2
Example	FLASH	RAM	FLASH	RAM
libraries/OpenThread/examples/CLI/COAP/coap_lamp	-	-	-	-
libraries/OpenThread/examples/CLI/COAP/coap_switch	-	-	-	-
libraries/OpenThread/examples/CLI/SimpleCLI	-	-	-	-
libraries/OpenThread/examples/CLI/SimpleNode	-	-	-	-
libraries/OpenThread/examples/CLI/SimpleThreadNetwork/ExtendedRouterNode	-	-	-	-
libraries/OpenThread/examples/CLI/SimpleThreadNetwork/LeaderNode	-	-	-	-
libraries/OpenThread/examples/CLI/SimpleThreadNetwork/RouterNode	-	-	-	-
libraries/OpenThread/examples/CLI/ThreadScan	-	-	-	-
libraries/OpenThread/examples/CLI/onReceive	-	-	-	-
libraries/OpenThread/examples/Native/SimpleThreadNetwork/LeaderNode	-	-	-	-
libraries/OpenThread/examples/Native/SimpleThreadNetwork/RouterNode	-	-	-	-

fix(openthread): CR/LF fix

a48f398

SuGlider requested a review fromCopilot

July 14, 2025 19:17

This comment was marked as outdated.

SuGlider added2 commits

July 14, 2025 16:25

feat(openthread): print leader RLOC information

c336d93

feat(openthread): code improvements

0ae4855

SuGlider requested a review fromCopilot

July 15, 2025 01:56

CopilotAI reviewed

Jul 15, 2025

View reviewed changes

Copy link

Contributor

CopilotAI 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 enhances the native OpenThread API by exposing operational dataset and network parameters to Arduino applications, adds caching for unicast and multicast IPv6 addresses, and updates examples and keyword lists to demonstrate the new functionality.

Added getters for network name, extended PAN ID, network key, channel, PAN ID, RLOCs, and the current dataset.
Introduced mutable caching for unicast and multicast addresses, with populate/clear APIs.
Updated Arduino keywords and example sketches (RouterNode and LeaderNode) to use and showcase the new methods.

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
libraries/OpenThread/src/OThread.h	Declared new getters for network info and address-cache methods
libraries/OpenThread/src/OThread.cpp	Implemented dataset setters with null checks, getters, caching
libraries/OpenThread/keywords.txt	Added new API methods and`OnReceiveCb_t` to the keyword list
libraries/OpenThread/examples/.../RouterNode.ino	Updated example to display active dataset details
libraries/OpenThread/examples/.../LeaderNode.ino	Updated example to list unicast/multicast addresses and handle role changes

Comments suppressed due to low confidence (5)

libraries/OpenThread/src/OThread.h:153

[nitpick] The member namemCurrentDataset differs from the originalmCurrentDataSet naming. Align with the existing convention (e.g.,mCurrentDataSet) for consistency.

  static DataSet mCurrentDataset;  // Current dataset being used by the OpenThread instance.

libraries/OpenThread/src/OThread.cpp:621

The new address-caching APIs (getUnicastAddressCount,getUnicastAddress,getAllUnicastAddresses and multicast equivalents) currently lack unit tests. Add tests to verify cache population, clearing, and out-of-range behavior.

size_t OpenThread::getUnicastAddressCount() const {

libraries/OpenThread/src/OThread.cpp:142

Using OT_NETWORK_KEY_SIZE may not match the actual network name buffer length and doesn’t guarantee null-termination. Use sizeof(mDataset.mNetworkName.m8) (or the correct OT_NETWORK_NAME_SIZE) and explicitly set the final byte to '\0' to avoid overflow.

  strncpy(mDataset.mNetworkName.m8, name, OT_NETWORK_KEY_SIZE);

libraries/OpenThread/examples/Native/SimpleThreadNetwork/RouterNode/RouterNode.ino:26

The example callsotGetDeviceRole(), but this wrapper isn’t declared in the updatedOThread.h. Either expose this method in the header or use the correct existing API name to avoid a compile error.

  ot_device_role_t currentRole = threadChildNode.otGetDeviceRole();

libraries/OpenThread/keywords.txt:16

[nitpick]OnReceiveCb_t was added to the keyword list but isn’t introduced in these changes. If it’s not used in any new API, consider removing it to keep the keyword file focused.