Class: DefaultWindDataProvider

Defined in: src/garminsdk/wind/WindDataProvider.ts:47

A default implementation of WindDataProvider.

Implements

• WindDataProvider

Constructors

Constructor

new DefaultWindDataProvider(bus, adcIndex, ahrsIndex, fmsPosIndex, smoothingTau, accumulateTime): DefaultWindDataProvider

Defined in: src/garminsdk/wind/WindDataProvider.ts:140

Constructor.

Parameters

Parameter	Type	Default value	Description
bus	EventBus	undefined	The event bus.
adcIndex	number | Subscribable<number>	undefined	The index of the ADC that is the source of this provider's data.
ahrsIndex	number | Subscribable<number>	undefined	The index of the AHRS that is the source of this provider's data.
fmsPosIndex	number | Subscribable<number>	undefined	The index of the FMS geo-positioning system that is the source of this provider's data.
smoothingTau	number	DefaultWindDataProvider.DEFAULT_SMOOTHING_TAU	The smoothing time constant, in milliseconds, used to apply smoothing to wind speed and direction. Defaults to DefaultWindDataProvider.DEFAULT_SMOOTHING_TAU.
accumulateTime	number	DefaultWindDataProvider.DEFAULT_ACCUMULATE_TIME	The time required for this provider to accumulate enough source data to generate valid wind data.

Returns

DefaultWindDataProvider

Properties

crosswind

readonly crosswind: Subscribable<number>

Defined in: src/garminsdk/wind/WindDataProvider.ts:72

The current crosswind component, in knots. Positive values indicate wind from the right, negative values indicate wind from the left.

Implementation of

WindDataProvider.crosswind

---

headwind

readonly headwind: Subscribable<number>

Defined in: src/garminsdk/wind/WindDataProvider.ts:68

The current headwind component, in knots. Positive values indicate headwind, negative values indicate tailwind.

Implementation of

WindDataProvider.headwind

---

isDataFailed

readonly isDataFailed: Subscribable<boolean>

Defined in: src/garminsdk/wind/WindDataProvider.ts:84

Whether this provider's wind data is in a failed state.

Implementation of

WindDataProvider.isDataFailed

---

isGpsDeadReckoning

readonly isGpsDeadReckoning: Subscribable<boolean>

Defined in: src/garminsdk/wind/WindDataProvider.ts:80

Whether GPS position is in dead reckoning mode.

Implementation of

WindDataProvider.isGpsDeadReckoning

---

magVar

readonly magVar: Subscribable<number>

Defined in: src/garminsdk/wind/WindDataProvider.ts:76

The magnetic variation, in degrees, at the airplane's location.

Implementation of

WindDataProvider.magVar

---

windDirection

readonly windDirection: Subscribable<number>

Defined in: src/garminsdk/wind/WindDataProvider.ts:56

The current wind direction, in degrees true.

Implementation of

WindDataProvider.windDirection

---

windDirectionRelative

readonly windDirectionRelative: Subscribable<number>

Defined in: src/garminsdk/wind/WindDataProvider.ts:60

The current wind direction relative to airplane heading, in degrees. A value of zero degrees indicates a direct headwind, with positive angles proceeding clockwise.

Implementation of

WindDataProvider.windDirectionRelative

---

windSpeed

readonly windSpeed: Subscribable<number>

Defined in: src/garminsdk/wind/WindDataProvider.ts:64

The current wind speed, in knots.

Implementation of

WindDataProvider.windSpeed

Methods

destroy()

destroy(): void

Defined in: src/garminsdk/wind/WindDataProvider.ts:306

Destroys this data provider. Once destroyed, this data provider will no longer update its provided data, and can no longer be paused or resumed.

Returns

void

---

init()

init(paused): void

Defined in: src/garminsdk/wind/WindDataProvider.ts:160

Initializes this data provider. Once initialized, this data provider will continuously update its data until paused or destroyed.

Parameters

Parameter	Type	Default value	Description
paused	boolean	false	Whether to initialize this data provider as paused. If true, this data provider will provide an initial set of data but will not update the provided data until it is resumed. Defaults to false.

Returns

void

Throws

Error if this data provider is dead.

---

pause()

pause(): void

Defined in: src/garminsdk/wind/WindDataProvider.ts:227

Pauses this data provider. Once paused, this data provider will not update its data until it is resumed.

Returns

void

Throws

Error if this data provider is dead.

---

resume()

resume(): void

Defined in: src/garminsdk/wind/WindDataProvider.ts:205

Resumes this data provider. Once resumed, this data provider will continuously update its data until paused or destroyed.

Returns

void

Throws

Error if this data provider is dead.