v1

package
v0.1.295 Latest Latest
Warning

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

Go to latest
Published: May 1, 2024 License: Apache-2.0 Imports: 18 Imported by: 1

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 File_service_vision_v1_vision_proto protoreflect.FileDescriptor
View Source
var VisionService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "viam.service.vision.v1.VisionService",
	HandlerType: (*VisionServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetDetectionsFromCamera",
			Handler:    _VisionService_GetDetectionsFromCamera_Handler,
		},
		{
			MethodName: "GetDetections",
			Handler:    _VisionService_GetDetections_Handler,
		},
		{
			MethodName: "GetClassificationsFromCamera",
			Handler:    _VisionService_GetClassificationsFromCamera_Handler,
		},
		{
			MethodName: "GetClassifications",
			Handler:    _VisionService_GetClassifications_Handler,
		},
		{
			MethodName: "GetObjectPointClouds",
			Handler:    _VisionService_GetObjectPointClouds_Handler,
		},
		{
			MethodName: "DoCommand",
			Handler:    _VisionService_DoCommand_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "service/vision/v1/vision.proto",
}

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

Functions

func RegisterVisionServiceHandler

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

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

func RegisterVisionServiceHandlerClient

func RegisterVisionServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client VisionServiceClient) error

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

func RegisterVisionServiceHandlerFromEndpoint

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

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

func RegisterVisionServiceHandlerServer

func RegisterVisionServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server VisionServiceServer) error

RegisterVisionServiceHandlerServer registers the http handlers for service VisionService to "mux". UnaryRPC :call VisionServiceServer 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 RegisterVisionServiceHandlerFromEndpoint instead.

func RegisterVisionServiceServer

func RegisterVisionServiceServer(s grpc.ServiceRegistrar, srv VisionServiceServer)

Types

type Classification

type Classification struct {

	// the class name
	ClassName string `protobuf:"bytes,1,opt,name=class_name,json=className,proto3" json:"class_name,omitempty"`
	// the confidence score of the classification
	Confidence float64 `protobuf:"fixed64,2,opt,name=confidence,proto3" json:"confidence,omitempty"`
	// contains filtered or unexported fields
}

the general form of the output from a classifier

func (*Classification) Descriptor deprecated

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

Deprecated: Use Classification.ProtoReflect.Descriptor instead.

func (*Classification) GetClassName

func (x *Classification) GetClassName() string

func (*Classification) GetConfidence

func (x *Classification) GetConfidence() float64

func (*Classification) ProtoMessage

func (*Classification) ProtoMessage()

func (*Classification) ProtoReflect

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

func (*Classification) Reset

func (x *Classification) Reset()

func (*Classification) String

func (x *Classification) String() string

type Detection

type Detection struct {

	// the four corners of the box
	XMin *int64 `protobuf:"varint,1,opt,name=x_min,json=xMin,proto3,oneof" json:"x_min,omitempty"`
	YMin *int64 `protobuf:"varint,2,opt,name=y_min,json=yMin,proto3,oneof" json:"y_min,omitempty"`
	XMax *int64 `protobuf:"varint,3,opt,name=x_max,json=xMax,proto3,oneof" json:"x_max,omitempty"`
	YMax *int64 `protobuf:"varint,4,opt,name=y_max,json=yMax,proto3,oneof" json:"y_max,omitempty"`
	// the confidence of the detection
	Confidence float64 `protobuf:"fixed64,5,opt,name=confidence,proto3" json:"confidence,omitempty"`
	// label associated with the detected object
	ClassName string `protobuf:"bytes,6,opt,name=class_name,json=className,proto3" json:"class_name,omitempty"`
	// contains filtered or unexported fields
}

func (*Detection) Descriptor deprecated

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

Deprecated: Use Detection.ProtoReflect.Descriptor instead.

func (*Detection) GetClassName

func (x *Detection) GetClassName() string

func (*Detection) GetConfidence

func (x *Detection) GetConfidence() float64

func (*Detection) GetXMax

func (x *Detection) GetXMax() int64

func (*Detection) GetXMin

func (x *Detection) GetXMin() int64

func (*Detection) GetYMax

func (x *Detection) GetYMax() int64

func (*Detection) GetYMin

func (x *Detection) GetYMin() int64

