Raise exception when spa is unreachable

README.md

@@ -57,6 +57,12 @@ This python package follows Semantic Versioning 2.0.0
 
 ***Reminder**: Major version zero (0.y.z) is for initial development. Anything MAY change at any time. The public API SHOULD NOT be considered stable.*
 
+### 0.7.0 - 2022-07-03
+
+Raise exception when spa is unreachable
+
+**Breaking change**: Refactor return values
+
 ### 0.6.0 - 2022-07-03
 
 Handle network exceptions

intex_spa/__init__.py

@@ -1,4 +1,7 @@
 """Initialize the package."""
 
 from intex_spa.intex_spa import IntexSpa
-from intex_spa.intex_spa_status import IntexSpaStatus
+from intex_spa.intex_spa_exceptions import (
+    IntexSpaUnreachableException,
+    IntexSpaDnsException,
+)

intex_spa/intex_spa.py

@@ -1,12 +1,12 @@
 """IntexSpa"""
 import logging
-import time
 import asyncio
 import typing
 
 from .intex_spa_network_layer import IntexSpaNetworkLayer
 from .intex_spa_query import IntexSpaQuery
 from .intex_spa_status import IntexSpaStatus
+from .intex_spa_exceptions import IntexSpaUnreachableException
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -21,10 +21,6 @@ class IntexSpa:
       The network layer object for communications with intex spa wifi module
     status : IntexSpaStatus
       The status object of the spa
-    last_successful_update_ms : int
-      The millisecond timestamp of the last successful update
-    is_reachable : bool
-      Is the spa wifi module available
     """
 
     def __init__(self, address: str = "SPA_DEVICE", port: str = "8990"):
@@ -41,8 +37,6 @@ def __init__(self, address: str = "SPA_DEVICE", port: str = "8990"):
         _LOGGER.warning("Initializing IntexSpa instance")
         self.network = IntexSpaNetworkLayer(address, port)
         self.status = IntexSpaStatus()
-        self.last_successful_update_ms: int = None
-        self.is_reachable: bool = None
         self._semaphore = asyncio.Semaphore(1)
 
     async def _async_handle_intent(
@@ -112,13 +106,11 @@ async def _async_handle_intent(
                         # And update the status object with it
                         self.status = query.response_status
 
-                        # Set availability info
-                        self.last_successful_update_ms = int(time.time() * 1000)
-                        self.is_reachable = True
                     except (AssertionError,):
                         _LOGGER.info("Malformed spa response during spa querying")
                         await asyncio.sleep(2)
                         continue
+
                     except (
                         asyncio.IncompleteReadError,
                         asyncio.TimeoutError,
@@ -131,19 +123,15 @@ async def _async_handle_intent(
                         await self.network.async_force_reconnect()
                         await asyncio.sleep(2)
                         continue
+
                     else:
                         break
                 else:  # No retry has succeeded
                     _LOGGER.info("Spa is unreachable")
-                    # Set unavailability info
-                    self.is_reachable = False
                     self.status = IntexSpaStatus()
+                    raise IntexSpaUnreachableException("Spa is unreachable")
 
-        return {
-            "status": self.status,
-            "is_reachable": self.is_reachable,
-            "last_successful_update_ms": self.last_successful_update_ms,
-        }
+        return self.status
 
     async def async_update_status(self) -> IntexSpaStatus:
         """Update known status of the spa

intex_spa/intex_spa_exceptions.py

@@ -0,0 +1,9 @@
+"""IntexSpaExceptions"""
+
+
+class IntexSpaUnreachableException(Exception):
+    """Exception raised when spa is unreachable"""
+
+
+class IntexSpaDnsException(Exception):
+    """Exception raised when DNS address cannot be resolved"""

intex_spa/intex_spa_network_layer.py

@@ -1,6 +1,9 @@
 """IntexSpa"""
 import logging
 import asyncio
+import socket
+
+from .intex_spa_exceptions import IntexSpaDnsException
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -45,9 +48,19 @@ async def _async_connect(self) -> None:
             self.address,
             self.port,
         )
-        self.reader, self.writer = await asyncio.open_connection(
-            self.address, self.port
-        )
+        try:
+            self.reader, self.writer = await asyncio.open_connection(
+                self.address, self.port
+            )
+
+        except socket.gaierror as err:
+            if err.args[0] == socket.EAI_NONAME:
+                raise IntexSpaDnsException(
+                    f"Cannot resolve DNS address for {self.address}"
+                ) from err
+            else:
+                raise socket.gaierror from err
+
         _LOGGER.info(
             "TCP connection established with the spa",
         )