viam.proto.robot

@generated by Viam. Do not edit manually!

Classes

`RobotServiceBase`	Helper class that provides a standard way to create an ABC using
`RobotServiceStub`
`UnimplementedRobotServiceBase`	Helper class that provides a standard way to create an ABC using
`BlockForOperationRequest`	Abstract base class for protocol messages.
`BlockForOperationResponse`	Abstract base class for protocol messages.
`CancelOperationRequest`	Abstract base class for protocol messages.
`CancelOperationResponse`	Abstract base class for protocol messages.
`ConfigStatus`	Abstract base class for protocol messages.
`DiscoverComponentsRequest`	Abstract base class for protocol messages.
`DiscoverComponentsResponse`	Abstract base class for protocol messages.
`Discovery`	Abstract base class for protocol messages.
`DiscoveryQuery`	Discovery
`FrameSystemConfig`	this is an experimental API message
`FrameSystemConfigRequest`	Abstract base class for protocol messages.
`FrameSystemConfigResponse`	Abstract base class for protocol messages.
`GetCloudMetadataRequest`	Abstract base class for protocol messages.
`GetCloudMetadataResponse`	Abstract base class for protocol messages.
`GetMachineStatusRequest`	Abstract base class for protocol messages.
`GetMachineStatusResponse`	Abstract base class for protocol messages.
`GetOperationsRequest`	Abstract base class for protocol messages.
`GetOperationsResponse`	Abstract base class for protocol messages.
`GetSessionsRequest`	Abstract base class for protocol messages.
`GetSessionsResponse`	Abstract base class for protocol messages.
`GetStatusRequest`	Abstract base class for protocol messages.
`GetStatusResponse`	Abstract base class for protocol messages.
`GetVersionRequest`	Abstract base class for protocol messages.
`GetVersionResponse`	Abstract base class for protocol messages.
`LogRequest`	Abstract base class for protocol messages.
`LogResponse`	Abstract base class for protocol messages.
`Operation`	Abstract base class for protocol messages.
`PeerConnectionInfo`	Abstract base class for protocol messages.
`PeerConnectionType`
`ResourceNamesRequest`	Abstract base class for protocol messages.
`ResourceNamesResponse`	Abstract base class for protocol messages.
`ResourceRPCSubtype`	Abstract base class for protocol messages.
`ResourceRPCSubtypesRequest`	Abstract base class for protocol messages.
`ResourceRPCSubtypesResponse`	Abstract base class for protocol messages.
`ResourceStatus`	Abstract base class for protocol messages.
`RestartModuleRequest`	Abstract base class for protocol messages.
`RestartModuleResponse`	Abstract base class for protocol messages.
`SendSessionHeartbeatRequest`	Abstract base class for protocol messages.
`SendSessionHeartbeatResponse`	Abstract base class for protocol messages.
`Session`	Abstract base class for protocol messages.
`ShutdownRequest`	Abstract base class for protocol messages.
`ShutdownResponse`	Abstract base class for protocol messages.
`StartSessionRequest`	Abstract base class for protocol messages.
`StartSessionResponse`	Abstract base class for protocol messages.
`Status`	Abstract base class for protocol messages.
`StopAllRequest`	Abstract base class for protocol messages.
`StopAllResponse`	Abstract base class for protocol messages.
`StopExtraParameters`	Abstract base class for protocol messages.
`StreamStatusRequest`	Abstract base class for protocol messages.
`StreamStatusResponse`	Abstract base class for protocol messages.
`TransformPCDRequest`	Abstract base class for protocol messages.
`TransformPCDResponse`	Abstract base class for protocol messages.
`TransformPoseRequest`	Abstract base class for protocol messages.
`TransformPoseResponse`	Abstract base class for protocol messages.

Package Contents

class viam.proto.robot.RobotServiceBase[source]

Bases: abc.ABC

Helper class that provides a standard way to create an ABC using inheritance.

abstract GetOperations(stream: grpclib.server.Stream[robot.v1.robot_pb2.GetOperationsRequest, robot.v1.robot_pb2.GetOperationsResponse]) → None[source]

Async:

abstract GetSessions(stream: grpclib.server.Stream[robot.v1.robot_pb2.GetSessionsRequest, robot.v1.robot_pb2.GetSessionsResponse]) → None[source]

Async:

abstract ResourceNames(stream: grpclib.server.Stream[robot.v1.robot_pb2.ResourceNamesRequest, robot.v1.robot_pb2.ResourceNamesResponse]) → None[source]