func (*Detection) ProtoMessage

func (*Detection) ProtoMessage()

func (*Detection) ProtoReflect

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

func (*Detection) Reset

func (x *Detection) Reset()

func (*Detection) String

func (x *Detection) String() string

type GetClassificationsFromCameraRequest

type GetClassificationsFromCameraRequest struct {

	// name of the vision service
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// the image encoded as bytes
	CameraName string `protobuf:"bytes,2,opt,name=camera_name,json=cameraName,proto3" json:"camera_name,omitempty"`
	// the number of classifications desired
	N int32 `protobuf:"varint,3,opt,name=n,proto3" json:"n,omitempty"`
	// Additional arguments to the method
	Extra *structpb.Struct `protobuf:"bytes,99,opt,name=extra,proto3" json:"extra,omitempty"`
	// contains filtered or unexported fields
}

func (*GetClassificationsFromCameraRequest) Descriptor deprecated

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

Deprecated: Use GetClassificationsFromCameraRequest.ProtoReflect.Descriptor instead.

func (*GetClassificationsFromCameraRequest) GetCameraName

func (x *GetClassificationsFromCameraRequest) GetCameraName() string

func (*GetClassificationsFromCameraRequest) GetExtra added in v0.1.6

func (*GetClassificationsFromCameraRequest) GetN

func (*GetClassificationsFromCameraRequest) GetName

func (*GetClassificationsFromCameraRequest) ProtoMessage

func (*GetClassificationsFromCameraRequest) ProtoMessage()

func (*GetClassificationsFromCameraRequest) ProtoReflect

func (*GetClassificationsFromCameraRequest) Reset

func (*GetClassificationsFromCameraRequest) String

type GetClassificationsFromCameraResponse

type GetClassificationsFromCameraResponse struct {
	Classifications []*Classification `protobuf:"bytes,1,rep,name=classifications,proto3" json:"classifications,omitempty"`
	// contains filtered or unexported fields
}

func (*GetClassificationsFromCameraResponse) Descriptor deprecated

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

Deprecated: Use GetClassificationsFromCameraResponse.ProtoReflect.Descriptor instead.

func (*GetClassificationsFromCameraResponse) GetClassifications

func (x *GetClassificationsFromCameraResponse) GetClassifications() []*Classification

func (*GetClassificationsFromCameraResponse) ProtoMessage

func (*GetClassificationsFromCameraResponse) ProtoMessage()

func (*GetClassificationsFromCameraResponse) ProtoReflect

func (*GetClassificationsFromCameraResponse) Reset

func (*GetClassificationsFromCameraResponse) String

type GetClassificationsRequest

type GetClassificationsRequest struct {

	// name of the vision service
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// the image encoded as bytes
	Image []byte `protobuf:"bytes,2,opt,name=image,proto3" json:"image,omitempty"`
	// the width of the image
	Width int32 `protobuf:"varint,3,opt,name=width,proto3" json:"width,omitempty"`
	// the height of the image
	Height int32 `protobuf:"varint,4,opt,name=height,proto3" json:"height,omitempty"`
	// the actual MIME type of image
	MimeType string `protobuf:"bytes,5,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"`
	// the number of classifications desired
	N int32 `protobuf:"varint,6,opt,name=n,proto3" json:"n,omitempty"`
	// Additional arguments to the method
	Extra *structpb.Struct `protobuf:"bytes,99,opt,name=extra,proto3" json:"extra,omitempty"`
	// contains filtered or unexported fields
}

func (*GetClassificationsRequest) Descriptor deprecated

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

Deprecated: Use GetClassificationsRequest.ProtoReflect.Descriptor instead.

func (*GetClassificationsRequest) GetExtra added in v0.1.6

func (x *GetClassificationsRequest) GetExtra() *structpb.Struct

func (*GetClassificationsRequest) GetHeight

func (x *GetClassificationsRequest) GetHeight() int32

func (*GetClassificationsRequest) GetImage

func (x *GetClassificationsRequest) GetImage() []byte

func (*GetClassificationsRequest) GetMimeType

func (x *GetClassificationsRequest) GetMimeType() string

func (*GetClassificationsRequest) GetN

func (x *GetClassificationsRequest) GetN() int32

func (*GetClassificationsRequest) GetName

