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

Support for Matter 1.4 Water Heater #131505

Open
wants to merge 70 commits into
base: dev
Choose a base branch
from
Open

Conversation

lboue
Copy link
Contributor

@lboue lboue commented Nov 25, 2024

Proposed change

Adding support for Matter 1.4 Water Heater :

Clusters

ID (Decimal) ID (hex) Name
144 0x0090 Electrical Power Measurement
145 0x0091 Electrical Energy Measurement
148 0x0094 Water Heater Management
152 0x0098 Device Energy Management
156 0x009C Power Topology
158 0x009E Water Heater Mode
159 0x009F Device Energy Management Mode
513 0x0201 Thermostat

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Deprecation (breaking change to happen in the future)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

Testing

WaterHeaterManagement Cluster on Endpoint 2

WaterHeaterMode Cluster on Endpoint 2

  • 3 modes: [{"0":"Off","1":0,"2":[{"1":16384}]},{"0":"Manual","1":1,"2":[{"1":16385}]},{"0":"Timed","1":2,"2":[{"1":16386}]}]

  • This PR fixes or closes issue: fixes #

  • This PR is related to issue:

  • Link to documentation pull request:

image

image

Checklist

  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • I have followed the perfect PR recommendations
  • The code has been formatted using Ruff (ruff format homeassistant tests)
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.

To help with the load of incoming pull requests:

@home-assistant
Copy link

Hey there @home-assistant/matter, mind taking a look at this pull request as it has been labeled with an integration (matter) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of matter can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign matter Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

Copy link
Member

@joostlek joostlek left a comment

Choose a reason for hiding this comment

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

Why don't we implement the water_heater platform?

@lboue
Copy link
Contributor Author

lboue commented Dec 10, 2024

Why don't we implement the water_heater platform?

I have not found the following parameters in this entity: Water heater entity

  • TankVolume
  • TankPercentage
  • EstimatedHeatRequired
  • BoostState

@joostlek
Copy link
Member

That would be sensors, but I think the main control like modes and stuff should be a water_heater rather than a climate and select

@lboue
Copy link
Contributor Author

lboue commented Dec 10, 2024

That would be sensors, but I think the main control like modes and stuff should be a water_heater rather than a climate and select

OK but this is a special case, because even if we use Platform.WATER_HEATER, we still have to read the Thermostat cluster, which is usually used by Platform.CLIMATE.

@lboue lboue marked this pull request as ready for review January 31, 2025 17:02
@lboue lboue requested a review from a team as a code owner January 31, 2025 17:02
@lboue
Copy link
Contributor Author

lboue commented Jan 31, 2025

I've now used the water_heater entity and associated it with the EP2 Thermostat cluster.
Request an initial review to assess the improvements to be made.

@lboue
Copy link
Contributor Author

lboue commented Feb 1, 2025

What would be the best way to select the boost duration ? We'd need to be able to read this value when boost mode is activated?
I think we need to add a selector entity or add a selector in the graphical interface of the water heater entity.

image

"name": "Tank percentage"
},
"estimated_heat_required": {
"name": "Heat energy needed"
Copy link
Contributor

Choose a reason for hiding this comment

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

Correct me if I'm wrong:
If that is the estimated energy needed to heat the water that should be "Required heating energy"

"heat energy" sounds more like the energy contained in hot water.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I agree with you. I will fix it.

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

Successfully merging this pull request may close these issues.

5 participants