https://github.com/jalle19/roth-modbus-mqtt

A Modbus to MQTT proxy for modern Roth Touchline SL floor heating controllers
https://github.com/jalle19/roth-modbus-mqtt

homeassistant modbus mqtt roth touchline

Last synced: 8 days ago
JSON representation

A Modbus to MQTT proxy for modern Roth Touchline SL floor heating controllers

• Host: GitHub
• URL: https://github.com/jalle19/roth-modbus-mqtt
• Owner: Jalle19
• License: gpl-3.0
• Created: 2024-12-04T06:38:10.000Z (2 months ago)
• Default Branch: master
• Last Pushed: 2025-02-04T18:58:12.000Z (8 days ago)
• Last Synced: 2025-02-04T19:37:39.142Z (8 days ago)
• Topics: homeassistant, modbus, mqtt, roth, touchline
• Language: TypeScript
• Homepage:
• Size: 237 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# roth-modbus-mqtt

[![CI](https://github.com/Jalle19/roth-modbus-mqtt/actions/workflows/ci.yml/badge.svg)](https://github.com/Jalle19/roth-modbus-mqtt/actions/workflows/ci.yml)

A Modbus to MQTT proxy for modern Roth Touchline SL floor heating controllers.

## Features

- Supports both Modbus RTU serial devices and Modbus TCP gateways

- Automatically discovers the number of zones

- Supports Home Assistant auto-discovery

### Screenshots (from Home Assistant)

![Controls](resources/controls.png)

![Configuration](resources/configuration.png)

![Sensors](resources/sensors.png)

![Diagnostic](resources/diagnostic.png)

### Unsupported features

The following features are unsupported since I don't have the required hardware:

- floor temperature sensors

- actuators

- window sensors

- extension units (zones 9-48)

### Known issues

* Register reads may randomly fail some time after the controller has been restarted, especially before all the 

  thermostats have properly registered themselves

* When a thermostat has issues communicating with the controller, temperature and humidity will be `null`, and the 

  zone-specific binary sensor will turn on

* If the controller is rebooted while the application is running, the number of detected zones, window sensor etc. may 

  initially be incorrect. Regular peripheral probes are done to rectify this issue. The user can also trigger a 

  peripheral at runtime via an MQTT button 

## Installation

The following instructions assume you're running as `root`.

1. Clone the repository to `/opt`

2. Run `systemctl enable /opt/roth-modbus-mqtt/systemd/roth-modbus-mqtt.service`

3. Run `systemctl edit roth-modbus-mqtt`, then add a section like this:

```

[Service]

ExecStart=/usr/bin/node /opt/roth-modbus-mqtt/dist/roth-modbus-mqtt.js -d tcp://192.168.1.209:502 -m mqtt://192.168.1.210:1883

```

4. Run `systemctl start roth-modbus-mqtt`

If everything runs correctly and your Home Assistant is configured to use the same MQTT broker, a new 

device should appear under the MQTT integration.

Run `/opt/roth-modbus-mqtt/dist/roth-modbus-mqtt.js -h` for full usage details.

## Contributing

Pull requests are always welcome! There are many things that are not supported, I've only implemented the 

basics.

## License

GNU GENERAL PUBLIC LICENSE Version 3