Appearance

mavsdk::Ftp Class Reference ​

#include: ftp.h

Implements file transfer functionality using MAVLink FTP.

Data Structures ​

struct ListDirectoryData

struct ProgressData

Public Types ​

TypeDescription
enum ResultPossible results returned for FTP commands.
std::function< void(Result)> ResultCallbackCallback type for asynchronous Ftp calls.
std::function< void(Result, ProgressData)> DownloadCallbackCallback type for download_async.
std::function< void(Result, ProgressData)> UploadCallbackCallback type for upload_async.
std::function< void(Result, ListDirectoryData)> ListDirectoryCallbackCallback type for list_directory_async.
std::function< void(Result, bool)> AreFilesIdenticalCallbackCallback type for are_files_identical_async.

Public Member Functions ​

TypeNameDescription
 Ftp (System & system)Constructor. Creates the plugin for a specific System.
 Ftp (std::shared_ptr< System > system)Constructor. Creates the plugin for a specific System.
 ~Ftp () overrideDestructor (internal use only).
 Ftp (const Ftp & other)Copy constructor.
voiddownload_async (std::string remote_file_path, std::string local_dir, bool use_burst, const DownloadCallback & callback)Downloads a file to local directory.
voidupload_async (std::string local_file_path, std::string remote_dir, const UploadCallback & callback)Uploads local file to remote directory.
voidlist_directory_async (std::string remote_dir, const ListDirectoryCallback callback)Lists items from a remote directory.
std::pair< Result, Ftp::ListDirectoryData >list_directory (std::string remote_dir)constLists items from a remote directory.
voidcreate_directory_async (std::string remote_dir, const ResultCallback callback)Creates a remote directory.
Resultcreate_directory (std::string remote_dir)constCreates a remote directory.
voidremove_directory_async (std::string remote_dir, const ResultCallback callback)Removes a remote directory.
Resultremove_directory (std::string remote_dir)constRemoves a remote directory.
voidremove_file_async (std::string remote_file_path, const ResultCallback callback)Removes a remote file.
Resultremove_file (std::string remote_file_path)constRemoves a remote file.
voidrename_async (std::string remote_from_path, std::string remote_to_path, const ResultCallback callback)Renames a remote file or remote directory.
Resultrename (std::string remote_from_path, std::string remote_to_path)constRenames a remote file or remote directory.
voidare_files_identical_async (std::string local_file_path, std::string remote_file_path, const AreFilesIdenticalCallback callback)Compares a local file to a remote file using a CRC32 checksum.
std::pair< Result, bool >are_files_identical (std::string local_file_path, std::string remote_file_path)constCompares a local file to a remote file using a CRC32 checksum.
Resultset_target_compid (uint32_t compid)constSet target component ID. By default it is the autopilot.
const Ftp &operator= (const Ftp &)=deleteEquality operator (object is not copyable).

Constructor & Destructor Documentation ​

Ftp() ​

cpp
mavsdk::Ftp::Ftp(System &system)

Constructor. Creates the plugin for a specific System.

The plugin is typically created as shown below:

cpp
auto ftp = Ftp(system);

Parameters

  • System& system - The specific system associated with this plugin.

Ftp() ​

cpp
mavsdk::Ftp::Ftp(std::shared_ptr< System > system)

Constructor. Creates the plugin for a specific System.

The plugin is typically created as shown below:

cpp
auto ftp = Ftp(system);

Parameters

  • std::shared_ptr< System > system - The specific system associated with this plugin.

~Ftp() ​

cpp
mavsdk::Ftp::~Ftp() override

Destructor (internal use only).

Ftp() ​

cpp
mavsdk::Ftp::Ftp(const Ftp &other)

Copy constructor.

Parameters

  • const Ftp& other -

Member Typdef Documentation ​

typedef ResultCallback ​

cpp
using mavsdk::Ftp::ResultCallback =  std::function<void(Result)>

Callback type for asynchronous Ftp calls.

typedef DownloadCallback ​

cpp
using mavsdk::Ftp::DownloadCallback =  std::function<void(Result, ProgressData)>

Callback type for download_async.

typedef UploadCallback ​

cpp
using mavsdk::Ftp::UploadCallback =  std::function<void(Result, ProgressData)>

Callback type for upload_async.

typedef ListDirectoryCallback ​

cpp
using mavsdk::Ftp::ListDirectoryCallback =  std::function<void(Result, ListDirectoryData)>

Callback type for list_directory_async.

typedef AreFilesIdenticalCallback ​

cpp
using mavsdk::Ftp::AreFilesIdenticalCallback =  std::function<void(Result, bool)>

Callback type for are_files_identical_async.

Member Enumeration Documentation ​

enum Result ​

Possible results returned for FTP commands.

