xbox smartglass core python

Xbox-Smartglass核心

该库为与Xbox One游戏机一起使用的SmartGlass协议提供了核心基础

有关深度信息，请查看文档：https：//openxbox.org/smartglass-documentation

注意：自29.02.2020以来

特征

• 电源开 /关机控制台
• 获取系统信息（运行应用程序/游戏/标题，仪表板版本）
• 媒体播放器控制（查看内容ID，内容应用，播放操作等）
• 树桩协议（Live-TV流媒体 / IR控制）
• 标题 /辅助流协议（FE Fallout 4 Companion App）
• 远程触发gamedvr
• REST服务器

使用的主要框架

• Xbox webapi https://github.com/openxbox/xbox-webapi-python
• 构造 - 二进制解析https：//construct.readthedocs.io/
• 密码学 - 密码学魔术https://cryptography.io/en/stable/
• DPKT -PCAP解析https://dpkt.readthedocs.io/en/latest/
• fastapi -rest api https：//github.com/tiangolo/fastapi
• urwid -tui应用程序https：//github.com/urwid/urwid
• Pydantic -JSON模型https：//github.com/samuelcolvin/pydantic

安装

通过PIP

 pip install xbox-smartglass-core

有关开发定位的说明，请参见此读数的结尾。

如何使用

有几个命令行实用程序可以退房::

 xbox-cli

某些功能（例如GAMEDVR记录）需要使用您的Microsoft帐户进行身份验证，以验证您有权触发此类操作。

验证 /获取身份验证令牌使用::

 xbox-authenticate

REST服务器

启动服务器守护程序

使用信息

示例Localhost：

 # Serve on '127.0.0.1:5557'
$ xbox-rest-server
INFO:     Started server process [927195]
INFO:     Waiting for application startup.
INFO:     Application startup complete.
INFO:     Uvicorn running on http://127.0.0.1:5557 (Press CTRL+C to quit)

示例本地网络：

192.168.0.100是运行服务器的计算机的IP地址：

xbox-rest-server --host 192.168.0.100 -p 1234
INFO:     Started server process [927195]
INFO:     Waiting for application startup.
INFO:     Application startup complete.
INFO:     Uvicorn running on http://192.168.0.100:1234 (Press CTRL+C to quit)

REST API

由于从烧瓶框架迁移到Fastapi，因此有一个不错的OpenAPI文档可用：

http：// {ipaddress}：{port}/docs

验证

如果您的服务器在127.0.0.1:5557或127.0.0.1：8080上运行，则需要在Azure AD上注册自己的OAUTH应用程序，并向REST服务器的登录端点提供适当的参数。

查看：https：//github.com/openxbox/xbox-webapi-python/blob/master/master/readme.md

辐射4接力服务

将标题通信从Xbox转发到您本地主机，以使用第三方辐射4 PIP男孩应用程序或扩展程序

 xbox-fo4-relay

屏幕截图

在这里，您可以看到SmartGlass TUI（文本用户界面）：

开发工作流程

准备贡献了吗？这是为本地开发设置xbox-smartglass-core-python的方法。

1. 分叉在Github上xbox-smartglass-core-python repo。
2. 克隆到本地的叉子

 git clone [email protected]:your_name_here/xbox-smartglass-core-python.git

3. 将您的本地副本安装到虚拟环境中。这就是您为本地开发设置叉子的方式

 python -m venv ~/pyvenv/xbox-smartglass
source ~/pyvenv/xbox-smartglass/bin/activate
cd xbox-smartglass-core-python
pip install -e .[dev]

5. 为地方开发创建一个分支::

 git checkout -b name-of-your-bugfix-or-feature

6. 进行更改。

7. 在将更改推向git之前，请验证他们实际上有效

 pytest

8. 进行更改，并将分支推向GitHub ::

 git commit -m "Your detailed description of your changes."
git push origin name-of-your-bugfix-or-feature

9. 通过GitHub网站提交拉动请求。

拉请求指南

在提交拉动请求之前，请检查它符合以下准则：

1. 代码包括单位测试。
2. 添加的代码已正确命名和记录。
3. 关于重大更改，更新了校友。
4. 在推到遥控器之前，请在本地运行测试 /覆盖。

学分

首先要弄清楚AuxiliaryStream / Titlechannel通信，感谢Joelday！您可以在此处找到原始实现：smartglass.csharp

该包装使用CookieCutter和Audreyr/CookieCutter-Pypackage项目模板的一部分