Module Contents



Camera represents any physical hardware that can capture frames.

class str)[source]

Bases: viam.components.component_base.ComponentBase

Camera represents any physical hardware that can capture frames.

This acts as an abstract base class for any drivers representing specific camera implementations. This cannot be used on its own. If the __init__() function is overridden, it must call the super().__init__() function.

class Properties[source]

Bases: NamedTuple

The camera’s supported features and settings

supports_pcd: bool

Whether the camera has a valid implementation of get_point_cloud


The properties of the camera


The distortion parameters of the camera

abstract async get_image(mime_type: str = '', *, extra: Optional[Dict[str, Any]] = None, timeout: Optional[float] = None, **kwargs) Union[PIL.Image.Image,][source]

Get the next image from the camera as an Image or RawImage. Be sure to close the image when finished.

NOTE: If the mime type is image/vnd.viam.dep you can use to convert the data to a standard representation.


mime_type (str) – The desired mime type of the image. This does not guarantee output type


The frame

Return type:

Image | RawImage

abstract async get_images(*, timeout: Optional[float] = None, **kwargs) Tuple[List[], viam.proto.common.ResponseMetadata][source]

Get simultaneous images from different imagers, along with associated metadata. This should not be used for getting a time series of images from the same imager.


  • List[NamedImage]: The list of images returned from the camera system.

  • ResponseMetadata: The metadata associated with this response

Return type:

Tuple[List[NamedImage], ResponseMetadata]

abstract async get_point_cloud(*, extra: Optional[Dict[str, Any]] = None, timeout: Optional[float] = None, **kwargs) Tuple[bytes, str][source]

Get the next point cloud from the camera. This will be returned as bytes with a mimetype describing the structure of the data. The consumer of this call should encode the bytes into the formatted suggested by the mimetype.

To deserialize the returned information into a numpy array, use the Open3D library.

import numpy as np
import open3d as o3d

data, _ = await camera.get_point_cloud()

# write the point cloud into a temporary file
with open("/tmp/pointcloud_data.pcd", "wb") as f:
pcd ="/tmp/pointcloud_data.pcd")
points = np.asarray(pcd.points)

The pointcloud data. str: The mimetype of the pointcloud (e.g. PCD).

Return type:


abstract async get_properties(*, timeout: Optional[float] = None, **kwargs) Properties[source]

Get the camera intrinsic parameters and camera distortion parameters


The properties of the camera

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:


abstract async do_command(command: Mapping[str, ValueTypes], *, timeout: Optional[float] = None, **kwargs) Mapping[str, ValueTypes]

Send/Receive arbitrary commands to the Resource


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: Optional[Dict[str, Any]] = None, timeout: Optional[float] = None) List[viam.proto.common.Geometry]

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


The geometries associated with the Component.

Return type:


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

Get the ResourceName for this Resource with the given name


name (str) – The name of the Resource

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 retun errors when future non-Close methods are called.