feat: add manual ping requests on websocket (#401)

* feat: add manual ping requests on websocket

* linting

* more linting

Author: firstof9

openevsehttp/__main__.py

@@ -240,6 +240,7 @@ def _start_listening(self):
 
         if not self._ws_listening:
             self._loop.create_task(self.websocket.listen())
+            self._loop.create_task(self.repeat(300, self.websocket.keepalive()))
             pending = asyncio.all_tasks()
             self._ws_listening = True
             try:
@@ -301,6 +302,20 @@ def ws_state(self) -> Any:
         assert self.websocket
         return self.websocket.state
 
+    async def repeat(self, interval, func, *args, **kwargs):
+        """Run func every interval seconds.
+
+        If func has not finished before *interval*, will run again
+        immediately when the previous iteration finished.
+
+        *args and **kwargs are passed as the arguments to func.
+        """
+        while True:
+            await asyncio.gather(
+                func(*args, **kwargs),
+                asyncio.sleep(interval),
+            )
+
     async def get_schedule(self) -> Union[Dict[str, str], Dict[str, Any]]:
         """Return the current schedule."""
         url = f"{self.url}schedule"

openevsehttp/websocket.py

@@ -1,6 +1,7 @@
 """Websocket class for OpenEVSE HTTP."""
 
 import asyncio
+import json
 import logging
 
 import aiohttp  # type: ignore
@@ -39,6 +40,7 @@ def __init__(
         self._state = None
         self.failed_attempts = 0
         self._error_reason = None
+        self._client = None
 
     @property
     def state(self):
@@ -74,6 +76,7 @@ async def running(self):
             ) as ws_client:
                 await OpenEVSEWebsocket.state.fset(self, STATE_CONNECTED)
                 self.failed_attempts = 0
+                self._client = ws_client
 
                 async for message in ws_client:
                     if self.state == STATE_STOPPED:
@@ -133,3 +136,16 @@ async def listen(self):
     async def close(self):
         """Close the listening websocket."""
         await OpenEVSEWebsocket.state.fset(self, STATE_STOPPED)
+
+    async def keepalive(self):
+        """Send ping requests to websocket."""
+        data = json.dumps({"ping": 1})
+        _LOGGER.debug("Sending message: %s to websocket.", data)
+        try:
+            await self._client.send_str(data)
+            _LOGGER.debug("Ping message sent.")
+        except TypeError as err:
+            _LOGGER.error("Attempt to send ping data failed: %s", err)
+        except Exception as err:  # pylint: disable=broad-exception-caught
+            _LOGGER.error("Problem sending ping request: %s", err)
+            await OpenEVSEWebsocket.state.fset(self, STATE_STOPPED)

setup.py

@@ -6,7 +6,7 @@
 
 PROJECT_DIR = Path(__file__).parent.resolve()
 README_FILE = PROJECT_DIR / "README.md"
-VERSION = "0.1.66"
+VERSION = "0.1.67"
 
 setup(
     name="python_openevse_http",