Async:

abstract ResourceRPCSubtypes(stream: grpclib.server.Stream[robot.v1.robot_pb2.ResourceRPCSubtypesRequest, robot.v1.robot_pb2.ResourceRPCSubtypesResponse]) → None[source]

Async:

abstract CancelOperation(stream: grpclib.server.Stream[robot.v1.robot_pb2.CancelOperationRequest, robot.v1.robot_pb2.CancelOperationResponse]) → None[source]

Async:

abstract BlockForOperation(stream: grpclib.server.Stream[robot.v1.robot_pb2.BlockForOperationRequest, robot.v1.robot_pb2.BlockForOperationResponse]) → None[source]

Async:

abstract DiscoverComponents(stream: grpclib.server.Stream[robot.v1.robot_pb2.DiscoverComponentsRequest, robot.v1.robot_pb2.DiscoverComponentsResponse]) → None[source]

Async:

abstract FrameSystemConfig(stream: grpclib.server.Stream[robot.v1.robot_pb2.FrameSystemConfigRequest, robot.v1.robot_pb2.FrameSystemConfigResponse]) → None[source]

Async:

abstract TransformPose(stream: grpclib.server.Stream[robot.v1.robot_pb2.TransformPoseRequest, robot.v1.robot_pb2.TransformPoseResponse]) → None[source]

Async:

abstract TransformPCD(stream: grpclib.server.Stream[robot.v1.robot_pb2.TransformPCDRequest, robot.v1.robot_pb2.TransformPCDResponse]) → None[source]

Async:

abstract GetStatus(stream: grpclib.server.Stream[robot.v1.robot_pb2.GetStatusRequest, robot.v1.robot_pb2.GetStatusResponse]) → None[source]

Async:

abstract StreamStatus(stream: grpclib.server.Stream[robot.v1.robot_pb2.StreamStatusRequest, robot.v1.robot_pb2.StreamStatusResponse]) → None[source]

Async:

abstract StopAll(stream: grpclib.server.Stream[robot.v1.robot_pb2.StopAllRequest, robot.v1.robot_pb2.StopAllResponse]) → None[source]

Async:

abstract StartSession(stream: grpclib.server.Stream[robot.v1.robot_pb2.StartSessionRequest, robot.v1.robot_pb2.StartSessionResponse]) → None[source]

Async:

abstract SendSessionHeartbeat(stream: grpclib.server.Stream[robot.v1.robot_pb2.SendSessionHeartbeatRequest, robot.v1.robot_pb2.SendSessionHeartbeatResponse]) → None[source]

Async:

abstract Log(stream: grpclib.server.Stream[robot.v1.robot_pb2.LogRequest, robot.v1.robot_pb2.LogResponse]) → None[source]

Async:

abstract GetCloudMetadata(stream: grpclib.server.Stream[robot.v1.robot_pb2.GetCloudMetadataRequest, robot.v1.robot_pb2.GetCloudMetadataResponse]) → None[source]

Async:

abstract RestartModule(stream: grpclib.server.Stream[robot.v1.robot_pb2.RestartModuleRequest, robot.v1.robot_pb2.RestartModuleResponse]) → None[source]

Async:

abstract Shutdown(stream: grpclib.server.Stream[robot.v1.robot_pb2.ShutdownRequest, robot.v1.robot_pb2.ShutdownResponse]) → None[source]

Async:

abstract GetMachineStatus(stream: grpclib.server.Stream[robot.v1.robot_pb2.GetMachineStatusRequest, robot.v1.robot_pb2.GetMachineStatusResponse]) → None[source]

Async:

abstract GetVersion(stream: grpclib.server.Stream[robot.v1.robot_pb2.GetVersionRequest, robot.v1.robot_pb2.GetVersionResponse]) → None[source]

Async:

__mapping__() → Dict[str, grpclib.const.Handler][source]

class viam.proto.robot.RobotServiceStub(channel: grpclib.client.Channel)[source]

GetOperations

GetSessions

ResourceNames

ResourceRPCSubtypes

CancelOperation

BlockForOperation

DiscoverComponents

FrameSystemConfig

TransformPose

TransformPCD

GetStatus

StreamStatus

StopAll

StartSession

SendSessionHeartbeat

Log

GetCloudMetadata

RestartModule

Shutdown

GetMachineStatus

GetVersion

class viam.proto.robot.UnimplementedRobotServiceBase[source]

Bases: RobotServiceBase

Helper class that provides a standard way to create an ABC using inheritance.

