Skip to main content

Type Alias: EspOptions

EspOptions = object

Defined in: src/garminsdk/esp/Esp.ts:10

Configuration options for Esp.

Properties​

armAglThreshold​

armAglThreshold: number

Defined in: src/garminsdk/esp/Esp.ts:12

The above ground height, in feet, at or above which ESP can become armed from a disarmed state.

armMaxPitchLimit?​

optional armMaxPitchLimit: number

Defined in: src/garminsdk/esp/Esp.ts:30

The maximum pitch angle, in degrees, at which ESP can become armed. Positive angles represent downward pitch. Defaults to 90.

armMinPitchLimit?​

optional armMinPitchLimit: number

Defined in: src/garminsdk/esp/Esp.ts:24

The minimum pitch angle, in degrees, at which ESP can become armed. Positive angles represent downward pitch. Defaults to -90.

armRollLimit?​

optional armRollLimit: number

Defined in: src/garminsdk/esp/Esp.ts:33

The maximum roll angle magnitude, in degrees, at which ESP can become armed. Defaults to 90.

canArmWhenAglInvalid?​

optional canArmWhenAglInvalid: boolean

Defined in: src/garminsdk/esp/Esp.ts:18

Whether ESP can become armed when AGL data is invalid. Defaults to false.

disarmAglThreshold​

disarmAglThreshold: number

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

The above ground height, in feet, below which ESP becomes disarmed from an armed state.

engagementTimeWindow?​

optional engagementTimeWindow: number

Defined in: src/garminsdk/esp/Esp.ts:84

The length of the window, in seconds, in which engagement time is tracked. Values less than or equal to zero will cause engagement time to not be tracked. Defaults to 0.

pitchAxisForceRate?​

optional pitchAxisForceRate: number

Defined in: src/garminsdk/esp/Esp.ts:53

The rate at which the system changes the force applied to the pitch control axis, in units of force per second. Defaults to 0.1.

pitchAxisMaxForceDown?​

optional pitchAxisMaxForceDown: number

Defined in: src/garminsdk/esp/Esp.ts:47

The maximum force ESP is allowed to apply to the pitch control axis to move it in the pitch down direction. 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). Defaults to 1.

pitchAxisMaxForceUp?​

optional pitchAxisMaxForceUp: number

Defined in: src/garminsdk/esp/Esp.ts:40

The maximum force ESP is allowed to apply to the pitch control axis to move it in the pitch up direction. 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). Defaults to 1.

pitchAxisUnloadRate?​

optional pitchAxisUnloadRate: number

Defined in: src/garminsdk/esp/Esp.ts:59

The rate at which the system unloads force applied to the pitch control axis when it is not armed, in units of force per second. Defaults to 1.

rollAxisForceRate?​

optional rollAxisForceRate: number

Defined in: src/garminsdk/esp/Esp.ts:72

The rate at which the system changes the force applied to the roll control axis, in units of force per second. Defaults to 0.1.

rollAxisMaxForce?​

optional rollAxisMaxForce: number

Defined in: src/garminsdk/esp/Esp.ts:66

The maximum force ESP is allowed to apply to the roll control axis. 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). Defaults to 1.

rollAxisUnloadRate?​

optional rollAxisUnloadRate: number

Defined in: src/garminsdk/esp/Esp.ts:78

The rate at which the system unloads force applied to the roll control axis when it is not armed, in units of force per second. Defaults to 1.