log_files

package
v0.0.8 Latest Latest
Warning

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

 Go to latest Published: Oct 22, 2024 License: BSD-3-Clause Imports: 10 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	LogFilesService_GetEntries_FullMethodName               = "/mavsdk.rpc.log_files.LogFilesService/GetEntries"
	LogFilesService_SubscribeDownloadLogFile_FullMethodName = "/mavsdk.rpc.log_files.LogFilesService/SubscribeDownloadLogFile"
	LogFilesService_EraseAllLogFiles_FullMethodName         = "/mavsdk.rpc.log_files.LogFilesService/EraseAllLogFiles"
)

Variables

View Source 
var (
	LogFilesResult_Result_name = map[int32]string{
		0: "RESULT_UNKNOWN",
		1: "RESULT_SUCCESS",
		2: "RESULT_NEXT",
		3: "RESULT_NO_LOGFILES",
		4: "RESULT_TIMEOUT",
		5: "RESULT_INVALID_ARGUMENT",
		6: "RESULT_FILE_OPEN_FAILED",
		7: "RESULT_NO_SYSTEM",
	}
	LogFilesResult_Result_value = map[string]int32{
		"RESULT_UNKNOWN":          0,
		"RESULT_SUCCESS":          1,
		"RESULT_NEXT":             2,
		"RESULT_NO_LOGFILES":      3,
		"RESULT_TIMEOUT":          4,
		"RESULT_INVALID_ARGUMENT": 5,
		"RESULT_FILE_OPEN_FAILED": 6,
		"RESULT_NO_SYSTEM":        7,
	}
)

Enum value maps for LogFilesResult_Result.

View Source 
var File_log_files_proto protoreflect.FileDescriptor
View Source 
var LogFilesService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "mavsdk.rpc.log_files.LogFilesService",
	HandlerType: (*LogFilesServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetEntries",
			Handler:    _LogFilesService_GetEntries_Handler,
		},
		{
			MethodName: "EraseAllLogFiles",
			Handler:    _LogFilesService_EraseAllLogFiles_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "SubscribeDownloadLogFile",
			Handler:       _LogFilesService_SubscribeDownloadLogFile_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "log_files.proto",
}

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

Functions

func RegisterLogFilesServiceServer 

func RegisterLogFilesServiceServer(s grpc.ServiceRegistrar, srv LogFilesServiceServer)

Types

type DownloadLogFileResponse 

type DownloadLogFileResponse struct {
	LogFilesResult *LogFilesResult `protobuf:"bytes,1,opt,name=log_files_result,json=logFilesResult,proto3" json:"log_files_result,omitempty"`
	Progress       *ProgressData   `protobuf:"bytes,2,opt,name=progress,proto3" json:"progress,omitempty"` // Progress if result is progress
	// contains filtered or unexported fields
}

func (*DownloadLogFileResponse) Descriptor deprecated 

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

Deprecated: Use DownloadLogFileResponse.ProtoReflect.Descriptor instead.

func (*DownloadLogFileResponse) GetLogFilesResult 

func (x *DownloadLogFileResponse) GetLogFilesResult() *LogFilesResult

func (*DownloadLogFileResponse) GetProgress 

func (x *DownloadLogFileResponse) GetProgress() *ProgressData

func (*DownloadLogFileResponse) ProtoMessage 

func (*DownloadLogFileResponse) ProtoMessage()

func (*DownloadLogFileResponse) ProtoReflect 

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

func (*DownloadLogFileResponse) Reset 

func (x *DownloadLogFileResponse) Reset()

func (*DownloadLogFileResponse) String 

func (x *DownloadLogFileResponse) String() string

type Entry 

