## 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](https://github.com/ghoti57/evofw3) firmware, such as the one from [here](https://indalo-tech.onlineweb.shop/).
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:
- [ramses_cc](https://github.com/zxdavb/ramses_cc), a Home Assistant integration
- [evohome-Listener](https://github.com/smar000/evohome-Listener), an MQTT gateway
## 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
```
Raw data
{
"_id": null,
"home_page": null,
"name": "ramses_rf",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "David Bonnes <zxdavb@bonnes.me>",
"keywords": "airios, chronotherm, evohome, hometronics, honeywell, itho, nuaire, orcon, ramses, resideo, round thermostat, sundial",
"author": null,
"author_email": "David Bonnes <zxdavb@bonnes.me>",
"download_url": "https://files.pythonhosted.org/packages/a1/0f/85c44eacb47a00b4cff9ac87871d41458cb9ff91597cc18cb24eceb360ef/ramses_rf-0.50.0.tar.gz",
"platform": null,
"description": "\n\n\n\n## Overview\n**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:\n - (Heat) **evohome**, **Sundial**, **Hometronic**, **Chronotherm**\n - (HVAC) **Itho**, **Orcon**, **Nuaire**\n\nIt requires a USB-to-RF device, either a Honeywell HGI80 (somewhat rare, expensive) or something running the [evofw3](https://github.com/ghoti57/evofw3) firmware, such as the one from [here](https://indalo-tech.onlineweb.shop/).\n\nIt does three things:\n - decodes RAMSES II-compatible packets and converts them into useful JSON\n - builds a picture (schema, config & state) of evohome-compatible CH/DHW systems - either passively (by eavesdropping), or actively (probing)\n - allows you to send commands to CH/DHW and HVAC systems, or monitor for state changes\n - allows you to emulate some hardware devices\n\nFor 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:\n - **R8810A**: OpenTherm Bridge\n - **BDR91A**: Wireless Relay (also BDR91T)\n - **HC60NG**: Wireless Relay (older hardware)\n\nOther systems may well work, such as some Itho Dallderop HVAC systems, use this protocol, YMMV.\n\nIt includes a CLI and can be used as a standalone tool, but also is used as a client library by:\n - [ramses_cc](https://github.com/zxdavb/ramses_cc), a Home Assistant integration\n - [evohome-Listener](https://github.com/smar000/evohome-Listener), an MQTT gateway\n\n## Installation\n\n```\ngit clone https://github.com/zxdavb/ramses_rf\ncd ramses_rf\npip install -r requirements.txt\n```\n\nThe CLI is called client.py:\n```\npython client.py monitor /dev/ttyUSB0 -o packet.log\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A stateful RAMSES-II protocol decoder & analyser.",
"version": "0.50.0",
"project_urls": {
"Bug Tracker": "https://github.com/zxdavb/ramses_rf/issues",
"Homepage": "https://github.com/zxdavb/ramses_rf",
"Wiki": "https://github.com/zxdavb/ramses_rf/wiki"
},
"split_keywords": [
"airios",
" chronotherm",
" evohome",
" hometronics",
" honeywell",
" itho",
" nuaire",
" orcon",
" ramses",
" resideo",
" round thermostat",
" sundial"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "fabafffdea2ed53e4db74350ad847c8fc00e0b8b76573825c8d5f604c8f35ad9",
"md5": "4ad9fe7a6c413560bc18a506a0f3fe57",
"sha256": "13d93f00867f6cab4829e97ab9468d62db851001a29d39e5849b2ca9bc5678db"
},
"downloads": -1,
"filename": "ramses_rf-0.50.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4ad9fe7a6c413560bc18a506a0f3fe57",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 254480,
"upload_time": "2024-12-04T16:52:07",
"upload_time_iso_8601": "2024-12-04T16:52:07.094167Z",
"url": "https://files.pythonhosted.org/packages/fa/ba/fffdea2ed53e4db74350ad847c8fc00e0b8b76573825c8d5f604c8f35ad9/ramses_rf-0.50.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "a10f85c44eacb47a00b4cff9ac87871d41458cb9ff91597cc18cb24eceb360ef",
"md5": "8b189cbf4de06bcb188d2dc89f2fcc3c",
"sha256": "76f2f61b7dcf13778cf5b511f99f117cad91fbb42fd57410c75c3f4392ae1dc1"
},
"downloads": -1,
"filename": "ramses_rf-0.50.0.tar.gz",
"has_sig": false,
"md5_digest": "8b189cbf4de06bcb188d2dc89f2fcc3c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 446161,
"upload_time": "2024-12-04T16:52:04",
"upload_time_iso_8601": "2024-12-04T16:52:04.680985Z",
"url": "https://files.pythonhosted.org/packages/a1/0f/85c44eacb47a00b4cff9ac87871d41458cb9ff91597cc18cb24eceb360ef/ramses_rf-0.50.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-04 16:52:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "zxdavb",
"github_project": "ramses_rf",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "click",
"specs": [
[
">=",
"8.1.7"
]
]
},
{
"name": "colorama",
"specs": [
[
">=",
"0.4.6"
]
]
},
{
"name": "debugpy",
"specs": [
[
">=",
"1.8.5"
]
]
}
],
"lcname": "ramses_rf"
}
JSON
