manual_control

package
v0.0.0-...-4a7e8af Latest Latest
Warning

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

Go to latest
Published: Jan 13, 2023 License: BSD-3-Clause Imports: 10 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	ManualControlResult_Result_name = map[int32]string{
		0: "RESULT_UNKNOWN",
		1: "RESULT_SUCCESS",
		2: "RESULT_NO_SYSTEM",
		3: "RESULT_CONNECTION_ERROR",
		4: "RESULT_BUSY",
		5: "RESULT_COMMAND_DENIED",
		6: "RESULT_TIMEOUT",
		7: "RESULT_INPUT_OUT_OF_RANGE",
		8: "RESULT_INPUT_NOT_SET",
	}
	ManualControlResult_Result_value = map[string]int32{
		"RESULT_UNKNOWN":            0,
		"RESULT_SUCCESS":            1,
		"RESULT_NO_SYSTEM":          2,
		"RESULT_CONNECTION_ERROR":   3,
		"RESULT_BUSY":               4,
		"RESULT_COMMAND_DENIED":     5,
		"RESULT_TIMEOUT":            6,
		"RESULT_INPUT_OUT_OF_RANGE": 7,
		"RESULT_INPUT_NOT_SET":      8,
	}
)

Enum value maps for ManualControlResult_Result.

View Source
var File_manual_control_proto protoreflect.FileDescriptor
View Source
var ManualControlService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "mavsdk.rpc.manual_control.ManualControlService",
	HandlerType: (*ManualControlServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "StartPositionControl",
			Handler:    _ManualControlService_StartPositionControl_Handler,
		},
		{
			MethodName: "StartAltitudeControl",
			Handler:    _ManualControlService_StartAltitudeControl_Handler,
		},
		{
			MethodName: "SetManualControlInput",
			Handler:    _ManualControlService_SetManualControlInput_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "manual_control.proto",
}

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

Functions

func RegisterManualControlServiceServer

func RegisterManualControlServiceServer(s grpc.ServiceRegistrar, srv ManualControlServiceServer)

Types

type ManualControlResult

type ManualControlResult struct {
	Result    ManualControlResult_Result `protobuf:"varint,1,opt,name=result,proto3,enum=mavsdk.rpc.manual_control.ManualControlResult_Result" json:"result,omitempty"` // Result enum value
	ResultStr string                     `protobuf:"bytes,2,opt,name=result_str,json=resultStr,proto3" json:"result_str,omitempty"`                                     // Human-readable English string describing the result
	// contains filtered or unexported fields
}

Result type.

func (*ManualControlResult) Descriptor deprecated

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

Deprecated: Use ManualControlResult.ProtoReflect.Descriptor instead.

func (*ManualControlResult) GetResult

func (*ManualControlResult) GetResultStr

func (x *ManualControlResult) GetResultStr() string

func (*ManualControlResult) ProtoMessage

func (*ManualControlResult) ProtoMessage()

func (*ManualControlResult) ProtoReflect

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

func (*ManualControlResult) Reset

func (x *ManualControlResult) Reset()

func (*ManualControlResult) String

func (x *ManualControlResult) String() string

type ManualControlResult_Result

type ManualControlResult_Result int32

Possible results returned for manual control requests.

const (
	ManualControlResult_RESULT_UNKNOWN            ManualControlResult_Result = 0 // Unknown result
	ManualControlResult_RESULT_SUCCESS            ManualControlResult_Result = 1 // Request was successful
	ManualControlResult_RESULT_NO_SYSTEM          ManualControlResult_Result = 2 // No system is connected
	ManualControlResult_RESULT_CONNECTION_ERROR   ManualControlResult_Result = 3 // Connection error
	ManualControlResult_RESULT_BUSY               ManualControlResult_Result = 4 // Vehicle is busy
	ManualControlResult_RESULT_COMMAND_DENIED     ManualControlResult_Result = 5 // Command refused by vehicle
	ManualControlResult_RESULT_TIMEOUT            ManualControlResult_Result = 6 // Request timed out
	ManualControlResult_RESULT_INPUT_OUT_OF_RANGE ManualControlResult_Result = 7 // Input out of range
	ManualControlResult_RESULT_INPUT_NOT_SET      ManualControlResult_Result = 8 // No Input set
)

func (ManualControlResult_Result) Descriptor

func (ManualControlResult_Result) Enum

func (ManualControlResult_Result) EnumDescriptor deprecated

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

