Skip to main content

Class: AglSystem

Defined in: src/garminsdk/system/AglSystem.ts:125

A Garmin system that calculates data related to the airplane's above ground height/level. The system supports sourcing FMS position data (plus terrain database) or radar altitude data.

Requires the event bus topics defined in ClockEvents to be published. In order to source FMS position data, requires the event bus topics defined in GNSSEvents and FmsPositionSystemEvents to be published. In order to source radar altitude data, requires the event bus topics defined in RadarAltimeterSystemEvents to be published.

Extends​

Constructors​

Constructor​

new AglSystem(index, bus, powerSource?, options?): AglSystem

Defined in: src/garminsdk/system/AglSystem.ts:182

Creates an instance of an angle of attack computer system.

Parameters​

ParameterTypeDescription
indexnumberThe index of the AoA computer.
busEventBusAn instance of the event bus.
powerSource?CompositeLogicXMLElement | Subscribable<boolean> | "elec_master_battery" | "elec_bat_v" | "elec_bat_load" | "elec_bat_soc" | "elec_ext_power_available" | "elec_ext_power_on" | "elec_ext_power_v" | "elec_ext_power_a" | "elec_apu_gen_active" | "elec_apu_gen_switch" | "elec_eng_gen_switch" | "elec_bus_avionics_v" | "elec_bus_avionics_a" | "elec_circuit_navcom1_on" | "elec_circuit_navcom2_on" | "elec_circuit_navcom3_on" | "elec_circuit_transponder_on" | "elec_av1_bus" | "elec_av2_bus" | `elec_bus_v_${number}` | `elec_bus_a_${number}` | `elec_bus_main_v_${number}` | `elec_bus_main_a_${number}` | `elec_bus_genalt_v_${number}` | `elec_bus_genalt_a_${number}` | `elec_circuit_on_${number}` | `elec_circuit_switch_on_${number}` | `elec_circuit_v_${number}` | `elec_circuit_a_${number}` | `elec_circuit_avionics_on_${number}` | `elec_circuit_com_on_${number}` | `elec_circuit_nav_on_${number}` | `elec_line_connection_on_${number}` | `elec_line_breaker_pulled_${number}` | `elec_gen_switch_on_${number}` | `elec_gen_active_${number}` | `elec_gen_v_${number}` | `elec_gen_a_${number}` | `elec_master_battery_${number}` | `elec_bat_v_${number}` | `elec_bat_load_${number}` | `elec_bat_soc_${number}` | `elec_ext_power_available_${number}` | `elec_ext_power_on_${number}` | `elec_ext_power_v_${number}` | `elec_ext_power_a_${number}` | `elec_apu_gen_active_${number}` | `elec_apu_gen_switch_${number}` | `elec_eng_gen_switch_${number}`The source from which to retrieve the system's power state. Can be an event bus topic defined in ElectricalEvents with boolean-valued data, an XML logic element that evaluates to zero (false) or non-zero (true) values, or a boolean-valued subscribable. If not defined, then the system will be considered always powered on.
options?Readonly<AglSystemOptions>Options with which to configure the system.

Returns​

AglSystem

Overrides​

BasicAvionicsSystem.constructor

Properties​

_state​

protected _state: AvionicsSystemState | undefined

Defined in: src/sdk/system/BasicAvionicsSystem.ts:32

Inherited from​

BasicAvionicsSystem._state


bus​

protected readonly bus: EventBus

Defined in: src/sdk/system/BasicAvionicsSystem.ts:63

The instance of the event bus for the system to use.

Inherited from​

BasicAvionicsSystem.bus


electricalPowerLogic?​

protected optional electricalPowerLogic: CompositeLogicXMLElement

Defined in: src/sdk/system/BasicAvionicsSystem.ts:48

Inherited from​

BasicAvionicsSystem.electricalPowerLogic


electricalPowerSub?​

protected optional electricalPowerSub: Subscription

Defined in: src/sdk/system/BasicAvionicsSystem.ts:47

Inherited from​

BasicAvionicsSystem.electricalPowerSub


index​

readonly index: number

Defined in: src/sdk/system/BasicAvionicsSystem.ts:62

The index of the system.

Inherited from​

BasicAvionicsSystem.index


initializationTime​

protected initializationTime: number = 0

Defined in: src/garminsdk/system/AglSystem.ts:126

The time it takes in milliseconds for the system to initialize.

Overrides​

BasicAvionicsSystem.initializationTime


initializationTimer​

protected readonly initializationTimer: DebounceTimer

Defined in: src/sdk/system/BasicAvionicsSystem.ts:42

A timeout after which initialization will be complete.

Inherited from​

BasicAvionicsSystem.initializationTimer


isPowered​

protected isPowered: boolean | undefined

Defined in: src/sdk/system/BasicAvionicsSystem.ts:45

Whether or not the system is powered.

Inherited from​

BasicAvionicsSystem.isPowered


isPowerValid​

protected isPowerValid: boolean = false

Defined in: src/sdk/system/BasicAvionicsSystem.ts:53

