stiebel_eltron_isg_component - GitLite

KO | EN

gitlite — search

#hacktoberfest #go #android #rust #deep-learning #nodejs #macos #java #windows #awesome #cli #kubernetes #vue #open-source

stiebel_eltron_isg_component

(★ 98)

Stiebel Eltron ISG integration for Home Assistant

File Explorer

Download Latest Version (.zip)

- - bug_report.yml
  - config.yml
  - feature_request.yml
- - lint_test.yml
  - release.yml
- dependabot.yml
- launch.json
- settings.json
- tasks.json
- configuration.yaml
- - __init__.py
  - binary_sensor.py
  - button.py
  - climate.py
  - config_flow.py
  - const.py
  - coordinator.py
  - diagnostics.py
  - entity.py
  - icons.json
  - lwz_coordinator.py
  - manifest.json
  - migration.py
  - number.py
  - repairs.py
  - select.py
  - sensor.py
  - strings.json
  - switch.py
  - wpm3i_coordinator.py
  - wpm_coordinator.py
- __init__.py
- build_release.py
- check_module_coverage.py
- develop
- lint
- setup
- __init__.py
- conftest.py
- entity_keys.txt
- README.md
- test_binary_sensor.py
- test_button.py
- test_climate.py
- test_config_flow.py
- test_coordinator.py
- test_diagnostics.py
- test_entity.py
- test_entity_descriptions.py
- test_entity_keys.py
- test_init.py
- test_manifest.py
- test_migration.py
- test_module_coverage.py
- test_number.py
- test_release_artifact.py
- test_repairs.py
- test_select.py
- test_sensor.py
- test_switch.py
- test_translations.py
- test_workflows.py
- test_write_ranges.py
.devcontainer-lock.json
.devcontainer.json
.gitattributes
.gitignore
CONTRIBUTING.md
hacs.json
info.md
LICENSE
pyproject.toml
README.md
uv.lock

# Installation Guide

1. Get the code

git clone https://github.com/pail23/stiebel_eltron_isg_component

Downloads the entire project code from GitHub to your computer.

cd stiebel_eltron_isg_component

Moves into the project folder you just downloaded.

2. Python

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.

pip install .

Installs the package published on PyPI directly — no need to clone the source.

python <실행할 파일명>.py # README에서 정확한 실행 파일명을 확인하세요

Runs the Python script (or module).

✅ If it runs without errors and prints output in the terminal, it worked.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Stiebel Eltron ISG integration

