Interface: EspModule

Defined in: src/garminsdk/esp/EspModule.ts:7

A module for a Garmin electronic stability and protection (ESP) system. Modules are attached to a parent system, which update the modules and provide them with data.

Properties

id

readonly id: string

Defined in: src/garminsdk/esp/EspModule.ts:9

This module's ID.

Methods

isEngaged()

isEngaged(): boolean

Defined in: src/garminsdk/esp/EspModule.ts:15

Checks if this module is engaged.

Returns

boolean

Whether this module is engaged.

---

onDestroy()

onDestroy(): void

Defined in: src/garminsdk/esp/EspModule.ts:43

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

Returns

void

---

onInit()

onInit(): void

Defined in: src/garminsdk/esp/EspModule.ts:21

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

---

onPause()

onPause(): void

Defined in: src/garminsdk/esp/EspModule.ts:38

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

Returns

void

---

onUpdate()

onUpdate(operatingMode, data, forceController): void

Defined in: src/garminsdk/esp/EspModule.ts:29

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