Class SourceService

Service for getting information about Sources and Signals

Hierarchy

SourceService

Index

Constructors

constructor

new SourceService(eventTarget: EventTarget): SourceService
Parameters
- eventTarget: EventTarget
Returns SourceService
- Defined in lib/services/source/source.service.d.ts:18

Properties

`Private` `Readonly` eventTarget

eventTarget: any

Methods

generateGetSignalScript

generateGetSignalScript(sourceID: string, signalID: string): Promise<string>
Returns the generated script code for getting the value of a given signal

Deprecated
use getGetSignalScript instead
Parameters
- sourceID: string
  
  The ID of the source containing the signal to get
- signalID: string
  
  The ID of the signal to get
Returns Promise<string>
- Defined in lib/services/source/source.service.d.ts:74

generateSetSignalScript

generateSetSignalScript(sourceID: string, signalID: string, value: SignalValue): Promise<string>
Returns the generated script code for setting the signal to the given value

Deprecated
use getSetSignalScript instead
Parameters
- sourceID: string
  
  The ID of the source containing the signal to set
- signalID: string
  
  The ID of the signal to set
- value: SignalValue
  
  The value to set the signal to - for digital values use 0 or 1, for registers use only integers, for analog values use any float
Returns Promise<string>
- Defined in lib/services/source/source.service.d.ts:59

getAnalogSignalDomains

getAnalogSignalDomains(sourceID: string): Promise<{
[signalID: string]: SignalAnalogDomainValueEnum;
}>
Returns an object literal containing a mapping of SignalIDs -> AnalogDomains

Deprecated
should be handled by the individual contribution
Parameters
- sourceID: string
  
  The ID of the Source for which to get Domain data
Returns Promise<{
[signalID: string]: SignalAnalogDomainValueEnum;
}>
- Defined in lib/services/source/source.service.d.ts:87

getGetSignalScript

getGetSignalScript(sourceGroupID: string, sourceID: string, signalID: string): Promise<string>
Returns the generated script code for getting the value of a given signal
Parameters
- sourceGroupID: string
  
  The Source group, containing the source to provide events for
- sourceID: string
  
  The ID of the source containing the signal to get
- signalID: string
  
  The ID of the signal to get
Returns Promise<string>
- Defined in lib/services/source/source.service.d.ts:81

getSetSignalScript

getSetSignalScript(sourceGroupID: string, sourceID: string, signalID: string, value: SignalValue): Promise<string>
Returns the generated script code for setting the signal to the given value
Parameters
- sourceGroupID: string
  
  The Source group, containing the source and signal to provide script for
- sourceID: string
  
  The ID of the source containing the signal to set
- signalID: string
  
  The ID of the signal to set
- value: SignalValue
  
  The value to set the signal to - for digital values use 0 or 1, for registers use only integers, for analog values use any float
Returns Promise<string>
- Defined in lib/services/source/source.service.d.ts:67

getSignalLabels

getSignalLabels(sourceID: string): Promise<{
[signalId: string]: string;
}>
Returns an object literal containing a mapping of SignalIDs -> Labels

Deprecated
Source contributions will be responsible for providing labels for signals directly
Parameters
- sourceID: string
  
  The ID of the Source for which to get the Label mappings
Returns Promise<{
[signalId: string]: string;
}>
- Defined in lib/services/source/source.service.d.ts:111

getSignalPresets

getSignalPresets(sourceID: string): Promise<SourcePresets>
Returns an object literal containing a mapping of SignalIDs -> Presets

Deprecated
Source contributions will be responsible for handling presets themselves
Parameters
- sourceID: string
  
  The ID of the Source for which to get the Preset mappings
Returns Promise<SourcePresets>
- Defined in lib/services/source/source.service.d.ts:119

getSignalUpdates

getSignalUpdates(sourceID: string, filter?: Partial<Pick<Signal, "direction" | "valueType">>): Observable<SignalEvent>
Returns an Observable providing Signal events

Deprecated
use getSourceUpdates instead
Parameters
- sourceID: string
  
  The Source containing the Signals to provide events for
- Optional filter: Partial<Pick<Signal, "direction" | "valueType">>
  
  SignalFilter used to filter only events for Signals which match the filter
Returns Observable<SignalEvent>
- Defined in lib/services/source/source.service.d.ts:44

getSignals

getSignals(sourceID: string, filter?: Partial<Pick<Signal, "direction" | "valueType">>): Promise<Signal[]>
Returns the list of Signals in a Source

Deprecated
use getSourceSignals instead
Parameters
- sourceID: string
  
  The Source to list Signals for
- Optional filter: Partial<Pick<Signal, "direction" | "valueType">>
  
  SignalFilter used to filter only Signals which match the filter
Returns Promise<Signal[]>
- Defined in lib/services/source/source.service.d.ts:30

getSourceSignals

