Skip to main content

Class: StallWarningPublisher

Defined in: src/sdk/data/StallWarningPublisher.ts:20

A publisher than handles publishing a debounced stall warning event based on an input AoA.

Extends​

Constructors​

Constructor​

new StallWarningPublisher(bus, aoaThreshold, debounceMs, aoa?): StallWarningPublisher

Defined in: src/sdk/data/StallWarningPublisher.ts:36

Creates an instance of the StallWarningPublisher. Requires the aoa (if not provided) and on_ground events from `AdcEvents``.

Parameters​

ParameterTypeDefault valueDescription
busEventBusundefinedThe event bus to use with this instance.
aoaThresholdnumberundefinedThe AoA stall warning threshold, where 1 is 100% of stall AoA.
debounceMsnumber500The amount of time, in milliseconds, to debounce the stall warning. Defaults to 500 ms.
aoa?Subscribable<number>undefinedAn optional subscribable that provides the AoA value, in degrees.

Returns​

StallWarningPublisher

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: PublishPacer<StallWarningEvents> | undefined

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<StallWarningEvents>

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/data/StallWarningPublisher.ts:46

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 "stall_warning_on"

Parameters​

ParameterTypeDefault valueDescription
topicKundefinedThe topic key to publish to.
dataStallWarningEvents[K]undefinedThe data type for chosen topic.
syncbooleanfalseWhether or not the event should be synced to other instruments. Defaults to false.
isCachedbooleantrueWhether or not the event should be cached. Defaults to true.

Returns​

void

Inherited from​

BasePublisher.publish


startPublish()​

startPublish(): void

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

Start publishing.

Returns​

void

Inherited from​

BasePublisher.startPublish


stopPublish()​

stopPublish(): void

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

Stop publishing.

Returns​

void

Inherited from​

BasePublisher.stopPublish