Skip to main content

Class: EspAoaModule

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

An angle of attack protection module for Garmin ESP systems. The module applies a force to the pitch control axis to combat excessively high angle of attack values.

Implements

Constructors

Constructor

new EspAoaModule(id, options): EspAoaModule

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

Creates a new instance of EspAoaModule.

Parameters

ParameterTypeDescription
idstringThis module's ID.
optionsReadonly<EspAoaModuleOptions>Options with which to configure the module.

Returns

EspAoaModule

Properties

id

readonly id: string

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

This module's ID.

Implementation of

EspModule.id

Methods

getEngageData()

getEngageData(): Readonly<EspAoaModuleEngageData>

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

Gets data describing this module's engagement state.

Returns

Readonly<EspAoaModuleEngageData>

Data describing this module's engagement state.


isEngaged()

isEngaged(): boolean

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

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/EspAoaModule.ts:134

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/EspAoaModule.ts:97

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/EspAoaModule.ts:129

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/EspAoaModule.ts:102

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

Parameters

ParameterTypeDescription
operatingModeEspOperatingModeThe parent system's current operating mode.
dataReadonly<EspData>The data provided by the parent system.
forceControllerEspForceControllerA controller for control axis forces applied by the parent system.

Returns

void

Implementation of

EspModule.onUpdate