Skip to main content

Type Alias: AutopilotDriverOptions

AutopilotDriverOptions = object

Defined in: src/sdk/autopilot/AutopilotDriver.ts:51

Configuration options for AutopilotDriver.

Properties

autoCoordinationEnabled?

optional autoCoordinationEnabled: boolean

Defined in: src/sdk/autopilot/AutopilotDriver.ts:88

Whether to provide turn auto-coordination while the autopilot is engaged. Only applicable if createOutput is not defined. Auto-coordination works by commanding a rudder deflection in the same direction as the commanded bank angle (e.g. a commanded left bank will result in a commanded left rudder). The commanded rudder deflection is proportional to the commanded bank angle.


bankServoRate?

optional bankServoRate: number

Defined in: src/sdk/autopilot/AutopilotDriver.ts:56

The default rate used to drive changes in commanded bank, in degrees per second. Defaults to 10.


createOutput()?

optional createOutput: (apValues) => AutopilotDriverOutput

Defined in: src/sdk/autopilot/AutopilotDriver.ts:63

A function that creates an output to which the autopilot driver will send pitch and bank reference commands.

Parameters

ParameterTypeDescription
apValuesAPValuesAutopilot values from the driver's parent autopilot.

Returns

AutopilotDriverOutput

An output to which the autopilot driver will send pitch and bank reference commands.


maxRudderDeflection?

optional maxRudderDeflection: number

Defined in: src/sdk/autopilot/AutopilotDriver.ts:94

The airplane's maximum rudder deflection, in degrees. Only applicable if createOutput is not defined. Ignored if autoCoordinationEnabled is false. Defaults to 25.


pitchServoRate?

optional pitchServoRate: number

Defined in: src/sdk/autopilot/AutopilotDriver.ts:53

The default rate used to drive changes in commanded pitch, in degrees per second. Defaults to 5.


rudderBankFactor?

optional rudderBankFactor: number

Defined in: src/sdk/autopilot/AutopilotDriver.ts:101

The factor to multiply with the commanded bank angle to calculate the rudder deflection commanded by rudder auto-coordination. Only applicable if createOutput is not defined. Ignored if autoCoordinationEnabled is false. Defaults to 0.3.


rudderServoRate?

optional rudderServoRate: number

Defined in: src/sdk/autopilot/AutopilotDriver.ts:107

The rate used to drive the rudder auto-coordination servo, in degrees per second. Only applicable if createOutput is not defined. Ignored if autoCoordinationEnabled is false. Defaults to 1.


setInternalFlightDirector?

optional setInternalFlightDirector: boolean

Defined in: src/sdk/autopilot/AutopilotDriver.ts:73

Whether to publish the pitch and bank reference values set by the driver to the event bus using the fd_target_pitch and fd_target_bank topics defined by FlightDirectorEvents. Ignored if createOutput is defined. Defaults to false.


zeroRollHeight?

optional zeroRollHeight: number

Defined in: src/sdk/autopilot/AutopilotDriver.ts:80

The radio altitude below which all commanded bank angles are forced to zero degrees. If not defined, then commanded bank angles will not be forced to zero degrees based on radio altitude. Only applicable if createOutput is not defined.