Type Alias: EspPitchModuleOptions

EspPitchModuleOptions = object

Defined in: src/garminsdk/esp/modules/EspPitchModule.ts:35

Configuration options for EspPitchModule.

Properties

canEngageWhenAglInvalid?

optional canEngageWhenAglInvalid: boolean

Defined in: src/garminsdk/esp/modules/EspPitchModule.ts:76

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

---

disengagePitch

disengagePitch: number | Accessible<number>

Defined in: src/garminsdk/esp/modules/EspPitchModule.ts:60

The pitch angle, in degrees, within which the module disengages. Positive angles represent downward pitch. The value will be clamped such that it is not in the same direction as exceedDirection relative to engagePitch. A value equal to NaN will inhibit the module from engaging.

---

engagePitch

engagePitch: number | Accessible<number>

Defined in: src/garminsdk/esp/modules/EspPitchModule.ts:46

The pitch angle, in degrees, at or beyond which the module engages. Positive angles represent downward pitch. A value equal to NaN will inhibit the module from engaging.

---

engagePitchLimit?

optional engagePitchLimit: number | Accessible<number>

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

The pitch angle, in degrees, beyond which the module cannot engage. Positive angles represent downward pitch. The value will be clamped such that it is not in the opposite direction as exceedDirection relative to engagePitch. A value equal to NaN will be treated as the equivalent of no limit. Defaults to NaN.

---

exceedDirection

exceedDirection: "up" | "down"

Defined in: src/garminsdk/esp/modules/EspPitchModule.ts:40

The direction of pitch angle exceedance used by the module. With a direction of up, the module will engage with excessive pitch up angles. With a direction of down, the module will engage with excessive pitch down angles.

---

getForceToApply()

getForceToApply: (data, engageData) => number

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

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<EspPitchModuleEngageData>	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).