Skip to main content

Class: GarminAPConfig

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

A Garmin Autopilot Configuration.

Extended by​

Implements​

Constructors​

Constructor​

new GarminAPConfig(bus, options?): GarminAPConfig

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

Creates a new instance of GarminAPConfig.

Parameters​

ParameterTypeDescription
busEventBusThe event bus.
options?Readonly<GarminAPConfigOptions>Options to configure the directors.

Returns​

GarminAPConfig

Properties​

autopilotDriverOptions​

autopilotDriverOptions: AutopilotDriverOptions

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

Options for the Autopilot Driver

Implementation of​

GarminAPConfigInterface.autopilotDriverOptions

cdiId​

readonly cdiId: string

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

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

Implementation of​

GarminAPConfigInterface.cdiId

deactivateAutopilotOnGa​

readonly deactivateAutopilotOnGa: boolean

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

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

Implementation of​

GarminAPConfigInterface.deactivateAutopilotOnGa

defaultLateralMode​

defaultLateralMode: APLateralModes = APLateralModes.ROLL

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

The autopilot's default lateral mode.

Implementation of​

GarminAPConfigInterface.defaultLateralMode

defaultMaxBankAngle​

defaultMaxBankAngle: number

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

The default maximum bank angle the autopilot may command, in degrees. If not defined, then the maximum bank angle will be sourced from the AUTOPILOT MAX BANK SimVar.

Implementation of​

GarminAPConfigInterface.defaultMaxBankAngle

defaultMaxNoseDownPitchAngle​

defaultMaxNoseDownPitchAngle: number

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

The default maximum nose down pitch angle the autopilot may command, in degrees. If not defined, then the angle can be controlled using the ap_set_max_nose_down_pitch event bus topic (defined in APControlEvents). If not defined and the ap_set_max_nose_down_pitch event bus topic is not used, then the angle defaults to Infinity.

Implementation of​

GarminAPConfigInterface.defaultMaxNoseDownPitchAngle

defaultMaxNoseUpPitchAngle​

defaultMaxNoseUpPitchAngle: number

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

The default maximum nose up pitch angle the autopilot may command, in degrees. If not defined, then the angle can be controlled using the ap_set_max_nose_up_pitch event bus topic (defined in APControlEvents). If not defined and the ap_set_max_nose_up_pitch event bus topic is not used, then the angle defaults to Infinity.

Implementation of​

GarminAPConfigInterface.defaultMaxNoseUpPitchAngle

defaultVerticalMode​

defaultVerticalMode: APVerticalModes = APVerticalModes.PITCH

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

The autopilot's default vertical mode.

Implementation of​

GarminAPConfigInterface.defaultVerticalMode

flightDirectorCount​

readonly flightDirectorCount: 1 | 2

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

The number of flight directors supported by the autopilot. Defaults to 2.

Implementation of​

GarminAPConfigInterface.flightDirectorCount

useIndicatedMach​

readonly useIndicatedMach: boolean

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

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.

Implementation of​

GarminAPConfigInterface.useIndicatedMach

DEFAULT_BANK_RATE​

readonly static DEFAULT_BANK_RATE: 10 = 10

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

The default commanded bank angle rate, in degrees per second.

DEFAULT_GA_PITCH_ANGLE​

readonly static DEFAULT_GA_PITCH_ANGLE: 7.5 = 7.5

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

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

DEFAULT_HDG_DIRECTION_UNLOCK_THRESHOLD​

readonly static DEFAULT_HDG_DIRECTION_UNLOCK_THRESHOLD: 331 = 331

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

The default HDG director turn direction unlock threshold, in degrees.

DEFAULT_LOW_BANK_ANGLE​

readonly static DEFAULT_LOW_BANK_ANGLE: 15 = 15

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

The default maximum bank angle, in degrees, in Low Bank Mode.

DEFAULT_MAX_BANK_ANGLE​

readonly static DEFAULT_MAX_BANK_ANGLE: 25 = 25

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

The default maximum bank angle, in degrees, for ROL, HDG, NAV, and LNAV directors.

DEFAULT_PITCH_RATE​

readonly static DEFAULT_PITCH_RATE: 5 = 5

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

The default commanded pitch angle rate, in degrees per second.

DEFAULT_ROLL_MIN_BANK_ANGLE​

readonly static DEFAULT_ROLL_MIN_BANK_ANGLE: 6 = 6

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

The default minimum bank angle, in degrees, for ROL director.

DEFAULT_TO_PITCH_ANGLE​

readonly static DEFAULT_TO_PITCH_ANGLE: 10 = 10

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

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

