New OpenThread CLI Arduino Library for ESP32-C6 and ESP32-H2 #9908

SuGlider · 2024-06-20T06:11:46Z

Description of Change

Adds the OpenThread CLI Arduino Library.
It has some examples.

Only available for the C6 and H2.

Tests scenarios

Examples tested on C6 and H2.

Related links

github-actions · 2024-06-20T06:12:24Z

	Warnings
⚠️	Some issues found for the commit messages in this PR: the commit message `"feat(OThread): Add Library"`: summary looks too short scope/component should be lowercase without whitespace, allowed special characters are `_` `/` `.` `,` `` `-` `.` the commit message `"feat(openthread): New Scan Example"`: summary* looks too short the commit message `"feat(openthread): README.md"`: summary looks too short the commit message `"feat(openthread): commentary"`: summary looks too short the commit message `"feat(openthread): formatting text"`: summary looks too short the commit message `"feat(openthread): onReceice example"`: summary looks too short the commit message `"fix(OpenThread): fixes file list in CMakeLists.txt"`: scope/component should be lowercase without whitespace, allowed special characters are `_` `/` `.` `,` `` `-` `.` the commit message `"fix(doc): fixing documentation apresentation"`: body's lines must not be longer than 100 characters the commit message `"fix(openthread): Fixes JSON CI Files"`: summary* looks too short the commit message `"fix(openthread): Fixes JSON CI Files"`: summary looks too short the commit message `"fix(openthread): Improves code"`: summary looks too short the commit message `"fix(openthread): begin end"`: summary looks too short the commit message `"fix(openthread): library properties"`: summary looks too short the commit message `"fix(openthread): tx queue error"`: 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 32 commits (simplifying branch history).
⚠️	The source branch `"OpenThread"` incorrect format: contains uppercase letters. This can cause troubles on case-insensitive file systems (macOS). Please rename your branch.

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

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

…into OpenThread

github-actions · 2024-06-20T06:23:51Z

Test Results

56 files 56 suites 9m 37s ⏱️
21 tests 20 ✅ 0 💤 1 ❌
135 runs 125 ✅ 0 💤 10 ❌

For more details on these failures, see this check.

Results for commit 81d62e9.

♻️ This comment has been updated with latest results.

SuGlider · 2024-06-20T06:37:32Z

@lucasssvaz - Is it possible that the CI failures are related to using cached files that don't have the necessary file structure?

libraries/OpenThread/examples/COAP/coap_lamp/ci.json

P-R-O-C-H-Y · 2024-06-20T08:20:33Z

@SuGlider Also you have to fix the Arduino as IDF component as CI is failing for C6 and H2.

In file included from /__w/arduino-esp32/arduino-esp32/components/arduino-esp32/libraries/OpenThread/src/OThreadCLI.cpp:1:
/__w/arduino-esp32/arduino-esp32/components/arduino-esp32/libraries/OpenThread/src/OThreadCLI.h:5:10: fatal error: esp_openthread.h: No such file or directory
    5 | #include "esp_openthread.h"
      |          ^~~~~~~~~~~~~~~~~~
Missing "esp_openthread.h" file name found in the following component(s): openthread(/opt/esp/idf/components/openthread/include/esp_openthread.h). 
Maybe one of the components needs to add the missing header directory to INCLUDE_DIRS of idf_component_register call in CMakeLists.txt.

SuGlider · 2024-06-20T12:06:26Z

@SuGlider Also you have to fix the Arduino as IDF component as CI is failing for C6 and H2.

In file included from /__w/arduino-esp32/arduino-esp32/components/arduino-esp32/libraries/OpenThread/src/OThreadCLI.cpp:1:
/__w/arduino-esp32/arduino-esp32/components/arduino-esp32/libraries/OpenThread/src/OThreadCLI.h:5:10: fatal error: esp_openthread.h: No such file or directory
    5 | #include "esp_openthread.h"
      |          ^~~~~~~~~~~~~~~~~~
Missing "esp_openthread.h" file name found in the following component(s): openthread(/opt/esp/idf/components/openthread/include/esp_openthread.h). 
Maybe one of the components needs to add the missing header directory to INCLUDE_DIRS of idf_component_register call in CMakeLists.txt.

Openthread is already an IDF component.
https://github.com/espressif/esp-idf/tree/master/components/openthread
But there are 2 folders there that are external repositories and those should be cloned by CI in a recursive way.

When I use Arduino as Component, I clone IDF repository with all submodules, recursively and this error never happens.

me-no-dev · 2024-06-20T12:07:08Z

@SuGlider I suggest you guard the library files with #if CONFIG_OPENTHREAD_ENABLED.

