OpenThread Example Improvement #10299

SuGlider · 2024-09-05T23:45:56Z

Description of Change

Adds a new example that mixes OpenThread native API with different Arduino OThreadCLI API calls.
New example is ExtendedRouterNode.ino.

Adds OpenThread Native API calls to the current Router and Leader Examples.

Fixes the Library keywords.txt file that didn't use TAB to separate fields.

Tests scenarios

Tested using two ESP32-C6 one for the Leader and the other for the Child/Router.
Used the modified examples.

Related links

Closes #10295
Related to #9486

Creates a new example that mixes different APIs

Adds neessary CI file

Update ExtendedRoterNode.ino with more use of API

Adds OpenThread Native calls to the example

Update LeaderNode.ino example to add OpenThread Native calls.

Update keywords.txt to use TAB instead of SPACE in order to recognize correctly the keywords.

github-actions · 2024-09-05T23:46:36Z

	Warnings
⚠️	Some issues found for the commit messages in this PR: the commit message `"feat(openthread): create cj.json file"`: summary looks too short the commit message `"feat(openthread): improve the example"`: summary looks too short the commit message `"feat(openthread): improve the example"`: summary looks too short Please fix these commit messages - here are some basic tips: follow Conventional 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 20 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 the Conventional Precommit Linter).
⚠️	Please consider squashing your 13 commits (simplifying branch history).

👋 Hello SuGlider, we appreciate your contribution to 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.
- Resolve all warnings (⚠️ ) before requesting a review from human reviewers - they will appreciate it.
- 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 52b3cb7

github-actions · 2024-09-05T23:53:17Z

Test Results

56 files 56 suites 4m 50s ⏱️
21 tests 21 ✅ 0 💤 0 ❌
135 runs 135 ✅ 0 💤 0 ❌

Results for commit 52b3cb7.

♻️ This comment has been updated with latest results.

Changed ExtendedRoterNode to ExtendedRouterNode - Typo error.

Added CI file to the example.

Delete libraries/OpenThread/examples/SimpleThreadNetwork/ExtendedRoterNode directory

github-actions · 2024-09-06T00:22:44Z

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	⚠️ +826	0.00	⚠️ +0.09	0	0	0.00	0.00
ESP32H2	0	⚠️ +934	0.00	⚠️ +0.10	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
OpenThread/examples/SimpleThreadNetwork/ExtendedRouterNode	-	-	-	-
OpenThread/examples/SimpleThreadNetwork/LeaderNode	⚠️ +814	0	⚠️ +920	0
OpenThread/examples/SimpleThreadNetwork/RouterNode	⚠️ +826	0	⚠️ +934	0

P-R-O-C-H-Y

Just a typo to fix :) esle LGTM

libraries/OpenThread/examples/SimpleThreadNetwork/LeaderNode/LeaderNode.ino

libraries/OpenThread/examples/SimpleThreadNetwork/RouterNode/RouterNode.ino

SuGlider · 2024-09-06T12:49:11Z

Typos are automatically detected by CI. It may find other places and then I'll fix them all together.

me-no-dev · 2024-09-09T09:43:03Z

libraries/OpenThread/keywords.txt

@@ -31,10 +31,10 @@ peek	KEYWORD2
 flush	KEYWORD2
 otGetDeviceRole	KEYWORD2
 otGetStringDeviceRole	KEYWORD2
-otGetRespCmd    KEYWORD2
+otGetRespCmd	KEYWORD2


I can't tell from the diff, but it's very important to remember that name and type need to be separated by TAB and not spaces. Is this here true?

Yes. It was separated by spaces and I have fixed it to use TABs.
I noticed it when I was writing the example and the keywords were not highlighted.

SuGlider added 6 commits September 5, 2024 18:05

feat(openthread): add extended example

6912437

Creates a new example that mixes different APIs

feat(openthread): create cj.json file

00f0d0a

Adds neessary CI file

feat(openthread): improve the example

4175638

