Class: GarminObsDirector

Defined in: src/garminsdk/autopilot/directors/GarminObsDirector.ts:34

A director that handles OBS Lateral Navigation.

Deprecated

Implements

• ObsDirector

Constructors

Constructor

new GarminObsDirector(bus, apValues, options?): GarminObsDirector

Defined in: src/garminsdk/autopilot/directors/GarminObsDirector.ts:127

Creates an instance of the GPS OBS Director.

Parameters

Parameter	Type	Description
bus	EventBus	The event bus to use with this instance.
apValues	APValues	Autopilot values from this director's parent autopilot.
options?	Readonly<GarminObsDirectorOptions>	Options to configure the new director.

Returns

GarminObsDirector

Properties

driveBank()?

optional driveBank: (bank, rate?) => void

Defined in: src/garminsdk/autopilot/directors/GarminObsDirector.ts:52

Parameters

Parameter	Type
bank	number
rate?	number

Returns

void

Inherit Doc

Implementation of

ObsDirector.driveBank

---

obsActive

obsActive: boolean = false

Defined in: src/garminsdk/autopilot/directors/GarminObsDirector.ts:55

Whether or not OBS mode is active.

Implementation of

ObsDirector.obsActive

---

onActivate()?

optional onActivate: () => void

Defined in: src/garminsdk/autopilot/directors/GarminObsDirector.ts:46

Returns

void

Inherit Doc

Implementation of

ObsDirector.onActivate

---

onArm()?

optional onArm: () => void

Defined in: src/garminsdk/autopilot/directors/GarminObsDirector.ts:43

Returns

void

Inherit Doc

Implementation of

ObsDirector.onArm

---

onDeactivate()?

optional onDeactivate: () => void

Defined in: src/garminsdk/autopilot/directors/GarminObsDirector.ts:49

Returns

void

Inherit Doc

Implementation of

ObsDirector.onDeactivate

---

state

state: DirectorState

Defined in: src/garminsdk/autopilot/directors/GarminObsDirector.ts:40

The current director state.

Implementation of

ObsDirector.state

Methods

activate()

activate(): void

Defined in: src/garminsdk/autopilot/directors/GarminObsDirector.ts:237

Returns

void

Inherit Doc

Implementation of

ObsDirector.activate

---

arm()

arm(): void

Defined in: src/garminsdk/autopilot/directors/GarminObsDirector.ts:245

Returns

void

Inherit Doc

Implementation of

ObsDirector.arm

---

canActivate()

canActivate(): boolean

Defined in: src/garminsdk/autopilot/directors/GarminObsDirector.ts:407

Tries to activate when armed.

Returns

boolean

whether OBS can activate

Implementation of

ObsDirector.canActivate

---

deactivate()

deactivate(): void

Defined in: src/garminsdk/autopilot/directors/GarminObsDirector.ts:253

Returns

void

Inherit Doc

Implementation of

ObsDirector.deactivate

---

setLeg()

setLeg(index, leg): void

Defined in: src/garminsdk/autopilot/directors/GarminObsDirector.ts:261

Parameters

Parameter	Type
index	number
leg	null | LegDefinition

Returns

void

Inherit Doc

Implementation of

ObsDirector.setLeg

---

startTracking()

startTracking(): void

Defined in: src/garminsdk/autopilot/directors/GarminObsDirector.ts:267

Returns

void

Inherit Doc

Implementation of

ObsDirector.startTracking

---

stopTracking()

stopTracking(): void

Defined in: src/garminsdk/autopilot/directors/GarminObsDirector.ts:277

Returns

void

Inherit Doc

Implementation of

ObsDirector.stopTracking

---

update()

update(): void

Defined in: src/garminsdk/autopilot/directors/GarminObsDirector.ts:307

Updates the lateral director.

Returns

void

Implementation of

ObsDirector.update