Quectel BG96 Installation manual

BG96 FILE
AT Commands Manual
LTE Module Series
Rev. BG96_FILE_AT_Commands_Manual_V1.0
Date: 2018-01-24
Status: Released
www.quectel.com

LTE Module Series
BG96 FILE AT Commands Manual
BG96_FILE_AT_Commands_Manual 1 / 22
Our aim is to provide customers with timely and comprehensive service. For any
assistance, please contact our company headquarters:
Quectel Wireless Solutions Co., Ltd.
7th Floor, Hongye Building, No.1801 Hongmei Road, Xuhui District, Shanghai 200233, China
Tel: [phone]
Email: [email protected]om
Or our local office. For more information, please visit:
http://quectel.com/support/sales.htm
For technical support, or to report documentation errors, please visit:
http://quectel.com/support/technical.htm
Or email to: [e-mail]
GENERAL NOTES
QUECTEL OFFERS THE INFORMATION AS A SERVICE TO ITS CUSTOMERS. THE INFORMATION
PROVIDED IS BASED UPON CUSTOMERS’ REQUIREMENTS. QUECTEL MAKES EVERY EFFORT
TO ENSURE THE QUALITY OF THE INFORMATION IT MAKES AVAILABLE. QUECTEL DOES NOT
MAKE ANY WARRANTY AS TO THE INFORMATION CONTAINED HEREIN, AND DOES NOT ACCEPT
ANY LIABILITY FOR ANY INJURY, LOSS OR DAMAGE OF ANY KIND INCURRED BY USE OF OR
RELIANCE UPON THE INFORMATION. ALL INFORMATION SUPPLIED HEREIN IS SUBJECT TO
CHANGE WITHOUT PRIOR NOTICE.
COPYRIGHT
THE INFORMATION CONTAINED HERE IS PROPRIETARY TECHNICAL INFORMATION OF
QUECTEL WIRELESS SOLUTIONS CO., LTD. TRANSMITTING, REPRODUCTION, DISSEMINATION
AND EDITING OF THIS DOCUMENT AS WELL AS UTILIZATION OF THE CONTENT ARE
FORBIDDEN WITHOUT PERMISSION. OFFENDERS WILL BE HELD LIABLE FOR PAYMENT OF
DAMAGES. ALL RIGHTS ARE RESERVED IN THE EVENT OF A PATENT GRANT OR
REGISTRATION OF A UTILITY MODEL OR DESIGN.
Copyright © Quectel Wireless Solutions Co., Ltd. 2018. All rights reserved.

LTE Module Series
BG96 FILE AT Commands Manual
BG96_FILE_AT_Commands_Manual 2 / 22
About the Document
History
Revision
Date
Author
Description
1.0
2018-01-24
Matt YE/
Kennen WU
Initial

LTE Module Series
BG96 FILE AT Commands Manual
BG96_FILE_AT_Commands_Manual 3 / 22
Contents
About the Document...................................................................................................................................2
Contents.......................................................................................................................................................3
Table Index...................................................................................................................................................4
1Introduction..........................................................................................................................................5
1.1. The Process of Using File AT Commands ..............................................................................5
1.2. Description of Data Mode........................................................................................................6
2Description of FILE AT Commands ...................................................................................................7
2.1. AT+QFLDS Get the Space Information of UFS....................................................................7
2.2. AT+QFLST List Files.............................................................................................................8
2.3. AT+QFDEL Delete Files .......................................................................................................9
2.4. AT+QFUPL Upload a File.....................................................................................................9
2.5. AT+QFDWL Download a File.............................................................................................. 11
2.6. AT+QFOPEN Open a File ..................................................................................................12
2.7. AT+QFREAD Read a File...................................................................................................13
2.8. AT+QFWRITE Write a File..................................................................................................13
2.9. AT+QFSEEK Set File Pointer to a Position........................................................................14
2.10. AT+QFPOSITION Get the Offset of a File Pointer.............................................................15
2.11. AT+QFTUCAT Truncate a File from the File Pointer..........................................................16
2.12. AT+QFCLOSE Close a File................................................................................................16
3Examples ............................................................................................................................................18
3.1. Upload and Download Files..................................................................................................18
3.1.1. Upload a File..................................................................................................................18
3.1.1.1. NonACK Mode..................................................................................................... 18
3.1.1.2. ACK Mode ............................................................................................................18
3.1.2. Download a File .............................................................................................................19
3.2. Write and Read Files.............................................................................................................19
3.2.1. Write and Read a UFS File............................................................................................19
4Summary of ERROR Codes..............................................................................................................20
5Appendix A Reference.......................................................................................................................22

LTE Module Series
BG96 FILE AT Commands Manual
BG96_FILE_AT_Commands_Manual 4 / 22
Table Index
TABLE 1: SUMMARY OF ERROR CODES ...................................................................................................... 20
TABLE 2: TERMS AND ABBREVIATIONS........................................................................................................ 22

LTE Module Series
BG96 FILE AT Commands Manual
BG96_FILE_AT_Commands_Manual 5 / 22
1Introduction
Quectel BG96 module provides AT commands to operate files on UFS (User File Storage directory, a
special directory on the flash file system). This document is a reference guide to these commands.
1.1. The Process of Using File AT Commands
The following illustrates the procedure to create, read and write a file in UFS of BG96:
1. A file can be uploaded to UFS by AT+QFUPL, and can be outputted/downloaded through the serial
interfaces byAT+QFDWL.
2. Open the file by AT+QFOPEN, and then the file can be written or read at any time and any location
until the file is closed byAT+QFCLOSE.
When the file is opened by AT+QFOPEN, it can be set as overwrite mode or read-only mode or
others by the parameter <mode>. (For more information about <mode>, please refer to Chapter
2.6). After the file is opened, a <filehandle> is assigned to it. Then the file can be operated via
this <filehandle>.
After the file is opened, it can be written byAT+QFWRITE and can be read byAT+QFREAD from
the current file position.
The file position can be set by AT+QFSEEK and the current position can be queried by
AT+QFPOSITION.
AT+QFTUCAT will truncate the file from the current position to the end of the file.
3. AT+QFCLOSE is used to close the file, after which the <filehandle> becomes meaningless any more.
The following are several commonly used commands to manage files in UFS:
1. AT+QFLDS: Get the storage size
2. AT+QFLST: List the file information in UFS.
3. AT+QFDEL: Delete the file(s)

LTE Module Series
BG96 FILE AT Commands Manual
BG96_FILE_AT_Commands_Manual 6 / 22
1.2. Description of Data Mode
The COM port of BG96 module has two working modes: AT command mode and data mode. In AT
command mode, the inputted data via COM port will be treated as AT command. While in data mode, it
will be treated as data.
Inputting “+++” or pulling up DTR (AT&D1 should be set first) can make the COM port exit from data mode.
To prevent the “+++” from being misinterpreted as data, the following sequence should be followed:
1) Do not input any character within 1s or longer before inputting “+++”.
2) Input “+++” within 1s, and no other characters can be inputted during the time.
3) Do not input any character within 1s after “+++” has been inputted.
When AT+QFUPL, AT+QFDWL, AT+QFREAD and AT+QFWRITE are executed, the COM port will enter
data mode. If customers are using “+++” or DTR to make the port exit from data mode, the executing
procedure of these commands will be interrupted before the response is returned. In such case, the COM
port cannot reenter data mode by executingATO command.

LTE Module Series
BG96 FILE AT Commands Manual
BG96_FILE_AT_Commands_Manual 7 / 22
2Description of FILE AT Commands
2.1. AT+QFLDS Get the Space Information of UFS
The command responds the space information of UFS.
Parameter
AT+QFLDS Get the Space Information of UFS
Test Command
AT+QFLDS=?
Response
OK
Write Command
AT+QFLDS=<name_pattern>
Response
+QFLDS: <freesize>,<total_size>
OK
If there is any error:
+CME ERROR: <err>
Execution Command
AT+QFLDS
Response
Return the UFS information:
+QFLDS: <UFS_file_size>,<UFS_file_number>
OK
If there is any error:
+CME ERROR: <err>
<name_pattern> Storage pattern.
“UFS”UFS
<freesize> The free space size of <name_pattern>. Unit: byte.
<total_size> The total size of <name_pattern>. Unit: byte.
<UFS_file_size> The size of all files in UFS. Unit: byte
<UFS_file_number> The number of files in UFS.
<err> An error code relating to ME or network. Please refer to Chapter 4 for details.

LTE Module Series
BG96 FILE AT Commands Manual
BG96_FILE_AT_Commands_Manual 8 / 22
Example
AT+QFLDS="UFS" //Query the space information of UFS.
+QFLDS: 12987840,14483456
OK
2.2. AT+QFLST List Files
The command lists the information of a specified file or all files in UFS.
Parameter
AT+QFLST List Files
Test Command
AT+QFLST=?
Response
OK
Write Command
AT+QFLST=<name_pattern>
Response
+QFLST: <filename>,<file_size>
[+QFLST: <filename>,<file_size>
[…]]
OK
If there is any error:
+CME ERROR: <err>
Execution Command
AT+QFLST
Response
Return the information of the UFS files:
+QFLST: <filename>,<file_size>
[+QFLST: <filename>,<file_size>
[…]]
OK
If there is any error:
+CME ERROR: <err>
<name_pattern> The file to be listed.
“*”All the files in UFS.
“<filename>”A specified file <filename> in UFS.
<filename> Name of the file.
<file_size> Size of the file. Unit: byte.
<err> An error code relating to ME or network. Please refer to Chapter 4 for details.

LTE Module Series
BG96 FILE AT Commands Manual
BG96_FILE_AT_Commands_Manual 9 / 22
Example
AT+QFLST="*" //List all the file in UFS.
+QFLST: "F_M12-1.bmp",562554
+QFLST: "F_M12-10.bmp",562554
+QFLST: "F_M12-11.bmp",562554
2.3. AT+QFDEL Delete Files
The command deletes a specified file or all the files in UFS.
Parameter
<filename> Name of the file to be deleted. The maximum length of <filename> is 80 bytes.
“*”Delete all the files in UFS (not delete the directory).
“<filename>”Delete a specified file <filename> in UFS.
<err> An error code relating to ME or network. Please refer to Chapter 4 for details.
Example
AT+QFDEL="*"
OK
2.4. AT+QFUPL Upload a File
The command can be used to upload a file to UFS. If there is any file in UFS which has the same name
with the file to be uploaded, an error will be reported.
AT+QFDEL Delete Files
Test Command
AT+QFDEL=?
Response
+QFDEL: <filename>
OK
Write Command
AT+QFDEL=<filename>
Response
OK
If there is any error:
+CME ERROR: <err>

LTE Module Series
BG96 FILE AT Commands Manual
BG96_FILE_AT_Commands_Manual 10 / 22
After executing the Write Command and “CONNECT”returns, the module will switch to data mode. When
the uploaded data reaches <file_size>, or there is no any data inputted when <timeout> reaches, then it
will exit from data mode automatically. During data transmission, customers can use “+++” or DTR to
make the module exit from data mode, and more details are provided in Chapter 1.2.
Parameter
AT+QFUPL Upload a File
Test Command
AT+QFUPL=?
Response
+QFUPL: <filename>[,(1-<freesize>)[,(1-65535)[,(0,1)]]]
OK
Write Command
AT+QFUPL=<filename>[,<file_size>[,
<timeout>[,<ackmode>]]]
Response
CONNECT
TAswitches to the data mode (transparent access mode), and
the binary data of file can be inputted. When the total size of
the inputted data reaches <file_size> (unit: byte), TA will
return to command mode and reply the following codes:
+QFUPL: <upload_size>,<checksum>
OK
If there is any error:
+CME ERROR: <err>
<freesize> The free space size of <name_pattern>. Please refer to AT+QFLDS command for
more details of <name_pattern>.
<filename> Name of the file to be uploaded. The maximum length is 80 bytes.
“<filename>”Name of the file to be uploaded to UFS.
<file_size> The file size expected to be uploaded.
The default value is 10240. Unit: byte.
<upload_size> The actual size of the uploaded data. Unit: byte.
<timeout> The time waiting for data to be inputted to USB/UART. The default value is 5. Unit: s.
<ackmode> Whether to use ACK mode.
0 Turn off the ACK mode by default.
1 Turn on the ACK mode.
<checksum> The checksum of the uploaded data.
<err> An error code relating to ME or network. Please refer to Chapter 4 for details.

LTE Module Series
BG96 FILE AT Commands Manual
BG96_FILE_AT_Commands_Manual 11 / 22
1. It is strongly recommended to use DOS 8.3 file name format for <filename>.
2. <checksum> is a 16 bit checksum based on bitwise XOR.
If the number of the characters is odd, set the last character as the high 8 bit, and the low 8 bit as 0,
and then use an XOR operator to calculate the checksum. “+++” sequence will cause TA to end the
command and switch to command mode. However, the data previously uploaded will be preserved
into the file.
3. When executing the command, the data must be entered after “CONNECT”is returned.
4. The ACK mode is provided to avoid the loss of data when uploading large files, in case hardware flow
control does not work. The ACK mode works as follows:
1) RunAT+QFUPL=<filename>,<file_size>,<timeout>,1 command to enable theACK mode.
2) BG96 outputs “CONNECT”.
3) MCU sends 1K bytes data, and then BG96 will respond with an “A”.
4) MCU receives this “A”and then sends the next 1K bytes data;
5) Repeat step 3) and 4) until the transfer is completed.
2.5. AT+QFDWL Download a File
The command downloads a specified file from UFS.
Parameter
AT+QFDWL Download a File
Test Command
AT+QFDWL=?
Response
+QFDWL: <filename>
OK
Write Command
AT+QFDWL=<filename>
Response
CONNECT
TA switches to data mode, and the binary data of the file will
be outputted. When the file is read over, TA will return to
command mode and reply the following codes:
+QFDWL: <download_size>,<checksum>
OK
If there is any error:
+CME ERROR: <err>
<filename> Name of the file to be downloaded. The maximum length is 80 bytes.
NOTES

LTE Module Series
BG96 FILE AT Commands Manual
BG96_FILE_AT_Commands_Manual 12 / 22
1. “+++” sequence will cause TA to end the command and switch to command mode.
2. <checksum> is a 16 bit checksum based on bitwise XOR.
2.6. AT+QFOPEN Open a File
The command can be used to open a file and get the file handle to be used in commands such as
AT+QFREAD, AT+QFWRITE,AT+QFSEEK, AT+QFPOSITION, AT+QFTUCAT and AT+QCLOSE.
Parameter
“<filename>” Name of the UFS file to be downloaded.
<download_size> The size of the downloaded data. Unit: byte.
<checksum> The checksum of the downloaded data.
<err> An error code relating to ME or network. Please refer to Chapter 4 for details.
AT+QFOPEN Open a File
Test Command
AT+QFOPEN=?
Response
+QFOPEN: <filename>[,(0-2)]
OK
Read Command
AT+QFOPEN?
Response
+QFOPEN: <filename>,<filehandle>,<mode>
[+QFOPEN: <filename>,<filehandle>,<mode>
[…]]
OK
Write Command
AT+QFOPEN=<filename>[,<mode>]
Response
+QFOPEN: <filehandle>
OK
If there is any error:
+CME ERROR: <err>
<filename> Name of the file to be opened. The maximum length is 80 bytes.
“<filename>” Name of the UFS file to be opened.
<filehandle> The handle of the file. The data type is 4 bytes.
<mode> The open mode of the file.
0 If the file does not exist, it will be created. If the file exists, it will be directly
NOTES

LTE Module Series
BG96 FILE AT Commands Manual
BG96_FILE_AT_Commands_Manual 13 / 22
2.7. AT+QFREAD Read a File
The command reads the data of a file which is specified by the file handle. The data starts from the
current position of the file pointer which belongs to the file handle.
Parameter
2.8. AT+QFWRITE Write a File
The command is used to write data into a file. The data starts from the current position of the file pointer
which belongs to the file handle.
opened.And both of them can be read and written.
1 If the file does not exist, it will be created. If the file exists, it will be overwritten
and cleared.And both of them can be read and written.
2 If the file exists, open it and it can be read only. When the file does not exist, it
will respond an error.
<err> An error code relating to ME or network. Please refer to Chapter 4 for details.
AT+QFREAD Read a File
Test Command
AT+QFREAD=?
Response
+QFREAD: <filehandle>[,<length>]
OK
Write Command
AT+QFREAD=<filehandle>[,<length>]
Response
CONNECT <read_length>
TA switches to data mode. When the total size of the data
reaches <length> (unit: byte), TA will return to command
mode, display the result and then reply the following codes:
OK
If there is any error:
+CME ERROR: <err>
<filehandle> The handle of the file to be operated.
<length> The length of the file to be read out and the default is the file length. Unit: byte.
<read_length> The actual read length. Unit: byte.
<err> An error code relating to ME or network. Please refer to Chapter 4 for details.

LTE Module Series
BG96 FILE AT Commands Manual
BG96_FILE_AT_Commands_Manual 14 / 22
Parameter
2.9. AT+QFSEEK Set File Pointer to a Position
The command sets a file pointer to a specified position. This will decide the starting position of commands
such as AT+QFREAD, AT+QFWRITE, AT+QFPOSITION and AT+QFTUCAT.
AT+QFWRITE Write a File
Test Command
AT+QFWRITE=?
Response
+QFWRITE: <filehandle>[,<length>[,<timeout>]]
OK
Write Command
AT+QFWRITE=<filehandle>[,<length>
[,<timeout>]]
Response
CONNECT
TA switches to data mode. When the total size of the written
data reaches <length> (unit: byte) or the time reaches
<timeout>, TA will return to command mode and reply the
following codes:
+QFWRITE: <written_length>,<total_length>
OK
If there is any error:
+CME ERROR: <err>
<filehandle> The handle of the file to be operated.
<length> The length of the file to be written, and the default length is 10K. The maximum
value of this parameter is determined by <freesize> of AT+QFUPL. Unit: byte.
<timeout> The time waiting for data to be inputted to USB/UART. The default value is 5.
Unit: s.
<written_length> The actual written length. Unit: byte.
<total_length> The total length of the file. Unit: byte.
<err> An error code relating to ME or network. Please refer to Chapter 4 for details.
AT+QFSEEK Set File Pointer to a Position
Test Command
AT+QFSEEK=?
Response
+QFSEEK: <filehandle>,<offset>[,<position>]
OK

LTE Module Series
BG96 FILE AT Commands Manual
BG96_FILE_AT_Commands_Manual 15 / 22
Parameter
1. If <position> is 0 and <offset> exceeds the file size, the command will return “ERROR”.
2. If <position> is 1 and the total size of <offset> and the current position of the pointer exceed the file
size, the command will return “ERROR”.
3. If <position> is 2, the handle will move forth.
2.10. AT+QFPOSITION Get the Offset of a File Pointer
The command gets the offset of a file pointer from the beginning of the file.
Write Command
AT+QFSEEK=<filehandle>,<offset>[,<
position>]
Response
OK
If there is any error:
+CME ERROR: <err>
<filehandle> The handle of the file to be operated.
<offset> The number of bytes of the file pointer movement.
<position> Pointer movement mode.
0 The beginning of the file.
1 The current position of the pointer.
2 The end of the file.
<err> An error code relating to ME or network. Please refer to Chapter 4 for details.
AT+QFPOSITION Get the Offset of a File Pointer
Test Command
AT+QFPOSITION=?
Response
+QFPOSITION: <filehandle>
OK
Write Command
AT+QFPOSITION=<filehandle>
Response
+QFPOSITION: <offset>
OK
If there is any error:
+CME ERROR: <err>
NOTES

LTE Module Series
BG96 FILE AT Commands Manual
BG96_FILE_AT_Commands_Manual 16 / 22
Parameter
2.11. AT+QFTUCAT Truncate a File from the File Pointer
The command will truncate all the data behind the position that the file pointer indicates.
Parameter
2.12. AT+QFCLOSE Close a File
The command closes a file and ends the operation to the file. After that, the file handle is released and
should not be used again, unless open the file again withAT+QFOPEN.
<filehandle> The handle of the file to be operated.
<offset> The offset from the beginning of the file.
<err> An error code relating to ME or network. Please refer to Chapter 4 for details.
AT+QFTUCAT Truncate a File from the File Pointer
Test Command
AT+QFTUCAT=?
Response
+QFTUCAT: <filehandle>
OK
Write Command
AT+QFTUCAT=<filehandle>
Response
OK
If there is any error:
+CME ERROR: <err>
<filehandle> The handle of the file to be operated.
<err> An error code relating to ME or network. Please refer to Chapter 4 for details.
AT+QFCLOSE Close a File
Test Command
AT+QFCLOSE=?
Response
+QFCLOSE: <filehandle>
OK
Write Command
AT+QFCLOSE=<filehandle>
Response
OK

LTE Module Series
BG96 FILE AT Commands Manual
BG96_FILE_AT_Commands_Manual 17 / 22
Parameter
If there is any error:
+CME ERROR: <err>
<filehandle> The handle of the file to be operated.
<err> An error code relating to ME or network. Please refer to Chapter 4 for details.

LTE Module Series
BG96 FILE AT Commands Manual
BG96_FILE_AT_Commands_Manual 18 / 22
3Examples
3.1. Upload and Download Files
3.1.1. Upload a File
3.1.1.1. Non ACK Mode
AT+QFUPL="test1.txt",10 //Upload the text file “test1.txt” to UFS.
CONNECT
<Input file bin data>
+QFUPL: 10,3938
OK
3.1.1.2. ACK Mode
The ACK mode can make the data transmission more reliable. When transmitting a large file without
hardware flow control, theACK mode is recommended to be used to prevent the data from being lost. For
more details aboutACK mode, please refer toAT+QFUPL command.
AT+QFUPL="test.txt",3000,5,1 //Upload the text file “test.txt” to UFS.
CONNECT
<input file bin data of 1024bytes>
A//After receiving 1024 bytes data, BG96 will respond
an “A”. And then the next 1024 bytes data can be
inputted.
<input file bin data of 1024bytes>
A
<input the rest file bin data>
+QFUPL: 3000,B34A
OK

LTE Module Series
BG96 FILE AT Commands Manual
BG96_FILE_AT_Commands_Manual 19 / 22
3.1.2. Download a File
AT+QFDWL="test.txt" //Download the text file “test.txt” from UFS.
CONNECT
<Output Data>
+QFDWL: 10,613e //Get the bytes of the downloaded data and the checksum.
OK
3.2. Write and Read Files
3.2.1. Write and Read a UFS File
AT+QFOPEN="test",0 //Open the file to get the file handle.
+QFOPEN: 0
OK
AT+QFWRITE=0,10 //Write 10 bytes to the file.
CONNECT
<Write Data>
+QFWRITE: 10,10 //The actual bytes written and the size of the file are returned.
OK
AT+QFSEEK=0,0,0 //Set the file pointer to the beginning of the file.
OK
AT+QFREAD=0,10 //Read 10 bytes from the file.
CONNECT 10
<Read Data>
OK
AT+QFCLOSE=0 //Close the file.
OK