v1

package
v0.1.313 Latest Latest
Warning

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

 Go to latest Published: Jun 11, 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 (
	MapType_name = map[int32]string{
		0: "MAP_TYPE_UNSPECIFIED",
		1: "MAP_TYPE_NONE",
		2: "MAP_TYPE_GPS",
	}
	MapType_value = map[string]int32{
		"MAP_TYPE_UNSPECIFIED": 0,
		"MAP_TYPE_NONE":        1,
		"MAP_TYPE_GPS":         2,
	}
)

Enum value maps for MapType.

View Source 
var (
	Mode_name = map[int32]string{
		0: "MODE_UNSPECIFIED",
		1: "MODE_MANUAL",
		2: "MODE_WAYPOINT",
		3: "MODE_EXPLORE",
	}
	Mode_value = map[string]int32{
		"MODE_UNSPECIFIED": 0,
		"MODE_MANUAL":      1,
		"MODE_WAYPOINT":    2,
		"MODE_EXPLORE":     3,
	}
)

Enum value maps for Mode.

View Source 
var File_service_navigation_v1_navigation_proto protoreflect.FileDescriptor
View Source 
var NavigationService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "viam.service.navigation.v1.NavigationService",
	HandlerType: (*NavigationServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetMode",
			Handler:    _NavigationService_GetMode_Handler,
		},
		{
			MethodName: "SetMode",
			Handler:    _NavigationService_SetMode_Handler,
		},
		{
			MethodName: "GetLocation",
			Handler:    _NavigationService_GetLocation_Handler,
		},
		{
			MethodName: "GetWaypoints",
			Handler:    _NavigationService_GetWaypoints_Handler,
		},
		{
			MethodName: "AddWaypoint",
			Handler:    _NavigationService_AddWaypoint_Handler,
		},
		{
			MethodName: "RemoveWaypoint",
			Handler:    _NavigationService_RemoveWaypoint_Handler,
		},
		{
			MethodName: "GetObstacles",
			Handler:    _NavigationService_GetObstacles_Handler,
		},
		{
			MethodName: "GetPaths",
			Handler:    _NavigationService_GetPaths_Handler,
		},
		{
			MethodName: "GetProperties",
			Handler:    _NavigationService_GetProperties_Handler,
		},
		{
			MethodName: "DoCommand",
			Handler:    _NavigationService_DoCommand_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "service/navigation/v1/navigation.proto",
}

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

Functions

func RegisterNavigationServiceHandler 

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

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

func RegisterNavigationServiceHandlerClient 

func RegisterNavigationServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client NavigationServiceClient) error

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

func RegisterNavigationServiceHandlerFromEndpoint 

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

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

func RegisterNavigationServiceHandlerServer 

func RegisterNavigationServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server NavigationServiceServer) error

RegisterNavigationServiceHandlerServer registers the http handlers for service NavigationService to "mux". UnaryRPC :call NavigationServiceServer 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 RegisterNavigationServiceHandlerFromEndpoint instead.

func RegisterNavigationServiceServer 

func RegisterNavigationServiceServer(s grpc.ServiceRegistrar, srv NavigationServiceServer)

Types

type AddWaypointRequest 

