Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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

Last synced: 19 days ago
JSON representation

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

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

### 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)

## 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