Metadata-Version: 2.4
Name: evohome-async
Version: 1.2.0
Summary: An async client for connecting to Honeywell's TCC RESTful API.
Project-URL: Homepage, https://github.com/zxdavb/evohome-async
Project-URL: Bug Tracker, https://github.com/zxdavb/evohome-async/issues
Project-URL: Wiki, https://github.com/zxdavb/evohome-async/wiki
Author-email: David Bonnes <zxdavb@bonnes.me>
Maintainer-email: David Bonnes <zxdavb@bonnes.me>
License-Expression: Apache-2.0
License-File: LICENSE
Keywords: evohome,honeywell,resideo,round thermostat,tcc,vision pro
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Topic :: Home Automation
Requires-Python: >=3.13.2
Requires-Dist: aiohttp>=3.13.3
Requires-Dist: aiozoneinfo>=0.2.3
Requires-Dist: voluptuous>=0.15.2
Provides-Extra: cli
Requires-Dist: aiofiles>=24.1.0; extra == 'cli'
Requires-Dist: asyncclick>=8.3.0; extra == 'cli'
Requires-Dist: debugpy>=1.8.17; extra == 'cli'
Requires-Dist: keyring>=25.7.0; extra == 'cli'
Provides-Extra: dev
Requires-Dist: aioresponses>=0.7.8; extra == 'dev'
Requires-Dist: hatch>=1.16.3; extra == 'dev'
Requires-Dist: mypy>=1.19.1; extra == 'dev'
Requires-Dist: prek>=0.2.28; extra == 'dev'
Requires-Dist: pytest-asyncio>=1.3.0; extra == 'dev'
Requires-Dist: pytest-cov>=7.0.0; extra == 'dev'
Requires-Dist: pytest-freezer>=0.4.9; extra == 'dev'
Requires-Dist: pytest-sugar>=1.0.0; extra == 'dev'
Requires-Dist: pytest-xdist>=3.8.0; extra == 'dev'
Requires-Dist: pytest>=9.0.0; extra == 'dev'
Requires-Dist: pyyaml>=6.0.3; extra == 'dev'
Requires-Dist: ruff>=0.14.13; extra == 'dev'
Requires-Dist: syrupy>=5.0.0; extra == 'dev'
Requires-Dist: types-aiofiles>=24.1.0.20250822; extra == 'dev'
Requires-Dist: types-pyyaml>=6.0.12.20250915; extra == 'dev'
Description-Content-Type: text/markdown

![ruff](https://github.com/zxdavb/evohome-async/actions/workflows/check-lint.yml/badge.svg)
![mypy](https://github.com/zxdavb/evohome-async/actions/workflows/check-type.yml/badge.svg)
![pytest](https://github.com/zxdavb/evohome-async/actions/workflows/check-test.yml/badge.svg)
![PyPI](https://img.shields.io/pypi/v/evohome-async?label=pypi%20package)
![PyPI - Downloads](https://img.shields.io/pypi/dm/evohome-async)

evohome-async
==============

Python client to asynchronously access the [Total Connect Comfort](https://international.mytotalconnectcomfort.com/Account/Login) RESTful API.

It provides support for Resideo TCC-based systems, such as **Evohome**, **Round Thermostat**, **VisionPro** and others:

- it supports _only_ EU/EMEA-based systems, please use (e.g.) [somecomfort](https://github.com/mkmer/AIOSomecomfort) for US-based systems
- it provides Evohome support for [Home Assistant](https://www.home-assistant.io/integrations/evohome) and other automation platforms

> **NOTE:** the TCC API available to this library does not currently support cooling.

This client _requires_ the [aiohttp](https://pypi.org/project/aiohttp/) library. If you prefer a non-async client, [evohome-client](https://github.com/watchforstock/evohome-client) uses [requests](https://pypi.org/project/requests/) instead.

### CLI for schedules (currently WIP)

To install a basic CLI:

```bash
pip install 'evohome-async[cli]'

evo-client --help
```

For example, to backup schedules (incl. DHW, if any):

```bash
evo-client -u username@gmail.com -p password get-schedules --loc-idx 2 > schedules.json
```

... and to restore:

```bash
evo-client -u username@gmail.com -p password set-schedules --loc-idx 2 -f schedules.json
```

To avoid exceeding the vendor's API rate limit, it will restore the access token cache, unless you use the the `--no-load-tokens` switch.

> **NOTE:** the client may save your access tokens to **.evo-cache.tmp**: this presents a small security concern.

### Example code...

```python
websession = aiohttp.ClientSession()
token_manager = TokenManager(username, password, websession)
await token_manager.load_access_token()

evo = EvohomeClient(token_manager)
await evo.update()

...

await token_manager.save_access_token()
await websession.close()
```

### Differences from non-async version

It is loosely based upon <https://github.com/watchforstock/evohome-client>, but async-aware.

The difference between the **evohome-async** and **evohome-client** libraries are significant, but it should be relatively straightforward to port your code over to this async library should you wish.

For example, entity ID attrs are `.id` and no longer `.dhwId`, `zoneId`, etc.

Other differences include (but are not limited to):

- namespace is refactored (simpler), and attrs are `snake_case` rather than `camelCase`
- all datetimes are now TZ-aware internally, and exposed as such
- can import schedule JSON by name as well as by zone/dhw id
- newer API exposes a **TokenManager** class (for authentication) and an **Auth** class (for authorization)
- older API exposes a **SessionManager** (for authentication) and an **Auth** class (for authorization)
- exceptions are parochial (e.g. `AuthenticationFailedError`) rather than generic (`TypeError`)
- improved logging: better error messages when things do go wrong
- additional logging: e.g. logs a warning for any active faults
- is now fully typed, including TypedDicts and py.typed
- uses best of class linting/typing via **ruff**/**mypy**
- more extensive testing via **pytest**
- (WIP) extended compatibility beyond pure evohome systems (e.g. VisionPro)

> **TIP:** the non-async documentation (from **evohome-client**) is available at <http://evohome-client.readthedocs.org/en/latest/>

---

## Development

### Prerequisites

- Python 3.13.2+ (on *nix recommended, use WSL on Windows)
- [uv](https://docs.astral.sh/uv/) (recommended) or pip

### Setup

Clone the repository and set up your development environment (using uv):

```bash
git clone https://github.com/zxdavb/evohome-async
cd evohome-async

# Create virtual environment and install dependencies
uv venv --python 3.13  # or: python3.13 -m venv venv
source .venv/bin/activate

uv pip install -e '.[cli,dev]'

prek install  # install pre-commit git hooks
```

#### Running tests and linting

```bash
# Run linting
ruff check .
ruff format --check .

# Run type checking
mypy

# Run tests
pytest --cov=src --cov-report=term-missing  # --log-cli-level=DEBUG

# Run pre-commit hooks (includes ruff)
prek run --all-files
```
