Class: GarminAutopilot

Defined in: src/garminsdk/autopilot/GarminAutopilot.ts:56

A Garmin autopilot.

Extends

• Autopilot<GarminAPConfigInterface>

Constructors

Constructor

new GarminAutopilot(bus, flightPlanner, config, stateManager, options?): GarminAutopilot

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

Creates a new instance of GarminAutopilot.

Parameters

Parameter	Type	Description
bus	EventBus	The event bus.
flightPlanner	FlightPlanner	This autopilot's associated flight planner.
config	GarminAPConfigInterface	This autopilot's configuration.
stateManager	APStateManager	This autopilot's state manager.
options?	Readonly<GarminAutopilotOptions>	Options with which to configure the new autopilot.

Returns

GarminAutopilot

Overrides

Autopilot<GarminAPConfigInterface>.constructor

Properties

_apValues

protected readonly _apValues: object

Defined in: src/sdk/autopilot/Autopilot.ts:160

apApproachModeOn

apApproachModeOn: Subject<boolean>

approachHasGP

approachHasGP: Subject<boolean>

approachIsActive

approachIsActive: Subject<boolean>

capturedAltitude

capturedAltitude: Subject<number>

cdiId

cdiId: string

cdiSource

cdiSource: Subject<Readonly<NavSourceId>>

isSelectedSpeedInMach

isSelectedSpeedInMach: Subject<boolean>

lateralActive

lateralActive: Subject<APLateralModes>

lateralArmed

lateralArmed: Subject<APLateralModes>

maxBankAngle

maxBankAngle: Subject<number>

maxBankId

maxBankId: Subject<number>

maxNoseDownPitchAngle

maxNoseDownPitchAngle: Subject<number>

maxNoseUpPitchAngle

maxNoseUpPitchAngle: Subject<number>

nav1HasGs

nav1HasGs: Subject<boolean>

nav2HasGs

nav2HasGs: Subject<boolean>

nav3HasGs

nav3HasGs: Subject<boolean>

nav4HasGs

nav4HasGs: Subject<boolean>

selectedAltitude

selectedAltitude: Subject<number>

selectedFlightPathAngle

selectedFlightPathAngle: Subject<number>

selectedHeading

selectedHeading: Subject<number>

selectedIas

selectedIas: Subject<number>

selectedMach

selectedMach: Subject<number>

selectedPitch

selectedPitch: Subject<number>

selectedVerticalSpeed

selectedVerticalSpeed: Subject<number>

simRate

simRate: Subject<number>

verticalActive

verticalActive: Subject<APVerticalModes>

verticalArmed

verticalArmed: Subject<APVerticalModes>

Inherited from

Autopilot._apValues

---

altCapArmed

protected altCapArmed: boolean = false

Defined in: src/sdk/autopilot/Autopilot.ts:148

Inherited from

Autopilot.altCapArmed

---

altSelectManager

protected readonly altSelectManager: AltitudeSelectManager

Defined in: src/garminsdk/autopilot/GarminAutopilot.ts:73

---

altSelectStops

protected readonly altSelectStops: SetSubject<number>

Defined in: src/garminsdk/autopilot/GarminAutopilot.ts:71

---

apDriver

protected readonly apDriver: AutopilotDriver

Defined in: src/sdk/autopilot/Autopilot.ts:139

This autopilot's sim autopilot driver.

Inherited from

Autopilot.apDriver

---

apValues

readonly apValues: APValues

Defined in: src/sdk/autopilot/Autopilot.ts:190

Inherited from

Autopilot.apValues

---

autopilotInitialized

protected autopilotInitialized: boolean = false

Defined in: src/sdk/autopilot/Autopilot.ts:192

Inherited from

Autopilot.autopilotInitialized

---

bus

protected readonly bus: EventBus

Defined in: src/sdk/autopilot/Autopilot.ts:202

The event bus.

Inherited from

Autopilot.bus

---

cdiSource

protected cdiSource: Readonly<NavSourceId>

Defined in: src/sdk/autopilot/Autopilot.ts:141

Inherited from

Autopilot.cdiSource

---

config

protected readonly config: GarminAPConfigInterface

Defined in: src/sdk/autopilot/Autopilot.ts:204

This autopilot's configuration.

Inherited from

Autopilot.config

