Class SafetyService

Service for getting information about Safety

Hierarchy

MessageInvokerService
- SafetyService

Index

Constructors

Properties

Methods

getIOs getMaxToolForce getPayloadLimits postAndAwait postAndObserve

Constructors

constructor

new SafetyService(eventTarget: EventTarget): SafetyService
Parameters
- eventTarget: EventTarget
Returns SafetyService
Overrides MessageInvokerService.constructor
- Defined in lib/services/robot/safety.service.d.ts:13

Properties

`Readonly` eventTarget

eventTarget: EventTarget

Methods

getIOs

getIOs(): Promise<Record<string, any>>
Returns a list of safety IO's

Returns Promise<Record<string, any>>
- Defined in lib/services/robot/safety.service.d.ts:17

getMaxToolForce

getMaxToolForce(): Promise<number>
Get the maximum allowed tool force for the robot

Returns Promise<number>
- Defined in lib/services/robot/safety.service.d.ts:21

getPayloadLimits

getPayloadLimits(): Promise<PayloadLimits>
Get the payload limits for the robot

Returns Promise<PayloadLimits>
- Defined in lib/services/robot/safety.service.d.ts:25

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
- Optional data: any
  
  The message data
Returns Promise<T>
Inherited from MessageInvokerService.postAndAwait
- Defined in lib/services/message-invoker.d.ts:44

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
- Optional data: any
  
  The message data
Returns Observable<T>
Inherited from MessageInvokerService.postAndObserve
- Defined in lib/services/message-invoker.d.ts:51

Generated using TypeDoc