Interface: PlaneDirector
Defined in: src/sdk/autopilot/directors/PlaneDirector.ts:20
An autopilot plane director guidance mode.
Extended by
Properties
driveBank()?
optionaldriveBank: (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
| Parameter | 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
drivePitch()?
optionaldrivePitch: (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
| Parameter | 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. |
maxNoseDownPitch? | number | The maximum nose down pitch angle, defaults to the global AP pitch limit. |
maxNoseUpPitch? | number | The maximum nose up pitch angle, defaults to the global AP pitch limit. |
Returns
void
onActivate()?
optionalonActivate: () =>void
Defined in: src/sdk/autopilot/directors/PlaneDirector.ts:46
A callback called when a mode signals it should be activated.
Returns
void
onArm()?
optionalonArm: () =>void
Defined in: src/sdk/autopilot/directors/PlaneDirector.ts:52
A callback called when a mode signals it should be armed.
Returns
void
onDeactivate()?
optionalonDeactivate: () =>void
Defined in: src/sdk/autopilot/directors/PlaneDirector.ts:58
A callback called when a mode signals it should be deactivated.
Returns
void
setBank()?
optionalsetBank: (bank) =>void
Defined in: src/sdk/autopilot/directors/PlaneDirector.ts:64
A callback called to set an exact AP bank target.
Parameters
| Parameter | Type | Description |
|---|---|---|
bank | number | The bank in degrees (positive = right, negative = left). |
Returns
void
setPitch()?
optionalsetPitch: (pitch) =>void
Defined in: src/sdk/autopilot/directors/PlaneDirector.ts:78
A callback called to set an exact AP pitch target.
Parameters
| Parameter | Type | Description |
|---|---|---|
pitch | number | The 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