viam.gen.common.v1.common_pb2

@generated by mypy-protobuf. Do not edit manually! isort:skip_file The following is a list of messages that are used across multiple resource subtypes

Attributes

`DESCRIPTOR`
`KINEMATICS_FILE_FORMAT_UNSPECIFIED`
`KINEMATICS_FILE_FORMAT_SVA`
`KINEMATICS_FILE_FORMAT_URDF`
`Global___KinematicsFileFormat`
`Global___ResourceName`
`Global___Pose`
`Global___Orientation`
`Global___PoseCloud`
`Global___PoseInFrame`
`Global___Vector3`
`Global___Sphere`
`Global___Capsule`
`Global___RectangularPrism`
`Global___Mesh`
`Global___PointCloud`
`Global___Geometry`
`Global___GeometriesInFrame`
`Global___PointCloudObject`
`Global___GeoPoint`
`Global___GeoGeometry`
`Global___Transform`
`Global___WorldState`
`Global___ActuatorStatus`
`Global___ResponseMetadata`
`Global___DoCommandRequest`
`Global___DoCommandResponse`
`Global___GetKinematicsRequest`
`Global___GetKinematicsResponse`
`Global___GetGeometriesRequest`
`Global___GetGeometriesResponse`
`Global___Get3DModelsRequest`
`Global___Get3DModelsResponse`
`Global___GetReadingsRequest`
`Global___GetReadingsResponse`
`Global___LogEntry`
`Global___AudioInfo`
`Global___GetPropertiesRequest`
`Global___GetPropertiesResponse`
`SAFETY_HEARTBEAT_MONITORED_FIELD_NUMBER`
`safety_heartbeat_monitored`	safety_heartbeat_monitored is used on methods to signify that if a session is in use

Classes

`KinematicsFileFormat`
`ResourceName`	Abstract base class for protocol messages.
`Pose`	Pose is a combination of location and orientation.
`Orientation`	Abstract base class for protocol messages.
`PoseCloud`	Abstract base class for protocol messages.
`PoseInFrame`	PoseInFrame contains a pose and the reference frame in which it was observed
`Vector3`	Abstract base class for protocol messages.
`Sphere`	Abstract base class for protocol messages.
`Capsule`	Abstract base class for protocol messages.
`RectangularPrism`	RectangularPrism contains a Vector3 field corresponding to the X, Y, Z dimensions of the prism in mms
`Mesh`	Abstract base class for protocol messages.
`PointCloud`	Abstract base class for protocol messages.
`Geometry`	Geometry contains the dimensions of a given geometry and the pose of its center. The geometry is one of either a sphere or a box.
`GeometriesInFrame`	GeometriesinFrame contains the dimensions of a given geometry, pose of its center point, and the reference frame by which it was
`PointCloudObject`	PointCloudObject contains an image in bytes with point cloud data of all of the objects captured by a given observer as well as a
`GeoPoint`	Abstract base class for protocol messages.
`GeoGeometry`	GeoGeometry contains information describing Geometry(s) that is located at a GeoPoint
`Transform`	Transform contains a pose and two reference frames. The first reference frame is the starting reference frame, and the second reference
`WorldState`	WorldState contains information about the physical environment around a given robot. All of the fields within this message are optional,
`ActuatorStatus`	ActuatorStatus is a generic status for resources that only need to return actuator status.
`ResponseMetadata`	Abstract base class for protocol messages.
`DoCommandRequest`	DoCommandRequest represents a generic DoCommand input
`DoCommandResponse`	DoCommandResponse represents a generic DoCommand output
`GetKinematicsRequest`	Abstract base class for protocol messages.
`GetKinematicsResponse`	Abstract base class for protocol messages.
`GetGeometriesRequest`	Abstract base class for protocol messages.
`GetGeometriesResponse`	Abstract base class for protocol messages.
`Get3DModelsRequest`	Abstract base class for protocol messages.
`Get3DModelsResponse`	Abstract base class for protocol messages.
`GetReadingsRequest`	Abstract base class for protocol messages.
`GetReadingsResponse`	Abstract base class for protocol messages.
`LogEntry`	Abstract base class for protocol messages.
`AudioInfo`	Information about an audio stream or device.
`GetPropertiesRequest`	Shared properties for AudioIn and AudioOut components.
`GetPropertiesResponse`	Abstract base class for protocol messages.

Module Contents

viam.gen.common.v1.common_pb2.DESCRIPTOR: google.protobuf.descriptor.FileDescriptor

class viam.gen.common.v1.common_pb2.KinematicsFileFormat: Bases: _KinematicsFileFormat

