Skip to main content

API Wrapper for Lennox S30 Cloud API

Project description

PyPI - lennoxs30api

API Wrapper for www.lennoxicomfort.com

By Pete Sage ()

Note: I'm working on a major refactor of this module and a push to PyPI.

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

This module is currently in test and prototype mode; as such it is not recommended at this time to build an application on-top of the API, as the API may change.

This module provides a command line test program; that can be used to exercise the main functions and create diagnostic output files to futher enhance and fix issues with the API

Current state - Tested with a single Zone S30 Air Conditioning System

Known Issues - Passwords with & will not work.

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/

Install 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

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.4.tar.gz (19.2 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.4-py3-none-any.whl (20.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: lennoxs30api-0.0.4.tar.gz
  • Upload date:
  • Size: 19.2 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.4.tar.gz
Algorithm Hash digest
SHA256 c048974fe2b6a3804f5e5fd117d4c4cd5a54c16c64062b26d3a611b6a24f86c7
MD5 f907dd760ea67aee5046ddd08f0e82f4
BLAKE2b-256 5ab3c6b00eb3d2d2f15342430eb75a04437fec1708054d696a9777cf26351dcf

See more details on using hashes here.

File details

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

File metadata

  • Download URL: lennoxs30api-0.0.4-py3-none-any.whl
  • Upload date:
  • Size: 20.4 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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 222af48b2fa2a0c36abe06325d6e3bad50e6a2a9693c1940441d3d9e2dc18a59
MD5 efc70b4b481f06e25539a298d4fc646e
BLAKE2b-256 014e7261de3d9ec21656629ce74b8ebf3f77f52a3c4384acaaf60b5a8f9cf7e5

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