Class: StallWarningPublisher
A publisher than handles publishing a debounced stall warning event based on an input AoA.
Hierarchy
BasePublisher
<StallWarningEvents
>↳
StallWarningPublisher
Constructors
constructor
• new StallWarningPublisher(bus
, aoaThreshold
, debounceMs?
, aoa?
): StallWarningPublisher
Creates an instance of the StallWarningPublisher. Requires the aoa
(if not provided) and on_ground
events from `AdcEvents``.
Parameters
Name | 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
Overrides
Defined in
src/sdk/data/StallWarningPublisher.ts:36
Properties
bus
• Protected
Readonly
bus: EventBus
Inherited from
Defined in
src/sdk/instruments/BasePublishers.ts:10
pacer
• Protected
Readonly
pacer: undefined
| PublishPacer
<StallWarningEvents
>
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
<StallWarningEvents
>
Inherited from
Defined in
src/sdk/instruments/BasePublishers.ts:11
Methods
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
onUpdate
▸ onUpdate(): void
A callback called when the publisher receives an update cycle.
Returns
void
Overrides
Defined in
src/sdk/data/StallWarningPublisher.ts:46
publish
▸ publish<K
>(topic
, data
, sync?
, isCached?
): void
Publish a message if publishing is acpive
Type parameters
Name | Type |
---|---|
K | extends "stall_warning_on" |
Parameters
Name | 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
Defined in
src/sdk/instruments/BasePublishers.ts:63
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