Skip to content

Smartglass provider

SmartGlass - Control Registered Devices

pythonxbox.api.provider.smartglass.SmartglassProvider(client)

Bases: BaseProvider

Initialize Baseclass, create smartglass session id

Args: Instance of XBL client

Source code in src/pythonxbox/api/provider/smartglass/__init__.py 
34
35
36
37
38
39
40
41
def __init__(self, client: "XboxLiveClient") -> None:
    """
    Initialize Baseclass, create smartglass session id

    Args: Instance of XBL client
    """
    super().__init__(client)
    self._smartglass_session_id = str(uuid4())

SG_URL = 'https://xccs.xboxlive.com' class-attribute instance-attribute

HEADERS_SG = {'x-xbl-contract-version': '4', 'skillplatform': 'RemoteManagement'} class-attribute instance-attribute

get_console_list(include_storage_devices=True, **kwargs) async

Get Console list

Parameters:

Name Type Description Default
include_storage_devices bool

Include a list of storage devices in the response

 True

Returns: Console List

Source code in src/pythonxbox/api/provider/smartglass/__init__.py 
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
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.model_validate_json(resp.text)

get_installed_apps(device_id=None, **kwargs) async

Get Installed Apps

Parameters:

Name Type Description Default
device_id str | None

ID of console (from console list)

 None

Returns: Installed Apps

Source code in src/pythonxbox/api/provider/smartglass/__init__.py 
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
async def get_installed_apps(
    self, device_id: str | None = 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.model_validate_json(resp.text)

get_storage_devices(device_id, **kwargs) async

Get Installed Apps

Parameters:

Name Type Description Default
device_id str

ID of console (from console list)

 required

Returns: Storage Devices list

Source code in src/pythonxbox/api/provider/smartglass/__init__.py 
78
79
80
81
82
83
84
85
86
87
88
89
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.model_validate_json(resp.text)

get_console_status(device_id, **kwargs) async

Get Console Status

Parameters:

Name Type Description Default
device_id str

ID of console (from console list)

 required

Returns: Console Status

Source code in src/pythonxbox/api/provider/smartglass/__init__.py 
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
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.model_validate_json(resp.text)

get_op_status(device_id, op_id, **kwargs) async

Get Operation Status

Parameters:

Name Type Description Default
device_id str

ID of console (from console list)

 required
op_id str

Operation ID (from previous command)

 required

Returns: Operation Status

Source code in src/pythonxbox/api/provider/smartglass/__init__.py 
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
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.model_validate_json(resp.text)

wake_up(device_id, **kwargs) async

Wake Up Console

Parameters:

Name Type Description Default
device_id str

ID of console (from console list)

 required

Returns: Command Response

Source code in src/pythonxbox/api/provider/smartglass/__init__.py 
129
130
131
132
133
134
135
136
137
138
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)

turn_off(device_id, **kwargs) async

Turn Off Console

Parameters:

Name Type Description Default
device_id str

ID of console (from console list)

 required

Returns: Command Response

Source code in src/pythonxbox/api/provider/smartglass/__init__.py 
140
141
142
143
144
145
146
147
148
149
150
151
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
    )

reboot(device_id, **kwargs) async

Reboot Console

Parameters:

Name Type Description Default
device_id str

ID of console (from console list)

 required

Returns: Command Response

Source code in src/pythonxbox/api/provider/smartglass/__init__.py 
153
154
155
156
157
158
159
160
161
162
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)

mute(device_id, **kwargs) async

Mute

Parameters:

Name Type Description Default
device_id str

ID of console (from console list)

 required

Returns: Command Response

Source code in src/pythonxbox/api/provider/smartglass/__init__.py 
164
165
166
167
168
169
170
171
172
173
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)

unmute(device_id, **kwargs) async

Unmute

Parameters:

Name Type Description Default
device_id str

ID of console (from console list)

 required

Returns: Command Response

Source code in src/pythonxbox/api/provider/smartglass/__init__.py 
175
176
177
178
179
180
181
182
183
184
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)

volume(device_id, direction, amount=1, **kwargs) async

Adjust Volume

Parameters:

Name Type Description Default
device_id str

ID of console (from console list)

 required

Returns: Command Response

Source code in src/pythonxbox/api/provider/smartglass/__init__.py 
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
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
    )

play(device_id, **kwargs) async

Play (media controls)

Parameters:

Name Type Description Default
device_id str

ID of console (from console list)

 required

Returns: Command Response

Source code in src/pythonxbox/api/provider/smartglass/__init__.py 
202
203
204
205
206
207
208
209
210
211
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)

pause(device_id, **kwargs) async

Pause (media controls)

Parameters:

Name Type Description Default
device_id str

ID of console (from console list)

 required

Returns: Command Response

Source code in src/pythonxbox/api/provider/smartglass/__init__.py 
213
214
215
216
217
218
219
220
221
222
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)

previous(device_id, **kwargs) async

Previous (media controls)

Parameters:

Name Type Description Default
device_id str

ID of console (from console list)

 required

Returns: Command Response

Source code in src/pythonxbox/api/provider/smartglass/__init__.py 
224
225
226
227
228
229
230
231
232
233
234
235
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
    )

next(device_id, **kwargs) async

Next (media controls)

Parameters:

Name Type Description Default
device_id str

ID of console (from console list)

 required

Returns: Command Response

Source code in src/pythonxbox/api/provider/smartglass/__init__.py 
237
238
239
240
241
242
243
244
245
246
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)

go_home(device_id, **kwargs) async

Go Home

Parameters:

Name Type Description Default
device_id str

ID of console (from console list)

 required

Returns: Command Response

Source code in src/pythonxbox/api/provider/smartglass/__init__.py 
248
249
250
251
252
253
254
255
256
257
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)

go_back(device_id, **kwargs) async

Go Back

Parameters:

Name Type Description Default
device_id str

ID of console (from console list)

 required

Returns:

Type Description
CommandResponse

class:SmartglassConsoleStatus: Command Response
Source code in src/pythonxbox/api/provider/smartglass/__init__.py 
259
260
261
262
263
264
265
266
267
268
269
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)

show_guide_tab(device_id, tab=GuideTab.Guide, **kwargs) async

Show Guide Tab

Parameters:

Name Type Description Default
device_id str

ID of console (from console list)

 required

Returns: Command Response

Source code in src/pythonxbox/api/provider/smartglass/__init__.py 
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
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
    )

press_button(device_id, button, **kwargs) async

Press Button

Parameters:

Name Type Description Default
device_id str

ID of console (from console list)

 required

Returns: Command Response

Source code in src/pythonxbox/api/provider/smartglass/__init__.py 
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
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
    )

insert_text(device_id, text, **kwargs) async

Insert Text

Parameters:

Name Type Description Default
device_id str

ID of console (from console list)

 required

Returns: Command Response

Source code in src/pythonxbox/api/provider/smartglass/__init__.py 
303
304
305
306
307
308
309
310
311
312
313
314
315
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
    )

launch_app(device_id, one_store_product_id, **kwargs) async

Launch Application

Parameters:

Name Type Description Default
device_id str

ID of console (from console list)

 required
one_store_product_id str

OneStoreProductID for the app to launch

 required

Returns: Command Response

Source code in src/pythonxbox/api/provider/smartglass/__init__.py 
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
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,
    )

show_tv_guide(device_id, **kwargs) async

Show TV Guide

Parameters:

Name Type Description Default
device_id str

ID of console (from console list)

 required

Returns: Command Response

Source code in src/pythonxbox/api/provider/smartglass/__init__.py 
338
339
340
341
342
343
344
345
346
347
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)