Skip to content

Repository files navigation

Remeha Modbus Gateway integration for Home Assistant

Remeha logo

GitHub License Hassfest Validate HACS pytest badge GitHub Release

This integration allows you to manage your Remeha heating/cooling appliance locally from Home Assistant.

Temporarily not accepting PRs

I'm working on separating the API into a dedicated library which uses up all my available time at the moment. Therefore I'm not accepting PRs during this period. New issues are accepted though so new ideas and bugs can still be reported there.

Like this integration?

Buy Me a Coffee

Table of Contents

Installation

To install this integration, you need to have HACS installed in your Home Assistant.

Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.

Current features

Planned features and features under discussion are available in the issues. If you're missing a feature that has not been mentioned yet in the issues, please submit an issue or a PR.

  • Connections:
    • Directly through a serial port
    • Indirectly through a proxy over WiFi or ethernet.
  • Supported climate zones are exposed as climate entities
    • DHW (domestic hot water)
    • CH (central heating)
    • Automatically discovered once the integration has been set up.
    • Linked to a device, showing the type of board in the Remeha appliance, including its soft- and hardware versions.
    • Climate features are enabled depending on the climate zone type (for instance, a DHW zone is only able to heat, not cool).
  • DHW auto scheduling:
    • This integration exposes a service called dhw_auto_schedule that can be used in automations or scripts. A detailed explanation follows below.
  • Time schedule editing: If you install the scheduler integration, you can edit your DHW schedules from Home Assistant after enabling it. Description is located here.

Modbus discovery table

At some point when installing the GTW-08 in your appliance, the meta data of your appliance is stored in the "discovery table". This encompasses registers 128 - 199 and some more in the zone register list. For reasons yet unknown, this table can become corrupted. Educated guesses (but guesses nonetheless) as to why this happens might be power cycles, updating the zone configuration or adding new hardware after te GTW-08 has been installed.

To allow users to force the GTW-08 to rediscover your appliance configuration, remeha_modbus exposes a service named force_system_rediscovery. This service can be called manually, but is also used in an automatic repair when a possibly corrupted discovery table is found after Home Assistant has started. Home Assistant must be restarted after this service has been called.

Supported appliances

According to Remeha, the following appliances can be extended with a GTW-08 (modbus interface), or have one pre-installed:

Appliance type Supported by GTW-08 Tested Notes
Confida 50E
Elga Ace
Elga Ace MB
Eria Tower
Eria Tower Ace (S)
Gas 220 Ace
Gas 320/620 Ace
Hera Condens HC 3-32 see below
Mercuria
Mercuria Ace
Mercuria Ace MB
miTerra
miTerra plus
Quinta Ace 65
Quinta Ace 160

This integration is known to be working with the tested devices, but since the modbus interface is the same for all others, it is very likely that it will work for those too. This list is also available on the Remeha site (Dutch 🇳🇱): Remeha modbus support.

Notes on the Hera Condens HC 3-32

  • If the mainboard is a CU-OH-04, the GTW-08 is supported on the L-Bus connector X13.
  • The heating returns water temperature reads -33 as long as the physical NTC sensor has not been added.
  • Water pressure value of the appliance (register 409, varApWaterPressure) appears to be incorrect.

Supported modbus proxies

The following proxies are known to be working with this integration. Other gateways or proxies probably work as well, but haven't been tested.

Device type URL Notes
Waveshare RS232/485 to WiFi and Ethernet https://www.waveshare.com/product/rs232-485-to-wifi-eth-b.htm?sku=25222 When setting a static ip, the device is only reachable in the same subnet since no default gateway can be set.

Entities

The entities described here require some extra attention.

climate.remeha_modbus_*

The climates exposed by this integration are unavailable if their zone function (CP020, modbus base register 641) is 0: Disabled. If a zone is enabled in your Remeha appliance, Home Assistant must be restarted or this integration disabled and then enabled to see those changes.

switch.heatpump_managed_schedules