type AddWaypointRequest struct {
	Name     string       `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Location *v1.GeoPoint `protobuf:"bytes,2,opt,name=location,proto3" json:"location,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 (*AddWaypointRequest) Descriptor deprecated 

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

Deprecated: Use AddWaypointRequest.ProtoReflect.Descriptor instead.

func (*AddWaypointRequest) GetExtra added in v0.1.6 

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

func (*AddWaypointRequest) GetLocation 

func (x *AddWaypointRequest) GetLocation() *v1.GeoPoint

func (*AddWaypointRequest) GetName 

func (x *AddWaypointRequest) GetName() string

func (*AddWaypointRequest) ProtoMessage 

func (*AddWaypointRequest) ProtoMessage()

func (*AddWaypointRequest) ProtoReflect 

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

func (*AddWaypointRequest) Reset 

func (x *AddWaypointRequest) Reset()

func (*AddWaypointRequest) String 

func (x *AddWaypointRequest) String() string

type AddWaypointResponse 

type AddWaypointResponse struct {
	// contains filtered or unexported fields
}

func (*AddWaypointResponse) Descriptor deprecated 

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

Deprecated: Use AddWaypointResponse.ProtoReflect.Descriptor instead.

func (*AddWaypointResponse) ProtoMessage 

func (*AddWaypointResponse) ProtoMessage()

func (*AddWaypointResponse) ProtoReflect 

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

func (*AddWaypointResponse) Reset 

func (x *AddWaypointResponse) Reset()

func (*AddWaypointResponse) String 

func (x *AddWaypointResponse) String() string

type GetLocationRequest 

type GetLocationRequest struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,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 (*GetLocationRequest) Descriptor deprecated 

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

Deprecated: Use GetLocationRequest.ProtoReflect.Descriptor instead.

func (*GetLocationRequest) GetExtra added in v0.1.6 

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

func (*GetLocationRequest) GetName 

func (x *GetLocationRequest) GetName() string

func (*GetLocationRequest) ProtoMessage 

func (*GetLocationRequest) ProtoMessage()

func (*GetLocationRequest) ProtoReflect 

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

func (*GetLocationRequest) Reset 

func (x *GetLocationRequest) Reset()

func (*GetLocationRequest) String 

func (x *GetLocationRequest) String() string

type GetLocationResponse 

type GetLocationResponse struct {
	Location *v1.GeoPoint `protobuf:"bytes,1,opt,name=location,proto3" json:"location,omitempty"`
	// A number from [0-360) where 0 is north
	// 90 is east, 180 is south, 270 is west
	CompassHeading float64 `protobuf:"fixed64,2,opt,name=compass_heading,json=compassHeading,proto3" json:"compass_heading,omitempty"`
	// contains filtered or unexported fields
}

func (*GetLocationResponse) Descriptor deprecated 

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

Deprecated: Use GetLocationResponse.ProtoReflect.Descriptor instead.

func (*GetLocationResponse) GetCompassHeading added in v0.1.174 

func (x *GetLocationResponse) GetCompassHeading() float64

func (*GetLocationResponse) GetLocation 

func (x *GetLocationResponse) GetLocation() *v1.GeoPoint

func (*GetLocationResponse) ProtoMessage 

func (*GetLocationResponse) ProtoMessage()

func (*GetLocationResponse) ProtoReflect 

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

func (*GetLocationResponse) Reset 

func (x *GetLocationResponse) Reset()

func (*GetLocationResponse) String 

func (x *GetLocationResponse) String() string

type GetModeRequest 

type GetModeRequest struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,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 (*GetModeRequest) Descriptor deprecated 

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

Deprecated: Use GetModeRequest.ProtoReflect.Descriptor instead.

func (*GetModeRequest) GetExtra added in v0.1.6 

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

func (*GetModeRequest) GetName 

func (x *GetModeRequest) GetName() string

func (*GetModeRequest) ProtoMessage 

func (*GetModeRequest) ProtoMessage()

func (*GetModeRequest) ProtoReflect 

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

func (*GetModeRequest) Reset 

func (x *GetModeRequest) Reset()

func (*GetModeRequest) String 

func (x *GetModeRequest) String() string

type GetModeResponse 

type GetModeResponse struct {
	Mode Mode `protobuf:"varint,1,opt,name=mode,proto3,enum=viam.service.navigation.v1.Mode" json:"mode,omitempty"`
	// contains filtered or unexported fields
}

func (*GetModeResponse) Descriptor deprecated 

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

Deprecated: Use GetModeResponse.ProtoReflect.Descriptor instead.

func (*GetModeResponse) GetMode 

func (x *GetModeResponse) GetMode() Mode

func (*GetModeResponse) ProtoMessage 

func (*GetModeResponse) ProtoMessage()

func (*GetModeResponse) ProtoReflect 

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

func (*GetModeResponse) Reset 

func (x *GetModeResponse) Reset()

func (*GetModeResponse) String 

func (x *GetModeResponse) String() string

type GetObstaclesRequest added in v0.1.155 

type GetObstaclesRequest struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Additional arguments to the method
	Extra *structpb.Struct `protobuf:"bytes,99,opt,name=extra,proto3" json:"extra,omitempty"`
	// contains filtered or unexported fields
}

GetObstacles will return the geopoint location and geometry of all known obstacles on the navigation map. Obstacles that are detected through the vision service will only be returned if this endpoint is called when the robot is sensing the obstacle

func (*GetObstaclesRequest) Descriptor deprecated added in v0.1.155 

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

Deprecated: Use GetObstaclesRequest.ProtoReflect.Descriptor instead.

func (*GetObstaclesRequest) GetExtra added in v0.1.155 

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

func (*GetObstaclesRequest) GetName added in v0.1.155 