#include "sdkconfig.h"
#if CONFIG_OPENTHREAD_ENABLED
#include "esp_openthread.h"
//...
#endif /* CONFIG_OPENTHREAD_ENABLED */

me-no-dev · 2024-06-20T12:08:34Z

Openthread is already an IDF component.

but it's not enabled in the default CI build. That's it's purpose

github-actions · 2024-06-20T13:20: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	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
OpenThread/examples/COAP/coap_lamp	-	-	-	-
OpenThread/examples/COAP/coap_switch	-	-	-	-
OpenThread/examples/SimpleCLI	-	-	-	-
OpenThread/examples/SimpleNode	-	-	-	-
OpenThread/examples/SimpleThreadNetwork/LeaderNode	-	-	-	-
OpenThread/examples/SimpleThreadNetwork/RouterNode	-	-	-	-
OpenThread/examples/ThreadScan	-	-	-	-
OpenThread/examples/onReceive	-	-	-	-

…into OpenThread

Fixes the documentation first paragraph in order to make it easier fore reading. It also displays in the very top which SoC are supported by the library.

SuGlider · 2024-06-24T01:32:24Z

@P-R-O-C-H-Y - DangerJS Linter fails... Is it a problem?

DangerJS checks (rules) output states:

Commit messages style......................................................................... Failed
Number of commits in Pull Request............................................................. Failed
Pull Request size (number of changed lines)................................ Passed (with suggestions)
Pull Request sufficient Description........................................................... Passed
Source branch name............................................................................ Failed
Target branch is project default branch....................................................... Passed

lucasssvaz · 2024-06-24T02:29:21Z

@SuGlider The DangerJS failure is bc some of the wokwi tests failed
https://github.com/espressif/arduino-esp32/runs/26578220915

SuGlider · 2024-06-24T02:33:34Z

@SuGlider The DangerJS failure is bc some of the wokwi tests failed https://github.com/espressif/arduino-esp32/runs/26578220915

But all passed, only DangerJS failed.

CMakeLists.txt

libraries/OpenThread/src/OThreadCLI.h

…into OpenThread

lucasssvaz

To avoid putting everything in a single line

libraries/OpenThread/examples/COAP/coap_lamp/coap_lamp.ino

libraries/OpenThread/examples/COAP/coap_switch/coap_switch.ino

SuGlider · 2024-06-24T14:19:45Z

@lucasssvaz - I have added more commented lines in the array. I think that it should get all in the right place. Could youforce running the formatting CI job on top of the current PR just to check if it changes anything else?
Thanks.

lucasssvaz

@SuGlider Yeah, looks good.

SuGlider · 2024-06-24T15:08:02Z

@me-no-dev - I guess that the PR is ready for merging. Please check if there is something else missing beside the Wokwi CI errors.

feat(OThread): Add Library

9e26803

SuGlider added this to the 3.0.2 milestone Jun 20, 2024

SuGlider self-assigned this Jun 20, 2024

Merge branch 'master' into OpenThread

fb2a502

SuGlider added 2 commits June 20, 2024 03:15

fix(OpenThread): fixes file list in CMakeLists.txt

1a66bc1

Merge branch 'OpenThread' of https://github.com/SuGlider/arduino-esp32 …

827b72c

…into OpenThread

SuGlider marked this pull request as draft June 20, 2024 06:23

P-R-O-C-H-Y reviewed Jun 20, 2024

View reviewed changes

libraries/OpenThread/examples/COAP/coap_lamp/ci.json Outdated Show resolved Hide resolved

SuGlider added 2 commits June 20, 2024 08:43

fix(openthread): Fixes JSON CI Files

54f043a

Merge branch 'master' into OpenThread

69f4fce

SuGlider added 4 commits June 20, 2024 09:19

fix(openthread): Fixes JSON CI Files

3e11343

fix(openthread): Include Openthread guarding

1b2530d

fix(openthread): COAP parametrization

739b77c

fix(openthread): Include Openthread guarding

3687c5f

fix(openthread): Improves commentaries and code

bbece1c

SuGlider requested review from me-no-dev and lucasssvaz June 20, 2024 14:47

SuGlider added 2 commits June 20, 2024 14:24

fix(openthread): Improves code

5c677be

fix(openthread): Includes StreamString.h

436a7ff

SuGlider marked this pull request as ready for review June 20, 2024 17:39

SuGlider added 2 commits June 20, 2024 16:34

Merge branch 'master' into OpenThread

378f993

feat(openthread): New Scan Example

ce46f4a

SuGlider added 4 commits June 23, 2024 13:47

Merge branch 'OpenThread' of https://github.com/SuGlider/arduino-esp32 …

