marq24 / ha-waterkotte-the-fork

HACS integration for Waterkotte Heatpumps [build since 2018] - # This version is deprecated - and no further updates will be provided! Please migrate to the new version of the Integration that have been published - TIA - see the 'Migration Guide' for details
MIT License
7 stars 1 forks source link
hacs hacs-integration home-assistant home-assistant-hacs home-assistant-integration waterkotte

- This version is deprecated -

Migration Guide

The old ha-waterkotte repository is deprecated and have now been renamed to ha-waterkotte-the-fork. After the refactoring process have been completed, I have decided to create an independent repository - since the refactored version does not have much in common with the origin sources.

Unfortunately HACS does not 'like' renaming of repositories, so you have to perform few steps in order to upgrade your home assistant installation to the latest ha-waterkotte integration version - sorry for this inconvenience!

How to migrate to the new version of the integration

  1. make a backup (just in case)
  2. go to HACS menu of your home assistant installation
  3. remove the (old) custom HACS repository 'https://github.com/marq24/ha-waterkotte'

    (This step will/should remove the Waterkotte Integration entry from the list of installed HACS Integrations)

  4. add the new repository 'https://github.com/marq24/ha-waterkotte' to HACS
  5. install the waterkotte integration to your local HACS
  6. restart your home assistant system

YES - this procedure sounds totally silly - but HACS stores a custom-id for each repository - And since I have decided to rename the old repository which base on the work from pattisonmichael to 'https://github.com/marq24/ha-waterkotte-the-fork' and created an independent repository, this procedure is necessary in order to be notified about any future updates.

Home Assistant Integration for Waterkotte Heatpumps [+2020]

logo

This Home Assistant Integration is providing information from the German heatpump pioneer Waterkotte. In addition and where possible functions are provided to control the system.

All data will be fetched (or send) to your Waterkotte via the build in webserver of the unit. So the functionality is based on the data and settings that are available also via the frontend that you can directly access via a web-browser.

hacs_badge BuyMeCoffee PayPal

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 adjustable Temperatures (demanded or heating curves)
service Provides services to interact with heatpump

Disclaimer

Please be aware, that we are developing this integration to best of our knowledge and belief, but cant give a guarantee. Therefore, use this integration at your own risk.

What you get [2024.02.15]

sampleview

[Get the sources for the sample dashboard_above]

Installation

HACS

  1. Add a custom integration repository to HACS: ha-waterkotte
  2. Install the custom integration
  3. In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "Waterkotte Heatpump [+2020]"
  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 [+2020]"

Adding or enabling the integration

My Home Assistant (2021.3+)

Just click the following Button to start the configuration automatically:

Open your Home Assistant instance and start setting up a new integration.

Manual

Use the following steps for a manual configuration by adding the custom integration using the web interface and follow instruction on screen:

After the integration was added you can use the 'config' button to adjust your settings and you can additionally modify the update intervall

Please note, that most of the available sensors are not enabled by default.

Services

The Integration provides currently 4 services:

Setting dates & times

Get Energy Balance

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 is a fork from @pattisonmichael' s Waterkotte-Integration

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

The original code template was mainly taken from @Ludeeus' s integration_blueprint template


Advertisement / Werbung - alternative way to support me

Switch to Tibber!

Be smart switch to Tibber - that's what I did in october 2023. If you want to join Tibber (become a customer), you might want to use my personal invitation link. When you use this link, Tibber will we grant you and me a bonus of 50,-€ for each of us. This bonus then can be used in the Tibber store (not for your power bill) - e.g. to buy a Tibber Bridge. If you are already a Tibber customer and have not used an invitation link yet, you can also enter one afterward in the Tibber App (up to 14 days). [see official Tibber support article]

Please consider using my personal Tibber invitation link to join Tibber today or Enter the following code: 6o0kqvzf (six, oscar, zero, kilo, quebec, victor, zulu, foxtrot) afterward in the Tibber App - TIA!