jackd/xpapi-wrapper
Watch
1
0
Fork
You've already forked xpapi-wrapper
 0
Code Issues Pull requests Activity
Wrapper for the X-Plane HTTP API
2 commits 1 branch 0 tags 34 KiB
  • Python 100%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Jack Deeth c312ec1aed pretty sure doubles are handled like floats
2026-02-18 01:12:26 +00:00
tests Initial commit 2026-02-18 01:10:58 +00:00
xpapi Initial commit 2026-02-18 01:10:58 +00:00
.gitignore Initial commit 2026-02-18 01:10:58 +00:00
LICENCE Initial commit 2026-02-18 01:10:58 +00:00
pyproject.toml Initial commit 2026-02-18 01:10:58 +00:00
README.md pretty sure doubles are handled like floats 2026-02-18 01:12:26 +00:00

README.md

XP-API Wrapper

This is a lightweight Python wrapper around the X-Plane 12 API, using the requests HTTP library.

https://developer.x-plane.com/article/x-plane-web-api

Please note, this has been put together in an evening and is incomplete, and not at all thoroughly tested. For feedback please raise an issue on this repository.

Current API features

Those supported by this wrapper are checked off.

v1 (XP12.1.1)

  • List available datarefs
  • Read or write a particular dataref
    • integer
    • float
    • double
    • int array
    • float array
    • data (/text)
  • Subscribe to datarefs via websockets
  • Stream data to datarefs via websockets

v2 (XP12.1.4)

  • Show supported API versions
  • List available commands
  • Activate a command
  • Subscribe to commands via websockets
  • Stream command activations via websockets

v3 (XP12.4.0)

  • Initialise or update a flight

API roadmap

  • LAN access and authorisation
  • Subscribe for dataref/command creation
  • Aircraft: read available aircraft and their capabilities
  • Traffic: read/write
  • Weather: read/write
  • More: failures, situations, nav data, time, airports...