Skip to content

Use with AI

Use with AI

Class: RobotRuntimeClient ​

Using this reference

Choose a convenience method for a common workflow or callRpc for a typed unary RPC. The selected RPC determines the effect: discovery reads state; configuration and motion requests can change Runtime state. The generic method preserves request values and does not automatically retry commands.

A successful response means what that RPC defines. Follow the returned motion ID through its lifecycle using the command lifecycle guide · Coming soon; use the streams and preview guide · Coming soon for subscriptions and planning.

Complete governed Robot Runtime v1 client. Runtime owns execution and safety.

Constructors ​

Constructor ​

new RobotRuntimeClient(transport): RobotRuntimeClient

Parameters ​

transport ​

RuntimeTransport

Returns ​

RobotRuntimeClient

Methods ​

callRpc() ​

callRpc<M>(method, request): Promise<RpcResponses[M]>

Invoke any unary RPC without changing Runtime data or retrying commands.

Type Parameters ​

M ​

M extends UnaryRpc

Parameters ​

method ​

M

request ​

RpcRequests[M]

Returns ​

Promise<RpcResponses[M]>


close() ​

close(): void

Close the connection and active local subscriptions.

Returns ​

void


confirmAllRuntimeErrors() ​

confirmAllRuntimeErrors(request?): Promise<OperationResult>

Parameters ​

request? ​

EmptyRequest = {}

Returns ​

Promise<OperationResult>


confirmRuntimeError() ​

confirmRuntimeError(request?): Promise<OperationResult>

Parameters ​

request? ​

ConfirmRuntimeErrorRequest = {}

Returns ​

Promise<OperationResult>


connect() ​

connect(): Promise<void>

Open the configured transport connection.

Returns ​

Promise<void>


deleteAllVisualizationPaths() ​

deleteAllVisualizationPaths(request?): Promise<OperationResult>

Parameters ​

request? ​

EmptyRequest = {}

Returns ​

Promise<OperationResult>


deleteAllVisualizationPoints() ​

deleteAllVisualizationPoints(request?): Promise<OperationResult>

Parameters ​

request? ​

EmptyRequest = {}

Returns ​

Promise<OperationResult>


executeTrajectory() ​

executeTrajectory(request?): Promise<OperationResult>

Parameters ​

request? ​

ExecuteTrajectoryRequest = {}

Returns ​

Promise<OperationResult>


forwardKinematics() ​

forwardKinematics(request?): Promise<ForwardKinematicsResponse>

Parameters ​

request? ​

ForwardKinematicsRequest = {}

Returns ​

Promise<ForwardKinematicsResponse>


getCollisionDetectionStatus() ​

getCollisionDetectionStatus(request?): Promise<CollisionDetectionStatus>

Parameters ​

request? ​

EmptyRequest = {}

Returns ​

Promise<CollisionDetectionStatus>


getCurrentCollisionGeometry() ​

getCurrentCollisionGeometry(request?): Promise<CollisionGeometry>

Parameters ​

request? ​

EmptyRequest = {}

Returns ​

Promise<CollisionGeometry>


getCurrentRobotJoints() ​

getCurrentRobotJoints(robotName?): Promise<JointAnglesDegrees>

Read current joint positions in degrees.

Parameters ​

robotName? ​

string

Returns ​

Promise<JointAnglesDegrees>


getCurrentRobotPosition() ​

getCurrentRobotPosition(robotName?, group?): Promise<RobotPose>

Read the current Cartesian pose for a robot or group. Positions use millimetres.

Parameters ​

robotName? ​

string

group? ​

string

Returns ​

Promise<RobotPose>


getFunctionFlagStatus() ​

getFunctionFlagStatus(request?): Promise<FunctionFlagStatusList>

Parameters ​

request? ​

EmptyRequest = {}

Returns ​

Promise<FunctionFlagStatusList>


getInput() ​

getInput(request?): Promise<IntValue>

Parameters ​

request? ​

IoName = {}

Returns ​

Promise<IntValue>


getJointActivationStatus() ​

getJointActivationStatus(request?): Promise<JointActivationStatus>

Parameters ​

request? ​

RobotSelectorRequest = {}

