Quectel GSM FTP AT Commands Manual V1.4

User Manual:

Open the PDF directly: View PDF PDF.
Page Count: 34

DownloadQuectel GSM FTP AT Commands Manual V1.4
Open PDF In BrowserView PDF
GSM
Quectel Cellular Engine

GSM FTP
AT Commands Manual
GSM_FTP_AT_Commands_Manual_V1.4

GSM FTP AT Commands Manual

Document Title

GSM FTP AT Commands Manual

Version

1.4

Date

2015-04-08

Status

Released

Document Control ID

GSM_FTP_AT_Commands_Manual_V1.4

l
e
t
l
c
a
e
i
t
u
n
Q ide
f
n
o
C

General Notes
Quectel offers this information as a service to its customers, to support application and
engineering efforts that use the products designed by Quectel. The information provided is
based upon requirements specifically provided to Quectel by the customers. Quectel has not
undertaken any independent search for additional relevant information, including any
information that may be in the customer’s possession. Furthermore, system validation of this
product designed by Quectel within a larger electronic system remains the responsibility of
the customer or the customer’s system integrator. All specifications supplied herein are
subject to change.
Copyright
This document contains proprietary technical information which is the property of Quectel
Limited. The copying of this document and giving it to others and the using or
communication of the contents thereof, are forbidden without express authority. Offenders are
liable to the payment of damages. All rights are reserved in the event of grant of a patent or
the registration of a utility model or design. All specification supplied herein are subject to
change without notice at any time.
Copyright © Quectel Wireless Solutions Co., Ltd. 2015

GSM_FTP_AT_Commands_Manual_V1.4

-1-

GSM FTP AT Commands Manual

Contents
Contents ............................................................................................................................................ 2
0. Revision history ............................................................................................................................ 4
1. Introduction ................................................................................................................................... 5
1.1. Reference............................................................................................................................. 5
1.2. Terms and abbreviations ...................................................................................................... 5
2. AT Commands for FTP Service .................................................................................................... 6
2.1. Overview of AT Commands for FTP Service ..................................................................... 6
2.2. Detailed Description of AT Commands for FTP Service.................................................... 7
2.2.1. AT+QFTPOPEN Open an FTP service to the given FTP server ........................... 7
2.2.2. AT+QFTPCLOSE Close the FTP service .............................................................. 8
2.2.3. AT+QFTPPUT Upload a file to the FTP server ..................................................... 8
2.2.4. AT+QFTPGET Download a file from the FTP server ........................................... 9
2.2.5. AT+QFTPPATH Set the path in the FTP server to upload or download file ....... 10
2.2.6. AT+QFTPUSER Set the user name of the account to open FTP service ............. 11
2.2.7. AT+QFTPPASS Set the password of the account to open FTP service ............... 12
2.2.8. AT+QFTPCFG Set some configurable parameters for the FTP service .............. 12
2.2.9. AT+QFTPSTAT Query status of FTP service ...................................................... 14
2.2.10. AT+QFTPLEN Query the real size transferred in the latest transfer ................... 15
2.2.11. AT+QFTPRENAME Rename the file or file folder name on the ftp server ........ 15
2.2.12. AT+QFTPSIZE Query the size of appointed file on the ftp server ...................... 16
2.2.13. AT+QFTPDELETE Delete the appointed file on the ftp server .......................... 17
2.2.14. AT+QFTPMKDIR Establish a new file folder on the ftp server ......................... 17
2.2.15. AT+QFTPRMDIR Remove a file folder on the ftp server................................... 18
2.2.16. AT+QFTPLIST List contents of directory or file information on the ftp server.. 19
2.2.17. AT+QFTPNLST List file names in the given directory on the ftp server ............ 20
3. Summary of Error Codes ............................................................................................................ 21
4. Examples ..................................................................................................................................... 22
4.1. Open an FTP service ......................................................................................................... 22
4.2. Upload a file to FTP server ............................................................................................... 22
4.2.1. Upload a file through UART ............................................................................... 22
4.2.2. Upload a file in UFS ............................................................................................ 23
4.2.3. Upload a file in RAM .......................................................................................... 23
4.2.4. Upload a specified file in UFS ............................................................................. 24
4.3. Download a file from FTP server ...................................................................................... 25
4.3.1. Download a file through UART........................................................................... 25
4.3.2. Download a file into UFS .................................................................................... 25
4.3.3. Download a file into a specified file in UFS ........................................................ 26
4.3.4. Download a file into RAM .................................................................................. 26
4.4. Operate a file or a file folder on the FTP........................................................................... 27
4.4.1. Operate a file on the FTP server .......................................................................... 27
4.4.2. Operate a file folder on the FTP server ................................................................ 28

