Skip to main content

Type Alias: FmsOptions

FmsOptions = object

Defined in: src/garminsdk/flightplan/Fms.ts:40

Configuration options for Fms.

Properties​

cdiId?​

optional cdiId: string

Defined in: src/garminsdk/flightplan/Fms.ts:59

The ID of the CDI associated with the FMS. Defaults to the empty string ('').

disableApproachAvailablePublish?​

optional disableApproachAvailablePublish: boolean

Defined in: src/garminsdk/flightplan/Fms.ts:88

Whether to prevent the FMS from publishing the FMS flight phase approach active status to the approach_available event bus topic. Defaults to false.

isAdvancedVnav?​

optional isAdvancedVnav: boolean

Defined in: src/garminsdk/flightplan/Fms.ts:62

Whether advanced VNAV is supported. Defaults to false.

optional lnavIndex: number

Defined in: src/garminsdk/flightplan/Fms.ts:42

The index of the LNAV associated with the FMS's active flight plan. Defaults to 0.

optional navRadioIndexes: Iterable<NavRadioIndex>

Defined in: src/garminsdk/flightplan/Fms.ts:82

The indexes of the sim NAV radios for which the FMS automatically tunes approach frequencies. The FMS will respect changes made to the iterable after the FMS is created. Defaults to [1, 2].

procedureLegMapper()?​

optional procedureLegMapper: (leg) => undefined | FlightPlanLeg

Defined in: src/garminsdk/flightplan/Fms.ts:70

A function that maps flight plan legs in a procedure to flight plan legs to insert into a flight plan when loading the procedure. If the function returns undefined, then the corresponding procedure leg will be omitted from the flight plan entirely. If not defined, then all procedure flight plan legs are inserted into the flight plan without modification.

Parameters​

ParameterType
legFlightPlanLeg

Returns​

undefined | FlightPlanLeg

useSimObsState?​

optional useSimObsState: boolean

Defined in: src/garminsdk/flightplan/Fms.ts:50

Whether to use the sim's native OBS state. If true, then the sim's OBS state as exposed through the event bus topics defined in NavEvents will be used, and standard sim OBS key events will be used to control the state. If false, then the OBS state exposed through the event bus topics defined in LNavObsEvents will be used, and control events defined in LNavObsControlEvents will be used to control the state. Defaults to true.

visualApproachOptions?​

optional visualApproachOptions: Readonly<FmsVisualApproachOptions>

Defined in: src/garminsdk/flightplan/Fms.ts:76

Options for visual approach procedures. If not defined, then visual approach fix distances will default to 2.5 nautical miles for both runway to FINAL and FINAL to STRGHT.

vnavIndex?​

optional vnavIndex: number

Defined in: src/garminsdk/flightplan/Fms.ts:56

The index of the VNAV associated with the FMS's flight plans. Defaults to 0. If a vertical path calculator is not provided to the FMS, then this option will be ignored.