Add exception-handling and additional logging for the connection port

Author: strohganoff

streamdeck/__main__.py

@@ -54,6 +54,8 @@ def main(
     # a child logger with `logging.getLogger("streamdeck.mycomponent")`, all with the same handler/formatter configuration.
     configure_streamdeck_logger(name="streamdeck", plugin_uuid=plugin_uuid)
 
+    logger.info("Stream Deck listening to plugin UUID '%s' on port %d", plugin_uuid, port)
+
     if debug_port:
         setup_debug_mode(debug_port)
 

streamdeck/websocket.py

@@ -59,8 +59,9 @@ def listen(self) -> Generator[str | bytes, Any, None]:
                 message: str | bytes = self._client.recv()
                 yield message
 
-        except ConnectionClosedOK:
+        except ConnectionClosedOK as exc:
             logger.debug("Connection was closed normally, stopping the client.")
+            logger.exception(dir(exc))
 
         except ConnectionClosed:
             logger.exception("Connection was closed with an error.")
@@ -70,7 +71,11 @@ def listen(self) -> Generator[str | bytes, Any, None]:
 
     def start(self) -> None:
         """Start the connection to the websocket server."""
-        self._client = connect(uri=f"ws://localhost:{self._port}")
+        try:
+            self._client = connect(uri=f"ws://localhost:{self._port}")
+        except ConnectionRefusedError:
+            logger.exception("Failed to connect to the WebSocket server. Make sure the Stream Deck software is running.")
+            raise
 
     def stop(self) -> None:
         """Close the WebSocket connection, if open."""