Whether power data consumed by this system is valid.

Inherited from​

BasicAvionicsSystem.isPowerValid


publisher​

protected readonly publisher: Publisher<AglSystemEvents>

Defined in: src/sdk/system/BasicAvionicsSystem.ts:50

Inherited from​

BasicAvionicsSystem.publisher


stateEvent​

protected readonly stateEvent: `agl_state_${number}`

Defined in: src/sdk/system/BasicAvionicsSystem.ts:64

The key of the state update event to send on state update.

Inherited from​

BasicAvionicsSystem.stateEvent

Accessors​

state​

Get Signature​

get state(): AvionicsSystemState | undefined

Defined in: src/sdk/system/BasicAvionicsSystem.ts:34

The state of the avionics system.

Returns​

AvionicsSystemState | undefined

The state of the avionics system.

Inherited from​

BasicAvionicsSystem.state

Methods​

connectToPower()​

protected connectToPower(source): void

Defined in: src/sdk/system/BasicAvionicsSystem.ts:95

Connects this system's power state to an ElectricalEvents topic, electricity logic element, or Subscribable.

Parameters​

ParameterTypeDescription
sourceCompositeLogicXMLElement | Subscribable<boolean> | "elec_master_battery" | "elec_bat_v" | "elec_bat_load" | "elec_bat_soc" | "elec_ext_power_available" | "elec_ext_power_on" | "elec_ext_power_v" | "elec_ext_power_a" | "elec_apu_gen_active" | "elec_apu_gen_switch" | "elec_eng_gen_switch" | "elec_bus_avionics_v" | "elec_bus_avionics_a" | "elec_circuit_navcom1_on" | "elec_circuit_navcom2_on" | "elec_circuit_navcom3_on" | "elec_circuit_transponder_on" | "elec_av1_bus" | "elec_av2_bus" | `elec_bus_v_${number}` | `elec_bus_a_${number}` | `elec_bus_main_v_${number}` | `elec_bus_main_a_${number}` | `elec_bus_genalt_v_${number}` | `elec_bus_genalt_a_${number}` | `elec_circuit_on_${number}` | `elec_circuit_switch_on_${number}` | `elec_circuit_v_${number}` | `elec_circuit_a_${number}` | `elec_circuit_avionics_on_${number}` | `elec_circuit_com_on_${number}` | `elec_circuit_nav_on_${number}` | `elec_line_connection_on_${number}` | `elec_line_breaker_pulled_${number}` | `elec_gen_switch_on_${number}` | `elec_gen_active_${number}` | `elec_gen_v_${number}` | `elec_gen_a_${number}` | `elec_master_battery_${number}` | `elec_bat_v_${number}` | `elec_bat_load_${number}` | `elec_bat_soc_${number}` | `elec_ext_power_available_${number}` | `elec_ext_power_on_${number}` | `elec_ext_power_v_${number}` | `elec_ext_power_a_${number}` | `elec_apu_gen_active_${number}` | `elec_apu_gen_switch_${number}` | `elec_eng_gen_switch_${number}`The source to which to connect this system's power state.

Returns​

void

Inherited from​

BasicAvionicsSystem.connectToPower


onPowerChanged()​

protected onPowerChanged(isPowered): void

Defined in: src/sdk/system/BasicAvionicsSystem.ts:140

A callback called when the connected power state of the avionics system changes.

Parameters​

ParameterTypeDescription
isPoweredbooleanWhether or not the system is powered.

Returns​

void

Inherited from​

BasicAvionicsSystem.onPowerChanged


onPowerValid()​

protected onPowerValid(): void

Defined in: src/sdk/system/BasicAvionicsSystem.ts:86

Responds to when power data becomes valid.

Returns​

void

Inherited from​

BasicAvionicsSystem.onPowerValid


onStateChanged()​

protected onStateChanged(previousState, currentState): void

Defined in: src/sdk/system/BasicAvionicsSystem.ts:132

Responds to changes in this system's state.

Parameters​

ParameterTypeDescription
previousStateAvionicsSystemState | undefinedThe previous state.
currentStateAvionicsSystemStateThe current state.

Returns​

void

Inherited from​

BasicAvionicsSystem.onStateChanged


onUpdate()​

onUpdate(): void

Defined in: src/garminsdk/system/AglSystem.ts:312

A callback to call to update the state of the avionics system.

Returns​

void

Overrides​

BasicAvionicsSystem.onUpdate


setState()​

protected setState(state): void

Defined in: src/sdk/system/BasicAvionicsSystem.ts:117

Sets the state of the avionics system and publishes the change.

Parameters​

ParameterTypeDescription
stateAvionicsSystemStateThe new state to change to.

Returns​

void

Inherited from​

BasicAvionicsSystem.setState


updatePowerFromLogic()​

protected updatePowerFromLogic(): void

Defined in: src/sdk/system/BasicAvionicsSystem.ts:171

Updates this system's power state from an electricity logic element.

Returns​

void

Inherited from​

BasicAvionicsSystem.updatePowerFromLogic