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
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
RuntimeClient.call_rpc(self, method: 'str', request: 'Message | dict | None' = None)close
RuntimeClient.close(self) -> Noneconfirm_all_runtime_errors
RuntimeClient.confirm_all_runtime_errors(self, request: 'common_pb2.EmptyRequest | dict | None' = None) -> 'common_pb2.OperationResult'ConfirmAllRuntimeErrors: EmptyRequest → OperationResult.
confirm_runtime_error
RuntimeClient.confirm_runtime_error(self, request: 'common_pb2.ConfirmRuntimeErrorRequest | dict | None' = None) -> 'common_pb2.OperationResult'ConfirmRuntimeError: ConfirmRuntimeErrorRequest → OperationResult.
delete_all_visualization_paths
RuntimeClient.delete_all_visualization_paths(self, request: 'common_pb2.EmptyRequest | dict | None' = None) -> 'common_pb2.OperationResult'DeleteAllVisualizationPaths: EmptyRequest → OperationResult.
delete_all_visualization_points
RuntimeClient.delete_all_visualization_points(self, request: 'common_pb2.EmptyRequest | dict | None' = None) -> 'common_pb2.OperationResult'DeleteAllVisualizationPoints: EmptyRequest → OperationResult.
execute_trajectory
RuntimeClient.execute_trajectory(self, request: 'control_pb2.ExecuteTrajectoryRequest | dict | None' = None) -> 'common_pb2.OperationResult'ExecuteTrajectory: ExecuteTrajectoryRequest → OperationResult.
forward_kinematics
RuntimeClient.forward_kinematics(self, request: 'control_pb2.ForwardKinematicsRequest | dict | None' = None) -> 'control_pb2.ForwardKinematicsResponse'ForwardKinematics: ForwardKinematicsRequest → ForwardKinematicsResponse.
get_collision_detection_status
RuntimeClient.get_collision_detection_status(self, request: 'common_pb2.EmptyRequest | dict | None' = None) -> 'common_pb2.CollisionDetectionStatus'GetCollisionDetectionStatus: EmptyRequest → CollisionDetectionStatus.
get_current_collision_geometry
RuntimeClient.get_current_collision_geometry(self, request: 'common_pb2.EmptyRequest | dict | None' = None) -> 'common_pb2.CollisionGeometry'GetCurrentCollisionGeometry: EmptyRequest → CollisionGeometry.
get_current_joints
RuntimeClient.get_current_joints(self, robot_name: str) -> plexa_runtime_sdk.read_client.JointAnglesDegreesget_current_pose
RuntimeClient.get_current_pose(self, robot_name: str, group: str = '') -> plexa_runtime_sdk.read_client.RobotPoseget_current_robot_joints
RuntimeClient.get_current_robot_joints(self, request: 'common_pb2.RobotSelectorRequest | dict | None' = None) -> 'common_pb2.JointAngles'GetCurrentRobotJoints: RobotSelectorRequest → JointAngles.
get_current_robot_position
RuntimeClient.get_current_robot_position(self, request: 'common_pb2.RobotSelectorRequest | dict | None' = None) -> 'common_pb2.RobotPose'GetCurrentRobotPosition: RobotSelectorRequest → RobotPose.
get_function_flag_status
RuntimeClient.get_function_flag_status(self, request: 'common_pb2.EmptyRequest | dict | None' = None) -> 'control_pb2.FunctionFlagStatusList'GetFunctionFlagStatus: EmptyRequest → FunctionFlagStatusList.
get_input
RuntimeClient.get_input(self, request: 'common_pb2.IoName | dict | None' = None) -> 'common_pb2.IntValue'GetInput: IoName → IntValue.
get_joint_activation_status
RuntimeClient.get_joint_activation_status(self, request: 'common_pb2.RobotSelectorRequest | dict | None' = None) -> 'control_pb2.JointActivationStatus'GetJointActivationStatus: RobotSelectorRequest → JointActivationStatus.
get_joint_initialization_status
RuntimeClient.get_joint_initialization_status(self, request: 'common_pb2.RobotSelectorRequest | dict | None' = None) -> 'common_pb2.JointInitializationStatus'GetJointInitializationStatus: RobotSelectorRequest → JointInitializationStatus.
get_motion_limit_profile
RuntimeClient.get_motion_limit_profile(self, request: 'common_pb2.EmptyRequest | dict | None' = None) -> 'common_pb2.MotionLimitProfile'GetMotionLimitProfile: EmptyRequest → MotionLimitProfile.
get_motion_status
RuntimeClient.get_motion_status(self, request: 'common_pb2.MotionStatusRequest | dict | None' = None) -> 'common_pb2.MotionStatus'GetMotionStatus: MotionStatusRequest → MotionStatus.
get_output
RuntimeClient.get_output(self, request: 'common_pb2.IoName | dict | None' = None) -> 'common_pb2.IntValue'GetOutput: IoName → IntValue.
get_runtime_target_profile
RuntimeClient.get_runtime_target_profile(self, request: 'common_pb2.EmptyRequest | dict | None' = None) -> 'common_pb2.RuntimeTargetProfile'GetRuntimeTargetProfile: EmptyRequest → RuntimeTargetProfile.
inverse_kinematics
RuntimeClient.inverse_kinematics(self, request: 'control_pb2.InverseKinematicsRequest | dict | None' = None) -> 'control_pb2.InverseKinematicsResponse'InverseKinematics: InverseKinematicsRequest → InverseKinematicsResponse.
jog_uninitialized_joint
RuntimeClient.jog_uninitialized_joint(self, request: 'control_pb2.UninitializedJointJogRequest | dict | None' = None) -> 'common_pb2.OperationResult'JogUninitializedJoint: UninitializedJointJogRequest → OperationResult.
list_active_errors
RuntimeClient.list_active_errors(self, request: 'common_pb2.EmptyRequest | dict | None' = None) -> 'common_pb2.RuntimeErrorList'ListActiveErrors: EmptyRequest → RuntimeErrorList.
list_robots
RuntimeClient.list_robots(self, request: 'common_pb2.EmptyRequest | dict | None' = None) -> 'common_pb2.RobotList'ListRobots: EmptyRequest → RobotList.
move_in_axis_direction
RuntimeClient.move_in_axis_direction(self, request: 'control_pb2.AxisMovementRequest | dict | None' = None) -> 'common_pb2.OperationResult'MoveInAxisDirection: AxisMovementRequest → OperationResult.
move_linear
RuntimeClient.move_linear(self, request: 'control_pb2.MoveToPoseRequest | dict | None' = None) -> 'common_pb2.OperationResult'MoveLinear: MoveToPoseRequest → OperationResult.
move_rigid_object
RuntimeClient.move_rigid_object(self, request: 'control_pb2.RigidObjectMotionRequest | dict | None' = None) -> 'common_pb2.OperationResult'MoveRigidObject: RigidObjectMotionRequest → OperationResult.
move_to_joints
RuntimeClient.move_to_joints(self, request: 'control_pb2.MoveToJointsRequest | dict | None' = None) -> 'common_pb2.OperationResult'MoveToJoints: MoveToJointsRequest → OperationResult.
move_to_pose
RuntimeClient.move_to_pose(self, request: 'control_pb2.MoveToPoseRequest | dict | None' = None) -> 'common_pb2.OperationResult'MoveToPose: MoveToPoseRequest → OperationResult.
plan_cartesian_trajectory
RuntimeClient.plan_cartesian_trajectory(self, request: 'control_pb2.PlanCartesianTrajectoryRequest | dict | None' = None) -> 'control_pb2.MotionPlan'PlanCartesianTrajectory: PlanCartesianTrajectoryRequest → MotionPlan.
preview_motion
RuntimeClient.preview_motion(self, request: 'control_pb2.PreviewMotionRequest | dict | None' = None) -> 'control_pb2.MotionPlan'PreviewMotion: PreviewMotionRequest → MotionPlan.
preview_move_to_pose
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.MotionPlanPreviewRequest a plan preview. This method never submits or executes motion.
preview_rigid_object_motion
RuntimeClient.preview_rigid_object_motion(self, request: 'control_pb2.RigidObjectMotionRequest | dict | None' = None) -> 'control_pb2.MotionPlan'PreviewRigidObjectMotion: RigidObjectMotionRequest → MotionPlan.
request_type
RuntimeClient.request_type(method: 'str')rotate_around_axis
RuntimeClient.rotate_around_axis(self, request: 'control_pb2.AxisMovementRequest | dict | None' = None) -> 'common_pb2.OperationResult'RotateAroundAxis: AxisMovementRequest → OperationResult.
rpc_methods
RuntimeClient.rpc_methods()set_collision_detection_enabled
RuntimeClient.set_collision_detection_enabled(self, request: 'common_pb2.SetCollisionDetectionEnabledRequest | dict | None' = None) -> 'common_pb2.OperationResult'SetCollisionDetectionEnabled: SetCollisionDetectionEnabledRequest → OperationResult.
set_joints_active
RuntimeClient.set_joints_active(self, request: 'control_pb2.JointActivationCommand | dict | None' = None) -> 'common_pb2.OperationResult'SetJointsActive: JointActivationCommand → OperationResult.
set_motion_limit_factor
RuntimeClient.set_motion_limit_factor(self, request: 'common_pb2.SetMotionLimitFactorRequest | dict | None' = None) -> 'common_pb2.OperationResult'SetMotionLimitFactor: SetMotionLimitFactorRequest → OperationResult.
set_output
RuntimeClient.set_output(self, request: 'common_pb2.IoValue | dict | None' = None) -> 'common_pb2.OperationResult'SetOutput: IoValue → OperationResult.
stop_motion
RuntimeClient.stop_motion(self, request: 'common_pb2.StopMotionRequest | dict | None' = None) -> 'common_pb2.OperationResult'StopMotion: StopMotionRequest → OperationResult.
stop_robot_motion
RuntimeClient.stop_robot_motion(self, request: 'common_pb2.RobotSelectorRequest | dict | None' = None) -> 'common_pb2.OperationResult'StopRobotMotion: RobotSelectorRequest → OperationResult.
stream_current_collision_geometry
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
RuntimeClient.stream_current_joints(self, robot_name: str) -> plexa_runtime_sdk.read_client.JointStreamstream_current_pose
RuntimeClient.stream_current_pose(self, robot_name: str, group: str = '') -> plexa_runtime_sdk.read_client.PoseStreamstream_current_robot_joints
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
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
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
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
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
RuntimeClient.switch_runtime_target(self, request: 'common_pb2.SwitchRuntimeTargetRequest | dict | None' = None) -> 'common_pb2.OperationResult'SwitchRuntimeTarget: SwitchRuntimeTargetRequest → OperationResult.
switch_simulation_robot
RuntimeClient.switch_simulation_robot(self, request: 'common_pb2.SwitchSimulationRobotRequest | dict | None' = None) -> 'common_pb2.OperationResult'SwitchSimulationRobot: SwitchSimulationRobotRequest → OperationResult.
upsert_visualization_path
RuntimeClient.upsert_visualization_path(self, request: 'control_pb2.VisualizationPath | dict | None' = None) -> 'common_pb2.OperationResult'UpsertVisualizationPath: VisualizationPath → OperationResult.
upsert_visualization_point
RuntimeClient.upsert_visualization_point(self, request: 'control_pb2.VisualizationPoint | dict | None' = None) -> 'common_pb2.OperationResult'UpsertVisualizationPoint: VisualizationPoint → OperationResult.
upsert_visualization_tracker
RuntimeClient.upsert_visualization_tracker(self, request: 'control_pb2.VisualizationTracker | dict | None' = None) -> 'common_pb2.OperationResult'UpsertVisualizationTracker: VisualizationTracker → OperationResult.
CONTRACT_REVISION
4002245f167f7dbd2e1d5ed34d315d724ca1ca70
CartesianPositionMillimetres
CartesianPositionMillimetres(x: float, y: float, z: float) -> NoneEulerAngles
EulerAngles(rx: float, ry: float, rz: float) -> NoneFunctionFlag
FunctionFlag(name: str, active: bool, position: int) -> NoneFunctionFlagStatus
FunctionFlagStatus(flags: tuple[plexa_runtime_sdk.read_client.FunctionFlag, ...], status_available: bool) -> NoneJointActivationStatus
JointActivationStatus(active: bool, status_available: bool) -> NoneJointAnglesDegrees
JointAnglesDegrees(values: tuple[float, ...]) -> NoneJointInitializationStatus
JointInitializationStatus(initialized: tuple[bool, ...], status_available: bool) -> NoneJointStream
JointStream(call, observer=None, rpc_method: str = '', trace=None)cancel
JointStream.cancel(self) -> NoneMotionLimitProfile
MotionLimitProfile(active_factor: float, maximum_factor: float) -> NoneMotionPlanPreview
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, ...]) -> NoneMotionStatus
MotionStatus(motion_id: str, robot_name: str, state: str, path_ratio: float, message: str) -> NonePoseStream
PoseStream(call, observer=None, rpc_method: str = '', trace=None)cancel
PoseStream.cancel(self) -> NoneRawRuntimeResponse
RawRuntimeResponse(rpc_method: str, received_at_ns: int, schema_name: str, schema_data: bytes, message_data: bytes) -> NoneSerialized Runtime protobuf response with its MCAP-ready schema and receive time.
Quaternion
Quaternion(q0: float, q1: float, q2: float, q3: float) -> NoneRobotInfo
RobotInfo(name: str, axis_count: int, model_id: str) -> NoneRobotPose
RobotPose(position: plexa_runtime_sdk.read_client.CartesianPositionMillimetres, quaternion: plexa_runtime_sdk.read_client.Quaternion, euler: plexa_runtime_sdk.read_client.EulerAngles) -> NoneRobotSystemModule
RobotSystemModule(module_id: str, robot_name: str, system_axis_indices: tuple[int, ...], kinematic_group: str) -> NoneRobotSystemProfile
RobotSystemProfile(profile_id: str, model_id: str, modules: tuple[plexa_runtime_sdk.read_client.RobotSystemModule, ...]) -> NoneRuntimeErrorInfo
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) -> NoneRuntimeReadClient
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
RuntimeReadClient.close(self) -> Noneget_current_joints
RuntimeReadClient.get_current_joints(self, robot_name: str) -> plexa_runtime_sdk.read_client.JointAnglesDegreesget_current_pose
RuntimeReadClient.get_current_pose(self, robot_name: str, group: str = '') -> plexa_runtime_sdk.read_client.RobotPoseget_function_flag_status
RuntimeReadClient.get_function_flag_status(self) -> plexa_runtime_sdk.read_client.FunctionFlagStatusget_joint_activation_status
RuntimeReadClient.get_joint_activation_status(self, robot_name: str) -> plexa_runtime_sdk.read_client.JointActivationStatusget_joint_initialization_status
RuntimeReadClient.get_joint_initialization_status(self, robot_name: str) -> plexa_runtime_sdk.read_client.JointInitializationStatusget_motion_limit_profile
RuntimeReadClient.get_motion_limit_profile(self) -> plexa_runtime_sdk.read_client.MotionLimitProfileget_motion_status
RuntimeReadClient.get_motion_status(self, motion_id: str) -> plexa_runtime_sdk.read_client.MotionStatusget_runtime_target_profile
RuntimeReadClient.get_runtime_target_profile(self) -> plexa_runtime_sdk.read_client.RuntimeTargetProfilelist_active_errors
RuntimeReadClient.list_active_errors(self) -> tuple[plexa_runtime_sdk.read_client.RuntimeErrorInfo, ...]list_robots
RuntimeReadClient.list_robots(self) -> tuple[plexa_runtime_sdk.read_client.RobotInfo, ...]preview_move_to_pose
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.MotionPlanPreviewRequest a plan preview. This method never submits or executes motion.
stream_current_joints
RuntimeReadClient.stream_current_joints(self, robot_name: str) -> plexa_runtime_sdk.read_client.JointStreamstream_current_pose
RuntimeReadClient.stream_current_pose(self, robot_name: str, group: str = '') -> plexa_runtime_sdk.read_client.PoseStreamRuntimeReadError
RuntimeReadError(code: grpc.StatusCode, details: str)RuntimeTarget
RuntimeTarget(target_id: str, mode: str, enabled: bool, active: bool) -> NoneRuntimeTargetProfile
RuntimeTargetProfile(targets: tuple[plexa_runtime_sdk.read_client.RuntimeTarget, ...], active_robot_system: plexa_runtime_sdk.read_client.RobotSystemProfile) -> NoneTrajectorySample
TrajectorySample(positions_degrees: tuple[float, ...], velocities_degrees_per_second: tuple[float, ...], accelerations_degrees_per_second_squared: tuple[float, ...]) -> None