Skip to main content

A stateful RAMSES-II protocol decoder & analyser.

Project description

License: MIT Linting Typing Testing Coverage

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

[!NOTE] Ramses RF can not interpret the new Honeywell Ramses-III (R3) messages used after a firmware upgrade since 2025 and (some) new devices.

It requires a USB-to-RF device, either a Honeywell HGI80 (somewhat rare, expensive) or a USB/MQTT dongle running the ramses_esp or evofw3 firmware, such as the one from here or your own ESP32-S3-WROOM-1 N16R8 with a CC1100 transponder.

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)

[!WARNING] This library is not affiliated with Honeywell, Airios nor any final manufacturer. The developers take no responsibility for anything that may happen to your devices because of this library.

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

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ramses_rf-0.58.0.tar.gz (1.5 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ramses_rf-0.58.0-py3-none-any.whl (427.9 kB view details)

Uploaded Python 3

File details

Details for the file ramses_rf-0.58.0.tar.gz.

File metadata

  • Download URL: ramses_rf-0.58.0.tar.gz
  • Upload date:
  • Size: 1.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for ramses_rf-0.58.0.tar.gz
Algorithm Hash digest
SHA256 8c25eda395fc5a2b538d0e7279a58b7d970c9b1de6c2bfad06fce12b87870c15
MD5 734983c73d81867d99cd003b008bdc27
BLAKE2b-256 32dccbd9b7cedb32411e4f3ade08e321501950e5318020b3481168a430c38675

See more details on using hashes here.

File details

Details for the file ramses_rf-0.58.0-py3-none-any.whl.

File metadata

  • Download URL: ramses_rf-0.58.0-py3-none-any.whl
  • Upload date:
  • Size: 427.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for ramses_rf-0.58.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d735938de9ac8906b0e7e09669f25c5930d4b9ccba3a4697557790ed5630bc60
MD5 3bb5f1ef978271a55282fa24e54ddbe6
BLAKE2b-256 f507413fc32df60f9533ef4a4ff591ab8bc1f5db22e4f15ccd6b7c10d031e5f6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page