package mavsdk.rpc.ftp

Get desktop application:
View/edit binary Protocol Buffers messages

Implements file transfer functionality using MAVLink FTP.

• rpc AreFilesIdentical (AreFilesIdenticalRequest, AreFilesIdenticalResponse)

  ftp.proto:51

  Compares a local file to a remote file using a CRC32 checksum.

  message AreFilesIdenticalRequest

  ftp.proto:135

  • string local_file_path = 1

    The path of the local file.

  • string remote_file_path = 2

    The path of the remote file.

  message AreFilesIdenticalResponse

  ftp.proto:139

  • optional FtpResult ftp_result = 1

  • bool are_identical = 2

    Whether the files are identical.

• rpc CreateDirectory (CreateDirectoryRequest, CreateDirectoryResponse)

  ftp.proto:35

  Creates a remote directory.

  message CreateDirectoryRequest

  ftp.proto:106

  • string remote_dir = 1

    The remote directory to create.

  message CreateDirectoryResponse

  ftp.proto:109

  • optional FtpResult ftp_result = 1

• rpc ListDirectory (ListDirectoryRequest, ListDirectoryResponse)

  ftp.proto:31

  Lists items from a remote directory.

  message ListDirectoryRequest

  ftp.proto:77

  • string remote_dir = 1

    The remote directory to list the contents for.

  message ListDirectoryResponse

  ftp.proto:101

  • optional FtpResult ftp_result = 1

  • optional ListDirectoryData data = 2

    The found directories and files.

• rpc RemoveDirectory (RemoveDirectoryRequest, RemoveDirectoryResponse)

  ftp.proto:39

  Removes a remote directory.

  message RemoveDirectoryRequest

  ftp.proto:113

  • string remote_dir = 1

    The remote directory to remove.

  message RemoveDirectoryResponse

  ftp.proto:116

  • optional FtpResult ftp_result = 1

• rpc RemoveFile (RemoveFileRequest, RemoveFileResponse)

  ftp.proto:43

  Removes a remote file.

  message RemoveFileRequest

  ftp.proto:120

  • string remote_file_path = 1

    The path of the remote file to remove.

  message RemoveFileResponse

  ftp.proto:123

  • optional FtpResult ftp_result = 1

• rpc Rename (RenameRequest, RenameResponse)

  ftp.proto:47

  Renames a remote file or remote directory.

  message RenameRequest

  ftp.proto:127

  • string remote_from_path = 1

    The remote source path.

  • string remote_to_path = 2

    The remote destination path.

  message RenameResponse

  ftp.proto:131

  • optional FtpResult ftp_result = 1

• rpc SetTargetCompid (SetTargetCompidRequest, SetTargetCompidResponse)

  ftp.proto:55

  Set target component ID. By default it is the autopilot.

  message SetTargetCompidRequest

  ftp.proto:144

  • uint32 compid = 1

    The component ID to set.

  message SetTargetCompidResponse

  ftp.proto:147

  • optional FtpResult ftp_result = 1

• rpc SubscribeDownload (SubscribeDownloadRequest, stream DownloadResponse)

  ftp.proto:17

  Downloads a file to local directory.

  message SubscribeDownloadRequest

  ftp.proto:58

  • string remote_file_path = 1

    The path of the remote file to download.

  • string local_dir = 2

    The local directory to download to.

  • bool use_burst = 3

    Use burst for faster downloading.

  message DownloadResponse

  ftp.proto:63

  • optional FtpResult ftp_result = 1

  • optional ProgressData progress_data = 2

    The progress data if result is next

• rpc SubscribeUpload (SubscribeUploadRequest, stream UploadResponse)

  ftp.proto:24

  Uploads local file to remote directory.

  message SubscribeUploadRequest

  ftp.proto:68

  • string local_file_path = 1

    The local file path to upload.

  • string remote_dir = 2

    The remote directory to upload to.

  message UploadResponse

  ftp.proto:72

  • optional FtpResult ftp_result = 1

  • optional ProgressData progress_data = 2

    The progress data if result is next

A file system entry (file or directory) with metadata.

Used in: ListDirectoryData

• string name = 1

  The name of the file or directory.

• FilesystemEntry.EntryType entry_type = 2

  Whether the entry is a file or a directory.

• uint64 size_bytes = 3

  The size of the file in bytes (0 for directories).

• uint64 modification_time_s = 4

  Last modification time in seconds since UNIX epoch (UTC), 0 if unknown.

The type of a file system entry.

Used in: FilesystemEntry

• ENTRY_TYPE_UNKNOWN = 0

  Unknown entry type

• ENTRY_TYPE_FILE = 1

  A regular file

• ENTRY_TYPE_DIRECTORY = 2

  A directory

Result type.

Used in: AreFilesIdenticalResponse, CreateDirectoryResponse, DownloadResponse, ListDirectoryResponse, RemoveDirectoryResponse, RemoveFileResponse, RenameResponse, SetTargetCompidResponse, UploadResponse

• FtpResult.Result result = 1

  Result enum value

• string result_str = 2

  Human-readable English string describing the result

Possible results returned for FTP commands

Used in: FtpResult

• RESULT_UNKNOWN = 0

  Unknown result

• RESULT_SUCCESS = 1

  Success

• RESULT_NEXT = 2

  Intermediate message showing progress

• RESULT_TIMEOUT = 3

  Timeout

• RESULT_BUSY = 4

  Operation is already in progress

• RESULT_FILE_IO_ERROR = 5

  File IO operation error

• RESULT_FILE_EXISTS = 6

  File exists already

• RESULT_FILE_DOES_NOT_EXIST = 7

  File does not exist

• RESULT_FILE_PROTECTED = 8

  File is write protected

• RESULT_INVALID_PARAMETER = 9

  Invalid parameter

• RESULT_UNSUPPORTED = 10

  Unsupported command

• RESULT_PROTOCOL_ERROR = 11

  General protocol error

• RESULT_NO_SYSTEM = 12

  No system connected

The output of a directory list

Used in: ListDirectoryResponse

• repeated FilesystemEntry entries = 1

  The directory entries (files and directories) with their metadata.

Progress data type for file transfer.

Used in: DownloadResponse, UploadResponse

• uint32 bytes_transferred = 1

  The number of bytes already transferred.

• uint32 total_bytes = 2

  The total bytes to transfer.