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

Add minimum setpoint deadband to Climate entity #118186

Closed
wants to merge 10 commits into from
Closed

Conversation

gjohansson-ST
Copy link
Member

@gjohansson-ST gjohansson-ST commented May 26, 2024

Proposed change

Add minimum setpoint deadband according to arch discussion in home-assistant/architecture#996

Should rebase on top of #123941

  • Add dev docs PR
  • Frontend adjustment

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

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:

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

To help with the load of incoming pull requests:

@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 (climate) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of climate 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 climate 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.

This comment has been minimized.

Comment on lines 1015 to 1017
# Guard target_low_temp isn't lower than entity low_temp
if target_low_temp < min_temp:
raise ServiceValidationError(
Copy link
Member Author

Choose a reason for hiding this comment

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

Do we want to raise if this happens or should we modify the high temp instead to ensure we're within tolerance?
In theory neither low or high could fit but we could guard for that and raise in that case.

Copy link
Contributor

Choose a reason for hiding this comment

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

I think the behavior should be symmetric; if we try to "fix" the service call by adjusting the passed in low_temp, we should try to adjust the high_temp too.

If targetting multiple termostats is a valid use case, it might make sense to allow the user to pass in a narrow deadband, and then adjust it in the service call for thermostats which support it?

Is there a frontend design, or even better a draft PR, which takes the min_temp_range into account?

Copy link
Member Author

Choose a reason for hiding this comment

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

Made it symmetric now in the sense that it first moves the low_temp and second the high_temp if needed.

It does not check if the deadband makes the equation impossible e.g. in theory an endless loop to get inside min/max temp and still ensure the deadband. Is such check necessary and should raise?

Copy link
Member Author

Choose a reason for hiding this comment

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

If it's targeting multiple entities it would seem strange if the user is allowed to set a deadband as the integrations should be in control of that?

@gjohansson-ST gjohansson-ST marked this pull request as ready for review August 14, 2024 17:28
@gjohansson-ST gjohansson-ST requested a review from a team as a code owner August 14, 2024 17:28
Comment on lines +1003 to +1008
# Ensure target_low_temp is not higher than target_high_temp.
if target_low_temp > target_high_temp:
raise ServiceValidationError(
translation_domain=DOMAIN,
translation_key="low_temp_higher_than_high_temp",
)
Copy link
Contributor

@emontnemery emontnemery Aug 22, 2024

Choose a reason for hiding this comment

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

It's somewhat weird this is only checked if we have a min temperature range. Shouldn't this always be checked if we don't allow it? If base components don't check it, do integration check and handle it?

Edit: Based on a quick search for ATTR_TARGET_TEMP_LOW, it seems integrations do NOT check this.

Copy link
Member Author

Choose a reason for hiding this comment

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

Prel PR: #124488
Then we should move this out of this PR 👍

Comment on lines 1015 to 1017
# Guard target_low_temp isn't lower than entity low_temp
if target_low_temp < min_temp:
raise ServiceValidationError(
Copy link
Contributor

Choose a reason for hiding this comment

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

I think the behavior should be symmetric; if we try to "fix" the service call by adjusting the passed in low_temp, we should try to adjust the high_temp too.

If targetting multiple termostats is a valid use case, it might make sense to allow the user to pass in a narrow deadband, and then adjust it in the service call for thermostats which support it?

Is there a frontend design, or even better a draft PR, which takes the min_temp_range into account?

homeassistant/components/climate/__init__.py Outdated Show resolved Hide resolved
@gjohansson-ST

This comment was marked as resolved.

@gjohansson-ST gjohansson-ST marked this pull request as draft September 30, 2024 19:46
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 Nov 29, 2024
@github-actions github-actions bot closed this Dec 7, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Dec 8, 2024
@frenck frenck deleted the climate-deadband branch December 24, 2024 08:37
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.

2 participants