Returns ​

Promise<JointActivationStatus>


getJointInitializationStatus() ​

getJointInitializationStatus(request?): Promise<JointInitializationStatus>

Parameters ​

request? ​

RobotSelectorRequest = {}

Returns ​

Promise<JointInitializationStatus>


getMotionLimitProfile() ​

getMotionLimitProfile(request?): Promise<MotionLimitProfile>

Parameters ​

request? ​

EmptyRequest = {}

Returns ​

Promise<MotionLimitProfile>


getMotionStatus() ​

getMotionStatus(motionId): Promise<MotionStatus>

Read the state and progress of a motion ID.

Parameters ​

motionId ​

string

Returns ​

Promise<MotionStatus>


getOutput() ​

getOutput(request?): Promise<IntValue>

Parameters ​

request? ​

IoName = {}

Returns ​

Promise<IntValue>


getRuntimeTargetProfile() ​

getRuntimeTargetProfile(request?): Promise<RuntimeTargetProfile>

Parameters ​

request? ​

EmptyRequest = {}

Returns ​

Promise<RuntimeTargetProfile>


inverseKinematics() ​

inverseKinematics(request?): Promise<InverseKinematicsResponse>

Parameters ​

request? ​

InverseKinematicsRequest = {}

Returns ​

Promise<InverseKinematicsResponse>


jogUninitializedJoint() ​

jogUninitializedJoint(request?): Promise<OperationResult>

Parameters ​

request? ​

UninitializedJointJogRequest = {}

Returns ​

Promise<OperationResult>


listActiveErrors() ​

listActiveErrors(request?): Promise<RuntimeErrorList>

Parameters ​

request? ​

EmptyRequest = {}

Returns ​

Promise<RuntimeErrorList>


listRobots() ​

listRobots(): Promise<RobotInfo[]>

Discover available robots.

Returns ​

Promise<RobotInfo[]>


moveInAxisDirection() ​

moveInAxisDirection(request?): Promise<OperationResult>

Parameters ​

request? ​

AxisMovementRequest = {}

Returns ​

Promise<OperationResult>


moveLinear() ​

moveLinear(request?): Promise<OperationResult>

Parameters ​

request? ​

MoveToPoseRequest = {}

Returns ​

Promise<OperationResult>


moveRigidObject() ​

moveRigidObject(request?): Promise<OperationResult>

Parameters ​

request? ​

RigidObjectMotionRequest = {}

Returns ​

Promise<OperationResult>


moveToJoints() ​

moveToJoints(request?): Promise<OperationResult>

Parameters ​

request? ​

MoveToJointsRequest = {}

Returns ​

Promise<OperationResult>


moveToPose() ​

moveToPose(request?): Promise<OperationResult>

Parameters ​

request? ​

MoveToPoseRequest = {}

Returns ​

Promise<OperationResult>


planCartesianTrajectory() ​

planCartesianTrajectory(request?): Promise<MotionPlan>

Parameters ​

request? ​

PlanCartesianTrajectoryRequest = {}

Returns ​

Promise<MotionPlan>


previewMotion() ​

previewMotion(request): Promise<MotionPlan>

Plan a motion without executing it.

Parameters ​

request ​

PreviewMotionRequest

Returns ​

Promise<MotionPlan>


previewRigidObjectMotion() ​

previewRigidObjectMotion(request?): Promise<MotionPlan>

Parameters ​

request? ​

RigidObjectMotionRequest = {}

Returns ​

Promise<MotionPlan>


rotateAroundAxis() ​

rotateAroundAxis(request?): Promise<OperationResult>

Parameters ​

request? ​

AxisMovementRequest = {}

Returns ​

Promise<OperationResult>


setCollisionDetectionEnabled() ​

setCollisionDetectionEnabled(request?): Promise<OperationResult>

Parameters ​

request? ​

SetCollisionDetectionEnabledRequest = {}

Returns ​

Promise<OperationResult>


setJointsActive() ​

setJointsActive(request?): Promise<OperationResult>

Parameters ​

request? ​

JointActivationCommand = {}

Returns ​

Promise<OperationResult>


setMotionLimitFactor() ​

