Skip to main content

Type Alias: EspAoaModuleOptions

EspAoaModuleOptions = object

Defined in: src/garminsdk/esp/modules/EspAoaModule.ts:23

Configuration options for EspAoaModule.

Properties

canEngageWhenAglInvalid?

optional canEngageWhenAglInvalid: boolean

Defined in: src/garminsdk/esp/modules/EspAoaModule.ts:50

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


disengageAoa

disengageAoa: number | Accessible<number>

Defined in: src/garminsdk/esp/modules/EspAoaModule.ts:34

The angle of attack, in degrees, below which the module disengages. The value will be clamped such that it is not greater than engageAoa. A value equal to NaN will inhibit the module from engaging.


engageAoa

engageAoa: number | Accessible<number>

Defined in: src/garminsdk/esp/modules/EspAoaModule.ts:28

The angle of attack, in degrees, at or above which the module engages. A value equal to NaN will inhibit the module from engaging.


getForceToApply()

getForceToApply: (data, engageData) => number

Defined in: src/garminsdk/esp/modules/EspAoaModule.ts:47

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

ParameterTypeDescription
dataReadonly<EspData>The current ESP data.
engageDataReadonly<EspAoaModuleEngageData>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).