[![GitHub Release][releases-shield]][releases]
[![GitHub Activity][commits-shield]][commits]
[![Github Downloads](https://img.shields.io/github/downloads/pail23/stiebel_eltron_isg_component/total)](https://github.com/pail23/stiebel_eltron_isg_component) [![Github Downloads](https://img.shields.io/github/downloads/pail23/stiebel_eltron_isg_component/latest/total)](https://github.com/pail23/stiebel_eltron_isg_component)
[![License][license-shield]](https://raw.githubusercontent.com/pail23/stiebel_eltron_isg_component/main/LICENSE)

[![hacs][hacsbadge]][hacs]
![Project Maintenance][maintenance-shield]
[![BuyMeCoffee][buymecoffeebadge]][buymecoffee]

[![Community Forum][forum-shield]][forum]

## What this integration does

This custom integration connects Home Assistant directly to an ISG over the
local Modbus TCP interface. It does not require the Stiebel Eltron cloud or a
Web-Monitoring subscription.

Supported controller families include WPM 3, WPM 3i, WPMsystem, LWZ, LWZ x04
SOL and LWZ R290. The exact entities depend on the controller and the registers
it exposes. They can include temperatures, operating states, energy values,
climate controls, setpoints, operating modes and SG Ready inputs.

Although the integration was created for Stiebel Eltron devices, it can also be
used with compatible Tecalor devices.

## Prerequisites

You need:

1. An ISG connected to the heat pump and the same local network as Home
   Assistant.
2. Modbus TCP enabled on the ISG.
3. The IP address or hostname of the ISG. A DHCP reservation is recommended.

For connecting the ISG device to your heat pump refer to the corresponding Stiebel Eltron documentation or ask your installer.
There is no need to buy the "STIEBEL ELTRON Web-Monitoring" subscription.

If you are using the ISG with the [STIEBEL ELTRON EMI extension](https://www.stiebel-eltron.de/de/home/service/smart-home/energy-management-interface-emi.html) make sure that your ISG Firmware is current because this Integration is using Modbus, older versions of ISG Software are not able to do Modbus and EMI at the same time. (ISG Software Version `v12.1.2` was tested by [@northalpha](https://github.com/northalpha) using this integration to be working).
An update may be triggered via Stiebel Eltron Support (Kundendienst).

## Installation

### Using HACS

This is the preferred installation option:

1. Open the repository in HACS: [![Open your Home Assistant instance and show
   the HACS repository.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=pail23&repository=stiebel_eltron_isg_component&category=integration)
2. Download _Stiebel Eltron ISG_ and restart Home Assistant.
3. Go to **Settings → Devices & services**, select **Add integration**, and
   search for _Stiebel Eltron ISG_.

### Manual installation

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 `stiebel_eltron_isg`.
4. Download _all_ the files from the `custom_components/stiebel_eltron_isg/` directory (folder) in this repository.
5. Place the files you downloaded in the new directory (folder) you created.
6. Restart Home Assistant
7. Go to **Settings → Devices & services**, select **Add integration**, and
   search for _Stiebel Eltron ISG_.

## Configuration

Configuration is entirely UI based. Enter the ISG host and Modbus TCP port
(normally `502`). When the ISG advertises itself through DHCP, Home Assistant
may discover it automatically.

To change the address later, open **Settings → Devices & services**, select the
three-dot menu on the integration entry, and choose **Reconfigure**. Existing
entity IDs and history are retained.

## Energy and long-term statistics

For the Energy Dashboard and other long-term statistics, use the cumulative
consumed or produced energy sensor whose source combines the current day with
the historical total (`day_and_total`). These sensors are marked as
`total_increasing`, so Home Assistant can derive clean hourly and daily deltas
from them.

Sensors whose names end in **Today** expose the raw ISG day registers. They are
useful on dashboards for the device's current-day value, but deliberately do
not generate long-term sums. At midnight the ISG transfers only whole kWh to
the total register and retains the fractional remainder in the day register.
Treating that remainder as a reset to zero would count part of the energy
twice.

The separate **Total** sensors remain cumulative alternatives. Which energy
entities are available depends on the connected controller.

## Removing the integration

1. Open **Settings → Devices & services**.
2. Select the three-dot menu on the Stiebel Eltron ISG entry and choose
   **Delete**.
3. To remove the code as well, uninstall the repository in HACS and restart
   Home Assistant.

Removing the entry stops polling and removes its devices and entities. Recorder
history is retained by Home Assistant until it is deleted separately.

## Troubleshooting

- Verify that Home Assistant can reach the ISG on the configured host and port.
- Confirm that Modbus TCP is enabled and that no firewall or VLAN rule blocks
  the connection.
- Reserve the ISG address in DHCP, or use **Reconfigure** after an address
  change.
- If the integration fails to start with _Unsupported controller model_,
  include the controller ID from that error and the relevant Home Assistant log
  in a GitHub issue.
- For an entry that loads successfully, include a diagnostics download with the
  issue. Diagnostics redact the configured host.
- A register that is not exposed by a controller remains unavailable. This is
  preferable to reporting a plausible but stale value.

The integration polls locally every 30 seconds. A failed update marks entities
unavailable; it does not keep presenting cached values as current.
Write errors are returned to the Home Assistant action that initiated them.

The integration cannot update ISG firmware. Firmware updates are handled
through Stiebel Eltron support. It also cannot make a register writable when
the connected controller or firmware exposes it as read-only.

## Upgrading to 2026.8

Release 2026.8 needs no reconfiguration of the integration entry, but six things change for an existing installation.
Three of them can ask something of you: an automation, a dashboard or an Energy dashboard source.
The rest is metadata.

Writable temperature entities now carry the range the library accepts.
They used to offer a wider one, so a value outside the library's range was accepted by the interface and refused further down, with a `ValueError` in the log and no useful message in the interface.

| Entities | Offered before | Offered now | Library accepts |
|---|---|---|---|
| Climate on WPM, WPM 3i and LWZ R290 | 7 to 35 °C | 5 to 30 °C | 5 to 30 °C |
| Climate on the other LWZ controllers | 7 to 35 °C | 10 to 30 °C | 10 to 30 °C |
| The four room temperature settings, same controllers | from 5 °C | from 10 °C | from 10 °C |
| The two hot water settings, same controllers | up to 60 °C | up to 55 °C | up to 55 °C |

LWZ R290 is served by the WPM entity set on both platforms, so it follows the first row rather than the LWZ ones.

A write outside the range failed before this release as well, so no automation that used to succeed starts failing.
What changes is where it fails: Home Assistant now rejects a `climate.set_temperature` outside `min_temp` and `max_temp` with a `ServiceValidationError` that names the allowed range, instead of the write travelling as far as the library.
On WPM the lower end also moves down, so 5 to 7 °C can be set for the first time.

The hot water maximum follows the range the library documents for the whole LWZ family.
Individual controllers document a higher one, and correcting that belongs in the library rather than in the entity description.

The domestic hot water circulation pump is a read-only operating status on
WPMsystem and LWZ R290. It is therefore exposed as
`binary_sensor.<device>_circulation_pump`, not as a switch. Existing
automations and dashboards that reference the former switch entity need to use
the binary sensor instead; switch actions must be removed because the register
was never writable.

Raw energy entities whose names end in `Today` are disabled by default for new installations.
Their ISG registers reset at midnight to a non-zero fractional remainder.
Treating that value as `TOTAL_INCREASING` makes Home Assistant interpret the reset incorrectly and causes long-term sums to drift.
Existing registry entries stay enabled after the update, but no longer expose a state class.

If a `Today` entity is configured in the Energy dashboard, replace it with the corresponding enabled cumulative entity.
For example, replace **Produced Heating Today** with **Produced Heating**.
This preferred `day_and_total` counter includes the current day's fractional energy while remaining cumulative.
**Produced Heating Total** is also cumulative but is the whole-kWh lifetime counter that is updated when the day value is transferred.
The same naming pattern applies to consumed and water-heating energy.
Entity IDs depend on the installation and language, so select by the entity name under **Settings → Devices & services → Entities**.
Statistics already stored under the old `Today` entity are not transferred to the replacement.

Home Assistant may offer a fixable `state_class_removed` issue under **Developer Tools → Statistics** for a `Today` entity that previously generated statistics.
Deleting that invalid statistic removes its long-term statistics, not the entity's ordinary state history.
To derive a daily value, create a Home Assistant `utility_meter` helper with a daily cycle from the cumulative source.
Users who still need the raw operational `Today` value can enable it manually under **Settings → Devices & services → Entities**.

Flow-rate sensors now use Home Assistant's canonical `L/min` unit and volume-flow device class instead of the legacy `l/min` string.
To the recorder those two spellings are different units, so it reports a `units_changed` issue for an existing long-term statistic and stops extending it until the issue is resolved.
Open **Developer Tools → Statistics** and apply the offered fix.
Choose the option that updates the stored unit, which keeps the entire history; the other one deletes the statistic.
No values change either way, `L/min` and `l/min` are the same quantity.

Pressure sensors now use Home Assistant's pressure device class. On US customary
installations, Home Assistant therefore displays their native `bar` values as
`psi`. Ventilation flow-rate sensors keep their native `m³/h` values.

Writable number entities are now grouped under **Configuration** on the device
page. Existing entity IDs and manually configured dashboards or automations are not
changed. These settings may no longer appear in automatically generated dashboards
or default voice-assistant exposure.

## Upgrading to 2026.7

Release 2026.7 is a significant refactoring of the integration.

For users:

1. Update the integration and restart Home Assistant.
2. If entities show as unavailable, reload the integration once from the UI.
3. Some installations briefly created replacement entities during the unique-ID transition.
   If Home Assistant reports unavailable duplicates, open the Repair and review the exact entity IDs before confirming their removal.
   If the Repair is not available, remove only an unavailable leftover that has a working counterpart and is no longer referenced by a dashboard or automation.
   Removing and adding the integration again is not the preferred cleanup because it can change entity IDs and require references to be updated.

A note on history, because it is easy to get wrong in both directions. Removing an
entity does not delete its recorded history: the long term statistics stay behind
under the old entity id and show up in Developer Tools, Statistics as no longer
provided, where you can delete them deliberately.
Home Assistant does not merge that separate series into the working entity automatically.
Renaming an entity inside Home Assistant is the one path that carries its statistics along, because the recorder migrates the statistic id on a rename but has no hook for a removal.

To change the IP address or port of the ISG, use **Reconfigure** in the three-dot
menu of the integration entry. It leaves the entities untouched, so nothing has to be
matched up afterwards.

For contributors, the transition the earlier migration notes described is complete.
The compatibility shims are gone, along with `probe.py` and `client_bridge.py`:

1. Platform code reads through `coordinator.get_value` and writes through
   `coordinator.write_component_value`.
2. Entity descriptions address library fields directly, for example
   `modbus_register=lambda api: api.system_parameters.comfort_temperature_hk_1`.
3. The pinned `pystiebeleltron` version is in
   `custom_components/stiebel_eltron_isg/manifest.json`.

Note that the library uses wire addresses, which are one below the addresses in the
Stiebel Eltron Modbus documentation. Documented register 1514 is `1513` in the
library.

## Contributions are welcome!

If you want to contribute to this please read the [Contribution guidelines](CONTRIBUTING.md)

***

[stiebel_eltron_isg]: https://github.com/pail23/stiebel_eltron_isg_component
[buymecoffee]: https://www.buymeacoffee.com/pail23
[buymecoffeebadge]: https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg
[commits-shield]: https://img.shields.io/github/commit-activity/y/pail23/stiebel_eltron_isg_component
[commits]: https://github.com/pail23/stiebel_eltron_isg_component/commits/main
[hacs]: https://github.com/hacs
[hacsbadge]: https://img.shields.io/badge/HACS-Default-orange
[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen
[forum]: https://community.home-assistant.io/
[license-shield]: https://img.shields.io/github/license/pail23/stiebel_eltron_isg_component
[maintenance-shield]: https://img.shields.io/badge/maintainer-Paul%20Frank-green
[releases-shield]: https://img.shields.io/github/v/release/pail23/stiebel_eltron_isg_component
[releases]: https://github.com/pail23/stiebel_eltron_isg_component/releases