SIM800 Series_IP_Application Note_V1.02

Transcription

1 SIM800 Series_IP_Application Note_V1.02

2 Document Title SIM800 Series_IP_Application Note Version 1.02 Date Status Document Control ID Release SIM800 Series_IP_ Application Note_V1.02 General Notes SIMCom offers this information as a service to its customers, to support application and engineering efforts that use the products designed by SIMCom. The information provided is based upon requirements specifically provided to SIMCom by the customers. SIMCom 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 SIMCom 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 Shanghai SIMCom Wireless Solutions Ltd, 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 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 Shanghai SIMCom Wireless Solutions Ltd SIM800 Series_IP_Application Note_V1.02 3

3 Contents Features AT commands Examples Bearer Configure HTTP GET Method HTTP POST Method HTTP HEAD Method Set Proxy HTTP Server Set HTTP Redirection Parameter Set HTTP Download Break Point Parameter Get HTTP Current Status FTP GET Method FTP PUT Method FTP Time out FTP Error FTP Operation Error FTP READ and WRITE Error Set FTP Download Break Point Parameter FTP DELE Method FTP SIZE Method FTP MKD and RMD Method FTP LIST Session FTP Extend PUT Method FTPGETTOFS Method FTPPUTFRMFS Method FTPEXTGET Method FTPFILEPUT Method FTPQUIT Method...23 Appendix...25 A. Related Documents...25 B. Terms and Abbreviations...25 SIM800 Series_IP_Application Note_V1.02 4

4 Version History Date Version What is new Author New version Hanjun.liu Chapter 3.15, change "AT+FTPRESET=20" to "AT+FTPREST=20" 1.02 Chapter Scope, Add projects Chapter 3.14,Change 1280 to 1360 Chapter 3.21,Add example of "AT+FTPGETTOFS" Chapter 3.22,Add example of "AT+FTPPUTFRMFS" Chapter 3.23,Add example of "AT+FTPEXTGET" Chapter 3.24,Add example of "AT+FTPFILEPUT" Chapter 3.25,Add example of "AT+FTPQUIT" Hanjun.liu Hanjun.liu Hanjun.liu Hanjun.liu Hanjun.liu Hanjun.liu Hanjun.liu Hanjun.liu Scope This document presents the AT command of HTTP&FTP operation and application examples. This document can apply to SIM800 series modules, including SIM800V, SIM840V, SIM800W, SIM840W, SIM800L, SIM800H, SIM800, SIM800-WB64, SIM800G and SIM808. SIM800 Series_IP_Application Note_V1.02 5

5 1 This chapter introduces the IP application features of SIM800 series modules 1.1 Features 1) SIM800 series modules support Hyper Text Transfer Protocol application. Which provides a mode to alternate of HTTP server. The basic application contains GET, POST, HEAD methods; it also supports proxy server, redirection, broken transfer resuming functions. 2) SIM800 series modules support File Transfer Protocol application. Which provides a mode to interact with FTP server. The basic application contains GET, PUT methods, it also supports broken transfer resuming function. PUT method supports APPE, STOR and other modes. SIM800 Series_IP_Application Note_V1.02 6

6 2 AT commands Command AT+HTTPINIT AT+HTTPTERM AT+HTTPPARA AT+HTTPDATA AT+HTTPACTION AT+HTTPREAD AT+HTTPSCONT AT+HTTPSTATUS AT+FTPPORT AT+FTPMODE AT+FTPTYPE AT+FTPPUTOPT AT+FTPCID AT+FTPREST AT+FTPSERV AT+FTPUN AT+FTPPW AT+FTPGETNAME AT+FTPGETPATH AT+FTPPUTNAME AT+FTPPUTPATH AT+FTPGET AT+FTPPUT AT+FTPSCONT AT+FTPDELE AT+FTPSIZE AT+FTPSTATE AT+FTPEXTPUT AT+FTPMKD AT+FTPRMD AT+FTPLIST AT+FTPGETTOFS AT+FTPPUTFRMFS AT+FTPEXTGET Initialize HTTP service Terminate HTTP service Set HTTP parameters value Input HTTP data Http method action Read the HTTP server response Save HTTP application context Read HTTP status Set FTP control port Set active or passive FTP mode Set the type of data to be transferred Set FTP put type Set FTP bearer profile identifier Set resume broken download Set FTP server address Set FTP user name Set FTP password Set download file name Set download file path Set upload file name Set upload file path Download file Set upload file Save FTP application context Delete specified file in FTP server Get the size of specified file in FTP server Get the FTP state Extend upload file Make directory on the remote machine Remove directory on the remote machine List contents of directory on the remote machine Download file and save in file system Upload file from file system Extend download file SIM800 Series_IP_Application Note_V1.02 7