async GetOperations(stream: grpclib.server.Stream[robot.v1.robot_pb2.GetOperationsRequest, robot.v1.robot_pb2.GetOperationsResponse]) → None[source]

async GetSessions(stream: grpclib.server.Stream[robot.v1.robot_pb2.GetSessionsRequest, robot.v1.robot_pb2.GetSessionsResponse]) → None[source]

async ResourceNames(stream: grpclib.server.Stream[robot.v1.robot_pb2.ResourceNamesRequest, robot.v1.robot_pb2.ResourceNamesResponse]) → None[source]

async ResourceRPCSubtypes(stream: grpclib.server.Stream[robot.v1.robot_pb2.ResourceRPCSubtypesRequest, robot.v1.robot_pb2.ResourceRPCSubtypesResponse]) → None[source]

async CancelOperation(stream: grpclib.server.Stream[robot.v1.robot_pb2.CancelOperationRequest, robot.v1.robot_pb2.CancelOperationResponse]) → None[source]

async BlockForOperation(stream: grpclib.server.Stream[robot.v1.robot_pb2.BlockForOperationRequest, robot.v1.robot_pb2.BlockForOperationResponse]) → None[source]

async DiscoverComponents(stream: grpclib.server.Stream[robot.v1.robot_pb2.DiscoverComponentsRequest, robot.v1.robot_pb2.DiscoverComponentsResponse]) → None[source]

async FrameSystemConfig(stream: grpclib.server.Stream[robot.v1.robot_pb2.FrameSystemConfigRequest, robot.v1.robot_pb2.FrameSystemConfigResponse]) → None[source]

async TransformPose(stream: grpclib.server.Stream[robot.v1.robot_pb2.TransformPoseRequest, robot.v1.robot_pb2.TransformPoseResponse]) → None[source]

async TransformPCD(stream: grpclib.server.Stream[robot.v1.robot_pb2.TransformPCDRequest, robot.v1.robot_pb2.TransformPCDResponse]) → None[source]

async GetStatus(stream: grpclib.server.Stream[robot.v1.robot_pb2.GetStatusRequest, robot.v1.robot_pb2.GetStatusResponse]) → None[source]

async StreamStatus(stream: grpclib.server.Stream[robot.v1.robot_pb2.StreamStatusRequest, robot.v1.robot_pb2.StreamStatusResponse]) → None[source]

async StopAll(stream: grpclib.server.Stream[robot.v1.robot_pb2.StopAllRequest, robot.v1.robot_pb2.StopAllResponse]) → None[source]

async StartSession(stream: grpclib.server.Stream[robot.v1.robot_pb2.StartSessionRequest, robot.v1.robot_pb2.StartSessionResponse]) → None[source]

async SendSessionHeartbeat(stream: grpclib.server.Stream[robot.v1.robot_pb2.SendSessionHeartbeatRequest, robot.v1.robot_pb2.SendSessionHeartbeatResponse]) → None[source]

async Log(stream: grpclib.server.Stream[robot.v1.robot_pb2.LogRequest, robot.v1.robot_pb2.LogResponse]) → None[source]

async GetCloudMetadata(stream: grpclib.server.Stream[robot.v1.robot_pb2.GetCloudMetadataRequest, robot.v1.robot_pb2.GetCloudMetadataResponse]) → None[source]

async RestartModule(stream: grpclib.server.Stream[robot.v1.robot_pb2.RestartModuleRequest, robot.v1.robot_pb2.RestartModuleResponse]) → None[source]

async Shutdown(stream: grpclib.server.Stream[robot.v1.robot_pb2.ShutdownRequest, robot.v1.robot_pb2.ShutdownResponse]) → None[source]

async GetMachineStatus(stream: grpclib.server.Stream[robot.v1.robot_pb2.GetMachineStatusRequest, robot.v1.robot_pb2.GetMachineStatusResponse]) → None[source]

async GetVersion(stream: grpclib.server.Stream[robot.v1.robot_pb2.GetVersionRequest, robot.v1.robot_pb2.GetVersionResponse]) → None[source]

