RUI3 (RAK Unified Interface 3) - RAK4631
bg77::qftpget

Public Member Functions

String set (String)
 
String set (String, int)
 
String set (String, String)
 
String set (String, String, int)
 
String set (String, int, int)
 

Member Function Documentation

◆ set() [1/5]

String set ( String  )
Description
This api is used to download a file from FTP(S) server
Syntax
bg77.qftpget.set(filename)
Parameters
filenameString String type. The file name on FTP(S) server. The maximum size of the parameter is 255 bytes.
Returns
String response

◆ set() [2/5]

String set ( String  ,
int   
)
Description
This api is used to download a file from FTP(S) server
Syntax
bg77.qftpget.set(filename,startpos,downloadlen)
Parameters
filenameString String type. The file name on FTP(S) server. The maximum size of the parameter is 255 bytes.
startposint Integer type. The start position of the file to be uploaded. The default value is 0.
Returns
String response

◆ set() [3/5]

String set ( String  ,
String   
)
Description
This api is used to download a file from FTP(S) server
Syntax
bg77.qftpget.set(filename,local_name)
Parameters
filenameString String type. The file name on FTP(S) server. The maximum size of the parameter is 255 bytes.
local_nameString String type. The local file name. The maximum size of the parameter is 60 bytes. If it is "COM:", the file data will be outputted to COM port. If it is not "COM:", the data will be saved to UFS, and then the file can be read by AT+QFREAD. For more details, please refer to Quectel_BG95&BG77_FILE_Application_Note.
Returns
String response

◆ set() [4/5]

String set ( String  ,
String  ,
int   
)
Description
This api is used to download a file from FTP(S) server
Syntax
bg77.qftpget.set(filename,local_name,startpos)
Parameters
filenameString String type. The file name on FTP(S) server. The maximum size of the parameter is 255 bytes.
local_nameString String type. The local file name. The maximum size of the parameter is 60 bytes. If it is "COM:", the file data will be outputted to COM port. If it is not "COM:", the data will be saved to UFS, and then the file can be read by AT+QFREAD. For more details, please refer to Quectel_BG95&BG77_FILE_Application_Note.
startposint Integer type. The start position of the file to be uploaded. The default value is 0.
Returns
String response

◆ set() [5/5]

String set ( String  ,
int  ,
int   
)
Description
This api is used to download a file from FTP(S) server
Syntax
bg77.qftpget.set(filename,startpos,downloadlen)
Parameters
filenameString String type. The file name on FTP(S) server. The maximum size of the parameter is 255 bytes.
startposint Integer type. The start position of the file to be uploaded. The default value is 0.
downloadlenint Integer type. The length of data to be downloaded. It is valid only if <local_name> is "COM:". If this parameter is specified, the module will output <downloadlen> bytes to COM port and exit from data mode. And data can be downloaded from <startpos> by the same AT command if there are some data left. Unit: byte.
Returns
String response