Skip to main content

API Wrapper for myicomfort.com

Project description

PyPI - myicomfort

API Wrapper for www.myicomfort.com

By Jacob Southard (https://github.com/thevoltagesource)
Based on the work of Jerome Avondo (https://github.com/ut666)

Read and adjust your Lennox iComfort WiFi thermostat thru the Lennox cloud API at www.myicomfort.com. You must have an existing myicomfort account and have your iComfort WiFi thermostat configured to work with the cloud service. If you can control your thermostat from your iPhone or Android you are ready to use this wrapper.

Support has been added for AirEase thermostats. AirEase is in the Lennox family and the interaction is the same, just with a different URL (www.mycomfortsync.com). A parameter has been added to the class to select the AirEase Cloud API instead of the Lennox Cloud API.

This was created primarly to provide an API for use with https://www.home-assistant.io/ but should work on any project you have in mind. For those using this in your own project, there is a get_json() method which returns the current status of the thermostat in JSON format.

Class:

myicomfort.api.Tstat (username, password, system, zone, svc, units)

  • username: your myicomfort account username
  • password: your myicomfort account password
  • system: Zero-based index of systems in your myicomfort account (default = 0)
  • zone: Zero-based index of zones for selected system (default = 0)
  • svc: String value to select 'lennox' or 'airease' API (default = 'lennox')
  • units: F = 0, C = 1, Use thermostat setting = 9 (default = 9)
Example:
from myicomfort.api import Tstat

t = Tstat('username', 'password', 0, 0, 'lennox', 0)
t.current_temperature
t.set_points((68, 75))
t.pull_status()
t.get_json()
Notes:
  • This API currently only supports manual mode (no programs) on the thermostat.
Cloud API Response Notes:
  • Pref_Temp_Units: [0='F', 1='C']
  • Operation_Mode: [0='Off', 1='Heat only', 2='Cool only', 3='Heat & Cool', 4='Emergency Heat']
  • Fan_Mode: [0='Auto', 1='On', 2='Circulate']
  • System_Status: [0='Idle', 1='Heating', 2='Cooling']
Ideas/Future:
  • Support thermostat programs
  • Set Away temps - Research if possible through cloud API
  • Support other states - dehumidify / waiting

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

myicomfort-0.5.1.tar.gz (5.9 kB view details)

Uploaded Source

Built Distribution

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

myicomfort-0.5.1-py3-none-any.whl (6.6 kB view details)

Uploaded Python 3

File details

Details for the file myicomfort-0.5.1.tar.gz.

File metadata

  • Download URL: myicomfort-0.5.1.tar.gz
  • Upload date:
  • Size: 5.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.0 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.8

File hashes

Hashes for myicomfort-0.5.1.tar.gz
Algorithm Hash digest
SHA256 33f12faf4e93f2fc02d1a2e1308a03beacbeae812fb0e0fc05f4aab7627a9a2b
MD5 efecd3b0ae141668973c73da264590aa
BLAKE2b-256 0835857dd311c557700b452e4c1d6d3f8d4b8de55c36648beb59ed9e66bc5588

See more details on using hashes here.

File details

Details for the file myicomfort-0.5.1-py3-none-any.whl.

File metadata

  • Download URL: myicomfort-0.5.1-py3-none-any.whl
  • Upload date:
  • Size: 6.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.0 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.8

File hashes

Hashes for myicomfort-0.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 065f16afbebd0c7eb0e173deae68a25d2f98f35dcf44e8468a577a820a34103f
MD5 88f9a12e50035c01c7958369d3f28ebc
BLAKE2b-256 a890ffddbd7bbdcc1be155d90e52ea1bd9f1c1337dd8968a6740b14d9e5d00de

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