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.57.5.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.57.5-py3-none-any.whl (408.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ramses_rf-0.57.5.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.57.5.tar.gz
Algorithm Hash digest
SHA256 983741ff10ed15c15c7a1b8862dbb116df7785b1ef9f9e6b6e05611cdf96243c
MD5 e0038fa12621fcfa234d22d3d3034465
BLAKE2b-256 625e04747b986205db9ddb5be26c9da5c3f04f7ae2887cbd97f0c39a857f2105

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ramses_rf-0.57.5-py3-none-any.whl
  • Upload date:
  • Size: 408.1 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.57.5-py3-none-any.whl
Algorithm Hash digest
SHA256 e044a9a267e18f6422c80727fc175b2064ab17c4a73df3dabb292b7bad939dc2
MD5 48f050abfda5aef2ec121e30de91d2eb
BLAKE2b-256 692c73838d11aba36e1b3622c9913ee7cecb2f99cbd270168d989d5b0657725d

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