lennoxs30api 0.0.3__tar.gz

lennoxS30api-0.0.3/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Jacob Southard
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

lennoxS30api-0.0.3/PKG-INFO

@@ -0,0 +1,77 @@
+Metadata-Version: 2.1
+Name: lennoxS30api
+Version: 0.0.3
+Summary: API Wrapper for Lennox 30 Cloud
+Home-page: https://github.com/thevoltagesource/myicomfort
+Author: Pete Sage
+Author-email: pete.saged@icloud.com
+License: UNKNOWN
+Platform: UNKNOWN
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# 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
+
+
+
+

lennoxS30api-0.0.3/README.md

@@ -0,0 +1,60 @@
+# 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
+
+

lennoxS30api-0.0.3/lennoxS30api.egg-info/PKG-INFO

@@ -0,0 +1,77 @@
+Metadata-Version: 2.1
+Name: lennoxS30api
+Version: 0.0.3
+Summary: API Wrapper for Lennox 30 Cloud
+Home-page: https://github.com/thevoltagesource/myicomfort
+Author: Pete Sage
+Author-email: pete.saged@icloud.com
+License: UNKNOWN
+Platform: UNKNOWN
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# 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
+
+
+
+

lennoxS30api-0.0.3/lennoxS30api.egg-info/SOURCES.txt

@@ -0,0 +1,15 @@
+LICENSE
+README.md
+setup.py
+lennoxS30api.egg-info/PKG-INFO
+lennoxS30api.egg-info/SOURCES.txt
+lennoxS30api.egg-info/dependency_links.txt
+lennoxS30api.egg-info/requires.txt
+lennoxS30api.egg-info/top_level.txt
+lennoxs30api/__init__.py
+lennoxs30api/lennox_home.py
+lennoxs30api/lennox_period.py
+lennoxs30api/lennox_schedule.py
+lennoxs30api/metrics.py
+lennoxs30api/s30api_async.py
+lennoxs30api/s30exception.py

lennoxS30api-0.0.3/lennoxS30api.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

lennoxS30api-0.0.3/lennoxS30api.egg-info/requires.txt

@@ -0,0 +1 @@
+aiohttp

lennoxS30api-0.0.3/lennoxS30api.egg-info/top_level.txt

@@ -0,0 +1 @@
+lennoxs30api

lennoxS30api-0.0.3/lennoxs30api/__init__.py

@@ -0,0 +1,6 @@
+from .lennox_home import *
+from .lennox_period import *
+from .lennox_schedule import *
+from .s30exception import *
+from .s30api_async import *
+

lennoxS30api-0.0.3/lennoxs30api/lennox_home.py

@@ -0,0 +1,20 @@
+import logging
+import json
+
+_LOGGER = logging.getLogger(__name__)
+
+class lennox_home(object):
+
+
+    def __init__(self, homeId:int):
+        self.id:int = homeId
+        self.idx: int = None
+        self.name: str = None
+        self.json: json = None
+        _LOGGER.info(f"Creating lennox_home  homeId [{self.id}]") 
+
+    def update(self, homeIdx:int, homeName:str, json:json) -> None:
+        self.idx = homeIdx
+        self.name = homeName
+        self.json = json
+        _LOGGER.info(f"Updating lennox_home homeIdx [{str(self.idx)} homeId [{self.id}] homeName [{self.name}] json [{str(json)}]") 

lennoxS30api-0.0.3/lennoxs30api/lennox_period.py

@@ -0,0 +1,46 @@
+class lennox_period(object):
+    def __init__(self, id):
+        self.id = id
+        self.enabled = False
+        self.startTime = None
+        self.systemMode = None
+        self.hsp = None
+        self.hspC = None
+        self.csp = None
+        self.cspC = None
+        self.sp = None
+        self.spC = None
+        self.humidityMode = None
+        self.husp = None
+        self.desp = None
+        self.fanMode = None
+
+    def update(self, periods):
+        if 'enabled' in periods:
+            self.enabled = periods['enabled']
+        if 'period' in periods:
+            period = periods['period']
+            if 'startTime' in period:
+                self.startTime = period['startTime']
+            if 'systemMode' in period:
+                self.systemMode = period['systemMode']
+            if 'hsp' in period:
+                self.hsp = period['hsp']
+            if 'hspC' in period:
+                self.hspC = period['hspC']
+            if 'csp' in period:
+                self.csp = period['csp']
+            if 'cspC' in period:
+                self.cspC = period['cspC']
+            if 'sp' in period:
+                self.sp = period['sp']
+            if 'spC' in period:
+                self.spC = period['spC']
+            if 'humidityMode' in period:
+                self.humidityMode = period['humidityMode']
+            if 'husp' in period:
+                self.husp = period['husp']
+            if 'desp' in period:
+                self.desp = period['desp']
+            if 'fanMode' in period:
+                self.fanMode = period['fanMode']

