Class: EISPublisher
Defined in: src/sdk/instruments/EngineData.ts:150
A publisher for Engine information.
Extends
Constructors
Constructor
new EISPublisher(
bus
,pacer?
):EISPublisher
Defined in: src/sdk/instruments/EngineData.ts:163
Create an EISPublisher
Parameters
Parameter | Type | Description |
---|---|---|
bus | EventBus | The EventBus to publish to |
pacer? | PublishPacer <EngineEvents > | An optional pacer to use to control the rate of publishing |
Returns
EISPublisher
Overrides
Properties
bus
protected
readonly
bus:EventBus
Defined in: src/sdk/instruments/BasePublishers.ts:10
Inherited from
pacer
protected
readonly
pacer:undefined
|PublishPacer
<EngineEvents
>
Defined in: src/sdk/instruments/BasePublishers.ts:13
Inherited from
publishActive
protected
publishActive:boolean
Defined in: src/sdk/instruments/BasePublishers.ts:12
Inherited from
publisher
protected
readonly
publisher:Publisher
<EngineEvents
>
Defined in: src/sdk/instruments/BasePublishers.ts:11
Inherited from
Methods
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
onUpdate()
onUpdate():
void
Defined in: src/sdk/instruments/EngineData.ts:269
A callback called when the publisher receives an update cycle.
Returns
void
Overrides
publish()
protected
publish<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 keyof BaseEngineIndexedEngineEvents | `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 BaseNonIndexedEngineEvents |
Parameters
Parameter | Type | Default value | Description |
---|---|---|---|
topic | K | undefined | The topic key to publish to. |
data | EngineEvents [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
startPublish()
startPublish():
void
Defined in: src/sdk/instruments/EngineData.ts:255
Start publishing.
Returns
void
Overrides
stopPublish()
stopPublish():
void
Defined in: src/sdk/instruments/EngineData.ts:262
Stop publishing.
Returns
void