DC3500 Extended AT Commands Manual 500243R02

DC3500 GSM / GPRS Module

Extended AT Commands Manual
R02 10-Nov-09

DC3500 Extended AT Commands Manual 500243R02

Revision History
Rev 01 02 Date 30-Oct-09 10-Nov-09 Originator Yingsi Yingsi Description Initial Release based on Rev 0.3 Amended Section 2.8: AT+XISR Command Syntax

Confidential

DAVISCOMMS (S) PTE LTD

2 /14

DC3500 Extended AT Commands Manual 500243R02

Table of Contents
1. 2. 2.1. 2.2. 2.3. 2.4. 2.5. 2.6. 2.7. 2.8. 2.9. 3. 3.1. 3.2. 3.3. 3.4. Introduction ............................................................................................ 4 TCPIP Extension.................................................................................... 4 Overview ................................................................................................ 4 AT+XISP ................................................................................................ 6 AT+XIIC.................................................................................................. 7 AT+XISS ................................................................................................ 8 AT+XISD ................................................................................................ 9 AT+XISO .............................................................................................. 10 AT+XISC .............................................................................................. 10 AT+XISR .............................................................................................. 11 AT+XISW ............................................................................................. 12 Control Extension................................................................................. 13 Overview .............................................................................................. 13 AT+ZGPIO ........................................................................................... 13 AT+ZCTRL ........................................................................................... 14 AT+ZIDLE ............................................................................................ 14

Confidential

DAVISCOMMS (S) PTE LTD

3 /14

DC3500 Extended AT Commands Manual 500243R02

1.

Introduction

This document describes the extended AT commands available at DC3500 Series GSM/GPRS module series. It includes the TCPIP extension as well as some specially defined AT commands for control applications.

2.
2.1.

TCPIP Extension
Overview

DC3500 modem module implements an embedded TCP/IP stack. This stack can be directly driven by AT commands from the terminal equipment. Two options are provided for the Internet access via GPRS, over PPP or TCP/IP. Host application can choose one of them to activate the corresponding protocol. There are 8 new AT commands used for TCP/IP features: ----------------------------------------------------XIIC: Internet Connect --------------------------------------------------AT+XIIC=1 Trigger the Internet connection. AT+XIIC=? Show the available choice of the parameter, currently only 1. AT+XIIC? Show the current status of the Internet connection. ----------------------------------------------------XISP: Internet Service Protocol Select --------------------------------------------------AT+XISP Select the protocol type used to access the Internet, one is the embedded TCP/IP protocol stack, the other is PPP connection. AT+XISP=? Show the available choice of the protocols, currently (0-1). AT+XISP? Show the current choice of the Internet protocol. ----------------------------------------------------XISS: Internet Service Profiles Setup --------------------------------------------------AT+XISS Set up Internet service profiles. AT+XISS? Show the current settings of all the service profiles. ----------------------------------------------------XISD: Internet Service Profiles Delete --------------------------------------------------AT+XISD Delete service profile which is defined but not being used. ----------------------------------------------------XISO: Internet Service Open --------------------------------------------------AT+XISO Open defined service profile when there is no other connection. AT+XISO=? Show the available choices of XISO command, currently return (0-11). AT+XISO? Show the current status of all the service profiles. ----------------------------------------------------XISC: Internet Service Close --------------------------------------------------AT+XISC Close the specified Internet connection. AT+XISC=? Show the format and available parameters of this command. ----------------------------------------------------XISR: Read data from the Internet --------------------------------------------------AT+XISR Read data from the recv buffer, the data will be part of the command response. AT+XISR=? Show the format and available parameters of this command. AT+XISR? Show the remaining data size in the receive buffer of the specified connection. ---------------------------------------------------

Confidential

DAVISCOMMS (S) PTE LTD

4 /14

DC3500 Extended AT Commands Manual 500243R02

