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

Rework mqtt climate platform to simplify implementation water_heater platform #93751

Merged
merged 4 commits into from May 31, 2023

Conversation

jbouwh
Copy link
Contributor

@jbouwh jbouwh commented May 29, 2023

Proposed change

PR #93644 implements the water_heater platform. This platform has a lot in common with the climate platform.

This PR isolates the code that can be shared to set up both entity types.
The new MqttTemperatureControlEntity class implements MqttEntity and implements the shared code to subscribe to topics, handle incoming messages, and control target temperature.
The MqttClimate base class inherrits MqttTemperatureControlEntity.

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 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:

@home-assistant
Copy link

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

Code owner commands

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

@jbouwh jbouwh marked this pull request as ready for review May 30, 2023 07:07
@jbouwh jbouwh requested a review from emontnemery as a code owner May 30, 2023 07:07
@jbouwh
Copy link
Contributor Author

jbouwh commented May 30, 2023

@hookedonunix I also have splitted the climate specific parts from the common parts. Initially I added them together, but I guess it starts getting messy if the water_heater parts should be added here to. Now this can stay in your PR. You could leave out the shared parts and keep the specific parts in water_heater.py.

Copy link
Contributor

@emontnemery emontnemery left a comment

Choose a reason for hiding this comment

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

LGTM, thanks @jbouwh 👍

@jbouwh jbouwh merged commit fa4d9b2 into home-assistant:dev May 31, 2023
52 checks passed
@jbouwh jbouwh deleted the mqtt-refactor-climate branch May 31, 2023 09:13
@hookedonunix
Copy link
Contributor

Looks great, thank you!

@github-actions github-actions bot locked and limited conversation to collaborators Jun 2, 2023
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.

None yet

3 participants