ramses-rf


Nameramses-rf JSON
Version 0.22.40 PyPI version JSON
download
home_pagehttps://github.com/zxdavb/ramses_rf
SummaryAn interface for the RAMSES RF protocol, as used by Honeywell-compatible HVAC & CH/DHW systems.
upload_time2023-01-06 10:08:39
maintainer
docs_urlNone
authorDavid Bonnes
requires_python>=3.7
licenseMIT
keywords ramses evohome sundial chronotherm hometronics
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![CircleCI](https://circleci.com/gh/zxdavb/ramses_rf.svg?style=svg)](https://circleci.com/gh/zxdavb/ramses_rf) [![Join the chat at https://gitter.im/evohome_rf/community](https://badges.gitter.im/evohome_rf/community.svg)](https://gitter.im/evohome_rf/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

## 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 an evohome-compatible system - either passively (by eavesdropping), or actively (probing)
 - allows you to send commands to evohome, 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:
 - [evohome_cc](https://github.com/zxdavb/evohome_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": "https://github.com/zxdavb/ramses_rf",
    "name": "ramses-rf",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "ramses,evohome,sundial,chronotherm,hometronics",
    "author": "David Bonnes",
    "author_email": "zxdavb@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/db/60/708807afc3af8d904c8af0faa6f70171e6cb62777962f7fafb3fc0b14447/ramses-rf-0.22.40.tar.gz",
    "platform": null,
    "description": "[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![CircleCI](https://circleci.com/gh/zxdavb/ramses_rf.svg?style=svg)](https://circleci.com/gh/zxdavb/ramses_rf) [![Join the chat at https://gitter.im/evohome_rf/community](https://badges.gitter.im/evohome_rf/community.svg)](https://gitter.im/evohome_rf/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)\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 an evohome-compatible system - either passively (by eavesdropping), or actively (probing)\n - allows you to send commands to evohome, 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 - [evohome_cc](https://github.com/zxdavb/evohome_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\n\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "An interface for the RAMSES RF protocol, as used by Honeywell-compatible HVAC & CH/DHW systems.",
    "version": "0.22.40",
    "split_keywords": [
        "ramses",
        "evohome",
        "sundial",
        "chronotherm",
        "hometronics"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8f6364213deee546a4044079bb088793e75adcca98139dea112f7aa56b4e8aec",
                "md5": "361aec662da3a1ee6e947c318da0161a",
                "sha256": "e2de322687c524052ceb37682507e85a54eefae93dbb02d62a0ea169b8b403e8"
            },
            "downloads": -1,
            "filename": "ramses_rf-0.22.40-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "361aec662da3a1ee6e947c318da0161a",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 202869,
            "upload_time": "2023-01-06T10:08:38",
            "upload_time_iso_8601": "2023-01-06T10:08:38.699502Z",
            "url": "https://files.pythonhosted.org/packages/8f/63/64213deee546a4044079bb088793e75adcca98139dea112f7aa56b4e8aec/ramses_rf-0.22.40-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "db60708807afc3af8d904c8af0faa6f70171e6cb62777962f7fafb3fc0b14447",
                "md5": "e8223f7bf953684c03e5eb9f85d01238",
                "sha256": "77928fc78485ba2248344ee3e8dd90c89f5c2fdae906e1fba78eaadd2916024b"
            },
            "downloads": -1,
            "filename": "ramses-rf-0.22.40.tar.gz",
            "has_sig": false,
            "md5_digest": "e8223f7bf953684c03e5eb9f85d01238",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 184844,
            "upload_time": "2023-01-06T10:08:39",
            "upload_time_iso_8601": "2023-01-06T10:08:39.725806Z",
            "url": "https://files.pythonhosted.org/packages/db/60/708807afc3af8d904c8af0faa6f70171e6cb62777962f7fafb3fc0b14447/ramses-rf-0.22.40.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-01-06 10:08:39",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "zxdavb",
    "github_project": "ramses_rf",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "circle": true,
    "requirements": [],
    "lcname": "ramses-rf"
}
        
Elapsed time: 0.03413s