Skip to main content

A stateful RAMSES-II protocol decoder & analyser.

Project description

ruff mypy pytest

Overview

ramses_rf is a 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

It requires a USB-to-RF device, either a Honeywell HGI80 (somewhat rare, expensive) or something running the evofw3 firmware, such as the one from here.

It does three 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 for state changes
  • allows you to emulate some hardware devices

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 Dallderop HVAC systems, use this protocol, YMMV.

It includes a CLI and can be used as a standalone tool, but also is used as a client library by:

Installation

git clone https://github.com/zxdavb/ramses_rf
cd ramses_rf
pip install -r requirements.txt

The CLI is called client.py:

python client.py monitor /dev/ttyUSB0 -o packet.log

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.42.0.tar.gz (441.9 kB view details)

Uploaded Source

Built Distribution

ramses_rf-0.42.0-py3-none-any.whl (255.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ramses_rf-0.42.0.tar.gz
  • Upload date:
  • Size: 441.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.27.0

File hashes

Hashes for ramses_rf-0.42.0.tar.gz
Algorithm Hash digest
SHA256 bdf8daf996db6da2c68d11a0305996a438e1350170e2e98a9f54b2667e9cba73
MD5 2593f9b9f903205b11cb46ce74530198
BLAKE2b-256 76751d7d5ac1cab58b242cff63e4699cbade893ac0031233d4c5e3834444b717

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ramses_rf-0.42.0-py3-none-any.whl
  • Upload date:
  • Size: 255.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.27.0

File hashes

Hashes for ramses_rf-0.42.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1ef5cfb48497ea9e669fd5a8364791e56da53fb0d818daf98b67ab4f08c01ef6
MD5 efc5762e372c568e2806a479e64e55c4
BLAKE2b-256 91644cf57b730ed3ef0869b827b6c0a9187117cabd064ac02836894f851ca447

See more details on using hashes here.

Supported by

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