Interface: APConfig

Defined in: src/sdk/autopilot/APConfig.ts:22

An autopilot configuration.

Extended by

• GarminAPConfigInterface

Properties

altitudeHoldSlotIndex?

optional altitudeHoldSlotIndex: 2 | 1 | 3

Defined in: src/sdk/autopilot/APConfig.ts:91

The altitude hold slot index to use. Defaults to 1

---

autoEngageFd?

optional autoEngageFd: boolean

Defined in: src/sdk/autopilot/APConfig.ts:114

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.

---

autopilotDriverOptions?

readonly optional autopilotDriverOptions: Readonly<AutopilotDriverOptions>

Defined in: src/sdk/autopilot/APConfig.ts:124

Options for the Autopilot Driver

---

cdiId?

readonly optional cdiId: string

Defined in: src/sdk/autopilot/APConfig.ts:97

The ID of the CDI associated with the autopilot. Defaults to the empty string ''.

---

deactivateAutopilotOnGa?

readonly optional deactivateAutopilotOnGa: boolean

Defined in: src/sdk/autopilot/APConfig.ts:105

Whether to deactivate the autopilot when GA mode is armed in response to a TO/GA mode button press. Defaults to true.

---

defaultLateralMode

defaultLateralMode: number | () => number

Defined in: src/sdk/autopilot/APConfig.ts:65

The autopilot's default lateral mode.

---

defaultMaxBankAngle?

optional defaultMaxBankAngle: number

Defined in: src/sdk/autopilot/APConfig.ts:74

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.

---

defaultMaxNoseDownPitchAngle?

optional defaultMaxNoseDownPitchAngle: number

Defined in: src/sdk/autopilot/APConfig.ts:88

The default maximum nose down pitch angle the autopilot may command, in degrees. If not defined, then the angle can be controlled using the ap_set_max_nose_down_pitch event bus topic (defined in APControlEvents). If not defined and the ap_set_max_nose_down_pitch event bus topic is not used, then the angle defaults to Infinity.

---

defaultMaxNoseUpPitchAngle?

optional defaultMaxNoseUpPitchAngle: number

Defined in: src/sdk/autopilot/APConfig.ts:81

The default maximum nose up pitch angle the autopilot may command, in degrees. If not defined, then the angle can be controlled using the ap_set_max_nose_up_pitch event bus topic (defined in APControlEvents). If not defined and the ap_set_max_nose_up_pitch event bus topic is not used, then the angle defaults to Infinity.

---

defaultVerticalMode

defaultVerticalMode: number | () => number

Defined in: src/sdk/autopilot/APConfig.ts:68

The autopilot's default vertical mode.

---

flightDirectorCount?

readonly optional flightDirectorCount: 2 | 1

Defined in: src/sdk/autopilot/APConfig.ts:108

The number of flight directors supported by the autopilot. Defaults to 2.

---

headingHoldSlotIndex?

optional headingHoldSlotIndex: 2 | 1 | 3

Defined in: src/sdk/autopilot/APConfig.ts:94

The heading hold slot index to use. Defaults to 1

---

independentFds?

optional independentFds: boolean

Defined in: src/sdk/autopilot/APConfig.ts:119

Whether to have independent flight directors that can be switched on/off separately. Defaults to false.

---

onlyDisarmLnavOnOffEvent?

optional onlyDisarmLnavOnOffEvent: boolean

Defined in: src/sdk/autopilot/APConfig.ts:102

Whether to only allow disarming (not deactivating) LNAV when receiving the AP_NAV1_HOLD_OFF event

---

publishAutopilotModesAsLVars?

readonly optional publishAutopilotModesAsLVars: boolean

Defined in: src/sdk/autopilot/APConfig.ts:129

Whether to publish the active and armed autopilot modes as LVars. Defaults to false.

Methods

createLateralDirectors()?

optional createLateralDirectors(apValues): Iterable<Readonly<APConfigDirectorEntry>>

Defined in: src/sdk/autopilot/APConfig.ts:55

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.

---

createNavToNavManager()?

optional createNavToNavManager(apValues): NavToNavManager2 | undefined

Defined in: src/sdk/autopilot/APConfig.ts:41

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

Parameters

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

Returns

NavToNavManager2 | undefined

The autopilot's nav-to-nav manager.

---

createVariableBankManager()?

optional createVariableBankManager(apValues): Record<any, any> | undefined

Defined in: src/sdk/autopilot/APConfig.ts:48

Creates the autopilot's variable bank manager.

Parameters

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

Returns

Record<any, any> | undefined

The autopilot's variable bank manager.

---

createVerticalDirectors()?

optional createVerticalDirectors(apValues): Iterable<Readonly<APConfigDirectorEntry>>

Defined in: src/sdk/autopilot/APConfig.ts:62

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.

---

createVNavManager()?

optional createVNavManager(apValues): VNavManager | undefined

Defined in: src/sdk/autopilot/APConfig.ts:34

Creates the autopilot's VNAV Manager.

Parameters

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

Returns

VNavManager | undefined

The autopilot's VNAV Manager.

---

getDataProvider()?

optional getDataProvider(): ControllableAPDataProvider | undefined

Defined in: src/sdk/autopilot/APConfig.ts:27

Gets a provider of data for the autopilot.

Returns

ControllableAPDataProvider | undefined

A provider of data for the autopilot.