xbox smartglass core python

Xbox-Smartglass-Core

Diese Bibliothek bietet die Kerngrundlage für das SmartGass -Protokoll, das mit der Xbox One Gaming -Konsole verwendet wird

Überausführliche Informationen finden Sie in der Dokumentation: https://openxbox.org/smartglass-documentation

HINWEIS: Seit 29.02.2020 sind die folgenden Module in den Kern integriert: Stumpf, Auxiliary, Rest-Server- Hinweis: Nano-Modul wird immer noch separat angeboten

Merkmale

• Stromversorgung der Konsole
• Systeminformationen abrufen (App/Game/Title, Dashboard -Version)
• Media Player Control (Sehen in Content -ID, Inhalts -App, Wiedergabeaktionen usw.)
• Stumpfprotokoll (Live-TV-Streaming / IR-Kontrolle)
• Titel / Hilfsstromprotokoll (Fe Fallout 4 Companion App)
• Auslöser von GAMEDVR REMOTELY
• Restserver

Hauptrahmen verwendet

• Xbox webapi https://github.com/openxbox/xbox-webapi-python
• Konstrukt - Binäres Parsen https://construct.readthedocs.io/
• Kryptographie - Kryptographie Magic https://cryptography.io/en/stable/
• DPKT - PCAP Parsing https://dpkt.readthedocs.io/en/latest/
• Fastapi - rest api https://github.com/tiangolo/fastapi
• Urwid - TUI App https://github.com/urwid/urwid
• Pydantic - JSON -Modelle https://github.com/samuelcolvin/pydanticantic

Installieren

Via pip

 pip install xbox-smartglass-core

Sehen Sie sich das Ende dieses Readme für Entwicklungsanweisungen an.

Wie man benutzt

Es gibt mehrere Befehlszeilen -Dienstprogramme, die Sie auschecken müssen ::

 xbox-cli

Einige Funktionen wie GAMMedVR -Datensatz erfordert eine Authentifizierung mit Ihrem Microsoft -Konto, um zu validieren, dass Sie das Recht haben, solche Aktionen auszulösen.

Authentifizierung / Authentifizierungs -Token verwenden ::

 xbox-authenticate

Restserver

Starten Sie den Server -Daemon

Nutzungsinformationen

Beispiel 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)

Beispiel Lokales Netzwerk:

192.168.0.100 ist die IP -Adresse Ihres Computers, die den Server ausführen:

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)

Ruhe -API

Da die Migration von Flask Framework nach Fastapi eine schöne OpenAPI -Dokumentation verfügbar ist:

http: // {ipaddress}: {port}/docs

Authentifizierung

Wenn Ihr Server auf etwas anderem als 127.0.0.1:5557 oder 127.0.0.1:8080 ausgeführt wird, müssen Sie Ihre eigene OAUTH-Anwendung auf Azure AD registrieren und an den Anmeldetendpunkt des Restservers entsprechende Parameter bereitstellen.

Schauen Sie sich an: https://github.com/openxbox/xbox-webapi-python/blob/master/readme.md

Fallout 4 Relay Service

Um die Titelkommunikation von der Xbox an Ihren lokalen Host weiterzuleiten, um Faly-4-Pip-Boy-Anwendungen oder Erweiterungen von Drittanbietern zu verwenden

 xbox-fo4-relay

Screenshots

Hier sehen Sie die Smartglass TUI (Textbenutzeroberfläche):

Entwicklungsworkflow

Bereit zu beitragen? Hier erfahren Sie, wie Sie xbox-smartglass-core-python für die lokale Entwicklung einrichten.

1. Geben Sie das xbox-smartglass-core-python Repo auf GitHub auf.
2. Klonen Sie Ihre Gabel vor Ort

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

3. Installieren Sie Ihre lokale Kopie in eine virtuelle Umgebung. So richten Sie Ihre Gabel für die lokale Entwicklung ein

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

5. Erstellen Sie einen Zweig für die lokale Entwicklung ::

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

6. Nehmen Sie Ihre Änderungen vor.

7. Bevor Sie die Änderungen in Git drücken, vergewissern Sie sich bitte, dass sie tatsächlich funktionieren

 pytest

8. Beachten Sie Ihre Änderungen und drücken Sie Ihren Zweig nach Github ::

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

9. Senden Sie eine Pull -Anfrage über die Github -Website.

Richtlinien für Anforderungsrichtlinien ziehen

Bevor Sie eine Pull -Anfrage einreichen, überprüfen Sie, ob sie diese Richtlinien entsprechen:

1. Code enthält Einheitstests.
2. Der hinzugefügte Code ist ordnungsgemäß benannt und dokumentiert.
3. Bei wichtigen Änderungen wird die Readme aktualisiert.
4. Führen Sie Tests / Leinen lokal aus, bevor Sie zur Remote drängen.

Credits

Ein großes Lob an Joelday, um zuerst die Hilfsstream / Titlechannel -Kommunikation herauszufinden! Hier finden Sie die ursprüngliche Implementierung: smartglass.csharp

Dieses Paket verwendet Teile von CookieCutter und die Project-Vorlage von Audreyr/CookieCutter-Pypackage