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): New Matter Fan endpoint #10687

Closed
wants to merge 22 commits into from

Conversation

SuGlider
Copy link
Collaborator

@SuGlider SuGlider commented Dec 6, 2024

Description of Change

Adds Fan as an endpoint. Matter Fan can control On/Off state and its velocity.
It also has a configurable set of Modes.

Tests scenarios

ESP32S3 using the provided example.

Related links

Related to #7432

@SuGlider SuGlider added this to the 3.1.0 milestone Dec 6, 2024
@SuGlider SuGlider self-assigned this Dec 6, 2024
Copy link
Contributor

github-actions bot commented Dec 6, 2024

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "Update libraries/Matter/src/MatterEndpoints/MatterColorLight.h ":
    • summary looks empty
    • type/action looks empty
  • the commit message "Update libraries/Matter/src/MatterEndpoints/MatterFan.h":
    • summary looks empty
    • type/action looks empty

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 20 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).

⚠️ Please consider squashing your 22 commits (simplifying branch history).
⚠️
	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 7b3fe09

Copy link
Contributor

github-actions bot commented Dec 6, 2024

Test Results

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

Results for commit 7b3fe09.

♻️ This comment has been updated with latest results.

Copy link
Contributor

github-actions bot commented Dec 6, 2024

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/MatterColorLight----------
Matter/examples/MatterCommissionTest----------
Matter/examples/MatterComposedLights----------
Matter/examples/MatterDimmableLight----------
Matter/examples/MatterEnhancedColorLight----------
Matter/examples/MatterFan----------
Matter/examples/MatterMinimum----------
Matter/examples/MatterOnOffLight----------
Matter/examples/MatterSmartButon----------
Matter/examples/Matter_CW_WW_Light----------
Matter/examples/WiFiProvWithinMatter----------

fix(matter): reveting non related endpoint code change
protected:
bool started = false;
bool onOffState = false; // default initial state is off, but it can be changed by begin(bool)
espHsvColor_t colorHSV = {0}; // default initial color HSV is black, but it can be changed by begin(bool, espHsvColor_t)```
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
espHsvColor_t colorHSV = {0}; // default initial color HSV is black, but it can be changed by begin(bool, espHsvColor_t)```
espHsvColor_t colorHSV = {0}; // default initial color HSV is black, but it can be changed by begin(bool, espHsvColor_t)

MatterColorLight();
~MatterColorLight();
// default initial state is off, color is red 12% intensity HSV(0, 254, 31)
virtual bool begin(bool initialState = false, espHsvColor_t colorHSV = { 0, 254, 31});
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
virtual bool begin(bool initialState = false, espHsvColor_t colorHSV = { 0, 254, 31});
virtual bool begin(bool initialState = false, espHsvColor_t colorHSV = {0, 254, 31});

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging this pull request may close these issues.

2 participants