Skip to content

Latest commit

 

History

History
109 lines (82 loc) · 5.41 KB

README.md

File metadata and controls

109 lines (82 loc) · 5.41 KB
Raw

Waterkotte Heatpump

GitHub Release GitHub Activity License

pre-commit Black

hacs Project Maintenance BuyMeCoffee

Discord Community Forum

Waterkotte Heatpump Integration for Home Assistant

This component will set up the following platforms.

Platform Description
binary_sensor Show something True or False.
sensor Show info from Waterkotte Heatpump API.
switch Switch something True or False.
select Select a value from options.
number Change a numeric value.
service Provides services to interact with heatpump

logo

Installation

Installation

HACS hacs_badge

  1. Add a custom integration repository to HACS: waterkotte-integration
  2. Install the custom integration
  3. In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "Waterkotte Heatpump"
  4. Setup the waterkotte custom integration as described below

Manual

  1. Using the tool of choice open the directory (folder) for your HA configuration (where you find configuration.yaml).
  2. If you do not have a custom_components directory (folder) there, you need to create it.
  3. In the custom_components directory (folder) create a new folder called waterkotte_heatpump.
  4. Download all the files from the custom_components/waterkotte_heatpump/ directory (folder) in this repository.
  5. Place the files you downloaded in the new directory (folder) you created.
  6. Restart Home Assistant
  7. In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "Waterkotte Heatpump"

Configuration is done in the UI

Use the Config flow to add the integration. You will need the IP/Hostname and Username/Password to log in.

Not all available sensors are enabled by default.

To set the the times for the holiday mode use the provided service waterkotte_heatpump.set_holiday and set start and end parameter.

Services

The Integration provides currently 3 services:

  • set_holiday Allows to set the start and end datetimes for the holiday mode

  • get_energy_balance Retrieves the overall energy consumption data for the year

  • get_energy_balance_monthly Retrieves the monthly breakdown energy consumption data for a moving 12 month window. 1 = January, 2 = February, etc...

Troubleshooting

Sessions

The Heatpump only allows 2 sessions and there is not way to close a session. Sometimes you will get an error about the login. Just wait a few minutes and it should auto correct itself. Session usually time out within about 5 min.

Stale Data

The Heatpump will not always respond with data. This happens usually after the system changes status, e.g. start/stop the heating. There is not much we can do about this unfortunately. I try to cache the data in possible for a better UX.

Credits

This project was generated from @oncleben31's Home Assistant Custom Component Cookiecutter template.

Code template was mainly taken from @Ludeeus's integration_blueprint template