Skip to main content

Type Alias: EspRollModuleEngageData

EspRollModuleEngageData = object

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

Data describing the engagement state of an EspRollModule.

Properties​

disengageRoll​

disengageRoll: number

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

The roll angle magnitude, in degrees, below which the module disengages, or NaN if the module cannot engage.

engageMode​

engageMode: "none" | "left" | "right"

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

The module's engagement mode:

  • none: The module is not engaged.
  • left: The module is engaged due to excessive leftward roll.
  • right: The module is engaged due to excessive rightward roll.

engageRoll​

engageRoll: number

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

The roll angle magnitude, in degrees, at or above which the module engages, or NaN if the module cannot engage.

engageRollLimit​

engageRollLimit: number

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

The roll angle magnitude, in degrees, above which the module cannot engage, or NaN if there is no limit.