Class: EspRollModule

Defined in: src/garminsdk/esp/modules/EspRollModule.ts:72

A roll engagement module for Garmin ESP systems. The module applies a force to the roll control axis to combat excessive roll angles.

Implements

• EspModule

Constructors

Constructor

new EspRollModule(id, options): EspRollModule

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

Creates a new instance of EspRollModule.

Parameters

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

Returns

EspRollModule

Properties

id

readonly id: string

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

This module's ID.

Implementation of

EspModule.id

Methods

getEngageData()

getEngageData(): Readonly<EspRollModuleEngageData>

Defined in: src/garminsdk/esp/modules/EspRollModule.ts:110

Gets data describing this module's engagement state.

Returns

Readonly<EspRollModuleEngageData>

Data describing this module's engagement state.

---

isEngaged()

isEngaged(): boolean

Defined in: src/garminsdk/esp/modules/EspRollModule.ts:102

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/EspRollModule.ts:159

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/EspRollModule.ts:115

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/EspRollModule.ts:154

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/EspRollModule.ts:120

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