Type Alias: EspAirspeedModuleOptions

EspAirspeedModuleOptions = object

Defined in: src/garminsdk/esp/modules/EspAirspeedModule.ts:53

Configuration options for EspAirspeedModule.

Properties

canEngageWhenAglInvalid?

optional canEngageWhenAglInvalid: boolean

Defined in: src/garminsdk/esp/modules/EspAirspeedModule.ts:117

Whether the module can engage when AGL data is invalid. Defaults to false.

---

disengageIas?

optional disengageIas: number | Accessible<number>

Defined in: src/garminsdk/esp/modules/EspAirspeedModule.ts:73

The indicated airspeed, in knots, within which the module disengages. The value will be clamped such that it is not in the same direction as exceedDirection relative to engageIas. A value equal to NaN will inhibit the module from engaging due to indicated airspeed exceedance. If not defined, then the module will not engage due to indicated airspeed exceedance.

---

disengageMach?

optional disengageMach: number | Accessible<number>

Defined in: src/garminsdk/esp/modules/EspAirspeedModule.ts:86

The mach number within which the module disengages. The value will be clamped such that it is not in the same direction as exceedDirection relative to engageMach. A value equal to NaN will inhibit the module from engaging due to mach exceedance. If not defined, then the module will not engage due to mach exceedance.

---

disengageTas?

optional disengageTas: number | Accessible<number>

Defined in: src/garminsdk/esp/modules/EspAirspeedModule.ts:101

The true airspeed, in knots, within which the module disengages. The value will be clamped such that it is not in the same direction as exceedDirection relative to engageTas. A value equal to NaN will inhibit the module from engaging due to true airspeed exceedance. If not defined, then the module will not engage due to true airspeed exceedance.

---

engageIas?

optional engageIas: number | Accessible<number>

Defined in: src/garminsdk/esp/modules/EspAirspeedModule.ts:65

The indicated airspeed, in knots, at or beyond which the module engages. A value equal to NaN will inhibit the module from engaging due to indicated airspeed exceedance. If not defined, then the module will not engage due to indicated airspeed exceedance.

---

engageMach?

optional engageMach: number | Accessible<number>

Defined in: src/garminsdk/esp/modules/EspAirspeedModule.ts:79

The mach number at or beyond which the module engages. A value equal to NaN will inhibit the module from engaging due to mach exceedance. If not defined, then the module will not engage due to mach exceedance.

---

engageTas?

optional engageTas: number | Accessible<number>

Defined in: src/garminsdk/esp/modules/EspAirspeedModule.ts:93

The true airspeed, in knots, at or beyond which the module engages. A value equal to NaN will inhibit the module from engaging due to true airspeed exceedance. If not defined, then the module will not engage due to true airspeed exceedance.

---

exceedDirection

exceedDirection: "high" | "low"

Defined in: src/garminsdk/esp/modules/EspAirspeedModule.ts:58

The direction of airspeed exceedance used by the module. With a direction of high, the module will engage in high airspeed conditions. With a direction of low, the module will engage in low airspeed conditions.

---

getForceToApply()

getForceToApply: (data, engageData) => number

Defined in: src/garminsdk/esp/modules/EspAirspeedModule.ts:114

Gets the force to apply to the pitch control axis when the module is engaged, scaled such that a force of magnitude one is the amount of force required to deflect the control axis from the neutral position to maximum deflection (on either side). Positive force deflects the control axis to command an increase in pitch angle (i.e. increase downward pitch).

Parameters

Parameter	Type	Description
data	Readonly<EspData>	The current ESP data.
engageData	Readonly<EspAirspeedModuleEngageData>	Data describing the engagement state of the module.

Returns

number

The force to apply to the pitch control axis when the module is engaged, scaled such that a force of magnitude one is the amount of force required to deflect the control axis from the neutral position to maximum deflection (on either side).