viam.gen.common.v1.common_pb2.KINEMATICS_FILE_FORMAT_UNSPECIFIED: KinematicsFileFormat

viam.gen.common.v1.common_pb2.KINEMATICS_FILE_FORMAT_SVA: KinematicsFileFormat

viam.gen.common.v1.common_pb2.KINEMATICS_FILE_FORMAT_URDF: KinematicsFileFormat

type viam.gen.common.v1.common_pb2.Global___KinematicsFileFormat = KinematicsFileFormat

class viam.gen.common.v1.common_pb2.ResourceName(*, namespace: str = ..., type: str = ..., subtype: str = ..., name: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

namespace: str

type: str

subtype: str

name: str

type viam.gen.common.v1.common_pb2.Global___ResourceName = ResourceName

class viam.gen.common.v1.common_pb2.Pose(*, x: float = ..., y: float = ..., z: float = ..., o_x: float = ..., o_y: float = ..., o_z: float = ..., theta: float = ...)

Bases: google.protobuf.message.Message

Pose is a combination of location and orientation. Location is expressed as distance which is represented by x , y, z coordinates. Orientation is expressed as an orientation vector which is represented by o_x, o_y, o_z and theta. The o_x, o_y, o_z coordinates represent the point on the cartesian unit sphere that the end of the arm is pointing to (with the origin as reference). That unit vector forms an axis around which theta rotates. This means that incrementing / decrementing theta will perform an inline rotation of the end effector. Theta is defined as rotation between two planes: the first being defined by the origin, the point (0,0,1), and the rx, ry, rz point, and the second being defined by the origin, the rx, ry, rz point and the local Z axis. Therefore, if theta is kept at zero as the north/south pole is circled, the Roll will correct itself to remain in-line.

x: float: millimeters from the origin

y: float: millimeters from the origin

z: float: millimeters from the origin

o_x: float: z component of a vector defining axis of rotation

o_y: float: x component of a vector defining axis of rotation

o_z: float: y component of a vector defining axis of rotation

theta: float: degrees

type viam.gen.common.v1.common_pb2.Global___Pose = Pose

class viam.gen.common.v1.common_pb2.Orientation(*, o_x: float = ..., o_y: float = ..., o_z: float = ..., theta: float = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

o_x: float: x component of a vector defining axis of rotation

o_y: float: y component of a vector defining axis of rotation

o_z: float: z component of a vector defining axis of rotation

theta: float: degrees

type viam.gen.common.v1.common_pb2.Global___Orientation = Orientation

class viam.gen.common.v1.common_pb2.PoseCloud(*, x: float = ..., y: float = ..., z: float = ..., o_x: float = ..., o_y: float = ..., o_z: float = ..., theta: float = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

x: float

y: float

z: float

o_x: float

o_y: float

o_z: float

theta: float

type viam.gen.common.v1.common_pb2.Global___PoseCloud = PoseCloud

class viam.gen.common.v1.common_pb2.PoseInFrame(*, reference_frame: str = ..., pose: Global___Pose | None = ..., goal_cloud: Global___PoseCloud | None = ...)

Bases: google.protobuf.message.Message

PoseInFrame contains a pose and the reference frame in which it was observed

reference_frame: str

pose() → Global___Pose

goal_cloud() → Global___PoseCloud

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__goal_cloud) → _WhichOneofReturnType__goal_cloud | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:: oneof_group (str) – the name of the oneof group to check.
Returns:: The name of the group that is set, or None.
Return type:: str or None
Raises:: ValueError – no group with the given name exists

type viam.gen.common.v1.common_pb2.Global___PoseInFrame = PoseInFrame

class viam.gen.common.v1.common_pb2.Vector3(*, x: float = ..., y: float = ..., z: float = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

x: float

y: float

z: float

type viam.gen.common.v1.common_pb2.Global___Vector3 = Vector3

class viam.gen.common.v1.common_pb2.Sphere(*, radius_mm: float = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

radius_mm: float

type viam.gen.common.v1.common_pb2.Global___Sphere = Sphere

class viam.gen.common.v1.common_pb2.Capsule(*, radius_mm: float = ..., length_mm: float = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

radius_mm: float

length_mm: float

type viam.gen.common.v1.common_pb2.Global___Capsule = Capsule

class viam.gen.common.v1.common_pb2.RectangularPrism(*, dims_mm: Global___Vector3 | None = ...)

Bases: google.protobuf.message.Message

RectangularPrism contains a Vector3 field corresponding to the X, Y, Z dimensions of the prism in mms These dimensions are with respect to the referenceframe in which the RectangularPrism is defined

dims_mm() → Global___Vector3

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

type viam.gen.common.v1.common_pb2.Global___RectangularPrism = RectangularPrism

class viam.gen.common.v1.common_pb2.Mesh(*, content_type: str = ..., mesh: bytes = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

content_type: str: Content type of mesh (e.g. ply)

mesh: bytes: Contents of mesh data in binary form defined by content_type

type viam.gen.common.v1.common_pb2.Global___Mesh = Mesh

class viam.gen.common.v1.common_pb2.PointCloud(*, point_cloud: bytes = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

point_cloud: bytes

type viam.gen.common.v1.common_pb2.Global___PointCloud = PointCloud

class viam.gen.common.v1.common_pb2.Geometry(*, center: Global___Pose | None = ..., sphere: Global___Sphere | None = ..., box: Global___RectangularPrism | None = ..., capsule: Global___Capsule | None = ..., mesh: Global___Mesh | None = ..., pointcloud: Global___PointCloud | None = ..., label: str = ...)

Bases: google.protobuf.message.Message

Geometry contains the dimensions of a given geometry and the pose of its center. The geometry is one of either a sphere or a box.

label: str: Label of the geometry. If none supplied, will be an empty string.

center() → Global___Pose: Pose of a geometries center point

sphere() → Global___Sphere

box() → Global___RectangularPrism

capsule() → Global___Capsule

mesh() → Global___Mesh

pointcloud() → Global___PointCloud

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType_geometry_type) → _WhichOneofReturnType_geometry_type | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:: oneof_group (str) – the name of the oneof group to check.
Returns:: The name of the group that is set, or None.
Return type:: str or None
Raises:: ValueError – no group with the given name exists

type viam.gen.common.v1.common_pb2.Global___Geometry = Geometry

class viam.gen.common.v1.common_pb2.GeometriesInFrame(*, reference_frame: str = ..., geometries: collections.abc.Iterable[Global___Geometry] | None = ...)

Bases: google.protobuf.message.Message

GeometriesinFrame contains the dimensions of a given geometry, pose of its center point, and the reference frame by which it was observed.

reference_frame: str: Reference frame of the observer of the geometry

geometries() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___Geometry]: Dimensional type

type viam.gen.common.v1.common_pb2.Global___GeometriesInFrame = GeometriesInFrame

class viam.gen.common.v1.common_pb2.PointCloudObject(*, point_cloud: bytes = ..., geometries: Global___GeometriesInFrame | None = ...)

Bases: google.protobuf.message.Message

PointCloudObject contains an image in bytes with point cloud data of all of the objects captured by a given observer as well as a repeated list of geometries which respresents the center point and geometry of each of the objects within the point cloud

point_cloud: bytes: image frame expressed in bytes

geometries() → Global___GeometriesInFrame: volume of a given geometry

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

type viam.gen.common.v1.common_pb2.Global___PointCloudObject = PointCloudObject

class viam.gen.common.v1.common_pb2.GeoPoint(*, latitude: float = ..., longitude: float = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

latitude: float

longitude: float

type viam.gen.common.v1.common_pb2.Global___GeoPoint = GeoPoint

class viam.gen.common.v1.common_pb2.GeoGeometry(*, location: Global___GeoPoint | None = ..., geometries: collections.abc.Iterable[Global___Geometry] | None = ...)

Bases: google.protobuf.message.Message

GeoGeometry contains information describing Geometry(s) that is located at a GeoPoint

location() → Global___GeoPoint: Location of the geometry

geometries() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___Geometry]: Geometries associated with the location, where embedded Pose data is with respect to the specified location

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

type viam.gen.common.v1.common_pb2.Global___GeoGeometry = GeoGeometry

class viam.gen.common.v1.common_pb2.Transform(*, reference_frame: str = ..., pose_in_observer_frame: Global___PoseInFrame | None = ..., physical_object: Global___Geometry | None = ..., uuid: bytes = ..., metadata: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Transform contains a pose and two reference frames. The first reference frame is the starting reference frame, and the second reference frame is the observer reference frame. The second reference frame has a pose which represents the pose of an object in the first reference frame as observed within the second reference frame.

reference_frame: str: the name of a given reference frame

uuid: bytes: The UUID of the transform

pose_in_observer_frame() → Global___PoseInFrame: the pose of the above reference frame with respect to a different observer reference frame

physical_object() → Global___Geometry

metadata() → google.protobuf.struct_pb2.Struct: Can hold information like color, opacity, points colors, collision_allowed, etc…

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__metadata) → _WhichOneofReturnType__metadata | None

WhichOneof(oneof_group: _WhichOneofArgType__physical_object) → _WhichOneofReturnType__physical_object | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:: oneof_group (str) – the name of the oneof group to check.
Returns:: The name of the group that is set, or None.
Return type:: str or None
Raises:: ValueError – no group with the given name exists

type viam.gen.common.v1.common_pb2.Global___Transform = Transform

class viam.gen.common.v1.common_pb2.WorldState(*, obstacles: collections.abc.Iterable[Global___GeometriesInFrame] | None = ..., transforms: collections.abc.Iterable[Global___Transform] | None = ...)

Bases: google.protobuf.message.Message

WorldState contains information about the physical environment around a given robot. All of the fields within this message are optional, they can include information about the physical dimensions of an obstacle, the freespace of a robot, and any desired transforms between a given reference frame and a new target reference frame.

obstacles() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___GeometriesInFrame]: a list of obstacles expressed as a geometry and the reference frame in which it was observed; this field is optional

transforms() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___Transform]: a list of Transforms, optionally with geometries. Used as supplemental transforms to transform a pose from one reference frame to another, or to attach moving geometries to the frame system. This field is optional

type viam.gen.common.v1.common_pb2.Global___WorldState = WorldState

class viam.gen.common.v1.common_pb2.ActuatorStatus(*, is_moving: bool = ...)

Bases: google.protobuf.message.Message

ActuatorStatus is a generic status for resources that only need to return actuator status.

is_moving: bool

type viam.gen.common.v1.common_pb2.Global___ActuatorStatus = ActuatorStatus

class viam.gen.common.v1.common_pb2.ResponseMetadata(*, captured_at: google.protobuf.timestamp_pb2.Timestamp | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

captured_at() → google.protobuf.timestamp_pb2.Timestamp: captured_at is the time at which the resource as close as physically possible, captured the data in the response. Note: If correlating between other resources, be sure that the means of measuring the capture are similar enough such that comparison can be made between them.

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__captured_at) → _WhichOneofReturnType__captured_at | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:: oneof_group (str) – the name of the oneof group to check.
Returns:: The name of the group that is set, or None.
Return type:: str or None
Raises:: ValueError – no group with the given name exists

type viam.gen.common.v1.common_pb2.Global___ResponseMetadata = ResponseMetadata

class viam.gen.common.v1.common_pb2.DoCommandRequest(*, name: str = ..., command: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

DoCommandRequest represents a generic DoCommand input

name: str

command() → google.protobuf.struct_pb2.Struct

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

type viam.gen.common.v1.common_pb2.Global___DoCommandRequest = DoCommandRequest

class viam.gen.common.v1.common_pb2.DoCommandResponse(*, result: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

DoCommandResponse represents a generic DoCommand output

result() → google.protobuf.struct_pb2.Struct

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

type viam.gen.common.v1.common_pb2.Global___DoCommandResponse = DoCommandResponse

class viam.gen.common.v1.common_pb2.GetKinematicsRequest(*, name: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

name: str: The component name

extra() → google.protobuf.struct_pb2.Struct: Additional arguments to the method

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

type viam.gen.common.v1.common_pb2.Global___GetKinematicsRequest = GetKinematicsRequest

class viam.gen.common.v1.common_pb2.GetKinematicsResponse(*, format: Global___KinematicsFileFormat = ..., kinematics_data: bytes = ..., meshes_by_urdf_filepath: collections.abc.Mapping[str, Global___Mesh] | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

class MeshesByUrdfFilepathEntry(*, key: str = ..., value: Global___Mesh | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

key: str

value() → Global___Mesh

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

format: Global___KinematicsFileFormat: The kinematics of the component, in either URDF format or in Viam’s kinematic parameter format (spatial vector algebra) https://docs.viam.com/internals/kinematic-chain-config/#kinematic-parameters

kinematics_data: bytes: The byte contents of the file

meshes_by_urdf_filepath() → google.protobuf.internal.containers.MessageMap[str, Global___Mesh]: Map of URDF mesh file paths to mesh data

type viam.gen.common.v1.common_pb2.Global___GetKinematicsResponse = GetKinematicsResponse

class viam.gen.common.v1.common_pb2.GetGeometriesRequest(*, name: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

name: str: The component name

extra() → google.protobuf.struct_pb2.Struct: Additional arguments to the method

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

type viam.gen.common.v1.common_pb2.Global___GetGeometriesRequest = GetGeometriesRequest

class viam.gen.common.v1.common_pb2.GetGeometriesResponse(*, geometries: collections.abc.Iterable[Global___Geometry] | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

geometries() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___Geometry]: All geometries associated with the component, in their current configuration, in the frame of that component.

type viam.gen.common.v1.common_pb2.Global___GetGeometriesResponse = GetGeometriesResponse

class viam.gen.common.v1.common_pb2.Get3DModelsRequest(*, name: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

name: str: The component name

extra() → google.protobuf.struct_pb2.Struct: Additional arguments to the method

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

type viam.gen.common.v1.common_pb2.Global___Get3DModelsRequest = Get3DModelsRequest

class viam.gen.common.v1.common_pb2.Get3DModelsResponse(*, models: collections.abc.Mapping[str, Global___Mesh] | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

class ModelsEntry(*, key: str = ..., value: Global___Mesh | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

key: str

value() → Global___Mesh

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

models() → google.protobuf.internal.containers.MessageMap[str, Global___Mesh]: the 3D models associated with the component

type viam.gen.common.v1.common_pb2.Global___Get3DModelsResponse = Get3DModelsResponse

class viam.gen.common.v1.common_pb2.GetReadingsRequest(*, name: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

name: str: Name of a sensor

extra() → google.protobuf.struct_pb2.Struct: Additional arguments to the method

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

type viam.gen.common.v1.common_pb2.Global___GetReadingsRequest = GetReadingsRequest

class viam.gen.common.v1.common_pb2.GetReadingsResponse(*, readings: collections.abc.Mapping[str, google.protobuf.struct_pb2.Value] | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

class ReadingsEntry(*, key: str = ..., value: google.protobuf.struct_pb2.Value | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

key: str

value() → google.protobuf.struct_pb2.Value

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

readings() → google.protobuf.internal.containers.MessageMap[str, google.protobuf.struct_pb2.Value]

type viam.gen.common.v1.common_pb2.Global___GetReadingsResponse = GetReadingsResponse

class viam.gen.common.v1.common_pb2.LogEntry(*, host: str = ..., level: str = ..., time: google.protobuf.timestamp_pb2.Timestamp | None = ..., logger_name: str = ..., message: str = ..., caller: google.protobuf.struct_pb2.Struct | None = ..., stack: str = ..., fields: collections.abc.Iterable[google.protobuf.struct_pb2.Struct] | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

host: str

level: str

logger_name: str

message: str

stack: str

time() → google.protobuf.timestamp_pb2.Timestamp

caller() → google.protobuf.struct_pb2.Struct

fields() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[google.protobuf.struct_pb2.Struct]

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

type viam.gen.common.v1.common_pb2.Global___LogEntry = LogEntry

class viam.gen.common.v1.common_pb2.AudioInfo(*, codec: str = ..., sample_rate_hz: int = ..., num_channels: int = ...)

Bases: google.protobuf.message.Message

Information about an audio stream or device.

codec: str: Audio codec used for the stream or device (e.g., “pcm16”, “pcm32float”, “mp3”)

sample_rate_hz: int: Sample rate of the audio in Hz

num_channels: int: Number of audio channels in the recording or playback

type viam.gen.common.v1.common_pb2.Global___AudioInfo = AudioInfo

class viam.gen.common.v1.common_pb2.GetPropertiesRequest(*, name: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Shared properties for AudioIn and AudioOut components.

name: str

extra() → google.protobuf.struct_pb2.Struct

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

type viam.gen.common.v1.common_pb2.Global___GetPropertiesRequest = GetPropertiesRequest

class viam.gen.common.v1.common_pb2.GetPropertiesResponse(*, supported_codecs: collections.abc.Iterable[str] | None = ..., sample_rate_hz: int = ..., num_channels: int = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

sample_rate_hz: int: current sample rate in Hz

num_channels: int: Maximum number of audio channels supported (e.g., 1 for mono, 2 for stereo)

supported_codecs() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]: List of audio codecs supported by the system (e.g., “mp3”, “pcm16”, “pcm32float”)

type viam.gen.common.v1.common_pb2.Global___GetPropertiesResponse = GetPropertiesResponse

viam.gen.common.v1.common_pb2.SAFETY_HEARTBEAT_MONITORED_FIELD_NUMBER: int

viam.gen.common.v1.common_pb2.safety_heartbeat_monitored: google.protobuf.internal.extension_dict._ExtensionFieldDescriptor[google.protobuf.descriptor_pb2.MethodOptions, bool]: safety_heartbeat_monitored is used on methods to signify that if a session is in use and the session was the last to call this method, the resource associated with the method will be stopped.