Update ExtendedRoterNode.ino with more use of API

feat(openthread): improve the example

1b27f84

Adds OpenThread Native calls to the example

feat(openthread): improve the example

0c49edd

Update LeaderNode.ino example to add OpenThread Native calls.

fix(openthread): bad formatting using space

323d4a8

Update keywords.txt to use TAB instead of SPACE in order to recognize correctly the keywords.

SuGlider added the Type: Example Issue is related to specific example. label Sep 5, 2024

SuGlider added this to the 3.0.5 milestone Sep 5, 2024

SuGlider self-assigned this Sep 5, 2024

SuGlider added 3 commits September 5, 2024 21:14

fix(openthread): bad example file name - typo

d21d0bc

Changed ExtendedRoterNode to ExtendedRouterNode - Typo error.

feat(openthread): add extended example ci.json file

eb243f9

Added CI file to the example.

fix(openthread): deleted bad file names in the example

40ae94f

Delete libraries/OpenThread/examples/SimpleThreadNetwork/ExtendedRoterNode directory

SuGlider requested review from me-no-dev, P-R-O-C-H-Y and lucasssvaz September 6, 2024 00:31

P-R-O-C-H-Y approved these changes Sep 6, 2024

View reviewed changes

libraries/OpenThread/examples/SimpleThreadNetwork/LeaderNode/LeaderNode.ino Outdated Show resolved Hide resolved

libraries/OpenThread/examples/SimpleThreadNetwork/RouterNode/RouterNode.ino Outdated Show resolved Hide resolved

me-no-dev reviewed Sep 9, 2024

View reviewed changes

SuGlider added 3 commits September 9, 2024 07:45

Merge branch 'master' into new_openthread_example

e5a0eaf

fix(openthread): typo in commentaries

20f7c4d

fix(openthread): typo in commentaries

79827b7

me-no-dev added the Status: Pending Merge Pull Request is ready to be merged label Sep 9, 2024

me-no-dev approved these changes Sep 9, 2024

View reviewed changes

ci(pre-commit): Apply automatic fixes

52b3cb7

SuGlider mentioned this pull request Sep 9, 2024

Implement OpenThread in Arduino #9486

Open

18 tasks

me-no-dev merged commit cbe0f2f into master Sep 9, 2024
43 checks passed

me-no-dev deleted the new_openthread_example branch September 9, 2024 13:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

OpenThread Example Improvement #10299

OpenThread Example Improvement #10299

SuGlider commented Sep 5, 2024 •

edited

Loading

github-actions bot commented Sep 5, 2024 •

edited

Loading

github-actions bot commented Sep 5, 2024 •

edited

Loading

github-actions bot commented Sep 6, 2024 •

edited

Loading

P-R-O-C-H-Y left a comment

SuGlider commented Sep 6, 2024 •

edited

Loading

me-no-dev Sep 9, 2024

SuGlider Sep 9, 2024

OpenThread Example Improvement #10299

OpenThread Example Improvement #10299

Conversation

SuGlider commented Sep 5, 2024 • edited Loading

Description of Change

Tests scenarios

Related links

github-actions bot commented Sep 5, 2024 • edited Loading

github-actions bot commented Sep 5, 2024 • edited Loading

Test Results

github-actions bot commented Sep 6, 2024 • edited Loading

Memory usage test (comparing PR against master branch)

P-R-O-C-H-Y left a comment

Choose a reason for hiding this comment

SuGlider commented Sep 6, 2024 • edited Loading

me-no-dev Sep 9, 2024

Choose a reason for hiding this comment

SuGlider Sep 9, 2024

Choose a reason for hiding this comment

SuGlider commented Sep 5, 2024 •

edited

Loading

github-actions bot commented Sep 5, 2024 •

edited

Loading

github-actions bot commented Sep 5, 2024 •

edited

Loading

github-actions bot commented Sep 6, 2024 •

edited

Loading

SuGlider commented Sep 6, 2024 •

edited

Loading