Skip to content

Conversation

@SuGlider
Copy link
Collaborator

@SuGlider SuGlider commented Dec 14, 2025

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:

  // Network and Commissioning Capability Queries
  // These methods check both hardware support (SOC capabilities) and Matter configuration
  static bool isWiFiStationEnabled();        // Check if WiFi Station mode is supported and enabled
  static bool isWiFiAccessPointEnabled();    // Check if WiFi AP mode is supported and enabled
  static bool isThreadEnabled();             // Check if Thread network is supported and enabled
  static bool isBLECommissioningEnabled();   // Check if BLE commissioning is supported and enabled

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

@SuGlider SuGlider self-assigned this Dec 14, 2025
@SuGlider SuGlider added the Area: Matter Issues and Feature Request about Matter Protocol label Dec 14, 2025
@SuGlider SuGlider added this to the 3.3.0 milestone Dec 14, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Dec 14, 2025

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "fix(matter): typo":
    • summary looks too short
  • the commit message "fix(matter_docs): typo":
    • summary looks too short
  • the commit message "fix(matter_docs): typo":
    • 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 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 the Conventional Precommit Linter).

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

@github-actions
Copy link
Contributor

github-actions bot commented Dec 14, 2025

Test Results

 90 files   90 suites   27m 57s ⏱️
 66 tests  56 ✅ 0 💤 10 ❌
675 runs  655 ✅ 0 💤 20 ❌

For more details on these failures, see this check.

Results for commit 7ca27fd.

♻️ This comment has been updated with latest results.

@SuGlider SuGlider moved this from Todo to In Progress in Arduino ESP32 Core Project Roadmap Dec 14, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Dec 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.

MemoryFLASH [bytes]FLASH [%]RAM [bytes]RAM [%]
TargetDECINCDECINCDECINCDECINC
ESP32C50⚠️ +300.000.00000.000.00
ESP32S3000.000.00000.000.00
ESP32S2000.000.00000.000.00
ESP32C3000.000.00000.000.00
ESP32C60⚠️ +360.000.00000.000.00
ESP32H20⚠️ +300.000.00000.000.00
ESP32000.000.00000.000.00
Click to expand the detailed deltas report [usage change in BYTES]
TargetESP32C5ESP32S3ESP32S2ESP32C3ESP32C6ESP32H2ESP32
ExampleFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAM
libraries/Matter/examples/MatterColorLight00--0000000000
libraries/Matter/examples/MatterCommissionTest00--0000000000
libraries/Matter/examples/MatterComposedLights00--0000000000
libraries/Matter/examples/MatterContactSensor00--0000000000
libraries/Matter/examples/MatterDimmableLight00--0000000000
libraries/Matter/examples/MatterDimmablePlugin00--0000000000
libraries/Matter/examples/MatterEnhancedColorLight00--0000000000
libraries/Matter/examples/MatterEvents00--0000000000
libraries/Matter/examples/MatterFan00--0000000000
libraries/Matter/examples/MatterHumiditySensor00--0000000000
libraries/Matter/examples/MatterLambdaSingleCallbackManyEPs⚠️ +300--0000⚠️ +360⚠️ +30000
libraries/Matter/examples/MatterMinimum00--0000000000
libraries/Matter/examples/MatterOccupancySensor00--0000000000
libraries/Matter/examples/MatterOnIdentify00--0000000000
libraries/Matter/examples/MatterOnOffLight00--0000000000
libraries/Matter/examples/MatterOnOffPlugin00--0000000000
libraries/Matter/examples/MatterPressureSensor00--0000000000
libraries/Matter/examples/MatterRainSensor00--0000000000
libraries/Matter/examples/MatterSimpleBlinds--------------
libraries/Matter/examples/MatterSmartButton00--0000000000
libraries/Matter/examples/MatterStatus--------------
libraries/Matter/examples/MatterTemperatureControlledCabinet00--0000000000
libraries/Matter/examples/MatterTemperatureControlledCabinetLevels00--0000000000
libraries/Matter/examples/MatterTemperatureLight00--0000000000
libraries/Matter/examples/MatterTemperatureSensor00--0000000000
libraries/Matter/examples/MatterThermostat00--0000000000
libraries/Matter/examples/MatterWaterFreezeDetector00--0000000000
libraries/Matter/examples/MatterWaterLeakDetector00--0000000000
libraries/Matter/examples/MatterWindowCovering00--0000000000

@SuGlider SuGlider moved this from In Progress to In Review in Arduino ESP32 Core Project Roadmap Dec 14, 2025
@SuGlider
Copy link
Collaborator Author

@lucasssvaz - Wokwi fails with the SD Card unity test.

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

SuGlider and others added 3 commits December 14, 2025 18:59
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>
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

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.

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

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.

@Gunni
Copy link

Gunni commented Dec 14, 2025

On mobile, can't check, please ensure no hard dependence on specific network stack, f.ex wifi, thread, or ethernet.

SuGlider and others added 2 commits December 14, 2025 20:47
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@SuGlider
Copy link
Collaborator Author

On mobile, can't check, please ensure no hard dependence on specific network stack, f.ex wifi, thread, or ethernet.

@Gunni - Please elaborate more about your comment.
The Mobile APP (Alexa, Apple Home, Google HA etc) will follow whatever the Matter Accessory defines (ESP32 device implementation).

@Gunni
Copy link

Gunni commented Dec 15, 2025

Sorry, it just meant that I was on my phone when making that comment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Area: Matter Issues and Feature Request about Matter Protocol

Projects

Status: In Review

Development

Successfully merging this pull request may close these issues.

Implement the isThreadConnected method

3 participants