class viam.proto.robot.BlockForOperationRequest(*, id: 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.

id: str

class viam.proto.robot.BlockForOperationResponse

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 viam.proto.robot.CancelOperationRequest(*, id: 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.

id: str

class viam.proto.robot.CancelOperationResponse

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 viam.proto.robot.ConfigStatus(*, revision: str = ..., last_updated: 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.

revision: str: revision of the last config that the machine successfully ingested.

property last_updated: google.protobuf.timestamp_pb2.Timestamp: config ingestion timestamp.

HasField(field_name: Literal['last_updated', b'last_updated']) → 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.

class viam.proto.robot.DiscoverComponentsRequest(*, queries: collections.abc.Iterable[global___DiscoveryQuery] | 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.

property queries: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___DiscoveryQuery]

class viam.proto.robot.DiscoverComponentsResponse(*, discovery: collections.abc.Iterable[global___Discovery] | 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.

property discovery: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Discovery]

class viam.proto.robot.Discovery(*, query: global___DiscoveryQuery | None = ..., results: 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.

property query: global___DiscoveryQuery

property results: google.protobuf.struct_pb2.Struct

HasField(field_name: Literal['query', b'query', 'results', b'results']) → 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.

class viam.proto.robot.DiscoveryQuery(*, subtype: str = ..., model: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Discovery

subtype: str

model: str

property extra: google.protobuf.struct_pb2.Struct

HasField(field_name: Literal['extra', b'extra']) → 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.

class viam.proto.robot.FrameSystemConfig(*, frame: viam.gen.common.v1.common_pb2.Transform | None = ..., kinematics: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

this is an experimental API message

property frame: viam.gen.common.v1.common_pb2.Transform

property kinematics: google.protobuf.struct_pb2.Struct

HasField(field_name: Literal['frame', b'frame', 'kinematics', b'kinematics']) → 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.

class viam.proto.robot.FrameSystemConfigRequest(*, supplemental_transforms: collections.abc.Iterable[viam.gen.common.v1.common_pb2.Transform] | 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.

property supplemental_transforms: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[viam.gen.common.v1.common_pb2.Transform]: pose information on any additional reference frames that are needed to supplement the robot’s frame system

class viam.proto.robot.FrameSystemConfigResponse(*, frame_system_configs: collections.abc.Iterable[global___FrameSystemConfig] | 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.

property frame_system_configs: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___FrameSystemConfig]

class viam.proto.robot.GetCloudMetadataRequest

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 viam.proto.robot.GetCloudMetadataResponse(*, robot_part_id: str = ..., primary_org_id: str = ..., location_id: str = ..., machine_id: str = ..., machine_part_id: 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.

robot_part_id: str

use machine_part_id field.

Type:: Deprecated

primary_org_id: str

location_id: str

machine_id: str

machine_part_id: str

class viam.proto.robot.GetMachineStatusRequest

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 viam.proto.robot.GetMachineStatusResponse(*, resources: collections.abc.Iterable[global___ResourceStatus] | None = ..., config: global___ConfigStatus | None = ..., state: global___GetMachineStatusResponse = ...)

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 State: Bases: _State

STATE_UNSPECIFIED: GetMachineStatusResponse

STATE_INITIALIZING: GetMachineStatusResponse: the machine is reachable but still in the process of configuring initial modules and resources.

STATE_RUNNING: GetMachineStatusResponse: the machine has finished initializing.

state: global___GetMachineStatusResponse.State.ValueType

property resources: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___ResourceStatus]

property config: global___ConfigStatus

HasField(field_name: Literal['config', b'config']) → 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.

class viam.proto.robot.GetOperationsRequest

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 viam.proto.robot.GetOperationsResponse(*, operations: collections.abc.Iterable[global___Operation] | 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.

property operations: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Operation]

class viam.proto.robot.GetSessionsRequest

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 viam.proto.robot.GetSessionsResponse(*, sessions: collections.abc.Iterable[global___Session] | 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.

property sessions: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Session]

class viam.proto.robot.GetStatusRequest(*, resource_names: collections.abc.Iterable[viam.gen.common.v1.common_pb2.ResourceName] | 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.

property resource_names: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[viam.gen.common.v1.common_pb2.ResourceName]

class viam.proto.robot.GetStatusResponse(*, status: collections.abc.Iterable[global___Status] | 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.

property status: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Status]

class viam.proto.robot.GetVersionRequest

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 viam.proto.robot.GetVersionResponse(*, platform: str = ..., version: str = ..., api_version: 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.

platform: str: platform type of viam-server (ie. rdk or micro-rdk).

version: str: version of viam-server. If built without a version, it will be dev-<git hash>.

api_version: str

class viam.proto.robot.LogRequest(*, logs: collections.abc.Iterable[viam.gen.common.v1.common_pb2.LogEntry] | 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.

property logs: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[viam.gen.common.v1.common_pb2.LogEntry]

class viam.proto.robot.LogResponse

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 viam.proto.robot.Operation(*, id: str = ..., method: str = ..., arguments: google.protobuf.struct_pb2.Struct | None = ..., started: google.protobuf.timestamp_pb2.Timestamp | None = ..., session_id: str | 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.

id: str

method: str

session_id: str

property arguments: google.protobuf.struct_pb2.Struct

property started: google.protobuf.timestamp_pb2.Timestamp

HasField(field_name: Literal['_session_id', b'_session_id', 'arguments', b'arguments', 'session_id', b'session_id', 'started', b'started']) → 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: Literal['_session_id', b'_session_id']) → Literal['session_id'] | 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

class viam.proto.robot.PeerConnectionInfo(*, type: global___PeerConnectionType = ..., remote_address: str | None = ..., local_address: str | 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.

type: global___PeerConnectionType

remote_address: str

local_address: str

HasField(field_name: Literal['_local_address', b'_local_address', '_remote_address', b'_remote_address', 'local_address', b'local_address', 'remote_address', b'remote_address']) → 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: Literal['_local_address', b'_local_address']) → Literal['local_address'] | None

WhichOneof(oneof_group: Literal['_remote_address', b'_remote_address']) → Literal['remote_address'] | 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

class viam.proto.robot.PeerConnectionType: Bases: _PeerConnectionType

class viam.proto.robot.ResourceNamesRequest

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 viam.proto.robot.ResourceNamesResponse(*, resources: collections.abc.Iterable[viam.gen.common.v1.common_pb2.ResourceName] | 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.

property resources: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[viam.gen.common.v1.common_pb2.ResourceName]

class viam.proto.robot.ResourceRPCSubtype(*, subtype: viam.gen.common.v1.common_pb2.ResourceName | None = ..., proto_service: 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.

proto_service: str

property subtype: viam.gen.common.v1.common_pb2.ResourceName

HasField(field_name: Literal['subtype', b'subtype']) → 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.

class viam.proto.robot.ResourceRPCSubtypesRequest

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 viam.proto.robot.ResourceRPCSubtypesResponse(*, resource_rpc_subtypes: collections.abc.Iterable[global___ResourceRPCSubtype] | 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.

property resource_rpc_subtypes: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___ResourceRPCSubtype]

class viam.proto.robot.ResourceStatus(*, name: viam.gen.common.v1.common_pb2.ResourceName | None = ..., state: global___ResourceStatus = ..., last_updated: google.protobuf.timestamp_pb2.Timestamp | None = ..., revision: str = ..., error: str = ..., cloud_metadata: global___GetCloudMetadataResponse | 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 State: Bases: _State

STATE_UNSPECIFIED: ResourceStatus

STATE_UNCONFIGURED: ResourceStatus: a newly created resource.

STATE_CONFIGURING: ResourceStatus: a resource that is being configured.

STATE_READY: ResourceStatus: a resource that has been successfully configured once, and is not re-configuring, being removed, or unhealthy.

STATE_REMOVING: ResourceStatus: a resource that is being removed from the robot.

STATE_UNHEALTHY: ResourceStatus: a resource that is in an unhealthy state.

state: global___ResourceStatus.State.ValueType: current state.

revision: str: revision of the last config that successfully updated this resource.

error: str: error details for a resource. This is guaranteed to be null if the resource is ready and non-null if the resource unhealthy.

property name: viam.gen.common.v1.common_pb2.ResourceName: resource name.

property last_updated: google.protobuf.timestamp_pb2.Timestamp: state transition timestamp.

property cloud_metadata: global___GetCloudMetadataResponse: infomation about resource orgID, locationID and partID

HasField(field_name: Literal['_cloud_metadata', b'_cloud_metadata', 'cloud_metadata', b'cloud_metadata', 'last_updated', b'last_updated', 'name', b'name']) → 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: Literal['_cloud_metadata', b'_cloud_metadata']) → Literal['cloud_metadata'] | 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

class viam.proto.robot.RestartModuleRequest(*, module_id: str = ..., module_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.

module_id: str: ID is for registry modules, name for local modules

module_name: str

HasField(field_name: Literal['id_or_name', b'id_or_name', 'module_id', b'module_id', 'module_name', b'module_name']) → 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: Literal['id_or_name', b'id_or_name']) → Literal['module_id', 'module_name'] | 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

class viam.proto.robot.RestartModuleResponse

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 viam.proto.robot.SendSessionHeartbeatRequest(*, id: 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.

id: str

class viam.proto.robot.SendSessionHeartbeatResponse

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 viam.proto.robot.Session(*, id: str = ..., peer_connection_info: global___PeerConnectionInfo | 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.

id: str

property peer_connection_info: global___PeerConnectionInfo

HasField(field_name: Literal['_peer_connection_info', b'_peer_connection_info', 'peer_connection_info', b'peer_connection_info']) → 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: Literal['_peer_connection_info', b'_peer_connection_info']) → Literal['peer_connection_info'] | 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

class viam.proto.robot.ShutdownRequest

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 viam.proto.robot.ShutdownResponse

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 viam.proto.robot.StartSessionRequest(*, resume: 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.

resume: str: resume can be used to attempt to continue a stream after a disconnection event. If a session is not found, a new one will be created and returned.

class viam.proto.robot.StartSessionResponse(*, id: str = ..., heartbeat_window: google.protobuf.duration_pb2.Duration | 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.

id: str

property heartbeat_window: google.protobuf.duration_pb2.Duration

HasField(field_name: Literal['heartbeat_window', b'heartbeat_window']) → 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.

class viam.proto.robot.Status(*, name: viam.gen.common.v1.common_pb2.ResourceName | None = ..., status: google.protobuf.struct_pb2.Struct | None = ..., last_reconfigured: 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.

property name: viam.gen.common.v1.common_pb2.ResourceName

property status: google.protobuf.struct_pb2.Struct

property last_reconfigured: google.protobuf.timestamp_pb2.Timestamp

HasField(field_name: Literal['last_reconfigured', b'last_reconfigured', 'name', b'name', 'status', b'status']) → 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.

class viam.proto.robot.StopAllRequest(*, extra: collections.abc.Iterable[global___StopExtraParameters] | 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.

property extra: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___StopExtraParameters]

class viam.proto.robot.StopAllResponse

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 viam.proto.robot.StopExtraParameters(*, name: viam.gen.common.v1.common_pb2.ResourceName | None = ..., params: 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.

property name: viam.gen.common.v1.common_pb2.ResourceName

property params: google.protobuf.struct_pb2.Struct

HasField(field_name: Literal['name', b'name', 'params', b'params']) → 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.

class viam.proto.robot.StreamStatusRequest(*, resource_names: collections.abc.Iterable[viam.gen.common.v1.common_pb2.ResourceName] | None = ..., every: google.protobuf.duration_pb2.Duration | 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.

property resource_names: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[viam.gen.common.v1.common_pb2.ResourceName]

property every: google.protobuf.duration_pb2.Duration: how often to send a new status.

HasField(field_name: Literal['every', b'every']) → 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.

class viam.proto.robot.StreamStatusResponse(*, status: collections.abc.Iterable[global___Status] | 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.

property status: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Status]

class viam.proto.robot.TransformPCDRequest(*, point_cloud_pcd: bytes = ..., source: str = ..., destination: 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.

point_cloud_pcd: bytes: the point clouds to transform. This should be in the PCD format encoded into bytes: https://pointclouds.org/documentation/tutorials/pcd_file_format.html

source: str: the reference frame of the point cloud.

destination: str: the reference frame into which the source data should be transformed, if unset this defaults to the “world” reference frame. Do not move the robot between the generation of the initial pointcloud and the receipt of the transformed pointcloud because that will make the transformations inaccurate

class viam.proto.robot.TransformPCDResponse(*, point_cloud_pcd: 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_pcd: bytes

class viam.proto.robot.TransformPoseRequest(*, source: viam.gen.common.v1.common_pb2.PoseInFrame | None = ..., destination: str = ..., supplemental_transforms: collections.abc.Iterable[viam.gen.common.v1.common_pb2.Transform] | 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.

destination: str: the reference frame into which the source pose should be transformed, if unset this defaults to the “world” reference frame

property source: viam.gen.common.v1.common_pb2.PoseInFrame: the original pose to transform along with the reference frame in which it was observed

property supplemental_transforms: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[viam.gen.common.v1.common_pb2.Transform]: pose information on any additional reference frames that are needed to perform the transform

HasField(field_name: Literal['source', b'source']) → 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.

class viam.proto.robot.TransformPoseResponse(*, pose: viam.gen.common.v1.common_pb2.PoseInFrame | 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.

property pose: viam.gen.common.v1.common_pb2.PoseInFrame

HasField(field_name: Literal['pose', b'pose']) → 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.