Skip to main content

Class: GarminAPConfig

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

A Garmin Autopilot Configuration.

Implements​

Constructors​

Constructor​

new GarminAPConfig(bus, flightPlanner, verticalPathCalculator?, options?): GarminAPConfig

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

Creates a new instance of GarminAPConfig.

Parameters​

ParameterTypeDescription
busEventBusThe event bus.
flightPlannerFlightPlannerThe flight planner of the FMS instance from which to source data. The LNAV instance index associated with the flight planner is assumed to be 0.
verticalPathCalculator?VNavPathCalculatorThe vertical path calculator to use for the autopilot's internal VNAV and glidepath computers. If not defined, then the internal computers will not be created even if the omission would leave the autopilot without VNAV and glidepath capability.
options?Readonly<GarminAPConfigOptions>Options to configure the directors.

Returns​

GarminAPConfig

Deprecated​

Constructor​

new GarminAPConfig(bus, fms, verticalPathCalculator?, options?): GarminAPConfig

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

Creates a new instance of GarminAPConfig.

Parameters​

ParameterTypeDescription
busEventBusThe event bus.
fmsFms<any> | Subscribable<Fms<any>>The FMS instance from which to source data.
verticalPathCalculator?VNavPathCalculatorThe vertical path calculator to use for the autopilot's internal VNAV and glidepath computers. If not defined, then the internal computers will not be created even if the omission would leave the autopilot without VNAV and glidepath capability.
options?Readonly<GarminAPConfigOptions>Options to configure the directors.

Returns​

GarminAPConfig

Properties​

autopilotDriverOptions​

autopilotDriverOptions: AutopilotDriverOptions

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

Options for the Autopilot Driver

Implementation of​

GarminAPConfigInterface.autopilotDriverOptions

cdiId​

readonly cdiId: string

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

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

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

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

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

The autopilot's default vertical mode.

Implementation of​

GarminAPConfigInterface.defaultVerticalMode

useIndicatedMach​

readonly useIndicatedMach: boolean

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

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

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

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

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

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

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

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

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

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

Methods​

createAltCapDirector()​

createAltCapDirector(apValues): APAltCapDirector

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

Creates the autopilot's altitude capture mode director.

Parameters​

ParameterTypeDescription
apValuesAPValuesThe autopilot's state values.

Returns​

APAltCapDirector

The autopilot's altitude capture mode director.

Implementation of​

GarminAPConfigInterface.createAltCapDirector

createAltHoldDirector()​

createAltHoldDirector(apValues): APAltDirector

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

Creates the autopilot's altitude hold mode director.

Parameters​

ParameterTypeDescription
apValuesAPValuesThe autopilot's state values.

Returns​

APAltDirector

The autopilot's altitude hold mode director.

Implementation of​

GarminAPConfigInterface.createAltHoldDirector

createBcDirector()​

createBcDirector(apValues): APBackCourseDirector

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

Creates the autopilot's back-course mode director.

Parameters​

ParameterTypeDescription
apValuesAPValuesThe autopilot's state values.

Returns​

APBackCourseDirector

The autopilot's back-course mode director.

Implementation of​

GarminAPConfigInterface.createBcDirector

createFlcDirector()​

createFlcDirector(apValues): APFLCDirector

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

Creates the autopilot's flight level change mode director.

Parameters​

ParameterTypeDescription
apValuesAPValuesThe autopilot's state values.

Returns​

APFLCDirector

The autopilot's flight level change mode director.

Implementation of​

GarminAPConfigInterface.createFlcDirector

createGaLateralDirector()​

createGaLateralDirector(apValues): undefined | PlaneDirector

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

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

Parameters​

ParameterType
apValuesAPValues

Returns​

undefined | PlaneDirector

The autopilot's lateral go-around mode director.

Implementation of​

GarminAPConfigInterface.createGaLateralDirector

createGaVerticalDirector()​

createGaVerticalDirector(apValues): undefined | PlaneDirector

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

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

Parameters​

ParameterType
apValuesAPValues

Returns​

undefined | PlaneDirector

The autopilot's vertical go-around mode director.

Implementation of​

GarminAPConfigInterface.createGaVerticalDirector

createGpDirector()​

createGpDirector(apValues): APGPDirector

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

Creates the autopilot's GPS glidepath mode director.

Parameters​

ParameterTypeDescription
apValuesAPValuesThe autopilot's state values.

Returns​

APGPDirector

The autopilot's GPS glidepath mode director.

Implementation of​

GarminAPConfigInterface.createGpDirector

createGpssDirector()​

createGpssDirector(apValues): undefined | PlaneDirector

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

Creates the autopilot's GPS LNAV mode director.

Parameters​

ParameterTypeDescription
apValuesAPValuesThe autopilot's state values.

Returns​

undefined | PlaneDirector

The autopilot's GPS LNAV mode director.

Implementation of​

GarminAPConfigInterface.createGpssDirector

createGsDirector()​

createGsDirector(apValues): APGSDirector

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

Creates the autopilot's ILS glideslope mode director.