---

currentAltitude

protected currentAltitude: number = 0

Defined in: src/sdk/autopilot/Autopilot.ts:152

Inherited from

Autopilot.currentAltitude

---

directors

readonly directors: APDirectors

Defined in: src/sdk/autopilot/Autopilot.ts:125

This autopilot's plane directors.

Inherited from

Autopilot.directors

---

flightPlanner

protected readonly flightPlanner: FlightPlanner

Defined in: src/sdk/autopilot/Autopilot.ts:203

This autopilot's associated flight planner.

Inherited from

Autopilot.flightPlanner

---

flightPlanSynced

protected flightPlanSynced: boolean = false

Defined in: src/sdk/autopilot/Autopilot.ts:155

Inherited from

Autopilot.flightPlanSynced

---

fmaData

protected readonly fmaData: ObjectSubject<FmaData>

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

---

fmaDataPublisher

protected readonly fmaDataPublisher: Publisher<FmaDataEvents>

Defined in: src/garminsdk/autopilot/GarminAutopilot.ts:88

---

inClimb

protected inClimb: boolean = false

Defined in: src/sdk/autopilot/Autopilot.ts:151

Inherited from

Autopilot.inClimb

---

isApproachModeCommandedOn

protected isApproachModeCommandedOn: boolean = false

Defined in: src/garminsdk/autopilot/GarminAutopilot.ts:99

---

isApproachModeOn

protected readonly isApproachModeOn: Subject<boolean>

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

---

isNavModeOn

protected readonly isNavModeOn: Subject<boolean>

Defined in: src/garminsdk/autopilot/GarminAutopilot.ts:96

---

lateralModeFailed

protected lateralModeFailed: boolean = false

Defined in: src/sdk/autopilot/Autopilot.ts:149

Inherited from

Autopilot.lateralModeFailed

---

lateralModes

protected lateralModes: Map<APLateralModes, PlaneDirector>

Defined in: src/sdk/autopilot/Autopilot.ts:143

Inherited from

Autopilot.lateralModes

---

machToKias

protected readonly machToKias: ConsumerValue<number>

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

---

navToNavManager

readonly navToNavManager: undefined | NavToNavManager | NavToNavManager2

Defined in: src/sdk/autopilot/Autopilot.ts:128

This autopilot's nav-to-nav transfer manager.

Inherited from

Autopilot.navToNavManager

---

navToNavManagerToUse

protected readonly navToNavManagerToUse: undefined | NavToNavManager2

Defined in: src/sdk/autopilot/Autopilot.ts:130

Inherited from

Autopilot.navToNavManagerToUse

---

needPublishFmaData

protected needPublishFmaData: boolean = false

Defined in: src/garminsdk/autopilot/GarminAutopilot.ts:89

---

requireApproachIsActiveForNavToNav

protected requireApproachIsActiveForNavToNav: boolean = true

Defined in: src/sdk/autopilot/Autopilot.ts:158

Can be set to false in child classes to override behavior for certain aircraft.

Inherited from

Autopilot.requireApproachIsActiveForNavToNav

---

selSpeedIsMach

protected readonly selSpeedIsMach: ConsumerSubject<boolean>

Defined in: src/garminsdk/autopilot/GarminAutopilot.ts:92

---

stateManager

readonly stateManager: APStateManager

Defined in: src/sdk/autopilot/Autopilot.ts:205

This autopilot's state manager.

Inherited from

Autopilot.stateManager

---

supportMachSelect

protected readonly supportMachSelect: boolean

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

---

variableBankManager

readonly variableBankManager: undefined | Record<any, any>

Defined in: src/sdk/autopilot/Autopilot.ts:136

This autopilot's variable bank angle Manager.

Inherited from

Autopilot.variableBankManager

---

verticalAltitudeArmed

protected verticalAltitudeArmed: APAltitudeModes = APAltitudeModes.NONE

Defined in: src/sdk/autopilot/Autopilot.ts:146

Inherited from

Autopilot.verticalAltitudeArmed

---

verticalApproachArmed

protected verticalApproachArmed: APVerticalModes = APVerticalModes.NONE

Defined in: src/sdk/autopilot/Autopilot.ts:147

Inherited from

Autopilot.verticalApproachArmed

---

verticalModes