setMotionLimitFactor(request?): Promise<OperationResult>

Parameters ​

request? ​

SetMotionLimitFactorRequest = {}

Returns ​

Promise<OperationResult>


setOutput() ​

setOutput(request?): Promise<OperationResult>

Parameters ​

request? ​

IoValue = {}

Returns ​

Promise<OperationResult>


startRobotPoseStream() ​

startRobotPoseStream(onPose, onStatus, robotName?, group?): StopRuntimeStream

Subscribe to pose updates. Call the returned async function to cancel the stream.

Parameters ​

onPose ​

(pose) => void

onStatus ​

(message) => void

robotName? ​

string

group? ​

string

Returns ​

StopRuntimeStream


startRpcStream() ​

startRpcStream<M>(method, request, onValue, onStatus): StopRuntimeStream

Each stream has its own correlation ID and explicit terminal/error callback.

Type Parameters ​

M ​

M extends StreamRpc

Parameters ​

method ​

M

request ​

RpcRequests[M]

onValue ​

(value) => void

onStatus ​

(message) => void

Returns ​

StopRuntimeStream


stopMotion() ​

stopMotion(request?): Promise<OperationResult>

Parameters ​

request? ​

StopMotionRequest = {}

Returns ​

Promise<OperationResult>


stopRobotMotion() ​

stopRobotMotion(request?): Promise<OperationResult>

Parameters ​

request? ​

RobotSelectorRequest = {}

Returns ​

Promise<OperationResult>


streamCurrentCollisionGeometry() ​

streamCurrentCollisionGeometry(request, onValue, onStatus): StopRuntimeStream

Parameters ​

request ​

EmptyRequest

onValue ​

(value) => void

onStatus ​

(message) => void

Returns ​

StopRuntimeStream


streamCurrentRobotJoints() ​

streamCurrentRobotJoints(request, onValue, onStatus): StopRuntimeStream

Parameters ​

request ​

RobotSelectorRequest

onValue ​

(value) => void

onStatus ​

(message) => void

Returns ​

StopRuntimeStream


streamCurrentRobotPosition() ​

streamCurrentRobotPosition(request, onValue, onStatus): StopRuntimeStream

Parameters ​

request ​

RobotSelectorRequest

onValue ​

(value) => void

onStatus ​

(message) => void

Returns ​

StopRuntimeStream


streamVisualizationPaths() ​

streamVisualizationPaths(request, onValue, onStatus): StopRuntimeStream

Parameters ​

request ​

EmptyRequest

onValue ​

(value) => void

onStatus ​

(message) => void

Returns ​

StopRuntimeStream


streamVisualizationPoints() ​

streamVisualizationPoints(request, onValue, onStatus): StopRuntimeStream

Parameters ​

request ​

EmptyRequest

onValue ​

(value) => void

onStatus ​

(message) => void

Returns ​

StopRuntimeStream


streamVisualizationTrackers() ​

streamVisualizationTrackers(request, onValue, onStatus): StopRuntimeStream

Parameters ​

request ​

EmptyRequest

onValue ​

(value) => void

onStatus ​

(message) => void

Returns ​

StopRuntimeStream


switchRuntimeTarget() ​

switchRuntimeTarget(request?): Promise<OperationResult>

Parameters ​

request? ​

SwitchRuntimeTargetRequest = {}

Returns ​

Promise<OperationResult>


switchSimulationRobot() ​

switchSimulationRobot(request?): Promise<OperationResult>

Parameters ​

request? ​

SwitchSimulationRobotRequest = {}

Returns ​

Promise<OperationResult>


upsertVisualizationPath() ​

upsertVisualizationPath(request?): Promise<OperationResult>

Parameters ​

request? ​

VisualizationPath = {}

Returns ​

Promise<OperationResult>


upsertVisualizationPoint() ​

upsertVisualizationPoint(request?): Promise<OperationResult>

Parameters ​

request? ​

VisualizationPoint = {}

Returns ​

Promise<OperationResult>


upsertVisualizationTracker() ​

upsertVisualizationTracker(request?): Promise<OperationResult>

Parameters ​

request? ​

VisualizationTracker = {}

Returns ​

Promise<OperationResult>