Class SignalService

A service for setting signal properties such as their label or preset

Hierarchy (View Summary)

MessageInvokerService
- SignalService

Index

Constructors

constructor

new SignalService(
eventTarget: EventTargetOrCommChannel,
sourceID: string,
): SignalService
Parameters
- eventTarget: EventTargetOrCommChannel
- sourceID: string
Returns SignalService
Overrides MessageInvokerService.constructor
- Defined in node_modules/@universal-robots/contribution-api/lib/services/source/signal.service.d.ts:13

Properties

communicationChannel

communicationChannel: CommunicationChannel

`Readonly`eventTarget

eventTarget: EventTargetOrCommChannel

sourceID

sourceID: string

Methods

postAndAwait

postAndAwait<T>(type: string, data?: any): Promise<T>
returns a reply promise to the specified message
Type Parameters
- T
Parameters
- type: string
  The type of message being sent
- Optionaldata: any
  The message data
Returns Promise<T>
Inherited from MessageInvokerService.postAndAwait
- Defined in node_modules/@universal-robots/contribution-api/lib/services/message-invoker.d.ts:192

postAndObserve

postAndObserve<T>(type: string, data?: any): Observable<T>
returns an observable that will emit any messages replied to the specified message
Type Parameters
- T
Parameters
- type: string
  The type of message being sent
- Optionaldata: any
  The message data
Returns Observable<T>
Inherited from MessageInvokerService.postAndObserve
- Defined in node_modules/@universal-robots/contribution-api/lib/services/message-invoker.d.ts:199

request

request<T>(type: string, data?: any): Promise<T>
returns a reply promise for the requested message
Type Parameters
- T
Parameters
- type: string
  The type of message being sent
- Optionaldata: any
  The message data
Returns Promise<T>
Inherited from MessageInvokerService.request
- Defined in node_modules/@universal-robots/contribution-api/lib/services/message-invoker.d.ts:178

requestObserve

requestObserve<T>(type: string, data?: any): Observable<T>
returns an observable that will emit any messages replied to the requested message
Type Parameters
- T
Parameters
- type: string
  The type of message being sent
- Optionaldata: any
  The message data
Returns Observable<T>
Inherited from MessageInvokerService.requestObserve
- Defined in node_modules/@universal-robots/contribution-api/lib/services/message-invoker.d.ts:185

setDigitalInPreset

setDigitalInPreset(signalID: string, preset: DigitalInPreset): Promise<void>
Set the Preset Action for a given Digital-In signal
Parameters
- signalID: string
  ID of the signal to set the preset for
- preset: DigitalInPreset
  the preset to set
Returns Promise<void>
Deprecated
Source contributions will be responsible for handling presets themselves
- Defined in node_modules/@universal-robots/contribution-api/lib/services/source/signal.service.d.ts:32

updateSignalAnalogDomain

updateSignalAnalogDomain(
signalID: string,
analogDomainValueEnum: SignalAnalogDomainValueEnum,
): Promise<void>
Update the Analog Domain for a specific signal id
Parameters
- signalID: string
  id for the signal being changed
- analogDomainValueEnum: SignalAnalogDomainValueEnum
  the domain to set
Returns Promise<void>
Deprecated
should be handled by the individual contribution
- Defined in node_modules/@universal-robots/contribution-api/lib/services/source/signal.service.d.ts:25

updateSignalLabel

updateSignalLabel(signalID: string, label: string): Promise<void>
Update the label for a specific signal id
Parameters
- signalID: string
  id for the signal being labelled
- label: string
  the new label for the signal
Returns Promise<void>
Deprecated
Source contributions will be responsible for labels for signals directly
- Defined in node_modules/@universal-robots/contribution-api/lib/services/source/signal.service.d.ts:19

Class SignalService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SignalService

Properties

communicationChannel

ReadonlyeventTarget

sourceID

Methods

postAndAwait

Type Parameters

Parameters

Returns Promise<T>

postAndObserve

Type Parameters

Parameters

Returns Observable<T>

request

Type Parameters

Parameters

Returns Promise<T>

requestObserve

Type Parameters

Parameters

Returns Observable<T>

setDigitalInPreset

Parameters

Returns Promise<void>

Deprecated

updateSignalAnalogDomain

Parameters

Returns Promise<void>

Deprecated

updateSignalLabel

Parameters

Returns Promise<void>

Deprecated

Settings

On This Page

`Readonly`eventTarget