Skip to main content

Type Alias: GarminAPConfigOptions

GarminAPConfigOptions = object

Defined in: src/garminsdk/autopilot/GarminAPConfig.ts:36

Options for configuring Garmin autopilots.

Properties​

cdiId?​

optional cdiId: string

Defined in: src/garminsdk/autopilot/GarminAPConfig.ts:38

The ID of the CDI associated with the autopilot. Defaults to the empty string ('').

deactivateAutopilotOnGa?​

optional deactivateAutopilotOnGa: boolean

Defined in: src/garminsdk/autopilot/GarminAPConfig.ts:140

Whether to deactivate the autopilot when GA mode is armed in response to a TO/GA mode button press. Defaults to true.

defaultBankRate?​

optional defaultBankRate: number

Defined in: src/garminsdk/autopilot/GarminAPConfig.ts:50

The default rate at which commanded bank changes, in degrees per second. Defaults to 10.

defaultPitchRate?​

optional defaultPitchRate: number

Defined in: src/garminsdk/autopilot/GarminAPConfig.ts:47

The default rate at which commanded pitch changes, in degrees per second. Defaults to 5.

gaPitchAngle?​

optional gaPitchAngle: number

Defined in: src/garminsdk/autopilot/GarminAPConfig.ts:127

The target pitch angle, in degrees, commanded by the GA director. Positive values indicate upward pitch. Defaults to 7.5.

glidepathGuidance?​

optional glidepathGuidance: Accessible<Readonly<GarminVNavGlidepathGuidance>>

Defined in: src/garminsdk/autopilot/GarminAPConfig.ts:78

Guidance for the autopilot's glidepath director to use. Ignored if internalGlidepathComputer is defined.

hdgMaxBankAngle?​

optional hdgMaxBankAngle: number

Defined in: src/garminsdk/autopilot/GarminAPConfig.ts:100

The maximum bank angle, in degrees, supported by the HDG director. Defaults to 25.

hdgTurnReversalThreshold?​

optional hdgTurnReversalThreshold: number

Defined in: src/garminsdk/autopilot/GarminAPConfig.ts:137

The threshold difference between selected heading and current heading, in degrees, at which the heading director unlocks its commanded turn direction and chooses a new optimal turn direction to establish on the selected heading, potentially resulting in a turn reversal. Any value less than or equal to 180 degrees effectively prevents the director from locking a commanded turn direction. Any value greater than or equal to 360 degrees will require the selected heading to traverse past the current heading in the desired turn direction in order for the director to issue a turn reversal. Defaults to 331.

internalGlidepathComputer()?​

optional internalGlidepathComputer: (apValues) => GarminGlidepathComputer

Defined in: src/garminsdk/autopilot/GarminAPConfig.ts:69

A function that creates an internal glidepath computer for the autopilot's VNAV manager. The internal computer will be updated by the VNAV manager, and the autopilot will use the internal computer's glidepath guidance.

Parameters​

ParameterTypeDescription
apValuesAPValuesThe autopilot's state values.

Returns​

GarminGlidepathComputer

An internal glidepath computer for the autopilot's VNAV manager.

internalVNavComputer()?​

optional internalVNavComputer: (apValues) => GarminVNavComputer

Defined in: src/garminsdk/autopilot/GarminAPConfig.ts:61

A function that creates an internal VNAV computer for the autopilot's VNAV manager. The internal computer will be updated by the VNAV manager, and the autopilot will use the internal computer's VNAV and VNAV path guidance.

Parameters​

ParameterTypeDescription
apValuesAPValuesThe autopilot's state values.

Returns​

GarminVNavComputer

An internal VNAV computer for the autopilot's VNAV manager.

optional lnavMaxBankAngle: number

Defined in: src/garminsdk/autopilot/GarminAPConfig.ts:109

The maximum bank angle, in degrees, supported by the LNAV director. Defaults to 25.

optional lnavOptions: Readonly<GarminLNavDirectorOptions>

Defined in: src/garminsdk/autopilot/GarminAPConfig.ts:53

Options for the LNAV (GPSS) director. If not defined, then the autopilot will not include an LNAV director

locMaxBankAngle?​

optional locMaxBankAngle: number

Defined in: src/garminsdk/autopilot/GarminAPConfig.ts:106

The maximum bank angle, in degrees, supported by the LOC director. Defaults to 25.

lowBankAngle?​

optional lowBankAngle: number

Defined in: src/garminsdk/autopilot/GarminAPConfig.ts:115

The maximum bank angle, in degrees, to apply to the HDG, VOR, LOC, and LNAV directors while in Low Bank Mode. Defaults to 15.

optional navToNavGuidance: GarminNavToNavManager2Guidance

Defined in: src/garminsdk/autopilot/GarminAPConfig.ts:85

Guidance for the autopilot's nav-to-nav manager to use. If defined, then a GarminNavToNavManager2 will be created as the autopilot's nav-to-nav manager and the guidance will be passed to it. If not defined, then the autopilot will not support nav-to-nav.

optional navToNavOptions: Readonly<GarminNavToNavManager2Options>

Defined in: src/garminsdk/autopilot/GarminAPConfig.ts:91

Options with which to configure the autopilot's GarminNavToNavManager2 nav-to-nav manager. Ignored if navToNavGuidance is undefined.

rollMaxBankAngle?​

optional rollMaxBankAngle: number

Defined in: src/garminsdk/autopilot/GarminAPConfig.ts:97

The maximum bank angle, in degrees, supported by the ROL director. Defaults to 25.

rollMinBankAngle?​

optional rollMinBankAngle: number

Defined in: src/garminsdk/autopilot/GarminAPConfig.ts:94

The minimum bank angle, in degrees, supported by the ROL director. Defaults to 6.

toPitchAngle?​

optional toPitchAngle: number

Defined in: src/garminsdk/autopilot/GarminAPConfig.ts:121

The target pitch angle, in degrees, commanded by the TO director. Positive values indicate upward pitch. Defaults to 10.

useIndicatedMach?​

optional useIndicatedMach: boolean

Defined in: src/garminsdk/autopilot/GarminAPConfig.ts:44

Whether the autopilot should use mach number calculated from the impact pressure derived from indicated airspeed and ambient pressure instead of the true mach number. Defaults to false.

verticalPathGuidance?​

optional verticalPathGuidance: Accessible<Readonly<GarminVNavPathGuidance>>

Defined in: src/garminsdk/autopilot/GarminAPConfig.ts:75

Guidance for the autopilot's VNAV path director to use. Ignored if internalVNavComputer is defined.

vnavGuidance?​

optional vnavGuidance: Accessible<Readonly<GarminVNavGuidance>>

Defined in: src/garminsdk/autopilot/GarminAPConfig.ts:72

VNAV guidance for the autopilot's VNAV manager to use. Ignored if internalVNavComputer is defined.

vorMaxBankAngle?​

optional vorMaxBankAngle: number

Defined in: src/garminsdk/autopilot/GarminAPConfig.ts:103

The maximum bank angle, in degrees, supported by the VOR director. Defaults to 25.