-
Notifications
You must be signed in to change notification settings - Fork 7.8k
feature(matter): improves Matter testing/status functions and documentation #12140
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 ...
|
Test Results 90 files 90 suites 27m 57s ⏱️ For more details on these failures, see this check. Results for commit 7ca27fd. ♻️ This comment has been updated with latest results. |
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.
Click to expand the detailed deltas report [usage change in BYTES]
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
@lucasssvaz - Wokwi fails with the SD Card unity test. |
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 enhances the Matter library by adding capability query functions to check enabled features and network support, fixes the Thread connection status implementation, and significantly improves documentation across all Matter examples. The changes enable developers to programmatically determine which Matter features are available on their hardware and configuration.
- Adds four new capability query functions to check WiFi Station, WiFi AP, Thread, and BLE commissioning support
- Fixes the
isThreadConnected()implementation to use the correct ConnectivityMgr API - Adds comprehensive building and flashing instructions to all example README files
- Creates a new MatterStatus example demonstrating the capability query functions
Reviewed changes
Copilot reviewed 35 out of 37 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| libraries/Matter/src/Matter.h | Adds declarations for four new capability query methods and removes conditional compilation directives around connection status methods |
| libraries/Matter/src/Matter.cpp | Implements new capability query functions checking both hardware support and Matter configuration; fixes isThreadConnected() to use IsThreadAttached(); simplifies isDeviceConnected() logic |
| libraries/Matter/keywords.txt | Registers new capability query functions (isBLECommissioningEnabled, isThreadEnabled, isWiFiAccessPointEnabled, isWiFiStationEnabled) as keywords |
| libraries/Matter/examples/MatterStatus/MatterStatus.ino | New example demonstrating capability queries and connection status monitoring with periodic reporting |
| libraries/Matter/examples/MatterStatus/README.md | Comprehensive documentation for the new MatterStatus example including supported targets, features, and usage instructions |
| libraries/Matter/examples/MatterStatus/ci.yml | CI configuration for MatterStatus example specifying partition scheme and Matter data model requirement |
| libraries/Matter/examples/*/README.md | Adds standardized building/flashing instructions (partition scheme and erase flash settings) to 22 existing example README files |
| docs/en/matter/matter.rst | Adds building/flashing prerequisites section with screenshots, updates Matter class method list, and adds comprehensive examples catalog with descriptions and GitHub links |
| docs/_static/matter_partition_scheme.png | Screenshot showing partition scheme selection in Arduino IDE |
| docs/_static/matter_erase_flash.png | Screenshot showing erase flash option in Arduino IDE |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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
Copilot reviewed 36 out of 39 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
Copilot reviewed 36 out of 39 changed files in this pull request and generated 4 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
On mobile, can't check, please ensure no hard dependence on specific network stack, f.ex wifi, thread, or ethernet. |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@Gunni - Please elaborate more about your comment. |
|
Sorry, it just meant that I was on my phone when making that comment. |
Description of Change
This PR improves and adds some new Matter network and status functions as well as the documentation:
1- Adds the necessary Arduino settings and IDE options in order to build it and upload the sketch.
2- Adds new functions to verify if WiFi (STA and AP), Thread and BLE Commissioning are enabled in the configuration.
3- Adds the list of examples with a short description to the main documentation.
4- Adds necessary IDE building option to all example's README.md files
5- Adds a new exmaple that demonstrates the Matter status and feature test functions.
6- Fixes incorrect example name and terms Windows Blind --> Blinds
7- Fixes documentation API
isWi-FiConnected()-->isWiFiConnected()Added new Matter Functions:
Fixes implementation of
static bool isThreadConnected()Matter class method.Test Scenarios
Tested using the provided example for the ESP32-S2, ESP32-C6, ESP32-C3 and ESP32-H2.
Related links
Closes #12139
Related to #11965