func (x *GetObstaclesRequest) GetName() string

func (*GetObstaclesRequest) ProtoMessage added in v0.1.155 

func (*GetObstaclesRequest) ProtoMessage()

func (*GetObstaclesRequest) ProtoReflect added in v0.1.155 

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

func (*GetObstaclesRequest) Reset added in v0.1.155 

func (x *GetObstaclesRequest) Reset()

func (*GetObstaclesRequest) String added in v0.1.155 

func (x *GetObstaclesRequest) String() string

type GetObstaclesResponse added in v0.1.155 

type GetObstaclesResponse struct {

	// List of all known geometries
	Obstacles []*v1.GeoGeometry `protobuf:"bytes,1,rep,name=obstacles,proto3" json:"obstacles,omitempty"`
	// contains filtered or unexported fields
}

func (*GetObstaclesResponse) Descriptor deprecated added in v0.1.155 

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

Deprecated: Use GetObstaclesResponse.ProtoReflect.Descriptor instead.

func (*GetObstaclesResponse) GetObstacles added in v0.1.155 

func (x *GetObstaclesResponse) GetObstacles() []*v1.GeoGeometry

func (*GetObstaclesResponse) ProtoMessage added in v0.1.155 

func (*GetObstaclesResponse) ProtoMessage()

func (*GetObstaclesResponse) ProtoReflect added in v0.1.155 

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

func (*GetObstaclesResponse) Reset added in v0.1.155 

func (x *GetObstaclesResponse) Reset()

func (*GetObstaclesResponse) String added in v0.1.155 

func (x *GetObstaclesResponse) String() string

type GetPathsRequest added in v0.1.213 

