Thanks to everyone having starred my repo! To star it click here, then click on the star on the top right. Thanks!

hass-Deltasol-KM2

Custom component for retrieving sensor information from Resol KM1/KM2 or DL2/DL2Plus/DL3 or VBus/LAN or VBus/USB. This component automatically determines if you are using KM2 or DL2/DL2Plus/DL3 device and can also be set up to work with KM1, VBus/LAN or VBus/USB. Component uses webservice to get all the sensor data and makes it available in Home Assistant.

Features

Currently Available Features

• 💻 This integration supports all Resol devices: KM1/KM2, DL2/DL2Plus/DL3, VBus/LAN and VBus/USB and is capable of auto detecting your device. Welcome the DL2Plus as the newest family member.
• ⭐ The exclusive Filter that is only available on DL2/DL3 devices can be used with this integration!
• 📺 This integration is fully configurable within the UI, no yaml configuration needed.
• 🔗 If the connection to your Resol device gets lost (network issue, Add-on not yet started, ...) the integration makes retries until the connection is established.
• 🔷 All the data of your Resol device is shown in Home Assistant. I.e. Product Name, Serial Number, Product Features, Software Version, Hardware Version, ...
• 🔹 All bus devices that are connected to your Resol device are shown as device in Home Assistant with the specific bus device name. Additionally all the sensors are grouped by these bus devices to make it easier to find your desired sensors.
• 🔸 By default all sensors without a unit are handled as diagnostic sensors and disabled by default. You can manually enable them if needed.
• 🌍 Multiple language support, currently we have 🇬🇧, 🇩🇪, 🇮🇹 and 🇳🇱. If you speak another language, just directly open a PR or create an Translation Request for your language and provide the translation there.

Next To Come Features (Wishlist)

• 🔄 Better UI Configuration Flow with device detection and only showing the options that are relevant for the specific device.
• ... more ideas? Feel free to open an Feature Request.

Bugs

🐛 No software is perfect and therefore neither is this one. If you encounter a problem, please open an Bug Report.

Release 1.x.x

Important

With version 1.x.x we have moved on to UI based configuration. The yaml configuration will be automtically migrated. The process is as following:

• Update the integration to version 1.x.x.
• Restart Home Assistant Core.
• Remove the old sensor definition from your configuration.yaml.

Installation

HACS (preferred method)

• or go to your HACS store and search for dm82m/hass-Deltasol-KM2.
• Click Download in the lower right side and install it.
• Restart Home Assistant Core.
• or configure the integration by adding it via UI Settings -> Devices & Services -> Add Integration -> Resol KM1/KM2, DL2/DL2Plus/DL3, VBus/LAN, VBus/USB. Then follow the configuration steps below.

Manual install

Create a directory called deltasol in the <config directory>/custom_components/ directory on your Home Assistant instance. Install this component by copying all files in /custom_components/deltasol/ folder from this repo into the new <config directory>/custom_components/deltasol/ directory you just created.

This is how your custom_components directory should look like:

custom_components
├── deltasol
│   ├── __init__.py
│   ├── config_flow.py
│   ├── const.py
│   ├── deltasolapi.py
│   ├── manifest.json
│   ├── sensor.py
│   ├── strings.json
│   └── languages
│       ├── de.json
│       ├── en.json
│       ├── it.json
│       └── nl.json

Restart Home Assistant Core and afterwards or configure the integration by adding it via UI Settings -> Devices & Services -> Add Integration -> Resol KM1/KM2, DL2/DL2Plus/DL3, VBus/LAN, VBus/USB. Then follow the configuration steps below.

Configuration

In any case, try to ensure to have the latest firmware running on your Resol device.

KM2 and DL2/DL2Plus/DL3

It works out-of-the-box, the only thing that is needed is the configuration described next.

Configuration

• Host: Hostname or IP address of your Resol KM2 or DL2/DL2Plus/DL3.
• Port: Port of your Resol KM2 or DL2/DL2Plus/DL3. Defaults to 80. Do not change that, unless you know what you do.
• Username: Username used for logging in to Resol KM2 or DL2/DL2Plus/DL3.
• Password: Password used for logging in to Resol KM2 or DL2/DL2Plus/DL3.
• Scan interval (Optional): Defines update frequency. Optional and in seconds. Defaults to 300 (5 min), minimum value is 60 (1 min).
• API key (Optional): Only applicable if you are using DL2/DL3 device. Applies the filter defined on the DL2/DL3. Use the id of the DL2/DL3 defined filter here.

KM1, VBus/LAN and VBus/USB

There is one prerequisite before it works. You need to run the resol-vbus json-live-data-server. To do so you have at least two possibilities:

1. Run the server as an HAOS add-on, continue here.
2. Run the server on your own, continue here and ensure to be at least on git commit 7c9e88af5af3e14443c01a4ec5d7c042be2163f9.

If your json-live-data-server is successfully running, lets continue here.

Configuration

• Host: If you went with point 1 it is 127.0.0.1 and if you went with point 2 it is hostname_or_ip_of_your_json-live-data-server.
• Port: Within default json-live-data-server it is port 3333. If you have changed that, you need to use this port here aswell. Otherweise set it to 3333.
• Scan interval (Optional): Defines update frequency. Optional and in seconds. Defaults to 300 (5 min), minimum value is 60 (1 min).
• Do not set Username, Password or API key here, they are not needed.

Troubleshooting

Please set your logging for this custom component to debug during initial setup phase. If everything works well, you are safe to remove the debug logging:

logger:
  default: warn
  logs:
    custom_components.deltasol: debug

Credits

A huge thank you to all the contributors and also thank you to everyone who contributed ideas.