Skip to content

Conversation

@SuGlider
Copy link
Collaborator

@SuGlider SuGlider commented Nov 5, 2025

Description of Change

Adds README.md file for each example

Test Scenarios

CI only

Related links

N/A

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

github-actions bot commented Nov 5, 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): typo":
    • summary looks too short
  • the commit message "fix(matter): 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).

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

👋 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.
- 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 2334eb4

@SuGlider SuGlider moved this from Todo to In Progress in Arduino ESP32 Core Project Roadmap Nov 5, 2025
@SuGlider SuGlider requested a review from Copilot November 5, 2025 08:05
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 adds comprehensive README documentation for 19 Matter example sketches in the ESP32 Arduino Core library. Each README provides detailed instructions for hardware setup, software configuration, commissioning, smart home integration, and troubleshooting for Matter-compatible IoT devices.

Key Changes

  • Added detailed README files for all Matter example projects covering sensors, lights, buttons, and other device types
  • Standardized documentation structure across all examples with consistent sections for supported targets, features, setup, and troubleshooting
  • Included platform-specific commissioning instructions for Apple Home, Amazon Alexa, and Google Home

Reviewed Changes

Copilot reviewed 19 out of 20 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
MatterThermostat/README.md Documentation for thermostat device with heating/cooling control
MatterTemperatureSensor/README.md Documentation for temperature sensor with simulated readings
MatterSmartButon/README.md Documentation for smart button/switch device (note: directory name has typo)
MatterPressureSensor/README.md Documentation for pressure sensor device
MatterOnOffPlugin/README.md Documentation for on/off power relay device
MatterOnOffLight/README.md Documentation for simple on/off light device
MatterOnIdentify/README.md Documentation for light with identify cluster callback
MatterOccupancySensor/README.md Documentation for occupancy/motion sensor device
MatterMinimum/README.md Documentation for minimal Matter implementation example
MatterLambdaSingleCallbackManyEPs/README.md Documentation for multi-endpoint device with lambda callbacks
MatterHumiditySensor/README.md Documentation for humidity sensor device
MatterFan/README.md Documentation for fan device with speed control
MatterEvents/README.md Documentation for Matter event monitoring example
MatterEnhancedColorLight/README.md Documentation for color light with temperature control
MatterDimmableLight/README.md Documentation for dimmable light device
MatterContactSensor/README.md Documentation for contact/door sensor device
MatterComposedLights/README.md Documentation for multi-light composed device
MatterCommissionTest/README.md Documentation for commissioning test example
MatterColorLight/README.md Documentation for RGB color light device

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

SuGlider and others added 3 commits November 5, 2025 05:29
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@SuGlider SuGlider requested a review from lucasssvaz as a code owner November 5, 2025 09:21
@SuGlider SuGlider requested review from Nezaemmy and Copilot November 5, 2025 09:24
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 24 out of 26 changed files in this pull request and generated 1 comment.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@P-R-O-C-H-Y
Copy link
Member

@SuGlider The SmartButton sketch name does not match the folder name.

SuGlider and others added 2 commits November 5, 2025 06:31
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@P-R-O-C-H-Y P-R-O-C-H-Y added the Type: Example Issue is related to specific example. label Nov 5, 2025
@SuGlider SuGlider requested review from Nezaemmy, Copilot and me-no-dev and removed request for Nezaemmy November 5, 2025 09:36
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 24 out of 26 changed files in this pull request and generated no new comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@SuGlider SuGlider moved this from In Progress to In Review in Arduino ESP32 Core Project Roadmap Nov 5, 2025
@SuGlider SuGlider added the Status: Review needed Issue or PR is awaiting review label Nov 5, 2025
@P-R-O-C-H-Y
Copy link
Member

P-R-O-C-H-Y commented Nov 5, 2025

@SuGlider CI is failing, some example is trying to compile for P4

@github-actions
Copy link
Contributor

github-actions bot commented Nov 5, 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
ESP32C5000.000.00000.000.00
ESP32S3000.000.00000.000.00
ESP32S2000.000.00000.000.00
ESP32C3000.000.00000.000.00
ESP32C6000.000.00000.000.00
ESP32H2000.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/MatterCommissionTest00000000000000
libraries/Matter/examples/MatterSmartButton--------------

@SuGlider
Copy link
Collaborator Author

SuGlider commented Nov 5, 2025

@P-R-O-C-H-Y @me-no-dev @lucasssvaz @Nezaemmy - PR ready for final review.

@me-no-dev me-no-dev added Status: Pending Merge Pull Request is ready to be merged and removed Status: Review needed Issue or PR is awaiting review labels Nov 5, 2025
@github-actions github-actions bot added the Status: Pre-commit fixes required ⚠️ The pre-commit bot can't fix the issues automatically. Please fix the issues manually. label Nov 5, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Nov 5, 2025

⚠️ Pre-commit Hooks Failed

Some pre-commit hooks failed and require manual fixes. Please see the detailed error report below.

What to do:

  1. 📋 View the detailed error report to see which hooks failed
  2. 🔧 Fix the issues locally in your code
  3. 💾 Commit and push your changes
  4. 🔄 The hooks will run again automatically

Need help? Ask in the comments below.

@github-actions
Copy link
Contributor

github-actions bot commented Nov 5, 2025

⚠️ Pre-commit Hooks Failed

Some pre-commit hooks failed and require manual fixes. Please see the detailed error report below.

What to do:

  1. 📋 View the detailed error report to see which hooks failed
  2. 🔧 Fix the issues locally in your code
  3. 💾 Commit and push your changes
  4. 🔄 The hooks will run again automatically

Need help? Ask in the comments below.

@lucasssvaz lucasssvaz force-pushed the feature/matter_example_docs branch from 4b192fc to 2334eb4 Compare November 5, 2025 12:20
@github-actions github-actions bot removed the Status: Pre-commit fixes required ⚠️ The pre-commit bot can't fix the issues automatically. Please fix the issues manually. label Nov 5, 2025
@me-no-dev me-no-dev merged commit 21ddb09 into master Nov 5, 2025
17 checks passed
@me-no-dev me-no-dev deleted the feature/matter_example_docs branch November 5, 2025 12:38
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 Status: Pending Merge Pull Request is ready to be merged Type: Example Issue is related to specific example.

Projects

Development

Successfully merging this pull request may close these issues.

6 participants