Skip to content

Use with AI

Use with AI

Python SDK reference ​

Generated from the installed plexa-runtime-read wheel public __all__ surface.

RuntimeClient exposes all 48 pinned northbound RPCs, including motion submission, trajectory execution, I/O and Runtime collision/limit configuration. RuntimeReadClient retains its read/preview convenience API. Joint angles are degrees; Cartesian positions are millimetres. Robot Runtime owns authorization, execution and safety. No realtime or hardware acceptance.

Contract revision: 4002245f167f7dbd2e1d5ed34d315d724ca1ca70.

Optional terminal, MCP, visualization and tracing adapters are separate from the core API. Their package extras and guides define their scope.

RuntimeClient ​

python
RuntimeClient(*args, **kwargs)

All 48 pinned Runtime RPCs, preserving protobuf data and Runtime rejection.

Unary calls and streams use the configured deadline. No automatic retry of commands. Caller-supplied channels retain ownership. Degrees, millimetres, seconds and q0/q1/q2/q3 follow the northbound Contract.

call_rpc ​

python
RuntimeClient.call_rpc(self, method: 'str', request: 'Message | dict | None' = None)

close ​

python
RuntimeClient.close(self) -> None

confirm_all_runtime_errors ​

python
RuntimeClient.confirm_all_runtime_errors(self, request: 'common_pb2.EmptyRequest | dict | None' = None) -> 'common_pb2.OperationResult'

ConfirmAllRuntimeErrors: EmptyRequest → OperationResult.

confirm_runtime_error ​

python
RuntimeClient.confirm_runtime_error(self, request: 'common_pb2.ConfirmRuntimeErrorRequest | dict | None' = None) -> 'common_pb2.OperationResult'

ConfirmRuntimeError: ConfirmRuntimeErrorRequest → OperationResult.

delete_all_visualization_paths ​

python
RuntimeClient.delete_all_visualization_paths(self, request: 'common_pb2.EmptyRequest | dict | None' = None) -> 'common_pb2.OperationResult'

DeleteAllVisualizationPaths: EmptyRequest → OperationResult.

delete_all_visualization_points ​

python
RuntimeClient.delete_all_visualization_points(self, request: 'common_pb2.EmptyRequest | dict | None' = None) -> 'common_pb2.OperationResult'

DeleteAllVisualizationPoints: EmptyRequest → OperationResult.

execute_trajectory ​

python
RuntimeClient.execute_trajectory(self, request: 'control_pb2.ExecuteTrajectoryRequest | dict | None' = None) -> 'common_pb2.OperationResult'

ExecuteTrajectory: ExecuteTrajectoryRequest → OperationResult.

forward_kinematics ​

python
RuntimeClient.forward_kinematics(self, request: 'control_pb2.ForwardKinematicsRequest | dict | None' = None) -> 'control_pb2.ForwardKinematicsResponse'

ForwardKinematics: ForwardKinematicsRequest → ForwardKinematicsResponse.

get_collision_detection_status ​

python
RuntimeClient.get_collision_detection_status(self, request: 'common_pb2.EmptyRequest | dict | None' = None) -> 'common_pb2.CollisionDetectionStatus'

GetCollisionDetectionStatus: EmptyRequest → CollisionDetectionStatus.

get_current_collision_geometry ​

python
RuntimeClient.get_current_collision_geometry(self, request: 'common_pb2.EmptyRequest | dict | None' = None) -> 'common_pb2.CollisionGeometry'

GetCurrentCollisionGeometry: EmptyRequest → CollisionGeometry.

get_current_joints ​

python
RuntimeClient.get_current_joints(self, robot_name: str) -> plexa_runtime_sdk.read_client.JointAnglesDegrees

get_current_pose ​

python
RuntimeClient.get_current_pose(self, robot_name: str, group: str = '') -> plexa_runtime_sdk.read_client.RobotPose

get_current_robot_joints ​

python
RuntimeClient.get_current_robot_joints(self, request: 'common_pb2.RobotSelectorRequest | dict | None' = None) -> 'common_pb2.JointAngles'

GetCurrentRobotJoints: RobotSelectorRequest → JointAngles.

get_current_robot_position ​

python
RuntimeClient.get_current_robot_position(self, request: 'common_pb2.RobotSelectorRequest | dict | None' = None) -> 'common_pb2.RobotPose'

GetCurrentRobotPosition: RobotSelectorRequest → RobotPose.

get_function_flag_status ​

python
RuntimeClient.get_function_flag_status(self, request: 'common_pb2.EmptyRequest | dict | None' = None) -> 'control_pb2.FunctionFlagStatusList'

