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
Parameter | Type | Default value | Description |
---|---|---|---|
bus | EventBus | undefined | The event bus to use with this instance. |
aoaThreshold | number | undefined | The AoA stall warning threshold, where 1 is 100% of stall AoA. |
debounceMs | number | 500 | The amount of time, in milliseconds, to debounce the stall warning. Defaults to 500 ms. |
aoa? | Subscribable <number > | undefined | An optional subscribable that provides the AoA value, in degrees. |
Returns
StallWarningPublisher
Overrides
Properties
bus
protected
readonly
bus:EventBus
Defined in: src/sdk/instruments/BasePublishers.ts:10
Inherited from
pacer
protected
readonly
pacer:undefined
|PublishPacer
<StallWarningEvents
>
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
<StallWarningEvents
>
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/data/StallWarningPublisher.ts:46
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 "stall_warning_on" |
Parameters
Parameter | Type | Default value | Description |
---|---|---|---|
topic | K | undefined | The topic key to publish to. |
data | StallWarningEvents [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/BasePublishers.ts:30
Start publishing.
Returns
void
Inherited from
stopPublish()
stopPublish():
void
Defined in: src/sdk/instruments/BasePublishers.ts:37
Stop publishing.
Returns
void