Methods​

createAltCapDirector()​

protected createAltCapDirector(apValues): PlaneDirector | undefined

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

Creates the autopilot's altitude capture mode director.

Parameters​

ParameterTypeDescription
apValuesAPValuesThe autopilot's state values.

Returns​

PlaneDirector | undefined

The autopilot's altitude capture mode director, or undefined to omit the director.

createAltHoldDirector()​

protected createAltHoldDirector(apValues): PlaneDirector | undefined

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

Creates the autopilot's altitude hold mode director.

Parameters​

ParameterTypeDescription
apValuesAPValuesThe autopilot's state values.

Returns​

PlaneDirector | undefined

The autopilot's altitude hold mode director, or undefined to omit the director.

createBcDirector()​

protected createBcDirector(apValues): PlaneDirector | undefined

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

Creates the autopilot's localizer backcourse mode director.

Parameters​

ParameterTypeDescription
apValuesAPValuesThe autopilot's state values.

Returns​

PlaneDirector | undefined

The autopilot's localizer backcourse mode director, or undefined to omit the director.

createFlcDirector()​

protected createFlcDirector(apValues): PlaneDirector | undefined

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

Creates the autopilot's flight level change mode director.

Parameters​

ParameterTypeDescription
apValuesAPValuesThe autopilot's state values.

Returns​

PlaneDirector | undefined

The autopilot's flight level change mode director, or undefined to omit the director.

createGaLateralDirector()​

protected createGaLateralDirector(apValues): PlaneDirector | undefined

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

Creates the autopilot's go-around lateral mode director.

Parameters​

ParameterTypeDescription
apValuesAPValuesThe autopilot's state values.

Returns​

PlaneDirector | undefined

The autopilot's go-around lateral mode director, or undefined to omit the director.

createGaVerticalDirector()​

protected createGaVerticalDirector(apValues): PlaneDirector | undefined

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

Creates the autopilot's go-around vertical mode director.

Parameters​

ParameterTypeDescription
apValuesAPValuesThe autopilot's state values.

Returns​

PlaneDirector | undefined

The autopilot's go-around vertical mode director, or undefined to omit the director.

createGpDirector()​

protected createGpDirector(apValues): PlaneDirector | undefined

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

Creates the autopilot's glidepath mode director.

Parameters​

ParameterTypeDescription
apValuesAPValuesThe autopilot's state values.

Returns​

PlaneDirector | undefined

The autopilot's glidepath mode director, or undefined to omit the director.

createGpssDirector()​

protected createGpssDirector(apValues): PlaneDirector | undefined

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

Creates the autopilot's GPSS mode director.

Parameters​

ParameterTypeDescription
apValuesAPValuesThe autopilot's state values.

Returns​

PlaneDirector | undefined

The autopilot's GPSS mode director, or undefined to omit the director.

createGsDirector()​

protected createGsDirector(apValues): PlaneDirector | undefined

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

Creates the autopilot's glideslope mode director.

Parameters​

ParameterTypeDescription
apValuesAPValuesThe autopilot's state values.

Returns​

PlaneDirector | undefined

The autopilot's glideslope mode director, or undefined to omit the director.

createHeadingDirector()​

protected createHeadingDirector(apValues): PlaneDirector | undefined

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

Creates the autopilot's heading mode director.

Parameters​

ParameterTypeDescription
apValuesAPValuesThe autopilot's state values.

Returns​

PlaneDirector | undefined

The autopilot's heading mode director, or undefined to omit the director.

createLateralDirectors()​

createLateralDirectors(apValues): Iterable<Readonly<APConfigDirectorEntry>>

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

Creates the autopilot's lateral mode directors. Mode APLateralModes.NONE (0) is ignored.

Parameters​

ParameterTypeDescription
apValuesAPValuesThe autopilot's state values.

Returns​

Iterable<Readonly<APConfigDirectorEntry>>

An iterable of lateral mode directors to add to the autopilot.

Implementation of​

GarminAPConfigInterface.createLateralDirectors

createLocDirector()​

protected createLocDirector(apValues): PlaneDirector | undefined

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

Creates the autopilot's localizer mode director.

Parameters​

ParameterTypeDescription
apValuesAPValuesThe autopilot's state values.

Returns​

PlaneDirector | undefined

The autopilot's localizer mode director, or undefined to omit the director.

createNavToNavManager()​

createNavToNavManager(apValues): NavToNavManager2 | undefined

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

Creates the autopilot's nav-to-nav manager.

Parameters​

