Add Generic Water Heater #44605

dgomes · 2020-12-29T01:50:16Z

Proposed change

Adds a generic water heater. This is mostly a dumb water reservoir with a resistance in it which can be controlled with a switch entity. Inside the reservoir there is a temperature sensor. You can control the target temperature and turn off the heater in advance, avoiding overshoot.

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)
Breaking change (fix/feature causing existing functionality to break)
Code quality improvements to existing code or addition of tests

Example entry for `configuration.yaml`:

# Example configuration.yaml
generic_water_heater:
   bath water:
     heater_switch: switch.dhw_switch
     temperature_sensor: sensor.dhw_temperature
     target_temperature: 50
     delta_temperature: 5

Additional information

This PR fixes or closes issue: fixes #
This PR is related to issue:
Link to documentation pull request: Add Generic Water Heater home-assistant.io#16046

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

Documentation added/updated for www.home-assistant.io

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

The integration reached or maintains the following Integration Quality Scale:

No score or internal
🥈 Silver
🥇 Gold
🏆 Platinum

To help with the load of incoming pull requests:

I have reviewed two other open pull requests in this repository.

davet2001 · 2020-12-29T08:24:01Z

I don't agree with this.

The 'generic' integration currently provides a camera only.

While it is possible to add other unrelated entities to this, I don't think it's a good idea, mainly because it would make the config flow really confusing to the user.

I have a config flow PR open for the existing generic component, and making it also deal with water heaters would make no sense.

Probably 'generic' should be renamed to 'generic_ip_camera' - that is how it appears in the documentation.

My suggestion is that your new code goes into a new 'generic_water_heater' integration, along with its own config flow.

dgomes · 2020-12-29T10:07:41Z

I don't necessarily disagree with you :)

But config flows are reserved for integrations that communicate with devices or services (see #44562 (comment))

I realised there was generic (with the camera) and generic_thermostat. But it is also true that you have template (with almost every possible platform). I therefore decided to follow the template organisation pattern.

Let me be clear, I have no problem refactoring the code into a generic_water_heater.

dgomes · 2020-12-30T13:20:47Z

Since the initial PR did not address ADDR-0007 I decided to take the opportunity to move the integration into it's own directory, therefore clearing any concerns from @davet2001 😉

Still think generic and template are parallel and some refactoring is necessary (at least rename generic -> generic_camera)

davet2001 · 2020-12-30T14:25:24Z

Since the initial PR did not address ADDR-0007 I decided to take the opportunity to move the integration into it's own directory, therefore clearing any concerns from @davet2001 😉

Still think generic and template are parallel and some refactoring is necessary (at least rename generic -> generic_camera)

Thank you! :)
Yes, agree about the refactor. But renaming would cause a breaking change to existing configuration.yaml files. Possible route:

config flow for generic
deprecate yaml for generic & migrate to storage
remove yaml for generic
rename generic -> generic_ip_camera

dgomes · 2020-12-30T14:39:53Z

@davet2001 I think you should open up the discussion in it's proper issue (possibility in the architecture repository ?) and leave the discussion here for the Generic Water Heater 😉

Vizards · 2020-12-31T18:56:25Z

I'm looking for a way to build a generic water heater for homekit. Thank you for your hard work.
By the way, may be a water heater should have some status like heating/cooling/keep_warm/idle?

dgomes · 2020-12-31T18:58:46Z

By the way, may be a water heater should have some status like heating/cooling/keep_warm/idle?

I'm going for a 1st "as simple as it can get" PR (easier to be reviewed). Afterwards we can go beyond on/off :)

afaucogney · 2021-01-04T23:27:18Z

I m curious to know the difference with a generic_thermostat ?

dgomes · 2021-02-10T11:43:14Z

I m curious to know the difference with a generic_thermostat ?

This is a different platform. It's like the difference between switch and light, you can accomplish the same effect but are different things.

afaucogney · 2021-02-10T19:46:23Z

Sorry if I miss understood @dgomes, but switch and light does'nt have the same effect ! Because a switch can be used for something else !
In addition, every heater water is composed from a thermostat !
From my POV, it doesn't make sens to build new platform for every high level composant that is composed by a thermostat ...

Generic Electrical Heater,
Generic Gaz Heater,
Generic Heat Pump Water Water,
Generic Heat Pump Water Air....

This is like with you case the light. Today, in HA, if the light is not connected, we just need a switch that is wire to the bulb, and we can call the switch switch_for_my_light, but I understant your aim to rebuild a switch and recall it Generic Light.

Please tell me where I'm wrong here ?

dgomes · 2021-02-10T19:55:53Z

@afaucogney I understand you have issues with the concept of water_heater more then with the concept of generic_water_heater, please understand I'm not proposing a new component, I'm proposing a new instantiation of such component.

