Class: GarminAPConfig
A Garmin Autopilot Configuration.
Implements
Constructors
constructor
• new GarminAPConfig(bus, flightPlanner, verticalPathCalculator?, options?): GarminAPConfig
Creates a new instance of GarminAPConfig.
Parameters
| Name | Type | Description |
|---|---|---|
bus | EventBus | The event bus. |
flightPlanner | FlightPlanner<any> | The 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? | VNavPathCalculator | The 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
Deprecated
Defined in
src/garminsdk/autopilot/GarminAPConfig.ts:222
• new GarminAPConfig(bus, fms, verticalPathCalculator?, options?): GarminAPConfig
Creates a new instance of GarminAPConfig.
Parameters
| Name | Type | Description |
|---|---|---|
bus | EventBus | The event bus. |
fms | Fms<any> | Subscribable<Fms<any>> | The FMS instance from which to source data. |
verticalPathCalculator? | VNavPathCalculator | The 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
Defined in
src/garminsdk/autopilot/GarminAPConfig.ts:237
Properties
autopilotDriverOptions
• autopilotDriverOptions: AutopilotDriverOptions
Options for the Autopilot Driver
Implementation of
GarminAPConfigInterface.autopilotDriverOptions
Defined in
src/garminsdk/autopilot/GarminAPConfig.ts:161
cdiId
• Readonly cdiId: string
The ID of the CDI associated with the autopilot. Defaults to the empty string ''.
Implementation of
Defined in
src/garminsdk/autopilot/GarminAPConfig.ts:159
defaultLateralMode
• defaultLateralMode: APLateralModes = APLateralModes.ROLL
The autopilot's default lateral mode.
Implementation of
GarminAPConfigInterface.defaultLateralMode
Defined in
src/garminsdk/autopilot/GarminAPConfig.ts:154
defaultMaxBankAngle
• defaultMaxBankAngle: number = GarminAPConfig.DEFAULT_MAX_BANK_ANGLE
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
Defined in
src/garminsdk/autopilot/GarminAPConfig.ts:156
defaultVerticalMode
• defaultVerticalMode: APVerticalModes = APVerticalModes.PITCH
The autopilot's default vertical mode.
Implementation of
GarminAPConfigInterface.defaultVerticalMode
Defined in
src/garminsdk/autopilot/GarminAPConfig.ts:155
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.
Implementation of
GarminAPConfigInterface.useIndicatedMach
Defined in
src/garminsdk/autopilot/GarminAPConfig.ts:167
DEFAULT_BANK_RATE
▪ Static Readonly DEFAULT_BANK_RATE: 10
The default commanded bank angle rate, in degrees per second.
Defined in
src/garminsdk/autopilot/GarminAPConfig.ts:140
DEFAULT_HDG_DIRECTION_UNLOCK_THRESHOLD
▪ Static Readonly DEFAULT_HDG_DIRECTION_UNLOCK_THRESHOLD: 331
The default HDG director turn direction unlock threshold, in degrees.
Defined in
src/garminsdk/autopilot/GarminAPConfig.ts:152
DEFAULT_LOW_BANK_ANGLE
▪ Static Readonly DEFAULT_LOW_BANK_ANGLE: 15
The default maximum bank angle, in degrees, in Low Bank Mode.
Defined in
src/garminsdk/autopilot/GarminAPConfig.ts:149
DEFAULT_MAX_BANK_ANGLE
▪ Static Readonly DEFAULT_MAX_BANK_ANGLE: 25
The default maximum bank angle, in degrees, for ROL, HDG, NAV, and LNAV directors.
Defined in
src/garminsdk/autopilot/GarminAPConfig.ts:146
DEFAULT_PITCH_RATE
▪ Static Readonly DEFAULT_PITCH_RATE: 5
The default commanded pitch angle rate, in degrees per second.
Defined in
src/garminsdk/autopilot/GarminAPConfig.ts:137
DEFAULT_ROLL_MIN_BANK_ANGLE
▪ Static Readonly DEFAULT_ROLL_MIN_BANK_ANGLE: 6
The default minimum bank angle, in degrees, for ROL director.
Defined in
src/garminsdk/autopilot/GarminAPConfig.ts:143
Methods
createAltCapDirector
▸ createAltCapDirector(apValues): APAltCapDirector
Creates the autopilot's altitude capture mode director.
Parameters
| Name | Type | Description |
|---|---|---|
apValues | APValues | The autopilot's state values. |
Returns
APAltCapDirector
The autopilot's altitude capture mode director.
Implementation of
GarminAPConfigInterface.createAltCapDirector
Defined in
src/garminsdk/autopilot/GarminAPConfig.ts:416
createAltHoldDirector
▸ createAltHoldDirector(apValues): APAltDirector
Creates the autopilot's altitude hold mode director.
Parameters
| Name | Type | Description |
|---|---|---|
apValues | APValues | The autopilot's state values. |
Returns
APAltDirector
The autopilot's altitude hold mode director.
Implementation of
GarminAPConfigInterface.createAltHoldDirector
Defined in
src/garminsdk/autopilot/GarminAPConfig.ts:411
createBcDirector
▸ createBcDirector(apValues): APBackCourseDirector
Creates the autopilot's back-course mode director.
Parameters
| Name | Type | Description |
|---|---|---|
apValues | APValues | The autopilot's state values. |
Returns
APBackCourseDirector
The autopilot's back-course mode director.
Implementation of
GarminAPConfigInterface.createBcDirector
Defined in
src/garminsdk/autopilot/GarminAPConfig.ts:388
createFlcDirector
▸ createFlcDirector(apValues): APFLCDirector
Creates the autopilot's flight level change mode director.
Parameters
| Name | Type | Description |
|---|---|---|
apValues | APValues | The autopilot's state values. |
Returns
APFLCDirector
The autopilot's flight level change mode director.
Implementation of
GarminAPConfigInterface.createFlcDirector
Defined in
src/garminsdk/autopilot/GarminAPConfig.ts:406
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.
Implementation of
GarminAPConfigInterface.createGaLateralDirector
Defined in
src/garminsdk/autopilot/GarminAPConfig.ts:474
createGaVerticalDirector
▸ createGaVerticalDirector(): undefined | PlaneDirector
Creates the autopilot's vertical go-around mode director.
Returns
undefined | PlaneDirector
The autopilot's vertical go-around mode director.
Implementation of
GarminAPConfigInterface.createGaVerticalDirector
Defined in
src/garminsdk/autopilot/GarminAPConfig.ts:464
createGpDirector
▸ createGpDirector(apValues): APGPDirector
Creates the autopilot's GPS glidepath mode director.
Parameters
| Name | Type | Description |
|---|---|---|
apValues | APValues | The autopilot's state values. |
Returns
APGPDirector
The autopilot's GPS glidepath mode director.
Implementation of
GarminAPConfigInterface.createGpDirector
Defined in
src/garminsdk/autopilot/GarminAPConfig.ts:440
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.
Implementation of
GarminAPConfigInterface.createGpssDirector
Defined in
src/garminsdk/autopilot/GarminAPConfig.ts:334
createGsDirector
▸ createGsDirector(apValues): APGSDirector
Creates the autopilot's ILS glideslope mode director.
Parameters
| Name | Type | Description |
|---|---|---|
apValues | APValues | The autopilot's state values. |
Returns
APGSDirector
The autopilot's ILS glideslope mode director.
Implementation of
GarminAPConfigInterface.createGsDirector
Defined in
src/garminsdk/autopilot/GarminAPConfig.ts:452
createHeadingDirector
▸ createHeadingDirector(apValues): APHdgDirector
Creates the autopilot's heading mode director.
Parameters
| Name | Type | Description |
|---|---|---|
apValues | APValues | The autopilot's state values. |
Returns
APHdgDirector
The autopilot's heading mode director.
Implementation of
GarminAPConfigInterface.createHeadingDirector
Defined in
src/garminsdk/autopilot/GarminAPConfig.ts:311
createLocDirector
▸ createLocDirector(apValues): APNavDirector
Creates the autopilot's LOC mode director.
Parameters
| Name | Type | Description |
|---|---|---|
apValues | APValues | The autopilot's state values. |
Returns
APNavDirector
The autopilot's LOC mode director.
Implementation of
GarminAPConfigInterface.createLocDirector
Defined in
src/garminsdk/autopilot/GarminAPConfig.ts:380
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.
Implementation of
GarminAPConfigInterface.createNavToNavManager
Defined in
src/garminsdk/autopilot/GarminAPConfig.ts:479
createPitchDirector
▸ createPitchDirector(apValues): APPitchDirector
Creates the autopilot's pitch mode director.
Parameters
| Name | Type | Description |
|---|---|---|
apValues | APValues | The autopilot's state values. |
Returns
APPitchDirector
The autopilot's pitch mode director.
Implementation of
GarminAPConfigInterface.createPitchDirector
Defined in
src/garminsdk/autopilot/GarminAPConfig.ts:396
createPitchLevelerDirector
▸ createPitchLevelerDirector(apValues): APPitchLvlDirector
Creates the autopilot's pitch level mode director.
Parameters
| Name | Type | Description |
|---|---|---|
apValues | APValues | The autopilot's state values. |
Returns
APPitchLvlDirector
The autopilot's pitch level mode director.
Implementation of
GarminAPConfigInterface.createPitchLevelerDirector
Defined in
src/garminsdk/autopilot/GarminAPConfig.ts:329
createRollDirector
▸ createRollDirector(apValues): APRollDirector
Creates the autopilot's roll mode director.
Parameters
| Name | Type | Description |
|---|---|---|
apValues | APValues | The autopilot's state values. |
Returns
APRollDirector
The autopilot's heading mode director.
Implementation of
GarminAPConfigInterface.createRollDirector
Defined in
src/garminsdk/autopilot/GarminAPConfig.ts:319
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.
Implementation of
GarminAPConfigInterface.createToLateralDirector
Defined in
src/garminsdk/autopilot/GarminAPConfig.ts:469
createToVerticalDirector
▸ createToVerticalDirector(): undefined | PlaneDirector
Creates the autopilot's vertical takeoff mode director (or combined vertical takeoff/go-around mode director).
Returns
undefined | PlaneDirector
The autopilot's vertical takeoff mode director.
Implementation of
GarminAPConfigInterface.createToVerticalDirector
Defined in
src/garminsdk/autopilot/GarminAPConfig.ts:457
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.
Implementation of
GarminAPConfigInterface.createVNavManager
Defined in
src/garminsdk/autopilot/GarminAPConfig.ts:421
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.
Implementation of
GarminAPConfigInterface.createVNavPathDirector
Defined in
src/garminsdk/autopilot/GarminAPConfig.ts:435
createVorDirector
▸ createVorDirector(apValues): APNavDirector
Creates the autopilot's VOR mode director.
Parameters
| Name | Type | Description |
|---|---|---|
apValues | APValues | The autopilot's state values. |
Returns
APNavDirector
The autopilot's VOR mode director.
Implementation of
GarminAPConfigInterface.createVorDirector
Defined in
src/garminsdk/autopilot/GarminAPConfig.ts:372
createVsDirector
▸ createVsDirector(apValues): APVSDirector
Creates the autopilot's vertical speed mode director.
Parameters
| Name | Type | Description |
|---|---|---|
apValues | APValues | The autopilot's state values. |
Returns
APVSDirector
The autopilot's vertical speed mode director.
Implementation of
GarminAPConfigInterface.createVsDirector
Defined in
src/garminsdk/autopilot/GarminAPConfig.ts:401
createWingLevelerDirector
▸ createWingLevelerDirector(apValues): APLvlDirector
Creates the autopilot's wings level mode director.
Parameters
| Name | Type | Description |
|---|---|---|
apValues | APValues | The autopilot's state values. |
Returns
APLvlDirector
The autopilot's wings level mode director.
Implementation of
GarminAPConfigInterface.createWingLevelerDirector
Defined in
src/garminsdk/autopilot/GarminAPConfig.ts:324