Skip to main content

Type Alias: AutothrottleOptions

AutothrottleOptions = object

Defined in: src/sdk/autothrottle/AbstractAutothrottle.ts:138

Options used to initialize an autothrottle.

Properties

accelSmoothingConstant?

optional accelSmoothingConstant: number

Defined in: src/sdk/autothrottle/AbstractAutothrottle.ts:208

The smoothing time constant, in seconds, to use to smooth observed acceleration used by the speed controller to generate error terms when targeting acceleration. A value of zero is equivalent to no smoothing.


accelSmoothingVelocityConstant?

optional accelSmoothingVelocityConstant: number

Defined in: src/sdk/autothrottle/AbstractAutothrottle.ts:215

The smoothing time constant, in seconds, to use to smooth estimated acceleration velocity while smoothing observed acceleration. A value of zero is equivalent to no smoothing. If not defined, estimated acceleration velocity will not be used to adjust smoothed observed acceleration.


accelTargetSmoothingConstant?

optional accelTargetSmoothingConstant: number

Defined in: src/sdk/autothrottle/AbstractAutothrottle.ts:221

The smoothing time constant, in seconds, to use to smooth acceleration targets commanded by the speed controller. A value of zero is equivalent to no smoothing. Defaults to 0.


hysteresis

hysteresis: number

Defined in: src/sdk/autothrottle/AbstractAutothrottle.ts:317

The amount of hysteresis to apply to throttle position adjustment speeds commanded by the autothrottle's power controller, in units of normalized position per second. The autothrottle will ignore position adjustment speed commands of magnitude less than or equal to this value if it would reverse the direction of the most recent command that was carried out.


latchOptions?

optional latchOptions: Readonly<AutothrottleLatchOptions>

Defined in: src/sdk/autothrottle/AbstractAutothrottle.ts:309

Options for the latch function. A throttle can be latched if the commanded position adjustment speed for the throttle remains less than a specified threshold for a period of time. The autothrottle will not move a latched throttle. Once latched, the throttle is unlatched when the commanded position adjustment speed exceeds another threshold. Latching is disabled when throttle lever position targeting is active (unless the targeted throttle position is overridden by speed or power protection).


overpowerPid?

optional overpowerPid: AutothrottlePidParams

Defined in: src/sdk/autothrottle/AbstractAutothrottle.ts:335

Parameters for the overpower protection PID controller. Defaults to the same parameters as the target power PID controller.


overspeedAccelTarget?

optional overspeedAccelTarget: AutothrottleAccelTargetFunc

Defined in: src/sdk/autothrottle/AbstractAutothrottle.ts:196

A function which generates an acceleration target, in knots per second, from a given overspeed protection airspeed error. Defaults to the function specified for selectedSpeedAccelTarget.


overspeedChangeThreshold?

optional overspeedChangeThreshold: number

Defined in: src/sdk/autothrottle/AbstractAutothrottle.ts:351

The threshold, in knots per second, such that if the rate of change of the overspeed protection limit exceeds the threshold, the overspeed protection PID controller will ignore any contribution to the derivative term from the changing limit. This threshold is meant to prevent instantaneous changes in the overspeed protection limit from unduly influencing the PID output. Defaults to infinity.


overspeedPid?

optional overspeedPid: AutothrottlePidParams

Defined in: src/sdk/autothrottle/AbstractAutothrottle.ts:323

Parameters for the overspeed protection PID controller. Defaults to the same parameters as the target speed PID controller.


overspeedPowerCorrectionTransformer?

optional overspeedPowerCorrectionTransformer: AutothrottlePowerCorrectionTransformer

Defined in: src/sdk/autothrottle/AbstractAutothrottle.ts:233

A function which transforms a power target correction calculated by the overspeed protection speed controller. Defaults to the function specified for selectedSpeedPowerCorrectionTransformer.


powerLookahead

powerLookahead: number | Subscribable<number>

Defined in: src/sdk/autothrottle/AbstractAutothrottle.ts:259