--XISW: Write data to the Internet --------------------------------------------------AT+XISW Write data to the write buffer, the data is part of the command. AT+XISW=? Show the format and available parameters of this command. AT+XISW? Show the remaining buffer length that can be written to. Here briefs the AT command sequence to configure and to use a TCP/IP connection: First of all, select and register the GPRS network operator with AT+COPS=0. Define the PDP context used for GPRS connection, with AT+CGDCONT. For the use of AT+COPS and AT+CGDCONT, refer to AT Command Descriptions. Select TCP/IP as the protocol for Internet connection, with AT+XISP=0. Trigger the Internet connection with AT+XIIC=1. Create an Internet service profile with AT+XISS, this profile contains information needed to establish the Internet connection. The defined service profile can be deleted with AT+XISD. Once the Internet service profile are created, an Internet session can be opened by AT+XISO. After the Internet session is opened, the user can read data from the Internet with AT+XISR or write data to the Internet with AT+XISW. Finally, to end a session, use AT+XISC command.

Confidential

DAVISCOMMS (S) PTE LTD

5 /14

DC3500 Extended AT Commands Manual 500243R02

2.2.
2.2.1.

AT+XISP
Set Command

The AT+XISP set-command selects the protocol type used to access the Internet. Currently we have two ways to access Internet, one is through the embedded TCP/IP protocol stack, the other is through Dial-up connection using PPP protocol. Syntax: AT+XISP=<Prot> <Prot>=0 (default) means to select the embedded TCP/IP protocol stack. Only after this command, the following AT commands become available: AT+XIIC, AT+XISO, AT+XISC, AT+XISR, AT+XISW. <Prot>=1 means to select PPP protocol. After this command, the following AT commands become unavailable: AT+XIIC, AT+XISO, AT+XISC, AT+XISR, AT+XISW. AT+XISP=0 OK

2.2.2.

Query Command

The AT+XISP? query-command returns the current selection of the Internet accessing protocols. The return value 0 means currently selected TCP/IP stack, while 1 means PPP connection. AT+XISP? +XISP: 0 OK

2.2.3.

Test Command

The AT+XISP=? test-command returns the available choices of the protocols. AT+XISP=? +XISP: (0-1) OK

Confidential

DAVISCOMMS (S) PTE LTD

6 /14

DC3500 Extended AT Commands Manual 500243R02

2.3.
2.3.1.

AT+XIIC
Set Command

The AT+XIIC set-command triggers the Internet connection. Only after this command, the XISO (service open) command becomes available. Syntax: AT+XIIC=1 AT+XIIC=1 OK

2.3.2.

Query Command

The AT+XIIC query-command shows the current status of the Internet connection. Response 1 means connected while 0 means disconnected. The assigned modems IP address is returned if connected. AT+XIIC? +XIIC: 1, 10.13.117.121 OK

2.3.3.

Test Command

The AT+XIIC query-command shows the available choice of the prarameter, currently only 1. AT+XIIC=? +XIIC: 1 OK

Confidential

DAVISCOMMS (S) PTE LTD

7 /14

DC3500 Extended AT Commands Manual 500243R02

2.4.
2.4.1.

AT+XISS
Set Command