This entity is switched on by default, and is unavailable if the scheduler-component integration is not installed. If it's available though, switching this switch to 'off' causes the scheduler-component to execute the actions listed in synchronized zone schedules directly, instead of letting the Remeha appliance handle schedule execution.

This might be undesirable, because:

  • It might lead to conflicts: if your climate zone is still in scheduling mode, both the Remeha appliance and the scheduler-component will attempt to control the heat pump state. To prevent that, the affected climate zone is put in eco mode once this entity is switched off.
  • It prevents the heat pump from heating/cooling efficiently because it doesn't know what preset changes are coming up. This might lead to higher energy usage.

To ensure that you have been warned about this, a persistent notification is triggered as well.

switch.enable_schedule_sync

The entity named switch.enable_schedule_sync is switched off by default, and is unavailable if the scheduler-component integration is not installed. If it's available though, switching this switch to 'on' causes the DHW time zone schedules from your Remeha appliance to be synchronized with the scheduler-component integration, allowing you to edit them in Home Assistant as well.

Services / actions

bootstrap_blenders

  • Fields: no
  • Return value: no
  • Raised errors: RemehaIncorrectServiceCall if called when any required integrations are missing but the related switch entities have been enabled by the user.

Bootstraps integrations with other components. This service is called automatically once Home Assistant has started. Calling it multiple times has no additional effect, except possibly when the blenders didn't bootstrap somehow.

dhw_auto_schedule

  • Fields: no
  • Return value: no
  • Raised errors: RemehaIncorrectServiceCall if called when either:
    • There is no DHW climate
    • The configured weather forecast does not supply a solar_irradiance field

A description of this service is available in DHW auto scheduling

force_system_rediscovery

To force your appliance to reset the discovery table, execute this service. This integration must be reloaded after executing this service.

Caution

Run this service at your own risk. Executing it may mess up your pre-existing Remeha devices and entities if devices are added or (re)moved because of the rediscovery.

Forcing rediscovery does not change your physical appliance settings.

read_registers

Read arbitrary modbus registers from the Remeha modbus interface.

Field Type Required Description
start_register int The address of the first register to read.
register_count int The amount of registers to read (max 10). Defaults to 1
struct_format str The struct format of the returned registers. Defaults to =H

DHW auto scheduling

DHW auto scheduling is a feature allowing efficient heating of your DHW boiler by using as much solar power as possible while keeping the interference to a minimum with other devices also using (direct) solar power.

How to use

To start using the auto scheduling feature, execute the following steps:

Install KNMI weather integration

  • Request an API key at weerlive.nl
  • Install the KNMI weather integration using the button below and enter the obtained API key during installation.

Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.

Reconfigure this integration

  • Reconfigure this integration and provide the required information about your PV system and DHW boiler. Select the KNMI weather entity to retrieve the weather forecast.

Example configuration:

Example configuration

Create an automation

  • Then just create a new automation with the following properties:
    • Trigger at any time between 22:00 and 23:59
    • Call the Remeha Modbus service dhw_auto_schedule
    • Optionally set the DHW boiler climate to preset schedule_1.

Set the correct DHW preset mode

After creating the automation, a new schedule for the next day will automatically be created. If the preset is not set in the automation, manually change the preset mode of your DHW boiler climate to Schedule 1, otherwise the schedule will of course be inactive.

Screenshots

Remeha Appliance Info

Remeha Appliance Info

Central Heating and Domestic Hot Water (DHW) climates

Central Heating and Domesting Hot Water climates

DHW History View

Showing current temperature, target temperature and heating status.

DHW History View

DHW schedule synchronization

If you enable the switch.enable_schedule_sync switch, the DHW time schedules are synchronized between your Remeha appliance and the scheduler integration.

Note

If you edit a time schedule entry in Home Assistant, it takes between 10 and 30 minutes for it to show up in the Remeha Home app. This is because the Remeha Home app doesn't update the schedules that frequently from external sources like modbus. Schedule edits from the Remeha Home app show up within one minute in Home Assistant however.

See also the heatpump managed schedules entity.

Synchronized DHW schedule example

Releases

Sponsor this project

Packages

Used by

Contributors

Languages