Add functionality for websocket listening

rhasspyclient/__init__.py

@@ -25,10 +25,15 @@
 class RhasspyClient:
     """Client object for remote Rhasspy server."""
 
-    def __init__(self, api_url: str, session: aiohttp.ClientSession):
-        self.api_url = api_url
-        if not self.api_url.endswith("/"):
-            self.api_url += "/"
+    def __init__(
+        self, HOST: str, PORT: str, session: aiohttp.ClientSession, secure: bool = False
+    ):
+        if secure:
+            self.api_url = "https://{}:{}/api/".format(HOST, PORT)
+            self.events_url = "wss://{}:{}/api/events/".format(HOST, PORT)
+        else:
+            self.api_url = "http://{}:{}/api/".format(HOST, PORT)
+            self.events_url = "ws://{}:{}/api/events/".format(HOST, PORT)
 
         # Construct URLs for end-points
         self.sentences_url = urljoin(self.api_url, "sentences")
@@ -44,6 +49,10 @@ def __init__(self, api_url: str, session: aiohttp.ClientSession):
         self.lookup_url = urljoin(self.api_url, "lookup")
         self.version_url = urljoin(self.api_url, "version")
 
+        self.intent_listen_url = urljoin(self.events_url, "intent")
+        self.wake_listen_url = urljoin(self.events_url, "wake")
+        self.speech_listen_url = urljoin(self.events_url, "text")
+
         self.session = session
         assert self.session is not None, "ClientSession is required"
 
@@ -296,3 +305,40 @@ async def stream_to_text(self, raw_stream: aiohttp.StreamReader) -> str:
         ) as response:
             response.raise_for_status()
             return await response.text()
+
+    # -------------------------------------------------------------------------
+    async def listen_for_intent(self, handler, **handlerargs) -> None:
+        """Given a handler function at startup handles the intents as they arrive"""
+        async with self.session.ws_connect(self.intent_listen_url) as ws:
+            async for msg in ws:
+                if msg.type in (aiohttp.WSMsgType.CLOSED, aiohttp.WSMsgType.ERROR):
+                    break
+
+                if handlerargs:
+                    handler(msg, handlerargs)
+                else:
+                    handler(msg)
+
+    async def listen_for_speech(self, handler, **handlerargs) -> None:
+        """Given a handler function at startup handles the transcribed text as it arrives"""
+        async with self.session.ws_connect(self.speech_listen_url) as ws:
+            async for msg in ws:
+                if msg.type in (aiohttp.WSMsgType.CLOSED, aiohttp.WSMsgType.ERROR):
+                    break
+
+                if handlerargs:
+                    handler(msg, handlerargs)
+                else:
+                    handler(msg)
+
+    async def listen_for_wake(self, handler, **handlerargs) -> None:
+        """Given a handler function at startup, handles when a wakeword is heard"""
+        async with self.session.ws_connect(self.wake_listen_url) as ws:
+            async for msg in ws:
+                if msg.type in (aiohttp.WSMsgType.CLOSED, aiohttp.WSMsgType.ERROR):
+                    break
+
+                if handlerargs:
+                    handler(msg, handlerargs)
+                else:
+                    handler(msg)

rhasspyclient/__main__.py

@@ -29,9 +29,12 @@ async def main():
         "--debug", action="store_true", help="Print DEBUG messages to console"
     )
     parser.add_argument(
-        "--api-url",
-        default="http://localhost:12101/api",
-        help="URL of Rhasspy server (with /api)",
+        "--api-host",
+        default="localhost",
+        help="Host where the Rhasspy API can be found",
+    )
+    parser.add_argument(
+        "--api-port", default="12101", help="Port where Rhasspy is exposed"
     )
 
     sub_parsers = parser.add_subparsers()
@@ -105,7 +108,7 @@ async def main():
 
     # Begin client session
     async with aiohttp.ClientSession() as session:
-        client = RhasspyClient(args.api_url, session)
+        client = RhasspyClient(args.api_host, args.api_port, session)
 
         # Call sub-commmand
         await args.func(args, client)