Metadata-Version: 2.4
Name: incomfort-client
Version: 0.7.0
Summary: An aiohttp-based client for Intergas InComfort/InTouch Lan2RF systems.
License: MIT
License-File: LICENSE
Keywords: incomfort,api,async,client
Author: Jan Bouwhuis
Author-email: jan@jbsoft.nl
Maintainer: Jan Bouwhuis
Maintainer-email: jan@jbsoft.nl
Requires-Python: >=3.9,<4.0
Classifier: Development Status :: 5 - Production/Stable
Classifier: Framework :: AsyncIO
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Home Automation
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: aiohttp (>=3.8.1)
Project-URL: Bug Tracker, https://github.com/jbouwh/incomfort-client/issues
Project-URL: Changelog, https://github.com/jbouwh/incomfort-client/releases
Project-URL: Documentation, https://github.com/jbouwh/incomfort-client
Project-URL: Homepage, https://github.com/jbouwh/incomfort-client
Project-URL: Repository, https://github.com/jbouwh/incomfort-client
Description-Content-Type: text/markdown

[![PyPI version](https://badge.fury.io/py/incomfort-client.svg)](https://badge.fury.io/py/incomfort-client)

# incomfort-client

Python client library for **Intergas boilers** accessible via a **Lan2RF gateway** by abstracting its HTTP API. It includes a basic CLI to demonstrate how to use the library.

This library was previously called **intouch-client**, as it is known in the UK as **InTouch**, but in mainland Europe (especially the Netherlands, where is it popular) it is known as **Incomfort**.

It is written for Python v3.9+. It is available as a [PyPi package](https://pypi.org/project/incomfort-client/).

With many thanks, the code was refactored by @zxdavb and maintained for about 5 years, and maintenance now has been taken over by @jbouwh to be able to continue support.

The library is used as backend code for the [Intergas InComfort/Intouch Lan2RF gateway](https://www.home-assistant.io/integrations/incomfort/) integration with [Home Assistant](https://www.home-assistant.io/).

### Porting from syncio libraries

This library is based upon https://github.com/bwesterb/incomfort, but uses **aiohttp** rather than synchronous I/O (such as **requests** or **httplib**).

Where possible, it uses the same methods and properties as **bwesterb/incomfort**, but with the following differences:

- **`Gateway`** class

  - added kwargs: `username`, `password` (used for newer versions of firmware)

- **`Heater`** class

  - renamed: `is_burning`, `is_failed`, `is_pumping`, `is_tapping`
  - moved: `room_temp`, `setpoint`, `setpoint_override`, `set` to **`Room`** class
  - new/added: `update`, `status`, `rooms`

- **`Room`** class has been added, and some methods moved in from **`Heater`**
  - same name: `room_temp`, `setpoint`
  - renamed: `override`, `set_override`
  - new/added: `status`

### Basic CLI included

There is a very basic CLI (this output has been formatted for readability):

```bash
(venv) root@hostname:~/$ python inclient.py ${HOSTNAME}
{
  'display_code': 126,
  'display_text': 'standby',
  'fault_code': 0,

  'is_burning': False,
  'is_failed': False,
  'is_pumping': False,
  'is_tapping': False,

  'heater_temp': 31.22,
  'tap_temp': 27.91,
  'pressure': 1.23,
  'serial_no': '175t23072',

  'nodenr': 200,
  'rf_message_rssi': 38,
  'rfstatus_cntr': 0,

  'room_1': {'room_temp': 26.4, 'setpoint': 19.5, 'override': 19.5},
  'room_2': {'room_temp': None, 'setpoint': None, 'override': 19.0}
}
```

### QA/CI via CircleCI

QA includes comparing JSON from **cURL** with output from this app using **diff** (note the `--raw` switch):

```bash
(venv) root@hostname:~/$ curl -X GET http://${HOSTNAME}/data.json?heater=0 | \
    python -c "import sys, json; print(json.load(sys.stdin))" > a.out

(venv) root@hostname:~/$ python inclient.py ${HOSTNAME} --raw > b.out

(venv) root@hostname:~/$ diff a.out b.out
```

Newer versions of the gateway require authentication:

```bash
(venv) root@hostname:~/$ python inclient.py ${HOSTNAME} -u ${USER} -p ${PASS}

(venv) root@hostname:~/$ curl --user ${USER}:${PASS} -X GET http://${HOSTNAME}/protect/data.json?heater=0
```

> Note that at the moment CircleCI is not active.