func (x *GetClassificationsRequest) GetName() string

func (*GetClassificationsRequest) GetWidth

func (x *GetClassificationsRequest) GetWidth() int32

func (*GetClassificationsRequest) ProtoMessage

func (*GetClassificationsRequest) ProtoMessage()

func (*GetClassificationsRequest) ProtoReflect

func (*GetClassificationsRequest) Reset

func (x *GetClassificationsRequest) Reset()

func (*GetClassificationsRequest) String

func (x *GetClassificationsRequest) String() string

type GetClassificationsResponse

type GetClassificationsResponse struct {
	Classifications []*Classification `protobuf:"bytes,1,rep,name=classifications,proto3" json:"classifications,omitempty"`
	// contains filtered or unexported fields
}

func (*GetClassificationsResponse) Descriptor deprecated

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

Deprecated: Use GetClassificationsResponse.ProtoReflect.Descriptor instead.

func (*GetClassificationsResponse) GetClassifications

func (x *GetClassificationsResponse) GetClassifications() []*Classification

func (*GetClassificationsResponse) ProtoMessage

func (*GetClassificationsResponse) ProtoMessage()

func (*GetClassificationsResponse) ProtoReflect

func (*GetClassificationsResponse) Reset

func (x *GetClassificationsResponse) Reset()

func (*GetClassificationsResponse) String

func (x *GetClassificationsResponse) String() string

type GetDetectionsFromCameraRequest

type GetDetectionsFromCameraRequest struct {

	// name of the vision service
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// name of camera source to use as input
	CameraName string           `protobuf:"bytes,2,opt,name=camera_name,json=cameraName,proto3" json:"camera_name,omitempty"`
	Extra      *structpb.Struct `protobuf:"bytes,99,opt,name=extra,proto3" json:"extra,omitempty"`
	// contains filtered or unexported fields
}

func (*GetDetectionsFromCameraRequest) Descriptor deprecated

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

Deprecated: Use GetDetectionsFromCameraRequest.ProtoReflect.Descriptor instead.

func (*GetDetectionsFromCameraRequest) GetCameraName

func (x *GetDetectionsFromCameraRequest) GetCameraName() string

func (*GetDetectionsFromCameraRequest) GetExtra added in v0.1.6

func (*GetDetectionsFromCameraRequest) GetName

func (*GetDetectionsFromCameraRequest) ProtoMessage

func (*GetDetectionsFromCameraRequest) ProtoMessage()

func (*GetDetectionsFromCameraRequest) ProtoReflect

func (*GetDetectionsFromCameraRequest) Reset

func (x *GetDetectionsFromCameraRequest) Reset()

func (*GetDetectionsFromCameraRequest) String

type GetDetectionsFromCameraResponse

type GetDetectionsFromCameraResponse struct {

	// the bounding boxes and labels
	Detections []*Detection `protobuf:"bytes,1,rep,name=detections,proto3" json:"detections,omitempty"`
	// contains filtered or unexported fields
}

func (*GetDetectionsFromCameraResponse) Descriptor deprecated

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

Deprecated: Use GetDetectionsFromCameraResponse.ProtoReflect.Descriptor instead.

func (*GetDetectionsFromCameraResponse) GetDetections

func (x *GetDetectionsFromCameraResponse) GetDetections() []*Detection

func (*GetDetectionsFromCameraResponse) ProtoMessage

func (*GetDetectionsFromCameraResponse) ProtoMessage()

func (*GetDetectionsFromCameraResponse) ProtoReflect

func (*GetDetectionsFromCameraResponse) Reset

func (*GetDetectionsFromCameraResponse) String

type GetDetectionsRequest

type GetDetectionsRequest struct {

	// name of the vision service
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// the image, encoded as bytes
	Image []byte `protobuf:"bytes,2,opt,name=image,proto3" json:"image,omitempty"`
	// the width of the image
	Width int64 `protobuf:"varint,3,opt,name=width,proto3" json:"width,omitempty"`
	// the height of the image
	Height int64 `protobuf:"varint,4,opt,name=height,proto3" json:"height,omitempty"`
	// the actual MIME type of image
	MimeType string `protobuf:"bytes,5,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"`
	// Additional arguments to the method
	Extra *structpb.Struct `protobuf:"bytes,99,opt,name=extra,proto3" json:"extra,omitempty"`
	// contains filtered or unexported fields
}

func (*GetDetectionsRequest) Descriptor deprecated

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

Deprecated: Use GetDetectionsRequest.ProtoReflect.Descriptor instead.

func (*GetDetectionsRequest) GetExtra added in v0.1.6

func (x *GetDetectionsRequest) GetExtra() *structpb.Struct

func (*GetDetectionsRequest) GetHeight

func (x *GetDetectionsRequest) GetHeight() int64

func (*GetDetectionsRequest) GetImage

func (x *GetDetectionsRequest) GetImage() []byte

func (*GetDetectionsRequest) GetMimeType

func (x *GetDetectionsRequest) GetMimeType() string

func (*GetDetectionsRequest) GetName

func (x *GetDetectionsRequest) GetName() string

func (*GetDetectionsRequest) GetWidth

func (x *GetDetectionsRequest) GetWidth() int64

func (*GetDetectionsRequest) ProtoMessage

func (*GetDetectionsRequest) ProtoMessage()

func (*GetDetectionsRequest) ProtoReflect

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

func (*GetDetectionsRequest) Reset

func (x *GetDetectionsRequest) Reset()

func (*GetDetectionsRequest) String

func (x *GetDetectionsRequest) String() string

type GetDetectionsResponse

type GetDetectionsResponse struct {

	// the bounding boxes and labels
	Detections []*Detection `protobuf:"bytes,1,rep,name=detections,proto3" json:"detections,omitempty"`
	// contains filtered or unexported fields
}

func (*GetDetectionsResponse) Descriptor deprecated

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

Deprecated: Use GetDetectionsResponse.ProtoReflect.Descriptor instead.

func (*GetDetectionsResponse) GetDetections

func (x *GetDetectionsResponse) GetDetections() []*Detection

func (*GetDetectionsResponse) ProtoMessage

func (*GetDetectionsResponse) ProtoMessage()

func (*GetDetectionsResponse) ProtoReflect

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

func (*GetDetectionsResponse) Reset

func (x *GetDetectionsResponse) Reset()

func (*GetDetectionsResponse) String

func (x *GetDetectionsResponse) String() string

type GetObjectPointCloudsRequest

type GetObjectPointCloudsRequest struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Name of a camera
	CameraName string `protobuf:"bytes,2,opt,name=camera_name,json=cameraName,proto3" json:"camera_name,omitempty"`
	// Requested MIME type of response
	MimeType string `protobuf:"bytes,3,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"`
	// Additional arguments to the method
	Extra *structpb.Struct `protobuf:"bytes,99,opt,name=extra,proto3" json:"extra,omitempty"`
	// contains filtered or unexported fields
}

func (*GetObjectPointCloudsRequest) Descriptor deprecated

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

Deprecated: Use GetObjectPointCloudsRequest.ProtoReflect.Descriptor instead.

func (*GetObjectPointCloudsRequest) GetCameraName

func (x *GetObjectPointCloudsRequest) GetCameraName() string

func (*GetObjectPointCloudsRequest) GetExtra added in v0.1.6

func (*GetObjectPointCloudsRequest) GetMimeType

func (x *GetObjectPointCloudsRequest) GetMimeType() string

func (*GetObjectPointCloudsRequest) GetName

func (x *GetObjectPointCloudsRequest) GetName() string

func (*GetObjectPointCloudsRequest) ProtoMessage

func (*GetObjectPointCloudsRequest) ProtoMessage()

func (*GetObjectPointCloudsRequest) ProtoReflect

func (*GetObjectPointCloudsRequest) Reset

func (x *GetObjectPointCloudsRequest) Reset()

func (*GetObjectPointCloudsRequest) String

func (x *GetObjectPointCloudsRequest) String() string

type GetObjectPointCloudsResponse

type GetObjectPointCloudsResponse struct {

	// Actual MIME type of response
	MimeType string `protobuf:"bytes,1,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"`
	// List of objects in the scene
	Objects []*v1.PointCloudObject `protobuf:"bytes,2,rep,name=objects,proto3" json:"objects,omitempty"`
	// contains filtered or unexported fields
}

func (*GetObjectPointCloudsResponse) Descriptor deprecated

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

