emerald-hws 0.0.6__py3-none-any.whl → 0.0.8__py3-none-any.whl

emerald_hws/emeraldhws.py

@@ -4,7 +4,9 @@ import os
 import logging
 import boto3
 import random
-from AWSIoTPythonSDK.MQTTLib import AWSIoTMQTTClient
+import threading
+from awsiot import mqtt5_client_builder, mqtt_connection_builder
+from awscrt import mqtt5, http, auth, io
 
 
 class EmeraldHWS():
@@ -20,10 +22,11 @@ class EmeraldHWS():
     MQTT_HOST = "a13v32g67itvz9-ats.iot.ap-southeast-2.amazonaws.com"
     COGNITO_IDENTITY_POOL_ID = "ap-southeast-2:f5bbb02c-c00e-4f10-acb3-e7d1b05268e8"
 
-    def __init__(self, email, password):
+    def __init__(self, email, password, update_callback=None):
         """ Initialise the API client
         :param email: The email address for logging into the Emerald app
         :param password: The password for the supplied user account
+        :param update_callback: Optional callback function to be called when an update is available
         """
 
         self.email = email
@@ -31,6 +34,7 @@ class EmeraldHWS():
         self.token = ""
         self.properties = {}
         self.logger = logging.getLogger()
+        self.update_callback = update_callback
 
     def getLoginToken(self):
         """ Performs an API request to get a token from the API
@@ -72,58 +76,56 @@ class EmeraldHWS():
         post_response_json = post_response.json()
 
         if post_response_json.get("code") == 200:
-            self.logger.debug("Successfully logged into Emerald API")
+            self.logger.debug("emeraldhws: Successfully logged into Emerald API")
             self.properties = post_response_json.get("info").get("property")
         else:
             raise Exception("Unable to fetch properties from Emerald API")
 
-    def getTemporaryCreds(self):
-        """ Returns temporary credentials for IoT Core
+    def reconnectMQTT(self):
+        """ Stops an existing MQTT connection and creates a new one
         """
 
-        identityPoolID = self.COGNITO_IDENTITY_POOL_ID
-        region = self.MQTT_HOST.split('.')[2]
-        cognitoIdentityClient = boto3.client('cognito-identity', region_name=region)
-
-        temporaryIdentityId = cognitoIdentityClient.get_id(IdentityPoolId=identityPoolID)
-        identityID = temporaryIdentityId["IdentityId"]
-        self.logger.debug("AWS IoT IdentityID: {}".format(identityID))
-
-        temporaryCredentials = cognitoIdentityClient.get_credentials_for_identity(IdentityId=identityID)
-        self.logger.debug("Got new temporary credentials for AWS")
-        self.identityID = identityID
-        self.temporaryCredentials = temporaryCredentials
-
+        self.logger.debug("emeraldhws: awsiot: Tearing down and reconnecting to prevent stale connection")
+        self.mqttClient.stop()
+        self.connectMQTT()
+        self.subscribeAllHWS()
 
     def connectMQTT(self):
         """ Establishes a connection to Amazon IOT core's MQTT service
         """
 
         cert_path = os.path.join(os.path.dirname(__file__), '__assets__', 'SFSRootCAG2.pem')
-        self.getTemporaryCreds()
-
-        AccessKeyId = self.temporaryCredentials["Credentials"]["AccessKeyId"]
-        SecretKey = self.temporaryCredentials["Credentials"]["SecretKey"]
-        SessionToken = self.temporaryCredentials["Credentials"]["SessionToken"]
-
-        # Init AWSIoTMQTTClient
-        myAWSIoTMQTTClient = AWSIoTMQTTClient(self.identityID, useWebsocket=True)
-
-        # AWSIoTMQTTClient configuration
-        myAWSIoTMQTTClient.configureEndpoint(self.MQTT_HOST, 443)
-        myAWSIoTMQTTClient.configureCredentials(cert_path)
-        myAWSIoTMQTTClient.configureIAMCredentials(AccessKeyId, SecretKey, SessionToken)
-        myAWSIoTMQTTClient.configureAutoReconnectBackoffTime(1, 32, 20)
-        myAWSIoTMQTTClient.configureOfflinePublishQueueing(-1)  # Infinite offline Publish queueing
-        myAWSIoTMQTTClient.configureDrainingFrequency(2)  # Draining: 2 Hz
-        myAWSIoTMQTTClient.configureConnectDisconnectTimeout(10)  # 10 sec
-        myAWSIoTMQTTClient.configureMQTTOperationTimeout(10)  # 10 sec
-        myAWSIoTMQTTClient.onOffline = self.on_offline
-        myAWSIoTMQTTClient.onOnline = self.on_online
-        # Connect and subscribe to AWS IoT
-        myAWSIoTMQTTClient.connect(keepAliveIntervalSecond=60)
-
-        self.myAWSIoTMQTTClient = myAWSIoTMQTTClient
+        identityPoolID = self.COGNITO_IDENTITY_POOL_ID
+        region = self.MQTT_HOST.split('.')[2]
+        cognito_endpoint = "cognito-identity." + region + ".amazonaws.com"
+        cognitoIdentityClient = boto3.client('cognito-identity', region_name=region)
+
+        temporaryIdentityId = cognitoIdentityClient.get_id(IdentityPoolId=identityPoolID)
+        identityID = temporaryIdentityId["IdentityId"]
+        self.logger.debug("emeraldhws: awsiot: AWS IoT IdentityID: {}".format(identityID))
+
+        credentials_provider = auth.AwsCredentialsProvider.new_cognito(
+                endpoint=cognito_endpoint,
+                identity=identityID,
+                tls_ctx=io.ClientTlsContext(io.TlsContextOptions()))
+
+        client = mqtt5_client_builder.websockets_with_default_aws_signing(
+            endpoint = self.MQTT_HOST,
+            region = region,
+            credentials_provider = credentials_provider,
+            on_connection_interrupted = self.on_connection_interrupted,
+            on_connection_resumed = self.on_connection_resumed,
+            on_lifecycle_connection_success = self.on_lifecycle_connection_success,
+            on_lifecycle_stopped = self.on_lifecycle_stopped,
+            on_lifecycle_attempting_connect = self.on_lifecycle_attempting_connect,
+            on_lifecycle_disconnection = self.on_lifecycle_disconnection,
+            on_lifecycle_connection_failure = self.on_lifecycle_connection_failure,
+            on_publish_received = self.mqttCallback
+        )
+
+        client.start()
+        self.mqttClient = client
+        threading.Timer(43200.0, self.reconnectMQTT).start() # 12 hours
 
     def mqttDecodeUpdate(self, topic, payload):
         """ Attempt to decode a received MQTT message and direct appropriately
@@ -139,28 +141,53 @@ class EmeraldHWS():
                 for key in json_payload[1]:
                     self.updateHWSState(hws_id, key, json_payload[1][key])
 
-    def mqttCallback(self, client, userdata, message):
+    def mqttCallback(self, publish_packet_data):
         """ Calls decode update for received message
         """
+        publish_packet = publish_packet_data.publish_packet
+        assert isinstance(publish_packet, mqtt5.PublishPacket)
+        self.logger.debug("emeraldhws: awsiot: Received message from MQTT topic {}: {}".format(publish_packet.topic, publish_packet.payload))
+        self.mqttDecodeUpdate(publish_packet.topic, publish_packet.payload)
 
-        self.logger.debug("Received message from MQTT topic {}: {}".format(message.topic,message.payload.decode("utf-8")))
-        self.mqttDecodeUpdate(message.topic, message.payload)
+    def on_connection_interrupted(self, connection, error, **kwargs):
+        """ Log error when MQTT is interrupted
+        """
+        self.logger.debug("emeraldhws: awsiot: Connection interrupted. error: {}".format(error))
 
-    def on_offline(self):
-        """ Reconfigures temporary credentials
+    def on_connection_resumed(self, connection, return_code, session_present, **kwargs):
+        """ Log message when MQTT is resumed
         """
+        self.logger.debug("emeraldhws: awsiot: Connection resumed. return_code: {} session_present: {}".format(return_code, session_present))
 