GetFunctionFlagStatus: EmptyRequest → FunctionFlagStatusList.

get_input ​

python
RuntimeClient.get_input(self, request: 'common_pb2.IoName | dict | None' = None) -> 'common_pb2.IntValue'

GetInput: IoName → IntValue.

get_joint_activation_status ​

python
RuntimeClient.get_joint_activation_status(self, request: 'common_pb2.RobotSelectorRequest | dict | None' = None) -> 'control_pb2.JointActivationStatus'

GetJointActivationStatus: RobotSelectorRequest → JointActivationStatus.

get_joint_initialization_status ​

python
RuntimeClient.get_joint_initialization_status(self, request: 'common_pb2.RobotSelectorRequest | dict | None' = None) -> 'common_pb2.JointInitializationStatus'

GetJointInitializationStatus: RobotSelectorRequest → JointInitializationStatus.

get_motion_limit_profile ​

python
RuntimeClient.get_motion_limit_profile(self, request: 'common_pb2.EmptyRequest | dict | None' = None) -> 'common_pb2.MotionLimitProfile'

GetMotionLimitProfile: EmptyRequest → MotionLimitProfile.

get_motion_status ​

python
RuntimeClient.get_motion_status(self, request: 'common_pb2.MotionStatusRequest | dict | None' = None) -> 'common_pb2.MotionStatus'

GetMotionStatus: MotionStatusRequest → MotionStatus.

get_output ​

python
RuntimeClient.get_output(self, request: 'common_pb2.IoName | dict | None' = None) -> 'common_pb2.IntValue'

GetOutput: IoName → IntValue.

get_runtime_target_profile ​

python
RuntimeClient.get_runtime_target_profile(self, request: 'common_pb2.EmptyRequest | dict | None' = None) -> 'common_pb2.RuntimeTargetProfile'

GetRuntimeTargetProfile: EmptyRequest → RuntimeTargetProfile.

inverse_kinematics ​

python
RuntimeClient.inverse_kinematics(self, request: 'control_pb2.InverseKinematicsRequest | dict | None' = None) -> 'control_pb2.InverseKinematicsResponse'

InverseKinematics: InverseKinematicsRequest → InverseKinematicsResponse.

jog_uninitialized_joint ​

python
RuntimeClient.jog_uninitialized_joint(self, request: 'control_pb2.UninitializedJointJogRequest | dict | None' = None) -> 'common_pb2.OperationResult'

JogUninitializedJoint: UninitializedJointJogRequest → OperationResult.

list_active_errors ​

python
RuntimeClient.list_active_errors(self, request: 'common_pb2.EmptyRequest | dict | None' = None) -> 'common_pb2.RuntimeErrorList'

ListActiveErrors: EmptyRequest → RuntimeErrorList.

list_robots ​

python
RuntimeClient.list_robots(self, request: 'common_pb2.EmptyRequest | dict | None' = None) -> 'common_pb2.RobotList'

ListRobots: EmptyRequest → RobotList.

move_in_axis_direction ​

python
RuntimeClient.move_in_axis_direction(self, request: 'control_pb2.AxisMovementRequest | dict | None' = None) -> 'common_pb2.OperationResult'

MoveInAxisDirection: AxisMovementRequest → OperationResult.

move_linear ​

python
RuntimeClient.move_linear(self, request: 'control_pb2.MoveToPoseRequest | dict | None' = None) -> 'common_pb2.OperationResult'

MoveLinear: MoveToPoseRequest → OperationResult.

move_rigid_object ​

python
RuntimeClient.move_rigid_object(self, request: 'control_pb2.RigidObjectMotionRequest | dict | None' = None) -> 'common_pb2.OperationResult'

MoveRigidObject: RigidObjectMotionRequest → OperationResult.

move_to_joints ​

python
RuntimeClient.move_to_joints(self, request: 'control_pb2.MoveToJointsRequest | dict | None' = None) -> 'common_pb2.OperationResult'

MoveToJoints: MoveToJointsRequest → OperationResult.

move_to_pose ​

python
RuntimeClient.move_to_pose(self, request: 'control_pb2.MoveToPoseRequest | dict | None' = None) -> 'common_pb2.OperationResult'

MoveToPose: MoveToPoseRequest → OperationResult.

plan_cartesian_trajectory ​

python
RuntimeClient.plan_cartesian_trajectory(self, request: 'control_pb2.PlanCartesianTrajectoryRequest | dict | None' = None) -> 'control_pb2.MotionPlan'