ParameterTypeDescription
apValuesAPValuesThe autopilot's state values.

Returns​

NavToNavManager2 | undefined

The autopilot's nav-to-nav manager.

Implementation of​

GarminAPConfigInterface.createNavToNavManager

createPitchDirector()​

protected createPitchDirector(apValues): PlaneDirector | undefined

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

Creates the autopilot's pitch mode director.

Parameters​

ParameterTypeDescription
apValuesAPValuesThe autopilot's state values.

Returns​

PlaneDirector | undefined

The autopilot's pitch mode director, or undefined to omit the director.

createPitchLevelerDirector()​

protected createPitchLevelerDirector(apValues): PlaneDirector | undefined

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

Creates the autopilot's pitch level mode director.

Parameters​

ParameterTypeDescription
apValuesAPValuesThe autopilot's state values.

Returns​

PlaneDirector | undefined

The autopilot's pitch level mode director, or undefined to omit the director.

createRollDirector()​

protected createRollDirector(apValues): PlaneDirector | undefined

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

Creates the autopilot's roll mode director.

Parameters​

ParameterTypeDescription
apValuesAPValuesThe autopilot's state values.

Returns​

PlaneDirector | undefined

The autopilot's roll mode director, or undefined to omit the director.

createToLateralDirector()​

protected createToLateralDirector(apValues): PlaneDirector | undefined

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

Creates the autopilot's takeoff lateral mode director.

Parameters​

ParameterTypeDescription
apValuesAPValuesThe autopilot's state values.

Returns​

PlaneDirector | undefined

The autopilot's takeoff lateral mode director, or undefined to omit the director.

createToVerticalDirector()​

protected createToVerticalDirector(apValues): PlaneDirector | undefined

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

Creates the autopilot's takeoff vertical mode director.

Parameters​

ParameterTypeDescription
apValuesAPValuesThe autopilot's state values.

Returns​

PlaneDirector | undefined

The autopilot's takeoff vertical mode director, or undefined to omit the director.

createTrackDirector()​

protected createTrackDirector(apValues): PlaneDirector | undefined

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

Creates the autopilot's track mode director.

Parameters​

ParameterTypeDescription
apValuesAPValuesThe autopilot's state values.

Returns​

PlaneDirector | undefined

The autopilot's track mode director, or undefined to omit the director.

createVerticalDirectors()​

createVerticalDirectors(apValues): Iterable<Readonly<APConfigDirectorEntry>>

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

Creates the autopilot's vertical mode directors. Mode APVerticalModes.NONE (0) is ignored.

Parameters​

ParameterTypeDescription
apValuesAPValuesThe autopilot's state values.

Returns​

Iterable<Readonly<APConfigDirectorEntry>>

An iterable of vertical mode directors to add to the autopilot.

Implementation of​

GarminAPConfigInterface.createVerticalDirectors

createVNavManager()​

createVNavManager(apValues): VNavManager | undefined

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

Creates the autopilot's VNAV Manager.

Parameters​

ParameterTypeDescription
apValuesAPValuesThe autopilot's state values.

Returns​

VNavManager | undefined

The autopilot's VNAV Manager.

Implementation of​

GarminAPConfigInterface.createVNavManager

createVNavPathDirector()​

protected createVNavPathDirector(apValues): PlaneDirector | undefined

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

Creates the autopilot's VNAV path mode director.

Parameters​

ParameterTypeDescription
apValuesAPValuesThe autopilot's state values.

Returns​

PlaneDirector | undefined

The autopilot's VNAV path mode director, or undefined to omit the director.

createVorDirector()​

protected createVorDirector(apValues): PlaneDirector | undefined

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

Creates the autopilot's VOR mode director.

Parameters​

ParameterTypeDescription
apValuesAPValuesThe autopilot's state values.

Returns​

PlaneDirector | undefined

The autopilot's VOR mode director, or undefined to omit the director.

createVsDirector()​

protected createVsDirector(apValues): PlaneDirector | undefined

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

Creates the autopilot's vertical speed mode director.

Parameters​

ParameterTypeDescription
apValuesAPValuesThe autopilot's state values.

Returns​

PlaneDirector | undefined

The autopilot's vertical speed mode director, or undefined to omit the director.

createWingLevelerDirector()​

protected createWingLevelerDirector(apValues): PlaneDirector | undefined

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

Creates the autopilot's wing level mode director.

Parameters​

ParameterTypeDescription
apValuesAPValuesThe autopilot's state values.

Returns​

PlaneDirector | undefined

The autopilot's wing level mode director, or undefined to omit the director.