https://github.com/zxdavb/evohome-async
An asyncio Python client to access the Evohome web service
https://github.com/zxdavb/evohome-async
comfort connect evohome honeywell honeywell-evohome round thermostat total
Last synced: 7 months ago
JSON representation
An asyncio Python client to access the Evohome web service
- Host: GitHub
- URL: https://github.com/zxdavb/evohome-async
- Owner: zxdavb
- License: apache-2.0
- Created: 2019-08-18T07:09:18.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-29T13:00:58.000Z (12 months ago)
- Last Synced: 2024-10-29T15:55:16.868Z (12 months ago)
- Topics: comfort, connect, evohome, honeywell, honeywell-evohome, round, thermostat, total
- Language: Python
- Homepage: http://evohome-client.readthedocs.org/en/latest/
- Size: 897 KB
- Stars: 11
- Watchers: 3
- Forks: 13
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
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 used by the 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)
If you download the git repo you can use a basic CLI for backup/restore of schedules (incl. DHW, if any), for example:
```
python client.py -u username@gmail.com -p password get-schedules --loc-idx 2 > schedules.json
```
... and to restore:
```
python client.py -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-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, cache_file=CACHE_FILE_PATH)
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:
* 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/