-
Notifications
You must be signed in to change notification settings - Fork 7.7k
feat(matter): adds Arduino Matter Library documentation #11984
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 documentation for the Matter library in the Arduino ESP32 core. The documentation covers the Matter protocol overview, network topology, the main Matter class, the MatterEndPoint base class, and 15 specialized endpoint classes for various device types (lights, sensors, controls).
- Complete Matter library documentation with protocol overview and architecture
- API reference documentation for all endpoint classes with usage examples
- Structured documentation hierarchy using Sphinx/reStructuredText format
Reviewed Changes
Copilot reviewed 16 out of 16 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/en/matter/matter.rst | Main Matter documentation with protocol overview, library structure, troubleshooting guide, and links to endpoint documentation |
| docs/en/matter/matter_endpoint.rst | MatterEndPoint base class documentation covering endpoint management, attributes, identify cluster, and callbacks |
| docs/en/matter/ep_thermostat.rst | MatterThermostat endpoint documentation with temperature control, setpoints, and operating modes |
| docs/en/matter/ep_temperature_sensor.rst | MatterTemperatureSensor endpoint documentation for read-only temperature reporting |
| docs/en/matter/ep_pressure_sensor.rst | MatterPressureSensor endpoint documentation for atmospheric pressure monitoring |
| docs/en/matter/ep_on_off_plugin.rst | MatterOnOffPlugin endpoint documentation for smart power outlets and relays |
| docs/en/matter/ep_on_off_light.rst | MatterOnOffLight endpoint documentation for basic on/off light control |
| docs/en/matter/ep_occupancy_sensor.rst | MatterOccupancySensor endpoint documentation for motion/occupancy detection |
| docs/en/matter/ep_humidity_sensor.rst | MatterHumiditySensor endpoint documentation for humidity monitoring |
| docs/en/matter/ep_generic_switch.rst | MatterGenericSwitch endpoint documentation for smart button/automation triggers |
| docs/en/matter/ep_fan.rst | MatterFan endpoint documentation with speed and mode control |
| docs/en/matter/ep_enhanced_color_light.rst | MatterEnhancedColorLight endpoint documentation with RGB, brightness, and color temperature |
| docs/en/matter/ep_dimmable_light.rst | MatterDimmableLight endpoint documentation with brightness control |
| docs/en/matter/ep_contact_sensor.rst | MatterContactSensor endpoint documentation for door/window sensors |
| docs/en/matter/ep_color_temperature_light.rst | MatterColorTemperatureLight endpoint documentation for tunable white lights |
| docs/en/matter/ep_color_light.rst | MatterColorLight endpoint documentation for RGB color control |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
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 18 out of 18 changed files in this pull request and generated no new comments.
Comments suppressed due to low confidence (1)
libraries/Matter/src/MatterEndpoints/MatterThermostat.h:108
- The parameters are passed in the wrong order.
setCoolingHeatingSetpointsexpects heating temperature first, then cooling temperature, but here cooling is set to 0xffff (first parameter) and heating is set to the provided value (second parameter). This should besetCoolingHeatingSetpoints(_setpointHeatingTemperature, (double)0xffff).
return setCoolingHeatingSetpoints((double)0xffff, _setpointHeatingTemperature);
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Test Results 76 files 76 suites 15m 47s ⏱️ Results for commit 1ce3a16. ♻️ 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]
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
@me-no-dev - this PR depends on #11983 to be merged because the URL to the SmartButton example fixes the |
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.
@SuGlider The documentation sources needs to be added to the library.rst file. Check how the Zigbee is added there, as you are adding it the same way.
I will fix it. |
|
@lucasssvaz - it is necessary to add Matter.rst to the main index. I have left the office and I can't fix it from here... Please help fixing all the missing index references to the files. |
|
Description of Change
This pull request adds API documentation for Matter Library.
Test Scenarios
CI only
Related links
Requires #11983