PlanCartesianTrajectory: PlanCartesianTrajectoryRequest → MotionPlan.

preview_motion ​

python
RuntimeClient.preview_motion(self, request: 'control_pb2.PreviewMotionRequest | dict | None' = None) -> 'control_pb2.MotionPlan'

PreviewMotion: PreviewMotionRequest → MotionPlan.

preview_move_to_pose ​

python
RuntimeClient.preview_move_to_pose(self, robot_name: str, position_millimetres: tuple[float, float, float], quaternion: tuple[float, float, float, float], *, speed: float, group: str = '', coordinate_frame: str = 'SYSTEM_BASE') -> plexa_runtime_sdk.read_client.MotionPlanPreview

Request a plan preview. This method never submits or executes motion.

preview_rigid_object_motion ​

python
RuntimeClient.preview_rigid_object_motion(self, request: 'control_pb2.RigidObjectMotionRequest | dict | None' = None) -> 'control_pb2.MotionPlan'

PreviewRigidObjectMotion: RigidObjectMotionRequest → MotionPlan.

request_type ​

python
RuntimeClient.request_type(method: 'str')

rotate_around_axis ​

python
RuntimeClient.rotate_around_axis(self, request: 'control_pb2.AxisMovementRequest | dict | None' = None) -> 'common_pb2.OperationResult'

RotateAroundAxis: AxisMovementRequest → OperationResult.

rpc_methods ​

python
RuntimeClient.rpc_methods()

set_collision_detection_enabled ​

python
RuntimeClient.set_collision_detection_enabled(self, request: 'common_pb2.SetCollisionDetectionEnabledRequest | dict | None' = None) -> 'common_pb2.OperationResult'

SetCollisionDetectionEnabled: SetCollisionDetectionEnabledRequest → OperationResult.

set_joints_active ​

python
RuntimeClient.set_joints_active(self, request: 'control_pb2.JointActivationCommand | dict | None' = None) -> 'common_pb2.OperationResult'

SetJointsActive: JointActivationCommand → OperationResult.

set_motion_limit_factor ​

python
RuntimeClient.set_motion_limit_factor(self, request: 'common_pb2.SetMotionLimitFactorRequest | dict | None' = None) -> 'common_pb2.OperationResult'

SetMotionLimitFactor: SetMotionLimitFactorRequest → OperationResult.

set_output ​

python
RuntimeClient.set_output(self, request: 'common_pb2.IoValue | dict | None' = None) -> 'common_pb2.OperationResult'

SetOutput: IoValue → OperationResult.

stop_motion ​

python
RuntimeClient.stop_motion(self, request: 'common_pb2.StopMotionRequest | dict | None' = None) -> 'common_pb2.OperationResult'

StopMotion: StopMotionRequest → OperationResult.

stop_robot_motion ​

python
RuntimeClient.stop_robot_motion(self, request: 'common_pb2.RobotSelectorRequest | dict | None' = None) -> 'common_pb2.OperationResult'

StopRobotMotion: RobotSelectorRequest → OperationResult.

stream_current_collision_geometry ​

python
RuntimeClient.stream_current_collision_geometry(self, request: 'common_pb2.EmptyRequest | dict | None' = None) -> '_RuntimeStream[common_pb2.CollisionGeometry]'

StreamCurrentCollisionGeometry: EmptyRequest → cancellable stream of CollisionGeometry.

stream_current_joints ​

python
RuntimeClient.stream_current_joints(self, robot_name: str) -> plexa_runtime_sdk.read_client.JointStream

stream_current_pose ​

python
RuntimeClient.stream_current_pose(self, robot_name: str, group: str = '') -> plexa_runtime_sdk.read_client.PoseStream

stream_current_robot_joints ​

python
RuntimeClient.stream_current_robot_joints(self, request: 'common_pb2.RobotSelectorRequest | dict | None' = None) -> '_RuntimeStream[common_pb2.JointAngles]'

StreamCurrentRobotJoints: RobotSelectorRequest → cancellable stream of JointAngles.

stream_current_robot_position ​

python
RuntimeClient.stream_current_robot_position(self, request: 'common_pb2.RobotSelectorRequest | dict | None' = None) -> '_RuntimeStream[common_pb2.RobotPose]'

StreamCurrentRobotPosition: RobotSelectorRequest → cancellable stream of RobotPose.

stream_visualization_paths ​

python
RuntimeClient.stream_visualization_paths(self, request: 'common_pb2.EmptyRequest | dict | None' = None) -> '_RuntimeStream[control_pb2.VisualizationPathList]'