7 AT+FTPFILEPUT AT+FTPQUIT Load file in RAM from file system then upload with FTPPUT Quit current FTP session SIM800 Series_IP_Application Note_V1.02 8

8 3 Examples In the columns of following tables, input of AT commands are in black, module return values are in blue Bearer Configure AT+SAPBR=3,1,"Contype", "GPRS" AT+SAPBR=3,1,"APN","CMNET" AT+SAPBR=1,1 AT+SAPBR=2,1 +SAPBR:1,1, Configure bearer profile 1 To open a GPRS context. To query the GPRS context. AT+SAPBR=0,1 To close a GPRS context HTTP GET Method Download data from HTTP server. AT+HTTPINIT AT+HTTPPARA="CID",1 AT+HTTPPARA="URL"," AT+HTTPACTION=0 +HTTPACTION: 0,200,1000 AT+HTTPREAD +HTTPREAD: AT+HTTPTERM Init HTTP service Set parameters for HTTP session GET session start GET successfully Read the data of HTTP server Terminate HTTP service SIM800 Series_IP_Application Note_V1.02 9

9 3.3. HTTP POST Method Upload data to HTTP server. AT+HTTPINIT AT+HTTPPARA="CID",1 AT+HTTPPARA="URL"," AT+HTTPDATA=100,10000 DOWNLOAD AT+HTTPACTION=1 +HTTPACTION: 1,200,0 AT+HTTPTERM Init HTTP service Set parameters for HTTP session POST the data whose size is 100 Bytes and the maximum latency time for inputting is ms. It is recommended to set the latency time long enough to allow downloading all the data. It is ready to receive data from UART, and DCD has been set to low. All data has been received over, and DCD is set to high. POST session start POST successfully Terminate HTTP service 3.4. HTTP HEAD Method Get HTTP head information from HTTP server. AT+HTTPINIT AT+HTTPPARA="CID",1 AT+HTTPPARA="URL"," AT+HTTPACTION=2 +HTTPACTION: 2,200,0 Init HTTP service Set parameters for HTTP session HEAD session start HEAD successfully AT+HTTPTERM Terminate HTTP service SIM800 Series_IP_Application Note_V

10 3.5. Set Proxy HTTP Server It provides the method to use proxy HTTP server. AT+HTTPINIT AT+HTTPPARA="CID",1 AT+HTTPPARA="URL"," AT+HTTPPARA="PROIP"," " AT+HTTPPARA="PROPORT",80 AT+HTTPACTION=0 +HTTPACTION: 0,200,1000 AT+HTTPREAD +HTTPREAD: AT+HTTPTERM Init HTTP service Set parameters for HTTP session Set proxy server IP address Set proxy server port GET session start GET successfully Read the data of HTTP server. Output the data to UART Terminate HTTP service 3.6. Set HTTP Redirection Parameter It provides the method to use HTTP redirection function. AT+HTTPINIT AT+HTTPPARA="CID",1 AT+HTTPPARA="REDIR",1 AT+HTTPPARA="URL"," bcde" AT+HTTPACTION=0 +HTTPACTION: 0,200,1000 Init HTTP service Set parameters for HTTP session Set the redirection parameter Set the URL GET session start GET successfully SIM800 Series_IP_Application Note_V

11 AT+HTTPREAD +HTTPREAD: AT+HTTPTERM Read the response of HTTP server Output the data to UART Terminate HTTP service 3.7. Set HTTP Download Break Point Parameter It provides the method to use HTTP broken download resuming function. AT+HTTPINIT AT+HTTPPARA="CID",1 AT+HTTPPARA="URL"," m.com/img/sim_logo_jr_1003_38.gif" AT+HTTPPARA="BREAK",2000 AT+HTTPACTION=0 +HTTPACTION: 0, 200,14384 AT+HTTPREAD +HTTPREAD: AT+HTTPTERM Init HTTP service Set parameters for HTTP session Set the URL, the size of gif is bytes Set the break point GET session start, get data from 2000 to GET successfully Read the data of HTTP server Output the data to UART Terminate HTTP service 3.8. Get HTTP Current Status AT+HTTPINIT AT+HTTPPARA="CID",1 AT+HTTPPARA="URL"," " Init HTTP service Set parameters for HTTP session Set the URL SIM800 Series_IP_Application Note_V

