1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344
|
"""Service presentation for a single endpoint (e.g. audio or avContent)."""
import logging
from typing import List
import aiohttp
from songpal.common import ProtocolType, SongpalException
from songpal.method import Method, MethodSignature
from songpal.notification import (
ContentChange,
Notification,
NotificationChange,
PlaybackFunctionChange,
PowerChange,
SettingChange,
SoftwareUpdateChange,
StorageChange,
VolumeChange,
ZoneActivatedChange,
)
_LOGGER = logging.getLogger(__name__)
class Service:
"""Service presents an endpoint providing a set of methods."""
def __init__(self, name, endpoint, protocol, idgen, debug=0):
"""Service constructor.
Do not call this directly, but use :func:from_payload:
"""
self.name = name
self.endpoint = endpoint
self.active_protocol = protocol
self.idgen = idgen
self._protocols = []
self._notifications = []
self.debug = debug
self.timeout = 2
self.listening = False
@staticmethod
async def fetch_signatures(endpoint, protocol, idgen):
"""Request available methods for the service."""
async with aiohttp.ClientSession() as session:
req = {
"method": "getMethodTypes",
"params": [""],
"version": "1.0",
"id": next(idgen),
}
if protocol == ProtocolType.WebSocket:
async with session.ws_connect(endpoint, timeout=2) as s:
await s.send_json(req)
res = await s.receive_json()
return res
else:
res = await session.post(endpoint, json=req)
json = await res.json(content_type=None)
return json
@classmethod
async def from_payload(cls, payload, endpoint, idgen, debug, force_protocol=None):
"""Create Service object from a payload."""
service_name = payload["service"]
if "protocols" not in payload:
raise SongpalException(
"Unable to find protocols from payload: %s" % payload
)
protocols = payload["protocols"]
_LOGGER.debug("Available protocols for %s: %s", service_name, protocols)
if force_protocol and force_protocol.value in protocols:
protocol = force_protocol
elif "websocket:jsonizer" in protocols:
protocol = ProtocolType.WebSocket
elif "xhrpost:jsonizer" in protocols:
protocol = ProtocolType.XHRPost
else:
raise SongpalException(
f"No known protocols for {service_name}, got: {protocols}"
)
_LOGGER.debug("Using protocol: %s", protocol)
service_endpoint = f"{endpoint}/{service_name}"
# creation here we want to pass the created service class to methods.
service = cls(service_name, service_endpoint, protocol, idgen, debug)
sigs = await cls.fetch_signatures(service_endpoint, protocol, idgen)
if debug > 1:
_LOGGER.debug("Signatures: %s", sigs)
if "error" in sigs:
_LOGGER.error("Got error when fetching sigs: %s", sigs["error"])
return None
methods = {}
for sig in sigs["results"]:
name = sig[0]
version = sig[3]
parsed_sig = MethodSignature.from_payload(*sig)
if name in methods:
methods[name].signatures[version] = parsed_sig
else:
methods[name] = Method(service, parsed_sig, debug)
# Populate supported versions for method if available
for api in payload["apis"]:
for v in api["versions"]:
if api["name"] in methods:
methods[api["name"]].add_supported_version(v["version"])
else:
_LOGGER.info(
"No matching method %s for supported version %s.",
api["name"],
v["version"],
)
service.methods = methods
if "notifications" in payload and "switchNotifications" in methods:
notifications = [
Notification(
service_endpoint, methods["switchNotifications"], notification
)
for notification in payload["notifications"]
]
service.notifications = notifications
_LOGGER.debug("Got notifications: %s", notifications)
return service
async def call_method(self, method: Method, *args, **kwargs):
"""Call a method (internal).
This is an internal implementation, which formats the parameters if necessary
and chooses the preferred transport protocol.
The return values are JSON objects.
Use :func:__call__: provides external API leveraging this.
"""
_LOGGER.debug(
"%s version %s got called with args (%s) kwargs (%s)",
method.name,
method.version,
args,
kwargs,
)
# Used for allowing keeping reading from the socket
_consumer = None
if "_consumer" in kwargs:
if self.active_protocol != ProtocolType.WebSocket:
raise SongpalException(
"Notifications are only supported over websockets"
)
_consumer = kwargs["_consumer"]
del kwargs["_consumer"]
if len(kwargs) == 0 and len(args) == 0:
params = [] # params need to be empty array, if none is given
elif len(kwargs) > 0:
params = [kwargs]
elif len(args) == 1 and args[0] is not None:
params = [args[0]]
else:
params = []
# Log that device supports newer method version than being used.
if method.latest_supported_version != method.version:
_LOGGER.debug(
"Device supports method %s version %s, but is using version %s!",
method.name,
method.latest_supported_version,
method.version,
)
# TODO check for type correctness
# TODO note parameters are not always necessary, see getPlaybackModeSettings
# which has 'target' and 'uri' but works just fine without anything (wildcard)
# if len(params) != len(method.inputs):
# _LOGGER.error(f"args: {args} signature: {method.inputs}")
# raise Exception(
# "Invalid number of inputs, wanted %s got %s / %s"
# % (len(method.inputs), len(args), len(kwargs))
# )
async with aiohttp.ClientSession() as session:
req = {
"method": method.name,
"params": params,
"version": method.version,
"id": next(self.idgen),
}
if self.debug > 1:
_LOGGER.debug(
"sending request: %s (proto: %s)", req, self.active_protocol
)
if self.active_protocol == ProtocolType.WebSocket:
async with session.ws_connect(
self.endpoint, timeout=self.timeout, heartbeat=self.timeout * 5
) as s:
await s.send_json(req)
# If we have a consumer, we are going to loop forever while
# emiting the incoming payloads to e.g. notification handler.
if _consumer is not None:
self.listening = True
while self.listening:
res_raw = await s.receive_json()
res = self.wrap_notification(res_raw)
_LOGGER.debug("Got notification: %s", res)
if self.debug > 1:
_LOGGER.debug("Got notification raw: %s", res_raw)
await _consumer(res)
res = await s.receive_json()
return res
else:
res = await session.post(self.endpoint, json=req)
return await res.json(content_type=None)
def wrap_notification(self, data):
"""Convert notification JSON to a notification class."""
notification_to_handler = {
"notifyPowerStatus": PowerChange,
"notifyExternalTerminalStatus": ZoneActivatedChange,
"notifyVolumeInformation": VolumeChange,
"notifyPlayingContentInfo": ContentChange,
"notifySettingsUpdate": SettingChange,
"notifySWUpdateInfo": SoftwareUpdateChange,
"notifyAvailablePlaybackFunction": PlaybackFunctionChange,
"notifyStorageStatus": StorageChange,
}
if "method" in data:
method = data["method"]
params = data["params"]
change = params[0]
if method not in notification_to_handler:
_LOGGER.warning(
"Got unknown notification type: %s - params: %s", method, params
)
return
return notification_to_handler[method].make(**change)
elif "result" in data:
result = data["result"][0]
if "enabled" in result and "enabled" in result:
return NotificationChange(**result)
else:
_LOGGER.warning("Unknown notification, returning raw: %s", data)
return data
def __getitem__(self, item) -> Method:
"""Return a method for the given name.
Example:
if "setPowerStatus" in system_service:
system_service["setPowerStatus"](status="off")
Raises SongpalException if the method does not exist.
"""
if item not in self._methods:
raise SongpalException(f"{self} does not contain method {item}")
return self._methods[item]
@property
def methods(self) -> List[Method]:
"""List of methods implemented in this service."""
return self._methods.values()
@methods.setter
def methods(self, methods):
self._methods = methods
@property
def protocols(self):
"""Protocols supported by this service."""
return self._protocols
@protocols.setter
def protocols(self, protocols):
self._protocols = protocols
@property
def notifications(self) -> List[Notification]:
"""List of notifications exposed by this service."""
return self._notifications
@notifications.setter
def notifications(self, notifications):
self._notifications = notifications
async def listen_all_notifications(self, callback):
"""Enable all exposed notifications.
Use :meth:`stop_listen_notifications` to quit the listening loop.
:param callback: Callback to call when a notification is received.
"""
everything = [noti.asdict() for noti in self.notifications]
if len(everything) > 0:
await self._methods["switchNotifications"](
{"enabled": everything}, _consumer=callback
)
else:
_LOGGER.debug("No notifications available for %s", self.name)
async def stop_listen_notifications(self):
"""Stop listening for notifications.
Calling this will set a flag to inform the notification loop to stop listening.
"""
_LOGGER.debug("Stop listening on %s", self.name)
self.listening = False
def asdict(self):
"""Return dict presentation of this service.
Useful for dumping the device information into JSON.
"""
return {
"methods": {m.name: m.asdict() for m in self.methods},
"protocols": self.protocols,
"notifications": {n.name: n.asdict() for n in self.notifications},
}
def __repr__(self):
return "<Service {}: {} methods, {} notifications, protocols: {} (active: {})".format( # noqa: E501
self.name,
len(self.methods),
len(self.notifications),
self.protocols,
self.active_protocol,
)
|