Skip to main content

Type Alias: GarminNegativeClimbRateModuleOptions

GarminNegativeClimbRateModuleOptions = object

Defined in: src/garminsdk/terrain/modules/ncr/GarminNegativeClimbRateModule.ts:10

Configuration options for GarminNegativeClimbRateModule.

Properties​

functionAsGpws?​

optional functionAsGpws: boolean

Defined in: src/garminsdk/terrain/modules/ncr/GarminNegativeClimbRateModule.ts:18

Whether alerting should function as a GPWS alert. If true, then radar altimeter data (up to 2500 feet AGL) will be used to measure height above terrain, and alerting will be inhibited when the GarminTawsStatus.GpwsFailed status is active. If false, then GPS altitude in conjunction with runway threshold elevation data will be used to measure height above terrain, and alerting will be inhibited when the GarminTawsStatus.TawsFailed or GarminTawsStatus.TawsNotAvailable statuses are active. Defaults to false.

inhibitFlags?​

optional inhibitFlags: Iterable<string>

Defined in: src/garminsdk/terrain/modules/ncr/GarminNegativeClimbRateModule.ts:45

The inhibit flags that should inhibit alerting. If not defined, then no flags will inhibit alerting.

triggerDebounce?​

optional triggerDebounce: number

Defined in: src/garminsdk/terrain/modules/ncr/GarminNegativeClimbRateModule.ts:24

The consecutive amount of time, in milliseconds, that the conditions for one of the module's alerts must be met before the alert is triggered. Defaults to 2000.

triggerHysteresis?​

optional triggerHysteresis: number

Defined in: src/garminsdk/terrain/modules/ncr/GarminNegativeClimbRateModule.ts:36

The amount of time, in milliseconds, after an alert becomes triggered before it can be untriggered. Defaults to 5000.

untriggerDebounce?​

optional untriggerDebounce: number

Defined in: src/garminsdk/terrain/modules/ncr/GarminNegativeClimbRateModule.ts:30

The consecutive amount of time, in milliseconds, that the conditions for one of the module's alerts must not be met before the alert is untriggered. Defaults to 2000.

untriggerHysteresis?​

optional untriggerHysteresis: number

Defined in: src/garminsdk/terrain/modules/ncr/GarminNegativeClimbRateModule.ts:42

The amount of time, in milliseconds, after an alert becomes untriggered before it can be triggered. Defaults to 0.