12 AT+HTTPACTION=0 AT+HTTPSTATUS? +HTTPSTATUS: GET,1,1440,7915 Get session start The status of getting session is in progress +HTTPACTION: 0, 200,9335 AT+HTTPSTATUS? +HTTPSTATUS: GET,0,0,0 GET successfully The status of getting session is over AT+HTTPACTION=1 AT+HTTPSTATUS? +HTTPSTATUS: POST,2,1440,608 POST session start The status of posting session is in progress +HTTPACTION: 1,200,0 AT+HTTPSTATUS? +HTTPSTATUS: POST,0,0,0 POST successfully The status of posting session is over AT+HTTPTERM Terminate HTTP service 3.9. FTP GET Method Download data from FTP server AT+FTPCID=1 AT+FTPSERV=" " AT+FTPUN="sim.cs1" AT+FTPPW="******" AT+FTPGETNAME="1K.txt" AT+FTPGETPATH="/" AT+FTPGET=1 Set parameters for FTP session. Open the FTP get session. SIM800 Series_IP_Application Note_V

13 +FTPGET: 1,1 AT+FTPGET=2,1024 +FTPGET: 2, AT+FTPGET=2,1024 +FTPGET: 2,0 +FTPGET: 1,1 AT+FTPGET=2,1024 +FTPGET: 2, FTPGET:1,0 Data are available. Request to read 1024 bytes, but Only 50 bytes are now available. Request to read 1024 bytes again. No byte is now available, but it is not the end of session. If the module receives data but user do not input "AT+FTPGET:2, <reqlength>" to read data, "+FTPGE T:1,1" will be shown again in a certain time. Request to read 1024 bytes bytes are now available. Data transfer finished. The connection to the FTP server is closed FTP PUT Method Upload data to FTP server. AT+FTPCID=1 AT+FTPSERV=" " AT+FTPUN="sim.cs1" AT+FTPPW="******" AT+FTPPUTNAME="1K.txt" AT+FTPPUTPATH="/" AT+FTPPUT=1 +FTPPUT: 1,1,1360 Set parameters for FTP session. Open the FTP put session. FTP session is ready for uploading is the max length of data which can be sent at a time. It depends on the network status. SIM800 Series_IP_Application Note_V

14 AT+FTPPUT=2,100 +FTPPUT: 2,100 +FTPPUT: 1,1,1360 AT+FTPPUT=2,0 +FTPPUT: 1,0 Client requests to send 100 bytes. Response indicates that user must input 100 bytes for transferring now. It is ready to receive data from UART, and DCD has been set to low. All data has been received over, and DCD is set to high. URC indicates that the FTP session is ready to transfer more data. No more data will be uploaded, the FTP session will be closed. Data transfer is finished. The connection to the FTP server is closed. During FTP session, different failure may occur because of bad network environment or other reasons. Some common failure includes timeout failure and wrong password failure FTP Time out Time out occurs during FTP session because of different reasons. AT+FTPGET=1 +FTPGET: 1,64 Open the FTP Get session. If the status of the network is poor, it may be time out. The connection to the FTP server is closed. AT+FTPGET=1 +FTPGET: 1,1 +FTPGET: 1,1.. +FTPGET: 1,1 +FTPGET: 1,64 Open the FTP Get session. Data are available. If customer does not use "AT+FTPGET:2, <reqlength>" to read data, "+FTPGE T:1,1" will be shown again in a certain time. If the user does not read data for a long time, the session will time out. The connection to the FTP server is closed FTP Error Error occurs during FTP applications because of wrong parameter setting. SIM800 Series_IP_Application Note_V

15 AT+FTPPW=" " Set wrong password AT+FTPGET=1 Open the FTP Get session +FTPGET: 1,72 FTP session password error. The connection to the FTP server is closed. Note: Other errors, you can refer to AT+FTPGET command in SIM800 Series AT Command Manual FTP Operation Error Error occurs during FTP applications because of wrong operating. AT+FTPGET=1 +FTPGET: 1,64 AT+FTPPUT=1 AT+FTPPUT=1 Open the FTP Get session. The parameter of "get file name" is empty. It shows ftp operation error. Open the FTP PUT session. Open the FTP PUT session again. Show ftp operation error. +FTPPUT: 1, FTP READ and WRITE Error Error occurs before FTP applications because of operating in wrong state. AT+FTPGET=1 AT+FTPGET=2,1000 ERROR +FTPGET: 1,1 AT+FTPGET=2,1000 +FTPGET: 2, FTPGET: 1,0 AT+FTPGET=2,1000 ERROR Open the FTP Get session. Read data before "+FTPGET:1,1" is shown. Data are available Read data after "+FTPGET: 1,1" is shown. Data transfer finished. The connection to the FTP server is closed. Read data after FTP session is stopped. SIM800 Series_IP_Application Note_V

