Skip to main content

Class: GarminHeadingSyncManager

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

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

Parameters​

NameTypeDescription
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

Defined in​

src/garminsdk/autopilot/GarminHeadingSyncManager.ts:112

Methods​

destroy​

▸ destroy(): void

Destroys this manager.

Returns​

void

Defined in​

src/garminsdk/autopilot/GarminHeadingSyncManager.ts:398

init​

▸ init(): Promise<void>

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.

Defined in​

src/garminsdk/autopilot/GarminHeadingSyncManager.ts:155

pause​

▸ pause(): void

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.

Defined in​

src/garminsdk/autopilot/GarminHeadingSyncManager.ts:234

reset​

▸ reset(): void

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

Returns​

void

Defined in​

src/garminsdk/autopilot/GarminHeadingSyncManager.ts:258

resume​

▸ resume(): void

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.

Defined in​

src/garminsdk/autopilot/GarminHeadingSyncManager.ts:208