Class RobotClient

A gRPC-web client for a Robot.

Hierarchy

  • EventDispatcher
    • RobotClient

Implements

Constructors

constructor

Properties

armServiceClient baseServiceClient boardServiceClient connectResolve connecting directOptions encoderServiceClient gRPCConnectionManager gantryServiceClient genericServiceClient gripperServiceClient inputControllerServiceClient listeners motionServiceClient motorServiceClient movementSensorServiceClient navigationServiceClient peerConn powerSensorServiceClient robotServiceClient savedAuthEntity savedCreds sensorsServiceClient serviceHost servoServiceClient sessionManager sessionOptions slamServiceClient transportFactory visionServiceClient webrtcOptions notConnectedYetStr

Accessors

armService baseService boardService encoderService gantryService genericService gripperService inputControllerService motionService motorService movementSensorService navigationService noReconnect peerConnection powerSensorService reconnectMaxAttempts reconnectMaxWait robotService sensorsService servoService sessionId slamService visionService

Methods

connect createServiceClient disconnect emit has isConnected off on onDisconnect once

App/Cloud

getCloudMetadata

Discovery

discoverComponents

Frame System

frameSystemConfig transformPCD transformPose

Operations

blockForOperation cancelOperation getOperations stopAll

Resources

resourceNames resourceRPCSubtypes

Status

getStatus streamStatus

Constructors

constructor

  • new RobotClient(serviceHost, webrtcOptions?, sessionOptions?, directOptions?): RobotClient

  • Parameters

    • serviceHost: string
    • Optional webrtcOptions: WebRTCOptions
    • Optional sessionOptions: SessionOptions
    • Optional directOptions: DirectOptions

    Returns RobotClient

Properties

Private armServiceClient

armServiceClient: undefined | ArmServiceClient

Private baseServiceClient

baseServiceClient: undefined | BaseServiceClient

Private boardServiceClient

boardServiceClient: undefined | BoardServiceClient

Private connectResolve

connectResolve: undefined | (() => void)

Type declaration

    • (): void

    • Returns void

Private connecting

connecting: undefined | Promise<void>

Private Readonly directOptions

directOptions: undefined | DirectOptions

Private encoderServiceClient

encoderServiceClient: undefined | EncoderServiceClient

Private gRPCConnectionManager

gRPCConnectionManager: default

Private gantryServiceClient

gantryServiceClient: undefined | GantryServiceClient

Private genericServiceClient

genericServiceClient: undefined | GenericServiceClient

Private gripperServiceClient

gripperServiceClient: undefined | GripperServiceClient

Private inputControllerServiceClient

inputControllerServiceClient: undefined | InputControllerServiceClient

listeners

listeners: Partial<Record<string, Set<Callback>>> = {}

Private motionServiceClient

motionServiceClient: undefined | MotionServiceClient

Private motorServiceClient

motorServiceClient: undefined | MotorServiceClient

Private movementSensorServiceClient

movementSensorServiceClient: undefined | MovementSensorServiceClient

Private navigationServiceClient

navigationServiceClient: undefined | NavigationServiceClient

Private peerConn

peerConn: undefined | RTCPeerConnection

Private powerSensorServiceClient

powerSensorServiceClient: undefined | PowerSensorServiceClient

Private robotServiceClient

robotServiceClient: undefined | RobotServiceClient

Private savedAuthEntity

savedAuthEntity: undefined | string

Private savedCreds

savedCreds: undefined | Credentials

Private sensorsServiceClient

sensorsServiceClient: undefined | SensorsServiceClient

Private Readonly serviceHost

serviceHost: string

Private servoServiceClient

servoServiceClient: undefined | ServoServiceClient

Private sessionManager

sessionManager: default

Private Readonly sessionOptions

sessionOptions: undefined | SessionOptions

Private slamServiceClient

slamServiceClient: undefined | SLAMServiceClient

Private transportFactory

transportFactory: undefined | TransportFactory

Private visionServiceClient

visionServiceClient: undefined | VisionServiceClient

Private Readonly webrtcOptions

webrtcOptions: undefined | WebRTCOptions

Static Private Readonly notConnectedYetStr

notConnectedYetStr: "not connected yet" = 'not connected yet'

Accessors

armService

  • get armService(): ArmServiceClient

  • Returns ArmServiceClient

baseService

  • get baseService(): BaseServiceClient

  • Returns BaseServiceClient

boardService

  • get boardService(): BoardServiceClient

  • Returns BoardServiceClient

encoderService

  • get encoderService(): EncoderServiceClient

  • Returns EncoderServiceClient

gantryService

  • get gantryService(): GantryServiceClient

  • Returns GantryServiceClient

genericService

  • get genericService(): GenericServiceClient

  • Returns GenericServiceClient

gripperService

  • get gripperService(): GripperServiceClient

  • Returns GripperServiceClient

