Skip to content
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

feat(matter): Adds a new Matter Endpoint: Generic Switch (smart button) #10662

Open
wants to merge 1 commit into
base: release/v3.1.x
Choose a base branch
from

Conversation

SuGlider
Copy link
Collaborator

Description of Change

Adds a new matter endpoint for a generic switch that works as a smart button.
This endpoint is supported by Amazon Alexa and Samsung SmartThings.
This is not cleatr if Google HA has implemented it on their Matter Controllers.

This endpoint can send a click() command to the Matter Controller.
It can be programmed to trigger 1 or more actions that will be stored in the Controller (example Alexa Echo Dot).

Tests scenarios

Tested with ESP32-S3, ESP32-C6 and ESP32 using the provided example.

Related links

Related to #7432

@SuGlider SuGlider added the Status: Review needed Issue or PR is awaiting review label Nov 29, 2024
@SuGlider SuGlider added this to the 3.1.0 milestone Nov 29, 2024
@SuGlider SuGlider self-assigned this Nov 29, 2024
Copy link
Contributor

github-actions bot commented Nov 29, 2024

Warnings
⚠️
	The **target branch** for this Pull Request **must be the default branch** of the project (`master`).

	If you would like to add this feature to a different branch, please state this in the PR description and we will consider it.

👋 Hello SuGlider, we appreciate your contribution to 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 dca8a90

@SuGlider
Copy link
Collaborator Author

@me-no-dev - This is the Matter Switch (a smart button) endpoint.
It can control any thing on the matter environment.

This will send a command message to the Matter Controller (Alexa, Google, iOS mini pods etc).
The user shall use the phone APP to associate the Click Event to the necessary Action (toggle a light, increase/decrease a dimmer, activate a scene, etc).

This is the only sort of Swtich Matter Endpoint supported by the main Matter Controller manufacturers.

Copy link
Contributor

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
ESP32S3000.000.00000.000.00
ESP32S2000.000.00000.000.00
ESP32C3000.000.00000.000.00
ESP32C6000.000.00000.000.00
ESP32000.000.00000.000.00
Click to expand the detailed deltas report [usage change in BYTES]
TargetESP32S3ESP32S2ESP32C3ESP32C6ESP32
ExampleFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAM
Matter/examples/MatterCommissionTest----------
Matter/examples/MatterComposedLights----------
Matter/examples/MatterDimmableLight----------
Matter/examples/MatterMinimum----------
Matter/examples/MatterOnOffLight----------
Matter/examples/MatterSmartButon----------
Matter/examples/Matter_CW_WW_Light----------
Matter/examples/Matter_ColorLight----------

Copy link
Contributor

Test Results

 61 files   61 suites   5m 46s ⏱️
 21 tests  21 ✅ 0 💤 0 ❌
143 runs  143 ✅ 0 💤 0 ❌

Results for commit dca8a90.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Review needed Issue or PR is awaiting review
Projects
Status: In Review
Development

Successfully merging this pull request may close these issues.

1 participant