-        self.logger.debug("AWS IoT offline")
-        self.getTemporaryCreds()
-        AccessKeyId = self.temporaryCredentials["Credentials"]["AccessKeyId"]
-        SecretKey = self.temporaryCredentials["Credentials"]["SecretKey"]
-        SessionToken = self.temporaryCredentials["Credentials"]["SessionToken"]
-        self.myAWSIoTMQTTClient.configureIAMCredentials(AccessKeyId, SecretKey, SessionToken)
+    def on_lifecycle_connection_success(self, lifecycle_connect_success_data: mqtt5.LifecycleConnectSuccessData):
+        """ Log message when connection succeeded
+        """
+        self.logger.debug("emeraldhws: awsiot: connection succeeded")
+        return
+
+    def on_lifecycle_connection_failure(self, lifecycle_connection_failure: mqtt5.LifecycleConnectFailureData):
+        """ Log message when connection failed
+        """
+        self.logger.debug("emeraldhws: awsiot: connection failed")
+        return
 
-    def on_online(self):
-        """ Logs online state
+    def on_lifecycle_stopped(self, lifecycle_stopped_data: mqtt5.LifecycleStoppedData):
+        """ Log message when stopped
         """
-        self.logger.debug("AWS IoT online")
+        self.logger.debug("emeraldhws: awsiot: stopped")
+        return
+
+    def on_lifecycle_disconnection(self, lifecycle_disconnect_data: mqtt5.LifecycleDisconnectData):
+        """ Log message when disconnected
+        """
+        self.logger.debug("emeraldhws: awsiot: disconnected")
+        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")
+        return
 
     def updateHWSState(self, id, key, value):
         """ Updates the specified value for the supplied key in the HWS id specified
@@ -174,17 +201,24 @@ class EmeraldHWS():
             for heat_pump in heat_pumps:
                 if heat_pump['id'] == id:
                     heat_pump['last_state'][key] = value
+        if self.update_callback != None:
+            self.update_callback()
 
     def subscribeForUpdates(self, id):
         """ Subscribes to the MQTT topics for the supplied HWS
         :param id: The UUID of the requested HWS
         """
-        if not self.myAWSIoTMQTTClient:
+        if not self.mqttClient:
             self.connectMQTT()
 