Deprecated: Use ManualControlResult_Result.Descriptor instead.

func (ManualControlResult_Result) Number

func (ManualControlResult_Result) String

func (ManualControlResult_Result) Type

type ManualControlServiceClient

type ManualControlServiceClient interface {
	// Start position control using e.g. joystick input.
	//
	// Requires manual control input to be sent regularly already.
	// Requires a valid position using e.g. GPS, external vision, or optical flow.
	StartPositionControl(ctx context.Context, in *StartPositionControlRequest, opts ...grpc.CallOption) (*StartPositionControlResponse, error)
	// Start altitude control
	//
	// Requires manual control input to be sent regularly already.
	// Does not require a  valid position e.g. GPS.
	StartAltitudeControl(ctx context.Context, in *StartAltitudeControlRequest, opts ...grpc.CallOption) (*StartAltitudeControlResponse, error)
	// Set manual control input
	//
	// The manual control input needs to be sent at a rate high enough to prevent
	// triggering of RC loss, a good minimum rate is 10 Hz.
	SetManualControlInput(ctx context.Context, in *SetManualControlInputRequest, opts ...grpc.CallOption) (*SetManualControlInputResponse, error)
}

ManualControlServiceClient is the client API for ManualControlService 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 ManualControlServiceServer

type ManualControlServiceServer interface {
	// Start position control using e.g. joystick input.
	//
	// Requires manual control input to be sent regularly already.
	// Requires a valid position using e.g. GPS, external vision, or optical flow.
	StartPositionControl(context.Context, *StartPositionControlRequest) (*StartPositionControlResponse, error)
	// Start altitude control
	//
	// Requires manual control input to be sent regularly already.
	// Does not require a  valid position e.g. GPS.
	StartAltitudeControl(context.Context, *StartAltitudeControlRequest) (*StartAltitudeControlResponse, error)
	// Set manual control input
	//
	// The manual control input needs to be sent at a rate high enough to prevent
	// triggering of RC loss, a good minimum rate is 10 Hz.
	SetManualControlInput(context.Context, *SetManualControlInputRequest) (*SetManualControlInputResponse, error)
	// contains filtered or unexported methods
}

ManualControlServiceServer is the server API for ManualControlService service. All implementations must embed UnimplementedManualControlServiceServer for forward compatibility

type ServiceImpl

type ServiceImpl struct {
	Client ManualControlServiceClient
}

func (*ServiceImpl) SetManualControlInput

func (s *ServiceImpl) SetManualControlInput(ctx context.Context, x float32, y float32, z float32, r float32) (*SetManualControlInputResponse, error)

func (*ServiceImpl) StartAltitudeControl

func (s *ServiceImpl) StartAltitudeControl(ctx context.Context) (*StartAltitudeControlResponse, error)

func (*ServiceImpl) StartPositionControl

func (s *ServiceImpl) StartPositionControl(ctx context.Context) (*StartPositionControlResponse, error)

type SetManualControlInputRequest

type SetManualControlInputRequest struct {
	X float32 `protobuf:"fixed32,1,opt,name=x,proto3" json:"x,omitempty"` // value between -1. to 1. negative -> backwards, positive -> forwards
	Y float32 `protobuf:"fixed32,2,opt,name=y,proto3" json:"y,omitempty"` // value between -1. to 1. negative -> left, positive -> right
	Z float32 `protobuf:"fixed32,3,opt,name=z,proto3" json:"z,omitempty"` // value between -1. to 1. negative -> down, positive -> up (usually for now, for multicopter 0 to 1 is expected)
	R float32 `protobuf:"fixed32,4,opt,name=r,proto3" json:"r,omitempty"` // value between -1. to 1. negative -> turn anti-clockwise (towards the left), positive -> turn clockwise (towards the right)
	// contains filtered or unexported fields
}

func (*SetManualControlInputRequest) Descriptor deprecated

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

Deprecated: Use SetManualControlInputRequest.ProtoReflect.Descriptor instead.

func (*SetManualControlInputRequest) GetR

func (*SetManualControlInputRequest) GetX

func (*SetManualControlInputRequest) GetY

func (*SetManualControlInputRequest) GetZ

func (*SetManualControlInputRequest) ProtoMessage

func (*SetManualControlInputRequest) ProtoMessage()

func (*SetManualControlInputRequest) ProtoReflect

func (*SetManualControlInputRequest) Reset