type GetPathsRequest struct {

	// Name of the navigation service
	Name  string           `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Extra *structpb.Struct `protobuf:"bytes,99,opt,name=extra,proto3" json:"extra,omitempty"`
	// contains filtered or unexported fields
}

Returns all the paths known to the navigation service

func (*GetPathsRequest) Descriptor deprecated added in v0.1.213 

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

Deprecated: Use GetPathsRequest.ProtoReflect.Descriptor instead.

func (*GetPathsRequest) GetExtra added in v0.1.213 

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

func (*GetPathsRequest) GetName added in v0.1.213 

func (x *GetPathsRequest) GetName() string

func (*GetPathsRequest) ProtoMessage added in v0.1.213 

func (*GetPathsRequest) ProtoMessage()

func (*GetPathsRequest) ProtoReflect added in v0.1.213 

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

func (*GetPathsRequest) Reset added in v0.1.213 

func (x *GetPathsRequest) Reset()

func (*GetPathsRequest) String added in v0.1.213 

func (x *GetPathsRequest) String() string

type GetPathsResponse added in v0.1.213 

type GetPathsResponse struct {
	Paths []*Path `protobuf:"bytes,1,rep,name=paths,proto3" json:"paths,omitempty"`
	// contains filtered or unexported fields
}

func (*GetPathsResponse) Descriptor deprecated added in v0.1.213 

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

Deprecated: Use GetPathsResponse.ProtoReflect.Descriptor instead.

func (*GetPathsResponse) GetPaths added in v0.1.213 

func (x *GetPathsResponse) GetPaths() []*Path

func (*GetPathsResponse) ProtoMessage added in v0.1.213 

func (*GetPathsResponse) ProtoMessage()

func (*GetPathsResponse) ProtoReflect added in v0.1.213 

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

func (*GetPathsResponse) Reset added in v0.1.213 

func (x *GetPathsResponse) Reset()

func (*GetPathsResponse) String added in v0.1.213 

func (x *GetPathsResponse) String() string

type GetPropertiesRequest added in v0.1.245 

type GetPropertiesRequest struct {

	// Name of the navigation 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 {
	MapType MapType `protobuf:"varint,1,opt,name=map_type,json=mapType,proto3,enum=viam.service.navigation.v1.MapType" json:"map_type,omitempty"`
	// contains filtered or unexported fields
}

Returns properties information for the named navigation service

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

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

Deprecated: Use GetPropertiesResponse.ProtoReflect.Descriptor instead.

func (*GetPropertiesResponse) GetMapType added in v0.1.245 

func (x *GetPropertiesResponse) GetMapType() MapType

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 GetWaypointsRequest 

type GetWaypointsRequest struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,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 (*GetWaypointsRequest) Descriptor deprecated 

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

Deprecated: Use GetWaypointsRequest.ProtoReflect.Descriptor instead.

func (*GetWaypointsRequest) GetExtra added in v0.1.6 

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

func (*GetWaypointsRequest) GetName 

func (x *GetWaypointsRequest) GetName() string

func (*GetWaypointsRequest) ProtoMessage 

func (*GetWaypointsRequest) ProtoMessage()

func (*GetWaypointsRequest) ProtoReflect 

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

func (*GetWaypointsRequest) Reset 

func (x *GetWaypointsRequest) Reset()

func (*GetWaypointsRequest) String 

func (x *GetWaypointsRequest) String() string

type GetWaypointsResponse 

type GetWaypointsResponse struct {
	Waypoints []*Waypoint `protobuf:"bytes,1,rep,name=waypoints,proto3" json:"waypoints,omitempty"`
	// contains filtered or unexported fields
}

func (*GetWaypointsResponse) Descriptor deprecated 

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

Deprecated: Use GetWaypointsResponse.ProtoReflect.Descriptor instead.

func (*GetWaypointsResponse) GetWaypoints 

func (x *GetWaypointsResponse) GetWaypoints() []*Waypoint

func (*GetWaypointsResponse) ProtoMessage 

func (*GetWaypointsResponse) ProtoMessage()

func (*GetWaypointsResponse) ProtoReflect 

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

func (*GetWaypointsResponse) Reset 

func (x *GetWaypointsResponse) Reset()

func (*GetWaypointsResponse) String 

func (x *GetWaypointsResponse) String() string

type MapType added in v0.1.245 

type MapType int32

MapType represents the various types of maps the navigation service can ingest. 

const (
	MapType_MAP_TYPE_UNSPECIFIED MapType = 0
	MapType_MAP_TYPE_NONE        MapType = 1
	MapType_MAP_TYPE_GPS         MapType = 2
)

func (MapType) Descriptor added in v0.1.245 

func (MapType) Descriptor() protoreflect.EnumDescriptor

func (MapType) Enum added in v0.1.245 

func (x MapType) Enum() *MapType

func (MapType) EnumDescriptor deprecated added in v0.1.245 

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

Deprecated: Use MapType.Descriptor instead.

func (MapType) Number added in v0.1.245 

func (x MapType) Number() protoreflect.EnumNumber

func (MapType) String added in v0.1.245 

func (x MapType) String() string

func (MapType) Type added in v0.1.245 

func (MapType) Type() protoreflect.EnumType

type Mode 

type Mode int32
const (
	Mode_MODE_UNSPECIFIED Mode = 0
	Mode_MODE_MANUAL      Mode = 1
	Mode_MODE_WAYPOINT    Mode = 2
	Mode_MODE_EXPLORE     Mode = 3
)

func (Mode) Descriptor 

func (Mode) Descriptor() protoreflect.EnumDescriptor

func (Mode) Enum 

func (x Mode) Enum() *Mode

func (Mode) EnumDescriptor deprecated 

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

Deprecated: Use Mode.Descriptor instead.

func (Mode) Number 

func (x Mode) Number() protoreflect.EnumNumber

func (Mode) String 

func (x Mode) String() string

func (Mode) Type 

func (Mode) Type() protoreflect.EnumType
type NavigationServiceClient interface {
	GetMode(ctx context.Context, in *GetModeRequest, opts ...grpc.CallOption) (*GetModeResponse, error)
	SetMode(ctx context.Context, in *SetModeRequest, opts ...grpc.CallOption) (*SetModeResponse, error)
	GetLocation(ctx context.Context, in *GetLocationRequest, opts ...grpc.CallOption) (*GetLocationResponse, error)
	GetWaypoints(ctx context.Context, in *GetWaypointsRequest, opts ...grpc.CallOption) (*GetWaypointsResponse, error)
	AddWaypoint(ctx context.Context, in *AddWaypointRequest, opts ...grpc.CallOption) (*AddWaypointResponse, error)
	RemoveWaypoint(ctx context.Context, in *RemoveWaypointRequest, opts ...grpc.CallOption) (*RemoveWaypointResponse, error)
	GetObstacles(ctx context.Context, in *GetObstaclesRequest, opts ...grpc.CallOption) (*GetObstaclesResponse, error)
	GetPaths(ctx context.Context, in *GetPathsRequest, opts ...grpc.CallOption) (*GetPathsResponse, error)
	// GetProperties returns properties of the current navigation service, including the
	// map_type being operated on.
	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)
}

NavigationServiceClient is the client API for NavigationService 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.

func NewNavigationServiceClient 

func NewNavigationServiceClient(cc grpc.ClientConnInterface) NavigationServiceClient
type NavigationServiceServer interface {
	GetMode(context.Context, *GetModeRequest) (*GetModeResponse, error)
	SetMode(context.Context, *SetModeRequest) (*SetModeResponse, error)
	GetLocation(context.Context, *GetLocationRequest) (*GetLocationResponse, error)
	GetWaypoints(context.Context, *GetWaypointsRequest) (*GetWaypointsResponse, error)
	AddWaypoint(context.Context, *AddWaypointRequest) (*AddWaypointResponse, error)
	RemoveWaypoint(context.Context, *RemoveWaypointRequest) (*RemoveWaypointResponse, error)
	GetObstacles(context.Context, *GetObstaclesRequest) (*GetObstaclesResponse, error)
	GetPaths(context.Context, *GetPathsRequest) (*GetPathsResponse, error)
	// GetProperties returns properties of the current navigation service, including the
	// map_type being operated on.
	GetProperties(context.Context, *GetPropertiesRequest) (*GetPropertiesResponse, error)
	// DoCommand sends/receives arbitrary commands
	DoCommand(context.Context, *v1.DoCommandRequest) (*v1.DoCommandResponse, error)
	// contains filtered or unexported methods
}

NavigationServiceServer is the server API for NavigationService service. All implementations must embed UnimplementedNavigationServiceServer for forward compatibility

type Path added in v0.1.213 

type Path struct {

	// The id of the user specified waypoint
	DestinationWaypointId string `` /* 126-byte string literal not displayed */
	// List of geopoints that the motion planner output to reach the destination
	// The first geopoint is the starting position of the robot for that path
	Geopoints []*v1.GeoPoint `protobuf:"bytes,2,rep,name=geopoints,proto3" json:"geopoints,omitempty"`
	// contains filtered or unexported fields
}

A user provided destination and the set of geopoints that the robot is expected to take to get there

func (*Path) Descriptor deprecated added in v0.1.213 

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

Deprecated: Use Path.ProtoReflect.Descriptor instead.

func (*Path) GetDestinationWaypointId added in v0.1.213 

func (x *Path) GetDestinationWaypointId() string

func (*Path) GetGeopoints added in v0.1.213 

func (x *Path) GetGeopoints() []*v1.GeoPoint

func (*Path) ProtoMessage added in v0.1.213 

func (*Path) ProtoMessage()

func (*Path) ProtoReflect added in v0.1.213 

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

func (*Path) Reset added in v0.1.213 

func (x *Path) Reset()

func (*Path) String added in v0.1.213 

func (x *Path) String() string

type RemoveWaypointRequest 

type RemoveWaypointRequest struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Id   string `protobuf:"bytes,2,opt,name=id,proto3" json:"id,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 (*RemoveWaypointRequest) Descriptor deprecated 

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

Deprecated: Use RemoveWaypointRequest.ProtoReflect.Descriptor instead.

func (*RemoveWaypointRequest) GetExtra added in v0.1.6 

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

func (*RemoveWaypointRequest) GetId 

func (x *RemoveWaypointRequest) GetId() string

func (*RemoveWaypointRequest) GetName 

func (x *RemoveWaypointRequest) GetName() string

func (*RemoveWaypointRequest) ProtoMessage 

func (*RemoveWaypointRequest) ProtoMessage()

func (*RemoveWaypointRequest) ProtoReflect 

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

func (*RemoveWaypointRequest) Reset 

func (x *RemoveWaypointRequest) Reset()

func (*RemoveWaypointRequest) String 

func (x *RemoveWaypointRequest) String() string

type RemoveWaypointResponse 

type RemoveWaypointResponse struct {
	// contains filtered or unexported fields
}

func (*RemoveWaypointResponse) Descriptor deprecated 

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

Deprecated: Use RemoveWaypointResponse.ProtoReflect.Descriptor instead.

func (*RemoveWaypointResponse) ProtoMessage 

func (*RemoveWaypointResponse) ProtoMessage()

func (*RemoveWaypointResponse) ProtoReflect 

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

func (*RemoveWaypointResponse) Reset 

func (x *RemoveWaypointResponse) Reset()

func (*RemoveWaypointResponse) String 

func (x *RemoveWaypointResponse) String() string

type SetModeRequest 

type SetModeRequest struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Mode Mode   `protobuf:"varint,2,opt,name=mode,proto3,enum=viam.service.navigation.v1.Mode" json:"mode,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 (*SetModeRequest) Descriptor deprecated 

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

Deprecated: Use SetModeRequest.ProtoReflect.Descriptor instead.

func (*SetModeRequest) GetExtra added in v0.1.6 

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

func (*SetModeRequest) GetMode 

func (x *SetModeRequest) GetMode() Mode

func (*SetModeRequest) GetName 

func (x *SetModeRequest) GetName() string

func (*SetModeRequest) ProtoMessage 

func (*SetModeRequest) ProtoMessage()

func (*SetModeRequest) ProtoReflect 

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

func (*SetModeRequest) Reset 

func (x *SetModeRequest) Reset()

func (*SetModeRequest) String 

func (x *SetModeRequest) String() string

type SetModeResponse 

type SetModeResponse struct {
	// contains filtered or unexported fields
}

func (*SetModeResponse) Descriptor deprecated 

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

Deprecated: Use SetModeResponse.ProtoReflect.Descriptor instead.

func (*SetModeResponse) ProtoMessage 

func (*SetModeResponse) ProtoMessage()

func (*SetModeResponse) ProtoReflect 

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

func (*SetModeResponse) Reset 

func (x *SetModeResponse) Reset()

func (*SetModeResponse) String 

func (x *SetModeResponse) String() string

type UnimplementedNavigationServiceServer 

type UnimplementedNavigationServiceServer struct {
}

UnimplementedNavigationServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedNavigationServiceServer) AddWaypoint 

func (UnimplementedNavigationServiceServer) AddWaypoint(context.Context, *AddWaypointRequest) (*AddWaypointResponse, error)

func (UnimplementedNavigationServiceServer) DoCommand added in v0.1.80 

func (UnimplementedNavigationServiceServer) DoCommand(context.Context, *v1.DoCommandRequest) (*v1.DoCommandResponse, error)

func (UnimplementedNavigationServiceServer) GetLocation 

func (UnimplementedNavigationServiceServer) GetLocation(context.Context, *GetLocationRequest) (*GetLocationResponse, error)

func (UnimplementedNavigationServiceServer) GetMode 

func (UnimplementedNavigationServiceServer) GetMode(context.Context, *GetModeRequest) (*GetModeResponse, error)

func (UnimplementedNavigationServiceServer) GetObstacles added in v0.1.155 

func (UnimplementedNavigationServiceServer) GetObstacles(context.Context, *GetObstaclesRequest) (*GetObstaclesResponse, error)

func (UnimplementedNavigationServiceServer) GetPaths added in v0.1.213 

func (UnimplementedNavigationServiceServer) GetPaths(context.Context, *GetPathsRequest) (*GetPathsResponse, error)

func (UnimplementedNavigationServiceServer) GetProperties added in v0.1.245 

func (UnimplementedNavigationServiceServer) GetProperties(context.Context, *GetPropertiesRequest) (*GetPropertiesResponse, error)

func (UnimplementedNavigationServiceServer) GetWaypoints 

func (UnimplementedNavigationServiceServer) GetWaypoints(context.Context, *GetWaypointsRequest) (*GetWaypointsResponse, error)

func (UnimplementedNavigationServiceServer) RemoveWaypoint 

func (UnimplementedNavigationServiceServer) RemoveWaypoint(context.Context, *RemoveWaypointRequest) (*RemoveWaypointResponse, error)

func (UnimplementedNavigationServiceServer) SetMode 

func (UnimplementedNavigationServiceServer) SetMode(context.Context, *SetModeRequest) (*SetModeResponse, error)

type UnsafeNavigationServiceServer 

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

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

type Waypoint 

type Waypoint struct {
	Id       string       `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	Location *v1.GeoPoint `protobuf:"bytes,2,opt,name=location,proto3" json:"location,omitempty"`
	// contains filtered or unexported fields
}

func (*Waypoint) Descriptor deprecated 

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

Deprecated: Use Waypoint.ProtoReflect.Descriptor instead.

func (*Waypoint) GetId 

func (x *Waypoint) GetId() string

func (*Waypoint) GetLocation 

func (x *Waypoint) GetLocation() *v1.GeoPoint

func (*Waypoint) ProtoMessage 

func (*Waypoint) ProtoMessage()

func (*Waypoint) ProtoReflect 

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

func (*Waypoint) Reset 

func (x *Waypoint) Reset()

func (*Waypoint) String 

func (x *Waypoint) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.