emerald-hws 0.0.11__py3-none-any.whl → 0.0.13__py3-none-any.whl

emerald_hws/__init__.py

@@ -1 +1,3 @@
+from .emeraldhws import EmeraldHWS
 
+__all__ = ["EmeraldHWS"]

emerald_hws/emeraldhws.py

@@ -1,13 +1,14 @@
 import json
-import requests
-import os
 import logging
-import boto3
+import os
 import random
 import threading
 import time
-from awsiot import mqtt5_client_builder, mqtt_connection_builder
-from awscrt import mqtt5, http, auth, io
+
+import boto3
+import requests
+from awscrt import mqtt5, auth, io
+from awsiot import mqtt5_client_builder
 
 
 class EmeraldHWS():
@@ -36,7 +37,7 @@ class EmeraldHWS():
         self.password = password
         self.token = ""
         self.properties = {}
-        self.logger = logging.getLogger()
+        self.logger = logging.getLogger("emerald_hws")
         self.update_callback = update_callback
         
         # Convert minutes to seconds for internal use
@@ -45,6 +46,11 @@ class EmeraldHWS():
         self.last_message_time = None
         self.health_check_timer = None
         
+        # Connection state tracking
+        self.connection_state = "initial"  # possible states: initial, connected, failed
+        self.consecutive_failures = 0
+        self.max_backoff_seconds = 60  # Maximum backoff of 1 minute
+        
         # Ensure reasonable minimum values (e.g., at least 5 minutes for connection timeout)
         if connection_timeout_minutes < 5 and connection_timeout_minutes != 0:
             self.logger.warning("emeraldhws: Connection timeout too short, setting to minimum of 5 minutes")
@@ -146,7 +152,8 @@ class EmeraldHWS():
         """ Establishes a connection to Amazon IOT core's MQTT service
         """
 
-        cert_path = os.path.join(os.path.dirname(__file__), '__assets__', 'SFSRootCAG2.pem')
+        # Certificate path is available but not currently used in the connection
+        # os.path.join(os.path.dirname(__file__), '__assets__', 'SFSRootCAG2.pem')
         identityPoolID = self.COGNITO_IDENTITY_POOL_ID
         region = self.MQTT_HOST.split('.')[2]
         cognito_endpoint = "cognito-identity." + region + ".amazonaws.com"
@@ -214,7 +221,9 @@ class EmeraldHWS():
     def on_connection_interrupted(self, connection, error, **kwargs):
         """ Log error when MQTT is interrupted
         """
-        self.logger.debug("emeraldhws: awsiot: Connection interrupted. error: {}".format(error))
+        error_code = getattr(error, 'code', 'unknown')
+        error_name = getattr(error, 'name', 'unknown')
+        self.logger.info(f"emeraldhws: awsiot: Connection interrupted. Error: {error_name} (code: {error_code}), Message: {error}")
 
     def on_connection_resumed(self, connection, return_code, session_present, **kwargs):
         """ Log message when MQTT is resumed
@@ -225,12 +234,35 @@ class EmeraldHWS():
         """ Log message when connection succeeded
         """
         self.logger.debug("emeraldhws: awsiot: connection succeeded")
+        # Reset failure counter and update connection state
+        self.consecutive_failures = 0
+        self.connection_state = "connected"
         return
 
     def on_lifecycle_connection_failure(self, lifecycle_connection_failure: mqtt5.LifecycleConnectFailureData):
         """ Log message when connection failed
         """
-        self.logger.debug("emeraldhws: awsiot: connection failed")
+        error = lifecycle_connection_failure.error
+        error_code = getattr(error, 'code', 'unknown')
+        error_name = getattr(error, 'name', 'unknown')
+        error_message = str(error)
+        
+        # Update connection state and increment failure counter
+        self.connection_state = "failed"
+        self.consecutive_failures += 1
+        
+        # Log at INFO level since this is important for troubleshooting
+        self.logger.info(f"emeraldhws: awsiot: connection failed - Error: {error_name} (code: {error_code}), Message: {error_message}")
+        
+        # If there's a CONNACK packet available, log its details too
+        if hasattr(lifecycle_connection_failure, 'connack_packet') and lifecycle_connection_failure.connack_packet:
+            connack = lifecycle_connection_failure.connack_packet
+            reason_code = getattr(connack, 'reason_code', 'unknown')
+            reason_string = getattr(connack, 'reason_string', '')
+            if reason_string:
+                self.logger.info(f"emeraldhws: awsiot: MQTT CONNACK reason: {reason_code} - {reason_string}")
+            else:
+                self.logger.info(f"emeraldhws: awsiot: MQTT CONNACK reason code: {reason_code}")
         return
 
     def on_lifecycle_stopped(self, lifecycle_stopped_data: mqtt5.LifecycleStoppedData):
@@ -242,13 +274,22 @@ class EmeraldHWS():
     def on_lifecycle_disconnection(self, lifecycle_disconnect_data: mqtt5.LifecycleDisconnectData):
         """ Log message when disconnected
         """
-        self.logger.debug("emeraldhws: awsiot: disconnected")
+        # Extract disconnect reason if available
+        reason = "unknown reason"
+        if hasattr(lifecycle_disconnect_data, 'disconnect_packet') and lifecycle_disconnect_data.disconnect_packet:
+            reason_code = getattr(lifecycle_disconnect_data.disconnect_packet, 'reason_code', 'unknown')
+            reason_string = getattr(lifecycle_disconnect_data.disconnect_packet, 'reason_string', '')
+            reason = f"reason code: {reason_code}" + (f" - {reason_string}" if reason_string else "")
+        
+        self.logger.info(f"emeraldhws: awsiot: disconnected - {reason}")
         return
 
     def on_lifecycle_attempting_connect(self, lifecycle_attempting_connect_data: mqtt5.LifecycleAttemptingConnectData):
         """ Log message when attempting connect
         """
-        self.logger.debug("emeraldhws: awsiot: attempting to connect")
+        # Include endpoint information if available
+        endpoint = getattr(lifecycle_attempting_connect_data, 'endpoint', 'unknown')
+        self.logger.debug(f"emeraldhws: awsiot: attempting to connect to {endpoint}")
         return
         
     def check_connection_health(self):
@@ -265,6 +306,14 @@ class EmeraldHWS():
             if time_since_last_message > self.health_check_interval:
                 # This is an INFO level log because it's an important event
                 self.logger.info(f"emeraldhws: awsiot: No messages received for {minutes_since_last:.1f} minutes, reconnecting")
+                
+                # If we're in a failed state, apply exponential backoff
+                if self.connection_state == "failed" and self.consecutive_failures > 0:
+                    # Calculate backoff time with exponential increase, capped at max_backoff_seconds
+                    backoff_seconds = min(2 ** (self.consecutive_failures - 1), self.max_backoff_seconds)
+                    self.logger.info(f"emeraldhws: awsiot: Connection in failed state, applying backoff of {backoff_seconds} seconds before retry (attempt {self.consecutive_failures})")
+                    time.sleep(backoff_seconds)
+                
                 self.reconnectMQTT(reason="health_check")
             else:
                 # This is a DEBUG level log to avoid cluttering logs
@@ -288,7 +337,7 @@ class EmeraldHWS():
             for heat_pump in heat_pumps:
                 if heat_pump['id'] == id:
                     heat_pump['last_state'][key] = value
-        if self.update_callback != None:
+        if self.update_callback is not None:
             self.update_callback()
 
     def subscribeForUpdates(self, id):
@@ -305,7 +354,8 @@ class EmeraldHWS():
                         topic_filter=mqtt_topic,
                         qos=mqtt5.QoS.AT_LEAST_ONCE)]))
 
-        suback = subscribe_future.result(20)
+        # Wait for subscription to complete
+        subscribe_future.result(20)
 
     def getFullStatus(self, id):
         """ Returns a dict with the full status of the specified HWS

