Class: ElectricalPublisher

Defined in: src/sdk/instruments/Electrical.ts:187

A publisher for electrical information.

Extends

• BasePublisher<ElectricalEvents>

Constructors

Constructor

new ElectricalPublisher(bus, pacer?): ElectricalPublisher

Defined in: src/sdk/instruments/Electrical.ts:203

Create an ElectricalPublisher

Parameters

Parameter	Type	Description
bus	EventBus	The EventBus to publish to
pacer?	PublishPacer<ElectricalEvents>	An optional pacer to use to control the rate of publishing

Returns

ElectricalPublisher

Overrides

BasePublisher.constructor

Properties

bus

protected readonly bus: EventBus

Defined in: src/sdk/instruments/BasePublishers.ts:10

Inherited from

BasePublisher.bus

---

pacer

protected readonly pacer: undefined | PublishPacer<ElectricalEvents>

Defined in: src/sdk/instruments/BasePublishers.ts:13

Inherited from

BasePublisher.pacer

---

publishActive

protected publishActive: boolean

Defined in: src/sdk/instruments/BasePublishers.ts:12

Inherited from

BasePublisher.publishActive

---

publisher

protected readonly publisher: Publisher<ElectricalEvents>

Defined in: src/sdk/instruments/BasePublishers.ts:11

Inherited from

BasePublisher.publisher

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

BasePublisher.isPublishing

---

onUpdate()

onUpdate(): void

Defined in: src/sdk/instruments/Electrical.ts:319

A callback called when the publisher receives an update cycle.

Returns

void

Overrides

BasePublisher.onUpdate

---

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 "elec_master_battery" | "elec_bat_v" | "elec_bat_load" | "elec_bat_soc" | "elec_ext_power_available" | "elec_ext_power_on" | "elec_ext_power_v" | "elec_ext_power_a" | "elec_apu_gen_active" | "elec_apu_gen_switch" | "elec_eng_gen_switch" | "elec_bus_avionics_v" | "elec_bus_avionics_a" | "elec_circuit_navcom1_on" | "elec_circuit_navcom2_on" | "elec_circuit_navcom3_on" | "elec_circuit_transponder_on" | "elec_av1_bus" | "elec_av2_bus" | `elec_bus_v_${number}` | `elec_bus_a_${number}` | `elec_bus_main_v_${number}` | `elec_bus_main_a_${number}` | `elec_bus_genalt_v_${number}` | `elec_bus_genalt_a_${number}` | `elec_circuit_on_${number}` | `elec_circuit_switch_on_${number}` | `elec_circuit_v_${number}` | `elec_circuit_a_${number}` | `elec_circuit_avionics_on_${number}` | `elec_circuit_com_on_${number}` | `elec_circuit_nav_on_${number}` | `elec_line_connection_on_${number}` | `elec_line_breaker_pulled_${number}` | `elec_gen_switch_on_${number}` | `elec_gen_active_${number}` | `elec_gen_v_${number}` | `elec_gen_a_${number}` | `elec_master_battery_${number}` | `elec_bat_v_${number}` | `elec_bat_load_${number}` | `elec_bat_soc_${number}` | `elec_ext_power_available_${number}` | `elec_ext_power_on_${number}` | `elec_ext_power_v_${number}` | `elec_ext_power_a_${number}` | `elec_apu_gen_active_${number}` | `elec_apu_gen_switch_${number}` | `elec_eng_gen_switch_${number}`

Parameters

Parameter	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

BasePublisher.publish

---

setAv1Bus()

setAv1Bus(logicElement): void

Defined in: src/sdk/instruments/Electrical.ts:348

Sets the logic element to use for the avionics 1 bus.

Parameters

Parameter	Type	Description
logicElement	CompositeLogicXMLElement	The logic element to use.

Returns

void

---

setAv2Bus()

setAv2Bus(logicElement): void

Defined in: src/sdk/instruments/Electrical.ts:356

Sets the logic element to use for the avionics 2 bus.

Parameters

Parameter	Type	Description
logicElement	CompositeLogicXMLElement	The logic element to use.

Returns

void

---

startPublish()

startPublish(): void

Defined in: src/sdk/instruments/Electrical.ts:305

Start publishing.

Returns

void

Overrides

BasePublisher.startPublish

---

stopPublish()

stopPublish(): void

Defined in: src/sdk/instruments/Electrical.ts:312

Stop publishing.

Returns

void

Overrides

BasePublisher.stopPublish