Class SourceService

constructor

• new SourceService(eventTarget: EventTargetOrCommChannel): SourceService

  Parameters

  • eventTarget: EventTargetOrCommChannel

  Returns SourceService

ReadonlyeventTarget

generateGetSignalScript

• generateGetSignalScript(sourceID: string, signalID: string): Promise<string>

  Returns the generated script code for getting the value of a given signal

  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>

  Deprecated

  use getGetSignalScript instead

generateSetSignalScript

• generateSetSignalScript(
      sourceID: string,
      signalID: string,
      value: SignalValue,
  ): Promise<string>

  Returns the generated script code for setting the signal to the given value

  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>

  Deprecated

  use getSetSignalScript instead

getAnalogSignalDomains

• getAnalogSignalDomains(
      sourceID: string,
  ): Promise<{ [signalID: string]: SignalAnalogDomainValueEnum }>

  Returns an object literal containing a mapping of SignalIDs -> AnalogDomains

  Parameters

  • sourceID: string

    The ID of the Source for which to get Domain data

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

  Deprecated

  should be handled by the individual contribution

getGetSignalScript

• getGetSignalScript(
      groupId: string,
      sourceId: string,
      signalId: string,
  ): Promise<string>

  Returns the generated script code for getting the value of a given signal

  Parameters

  • groupId: 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>

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>

getSignalLabels

• getSignalLabels(sourceID: string): Promise<{ [signalId: string]: string }>

  Returns an object literal containing a mapping of SignalIDs -> Labels

  Parameters

  • sourceID: string

    The ID of the Source for which to get the Label mappings

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

  Deprecated

  Source contributions will be responsible for providing labels for signals directly

getSignalPresets

• getSignalPresets(sourceID: string): Promise<SourcePresets>

  Returns an object literal containing a mapping of SignalIDs -> Presets

  Parameters

  • sourceID: string

    The ID of the Source for which to get the Preset mappings

  Returns Promise<SourcePresets>

  Deprecated

  Source contributions will be responsible for handling presets themselves

getSignals

• getSignals(
      sourceID: string,
      filter?: Partial<Pick<Signal, "direction" | "valueType">>,
  ): Promise<Signal[]>

  Returns the list of Signals in a Source

  Parameters

  • sourceID: string

    The Source to list Signals for

  • Optionalfilter: Partial<Pick<Signal, "direction" | "valueType">>

    SignalFilter used to filter only Signals which match the filter

  Returns Promise<Signal[]>

  Deprecated

  use getSourceSignals instead

getSignalsDomainData

• getSignalsDomainData(
      groupId: string,
      sourceId: string,
  ): Promise<Record<string, ValueRange<string>>>

  Returns info about the signals for a given source

  Parameters

  • groupId: string
  • sourceId: string

  Returns Promise<Record<string, ValueRange<string>>>

getSignalUpdates

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

  Returns an Observable providing Signal events

  Parameters

  • sourceID: string

    The Source containing the Signals to provide events for

  • Optionalfilter: Partial<Pick<Signal, "direction" | "valueType">>

    SignalFilter used to filter only events for Signals which match the filter

  Returns Observable<SignalEvent>

  Deprecated

  use getSourceUpdates instead

getSources

• getSources(
      filter?: Partial<Pick<Signal, "direction" | "valueType">>,
  ): Promise<string[]>

  Returns the ID's of Sources that are available to the application

  Parameters

  • Optionalfilter: Partial<Pick<Signal, "direction" | "valueType">>

    SignalFilter used to filter only Sources which contain Signals matching the filter

  Returns Promise<string[]>

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

  • Optionalfilter: Partial<Pick<Signal, "direction" | "valueType">>

    SignalFilter used to filter only events for Signals which match the filter

  Returns Observable<SignalEvent>

setSignalValue

• setSignalValue(
      sourceID: string,
      signalID: string,
      value: SignalBooleanValue | SignalFloatValue,
  ): Promise<void>

  Sets a value on a signal

  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>

  Deprecated

  use setSourceSignalValue instead

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>

sourceNodeLabel

• sourceNodeLabel(groupId: string): Observable<string | undefined>

  Returns the source node label for the griven groupId

  Parameters

  • groupId: string

  Returns Observable<string | undefined>

sourceNodeLabels

• sourceNodeLabels(): Observable<{ [groupId: string]: string }>

  Returns the map of source node labels

  Returns Observable<{ [groupId: string]: string }>

sources

• sources(
      filter?: Partial<Pick<Signal, "direction" | "valueType">>,
  ): Observable<{ [groupId: string]: Source[] }>

  Returns the map of Sources

  Parameters

  • Optionalfilter: Partial<Pick<Signal, "direction" | "valueType">>

  Returns Observable<{ [groupId: string]: Source[] }>

sourceSignals

• sourceSignals(
      sourceGroupID: string,
      sourceID: string,
      filter?: Partial<Pick<Signal, "direction" | "valueType">>,
  ): Observable<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

  • Optionalfilter: Partial<Pick<Signal, "direction" | "valueType">>

    SignalFilter used to filter only Signals which match the filter

  Returns Observable<Signal[]>

validateGetSignal

• validateGetSignal(
      groupId: string,
      sourceId: string,
      signalId: string,
      value: SignalValue,
      operator: string,
  ): Promise<ValidationResponse>

  Performs validation on a new value that will be used in a get script

  Parameters

  • groupId: string

    The contribution groupId

  • sourceId: string

    The contribution sourceId

  • signalId: string

    The contribution signalId

  • value: SignalValue

    The value that will be got

  • operator: string

    The operator on the value that will be got

  Returns Promise<ValidationResponse>

validateSetSignal

• validateSetSignal(
      groupId: string,
      sourceId: string,
      signalId: string,
      value: SignalValue,
  ): Promise<ValidationResponse>

  Performs validation on a new value that will be used in a set script

  Parameters

  • groupId: string

    The contribution groupId

  • sourceId: string

    The contribution sourceId

  • signalId: string

    The contribution signalId

  • value: SignalValue

    The value that will be set

  Returns Promise<ValidationResponse>