Skip to content

Conversation

@SuGlider
Copy link
Collaborator

@SuGlider SuGlider commented Dec 3, 2025

Description of Change

Adds new Matter Endpoint for Water Freeze Detector endpoint, related example and documentation.

Test Scenarios

ESP32-S3 with posted example

Related links

None

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

github-actions bot commented Dec 3, 2025

Messages
📖 🎉 Good Job! All checks are passing!

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

@SuGlider SuGlider requested a review from P-R-O-C-H-Y December 3, 2025 19:12
@SuGlider SuGlider moved this from Todo to In Progress in Arduino ESP32 Core Project Roadmap Dec 3, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Dec 3, 2025

Test Results

 83 files   83 suites   27m 58s ⏱️
 55 tests  55 ✅ 0 💤 0 ❌
598 runs  598 ✅ 0 💤 0 ❌

Results for commit c893b68.

♻️ This comment has been updated with latest results.

@github-actions
Copy link
Contributor

github-actions bot commented Dec 3, 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
ESP32S30⚠️ +2240.00⚠️ +0.01000.000.00
ESP32S20⚠️ +2240.00⚠️ +0.01000.000.00
ESP32C3000.000.00000.000.00
ESP32C6000.000.00000.000.00
ESP32H2000.000.00000.000.00
ESP320⚠️ +2240.00⚠️ +0.01000.000.00
Click to expand the detailed deltas report [usage change in BYTES]
TargetESP32C5ESP32S3ESP32S2ESP32C3ESP32C6ESP32H2ESP32
ExampleFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAM
libraries/Matter/examples/MatterColorLight00⚠️ +2240⚠️ +2240000000⚠️ +2240
libraries/Matter/examples/MatterCommissionTest00⚠️ +2240⚠️ +2240000000⚠️ +2240
libraries/Matter/examples/MatterComposedLights00⚠️ +2240⚠️ +2240000000⚠️ +2240
libraries/Matter/examples/MatterContactSensor00⚠️ +2240⚠️ +2240000000⚠️ +2240
libraries/Matter/examples/MatterDimmableLight00⚠️ +2240⚠️ +2240000000⚠️ +2240
libraries/Matter/examples/MatterEnhancedColorLight00⚠️ +2240⚠️ +2240000000⚠️ +2240
libraries/Matter/examples/MatterEvents00⚠️ +2240⚠️ +2240000000⚠️ +2240
libraries/Matter/examples/MatterFan00⚠️ +2240⚠️ +2240000000⚠️ +2240
libraries/Matter/examples/MatterHumiditySensor00⚠️ +2240⚠️ +2240000000⚠️ +2240
libraries/Matter/examples/MatterLambdaSingleCallbackManyEPs00⚠️ +2240⚠️ +2240000000⚠️ +2240
libraries/Matter/examples/MatterMinimum00⚠️ +2240⚠️ +2240000000⚠️ +2240
libraries/Matter/examples/MatterOccupancySensor00⚠️ +2240⚠️ +2240000000⚠️ +2240
libraries/Matter/examples/MatterOnIdentify00⚠️ +2240⚠️ +2240000000⚠️ +2240
libraries/Matter/examples/MatterOnOffLight00⚠️ +2240⚠️ +2240000000⚠️ +2240
libraries/Matter/examples/MatterOnOffPlugin00⚠️ +2240⚠️ +2240000000⚠️ +2240
libraries/Matter/examples/MatterPressureSensor00⚠️ +2240⚠️ +2240000000⚠️ +2240
libraries/Matter/examples/MatterRainSensor--------------
libraries/Matter/examples/MatterSmartButton00⚠️ +2240⚠️ +2240000000⚠️ +2240
libraries/Matter/examples/MatterTemperatureLight00⚠️ +2240⚠️ +2240000000⚠️ +2240
libraries/Matter/examples/MatterTemperatureSensor00⚠️ +2240⚠️ +2240000000⚠️ +2240
libraries/Matter/examples/MatterThermostat00⚠️ +2240⚠️ +2240000000⚠️ +2240
libraries/Matter/examples/MatterWaterFreezeDetector--------------

@SuGlider SuGlider added the Status: Review needed Issue or PR is awaiting review label Dec 3, 2025
@SuGlider SuGlider moved this from In Progress to In Review in Arduino ESP32 Core Project Roadmap Dec 3, 2025
@me-no-dev me-no-dev requested a review from Copilot December 4, 2025 09:25
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 a new Matter endpoint for Water Freeze Detector devices, enabling ESP32-based smart home devices to detect and report water freeze conditions through the Matter protocol. The implementation follows the established patterns used by similar sensor endpoints like MatterContactSensor.

Key Changes:

  • New MatterWaterFreezeDetector endpoint class with boolean state management (detected/not detected)
  • Complete working example with WiFi/BLE commissioning, button control, LED indication, and automatic state simulation
  • Comprehensive documentation including API reference, usage examples, and integration guides

Reviewed changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated no comments.

Show a summary per file
File Description
libraries/Matter/src/MatterEndpoints/MatterWaterFreezeDetector.h Header file defining the MatterWaterFreezeDetector class with freeze state management API
libraries/Matter/src/MatterEndpoints/MatterWaterFreezeDetector.cpp Implementation of water freeze detector endpoint using BooleanState cluster
libraries/Matter/src/Matter.h Added include and friend class declaration for new endpoint
libraries/Matter/keywords.txt Added Arduino IDE syntax highlighting keywords for the new class and methods
libraries/Matter/examples/MatterWaterFreezeDetector/MatterWaterFreezeDetector.ino Complete working example demonstrating commissioning, manual control, and automatic simulation
libraries/Matter/examples/MatterWaterFreezeDetector/README.md Comprehensive documentation covering hardware requirements, setup, usage, and troubleshooting
libraries/Matter/examples/MatterWaterFreezeDetector/ci.yml CI configuration for testing the example
docs/en/matter/matter.rst Updated endpoint list to include water freeze detector
docs/en/matter/ep_water_freeze_detector.rst Complete API reference documentation with code examples
CMakeLists.txt Added new source file to build system

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

Copy link
Member

@pedrominatel pedrominatel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@P-R-O-C-H-Y P-R-O-C-H-Y added Status: Pending Merge Pull Request is ready to be merged and removed Status: Review needed Issue or PR is awaiting review labels Dec 4, 2025
@me-no-dev me-no-dev merged commit 471dcb0 into master Dec 4, 2025
80 checks passed
@me-no-dev me-no-dev deleted the feat/matter_water_freeze_detector_ep branch December 4, 2025 14:45
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

Projects

Development

Successfully merging this pull request may close these issues.

6 participants