ValueDescription
UnknownUnknown result.
SuccessSuccess.
NextIntermediate message showing progress.
TimeoutTimeout.
BusyOperation is already in progress.
FileIoErrorFile IO operation error.
FileExistsFile exists already.
FileDoesNotExistFile does not exist.
FileProtectedFile is write protected.
InvalidParameterInvalid parameter.
UnsupportedUnsupported command.
ProtocolErrorGeneral protocol error.
NoSystemNo system connected.

Member Function Documentation ​

download_async() ​

cpp
void mavsdk::Ftp::download_async(std::string remote_file_path, std::string local_dir, bool use_burst, const DownloadCallback &callback)

Downloads a file to local directory.

Parameters

  • std::string remote_file_path -
  • std::string local_dir -
  • bool use_burst -
  • const DownloadCallback& callback -

upload_async() ​

cpp
void mavsdk::Ftp::upload_async(std::string local_file_path, std::string remote_dir, const UploadCallback &callback)

Uploads local file to remote directory.

Parameters

  • std::string local_file_path -
  • std::string remote_dir -
  • const UploadCallback& callback -

list_directory_async() ​

cpp
void mavsdk::Ftp::list_directory_async(std::string remote_dir, const ListDirectoryCallback callback)

Lists items from a remote directory.

This function is non-blocking. See 'list_directory' for the blocking counterpart.

Parameters

list_directory() ​

cpp
std::pair< Result, Ftp::ListDirectoryData > mavsdk::Ftp::list_directory(std::string remote_dir) const

Lists items from a remote directory.

This function is blocking. See 'list_directory_async' for the non-blocking counterpart.

Parameters

  • std::string remote_dir -

Returns

 std::pair< Result, Ftp::ListDirectoryData > - Result of request.

create_directory_async() ​

cpp
void mavsdk::Ftp::create_directory_async(std::string remote_dir, const ResultCallback callback)

Creates a remote directory.

This function is non-blocking. See 'create_directory' for the blocking counterpart.

Parameters

create_directory() ​

cpp
Result mavsdk::Ftp::create_directory(std::string remote_dir) const

Creates a remote directory.

This function is blocking. See 'create_directory_async' for the non-blocking counterpart.

Parameters

  • std::string remote_dir -

Returns

 Result - Result of request.

remove_directory_async() ​

cpp
void mavsdk::Ftp::remove_directory_async(std::string remote_dir, const ResultCallback callback)

Removes a remote directory.

This function is non-blocking. See 'remove_directory' for the blocking counterpart.

Parameters

remove_directory() ​

cpp
Result mavsdk::Ftp::remove_directory(std::string remote_dir) const

Removes a remote directory.

This function is blocking. See 'remove_directory_async' for the non-blocking counterpart.

Parameters

  • std::string remote_dir -

Returns

 Result - Result of request.

remove_file_async() ​

cpp
void mavsdk::Ftp::remove_file_async(std::string remote_file_path, const ResultCallback callback)

Removes a remote file.

This function is non-blocking. See 'remove_file' for the blocking counterpart.

Parameters

remove_file() ​

cpp
Result mavsdk::Ftp::remove_file(std::string remote_file_path) const

Removes a remote file.

This function is blocking. See 'remove_file_async' for the non-blocking counterpart.

Parameters

  • std::string remote_file_path -

Returns

 Result - Result of request.

rename_async() ​

cpp
void mavsdk::Ftp::rename_async(std::string remote_from_path, std::string remote_to_path, const ResultCallback callback)

Renames a remote file or remote directory.

This function is non-blocking. See 'rename' for the blocking counterpart.

Parameters

  • std::string remote_from_path -
  • std::string remote_to_path -
  • const ResultCallback callback -

rename() ​

cpp
Result mavsdk::Ftp::rename(std::string remote_from_path, std::string remote_to_path) const

Renames a remote file or remote directory.

This function is blocking. See 'rename_async' for the non-blocking counterpart.

Parameters

  • std::string remote_from_path -
  • std::string remote_to_path -

Returns

 Result - Result of request.

are_files_identical_async() ​

cpp
void mavsdk::Ftp::are_files_identical_async(std::string local_file_path, std::string remote_file_path, const AreFilesIdenticalCallback callback)

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

This function is non-blocking. See 'are_files_identical' for the blocking counterpart.

Parameters

are_files_identical() ​

cpp
std::pair< Result, bool > mavsdk::Ftp::are_files_identical(std::string local_file_path, std::string remote_file_path) const

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

This function is blocking. See 'are_files_identical_async' for the non-blocking counterpart.

Parameters

  • std::string local_file_path -
  • std::string remote_file_path -

Returns

 std::pair< Result, bool > - Result of request.

set_target_compid() ​

cpp
Result mavsdk::Ftp::set_target_compid(uint32_t compid) const

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

This function is blocking.

Parameters

  • uint32_t compid -

Returns

 Result - Result of request.

operator=() ​

cpp
const Ftp & mavsdk::Ftp::operator=(const Ftp &)=delete

Equality operator (object is not copyable).

Parameters

Returns

 const Ftp & -