-
-
Notifications
You must be signed in to change notification settings - Fork 4
Documentation MSFS
This plugin provides tools for Touch Portal macro launcher software to build two-way interactive interfaces with Microsoft Flight Simulator 2020 and 2024.
For further documentation, please see https://github.com/mpaperno/MSFSTouchPortalPlugin/wiki
This documentation generated for plugin v1.6.0.0
Actions and States by Category
Click to expand
Type | Default Value | Min. Value | Max. Value |
---|---|---|---|
boolean (on/off) | 0 | 0 | 1 |
Set to 1 to automatically attempt connection to flight simulator upon Touch Portal startup. Set to 0 to only connect manually via the Action "MSFS - Plugin -> Connect & Update".
Type | Default Value | Min. Value | Max. Value |
---|---|---|---|
boolean (on/off) | 0 | 0 | 1 |
Set to 1 to check for new versions of this plugin when it starts, or 0 to disable update checks. A version check is also performed when this value is changed from 0 to 1 and the settings are saved. The minimum time between update checks is 6 hours, even if the plugin is restarted. It will never check more often than that. Update checks require an active Internet connection.
Type | Default Value | Max. Length |
---|---|---|
text | Default | 255 |
Here you can specify one or more custom configuration files which define SimConnect variables to request as Touch Portal States. This plugin comes with an extensive default set of states, however since the possibilities between which variables are requested, which units they are displayed in,and how they are formatted are almost endless. This option provides a way to customize the output as desired.
Enter a file name here, with or w/out the suffix (".ini" is assumed). Separate multiple files with commas (and optional space). To include the default set of variables/states, use the name Default
as one of the file names (in any position of the list).
Files are loaded in the order in which they appear in the list, and in case of conflicting state IDs, the last one found will be used.
The custom file(s) are expected to be in the folder specified in the "User Config Files Path" setting (see below).
See https://github.com/mpaperno/MSFSTouchPortalPlugin/wiki/Using-Custom-States-and-Simulator-Variables for more details.
Type | Default Value | Min. Value | Max. Value |
---|---|---|---|
number | 0 | 0 | 20 |
A "SimConnect.cfg" file can contain a number of connection configurations, identified in sections with the [SimConnect.N]
title. A default "SimConnect.cfg" is included with this plugin (in the installation folder). You may also use a custom configuration file stored in the "User Config Files Path" folder (see below).
The index number can be specified in this setting. This is useful for:
- Compatibility with FSX.
- Custom configurations over network connections (running Touch Portal on a different computer than the sim).
The default configuration index is zero, which (in the included default SimConnect.cfg) is suitable for MSFS (2020). Use the index 1 for compatibility with FSX (or perhaps other sims).
See here for more info about the file format: https://docs.flightsimulator.com/html/Programming_Tools/SimConnect/SimConnect_CFG_Definition.htm
For more information on using Touch Portal remotely see https://github.com/mpaperno/MSFSTouchPortalPlugin/wiki/Multiple-Touch-Portal-Device-Setup
Type | Default Value | Max. Length |
---|---|---|
text | 255 |
The system path where plugin settings are stored, including custom user State configuration files for sate definitions & the "SimConnect.cfg" configuration file. Keep it blank for default, which is "C:\Users<UserName>\AppData\Roaming\MSFSTouchPortalPlugin".
Note that using this plugin's installation folder for custom data storage is not recommended, since anything in there will likely get overwritten during a plugin update/re-install.
Type | Default Value | Min. Value | Max. Value |
---|---|---|---|
boolean (on/off) | 1 | 0 | 1 |
Touch Portal cannot perform math or numeric comparison operations on decimal numbers formatted with comma decimal separator, even in locations where this is the norm. Set this setting to 1 (one) to always format numbers in "neutral" format with period decimal separators.
NOTE that this affects input number formatting as well (the plugin will expect all numbers with period decimal separators regardless of your location).
Type | Default Value | Min. Value | Max. Value |
---|---|---|---|
boolean (on/off) | 0 | 0 | 1 |
Set to 1 (one) to automatically load latest HubHop data when plugin starts. Set to 0 (zero) to disable. Updates can always be triggered manually via the Action "MSFS - Plugin -> Connect & Update". Updates require a working Internet connection!
Type | Default Value | Min. Value | Max. Value |
---|---|---|---|
number | 60 | 0 | 600 |
Maximum number of seconds to wait for a HubHop data update check or download via the Internet.
Type | Default Value | Min. Value | Max. Value |
---|---|---|---|
boolean (on/off) | 1 | 0 | 1 |
Set to 1 (one) to have all Local ('L') simulator variables sorted in alphabetical order within selection lists. Setting to 0 (zero) will keep them in the original order they're loaded in on the simulator (by ascending ID).
This setting only applies when using WASimModule integration since there is no other way to get a list.
Type | Default Value | Min. Value | Max. Value |
---|---|---|---|
number | 0 | 25 | 4294967295 |
Default delay period before a held action starts repeating.
- A value of 0 will make the delay be the same as the current repeat interval (this is the default value for this setting).
- If set to > 0, the smallest effective value is 25ms, same as the repeat interval. This is how often the plugin checks for events to fire.
Typically the delay would be same or longer than the repeat interval. For example with a very short interval it may be possible to get unintentional repeating if a button is pressed for a little too long. Introducing a longer delay time before the repeat starts would help the issue.
A delay can also be specified per action when it is used in the "On Hold" button setup area, which would override this setting.
Type | Default Value | Min. Value | Max. Value |
---|---|---|---|
number | 75 | 0 | 300 |
Some plugin actions and connectors allow selecting Variables and Events from lists. These may have some informative descriptions (imported from the FS documentation or HubHop data).This setting controls how much of that description will be shown in the selection lists along with the variable/event name. The longer they are, the more space they will need in the TP button editor.
Enter zero (0) to disable showing descriptions entirely. Maximum value is 300.
Type | Default Value | Min. Value | Max. Value |
---|---|---|---|
number | 12 | 0 | 50 |
Maximum number of log messages to include in the "Most recent plugin log messages" State value. Enter zero (0) to disable sending any log entries. Maximum value is 50.
Click to expand
Actions | Connectors | States
Name | Description | Format | On Hold |
---|---|---|---|
Connect & Update | Control connection to the Simulator, or perform various data update tasks. |
Plugin Action:
|
|
Action Repeat Interval | Set the default held action repeat rate, in milliseconds. The minimum value is 25ms. |
Repeat Interval:
|
☑ |
Activate a Selected Simulator Event | Activate a Selected Simulator Event. Parameter values are optional and event-specific. The list is imported from MSFS SDK Event IDs Docs (may contain errors or omissions). The value(s), if any, should evaluate to numeric or remain blank if the value is unused by the event. Using basic math operators and dynamic states in values is possible. |
System /
Category
|
☑ |
Activate a Named Simulator Event | Trigger any Simulator Event by name with optional parameter value(s). See MSFS SDK Documentation 'Event IDs' for reference. The value(s), if any, should evaluate to numeric or remain blank if the value is unused by the event. Using basic math operators and dynamic state values is possible. | Activate Event [text] with Value(s) 0: [number] 1: [number] 2: [number] 3: [number] 4: [number] | ☑ |
Activate an Input Event From HubHop | ** Requires WASimModule or MobiFlight. ** Trigger a Simulator Event from loaded HubHop data. "Potentiometer" type events are indicated with (@) in the name and are only supported with WASimModule (using the provided numeric value). |
Aircraft/Device:
|
☑ |
Set a Selected Simulator Variable | Set a Selected Simulator Variable. The list of Sim Vars is imported from MSFS SDK Simulator Variables Docs (may contain errors or omissions). Variables with ":N" in the name require an Index value. |
System /
Category
|
☑ |
Set a Selected Airplane Local Variable | Sets a value on a Local variable from currently loaded aircraft. The Unit type is usually "number" and will be ignored except in a few specific instances for some 3rd-party models. |
Set Variable:
|
☑ |
Set a Selected Input Event Value | Sets a value on an Input Event from currently loaded aircraft. These are sometimes also referred to as 'B' type variables and are always model-specific. The value meaning and type (numeric/string) depends entirely on the specific event. A list of Input Events can be found in the MSFS Dev Mode 'Behaviors' window. |
Set Input Event:
|
☑ |
Set a Named Variable | Set a Named Variable. Sets a value on any named variable of various types. ** Using 'C', 'H', 'K', and 'Z' types require WASimModule. ** 'L' type variables can also be created. 'A' and 'C' types require a Unit, for 'B' and 'L' it is optional (default is 'number'). For SimVars requiring an index, include it in the name after a : (colon), eg. "VARIABLE NAME:1". |
Variable
Type
|
☑ |
Execute Calculator Code | Execute Calculator Code. ** Requires WASimModule ** Runs any entered string of RPN code through the 'execute_calculator_code' Gauge API function. You may use TP state value macros to insert dynamic data. | Execute this code: [text] (must be valid RPN format) | ☑ |
Name | Description | Format |
---|---|---|
Action Repeat Interval | Set the default held action repeat rate, in milliseconds. The minimum value is 25ms. | Set Repeat Interval Milliseconds in Range (min: 25ms): [number (25)] - [number (25)] |
Activate a Selected Simulator Event | Activate a Selected Simulator Event, setting one parameter value with a slider, with optional extra parameter value(s). The list is imported from MSFS SDK Event IDs Docs. The extra value(s), if any, should evaluate to numeric or remain blank if the value is unused by the event. Using basic math operators and dynamic states in the extra values is possible. |
System /
Category
|
Activate a Named Simulator Event | Trigger any Simulator Event by name setting one parameter value with a slider, with optional extra parameter value(s). See MSFS SDK Documentation 'Event IDs' for reference. The extra value(s), if any, should evaluate to numeric or remain blank if the value is unused by the event. Using basic math operators and dynamic state the extra values is possible. |
Set Event: [text] in Value
Range [number] - [number] | With Other
| Values (opt) [number] [number] Connector
Value Index
|
Activate an Input Event From HubHop | ** Requires WASimModule or MobiFlight. ** Trigger a Simulator Event from loaded HubHop data. "Potentiometer" type events are indicated with (@) in the name and are only supported with WASimModule (using the provided numeric value). |
Aircraft
Device:
|
Set a Selected Simulator Variable | Set a Selected Simulator Variable. The list of Sim Vars is imported from MSFS SDK Simulator Variables Docs (may contain errors or omissions). Variables with ":N" in the name require an Index value. |
System /
Category
|
Set a Selected Airplane Local Variable | Sets a value on a Local variable from currently loaded aircraft. The Unit type is usually "number" and will be ignored except in a few specific instances for some 3rd-party models. |
Set Variable:
|
Set a Selected Input Event Value | Sets a value on an Input Event from currently loaded aircraft. These are sometimes also referred to as 'B' type variables and are always model-specific. The value meaning and type (numeric/string) depends entirely on the specific event. A list of Input Events can be found in the MSFS Dev Mode 'Behaviors' window. |
Set Input Event:
|
Set a Named Variable | Set a Named Variable. Sets a value on any named variable of various types. ** Using 'C', 'H', 'K', and 'Z' types require WASimModule. ** 'L' type variables can also be created. 'A' and 'C' types require a Unit, for 'B' and 'L' it is optional (default is 'number'). For SimVars requiring an index, include it in the name after a : (colon), eg. "VARIABLE NAME:1". |
Variable
Type
|
Execute Calculator Code | Runs any entered string of RPN code through the 'execute_calculator_code' Gauge API function. Use a '@' placeholder for the connector value. | Calculator Code: (use @ as placeholder(s) for slider value) [text] Value Range: [number] - [number] |
Visual Feedback Connector | This connector provides only visual feedback by setting the position of a slider based on an existing State/variable value. |
Set Connector Value Based on
Feedback From Category:
|
Base Id: MSFSTouchPortalPlugin.Plugin.State.
Id | SimVar Name | Description | Unit | Format | DefaultValue |
---|---|---|---|---|---|
LoadedStateConfigFiles | List of currently loaded state configuration file(s). | string | |||
LogMessages | Most recent plugin log messages. | string | |||
UserConfigFilesPath | Plugin configuration files path. | string | |||
CurrentTouchPortalPage | The current device Touch Portal page name. | string | |||
ActionRepeatInterval | The current Held Action Repeat Rate (ms) | millisecond | 450 | ||
EntryVersion | The loaded entry.tp plugin version number. | number | 0 | ||
RunningVersion | The running plugin version number. | number | 0 | ||
Connected | The status of SimConnect (true/false/connecting) | string | false | ||
TouchPortalConfigPath | Touch Portal configuration files path. | string |
Click to expand
Name | Description | Format | On Hold |
---|---|---|---|
Request a Selected Simulator Variable | Request a Selected Simulator Variable. The list of Sim Vars is imported from MSFS SDK Simulator Variables Docs (may contain errors or omissions). Variables with ":N" in the name require an Index value. |
System
|
|
Request an Airplane Local Variable | Request an Airplane Local Variable. ** Requires WASimModule for list (otherwise use "Request Named Variable") ** The list of variables is loaded live from the Simulator.The Unit type is usually "number" and will be ignored except in a few specific instances for some 3rd-party models. |
Request
Variable
|
|
Request an Input Event Value | Request an "Input Event" Value. The list of available variables is loaded live from the Simulator. Input Events are a.k.a. 'B' variables and are always model-specific. |
Request
Variable
|
|
Request a Named Variable | Request a Named Variable. ** Using types other than 'A', 'B', or 'L' requires WASimModule. ** 'A', 'C', & 'E' types require a Unit type, and for 'L' it is optional (default is 'number'). For SimVars requiring an index, include it in the name after a : (colon), eg. "VARIABLE NAME:1". |
Type
|
|
Request a Calculated Value | Request a Calculated Value. ** Requires WASimModule ** |
Calculator
Code [text] Result
Type
|
|
Update a Variable Value | Request a value update for an added variable. This is especially useful for variables with a "Once" type Update Period. |
From Category
|
|
Remove a Simulator Variable | Remove an existing Simulator Variable. |
From Category
|
|
Clear Variable Definitions | Removes either all or only custom-added variable state definitions. |
Clear Variables:
|
|
Load Variable Definitions From File | Load a set of variable state definitions from a configuration file. | Load definitions from file [text] (file name only for user config. folder, or full path with file name) | |
Save Variable Definitions To File | Save Variable Definitions To File. Save the current simulator variable state definitions to a configuration file. |
Save
|
Click to expand
Actions | Connectors | States
Name | Description | Format | Sim Event Mappings | On Hold |
---|---|---|---|---|
Airspeed Hold Value Adj/Sel/Hold |
Airspeed Hold Value -
|
|
☑ | |
Airspeed Hold Value Set | Set Airspeed Hold Value to [number (0.00 50000.00)] kts |
|
☑ | |
Altitude Hold Value Adj/Sel |
Altitude Hold Value -
|
|
☑ | |
Altitude Hold Value Set |
Altitude Hold Value
|
|
☑ | |
AP Switches |
Auto Pilot
|
|
||
Attitude Hold Pitch Value Adj/Sel |
Attitude Hold Pitch Value
|
|
☑ | |
Attitude Hold Pitch Value Set | Set Attitude Hold Pitch Value to [number (-16384 16384)] |
|
☑ | |
Auto Brake |
Auto Brake -
|
|
☑ | |
Auto Brake Set | Set Auto Brake Value to [number (0 4)] |
|
☑ | |
Auto Throttle |
Toggle Auto Throttle -
|
|
||
Flight Director Switches |
Toggle Flight Director
|
|
||
Heading Hold Value Adj/Sel |
Heading Hold Value -
|
|
☑ | |
Heading Hold Value Set | Set Heading Hold Value - [number (0.00 359.00)] |
|
☑ | |
Mach Hold Value Adjust/Hold |
Mach Hold Value -
|
|
☑ | |
Mach Hold Value Set | Set Mach Hold Value to [number (0.00 20.00)] |
|
☑ | |
Max. Bank Angle Adjust |
Max Bank Angle -
|
|
☑ | |
Max. Bank Set |
Set Max Bank
|
|
☑ | |
N1 Reference Value Adjust/Hold |
N1 Reference Value -
|
|
☑ | |
N1 Reference Value Set | Set N1 Reference Value to [number (0.00 150.00)] |
|
☑ | |
Nav Mode Select |
Select Nav Mode
|
|
||
Vertical Speed Value Adj/Sel/Hold |
Vertical Speed Value -
|
|
☑ | |
Vertical Speed Value Set |
Vertical Speed Hold
|
|
☑ |
Name | Description | Format | Sim Event Mappings |
---|---|---|---|
Airspeed Hold Value Set | Set Airspeed Hold in Value Range (kts): [number (0.00 50000.00)] - [number (0.00 50000.00)] |
|
|
Attitude Hold Pitch Value Set | Set Attitude Pitch Hold in Value Range: [number (-16384 16384)] - [number (-16384 16384)] |
|
|
Auto Brake Set | Set Auto Brake in Value Range: [number (0 4)] - [number (0 4)] |
|
|
Heading Hold Value Set | Set Heading Hold in Value Range: [number (0.00 359.00)] - [number (0.00 359.00)] |
|
|
Mach Hold Value Set | Set Mach Hold in Value Range: [number (0.00 20.00)] - [number (0.00 20.00)] |
|
|
Max. Bank Set |
Set Max Bank
|
|
|
N1 Reference Value Set | Set N1 Reference in Value Range: [number (0.00 150.00)] - [number (0.00 150.00)] |
|
|
Vertical Speed Value Set |
Vertical Speed Hold
|
|
Base Id: MSFSTouchPortalPlugin.AutoPilot.State.
Id | SimVar Name | Description | Unit | Format | DefaultValue |
---|---|---|---|---|---|
AutoThrottleArm | AUTOPILOT THROTTLE ARM | Auto Throttle Armed | Bool | ||
AutoThrottleGoAround | AUTOPILOT TAKEOFF POWER ACTIVE | Auto Throttle GoAround | Bool | ||
AutoPilotAirSpeedHold | AUTOPILOT AIRSPEED HOLD | AutoPilot Air Speed Status | Bool | ||
AutoPilotAirSpeedVar | AUTOPILOT AIRSPEED HOLD VAR | AutoPilot Air Speed Value | knots | 0.0# | |
AutoPilotAltitudeHold | AUTOPILOT ALTITUDE LOCK | AutoPilot Altitude Status | Bool | ||
AutoPilotAltitudeVar | AUTOPILOT ALTITUDE LOCK VAR | AutoPilot Altitude Value | feet | ||
AutoPilotApproachHold | AUTOPILOT APPROACH HOLD | AutoPilot Approach Status | Bool | ||
AutoPilotAttitudeHold | AUTOPILOT ATTITUDE HOLD | AutoPilot Attitude Status | Bool | ||
AutoPilotAvailable | AUTOPILOT AVAILABLE | AutoPilot Availability | Bool | ||
AutoPilotBackCourseHold | AUTOPILOT BACKCOURSE HOLD | AutoPilot Back Course Status | Bool | ||
AutoPilotFlightDirector | AUTOPILOT FLIGHT DIRECTOR ACTIVE | AutoPilot Flight Director Status | Bool | ||
AutoPilotHeadingVar | AUTOPILOT HEADING LOCK DIR | AutoPilot Heading Direction | degrees | F0 | |
AutoPilotHeadingHold | AUTOPILOT HEADING LOCK | AutoPilot Heading Status | Bool | ||
AutoPilotMach | AUTOPILOT MACH HOLD | AutoPilot Mach Hold | Bool | ||
AutoPilotMachVar | AUTOPILOT MACH HOLD VAR | AutoPilot Mach Value | number | 0.## | |
AutoPilotMaster | AUTOPILOT MASTER | AutoPilot Master Status | Bool | ||
AutoPilotBanking | AUTOPILOT MAX BANK | AutoPilot Max Bank Angle | degrees | F2 | |
AutoPilotNavSelected | AUTOPILOT NAV SELECTED | AutoPilot Nav Selected Index | number | ||
AutoPilotNav1Hold | AUTOPILOT NAV1 LOCK | AutoPilot Nav1 Status | Bool | ||
AutoPilotAttitudeVar | AUTOPILOT PITCH HOLD REF | AutoPilot Pitch Reference Value | degrees | F2 | |
AutoPilotVerticalSpeedHold | AUTOPILOT VERTICAL HOLD | AutoPilot Vertical Speed Status | Bool | ||
AutoPilotVerticalSpeedVar | AUTOPILOT VERTICAL HOLD VAR | AutoPilot Vertical Speed Value | feet/minute | ||
AutoPilotWingLeveler | AUTOPILOT WING LEVELER | AutoPilot Wing Leveler | Bool | ||
AutoPilotFlightDirectorCurrentBank | AUTOPILOT FLIGHT DIRECTOR BANK | Flight Director Current Bank | degrees | F2 | |
AutoPilotFlightDirectorCurrentPitch | AUTOPILOT FLIGHT DIRECTOR PITCH | Flight Director Current Pitch | degrees | F2 | |
AutoPilotPitchHold | AUTOPILOT PITCH HOLD | The status of Auto Pilot Pitch Hold button | Bool | ||
AutoPilotYawDampener | AUTOPILOT YAW DAMPER | Yaw Dampener Status | Bool |
Click to expand
Actions | Connectors | States
Name | Description | Format | Sim Event Mappings | On Hold |
---|---|---|---|---|
ADF Adjust |
ADF
|
|
☑ | |
ADF Values Set |
Set ADF
|
|
☑ | |
Radio Interaction |
Radio
|
|
☑ | |
Radio Values Set |
Set Radio
|
|
☑ | |
Transponder Adjust |
Transponder Action:
|
|
☑ | |
Transponder Set |
Set Transponder
|
|
Name | Description | Format | Sim Event Mappings |
---|---|---|---|
ADF Values Set |
Set ADF
|
|
|
Radio Values Set |
Set Radio
|
|
Base Id: MSFSTouchPortalPlugin.Communication.State.
Id | SimVar Name | Description | Unit | Format | DefaultValue |
---|---|---|---|---|---|
Com1ActiveFrequency | COM ACTIVE FREQUENCY:1 | The frequency of the active COM1 radio | MHz | 0.000# | |
Com2ActiveFrequency | COM ACTIVE FREQUENCY:2 | The frequency of the active COM2 radio | MHz | 0.000# | |
Nav1ActiveFrequency | NAV ACTIVE FREQUENCY:1 | The frequency of the active NAV1 radio | MHz | 0.000# | |
Nav2ActiveFrequency | NAV ACTIVE FREQUENCY:2 | The frequency of the active NAV2 radio | MHz | 0.000# | |
Com1StandbyFrequency | COM STANDBY FREQUENCY:1 | The frequency of the standby COM1 radio | MHz | 0.000# | |
Com2StandbyFrequency | COM STANDBY FREQUENCY:2 | The frequency of the standby COM2 radio | MHz | 0.000# | |
Nav1StandbyFrequency | NAV STANDBY FREQUENCY:1 | The frequency of the standby NAV1 radio | MHz | 0.000# | |
Nav2StandbyFrequency | NAV STANDBY FREQUENCY:2 | The frequency of the standby NAV2 radio | MHz | 0.000# |
Click to expand
Actions | Connectors | States
Name | Description | Format | Sim Event Mappings | On Hold |
---|---|---|---|---|
Alternator Control |
|
|
||
Alternator Toggle |
Toggle Alternator -
|
|
||
Avionics Master Switch |
Avionics
|
|
||
External Power | External Power Control. |
External Power
|
|
|
Landing Lights Switch/Direction |
Landing Lights
|
|
||
Light Dimming |
Set Light Potentiometer
|
|
☑ | |
Light Switch Control | Light Switch Controls. NOTE: The 'All' and 'Circuit' types can only be Toggled. |
Switch
|
|
|
Master Battery | Toggle Master Battery |
|
||
Master Battery & Alternator | Toggle Master Battery & Alternator |
|
Name | Description | Format | Sim Event Mappings |
---|---|---|---|
Light Dimming |
Set Light Potentiometer
|
|
Base Id: MSFSTouchPortalPlugin.Electrical.State.
Id | SimVar Name | Description | Unit | Format | DefaultValue |
---|---|---|---|---|---|
AvionicsMasterSwitch | AVIONICS MASTER SWITCH | Avionics Master Switch | Bool | ||
LightBeaconOn | LIGHT BEACON | Light Beacon Switch Status | Bool | ||
LightBrakeOn | LIGHT BRAKE ON | Light Brake Switch or Light Status | Bool | ||
LightCabinOn | LIGHT CABIN | Light Cabin Switch Status | Bool | ||
LightHeadOn | LIGHT HEAD ON | Light Head Switch or Light Status | Bool | ||
LightLandingOn | LIGHT LANDING | Light Landing Switch Status | Bool | ||
LightLogoOn | LIGHT LOGO | Light Logo Switch Status | Bool | ||
LightNavOn | LIGHT NAV | Light Nav Switch Status | Bool | ||
LightPanelOn | LIGHT PANEL | Light Panel Switch Status | Bool | ||
LightRecognitionOn | LIGHT RECOGNITION | Light Recognition Switch Status | Bool | ||
LightStrobeOn | LIGHT STROBE | Light Strobe Switch Status | Bool | ||
LightTaxiOn | LIGHT TAXI | Light Taxi Switch Status | Bool | ||
LightWingOn | LIGHT WING | Light Wing Switch Status | Bool | ||
MasterAlternator | GENERAL ENG MASTER ALTERNATOR:1 | Master Alternator Status | Bool | ||
MasterBattery | ELECTRICAL MASTER BATTERY | Master Battery Status | Bool |
Click to expand
Actions | Connectors | States
Name | Description | Format | Sim Event Mappings | On Hold |
---|---|---|---|---|
Afterburner Toggle |
Toggle Afterburner(s):
|
|
||
Condition Lever Adjust |
Condition Lever
|
|
☑ | |
Condition Lever Set |
Set Condition Lever
|
|
☑ | |
Engine Auto Start/Shutdown | Start/Shutdown Engine |
Engine -
|
|
|
Engine Master Set |
Set Engine
|
|
||
Engine Master Toggle |
Toggle Engine Master Switch
|
|
||
Magnetos Switch - All |
All Magnetos -
|
|
||
Magnetos Switch - Individual |
Magneto
|
|
||
Magnetos Switch Set |
Set Magneto Switch
|
|
||
Master Ignition Switch | Toggle Master Ignition Switch | Toggle Master Ignition Switch |
|
|
Mixture Adjust - All |
All Mixtures -
|
|
☑ | |
Mixture Adjust - Individual |
Mixture
|
|
☑ | |
Mixture Set |
Set Mixture
|
|
☑ | |
Primers |
Toggle Primer(s):
|
|
||
Propeller Pitch Adjust |
Pitch
|
|
☑ | |
Propeller Pitch Set |
Set Propeller
|
|
☑ | |
Starters Set |
Starter
|
|
☑ | |
Starters Toggle |
Toggle Starter -
|
|
||
Throttle Adjust - All |
All Throttles -
|
|
☑ | |
Throttle Adjust - Individual |
Throttle
|
|
☑ | |
Throttle Set |
Set Throttle
|
|
☑ |
Name | Description | Format | Sim Event Mappings |
---|---|---|---|
Condition Lever Set |
Set Condition Lever
|
|
|
Magnetos Switch Set |
Set Magneto Switch
|
|
|
Mixture Set |
Set Mixture
|
|
|
Propeller Pitch Set |
Set Propeller
|
|
|
Throttle Set |
Set Throttle
|
|
Base Id: MSFSTouchPortalPlugin.Engine.State.
Id | SimVar Name | Description | Unit | Format | DefaultValue |
---|---|---|---|---|---|
MasterIgnitionSwitch | MASTER IGNITION SWITCH | Master Ignition Switch Status | Bool | ||
MixtureEngine1 | GENERAL ENG MIXTURE LEVER POSITION:1 | Mixture - Engine 1 - Percentage | percent | 0.0# | |
MixtureEngine2 | GENERAL ENG MIXTURE LEVER POSITION:2 | Mixture - Engine 2 - Percentage | percent | 0.0# | |
MixtureEngine3 | GENERAL ENG MIXTURE LEVER POSITION:3 | Mixture - Engine 3 - Percentage | percent | 0.0# | |
MixtureEngine4 | GENERAL ENG MIXTURE LEVER POSITION:4 | Mixture - Engine 4 - Percentage | percent | 0.0# | |
Propeller1FeatherSw | PROP FEATHER SWITCH:1 | Propeller - Engine 1 - Feather Switch State (bool) | Bool | ||
Propeller1Feathered | PROP FEATHERED:1 | Propeller - Engine 1 - Feathered (bool) | Bool | ||
PropellerEngine1 | GENERAL ENG PROPELLER LEVER POSITION:1 | Propeller - Engine 1 - Percentage | percent | 0.0# | |
Propeller2FeatherSw | PROP FEATHER SWITCH:2 | Propeller - Engine 2 - Feather Switch State (bool) | Bool | ||
Propeller2Feathered | PROP FEATHERED:2 | Propeller - Engine 2 - Feathered (bool) | Bool | ||
PropellerEngine2 | GENERAL ENG PROPELLER LEVER POSITION:2 | Propeller - Engine 2 - Percentage | percent | 0.0# | |
Propeller3FeatherSw | PROP FEATHER SWITCH:3 | Propeller - Engine 3 - Feather Switch State (bool) | Bool | ||
Propeller3Feathered | PROP FEATHERED:3 | Propeller - Engine 3 - Feathered (bool) | Bool | ||
PropellerEngine3 | GENERAL ENG PROPELLER LEVER POSITION:3 | Propeller - Engine 3 - Percentage | percent | 0.0# | |
Propeller4FeatherSw | PROP FEATHER SWITCH:4 | Propeller - Engine 4 - Feather Switch State (bool) | Bool | ||
Propeller4Feathered | PROP FEATHERED:4 | Propeller - Engine 4 - Feathered (bool) | Bool | ||
PropellerEngine4 | GENERAL ENG PROPELLER LEVER POSITION:4 | Propeller - Engine 4 - Percentage | percent | 0.0# | |
RPMN1Engine1 | ENG N1 RPM:1 | RPM - Engine 1 | percent | 0.0# | |
RPMN1Engine2 | ENG N1 RPM:2 | RPM - Engine 2 | percent | 0.0# | |
RPMN1Engine3 | ENG N1 RPM:3 | RPM - Engine 3 | percent | 0.0# | |
RPMN1Engine4 | ENG N1 RPM:4 | RPM - Engine 4 | percent | 0.0# | |
RPMPropeller1 | PROP RPM:1 | RPM - Propeller 1 | rpm | 0.0# | |
RPMPropeller2 | PROP RPM:2 | RPM - Propeller 2 | rpm | 0.0# | |
RPMPropeller3 | PROP RPM:3 | RPM - Propeller 3 | rpm | 0.0# | |
RPMPropeller4 | PROP RPM:4 | RPM - Propeller 4 | rpm | 0.0# | |
ThrottleEngine1 | GENERAL ENG THROTTLE LEVER POSITION:1 | Throttle - Engine 1 - Percentage | percent | 0.# | |
ThrottleEngine2 | GENERAL ENG THROTTLE LEVER POSITION:2 | Throttle - Engine 2 - Percentage | percent | 0.# | |
ThrottleEngine3 | GENERAL ENG THROTTLE LEVER POSITION:3 | Throttle - Engine 3 - Percentage | percent | 0.# | |
ThrottleEngine4 | GENERAL ENG THROTTLE LEVER POSITION:4 | Throttle - Engine 4 - Percentage | percent | 0.# |
Click to expand
Actions | Connectors | States
Name | Description | Format | Sim Event Mappings | On Hold |
---|---|---|---|---|
Anti Ice System Set |
Set
|
|
☑ | |
Anti Ice System Switches | NOTE: Structural and Propeller De Ice can only be Toggled. |
|
|
Name | Description | Format | Sim Event Mappings |
---|---|---|---|
Anti Ice System Set |
Set
|
|
Base Id: MSFSTouchPortalPlugin.Environment.State.
Id | SimVar Name | Description | Unit | Format | DefaultValue |
---|---|---|---|---|---|
AntiIceEng1 | GENERAL ENG ANTI ICE POSITION:1 | Anti-Ice Engine 1 | Bool | ||
AntiIceEng2 | GENERAL ENG ANTI ICE POSITION:2 | Anti-Ice Engine 2 | Bool | ||
AntiIceEng3 | GENERAL ENG ANTI ICE POSITION:3 | Anti-Ice Engine 3 | Bool | ||
AntiIceEng4 | GENERAL ENG ANTI ICE POSITION:4 | Anti-Ice Engine 4 | Bool | ||
AntiIcePanelSwitch | PANEL ANTI ICE SWITCH | Panel Anti-Ice Switch | Bool | ||
PitotHeat | PITOT HEAT | Pitot Heat Status | Bool | ||
PitotHeatSwitch1 | PITOT HEAT SWITCH:1 | Pitot Heat Switch 1 State (0=Off; 1=On; 2=Auto) | Enum | ||
PitotHeatSwitch2 | PITOT HEAT SWITCH:2 | Pitot Heat Switch 2 State (0=Off; 1=On; 2=Auto) | Enum | ||
PitotHeatSwitch3 | PITOT HEAT SWITCH:3 | Pitot Heat Switch 3 State (0=Off; 1=On; 2=Auto) | Enum | ||
PitotHeatSwitch4 | PITOT HEAT SWITCH:4 | Pitot Heat Switch 4 State (0=Off; 1=On; 2=Auto) | Enum | ||
AntiIcePropeller1Switch | PROP DEICE SWITCH:1 | Propeller 1 Deice Switch | Bool | ||
AntiIcePropeller2Switch | PROP DEICE SWITCH:2 | Propeller 2 Deice Switch | Bool | ||
AntiIcePropeller3Switch | PROP DEICE SWITCH:3 | Propeller 3 Deice Switch | Bool | ||
AntiIcePropeller4Switch | PROP DEICE SWITCH:4 | Propeller 4 Deice Switch | Bool | ||
AntiIceStructuralSwitch | STRUCTURAL DEICE SWITCH | Structural Deice Switch | Bool | ||
AntiIceWindshieldSwitch | WINDSHIELD DEICE SWITCH | Windshield Deice Switch | Bool |
Click to expand
Base Id: MSFSTouchPortalPlugin.FlightInstruments.State.
Id | SimVar Name | Description | Unit | Format | DefaultValue |
---|---|---|---|---|---|
AirSpeedIndicated | AIRSPEED INDICATED | Air Speed indicated (knots) | knots | 0.0# | |
AirSpeedMach | AIRSPEED MACH | Air Speed indicated (Mach) | mach | 0.0# | |
AirSpeedTrue | AIRSPEED TRUE | Air Speed true (knots) | knots | 0.0# | |
PlaneAltitudeAGL | PLANE ALT ABOVE GROUND | Altitude Above Ground (feet) | feet | 0.# | |
PlaneAltitudeIndicated | INDICATED ALTITUDE | Altitude Indicated (feet) | feet | F1 | |
PlaneAltitude | PLANE ALTITUDE | Altitude True (feet) | feet | 0.# | |
PlaneBankAngle | PLANE BANK DEGREES | Bank Angle (degrees) | degrees | F0 | |
FlapSpeedExceeeded | FLAP SPEED EXCEEDED | Flap Speed Exceeded Warning (0/1) | Bool | ||
GroundAltitude | GROUND ALTITUDE | Ground level (feet) | feet | 0.# | |
GroundVelocity | GROUND VELOCITY | Ground Speed (knots) | knots | 0.0# | |
PlaneHeadingMagnetic | PLANE HEADING DEGREES MAGNETIC | Heading (Magnetic North) (degrees) | degrees | F0 | |
PlaneHeadingTrue | PLANE HEADING DEGREES TRUE | Heading (True North) (degrees) | degrees | F0 | |
OverspeedWarning | OVERSPEED WARNING | Overspeed Warning (0/1) | Bool | ||
PlanePitchAngle | PLANE PITCH DEGREES | Pitch Angle (degrees) | degrees | F0 | |
StallWarning | STALL WARNING | Stall Warning (0/1) | Bool | ||
VerticalSpeed | VERTICAL SPEED | Vertical Speed (f/m) | feet/minute | 0.0# |
Click to expand
Actions | Connectors | States
Name | Description | Format | Sim Event Mappings | On Hold |
---|---|---|---|---|
Aileron Trim Adjust |
Adjust Aileron Trim
|
|
☑ | |
Aileron Trim Set | Set Aileron Trim to [number (-100 100)] % |
|
☑ | |
Ailerons Adjust |
Adjust Ailerons
|
|
☑ | |
Ailerons Set | Set Ailerons | Set Ailerons to [number (-16384 16384)] |
|
☑ |
Brake Axis Set |
Set Brake Axis
|
|
☑ | |
Brakes Activate |
Activate
|
|
☑ | |
Cowl Flap Levers Adjust |
Cowl Flaps Lever
|
|
☑ | |
Cowl Flaps Lever Set |
Set Cowl
|
|
☑ | |
Elevator Adjust |
Adjust Elevator
|
|
☑ | |
Elevator Set | Set Elevator | Set Elevator to [number (-16384 16384)] |
|
☑ |
Elevator Trim Adjust |
Adjust Elevator Trim
|
|
☑ | |
Elevator Trim Set | Set Elevator Trim to [number (-16384 16384)] |
|
☑ | |
Flaps Adjust |
Flaps
|
|
||
Flaps Handle Set | Set Flaps Handle Position | Set Flaps Handle to [number (0 16384)] |
|
☑ |
Gear Manipulation |
Gear
|
|
☑ | |
Parking Brake Toggle | Toggle the Parking Brake On/Off |
|
||
Rudder Adjust |
Adjust Rudder
|
|
☑ | |
Rudder Set | Set Rudder | Set Rudder to [number (-16384 16384)] |
|
☑ |
Rudder Trim Adjust |
Adjust Rudder Trim
|
|
☑ | |
Rudder Trim Set | Set Rudder Trim to [number (-100 100)] % |
|
☑ | |
Spoilers Action |
Spoilers
|
|
||
Spoilers Arm |
Spoilers Arm
|
|
||
Spoilers Set | Set Spoilers handle position to [number (0 16384)] |
|
☑ |
Name | Description | Format | Sim Event Mappings |
---|---|---|---|
Aileron Trim Set | Set Aileron Trim in Value Range (%): [number (-100 100)] - [number (-100 100)] |
|
|
Ailerons Set | Set Ailerons | Set Ailerons in Value Range: [number (-16384 16384)] - [number (-16384 16384)] |
|
Brake Axis Set |
Set Brake Axis
|
|
|
Cowl Flaps Lever Set |
Set Cowl
|
|
|
Elevator Set | Set Elevator | Set Elevator in Value Range: [number (-16384 16384)] - [number (-16384 16384)] |
|
Elevator Trim Set | Set Elevator Trim in Value Range: [number (-16384 16384)] - [number (-16384 16384)] |
|
|
Flaps Handle Set | Set Flaps Handle Position | Set Flaps Handle in Value Range: [number (0 16384)] - [number (0 16384)] |
|
Rudder Set | Set Rudder | Set Rudder in Value Range: [number (-16384 16384)] - [number (-16384 16384)] |
|
Rudder Trim Set | Set Rudder Trim in Value Range (%): [number (-100 100)] - [number (-100 100)] |
|
|
Spoilers Set | Set Spoilers Handle Position in Value Range: [number (0 16384)] - [number (0 16384)] |
|
Base Id: MSFSTouchPortalPlugin.FlightSystems.State.
Id | SimVar Name | Description | Unit | Format | DefaultValue |
---|---|---|---|---|---|
AileronTrim | AILERON TRIM | Aileron Trim Angle | degrees | F2 | |
AileronTrimPct | AILERON TRIM PCT | Aileron Trim Percent | percent | F1 | 0 |
CowlFlaps1Percent | RECIP ENG COWL FLAP POSITION:1 | Cowl Flaps 1 Opened Percentage | percent | F1 | |
CowlFlaps2Percent | RECIP ENG COWL FLAP POSITION:2 | Cowl Flaps 2 Opened Percentage | percent | F1 | |
CowlFlaps3Percent | RECIP ENG COWL FLAP POSITION:3 | Cowl Flaps 3 Opened Percentage | percent | F1 | |
CowlFlaps4Percent | RECIP ENG COWL FLAP POSITION:4 | Cowl Flaps 4 Opened Percentage | percent | F1 | |
ElevatorTrim | ELEVATOR TRIM POSITION | Elevator Trim Angle | degrees | F2 | |
ElevatorTrimPct | ELEVATOR TRIM PCT | Elevator Trim Percent | percent | F1 | 0 |
FlapsHandlePercent | FLAPS HANDLE PERCENT | Flaps Handle Percentage | percent | F1 | |
ParkingBrakeIndicator | BRAKE PARKING POSITION | Parking Brake Indicator (0/1) | Bool | ||
RudderTrim | RUDDER TRIM | Rudder Trim Angle | degrees | F2 | |
RudderTrimPct | RUDDER TRIM PCT | Rudder Trim Percent | percent | F1 | 0 |
SpoilersArmed | SPOILERS ARMED | Spoilers Armed (0/1) | Bool | 0 | |
SpoilersAvailable | SPOILER AVAILABLE | Spoilers Available (0/1) | Bool | 0 | |
SpoilersHandlePosition | SPOILERS HANDLE POSITION | Spoilers Handle Position (0 - 16384) | position 16k | 0 | |
SpoilersLeftPosition | SPOILERS LEFT POSITION | Spoilers Left Position Percent | percent | F1 | 0 |
SpoilersRightPosition | SPOILERS RIGHT POSITION | Spoilers Right Position Percent | percent | F1 | 0 |
GearTotalExtended | GEAR TOTAL PCT EXTENDED | Total percentage of gear extended | percent | F0 |
Click to expand
Name | Description | Format | Sim Event Mappings | On Hold |
---|---|---|---|---|
Add Fuel | Add Fuel (1 to 65535 or zero for 25% of capacity) | Add [number (0 65535)] amount of Fuel |
|
☑ |
Cross Feed Switch |
Cross Feed -
|
|
||
Electric Fuel Pump Set |
Set Electric Fuel Pump
|
|
||
Electric Fuel Pump Toggle |
Toggle Electric Fuel Pump:
|
|
||
Fuel Dump / Tank Drop |
Action:
|
|
||
Fuel Selectors |
Fuel Selector
|
|
||
Fuel System Component |
Set
|
|
||
Fuel Valve |
Toggle Fuel Valve:
|
|
||
Refuel & Repair |
Action:
|
|
Name | Description | Format | Sim Event Mappings |
---|---|---|---|
Add Fuel | Add Fuel (1 to 65535 or zero for 25% of capacity) | Add Fuel in Value Range: [number (0 65535)] - [number (0 65535)] |
|
Click to expand
Actions | Connectors | States | Events
Name | Description | Format | Sim Event Mappings | On Hold |
---|---|---|---|---|
Adjust a Selected Value (+/-) | This action affects any value previously "selected" with some other action (such as AP settings, frequencies, etc). |
|
|
☑ |
Failures |
Toggle Failure -
|
|
||
Pause - Full | A "full" pause stops the simulation completely, including any time passing in the simulated world. Same as "Dev Mode Pause." | Set Full Pause to [number (0.00 1.00)] (0/1) |
|
|
Pause - Simulator | A "simulator" pause stops some aspects of the simulation, but not time. Same as the "Menu (ESC) Pause" but w/out the actual menu. |
|
|
|
Simulation Rate Adjust |
|
|
☑ | |
Simulation Rate Set | Set Simulation Rate to [number (0.00 50000.00)] |
|
☑ |
Name | Description | Format | Sim Event Mappings |
---|---|---|---|
Simulation Rate Set | Set Simulation Rate in Value Range: [number] - [number] |
|
Base Id: MSFSTouchPortalPlugin.SimSystem.State.
Id | SimVar Name | Description | Unit | Format | DefaultValue |
---|---|---|---|---|---|
AtcId | ATC ID | Aircraft Id used by ATC | string | ||
AircraftTitle | TITLE | Aircraft Title | string | ||
AtcAirline | ATC AIRLINE | Airline used by ATC | string | ||
SimSystemEventData | Data from the most recent Simulator System Event, if any. | string | |||
AtcFlightNumber | ATC FLIGHT NUMBER | Flight Number used by ATC | string | ||
AtcModel | ATC MODEL | Model of aircraft used by ATC | string | ||
SimSystemEvent | Most recent Simulator System Event name. | string | |||
SimPauseState | Simulator Pause State Flag(s) (OFF | FULL | ACTIVE | SIM) | |
SimulationRate | SIMULATION RATE | The current simulation rate | number | ||
AtcType | ATC TYPE | Type of aircraft used by ATC | string |
Name | Id | Evaluated State Id | Format |
---|---|---|---|
Simulator System Event | SimSystem.Event.SimSystemEvent | SimSystem.State.SimSystemEvent | On Simulator Event [ select ]
|
- Home
- Plugin Reference MSFS 20/24
- Plugin Reference FS-X/P3D/SimConnect
- Pages Buttons and Graphics
- Using Custom States and Simulator Variables
- Multiple Touch Portal Device Setup
- Tips And Tricks For Setting Simulator Values
- Reverse Polish Notation Tips
- List of Published Touch Portal Pages for MSFS Plugin
- Using With MobiFlight (outdated)