Skip to main content

License: MIT Linting Typing Testing Coverage

Overview

ramses_rf is a Python 3.13-3.14 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:

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

Metadata

Release files for ramses-rf 0.61.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ramses-rf 0.61.3
File Size Uploaded Provenance Actions
ramses_rf-0.61.3.tar.gz 1.6 MB Without provenance Details for ramses_rf-0.61.3.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for ramses-rf 0.61.3
File Interpreter ABI Platform Actions
ramses_rf-0.61.3-py3-none-any.whl Python 3 none any Details for ramses_rf-0.61.3-py3-none-any.whl

Total release size: 2.2 MB

Release files / ramses_rf-0.61.3.tar.gz

Download URL ramses_rf-0.61.3.tar.gz
Size 1.6 MB
Tags Source
SHA-256 checksum
How to use checksums
47b7606dfb4223378122f6c91760cd6c2e2b8c4d925a3bb54316b1c0159a2b9d
BLAKE2b-256 checksum
How to use checksums
3015d98fe28aed5e43876e71ec713c33070842ba56fc6a530dfb506d397cd6d2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / ramses_rf-0.61.3-py3-none-any.whl

Download URL ramses_rf-0.61.3-py3-none-any.whl
Size 616.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
17feebe16456a8547adc11c546da0ababd7dcc82791c9cb738be0e908b18e219
BLAKE2b-256 checksum
How to use checksums
4bab6b7bc2b09898e4ce10e42c89cd6e28cdc2014d5a8d19b7f9a77bfaaa96c4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Security for ramses-rf 0.61.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.61.3 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page