type Entry struct {
	Id        uint32 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`                                // ID of the log file, to specify a file to be downloaded
	Date      string `protobuf:"bytes,2,opt,name=date,proto3" json:"date,omitempty"`                             // Date of the log file in UTC in ISO 8601 format "yyyy-mm-ddThh:mm:ssZ"
	SizeBytes uint32 `protobuf:"varint,3,opt,name=size_bytes,json=sizeBytes,proto3" json:"size_bytes,omitempty"` // Size of file in bytes
	// contains filtered or unexported fields
}

Log file entry type.

func (*Entry) Descriptor deprecated 

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

Deprecated: Use Entry.ProtoReflect.Descriptor instead.

func (*Entry) GetDate 

func (x *Entry) GetDate() string

func (*Entry) GetId 

func (x *Entry) GetId() uint32

func (*Entry) GetSizeBytes 

func (x *Entry) GetSizeBytes() uint32

func (*Entry) ProtoMessage 

func (*Entry) ProtoMessage()

func (*Entry) ProtoReflect 

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

func (*Entry) Reset 

func (x *Entry) Reset()

func (*Entry) String 

func (x *Entry) String() string

type EraseAllLogFilesRequest added in v0.0.6 

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

func (*EraseAllLogFilesRequest) Descriptor deprecated added in v0.0.6 

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

Deprecated: Use EraseAllLogFilesRequest.ProtoReflect.Descriptor instead.

func (*EraseAllLogFilesRequest) ProtoMessage added in v0.0.6 

func (*EraseAllLogFilesRequest) ProtoMessage()

func (*EraseAllLogFilesRequest) ProtoReflect added in v0.0.6 

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

func (*EraseAllLogFilesRequest) Reset added in v0.0.6 

func (x *EraseAllLogFilesRequest) Reset()

func (*EraseAllLogFilesRequest) String added in v0.0.6 

func (x *EraseAllLogFilesRequest) String() string

type EraseAllLogFilesResponse added in v0.0.6 

type EraseAllLogFilesResponse struct {
	LogFilesResult *LogFilesResult `protobuf:"bytes,1,opt,name=log_files_result,json=logFilesResult,proto3" json:"log_files_result,omitempty"`
	// contains filtered or unexported fields
}

func (*EraseAllLogFilesResponse) Descriptor deprecated added in v0.0.6 

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

Deprecated: Use EraseAllLogFilesResponse.ProtoReflect.Descriptor instead.

func (*EraseAllLogFilesResponse) GetLogFilesResult added in v0.0.6 

func (x *EraseAllLogFilesResponse) GetLogFilesResult() *LogFilesResult

func (*EraseAllLogFilesResponse) ProtoMessage added in v0.0.6 

func (*EraseAllLogFilesResponse) ProtoMessage()

func (*EraseAllLogFilesResponse) ProtoReflect added in v0.0.6 

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

func (*EraseAllLogFilesResponse) Reset added in v0.0.6 

func (x *EraseAllLogFilesResponse) Reset()

func (*EraseAllLogFilesResponse) String added in v0.0.6 

func (x *EraseAllLogFilesResponse) String() string

type GetEntriesRequest 

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

func (*GetEntriesRequest) Descriptor deprecated 

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

Deprecated: Use GetEntriesRequest.ProtoReflect.Descriptor instead.

func (*GetEntriesRequest) ProtoMessage 

func (*GetEntriesRequest) ProtoMessage()

func (*GetEntriesRequest) ProtoReflect 

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

func (*GetEntriesRequest) Reset 

func (x *GetEntriesRequest) Reset()

func (*GetEntriesRequest) String 

func (x *GetEntriesRequest) String() string

type GetEntriesResponse 

type GetEntriesResponse struct {
	LogFilesResult *LogFilesResult `protobuf:"bytes,1,opt,name=log_files_result,json=logFilesResult,proto3" json:"log_files_result,omitempty"`
	Entries        []*Entry        `protobuf:"bytes,2,rep,name=entries,proto3" json:"entries,omitempty"` // List of entries
	// contains filtered or unexported fields
}

func (*GetEntriesResponse) Descriptor deprecated 

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

Deprecated: Use GetEntriesResponse.ProtoReflect.Descriptor instead.

func (*GetEntriesResponse) GetEntries 

func (x *GetEntriesResponse) GetEntries() []*Entry

func (*GetEntriesResponse) GetLogFilesResult 

func (x *GetEntriesResponse) GetLogFilesResult() *LogFilesResult

func (*GetEntriesResponse) ProtoMessage 

func (*GetEntriesResponse) ProtoMessage()

func (*GetEntriesResponse) ProtoReflect 

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

func (*GetEntriesResponse) Reset 

func (x *GetEntriesResponse) Reset()

func (*GetEntriesResponse) String 

func (x *GetEntriesResponse) String() string

type LogFilesResult 

type LogFilesResult struct {
	Result    LogFilesResult_Result `protobuf:"varint,1,opt,name=result,proto3,enum=mavsdk.rpc.log_files.LogFilesResult_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 (*LogFilesResult) Descriptor deprecated 

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

Deprecated: Use LogFilesResult.ProtoReflect.Descriptor instead.

func (*LogFilesResult) GetResult 

func (x *LogFilesResult) GetResult() LogFilesResult_Result

func (*LogFilesResult) GetResultStr 

func (x *LogFilesResult) GetResultStr() string

func (*LogFilesResult) ProtoMessage 

func (*LogFilesResult) ProtoMessage()

func (*LogFilesResult) ProtoReflect 

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

func (*LogFilesResult) Reset 

func (x *LogFilesResult) Reset()

func (*LogFilesResult) String 

func (x *LogFilesResult) String() string

type LogFilesResult_Result 

type LogFilesResult_Result int32

Possible results returned for calibration commands 

const (
	LogFilesResult_RESULT_UNKNOWN          LogFilesResult_Result = 0 // Unknown result
	LogFilesResult_RESULT_SUCCESS          LogFilesResult_Result = 1 // Request succeeded
	LogFilesResult_RESULT_NEXT             LogFilesResult_Result = 2 // Progress update
	LogFilesResult_RESULT_NO_LOGFILES      LogFilesResult_Result = 3 // No log files found
	LogFilesResult_RESULT_TIMEOUT          LogFilesResult_Result = 4 // A timeout happened
	LogFilesResult_RESULT_INVALID_ARGUMENT LogFilesResult_Result = 5 // Invalid argument
	LogFilesResult_RESULT_FILE_OPEN_FAILED LogFilesResult_Result = 6 // File open failed
	LogFilesResult_RESULT_NO_SYSTEM        LogFilesResult_Result = 7 // No system is connected
)

func (LogFilesResult_Result) Descriptor 

func (LogFilesResult_Result) Descriptor() protoreflect.EnumDescriptor

func (LogFilesResult_Result) Enum 

func (x LogFilesResult_Result) Enum() *LogFilesResult_Result

func (LogFilesResult_Result) EnumDescriptor deprecated 

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

Deprecated: Use LogFilesResult_Result.Descriptor instead.

func (LogFilesResult_Result) Number 

func (x LogFilesResult_Result) Number() protoreflect.EnumNumber

func (LogFilesResult_Result) String 

func (x LogFilesResult_Result) String() string

func (LogFilesResult_Result) Type 

func (LogFilesResult_Result) Type() protoreflect.EnumType

type LogFilesServiceClient 

type LogFilesServiceClient interface {
	// Get List of log files.
	GetEntries(ctx context.Context, in *GetEntriesRequest, opts ...grpc.CallOption) (*GetEntriesResponse, error)
	// Download log file.
	SubscribeDownloadLogFile(ctx context.Context, in *SubscribeDownloadLogFileRequest, opts ...grpc.CallOption) (grpc.ServerStreamingClient[DownloadLogFileResponse], error)
	// Erase all log files.
	EraseAllLogFiles(ctx context.Context, in *EraseAllLogFilesRequest, opts ...grpc.CallOption) (*EraseAllLogFilesResponse, error)
}

LogFilesServiceClient is the client API for LogFilesService 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.

Allow to download log files from the vehicle after a flight is complete. For log streaming during flight check the logging plugin.

func NewLogFilesServiceClient 

func NewLogFilesServiceClient(cc grpc.ClientConnInterface) LogFilesServiceClient

type LogFilesServiceServer 

type LogFilesServiceServer interface {
	// Get List of log files.
	GetEntries(context.Context, *GetEntriesRequest) (*GetEntriesResponse, error)
	// Download log file.
	SubscribeDownloadLogFile(*SubscribeDownloadLogFileRequest, grpc.ServerStreamingServer[DownloadLogFileResponse]) error
	// Erase all log files.
	EraseAllLogFiles(context.Context, *EraseAllLogFilesRequest) (*EraseAllLogFilesResponse, error)
	// contains filtered or unexported methods
}

LogFilesServiceServer is the server API for LogFilesService service. All implementations must embed UnimplementedLogFilesServiceServer for forward compatibility.

Allow to download log files from the vehicle after a flight is complete. For log streaming during flight check the logging plugin.

type LogFilesService_SubscribeDownloadLogFileClient 

type LogFilesService_SubscribeDownloadLogFileClient = grpc.ServerStreamingClient[DownloadLogFileResponse]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type LogFilesService_SubscribeDownloadLogFileServer 

type LogFilesService_SubscribeDownloadLogFileServer = grpc.ServerStreamingServer[DownloadLogFileResponse]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type ProgressData 

type ProgressData struct {
	Progress float32 `protobuf:"fixed32,1,opt,name=progress,proto3" json:"progress,omitempty"` // Progress from 0 to 1
	// contains filtered or unexported fields
}

Progress data coming when downloading a log file.

func (*ProgressData) Descriptor deprecated 

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

Deprecated: Use ProgressData.ProtoReflect.Descriptor instead.

func (*ProgressData) GetProgress 

func (x *ProgressData) GetProgress() float32

func (*ProgressData) ProtoMessage 

func (*ProgressData) ProtoMessage()

func (*ProgressData) ProtoReflect 

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

func (*ProgressData) Reset 

func (x *ProgressData) Reset()

func (*ProgressData) String 

func (x *ProgressData) String() string

type ServiceImpl 

type ServiceImpl struct {
	Client LogFilesServiceClient
}

func (*ServiceImpl) DownloadLogFile 

func (a *ServiceImpl) DownloadLogFile(ctx context.Context, entry *Entry, path string) (<-chan *ProgressData, error)

func (*ServiceImpl) EraseAllLogFiles added in v0.0.6 

func (s *ServiceImpl) EraseAllLogFiles(ctx context.Context) (*EraseAllLogFilesResponse, error)

func (*ServiceImpl) GetEntries 

func (s *ServiceImpl) GetEntries(ctx context.Context) (*GetEntriesResponse, error)

type SubscribeDownloadLogFileRequest 

type SubscribeDownloadLogFileRequest struct {
	Entry *Entry `protobuf:"bytes,1,opt,name=entry,proto3" json:"entry,omitempty"` // Entry of the log file to download.
	Path  string `protobuf:"bytes,2,opt,name=path,proto3" json:"path,omitempty"`   // Path of where to download log file to.
	// contains filtered or unexported fields
}

func (*SubscribeDownloadLogFileRequest) Descriptor deprecated 

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

Deprecated: Use SubscribeDownloadLogFileRequest.ProtoReflect.Descriptor instead.

func (*SubscribeDownloadLogFileRequest) GetEntry added in v0.0.4 

func (x *SubscribeDownloadLogFileRequest) GetEntry() *Entry

func (*SubscribeDownloadLogFileRequest) GetPath 

func (x *SubscribeDownloadLogFileRequest) GetPath() string

func (*SubscribeDownloadLogFileRequest) ProtoMessage 

func (*SubscribeDownloadLogFileRequest) ProtoMessage()

func (*SubscribeDownloadLogFileRequest) ProtoReflect 

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

func (*SubscribeDownloadLogFileRequest) Reset 

func (x *SubscribeDownloadLogFileRequest) Reset()

func (*SubscribeDownloadLogFileRequest) String 

func (x *SubscribeDownloadLogFileRequest) String() string

type UnimplementedLogFilesServiceServer 

type UnimplementedLogFilesServiceServer struct{}

UnimplementedLogFilesServiceServer must be embedded to have forward compatible implementations.

NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.

func (UnimplementedLogFilesServiceServer) EraseAllLogFiles added in v0.0.6 

func (UnimplementedLogFilesServiceServer) EraseAllLogFiles(context.Context, *EraseAllLogFilesRequest) (*EraseAllLogFilesResponse, error)

func (UnimplementedLogFilesServiceServer) GetEntries 

func (UnimplementedLogFilesServiceServer) GetEntries(context.Context, *GetEntriesRequest) (*GetEntriesResponse, error)

func (UnimplementedLogFilesServiceServer) SubscribeDownloadLogFile 

func (UnimplementedLogFilesServiceServer) SubscribeDownloadLogFile(*SubscribeDownloadLogFileRequest, grpc.ServerStreamingServer[DownloadLogFileResponse]) error

type UnsafeLogFilesServiceServer added in v0.0.4 

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

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

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.