https://github.com/dgomes/ha_generic_water_heater

Home Assistant Custom Component - Generic Water Heater
https://github.com/dgomes/ha_generic_water_heater

home-assistant-integration

Last synced: 1 day ago
JSON representation

Home Assistant Custom Component - Generic Water Heater

• Host: GitHub
• URL: https://github.com/dgomes/ha_generic_water_heater
• Owner: dgomes
• License: mit
• Created: 2022-04-14T22:10:34.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-12-02T16:25:58.000Z (about 2 years ago)
• Last Synced: 2023-03-11T12:42:30.066Z (almost 2 years ago)
• Topics: home-assistant-integration
• Language: Python
• Homepage:
• Size: 24.4 KB
• Stars: 8
• Watchers: 2
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Home Assistant Custom Component - Generic Water Heater

The `Generic Water Heater` water_heater platform is a Water Heater implemented in Home Assistant. It uses a sensor and a switch connected to a domestic hot water (DHW) reservoir and a heat source (eg. resistance). When "on", if the measured temperature is cooler than the target temperature, the heater will be turned on, and turned off when the required temperature is reached. 

```yaml

# Example configuration.yaml entry

generic_water_heater:

  bath_water:

    heater_switch: switch.dhw_switch

    temperature_sensor: sensor.dhw_temperature

    target_temperature: 50

    delta_temperature: 5

```

## Installation 

Manual

- Place the custom_components folder in your configuration directory (or add its contents to an existing custom_components folder). It should look similar to this:

```

/

|-- custom_components/

|   |-- generic_water_heater/

|       |-- __init__.py

|       |-- water_heater.py

```

- Edit your configuration.yaml file according to the example above

## HACS

If you want HACS to handle installation and updates, add _Generic Water Heater_ as a custom repository. In this case, it is recommended that you turn off automatic updates, as above. 

## Configuration

| Option | Required | Type | Description |

--- | --- | --- |--- 

heater_switch | True | string | `entity_id` for heater switch, must be a toggle device.

temperature_sensor | True | string | `entity_id` for a temperature sensor, temperature_sensor.state must be temperature.

target_temperature | False | float | Set initial target temperature. Failure to set this variable will result in target temperature being set to null on startup

delta_temperature | False | float | In order to avoid continuous on/off triggering of the heater a delta_temperature can be defined, where by the heater turns off below the `target_temperature` minus the `delta_temperature`.

Currently the `Generic Water Heater` climate platform supports 'on' and 'off' modes. 

The `Generic Water Heater` has a failsafe mechanism by which if the temperature sensor becomes unavailable the heater is turned off.