xbox smartglass core python

Xbox-smartglass-core

Perpustakaan ini menyediakan fondasi inti untuk protokol pintar yang digunakan dengan konsol game Xbox One

Untuk informasi mendalam, lihat dokumentasi: https://openxbox.org/smartglass-documentation

CATATAN: Sejak 29.02.2020 modul berikut diintegrasikan ke dalam inti: tunggul, tambahan, server-server Catatan: Modul nano masih ditawarkan secara terpisah

Fitur

• Kekuasaan / Mati Konsol
• Dapatkan info sistem (menjalankan aplikasi/game/judul, versi dasbor)
• Kontrol pemutar media (melihat ID konten, aplikasi konten, tindakan pemutaran dll.)
• Protokol tunggul (streaming-TV live / kontrol IR)
• Protokol Aliran Judul / Auxiliary (Fe Fallout 4 Companion App)
• Memicu gamedvr jarak jauh
• Server istirahat

Kerangka kerja besar digunakan

• Xbox Webapi https://github.com/openxbox/xbox-webapi-python
• Konstruk - Biner Parsing https://construct.readthedocs.io/
• Cryptography - Cryptography Magic https://cryptography.io/en/stable/
• DPKT - PCAP Parsing https://dpkt.readthedocs.io/en/latest/
• Fastapi - REST API https://github.com/tiangolo/fastapi
• Urwid - Aplikasi TUI https://github.com/urwid/urwid
• Pydantic - model JSON https://github.com/samuelcolvin/pydantic

Memasang

Melalui pip

 pip install xbox-smartglass-core

Lihat akhir Readme ini untuk instruksi yang ditargetkan pengembangan.

Cara menggunakan

Ada beberapa utilitas baris perintah untuk check out ::

 xbox-cli

Beberapa fungsionalitas, seperti catatan gamedvr, membutuhkan otentikasi dengan akun Microsoft Anda untuk memvalidasi Anda memiliki hak untuk memicu tindakan tersebut.

Untuk mengotentikasi / mendapatkan token otentikasi digunakan ::

 xbox-authenticate

Server istirahat

Mulai Daemon Server

Informasi penggunaan

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

Contoh Jaringan Lokal:

192.168.0.100 adalah alamat IP komputer Anda yang menjalankan server:

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)

API istirahat

Karena migrasi dari kerangka flask ke fastapi, ada dokumentasi openapi yang bagus yang tersedia:

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

Otentikasi

Jika server Anda berjalan pada sesuatu yang lain dari 127.0.0.1:5557 atau 127.0.0.1:8080 Anda perlu mendaftarkan aplikasi OAuth Anda sendiri pada Azure AD dan menyediakan parameter yang sesuai ke titik login server REST.

Lihat: https://github.com/openxbox/xbox-webapi-python/blob/master/readme.md

Layanan Relay Fallout 4

Untuk meneruskan judul komunikasi dari Xbox ke host lokal Anda untuk menggunakan aplikasi atau ekstensi Fallout 4 Pip Pip-pihak ketiga

 xbox-fo4-relay

Tangkapan layar

Di sini Anda dapat melihat Smartglass TUI (antarmuka pengguna teks):

Alur kerja pengembangan

Siap berkontribusi? Inilah cara mengatur xbox-smartglass-core-python untuk pengembangan lokal.

1. Fork The xbox-smartglass-core-python Repo di GitHub.
2. Klon garpu Anda secara lokal

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

3. Instal salinan lokal Anda ke lingkungan virtual. Beginilah cara Anda mengatur garpu untuk pengembangan lokal

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

5. Buat cabang untuk pengembangan lokal ::

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

6. Membuat perubahan Anda.

7. Sebelum mendorong perubahan ke git, harap verifikasi mereka benar -benar berfungsi

 pytest

8. Melakukan perubahan Anda dan dorong cabang Anda ke github ::

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

9. Kirim permintaan tarik melalui situs web GitHub.

Pedoman Permintaan Tarik

Sebelum Anda mengirimkan permintaan tarik, periksa apakah itu memenuhi panduan ini:

1. Kode termasuk tes unit.
2. Kode tambahan dinamai dan didokumentasikan dengan benar.
3. Pada perubahan besar, readme diperbarui.
4. Jalankan tes / linting secara lokal sebelum mendorong ke jarak jauh.

Kredit

Kudos to Joelday karena mencari tahu komunikasi AuxiliaryStream / Titlechannel terlebih dahulu! Anda dapat menemukan implementasi asli di sini: Smartglass.csharp

Paket ini menggunakan bagian dari cookiecutter dan template proyek audreyr/cookiecutter-pypackage