Class: FmsPositionSystem
A Garmin FMS geo-positioning system.
Hierarchy
BasicAvionicsSystem<FmsPositionSystemEvents>↳
FmsPositionSystem
Constructors
constructor
• new FmsPositionSystem(index, bus, gpsReceiverIndex, adcIndex, ahrsIndex, hnsIndex?, dmeIndex?, powerSource?): FmsPositionSystem
Creates an instance of an FMS geo-positioning system.
Parameters
| Name | Type | Description |
|---|---|---|
index | number | The index of the FMS geo-positioning system. |
bus | EventBus | An instance of the event bus. |
gpsReceiverIndex | number | Subscribable<number> | The index of the GPS receiver used by this system. No GPS data will be used if the index is negative. |
adcIndex | number | Subscribable<number> | The index of the ADC used by this system in dead reckoning mode to obtain airspeed data. |
ahrsIndex | number | Subscribable<number> | The index of the AHRS used by this system in dead reckoning mode to obtain heading data. |
hnsIndex? | number | Subscribable<number> | The index of the HNS used by this system. No HNS data will be used if the index is negative. Defaults to -1. |
dmeIndex? | number | Subscribable<number> | The index of the DME/DME navigation system used by this system. No DME/DME data will be used if the index is negative. Defaults to -1. |
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}` | The ElectricalEvents topic or electricity logic element to which to connect the system's power. |
Returns
Overrides
BasicAvionicsSystem\<FmsPositionSystemEvents\>.constructor
Defined in
src/garminsdk/system/FmsPositionSystem.ts:121
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
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
Overrides
BasicAvionicsSystem.initializationTime
Defined in
src/garminsdk/system/FmsPositionSystem.ts:74
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
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
publisher
• Protected Readonly publisher: Publisher<FmsPositionSystemEvents>
Inherited from
BasicAvionicsSystem.publisher
Defined in
src/sdk/system/BasicAvionicsSystem.ts:50
stateEvent
• Protected Readonly stateEvent: `fms_pos_state_${number}`
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
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
onPowerChanged
▸ onPowerChanged(isPowered): void
A callback called when the connected power state of the avionics system changes.
Parameters
| Name | Type | Description |
|---|---|---|
isPowered | boolean | Whether or not the system is powered. |
Returns
void
Inherited from
BasicAvionicsSystem.onPowerChanged
Defined in
src/sdk/system/BasicAvionicsSystem.ts:140
onPowerValid
▸ onPowerValid(): void
Responds to when power data becomes valid.
Returns
void
Inherited from
BasicAvionicsSystem.onPowerValid
Defined in
src/sdk/system/BasicAvionicsSystem.ts:86
onStateChanged
▸ onStateChanged(previousState, currentState): void
Parameters
| Name | Type |
|---|---|
previousState | undefined | AvionicsSystemState |
currentState | AvionicsSystemState |
Returns
void
Inherit Doc
Overrides
BasicAvionicsSystem.onStateChanged
Defined in
src/garminsdk/system/FmsPositionSystem.ts:197
onUpdate
▸ onUpdate(): void
Returns
void
Inherit Doc
Overrides
BasicAvionicsSystem.onUpdate
Defined in
src/garminsdk/system/FmsPositionSystem.ts:213
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
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