protected verticalModes: Map<APVerticalModes, PlaneDirector>

Defined in: src/sdk/autopilot/Autopilot.ts:145

Inherited from

Autopilot.verticalModes

---

vnavCaptureType

protected vnavCaptureType: VNavAltCaptureType = VNavAltCaptureType.None

Defined in: src/sdk/autopilot/Autopilot.ts:153

Inherited from

Autopilot.vnavCaptureType

---

vnavManager

readonly vnavManager: undefined | VNavManager

Defined in: src/sdk/autopilot/Autopilot.ts:133

This autopilot's VNav Manager.

Inherited from

Autopilot.vnavManager

---

ALT_SELECT_OPTIONS_DEFAULT

protected readonly static ALT_SELECT_OPTIONS_DEFAULT: AltitudeSelectManagerOptions

Defined in: src/garminsdk/autopilot/GarminAutopilot.ts:57

Methods

activateApproachMode()

protected activateApproachMode(): void

Defined in: src/garminsdk/autopilot/GarminAutopilot.ts:393

Activates approach mode. Activating approach mode will arm lateral and vertical modes based on the current CDI source and nav-to-nav guidance.

Returns

void

---

approachPressed()

protected approachPressed(set?): void

Defined in: src/garminsdk/autopilot/GarminAutopilot.ts:370

Parameters

Parameter	Type
set?	boolean

Returns

void

Inherit Doc

Overrides

Autopilot.approachPressed

---

armModesForApproach()

protected armModesForApproach(lateralMode, verticalMode): void

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

Arms lateral and vertical approach modes. The vertical mode will only be armed if the lateral mode is successfully armed.

Parameters

Parameter	Type	Description
lateralMode	APLateralModes	The lateral mode to arm.
verticalMode	APVerticalModes	The vertical mode to arm.

Returns

void

---

checkModes()

protected checkModes(): void

Defined in: src/sdk/autopilot/Autopilot.ts:1032

Checks if all the active and armed modes are still in their proper state and takes corrective action if not.

Returns

void

Inherited from

Autopilot.checkModes

---

checkRollModeActive()

protected checkRollModeActive(): void

Defined in: src/sdk/autopilot/Autopilot.ts:1350

Checks if the sim AP is in roll mode and sets it if not.

Returns

void

Inherited from

Autopilot.checkRollModeActive

---

deactivateApproachMode()

protected deactivateApproachMode(preserveLateralMode): void

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

Deactivates approach mode. Deactivating approach mode will deactivate any armed or active lateral and vertical approach modes.

Parameters

Parameter	Type	Description
preserveLateralMode	boolean	Whether to preserve armed or active lateral modes. If true, then any armed or active lateral approach mode that is deactivated will be replaced with its non-approach counterpart, if one exists.

Returns

void

---

deactivateArmedOrActiveLateralMode()

protected deactivateArmedOrActiveLateralMode(mode): boolean

Defined in: src/sdk/autopilot/Autopilot.ts:463

Attempts to deactivate an armed or active lateral mode.

Parameters

Parameter	Type	Description
mode	APLateralModes	The lateral mode to deactivate.

Returns

boolean

Whether the specified mode was armed or active and deactivated by this method.

Inherited from

Autopilot.deactivateArmedOrActiveLateralMode

---

deactivateArmedOrActiveVerticalMode()

protected deactivateArmedOrActiveVerticalMode(mode): boolean

Defined in: src/sdk/autopilot/Autopilot.ts:509

Attempts to deactivate an armed or active vertical mode.

Parameters

Parameter	Type	Description
mode	APVerticalModes	The vertical mode to deactivate.

Returns

boolean

Whether the specified mode was armed or active and deactivated by this method.

Inherited from

Autopilot.deactivateArmedOrActiveVerticalMode

---

getArmableApproachType()

protected getArmableApproachType(): APLateralModes

Defined in: src/sdk/autopilot/Autopilot.ts:615

Returns the AP Lateral Mode that can be armed.

Returns

APLateralModes

The AP Lateral Mode that can be armed.

Inherited from

Autopilot.getArmableApproachType

---

getDefaultLateralMode()

protected getDefaultLateralMode(): APLateralModes

Defined in: src/sdk/autopilot/Autopilot.ts:1369

Get the default lateral mode from APConfig