f9d1e55

…into OpenThread

fix(openthread): tx queue error

176f92b

fix(doc): fixing documentation apresentation

6b0b9af

Fixes the documentation first paragraph in order to make it easier fore reading. It also displays in the very top which SoC are supported by the library.

fix(doc): documentation format

4ec1397

feat(openthread): commentary

2aaa575

me-no-dev reviewed Jun 24, 2024

View reviewed changes

CMakeLists.txt Outdated Show resolved Hide resolved

Merge branch 'master' into OpenThread

46cf9aa

me-no-dev requested changes Jun 24, 2024

View reviewed changes

libraries/OpenThread/src/OThreadCLI.h Outdated Show resolved Hide resolved

SuGlider added 2 commits June 24, 2024 08:50

fix(openthread): Typo, start/stop console

eb7b019

Merge branch 'OpenThread' of https://github.com/SuGlider/arduino-esp32 …

919bf79

…into OpenThread

me-no-dev approved these changes Jun 24, 2024

View reviewed changes

lucasssvaz approved these changes Jun 24, 2024

View reviewed changes

lucasssvaz added Status: Pending Merge Pull Request is ready to be merged Area: Libraries Issue is related to Library support. labels Jun 24, 2024

P-R-O-C-H-Y approved these changes Jun 24, 2024

View reviewed changes

lucasssvaz removed the Status: Pending Merge Pull Request is ready to be merged label Jun 24, 2024

SuGlider and others added 2 commits June 24, 2024 09:51

fix(openthread): library properties

b60a354

ci(pre-commit): Apply automatic fixes

11ec1d1

lucasssvaz force-pushed the OpenThread branch from 1f20860 to 11ec1d1 Compare June 24, 2024 12:52

feat(openthread): formatting text

55f9378

lucasssvaz requested changes Jun 24, 2024

View reviewed changes

lucasssvaz added the Status: Pending Merge Pull Request is ready to be merged label Jun 24, 2024

ci(pre-commit): Apply automatic fixes

81d62e9

lucasssvaz approved these changes Jun 24, 2024

View reviewed changes

me-no-dev merged commit d891ddf into espressif:master Jun 24, 2024
42 of 47 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New OpenThread CLI Arduino Library for ESP32-C6 and ESP32-H2 #9908

New OpenThread CLI Arduino Library for ESP32-C6 and ESP32-H2 #9908

SuGlider commented Jun 20, 2024

github-actions bot commented Jun 20, 2024 •

edited

Loading

github-actions bot commented Jun 20, 2024 •

edited

Loading

SuGlider commented Jun 20, 2024

P-R-O-C-H-Y commented Jun 20, 2024

SuGlider commented Jun 20, 2024

me-no-dev commented Jun 20, 2024

me-no-dev commented Jun 20, 2024

github-actions bot commented Jun 20, 2024 •

edited

Loading

SuGlider commented Jun 24, 2024 •

edited

Loading

lucasssvaz commented Jun 24, 2024 •

edited

Loading

SuGlider commented Jun 24, 2024

lucasssvaz left a comment

SuGlider commented Jun 24, 2024

lucasssvaz left a comment

SuGlider commented Jun 24, 2024

New OpenThread CLI Arduino Library for ESP32-C6 and ESP32-H2 #9908

New OpenThread CLI Arduino Library for ESP32-C6 and ESP32-H2 #9908

Conversation

SuGlider commented Jun 20, 2024

Description of Change

Tests scenarios

Related links

github-actions bot commented Jun 20, 2024 • edited Loading

github-actions bot commented Jun 20, 2024 • edited Loading

Test Results

SuGlider commented Jun 20, 2024

P-R-O-C-H-Y commented Jun 20, 2024

SuGlider commented Jun 20, 2024

me-no-dev commented Jun 20, 2024

me-no-dev commented Jun 20, 2024

github-actions bot commented Jun 20, 2024 • edited Loading

Memory usage test (comparing PR against master branch)

SuGlider commented Jun 24, 2024 • edited Loading

lucasssvaz commented Jun 24, 2024 • edited Loading

SuGlider commented Jun 24, 2024

lucasssvaz left a comment

Choose a reason for hiding this comment

SuGlider commented Jun 24, 2024

lucasssvaz left a comment

Choose a reason for hiding this comment

SuGlider commented Jun 24, 2024

github-actions bot commented Jun 20, 2024 •

edited

Loading

github-actions bot commented Jun 20, 2024 •

edited

Loading

github-actions bot commented Jun 20, 2024 •

edited

Loading

SuGlider commented Jun 24, 2024 •

edited

Loading

lucasssvaz commented Jun 24, 2024 •

edited

Loading