The lookahead time, in seconds, to use for engine power data. If less than or equal to zero, the autothrottle will use the current (smoothed) engine power. If greater than zero, the autothrottle will use the (smoothed) engine power trend projected into the future by amount of time equal to the lookahead.


powerLookaheadSmoothingConstant?

optional powerLookaheadSmoothingConstant: number

Defined in: src/sdk/autothrottle/AbstractAutothrottle.ts:265

The smoothing time constant, in seconds, to use to smooth lookahead engine power data. A value of zero is equivalent to no smoothing. If not defined, defaults to the value of powerSmoothingConstant.


powerLookaheadSmoothingVelocityConstant?

optional powerLookaheadSmoothingVelocityConstant: number

Defined in: src/sdk/autothrottle/AbstractAutothrottle.ts:273

The smoothing time constant, in seconds, to use to smooth estimated power velocity while smoothing lookahead engine power data. A value of zero is equivalent to no smoothing. If not defined, estimated power velocity will not be used to adjust smoothed lookahead engine power data. If not defined, defaults to the value of powerSmoothingVelocityConstant.


powerSmoothingConstant

powerSmoothingConstant: number

Defined in: src/sdk/autothrottle/AbstractAutothrottle.ts:245

The smoothing time constant, in seconds, to use to smooth engine power data. A value of zero is equivalent to no smoothing.


powerSmoothingVelocityConstant?

optional powerSmoothingVelocityConstant: number

Defined in: src/sdk/autothrottle/AbstractAutothrottle.ts:252

The smoothing time constant, in seconds, to use to smooth estimated power velocity while smoothing engine power data. A value of zero is equivalent to no smoothing. If not defined, estimated power velocity will not be used to adjust smoothed engine power data.


powerTargetPid

powerTargetPid: AutothrottlePidParams

Defined in: src/sdk/autothrottle/AbstractAutothrottle.ts:286

Parameters for the target power PID controller. The input of the PID is engine power error. The output of the PID is a throttle position adjustment speed, in units of normalized position per second.


powerTargetSmoothingConstant

powerTargetSmoothingConstant: number

Defined in: src/sdk/autothrottle/AbstractAutothrottle.ts:292

The smoothing time constant, in seconds, to use to smooth power targets commanded by the speed controller. A value of zero is equivalent to no smoothing.


selectedSpeedAccelTarget?

optional selectedSpeedAccelTarget: AutothrottleAccelTargetFunc

Defined in: src/sdk/autothrottle/AbstractAutothrottle.ts:190

A function which generates an acceleration target, in knots per second, from a given selected airspeed error. If not defined, then the speed controller will directly target selected airspeed instead of acceleration.


selectedSpeedPowerCorrectionTransformer?

optional selectedSpeedPowerCorrectionTransformer: AutothrottlePowerCorrectionTransformer

Defined in: src/sdk/autothrottle/AbstractAutothrottle.ts:227

A function which transforms a power target correction calculated by the selected speed controller. If not defined, then the identity transformation is used.


servoSpeed

servoSpeed: number | Accessible<number>

Defined in: src/sdk/autothrottle/AbstractAutothrottle.ts:150

The rate at which the autothrottle's servos moves throttle levers, in units of normalized position per second. One normalized throttle position is equal to the distance traversed by the throttle from the idle position to the max thrust position.


speedLookahead

speedLookahead: number | Subscribable<number>

Defined in: src/sdk/autothrottle/AbstractAutothrottle.ts:170

The lookahead time, in seconds, to use for airspeed data. If less than or equal to zero, the autothrottle will use the current (smoothed) airspeed. If greater than zero, the autothrottle will use the (smoothed) airspeed trend projected into the future by amount of time equal to the lookahead.


speedLookaheadSmoothingConstant?

optional speedLookaheadSmoothingConstant: number

Defined in: src/sdk/autothrottle/AbstractAutothrottle.ts:176

The smoothing time constant, in seconds, to use to smooth lookahead airspeed data. A value of zero is equivalent to no smoothing. If not defined, defaults to the value of speedSmoothingConstant.


speedLookaheadSmoothingVelocityConstant?

optional speedLookaheadSmoothingVelocityConstant: number

