feat(matter): adds water leak detector ep by SuGlider · Pull Request #12102 · espressif/arduino-esp32

SuGlider · 2025-12-03T20:16:58Z

Description of Change

Adds a new Matter Endpoint: Water Leak Detector, with related example, readme and documentation.

Test Scenarios

ESP32-S3 with the provided example. CI and execution Logs.

Related links

None

github-actions · 2025-12-03T20:17:37Z

	Warnings
⚠️	Some issues found for the commit messages in this PR: the commit message `"fix(matter): spelling"`: 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 1272d1c

github-actions · 2025-12-03T20:29:18Z

Test Results

83 files 83 suites 25m 11s ⏱️
55 tests 55 ✅ 0 💤 0 ❌
598 runs 598 ✅ 0 💤 0 ❌

Results for commit 1272d1c.

♻️ This comment has been updated with latest results.

github-actions · 2025-12-03T20:36:56Z

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.

Memory	FLASH [bytes]		FLASH [%]		RAM [bytes]		RAM [%]
Target	DEC	INC	DEC	INC	DEC	INC	DEC	INC
ESP32C5	0	0	0.00	0.00	0	0	0.00	0.00
ESP32S3	0	⚠️ +336	0.00	⚠️ +0.02	0	0	0.00	0.00
ESP32S2	0	⚠️ +336	0.00	⚠️ +0.02	0	0	0.00	0.00
ESP32C3	0	0	0.00	0.00	0	0	0.00	0.00
ESP32C6	0	0	0.00	0.00	0	0	0.00	0.00
ESP32H2	0	0	0.00	0.00	0	0	0.00	0.00
ESP32	0	⚠️ +336	0.00	⚠️ +0.02	0	0	0.00	0.00

Click to expand the detailed deltas report [usage change in BYTES]

Target	ESP32C5		ESP32S3		ESP32S2		ESP32C3		ESP32C6		ESP32H2		ESP32
Example	FLASH	RAM	FLASH	RAM	FLASH	RAM	FLASH	RAM	FLASH	RAM	FLASH	RAM	FLASH	RAM
libraries/Matter/examples/MatterColorLight	0	0	⚠️ +336	0	⚠️ +336	0	0	0	0	0	0	0	⚠️ +336	0
libraries/Matter/examples/MatterCommissionTest	0	0	⚠️ +336	0	⚠️ +336	0	0	0	0	0	0	0	⚠️ +336	0
libraries/Matter/examples/MatterComposedLights	0	0	⚠️ +336	0	⚠️ +336	0	0	0	0	0	0	0	⚠️ +336	0
libraries/Matter/examples/MatterContactSensor	0	0	⚠️ +336	0	⚠️ +336	0	0	0	0	0	0	0	⚠️ +336	0
libraries/Matter/examples/MatterDimmableLight	0	0	⚠️ +336	0	⚠️ +336	0	0	0	0	0	0	0	⚠️ +336	0
libraries/Matter/examples/MatterEnhancedColorLight	0	0	⚠️ +336	0	⚠️ +336	0	0	0	0	0	0	0	⚠️ +336	0
libraries/Matter/examples/MatterEvents	0	0	⚠️ +336	0	⚠️ +336	0	0	0	0	0	0	0	⚠️ +336	0
libraries/Matter/examples/MatterFan	0	0	⚠️ +336	0	⚠️ +336	0	0	0	0	0	0	0	⚠️ +336	0
libraries/Matter/examples/MatterHumiditySensor	0	0	⚠️ +336	0	⚠️ +336	0	0	0	0	0	0	0	⚠️ +336	0
libraries/Matter/examples/MatterLambdaSingleCallbackManyEPs	0	0	⚠️ +336	0	⚠️ +336	0	0	0	0	0	0	0	⚠️ +336	0
libraries/Matter/examples/MatterMinimum	0	0	⚠️ +336	0	⚠️ +336	0	0	0	0	0	0	0	⚠️ +336	0
libraries/Matter/examples/MatterOccupancySensor	0	0	⚠️ +336	0	⚠️ +336	0	0	0	0	0	0	0	⚠️ +336	0
libraries/Matter/examples/MatterOnIdentify	0	0	⚠️ +336	0	⚠️ +336	0	0	0	0	0	0	0	⚠️ +336	0
libraries/Matter/examples/MatterOnOffLight	0	0	⚠️ +336	0	⚠️ +336	0	0	0	0	0	0	0	⚠️ +336	0
libraries/Matter/examples/MatterOnOffPlugin	0	0	⚠️ +336	0	⚠️ +336	0	0	0	0	0	0	0	⚠️ +336	0
libraries/Matter/examples/MatterPressureSensor	0	0	⚠️ +336	0	⚠️ +336	0	0	0	0	0	0	0	⚠️ +336	0
libraries/Matter/examples/MatterRainSensor	-	-	-	-	-	-	-	-	-	-	-	-	-	-
libraries/Matter/examples/MatterSmartButton	0	0	⚠️ +336	0	⚠️ +336	0	0	0	0	0	0	0	⚠️ +336	0
libraries/Matter/examples/MatterTemperatureLight	0	0	⚠️ +336	0	⚠️ +336	0	0	0	0	0	0	0	⚠️ +336	0
libraries/Matter/examples/MatterTemperatureSensor	0	0	⚠️ +336	0	⚠️ +336	0	0	0	0	0	0	0	⚠️ +336	0
libraries/Matter/examples/MatterThermostat	0	0	⚠️ +336	0	⚠️ +336	0	0	0	0	0	0	0	⚠️ +336	0
libraries/Matter/examples/MatterWaterFreezeDetector	-	-	-	-	-	-	-	-	-	-	-	-	-	-
libraries/Matter/examples/MatterWaterLeakDetector	-	-	-	-	-	-	-	-	-	-	-	-	-	-

