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項目模板的一部分