v1

package
v0.1.367 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 22, 2024 License: Apache-2.0 Imports: 17 Imported by: 3

Documentation

Overview

Package v1 is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

This section is empty.

Variables

View Source
var (
	MappingMode_name = map[int32]string{
		0: "MAPPING_MODE_UNSPECIFIED",
		1: "MAPPING_MODE_CREATE_NEW_MAP",
		2: "MAPPING_MODE_LOCALIZE_ONLY",
		3: "MAPPING_MODE_UPDATE_EXISTING_MAP",
	}
	MappingMode_value = map[string]int32{
		"MAPPING_MODE_UNSPECIFIED":         0,
		"MAPPING_MODE_CREATE_NEW_MAP":      1,
		"MAPPING_MODE_LOCALIZE_ONLY":       2,
		"MAPPING_MODE_UPDATE_EXISTING_MAP": 3,
	}
)

Enum value maps for MappingMode.

View Source
var (
	SensorType_name = map[int32]string{
		0: "SENSOR_TYPE_UNSPECIFIED",
		1: "SENSOR_TYPE_CAMERA",
		2: "SENSOR_TYPE_MOVEMENT_SENSOR",
	}
	SensorType_value = map[string]int32{
		"SENSOR_TYPE_UNSPECIFIED":     0,
		"SENSOR_TYPE_CAMERA":          1,
		"SENSOR_TYPE_MOVEMENT_SENSOR": 2,
	}
)

Enum value maps for SensorType.

View Source
var File_service_slam_v1_slam_proto protoreflect.FileDescriptor
View Source
var SLAMService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "viam.service.slam.v1.SLAMService",
	HandlerType: (*SLAMServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetPosition",
			Handler:    _SLAMService_GetPosition_Handler,
		},
		{
			MethodName: "GetProperties",
			Handler:    _SLAMService_GetProperties_Handler,
		},
		{
			MethodName: "DoCommand",
			Handler:    _SLAMService_DoCommand_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "GetPointCloudMap",
			Handler:       _SLAMService_GetPointCloudMap_Handler,
			ServerStreams: true,
		},
		{
			StreamName:    "GetInternalState",
			Handler:       _SLAMService_GetInternalState_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "service/slam/v1/slam.proto",
}

SLAMService_ServiceDesc is the grpc.ServiceDesc for SLAMService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterSLAMServiceHandler

func RegisterSLAMServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterSLAMServiceHandler registers the http handlers for service SLAMService to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterSLAMServiceHandlerClient

func RegisterSLAMServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client SLAMServiceClient) error

RegisterSLAMServiceHandlerClient registers the http handlers for service SLAMService to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "SLAMServiceClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "SLAMServiceClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "SLAMServiceClient" to call the correct interceptors.

func RegisterSLAMServiceHandlerFromEndpoint

func RegisterSLAMServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterSLAMServiceHandlerFromEndpoint is same as RegisterSLAMServiceHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterSLAMServiceHandlerServer

func RegisterSLAMServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server SLAMServiceServer) error

RegisterSLAMServiceHandlerServer registers the http handlers for service SLAMService to "mux". UnaryRPC :call SLAMServiceServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterSLAMServiceHandlerFromEndpoint instead.

func RegisterSLAMServiceServer

func RegisterSLAMServiceServer(s grpc.ServiceRegistrar, srv SLAMServiceServer)

Types

type GetInternalStateRequest added in v0.1.42

