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 TARGET_TEMPERATURE_RANGE for water heater entities #102960

Conversation

kamaradclimber
Copy link

@kamaradclimber kamaradclimber commented Oct 28, 2023

Breaking change

Expected changes:

  • integration exposing water heater entities should be aware that set_temperature might not contain temperature field anymore but can contain target_temp_high and target_temp_low instead.

State of water_heater entities will not contain target_temp_high and target_temp_low unless those features are explicitly supported.

Proposed change

This patch allows to set temperature_target_{high, low} with water_heater.set_temperature service.

Those values were already present before this patch but could not be set with a service.
This patch changes the default WaterHeaterEntityFeature to include TARGET_TEMPERATURE to be fully backward compatible.

This is heavily inspired by the same behavior on ClimateEntity.

This patch opens the way for the UI to expose/update high/low temperature targets.

See home-assistant/architecture#995

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

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 Black (black --fast 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.
  • Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

This patch allows to set temperature_target_{high, low} with
`water_heater.set_temperature` service.

Those values were already present before this patch but could not be set
with a service.
This patch changes the default WaterHeaterEntityFeature to include
TARGET_TEMPERATURE to be fully backward compatible.

This is heavily inspired by the same behavior on ClimateEntity.

This patch opens the way for the UI to expose/update high/low temperature targets.
@home-assistant
Copy link

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

Code owner commands

Code owners of water_heater 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 water_heater Removes the current integration label and assignees on the pull request, add the integration domain after the command.

Copy link
Member

@gjohansson-ST gjohansson-ST left a comment

Choose a reason for hiding this comment

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

This requires a architectural discussion to take place before such feature is added.
Please open a discussion here and once that is approved this PR can be reopened.

@home-assistant
Copy link

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

@kamaradclimber
Copy link
Author

kamaradclimber commented Nov 16, 2023

@gjohansson-ST , I've opened home-assistant/architecture#995 but don't get feedback for now. Could you guide me further if there a need to do something else to have the discussion started?

Copy link

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days.
If you are the author of this PR, please leave a comment if you want to keep it open. Also, please rebase your PR onto the latest dev branch to ensure that it's up to date with the latest changes.
Thank you for your contribution!

@github-actions github-actions bot added the stale label Jan 15, 2024
@kamaradclimber
Copy link
Author

I'd be glad to keep this open and get some feedback :)

@gjohansson-ST
Copy link
Member

No need to keep open until the architectural discussion has been decided upon.
There won't be any feedback here until then.

@github-actions github-actions bot removed the stale label Jan 15, 2024
@kamaradclimber
Copy link
Author

Thanks for your comment, do you know how I can get feedback on the architectural discussion?

@kukulich
Copy link
Contributor

The interesting thing is that the entity already have high and low temperature attributes: https://developers.home-assistant.io/docs/core/entity/water-heater/

@kamaradclimber
Copy link
Author

Yes, those values were already present before this patch but could not be set with a service.

Copy link

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days.
If you are the author of this PR, please leave a comment if you want to keep it open. Also, please rebase your PR onto the latest dev branch to ensure that it's up to date with the latest changes.
Thank you for your contribution!

@github-actions github-actions bot added the stale label Mar 16, 2024
@kamaradclimber
Copy link
Author

PR is still relevant. I'll keep it open until there is a consensus on the related architecture discussion.

@github-actions github-actions bot removed the stale label Mar 17, 2024
Copy link

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days.
If you are the author of this PR, please leave a comment if you want to keep it open. Also, please rebase your PR onto the latest dev branch to ensure that it's up to date with the latest changes.
Thank you for your contribution!

@github-actions github-actions bot added the stale label May 16, 2024
@github-actions github-actions bot closed this May 23, 2024
@github-actions github-actions bot locked and limited conversation to collaborators May 25, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants