viam.proto.app.cloudslam

@generated by Viam. Do not edit manually!

Classes

`CloudSLAMServiceBase`	Helper class that provides a standard way to create an ABC using
`CloudSLAMServiceStub`
`UnimplementedCloudSLAMServiceBase`	Helper class that provides a standard way to create an ABC using
`CaptureInterval`	Abstract base class for protocol messages.
`EndStatus`
`GetActiveMappingSessionsForRobotRequest`	GetActiveMappingSessionsForRobot
`GetActiveMappingSessionsForRobotResponse`	Abstract base class for protocol messages.
`GetMappingSessionMetadataByIDRequest`	GetMappingSessionMetadataByID
`GetMappingSessionMetadataByIDResponse`	Abstract base class for protocol messages.
`GetMappingSessionPointCloudRequest`	GetMappingSessionPointCloud
`GetMappingSessionPointCloudResponse`	Abstract base class for protocol messages.
`ListMappingSessionsRequest`	ListMappingSessions
`ListMappingSessionsResponse`	Abstract base class for protocol messages.
`MappingMetadata`	Abstract base class for protocol messages.
`Module`	Abstract base class for protocol messages.
`SensorInfo`	Abstract base class for protocol messages.
`StartMappingSessionRequest`	StartMappingSession
`StartMappingSessionResponse`	Abstract base class for protocol messages.
`StopMappingSessionRequest`	StopMappingSession
`StopMappingSessionResponse`	Abstract base class for protocol messages.

Package Contents

class viam.proto.app.cloudslam.CloudSLAMServiceBase[source]

Bases: abc.ABC

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

abstract StartMappingSession(stream: grpclib.server.Stream[app.cloudslam.v1.cloud_slam_pb2.StartMappingSessionRequest, app.cloudslam.v1.cloud_slam_pb2.StartMappingSessionResponse]) → None[source]

Async:

abstract GetActiveMappingSessionsForRobot(stream: grpclib.server.Stream[app.cloudslam.v1.cloud_slam_pb2.GetActiveMappingSessionsForRobotRequest, app.cloudslam.v1.cloud_slam_pb2.GetActiveMappingSessionsForRobotResponse]) → None[source]

Async:

abstract GetMappingSessionPointCloud(stream: grpclib.server.Stream[app.cloudslam.v1.cloud_slam_pb2.GetMappingSessionPointCloudRequest, app.cloudslam.v1.cloud_slam_pb2.GetMappingSessionPointCloudResponse]) → None[source]

Async:

abstract ListMappingSessions(stream: grpclib.server.Stream[app.cloudslam.v1.cloud_slam_pb2.ListMappingSessionsRequest, app.cloudslam.v1.cloud_slam_pb2.ListMappingSessionsResponse]) → None[source]

Async:

abstract StopMappingSession(stream: grpclib.server.Stream[app.cloudslam.v1.cloud_slam_pb2.StopMappingSessionRequest, app.cloudslam.v1.cloud_slam_pb2.StopMappingSessionResponse]) → None[source]

Async:

abstract GetMappingSessionMetadataByID(stream: grpclib.server.Stream[app.cloudslam.v1.cloud_slam_pb2.GetMappingSessionMetadataByIDRequest, app.cloudslam.v1.cloud_slam_pb2.GetMappingSessionMetadataByIDResponse]) → None[source]

Async:

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

class viam.proto.app.cloudslam.CloudSLAMServiceStub(channel: grpclib.client.Channel)[source]

StartMappingSession

GetActiveMappingSessionsForRobot

GetMappingSessionPointCloud

ListMappingSessions

StopMappingSession

GetMappingSessionMetadataByID

class viam.proto.app.cloudslam.UnimplementedCloudSLAMServiceBase[source]

Bases: CloudSLAMServiceBase

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

async StartMappingSession(stream: grpclib.server.Stream[app.cloudslam.v1.cloud_slam_pb2.StartMappingSessionRequest, app.cloudslam.v1.cloud_slam_pb2.StartMappingSessionResponse]) → None[source]

async GetActiveMappingSessionsForRobot(stream: grpclib.server.Stream[app.cloudslam.v1.cloud_slam_pb2.GetActiveMappingSessionsForRobotRequest, app.cloudslam.v1.cloud_slam_pb2.GetActiveMappingSessionsForRobotResponse]) → None[source]

async GetMappingSessionPointCloud(stream: grpclib.server.Stream[app.cloudslam.v1.cloud_slam_pb2.GetMappingSessionPointCloudRequest, app.cloudslam.v1.cloud_slam_pb2.GetMappingSessionPointCloudResponse]) → None[source]

async ListMappingSessions(stream: grpclib.server.Stream[app.cloudslam.v1.cloud_slam_pb2.ListMappingSessionsRequest, app.cloudslam.v1.cloud_slam_pb2.ListMappingSessionsResponse]) → None[source]

async StopMappingSession(stream: grpclib.server.Stream[app.cloudslam.v1.cloud_slam_pb2.StopMappingSessionRequest, app.cloudslam.v1.cloud_slam_pb2.StopMappingSessionResponse]) → None[source]

async GetMappingSessionMetadataByID(stream: grpclib.server.Stream[app.cloudslam.v1.cloud_slam_pb2.GetMappingSessionMetadataByIDRequest, app.cloudslam.v1.cloud_slam_pb2.GetMappingSessionMetadataByIDResponse]) → None[source]

class viam.proto.app.cloudslam.CaptureInterval(*, start_time: google.protobuf.timestamp_pb2.Timestamp | None = ..., end_time: 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 start_time: google.protobuf.timestamp_pb2.Timestamp

property end_time: google.protobuf.timestamp_pb2.Timestamp: if no end_time specified cloud slam will be run using live sensors

HasField(field_name: Literal['end_time', b'end_time', 'start_time', b'start_time']) → 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.app.cloudslam.EndStatus: Bases: _EndStatus

class viam.proto.app.cloudslam.GetActiveMappingSessionsForRobotRequest(*, robot_id: str = ...)

Bases: google.protobuf.message.Message

GetActiveMappingSessionsForRobot

robot_id: str: assumes only one active mapping session on a robot

class viam.proto.app.cloudslam.GetActiveMappingSessionsForRobotResponse(*, session_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.

session_id: str

class viam.proto.app.cloudslam.GetMappingSessionMetadataByIDRequest(*, session_id: str = ...)

Bases: google.protobuf.message.Message

GetMappingSessionMetadataByID

session_id: str

class viam.proto.app.cloudslam.GetMappingSessionMetadataByIDResponse(*, session_metadata: global___MappingMetadata | 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 session_metadata: global___MappingMetadata

HasField(field_name: Literal['session_metadata', b'session_metadata']) → 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.app.cloudslam.GetMappingSessionPointCloudRequest(*, session_id: str = ...)

Bases: google.protobuf.message.Message

GetMappingSessionPointCloud

session_id: str

class viam.proto.app.cloudslam.GetMappingSessionPointCloudResponse(*, map_url: str = ..., pose: viam.gen.common.v1.common_pb2.Pose | 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.

map_url: str: url to the pointcloud map

property pose: viam.gen.common.v1.common_pb2.Pose: Current position within the SLAM Map

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.

class viam.proto.app.cloudslam.ListMappingSessionsRequest(*, organization_id: str = ..., location_id: str = ...)

Bases: google.protobuf.message.Message

ListMappingSessions

organization_id: str

location_id: str

class viam.proto.app.cloudslam.ListMappingSessionsResponse(*, session: collections.abc.Iterable[global___MappingMetadata] | 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 session: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___MappingMetadata]

class viam.proto.app.cloudslam.MappingMetadata(*, org_id: str = ..., location_id: str = ..., robot_id: str = ..., time_start_submitted: google.protobuf.timestamp_pb2.Timestamp | None = ..., time_cloud_run_job_started: google.protobuf.timestamp_pb2.Timestamp | None = ..., time_end_submitted: google.protobuf.timestamp_pb2.Timestamp | None = ..., time_cloud_run_job_ended: google.protobuf.timestamp_pb2.Timestamp | None = ..., end_status: global___EndStatus = ..., cloud_run_job_id: str = ..., viam_server_version: str = ..., map_name: str = ..., slam_version: str = ..., config: str = ..., error_msg: 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.

org_id: str: org associated with the slam session

location_id: str: location associated with the slam session

robot_id: str: robot associated with slam session

end_status: global___EndStatus: enums that represent “success”, “failed”, etc

cloud_run_job_id: str: initially unset

viam_server_version: str: version tag from request, defaults to stable

map_name: str: name of the map package

slam_version: str: version tag from request, defaults to stable

config: str: a robot config for a slam session

error_msg: str: additional details on the end status if needed, such as errors

property time_start_submitted: google.protobuf.timestamp_pb2.Timestamp: time this document was created

property time_cloud_run_job_started: google.protobuf.timestamp_pb2.Timestamp: time the cloud run job started

property time_end_submitted: google.protobuf.timestamp_pb2.Timestamp: time StopSlamSession was called

property time_cloud_run_job_ended: google.protobuf.timestamp_pb2.Timestamp: time the cloud run job ended

HasField(field_name: Literal['time_cloud_run_job_ended', b'time_cloud_run_job_ended', 'time_cloud_run_job_started', b'time_cloud_run_job_started', 'time_end_submitted', b'time_end_submitted', 'time_start_submitted', b'time_start_submitted']) → 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.app.cloudslam.Module(*, name: str = ..., module_id: str = ..., 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.

name: str

module_id: str

version: str

class viam.proto.app.cloudslam.SensorInfo(*, source_component_name: str = ..., type: str = ..., data_frequency_hz: 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.

source_component_name: str

type: str: type is the RDK component type

data_frequency_hz: str

class viam.proto.app.cloudslam.StartMappingSessionRequest(*, slam_version: str = ..., viam_server_version: str = ..., map_name: str = ..., organization_id: str = ..., location_id: str = ..., robot_id: str = ..., capture_interval: global___CaptureInterval | None = ..., sensors: collections.abc.Iterable[global___SensorInfo] | None = ..., slam_config: google.protobuf.struct_pb2.Struct | None = ..., existing_map_version: str = ..., module: global___Module | None = ...)

Bases: google.protobuf.message.Message

StartMappingSession

slam_version: str: Version to use for slam, defaults stable

viam_server_version: str: Version to use for viam, defaults stable

map_name: str

organization_id: str

location_id: str

robot_id: str

existing_map_version: str

property capture_interval: global___CaptureInterval

property sensors: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___SensorInfo]

property slam_config: google.protobuf.struct_pb2.Struct

property module: global___Module

HasField(field_name: Literal['capture_interval', b'capture_interval', 'module', b'module', 'slam_config', b'slam_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.app.cloudslam.StartMappingSessionResponse(*, session_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.

session_id: str

class viam.proto.app.cloudslam.StopMappingSessionRequest(*, session_id: str = ...)

Bases: google.protobuf.message.Message

StopMappingSession

session_id: str

class viam.proto.app.cloudslam.StopMappingSessionResponse(*, package_id: str = ..., 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.

package_id: str

version: str