Class: EspAirspeedModule

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

An airspeed engagement module for Garmin ESP systems. The module applies a force to the pitch control axis to combat excessive airspeed in one direction (either high airspeed or low airspeed). The module supports engagement due to exceedances in indicated airspeed, mach number, and true airspeed. The module engages when there is an exceedance in any of the supported airspeed types and disengages when there are no exceedances in any of the airspeed types.

Implements

• EspModule

Constructors

Constructor

new EspAirspeedModule(id, options): EspAirspeedModule

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

Creates a new instance of EspAirspeedModule.

Parameters

Parameter	Type	Description
id	string	This module's ID.
options	Readonly<EspAirspeedModuleOptions>	Options with which to configure the module.

Returns

EspAirspeedModule

Properties

id

readonly id: string

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

This module's ID.

Implementation of

EspModule.id

Methods

getEngageData()

getEngageData(): Readonly<EspAirspeedModuleEngageData>

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

Gets data describing this module's engagement state.

Returns

Readonly<EspAirspeedModuleEngageData>

Data describing this module's engagement state.

---

isEngaged()

isEngaged(): boolean

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

Checks if this module is engaged.

Returns

boolean

Whether this module is engaged.

Implementation of

EspModule.isEngaged

---

onDestroy()

onDestroy(): void

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

A method that is called when this module's parent system is destroyed.

Returns

void

Implementation of

EspModule.onDestroy

---

onInit()

onInit(): void

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

A method that is called when this module is attached to an initialized system, or when this module's parent system is initialized.

Returns

void

Implementation of

EspModule.onInit

---

onPause()

onPause(): void

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

A method that is called when this module's parent system is paused.

Returns

void

Implementation of

EspModule.onPause

---

onUpdate()

onUpdate(operatingMode, data, forceController): void

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

A method that is called every time this module's parent system is updated.

Parameters

Parameter	Type	Description
operatingMode	EspOperatingMode	The parent system's current operating mode.
data	Readonly<EspData>	The data provided by the parent system.
forceController	EspForceController	A controller for control axis forces applied by the parent system.

Returns

void

Implementation of

EspModule.onUpdate