Deprecated: Use GetObjectPointCloudsResponse.ProtoReflect.Descriptor instead.

func (*GetObjectPointCloudsResponse) GetMimeType

func (x *GetObjectPointCloudsResponse) GetMimeType() string

func (*GetObjectPointCloudsResponse) GetObjects

func (*GetObjectPointCloudsResponse) ProtoMessage

func (*GetObjectPointCloudsResponse) ProtoMessage()

func (*GetObjectPointCloudsResponse) ProtoReflect

func (*GetObjectPointCloudsResponse) Reset

func (x *GetObjectPointCloudsResponse) Reset()

func (*GetObjectPointCloudsResponse) String

type UnimplementedVisionServiceServer

type UnimplementedVisionServiceServer struct {
}

UnimplementedVisionServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedVisionServiceServer) DoCommand added in v0.1.80

func (UnimplementedVisionServiceServer) GetClassifications

func (UnimplementedVisionServiceServer) GetDetections

type UnsafeVisionServiceServer

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

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

type VisionServiceClient

type VisionServiceClient interface {
	// GetDetectionsFromCamera will return a list of detections in the next image given a camera and a detector
	GetDetectionsFromCamera(ctx context.Context, in *GetDetectionsFromCameraRequest, opts ...grpc.CallOption) (*GetDetectionsFromCameraResponse, error)
	// GetDetections will return a list of detections in the next image given the image bytes and a detector
	GetDetections(ctx context.Context, in *GetDetectionsRequest, opts ...grpc.CallOption) (*GetDetectionsResponse, error)
	// GetClassificationsFromCamera will return a list of classifications in the next image given a camera and a classifier
	GetClassificationsFromCamera(ctx context.Context, in *GetClassificationsFromCameraRequest, opts ...grpc.CallOption) (*GetClassificationsFromCameraResponse, error)
	// GetClassifications will return a list of classifications in the next image given the image bytes and a classifier
	GetClassifications(ctx context.Context, in *GetClassificationsRequest, opts ...grpc.CallOption) (*GetClassificationsResponse, error)
	// GetObjectPointClouds returns all the found objects in a pointcloud from a camera of the underlying robot,
	// as well as the 3-vector center of each of the found objects.
	// A specific MIME type can be requested but may not necessarily be the same one returned.
	GetObjectPointClouds(ctx context.Context, in *GetObjectPointCloudsRequest, opts ...grpc.CallOption) (*GetObjectPointCloudsResponse, error)
	// DoCommand sends/receives arbitrary commands
	DoCommand(ctx context.Context, in *v1.DoCommandRequest, opts ...grpc.CallOption) (*v1.DoCommandResponse, error)
}

VisionServiceClient is the client API for VisionService 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 VisionServiceServer

type VisionServiceServer interface {
	// GetDetectionsFromCamera will return a list of detections in the next image given a camera and a detector
	GetDetectionsFromCamera(context.Context, *GetDetectionsFromCameraRequest) (*GetDetectionsFromCameraResponse, error)
	// GetDetections will return a list of detections in the next image given the image bytes and a detector
	GetDetections(context.Context, *GetDetectionsRequest) (*GetDetectionsResponse, error)
	// GetClassificationsFromCamera will return a list of classifications in the next image given a camera and a classifier
	GetClassificationsFromCamera(context.Context, *GetClassificationsFromCameraRequest) (*GetClassificationsFromCameraResponse, error)
	// GetClassifications will return a list of classifications in the next image given the image bytes and a classifier
	GetClassifications(context.Context, *GetClassificationsRequest) (*GetClassificationsResponse, error)
	// GetObjectPointClouds returns all the found objects in a pointcloud from a camera of the underlying robot,
	// as well as the 3-vector center of each of the found objects.
	// A specific MIME type can be requested but may not necessarily be the same one returned.
	GetObjectPointClouds(context.Context, *GetObjectPointCloudsRequest) (*GetObjectPointCloudsResponse, error)
	// DoCommand sends/receives arbitrary commands
	DoCommand(context.Context, *v1.DoCommandRequest) (*v1.DoCommandResponse, error)
	// contains filtered or unexported methods
}

VisionServiceServer is the server API for VisionService service. All implementations must embed UnimplementedVisionServiceServer for forward compatibility

Jump to

Keyboard shortcuts

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