Parameters​

ParameterTypeDescription
apValuesAPValuesThe autopilot's state values.

Returns​

APGSDirector

The autopilot's ILS glideslope mode director.

Implementation of​

GarminAPConfigInterface.createGsDirector

createHeadingDirector()​

createHeadingDirector(apValues): APHdgDirector

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

Creates the autopilot's heading mode director.

Parameters​

ParameterTypeDescription
apValuesAPValuesThe autopilot's state values.

Returns​

APHdgDirector

The autopilot's heading mode director.

Implementation of​

GarminAPConfigInterface.createHeadingDirector

createLocDirector()​

createLocDirector(apValues): APNavDirector

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

Creates the autopilot's LOC mode director.

Parameters​

ParameterTypeDescription
apValuesAPValuesThe autopilot's state values.

Returns​

APNavDirector

The autopilot's LOC mode director.

Implementation of​

GarminAPConfigInterface.createLocDirector

createNavToNavManager()​

createNavToNavManager(apValues): undefined | NavToNavManager | NavToNavManager2

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

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

Parameters​

ParameterTypeDescription
apValuesAPValuesThe autopilot's state values.

Returns​

undefined | NavToNavManager | NavToNavManager2

The autopilot's nav-to-nav manager.

Implementation of​

GarminAPConfigInterface.createNavToNavManager

createPitchDirector()​

createPitchDirector(apValues): APPitchDirector

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

Creates the autopilot's pitch mode director.

Parameters​

ParameterTypeDescription
apValuesAPValuesThe autopilot's state values.

Returns​

APPitchDirector

The autopilot's pitch mode director.

Implementation of​

GarminAPConfigInterface.createPitchDirector

createPitchLevelerDirector()​

createPitchLevelerDirector(apValues): APPitchLvlDirector

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

Creates the autopilot's pitch level mode director.

Parameters​

ParameterTypeDescription
apValuesAPValuesThe autopilot's state values.

Returns​

APPitchLvlDirector

The autopilot's pitch level mode director.

Implementation of​

GarminAPConfigInterface.createPitchLevelerDirector

createRollDirector()​

createRollDirector(apValues): APRollDirector

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

Creates the autopilot's roll mode director.

Parameters​

ParameterTypeDescription
apValuesAPValuesThe autopilot's state values.

Returns​

APRollDirector

The autopilot's heading mode director.

Implementation of​

GarminAPConfigInterface.createRollDirector

createToLateralDirector()​

createToLateralDirector(apValues): undefined | PlaneDirector

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

Creates the autopilot's lateral takeoff mode director (or combined lateral takeoff/go-around mode director).

Parameters​

ParameterType
apValuesAPValues

Returns​

undefined | PlaneDirector

The autopilot's lateral takeoff mode director.

Implementation of​

GarminAPConfigInterface.createToLateralDirector

createToVerticalDirector()​

createToVerticalDirector(apValues): undefined | PlaneDirector

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

Creates the autopilot's vertical takeoff mode director (or combined vertical takeoff/go-around mode director).

Parameters​

ParameterType
apValuesAPValues

Returns​

undefined | PlaneDirector

The autopilot's vertical takeoff mode director.

Implementation of​

GarminAPConfigInterface.createToVerticalDirector

createVNavManager()​

createVNavManager(apValues): undefined | VNavManager

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

Creates the autopilot's VNAV Manager.

Parameters​

ParameterTypeDescription
apValuesAPValuesThe autopilot's state values.

Returns​

undefined | VNavManager

The autopilot's VNAV Manager.

Implementation of​

GarminAPConfigInterface.createVNavManager

createVNavPathDirector()​

createVNavPathDirector(apValues): undefined | PlaneDirector

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

Creates the autopilot's VNAV Path mode director.

Parameters​

ParameterTypeDescription
apValuesAPValuesThe autopilot's state values.

Returns​

undefined | PlaneDirector

The autopilot's VNAV Path mode director.

Implementation of​

GarminAPConfigInterface.createVNavPathDirector

createVorDirector()​

createVorDirector(apValues): APNavDirector

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

Creates the autopilot's VOR mode director.

Parameters​

ParameterTypeDescription
apValuesAPValuesThe autopilot's state values.

Returns​

APNavDirector

The autopilot's VOR mode director.

Implementation of​

GarminAPConfigInterface.createVorDirector

createVsDirector()​

createVsDirector(apValues): APVSDirector

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

Creates the autopilot's vertical speed mode director.

Parameters​

ParameterTypeDescription
apValuesAPValuesThe autopilot's state values.

Returns​

APVSDirector

The autopilot's vertical speed mode director.

Implementation of​

GarminAPConfigInterface.createVsDirector

createWingLevelerDirector()​

createWingLevelerDirector(apValues): APLvlDirector

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

Creates the autopilot's wings level mode director.

Parameters​

ParameterTypeDescription
apValuesAPValuesThe autopilot's state values.

Returns​

APLvlDirector

The autopilot's wings level mode director.

Implementation of​

GarminAPConfigInterface.createWingLevelerDirector