This has been discussed previously in:
#17058
home-assistant/architecture#59

homeassistant/components/generic_water_heater/manifest.json

homeassistant/components/generic_water_heater/water_heater.py

bdraco

Nice!

homeassistant/components/generic_water_heater/__init__.py

dgomes · 2021-08-09T10:55:10Z

I can understand that for a generic integration that is no more then a template packaged as an integration. But if you add logic (which would otherwise would be a better fit for python script) I think there is room for the generic platform.

Is the general consensus described in any architectural issue / discussion ?

frenck · 2021-08-09T11:02:31Z

It needs to be formalized, I'm just hitting the breaks here, before we merge stuff (like generic humidifier was) that we actually don't want anymore. We have considered reverting the generic humifier.

github-actions · 2021-11-07T11:04:58Z

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.
Thank you for your contributions.

github-actions · 2022-02-17T23:05:12Z

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.
Thank you for your contributions.

BeardedTinker · 2022-06-21T07:39:42Z

I'm a bit concerned about this integration. While I do think it's awesome idea, this also rings a lot of bells for thermal runaway - something that cheap/malfunctioning 3d printers are known for.
Detecting unknown temperature sensor is great, but it doesn't resolve all potential cases where bad thermometer/thermostat could keep heating water when not needed.
3D printers have PID tuning to learn heating curve for heater and if it doesn't match it or intended temperature, it shuts down to protect from potential fire hazard.

dgomes · 2022-06-21T09:14:59Z

I'm a bit concerned about this integration. While I do think it's awesome idea, this also rings a lot of bells for thermal runaway - something that cheap/malfunctioning 3d printers are known for.
Detecting unknown temperature sensor is great, but it doesn't resolve all potential cases where bad thermometer/thermostat could keep heating water when not needed.
3D printers have PID tuning to learn heating curve for heater and if it doesn't match it or intended temperature, it shuts down to protect from potential fire hazard.

Thank you for commenting, this is an initial PR which should be as basic as possible to ease the review process. Of course we can add many other features in future PR's.

Since this PR is blocked I'm maintaining a HACS fork https://github.com/dgomes/ha_generic_water_heater

davet2001 · 2022-06-21T12:00:41Z

@BeardedTinker The problems you describe are not eliminated by a PID or any software. Most water heaters include a thermal cutout for this reason, i.e. they have a built in mechanical device such as a bi-metalic strip which shuts off power above a certain temperature.

I don't think we should claim that the integration has any dependable safety features - in my view the user should ensure that their system will be safe even if the output is stuck in the on state.

Rudd-O

This looks like a useful thing, in general.

Rudd-O · 2022-08-25T23:00:01Z

homeassistant/components/generic_water_heater/__init__.py

+)
+
+
+async def async_setup(hass, hass_config):


Migrate to async_setup_entry.

Thanks for the feedback, but this integration is YAML only, so no config_entries

github-actions · 2023-01-22T03:06:00Z

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.
Thank you for your contributions.

marcelveldt · 2023-06-07T10:38:15Z

I've marked this PR as draft, as changes are requested that need to be processed or, in this case, more discussion is needed.
Please un-draft it once it is ready for review again by clicking the "Ready for review" button.

Thanks! 👍

Marcel

Learn more about our pull request process.

github-actions · 2023-09-07T11:05:04Z

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.
Thank you for your contributions.

Rudd-O · 2023-09-18T08:41:10Z

@dgomes can you restart activity on this PR?

dgomes · 2023-09-18T08:46:35Z

@dgomes can you restart activity on this PR?

Given the current stance, better discuss this at https://github.com/dgomes/ha_generic_water_heater

frenck · 2023-10-06T14:58:32Z

I'm going to close and decline this PR for now, until we have a proper way to handle with "generic" type of integrations. As shown above, there is now a custom integration in case one really wants this (although, of course, is not supported by the Home Assistant project).

../Frenck

homeassistant added the cla-signed label Dec 29, 2020

probot-home-assistant bot added has-tests integration: generic new-integration new-platform labels Dec 29, 2020

This was referenced Dec 29, 2020

Add Generic Water Heater home-assistant/home-assistant.io#16045

Closed

Add Generic Water Heater home-assistant/home-assistant.io#16046

Closed

dgomes mentioned this pull request Jan 4, 2021

Add generic_water_heater entity similar to generic_thermostat home-assistant/architecture#383

Closed

dgomes added the Ready for review label Feb 10, 2021

bdraco reviewed Feb 10, 2021

View reviewed changes

homeassistant/components/generic_water_heater/manifest.json Outdated Show resolved Hide resolved

bdraco reviewed Feb 10, 2021

