Initial support for Websockets connection to Snapcast Server

README.md

@@ -3,8 +3,9 @@
 # python-snapcast
 
 Control [Snapcast](https://github.com/badaix/snapcast) in Python 3. Reads client configurations, updates clients, and receives updates from other controllers.
+The connection could be made with the json-rpc or Websockets interface. Websockets is more stable due to [issue](https://github.com/badaix/snapcast/issues/1173) in snapserver. 
 
-Supports Snapcast `0.15.0`.
+Supports Snapcast `0.15.0`, but works well with latest Snapcast `0.27.0`
 
 ## Install
 
@@ -18,7 +19,7 @@ import asyncio
 import snapcast.control
 
 loop = asyncio.get_event_loop()
-server = loop.run_until_complete(snapcast.control.create_server(loop, 'localhost'))
+server = loop.run_until_complete(snapcast.control.create_server(loop, 'localhost', port=1780, reconnect=True, use_websockets=True))
 
 # print all client names
 for client in server.clients:

setup.cfg

@@ -1,2 +1,2 @@
 [metadata]
-description-file = README.md
+description_file = README.md

setup.py

@@ -2,7 +2,7 @@
 
 setup(
     name='snapcast',
-    version='2.3.3',
+    version='2.3.6',
     description='Control Snapcast.',
     url='https://github.com/happyleavesaoc/python-snapcast/',
     license='MIT',
@@ -12,6 +12,7 @@
     install_requires=[
         'construct>=2.5.2',
         'packaging',
+        'websockets',
     ],
     classifiers=[
         'License :: OSI Approved :: MIT License',

snapcast/control/__init__.py

@@ -3,8 +3,8 @@
 from snapcast.control.server import Snapserver, CONTROL_PORT
 
 
-async def create_server(loop, host, port=CONTROL_PORT, reconnect=False):
+async def create_server(loop, host, port=CONTROL_PORT, reconnect=False, use_websockets=False):
     """Server factory."""
-    server = Snapserver(loop, host, port, reconnect)
+    server = Snapserver(loop, host, port, reconnect, use_websockets)
     await server.start()
     return server

snapcast/control/client.py

@@ -32,6 +32,7 @@ def group(self):
         for group in self._server.groups:
             if self.identifier in group.clients:
                 return group
+        return None
 
     @property
     def friendly_name(self):
@@ -162,5 +163,5 @@ def set_callback(self, func):
         self._callback_func = func
 
     def __repr__(self):
-        """String representation."""
+        """Return string representation."""
         return f'Snapclient {self.version} ({self.friendly_name}, {self.identifier})'

snapcast/control/group.py

@@ -105,8 +105,10 @@ async def set_volume(self, volume):
     @property
     def friendly_name(self):
         """Get friendly name."""
-        return self.name if self.name != '' else "+".join(
-            sorted([self._server.client(c).friendly_name for c in self.clients]))
+        fname = self.name if self.name != '' else "+".join(
+            sorted([self._server.client(c).friendly_name for c in self.clients
+                    if c in [client.identifier for client in self._server.clients]]))
+        return fname if fname != '' else self.identifier
 
     @property
     def clients(self):
@@ -122,7 +124,7 @@ async def add_client(self, client_identifier):
         new_clients.append(client_identifier)
         await self._server.group_clients(self.identifier, new_clients)
         _LOGGER.debug('added %s to %s', client_identifier, self.identifier)
-        status = await self._server.status()
+        status = (await self._server.status())[0]
         self._server.synchronize(status)
         self._server.client(client_identifier).callback()
         self.callback()
@@ -133,7 +135,7 @@ async def remove_client(self, client_identifier):
         new_clients.remove(client_identifier)
         await self._server.group_clients(self.identifier, new_clients)
         _LOGGER.debug('removed %s from %s', client_identifier, self.identifier)
-        status = await self._server.status()
+        status = (await self._server.status())[0]
         self._server.synchronize(status)
         self._server.client(client_identifier).callback()
         self.callback()
@@ -189,5 +191,5 @@ def set_callback(self, func):
         self._callback_func = func
 
     def __repr__(self):
-        """String representation."""
+        """Return string representation."""
         return f'Snapgroup ({self.friendly_name}, {self.identifier})'

snapcast/control/protocol.py

@@ -7,6 +7,7 @@
 SERVER_ONDISCONNECT = 'Server.OnDisconnect'
 
 
+# pylint: disable=consider-using-f-string
 def jsonrpc_request(method, identifier, params=None):
     """Produce a JSONRPC request."""
     return '{}\r\n'.format(json.dumps({
@@ -33,6 +34,9 @@ def connection_made(self, transport):
 
     def connection_lost(self, exc):
         """When a connection is lost."""
+        for b in self._buffer.values():
+            b['error'] = {"code": -1, "message": "connection lost"}
+            b['flag'].set()
         self._callbacks.get(SERVER_ONDISCONNECT)(exc)
 
     def data_received(self, data):
@@ -74,8 +78,8 @@ async def request(self, method, params):
         self._transport.write(jsonrpc_request(method, identifier, params))
         self._buffer[identifier] = {'flag': asyncio.Event()}
         await self._buffer[identifier]['flag'].wait()
-        result = self._buffer[identifier]['data']
-        error = self._buffer[identifier]['error']
-        del self._buffer[identifier]['data']
-        del self._buffer[identifier]['error']
+        result = self._buffer[identifier].get('data')
+        error = self._buffer[identifier].get('error')
+        self._buffer[identifier].clear()
+        del self._buffer[identifier]
         return (result, error)