Skip to main content

No project description provided

Project description

pyaprilaire

pyaprilaire is a library to interact with Aprilaire thermostats.

Compatibility

aprilaire-ha is generally compatible with Aprilaire Home Automation 8800-series and Zone Control 6000-series thermostats. However, due to the number of physical models, it has not been tested on all models.

Prerequisites

In order to connect to the thermostat, you will need to enable automation mode. This involves going into the Contractor Menu on your thermostat and changing the Connection Type to Automation. Please look up the instructions for your model, as this can vary between models.

Development

Mock server

During development, it is necessary to connect to a thermostat, but this can be problematic as a thermostat only allows a single connection at a time. There is a mock server that can be run to expose a local server for development that emulates a thermostat.

python -m pyaprilaire.mock_server

The port can be specified with -p PORT_NUMBER. The default port is 7001.

Caution regarding device limitations

Due to limitations of the thermostats, only one home automation connection to a device is permitted at one time (the Aprilaire app is not included in this limitation as it uses a separate protocol). Attempting to connecting multiple times to the same thermostat simultaneously can cause various issues, including the thermostat becoming unresponsive and shutting down. If this does occur, power cycling the thermostat should restore functionality.

The socket that is exposed by the thermostat can be unreliable in general. In some cases, it can silently drop the connection or otherwise stop responding. The integration handles this by quietly disconnecting and reconnecting every hour, which generally improves stability. In some cases, however, there may be periods where the change of state (COS) packets aren't received, potentially causing stale data to be shown until the connection is reset. If this happens to you frequently and you are able to capture the packets at the time via Wireshark showing the state of the socket, this data would be valuable to share.

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

pyaprilaire-0.7.4.tar.gz (19.7 kB view details)

Uploaded Source

Built Distribution

pyaprilaire-0.7.4-py3-none-any.whl (16.0 kB view details)

Uploaded Python 3

File details

Details for the file pyaprilaire-0.7.4.tar.gz.

File metadata

  • Download URL: pyaprilaire-0.7.4.tar.gz
  • Upload date:
  • Size: 19.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.19

File hashes

Hashes for pyaprilaire-0.7.4.tar.gz
Algorithm Hash digest
SHA256 de1c13d3323f5ae9361513e8e23e1a5bdaedc5a036d607beda705f4dfc9c1c99
MD5 159a528683082c7db06af45954ef3ce7
BLAKE2b-256 d51d575bd0d74dc6af9b52db65031629a2ee193516d6e347c3e43346a0ebc93f

See more details on using hashes here.

File details

Details for the file pyaprilaire-0.7.4-py3-none-any.whl.

File metadata

  • Download URL: pyaprilaire-0.7.4-py3-none-any.whl
  • Upload date:
  • Size: 16.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.19

File hashes

Hashes for pyaprilaire-0.7.4-py3-none-any.whl
Algorithm Hash digest
SHA256 f22a911f926c921676647093b3757046ba76c325f427f419a8daf8fe76a90b0a
MD5 726fb8483ec99124ecb85ce37b2ca749
BLAKE2b-256 f000b704a0c1cb05220ac57d70abda7e546d004668460d4a31330efd08376288

See more details on using hashes here.

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