-
Notifications
You must be signed in to change notification settings - Fork 7.7k
feat(matter): examples documentation #11983
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
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 ...
|
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 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.
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 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.
libraries/Matter/examples/MatterCommissionTest/MatterCommissionTest.ino
Outdated
Show resolved
Hide resolved
|
@SuGlider The SmartButton sketch name does not match the folder name. |
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 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 CI is failing, some example is trying to compile for P4 |
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]
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
@P-R-O-C-H-Y @me-no-dev @lucasssvaz @Nezaemmy - PR ready for final review. |
|
|
4b192fc to
2334eb4
Compare
Description of Change
Adds README.md file for each example
Test Scenarios
CI only
Related links
N/A