View reviewed changes

homeassistant/components/generic_water_heater/water_heater.py Show resolved Hide resolved

bdraco reviewed Feb 10, 2021

View reviewed changes

homeassistant/components/generic_water_heater/water_heater.py Show resolved Hide resolved

bdraco reviewed Feb 10, 2021

View reviewed changes

homeassistant/components/generic_water_heater/water_heater.py Outdated Show resolved Hide resolved

bdraco approved these changes Feb 11, 2021

View reviewed changes

bdraco reviewed Feb 21, 2021

View reviewed changes

homeassistant/components/generic_water_heater/__init__.py Show resolved Hide resolved

bdraco removed the integration: generic label Feb 21, 2021

dgomes added the integration: template label Feb 21, 2021

github-actions bot added the stale label Nov 7, 2021

dgomes removed the stale label Nov 7, 2021

github-actions bot added the stale label Feb 17, 2022

dgomes removed the stale label Feb 17, 2022

Rudd-O suggested changes Aug 25, 2022

View reviewed changes

github-actions bot added the stale label Jan 22, 2023

dgomes removed the stale label Jan 22, 2023

Rudd-O approved these changes Mar 9, 2023

View reviewed changes

marcelveldt marked this pull request as draft June 7, 2023 10:38

github-actions bot added the stale label Sep 7, 2023

github-actions bot removed the stale label Sep 21, 2023

frenck closed this Oct 6, 2023

home-assistant bot removed the Ready for review label Oct 6, 2023

github-actions bot locked and limited conversation to collaborators Oct 7, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Generic Water Heater #44605

Add Generic Water Heater #44605

dgomes commented Dec 29, 2020 •

edited

Loading

davet2001 commented Dec 29, 2020

dgomes commented Dec 29, 2020

dgomes commented Dec 30, 2020

davet2001 commented Dec 30, 2020

dgomes commented Dec 30, 2020 •

edited

Loading

Vizards commented Dec 31, 2020 •

edited

Loading

dgomes commented Dec 31, 2020

afaucogney commented Jan 4, 2021

dgomes commented Feb 10, 2021

afaucogney commented Feb 10, 2021

dgomes commented Feb 10, 2021

bdraco left a comment

dgomes commented Aug 9, 2021

frenck commented Aug 9, 2021

github-actions bot commented Nov 7, 2021

github-actions bot commented Feb 17, 2022

BeardedTinker commented Jun 21, 2022

dgomes commented Jun 21, 2022

davet2001 commented Jun 21, 2022

Rudd-O left a comment •

edited

Loading

Rudd-O Aug 25, 2022

dgomes Aug 26, 2022

github-actions bot commented Jan 22, 2023

marcelveldt commented Jun 7, 2023

github-actions bot commented Sep 7, 2023

Rudd-O commented Sep 18, 2023

dgomes commented Sep 18, 2023

frenck commented Oct 6, 2023

Add Generic Water Heater #44605

Add Generic Water Heater #44605

Conversation

dgomes commented Dec 29, 2020 • edited Loading

Proposed change

Type of change

Example entry for configuration.yaml:

Additional information

Checklist

davet2001 commented Dec 29, 2020

dgomes commented Dec 29, 2020

dgomes commented Dec 30, 2020

davet2001 commented Dec 30, 2020

dgomes commented Dec 30, 2020 • edited Loading

Vizards commented Dec 31, 2020 • edited Loading

dgomes commented Dec 31, 2020

afaucogney commented Jan 4, 2021

dgomes commented Feb 10, 2021

afaucogney commented Feb 10, 2021

dgomes commented Feb 10, 2021

bdraco left a comment

Choose a reason for hiding this comment

dgomes commented Aug 9, 2021

frenck commented Aug 9, 2021

github-actions bot commented Nov 7, 2021

github-actions bot commented Feb 17, 2022

BeardedTinker commented Jun 21, 2022

dgomes commented Jun 21, 2022

davet2001 commented Jun 21, 2022

Rudd-O left a comment • edited Loading

Choose a reason for hiding this comment

Rudd-O Aug 25, 2022

Choose a reason for hiding this comment

dgomes Aug 26, 2022

Choose a reason for hiding this comment

github-actions bot commented Jan 22, 2023

marcelveldt commented Jun 7, 2023

github-actions bot commented Sep 7, 2023

Rudd-O commented Sep 18, 2023

dgomes commented Sep 18, 2023

frenck commented Oct 6, 2023

dgomes commented Dec 29, 2020 •

edited

Loading

Example entry for `configuration.yaml`:

dgomes commented Dec 30, 2020 •

edited

Loading

Vizards commented Dec 31, 2020 •

edited

Loading

Rudd-O left a comment •

edited

Loading