viam-sdk 0.45.2__py3-none-win_amd64.whl

viam/gen/service/shell/v1/shell_pb2.pyi

@@ -0,0 +1,307 @@
+"""
+@generated by mypy-protobuf.  Do not edit manually!
+isort:skip_file
+"""
+import builtins
+import collections.abc
+import google.protobuf.descriptor
+import google.protobuf.internal.containers
+import google.protobuf.internal.enum_type_wrapper
+import google.protobuf.message
+import google.protobuf.struct_pb2
+import google.protobuf.timestamp_pb2
+import sys
+import typing
+if sys.version_info >= (3, 10):
+    import typing as typing_extensions
+else:
+    import typing_extensions
+DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
+
+class _CopyFilesSourceType:
+    ValueType = typing.NewType('ValueType', builtins.int)
+    V: typing_extensions.TypeAlias = ValueType
+
+class _CopyFilesSourceTypeEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[_CopyFilesSourceType.ValueType], builtins.type):
+    DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
+    COPY_FILES_SOURCE_TYPE_UNSPECIFIED: _CopyFilesSourceType.ValueType
+    COPY_FILES_SOURCE_TYPE_SINGLE_FILE: _CopyFilesSourceType.ValueType
+    COPY_FILES_SOURCE_TYPE_SINGLE_DIRECTORY: _CopyFilesSourceType.ValueType
+    COPY_FILES_SOURCE_TYPE_MULTIPLE_FILES: _CopyFilesSourceType.ValueType
+
+class CopyFilesSourceType(_CopyFilesSourceType, metaclass=_CopyFilesSourceTypeEnumTypeWrapper):
+    """CopyFilesSourceType indicates what will be copied. It's important
+    to disambiguate the single directory case from the multiple files
+    case in order to indicate that the user's intent is to copy a directory
+    into a single location which may result in a new top-level directory versus
+    the cause of multiples files that always go into the existing target destination.
+    """
+COPY_FILES_SOURCE_TYPE_UNSPECIFIED: CopyFilesSourceType.ValueType
+COPY_FILES_SOURCE_TYPE_SINGLE_FILE: CopyFilesSourceType.ValueType
+COPY_FILES_SOURCE_TYPE_SINGLE_DIRECTORY: CopyFilesSourceType.ValueType
+COPY_FILES_SOURCE_TYPE_MULTIPLE_FILES: CopyFilesSourceType.ValueType
+global___CopyFilesSourceType = CopyFilesSourceType
+
+@typing.final
+class ShellRequest(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+    NAME_FIELD_NUMBER: builtins.int
+    DATA_IN_FIELD_NUMBER: builtins.int
+    EXTRA_FIELD_NUMBER: builtins.int
+    name: builtins.str
+    data_in: builtins.str
+
+    @property
+    def extra(self) -> google.protobuf.struct_pb2.Struct:
+        """Additional arguments to the method"""
+
+    def __init__(self, *, name: builtins.str=..., data_in: builtins.str=..., extra: google.protobuf.struct_pb2.Struct | None=...) -> None:
+        ...
+
+    def HasField(self, field_name: typing.Literal['extra', b'extra']) -> builtins.bool:
+        ...
+
+    def ClearField(self, field_name: typing.Literal['data_in', b'data_in', 'extra', b'extra', 'name', b'name']) -> None:
+        ...
+global___ShellRequest = ShellRequest
+
+@typing.final
+class ShellResponse(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+    DATA_OUT_FIELD_NUMBER: builtins.int
+    DATA_ERR_FIELD_NUMBER: builtins.int
+    EOF_FIELD_NUMBER: builtins.int
+    data_out: builtins.str
+    data_err: builtins.str
+    eof: builtins.bool
+
+    def __init__(self, *, data_out: builtins.str=..., data_err: builtins.str=..., eof: builtins.bool=...) -> None:
+        ...
+
+    def ClearField(self, field_name: typing.Literal['data_err', b'data_err', 'data_out', b'data_out', 'eof', b'eof']) -> None:
+        ...
+global___ShellResponse = ShellResponse
+
+@typing.final
+class FileData(google.protobuf.message.Message):
+    """FileData contains partial (sometimes complete) information about a File.
+    When transmitting FileData with CopyFilesToMachine and CopyFilesFromMachine,
+    it MUST initially contain its name, size, and is_dir. Depending on whether
+    preservation is in use, the mod_time and mode fields may be initially set
+    as well. On all transmissions, data and eof must be set. Because files are
+    sent one-by-one, it is currently permitted to exclude the initially set fields.
+    If this ever changes, a new scheme should be used for identifying files (like a number)
+    in order to reduce data transmission while allowing out-of-order transfers.
+    eof must be true and its own message once no more data is to be sent for this file.
+    """
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+    NAME_FIELD_NUMBER: builtins.int
+    SIZE_FIELD_NUMBER: builtins.int
+    IS_DIR_FIELD_NUMBER: builtins.int
+    DATA_FIELD_NUMBER: builtins.int
+    EOF_FIELD_NUMBER: builtins.int
+    MOD_TIME_FIELD_NUMBER: builtins.int
+    MODE_FIELD_NUMBER: builtins.int
+    name: builtins.str
+    size: builtins.int
+    is_dir: builtins.bool
+    data: builtins.bytes
+    eof: builtins.bool
+    mode: builtins.int
+
+    @property
+    def mod_time(self) -> google.protobuf.timestamp_pb2.Timestamp:
+        """Note(erd): maybe support access time in the future if needed"""
+
+    def __init__(self, *, name: builtins.str=..., size: builtins.int=..., is_dir: builtins.bool=..., data: builtins.bytes=..., eof: builtins.bool=..., mod_time: google.protobuf.timestamp_pb2.Timestamp | None=..., mode: builtins.int | None=...) -> None:
+        ...
+
+    def HasField(self, field_name: typing.Literal['_mod_time', b'_mod_time', '_mode', b'_mode', 'mod_time', b'mod_time', 'mode', b'mode']) -> builtins.bool:
+        ...
+
+    def ClearField(self, field_name: typing.Literal['_mod_time', b'_mod_time', '_mode', b'_mode', 'data', b'data', 'eof', b'eof', 'is_dir', b'is_dir', 'mod_time', b'mod_time', 'mode', b'mode', 'name', b'name', 'size', b'size']) -> None:
+        ...
+
+    @typing.overload
+    def WhichOneof(self, oneof_group: typing.Literal['_mod_time', b'_mod_time']) -> typing.Literal['mod_time'] | None:
+        ...
+
+    @typing.overload
+    def WhichOneof(self, oneof_group: typing.Literal['_mode', b'_mode']) -> typing.Literal['mode'] | None:
+        ...
+global___FileData = FileData
+
+@typing.final
+class CopyFilesToMachineRequestMetadata(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+    NAME_FIELD_NUMBER: builtins.int
+    SOURCE_TYPE_FIELD_NUMBER: builtins.int
+    DESTINATION_FIELD_NUMBER: builtins.int
+    PRESERVE_FIELD_NUMBER: builtins.int
+    EXTRA_FIELD_NUMBER: builtins.int
+    name: builtins.str
+    'name is the service name.'
+    source_type: global___CopyFilesSourceType.ValueType
+    'source_type is the type of files that will be transmitted in this request stream.'
+    destination: builtins.str
+    'destination is where the files should be placed. The receiver can choose to\n    reasonably modify this destination based on its implementation semantics.\n    '
+    preserve: builtins.bool
+    'preserve indicates the the receiver should use the metadata in the file to reflect\n    the same state in its filesystem as applicable.\n    '
+
+    @property
+    def extra(self) -> google.protobuf.struct_pb2.Struct:
+        """Additional arguments to the method"""
+
+    def __init__(self, *, name: builtins.str=..., source_type: global___CopyFilesSourceType.ValueType=..., destination: builtins.str=..., preserve: builtins.bool=..., extra: google.protobuf.struct_pb2.Struct | None=...) -> None:
+        ...
+
+    def HasField(self, field_name: typing.Literal['extra', b'extra']) -> builtins.bool:
+        ...
+
+    def ClearField(self, field_name: typing.Literal['destination', b'destination', 'extra', b'extra', 'name', b'name', 'preserve', b'preserve', 'source_type', b'source_type']) -> None:
+        ...
+global___CopyFilesToMachineRequestMetadata = CopyFilesToMachineRequestMetadata
+
+@typing.final
+class CopyFilesToMachineRequest(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+    METADATA_FIELD_NUMBER: builtins.int
+    FILE_DATA_FIELD_NUMBER: builtins.int
+
+    @property
+    def metadata(self) -> global___CopyFilesToMachineRequestMetadata:
+        """metadata is sent first and only once."""
+
+    @property
+    def file_data(self) -> global___FileData:
+        """file_data is sent only after metadata. All data MUST be sent
+        in order per-file.
+        """
+
+    def __init__(self, *, metadata: global___CopyFilesToMachineRequestMetadata | None=..., file_data: global___FileData | None=...) -> None:
+        ...
+
+    def HasField(self, field_name: typing.Literal['file_data', b'file_data', 'metadata', b'metadata', 'request', b'request']) -> builtins.bool:
+        ...
+
+    def ClearField(self, field_name: typing.Literal['file_data', b'file_data', 'metadata', b'metadata', 'request', b'request']) -> None:
+        ...
+
+    def WhichOneof(self, oneof_group: typing.Literal['request', b'request']) -> typing.Literal['metadata', 'file_data'] | None:
+        ...
+global___CopyFilesToMachineRequest = CopyFilesToMachineRequest
+
+@typing.final
+class CopyFilesToMachineResponse(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+    ACK_LAST_FILE_FIELD_NUMBER: builtins.int
+    ack_last_file: builtins.bool
+    'value does not matter here but responses must be sent after every\n    file has been received.\n    '
+
+    def __init__(self, *, ack_last_file: builtins.bool=...) -> None:
+        ...
+
+    def ClearField(self, field_name: typing.Literal['ack_last_file', b'ack_last_file']) -> None:
+        ...
+global___CopyFilesToMachineResponse = CopyFilesToMachineResponse
+
+@typing.final
+class CopyFilesFromMachineRequestMetadata(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+    NAME_FIELD_NUMBER: builtins.int
+    PATHS_FIELD_NUMBER: builtins.int
+    ALLOW_RECURSION_FIELD_NUMBER: builtins.int
+    PRESERVE_FIELD_NUMBER: builtins.int
+    EXTRA_FIELD_NUMBER: builtins.int
+    name: builtins.str
+    'name is the service name.'
+    allow_recursion: builtins.bool
+    'allow_recursion indicates if directories should be recursed into. If\n    a directory is encountered and this is false, an error MUST occur.\n    '
+    preserve: builtins.bool
+    "preserve indicates the the receiver should provide the metadata in the file\n    to reflect the same state in the sender's filesystem as applicable.\n    "
+
+    @property
+    def paths(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.str]:
+        """paths are the paths to copy from and send back over the wire."""
+
+    @property
+    def extra(self) -> google.protobuf.struct_pb2.Struct:
+        """Additional arguments to the method"""
+
+    def __init__(self, *, name: builtins.str=..., paths: collections.abc.Iterable[builtins.str] | None=..., allow_recursion: builtins.bool=..., preserve: builtins.bool=..., extra: google.protobuf.struct_pb2.Struct | None=...) -> None:
+        ...
+
+    def HasField(self, field_name: typing.Literal['extra', b'extra']) -> builtins.bool:
+        ...
+
+    def ClearField(self, field_name: typing.Literal['allow_recursion', b'allow_recursion', 'extra', b'extra', 'name', b'name', 'paths', b'paths', 'preserve', b'preserve']) -> None:
+        ...
+global___CopyFilesFromMachineRequestMetadata = CopyFilesFromMachineRequestMetadata
+
+@typing.final
+class CopyFilesFromMachineRequest(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+    METADATA_FIELD_NUMBER: builtins.int
+    ACK_LAST_FILE_FIELD_NUMBER: builtins.int
+    ack_last_file: builtins.bool
+    'ack_last_file is sent only after metadata and after each file has been received.\n    The value does not matter.\n    '
+
+    @property
+    def metadata(self) -> global___CopyFilesFromMachineRequestMetadata:
+        """metadata is sent first and only once."""
+
+    def __init__(self, *, metadata: global___CopyFilesFromMachineRequestMetadata | None=..., ack_last_file: builtins.bool=...) -> None:
+        ...
+
+    def HasField(self, field_name: typing.Literal['ack_last_file', b'ack_last_file', 'metadata', b'metadata', 'request', b'request']) -> builtins.bool:
+        ...
+
+    def ClearField(self, field_name: typing.Literal['ack_last_file', b'ack_last_file', 'metadata', b'metadata', 'request', b'request']) -> None:
+        ...
+
+    def WhichOneof(self, oneof_group: typing.Literal['request', b'request']) -> typing.Literal['metadata', 'ack_last_file'] | None:
+        ...
+global___CopyFilesFromMachineRequest = CopyFilesFromMachineRequest
+
+@typing.final
+class CopyFilesFromMachineResponseMetadata(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+    SOURCE_TYPE_FIELD_NUMBER: builtins.int
+    source_type: global___CopyFilesSourceType.ValueType
+    'source_type is the type of files that will be transmitted in this response stream.'
+
+    def __init__(self, *, source_type: global___CopyFilesSourceType.ValueType=...) -> None:
+        ...
+
+    def ClearField(self, field_name: typing.Literal['source_type', b'source_type']) -> None:
+        ...
+global___CopyFilesFromMachineResponseMetadata = CopyFilesFromMachineResponseMetadata
+
+@typing.final
+class CopyFilesFromMachineResponse(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+    METADATA_FIELD_NUMBER: builtins.int
+    FILE_DATA_FIELD_NUMBER: builtins.int
+
+    @property
+    def metadata(self) -> global___CopyFilesFromMachineResponseMetadata:
+        """metadata is sent first and only once."""
+
+    @property
+    def file_data(self) -> global___FileData:
+        """file_data is sent only after metadata. All data MUST be sent
+        in order per-file.
+        """
+
+    def __init__(self, *, metadata: global___CopyFilesFromMachineResponseMetadata | None=..., file_data: global___FileData | None=...) -> None:
+        ...
+
+    def HasField(self, field_name: typing.Literal['file_data', b'file_data', 'metadata', b'metadata', 'response', b'response']) -> builtins.bool:
+        ...
+
+    def ClearField(self, field_name: typing.Literal['file_data', b'file_data', 'metadata', b'metadata', 'response', b'response']) -> None:
+        ...
+
+    def WhichOneof(self, oneof_group: typing.Literal['response', b'response']) -> typing.Literal['metadata', 'file_data'] | None:
+        ...
+global___CopyFilesFromMachineResponse = CopyFilesFromMachineResponse

viam/gen/service/slam/v1/slam_grpc.py

@@ -0,0 +1,61 @@
+import abc
+import typing
+import grpclib.const
+import grpclib.client
+import grpclib.exceptions
+if typing.TYPE_CHECKING:
+    import grpclib.server
+from .... import common
+import google.api.annotations_pb2
+from .... import service
+
+class SLAMServiceBase(abc.ABC):
+
+    @abc.abstractmethod
+    async def GetPosition(self, stream: 'grpclib.server.Stream[service.slam.v1.slam_pb2.GetPositionRequest, service.slam.v1.slam_pb2.GetPositionResponse]') -> None:
+        pass
+
+    @abc.abstractmethod
+    async def GetPointCloudMap(self, stream: 'grpclib.server.Stream[service.slam.v1.slam_pb2.GetPointCloudMapRequest, service.slam.v1.slam_pb2.GetPointCloudMapResponse]') -> None:
+        pass
+
+    @abc.abstractmethod
+    async def GetInternalState(self, stream: 'grpclib.server.Stream[service.slam.v1.slam_pb2.GetInternalStateRequest, service.slam.v1.slam_pb2.GetInternalStateResponse]') -> None:
+        pass
+
+    @abc.abstractmethod
+    async def GetProperties(self, stream: 'grpclib.server.Stream[service.slam.v1.slam_pb2.GetPropertiesRequest, service.slam.v1.slam_pb2.GetPropertiesResponse]') -> None:
+        pass
+
+    @abc.abstractmethod
+    async def DoCommand(self, stream: 'grpclib.server.Stream[common.v1.common_pb2.DoCommandRequest, common.v1.common_pb2.DoCommandResponse]') -> None:
+        pass
+
+    def __mapping__(self) -> typing.Dict[str, grpclib.const.Handler]:
+        return {'/viam.service.slam.v1.SLAMService/GetPosition': grpclib.const.Handler(self.GetPosition, grpclib.const.Cardinality.UNARY_UNARY, service.slam.v1.slam_pb2.GetPositionRequest, service.slam.v1.slam_pb2.GetPositionResponse), '/viam.service.slam.v1.SLAMService/GetPointCloudMap': grpclib.const.Handler(self.GetPointCloudMap, grpclib.const.Cardinality.UNARY_STREAM, service.slam.v1.slam_pb2.GetPointCloudMapRequest, service.slam.v1.slam_pb2.GetPointCloudMapResponse), '/viam.service.slam.v1.SLAMService/GetInternalState': grpclib.const.Handler(self.GetInternalState, grpclib.const.Cardinality.UNARY_STREAM, service.slam.v1.slam_pb2.GetInternalStateRequest, service.slam.v1.slam_pb2.GetInternalStateResponse), '/viam.service.slam.v1.SLAMService/GetProperties': grpclib.const.Handler(self.GetProperties, grpclib.const.Cardinality.UNARY_UNARY, service.slam.v1.slam_pb2.GetPropertiesRequest, service.slam.v1.slam_pb2.GetPropertiesResponse), '/viam.service.slam.v1.SLAMService/DoCommand': grpclib.const.Handler(self.DoCommand, grpclib.const.Cardinality.UNARY_UNARY, common.v1.common_pb2.DoCommandRequest, common.v1.common_pb2.DoCommandResponse)}
+
+class UnimplementedSLAMServiceBase(SLAMServiceBase):
+
+    async def GetPosition(self, stream: 'grpclib.server.Stream[service.slam.v1.slam_pb2.GetPositionRequest, service.slam.v1.slam_pb2.GetPositionResponse]') -> None:
+        raise grpclib.exceptions.GRPCError(grpclib.const.Status.UNIMPLEMENTED)
+
+    async def GetPointCloudMap(self, stream: 'grpclib.server.Stream[service.slam.v1.slam_pb2.GetPointCloudMapRequest, service.slam.v1.slam_pb2.GetPointCloudMapResponse]') -> None:
+        raise grpclib.exceptions.GRPCError(grpclib.const.Status.UNIMPLEMENTED)
+
+    async def GetInternalState(self, stream: 'grpclib.server.Stream[service.slam.v1.slam_pb2.GetInternalStateRequest, service.slam.v1.slam_pb2.GetInternalStateResponse]') -> None:
+        raise grpclib.exceptions.GRPCError(grpclib.const.Status.UNIMPLEMENTED)
+
+    async def GetProperties(self, stream: 'grpclib.server.Stream[service.slam.v1.slam_pb2.GetPropertiesRequest, service.slam.v1.slam_pb2.GetPropertiesResponse]') -> None:
+        raise grpclib.exceptions.GRPCError(grpclib.const.Status.UNIMPLEMENTED)
+
+    async def DoCommand(self, stream: 'grpclib.server.Stream[common.v1.common_pb2.DoCommandRequest, common.v1.common_pb2.DoCommandResponse]') -> None:
+        raise grpclib.exceptions.GRPCError(grpclib.const.Status.UNIMPLEMENTED)
+
+class SLAMServiceStub:
+
+    def __init__(self, channel: grpclib.client.Channel) -> None:
+        self.GetPosition = grpclib.client.UnaryUnaryMethod(channel, '/viam.service.slam.v1.SLAMService/GetPosition', service.slam.v1.slam_pb2.GetPositionRequest, service.slam.v1.slam_pb2.GetPositionResponse)
+        self.GetPointCloudMap = grpclib.client.UnaryStreamMethod(channel, '/viam.service.slam.v1.SLAMService/GetPointCloudMap', service.slam.v1.slam_pb2.GetPointCloudMapRequest, service.slam.v1.slam_pb2.GetPointCloudMapResponse)
+        self.GetInternalState = grpclib.client.UnaryStreamMethod(channel, '/viam.service.slam.v1.SLAMService/GetInternalState', service.slam.v1.slam_pb2.GetInternalStateRequest, service.slam.v1.slam_pb2.GetInternalStateResponse)
+        self.GetProperties = grpclib.client.UnaryUnaryMethod(channel, '/viam.service.slam.v1.SLAMService/GetProperties', service.slam.v1.slam_pb2.GetPropertiesRequest, service.slam.v1.slam_pb2.GetPropertiesResponse)
+        self.DoCommand = grpclib.client.UnaryUnaryMethod(channel, '/viam.service.slam.v1.SLAMService/DoCommand', common.v1.common_pb2.DoCommandRequest, common.v1.common_pb2.DoCommandResponse)

viam/gen/service/slam/v1/slam_pb2.py

@@ -0,0 +1,51 @@
+"""Generated protocol buffer code."""
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import descriptor_pool as _descriptor_pool
+from google.protobuf import runtime_version as _runtime_version
+from google.protobuf import symbol_database as _symbol_database
+from google.protobuf.internal import builder as _builder
+_runtime_version.ValidateProtobufRuntimeVersion(_runtime_version.Domain.PUBLIC, 5, 29, 2, '', 'service/slam/v1/slam.proto')
+_sym_db = _symbol_database.Default()
+from ....common.v1 import common_pb2 as common_dot_v1_dot_common__pb2
+from google.api import annotations_pb2 as google_dot_api_dot_annotations__pb2
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x1aservice/slam/v1/slam.proto\x12\x14viam.service.slam.v1\x1a\x16common/v1/common.proto\x1a\x1cgoogle/api/annotations.proto"(\n\x12GetPositionRequest\x12\x12\n\x04name\x18\x01 \x01(\tR\x04name"?\n\x13GetPositionResponse\x12(\n\x04pose\x18\x01 \x01(\x0b2\x14.viam.common.v1.PoseR\x04pose"t\n\x17GetPointCloudMapRequest\x12\x12\n\x04name\x18\x01 \x01(\tR\x04name\x12/\n\x11return_edited_map\x18\x02 \x01(\x08H\x00R\x0freturnEditedMap\x88\x01\x01B\x14\n\x12_return_edited_map"M\n\x18GetPointCloudMapResponse\x121\n\x15point_cloud_pcd_chunk\x18\x01 \x01(\x0cR\x12pointCloudPcdChunk"-\n\x17GetInternalStateRequest\x12\x12\n\x04name\x18\x01 \x01(\tR\x04name"L\n\x18GetInternalStateResponse\x120\n\x14internal_state_chunk\x18\x01 \x01(\x0cR\x12internalStateChunk"*\n\x14GetPropertiesRequest\x12\x12\n\x04name\x18\x01 \x01(\tR\x04name"\x9a\x02\n\x15GetPropertiesResponse\x12\x1d\n\ncloud_slam\x18\x01 \x01(\x08R\tcloudSlam\x12D\n\x0cmapping_mode\x18\x02 \x01(\x0e2!.viam.service.slam.v1.MappingModeR\x0bmappingMode\x12<\n\x18internal_state_file_type\x18\x03 \x01(\tH\x00R\x15internalStateFileType\x88\x01\x01\x12A\n\x0bsensor_info\x18\x04 \x03(\x0b2 .viam.service.slam.v1.SensorInfoR\nsensorInfoB\x1b\n\x19_internal_state_file_type"V\n\nSensorInfo\x12\x12\n\x04name\x18\x01 \x01(\tR\x04name\x124\n\x04type\x18\x02 \x01(\x0e2 .viam.service.slam.v1.SensorTypeR\x04type*\x92\x01\n\x0bMappingMode\x12\x1c\n\x18MAPPING_MODE_UNSPECIFIED\x10\x00\x12\x1f\n\x1bMAPPING_MODE_CREATE_NEW_MAP\x10\x01\x12\x1e\n\x1aMAPPING_MODE_LOCALIZE_ONLY\x10\x02\x12$\n MAPPING_MODE_UPDATE_EXISTING_MAP\x10\x03*b\n\nSensorType\x12\x1b\n\x17SENSOR_TYPE_UNSPECIFIED\x10\x00\x12\x16\n\x12SENSOR_TYPE_CAMERA\x10\x01\x12\x1f\n\x1bSENSOR_TYPE_MOVEMENT_SENSOR\x10\x022\xac\x06\n\x0bSLAMService\x12\x95\x01\n\x0bGetPosition\x12(.viam.service.slam.v1.GetPositionRequest\x1a).viam.service.slam.v1.GetPositionResponse"1\x82\xd3\xe4\x93\x02+\x12)/viam/api/v1/service/slam/{name}/position\x12\xad\x01\n\x10GetPointCloudMap\x12-.viam.service.slam.v1.GetPointCloudMapRequest\x1a..viam.service.slam.v1.GetPointCloudMapResponse"8\x82\xd3\xe4\x93\x022\x120/viam/api/v1/service/slam/{name}/point_cloud_map0\x01\x12\xac\x01\n\x10GetInternalState\x12-.viam.service.slam.v1.GetInternalStateRequest\x1a..viam.service.slam.v1.GetInternalStateResponse"7\x82\xd3\xe4\x93\x021\x12//viam/api/v1/service/slam/{name}/internal_state0\x01\x12\x9d\x01\n\rGetProperties\x12*.viam.service.slam.v1.GetPropertiesRequest\x1a+.viam.service.slam.v1.GetPropertiesResponse"3\x82\xd3\xe4\x93\x02-\x12+/viam/api/v1/service/slam/{name}/properties\x12\x85\x01\n\tDoCommand\x12 .viam.common.v1.DoCommandRequest\x1a!.viam.common.v1.DoCommandResponse"3\x82\xd3\xe4\x93\x02-"+/viam/api/v1/service/slam/{name}/do_commandB;\n\x18com.viam.service.slam.v1Z\x1fgo.viam.com/api/service/slam/v1b\x06proto3')
+_globals = globals()
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'service.slam.v1.slam_pb2', _globals)
+if not _descriptor._USE_C_DESCRIPTORS:
+    _globals['DESCRIPTOR']._loaded_options = None
+    _globals['DESCRIPTOR']._serialized_options = b'\n\x18com.viam.service.slam.v1Z\x1fgo.viam.com/api/service/slam/v1'
+    _globals['_SLAMSERVICE'].methods_by_name['GetPosition']._loaded_options = None
+    _globals['_SLAMSERVICE'].methods_by_name['GetPosition']._serialized_options = b'\x82\xd3\xe4\x93\x02+\x12)/viam/api/v1/service/slam/{name}/position'
+    _globals['_SLAMSERVICE'].methods_by_name['GetPointCloudMap']._loaded_options = None
+    _globals['_SLAMSERVICE'].methods_by_name['GetPointCloudMap']._serialized_options = b'\x82\xd3\xe4\x93\x022\x120/viam/api/v1/service/slam/{name}/point_cloud_map'
+    _globals['_SLAMSERVICE'].methods_by_name['GetInternalState']._loaded_options = None
+    _globals['_SLAMSERVICE'].methods_by_name['GetInternalState']._serialized_options = b'\x82\xd3\xe4\x93\x021\x12//viam/api/v1/service/slam/{name}/internal_state'
+    _globals['_SLAMSERVICE'].methods_by_name['GetProperties']._loaded_options = None
+    _globals['_SLAMSERVICE'].methods_by_name['GetProperties']._serialized_options = b'\x82\xd3\xe4\x93\x02-\x12+/viam/api/v1/service/slam/{name}/properties'
+    _globals['_SLAMSERVICE'].methods_by_name['DoCommand']._loaded_options = None
+    _globals['_SLAMSERVICE'].methods_by_name['DoCommand']._serialized_options = b'\x82\xd3\xe4\x93\x02-"+/viam/api/v1/service/slam/{name}/do_command'
+    _globals['_MAPPINGMODE']._serialized_start = 953
+    _globals['_MAPPINGMODE']._serialized_end = 1099
+    _globals['_SENSORTYPE']._serialized_start = 1101
+    _globals['_SENSORTYPE']._serialized_end = 1199
+    _globals['_GETPOSITIONREQUEST']._serialized_start = 106
+    _globals['_GETPOSITIONREQUEST']._serialized_end = 146
+    _globals['_GETPOSITIONRESPONSE']._serialized_start = 148
+    _globals['_GETPOSITIONRESPONSE']._serialized_end = 211
+    _globals['_GETPOINTCLOUDMAPREQUEST']._serialized_start = 213
+    _globals['_GETPOINTCLOUDMAPREQUEST']._serialized_end = 329
+    _globals['_GETPOINTCLOUDMAPRESPONSE']._serialized_start = 331
+    _globals['_GETPOINTCLOUDMAPRESPONSE']._serialized_end = 408
+    _globals['_GETINTERNALSTATEREQUEST']._serialized_start = 410
+    _globals['_GETINTERNALSTATEREQUEST']._serialized_end = 455
+    _globals['_GETINTERNALSTATERESPONSE']._serialized_start = 457
+    _globals['_GETINTERNALSTATERESPONSE']._serialized_end = 533
+    _globals['_GETPROPERTIESREQUEST']._serialized_start = 535
+    _globals['_GETPROPERTIESREQUEST']._serialized_end = 577
+    _globals['_GETPROPERTIESRESPONSE']._serialized_start = 580
+    _globals['_GETPROPERTIESRESPONSE']._serialized_end = 862
+    _globals['_SENSORINFO']._serialized_start = 864
+    _globals['_SENSORINFO']._serialized_end = 950
+    _globals['_SLAMSERVICE']._serialized_start = 1202
+    _globals['_SLAMSERVICE']._serialized_end = 2014

viam/gen/service/slam/v1/slam_pb2.pyi

@@ -0,0 +1,213 @@
+"""
+@generated by mypy-protobuf.  Do not edit manually!
+isort:skip_file
+"""
+import builtins
+import collections.abc
+from .... import common
+import google.protobuf.descriptor
+import google.protobuf.internal.containers
+import google.protobuf.internal.enum_type_wrapper
+import google.protobuf.message
+import sys
+import typing
+if sys.version_info >= (3, 10):
+    import typing as typing_extensions
+else:
+    import typing_extensions
+DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
+
+class _MappingMode:
+    ValueType = typing.NewType('ValueType', builtins.int)
+    V: typing_extensions.TypeAlias = ValueType
+
+class _MappingModeEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[_MappingMode.ValueType], builtins.type):
+    DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
+    MAPPING_MODE_UNSPECIFIED: _MappingMode.ValueType
+    MAPPING_MODE_CREATE_NEW_MAP: _MappingMode.ValueType
+    MAPPING_MODE_LOCALIZE_ONLY: _MappingMode.ValueType
+    MAPPING_MODE_UPDATE_EXISTING_MAP: _MappingMode.ValueType
+
+class MappingMode(_MappingMode, metaclass=_MappingModeEnumTypeWrapper):
+    """MappingMode represnts the various form of mapping and localizing SLAM can perform.
+    These include, creating a new map, localizing on an existiing map and updating an
+    exisiting map.
+    """
+MAPPING_MODE_UNSPECIFIED: MappingMode.ValueType
+MAPPING_MODE_CREATE_NEW_MAP: MappingMode.ValueType
+MAPPING_MODE_LOCALIZE_ONLY: MappingMode.ValueType
+MAPPING_MODE_UPDATE_EXISTING_MAP: MappingMode.ValueType
+global___MappingMode = MappingMode
+
+class _SensorType:
+    ValueType = typing.NewType('ValueType', builtins.int)
+    V: typing_extensions.TypeAlias = ValueType
+
+class _SensorTypeEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[_SensorType.ValueType], builtins.type):
+    DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
+    SENSOR_TYPE_UNSPECIFIED: _SensorType.ValueType
+    SENSOR_TYPE_CAMERA: _SensorType.ValueType
+    SENSOR_TYPE_MOVEMENT_SENSOR: _SensorType.ValueType
+
+class SensorType(_SensorType, metaclass=_SensorTypeEnumTypeWrapper):
+    ...
+SENSOR_TYPE_UNSPECIFIED: SensorType.ValueType
+SENSOR_TYPE_CAMERA: SensorType.ValueType
+SENSOR_TYPE_MOVEMENT_SENSOR: SensorType.ValueType
+global___SensorType = SensorType
+
+@typing.final
+class GetPositionRequest(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+    NAME_FIELD_NUMBER: builtins.int
+    name: builtins.str
+    'Name of slam service'
+
+    def __init__(self, *, name: builtins.str=...) -> None:
+        ...
+
+    def ClearField(self, field_name: typing.Literal['name', b'name']) -> None:
+        ...
+global___GetPositionRequest = GetPositionRequest
+
+@typing.final
+class GetPositionResponse(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+    POSE_FIELD_NUMBER: builtins.int
+
+    @property
+    def pose(self) -> common.v1.common_pb2.Pose:
+        """Current position of the specified component in the SLAM Map"""
+
+    def __init__(self, *, pose: common.v1.common_pb2.Pose | None=...) -> None:
+        ...
+
+    def HasField(self, field_name: typing.Literal['pose', b'pose']) -> builtins.bool:
+        ...
+
+    def ClearField(self, field_name: typing.Literal['pose', b'pose']) -> None:
+        ...
+global___GetPositionResponse = GetPositionResponse
+
+@typing.final
+class GetPointCloudMapRequest(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+    NAME_FIELD_NUMBER: builtins.int
+    RETURN_EDITED_MAP_FIELD_NUMBER: builtins.int
+    name: builtins.str
+    'Name of slam service'
+    return_edited_map: builtins.bool
+    'For SLAM services that implement handling an edited map, this boolean\n    should indicate whether to return that edited map. If the SLAM service\n    does not handle edited maps, the unedited map will be returned instead.\n    '
+
+    def __init__(self, *, name: builtins.str=..., return_edited_map: builtins.bool | None=...) -> None:
+        ...
+
+    def HasField(self, field_name: typing.Literal['_return_edited_map', b'_return_edited_map', 'return_edited_map', b'return_edited_map']) -> builtins.bool:
+        ...
+
+    def ClearField(self, field_name: typing.Literal['_return_edited_map', b'_return_edited_map', 'name', b'name', 'return_edited_map', b'return_edited_map']) -> None:
+        ...
+
+    def WhichOneof(self, oneof_group: typing.Literal['_return_edited_map', b'_return_edited_map']) -> typing.Literal['return_edited_map'] | None:
+        ...
+global___GetPointCloudMapRequest = GetPointCloudMapRequest
+
+@typing.final
+class GetPointCloudMapResponse(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+    POINT_CLOUD_PCD_CHUNK_FIELD_NUMBER: builtins.int
+    point_cloud_pcd_chunk: builtins.bytes
+    'One chunk of the PointCloud.\n    For a given GetPointCloudMap request, concatenating all\n    GetPointCloudMapResponse.point_cloud_pcd_chunk values in the\n    order received result in the complete pointcloud in standard PCD\n    format where XY is the ground plane and positive Z is up, following\n    the Right Hand Rule.\n\n    Read more about the pointcloud format here:\n    https://pointclouds.org/documentation/tutorials/pcd_file_format.html\n\n    Viam expects pointcloud data with fields "x y z" or "x y z rgb", and for\n    this to be specified in the pointcloud header in the FIELDS entry. If color\n    data is included in the pointcloud, Viam\'s services assume that the color\n    value encodes a confidence score for that data point. Viam expects the\n    confidence score to be encoded in the blue parameter of the RGB value, on a\n    scale from 1-100.\n\n    Pointclouds are little endian encoded.\n    '
+
+    def __init__(self, *, point_cloud_pcd_chunk: builtins.bytes=...) -> None:
+        ...
+
+    def ClearField(self, field_name: typing.Literal['point_cloud_pcd_chunk', b'point_cloud_pcd_chunk']) -> None:
+        ...
+global___GetPointCloudMapResponse = GetPointCloudMapResponse
+
+@typing.final
+class GetInternalStateRequest(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+    NAME_FIELD_NUMBER: builtins.int
+    name: builtins.str
+    'Name of slam service'
+
+    def __init__(self, *, name: builtins.str=...) -> None:
+        ...
+
+    def ClearField(self, field_name: typing.Literal['name', b'name']) -> None:
+        ...
+global___GetInternalStateRequest = GetInternalStateRequest
+
+@typing.final
+class GetInternalStateResponse(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+    INTERNAL_STATE_CHUNK_FIELD_NUMBER: builtins.int
+    internal_state_chunk: builtins.bytes
+    'Chunk of the internal state of the SLAM algorithm required to continue\n    mapping/localization\n    '
+
+    def __init__(self, *, internal_state_chunk: builtins.bytes=...) -> None:
+        ...
+
+    def ClearField(self, field_name: typing.Literal['internal_state_chunk', b'internal_state_chunk']) -> None:
+        ...
+global___GetInternalStateResponse = GetInternalStateResponse
+
+@typing.final
+class GetPropertiesRequest(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+    NAME_FIELD_NUMBER: builtins.int
+    name: builtins.str
+    'Name of the slam service'
+
+    def __init__(self, *, name: builtins.str=...) -> None:
+        ...
+
+    def ClearField(self, field_name: typing.Literal['name', b'name']) -> None:
+        ...
+global___GetPropertiesRequest = GetPropertiesRequest
+
+@typing.final
+class GetPropertiesResponse(google.protobuf.message.Message):
+    """Returns properties information for the named slam service"""
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+    CLOUD_SLAM_FIELD_NUMBER: builtins.int
+    MAPPING_MODE_FIELD_NUMBER: builtins.int
+    INTERNAL_STATE_FILE_TYPE_FIELD_NUMBER: builtins.int
+    SENSOR_INFO_FIELD_NUMBER: builtins.int
+    cloud_slam: builtins.bool
+    mapping_mode: global___MappingMode.ValueType
+    internal_state_file_type: builtins.str
+
+    @property
+    def sensor_info(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___SensorInfo]:
+        ...
+
+    def __init__(self, *, cloud_slam: builtins.bool=..., mapping_mode: global___MappingMode.ValueType=..., internal_state_file_type: builtins.str | None=..., sensor_info: collections.abc.Iterable[global___SensorInfo] | None=...) -> None:
+        ...
+
+    def HasField(self, field_name: typing.Literal['_internal_state_file_type', b'_internal_state_file_type', 'internal_state_file_type', b'internal_state_file_type']) -> builtins.bool:
+        ...
+
+    def ClearField(self, field_name: typing.Literal['_internal_state_file_type', b'_internal_state_file_type', 'cloud_slam', b'cloud_slam', 'internal_state_file_type', b'internal_state_file_type', 'mapping_mode', b'mapping_mode', 'sensor_info', b'sensor_info']) -> None:
+        ...
+
+    def WhichOneof(self, oneof_group: typing.Literal['_internal_state_file_type', b'_internal_state_file_type']) -> typing.Literal['internal_state_file_type'] | None:
+        ...
+global___GetPropertiesResponse = GetPropertiesResponse
+
+@typing.final
+class SensorInfo(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+    NAME_FIELD_NUMBER: builtins.int
+    TYPE_FIELD_NUMBER: builtins.int
+    name: builtins.str
+    type: global___SensorType.ValueType
+
+    def __init__(self, *, name: builtins.str=..., type: global___SensorType.ValueType=...) -> None:
+        ...
+
+    def ClearField(self, field_name: typing.Literal['name', b'name', 'type', b'type']) -> None:
+        ...
+global___SensorInfo = SensorInfo