l
e
t
l
c
a
e
i
t
u
n
Q ide
f
n
o
C

GSM_FTP_AT_Commands_Manual_V1.4

-2-

GSM FTP AT Commands Manual

4.5. Resume file at the resuming point ..................................................................................... 28
4.5.1. Upload a file to FTP server from the resuming point .......................................... 28
4.5.2. Download a file from FTP server from the resuming point ................................. 29
4.6. Get FTP list ....................................................................................................................... 30
4.7. Get FTP file name list ....................................................................................................... 31
4.8. Close the FTP service ........................................................................................................ 31

l
e
t
l
c
a
e
i
t
u
n
Q ide
f
n
o
C
GSM_FTP_AT_Commands_Manual_V1.4

-3-

GSM FTP AT Commands Manual

0. Revision history

Revision

Date

Author

Description of change

1.00

2009-7-27

Colin HU

Initial

1.01

2010-4-12

Joanna LI

Added example for resuming file.

1.1

2010-7-1

Colin HU

Added the notice of hardware flow control when
transferring file.

2010-8-3

Colin HU

Added the description about how to upload a file
in UFS or SD or RAM and download a file to
UFS or SD or RAM.

2012-1-20

Derrick DAI

Added the description about the new AT
commands which control the operations of file
and file folder on FTP.

2012-6-4

Will SHAO

Modified AT+QFTPGET for RAM file.

2012-8-22

Jonathan WEN

Added AT+QFTPLIST & AT+QFTPNLST.

2012-8-24

Jonathan WEN

Added examples of downloading FTP file to
RAM and uploading RAM file to FTP.

2015-04-08

Jonathan WEN

Added applicable modules

1.2

1.3
1.4

l
e
t
l
c
a
e
i
t
u
n
Q ide
f
n
o
C

GSM_FTP_AT_Commands_Manual_V1.4

-4-

GSM FTP AT Commands Manual

1. Introduction
Quectel Module provides an internal TCP/IP stack that is driven by AT commands and
enables the host application to easily access the Internet service. It includes TCP service,
UDP service, HTTP service and FTP service, etc. This document is a reference guide to all
the AT commands and responses defined for FTP Service.
This document is applicable to all Quectel GSM modules.

l
e
t
l
c
a
e
i
t
u
n
Q ide
f
n
o
C

1.1. Reference

Table 1: Reference
SN

Document name

Remark

[1]

M10_ATC.pdf

The introduction to AT commands for M10

[2]

GSM_TCPIP_AN.pdf

To introduce how to use the internal TCP/IP stack

[3]

GSM_File_ATC

To introduce the AT command for the file system

1.2. Terms and abbreviations

Table 2: Terms and abbreviations
Abbreviation

Description

APN

Access Point Network

CSD
FTP
GPRS
HTTP
TA
TCP
TE
UART
UDP
UFS

Circuit Switched Data
File Transfer Protocol

General Packet Radio Service

Hypertext Transfer Protocol Overview
Terminal Adapter, i.e. the module
Transmission Control Protocol

Terminal Equipment, i.e. the device who control the module via UART
Universal Asynchronous Receiver/Transmitter
User Datagram Protocol

User File Storage. Please refer to [3]

GSM_FTP_AT_Commands_Manual_V1.4

-5-

GSM FTP AT Commands Manual

2. AT Commands for FTP Service

2.1. Overview of AT Commands for FTP Service
Command

Description

AT+QFTPOPEN

OPEN AN FTP SERVICE TO THE GIVEN FTP SERVER

AT+QFTPCLOSE

CLOSE THE FTP SERVICE

AT+QFTPPUT

UPLOAD A FILE TO THE FTP SERVER

AT+QFTPGET

DOWNLOAD A FILE FROM THE FTP SERVER

AT+QFTPPATH

SET THE PATH IN THE FTP SERVER TO UPLOAD OR DOWNLOAD
FILE

AT+QFTPUSER

SET THE USER NAME OF THE ACCOUNT TO OPEN FTP SERVICE

AT+QFTPPASS

SET THE PASSWORD OF THE ACCOUNT TO OPEN FTP SERVICE

AT+QFTPCFG

SET SOME CONFIGUABLE PARAMETERS FOR THE FTP SERVICE

AT+QFTPSTAT

QUERY STATUS OF FTP SERVICE

AT+QFTPLEN

