Skip to main content

Class: GarminHeadingSyncManager

Defined in: src/garminsdk/autopilot/GarminHeadingSyncManager.ts:45

A manager which handles heading sync events for the Garmin autopilot. The manager syncs the autopilot's selected heading to current heading in response to heading sync H events. In addition, the manager has option support for automatic adjustment of selected heading during turns while HDG mode is active and for heading sync mode while an autopilot NAV mode is active.

Constructors

Constructor

new GarminHeadingSyncManager(bus, ahrsIndex, options?): GarminHeadingSyncManager

Defined in: src/garminsdk/autopilot/GarminHeadingSyncManager.ts:112

Creates a new instance of GarminHeadingSyncManager. The new manager is created uninitialized and paused.

Parameters

ParameterTypeDescription
busEventBusThe event bus.
ahrsIndexnumber | Subscribable<number>The index of the AHRS used by the autopilot.
options?Readonly<GarminHeadingSyncManagerOptions>Options with which to configure the manager.

Returns

GarminHeadingSyncManager

Methods

destroy()

destroy(): void

Defined in: src/garminsdk/autopilot/GarminHeadingSyncManager.ts:398

Destroys this manager.

Returns

void


init()

init(): Promise<void>

Defined in: src/garminsdk/autopilot/GarminHeadingSyncManager.ts:155

Initializes this manager. Once this manager is initialized, it will automatically adjust the autopilot's selected heading in response to heading sync H events and whether turn heading adjustment or heading sync mode are active.

Returns

Promise<void>

Throws

Error if this manager has been destroyed.


pause()

pause(): void

Defined in: src/garminsdk/autopilot/GarminHeadingSyncManager.ts:234

Pauses this manager. Once paused, this manager will no longer automatically adjust the autopilot's selected heading.

Returns

void

Throws

Error if this manager has been destroyed.


reset()

reset(): void

Defined in: src/garminsdk/autopilot/GarminHeadingSyncManager.ts:258

Resets this manager. Deactivates both turn heading adjustment and heading sync mode if they were active.

Returns

void


resume()

resume(): void

Defined in: src/garminsdk/autopilot/GarminHeadingSyncManager.ts:208

Resumes this manager. Once resumed, this manager will automatically adjust the autopilot's selected heading in response to heading sync H events and whether turn heading adjustment or heading sync mode are active.

Returns

void

Throws

Error if this manager has been destroyed.