Returns

APLateralModes

default lateral mode

Inherited from

Autopilot.getDefaultLateralMode

---

getDefaultVerticalMode()

protected getDefaultVerticalMode(): APVerticalModes

Defined in: src/sdk/autopilot/Autopilot.ts:1381

Get the default vertical mode from APConfig

Returns

APVerticalModes

default vertical mode

Inherited from

Autopilot.getDefaultVerticalMode

---

handleApFdStateChange()

protected handleApFdStateChange(): void

Defined in: src/sdk/autopilot/Autopilot.ts:1312

Manages the FD state and the modes when AP/FD are off.

Returns

void

Inherited from

Autopilot.handleApFdStateChange

---

initLateralModes()

protected initLateralModes(): void

Defined in: src/sdk/autopilot/Autopilot.ts:729

Initializes the Autopilot with the available lateral modes from the config.

Returns

void

Inherited from

Autopilot.initLateralModes

---

initNavToNavManager()

protected initNavToNavManager(): void

Defined in: src/sdk/autopilot/Autopilot.ts:856

Initializes the Autopilot with the available Nav To Nav Manager.

Returns

void

Inherited from

Autopilot.initNavToNavManager

---

initVerticalModes()

protected initVerticalModes(): void

Defined in: src/garminsdk/autopilot/GarminAutopilot.ts:163

Returns

void

Inherit Doc

Overrides

Autopilot.initVerticalModes

---

initVNavManager()

protected initVNavManager(): void

Defined in: src/sdk/autopilot/Autopilot.ts:872

Initializes the Autopilot with the available VNav Manager.

Returns

void

Inherited from

Autopilot.initVNavManager

---

isLateralModeActivatedOrArmed()

protected isLateralModeActivatedOrArmed(mode): boolean

Defined in: src/sdk/autopilot/Autopilot.ts:454

Checks if a lateral mode is armed or active and if so, deactivates it.

Parameters

Parameter	Type	Description
mode	APLateralModes	The lateral mode to check and deactivate.

Returns

boolean

Whether the specified mode was armed or active and deactivated by this method.

Deprecated

Please use deactivateArmedOrActiveLateralMode() instead.

Inherited from

Autopilot.isLateralModeActivatedOrArmed

---

lateralPressed()

protected lateralPressed(data): void

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

Parameters

Parameter	Type
data	APModePressEvent

Returns

void

Inherit Doc

Overrides

Autopilot.lateralPressed

---

manageAltitudeCapture()

protected manageAltitudeCapture(): void

Defined in: src/garminsdk/autopilot/GarminAutopilot.ts:221

Checks and sets the proper armed altitude mode.

Returns

void

Overrides

Autopilot.manageAltitudeCapture

---

monitorAdditionalEvents()

protected monitorAdditionalEvents(): void

Defined in: src/garminsdk/autopilot/GarminAutopilot.ts:188

Returns

void

Inherit Doc

Overrides

Autopilot.monitorAdditionalEvents

---

monitorApSpeedValues()

protected monitorApSpeedValues(): void

Defined in: src/sdk/autopilot/Autopilot.ts:1289

Overridable method for setting the selected speed values for the A/P to follow.

Returns

void

Inherited from

Autopilot.monitorApSpeedValues

---

monitorEvents()

protected monitorEvents(): void

Defined in: src/sdk/autopilot/Autopilot.ts:1157

Monitors subevents and bus events.

Returns

void

Inherited from

Autopilot.monitorEvents

---

monitorGarminEvents()

protected monitorGarminEvents(): void

Defined in: src/garminsdk/autopilot/GarminAutopilot.ts:177

Monitors Garmin autopilot-specific events.

Returns

void

---

onAfterUpdate()

protected onAfterUpdate(): void

Defined in: src/garminsdk/autopilot/GarminAutopilot.ts:253

Returns

void

Inherit Doc

Overrides

Autopilot.onAfterUpdate

---

onBeforeUpdate()

protected onBeforeUpdate(): void

Defined in: src/sdk/autopilot/Autopilot.ts:328

This method runs each update cycle before the update occurs.

Returns

void

Inherited from

Autopilot.onBeforeUpdate

---

onInitialized()

protected onInitialized(): void

Defined in: src/garminsdk/autopilot/GarminAutopilot.ts:183

