Skip to content

feat(matter): adds window covering matter endpoint #12114

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.

Sign up for GitHub

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

Jump to bottom
Merged
me-no-dev merged 28 commits into from
Dec 10, 2025
Merged

feat(matter): adds window covering matter endpoint #12114

me-no-dev merged 28 commits into from
Dec 10, 2025

Conversation

@SuGlider
Copy link
Collaborator

@SuGlider SuGlider commented Dec 7, 2025 •
edited
Loading

Description of Change

Add a new Matter endpoint for window covering, including example and documentation.

Test Scenarios

Using Alexa and the ESP32-S3 with the provided example.
CI

Related links

Closes #11943
Closes #10789

@SuGlider SuGlider added this to the 3.3.0 milestone Dec 7, 2025
@SuGlider SuGlider self-assigned this Dec 7, 2025
@SuGlider SuGlider added the Area: Matter Issues and Feature Request about Matter Protocol label Dec 7, 2025
@SuGlider SuGlider moved this from Todo to In Progress in Arduino ESP32 Core Project Roadmap Dec 7, 2025
@SuGlider SuGlider requested a review from P-R-O-C-H-Y December 7, 2025 02:26
@github-actions
Copy link
Contributor

github-actions bot commented Dec 7, 2025 •
edited
Loading

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "feat(matter_docs): Enhance README with callback usage details":
    • body's lines must not be longer than 100 characters
  • the commit message "fix(matter_docs): CI Vale check":
    • body's lines must not be longer than 100 characters

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: 2516), 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 52b04af

@github-actions
Copy link
Contributor

github-actions bot commented Dec 7, 2025 •
edited
Loading

Test Results

 83 files   83 suites   44m 4s ⏱️
 61 tests  52 ✅ 0 💤  9 ❌
523 runs  511 ✅ 0 💤 12 ❌

For more details on these failures, see this check.

Results for commit 52b04af.

♻️ This comment has been updated with latest results.

@SuGlider SuGlider marked this pull request as draft December 7, 2025 03:43
@github-actions
Copy link
Contributor