inputControllerService

  • get inputControllerService(): InputControllerServiceClient

  • Returns InputControllerServiceClient

motionService

  • get motionService(): MotionServiceClient

  • Returns MotionServiceClient

motorService

  • get motorService(): MotorServiceClient

  • Returns MotorServiceClient

movementSensorService

  • get movementSensorService(): MovementSensorServiceClient

  • Returns MovementSensorServiceClient

navigationService

  • Returns NavigationServiceClient

Private noReconnect

  • get noReconnect(): undefined | boolean

  • Returns undefined | boolean

peerConnection

  • get peerConnection(): undefined | RTCPeerConnection

  • Returns undefined | RTCPeerConnection

powerSensorService

  • get powerSensorService(): PowerSensorServiceClient

  • Returns PowerSensorServiceClient

Private reconnectMaxAttempts

  • get reconnectMaxAttempts(): undefined | number

  • Returns undefined | number

Private reconnectMaxWait

  • get reconnectMaxWait(): undefined | number

  • Returns undefined | number

robotService

  • get robotService(): RobotServiceClient

  • Returns RobotServiceClient

sensorsService

  • get sensorsService(): SensorsServiceClient

  • Returns SensorsServiceClient

servoService

  • get servoService(): ServoServiceClient

  • Returns ServoServiceClient

sessionId

  • get sessionId(): string

  • Returns string

slamService

  • get slamService(): SLAMServiceClient

  • Returns SLAMServiceClient

visionService

  • get visionService(): VisionServiceClient

  • Returns VisionServiceClient

Methods

connect

  • connect(__namedParameters?): Promise<void>

  • Parameters

    • __namedParameters: ConnectOptions = {}

    Returns Promise<void>

createServiceClient

  • createServiceClient<T>(SC): T

  • Type Parameters

    • T extends ServiceClient

    Parameters

    • SC: (new (serviceHost, options?) => T)
        • new (serviceHost, options?): T

        • Parameters

          • serviceHost: string
          • Optional options: RpcOptions

          Returns T

    Returns T

disconnect

  • disconnect(): Promise<void>

  • Returns Promise<void>

emit

  • emit(type, args): void

  • Parameters

    • type: string
    • args: unknown

    Returns void

has

  • has(type, listener): undefined | boolean

  • Parameters

    • type: string
    • listener: Callback

    Returns undefined | boolean

isConnected

  • isConnected(): boolean

  • Returns boolean

off

  • off(type, listener): void

  • Parameters

    • type: string
    • listener: Callback

    Returns void

Alpha on

  • on(type, listener): void

  • Parameters

    • type: string
    • listener: Callback

    Returns void

Private onDisconnect

  • onDisconnect(event?): void

  • Parameters

    • Optional event: Event

    Returns void

once

  • once(type, listener): void

  • Parameters

    • type: string
    • listener: Callback

    Returns void

App/Cloud

getCloudMetadata

Discovery

discoverComponents

Frame System

frameSystemConfig

transformPCD

  • transformPCD(pointCloudPCD, source, destination): Promise<Uint8Array>
  • Alpha

    Transform a given source point cloud from the reference frame to a new specified destination which is a reference frame.

    Parameters

    • pointCloudPCD: Uint8Array

      The point clouds to transform. This should be in the PCD format encoded into bytes: https://pointclouds.org/documentation/tutorials/pcd_file_format.html

    • source: string

      The reference frame of the point cloud.

    • destination: string

      The reference frame into which the source data should be transformed, if unset this defaults to the "world" reference frame. Do not move the robot between the generation of the initial pointcloud and the receipt of the transformed pointcloud because that will make the transformations inaccurate.

    Returns Promise<Uint8Array>

transformPose

  • transformPose(source, destination, supplementalTransforms): Promise<commonApi.PoseInFrame>
  • Alpha

    Transform a given source Pose from the reference frame to a new specified destination which is a reference frame.

    Parameters

    • source: commonApi.PoseInFrame
    • destination: string

      The name of the reference frame to transform the given

    • supplementalTransforms: commonApi.Transform[]

      Pose information on any additional reference frames that are needed to perform the transform

    Returns Promise<commonApi.PoseInFrame>

Operations

blockForOperation

  • blockForOperation(id): Promise<void>
  • Alpha

    Blocks on the specified operation on the robot. This function will only return when the specific operation has finished or has been cancelled.

    Parameters

    • id: string

      ID of operation to block on.

    Returns Promise<void>

cancelOperation

  • cancelOperation(id): Promise<void>
  • Alpha

    Cancels the specified operation on the robot.

    Parameters

    • id: string

      ID of operation to kill.

    Returns Promise<void>

getOperations

stopAll

  • stopAll(): Promise<void>
  • Alpha

    Cancel all current and outstanding operations for the robot and stop all actuators and movement.

    Returns Promise<void>

Resources

resourceNames

resourceRPCSubtypes

Status

getStatus

streamStatus

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc