Class: ElectricalPublisher
A publisher for electrical information.
Hierarchy
SimVarPublisher<ElectricalEvents>↳
ElectricalPublisher
Constructors
constructor
• new ElectricalPublisher(bus, pacer?): ElectricalPublisher
Create an ElectricalPublisher
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
bus | EventBus | undefined | The EventBus to publish to |
pacer | undefined | PublishPacer<ElectricalEvents> | undefined | An optional pacer to use to control the rate of publishing |
Returns
Overrides
Defined in
src/sdk/instruments/Electrical.ts:169
Properties
bus
• Protected Readonly bus: EventBus
Inherited from
Defined in
src/sdk/instruments/BasePublishers.ts:10
indexedSimVars
• Protected Readonly indexedSimVars: Map<"elec_bus_main_v" | "elec_bus_main_a" | "elec_master_battery" | "elec_circuit_avionics_on" | "elec_bat_v" | "elec_bat_a" | "elec_ext_power_available" | "elec_ext_power_on" | "elec_apu_gen_active" | "elec_apu_gen_switch" | "elec_eng_gen_switch" | "elec_circuit_on" | "elec_circuit_switch_on" | "elec_circuit_navcom1_on" | "elec_circuit_navcom2_on" | "elec_circuit_navcom3_on" | "elec_av1_bus" | "elec_av2_bus" | "elec_bus_avionics_v" | "elec_bus_avionics_a" | "elec_bus_genalt_1_v" | "elec_bus_genalt_2_v" | "elec_bus_genalt_3_v" | "elec_bus_genalt_4_v" | "elec_bus_genalt_5_v" | "elec_bus_genalt_6_v" | "elec_bus_genalt_1_a" | "elec_bus_genalt_2_a" | "elec_bus_genalt_3_a" | "elec_bus_genalt_4_a" | "elec_bus_genalt_5_a" | "elec_bus_genalt_6_a" | `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}`, IndexedSimVarPublisherEntry<any>>
Inherited from
SimVarPublisher.indexedSimVars
Defined in
src/sdk/instruments/BasePublishers.ts:149
pacer
• Protected Readonly pacer: undefined | PublishPacer<ElectricalEvents>
Inherited from
Defined in
src/sdk/instruments/BasePublishers.ts:13
publishActive
• Protected publishActive: boolean
Inherited from
Defined in
src/sdk/instruments/BasePublishers.ts:12
publisher
• Protected Readonly publisher: Publisher<ElectricalEvents>
Inherited from
Defined in
src/sdk/instruments/BasePublishers.ts:11
resolvedSimVars
• Protected Readonly resolvedSimVars: Map<"elec_bus_main_v" | "elec_bus_main_a" | "elec_master_battery" | "elec_circuit_avionics_on" | "elec_bat_v" | "elec_bat_a" | "elec_ext_power_available" | "elec_ext_power_on" | "elec_apu_gen_active" | "elec_apu_gen_switch" | "elec_eng_gen_switch" | "elec_circuit_on" | "elec_circuit_switch_on" | "elec_circuit_navcom1_on" | "elec_circuit_navcom2_on" | "elec_circuit_navcom3_on" | "elec_av1_bus" | "elec_av2_bus" | "elec_bus_avionics_v" | "elec_bus_avionics_a" | "elec_bus_genalt_1_v" | "elec_bus_genalt_2_v" | "elec_bus_genalt_3_v" | "elec_bus_genalt_4_v" | "elec_bus_genalt_5_v" | "elec_bus_genalt_6_v" | "elec_bus_genalt_1_a" | "elec_bus_genalt_2_a" | "elec_bus_genalt_3_a" | "elec_bus_genalt_4_a" | "elec_bus_genalt_5_a" | "elec_bus_genalt_6_a" | `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}`, ResolvedSimVarPublisherEntry<any>>
Inherited from
SimVarPublisher.resolvedSimVars
Defined in
src/sdk/instruments/BasePublishers.ts:147
subscribed
• Protected Readonly subscribed: Set<"elec_bus_main_v" | "elec_bus_main_a" | "elec_master_battery" | "elec_circuit_avionics_on" | "elec_bat_v" | "elec_bat_a" | "elec_ext_power_available" | "elec_ext_power_on" | "elec_apu_gen_active" | "elec_apu_gen_switch" | "elec_eng_gen_switch" | "elec_circuit_on" | "elec_circuit_switch_on" | "elec_circuit_navcom1_on" | "elec_circuit_navcom2_on" | "elec_circuit_navcom3_on" | "elec_av1_bus" | "elec_av2_bus" | "elec_bus_avionics_v" | "elec_bus_avionics_a" | "elec_bus_genalt_1_v" | "elec_bus_genalt_2_v" | "elec_bus_genalt_3_v" | "elec_bus_genalt_4_v" | "elec_bus_genalt_5_v" | "elec_bus_genalt_6_v" | "elec_bus_genalt_1_a" | "elec_bus_genalt_2_a" | "elec_bus_genalt_3_a" | "elec_bus_genalt_4_a" | "elec_bus_genalt_5_a" | "elec_bus_genalt_6_a" | `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}`>
Inherited from
Defined in
src/sdk/instruments/BasePublishers.ts:151
INDEXED_REGEX
▪ Static Protected Readonly INDEXED_REGEX: RegExp
Inherited from
Defined in
src/sdk/instruments/BasePublishers.ts:145
Methods
getValue
▸ getValue<K>(topic): undefined | ElectricalEvents[K]
Gets the current value for a topic.
Type parameters
| Name | Type |
|---|---|
K | extends "elec_bus_main_v" | "elec_bus_main_a" | "elec_master_battery" | "elec_circuit_avionics_on" | "elec_bat_v" | "elec_bat_a" | "elec_ext_power_available" | "elec_ext_power_on" | "elec_apu_gen_active" | "elec_apu_gen_switch" | "elec_eng_gen_switch" | "elec_circuit_on" | "elec_circuit_switch_on" | "elec_circuit_navcom1_on" | "elec_circuit_navcom2_on" | "elec_circuit_navcom3_on" | "elec_av1_bus" | "elec_av2_bus" | "elec_bus_avionics_v" | "elec_bus_avionics_a" | "elec_bus_genalt_1_v" | "elec_bus_genalt_2_v" | "elec_bus_genalt_3_v" | "elec_bus_genalt_4_v" | "elec_bus_genalt_5_v" | "elec_bus_genalt_6_v" | "elec_bus_genalt_1_a" | "elec_bus_genalt_2_a" | "elec_bus_genalt_3_a" | "elec_bus_genalt_4_a" | "elec_bus_genalt_5_a" | "elec_bus_genalt_6_a" | `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}` |
Parameters
| Name | Type | Description |
|---|---|---|
topic | K | A topic. |
Returns
undefined | ElectricalEvents[K]
The current value for the specified topic.
Inherited from
Defined in
src/sdk/instruments/BasePublishers.ts:343
getValueFromEntry
▸ getValueFromEntry<T>(entry): T
Gets the current value for a resolved topic entry.
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type | Description |
|---|---|---|
entry | ResolvedSimVarPublisherEntry<T> | An entry for a resolved topic. |
Returns
T
The current value for the specified entry.
Inherited from
SimVarPublisher.getValueFromEntry
Defined in
src/sdk/instruments/BasePublishers.ts:357
handleSubscribedTopic
▸ handleSubscribedTopic(topic): void
Handles when an event bus topic is subscribed to for the first time.
Parameters
| Name | Type | Description |
|---|---|---|
topic | string | The subscribed topic. |
Returns
void
Inherited from
SimVarPublisher.handleSubscribedTopic
Defined in
src/sdk/instruments/BasePublishers.ts:193
isPublishing
▸ isPublishing(): boolean
Tells whether or not the publisher is currently active.
Returns
boolean
True if the publisher is active, false otherwise.
Inherited from
Defined in
src/sdk/instruments/BasePublishers.ts:45
onTopicSubscribed
▸ onTopicSubscribed(topic): void
Responds to when one of this publisher's topics is subscribed to for the first time.
Parameters
| Name | Type | Description |
|---|---|---|
topic | "elec_bus_main_v" | "elec_bus_main_a" | "elec_master_battery" | "elec_circuit_avionics_on" | "elec_bat_v" | "elec_bat_a" | "elec_ext_power_available" | "elec_ext_power_on" | "elec_apu_gen_active" | "elec_apu_gen_switch" | "elec_eng_gen_switch" | "elec_circuit_on" | "elec_circuit_switch_on" | "elec_circuit_navcom1_on" | "elec_circuit_navcom2_on" | "elec_circuit_navcom3_on" | "elec_av1_bus" | "elec_av2_bus" | "elec_bus_avionics_v" | "elec_bus_avionics_a" | "elec_bus_genalt_1_v" | "elec_bus_genalt_2_v" | "elec_bus_genalt_3_v" | "elec_bus_genalt_4_v" | "elec_bus_genalt_5_v" | "elec_bus_genalt_6_v" | "elec_bus_genalt_1_a" | "elec_bus_genalt_2_a" | "elec_bus_genalt_3_a" | "elec_bus_genalt_4_a" | "elec_bus_genalt_5_a" | "elec_bus_genalt_6_a" | `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 topic that was subscribed to. |
Returns
void
Inherited from
SimVarPublisher.onTopicSubscribed
Defined in
src/sdk/instruments/BasePublishers.ts:279
onUpdate
▸ onUpdate(): void
Publish all subscribed data points to the bus.
Returns
void
Overrides
Defined in
src/sdk/instruments/Electrical.ts:201
publish
▸ publish<K>(topic, data, sync?, isCached?): void
Publish a message if publishing is acpive
Type parameters
| Name | Type |
|---|---|
K | extends 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}` |
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
topic | K | undefined | The topic key to publish to. |
data | ElectricalEvents[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
Defined in
src/sdk/instruments/BasePublishers.ts:63
publishTopic
▸ publishTopic(topic): void
Publishes data to the event bus for a topic.
Parameters
| Name | Type | Description |
|---|---|---|
topic | "elec_bus_main_v" | "elec_bus_main_a" | "elec_master_battery" | "elec_circuit_avionics_on" | "elec_bat_v" | "elec_bat_a" | "elec_ext_power_available" | "elec_ext_power_on" | "elec_apu_gen_active" | "elec_apu_gen_switch" | "elec_eng_gen_switch" | "elec_circuit_on" | "elec_circuit_switch_on" | "elec_circuit_navcom1_on" | "elec_circuit_navcom2_on" | "elec_circuit_navcom3_on" | "elec_av1_bus" | "elec_av2_bus" | "elec_bus_avionics_v" | "elec_bus_avionics_a" | "elec_bus_genalt_1_v" | "elec_bus_genalt_2_v" | "elec_bus_genalt_3_v" | "elec_bus_genalt_4_v" | "elec_bus_genalt_5_v" | "elec_bus_genalt_6_v" | "elec_bus_genalt_1_a" | "elec_bus_genalt_2_a" | "elec_bus_genalt_3_a" | "elec_bus_genalt_4_a" | "elec_bus_genalt_5_a" | "elec_bus_genalt_6_a" | `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 topic to publish. |
Returns
void
Inherited from
Defined in
src/sdk/instruments/BasePublishers.ts:325
resolveIndexedSimVar
▸ resolveIndexedSimVar(topic, entry, index): undefined | string
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
| Name | Type | Description |
|---|---|---|
topic | "elec_bus_main_v" | "elec_bus_main_a" | "elec_master_battery" | "elec_circuit_avionics_on" | "elec_bat_v" | "elec_bat_a" | "elec_ext_power_available" | "elec_ext_power_on" | "elec_apu_gen_active" | "elec_apu_gen_switch" | "elec_eng_gen_switch" | "elec_circuit_on" | "elec_circuit_switch_on" | "elec_circuit_navcom1_on" | "elec_circuit_navcom2_on" | "elec_circuit_navcom3_on" | "elec_av1_bus" | "elec_av2_bus" | "elec_bus_avionics_v" | "elec_bus_avionics_a" | "elec_bus_genalt_1_v" | "elec_bus_genalt_2_v" | "elec_bus_genalt_3_v" | "elec_bus_genalt_4_v" | "elec_bus_genalt_5_v" | "elec_bus_genalt_6_v" | "elec_bus_genalt_1_a" | "elec_bus_genalt_2_a" | "elec_bus_genalt_3_a" | "elec_bus_genalt_4_a" | "elec_bus_genalt_5_a" | "elec_bus_genalt_6_a" | `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 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
Defined in
src/sdk/instruments/BasePublishers.ts:250
setAv1Bus
▸ setAv1Bus(logicElement): void
Sets the logic element to use for the avionics 1 bus.
Parameters
| Name | Type | Description |
|---|---|---|
logicElement | CompositeLogicXMLElement | The logic element to use. |
Returns
void
Defined in
src/sdk/instruments/Electrical.ts:219
setAv2Bus
▸ setAv2Bus(logicElement): void
Sets the logic element to use for the avionics 2 bus.
Parameters
| Name | Type | Description |
|---|---|---|
logicElement | CompositeLogicXMLElement | The logic element to use. |
Returns
void
Defined in
src/sdk/instruments/Electrical.ts:227
startPublish
▸ startPublish(): void
Start publishing.
Returns
void
Inherited from
Defined in
src/sdk/instruments/BasePublishers.ts:30
stopPublish
▸ stopPublish(): void
Stop publishing.
Returns
void
Inherited from
Defined in
src/sdk/instruments/BasePublishers.ts:37
subscribe
▸ subscribe(data): void
NOOP - For backwards compatibility.
Parameters
| Name | Type | Description |
|---|---|---|
data | 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}` | Key of the event type in the simVarMap |
Returns
void
Deprecated
Inherited from
Defined in
src/sdk/instruments/BasePublishers.ts:298
tryMatchIndexedSubscribedTopic
▸ tryMatchIndexedSubscribedTopic(topic): void
Checks if a subscribed topic matches one of this publisher's indexed topics, and if so resolves and starts publishing the indexed topic.
Parameters
| Name | Type | Description |
|---|---|---|
topic | string | The subscribed topic to check. |
Returns
void
Inherited from
SimVarPublisher.tryMatchIndexedSubscribedTopic
Defined in
src/sdk/instruments/BasePublishers.ts:208
unsubscribe
▸ unsubscribe(data): void
NOOP - For backwards compatibility.
Parameters
| Name | Type | Description |
|---|---|---|
data | 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}` | Key of the event type in the simVarMap |
Returns
void
Deprecated
Inherited from
Defined in
src/sdk/instruments/BasePublishers.ts:308