lennoxS30api-0.0.3/lennoxs30api/lennox_schedule.py

@@ -0,0 +1,36 @@
+from .lennox_period import lennox_period
+
+class lennox_schedule(object):
+    def __init__(self, id):
+        self.id = id
+        self.name = '<Unknown>'
+        self.periodCount = -1
+        self._periods = []
+
+    def getOrCreatePeriod(self, id):
+        item = self.getPeriod(id)
+        if item != None:
+            return item
+        item = lennox_period(id)
+        self._periods.append(item)
+        return item
+
+    def getPeriod(self, id):
+        for item in self._periods:
+            if item.id == id:
+                return item
+        return None
+
+    def update(self, tschedule):
+        if 'schedule' not in tschedule:
+            return
+        schedule = tschedule['schedule']
+        if 'name' in schedule:
+            self.name = schedule['name']
+        if 'periodCount' in schedule:
+            self.periodCount = schedule['periodCount']
+        if 'periods' in schedule:
+            for periods in schedule['periods']:
+                periodId = periods['id']
+                lperiod = self.getOrCreatePeriod(periodId)
+                lperiod.update(periods)

lennoxS30api-0.0.3/lennoxs30api/metrics.py

@@ -0,0 +1,88 @@
+from datetime import datetime
+
+class Metrics:
+    def __init__(self):
+        self.error_count: int = 0
+
+        self.message_count: int = 0
+        self.receive_count: int = 0
+        self.send_count: int = 0
+
+        self.http_2xx_cnt: int  = 0
+        self.http_4xx_cnt: int = 0
+        self.http_5xx_cnt: int = 0
+
+        self.last_receive_time: datetime = None
+        self.last_send_time: datetime = None
+        self.last_error_time: datetime = None
+        self.last_reconnect_time: datetime = None
+        self.last_message_time: datetime = None
+        self.last_metric_time: datetime = None
+
+        self.bytes_in: int = 0
+        self.bytes_out: int = 0
+
+    def getMetricList(self):
+        return(
+            { 
+            "message_count" : self.message_count,
+            "send_count" : self.send_count,
+            "receive_count" : self.receive_count,
+            "bytes_in" : self.bytes_in,
+            "bytes_out" : self.bytes_out,
+            "error_count" : self.error_count,
+            "http_2xx_cnt" : self.http_2xx_cnt,
+            "http_4xx_cnt" : self.http_4xx_cnt,
+            "http_5xx_cnt" : self.http_5xx_cnt,
+            "last_receive_time" : self.last_receive_time,
+            "last_error_time" : self.last_error_time,
+            "last_reconnect_time" : self.last_reconnect_time,
+            "last_message_time" : self.last_message_time,
+            }
+        )
+
+    def inc_message_count(self) -> None:
+        self.message_count += 1
+        self.last_message_time = datetime.now()
+        self.last_metric_time = datetime.now()
+
+
+    def inc_send_count(self, bytes: int) -> None:
+        self.send_count += 1
+        self.last_send_time = datetime.now()
+        self.last_metric_time = datetime.now()
+        self.bytes_out += bytes
+
+    def inc_receive_count(self) -> None:
+        self.receive_count += 1
+        self.last_receive_time = datetime.now()
+        self.last_metric_time = datetime.now()
+
+    def inc_receive_bytes(self, bytes: int) -> None:
+        if bytes != None:
+            self.bytes_in += bytes
+
+    def inc_receive_message_error(self) -> None:
+        self.receive_message_error += 1
+        self.last_error_time = datetime.now()
+        self.last_metric_time = datetime.now()
+        self.error_count += 1
+
+    def process_http_code(self, http_code:int) -> None:
+        self.last_metric_time = datetime.now()
+        if http_code >= 200 and http_code <= 299:
+            self.http_2xx_cnt += 1
+            return
+        
+        self.error_count += 1
+        if http_code >= 400 and http_code <= 499:
+            self.http_4xx_cnt += 1
+            self.error_count += 1
+        elif http_code >= 500 and http_code <= 599:
+            self.http_5xx_cnt += 1
+            self.error_count += 1
+        
+        self.last_error_time = datetime.now()
+
+ 
+