Metadata-Version: 2.1
Name: ramses-rf
Version: 0.9.1
Summary: An interface for the RAMSES RF protocol, as used by HVAC, CH/DHW.
Home-page: https://github.com/zxdavb/ramses_rf
Author: David Bonnes
Author-email: zxdavb@gmail.com
License: MIT
Download-URL: https://github.com/zxdavb/ramses_rf/archive/0.9.1.tar.gz
Keywords: ramses,evohome,sunidal,chronotherm,hometronics
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Home Automation
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Requires-Dist: colorlog (>=4.7.2)
Requires-Dist: pyserial-asyncio (>=0.5)
Requires-Dist: voluptuous (>=0.12.1)

# ramses_rf

[![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/ramses_rf/community](https://badges.gitter.im/ramses_rf/community.svg)](https://gitter.im/ramses_rf/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

It does three things:
a) convert the RF packets in useful JSON
b) builds a picture (schema, config & state) of an evohome-compatible system - either passively (by eavesdropping), or actively (probing)
c) allows you to send commands to evohome

It provides services to https://github.com/zxdavb/evohome_cc, a Home Assistant integration

It requires a USB-to-RF device, either a Honeywell HGI80 (rare, expensive) or something running [evofw3](https://github.com/ghoti57/evofw3), such as the one from [here](https://indalo-tech.onlineweb.shop/).

## Installation

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

You may want to clean up/create a virtual environment somewhere along the way, something like:
```
deactivate
rm -rf venv
python -m venv venv
. venv/bin/activate
pip install --upgrade pip
```

## Instructions

```
python client.py monitor /dev/ttyUSB0
```

Be sure to have a look at `-o packet_log.out` and `-p` (probe).


