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
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
|
"""
SmartGlass - Control Registered Devices
"""
from typing import List, Optional
from uuid import uuid4
from httpx import Response
from xbox.webapi.api.provider.baseprovider import BaseProvider
from xbox.webapi.api.provider.smartglass.models import (
CommandResponse,
GuideTab,
InputKeyType,
InstalledPackagesList,
OperationStatusResponse,
SmartglassConsoleList,
SmartglassConsoleStatus,
StorageDevicesList,
VolumeDirection,
)
class SmartglassProvider(BaseProvider):
SG_URL = "https://xccs.xboxlive.com"
HEADERS_SG = {
"x-xbl-contract-version": "4",
"skillplatform": "RemoteManagement",
}
def __init__(self, client):
"""
Initialize Baseclass, create smartglass session id
Args: Instance of XBL client
"""
super().__init__(client)
self._smartglass_session_id = str(uuid4())
async def get_console_list(
self, include_storage_devices: bool = True, **kwargs
) -> SmartglassConsoleList:
"""
Get Console list
Args:
include_storage_devices: Include a list of storage devices in the response
Returns: Console List
"""
params = {
"queryCurrentDevice": "false",
"includeStorageDevices": str(include_storage_devices).lower(),
}
resp = await self._fetch_list("devices", params, **kwargs)
return SmartglassConsoleList(**resp.json())
async def get_installed_apps(
self, device_id: Optional[str] = None, **kwargs
) -> InstalledPackagesList:
"""
Get Installed Apps
Args:
device_id: ID of console (from console list)
Returns: Installed Apps
"""
params = {}
if device_id:
params["deviceId"] = device_id
resp = await self._fetch_list("installedApps", params, **kwargs)
return InstalledPackagesList(**resp.json())
async def get_storage_devices(self, device_id: str, **kwargs) -> StorageDevicesList:
"""
Get Installed Apps
Args:
device_id: ID of console (from console list)
Returns: Storage Devices list
"""
params = {"deviceId": device_id}
resp = await self._fetch_list("storageDevices", params, **kwargs)
return StorageDevicesList(**resp.json())
async def get_console_status(
self, device_id: str, **kwargs
) -> SmartglassConsoleStatus:
"""
Get Console Status
Args:
device_id: ID of console (from console list)
Returns: Console Status
"""
url = f"{self.SG_URL}/consoles/{device_id}"
resp = await self.client.session.get(url, headers=self.HEADERS_SG, **kwargs)
resp.raise_for_status()
return SmartglassConsoleStatus(**resp.json())
async def get_op_status(
self, device_id: str, op_id: str, **kwargs
) -> OperationStatusResponse:
"""
Get Operation Status
Args:
device_id: ID of console (from console list)
op_id: Operation ID (from previous command)
Returns: Operation Status
"""
url = f"{self.SG_URL}/opStatus"
headers = {
"x-xbl-contract-version": "3",
"x-xbl-opId": op_id,
"x-xbl-deviceId": device_id,
}
resp = await self.client.session.get(url, headers=headers, **kwargs)
resp.raise_for_status()
return OperationStatusResponse(**resp.json())
async def wake_up(self, device_id: str, **kwargs) -> CommandResponse:
"""
Wake Up Console
Args:
device_id: ID of console (from console list)
Returns: Command Response
"""
return await self._send_one_shot_command(device_id, "Power", "WakeUp", **kwargs)
async def turn_off(self, device_id: str, **kwargs) -> CommandResponse:
"""
Turn Off Console
Args:
device_id: ID of console (from console list)
Returns: Command Response
"""
return await self._send_one_shot_command(
device_id, "Power", "TurnOff", **kwargs
)
async def reboot(self, device_id: str, **kwargs) -> CommandResponse:
"""
Reboot Console
Args:
device_id: ID of console (from console list)
Returns: Command Response
"""
return await self._send_one_shot_command(device_id, "Power", "Reboot", **kwargs)
async def mute(self, device_id: str, **kwargs) -> CommandResponse:
"""
Mute
Args:
device_id: ID of console (from console list)
Returns: Command Response
"""
return await self._send_one_shot_command(device_id, "Audio", "Mute", **kwargs)
async def unmute(self, device_id: str, **kwargs) -> CommandResponse:
"""
Unmute
Args:
device_id: ID of console (from console list)
Returns: Command Response
"""
return await self._send_one_shot_command(device_id, "Audio", "Unmute", **kwargs)
async def volume(
self, device_id: str, direction: VolumeDirection, amount: int = 1, **kwargs
) -> CommandResponse:
"""
Adjust Volume
Args:
device_id: ID of console (from console list)
Returns: Command Response
"""
params = [{"direction": direction.value, "amount": str(amount)}]
return await self._send_one_shot_command(
device_id, "Audio", "Volume", params, **kwargs
)
async def play(self, device_id: str, **kwargs) -> CommandResponse:
"""
Play (media controls)
Args:
device_id: ID of console (from console list)
Returns: Command Response
"""
return await self._send_one_shot_command(device_id, "Media", "Play", **kwargs)
async def pause(self, device_id: str, **kwargs) -> CommandResponse:
"""
Pause (media controls)
Args:
device_id: ID of console (from console list)
Returns: Command Response
"""
return await self._send_one_shot_command(device_id, "Media", "Pause", **kwargs)
async def previous(self, device_id: str, **kwargs) -> CommandResponse:
"""
Previous (media controls)
Args:
device_id: ID of console (from console list)
Returns: Command Response
"""
return await self._send_one_shot_command(
device_id, "Media", "Previous", **kwargs
)
async def next(self, device_id: str, **kwargs) -> CommandResponse:
"""
Next (media controls)
Args:
device_id: ID of console (from console list)
Returns: Command Response
"""
return await self._send_one_shot_command(device_id, "Media", "Next", **kwargs)
async def go_home(self, device_id: str, **kwargs) -> CommandResponse:
"""
Go Home
Args:
device_id: ID of console (from console list)
Returns: Command Response
"""
return await self._send_one_shot_command(device_id, "Shell", "GoHome", **kwargs)
async def go_back(self, device_id: str, **kwargs) -> CommandResponse:
"""
Go Back
Args:
device_id: ID of console (from console list)
Returns:
:class:`SmartglassConsoleStatus`: Command Response
"""
return await self._send_one_shot_command(device_id, "Shell", "GoBack", **kwargs)
async def show_guide_tab(
self, device_id: str, tab: GuideTab = GuideTab.Guide, **kwargs
) -> CommandResponse:
"""
Show Guide Tab
Args:
device_id: ID of console (from console list)
Returns: Command Response
"""
params = [{"tabName": tab.value}]
return await self._send_one_shot_command(
device_id, "Shell", "ShowGuideTab", params, **kwargs
)
async def press_button(
self, device_id: str, button: InputKeyType, **kwargs
) -> CommandResponse:
"""
Press Button
Args:
device_id: ID of console (from console list)
Returns: Command Response
"""
params = [{"keyType": button.value}]
return await self._send_one_shot_command(
device_id, "Shell", "InjectKey", params, **kwargs
)
async def insert_text(self, device_id: str, text: str, **kwargs) -> CommandResponse:
"""
Insert Text
Args:
device_id: ID of console (from console list)
Returns: Command Response
"""
params = [{"replacementString": text}]
return await self._send_one_shot_command(
device_id, "Shell", "InjectString", params, **kwargs
)
async def launch_app(
self, device_id: str, one_store_product_id: str, **kwargs
) -> CommandResponse:
"""
Launch Application
Args:
device_id: ID of console (from console list)
one_store_product_id: OneStoreProductID for the app to launch
Returns: Command Response
"""
params = [{"oneStoreProductId": one_store_product_id}]
return await self._send_one_shot_command(
device_id,
"Shell",
"ActivateApplicationWithOneStoreProductId",
params,
**kwargs,
)
async def show_tv_guide(self, device_id: str, **kwargs) -> CommandResponse:
"""
Show TV Guide
Args:
device_id: ID of console (from console list)
Returns: Command Response
"""
return await self._send_one_shot_command(device_id, "TV", "ShowGuide", **kwargs)
async def _fetch_list(
self, list_name: str, params: Optional[dict] = None, **kwargs
) -> Response:
"""
Fetch arbitrary list
Args:
list_name: name of list
params: query params
Returns:
:class:`httpx.Response`: HTTP Response
"""
url = f"{self.SG_URL}/lists/{list_name}"
resp = await self.client.session.get(
url, params=params, headers=self.HEADERS_SG, **kwargs
)
resp.raise_for_status()
return resp
async def _send_one_shot_command(
self,
device_id: str,
command_type: str,
command: str,
params: Optional[List[dict]] = None,
**kwargs,
) -> CommandResponse:
"""
Send One Shot command to console
Args:
device_id: ID of console (from console list)
type: type of command
command: name of command
params: command parameters
Returns: Command Response
"""
url = f"{self.SG_URL}/commands"
body = {
"destination": "Xbox",
"type": command_type,
"command": command,
"sessionId": self._smartglass_session_id,
"sourceId": "com.microsoft.smartglass",
"parameters": params or [{}],
"linkedXboxId": device_id,
}
resp = await self.client.session.post(
url, json=body, headers=self.HEADERS_SG, **kwargs
)
resp.raise_for_status()
return CommandResponse(**resp.json())
|
