Class: GarminAPConfig

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

A Garmin Autopilot Configuration.

Extended by

• G3000APConfig

Implements

• GarminAPConfigInterface

Constructors

Constructor

new GarminAPConfig(bus, options?): GarminAPConfig

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

Creates a new instance of GarminAPConfig.

Parameters

Parameter	Type	Description
bus	EventBus	The event bus.
options?	Readonly<GarminAPConfigOptions>	Options to configure the directors.

Returns

GarminAPConfig

Properties

autopilotDriverOptions

autopilotDriverOptions: AutopilotDriverOptions

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

Options for the Autopilot Driver

Implementation of

GarminAPConfigInterface.autopilotDriverOptions

---

cdiId

readonly cdiId: string

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

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:179

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:171

The autopilot's default lateral mode.

Implementation of

GarminAPConfigInterface.defaultLateralMode

---

defaultMaxBankAngle

defaultMaxBankAngle: number = GarminAPConfig.DEFAULT_MAX_BANK_ANGLE

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

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

---

defaultVerticalMode

defaultVerticalMode: APVerticalModes = APVerticalModes.PITCH

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

The autopilot's default vertical mode.

Implementation of

GarminAPConfigInterface.defaultVerticalMode

---

useIndicatedMach

readonly useIndicatedMach: boolean

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

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:151

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:166

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:169

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:160

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:157

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:148

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:154

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:163

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

Methods

createAltCapDirector()

protected createAltCapDirector(apValues): undefined | PlaneDirector

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

Creates the autopilot's altitude capture mode director.

Parameters

Parameter	Type	Description
apValues	APValues	The autopilot's state values.

Returns

undefined | PlaneDirector

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

---

createAltHoldDirector()

protected createAltHoldDirector(apValues): undefined | PlaneDirector

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

Creates the autopilot's altitude hold mode director.

Parameters

Parameter	Type	Description
apValues	APValues	The autopilot's state values.

Returns

undefined | PlaneDirector

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

---

createBcDirector()

protected createBcDirector(apValues): undefined | PlaneDirector

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

Creates the autopilot's localizer backcourse mode director.

Parameters

Parameter	Type	Description
apValues	APValues	The autopilot's state values.

Returns

undefined | PlaneDirector

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

---

createFlcDirector()

protected createFlcDirector(apValues): undefined | PlaneDirector

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

Creates the autopilot's flight level change mode director.

Parameters

Parameter	Type	Description
apValues	APValues	The autopilot's state values.

Returns

undefined | PlaneDirector

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

---

createGaLateralDirector()

protected createGaLateralDirector(apValues): undefined | PlaneDirector

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

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

Parameters

Parameter	Type	Description
apValues	APValues	The autopilot's state values.

Returns

undefined | PlaneDirector

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

---

createGaVerticalDirector()

protected createGaVerticalDirector(apValues): undefined | PlaneDirector

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

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

Parameters

Parameter	Type	Description
apValues	APValues	The autopilot's state values.

Returns

undefined | PlaneDirector

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

---

createGpDirector()

protected createGpDirector(apValues): undefined | PlaneDirector

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

Creates the autopilot's glidepath mode director.

Parameters

Parameter	Type	Description
apValues	APValues	The autopilot's state values.

Returns

undefined | PlaneDirector

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

---

createGpssDirector()

protected createGpssDirector(apValues): undefined | PlaneDirector

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

Creates the autopilot's GPSS mode director.

Parameters

Parameter	Type	Description
apValues	APValues	The autopilot's state values.

Returns

undefined | PlaneDirector

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

---

createGsDirector()

protected createGsDirector(apValues): undefined | PlaneDirector

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

Creates the autopilot's glideslope mode director.

Parameters

Parameter	Type	Description
apValues	APValues	The autopilot's state values.

Returns

undefined | PlaneDirector

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

---

createHeadingDirector()

protected createHeadingDirector(apValues): undefined | PlaneDirector

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

Creates the autopilot's heading mode director.

