Overview
ramses_rf is a Python client library/CLI utility used to interface with some Honeywell-compatible HVAC & CH/DHW systems that use 868MHz RF, such as:
- (Heat) evohome, Sundial, Hometronic, Chronotherm
- (HVAC) Itho, Orcon, Nuaire, Vasco, ClimaRad
It requires a USB-to-RF device, either a Honeywell HGI80 (somewhat rare, expensive), a USB/MQTT dongle running the ramses_esp, evofw3 firmware, such as the one from here, your own ESP32-S3-WROOM-1 N16R8 with a CC1100 transponder or a combination of dongles for better RF coverage.
It does four things:
- decodes RAMSES II-compatible packets and converts them into useful JSON
- builds a picture (schema, config & state) of evohome-compatible CH/DHW systems - either passively (by eavesdropping), or actively (probing)
- allows you to send commands to CH/DHW and HVAC systems, or monitor them for state changes
- allows you to emulate some hardware devices (remotes)
For CH/DHW, the simplest way to know if it will work with your system is to identify the box connected to your boiler/HVAC appliance as one of:
- R8810A: OpenTherm Bridge
- BDR91A: Wireless Relay (also BDR91T)
- HC60NG: Wireless Relay (older hardware)
Other systems may well work, such as some Itho Daalderop HVAC systems, use this protocol. YMMV.
This library includes a CLI and can be used as a standalone tool, but also is used as a client library by:
- ramses_cc, a Home Assistant integration
- evohome-Listener, an MQTT gateway
Our Code of Conduct applies to all use of this repository and the code it creates.
Installation
To use the ramses_cc Integration in Home Assistant, just install Ramses RF using HACS. It will take care of installing this library. See the Ramses_cc wiki for details.
Ramses_rf CLI
To install the ramses_rf command line client:
git clone https://github.com/ramses-rf/ramses_rf
cd ramses_rf
pip install -r requirements/requirements.txt
pip install -e .
The CLI is called client.py and is included in the code root.
It has options to monitor and parse Ramses-II traffic to screen or a log file, and to parse a file containing Ramses-II messages to the screen.
See the client.py CLI wiki page for instructions.
For code development, some more setup is required. Please follow the steps in our Developer's Resource
Release files for ramses-rf 0.60.8
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| ramses_rf-0.60.8.tar.gz | 1.6 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ramses_rf-0.60.8-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 2.1 MB
Release files / ramses_rf-0.60.8.tar.gz
| Download URL | ramses_rf-0.60.8.tar.gz |
|---|---|
| Size | 1.6 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
25e4edf0ef18856d14d28bd634e513902eeedf1e4f539fb2083e5440b6d5288c
|
|
BLAKE2b-256 checksum How to use checksums |
05bd6d49afe3682a22a180e75467562627e06c3045894fb7af7043333a59d515
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / ramses_rf-0.60.8-py3-none-any.whl
| Download URL | ramses_rf-0.60.8-py3-none-any.whl |
|---|---|
| Size | 586.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8f4d97935c32bd3aced7e03f8a43b4d20c9ce0be5afe6374283d09e1f94eb02b
|
|
BLAKE2b-256 checksum How to use checksums |
b1e5e41cb9fb1e5172fae5844deff388262b91addda145068b737b8ad2eb8dbe
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