The AT+XISS set-command creates and defines an Internet service profile. When the user wants to establish an Internet connection, he must provide several parameters first. So this command is used to define these parameters in a profile. The parameters in the profile depend on the connection type. Different types of connection need different parameters. Currently we support 12 different service profiles at one time: 3 HTTP profiles, 6 SOCKET profiles, 1 FTP profile, 1 SMTP profile and 1 POP3 profile. 3.4.1.1 HTTP profile setup Syntax: AT+XISS=<conId>,<servType>,<ipAddr>,<hcMethod>(,<user>,<password>, <hcContent>,<hcContLen>,<hcUserAgent>,<hcProp>,<hcRedir>,<hcAuth>) Mandatary parameter, numeric value. Indicates which service profile you are creating. As we have 12 profiles that can be set up, the conId is the index of the specified profile, ranging from 0 to 11. <servType> Mandatary parameter, string value. Indicates the type of the service profile. All the following parameters depend on this value. Here for HTTP connection, it should be HTTP. <ipAddr> Mandatary parameter, string value. Provides the URL of the destination. The format is http://'server'/'path':'tcpPort'. Refer to RFC2616 for detailed descriptions. Example: http://www.Infineon.com/product/index.html:80. <hcMethod> Mandatary parameter, string value. HTTP method specification. It is a string value, and can be GET, POST or HEAD. <user> Optional parameter, string value. It is a string value to indicate the user ID. This parameter is used for HTTP authentication. <password> Optional parameter, string value. It is a string value to indicate the password. This parameter is used for HTTP authentication. <hcUserAgent> Optional parameter, string value. It is a string value used to identify the mobile. Usually operation system and software version info is set with this browser identifier. Example: Mozilla/4.04[en](Win95;I;Nav) <hcProp> Optional parameter, string value. It is a string value used to define parameters of several HTTP parameters. The general format is 'key': <space> 'value' "\0d\0a". Multiple settings can be given separated by "\0d\0a" sequences within the string. Possible 'key' values are defined at HTTP/1.1 Standard RFC 2616. Example: Accept-Encoding: gzip, deflate\r\nAccept-Language: en-us\r\n <hcContLen> Mandatory parameter for HTTP method "POST", numeric value. The content length shall be set in the header of the HTTP "POST" request before the data part is transferred. If <hcContLen>=0 then the data given in the "hcContent" string will be posted. If <hcContLen>>0 then the AT+XISW command will be used to send data from the client to the server. In this case, "hcContLen" specifies the total amount of data to be sent. <hcContent> Optional parameter for HTTP method "POST", string value. It can be used to transfer a small amount of data. The content of this string will only be sent if <hcContent>=0. The maximum length of "hcContent" is 256 bytes. To transmit a larger amount of data "hcContLen" must be set to a non-zero value. In this case the "hcContent" string will be ignored, and data transmission from the client to the server is done with AT+XISW. <hcRedir> Optional parameter, numeric value. This flag controls the redirection mechanism of the EGV modem acting as HTTP client (numeric). If <hcRedir>=1, the client automatically sends a new HTTP request if the <conId>

Confidential

DAVISCOMMS (S) PTE LTD

8 /14

DC3500 Extended AT Commands Manual 500243R02

<hcAuth>

server answers with a redirect code (range 30x). If <hcRedir>=0 (default), there will be no redirection. Optional parameter, numeric value. If <hcAuth>=1, this flag determines that the HTTP client will automatically answer on authentication requests from the server with the current "passwd" and "user" parameter settings. If these parameters are not specified, the modem will terminate the HTTP connection and send an indication to the TE. If <hcAuth>=0 (default), there will be no authentication. Currently we do not support HTTP authentication.

The first 4 parameters are mandatory for HTTP connection, and MUST be set in this AT+XISS command. The following 8 parameters are optional; the user can define any of these 8 parameters, or just ignore them. Annex I shows several examples of defining HTTP profile. 3.4.1.2 SOCKET profile setup Syntax: AT+XISS=<conId>,<servType>,<ipAddr> <conId> <servType> <ipAddr> Mandatary parameter, numeric value. Indicates which service profile you are creating. As we have 12 profiles that can be set up, the conId is the index of the specified profile, ranging from 0 to 11. Mandatary parameter, string value. Indicates the type of the service profile. All the following parameters depend on this value. Here for HTTP connection, it should be SOCKET. Mandatary parameter, string value.

There are 3 different kinds of socket service: TCP client, TCP server(listener) and UDP client. For TCP client, the format of is: socktcp://host:remote port Example: socktcp://172.17.127.34:4040. For TCP server, the format of is: socktcp://listener:local port Example: socktcp://listener:6060. For UDP client, the format of is: sockudp://host:remote port[;port='local port'] Example: sockudp://172.17.127.34:4040 or sockudp://172.17.127.34:4040;port=6060.

2.4.2.

Query Command

The AT+XISS query-command displays the current settings of all the 12 service profiles. For example, the 3rd service profile is defined to HTTP, and other profiles are not defined, the response is as follow: AT+XISS? +XISS: 0 OK

2.5.
2.5.1.

AT+XISD
Set Command

The AT+XISD set-command is used to delete service profile which is defined but not being used. Syntax: AT+XISD=<conId> <conId> ranges from 0 to 11, which indicates the service profile to be deleted. AT+XISD=4 OK

Confidential

DAVISCOMMS (S) PTE LTD

9 /14

DC3500 Extended AT Commands Manual 500243R02