github-actions bot commented Dec 7, 2025 •
edited
Loading

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⚠️ +9520.00⚠️ +0.05000.000.00
ESP32S20⚠️ +9520.00⚠️ +0.06000.000.00
ESP32C3000.000.00000.000.00
ESP32C6000.000.00000.000.00
ESP32H2000.000.00000.000.00
ESP320⚠️ +9520.00⚠️ +0.06000.000.00
Click to expand the detailed deltas report [usage change in BYTES]
TargetESP32C5ESP32S3ESP32S2ESP32C3ESP32C6ESP32H2ESP32
ExampleFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAM
libraries/Matter/examples/MatterColorLight00⚠️ +9520⚠️ +9520000000⚠️ +9520
libraries/Matter/examples/MatterCommissionTest00⚠️ +9520⚠️ +9520000000⚠️ +9520
libraries/Matter/examples/MatterComposedLights00⚠️ +9520⚠️ +9520000000⚠️ +9520
libraries/Matter/examples/MatterContactSensor00⚠️ +9520⚠️ +9520000000⚠️ +9520
libraries/Matter/examples/MatterDimmableLight00⚠️ +9520⚠️ +9520000000⚠️ +9520
libraries/Matter/examples/MatterDimmablePlugin00⚠️ +9520⚠️ +9520000000⚠️ +9520
libraries/Matter/examples/MatterEnhancedColorLight00⚠️ +9520⚠️ +9520000000⚠️ +9520
libraries/Matter/examples/MatterEvents00⚠️ +9520⚠️ +9520000000⚠️ +9520
libraries/Matter/examples/MatterFan00⚠️ +9520⚠️ +9520000000⚠️ +9520
libraries/Matter/examples/MatterHumiditySensor00⚠️ +9520⚠️ +9520000000⚠️ +9520
libraries/Matter/examples/MatterLambdaSingleCallbackManyEPs00⚠️ +9520⚠️ +9520000000⚠️ +9520
libraries/Matter/examples/MatterMinimum00⚠️ +9520⚠️ +9520000000⚠️ +9520
libraries/Matter/examples/MatterOccupancySensor00⚠️ +9520⚠️ +9520000000⚠️ +9520
libraries/Matter/examples/MatterOnIdentify00⚠️ +9520⚠️ +9520000000⚠️ +9520
libraries/Matter/examples/MatterOnOffLight00⚠️ +9520⚠️ +9520000000⚠️ +9520
libraries/Matter/examples/MatterOnOffPlugin00⚠️ +9520⚠️ +9520000000⚠️ +9520
libraries/Matter/examples/MatterPressureSensor00⚠️ +9520⚠️ +9520000000⚠️ +9520
libraries/Matter/examples/MatterRainSensor00⚠️ +9520⚠️ +9520000000⚠️ +9520
libraries/Matter/examples/MatterSimpleWidowsBlind--------------
libraries/Matter/examples/MatterSmartButton00⚠️ +9520⚠️ +9520000000⚠️ +9520
libraries/Matter/examples/MatterTemperatureControlledCabinet00⚠️ +9520⚠️ +9520000000⚠️ +9520
libraries/Matter/examples/MatterTemperatureControlledCabinetLevels00⚠️ +9520⚠️ +9520000000⚠️ +9520
libraries/Matter/examples/MatterTemperatureLight00⚠️ +9520⚠️ +9520000000⚠️ +9520
libraries/Matter/examples/MatterTemperatureSensor00⚠️ +9520⚠️ +9520000000⚠️ +9520
libraries/Matter/examples/MatterThermostat00⚠️ +9520⚠️ +9520000000⚠️ +9520
libraries/Matter/examples/MatterWaterFreezeDetector00⚠️ +9520⚠️ +9520000000⚠️ +9520
libraries/Matter/examples/MatterWaterLeakDetector00⚠️ +9520⚠️ +9520000000⚠️ +9520
libraries/Matter/examples/MatterWindowCovering--------------

@SuGlider SuGlider marked this pull request as ready for review December 7, 2025 04:05
@SuGlider SuGlider moved this from In Progress to In Review in Arduino ESP32 Core Project Roadmap Dec 7, 2025
@SuGlider SuGlider added the Status: Review needed Issue or PR is awaiting review label Dec 7, 2025
@lucasssvaz lucasssvaz requested a review from Copilot December 7, 2025 15:24
Copilot AI reviewed Dec 7, 2025
View reviewed changes
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 pull request adds comprehensive Matter support for window covering devices to the Arduino ESP32 library. The implementation includes lift and tilt control capabilities for motorized blinds, shades, and other window coverings, with full integration into Matter-compatible smart home ecosystems.

Key Changes:

  • New MatterWindowCovering endpoint class with lift and tilt position control (0-100% range)
  • Support for 10 different window covering types (roller shades, blinds, shutters, drapery, awnings, projector screens)
  • Complete example implementation with state persistence, button control, and LED visualization
  • Comprehensive API documentation with detailed usage examples

Reviewed changes

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

Show a summary per file
File Description
libraries/Matter/src/MatterEndpoints/MatterWindowCovering.h Header file defining the MatterWindowCovering class with lift/tilt control, operational status management, and callback interfaces
libraries/Matter/src/MatterEndpoints/MatterWindowCovering.cpp Implementation of window covering endpoint with position control, limit management, and Matter attribute handling (857 lines)
libraries/Matter/examples/MatterWindowCovering/MatterWindowCovering.ino Complete example demonstrating window covering control with state persistence, button input, and RGB LED visualization
libraries/Matter/examples/MatterWindowCovering/README.md Comprehensive documentation covering hardware requirements, setup instructions, and smart home integration guides
libraries/Matter/examples/MatterWindowCovering/ci.yml CI configuration specifying build requirements and partition scheme
docs/en/matter/ep_window_covering.rst Detailed API reference documentation with method descriptions and code examples (561 lines)
docs/en/matter/matter.rst Updated to include MatterWindowCovering in the list of available endpoints
libraries/Matter/src/Matter.h Added MatterWindowCovering header include and friend class declaration
libraries/Matter/keywords.txt Added keywords for syntax highlighting in Arduino IDE (window covering types, callbacks, and methods)
CMakeLists.txt Updated build configuration to include MatterWindowCovering.cpp source file

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

