An asyncio Python client to access the Evohome web service
APACHE-2.0 License
Python client to asynchronously access the Total Connect Comfort RESTful API.
It is intended to be a faithful port of https://github.com/watchforstock/evohome-client, but async-aware. That is, it exposes a superset of the evohome-client schema (same namespace, same JSON), but with some notable differences between the two (see below).
It provides support for Honeywell/Resideo TCC-based systems, such as Evohome, Round Thermostat, VisonPro and others:
This client requires the aiohttp library. If you prefer a non-async client, evohome-client uses requests instead.
Please contact me (e.g. open an issue) if you would like to help extending the functionality of evohome-async to include cooling, as support for such is minimal currently.
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 [email protected] -p password get-schedules --loc-idx 2 > schedules.json
... and to restore:
python client.py -u [email protected] -p password set-schedules --loc-idx 2 -f schedules.json
To avoid exceeding the vendor's API rate limit, you can cache the access tokens via the --cache-tokens
switch.
Beware that the above switch will save your tokens to .evo-cache.tmp: this presents a security concern.
The difference between the evohomeasync and evohomeclient libraries have been kept to the minimum, and it is planned for existing docs to be useful. Thus, it should be relatively easy to port your code over to this async library should you wish.
The non-async documentation (from evohomeclient) is available at http://evohome-client.readthedocs.org/en/latest/
Some additional functionality has been added to the methods that wrap the vendor APIs (e.g. restore schedules by name, as an alternative to by id). Note that this library is not able to expose more core functionality than it's non-async cousin (i.e. they both use the same vendor API).
Note that since 0.4.0, some attributes have been renamed, and a few have been deprecated altogether (when required, an informative exception will be thrown).
In both cases (evohomeclient2
and evohomeclient
):
session
to allow the client to utilize the consumer's aiohttp session self._session = kwargs.get('session', aiohttp.ClientSession(
timeout=aiohttp.ClientTimeout(total=30)
))
For the newer evohome API (evohomeclient2):
import evohomeasync2
instead of import evohomeclient2
await client.login()
after instntiating EvohomeClient
Exceptions
have changed...requests.ConnectionError
becomes: aiohttp.ClientConnectionError
requests.HTTPError
becomes aiohttp.ClientResponseError
RateLimitExceeded
, and AuthenticationFailed
(among others)For the older evohome API (evohomeclient):
import evohomeasync
instead of import evohomeclient
Other minor changes:
Hotwater.zoneId
is deprecated (can use .dhwId
, or _id
)ZoneBase.zone_type
is deprecated (use .TYPE
))None