-        # self.myAWSIoTMQTTClient.subscribe("ep/heat_pump/to_gw/{}".format(id), 1, self.mqttCallback)
-        self.myAWSIoTMQTTClient.subscribe("ep/heat_pump/from_gw/{}".format(id), 1, self.mqttCallback)
-        # self.myAWSIoTMQTTClient.subscribe("ep/heat_pump/custom/topic/{}".format(id), 1, self.mqttCallback)
+        mqtt_topic = "ep/heat_pump/from_gw/{}".format(id)
+        subscribe_future = self.mqttClient.subscribe(
+                subscribe_packet=mqtt5.SubscribePacket(
+                        subscriptions=[mqtt5.Subscription(
+                        topic_filter=mqtt_topic,
+                        qos=mqtt5.QoS.AT_LEAST_ONCE)]))
+
+        suback = subscribe_future.result(20)
 
     def getFullStatus(self, id):
         """ Returns a dict with the full status of the specified HWS
@@ -221,42 +255,47 @@ class EmeraldHWS():
                },
                payload
               ]
-
-        self.myAWSIoTMQTTClient.publish("ep/heat_pump/to_gw/{}".format(id), json.dumps(msg), 1)
+        mqtt_topic = "ep/heat_pump/to_gw/{}".format(id)
+        publish_future = self.mqttClient.publish(
+                mqtt5.PublishPacket(
+                        topic=mqtt_topic,
+                        payload=json.dumps(msg),
+                        qos=mqtt5.QoS.AT_LEAST_ONCE))
+        publish_future.result(20) # 20 seconds
 
     def turnOn(self, id):
         """ Turns the specified HWS on
         :param id: The UUID of the HWS to turn on
         """
-        self.logger.debug("Sending control message: turn on")
+        self.logger.debug("emeraldhws: Sending control message: turn on")
         self.sendControlMessage(id, {"switch":1})
 
     def turnOff(self, id):
         """ Turns the specified HWS off
         :param id: The UUID of the HWS to turn off
         """
-        self.logger.debug("Sending control message: turn off")
+        self.logger.debug("emeraldhws: Sending control message: turn off")
         self.sendControlMessage(id, {"switch":0})
 
     def setNormalMode(self, id):
         """ Sets the specified HWS to normal (not Boost or Quiet) mode
         :param id: The UUID of the HWS to set to normal mode
         """
-        self.logger.debug("Sending control message: normal mode")
+        self.logger.debug("emeraldhws: Sending control message: normal mode")
         self.sendControlMessage(id, {"mode":1})
 
     def setBoostMode(self, id):
         """ Sets the specified HWS to boost (high power) mode
         :param id: The UUID of the HWS to set to boost mode
         """
-        self.logger.debug("Sending control message: boost mode")
+        self.logger.debug("emeraldhws: Sending control message: boost mode")
         self.sendControlMessage(id, {"mode":0})
 
     def setQuietMode(self, id):
         """ Sets the specified HWS to quiet (low power) mode
         :param id: The UUID of the HWS to set to quiet mode
         """
-        self.logger.debug("Sending control message: quiet mode")
+        self.logger.debug("emeraldhws: Sending control message: quiet mode")
         self.sendControlMessage(id, {"mode":2})
 
     def isOn(self, id):

{emerald_hws-0.0.6.dist-info → emerald_hws-0.0.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: emerald_hws
-Version: 0.0.6
+Version: 0.0.8
 Summary: A package to manipulate and monitor Emerald Heat Pump Hot Water Systems
 Author-email: Ross Williamson <ross@inertia.net.nz>
 Project-URL: Homepage, https://github.com/ross-w/emerald_hws_py
@@ -12,7 +12,7 @@ Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: boto3
-Requires-Dist: AWSIoTPythonSDK
+Requires-Dist: awsiotsdk
 
 # emerald_hws_py
 Python package for controlling Emerald Heat Pump Hot Water Systems

emerald_hws-0.0.8.dist-info/RECORD

@@ -0,0 +1,8 @@
+emerald_hws/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+emerald_hws/emeraldhws.py,sha256=tsTBTs0ZrBgAkvERT6FqYI8iNqFEkg4LvLijnsWp3eY,13892
+emerald_hws/__assets__/SFSRootCAG2.pem,sha256=hw9W0AnYrrlbcWsOewAgIl1ULEsoO57Ylu35dCjWcS4,1424
+emerald_hws-0.0.8.dist-info/LICENSE,sha256=zzMi56JX7OO-epbXNfe_oFW6sfZHSlO7Yxm0Oh0V014,1072
+emerald_hws-0.0.8.dist-info/METADATA,sha256=4AvoaGEg0ITTsgGTW24_mbDu83ECe-ovrE0c5VQgKms,688
+emerald_hws-0.0.8.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+emerald_hws-0.0.8.dist-info/top_level.txt,sha256=ZCiUmnBkDr2n4QVkTet1s_AKiGJjuz3heuCR5w5ZqLY,12
+emerald_hws-0.0.8.dist-info/RECORD,,

emerald_hws-0.0.6.dist-info/RECORD

@@ -1,8 +0,0 @@
-emerald_hws/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-emerald_hws/emeraldhws.py,sha256=w7iSSo9hcsk8CoQsYD89Ar-PWyzVkjnpbxd8YEXrujc,12051
-emerald_hws/__assets__/SFSRootCAG2.pem,sha256=hw9W0AnYrrlbcWsOewAgIl1ULEsoO57Ylu35dCjWcS4,1424
-emerald_hws-0.0.6.dist-info/LICENSE,sha256=zzMi56JX7OO-epbXNfe_oFW6sfZHSlO7Yxm0Oh0V014,1072
-emerald_hws-0.0.6.dist-info/METADATA,sha256=jHPA5zbpaLofBPi47Pkx0U7Jrpf9xTurvIAMuC-bh10,694
-emerald_hws-0.0.6.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-emerald_hws-0.0.6.dist-info/top_level.txt,sha256=ZCiUmnBkDr2n4QVkTet1s_AKiGJjuz3heuCR5w5ZqLY,12
-emerald_hws-0.0.6.dist-info/RECORD,,