Class RobotInfoService

Provides access to information on the robot

Hierarchy (View Summary)

MessageInvokerService
- RobotInfoService

Index

Constructors

Properties

communicationChannel eventTarget

Methods

getRobotType getSerialNumber is3PEStop isRobotNormalMode isRobotReducedMode isRobotRunning postAndAwait postAndObserve request requestObserve

Constructors

constructor

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

Properties

communicationChannel

communicationChannel: CommunicationChannel

`Readonly`eventTarget

eventTarget: EventTargetOrCommChannel

Methods

getRobotType

getRobotType(): Promise<string>
Get the robot type

Returns Promise<string>
- Defined in node_modules/@universal-robots/contribution-api/lib/services/robot/robot-info.service.d.ts:17

getSerialNumber

getSerialNumber(): Promise<string>
Get the robot serial number

Returns Promise<string>
- Defined in node_modules/@universal-robots/contribution-api/lib/services/robot/robot-info.service.d.ts:21

is3PEStop

is3PEStop(): Observable<boolean>
Checks if the robot is in 3 PE stop state.

Returns Observable<boolean>
- An observable that emits true if the robot is in 3 PE stop state, otherwise false.
- Defined in node_modules/@universal-robots/contribution-api/lib/services/robot/robot-info.service.d.ts:28

isRobotNormalMode

isRobotNormalMode(): Observable<boolean>
Determines whether the robot is currently in Normal state.

Returns Observable<boolean>
An observable that emits true if the robot is in normal mode (robot.safetyMode === NORMAL), otherwise false.
- Defined in node_modules/@universal-robots/contribution-api/lib/services/robot/robot-info.service.d.ts:42

isRobotReducedMode

isRobotReducedMode(): Observable<boolean>
Determines whether the robot is currently in Normal state.

Returns Observable<boolean>
An observable that emits true if the robot is in normal mode (robot.safetyMode === NORMAL), otherwise false.
- Defined in node_modules/@universal-robots/contribution-api/lib/services/robot/robot-info.service.d.ts:49

isRobotRunning

isRobotRunning(): Observable<boolean>
Determines whether the robot is currently running.

Returns Observable<boolean>
An observable that emits true if the robot is running (robotMode === RUNNING), otherwise false.
- Defined in node_modules/@universal-robots/contribution-api/lib/services/robot/robot-info.service.d.ts:35

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