SuGlider and others added 5 commits December 8, 2025 08:21
@SuGlider
fix(matter): code formatting
62ef505 
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@SuGlider
fix(matter): better commentary
77d3fda 
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@SuGlider
fix(matter): better variable name
db0062a 
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@SuGlider
fix(matter): better commentary
b83cff7 
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@SuGlider
fix(matter): fix commentary
a6054c4 
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@SuGlider SuGlider mentioned this pull request Dec 8, 2025
Closed
1 task
@github-actions
Copy link
Contributor

github-actions bot commented Dec 9, 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 reviewed Dec 9, 2025
View reviewed changes
lucasssvaz
lucasssvaz reviewed Dec 9, 2025
View reviewed changes
@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 Dec 9, 2025
SuGlider and others added 2 commits December 9, 2025 15:09
@SuGlider
feat(matter): adds a simple Window Blind example
9168784 
This example is the simplest possible in order to demonstrate how to control a Window blind.
@pre-commit-ci-lite
ci(pre-commit): Apply automatic fixes
7304cea
@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 Dec 9, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Dec 9, 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 Dec 9, 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 Dec 9, 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.

SuGlider and others added 2 commits December 9, 2025 15:34
@SuGlider
feat(matter_docs): improves event handling documentation for MatterWi…
ed47deb 
…ndowCovering

Updated callback descriptions and clarified command triggers for window covering events.
@pre-commit-ci-lite
ci(pre-commit): Apply automatic fixes
af00cc7
@github-actions
Copy link
Contributor

github-actions bot commented Dec 9, 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.

SuGlider and others added 2 commits December 9, 2025 15:36
@SuGlider
feat(matter_docs): Enhance README with callback usage details
3c587c0 
Clarify the importance of calling setLiftPercentage() and setTiltPercentage() in callbacks to update CurrentPosition attributes. Expand on callback flow and provide details on target position callbacks.
@pre-commit-ci-lite
ci(pre-commit): Apply automatic fixes
562c25d
@github-actions
Copy link
Contributor

github-actions bot commented Dec 9, 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 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 Dec 9, 2025
@SuGlider
Copy link
Collaborator Author

SuGlider commented Dec 9, 2025

@me-no-dev - all set now. Waiting for your final review.

@me-no-dev me-no-dev merged commit 9c582dd into master Dec 10, 2025
77 of 80 checks passed
@me-no-dev me-no-dev deleted the feat/matter_window_covering_ep branch December 10, 2025 12:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@lucasssvaz lucasssvaz lucasssvaz approved these changes

Copilot code review Copilot Copilot left review comments

@pedrominatel pedrominatel pedrominatel approved these changes

@me-no-dev me-no-dev me-no-dev approved these changes

@P-R-O-C-H-Y P-R-O-C-H-Y P-R-O-C-H-Y approved these changes

Assignees

@SuGlider SuGlider

Labels

Area: Matter Issues and Feature Request about Matter Protocol Status: Pending Merge Pull Request is ready to be merged

Projects

Arduino ESP32 Core Project Roadmap
Status: Done

Milestone

3.3.0

Development

Successfully merging this pull request may close these issues.

Matter add Window Covering cluster/endpoint [Matter] add Support for window_covering Device Class

6 participants

@SuGlider @pedrominatel @me-no-dev @lucasssvaz @P-R-O-C-H-Y