Copilot

Pull request overview

This PR adds a new Matter endpoint for Water Leak Detector devices to the ESP32 Arduino Matter library. The implementation follows the established patterns used for similar sensor endpoints like ContactSensor, providing a boolean state sensor that can report water leak detection status (detected/not detected).

Key Changes:

New MatterWaterLeakDetector endpoint class with get/set methods and operator overloads
Complete example sketch demonstrating commissioning, button control, LED indication, and simulated sensor behavior
Comprehensive documentation including API reference and user guide

Reviewed changes

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

Show a summary per file

File	Description
`libraries/Matter/src/MatterEndpoints/MatterWaterLeakDetector.h`	Header file defining the MatterWaterLeakDetector class with boolean state interface
`libraries/Matter/src/MatterEndpoints/MatterWaterLeakDetector.cpp`	Implementation of water leak detector endpoint using BooleanState cluster
`libraries/Matter/src/Matter.h`	Added include and friend declaration for MatterWaterLeakDetector
`libraries/Matter/keywords.txt`	Added syntax highlighting keywords for the new class and methods
`libraries/Matter/examples/MatterWaterLeakDetector/MatterWaterLeakDetector.ino`	Example sketch demonstrating water leak detector with button control and simulation
`libraries/Matter/examples/MatterWaterLeakDetector/README.md`	Comprehensive user guide covering setup, usage, and troubleshooting
`libraries/Matter/examples/MatterWaterLeakDetector/ci.yml`	CI configuration for the example
`docs/en/matter/matter.rst`	Updated sensor endpoints list to include MatterWaterLeakDetector
`docs/en/matter/ep_water_leak_detector.rst`	Complete API reference documentation for the endpoint
`CMakeLists.txt`	Added MatterWaterLeakDetector.cpp to build configuration

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

libraries/Matter/examples/MatterWaterLeakDetector/MatterWaterLeakDetector.ino

pedrominatel

LGTM

lucasssvaz

LGTM. Please fix the spelling issues reported by copilot

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

libraries/Matter/examples/MatterWaterLeakDetector/MatterWaterLeakDetector.ino

SuGlider added 2 commits December 3, 2025 17:12

feat(matter): adds water leak detector matter endpoint

6ed86b2

feat(matter): fix matter.h conflicts

f999df9

