bg77::qftpcfg

Public Member Functions
String	set (String, int)
String	set (String, String, String)
String	get (String)

Member Function Documentation

set() [1/2]

String set	(	String	,
		int
	)

Description

This api is used to configure FTP(S) server parameters, including user account, file type, transfer mode, context ID, response timeout, SSL type, SSL context ID, data connection address selection, etc..

Syntax

bg77.qftpcfg.set(para,conf)

Parameters

para

String String type. "account" "filetype" "transmode" "contextid" "rsptimeout" "ssltype" "sslctxid" "data_sslctxid" "data_address"

conf

int "filetype" Integer type. The type of transferred data. 0 Binary 1 ASCII "transmode" Integer type. Whether the FTP(S) server or client listens on a port for data connection 0 Active mode, the module will listen on a port for data connection 1 Passive mode, the FTP(S) server will listen on a port for data connection "contextid" Integer type. The PDP context ID. The range is 1-16, and the default value is 1. It should be activated by AT+QIACT before using AT+QFTPOPEN. For more details of AT+QIACT, please refer to Quectel_BG95&BG77_TCP(IP)_Application_Note. "rsptimeout" Integer type. The range is 20-180, and the default value is 90. Unit: second. Generally, it is the timeout value for the OK result code to be returned for most FTP(S) AT commands except AT+QFTPPUT, AT+QFTPGET, AT+QFTPLST and AT+QFTPNLST. The rules for these four commands are shown as below: a) When the command has been sent, but CONNECT has not been outputted yet, this parameter indicates the maximum timeout value for CONNECT to be outputted after the command has been sent. b) When the module has entered data mode, this parameter indicates the maximum interval time between two packets of received/transmitted data. c) When the <local_name> is not "COM:", it indicates the maximum interval time between two packets of received/transmitted data. "ssltype" Integer type. The module works as an FTP client or FTPS client. 0 FTP client 1 FTPS client (FTP over implicit TLS/SSL) 2 FTPS client (FTP over explicit TLS/SSL) "sslctxid" Integer type. The SSL context ID of the control connection. The range is 0-5, and the default value is 0. The value should be different from <data_sslctxid>. And the SSL parameters should be configured by AT+QSSLCFG. For details of the command, please refer to Quectel_BG95&BG77_SSL_Application_Note. "data_sslctxid" Integer type. The SSL context ID of the data connection. The range is 0-5, and the default value is 1. The value should be different from <sslctxid>. The SSL parameters should be configured by AT+QSSLCFG. For details of the command, please refer to Quectel_BG95&BG77_SSL_Application_Note. "data_address" Integer type. FTP(S) data connection address selection. 0 Use server dispatched address 1 Use FTP(S) control session address

Returns

String response

set() [2/2]

String set	(	String	,
		String	,
		String
	)

Description

This api is used to configure FTP(S) server parameters, including user account, file type, transfer mode, context ID, response timeout, SSL type, SSL context ID, data connection address selection, etc..

Syntax

bg77.qftpcfg.set(para,username,password)

Parameters

para	String String type. "account"
username	String String type. The user name for authentication. The maximum size of the parameter is 255 bytes
password	String String type. The password for authentication. The maximum size of the parameter is 255 bytes.

Returns

String response

get()

String get

(

String

)

Description

This api is used to configure FTP(S) server parameters, including user account, file type, transfer mode, context ID, response timeout, SSL type, SSL context ID, data connection address selection, etc..

Syntax

bg77.qftpcfg.get(para)

Parameters

para	String String type. "account" "filetype" "transmode" "contextid" "rsptimeout" "ssltype" "sslctxid" "data_sslctxid" "data_address"

Returns

String response