Module Contents



gRPC client for the PoseTracker component.

class viam.components.pose_tracker.client.PoseTrackerClient(name: str, channel: grpclib.client.Channel)[source]

Bases: viam.components.pose_tracker.pose_tracker.PoseTracker, viam.resource.rpc_client_base.ReconfigurableResourceRPCClientBase

gRPC client for the PoseTracker component.

async get_poses(body_names: List[str], *, extra: Mapping[str, Any] | None = None, timeout: float | None = None, **__) Dict[str, viam.proto.common.PoseInFrame][source]

Returns the current pose of each body tracked by the pose tracker.


body_names (List[str]) – Names of the bodies whose poses are being requested. In the event this parameter is not supplied or is an empty list, all available poses are returned.

async do_command(command: Mapping[str, viam.utils.ValueTypes], *, timeout: float | None = None, **__) Mapping[str, viam.utils.ValueTypes][source]

Send/Receive arbitrary commands to the Resource

command = {"cmd": "test", "data1": 500}
result =

command (Mapping[str, ValueTypes]) – The command to execute


NotImplementedError – Raised if the Resource does not support arbitrary commands


Result of the executed command

Return type:

Mapping[str, ValueTypes]

async get_geometries(*, extra: Dict[str, Any] | None = None, timeout: float | None = None) List[viam.proto.common.Geometry][source]

Get all geometries associated with the Component, in their current configuration, in the frame of the Component.

geometries = await component.get_geometries()

if geometries:
    # Get the center of the first geometry
    print(f"Pose of the first geometry's centerpoint: {geometries[0].center}")

The geometries associated with the Component.

Return type:


classmethod from_robot(robot: viam.robot.client.RobotClient, name: str) typing_extensions.Self

Get the component named name from the provided robot.

  • robot (RobotClient) – The robot

  • name (str) – The name of the component


The component, if it exists on the robot

Return type:


classmethod get_resource_name(name: str) viam.proto.common.ResourceName

Get the ResourceName for this Resource with the given name

# Can be used with any resource, using an arm as an example
my_arm_name = my_arm.get_resource_name("my_arm")

name (str) – The name of the Resource


The ResourceName of this Resource

Return type:


get_operation(kwargs: Mapping[str, Any]) viam.operations.Operation

Get the Operation associated with the currently running function.

When writing custom resources, you should get the Operation by calling this function and check to see if it’s cancelled. If the Operation is cancelled, then you can perform any necessary (terminating long running tasks, cleaning up connections, etc. ).


kwargs (Mapping[str, Any]) – The kwargs object containing the operation


The operation associated with this function

Return type:


async close()

Safely shut down the resource and prevent further use.

Close must be idempotent. Later configuration may allow a resource to be “open” again. If a resource does not want or need a close function, it is assumed that the resource does not need to return errors when future non-Close methods are called.

await component.close()