16 AT+FTPPUT=1 AT+FTPPUT=2,1000 ERROR +FTPPUT: 1,1,1360 AT+FTPPUT=2,100 +FTPPUT: 2,100 AT+FTPPUT=2,0 AT+FTPPUT=2,100 ERROR Open the FTP PUT session. Write data before "+FTPPUT: 1,1,1360" is shown. FTP session is ready for uploading. Write data after "+FTPPUT: 1,1,1360" is shown. No more data will be uploaded, the FTP session will be closed. Write data after FTP session is stopped Set FTP Download Break Point Parameter It provides the method to use FTP broken download resuming function. AT+FTPGET=1 +FTPGET: 1,1 AT+FTPGET=2,1024 +FTPGET: 2,29 wodeceshijieguo,zhgeshigeshia +FTPGET: 1,0 AT+FTPREST=20 AT+FTPGET=1 +FTPGET: 1,1 AT+FTPGET=2,1024 +FTPGET: 2,9 shigeshia +FTPGET: 1,0 Open the FTP Get session. Data are available. Get data of FTP server. Data transfer finished. The connection to the FTP server is closed. Set the broken point. Open the FTP Get session. Data are available. Get the data begin from the broken point. Data transfer is finished. The connection to the FTP server is closed FTP DELE Method Delete the specified file in FTP server. SIM800 Series_IP_Application Note_V

17 AT+FTPCID=1 AT+FTPSERV=" " AT+FTPUN="sim.cs1" AT+FTPPW="******" AT+FTPGETNAME="1K.txt" AT+FTPGETPATH="/" AT+FTPDELE +FTPDELE: 1,0 Set parameters for FTP session. Open the FTP DELE session. Delete file finished. The connection to the FTP server is closed FTP SIZE Method Get the size of specified file in FTP server. AT+FTPCID=1 AT+FTPSERV=" " AT+FTPUN="sim.cs1" AT+FTPPW="******" AT+FTPGETNAME="1K.txt" AT+FTPGETPATH="/" AT+FTPSIZE +FTPSIZE: 1,0,1024 Set parameters for FTP session. Open the FTP SIZE session. Get the size of file finished. The connection to the FTP server is closed FTP MKD and RMD Method Make and remove directory on the remote machine. SIM800 Series_IP_Application Note_V

18 AT+FTPCID=1 AT+FTPSERV=" " AT+FTPUN="sim.cs1" AT+FTPPW="******" AT+FTPGETPATH="/test" AT+FTPMKD +FTPMKD: 1,0 AT+FTPRMD +FTPRMD: 1,0 Set parameters for FTP session. Open the FTP session. The directory "test" is made on the remote machine Open the FTP session The directory "test" is removed from the remote machine FTP LIST Session List contents of remote directory. AT+FTPCID=1 AT+FTPSERV=" " AT+FTPUN="sim.cs1" AT+FTPPW="******" AT+FTPGETNAME="1K.txt" AT+FTPGETPATH="/" AT+FTPLIST=1 +FTPLIST: 1,1 Set parameters for FTP session. Open the FTP session. Data are available SIM800 Series_IP_Application Note_V

19 AT+FTPLIST=2,1024 +FTPLIST: 2,126 total 0 drw-rw-rw- 1 user group 0 Oct 12 14:58. drw-rw-rw- 1 user group 0 Oct 12 14:58 Request to read 1024 bytes, but only 126 bytes are now available +FTPLIST: 1,0 Data transfer finished. The connection to the remote machine is closed FTP Extend PUT Method Extend Upload data to the remote machine. AT+FTPCID=1 AT+FTPSERV=" " AT+FTPUN="sim.cs1" AT+FTPPW="******" AT+FTPPUTNAME="1K.txt" AT+FTPPUTPATH="/" AT+FTPEXTPUT=1 AT+FTPEXTPUT=2,0,1024, FTPEXTPUT: 0,1024 AT+FTPPUT=1 +FTPPUT: 1,0 Set parameters for FTP session. Open the FTP session. Client requests to send 1024 bytes. Response indicates that user must input 1024 bytes for transferring. It is saved in the module. It is ready to receive data from UART, and DCD has been set to low. All data has been received over, and DCD is set to high. Open the FTP PUT session. Waiting for the module to upload the data to the remote machine. Data transfer finished. The connection to the remote machine is closed SIM800 Series_IP_Application Note_V

