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

Public Member Functions

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

Member Function Documentation

◆ set() [1/5]

String set ( String  )
Description
This api is used to upload a file to FTP(S) server
Syntax
bg77.qftpput.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 upload a file to FTP(S) server
Syntax
bg77.qftpput.set(filename,startpos)
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. If <uploadlen> and <beof> are specified, <startpos> should be the position where the data continues to be uploaded to the same file
Returns
String response

◆ set() [3/5]

String set ( String  ,
String   
)
Description
This api is used to upload a file to FTP(S) server
Syntax
bg77.qftpput.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 data will be inputted via COM port. If it is not "COM:", the data will be saved to UFS. After successful uploading, the file should be deleted by AT+QFDEL. For details of the command, 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 upload a file to FTP(S) server
Syntax
bg77.qftpput.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 data will be inputted via COM port. If it is not "COM:", the data will be saved to UFS. After successful uploading, the file should be deleted by AT+QFDEL. For details of the command, 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. If <uploadlen> and <beof> are specified, <startpos> should be the position where the data continues to be uploaded to the same file
Returns
String response

◆ set() [5/5]

String set ( String  ,
int  ,
int  ,
int   
)
Description
This api is used to upload a file to FTP(S) server
Syntax
bg77.qftpput.set(filename,startpos,uploadlen,beof)
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. If <uploadlen> and <beof> are specified, <startpos> should be the position where the data continues to be uploaded to the same file
uploadlenint Integer type. The length of the data to be uploaded. It is valid only when <local_name> is "COM:". When the length of data uploaded via COM port reaches <uploadlen>, the module will exit from data mode. Unit: byte.
beofint Integer type. Whether it is the last packet of data to be uploaded.
0 Not the last packet of data. When the data length reaches <uploadlen>, the module will exit from data mode and +QFTPPUT: 0,<transferlen> will be outputted. In such a case, please do not disconnect data connection, as the remained data needs to be uploaded to the same file on FTP(S).
1 The last packet of data. When the data length reaches <uploadlen>, the module will exit from data mode and data connection can be disconnected. After that, +QFTPPUT: 0,<transferlen> will be outputted.
Returns
String response