Async I/O modbus API for Remeha appliances

aio-remeha-modbus is an async python API for Remeha appliances.

Installation

Add this library to your project from PyPI using

$ uv add aio-remeha-modbus>=0.3.0

or build it locally by checking out the source of this project and

$ uv build
...
$ uv pip install dist/*.whl

Exposed API

The API is documented at readthedocs. A short textual description of the most important classes and their hierarchy is shown below.

Caching

All API calls are executed directly against the modbus proxy; no caching is implemented at this time.

Error handling

All errors raised by this library are intended to be translated. To facilitate that, the base error class contains a translation_key field to look up the translation and a translation_placeholders field. This is a dict to be used when extrapolating the error message.

Configuration

To create a new api instance, you first need an instance of api.config.Configuration. This can either be a SerialConfiguration, a TcpConfiguration or a UdpConfiguration, depending on your needs.

RemehaApi

To create a new API instance, call api.api.RemehaApi.create() and provide the Configuration instance created previously.

Appliance

The connected Remeha appliance can be retrieved using RemehaApi.async_read_appliance().

ClimateZone

Zones, as they are configured in the Remeha appliance are exposed as ClimateZone instances and can be retrieved using RemehaApi.async_read_zones(), providing the corresponding Appliance.

Zone schedules

When a ClimateZone is read from the appliance and its mode is ClimateZoneMode.SCHEDULING, the schedules for each Weekday are available through ClimateZone.current_schedule as instances of api.schedule.ZoneSchedule.