SuGlider added this to the 3.3.0 milestone Dec 3, 2025

SuGlider self-assigned this Dec 3, 2025

SuGlider requested review from lucasssvaz and me-no-dev as code owners December 3, 2025 20:16

SuGlider added the Area: Matter Issues and Feature Request about Matter Protocol label Dec 3, 2025

SuGlider requested a review from pedrominatel as a code owner December 3, 2025 20:16

SuGlider added this to Arduino ESP32 Core Project Roadmap Dec 3, 2025

github-project-automation bot moved this to Todo in Arduino ESP32 Core Project Roadmap Dec 3, 2025

SuGlider requested a review from P-R-O-C-H-Y December 3, 2025 20:17

SuGlider moved this from Todo to In Progress in Arduino ESP32 Core Project Roadmap Dec 3, 2025

SuGlider added the Status: Review needed Issue or PR is awaiting review label Dec 3, 2025

SuGlider moved this from In Progress to In Review in Arduino ESP32 Core Project Roadmap Dec 3, 2025

me-no-dev requested a review from Copilot December 4, 2025 09:25

Copilot started reviewing on behalf of me-no-dev December 4, 2025 09:27 View session

Copilot finished reviewing on behalf of me-no-dev December 4, 2025 09:30

me-no-dev approved these changes Dec 4, 2025

View reviewed changes

Copilot AI reviewed Dec 4, 2025

View reviewed changes

libraries/Matter/examples/MatterWaterLeakDetector/MatterWaterLeakDetector.ino Outdated Show resolved Hide resolved

libraries/Matter/examples/MatterWaterLeakDetector/MatterWaterLeakDetector.ino Outdated Show resolved Hide resolved

pedrominatel approved these changes Dec 4, 2025

View reviewed changes

P-R-O-C-H-Y changed the title ~~Feat/matter water leak detector ep~~ feat(matter): Add water leak detector ep Dec 4, 2025

P-R-O-C-H-Y changed the title ~~feat(matter): Add water leak detector ep~~ feat(matter): adds water leak detector ep Dec 4, 2025

P-R-O-C-H-Y approved these changes Dec 4, 2025

View reviewed changes

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

ci(pre-commit): Apply automatic fixes

90f9cb4

lucasssvaz approved these changes Dec 4, 2025

View reviewed changes

me-no-dev and others added 3 commits December 4, 2025 16:46

Merge branch 'master' into feat/matter_water_leak_detector_ep

80b5f25

fix(matter): spelling

ec4a5e1

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

fix(matter): formatting

99aec0a

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

SuGlider commented Dec 4, 2025

View reviewed changes

libraries/Matter/examples/MatterWaterLeakDetector/MatterWaterLeakDetector.ino Outdated Show resolved Hide resolved

fix(matter): fix var name - spelling

1272d1c

me-no-dev merged commit 9b3364c into master Dec 4, 2025
80 checks passed

github-project-automation bot moved this from In Review to Done in Arduino ESP32 Core Project Roadmap Dec 4, 2025

me-no-dev deleted the feat/matter_water_leak_detector_ep branch December 4, 2025 23:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(matter): adds water leak detector ep#12102

feat(matter): adds water leak detector ep#12102
me-no-dev merged 7 commits intomasterfrom
feat/matter_water_leak_detector_ep

SuGlider commented Dec 3, 2025

Uh oh!

github-actions bot commented Dec 3, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Dec 3, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Dec 3, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

pedrominatel left a comment

Uh oh!

lucasssvaz left a comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

SuGlider commented Dec 3, 2025

Description of Change

Test Scenarios

Related links

Uh oh!

github-actions bot commented Dec 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Dec 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Test Results

Uh oh!

github-actions bot commented Dec 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Memory usage test (comparing PR against master branch)

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

pedrominatel left a comment

Choose a reason for hiding this comment

Uh oh!

lucasssvaz left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

github-actions bot commented Dec 3, 2025 •

edited

Loading

github-actions bot commented Dec 3, 2025 •

edited

Loading

github-actions bot commented Dec 3, 2025 •

edited

Loading