Class: MagnetometerSystem

Defined in: src/garminsdk/system/MagnetometerSystem.ts:14

The GMU44 magnetometer system.

Extends

• BasicAvionicsSystem<MagnetometerSystemEvents>

Constructors

Constructor

new MagnetometerSystem(index, bus, powerSource?): MagnetometerSystem

Defined in: src/garminsdk/system/MagnetometerSystem.ts:24

Creates an instance of the MagnetometerSystem.

Parameters

Parameter	Type	Description
index	number	The index of the system.
bus	EventBus	The instance of the event bus for the system to use.
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}` | `elec_circuit_com_on_${number}` | `elec_circuit_nav_on_${number}`	The ElectricalEvents topic or electricity logic element to which to connect the system's power.

Returns

MagnetometerSystem

Overrides

BasicAvionicsSystem<MagnetometerSystemEvents>.constructor

Properties

_state

protected _state: undefined | AvionicsSystemState

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

Inherited from

BasicAvionicsSystem._state

---

bus

protected readonly bus: EventBus

Defined in: src/garminsdk/system/MagnetometerSystem.ts:26

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/garminsdk/system/MagnetometerSystem.ts:25

The index of the system.

Inherited from

BasicAvionicsSystem.index

---

initializationTime

protected initializationTime: number = 5000

Defined in: src/garminsdk/system/MagnetometerSystem.ts:15

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: undefined | boolean

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<MagnetometerSystemEvents>

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

Inherited from

BasicAvionicsSystem.publisher

---

stateEvent

protected readonly stateEvent: `magnetometer_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(): undefined | AvionicsSystemState

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

Inherit Doc

Returns

undefined | AvionicsSystemState

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

Parameter	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}` | `elec_circuit_com_on_${number}` | `elec_circuit_nav_on_${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

Parameter	Type	Description
isPowered	boolean	Whether 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

Parameter	Type	Description
previousState	undefined | AvionicsSystemState	The previous state.
currentState	AvionicsSystemState	The current state.

Returns

void

Inherited from

BasicAvionicsSystem.onStateChanged

---

onUpdate()

onUpdate(): void

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

Returns

void

Inherit Doc

Inherited from

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

Parameter	Type	Description
state	AvionicsSystemState	The 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