Interface: GarminAPConfigInterface
A Garmin Autopilot Configuration.
Hierarchy
APConfig↳
GarminAPConfigInterface
Implemented by
Properties
altitudeHoldDefaultAltitude
• Optional altitudeHoldDefaultAltitude: number
The default altitude hold value set during init, defaults to 0
Inherited from
APConfig.altitudeHoldDefaultAltitude
Defined in
src/sdk/autopilot/APConfig.ts:405
altitudeHoldSlotIndex
• Optional altitudeHoldSlotIndex: 2 | 1 | 3
The altitude hold slot index to use. Defaults to 1
Inherited from
APConfig.altitudeHoldSlotIndex
Defined in
src/sdk/autopilot/APConfig.ts:402
autoEngageFd
• Optional autoEngageFd: boolean
Whether to automatically engage the FD(s) with AP or mode button presses, defaults to true. Lateral/Vertical press events will be ignored if this is false and neither AP nor FDs are engaged.
Inherited from
APConfig.autoEngageFd
Defined in
src/sdk/autopilot/APConfig.ts:422
autopilotDriverOptions
• Optional Readonly autopilotDriverOptions: Readonly<AutopilotDriverOptions>
Options for the Autopilot Driver
Inherited from
APConfig.autopilotDriverOptions
Defined in
src/sdk/autopilot/APConfig.ts:440
cdiId
• Optional Readonly cdiId: string
The ID of the CDI associated with the autopilot. Defaults to the empty string ''.
Inherited from
APConfig.cdiId
Defined in
src/sdk/autopilot/APConfig.ts:411
defaultLateralMode
• defaultLateralMode: APLateralModes | () => APLateralModes
The autopilot's default lateral mode.
Inherited from
APConfig.defaultLateralMode
Defined in
src/sdk/autopilot/APConfig.ts:390
defaultMaxBankAngle
• Optional defaultMaxBankAngle: number
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
Inherited from
APConfig.defaultMaxBankAngle
Defined in
src/sdk/autopilot/APConfig.ts:399
defaultVerticalMode
• defaultVerticalMode: APVerticalModes | () => APVerticalModes
The autopilot's default vertical mode.
Inherited from
APConfig.defaultVerticalMode
Defined in
src/sdk/autopilot/APConfig.ts:393
headingHoldSlotIndex
• Optional headingHoldSlotIndex: 2 | 1 | 3
The heading hold slot index to use. Defaults to 1
Inherited from
APConfig.headingHoldSlotIndex
Defined in
src/sdk/autopilot/APConfig.ts:408
independentFds
• Optional independentFds: boolean
Whether to have independent flight directors that can be switched on/off separately. Defaults to false.
Inherited from
APConfig.independentFds
Defined in
src/sdk/autopilot/APConfig.ts:427
initializeStateManagerOnFirstFlightPlanSync
• Optional Readonly initializeStateManagerOnFirstFlightPlanSync: boolean
When true, will initialize the state manager when the flight plan is next synced. This is a work around to delay initialization of autopilot, and you may not need it if you handle initialization of the ap state manager in your code. Defaults to true.
Inherited from
APConfig.initializeStateManagerOnFirstFlightPlanSync
Defined in
src/sdk/autopilot/APConfig.ts:435
onlyDisarmLnavOnOffEvent
• Optional onlyDisarmLnavOnOffEvent: boolean
Whether to only allow disarming (not deactivating) LNAV when receiving the AP_NAV1_HOLD_OFF event
Inherited from
APConfig.onlyDisarmLnavOnOffEvent
Defined in
src/sdk/autopilot/APConfig.ts:416
useIndicatedMach
• Readonly useIndicatedMach: boolean
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.
Defined in
src/garminsdk/autopilot/GarminAPConfigInterface.ts:11
Methods
createAltCapDirector
▸ createAltCapDirector(apValues): undefined | PlaneDirector
Creates the autopilot's altitude capture mode director.
Parameters
| Name | Type | Description |
|---|---|---|
apValues | APValues | The autopilot's state values. |
Returns
undefined | PlaneDirector
The autopilot's altitude capture mode director.
Inherited from
APConfig.createAltCapDirector
Defined in
src/sdk/autopilot/APConfig.ts:328
createAltHoldDirector
▸ createAltHoldDirector(apValues): undefined | PlaneDirector
Creates the autopilot's altitude hold mode director.
Parameters
| Name | Type | Description |
|---|---|---|
apValues | APValues | The autopilot's state values. |
Returns
undefined | PlaneDirector
The autopilot's altitude hold mode director.
Inherited from
APConfig.createAltHoldDirector
Defined in
src/sdk/autopilot/APConfig.ts:321
createBcDirector
▸ createBcDirector(apValues): undefined | PlaneDirector
Creates the autopilot's back-course mode director.
Parameters
| Name | Type | Description |
|---|---|---|
apValues | APValues | The autopilot's state values. |
Returns
undefined | PlaneDirector
The autopilot's back-course mode director.
Inherited from
APConfig.createBcDirector
Defined in
src/sdk/autopilot/APConfig.ts:280
createFlareDirector
▸ createFlareDirector(): undefined | PlaneDirector
Creates the auto land FLARE mode director.
Returns
undefined | PlaneDirector
The autopilot's FLARE mode director.
Inherited from
APConfig.createFlareDirector
Defined in
src/sdk/autopilot/APConfig.ts:349
createFlcDirector
▸ createFlcDirector(apValues): undefined | PlaneDirector
Creates the autopilot's flight level change mode director.
Parameters
| Name | Type | Description |
|---|---|---|
apValues | APValues | The autopilot's state values. |
Returns
undefined | PlaneDirector
The autopilot's flight level change mode director.
Inherited from
APConfig.createFlcDirector
Defined in
src/sdk/autopilot/APConfig.ts:314
createFmsLocLateralDirector
▸ createFmsLocLateralDirector(apValues): undefined | PlaneDirector
Creates the autopilot's FMC LOC-style mode director.
Parameters
| Name | Type | Description |
|---|---|---|
apValues | APValues | The autopilot's state values. |
Returns
undefined | PlaneDirector
The autopilot's FMS LOC mode director.
Inherited from
APConfig.createFmsLocLateralDirector
Defined in
src/sdk/autopilot/APConfig.ts:380
createFpaDirector
▸ createFpaDirector(apValues): undefined | PlaneDirector
Creates the autopilot's flight path angle mode director.
Parameters
| Name | Type | Description |
|---|---|---|
apValues | APValues | The autopilot's state values. |
Returns
undefined | PlaneDirector
The autopilot's flight path angle mode director.
Inherited from
APConfig.createFpaDirector
Defined in
src/sdk/autopilot/APConfig.ts:307
createGaLateralDirector
▸ createGaLateralDirector(apValues): undefined | PlaneDirector
Creates the autopilot's lateral go-around mode director.
Parameters
| Name | Type |
|---|---|
apValues | APValues |
Returns
undefined | PlaneDirector
The autopilot's lateral go-around mode director.
Inherited from
APConfig.createGaLateralDirector
Defined in
src/sdk/autopilot/APConfig.ts:373
createGaVerticalDirector
▸ createGaVerticalDirector(apValues): undefined | PlaneDirector
Creates the autopilot's vertical go-around mode director.
Parameters
| Name | Type |
|---|---|
apValues | APValues |
Returns
undefined | PlaneDirector
The autopilot's vertical go-around mode director.
Inherited from
APConfig.createGaVerticalDirector
Defined in
src/sdk/autopilot/APConfig.ts:361
createGpDirector
▸ createGpDirector(apValues): undefined | PlaneDirector
Creates the autopilot's GPS glidepath mode director.
Parameters
| Name | Type | Description |
|---|---|---|
apValues | APValues | The autopilot's state values. |
Returns
undefined | PlaneDirector
The autopilot's GPS glidepath mode director.
Inherited from
APConfig.createGpDirector
Defined in
src/sdk/autopilot/APConfig.ts:335
createGpssDirector
▸ createGpssDirector(apValues): undefined | PlaneDirector
Creates the autopilot's GPS LNAV mode director.
Parameters
| Name | Type | Description |
|---|---|---|
apValues | APValues | The autopilot's state values. |
Returns
undefined | PlaneDirector
The autopilot's GPS LNAV mode director.
Inherited from
APConfig.createGpssDirector
Defined in
src/sdk/autopilot/APConfig.ts:259
createGsDirector
▸ createGsDirector(apValues): undefined | PlaneDirector
Creates the autopilot's ILS glideslope mode director.
Parameters
| Name | Type | Description |
|---|---|---|
apValues | APValues | The autopilot's state values. |
Returns
undefined | PlaneDirector
The autopilot's ILS glideslope mode director.
Inherited from
APConfig.createGsDirector
Defined in
src/sdk/autopilot/APConfig.ts:342
createHeadingDirector
▸ createHeadingDirector(apValues): undefined | PlaneDirector
Creates the autopilot's heading mode director.
Parameters
| Name | Type | Description |
|---|---|---|
apValues | APValues | The autopilot's state values. |
Returns
undefined | PlaneDirector
The autopilot's heading mode director.
Inherited from
APConfig.createHeadingDirector
Defined in
src/sdk/autopilot/APConfig.ts:210
createHeadingHoldDirector
▸ createHeadingHoldDirector(apValues): undefined | PlaneDirector
Creates the autopilot's heading hold (level off and then capture heading)
Parameters
| Name | Type | Description |
|---|---|---|
apValues | APValues | The autopilot's state values. |
Returns
undefined | PlaneDirector
The autopilot's heading hold director.
Inherited from
APConfig.createHeadingHoldDirector
Defined in
src/sdk/autopilot/APConfig.ts:217
createLocDirector
▸ createLocDirector(apValues): undefined | PlaneDirector
Creates the autopilot's LOC mode director.
Parameters
| Name | Type | Description |
|---|---|---|
apValues | APValues | The autopilot's state values. |
Returns
undefined | PlaneDirector
The autopilot's LOC mode director.
Inherited from
APConfig.createLocDirector
Defined in
src/sdk/autopilot/APConfig.ts:273
createNavToNavManager
▸ createNavToNavManager(apValues): undefined | NavToNavManager | NavToNavManager2
Creates the autopilot's nav-to-nav manager.
Parameters
| Name | Type | Description |
|---|---|---|
apValues | APValues | The autopilot's state values. |
Returns
undefined | NavToNavManager | NavToNavManager2
The autopilot's nav-to-nav manager.
Inherited from
APConfig.createNavToNavManager
Defined in
src/sdk/autopilot/APConfig.ts:189
createPitchDirector
▸ createPitchDirector(apValues): undefined | PlaneDirector
Creates the autopilot's pitch mode director.
Parameters
| Name | Type | Description |
|---|---|---|
apValues | APValues | The autopilot's state values. |
Returns
undefined | PlaneDirector
The autopilot's pitch mode director.
Inherited from
APConfig.createPitchDirector
Defined in
src/sdk/autopilot/APConfig.ts:293
createPitchLevelerDirector
▸ createPitchLevelerDirector(apValues): undefined | PlaneDirector
Creates the autopilot's pitch level mode director.
Parameters
| Name | Type | Description |
|---|---|---|
apValues | APValues | The autopilot's state values. |
Returns
undefined | PlaneDirector
The autopilot's pitch level mode director.
Inherited from
APConfig.createPitchLevelerDirector
Defined in
src/sdk/autopilot/APConfig.ts:252
createRollDirector
▸ createRollDirector(apValues): undefined | PlaneDirector
Creates the autopilot's roll mode director.
Parameters
| Name | Type | Description |
|---|---|---|
apValues | APValues | The autopilot's state values. |
Returns
undefined | PlaneDirector
The autopilot's heading mode director.
Inherited from
APConfig.createRollDirector
Defined in
src/sdk/autopilot/APConfig.ts:238
createRolloutDirector
▸ createRolloutDirector(): undefined | PlaneDirector
Creates the autopilot's ROLLOUT mode director.
Returns
undefined | PlaneDirector
The autopilot's ROLLOUT mode director.
Inherited from
APConfig.createRolloutDirector
Defined in
src/sdk/autopilot/APConfig.ts:286
createTakeoffLocLateralDirector
▸ createTakeoffLocLateralDirector(apValues): undefined | PlaneDirector
Creates the autopilot's takeoff LOC mode director.
Parameters
| Name | Type | Description |
|---|---|---|
apValues | APValues | The autopilot's state values. |
Returns
undefined | PlaneDirector
The autopilot's takeoff LOC mode director.
Inherited from
APConfig.createTakeoffLocLateralDirector
Defined in
src/sdk/autopilot/APConfig.ts:387
createToLateralDirector
▸ createToLateralDirector(apValues): undefined | PlaneDirector
Creates the autopilot's lateral takeoff mode director (or combined lateral takeoff/go-around mode director).
Parameters
| Name | Type |
|---|---|
apValues | APValues |
Returns
undefined | PlaneDirector
The autopilot's lateral takeoff mode director.
Inherited from
APConfig.createToLateralDirector
Defined in
src/sdk/autopilot/APConfig.ts:367
createToVerticalDirector
▸ createToVerticalDirector(apValues): undefined | PlaneDirector
Creates the autopilot's vertical takeoff mode director (or combined vertical takeoff/go-around mode director).
Parameters
| Name | Type |
|---|---|
apValues | APValues |
Returns
undefined | PlaneDirector
The autopilot's vertical takeoff mode director.
Inherited from
APConfig.createToVerticalDirector
Defined in
src/sdk/autopilot/APConfig.ts:355
createTrackDirector
▸ createTrackDirector(apValues): undefined | PlaneDirector
Creates the autopilot's track mode director.
Parameters
| Name | Type | Description |
|---|---|---|
apValues | APValues | The autopilot's state values. |
Returns
undefined | PlaneDirector
The autopilot's heading mode director.
Inherited from
APConfig.createTrackDirector
Defined in
src/sdk/autopilot/APConfig.ts:224
createTrackHoldDirector
▸ createTrackHoldDirector(apValues): undefined | PlaneDirector
Creates the autopilot's track hold (level off and then capture track)
Parameters
| Name | Type | Description |
|---|---|---|
apValues | APValues | The autopilot's state values. |
Returns
undefined | PlaneDirector
The autopilot's heading hold director.
Inherited from
APConfig.createTrackHoldDirector
Defined in
src/sdk/autopilot/APConfig.ts:231
createVNavManager
▸ createVNavManager(apValues): undefined | VNavManager
Creates the autopilot's VNAV Manager.
Parameters
| Name | Type | Description |
|---|---|---|
apValues | APValues | The autopilot's state values. |
Returns
undefined | VNavManager
The autopilot's VNAV Manager.
Inherited from
APConfig.createVNavManager
Defined in
src/sdk/autopilot/APConfig.ts:182
createVNavPathDirector
▸ createVNavPathDirector(apValues): undefined | PlaneDirector
Creates the autopilot's VNAV Path mode director.
Parameters
| Name | Type | Description |
|---|---|---|
apValues | APValues | The autopilot's state values. |
Returns
undefined | PlaneDirector
The autopilot's VNAV Path mode director.
Inherited from
APConfig.createVNavPathDirector
Defined in
src/sdk/autopilot/APConfig.ts:203
createVariableBankManager
▸ createVariableBankManager(apValues): undefined | Record<any, any>
Creates the autopilot's variable bank manager.
Parameters
| Name | Type | Description |
|---|---|---|
apValues | APValues | The autopilot's state values. |
Returns
undefined | Record<any, any>
The autopilot's variable bank manager.
Inherited from
APConfig.createVariableBankManager
Defined in
src/sdk/autopilot/APConfig.ts:196
createVorDirector
▸ createVorDirector(apValues): undefined | PlaneDirector
Creates the autopilot's VOR mode director.
Parameters
| Name | Type | Description |
|---|---|---|
apValues | APValues | The autopilot's state values. |
Returns
undefined | PlaneDirector
The autopilot's VOR mode director.
Inherited from
APConfig.createVorDirector
Defined in
src/sdk/autopilot/APConfig.ts:266
createVsDirector
▸ createVsDirector(apValues): undefined | PlaneDirector
Creates the autopilot's vertical speed mode director.
Parameters
| Name | Type | Description |
|---|---|---|
apValues | APValues | The autopilot's state values. |
Returns
undefined | PlaneDirector
The autopilot's vertical speed mode director.
Inherited from
APConfig.createVsDirector
Defined in
src/sdk/autopilot/APConfig.ts:300
createWingLevelerDirector
▸ createWingLevelerDirector(apValues): undefined | PlaneDirector
Creates the autopilot's wings level mode director.
Parameters
| Name | Type | Description |
|---|---|---|
apValues | APValues | The autopilot's state values. |
Returns
undefined | PlaneDirector
The autopilot's wings level mode director.
Inherited from
APConfig.createWingLevelerDirector
Defined in
src/sdk/autopilot/APConfig.ts:245