ramses_rf


Nameramses_rf JSON
Version 0.31.22 PyPI version JSON
download
home_pageNone
SummaryA stateful RAMSES-II protocol decoder & analyser.
upload_time2024-05-20 20:40:46
maintainerNone
docs_urlNone
authorNone
requires_python>=3.11
licenseNone
keywords airios chronotherm evohome hometronics honeywell itho nuaire orcon ramses resideo round thermostat sundial
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)

## 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/50/f4/f211aff670ba9a27ecf94255ff742b12d7758df6161b493d99b68e848ffa/ramses_rf-0.31.22.tar.gz",
    "platform": null,
    "description": "[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)\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": null,
    "summary": "A stateful RAMSES-II protocol decoder & analyser.",
    "version": "0.31.22",
    "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": "a3b32369e6d102fbeaf0dda65d28988c1af32ec66b2ef5be6e66ede0c927c1e3",
                "md5": "4fc895a8fddf48f6129fa2386ee7b9e7",
                "sha256": "0f5cc1f78cc508a6e9a5b7d4e44f004e2fc41c411b7f4cab185bd9f960b8f1f6"
            },
            "downloads": -1,
            "filename": "ramses_rf-0.31.22-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "4fc895a8fddf48f6129fa2386ee7b9e7",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 254155,
            "upload_time": "2024-05-20T20:40:50",
            "upload_time_iso_8601": "2024-05-20T20:40:50.196294Z",
            "url": "https://files.pythonhosted.org/packages/a3/b3/2369e6d102fbeaf0dda65d28988c1af32ec66b2ef5be6e66ede0c927c1e3/ramses_rf-0.31.22-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "50f4f211aff670ba9a27ecf94255ff742b12d7758df6161b493d99b68e848ffa",
                "md5": "819e5e952e5aeba52d27bcd2a8059e55",
                "sha256": "fc5e2b20faa4876d868481c066dd621e5dd106c190c4757e78d228468fdf8fad"
            },
            "downloads": -1,
            "filename": "ramses_rf-0.31.22.tar.gz",
            "has_sig": false,
            "md5_digest": "819e5e952e5aeba52d27bcd2a8059e55",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 439536,
            "upload_time": "2024-05-20T20:40:46",
            "upload_time_iso_8601": "2024-05-20T20:40:46.104655Z",
            "url": "https://files.pythonhosted.org/packages/50/f4/f211aff670ba9a27ecf94255ff742b12d7758df6161b493d99b68e848ffa/ramses_rf-0.31.22.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-05-20 20:40:46",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "zxdavb",
    "github_project": "ramses_rf",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "ramses_rf"
}
        
Elapsed time: 0.30394s