Class: WeatherRadarAvionicsSystem
A Garmin weather radar avionics system.
Hierarchy
BasicAvionicsSystem<WeatherRadarAvionicsSystemEvents>↳
WeatherRadarAvionicsSystem
Constructors
constructor
• new WeatherRadarAvionicsSystem(bus, powerSource?, activePowerSource?, isRadarScanActive?, initializationTime?): WeatherRadarAvionicsSystem
Creates an instance of a weather radar avionics system.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
bus | EventBus | undefined | An instance of the event bus. |
powerSource? | CompositeLogicXMLElement | keyof BaseElectricalEvents | `elec_bus_main_v_${number}` | `elec_bus_main_a_${number}` | `elec_master_battery_${number}` | `elec_circuit_avionics_on_${number}` | `elec_bat_v_${number}` | `elec_bat_a_${number}` | `elec_ext_power_available_${number}` | `elec_ext_power_on_${number}` | `elec_apu_gen_active_${number}` | `elec_apu_gen_switch_${number}` | `elec_eng_gen_switch_${number}` | `elec_circuit_on_${number}` | `elec_circuit_switch_on_${number}` | undefined | The AvionicsSystemPowerEvents topic or electricity logic element to which to connect the system's power. |
activePowerSource? | CompositeLogicXMLElement | keyof BaseElectricalEvents | `elec_bus_main_v_${number}` | `elec_bus_main_a_${number}` | `elec_master_battery_${number}` | `elec_circuit_avionics_on_${number}` | `elec_bat_v_${number}` | `elec_bat_a_${number}` | `elec_ext_power_available_${number}` | `elec_ext_power_on_${number}` | `elec_apu_gen_active_${number}` | `elec_apu_gen_switch_${number}` | `elec_eng_gen_switch_${number}` | `elec_circuit_on_${number}` | `elec_circuit_switch_on_${number}` | undefined | The AvionicsSystemPowerEvents topic or electricity logic element to which to connect the system's power when radar is actively scanning. If defined, then the system will enter the failed state if the radar is actively scanning and the active radar power source is unpowered. |
isRadarScanActive? | Subscribable<boolean> | undefined | Whether the weather radar is actively scanning. Ignored if activePowerSource is not defined. |
initializationTime | number | 0 | The time required for the system to initialize, in milliseconds. Defaults to 0. |
Returns
Overrides
BasicAvionicsSystem\<WeatherRadarAvionicsSystemEvents\>.constructor
Defined in
src/garminsdk/system/WeatherRadarAvionicsSystem.ts:35
Properties
_state
• Protected _state: undefined | AvionicsSystemState
Inherited from
BasicAvionicsSystem._state
Defined in
src/sdk/system/BasicAvionicsSystem.ts:32
bus
• Protected Readonly bus: EventBus
The instance of the event bus for the system to use.
Inherited from
BasicAvionicsSystem.bus
Defined in
src/sdk/system/BasicAvionicsSystem.ts:63
electricalActivePowerLogic
• Protected Optional electricalActivePowerLogic: CompositeLogicXMLElement
Defined in
src/garminsdk/system/WeatherRadarAvionicsSystem.ts:21
electricalActivePowerSub
• Protected Optional electricalActivePowerSub: Subscription
Defined in
src/garminsdk/system/WeatherRadarAvionicsSystem.ts:20
electricalPowerLogic
• Protected Optional electricalPowerLogic: CompositeLogicXMLElement
Inherited from
BasicAvionicsSystem.electricalPowerLogic
Defined in
src/sdk/system/BasicAvionicsSystem.ts:48
electricalPowerSub
• Protected Optional electricalPowerSub: Subscription
Inherited from
BasicAvionicsSystem.electricalPowerSub
Defined in
src/sdk/system/BasicAvionicsSystem.ts:47
index
• Readonly index: number
The index of the system.
Inherited from
BasicAvionicsSystem.index
Defined in
src/sdk/system/BasicAvionicsSystem.ts:62
initializationTime
• Protected initializationTime: number = 0
The time it takes in milliseconds for the system to initialize.
Inherited from
BasicAvionicsSystem.initializationTime
Defined in
src/sdk/system/BasicAvionicsSystem.ts:39
initializationTimer
• Protected Readonly initializationTimer: DebounceTimer
A timeout after which initialization will be complete.
Inherited from
BasicAvionicsSystem.initializationTimer
Defined in
src/sdk/system/BasicAvionicsSystem.ts:42
isActivePowered
• Protected isActivePowered: undefined | boolean
Defined in
src/garminsdk/system/WeatherRadarAvionicsSystem.ts:18
isPowerValid
• Protected isPowerValid: boolean = false
Whether power data consumed by this system is valid.
Inherited from
BasicAvionicsSystem.isPowerValid
Defined in
src/sdk/system/BasicAvionicsSystem.ts:53
isPowered
• Protected isPowered: undefined | boolean
Whether or not the system is powered.
Inherited from
BasicAvionicsSystem.isPowered
Defined in
src/sdk/system/BasicAvionicsSystem.ts:45
isRadarScanActive
• Protected Optional Readonly isRadarScanActive: Subscribable<boolean>
Whether the weather radar is actively scanning. Ignored if activePowerSource is not defined.
Defined in
src/garminsdk/system/WeatherRadarAvionicsSystem.ts:39
publisher
• Protected Readonly publisher: Publisher<WeatherRadarAvionicsSystemEvents>
Inherited from
BasicAvionicsSystem.publisher
Defined in
src/sdk/system/BasicAvionicsSystem.ts:50
stateEvent
• Protected Readonly stateEvent: "wx_radar_state"
The key of the state update event to send on state update.
Inherited from
BasicAvionicsSystem.stateEvent
Defined in
src/sdk/system/BasicAvionicsSystem.ts:64
Accessors
state
• get state(): undefined | AvionicsSystemState
Returns
undefined | AvionicsSystemState
Inherit Doc
Inherited from
BasicAvionicsSystem.state
Defined in
src/sdk/system/BasicAvionicsSystem.ts:34
Methods
connectToActivePower
▸ connectToActivePower(source): void
Connects this system's active radar power state to an AvionicsSystemPowerEvents topic or electricity logic element.
Parameters
| Name | Type | Description |
|---|---|---|
source | CompositeLogicXMLElement | keyof BaseElectricalEvents | `elec_bus_main_v_${number}` | `elec_bus_main_a_${number}` | `elec_master_battery_${number}` | `elec_circuit_avionics_on_${number}` | `elec_bat_v_${number}` | `elec_bat_a_${number}` | `elec_ext_power_available_${number}` | `elec_ext_power_on_${number}` | `elec_apu_gen_active_${number}` | `elec_apu_gen_switch_${number}` | `elec_eng_gen_switch_${number}` | `elec_circuit_on_${number}` | `elec_circuit_switch_on_${number}` | The source to which to connect this system's active radar power state. |
Returns
void
Defined in
src/garminsdk/system/WeatherRadarAvionicsSystem.ts:68
connectToPower
▸ connectToPower(source): void
Connects this system's power state to an ElectricalEvents topic, electricity logic element, or Subscribable.
Parameters
| Name | Type | Description |
|---|---|---|
source | CompositeLogicXMLElement | Subscribable<boolean> | keyof BaseElectricalEvents | `elec_bus_main_v_${number}` | `elec_bus_main_a_${number}` | `elec_master_battery_${number}` | `elec_circuit_avionics_on_${number}` | `elec_bat_v_${number}` | `elec_bat_a_${number}` | `elec_ext_power_available_${number}` | `elec_ext_power_on_${number}` | `elec_apu_gen_active_${number}` | `elec_apu_gen_switch_${number}` | `elec_eng_gen_switch_${number}` | `elec_circuit_on_${number}` | `elec_circuit_switch_on_${number}` | The source to which to connect this system's power state. |
Returns
void
Inherited from
BasicAvionicsSystem.connectToPower
Defined in
src/sdk/system/BasicAvionicsSystem.ts:95
onActivePowerChanged
▸ onActivePowerChanged(isPowered): void
A callback called when the connected active radar power state of the avionics system changes.
Parameters
| Name | Type | Description |
|---|---|---|
isPowered | boolean | Whether or not the system is powered. |
Returns
void
Defined in
src/garminsdk/system/WeatherRadarAvionicsSystem.ts:112
onPowerChanged
▸ onPowerChanged(isPowered): void
Parameters
| Name | Type |
|---|---|
isPowered | boolean |
Returns
void
Inherit Doc
Overrides
BasicAvionicsSystem.onPowerChanged
Defined in
src/garminsdk/system/WeatherRadarAvionicsSystem.ts:85
onPowerValid
▸ onPowerValid(): void
Returns
void
Inherit Doc
Overrides
BasicAvionicsSystem.onPowerValid
Defined in
src/garminsdk/system/WeatherRadarAvionicsSystem.ts:56
onRadarScanActiveChanged
▸ onRadarScanActiveChanged(): void
Responds to when whether the radar is actively scanning changes.
Returns
void
Defined in
src/garminsdk/system/WeatherRadarAvionicsSystem.ts:122
onStateChanged
▸ onStateChanged(previousState, currentState): void
Responds to changes in this system's state.
Parameters
| Name | Type | Description |
|---|---|---|
previousState | undefined | AvionicsSystemState | The previous state. |
currentState | AvionicsSystemState | The current state. |
Returns
void
Inherited from
BasicAvionicsSystem.onStateChanged
Defined in
src/sdk/system/BasicAvionicsSystem.ts:132
onUpdate
▸ onUpdate(): void
Returns
void
Inherit Doc
Overrides
BasicAvionicsSystem.onUpdate
Defined in
src/garminsdk/system/WeatherRadarAvionicsSystem.ts:140
setState
▸ setState(state): void
Sets the state of the avionics system and publishes the change.
Parameters
| Name | Type | Description |
|---|---|---|
state | AvionicsSystemState | The new state to change to. |
Returns
void
Inherited from
BasicAvionicsSystem.setState
Defined in
src/sdk/system/BasicAvionicsSystem.ts:117
updateActivePowerFromLogic
▸ updateActivePowerFromLogic(): void
Updates this system's active radar power state from an electricity logic element.
Returns
void
Defined in
src/garminsdk/system/WeatherRadarAvionicsSystem.ts:149
updatePowerFromLogic
▸ updatePowerFromLogic(): void
Updates this system's power state from an electricity logic element.
Returns
void
Inherited from
BasicAvionicsSystem.updatePowerFromLogic
Defined in
src/sdk/system/BasicAvionicsSystem.ts:171
updateStateFromActivePower
▸ updateStateFromActivePower(): void
Updates this system's state from its active radar power state and whether the radar is actively scanning.
Returns
void
Defined in
src/garminsdk/system/WeatherRadarAvionicsSystem.ts:131