Skip to main content

API Wrapper for Lennox S30 Cloud API

Project description

PyPI - lennoxs30api

pip install lennoxs30api

API Wrapper for www.lennoxicomfort.com

By Pete Rager

This asyncio module connects to the Lennox Cloud API to retrieve data from S30 / E30 thermostats. This API does not work for older models that use a different API. Those models are supported by this project: https://github.com/thevoltagesource/myicomfort

Prerequistes:

  1. Python version 3.8.6 or later

  2. A Lennox sign-on (email address and password)

  3. You may need to install aiohttp https://docs.aiohttp.org/en/stable/

Sample program Instructions:

  1. Grab the repo

  2. Edit the test_async.py program to supply the following

    LOG_PATH = '/home/pete/lennoxs30api' # Directoy to stash the log file in

    EMAIL_ADDRESS = 'myemail@myemail.com'

    PASSWORD = 'mypassword'

Command Line Program Instructions:

The command line program uses asyncio and runs 3 different tasks

  • Task 1 (runner) - this task connects to the cloud API and periodically polls it at a 10 second interval

  • Task 2 (poller) - this task runs on a 15 second interval and prints out information from all active Zones

  • Task 3 (prompt) - this task reads from the command line and executes commands on behalf of the user to enabling API testing. Cmd List

      cool, heat, off - sets the HVAC mode to cool, heat or off.  usage - just type the word followed by enter eg cool
    
      auto, on, circulate - sets the Fan mocde to auto, on, or ciruclate
    
      csp <TempF> - sets the cool setpoint in F.  example  csp 76
    
      hsp <TempF> - sets the heat setpoint in F.  example hsp 65
    

To exit the program hit crtl-c

Reporting Bugs

Please enabled debug logging when reporting bugs and provide sample code. Do not publicly post the debug logs as they contain Personally Identifiable Information that is part of the communication protocol. Your password IS NOT in the logs, but other information such as email, home address, etc., that is part of the lennox communications is.

Enhancements

Submit enhancement requests as issues or better yet send a pull request.

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

lennoxs30api-0.0.6.tar.gz (20.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

lennoxs30api-0.0.6-py3-none-any.whl (21.0 kB view details)

Uploaded Python 3

File details

Details for the file lennoxs30api-0.0.6.tar.gz.

File metadata

  • Download URL: lennoxs30api-0.0.6.tar.gz
  • Upload date:
  • Size: 20.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.8.6

File hashes

Hashes for lennoxs30api-0.0.6.tar.gz
Algorithm Hash digest
SHA256 ca7362d5bd464b2f107e8bedbaea9dc61e8cd9dccc79bff8ab3560238aefbe8b
MD5 2fb858eda46abd9bd7eccc9482c70a38
BLAKE2b-256 3c7465ac04a798fb1e92552beaf5ba094f38969f89c9ab8b00f9da3a880af51e

See more details on using hashes here.

File details

Details for the file lennoxs30api-0.0.6-py3-none-any.whl.

File metadata

  • Download URL: lennoxs30api-0.0.6-py3-none-any.whl
  • Upload date:
  • Size: 21.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.8.6

File hashes

Hashes for lennoxs30api-0.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 61faaff111e76d8ab3cab305b5467645784d41c3eae7ccf82a9c0ff5851683f0
MD5 9cb45e6a7e280cd4b7d499a6729fa31a
BLAKE2b-256 15a709770c49ac10ccc707a7d6257766b289bca9003a79cc1ab3a4d3ce099c0f

See more details on using hashes here.

Supported by

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