Class SmartSkillExecutionService

Service that handles executing smart skill instances

Hierarchy (View Summary)

MessageInvokerService
- SmartSkillExecutionService

Index

Constructors

Properties

communicationChannel eventTarget

Methods

activeSmartSkill executeInstance executionAllowed postAndAwait postAndObserve request requestObserve stopInstance waitForActiveSmartSkillToStop

Constructors

constructor

new SmartSkillExecutionService(
eventTarget: EventTargetOrCommChannel,
): SmartSkillExecutionService
Parameters
- eventTarget: EventTargetOrCommChannel
Returns SmartSkillExecutionService
Overrides MessageInvokerService.constructor
- Defined in node_modules/@universal-robots/contribution-api/lib/services/smart-skill-execution.service.d.ts:14

Properties

communicationChannel

communicationChannel: CommunicationChannel

`Readonly`eventTarget

eventTarget: EventTargetOrCommChannel

Methods

activeSmartSkill

activeSmartSkill(): Observable<SmartSkillInstance | undefined>
Get active smart skill observable

Returns Observable<SmartSkillInstance | undefined>
- Defined in node_modules/@universal-robots/contribution-api/lib/services/smart-skill-execution.service.d.ts:28

executeInstance

executeInstance(instance: SmartSkillInstance): Promise<void>
Execute the smart skill instance
Parameters
- instance: SmartSkillInstance
  Smart skill instance to execute
Returns Promise<void>
- Defined in node_modules/@universal-robots/contribution-api/lib/services/smart-skill-execution.service.d.ts:19

executionAllowed

executionAllowed(): Observable<boolean>
Will be false if 3PE is disengaged, robot is powered off or Freedrive is enabled.

Returns Observable<boolean>
- Defined in node_modules/@universal-robots/contribution-api/lib/services/smart-skill-execution.service.d.ts:32

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

stopInstance

stopInstance(instance: SmartSkillInstance): Promise<void>
Stop the smart skill instance
Parameters
- instance: SmartSkillInstance
  Smart skill instance to stop
Returns Promise<void>
- Defined in node_modules/@universal-robots/contribution-api/lib/services/smart-skill-execution.service.d.ts:24

waitForActiveSmartSkillToStop

waitForActiveSmartSkillToStop(timeoutMs?: number): Promise<void>
Wait for the active smart skill to stop
Parameters
- OptionaltimeoutMs: number
Returns Promise<void>
- Defined in node_modules/@universal-robots/contribution-api/lib/services/smart-skill-execution.service.d.ts:36