Returns

void

Inherit Doc

Overrides

Autopilot.onInitialized

---

reconcileApproachState()

protected reconcileApproachState(): void

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

Reconciles the nominal approach mode state with the state of this autopilot's directors.

Returns

void

---

reset()

reset(): void

Defined in: src/garminsdk/autopilot/GarminAutopilot.ts:152

Resets this autopilot. Resets the altitude preselector, sets AP MASTER to off, and deactivates the flight director.

Returns

void

---

setAltHold()

protected setAltHold(): void

Defined in: src/sdk/autopilot/Autopilot.ts:718

Method called when the ALT button is pressed.

Returns

void

Inherited from

Autopilot.setAltHold

---

setLateralActive()

protected setLateralActive(mode): void

Defined in: src/sdk/autopilot/Autopilot.ts:645

Callback to set the lateral active mode.

Parameters

Parameter	Type	Description
mode	APLateralModes	is the mode being set.

Returns

void

Inherited from

Autopilot.setLateralActive

---

setVerticalActive()

protected setVerticalActive(mode): void

Defined in: src/sdk/autopilot/Autopilot.ts:673

Callback to set the vertical active mode.

Parameters

Parameter	Type	Description
mode	APVerticalModes	is the mode being set.

Returns

void

Inherited from

Autopilot.setVerticalActive

---

setVerticalApproachArmed()

protected setVerticalApproachArmed(mode): void

Defined in: src/sdk/autopilot/Autopilot.ts:709

Callback to set the vertical approach armed mode.

Parameters

Parameter	Type	Description
mode	APVerticalModes	is the mode being set.

Returns

void

Inherited from

Autopilot.setVerticalApproachArmed

---

setVerticalArmed()

protected setVerticalArmed(mode): void

Defined in: src/sdk/autopilot/Autopilot.ts:694

Callback to set the vertical armed mode.

Parameters

Parameter	Type	Description
mode	APVerticalModes	is the mode being set.

Returns

void

Inherited from

Autopilot.setVerticalArmed

---

togaPressed()

protected togaPressed(): void

Defined in: src/sdk/autopilot/Autopilot.ts:567

Handles input from the State Manager when the TOGA button is pressed (K event AUTO_THROTTLE_TO_GA)

Returns

void

Inherited from

Autopilot.togaPressed

---

update()

update(): void

Defined in: src/sdk/autopilot/Autopilot.ts:312

Update method for the Autopilot.

Returns

void

Inherited from

Autopilot.update

---

updateApproachModeState()

protected updateApproachModeState(): void

Defined in: src/garminsdk/autopilot/GarminAutopilot.ts:301

Updates this autopilot's approach mode state.

Returns

void

---

updateFma()

protected updateFma(): void

Defined in: src/garminsdk/autopilot/GarminAutopilot.ts:311

Publishes data for the FMA.

Returns

void

---

updateModes()

protected updateModes(): void

Defined in: src/sdk/autopilot/Autopilot.ts:1069

Runs update on each of the active and armed modes.

Returns

void

Inherited from

Autopilot.updateModes

---

updateNavModeState()

protected updateNavModeState(): void

Defined in: src/garminsdk/autopilot/GarminAutopilot.ts:262

Updates this autopilot's NAV mode state.

Returns

void

---

updateNavToNavManagerAfter()

protected updateNavToNavManagerAfter(): void

Defined in: src/sdk/autopilot/Autopilot.ts:1150

Updates this autopilot's nav-to-nav manager after directors have been updated.

Returns

void

Inherited from

Autopilot.updateNavToNavManagerAfter

---

updateNavToNavManagerBefore()

protected updateNavToNavManagerBefore(): void

Defined in: src/sdk/autopilot/Autopilot.ts:1143

Updates this autopilot's nav-to-nav manager before directors have been updated.

Returns

void

Inherited from

Autopilot.updateNavToNavManagerBefore

---

verticalPressed()

protected verticalPressed(data): void

Defined in: src/sdk/autopilot/Autopilot.ts:398

Handles input from the State Manager when a vertical mode button is pressed.

Parameters

Parameter	Type	Description
data	APModePressEvent	is the AP Vertical Mode Event Data

Returns

void

Inherited from

Autopilot.verticalPressed