Unofficial product: not affiliated with or endorsed by Laminar Research. X-Plane is a trademark of Laminar Research.
Email contact@gramshift.com in English or Japanese. We reply within 7 business days, usually sooner. Please include your X-Plane version, the aircraft you were flying, your Windows or macOS version, your Stream Deck app version, the text of the "Status" line in the key's settings, and, if possible, a photo or screenshot of the key and of its settings. Ideas for new keys are welcome too.
| Key | Shows | Press |
|---|---|---|
| Landing Gear | A lamp for each of the first three gear legs: green down, red moving, dark up; DOWN, UP or TRANSIT; the gear lever position; UNSAFE when X-Plane reports the gear unsafe. FIXED on aircraft with fixed gear. On a retractable aircraft with a fixed nose or tail wheel, that wheel is left out once the other legs are up, so the key says UP. | Gear up or down |
| Flaps | UP, the percent or FULL, a bar (amber with MOVING while the flaps travel) and a white mark where the flap lever is. When the flaps do not follow the lever (for example without hydraulic pressure), MOVING goes away after a few seconds and the mark shows where the lever is. | Flaps down a notch, or up a notch (in the settings) |
| Speed Brake | ARMED, RETRACTED or EXT with the percent. NONE on aircraft without speed brakes. | Speed brake toggle |
| Parking Brake | BRAKES: SET (red) or OFF. The key shows X-Plane's brake control, which X-Plane's hold-brakes key also sets, so it also says SET while you hold the brakes. | Parking brake on or off |
| Light | Landing, taxi, strobe, beacon or nav lights: ON (yellow) or OFF. | That light on or off |
| Autopilot | AP, HDG, ALT, NAV, APR or V/S: green ON when the mode holds, white ARMED while it waits to capture, OFF; the selected heading, altitude or vertical speed; on the AP key, whether the flight director is on. NO POWER when the autopilot has no power. | That autopilot mode |
| Transponder | The squawk code (7500, 7600 and 7700 in red) and the mode: OFF, STBY, ON, ALT, TEST, GND, TA ONLY or TA/RA; IDENT while it is squawking ident. | STBY / ALT (from STBY or OFF to ALT, from any other mode to STBY), IDENT, or the next mode (in the settings) |
| Airspeed | Indicated airspeed and ground speed. | - |
| Altitude | Indicated altitude and vertical speed. | - |
| Fuel | Fuel on board and the time it lasts at the fuel flow of all engines (for example 2h 09m, or 15m 58s under an hour; 99h+ from 100 hours). Orange with less than the warning time left (30 minutes unless you change it), red with less than half of it, EMPTY at zero. "no fuel flow" while the engines burn nothing. NONE "no fuel system" on an aircraft that carries no fuel, such as a glider. | - |
| Heading | Magnetic heading and the autopilot heading bug. | - |
| Next Waypoint | The GPS destination, the distance and the time to go. NO WAYPOINT without a GPS destination. | - |
| Custom Key | Your label, and the dataref you enter as ON / OFF (any value but 0 is ON) or as a number with 0 to 3 decimals. Enter name[2] for one value of a list. | The command you enter: pressed and released, or held as long as you hold the key (see below) |
Switch keys show what X-Plane reports, so they stay right when you use the mouse, a joystick button or another panel. A short white frame shows that X-Plane took your press.
Some X-Plane commands act only while they are held, like a starter or the wheel brakes. In the Custom Key's settings, set "Press sends" to "held while the key is down": the command is held from the moment you press the key until you let go of it (and is let go if the key leaves the screen, for example on a page switch). Examples:
| Command | What it does while you hold the key |
|---|---|
sim/starters/engage_starter_1 | Engages the starter of engine 1 |
sim/flight_controls/brakes_regular | Holds the wheel brakes |
The default, "press and release", sends the command once, like a click on a switch.
The keys use X-Plane's standard controls, which the default aircraft and most add-on aircraft use. Some add-on aircraft (for example detailed airliners) have their own switches and systems that do not follow them. For those, use the Custom Key: enter the aircraft's own command name (its documentation lists them) and, if you like, its own dataref to show the state.
| Message | What it means / what to do |
|---|---|
| NO X-PLANE | X-Plane is not running. Start X-Plane 12: the keys connect by themselves. |
| NOT FOUND | X-Plane does not answer, and the plugin cannot tell whether it is running (this can happen on a Mac). Either X-Plane 12 is not running (start it: the keys connect by themselves), it is still starting, or its web server is off (--no_web_server) or on another port (--web_server_port: enter that port in the key's settings). |
| NO ANSWER | X-Plane is running but does not answer. It may still be starting. If it stays, X-Plane may have been started with --no_web_server, or on another port with --web_server_port: enter that port in the key's settings. |
| API BLOCKED | X-Plane refuses programs on this computer: in X-Plane, Settings > Network, "Disable Incoming Traffic" is chosen. Choose another option there. |
| UPDATE X-PLANE | This X-Plane is older than 12.1.4. Update X-Plane 12. |
| WRONG PORT | Another program answers on the port in the key's settings. Leave the port empty for X-Plane's usual port 8086, or enter the port X-Plane uses. |
| PORT? | The port in the key's settings is not a number from 1024 to 65535. |
| CONNECTING | X-Plane answered and the keys are connecting. |
| LOADING | X-Plane does not answer for a few seconds, for example while it loads scenery or an aircraft. The keys go on as soon as it answers. |
| NO DATA | This X-Plane does not have the values this key shows. The Status line names them. |
| NAME? / SET UP | Custom Key: the command or dataref name is not a name (letters, digits, _ - . and /), or nothing is entered yet. |
| NOT CONNECTED / NO COMMAND / NOT TAKEN / NO REPLY (red frame) | A press could not be sent: X-Plane is not connected, X-Plane does not have that command, X-Plane refused it, or X-Plane did not answer in time. |
No. X-Plane 12.1.4 and later accept the keys as they are. You only need the default network setting that lets programs on the same computer connect.
No. X-Plane accepts these connections only from the same computer, so the Stream Deck must be connected to the computer that runs X-Plane.
No. It needs X-Plane 12.1.4 or later.
The key shows the first three gear legs of the aircraft, like a three-light gear panel. DOWN, UP and TRANSIT on the key take every gear leg into account.
X-Plane 12.1.4 or later; Stream Deck app 6.9 or later on Windows 10 or later, or macOS 12 or later, on the same computer as X-Plane.