Interface: ObsDirector

A director that handles OBS Lateral Navigation.

Deprecated

Hierarchy

• PlaneDirector

  ↳ ObsDirector

Properties

driveBank

• Optional driveBank: (bank: number, rate?: number) => void

A function used to drive the autopilot commanded bank angle toward a desired value.

Param

The desired bank angle, in degrees. Positive values indicate left bank.

Param

The rate at which to drive the commanded bank angle, in degrees per second. If not defined, a default rate will be used.

Type declaration

▸ (bank, rate?): void

A function used to drive the autopilot commanded bank angle toward a desired value.

Parameters

Name	Type	Description
bank	number	The desired bank angle, in degrees. Positive values indicate left bank.
rate?	number	The rate at which to drive the commanded bank angle, in degrees per second. If not defined, a default rate will be used.

Returns

void

Inherited from

PlaneDirector.driveBank

Defined in

src/sdk/autopilot/directors/PlaneDirector.ts:72

---

drivePitch

• Optional drivePitch: (pitch: number, adjustForAoa?: boolean, adjustForVerticalWind?: boolean, rate?: number) => void

A function used to drive the autopilot commanded pitch angle toward a desired value while optionally correcting for angle of attack and vertical wind.

Param

The desired pitch angle, in degrees. Positive values indicate downward pitch.

Param

Whether to adjust the commanded pitch angle for angle of attack. If true, the provided pitch angle is treated as a desired flight path angle and a new commanded pitch angle will be calculated to produce the desired FPA given the airplane's current angle of attack. This correction can be used in conjunction with the vertical wind correction. Defaults to false.

Param

Whether to adjust the commanded pitch angle for vertical wind velocity. If true, the provided pitch angle is treated as a desired flight path angle and a new commanded pitch angle will be calculated to produce the desired FPA given the current vertical wind component. This correction can be used in conjunction with the angle of attack correction. Defaults to false.

Param

The rate at which to drive the commanded pitch angle, in degrees per second. If not defined, a default rate will be used.

Type declaration

▸ (pitch, adjustForAoa?, adjustForVerticalWind?, rate?): void

A function used to drive the autopilot commanded pitch angle toward a desired value while optionally correcting for angle of attack and vertical wind.

Parameters

Name	Type	Description
pitch	number	The desired pitch angle, in degrees. Positive values indicate downward pitch.
adjustForAoa?	boolean	Whether to adjust the commanded pitch angle for angle of attack. If true, the provided pitch angle is treated as a desired flight path angle and a new commanded pitch angle will be calculated to produce the desired FPA given the airplane's current angle of attack. This correction can be used in conjunction with the vertical wind correction. Defaults to false.
adjustForVerticalWind?	boolean	Whether to adjust the commanded pitch angle for vertical wind velocity. If true, the provided pitch angle is treated as a desired flight path angle and a new commanded pitch angle will be calculated to produce the desired FPA given the current vertical wind component. This correction can be used in conjunction with the angle of attack correction. Defaults to false.
rate?	number	The rate at which to drive the commanded pitch angle, in degrees per second. If not defined, a default rate will be used.

Returns

void

Inherited from

PlaneDirector.drivePitch

Defined in

src/sdk/autopilot/directors/PlaneDirector.ts:95

---

obsActive

• Readonly obsActive: boolean

Whether or not OBS mode is active.

Defined in

src/sdk/autopilot/directors/PlaneDirector.ts:107

---

onActivate

• Optional onActivate: () => void

A callback called when a mode signals it should be activated.

Type declaration

▸ (): void

A callback called when a mode signals it should be activated.

Returns

void

Inherited from

PlaneDirector.onActivate

Defined in

src/sdk/autopilot/directors/PlaneDirector.ts:46

---

onArm

• Optional onArm: () => void

A callback called when a mode signals it should be armed.

Type declaration

▸ (): void

A callback called when a mode signals it should be armed.

Returns

void

Inherited from

PlaneDirector.onArm

Defined in

src/sdk/autopilot/directors/PlaneDirector.ts:52

---

onDeactivate

• Optional onDeactivate: () => void

A callback called when a mode signals it should be deactivated.

Type declaration

▸ (): void

A callback called when a mode signals it should be deactivated.

Returns

void

Inherited from

PlaneDirector.onDeactivate

Defined in

src/sdk/autopilot/directors/PlaneDirector.ts:58

---

setBank

• Optional setBank: (bank: number) => void

A callback called to set an exact AP bank target.

Param

The bank in degrees (positive = right, negative = left).

Type declaration

▸ (bank): void

A callback called to set an exact AP bank target.

Parameters

Name	Type	Description
bank	number	The bank in degrees (positive = right, negative = left).

Returns

void

Inherited from

PlaneDirector.setBank

Defined in

src/sdk/autopilot/directors/PlaneDirector.ts:64

---

setPitch

• Optional setPitch: (pitch: number) => void

A callback called to set an exact AP pitch target.

Param

The pitch in degrees (positive = down, negative = up).

Type declaration

▸ (pitch): void

A callback called to set an exact AP pitch target.

Parameters

Name	Type	Description
pitch	number	The pitch in degrees (positive = down, negative = up).

Returns

void

Inherited from

PlaneDirector.setPitch

Defined in

src/sdk/autopilot/directors/PlaneDirector.ts:78

---

state

• state: DirectorState

The current director state.

Inherited from

PlaneDirector.state

Defined in

src/sdk/autopilot/directors/PlaneDirector.ts:98

Methods

activate

▸ activate(): void

Activates the guidance mode.

Returns

void

Inherited from

PlaneDirector.activate

Defined in

src/sdk/autopilot/directors/PlaneDirector.ts:25

---

arm

▸ arm(): void

Arms the guidance mode.

Returns

void

Inherited from

PlaneDirector.arm

Defined in

src/sdk/autopilot/directors/PlaneDirector.ts:30

---

canActivate

▸ canActivate(): boolean

Whether or not OBS mode can be activated currently.

Returns

boolean

Defined in

src/sdk/autopilot/directors/PlaneDirector.ts:117

---

deactivate

▸ deactivate(): void

Deactivates the guidance mode.

Returns

void

Inherited from

PlaneDirector.deactivate

Defined in

src/sdk/autopilot/directors/PlaneDirector.ts:35

---

setLeg

▸ setLeg(index, leg): void

Sets the flight plan leg whose terminator defines this director's OBS fix.

Parameters

Name	Type	Description
index	number	The global leg index of the leg.
leg	null | LegDefinition	The leg to track.

Returns

void

Defined in

src/sdk/autopilot/directors/PlaneDirector.ts:114

---

startTracking

▸ startTracking(): void

Starts tracking the OBS course.

Returns

void

Defined in

src/sdk/autopilot/directors/PlaneDirector.ts:120

---

stopTracking

▸ stopTracking(): void

Stops tracking the OBS course.

Returns

void

Defined in

src/sdk/autopilot/directors/PlaneDirector.ts:123

---

update

▸ update(): void

Updates the guidance mode control loops.

Returns

void

Inherited from

PlaneDirector.update

Defined in

src/sdk/autopilot/directors/PlaneDirector.ts:40