2.6.
2.6.1.

AT+XISO
Set Command

The AT+XISO set-command starts the Internet session configured by the service profile. Syntax: AT+XISO=<conId> <conId> is a numeric value which indicates the service to be opened.If this service profile has not been defined before, this will return error. If there is other Internet session opened at the moment, this service could not be opened. AT+XISO=3 OK

2.6.2.

Query Command

The AT+XISO? query-command shows the the current status of all the service profiles. AT+XISO? +XISO: 0 OK

2.6.3.

Test Command

The AT+XISO=? test-command shows the available choices of XISO command, currently return (0-11). AT+XISO=? +XISO: (0-11) OK

2.7.
2.7.1.

AT+XISC
Set Command

The AT+XISC set-command closes the specified Internet connection. Syntax: AT+XISC=<conId>(,<closeMode>) <conId> Mandatary parameter. Indicates which service profile you are closing, ranging from 0 to 11. <closeMode> Optional parameter. Specifies the mode to close an Internet connection. The effect of the selected mode varies depending on the type of service. <closeMode>=0 means gracefully closing (default). <closeMode>=1 means immediate closing. For HTTP connections, there is no difference between the 2 close modes. AT+XISC=3,1 OK

2.7.2.

Test Command

The AT+XISC=? test-command shows the format and available parameters of this command. AT+XISC=(0-11),(0-1) OK

Confidential

DAVISCOMMS (S) PTE LTD

10 /14

DC3500 Extended AT Commands Manual 500243R02

2.8.
2.8.1.

AT+XISR
Set Command

The AT+XISR set-command reads data from the receive buffer, the data will be part of the command response. Syntax: AT+XISR=<conId>,<reqReadLen>,<encoded_type>* <conId> Mandatary parameter. Indicates which service profile you are closing, ranging from 0 to 11. <reqReadLen> Mandatary parameter. Requested number of data bytes to be read via the Internet service. Currently the maximum value is 1024. <encoded_type>* - 0 (Default): means Direct Data Output No Data Conversion. (Direct Output) - 1: means Data Converted by HEX-to-ASCII Before Output to UART (ASCIIConverted Output) Response syntax: +XISR: <conId> <cnfReadLen> <remainingDataLen> \n <DATA> <cnfReadLen> Confirms the length of data to be read. <remainingDataLen> Indicates the length of data remaining in the recv buffer after reading. Data received from the Internet is automatically stored in the recv buffer by TCP/IP stack. If the data in the recv buffer is less than <reqReadLen>, the response will contain all these data and <cnfReadLen> will be the data length, while <remainingDataLen> will be 0. *Applicable only to M24.02.03 onwards. AT+XISR=2,25,1 +XISR: 2 25 5 0123456798012346578901234 OK AT+XISR=2,10,1 +XISR: 2 5 0 56789 OK

2.8.2.

Query Command

The AT+XISR? query-command shows the remaining data size in the recv buffer of the specified connection. Response syntax: +XISR: <conId> <remainingDataLen> <conId> Shows ID of the connecting service. <remainingDataLen> Indicates the length of data remaining in the recv buffer after reading. AT+XISR? +XISR: 2 OK

2.8.3.

Test Command

The AT+XISR=? test-command shows the format and available parameters of this command. AT+XISR=? +XISR: (0-11), (0-1024) OK Confidential DAVISCOMMS (S) PTE LTD 11 /14

DC3500 Extended AT Commands Manual 500243R02

2.9.
2.9.1.

AT+XISW
Set Command

The AT+XISW set-command is used to write data to the write buffer. The data is part of the command. Syntax: AT+XISW=<conId><CR><DATA><Ctrl-Z> <CR> separates the parameter part from the data part, while <Ctrl-Z> indicates the end of the data. <DATA> Application data. The length of data in one AT command should be no more than 1024 Bytes. Response syntax: +XISW: <writeResult> <writeDataLen> <remainingFreeBuffSize> <writeDataLen> <writeResult> Confirms the length of data that has been written. Indicates whether this writting action is successful. It could be SUCCESS or FAIL. <remainingFreeBuffSize> Indicates the remaining free write buffer size. Data written to the write buffer will be automatically sent to the Internet by TCP/IP stack. If the free space in the write buffer is shorter than the data written by AT+XISW, <writeResult> will be set to FAIL which means NO data has been written into the buffer. AT+XISW=6<CR> 01234567890123465789<ctrl-z> +XISW: SUCCESS 20 980 OK

