Class: GarminLowBankManager
Defined in: src/garminsdk/autopilot/GarminLowBankManager.ts:61
A manager which handles activation and deactivation of Low Bank Mode for Garmin autopilots. The manager ensures that Low Bank Mode is active only when supported by the autopilot's active lateral mode. Optionally, it will also automatically toggle Low Bank Mode in response to changes in indicated altitude.
Constructors
Constructor
new GarminLowBankManager(
bus,options?):GarminLowBankManager
Defined in: src/garminsdk/autopilot/GarminLowBankManager.ts:125
Creates a new instance of GarminLowBankManager. The new manager is created as uninitialized and with auto-toggle paused.
Parameters
| Parameter | Type | Description |
|---|---|---|
bus | EventBus | The event bus. |
options? | Readonly<GarminLowBankManagerOptions> | Options with which to configure the manager. |
Returns
GarminLowBankManager
Throws
Error if options.activateAltitude is less than options.deactivateAltitude.
Constructor
new GarminLowBankManager(
bus,activateAltitude?,deactivateAltitude?,supportedAdcIndexes?,autoToggleBankLimit?,supportedAhrsIndexes?):GarminLowBankManager
Defined in: src/garminsdk/autopilot/GarminLowBankManager.ts:149
Creates a new instance of GarminLowBankManager. The new manager is created as uninitialized and with auto-toggle paused.
Parameters
| Parameter | Type | Description |
|---|---|---|
bus | EventBus | The event bus. |
activateAltitude? | number | The indicated altitude threshold, in feet, for automatic activation of low-bank mode. If defined and auto-toggle is supported, this manager will automatically activate low-bank mode when the airplane climbs from below to above this altitude. |
deactivateAltitude? | number | The indicated altitude threshold, in feet, for automatic deactivation of low-bank mode. If defined and auto-toggle is supported, this manager will automatically deactivate low-bank mode when the airplane descends from above to below this altitude. |
supportedAdcIndexes? | Iterable<number> | An iterable of ADC system indexes from which the manager can source indicated altitude data. Required for auto-toggle behavior. The manager will source data from the first ADC system (in the order returned by the iterable) whose state is equal to AvionicsSystemState.On. |
autoToggleBankLimit? | number | The bank angle, in degrees, above which auto-toggle is inhibited. If this value is less than or equal to zero, then bank angle will not affect whether auto-toggle is inhibited. Defaults to 0. |
supportedAhrsIndexes? | Iterable<number> | An iterable of AHRS system indexes from which the manager can source bank angle data. Required for auto-toggle behavior to be limited by aircraft bank. The manager will source data from the first AHRS system (in the order returned by the iterable) whose state is equal to AvionicsSystemState.On. |
Returns
GarminLowBankManager
Throws
Error if activateAltitude is less than deactivateAltitude.
Methods
destroy()
destroy():
void
Defined in: src/garminsdk/autopilot/GarminLowBankManager.ts:491
Destroys this manager.
Returns
void
init()
init():
Promise<void>
Defined in: src/garminsdk/autopilot/GarminLowBankManager.ts:215
Initializes this manager. Once this manager is initialized, it will ensure that Low Bank Mode is active only when it is supported by the autopilot's active lateral mode. Additionally, it will automatically toggle Low Bank Mode in response to changes in indicated altitude if the function is supported and resumed.
Returns
Promise<void>
Throws
Error if this manager has been destroyed.
pauseAutoToggle()
pauseAutoToggle():
void
Defined in: src/garminsdk/autopilot/GarminLowBankManager.ts:346
Pauses this manager's auto-toggle behavior. Once paused, this manager will no longer automatically activate/deactivate Low Bank Mode until auto-toggle is resumed.
Returns
void
Throws
Error if this manager has been destroyed.
resumeAutoToggle()
resumeAutoToggle():
void
Defined in: src/garminsdk/autopilot/GarminLowBankManager.ts:324
Resumes this manager's auto-toggle behavior. Once resumed, this manager will automatically activate/deactivate Low Bank Mode based on changes in indicated altitude. If this manager has not been initialized, auto-toggle behavior will begin when initialization is complete.
Returns
void
Throws
Error if this manager has been destroyed.
setLowBankActive()
setLowBankActive(
active):void
Defined in: src/garminsdk/autopilot/GarminLowBankManager.ts:369
Sets the active state of Low Bank Mode. This method does not activate Low Bank Mode when it is not supported by the current lateral flight director mode. This method does nothing if this manager enforces auto-toggle and auto-toggle is resumed.
Parameters
| Parameter | Type | Description |
|---|---|---|
active | boolean | Whether to activate Low Bank Mode. |
Returns
void