20 AT+FTPEXTPUT=0 Set FTP to normal put method FTPGETTOFS Method Download file and save in file system. AT+FTPCID=1 AT+FTPSERV=" " AT+FTPUN="sim.cs1" AT+FTPPW="******" AT+FTPGETNAME="test.txt" AT+FTPGETPATH="/" AT+FTPGETTOFS=0,"test.txt" AT+FTPGETTOFS? +FTPGETTOFS: 1,174125, FTPGETTOFS: 0, Set parameters for FTP session. Open the FTP session. Query progress of FTP session FTP session running, bytes data has been download, bytes data has been saved in file system. File download succeed. Use file system commands to read or write file FTPPUTFRMFS Method Upload file from file system SIM800 Series_IP_Application Note_V

21 AT+FTPCID=1 AT+FTPSERV=" " AT+FTPUN="sim.cs1" AT+FTPPW="******" AT+FTPPUTNAME="test.txt" AT+FTPPUTPATH="/" AT+FTPPUTFRMFS="c:\user\ftp\test.txt" AT+FTPPUTFRMFS? +FTPPUTFRMFS: 1, FTPPUTFRMFS: 0, Set parameters for FTP session. Open the FTP session. Query progress of FTP session FTP session running, bytes data has been upload. File upload succeed. Total bytes data has been upload FTPEXTGET Method Extend Download File AT+FTPCID=1 AT+FTPSERV=" " AT+FTPUN="sim.cs1" AT+FTPPW="******" AT+FTPGETNAME="test.txt" AT+FTPGETPATH="/" AT+FTPEXTGET=1 AT+FTPEXTGET? +FTPEXTGET: 1,64136 Set parameters for FTP session. Open the FTP session. Query progress of FTP session FTP session running, bytes data has been download. SIM800 Series_IP_Application Note_V

22 +FTPEXTGET: 1,0 AT+FTPEXTGET=2,"test.txt" +FTPEXTGET: 2, File download succeed. Save download data to "c:\user\ftp\test.txt" Save success, bytes saved AT+FTPEXTGET=3,0, FTPEXTGET: 3, AT+FTPEXTGET=0 Output receive data from position 0, length Output data Finish output End FTPEXTGET FTPFILEPUT Method Load file in RAM from file system then upload with FTPPUT AT+FTPCID=1 AT+FTPSERV=" " AT+FTPUN="sim.cs1" AT+FTPPW="******" AT+FTPPUTNAME="test.txt" AT+FTPPUTPATH="/" AT+FTPFILEPUT=1,"c:\user\ftp\test.txt" AT+FTPPUT=1 +FTPPUT: 1,0 AT+FTPFILEPUT=0 Set parameters for FTP session. Load file to RAM Start FTP session File upload succeed. End FTPFILEPUT FTPQUIT Method Quit current FTP session SIM800 Series_IP_Application Note_V

23 AT+FTPCID=1 AT+FTPSERV=" " AT+FTPUN="sim.cs1" AT+FTPPW="******" AT+FTPGETNAME="1K.txt" AT+FTPGETPATH="/" AT+FTPGET=1 AT+FTPQUIT +FTPGET: 1,86 Set parameters for FTP session. Open the FTP session. Quit FTP session Manual quit FTP session SIM800 Series_IP_Application Note_V

24 Appendix A. Related Documents SN Document name Remark [1] SIM800 Series_AT Command Manual B. Terms and Abbreviations Abbreviation FTP File Transfer Protocol HTTP Hypertext Transfer Protocol APN Access Point Name GPRS General Packet Radio Service PDP Packet Data Protocol SIM800 Series_IP_Application Note_V

25 Contact us: Shanghai SIMCom Wireless Solutions Co.,Ltd. Address: Building A, SIM Technology Building, No. 633, Jinzhong Road, Shanghai, P. R. China Tel: Fax: URL: SIM800 Series_IP_Application Note_V