Skip to main content

Interface: PlaneDirector

Defined in: src/sdk/autopilot/directors/PlaneDirector.ts:20

An autopilot plane director guidance mode.

Extended by

Properties

driveBank()?

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

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

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

Parameters

ParameterTypeDescription
banknumberThe desired bank angle, in degrees. Positive values indicate left bank.
rate?numberThe rate at which to drive the commanded bank angle, in degrees per second. If not defined, a default rate will be used.

Returns

void


drivePitch()?

optional drivePitch: (pitch, adjustForAoa?, adjustForVerticalWind?, rate?, maxNoseDownPitch?, maxNoseUpPitch?) => void

Defined in: src/sdk/autopilot/directors/PlaneDirector.ts:97

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

ParameterTypeDescription
pitchnumberThe desired pitch angle, in degrees. Positive values indicate downward pitch.
adjustForAoa?booleanWhether 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?booleanWhether 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?numberThe rate at which to drive the commanded pitch angle, in degrees per second. If not defined, a default rate will be used.
maxNoseDownPitch?numberThe maximum nose down pitch angle, defaults to the global AP pitch limit.
maxNoseUpPitch?numberThe maximum nose up pitch angle, defaults to the global AP pitch limit.

Returns

void


onActivate()?

optional onActivate: () => void

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

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

Returns

void


onArm()?

optional onArm: () => void

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

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

Returns

void


onDeactivate()?

optional onDeactivate: () => void

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

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

Returns

void


setBank()?

optional setBank: (bank) => void

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

A callback called to set an exact AP bank target.

Parameters

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

Returns

void


setPitch()?

optional setPitch: (pitch) => void

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

A callback called to set an exact AP pitch target.

Parameters

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

Returns

void


state

state: DirectorState

Defined in: src/sdk/autopilot/directors/PlaneDirector.ts:100

The current director state.

Methods

activate()

activate(): void

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

Activates the guidance mode.

Returns

void


arm()

arm(): void

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

Arms the guidance mode.

Returns

void


deactivate()

deactivate(): void

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

Deactivates the guidance mode.

Returns

void


update()

update(): void

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

Updates the guidance mode control loops.

Returns

void