type GetInternalStateRequest struct {

	// Name of slam service
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

func (*GetInternalStateRequest) Descriptor deprecated added in v0.1.42

func (*GetInternalStateRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetInternalStateRequest.ProtoReflect.Descriptor instead.

func (*GetInternalStateRequest) GetName added in v0.1.42

func (x *GetInternalStateRequest) GetName() string

func (*GetInternalStateRequest) ProtoMessage added in v0.1.42

func (*GetInternalStateRequest) ProtoMessage()

func (*GetInternalStateRequest) ProtoReflect added in v0.1.42

func (x *GetInternalStateRequest) ProtoReflect() protoreflect.Message

func (*GetInternalStateRequest) Reset added in v0.1.42

func (x *GetInternalStateRequest) Reset()

func (*GetInternalStateRequest) String added in v0.1.42

func (x *GetInternalStateRequest) String() string

type GetInternalStateResponse added in v0.1.42

type GetInternalStateResponse struct {

	// Chunk of the internal state of the SLAM algorithm required to continue
	// mapping/localization
	InternalStateChunk []byte `protobuf:"bytes,1,opt,name=internal_state_chunk,json=internalStateChunk,proto3" json:"internal_state_chunk,omitempty"`
	// contains filtered or unexported fields
}

func (*GetInternalStateResponse) Descriptor deprecated added in v0.1.42

func (*GetInternalStateResponse) Descriptor() ([]byte, []int)

Deprecated: Use GetInternalStateResponse.ProtoReflect.Descriptor instead.

func (*GetInternalStateResponse) GetInternalStateChunk added in v0.1.98

func (x *GetInternalStateResponse) GetInternalStateChunk() []byte

func (*GetInternalStateResponse) ProtoMessage added in v0.1.42

func (*GetInternalStateResponse) ProtoMessage()

func (*GetInternalStateResponse) ProtoReflect added in v0.1.42

func (x *GetInternalStateResponse) ProtoReflect() protoreflect.Message

func (*GetInternalStateResponse) Reset added in v0.1.42

func (x *GetInternalStateResponse) Reset()

func (*GetInternalStateResponse) String added in v0.1.42

func (x *GetInternalStateResponse) String() string

type GetPointCloudMapRequest added in v0.1.42

type GetPointCloudMapRequest struct {

	// Name of slam service
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// For SLAM services that implement handling an edited map, this boolean
	// should indicate whether to return that edited map. If the SLAM service
	// does not handle edited maps, the unedited map will be returned instead.
	ReturnEditedMap *bool `protobuf:"varint,2,opt,name=return_edited_map,json=returnEditedMap,proto3,oneof" json:"return_edited_map,omitempty"`
	// contains filtered or unexported fields
}

func (*GetPointCloudMapRequest) Descriptor deprecated added in v0.1.42

func (*GetPointCloudMapRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetPointCloudMapRequest.ProtoReflect.Descriptor instead.

func (*GetPointCloudMapRequest) GetName added in v0.1.42

func (x *GetPointCloudMapRequest) GetName() string

func (*GetPointCloudMapRequest) GetReturnEditedMap added in v0.1.273

func (x *GetPointCloudMapRequest) GetReturnEditedMap() bool

func (*GetPointCloudMapRequest) ProtoMessage added in v0.1.42

func (*GetPointCloudMapRequest) ProtoMessage()

func (*GetPointCloudMapRequest) ProtoReflect added in v0.1.42

func (x *GetPointCloudMapRequest) ProtoReflect() protoreflect.Message

func (*GetPointCloudMapRequest) Reset added in v0.1.42

func (x *GetPointCloudMapRequest) Reset()

func (*GetPointCloudMapRequest) String added in v0.1.42

func (x *GetPointCloudMapRequest) String() string

type GetPointCloudMapResponse added in v0.1.42

type GetPointCloudMapResponse struct {

	// One chunk of the PointCloud.
	// For a given GetPointCloudMap request, concatenating all
	// GetPointCloudMapResponse.point_cloud_pcd_chunk values in the
	// order received result in the complete pointcloud in standard PCD
	// format where XY is the ground plane and positive Z is up, following
	// the Right Hand Rule.
	//
	// Read more about the pointcloud format here:
	// https://pointclouds.org/documentation/tutorials/pcd_file_format.html
	//
	// Viam expects pointcloud data with fields "x y z" or "x y z rgb", and for
	// this to be specified in the pointcloud header in the FIELDS entry. If color
	// data is included in the pointcloud, Viam's services assume that the color
	// value encodes a confidence score for that data point. Viam expects the
	// confidence score to be encoded in the blue parameter of the RGB value, on a
	// scale from 1-100.
	//
	// Pointclouds are little endian encoded.
	PointCloudPcdChunk []byte `protobuf:"bytes,1,opt,name=point_cloud_pcd_chunk,json=pointCloudPcdChunk,proto3" json:"point_cloud_pcd_chunk,omitempty"`
	// contains filtered or unexported fields
}

func (*GetPointCloudMapResponse) Descriptor deprecated added in v0.1.42

func (*GetPointCloudMapResponse) Descriptor() ([]byte, []int)

Deprecated: Use GetPointCloudMapResponse.ProtoReflect.Descriptor instead.

func (*GetPointCloudMapResponse) GetPointCloudPcdChunk added in v0.1.98

func (x *GetPointCloudMapResponse) GetPointCloudPcdChunk() []byte

func (*GetPointCloudMapResponse) ProtoMessage added in v0.1.42

func (*GetPointCloudMapResponse) ProtoMessage()

func (*GetPointCloudMapResponse) ProtoReflect added in v0.1.42

func (x *GetPointCloudMapResponse) ProtoReflect() protoreflect.Message

func (*GetPointCloudMapResponse) Reset added in v0.1.42

func (x *GetPointCloudMapResponse) Reset()

func (*GetPointCloudMapResponse) String added in v0.1.42

func (x *GetPointCloudMapResponse) String() string

type GetPositionRequest

type GetPositionRequest struct {

	// Name of slam service
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

func (*GetPositionRequest) Descriptor deprecated

func (*GetPositionRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetPositionRequest.ProtoReflect.Descriptor instead.

func (*GetPositionRequest) GetName

func (x *GetPositionRequest) GetName() string

func (*GetPositionRequest) ProtoMessage

func (*GetPositionRequest) ProtoMessage()

func (*GetPositionRequest) ProtoReflect

func (x *GetPositionRequest) ProtoReflect() protoreflect.Message

func (*GetPositionRequest) Reset

func (x *GetPositionRequest) Reset()

func (*GetPositionRequest) String

func (x *GetPositionRequest) String() string

type GetPositionResponse

type GetPositionResponse struct {

	// Current position of the specified component in the SLAM Map
	Pose *v1.Pose `protobuf:"bytes,1,opt,name=pose,proto3" json:"pose,omitempty"`
	// contains filtered or unexported fields
}

func (*GetPositionResponse) Descriptor deprecated

func (*GetPositionResponse) Descriptor() ([]byte, []int)

Deprecated: Use GetPositionResponse.ProtoReflect.Descriptor instead.

func (*GetPositionResponse) GetPose

func (x *GetPositionResponse) GetPose() *v1.Pose

func (*GetPositionResponse) ProtoMessage

func (*GetPositionResponse) ProtoMessage()

func (*GetPositionResponse) ProtoReflect

func (x *GetPositionResponse) ProtoReflect() protoreflect.Message

func (*GetPositionResponse) Reset

func (x *GetPositionResponse) Reset()

func (*GetPositionResponse) String

func (x *GetPositionResponse) String() string

type GetPropertiesRequest added in v0.1.245

type GetPropertiesRequest struct {

	// Name of the slam service
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

func (*GetPropertiesRequest) Descriptor deprecated added in v0.1.245

func (*GetPropertiesRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetPropertiesRequest.ProtoReflect.Descriptor instead.

func (*GetPropertiesRequest) GetName added in v0.1.245

func (x *GetPropertiesRequest) GetName() string

func (*GetPropertiesRequest) ProtoMessage added in v0.1.245

func (*GetPropertiesRequest) ProtoMessage()

func (*GetPropertiesRequest) ProtoReflect added in v0.1.245

func (x *GetPropertiesRequest) ProtoReflect() protoreflect.Message

func (*GetPropertiesRequest) Reset added in v0.1.245

func (x *GetPropertiesRequest) Reset()

func (*GetPropertiesRequest) String added in v0.1.245

func (x *GetPropertiesRequest) String() string

type GetPropertiesResponse added in v0.1.245

type GetPropertiesResponse struct {
	CloudSlam             bool          `protobuf:"varint,1,opt,name=cloud_slam,json=cloudSlam,proto3" json:"cloud_slam,omitempty"`
	MappingMode           MappingMode   `` /* 133-byte string literal not displayed */
	InternalStateFileType *string       `` /* 134-byte string literal not displayed */
	SensorInfo            []*SensorInfo `protobuf:"bytes,4,rep,name=sensor_info,json=sensorInfo,proto3" json:"sensor_info,omitempty"`
	// contains filtered or unexported fields
}

Returns properties information for the named slam service

func (*GetPropertiesResponse) Descriptor deprecated added in v0.1.245

func (*GetPropertiesResponse) Descriptor() ([]byte, []int)

Deprecated: Use GetPropertiesResponse.ProtoReflect.Descriptor instead.

func (*GetPropertiesResponse) GetCloudSlam added in v0.1.245

func (x *GetPropertiesResponse) GetCloudSlam() bool

func (*GetPropertiesResponse) GetInternalStateFileType added in v0.1.275

func (x *GetPropertiesResponse) GetInternalStateFileType() string

func (*GetPropertiesResponse) GetMappingMode added in v0.1.245

func (x *GetPropertiesResponse) GetMappingMode() MappingMode

func (*GetPropertiesResponse) GetSensorInfo added in v0.1.275

func (x *GetPropertiesResponse) GetSensorInfo() []*SensorInfo

func (*GetPropertiesResponse) ProtoMessage added in v0.1.245

func (*GetPropertiesResponse) ProtoMessage()

func (*GetPropertiesResponse) ProtoReflect added in v0.1.245

func (x *GetPropertiesResponse) ProtoReflect() protoreflect.Message

func (*GetPropertiesResponse) Reset added in v0.1.245

func (x *GetPropertiesResponse) Reset()

func (*GetPropertiesResponse) String added in v0.1.245

func (x *GetPropertiesResponse) String() string

type MappingMode added in v0.1.245

type MappingMode int32

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.

const (
	MappingMode_MAPPING_MODE_UNSPECIFIED         MappingMode = 0
	MappingMode_MAPPING_MODE_CREATE_NEW_MAP      MappingMode = 1
	MappingMode_MAPPING_MODE_LOCALIZE_ONLY       MappingMode = 2
	MappingMode_MAPPING_MODE_UPDATE_EXISTING_MAP MappingMode = 3
)

func (MappingMode) Descriptor added in v0.1.245

func (MappingMode) Enum added in v0.1.245

func (x MappingMode) Enum() *MappingMode

func (MappingMode) EnumDescriptor deprecated added in v0.1.245

func (MappingMode) EnumDescriptor() ([]byte, []int)

Deprecated: Use MappingMode.Descriptor instead.

func (MappingMode) Number added in v0.1.245

func (x MappingMode) Number() protoreflect.EnumNumber

func (MappingMode) String added in v0.1.245

func (x MappingMode) String() string

func (MappingMode) Type added in v0.1.245

type SLAMServiceClient

type SLAMServiceClient interface {
	// GetPosition returns the current estimated position of the robot with
	// respect to a returned component reference.
	GetPosition(ctx context.Context, in *GetPositionRequest, opts ...grpc.CallOption) (*GetPositionResponse, error)
	// GetPointCloudMap returns the latest pointcloud map available where XY is the ground
	// plane and positive Z is up, following the Right Hand Rule.
	GetPointCloudMap(ctx context.Context, in *GetPointCloudMapRequest, opts ...grpc.CallOption) (SLAMService_GetPointCloudMapClient, error)
	// GetInternalState returns the internal map as defined by the specified slam
	// algorithm required to continue mapping/localizing.
	// This endpoint is not intended for end users.
	GetInternalState(ctx context.Context, in *GetInternalStateRequest, opts ...grpc.CallOption) (SLAMService_GetInternalStateClient, error)
	// GetProperties returns properties of the current slam service including mapping_mode
	// and cloud_slam, where mapping_mode is the type of mapping/localizing being performed
	// and cloud_slam is a boolean representing if this SLAM service is being run in the cloud.
	GetProperties(ctx context.Context, in *GetPropertiesRequest, opts ...grpc.CallOption) (*GetPropertiesResponse, error)
	// DoCommand sends/receives arbitrary commands.
	DoCommand(ctx context.Context, in *v1.DoCommandRequest, opts ...grpc.CallOption) (*v1.DoCommandResponse, error)
}

SLAMServiceClient is the client API for SLAMService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

type SLAMServiceServer

type SLAMServiceServer interface {
	// GetPosition returns the current estimated position of the robot with
	// respect to a returned component reference.
	GetPosition(context.Context, *GetPositionRequest) (*GetPositionResponse, error)
	// GetPointCloudMap returns the latest pointcloud map available where XY is the ground
	// plane and positive Z is up, following the Right Hand Rule.
	GetPointCloudMap(*GetPointCloudMapRequest, SLAMService_GetPointCloudMapServer) error
	// GetInternalState returns the internal map as defined by the specified slam
	// algorithm required to continue mapping/localizing.
	// This endpoint is not intended for end users.
	GetInternalState(*GetInternalStateRequest, SLAMService_GetInternalStateServer) error
	// GetProperties returns properties of the current slam service including mapping_mode
	// and cloud_slam, where mapping_mode is the type of mapping/localizing being performed
	// and cloud_slam is a boolean representing if this SLAM service is being run in the cloud.
	GetProperties(context.Context, *GetPropertiesRequest) (*GetPropertiesResponse, error)
	// DoCommand sends/receives arbitrary commands.
	DoCommand(context.Context, *v1.DoCommandRequest) (*v1.DoCommandResponse, error)
	// contains filtered or unexported methods
}

SLAMServiceServer is the server API for SLAMService service. All implementations must embed UnimplementedSLAMServiceServer for forward compatibility

type SLAMService_GetInternalStateClient added in v0.1.98

type SLAMService_GetInternalStateClient interface {
	Recv() (*GetInternalStateResponse, error)
	grpc.ClientStream
}

type SLAMService_GetInternalStateServer added in v0.1.98

type SLAMService_GetInternalStateServer interface {
	Send(*GetInternalStateResponse) error
	grpc.ServerStream
}

type SLAMService_GetPointCloudMapClient added in v0.1.98

type SLAMService_GetPointCloudMapClient interface {
	Recv() (*GetPointCloudMapResponse, error)
	grpc.ClientStream
}

type SLAMService_GetPointCloudMapServer added in v0.1.98

type SLAMService_GetPointCloudMapServer interface {
	Send(*GetPointCloudMapResponse) error
	grpc.ServerStream
}

type SensorInfo added in v0.1.275

type SensorInfo struct {
	Name string     `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Type SensorType `protobuf:"varint,2,opt,name=type,proto3,enum=viam.service.slam.v1.SensorType" json:"type,omitempty"`
	// contains filtered or unexported fields
}

func (*SensorInfo) Descriptor deprecated added in v0.1.275

func (*SensorInfo) Descriptor() ([]byte, []int)

Deprecated: Use SensorInfo.ProtoReflect.Descriptor instead.

func (*SensorInfo) GetName added in v0.1.275

func (x *SensorInfo) GetName() string

func (*SensorInfo) GetType added in v0.1.275

func (x *SensorInfo) GetType() SensorType

func (*SensorInfo) ProtoMessage added in v0.1.275

func (*SensorInfo) ProtoMessage()

func (*SensorInfo) ProtoReflect added in v0.1.275

func (x *SensorInfo) ProtoReflect() protoreflect.Message

func (*SensorInfo) Reset added in v0.1.275

func (x *SensorInfo) Reset()

func (*SensorInfo) String added in v0.1.275

func (x *SensorInfo) String() string

type SensorType added in v0.1.275

type SensorType int32
const (
	SensorType_SENSOR_TYPE_UNSPECIFIED     SensorType = 0
	SensorType_SENSOR_TYPE_CAMERA          SensorType = 1
	SensorType_SENSOR_TYPE_MOVEMENT_SENSOR SensorType = 2
)

func (SensorType) Descriptor added in v0.1.275

func (SensorType) Descriptor() protoreflect.EnumDescriptor

func (SensorType) Enum added in v0.1.275

func (x SensorType) Enum() *SensorType

func (SensorType) EnumDescriptor deprecated added in v0.1.275

func (SensorType) EnumDescriptor() ([]byte, []int)

Deprecated: Use SensorType.Descriptor instead.

func (SensorType) Number added in v0.1.275

func (x SensorType) Number() protoreflect.EnumNumber

func (SensorType) String added in v0.1.275

func (x SensorType) String() string

func (SensorType) Type added in v0.1.275

type UnimplementedSLAMServiceServer

type UnimplementedSLAMServiceServer struct {
}

UnimplementedSLAMServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedSLAMServiceServer) DoCommand added in v0.1.80

func (UnimplementedSLAMServiceServer) GetInternalState added in v0.1.42

func (UnimplementedSLAMServiceServer) GetPointCloudMap added in v0.1.42

func (UnimplementedSLAMServiceServer) GetPosition

func (UnimplementedSLAMServiceServer) GetProperties added in v0.1.245

type UnsafeSLAMServiceServer

type UnsafeSLAMServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeSLAMServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to SLAMServiceServer will result in compilation errors.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL