Quectel BG96 At Command Manual

Quectel BG96 At Command Manual

Lte module
Hide thumbs Also See for BG96:

Advertisement

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

Advertisement

Table of Contents
loading

Summary of Contents for Quectel BG96

  • Page 1 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...
  • Page 2 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.
  • Page 3: About The Document

    LTE Module Series BG96 FILE AT Commands Manual About the Document History Revision Date Author Description Matt YE/ 2018-01-24 Initial Kennen WU BG96_FILE_AT_Commands_Manual 2 / 22...
  • Page 4: Table Of Contents

    LTE Module Series BG96 FILE AT Commands Manual Contents About the Document ........................... 2 Contents ............................... 3 Table Index ..............................4 Introduction ............................5 1.1. The Process of Using File AT Commands ................5 1.2. Description of Data Mode ......................6 Description of FILE AT Commands ....................
  • Page 5 LTE Module Series BG96 FILE AT Commands Manual Table Index TABLE 1: SUMMARY OF ERROR CODES ...................... 20 TABLE 2: TERMS AND ABBREVIATIONS ......................22 BG96_FILE_AT_Commands_Manual 4 / 22...
  • Page 6: Introduction

    BG96 FILE AT Commands Manual Introduction 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...
  • Page 7: Description Of Data Mode

    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.
  • Page 8: Description Of File At Commands

    LTE Module Series BG96 FILE AT Commands Manual Description of FILE AT Commands 2.1. AT+QFLDS Get the Space Information of UFS The command responds the space information of UFS. AT+QFLDS Get the Space Information of UFS Test Command Response AT+QFLDS=?
  • Page 9: At+Qflst List Files

    LTE Module Series BG96 FILE AT Commands Manual Example AT+QFLDS="UFS" //Query the space information of UFS. +QFLDS: 12987840,14483456 2.2. AT+QFLST List Files The command lists the information of a specified file or all files in UFS. AT+QFLST List Files Test Command...
  • Page 10: At+Qfdel Delete Files

    LTE Module Series BG96 FILE AT Commands Manual 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. AT+QFDEL Delete Files...
  • Page 11 LTE Module Series BG96 FILE AT Commands Manual 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.
  • Page 12: At+Qfdwl Download A File

    Run AT+QFUPL=<filename>,<file_size>,<timeout>,1 command to enable the ACK mode. BG96 outputs “CONNECT”. MCU sends 1K bytes data, and then BG96 will respond with an “A”. MCU receives this “A” and then sends the next 1K bytes data; Repeat step 3) and 4) until the transfer is completed.
  • Page 13: At+Qfopen Open A File

    LTE Module Series BG96 FILE AT Commands Manual “<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.
  • Page 14: At+Qfread Read A File

    LTE Module Series BG96 FILE AT Commands Manual opened. And both of them can be read and written. 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.
  • Page 15: At+Qfseek Set File Pointer To A Position

    LTE Module Series BG96 FILE AT Commands Manual AT+QFWRITE Write a File Test Command Response AT+QFWRITE=? +QFWRITE: <filehandle>[,<length>[,<timeout>]] Write Command Response AT+QFWRITE=<filehandle>[,<length> CONNECT TA switches to data mode. When the total size of the written [,<timeout>]] data reaches <length> (unit: byte) or the time reaches <timeout>, TA will return to command mode and reply the...
  • Page 16: At+Qfposition Get The Offset Of A File Pointer

    LTE Module Series BG96 FILE AT Commands Manual Write Command Response AT+QFSEEK=<filehandle>,<offset>[,< position>] If there is any error: +CME ERROR: <err> Parameter <filehandle> The handle of the file to be operated. <offset> The number of bytes of the file pointer movement.
  • Page 17: At+Qftucat Truncate A File From The File Pointer

    LTE Module Series BG96 FILE AT Commands Manual Parameter <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.
  • Page 18 LTE Module Series BG96 FILE AT Commands Manual If there is any error: +CME ERROR: <err> Parameter <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.
  • Page 19: Examples

    //Upload the text file “test.txt” to UFS. AT+QFUPL="test.txt",3000,5,1 CONNECT <input file bin data of 1024bytes> //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>...
  • Page 20: Download A File

    LTE Module Series BG96 FILE AT Commands Manual 3.1.2. Download a File //Download the text file “test.txt” from UFS. AT+QFDWL="test.txt" CONNECT <Output Data> +QFDWL: 10,613e //Get the bytes of the downloaded data and the checksum. 3.2. Write and Read Files 3.2.1.
  • Page 21: Summary Of Error Codes

    Summary of ERROR Codes The error code <err> indicates an error related to mobile equipment or network. The details about <err> are described in the following table, and these error codes are only related to file operation of BG96 module.
  • Page 22 LTE Module Series BG96 FILE AT Commands Manual No space Time out File too large Invalid parameter File already opened BG96_FILE_AT_Commands_Manual 21 / 22...
  • Page 23: Appendix A Reference

    LTE Module Series BG96 FILE AT Commands Manual Appendix A Reference Table 2: Terms and Abbreviations Abbreviation Description Communication Port Disk Operating System Mobile Equipment Terminal Adapter UART Universal Asynchronous Receiver-Transmitter User File Storage Universal Serial Bus BG96_FILE_AT_Commands_Manual 22 / 22...

Table of Contents