StreamVisualizationPaths: EmptyRequest → cancellable stream of VisualizationPathList.

stream_visualization_points ​

python
RuntimeClient.stream_visualization_points(self, request: 'common_pb2.EmptyRequest | dict | None' = None) -> '_RuntimeStream[control_pb2.VisualizationPointList]'

StreamVisualizationPoints: EmptyRequest → cancellable stream of VisualizationPointList.

stream_visualization_trackers ​

python
RuntimeClient.stream_visualization_trackers(self, request: 'common_pb2.EmptyRequest | dict | None' = None) -> '_RuntimeStream[control_pb2.VisualizationTrackerList]'

StreamVisualizationTrackers: EmptyRequest → cancellable stream of VisualizationTrackerList.

switch_runtime_target ​

python
RuntimeClient.switch_runtime_target(self, request: 'common_pb2.SwitchRuntimeTargetRequest | dict | None' = None) -> 'common_pb2.OperationResult'

SwitchRuntimeTarget: SwitchRuntimeTargetRequest → OperationResult.

switch_simulation_robot ​

python
RuntimeClient.switch_simulation_robot(self, request: 'common_pb2.SwitchSimulationRobotRequest | dict | None' = None) -> 'common_pb2.OperationResult'

SwitchSimulationRobot: SwitchSimulationRobotRequest → OperationResult.

upsert_visualization_path ​

python
RuntimeClient.upsert_visualization_path(self, request: 'control_pb2.VisualizationPath | dict | None' = None) -> 'common_pb2.OperationResult'

UpsertVisualizationPath: VisualizationPath → OperationResult.

upsert_visualization_point ​

python
RuntimeClient.upsert_visualization_point(self, request: 'control_pb2.VisualizationPoint | dict | None' = None) -> 'common_pb2.OperationResult'

UpsertVisualizationPoint: VisualizationPoint → OperationResult.

upsert_visualization_tracker ​

python
RuntimeClient.upsert_visualization_tracker(self, request: 'control_pb2.VisualizationTracker | dict | None' = None) -> 'common_pb2.OperationResult'

UpsertVisualizationTracker: VisualizationTracker → OperationResult.

CONTRACT_REVISION ​

4002245f167f7dbd2e1d5ed34d315d724ca1ca70

CartesianPositionMillimetres ​

python
CartesianPositionMillimetres(x: float, y: float, z: float) -> None

EulerAngles ​

python
EulerAngles(rx: float, ry: float, rz: float) -> None

FunctionFlag ​

python
FunctionFlag(name: str, active: bool, position: int) -> None

FunctionFlagStatus ​

python
FunctionFlagStatus(flags: tuple[plexa_runtime_sdk.read_client.FunctionFlag, ...], status_available: bool) -> None

JointActivationStatus ​

python
JointActivationStatus(active: bool, status_available: bool) -> None

JointAnglesDegrees ​

python
JointAnglesDegrees(values: tuple[float, ...]) -> None

JointInitializationStatus ​

python
JointInitializationStatus(initialized: tuple[bool, ...], status_available: bool) -> None

JointStream ​

python
JointStream(call, observer=None, rpc_method: str = '', trace=None)

cancel ​

python
JointStream.cancel(self) -> None

MotionLimitProfile ​

python
MotionLimitProfile(active_factor: float, maximum_factor: float) -> None

MotionPlanPreview ​

python
MotionPlanPreview(motion_type: str, model_id: str, duration_millis: int, groups: tuple[str, ...], joint_path_degrees: tuple[tuple[float, ...], ...], warnings: tuple[str, ...], joint_names: tuple[str, ...], sample_period_seconds: float, trajectory_samples: tuple[plexa_runtime_sdk.read_client.TrajectorySample, ...]) -> None

MotionStatus ​

python
MotionStatus(motion_id: str, robot_name: str, state: str, path_ratio: float, message: str) -> None

PoseStream ​

python
PoseStream(call, observer=None, rpc_method: str = '', trace=None)

cancel ​

python
PoseStream.cancel(self) -> None

RawRuntimeResponse ​

python
RawRuntimeResponse(rpc_method: str, received_at_ns: int, schema_name: str, schema_data: bytes, message_data: bytes) -> None

Serialized Runtime protobuf response with its MCAP-ready schema and receive time.

Quaternion ​

python
Quaternion(q0: float, q1: float, q2: float, q3: float) -> None

RobotInfo ​

python
RobotInfo(name: str, axis_count: int, model_id: str) -> None

RobotPose ​