{emerald_hws-0.0.11.dist-info → emerald_hws-0.0.13.dist-info}/METADATA

@@ -1,19 +1,20 @@
 Metadata-Version: 2.4
 Name: emerald_hws
-Version: 0.0.11
+Version: 0.0.13
 Summary: A package to manipulate and monitor Emerald Heat Pump Hot Water Systems
 Author-email: Ross Williamson <ross@inertia.net.nz>
+License-Expression: MIT
 Project-URL: Homepage, https://github.com/ross-w/emerald_hws_py
 Project-URL: Bug Tracker, https://github.com/ross-w/emerald_hws_py/issues
 Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: boto3
-Requires-Dist: awsiotsdk
-Dynamic: license-file
+Requires-Dist: boto3<2.0.0,>=1.40.0
+Requires-Dist: awsiotsdk<2.0.0,>=1.24.0
+Requires-Dist: requests>=2.25.0
+Provides-Extra: dev
+Requires-Dist: ruff<1.0.0,>=0.12.0; extra == "dev"
 
 # emerald_hws_py
 Python package for controlling Emerald Heat Pump Hot Water Systems

emerald_hws-0.0.13.dist-info/RECORD

@@ -0,0 +1,7 @@
+emerald_hws/__init__.py,sha256=uukjQ-kiPYKWvGT3jLL6kJA1DCNAxtw4HlLKqPSypXs,61
+emerald_hws/emeraldhws.py,sha256=ZkUbQcGYlj3gkpVjAcPfX6XLsxrmEX-m0PqyIXmdmII,22105
+emerald_hws/__assets__/SFSRootCAG2.pem,sha256=hw9W0AnYrrlbcWsOewAgIl1ULEsoO57Ylu35dCjWcS4,1424
+emerald_hws-0.0.13.dist-info/METADATA,sha256=PikQFknGIWDbzc3-tUKY6ZpFHcrNXnkLcZjui_aDjPg,2534
+emerald_hws-0.0.13.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+emerald_hws-0.0.13.dist-info/top_level.txt,sha256=ZCiUmnBkDr2n4QVkTet1s_AKiGJjuz3heuCR5w5ZqLY,12
+emerald_hws-0.0.13.dist-info/RECORD,,

emerald_hws-0.0.11.dist-info/RECORD

@@ -1,8 +0,0 @@
-emerald_hws/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-emerald_hws/emeraldhws.py,sha256=h8I-bJUq7RFlveWyzNsahjdt5h7zWPdrbmCX3Q99atg,19019
-emerald_hws/__assets__/SFSRootCAG2.pem,sha256=hw9W0AnYrrlbcWsOewAgIl1ULEsoO57Ylu35dCjWcS4,1424
-emerald_hws-0.0.11.dist-info/licenses/LICENSE,sha256=zzMi56JX7OO-epbXNfe_oFW6sfZHSlO7Yxm0Oh0V014,1072
-emerald_hws-0.0.11.dist-info/METADATA,sha256=mezYMqZpFZ1RnAkWj17mQHl6c4_wqRTduE1aU5_SRZk,2472
-emerald_hws-0.0.11.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-emerald_hws-0.0.11.dist-info/top_level.txt,sha256=ZCiUmnBkDr2n4QVkTet1s_AKiGJjuz3heuCR5w5ZqLY,12
-emerald_hws-0.0.11.dist-info/RECORD,,

emerald_hws-0.0.11.dist-info/licenses/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2024 Ross Williamson
-
-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.