func (x *SetManualControlInputRequest) Reset()

func (*SetManualControlInputRequest) String

type SetManualControlInputResponse

type SetManualControlInputResponse struct {
	ManualControlResult *ManualControlResult `protobuf:"bytes,1,opt,name=manual_control_result,json=manualControlResult,proto3" json:"manual_control_result,omitempty"`
	// contains filtered or unexported fields
}

func (*SetManualControlInputResponse) Descriptor deprecated

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

Deprecated: Use SetManualControlInputResponse.ProtoReflect.Descriptor instead.

func (*SetManualControlInputResponse) GetManualControlResult

func (x *SetManualControlInputResponse) GetManualControlResult() *ManualControlResult

func (*SetManualControlInputResponse) ProtoMessage

func (*SetManualControlInputResponse) ProtoMessage()

func (*SetManualControlInputResponse) ProtoReflect

func (*SetManualControlInputResponse) Reset

func (x *SetManualControlInputResponse) Reset()

func (*SetManualControlInputResponse) String

type StartAltitudeControlRequest

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

func (*StartAltitudeControlRequest) Descriptor deprecated

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

Deprecated: Use StartAltitudeControlRequest.ProtoReflect.Descriptor instead.

func (*StartAltitudeControlRequest) ProtoMessage

func (*StartAltitudeControlRequest) ProtoMessage()

func (*StartAltitudeControlRequest) ProtoReflect

func (*StartAltitudeControlRequest) Reset

func (x *StartAltitudeControlRequest) Reset()

func (*StartAltitudeControlRequest) String

func (x *StartAltitudeControlRequest) String() string

type StartAltitudeControlResponse

type StartAltitudeControlResponse struct {
	ManualControlResult *ManualControlResult `protobuf:"bytes,1,opt,name=manual_control_result,json=manualControlResult,proto3" json:"manual_control_result,omitempty"`
	// contains filtered or unexported fields
}

func (*StartAltitudeControlResponse) Descriptor deprecated

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

Deprecated: Use StartAltitudeControlResponse.ProtoReflect.Descriptor instead.

func (*StartAltitudeControlResponse) GetManualControlResult

func (x *StartAltitudeControlResponse) GetManualControlResult() *ManualControlResult

func (*StartAltitudeControlResponse) ProtoMessage

func (*StartAltitudeControlResponse) ProtoMessage()

func (*StartAltitudeControlResponse) ProtoReflect

func (*StartAltitudeControlResponse) Reset

func (x *StartAltitudeControlResponse) Reset()

func (*StartAltitudeControlResponse) String

type StartPositionControlRequest

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

func (*StartPositionControlRequest) Descriptor deprecated

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

Deprecated: Use StartPositionControlRequest.ProtoReflect.Descriptor instead.

func (*StartPositionControlRequest) ProtoMessage

func (*StartPositionControlRequest) ProtoMessage()

func (*StartPositionControlRequest) ProtoReflect

func (*StartPositionControlRequest) Reset

func (x *StartPositionControlRequest) Reset()

func (*StartPositionControlRequest) String

func (x *StartPositionControlRequest) String() string

type StartPositionControlResponse

type StartPositionControlResponse struct {
	ManualControlResult *ManualControlResult `protobuf:"bytes,1,opt,name=manual_control_result,json=manualControlResult,proto3" json:"manual_control_result,omitempty"`
	// contains filtered or unexported fields
}

func (*StartPositionControlResponse) Descriptor deprecated

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

Deprecated: Use StartPositionControlResponse.ProtoReflect.Descriptor instead.

func (*StartPositionControlResponse) GetManualControlResult

func (x *StartPositionControlResponse) GetManualControlResult() *ManualControlResult

func (*StartPositionControlResponse) ProtoMessage

func (*StartPositionControlResponse) ProtoMessage()

func (*StartPositionControlResponse) ProtoReflect

func (*StartPositionControlResponse) Reset

func (x *StartPositionControlResponse) Reset()

func (*StartPositionControlResponse) String

type UnimplementedManualControlServiceServer

type UnimplementedManualControlServiceServer struct {
}

UnimplementedManualControlServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedManualControlServiceServer) SetManualControlInput

func (UnimplementedManualControlServiceServer) StartAltitudeControl

func (UnimplementedManualControlServiceServer) StartPositionControl

type UnsafeManualControlServiceServer

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

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

Jump to

Keyboard shortcuts

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