Type Alias: EspRollModuleOptions
EspRollModuleOptions =
object
Defined in: src/garminsdk/esp/modules/EspRollModule.ts:31
Configuration options for EspRollModule.
Properties
canEngageWhenAglInvalid?
optionalcanEngageWhenAglInvalid:boolean
Defined in: src/garminsdk/esp/modules/EspRollModule.ts:65
Whether the module can engage when AGL data is invalid. Defaults to false.
disengageRoll
disengageRoll:
number|Accessible<number>
Defined in: src/garminsdk/esp/modules/EspRollModule.ts:49
The roll angle magnitude, in degrees, below which the module disengages. The value will be clamped to be less than
or equal to engageRoll.
engageRoll
engageRoll:
number|Accessible<number>
Defined in: src/garminsdk/esp/modules/EspRollModule.ts:36
The roll angle magnitude, in degrees, at or above which the module engages. The value will be clamped to be greater than or equal to zero.
engageRollLimit?
optionalengageRollLimit:number|Accessible<number>
Defined in: src/garminsdk/esp/modules/EspRollModule.ts:43
The roll angle magnitude, in degrees, above which the module cannot engage. The value will be clamped to be
greater than or equal to engageRoll. A value equal to NaN will be treated as the equivalent of no limit.
Defaults to NaN.
getForceToApply()
getForceToApply: (
data,engageData) =>number
Defined in: src/garminsdk/esp/modules/EspRollModule.ts:62
Gets the force to apply to the roll control axis when the module is engaged, scaled such that a force of magnitude one is the amount of force required to deflect the control axis from the neutral position to maximum deflection (on either side). Positive force deflects the control axis to command an increase in roll angle (i.e. increase leftward roll).
Parameters
| Parameter | Type | Description |
|---|---|---|
data | Readonly<EspData> | The current ESP data. |
engageData | Readonly<EspRollModuleEngageData> | Data describing the engagement state of the module. |
Returns
number
The force to apply to the roll control axis when the module is engaged, scaled such that a force of magnitude one is the amount of force required to deflect the control axis from the neutral position to maximum deflection (on either side).