2.9.2.

Query Command

The AT+XISW? query-command shows the remaining buffer length that can be written to. Response syntax: +XISW: <conId> <remainingFreeBuffSize> <conId> Shows ID of the connecting service. <remainingFreeBuffSize> Shows the remaining free buffer size of the connecting service. AT+XISW? +XISW: 6 OK

980

2.9.3.

Test Command

The AT+XISW test-command shows the format and available parameters of this command. AT+XISW=? +XISW: (0-11) <CR> DATA <CTRL-Z> OK

Confidential

DAVISCOMMS (S) PTE LTD

12 /14

DC3500 Extended AT Commands Manual 500243R02

3.
3.1.

Control Extension
Overview

DC3500 module implements a few AT commands that allow to poll some predefined GPIO pin status and to control its behavior over LED and reporting the pin status change. There are 3 new AT commands at this moment: ----------------------------------------------------ZGPIO: Read GPIO pin status --------------------------------------------------AT+ZGPIO? returns the voltage-level status at the predefined GPIO pins. ----------------------------------------------------ZCTRL: Set control parameters --------------------------------------------------AT+ZCTRL Set parameters to control the LED and pin status reporting. AT+ZCTRL? Query the control parameters AT+ZCTRL=? Returns the syntax and valid parameters for this command ----------------------------------------------------ZIDLE: Request to enter Idle mode --------------------------------------------------AT+ZIDLE Request to enter idle mode.

3.2.
3.2.1.

AT+ZGPIO
Query Command

The AT+ZGPIO? query-command returns the voltage-level status at the pre-defined GPIO pins. All these pins are configured as input with internal pull-down resistors. The return value is a bit-map of the predefined GPIO pins (total 8, pull-up), 1 indicates the corresponding pin is of active level (i.e. Low); 0 means the corresponding pin is inactive (High). This command also resets a hardware pin STA_KEYPAD to the inactive voltage level. AT+ZGPIO? +ZGPIO: 2 OK

Confidential

DAVISCOMMS (S) PTE LTD

13 /14

DC3500 Extended AT Commands Manual 500243R02

3.3.
3.3.1.

AT+ZCTRL
Set Command

The AT+ZCTRL set-command sets several control parameters. Syntax: AT+ZCTRL=<mask> (,<led>) <mask> Mandatory parameter, numeric value. It is a bit-map mask of the GPIO pins defined in 3.2.1 that their transactions from high to low voltage level should be reported via a dedicated hardware pin (STA_KEYPAD, it also subsequently triggers WAKE_G signal pin). A bit 1 represents that the corresponding GPIO will trigger the dedicated STA_KEYPAD pin becoming active; a bit 0 means that the corresponding GPIO status will only be returned upon AT+ZGPIO? command request. Optional parameter, numeric value. 1 indicates that the network indicator LED should be operational as per normal (default value) and 0 instructs that the LED should be muted after initial power-on process (i.e. only show indication during power-on stage; mute afterwards). Other values are reserved.

<led>

AT+ZCTRL=6,0 OK

3.3.2.

Query Command

The AT+ZCTRL? query-command shows the current values of the control parameter. AT+ZCTRL? +ZCTRL: 6,0 OK

3.3.3.

Test Command

The AT+ZCTRL test-command shows the format and available parameters of this command. AT+ZCTRL=? +ZCTRL: (0-63), (0-1) OK

3.4.
3.4.1.

AT+ZIDLE
Set Command

The AT+ZIDLE set-command requests to enter idle mode. The modem should echo the command parameter if it accepts the request, or respond 0 if it rejects the request. Syntax: AT+ZIDLE=1 AT+ZIDLE=1 +ZIDLE: OK AT+ZIDLE=1 +ZIDLE: OK

this means the idle request is rejected

it indicates that the idle request is accepted

Confidential

DAVISCOMMS (S) PTE LTD

14 /14