Simulation Variable Units
This page lists the different units of measurement that can be used when accessing or setting the different simulation variables.
Length
| Units | Description |
|---|---|
metermetersm | The meter is the base unit of length in the International System of Units (SI). 1m is equal to 3.28084 imperial feet. |
meter scaler 256meters scaler 256 | This is the same as the meter (above) only scaled by 1/256, ie: VALUE / 256. |
millimetermillimeters | The millimeter is an SI unit of length, equal to one thousandth of a meter. 1mm is equal to 0.0393701 inches. |
centimetercentimeterscm | A centimeter is an SI unit of length, equal to one hundredth of a meter. 1cm is equal to 0.393701 imperial inches. |
kilometerkilometerskm | The kilometer is an SI unit of length, equal to one thousand meters. 1km is equal to 0.621371 imperial miles. |
nautical milenautical milesnmilenmiles | A nautical mile is a unit of length used in air and marine navigation. The nautical mile is defined as exactly 1852 meters (6076 ft or 1.151 miles). |
decinmiledecinmiles | This is one tenth of a nautical mile, equivalent to 185.2 meters (607.61 ft). |
inchinchesin | The inch is an imperial unit of length derived as 1/12th of a foot. It is equal to 25.4 mm. |
footfeetft | The foot is an imperial unit of length, considered as 12 inches in length. It is equal to 0.3048 meters. |
yardyards | The yard is an imperial unit of length that comprises 3 feet or 36 inches, and 1,760 yards is equal to 1 mile. It is equal to 0.9144 meters. |
decimiledecimiles | This is one tenth of an imperial mile, equivalent to 160.93 meters. |
milemiles | The mile is an imperial unit of length, equivalent to 1,609.34 meters. |
Area
| Units | Description |
|---|---|
square inchsquare inchessq inin2 | A square inch is an imperial unit of area, equal to the area of a square with sides of one inch. It is equal to 6.4516cm². |
square feetsquare footsq ftft2 | A square foot is an imperial unit of area, equal to the area of a square with sides of one foot. It is equal to 929.03cm² or 144in². |
square yardsquare yardssq ydyd2 | A square yard is an imperial unit of area, equal to the area of a square with sides of one yard. It is equal to 0.83612736m² or 9ft². |
square milesquare miles | A square mile is an imperial unit of area, equal to the area of a square with sides of one mile. It is equal to 2.58999km². |
square millimetersquare millimeterssq mmmm2 | A square millimeter is an SI unit of area, equal to the area of a square with sides of one millimeter. It is equal to 0.0393701in². |
square centimetersquare centimeterssq cmcm2 | A square centimeter is an SI unit of area, equal to the area of a square with sides of one centimeter. It is equal to 0.155in². |
square metersquare meterssq mm2 | A square meter is an SI unit of area, equal to the area of a square with sides of one meter. It is equal to 10.7639ft². |
square kilometersquare kilometerssq kmkm2 | A square kilometer is an SI unit of area, equal to the area of a square with sides of one kilometer. It is equal to 0.386102miles². |
Volume
| Units | Description |
|---|---|
cubic inchcubic inchescu inin3 | A cubic inch is an imperial unit of area, equal to the area of a cube with sides of one inch. It is equal to 16.3871cm³. |
cubic footcubic feetcu ftft3 | A cubic foot is an imperial unit of area, equal to the area of a cube with sides of one foot. It is equal to 28316.917cm³ or 1728.01in³. |
cubic yardcubic yardscu ydyd3 | A cubic yard is an imperial unit of area, equal to the area of a cube with sides of one yard. It is equal to 0.764555m³ or 27ft³. |
cubic milecubic miles | A cubic mile is an imperial unit of area, equal to the area of a cube with sides of one mile. It is equal to 4.16818km³. |
cubic millimetercubic millimeterscu mmmm3 | A cubic millimeter is an SI unit of area, equal to the area of a cube with sides of one millimeter. |
cubic centimetercubic centimeterscu cmcm3 | A cubic centimeter is an SI unit of area, equal to the area of a cube with sides of one centimeter. It is equal to 0.0610237in³. |
cubic metercubic metersmeter cubedmeters cubedcu mm3 | A cubic meter is an SI unit of area, equal to the area of a cube with sides of one meter. It is equal to 35.3147ft³. |
cubic kilometercubic kilometerscu kmkm3 | A cubic kilometer is an SI unit of area, equal to the area of a cube with sides of one kilometer. It is equal to 0.239913miles³. |
literliters | The liter is an SI unit of volume based on the mass of one kilogram of liquid water. It is equal to 0.264172gallons. |
gallongallons | The gallon is an imperial unit of volume, defined as 231in³. It is equal to 3.785412 litres. |
quartquarts | The quart is an imperial unit of volume defined as 1 quarter of a gallon, or 57.75in³. It is equal to 0.946353 litres. |
fs7 oil quantity | This is an imperial unit derived from quarts and gallons and only used when dealing with engine oil amounts. The formula used to derive the unit is: VALUE * ((8 / 32767) * (0.25 * (3.785411784 * 0.001))) |
Temperature
| Units | Description |
|---|---|
kelvin | The kelvin is the base unit of temperature in the International System of Units (SI). The kelvin is the primary unit of temperature measurement for the physical sciences, but is often used in conjunction with the degree Celsius - which has the same magnitude - where 0 kelvin (called “Absolute Zero”) corresponds to a temperature of -273.15°C. “Absolute Zero” is the equivalent -459.67°F. |
rankine | The Rankine is a base unit of temperature, similar to the kelvin as 0 Rankine is the same as “Absolute Zero” kelvin. However the difference of 1 Rankine is defined as equal to 1 Fahrenheit degree, rather than the Celsius degree used on the kelvin scale. A temperature of 0K is equal to 0R which is the equivalent of -273.15°C or -459.67°F. |
farenheitfahrenheit | The Fahrenheit scale is a temperature scale based on two fixed points: the temperature at which pure water ice melts (32°F) and the temperature at which water boils (212°F) both at sea level and under standard atmospheric pressure. 0°F is equal to 255.372K, 459.67R or -17.7778°C. |
celsius | The Celsius scale is a temperature scale based on 0°C for the freezing point of water and 100 °C for the boiling point of water at 1 atmosphere of pressure. 0°C is equal to 273.15K, 491.67R or 32°F |
celsius fs7 egt | This the same as the Celsius unit only scaled by the following formula: VALUE / (1.8 * (6144 / 2060)). |
celsius fs7 oil temp | This the same as the Celsius unit only scaled by the following formula: (VALUE - 273.15) * (16384 / 140.0). It is only used when dealing with engine oil temperature. |
celsius scaler 1/256 | This unit is for degrees Celsius scaled by 1/256, eg: VALUE / 256. |
celsius scaler 256 | This unit is for degrees Celsius scaled by 256, eg: VALUE * 256. |
celsius scaler 16k | This unit is for degrees Celsius scaled by 16K, eg: VALUE * 16384.0. |
Angles
| Units | Description |
|---|---|
radianradians | The radian is the base unit of temperature in the International System of Units (SI). One radian is defined as the angle subtended from the center of a circle which intercepts an arc equal in length to the radius of the circle. 1 radian is equivalent to 57.296°. |
roundrounds | A round is defined as an angle of the full 360 degrees (ie: a circle). |
degreedegreesDegrees | The degree (°) is a base unit of angle defined such that an entire rotation is 360 degrees. 1° is equal to 0.0174533 radians. |
gradgrads | The grad (or gradian) is a unit of measurement of an angle, defined as one hundredth of the right angle. 1 grad is equal to 90°, or 1.5708 radians. |
angl16degree angl16degrees angl16 | This represents a unit that is a radian cast as a 16bit integer using the following formula: round(VALUE) / 65536.0 |
angl32degree angl32degrees angl32 | This represents a unit that is a radian cast as a 32bit integer using the following formula: round(VALUE) / (65536.0 * 65536.0) |
Global position
| Units | Description |
|---|---|
degree latitudedegrees latitude | A degree latitude is an angle used to measure the geographic position along the North-South axis of the Earth, over it’s surface. Degrees latitude range from 0° at the Equator to +90° at the North pole or -90° at the South pole. |
degree longitudedegrees longitude | A degree longitude is an angle used to measure the geographic position along the East-West axis of the Earth, over it’s surface. Degrees longitude range from 0° at the Prime Meridian to +180° Eastward and -180° Westward. |
meter latitudemeters latitude | A meter latitude is defined as the number of degrees traveled for a meter of circumference of the Earth. Essentially this equals meters * (360 / 40007000). |
Angular velocity
| Units | Description |
|---|---|
radian per secondradians per second | This is a unit of measurement that defines the number of radians that something will rotate for every second of time that passes. |
revolution per minuterevolutions per minuterpmrpms | This is a unit of measurement that defines the number of full revolutions that something will complete for every minute of time that passes. A revolution is considered as a rotation of 360°. |
rpm 1 over 16k | This is the same as the rpm unit, only scaled by 16K using the formula: VALUE / 16384.0 |
minute per roundminutes per round | This is a unit of measurement that defines the number minutes that something will require for to complete a full round. A round is considered as a rotation of 360°. |
nice minute per roundnice minutes per round | This is a unit of measurement that defines the number minutes that something will require for to complete a full round. A round is considered as a rotation of 360°. |
degree per seconddegrees per second | This is a unit of measurement that defines the number of degrees that something will rotate for every second of time that passes. |
degree per second ang16degrees per second ang16 | This is a unit of measurement that defines the number of degrees that something will rotate for every second of time that passes. The value is cast as a 16bit integer using the following formula: round(VALUE) / 65536.0 |
Angular acceleration
| Units | Description |
|---|---|
radian per second squaredradians per second squared | This is the unit of angular (rotational) acceleration magnitude in the International System of Units (SI). Essentially it is the rate of change of angular speed or velocity by one radian per second during a one second period. |
degree per second squareddegrees per second squared | This is a unit of angular (rotational) acceleration magnitude. Essentially it is the rate of change of angular speed or velocity by one degree per second during a one second period. |
Speed
| Units | Description |
|---|---|
meter per secondmeters/secondm/s | The metre per second is a unit of both speed and velocity in the International System of Units (SI). It is equal to the speed of a body covering a distance of one metre in one second of time. |
meter per second scaler 256meters per second scaler 256 | This is the same as the meter per second (above) only scaled by 1/256, ie: VALUE / 256. |
meter per minutemeters per minute | The metre per minute is a unit of both speed and velocity in the metric system. It is equal to the speed of a body covering a distance of one metre in one minute of time. |
kilometer/hourkilometers/hourkilometers per hourkph | The kilometer per hour is a unit of both speed and velocity in the metric system. It is equal to the speed of a body covering a distance of one kilometer in one minute of time. |
feet/second | The feet/second is a unit of both speed and velocity in the imperial system. It is equal to the speed of a body covering a distance of one foot in one second of time. |
feet/minuteft/min | The feet/minute is a unit of both speed and velocity in the imperial system. It is equal to the speed of a body covering a distance of one foot in one minute of time. |
mile per hourmiles per hourmph | The mile per hour is a unit of both speed and velocity in the imperial system. It is equal to the speed of a body covering a distance of one mile in one hour of time. |
knotknots | The knot is a unit of of both speed and velocity equal to one nautical mile per hour, which is 1.852kph using the metric scale and approximately 1.15078mph using the imperial scale. |
knot scaler 128knots scaler 128 | This is the same as the knot (above) only scaled by 1/128, ie: VALUE / 128. |
machmachs | A mach number is a unit of of both speed and velocity based on an aircraft’s speed relative to the speed of sound. An aircraft travelling at mach 1 is equivalent to 1234.8kph or 767.27mph. |
mach 3d2 over 64k | THis usnit will scale the mach value using the following formula: VALUE * (3.2 / 65536.0). |
Acceleration
| Units | Description |
|---|---|
meter per second squaredmeters per second squared | The metre per second squared is the unit of acceleration in the International System of Units (SI). It is equal to the increase in speed in meters per second for every second that passes. |
feet per second squaredfoot per second squared | The foot per second squared is the unit of acceleration in the imperial system. It is equal to the increase in speed in feet per second for every second that passes. |
GforceG Force | The g-force is a measurement of the type of force per unit mass - typically acceleration - that causes a perception of weight. A g-force of 1g is equal to the conventional value of gravitational acceleration on Earth - about 9.8 meters per second squared, or 32.174 feet per second squared. |
G Force 624 scaled | This is the same as the G Force unit, only scaled by 624 using the formula: VALUE / 624 |
Time
| Units | Description |
|---|---|
secondseconds | The second is the base unit of time in the International System of Units (SI), defined as 1⁄86400 of a day, or more accurately as being equal to the time duration of 9,192,631,770 periods of the radiation corresponding to the transition between the two hyperfine levels of the fundamental unperturbed ground-state of the caesium-133 atom. |
minuteminutes | The minute is a unit of time equal to 1⁄60 of an hour, or 60 seconds. Although not an SI unit, the minute is accepted for use with SI units. |
hourhours | The hour is a unit of time in the International System of Units (SI), defined as 1⁄24 of a day, or more accurately as 3,600 atomic seconds. |
daydays | The day is a unit of time equal to 24 hour. Although not an SI unit, the day is accepted for use with SI units, and is equal to 86,400 seconds. |
hour over 10hours over 10 | This is a unit of time equal to 1⁄10 of an hour, or 360 seconds. |
yearyears | The year is a unit of time in the International System of Units (SI), defined as 3645.25 days of exactly 86,400 seconds, totaling exactly 31,557,600 seconds. |
Power
| Units | Description |
|---|---|
WattWatts | The watt is a unit of power in the International System of Units (SI). It is defined as a 1 joule per second. |
ft lb per second | Foot pounds per second are a unit of power using the imperial system. It is the energy transferred upon applying a force of 1 pound-force through a linear displacement of 1 foot over the time of 1 second. |
Volume rate
| Units | Description |
|---|---|
meter cubed per secondmeters cubed per second | A cubic metre per second is a derived International System (SI) unit of volumetric flow rate equal to that of a cube of matter with sides of one metre in length exchanged or moving each second. |
liter per hourliters per hour | This is a non-SI unit of volumetric flow rate, defined as the rate at which one liter of matter crosses a given surface during the period of time equal to one hour. 1 liter per hour is equivalent to 0.264172 gallons per hour.IMPORTANT! SimVars that use this unit actually require a value in liters per second (0.264172 gallons per second). This is a hold-over from the legacy FSX simulation. |
gallon per hourgallons per hourgph | This is an imperial unit of volumetric flow rate, defined as the rate at which one gallon of matter crosses a given surface during the period of time equal to one hour. 1 gallon per hour is equivalent to 3.785411784 liters per hour. |
Weight
| Units | Description |
|---|---|
kilogramkilogramskg | The kilogram is the base unit of mass in the International System of Units (SI). The kilogram is defined in terms of the second and the metre, based on fixed fundamental constants of nature. It is equivalent to 2.20462 pounds. |
poundpoundslbs | The pound is a unit of mass in the imperial system. It is equivalent to 0.453592kilos. |
pound scaler 256pounds scaler 256 | This is the same as the pound (above) only scaled by 1/256, ie: VALUE / 256. |
slugslugsgeepoundgeepounds | The slug is a unit of mass in the imperial system. A slug is defined as the mass that is accelerated by 1 foot per second when a net force of one pound is exerted on it. 1 slug is a mass equal to 32.1740 pounds or 14.59390 kilograms (based on standard gravity). |
Weight rate
| Units | Description |
|---|---|
kilogram per secondkilograms per second | This is a unit of mass flow rate in the International System of Units (SI). It is defined as the mass of matter equal to one kilogram which crosses a given surface during the period of time equal to one second. |
pound per hourpounds per hour | This is a unit of mass flow rate in the imperial system. It is defined as the mass of matter equal to one pound which crosses a given surface during the period of time equal to one hour. |
Electrical current
| Units | Description |
|---|---|
ampereamperesampamps | The ampere is the base unit of electric current in the International System of Units (SI). A current of one ampere is one coulomb of charge going past a given point per second. |
fs7 charging amps | This is the same as the amp unit, only scaled using the following formula: VALUE * (50.0 / 65535.0). |
Electrical potential
| Units | Description |
|---|---|
voltvolts | The volt is the derived unit for electric potential, electric potential difference (voltage), and electromotive force. It is the potential difference between two points that will impart one joule of energy per coulomb of charge that passes through it, and can be expressed in terms of SI base units. |
Frequency
| Units | Description |
|---|---|
HertzHz | The hertz is the derived unit of frequency in the International System of Units (SI) and is defined as one cycle per second. |
KilohertzKHz | This is a measure of frequency equivalent to 1,000 cycles per second (103 hertz). |
MegahertzMHz | This is a measure of frequency equivalent to 1,000,000 cycles per second (106 hertz). |
Frequency BCD16 | This is a definition of a frequency using a 16bit binary coded decimal(opens in a new tab). |
Frequency BCD32 | This is a definition of a frequency using a 32bit binary coded decimal(opens in a new tab). |
Frequency ADF BCD32 | This is a definition of an ADF frequency using a 32bit binary coded decimal(opens in a new tab). |
Density
| Units | Description |
|---|---|
kilogram per cubic meterkilograms per cubic meter | The kilogram per cubic metre is an SI derived unit of density. It is defined by mass in kilograms divided by volume in cubic metres. It is equivalent to 0.00194032 slug per cubic foot, or 0.0083454 pounds per gallon. |
Slug per cubic feetSlugs per cubic feetSlug/ft3slug per cubic footslugsper cubic foot | The slug per cubic foot is an imperial unit of density. It is defined by the mass of a slug divided by volume in cubic feet. It is equivalent to 515.379 kilograms per cubic meter, or 4.30104 pounds per gallon. |
pound per gallonpounds per gallonlbs/gallon | The pound per gallon is an imperial unit of density. It is defined by the mass of a pound divided by volume in gallons. It is equivalent to 119.826 kilograms per cubic meter, or 0.232502 slug per cubic feet. |
Pressure
| Units | Description |
|---|---|
pascalpascalsPa | The pascal is the SI derived unit of pressure used to quantify internal pressure. The unit, is defined as one newton per square meter. |
kilopascalkpa | This is a measure of pressure equivalent to 1,000 pascal (103 pascal). |
millimeter of mercurymillimeters of mercurymmHg | A millimeter of mercury is a unit of pressure. It is defined as the extra pressure generated by a column of mercury one millimeter high under the force of 1 gravity. It is equivalent to 133.322 pascals, or 0.019337psi. |
centimeter of mercurycentimeters of mercurycmHg | A centimeter of mercury is a unit of pressure. It is defined as the extra pressure generated by a column of mercury one centimeter high under the force of 1 gravity. It is equivalent to 1333.223 pascals, or 0.193367psi. |
inch of mercuryinches of mercuryinHg | An inch of mercury is a unit of pressure. It is defined as the extra pressure generated by a column of mercury one centimeter high under the force of 1 gravity. It is equivalent to 3386.39 pascals, or 0.491154psi. |
inHg 64 over 64k | This unit is for inches of mercury, only the value has been scaled using the following formula: (64.0 / 65536.0) * VALUE. Generally only required for describing units of manifold pressure. |
millimeter of watermillimeters of water | A millimeter of water is a unit of pressure. It is defined as the extra pressure generated by a column of water 1 mm high with a density of 1 gram per cubic centimeter, under the force of 1 gravity. It is equivalent to 9.80638 pascals, or 0.0014223psi. |
Newton per square meternewtons per square meter | Newtons per square meter is a unit that shows how the pascal unit is derived from other SI units. 1 newton per square meter equals 1 pascal. |
kilogram force per square centimeterKgFSqCm | Kilogram force per square centimeter is a unit of pressure which is not a part of the International System of Units (SI). It is equivalent to 98066.5 pascals, or 14.2233psi. |
kilogram meter squaredkilograms meter squared | Kilograms per square meter is a unit of measurement of surface density. It is equivalent to 9.80665 pascals, or 0.001423psi. |
atmosphereatmospheresatm | The atmosphere is a unit of pressure defined as approximately equal to Earth’s atmospheric pressure at sea level. It is equivalent to 101325 pascals, or 14.6959psi. |
barbars | The bar is a metric unit of pressure, but not part of the International System of Units (SI). It is defined as exactly equal to 100,000 pascals, equivalent to 14.50378psi. |
millibarmillibarsmbarmbarshectopascalhectopascals | The millibar is a metric unit of pressure, but not part of the International System of Units (SI). It is defined as exactly equal to 1000 pascals, equivalent to 0.0145psi. |
millibar scaler 16millibars scaler 16 | This unit is the same as the millibar (above), only scaled by a factor of 1/16, ie: VALUE / 16; |
pound-force per square inchpsi | The pound-force per square inch is an imperial unit of pressure. It is equivalent to 6894.76 pascals. |
psi scaler 16k | This is the psi value scaled by 16K, using the formula: VALUE / 16384.0 |
psi 4 over 16k | This is the psi value scaled using the formula: (4 / 16384.0) * VALUE |
psi fs7 oil pressure | This is the psi value scaled using the formula: (55.0 / 16384) * VALUE. Only usually used when dealing with engine oil pressure. |
pound-force per square footpsf | The pound-force per square foot is an imperial unit of pressure. It is equivalent to 47.8803 pascals. |
psf scaler 16k | This is the psf value scaled by 16K, using the formula: VALUE / 16384.0 |
slug feet squaredslugs feet squared | The slug square foot is a unit of moment of inertia in imperial units. It is equivalent to 32.17405 pound foot squared, or 1.35582 Kilogram Square Meters. |
boost cmHg | A centimeter of mercury is a unit of pressure. It is defined as the extra pressure generated by a column of mercury one centimeter high under the force of 1 gravity. It is equivalent to 1333.223 pascals, or 0.193367psi. This unit is used when defining the boost provided by superchargers or turbochargers on equipped planes. |
boost inHg | An inch of mercury is a unit of pressure. It is defined as the extra pressure generated by a column of mercury one centimeter high under the force of 1 gravity. It is equivalent to 3386.39 pascals, or 0.491154psi. This unit is used when defining the boost provided by superchargers or turbochargers on equipped planes. |
boost psi | The pound-force per square inch is an imperial unit of pressure. It is equivalent to 6894.76 pascals. This unit is used when defining the boost provided by superchargers or turbochargers on equipped planes. |
Torque
| Units | Description |
|---|---|
Newton meterNewtonmetersnm | The newton meter is a unit of torque in the International System of Units (SI). One newton-metre is equal to the torque resulting from a force of one newton applied perpendicularly to the end of a moment arm that is one metre long. |
foot-poundfoot poundft-lbsfoot-pounds | The foot-pound is a unit of energy in the imperial unit of measure. It is the energy transferred upon applying a force of one pound-force through a linear displacement of one foot. The corresponding SI unit is the joule. |
lbf-feet | A pound-foot is a unit of torque representing one pound of force acting at a perpendicular distance of one foot from a pivot point. Conversely one pound-foot is the moment about an axis that applies one pound-force at a radius of one foot. |
kilogram meterkilogram meterskgf meterkgf meters | A kilogram-force meter is an International System of Units (SI) unit of torque representing one kilogram-force applied perpendicularly to a one-meter long moment arm. |
poundal feet | One poundal is the force that accelerates a mass of 1 pound at a rate of one foot per second per second. So a poundal foot is a unit of torque representing one poundal of force acting at a perpendicular distance of one foot from a pivot point. |
Miscellaneous Units
| Units | Description |
|---|---|
FractionalLatLonDigits | The number of fractional lat / lon digits. |
part | This is a base unit that will be used to make conversions when using other units in RPN and SimVar calculations. |
halfhalfs | The input will be halved. |
thirdthirds | The input will be divided by 3. |
percentpercentage | Normally a value between 0 and 100, though sometimes values outside this range are possible (reverse thrust, for example). |
percent over 100 | Normally a value between 0.0 and 1.0, though sometimes values outside this range are possible (reverse thrust, for example). |
percent scaler 16k | This is a precentage value scaled by 16K, using the formula: VALUE / 16384.0 |
percent scaler 32k | This is a precentage value scaled by 32K, using the formula: VALUE / 32767.0 |
percent scaler 2pow23 | This is a precentage value scaled by 223, using the formula: VALUE / 8388608.0 |
belbels | The bel is a unit used in the comparison of power levels in electrical communication or of intensities of sound, corresponding to an intensity ratio of 10 to 1. |
decibeldecibels | The decibel is a relative unit of measurement equal to one tenth of a bel. |
more_than_a_half | The input will be converted to either 0 (if it is less than a half of the “part” base value) or 1 (if it is more than half of the “part” base value) |
times | The input value is a multiplier. |
ratio | The input value is expected to be a ratio. |
numbernumbers | The input value is expected to be any real number. |
scaler | The input value is expected to be a scaler. |
positionposition 16Kposition 32Kposition 128 | The input value will be converted to an integer position value either using the “part” base scale, or as a value between 0 and 16843, or 0 and , or as an integer between 0 and 128. |
Enum | A positive or negative integer corresponding to the member of the enum |
BoolBoolean | The only reliable numeric equivalent is that 0 is returned for False. Non-zero values, especially both 1 and -1, are used to indicate True. |
Bco16 | This unit requires a four digit octal number(opens in a new tab), and is usually only used for transponder codes. |
mask | This indicates that the value is a bitmask where one or more bits in the value will be true/false, and each bit will represent a specific item. |
flags | This indicates a selection of one or more flag values combined into a single value. |
string | This unit expects some kind of string input. |
per radian | The input is value that will be a ratio “per radian”. |
per degree | The input is value that will be a ratio “per degree”. |
keyframekeyframes | The input is for an animation keyframe and will be divided by 200. |
Structs And Other Complex Units
The following units are used when the value is a struct or something other than a single value float or integer. In general these units are only used when retrieving the output from a specific SimVar and would never be used to define any inputs.
| Units | Description |
|---|---|
XYZ | This unit signifies a 3 value struct with the values (all 32bit floats):x - a value representing an X positiony - a value representing an Y positionz - a value representing an Z positionThis struct unit is required by the following SimVars:STRUCT BODY ROTATION VELOCITYSTRUCT BODY VELOCITYSTRUCT ENGINE POSITIONSTRUCT EYEPOINT DYNAMIC ANGLESTRUCT EYEPOINT DYNAMIC OFFSETSTRUCT SURFACE RELATIVE VELOCITYSTRUCT WORLDVELOCITYSTRUCT WORLD ACCELERATIONSTRUCT WORLD ROTATION VELOCITY |
PBH | This unit signifies a 3 value struct with the values (all 32bit integers):pitch - the pitch valuebank - the bank valueheading - the heading valueThis struct unit is required by the following SimVars:LANDING LIGHT PBHSTRUCT PBH32 |
latlonaltpbh | This unit signifies a 6 value struct with the values:lat - a latitude, expressed as a 64bit integer where the first 16bits are padding, the next 32bits are the integer value and the last 16bits are the fraction.lon - a longitude, expressed as 64bit integer where the lower 16bits are the fractional part, the upper 32 bits are the integer part and the rest is padding.alt - an altitude, expressed as a 64bit integer where the first 16bits are padding, the next 32bits are the integer value and the last 16bits are the fraction.pitch - the pitch value, expressed as 32bit integerbank - the bank value, expressed as 32bit integerheading - the heading value, expressed as 32bit integerThis struct unit is required by the following SimVars:- STRUCT_LATLONALTPBH |
latlonalt | This unit signifies a 6 value struct with the values:lat - a latitude, expressed as a 64bit integer where the first 16bits are padding, the next 32bits are the integer value and the last 16bits are the fraction.lon - a longitude, expressed as 64bit integer where the lower 16bits are the fractional part, the upper 32 bits are the integer part and the rest is padding.alt - an altitude, expressed as a 64bit integer where the first 16bits are padding, the next 32bits are the integer value and the last 16bits are the fraction.This struct unit is required by the following SimVars:ADF LATLONALTINNER MARKER LATLONALTMIDDLE MARKER LATLONALTNAV DME LATLONALTNAV GS LATLONALTNAV VOR LATLONALTOUTER MARKER LATLONALTSTRUCT LATLONALT |
PID_STRUCT | This unit signifies a 7 value struct containing PID controller state with the values (all 64bit floats):pid_p - the proportional valuepid_i - the first integral valuepid_i2 - the second integral valuepid_d - the proportional valuei_boundary - the first integral boundary valuei2_boundary - the second integral boundary valued_boundary - the derivative boundary valueThis struct is returned by the following SimVars:STRUC AIRSPEED HOLD PID CONSTSSTRUC HEADING HOLD PID CONSTS |
POIList | This unit signifies that the returned value is an array of POI data. This unit is only used within the JS for HTML gauges. |
GlassCockpitSettings | This unit is only used when retrieving the cockpit struct within the JS for HTML gauges.For the contents of this struct, please see the section on the Glass Cockpit Settings Struct. |
FuelLevels | This unit is for retrieving the fuel levels of all tanks and will return a struct containing the following values (all 32bit floats):CenterLeftMainRightMainLeftAuxRightAuxLeftTipRightTipCenter2Center3External1External2 |