QUERY THE REAL SIZE TRANSFERRED IN THE LATEST
TRANSFER

AT+QFTPRENA
ME

RENAME THE FILE OR FILEFOLDER NAME ON THE FTP SERVER

AT+QFTPSIZE

QUERY THE SIZE OF APPOINTED FILE ON THE FTP SERVER

AT+QFTPDELET
E

DELETE THE APPOINTED FILE ON THE FTP SERVER

AT+QFTPMKDI
R

ESTABLISH A NEW FILEFOLDER ON THE FTP SERVER

AT+QFTPRMDIR

REMOVE A FILEFOLDER ON THE FTP SERVER

AT+QFTPLIST

LIST CONTENTS OF DIRECTORY OR FILE INFORMATION ON
THE FTP SERVER

AT+ QFTPNLST

LIST FILE NAMES IN THE GIVEN DIRECTORY ON THE FTP
SERVER

l
e
t
l
c
a
e
i
t
u
n
Q ide
f
n
o
C

GSM_FTP_AT_Commands_Manual_V1.4

-6-

GSM FTP AT Commands Manual

2.2. Detailed Description of AT Commands for FTP Service
2.2.1.

AT+QFTPOPEN Open an FTP service to the given FTP server

AT+QFTPOPEN

Open an FTP service to the given FTP server

Test Command
Response
AT+QFTPOPEN +QFTPOPEN : "HOST NAME",(1-65535)
=?
OK
Parameters
See Write Command

l
e
t
l
c
a
e
i
t
u
n
Q ide
f
n
o
C

Read Command
Response
AT+QFTPOPEN +QFTPOPEN :"",(1-65535)
?
OK
Parameters
See Write Command
Write Command Response
AT+QFTPOPEN If format is right, response
="",
Otherwise response
ERROR
Next, if connect successfully, response
+QFTPOPEN:0

Otherwise, response
+QFTPOPEN:
Parameters

The address of the FTP server. It could be an IP address
or a domain name. The maximum size of the parameter
is 100.

The port of the FTP server. The range of the parameter is
1-65535.

A negative numeric to indicate the type of error, please
refer to the chapter 3.

Reference

Note:
 It is recommended to execute the commands AT+QFTPUSER and
AT+QFTPPASS to set the user name and password before opening
FTP service.
 If FTP state is IDLE or CLOSED (Please refer to 2.2.9), the fields of
host name and port in the response of the read command are empty.

GSM_FTP_AT_Commands_Manual_V1.4

-7-

GSM FTP AT Commands Manual

2.2.2.

AT+QFTPCLOSE Close the FTP service

AT+QFTPCLOSE Close the FTP service
Test Command
Response
AT+QFTPCLOS OK
Parameters
E=?
See Write Command
Execution
Response
Command
OK
AT+QFTPCLOS
Next, if the FTP service is closed successfully, response
E
+QFTPCLOSE:0

l
e
t
l
c
a
e
i
t
u
n
Q ide
f
n
o
C
Otherwise, response
+QFTPCLOSE:
Parameters

A negative numeric to indicate the type of error, please
refer to the chapter 3.

Reference

2.2.3.

AT+QFTPPUT Upload a file to the FTP server

AT+QFTPPUT

Upload a file to the FTP server

Test Command
Response
AT+QFTPPUT= +QFTPPUT: "FILE NAME",,(1-65535)
?
OK
Parameters
See Write Command

Write Command Response
AT+QFTPPUT= If format is right, response
"",[,
Source Exif Data: 
File Type                       : PDF
File Type Extension             : pdf
MIME Type                       : application/pdf
PDF Version                     : 1.5
Linearized                      : No
Has XFA                         : No
Language                        : zh-CN
XMP Toolkit                     : Adobe XMP Core 4.2.1-c043 52.372728, 2009/01/18-15:08:04
Format                          : application/pdf
Creator                         : Colin.Hu
Create Date                     : 2015:04:08 14:46:10+08:00
Creator Tool                    : Microsoft® Word 2010
Modify Date                     : 2015:04:08 14:47+08:00
Metadata Date                   : 2015:04:08 14:47+08:00
Producer                        : Microsoft® Word 2010
Document ID                     : uuid:0f76f3a6-18ba-4712-8b13-a1dd882f832f
Instance ID                     : uuid:486294e6-10fa-47b5-a243-cb68e8014918
Page Mode                       : UseOutlines
Page Count                      : 34
Author                          : Colin.Hu
EXIF Metadata provided by EXIF.tools

Navigation menu