Defined in: src/sdk/autothrottle/AbstractAutothrottle.ts:184

The smoothing time constant, in seconds, to use to smooth estimated lookahead airspeed velocity (i.e. acceleration) while smoothing lookahead airspeed data. A value of zero is equivalent to no smoothing. If not defined, estimated lookahead airspeed velocity will not be used to adjust smoothed lookahead airspeed data. Defaults to the value of speedSmoothingVelocityConstant.


speedSmoothingConstant

speedSmoothingConstant: number

Defined in: src/sdk/autothrottle/AbstractAutothrottle.ts:156

The smoothing time constant, in seconds, to use to smooth airspeed data. A value of zero is equivalent to no smoothing.


speedSmoothingVelocityConstant?

optional speedSmoothingVelocityConstant: number

Defined in: src/sdk/autothrottle/AbstractAutothrottle.ts:163

The smoothing time constant, in seconds, to use to smooth estimated airspeed velocity (i.e. acceleration) while smoothing airspeed data. A value of zero is equivalent to no smoothing. If not defined, estimated airspeed velocity will not be used to adjust smoothed airspeed data.


speedTargetChangeThreshold?

optional speedTargetChangeThreshold: number

Defined in: src/sdk/autothrottle/AbstractAutothrottle.ts:343

The threshold, in knots per second, such that if the rate of change of the speed target exceeds the threshold, the speed target PID controller will ignore any contribution to the derivative term from the changing speed target. This threshold is meant to prevent instantaneous changes in the speed target from unduly influencing the PID output. Defaults to infinity.


speedTargetPid

speedTargetPid: AutothrottlePidParams

Defined in: src/sdk/autothrottle/AbstractAutothrottle.ts:280

Parameters for the target speed PID controller. The input of the PID is either indicated airspeed error (in knots) if the speed controller is directly targeting airspeed or acceleration error (in knots per second) if the speed controller is targeting acceleration. The output of the PID is an engine power adjustment.


throttleSpeedSmoothingConstant?

optional throttleSpeedSmoothingConstant: number

Defined in: src/sdk/autothrottle/AbstractAutothrottle.ts:300

The smoothing time constant, in seconds, to use to smooth throttle position adjustment speeds commanded by the power controllers. A value of zero is equivalent to no smoothing. Smoothing is not applied when throttle lever position targeting is active (unless the targeted throttle position is overridden by speed or power protection). Defaults to 0.


underspeedAccelTarget?

optional underspeedAccelTarget: AutothrottleAccelTargetFunc

Defined in: src/sdk/autothrottle/AbstractAutothrottle.ts:202

A function which generates an acceleration target, in knots per second, from a given underspeed protection airspeed error. Defaults to the function specified for selectedSpeedAccelTarget.


underspeedChangeThreshold?

optional underspeedChangeThreshold: number

Defined in: src/sdk/autothrottle/AbstractAutothrottle.ts:359

The threshold, in knots per second, such that if the rate of change of the underspeed protection limit exceeds the threshold, the underspeed protection PID controller will ignore any contribution to the derivative term from the changing limit. This threshold is meant to prevent instantaneous changes in the underspeed protection limit from unduly influencing the PID output. Defaults to infinity.


underspeedPid?

optional underspeedPid: AutothrottlePidParams

Defined in: src/sdk/autothrottle/AbstractAutothrottle.ts:329

Parameters for the underspeed protection PID controller. Defaults to the same parameters as the target speed PID controller.


underspeedPowerCorrectionTransformer?

optional underspeedPowerCorrectionTransformer: AutothrottlePowerCorrectionTransformer

Defined in: src/sdk/autothrottle/AbstractAutothrottle.ts:239

A function which transforms a power target correction calculated by the underspeed protection speed controller. Defaults to the function specified for selectedSpeedPowerCorrectionTransformer.


useIndicatedMach?

optional useIndicatedMach: boolean

Defined in: src/sdk/autothrottle/AbstractAutothrottle.ts:143

Whether the autothrottle should use mach number calculated from the impact pressure derived from indicated airspeed and ambient pressure instead of the true mach number. Defaults to false.