Class: EISPublisher
Defined in: src/sdk/instruments/EngineData.ts:153
A publisher for Engine information.
Extends
Constructors
Constructor
new EISPublisher(
bus,pacer):EISPublisher
Defined in: src/sdk/instruments/EngineData.ts:161
Create an EISPublisher
Parameters
| Parameter | Type | Default value | Description |
|---|---|---|---|
bus | EventBus | undefined | The EventBus to publish to |
pacer | undefined | PublishPacer<EngineEvents<number>> | undefined | An optional pacer to use to control the rate of publishing |
Returns
EISPublisher
Overrides
Properties
bus
protectedreadonlybus:EventBus
Defined in: src/sdk/instruments/BasePublishers.ts:10
Inherited from
indexedSimVars
protectedreadonlyindexedSimVars:Map<"eng_starter_active"|`rpm_${number}`|`prop_rpm_${number}`|`n1_${number}`|`n1_uncorrected_${number}`|`n2_${number}`|`n2_uncorrected_${number}`|`torque_${number}`|`fuel_flow_${number}`|`fuel_flow_pph_${number}`|`recip_ff_${number}`|`oil_press_${number}`|`oil_temp_${number}`|`itt_${number}`|`egt_${number}`|`eng_hyd_press_${number}`|`eng_starter_on_${number}`|`eng_combustion_${number}`|`eng_ignition_switch_state_${number}`|`eng_igniting_${number}`|`eng_fuel_pump_on_${number}`|`eng_fuel_pump_switch_state_${number}`|`eng_vibration_${number}`|`torque_moment_${number}`|`eng_manifold_pressure_${number}`|`reverse_thrust_engaged_${number}`|`cylinder_head_temp_avg_${number}`|`recip_turbine_inlet_temp_avg_${number}`|`turbine_inlet_temp_${number}`|`jet_net_thrust_${number}`|`eng_fire_${number}`|`eng_starter_active_${number}`|"vac"|"fuel_flow_total"|"fuel_total"|"fuel_total_weight"|"fuel_usable_total"|"fuel_usable_total_weight"|"fuel_left"|"fuel_right"|"fuel_left_main"|"fuel_left_main_pct"|"fuel_right_main"|"fuel_right_main_pct"|"fuel_center"|"fuel_weight_per_gallon"|"fuel_tank_selector_state_1"|"fuel_tank_selector_state_2"|"fuel_tank_selector_state_3"|"fuel_tank_selector_state_4"|"eng_hours_1"|"apu_pct"|"apu_pct_starter"|"apu_switch"|"throttle_lower_limit",IndexedSimVarPublisherEntry<any>>
Defined in: src/sdk/instruments/BasePublishers.ts:149
Inherited from
SimVarPublisher.indexedSimVars
pacer
protectedreadonlypacer:undefined|PublishPacer<EngineEvents<number>>
Defined in: src/sdk/instruments/BasePublishers.ts:13
Inherited from
publishActive
protectedpublishActive:boolean
Defined in: src/sdk/instruments/BasePublishers.ts:12
Inherited from
publisher
protectedreadonlypublisher:Publisher<EngineEvents<number>>
Defined in: src/sdk/instruments/BasePublishers.ts:11
Inherited from
resolvedSimVars
protectedreadonlyresolvedSimVars:Map<"eng_starter_active"|`rpm_${number}`|`prop_rpm_${number}`|`n1_${number}`|`n1_uncorrected_${number}`|`n2_${number}`|`n2_uncorrected_${number}`|`torque_${number}`|`fuel_flow_${number}`|`fuel_flow_pph_${number}`|`recip_ff_${number}`|`oil_press_${number}`|`oil_temp_${number}`|`itt_${number}`|`egt_${number}`|`eng_hyd_press_${number}`|`eng_starter_on_${number}`|`eng_combustion_${number}`|`eng_ignition_switch_state_${number}`|`eng_igniting_${number}`|`eng_fuel_pump_on_${number}`|`eng_fuel_pump_switch_state_${number}`|`eng_vibration_${number}`|`torque_moment_${number}`|`eng_manifold_pressure_${number}`|`reverse_thrust_engaged_${number}`|`cylinder_head_temp_avg_${number}`|`recip_turbine_inlet_temp_avg_${number}`|`turbine_inlet_temp_${number}`|`jet_net_thrust_${number}`|`eng_fire_${number}`|`eng_starter_active_${number}`|"vac"|"fuel_flow_total"|"fuel_total"|"fuel_total_weight"|"fuel_usable_total"|"fuel_usable_total_weight"|"fuel_left"|"fuel_right"|"fuel_left_main"|"fuel_left_main_pct"|"fuel_right_main"|"fuel_right_main_pct"|"fuel_center"|"fuel_weight_per_gallon"|"fuel_tank_selector_state_1"|"fuel_tank_selector_state_2"|"fuel_tank_selector_state_3"|"fuel_tank_selector_state_4"|"eng_hours_1"|"apu_pct"|"apu_pct_starter"|"apu_switch"|"throttle_lower_limit",ResolvedSimVarPublisherEntry<any>>
Defined in: src/sdk/instruments/BasePublishers.ts:147
Inherited from
SimVarPublisher.resolvedSimVars
subscribed
protectedreadonlysubscribed:Set<"eng_starter_active"|`rpm_${number}`|`prop_rpm_${number}`|`n1_${number}`|`n1_uncorrected_${number}`|`n2_${number}`|`n2_uncorrected_${number}`|`torque_${number}`|`fuel_flow_${number}`|`fuel_flow_pph_${number}`|`recip_ff_${number}`|`oil_press_${number}`|`oil_temp_${number}`|`itt_${number}`|`egt_${number}`|`eng_hyd_press_${number}`|`eng_starter_on_${number}`|`eng_combustion_${number}`|`eng_ignition_switch_state_${number}`|`eng_igniting_${number}`|`eng_fuel_pump_on_${number}`|`eng_fuel_pump_switch_state_${number}`|`eng_vibration_${number}`|`torque_moment_${number}`|`eng_manifold_pressure_${number}`|`reverse_thrust_engaged_${number}`|`cylinder_head_temp_avg_${number}`|`recip_turbine_inlet_temp_avg_${number}`|`turbine_inlet_temp_${number}`|`jet_net_thrust_${number}`|`eng_fire_${number}`|`eng_starter_active_${number}`|"vac"|"fuel_flow_total"|"fuel_total"|"fuel_total_weight"|"fuel_usable_total"|"fuel_usable_total_weight"|"fuel_left"|"fuel_right"|"fuel_left_main"|"fuel_left_main_pct"|"fuel_right_main"|"fuel_right_main_pct"|"fuel_center"|"fuel_weight_per_gallon"|"fuel_tank_selector_state_1"|"fuel_tank_selector_state_2"|"fuel_tank_selector_state_3"|"fuel_tank_selector_state_4"|"eng_hours_1"|"apu_pct"|"apu_pct_starter"|"apu_switch"|"throttle_lower_limit">
Defined in: src/sdk/instruments/BasePublishers.ts:151
Inherited from
INDEXED_REGEX
protectedreadonlystaticINDEXED_REGEX:RegExp
Defined in: src/sdk/instruments/BasePublishers.ts:145
Inherited from
Methods
getValue()
protectedgetValue<K>(topic):undefined|EngineEvents<number>[K]
Defined in: src/sdk/instruments/BasePublishers.ts:343
Gets the current value for a topic.
Type Parameters
| Type Parameter |
|---|
K extends "eng_starter_active" | `rpm_${number}` | `prop_rpm_${number}` | `n1_${number}` | `n1_uncorrected_${number}` | `n2_${number}` | `n2_uncorrected_${number}` | `torque_${number}` | `fuel_flow_${number}` | `fuel_flow_pph_${number}` | `recip_ff_${number}` | `oil_press_${number}` | `oil_temp_${number}` | `itt_${number}` | `egt_${number}` | `eng_hyd_press_${number}` | `eng_starter_on_${number}` | `eng_combustion_${number}` | `eng_ignition_switch_state_${number}` | `eng_igniting_${number}` | `eng_fuel_pump_on_${number}` | `eng_fuel_pump_switch_state_${number}` | `eng_vibration_${number}` | `torque_moment_${number}` | `eng_manifold_pressure_${number}` | `reverse_thrust_engaged_${number}` | `cylinder_head_temp_avg_${number}` | `recip_turbine_inlet_temp_avg_${number}` | `turbine_inlet_temp_${number}` | `jet_net_thrust_${number}` | `eng_fire_${number}` | `eng_starter_active_${number}` | "vac" | "fuel_flow_total" | "fuel_total" | "fuel_total_weight" | "fuel_usable_total" | "fuel_usable_total_weight" | "fuel_left" | "fuel_right" | "fuel_left_main" | "fuel_left_main_pct" | "fuel_right_main" | "fuel_right_main_pct" | "fuel_center" | "fuel_weight_per_gallon" | "fuel_tank_selector_state_1" | "fuel_tank_selector_state_2" | "fuel_tank_selector_state_3" | "fuel_tank_selector_state_4" | "eng_hours_1" | "apu_pct" | "apu_pct_starter" | "apu_switch" | "throttle_lower_limit" |
Parameters
| Parameter | Type | Description |
|---|---|---|
topic | K | A topic. |
Returns
undefined | EngineEvents<number>[K]
The current value for the specified topic.
Inherited from
getValueFromEntry()
protectedgetValueFromEntry<T>(entry):T
Defined in: src/sdk/instruments/BasePublishers.ts:357
Gets the current value for a resolved topic entry.
Type Parameters
| Type Parameter |
|---|
T |
Parameters
| Parameter | Type | Description |
|---|---|---|
entry | ResolvedSimVarPublisherEntry<T> | An entry for a resolved topic. |
Returns
T
The current value for the specified entry.
Inherited from
SimVarPublisher.getValueFromEntry
handleSubscribedTopic()
protectedhandleSubscribedTopic(topic):void
Defined in: src/sdk/instruments/BasePublishers.ts:193
Handles when an event bus topic is subscribed to for the first time.
Parameters
| Parameter | Type | Description |
|---|---|---|
topic | string | The subscribed topic. |
Returns
void
Inherited from
SimVarPublisher.handleSubscribedTopic
isPublishing()
isPublishing():
boolean
Defined in: src/sdk/instruments/BasePublishers.ts:45
Tells whether or not the publisher is currently active.
Returns
boolean
True if the publisher is active, false otherwise.
Inherited from
onTopicSubscribed()
protectedonTopicSubscribed(topic):void
Defined in: src/sdk/instruments/BasePublishers.ts:279
Responds to when one of this publisher's topics is subscribed to for the first time.
Parameters
| Parameter | Type | Description |
|---|---|---|
topic | "eng_starter_active" | `rpm_${number}` | `prop_rpm_${number}` | `n1_${number}` | `n1_uncorrected_${number}` | `n2_${number}` | `n2_uncorrected_${number}` | `torque_${number}` | `fuel_flow_${number}` | `fuel_flow_pph_${number}` | `recip_ff_${number}` | `oil_press_${number}` | `oil_temp_${number}` | `itt_${number}` | `egt_${number}` | `eng_hyd_press_${number}` | `eng_starter_on_${number}` | `eng_combustion_${number}` | `eng_ignition_switch_state_${number}` | `eng_igniting_${number}` | `eng_fuel_pump_on_${number}` | `eng_fuel_pump_switch_state_${number}` | `eng_vibration_${number}` | `torque_moment_${number}` | `eng_manifold_pressure_${number}` | `reverse_thrust_engaged_${number}` | `cylinder_head_temp_avg_${number}` | `recip_turbine_inlet_temp_avg_${number}` | `turbine_inlet_temp_${number}` | `jet_net_thrust_${number}` | `eng_fire_${number}` | `eng_starter_active_${number}` | "vac" | "fuel_flow_total" | "fuel_total" | "fuel_total_weight" | "fuel_usable_total" | "fuel_usable_total_weight" | "fuel_left" | "fuel_right" | "fuel_left_main" | "fuel_left_main_pct" | "fuel_right_main" | "fuel_right_main_pct" | "fuel_center" | "fuel_weight_per_gallon" | "fuel_tank_selector_state_1" | "fuel_tank_selector_state_2" | "fuel_tank_selector_state_3" | "fuel_tank_selector_state_4" | "eng_hours_1" | "apu_pct" | "apu_pct_starter" | "apu_switch" | "throttle_lower_limit" | The topic that was subscribed to. |
Returns
void
Inherited from
SimVarPublisher.onTopicSubscribed
onUpdate()
onUpdate():
void
Defined in: src/sdk/instruments/EngineData.ts:252
Publish all subscribed data points to the bus.
Returns
void
Overrides
publish()
protectedpublish<K>(topic,data,sync,isCached):void
Defined in: src/sdk/instruments/BasePublishers.ts:63
Publish a message if publishing is acpive
Type Parameters
| Type Parameter |
|---|
K extends `rpm_${number}` | `prop_rpm_${number}` | `n1_${number}` | `n1_uncorrected_${number}` | `n2_${number}` | `n2_uncorrected_${number}` | `torque_${number}` | `fuel_flow_${number}` | `fuel_flow_pph_${number}` | `recip_ff_${number}` | `oil_press_${number}` | `oil_temp_${number}` | `itt_${number}` | `egt_${number}` | `eng_hyd_press_${number}` | `eng_starter_on_${number}` | `eng_combustion_${number}` | `eng_ignition_switch_state_${number}` | `eng_igniting_${number}` | `eng_fuel_pump_on_${number}` | `eng_fuel_pump_switch_state_${number}` | `eng_vibration_${number}` | `torque_moment_${number}` | `eng_manifold_pressure_${number}` | `reverse_thrust_engaged_${number}` | `cylinder_head_temp_avg_${number}` | `recip_turbine_inlet_temp_avg_${number}` | `turbine_inlet_temp_${number}` | `jet_net_thrust_${number}` | `eng_fire_${number}` | `eng_starter_active_${number}` | keyof BaseEngineEvents |
Parameters
| Parameter | Type | Default value | Description |
|---|---|---|---|
topic | K | undefined | The topic key to publish to. |
data | EngineEvents<number>[K] | undefined | The data type for chosen topic. |
sync | boolean | false | Whether or not the event should be synced to other instruments. Defaults to false. |
isCached | boolean | true | Whether or not the event should be cached. Defaults to true. |
Returns
void
Inherited from
publishTopic()
protectedpublishTopic(topic):void
Defined in: src/sdk/instruments/BasePublishers.ts:325
Publishes data to the event bus for a topic.
Parameters
| Parameter | Type | Description |
|---|---|---|
topic | "eng_starter_active" | `rpm_${number}` | `prop_rpm_${number}` | `n1_${number}` | `n1_uncorrected_${number}` | `n2_${number}` | `n2_uncorrected_${number}` | `torque_${number}` | `fuel_flow_${number}` | `fuel_flow_pph_${number}` | `recip_ff_${number}` | `oil_press_${number}` | `oil_temp_${number}` | `itt_${number}` | `egt_${number}` | `eng_hyd_press_${number}` | `eng_starter_on_${number}` | `eng_combustion_${number}` | `eng_ignition_switch_state_${number}` | `eng_igniting_${number}` | `eng_fuel_pump_on_${number}` | `eng_fuel_pump_switch_state_${number}` | `eng_vibration_${number}` | `torque_moment_${number}` | `eng_manifold_pressure_${number}` | `reverse_thrust_engaged_${number}` | `cylinder_head_temp_avg_${number}` | `recip_turbine_inlet_temp_avg_${number}` | `turbine_inlet_temp_${number}` | `jet_net_thrust_${number}` | `eng_fire_${number}` | `eng_starter_active_${number}` | "vac" | "fuel_flow_total" | "fuel_total" | "fuel_total_weight" | "fuel_usable_total" | "fuel_usable_total_weight" | "fuel_left" | "fuel_right" | "fuel_left_main" | "fuel_left_main_pct" | "fuel_right_main" | "fuel_right_main_pct" | "fuel_center" | "fuel_weight_per_gallon" | "fuel_tank_selector_state_1" | "fuel_tank_selector_state_2" | "fuel_tank_selector_state_3" | "fuel_tank_selector_state_4" | "eng_hours_1" | "apu_pct" | "apu_pct_starter" | "apu_switch" | "throttle_lower_limit" | The topic to publish. |
Returns
void
Inherited from
resolveIndexedSimVar()
protectedresolveIndexedSimVar(topic,entry,index):undefined|string
Defined in: src/sdk/instruments/BasePublishers.ts:250
Attempts to resolve an indexed topic with an index, generating a version of the topic which is mapped to an indexed simvar. The resolved indexed topic can then be published.
Parameters
| Parameter | Type | Description |
|---|---|---|
topic | "eng_starter_active" | `rpm_${number}` | `prop_rpm_${number}` | `n1_${number}` | `n1_uncorrected_${number}` | `n2_${number}` | `n2_uncorrected_${number}` | `torque_${number}` | `fuel_flow_${number}` | `fuel_flow_pph_${number}` | `recip_ff_${number}` | `oil_press_${number}` | `oil_temp_${number}` | `itt_${number}` | `egt_${number}` | `eng_hyd_press_${number}` | `eng_starter_on_${number}` | `eng_combustion_${number}` | `eng_ignition_switch_state_${number}` | `eng_igniting_${number}` | `eng_fuel_pump_on_${number}` | `eng_fuel_pump_switch_state_${number}` | `eng_vibration_${number}` | `torque_moment_${number}` | `eng_manifold_pressure_${number}` | `reverse_thrust_engaged_${number}` | `cylinder_head_temp_avg_${number}` | `recip_turbine_inlet_temp_avg_${number}` | `turbine_inlet_temp_${number}` | `jet_net_thrust_${number}` | `eng_fire_${number}` | `eng_starter_active_${number}` | "vac" | "fuel_flow_total" | "fuel_total" | "fuel_total_weight" | "fuel_usable_total" | "fuel_usable_total_weight" | "fuel_left" | "fuel_right" | "fuel_left_main" | "fuel_left_main_pct" | "fuel_right_main" | "fuel_right_main_pct" | "fuel_center" | "fuel_weight_per_gallon" | "fuel_tank_selector_state_1" | "fuel_tank_selector_state_2" | "fuel_tank_selector_state_3" | "fuel_tank_selector_state_4" | "eng_hours_1" | "apu_pct" | "apu_pct_starter" | "apu_switch" | "throttle_lower_limit" | The topic to resolve. |
entry | IndexedSimVarPublisherEntry<any> | The entry of the topic to resolve. |
index | number | The index with which to resolve the topic. If not defined, the topic will resolve to itself (without a suffix) and will be mapped the index-1 version of its simvar. |
Returns
undefined | string
The resolved indexed topic, or undefined if the topic could not be resolved with the specified index.
Inherited from
SimVarPublisher.resolveIndexedSimVar
startPublish()
startPublish():
void
Defined in: src/sdk/instruments/BasePublishers.ts:30
Start publishing.
Returns
void
Inherited from
stopPublish()
stopPublish():
void
Defined in: src/sdk/instruments/BasePublishers.ts:37
Stop publishing.
Returns
void
Inherited from
subscribe()
subscribe(
data):void
Defined in: src/sdk/instruments/BasePublishers.ts:298
NOOP - For backwards compatibility.
Parameters
| Parameter | Type | Description |
|---|---|---|
data | `rpm_${number}` | `prop_rpm_${number}` | `n1_${number}` | `n1_uncorrected_${number}` | `n2_${number}` | `n2_uncorrected_${number}` | `torque_${number}` | `fuel_flow_${number}` | `fuel_flow_pph_${number}` | `recip_ff_${number}` | `oil_press_${number}` | `oil_temp_${number}` | `itt_${number}` | `egt_${number}` | `eng_hyd_press_${number}` | `eng_starter_on_${number}` | `eng_combustion_${number}` | `eng_ignition_switch_state_${number}` | `eng_igniting_${number}` | `eng_fuel_pump_on_${number}` | `eng_fuel_pump_switch_state_${number}` | `eng_vibration_${number}` | `torque_moment_${number}` | `eng_manifold_pressure_${number}` | `reverse_thrust_engaged_${number}` | `cylinder_head_temp_avg_${number}` | `recip_turbine_inlet_temp_avg_${number}` | `turbine_inlet_temp_${number}` | `jet_net_thrust_${number}` | `eng_fire_${number}` | `eng_starter_active_${number}` | keyof BaseEngineEvents | Key of the event type in the simVarMap |
Returns
void
Deprecated
Inherited from
tryMatchIndexedSubscribedTopic()
protectedtryMatchIndexedSubscribedTopic(topic):void
Defined in: src/sdk/instruments/BasePublishers.ts:208
Checks if a subscribed topic matches one of this publisher's indexed topics, and if so resolves and starts publishing the indexed topic.
Parameters
| Parameter | Type | Description |
|---|---|---|
topic | string | The subscribed topic to check. |
Returns
void
Inherited from
SimVarPublisher.tryMatchIndexedSubscribedTopic
unsubscribe()
unsubscribe(
data):void
Defined in: src/sdk/instruments/BasePublishers.ts:308
NOOP - For backwards compatibility.
Parameters
| Parameter | Type | Description |
|---|---|---|
data | `rpm_${number}` | `prop_rpm_${number}` | `n1_${number}` | `n1_uncorrected_${number}` | `n2_${number}` | `n2_uncorrected_${number}` | `torque_${number}` | `fuel_flow_${number}` | `fuel_flow_pph_${number}` | `recip_ff_${number}` | `oil_press_${number}` | `oil_temp_${number}` | `itt_${number}` | `egt_${number}` | `eng_hyd_press_${number}` | `eng_starter_on_${number}` | `eng_combustion_${number}` | `eng_ignition_switch_state_${number}` | `eng_igniting_${number}` | `eng_fuel_pump_on_${number}` | `eng_fuel_pump_switch_state_${number}` | `eng_vibration_${number}` | `torque_moment_${number}` | `eng_manifold_pressure_${number}` | `reverse_thrust_engaged_${number}` | `cylinder_head_temp_avg_${number}` | `recip_turbine_inlet_temp_avg_${number}` | `turbine_inlet_temp_${number}` | `jet_net_thrust_${number}` | `eng_fire_${number}` | `eng_starter_active_${number}` | keyof BaseEngineEvents | Key of the event type in the simVarMap |
Returns
void