Class RobotMoveService

RobotMoveService handles movement screen navigation

Hierarchy (View Summary)

MessageInvokerService
- RobotMoveService

Index

Constructors

Properties

communicationChannel eventTarget

Methods

autoMove openMoveScreen postAndAwait postAndObserve request requestObserve

Constructors

constructor

new RobotMoveService(eventTarget: EventTargetOrCommChannel): RobotMoveService
Parameters
- eventTarget: EventTargetOrCommChannel
Returns RobotMoveService
Overrides MessageInvokerService.constructor
- Defined in node_modules/@universal-robots/contribution-api/lib/services/robot/robot-move.service.d.ts:14

Properties

communicationChannel

communicationChannel: CommunicationChannel

`Readonly`eventTarget

eventTarget: EventTargetOrCommChannel

Methods

autoMove

autoMove(targetPosition: JointPositions | Waypoint): Promise<void>
Opens the autoMove screen
Parameters
- targetPosition: JointPositions | Waypoint
  Joint vector to move to
Returns Promise<void>
- Defined in node_modules/@universal-robots/contribution-api/lib/services/robot/robot-move.service.d.ts:24

openMoveScreen

openMoveScreen(options: MoveScreenOptions): Promise<Waypoint | undefined>
Opens the move screen and returns the selected position of the robot. Returns undefined if cancel is selected
Parameters
- options: MoveScreenOptions
  Move screen options
Returns Promise<Waypoint | undefined>
- Defined in node_modules/@universal-robots/contribution-api/lib/services/robot/robot-move.service.d.ts:19

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