X-Plane 12

This page lists all available telemetry data and commands for X-Plane 12. X-Plane telemetry is captured via the X-Plane Web API (requires X-Plane 12.1.1+).

X-Plane Setup

To enable the Web API in X-Plane:

1. Open X-Plane 12
2. Go to Settings > General
3. Under Network, enable the Web API
4. Note the port (default: 8086)

GameGlue will automatically connect once the Web API is enabled.

SDK Settings

Name	Value
Game ID	xplane
Scopes	xplane:read xplane:write

Readable Data

Position Data

Name	Description
lat	Latitude (degrees)
lon	Longitude (degrees)
alt_msl	Altitude above mean sea level (feet)
alt_agl	Altitude above ground level (feet)
on_ground	Aircraft is on ground (0/1)

Speed Data

Name	Description
ias	Indicated airspeed (knots)
tas	True airspeed (knots)
gs	Ground speed (knots)
mach	Mach number
vvi	Vertical velocity (ft/min)
g_load	G-force

Attitude Data

Name	Description
hdg_mag	Magnetic heading (degrees)
hdg_true	True heading (degrees)
pitch	Pitch angle (degrees)
roll	Roll angle (degrees)
yaw	Yaw/sideslip angle (degrees)

Engine Data

Name	Description
throttle_0	Engine 1 throttle (0-1)
throttle_1	Engine 2 throttle (0-1)
throttle_2	Engine 3 throttle (0-1)
throttle_3	Engine 4 throttle (0-1)
rpm_0	Engine 1 RPM
rpm_1	Engine 2 RPM
rpm_2	Engine 3 RPM
rpm_3	Engine 4 RPM
n1_0	Engine 1 N1 percentage
n1_1	Engine 2 N1 percentage
n1_2	Engine 3 N1 percentage
n1_3	Engine 4 N1 percentage
n2_0	Engine 1 N2 percentage
n2_1	Engine 2 N2 percentage
n2_2	Engine 3 N2 percentage
n2_3	Engine 4 N2 percentage
egt_0	Engine 1 EGT (°C)
egt_1	Engine 2 EGT (°C)
egt_2	Engine 3 EGT (°C)
egt_3	Engine 4 EGT (°C)

Fuel Data

Name	Description
fuel_total_lbs	Total fuel quantity (lbs)
ff_0	Engine 1 fuel flow
ff_1	Engine 2 fuel flow
ff_2	Engine 3 fuel flow
ff_3	Engine 4 fuel flow

Autopilot Data

Name	Description
ap_master	Autopilot master engaged (0/1)
ap_alt_hold	Altitude hold engaged (0/1)
ap_hdg_hold	Heading hold engaged (0/1)
ap_vs_hold	Vertical speed hold engaged (0/1)
ap_spd_hold	Speed hold engaged (0/1)
ap_apr	Approach mode engaged (0/1)
ap_nav	NAV mode engaged (0/1)
fd_on	Flight director active (0/1)
ap_alt_set	Target altitude setting (feet)
ap_hdg_set	Target heading setting (degrees)
ap_vs_set	Target vertical speed (ft/min)
ap_spd_set	Target speed (knots)

Flight Controls

Name	Description
flap_ratio	Flap position (0-1)
spoiler_ratio	Spoiler position (0-1)
gear_deploy	Gear deployed (0/1)
park_brake	Parking brake set (0/1)
brake_left	Left brake position (0-1)
brake_right	Right brake position (0-1)

Lighting

Name	Description
land_lights	Landing lights (0/1)
taxi_lights	Taxi lights (0/1)
beacon	Beacon lights (0/1)
nav_lights	Navigation lights (0/1)
strobe	Strobe lights (0/1)

Environment

Name	Description
oat	Outside air temperature (°C)
baro_set	Altimeter setting (inHg)
wind_dir	Wind direction (degrees)
wind_spd	Wind speed (knots)

Warnings

Name	Description
stall	Stall warning active
overspeed	Overspeed warning active

Simulation State

Name	Description
paused	Simulation is paused
replay_mode	Replay mode active
time_local	Local time (seconds since midnight)
time_zulu	Zulu time (seconds since midnight)

Writable Commands

Use these commands with sendCommand(commandName, value) to control the simulator. Requires the xplane:write scope.

Cross-Sim Compatibility

X-Plane and MSFS use the same command names. Dashboards built for one simulator will work with the other without code changes.

Autopilot Commands

Command	Description
autopilot_on	Engage autopilot
autopilot_off	Disengage autopilot
autopilot_toggle	Toggle autopilot
autopilot_altitude_hold_on	Enable altitude hold
autopilot_altitude_hold_off	Disable altitude hold
autopilot_heading_hold_on	Enable heading hold
autopilot_heading_hold_off	Disable heading hold
autopilot_vs_hold_on	Enable vertical speed hold
autopilot_vs_hold_off	Disable vertical speed hold
autopilot_nav_on	Enable NAV mode
autopilot_nav_off	Disable NAV mode
autopilot_approach_on	Enable approach mode
autopilot_approach_off	Disable approach mode
flight_director_on	Turn on flight director
flight_director_off	Turn off flight director
set_autopilot_altitude	Set target altitude (feet)
set_autopilot_heading	Set target heading (degrees)
set_autopilot_vs	Set target vertical speed (ft/min)
set_autopilot_speed	Set target airspeed (knots)

Flight Control Commands

Command	Description
gear_up	Retract landing gear
gear_down	Extend landing gear
gear_toggle	Toggle landing gear
flaps_up	Retract flaps one notch
flaps_down	Extend flaps one notch
flaps_full	Full flaps
flaps_retract	Fully retract flaps
set_flaps	Set flap ratio (0-1)
spoilers_arm	Arm spoilers
spoilers_deploy	Deploy spoilers
spoilers_retract	Retract spoilers
spoilers_toggle	Toggle spoilers
parking_brake_on	Set parking brake
parking_brake_off	Release parking brake
parking_brake_toggle	Toggle parking brake

Throttle Commands

Command	Description
set_throttle	Set all throttles (0-1)
set_throttle_0	Set engine 1 throttle (0-1)
set_throttle_1	Set engine 2 throttle (0-1)
set_throttle_2	Set engine 3 throttle (0-1)
set_throttle_3	Set engine 4 throttle (0-1)
throttle_full	Throttle to maximum
throttle_idle	Throttle to idle
throttle_cutoff	Engine shutdown

Lighting Commands

Command	Description
landing_lights_on	Turn on landing lights
landing_lights_off	Turn off landing lights
landing_lights_toggle	Toggle landing lights
taxi_lights_on	Turn on taxi lights
taxi_lights_off	Turn off taxi lights
taxi_lights_toggle	Toggle taxi lights
beacon_lights_on	Turn on beacon
beacon_lights_off	Turn off beacon
beacon_lights_toggle	Toggle beacon
nav_lights_on	Turn on nav lights
nav_lights_off	Turn off nav lights
nav_lights_toggle	Toggle nav lights
strobe_lights_on	Turn on strobes
strobe_lights_off	Turn off strobes
strobe_lights_toggle	Toggle strobes

Simulation Commands

Command	Description
pause	Pause simulation
unpause	Resume simulation
pause_toggle	Toggle pause