Parameters

Parameter	Type	Description
apValues	APValues	The autopilot's state values.

Returns

undefined | PlaneDirector

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:297

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

Parameters

Parameter	Type	Description
apValues	APValues	The 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): undefined | PlaneDirector

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

Creates the autopilot's localizer mode director.

Parameters

Parameter	Type	Description
apValues	APValues	The autopilot's state values.

Returns

undefined | PlaneDirector

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

---

createNavToNavManager()

createNavToNavManager(apValues): undefined | NavToNavManager2

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

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

Parameters

Parameter	Type	Description
apValues	APValues	The autopilot's state values.

Returns

undefined | NavToNavManager2

The autopilot's nav-to-nav manager.

Implementation of

GarminAPConfigInterface.createNavToNavManager

---

createPitchDirector()

protected createPitchDirector(apValues): undefined | PlaneDirector

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

Creates the autopilot's pitch mode director.

Parameters

Parameter	Type	Description
apValues	APValues	The autopilot's state values.

Returns

undefined | PlaneDirector

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

---

createPitchLevelerDirector()

protected createPitchLevelerDirector(apValues): undefined | PlaneDirector

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

Creates the autopilot's pitch level mode director.

Parameters

Parameter	Type	Description
apValues	APValues	The autopilot's state values.

Returns

undefined | PlaneDirector

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

---

createRollDirector()

protected createRollDirector(apValues): undefined | PlaneDirector

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

Creates the autopilot's roll mode director.

Parameters

Parameter	Type	Description
apValues	APValues	The autopilot's state values.

Returns

undefined | PlaneDirector

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

---

createToLateralDirector()

protected createToLateralDirector(apValues): undefined | PlaneDirector

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

Creates the autopilot's takeoff lateral mode director.

Parameters

Parameter	Type	Description
apValues	APValues	The autopilot's state values.

Returns

undefined | PlaneDirector

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

---

createToVerticalDirector()

protected createToVerticalDirector(apValues): undefined | PlaneDirector

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

Creates the autopilot's takeoff vertical mode director.

Parameters

Parameter	Type	Description
apValues	APValues	The autopilot's state values.

Returns

undefined | PlaneDirector

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

---

createTrackDirector()

protected createTrackDirector(apValues): undefined | PlaneDirector

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

Creates the autopilot's track mode director.

Parameters

Parameter	Type	Description
apValues	APValues	The autopilot's state values.

Returns

undefined | PlaneDirector

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:313

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

Parameters

Parameter	Type	Description
apValues	APValues	The 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): undefined | VNavManager

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

Creates the autopilot's VNAV Manager.

Parameters

Parameter	Type	Description
apValues	APValues	The autopilot's state values.

Returns

undefined | VNavManager

The autopilot's VNAV Manager.

Implementation of

GarminAPConfigInterface.createVNavManager

---

createVNavPathDirector()

protected createVNavPathDirector(apValues): undefined | PlaneDirector

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

Creates the autopilot's VNAV path mode director.

Parameters

Parameter	Type	Description
apValues	APValues	The autopilot's state values.

Returns

undefined | PlaneDirector

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

---

createVorDirector()

protected createVorDirector(apValues): undefined | PlaneDirector

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

Creates the autopilot's VOR mode director.

Parameters

Parameter	Type	Description
apValues	APValues	The autopilot's state values.

Returns

undefined | PlaneDirector

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

---

createVsDirector()

protected createVsDirector(apValues): undefined | PlaneDirector

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

Creates the autopilot's vertical speed mode director.

Parameters

Parameter	Type	Description
apValues	APValues	The autopilot's state values.

Returns

undefined | PlaneDirector

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

---

createWingLevelerDirector()

protected createWingLevelerDirector(apValues): undefined | PlaneDirector

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

Creates the autopilot's wing level mode director.

Parameters

Parameter	Type	Description
apValues	APValues	The autopilot's state values.

Returns

undefined | PlaneDirector

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