python
RobotPose(position: plexa_runtime_sdk.read_client.CartesianPositionMillimetres, quaternion: plexa_runtime_sdk.read_client.Quaternion, euler: plexa_runtime_sdk.read_client.EulerAngles) -> None

RobotSystemModule ​

python
RobotSystemModule(module_id: str, robot_name: str, system_axis_indices: tuple[int, ...], kinematic_group: str) -> None

RobotSystemProfile ​

python
RobotSystemProfile(profile_id: str, model_id: str, modules: tuple[plexa_runtime_sdk.read_client.RobotSystemModule, ...]) -> None

RuntimeErrorInfo ​

python
RuntimeErrorInfo(error_id: str, code: str, severity: str, source: str, message: str, first_observed_at_epoch_millis: int, last_observed_at_epoch_millis: int, occurrence_count: int, acknowledged: bool, recovery_state: str) -> None

RuntimeReadClient ​

python
RuntimeReadClient(endpoint: str = '127.0.0.1:19040', deadline_seconds: float = 2.0, *, channel: grpc.Channel | None = None, response_observer: Optional[Callable[[plexa_runtime_sdk.read_client.RawRuntimeResponse], NoneType]] = None, tracer=None, trace_context=None)

Northbound Runtime reads plus planning-only preview; never motion execution.

Without channel the client creates a loopback-only insecure channel and owns it. A caller-supplied channel may use another transport and remains owned by the caller, including when this client is used as a context manager.

close ​

python
RuntimeReadClient.close(self) -> None

get_current_joints ​

python
RuntimeReadClient.get_current_joints(self, robot_name: str) -> plexa_runtime_sdk.read_client.JointAnglesDegrees

get_current_pose ​

python
RuntimeReadClient.get_current_pose(self, robot_name: str, group: str = '') -> plexa_runtime_sdk.read_client.RobotPose

get_function_flag_status ​

python
RuntimeReadClient.get_function_flag_status(self) -> plexa_runtime_sdk.read_client.FunctionFlagStatus

get_joint_activation_status ​

python
RuntimeReadClient.get_joint_activation_status(self, robot_name: str) -> plexa_runtime_sdk.read_client.JointActivationStatus

get_joint_initialization_status ​

python
RuntimeReadClient.get_joint_initialization_status(self, robot_name: str) -> plexa_runtime_sdk.read_client.JointInitializationStatus

get_motion_limit_profile ​

python
RuntimeReadClient.get_motion_limit_profile(self) -> plexa_runtime_sdk.read_client.MotionLimitProfile

get_motion_status ​

python
RuntimeReadClient.get_motion_status(self, motion_id: str) -> plexa_runtime_sdk.read_client.MotionStatus

get_runtime_target_profile ​

python
RuntimeReadClient.get_runtime_target_profile(self) -> plexa_runtime_sdk.read_client.RuntimeTargetProfile

list_active_errors ​

python
RuntimeReadClient.list_active_errors(self) -> tuple[plexa_runtime_sdk.read_client.RuntimeErrorInfo, ...]

list_robots ​

python
RuntimeReadClient.list_robots(self) -> tuple[plexa_runtime_sdk.read_client.RobotInfo, ...]

preview_move_to_pose ​

python
RuntimeReadClient.preview_move_to_pose(self, robot_name: str, position_millimetres: tuple[float, float, float], quaternion: tuple[float, float, float, float], *, speed: float, group: str = '', coordinate_frame: str = 'SYSTEM_BASE') -> plexa_runtime_sdk.read_client.MotionPlanPreview

Request a plan preview. This method never submits or executes motion.

stream_current_joints ​

python
RuntimeReadClient.stream_current_joints(self, robot_name: str) -> plexa_runtime_sdk.read_client.JointStream

stream_current_pose ​

python
RuntimeReadClient.stream_current_pose(self, robot_name: str, group: str = '') -> plexa_runtime_sdk.read_client.PoseStream

RuntimeReadError ​

python
RuntimeReadError(code: grpc.StatusCode, details: str)

RuntimeTarget ​

python
RuntimeTarget(target_id: str, mode: str, enabled: bool, active: bool) -> None

RuntimeTargetProfile ​

python
RuntimeTargetProfile(targets: tuple[plexa_runtime_sdk.read_client.RuntimeTarget, ...], active_robot_system: plexa_runtime_sdk.read_client.RobotSystemProfile) -> None

TrajectorySample ​

python
TrajectorySample(positions_degrees: tuple[float, ...], velocities_degrees_per_second: tuple[float, ...], accelerations_degrees_per_second_squared: tuple[float, ...]) -> None