package mavsdk.rpc.log_files

Get desktop application:
View/edit binary Protocol Buffers messages

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

• rpc CancelDownloadLogFile (CancelDownloadLogFileRequest, CancelDownloadLogFileResponse)

  log_files.proto:28

  Cancel an ongoing log file download. Returns Success, also if no download is in progress (a warning is logged). The callback of the ongoing download is called once with Cancelled, the vehicle is told to stop sending, and the partially downloaded file is deleted.

  message CancelDownloadLogFileRequest

  log_files.proto:53

  (message has no fields)

  message CancelDownloadLogFileResponse

  log_files.proto:54

  • optional LogFilesResult log_files_result = 1

• rpc EraseAllLogFiles (EraseAllLogFilesRequest, EraseAllLogFilesResponse)

  log_files.proto:33

  Erase all log files.

  message EraseAllLogFilesRequest

  log_files.proto:58

  (message has no fields)

  message EraseAllLogFilesResponse

  log_files.proto:59

  • optional LogFilesResult log_files_result = 1

• rpc GetEntries (GetEntriesRequest, GetEntriesResponse)

  log_files.proto:14

  Get List of log files.

  message GetEntriesRequest

  log_files.proto:38

  (message has no fields)

  message GetEntriesResponse

  log_files.proto:39

  • optional LogFilesResult log_files_result = 1

  • repeated Entry entries = 2

    List of entries

• rpc SubscribeDownloadLogFile (SubscribeDownloadLogFileRequest, stream DownloadLogFileResponse)

  log_files.proto:16

  Download log file.

  message SubscribeDownloadLogFileRequest

  log_files.proto:44

  • optional Entry entry = 1

    Entry of the log file to download.

  • string path = 2

    Path of where to download log file to.

  message DownloadLogFileResponse

  log_files.proto:48

  • optional LogFilesResult log_files_result = 1

  • optional ProgressData progress = 2

    Progress if result is progress

Log file entry type.

Used in: GetEntriesResponse, SubscribeDownloadLogFileRequest

• uint32 id = 1

  ID of the log file, to specify a file to be downloaded

• string date = 2

  Date of the log file in UTC in ISO 8601 format "yyyy-mm-ddThh:mm:ssZ"

• uint32 size_bytes = 3

  Size of file in bytes

Result type.

Used in: CancelDownloadLogFileResponse, DownloadLogFileResponse, EraseAllLogFilesResponse, GetEntriesResponse

• LogFilesResult.Result result = 1

  Result enum value

• string result_str = 2

  Human-readable English string describing the result

Possible results returned for calibration commands

Used in: LogFilesResult

• RESULT_UNKNOWN = 0

  Unknown result

• RESULT_SUCCESS = 1

  Request succeeded

• RESULT_NEXT = 2

  Progress update

• RESULT_NO_LOGFILES = 3

  No log files found

• RESULT_TIMEOUT = 4

  A timeout happened

• RESULT_INVALID_ARGUMENT = 5

  Invalid argument

• RESULT_FILE_OPEN_FAILED = 6

  File open failed

• RESULT_NO_SYSTEM = 7

  No system is connected

• RESULT_CANCELLED = 8

  Download was cancelled

Progress data coming when downloading a log file.

Used in: DownloadLogFileResponse

• float progress = 1

  Progress from 0 to 1