Skip to main content

An async Python client for connecting to the Evohome webservice

Project description

evohome-async

Build status: CircleCI

Python client to asynchronously access the Total Connect Comfort RESTful API.

It is a faithful port of https://github.com/watchforstock/evohome-client, which is not async-aware.

It provides support for Evohome and the Round Thermostat. It supports only EU/EMEA-based systems, please use somecomfort for US-based systems.

This client uses the aiohttp library. If you prefer a non-async client, evohome-client uses requests instead.

Provides Evohome support for Home Assistant (and other automation platforms), see https://www.home-assistant.io/integrations/evohome

Documentation (from evohomeclient) is available at http://evohome-client.readthedocs.org/en/latest/

Differences from non-async version

Note that this library is not intended to expose more functionality than it's non-async cousin, other than asyncio.

The difference between the evohomeasync and evohomeclient libraries have been keep to the minimum, and it is planned for exisiting docs to be useful. Thus, it should be relatively easy to port your code over to this async library should you wish.

Currently, only evohomeclient2 has been fully tested, and evohomeclient (the older API) is a WIP has not been fully tested.

Technical differences

In both cases (evohomeclient2 and evohomeclient):

  • uses aiohttp instead of requests:
  • most instantiation arguments (except for username, password) are now kwargs
  • added a new instantiation argument, session to allow the client to utilize the consumer's 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
  • need to add a call await client.login() after initialising
  • Exceptions have changed... requests.ConnectionError becomes: aiohttp.ClientConnectionError requests.HTTPError becomes aiohttp.ClientResponseError

For the older evohome API (evohomeclient):

  • import evohomeasync instead of import evohomeclient
  • Exceptions change similar to the above

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

evohome-async-0.3.8.tar.gz (10.5 kB view details)

Uploaded Source

Built Distribution

evohome_async-0.3.8-py3-none-any.whl (18.0 kB view details)

Uploaded Python 3

File details

Details for the file evohome-async-0.3.8.tar.gz.

File metadata

  • Download URL: evohome-async-0.3.8.tar.gz
  • Upload date:
  • Size: 10.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.8.0 tqdm/4.59.0 CPython/3.7.5

File hashes

Hashes for evohome-async-0.3.8.tar.gz
Algorithm Hash digest
SHA256 006ac3cf5e71d07c2b052e45b6459fd53c121e52c329d1fda41a693d7fb8ff1f
MD5 7f247b681b7349aaed9334a1b7c7b8f7
BLAKE2b-256 87cf8779236cd80a72fa78707880723f5a65f27a2d5edc6c2e9912532f3a106e

See more details on using hashes here.

Provenance

File details

Details for the file evohome_async-0.3.8-py3-none-any.whl.

File metadata

  • Download URL: evohome_async-0.3.8-py3-none-any.whl
  • Upload date:
  • Size: 18.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.8.0 tqdm/4.59.0 CPython/3.7.5

File hashes

Hashes for evohome_async-0.3.8-py3-none-any.whl
Algorithm Hash digest
SHA256 a520300c8285c227da001a534efa514263c56d4f1b3a49189a62d9e53b2d15f6
MD5 a3ac6663441b61c7002b6186a306fb6c
BLAKE2b-256 0dbbc8d86e41d09d19847566ef8552fa07500876031ec6eee87e3c1469c88d5b

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page