getSourceSignals(sourceGroupID: string, sourceID: string, filter?: Partial<Pick<Signal, "direction" | "valueType">>): Promise<Signal[]>
Returns the list of Signals in a Source
Parameters
- sourceGroupID: string
  
  The Source group, containing the source to provide signals for
- sourceID: string
  
  The Source to list Signals for
- Optional filter: Partial<Pick<Signal, "direction" | "valueType">>
  
  SignalFilter used to filter only Signals which match the filter
Returns Promise<Signal[]>
- Defined in lib/services/source/source.service.d.ts:37

getSourceUpdates

getSourceUpdates(sourceGroupID: string, sourceID: string, filter?: Partial<Pick<Signal, "direction" | "valueType">>): Observable<SignalEvent>
Returns an Observable providing Signal events
Parameters
- sourceGroupID: string
  
  The Source group, containing the source to provide events for
- sourceID: string
  
  The Source containing the Signals to provide events for
- Optional filter: Partial<Pick<Signal, "direction" | "valueType">>
  
  SignalFilter used to filter only events for Signals which match the filter
Returns Observable<SignalEvent>
- Defined in lib/services/source/source.service.d.ts:51

getSources

getSources(filter?: Partial<Pick<Signal, "direction" | "valueType">>): Promise<string[]>
Returns the ID's of Sources that are available to the application
Parameters
- Optional filter: Partial<Pick<Signal, "direction" | "valueType">>
  
  SignalFilter used to filter only Sources which contain Signals matching the filter
Returns Promise<string[]>
- Defined in lib/services/source/source.service.d.ts:23

setSignalValue

setSignalValue(sourceID: string, signalID: string, value: SignalBooleanValue | SignalFloatValue): Promise<void>
Sets a value on a signal

Deprecated
use setSourceSignalValue instead
Parameters
- sourceID: string
  
  The ID of the Source, containing the Signal to set
- signalID: string
  
  The ID of the Signal to set
- value: SignalBooleanValue | SignalFloatValue
  
  The value to set
Returns Promise<void>
- Defined in lib/services/source/source.service.d.ts:97

setSourceSignalValue

setSourceSignalValue(sourceGroupID: string, sourceID: string, signalID: string, value: SignalBooleanValue | SignalFloatValue): Promise<void>
Sets a value on a signal
Parameters
- sourceGroupID: string
  
  The Source group, containing the source to provide events for
- sourceID: string
  
  The ID of the Source, containing the Signal to set
- signalID: string
  
  The ID of the Signal to set
- value: SignalBooleanValue | SignalFloatValue
  
  The value to set
Returns Promise<void>
- Defined in lib/services/source/source.service.d.ts:105

Class SourceService

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

eventTarget: EventTarget

Returns SourceService

Properties

Private Readonly eventTarget

Methods

generateGetSignalScript

Deprecated

Parameters

sourceID: string

signalID: string

Returns Promise<string>

generateSetSignalScript

Deprecated

Parameters

sourceID: string

signalID: string

value: SignalValue

Returns Promise<string>

getAnalogSignalDomains

Deprecated

Parameters

sourceID: string

Returns Promise<{ [signalID: string]: SignalAnalogDomainValueEnum; }>

getGetSignalScript

Parameters

sourceGroupID: string

sourceID: string

signalID: string

Returns Promise<string>

getSetSignalScript

Parameters

sourceGroupID: string

sourceID: string

signalID: string

value: SignalValue

Returns Promise<string>

getSignalLabels

Deprecated

Parameters

sourceID: string

Returns Promise<{ [signalId: string]: string; }>

getSignalPresets

Deprecated

Parameters

sourceID: string

Returns Promise<SourcePresets>

getSignalUpdates

Deprecated

Parameters

sourceID: string

Optional filter: Partial<Pick<Signal, "direction" | "valueType">>

Returns Observable<SignalEvent>

getSignals

Deprecated

Parameters

sourceID: string

Optional filter: Partial<Pick<Signal, "direction" | "valueType">>

Returns Promise<Signal[]>

getSourceSignals

Parameters

sourceGroupID: string

sourceID: string

Optional filter: Partial<Pick<Signal, "direction" | "valueType">>

Returns Promise<Signal[]>

getSourceUpdates

Parameters

sourceGroupID: string

sourceID: string

Optional filter: Partial<Pick<Signal, "direction" | "valueType">>

Returns Observable<SignalEvent>

getSources

`Private` `Readonly` eventTarget

Returns Promise<{
[signalID: string]: SignalAnalogDomainValueEnum;
}>

Returns Promise<{
[signalId: string]: string;
}>

`Optional` filter: Partial<Pick<Signal, "direction" | "valueType">>

`Optional` filter: Partial<Pick<Signal, "direction" | "valueType">>

`Optional` filter: Partial<Pick<Signal, "direction" | "valueType">>

`Optional` filter: Partial<Pick<Signal, "direction" | "valueType">>

`Optional` filter: Partial<Pick<Signal, "direction" | "valueType">>