Home

AT COMMANDS USER GUIDE FOR WAVECOM IP V5.01

1. Data Exchange for Protocol Services Socket Data exchange WIPDATA 6 2 2 4 DLE Escaping Mechanism A DLE character will be sent as data only when it is preceded by another DLE character A single DLE character which is not preceded by a DLE character will not be transmitted Desktop GPRS NT Data received from PC1 abc DLE efgh Data sent from PC2 abc DLE efgh MAPPED ART Desktop PCI Data sent to PC2 abc DLE DLE efgh Data received from PC2 abc DLE DLE efgh The above schematic explains how DLE characters which have a special meaning in WIPSoft are handled on Wavecom Wireless CPU On transmitting side when DLE is not escaped use case Desktop PC1 sends data towards Wireless CPU Data contains a non escaped DLE no DLE DLE sequence then DLE is not transmitted On transmitting side when DLE is escaped use case Desktop PC1 sends data towards Wireless CPU Data contain an escaped DLE DLE DLE sequence then DLE data is transmitted Wave COMM ecconridential Page 77 126 This document is the sole and exclusive property of WWAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom n Make it wireless Data Exchange for Protocol Services Socket Data exchange WIPDATA On the receiving side use case when Desktop PC2 sends data towards Wirele
2. weaevecom Make it wireless Data Exchange for Protocol Services Socket Data exchange WIPDATA Command Responses AT WIPDATA 1 5 1 Note UDP with index 5 can send read data in continuous mode CONNECT lt read write data gt OK Note sequence causes the UART to switch to AT mode AT WIPDATA 1 5 1 Note UDP with index 5 can send read data in continuous mode CONNECT lt read write data gt lt ETX gt OK Note ETX character indicates end of data AT WIPDATA 2 5 2 Note TCP with index 5 can send read data in continuous transparent mode CONNECT lt read write data gt OK Note sequence causes the UART to switch to AT mode 6 2 11 Notes 6 2 11 1 Continuous Mode Non Transparent for a TCP Mapped Socket If the ETX character is sent from the peer it is considered as an end of data transfer After sending an ETX character the socket will be shutdown and the peer will be informed of this shutdown by a ICR LFISHUTDOWN CRI LF indication on its mapped UART and the UART does not switch to AT mode This indicates that no more data can be sent from the host socket but it can receive data The below schematic shows the shutdown procedure for a TCP socket Wave COMM ecconfidential Page 81 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_0
3. 192 168 0 1 81 OK WIPREADY 1 7 AT WIPCREATE 1 8 62 192 168 0 1 82 OK WIPREADY 1 8 Examples of Application Creating 8 UDP sockets 8 TCP Clients 4 TCP Servers and either one FTP HTTP SMTP POP3 unsolicited the UDP client socket is pseudo Z connected to the peer no real connection is UDP create a UDP client towards peer IP device 1 192 168 0 1 port 78 Vall parameters and IP stack behavior are OK unsolicited the UDP client socket is pseudo Z connected to the peer no real connection is UDP create a UDP client towards peer IP device 1 192 168 0 1 port 79 Yall parameters and IP stack behavior are OK unsolicited the UDP client socket is pseudo Z connected to the peer no real connection is UDP create a UDP client towards peer IP device 1 192 168 0 1 port 80 Vall parameters and IP stack behavior are OK unsolicited the UDP client socket is pseudo Z connected to the peer no real connection is UDP create a UDP client towards peer IP device 1 192 168 0 1 port 81 Jall parameters and IP stack behavior are OK unsolicited the UDP client socket is pseudo connected to the peer no real connection is UDP create a UDP client towards peer IP device 1 192 168 0 1 port 82 Vall parameters and IP stack behavior are OK unsolicited the UDP client socket is pseudo Z connected
4. 192 168 0 1 create a UDP client towards peer IP device 1 192 168 0 1 port 76 76 OK Hall parameters and IP stack behavior are OK WIPREADY 1 2 unsolicited the UDP client socket is pseudo Z connected to the peer no real connection is UDP AT WIPCREATE 1 3 57 j 192 168 0 1 create a UDP client towards peer IP device 4 192 168 0 1 port 77 77 OK fall parameters and IP stack behavior are OK WIPREADY 1 3 unsolicited the UDP client socket is pseudo Z connected to the peer no real connection is UDP AT WIPCREATE 1 A 4 F 58 192 168 0 1 create a UDP client towards peer IP device 78 1 192 168 0 1 port 78 F CME ERROR 838 maximum 3 sockets can be created as the MAX SOCK NUM value has been changed to 4 3 Hence an attempt to create a fourth socket returns error W VeECO M oconfidentiai Page 115 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom oe Make it wireless Examples of Application Creating 8 UDP sockets 8 TCP Clients 4 TCP Servers and either one FTP HTTP SMTP POP3 9 13 Creating 8 UDP sockets 8 TCP Clients 4 TCP Servers and either one FTP HTTP SMTP POP3 AT WIPCFG 1 start IP stack OK AT WIPBR 1 6 open GPRS bearer OK AT WIPBR 2 P 6 P 11 APN name set APN name of GPRS be
5. Data received from PC2 abc DLE ETX c The above schematic explains how ETX characters which have a special meaning in WIP soft are handled on Wavecom Wireless CPU WaVeCOMccontidentia Page 64 126 This document is the sole and exclusive property of WWAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom a Make it wireless Data Exchange for Protocol Services File Exchange W IPFILE On transmitting side when ETX characters are escaped by a DLE use case Desktop PC1 sends data to the Wireless CPU Data contains an ETX character escaped by a DLE character DLE ETX sequence then the ETX character is transmitted as data On the receiving side when ETX character is received as data use case The PC2 sends data to the Wireless CPU Data contains an ETX character then the ETX character will be preceded by a DLE character when it is sent to host through the serial port 6 1 3 DLE Escaping Mechanism In case a DLE character needs to be transmitted as data it should be preceded by another DLE character A single DLE character not preceded by a DLE character will not be transmitted Similarly DLE characters received are sent to the host through the serial port preceded by a DLE character GSM GPRS Data received from PC1 abc DLE d Data sent to PC1 abc DLE d MAPPED
6. Authentication is disabled when this parameter is not specified for HTTP SMTP and POPS lt password gt password for the authentication in string format Authentication is disabled when this parameter is not specified for HTTP SMTP and POPS WaVecCOMccontidentia Page 43 126 This document is the sole and exclusive property of WWAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless IP Protocol Services Service Creation WIPCREATE lt account gt account information of the user in string format This is required by some FTP server during authentication phases lt header list gt HTTP header message name value pair The first string in the message header field is the name of the header and the second string is the value of the header lt gt additional HTTP message header fields more pairs name value of HTTP message header field can be added 5 1 4 Parameter Storage None 5 1 5 Possible Errors CMEE AT error code Description 3 operation not allowed 800 invalid option 803 operation not allowed in the current WIP stack state 830 bad index 832 bad port number 834 not implemented 836 memory allocation error 837 bad protocol 839 error during channel creation 840 UDP TCP socket or FTP HTTP SMTP POP3 session is a
7. WIPOPT 5 54 lt message header field name gt lt message header field value gt 5 3 3 Parameters and Defined Values lt protocol gt protocol type UDP TCP client TCP server FTP HTTP SMTP N ol A oj N POP3 lt idx gt socket or FTP HTTP SMTP POP3 session identifier lt action gt requested operation 1 read the value of an option 2 write the value of an option lt optnum gt option that can be read written lt optval gt value of an option 5 3 4 Parameter Storage None 5 3 5 Possible Errors CMEE AT error code Description 800 invalid option 801 invalid option value 803 operation not allowed in the current WIP stack state 830 bad index WaVeECOMMecontidentiat Page 53 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless IP Protocol Services Service Option Handling WIPOPT CMEE AT error code Description 834 not implemented 835 option not supported 837 bad protocol 850 unknown reason 860 protocol undefined or internal error 863 protocol delete error 864 protocol list error 5 3 6 Examples Command Responses AT WIPOPT 2 1 2 8 20 Note Set TTL for TCP client AT WIPOPT 2 1 1 8 Not
8. WaVvecomn Make it wireless Operating Systems Integrated Development Environments Plug Ins Wireless CPUs Services weaevecom Make it wireless AT COMMANDS USER GUIDE FOR WAVECOM IP V5 01 Reference WM_DEV_OAT_UGD_076 Revision 002 Date September 11 2008 amp WaVeCCOMD confidential Page 2 126 This document is the sole and exclusive property of WWAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 waevecom Make it wireless AT COMMANDS USER GUIDE FOR WAVECOM IP V5 01 Trademarks e WAVECOM WISMO Open AT and certain other trademarks and logos appearing on this document are filed or registered trademarks of Wavecom S A in France or in other countries All other company and or product names mentioned may be filed or registered trademarks of their respective owners WaVe COMM ocontidentiai Page 3 126 This document is the sole and exclusive property of WWAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 wavecom Make it wireless AT COMMANDS USER GUIDE FOR WAVECOM IP V5 01 Copyright This manual is copyrighted by Wavecom with all rights reserved No part of this manual may be reproduced in any form without the prior written permission of Wavecom No patent liability is assumed with respect to the use of the information contained herein WaVeC
9. Note Create a FTP session towards the remote specified FTP server Communication index to be used then is 7 AT WIPCREATE 5 1 proxyaddress OK user name password User Agent WIP HTTP Client 1 0 WIPREADY 5 Note HTTP session with proxy and 1 message header field Use default 80 proxy port number 7 message header field Message header field name is User Agent Message header field value is WIP HTTTP Client 1 0 AT WIPCREATE 5 1 proxyaddress OK user name password User Agent WIP HTTP Client 1 0 Accept Encoding gzip Accept Language en US Note HTTP session with proxy and 3 message header fields Use default 80 proxy port number 3 message header fields Message header field name is User Agent and header field value is WIP HTTTP Client 1 0 Message header field name is Accept Encoding and header field value is gzip Message header field name is Accept Language and header field value is en US Wave COMM ccontidential Page 46 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless IP Protocol Services Service Creation WIPCREATE Command Responses AT WIPCREATE 5 1 proxyaddress OK al y
10. SENDERNAME default NULL string 63 string ascii WIP_COPT_SMTP_ set the recipients list RW REC default NULL string 64 string ascii WIP_COPT_SMTP_ set the CC recipients list RW CC_REC default NULL string 65 string ascii WIP_COPT_SMTP_ set the BCC recipients list RW BCC_REC default NULL string 66 string ascii WIP_COPT_SMTP_ set the mail subject RW SUBJ default NULL string 67 digit u32 WIP_COPT_SMTP_ decide if the SMTP library RW FORMAT_HEADER will format the mail header or if the application is in charge of formatting it O Application formats mail header 1 SMTP lib formats mail header default 1 Caution When option WIP_COPT_SMTP_FORMAT_HEADER is set to O application can format the mail header to attach documents see RFC 2822 for Standard for the Format of ARPA Internet Text Messages for formatting details Note that WIPFILE command is used to send both mail header and body WaVvecomccontidentia Page 60 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless IP Protocol Services Service Option Handling WIPOPT When option WIP_COPT_SMTP_STATUS_CODE is used to retrieve the error code and the associated error string for the SMTP session creation it will not return any error code and error string if no error occurred during that p
11. retrieval 6 1 9 Notes The ETX character is considered as an end of data Hence in case ETX character needs to be transmitted it should be preceded by DLE character Wave COMM confidential Page 73 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WML_DEV_OAT_UGD_076 September 11 2008 wevecom a Make it wireless Data Exchange for Protocol Services Socket Data exchange WIPDATA 6 2 Socket Data exchange WIPDATA TUELA 6 2 1 Description The WIPDATA command is used to read write from to a socket On successful execution of the command the UART switches to data mode The UART can be switched back to AT mode by sending with 1 second guard time before and after the sequence If data is not read using WIPDATA command further data will be delayed An unsolicited event is received when there is a data to read on socket ya Data can be sent on the sockets using two modes e continuous mode e continuous transparent mode 6 2 2 Continuous Mode 6 2 2 1 TCP Sockets in Continuous mode In continuous mode an ETX character is considered as an end of data When an ETX character is sent on the mapped UART the TCP socket is shutdown and the peer side is informed of this shutdown with the indication CR LFISHUTDOWNI CR LF on the mapped UART In case an ETX DLE character needs to be transmitted as
12. 1 Note Start P Stack AT WIPCFG AT WIPCFG 2 0 10 Note Configure TTL of IP Stack WaVvecomccontidentia Page 27 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom a Make it wireless General Configuration IP Stack Handling WIPCFG AT WIPCFG 8 0 9 0 10 4 11 4 12 10 AT WIPCFG 3 IP soft v202 on Open AT OS v312 Mar 26 2007 11 45 46 WIPlib v2a07 WIPSoft vlal2 Note Display software version OK AT WIPCFG 0 OK Note Stop the TCP IP Stack AT WIPCFG 4 1 Note Store IP configuration parameters into FLASH AT WIPCFG 4 0 Note Free IP configuration parameters stored in FLASH WaVe COMM ccontidentia Page 28 126 This document is the sole and exclusive property of WWAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless General Configuration IP Stack Handling WIPCFG 4 1 7 Notes It is recommended to change the default settings of the WIP stack using WIPCFG only when it is required Changing the parameter values especially the max number of sockets and the max TCP buffer size with the high values lead to over consumption of the stack memory which causes the WIP Soft to crash Hence care must be taken when the defa
13. 5 P 2 P Phone number set phone number for GSM bearer OK AT WIPBR 2 5 0 user name set user name OK AT WIPBR 2 5 1 passwd set password OK AT WIPBR 4 5 0 start GSM bearer OK AT WIPCREATE 2 F 1 i m ip addr P 80 create a TCP client towards peer IP device ip addr port 80 OK all parameters and iP stack behavior are OK WIPREADY 2 1 unsolicited the TCP client socket is connected to the peer AT WIPDATA 2 1 1 exchange data on socket idx 1 CONNECT read write shel oh switch to AT mode OK AT WIPCLOSE 2 y 1 close the TCP client socket index 1 OK WaVvecomccontidentia Page 95 126 This document is the sole and exclusive property of WWAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless Examples of Application UDP Socket 9 2 UDP Socket AT WIPCFG 1 start IP stack OK AT WIPBR 1 6 open GPRS bearer OK AT WIPBR 2 P 6 m 11 F APN name set APN name of GPRS bearer OK AT WIPBR 2 6 0 user name set user name OK AT WIPBR 2 j 6 P 1 m pas swd set password OK AT WIPBR 4 6 0 start GPRS bearer OK AT WIPCREATE 1 P 1 7 80 Www wavec create a UDP client towards peer IP device ir 1 www wavecom com port 80 om com 80 OK Vall parameters and IP stack behavior are OK WIPRFADY 1 P 1 unsolicited the UDP client socket is pseudo connected to t
14. 7 72 124000 OK Examples of Application POP3 start IP stack Hopen GPRS bearer set APN name of GPRS bearer set user name set password start GPRS bearer connect to remote POP3 server connection and authentication are successful get total number of mails get total mail size WaVvecomccontidentia Page 104 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 waevecom Make it wireless Examples of Application POP3 AT WIPFILE 7 1 1 5 retrieve mail id 5 CONNECT lt user starts getting the mail with the UART in data mode and ends with an ETX gt OK AT WIPFILE 7 1 3 1 retrieve mail id 1 and delete it from the server atter retrieving CONNECT lt user starts getting the mail with the UART in data mode and ends with an ETX gt OK WaVeCOMCccontidentia Page 105 126 This document is the sole and exclusive property of WWAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless Examples of Application Creating a TCP Server spawning the maximum TCP Socket for the configured Server 9 8 Creating a TCP Server spawning the maximum TCP Socket for the configured Server AT WIPCFG 1 OK AT WIPBR 1 6 OK AT WIPBR 2 6 11 APN
15. ID returned by the mail listing option default depends on the mails available in the mail box WaVeCOMMccontidentia Page 61 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless IP Protocol Services Service Option Handling WIPOPT Caution When option WIP_COPT_POP3_STATUS _ CODE is used to retrieve the error code and the associated error string for the POP3 session creation it will not return any error code and error string if no error occurred during that particular POP3 session creation For example After the SMTP session is created successfully an attempt to retrieve the error code and the associated error string using the option WIP_COPT_POP3_STATUS CODE will result in an error code O and the error string corresponding to the successful case Create a POP3 session for the second time which will result in the CME ERROR 840 error code because the session is already active Now an attempt to retrieve the error code along with the associated error string using the option WIP_COPT_POP3_STATUS_CODE will result in error code O and the associated error string because the first POP3 session was successful WaVeCOMCccontidentia Page 62 126 This document is the sole and exclusive property of WWAVECOM Not to be distributed or div
16. MAX_SOCK_NUM option value and try to create 8 UDP sockets 8 TCP Client sockets and 4 TCP Server sockets 9 12 Changing the MAX_SOCK_NUM option value and try to create 8 UDP sockets 8 TCP Client sockets and 4 TCP Server sockets AT WIPCFG 1 OK AT WIPCFG 2 6 3 OK AT WIPCFG 4 1 OK AT WIPCFG 0 OK AT WIPCFG 1 OK AT WIPBR 1 6 OK AT WIPBR 2 6 11 APN name OK AT WIPBR 2 6 0 user name OK AT WIPBR 2 6 1 passwd OK AT WIPBR 4 6 0 OK AT WIPCREATE 1 1 55 192 168 0 1 75 OK start IP stack JIMAX_SOCK_NUM has been changed to 3 save the changed configuration to flash close the IP stack start IP stack open GPRS bearer set APN name of GPRS bearer set user name set password start GPRS bearer create a UDP client towards peer IP device 1 192 168 0 1 port 75 Yall parameters and IP stack behavior are OK Wave COMM confidential Page 114 126 This document is the sole and exclusive property of WWAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless Examples of Application Changing the MAX_SOCK_NUM option value and try to create 8 UDP sockets 8 TCP Client sockets and 4 TCP Server sockets WIPRFADY 1 1 unsolicited the UDP client socket is pseudo Z connected to the peer no real connection is UDP AT WIPCREATE 1 2 E 56
17. UART Desktop PC1 Data sent to PC2 ab DLE c DLE DLE d Data received from PC2 abc DLE DLE d The above schematic explains how DLE characters which have a special meaning in WIP soft are handled on Wavecom Wireless CPU WaVvecomccontidentia Page 65 126 This document is the sole and exclusive property of WWAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless Data Exchange for Protocol Services File Exchange W IPFILE On the transmitting side when DLE characters are escaped by another DLE character use case Desktop PC1 sends data to the Wireless CPU Data contains a non escaped DLE character and another escaped DLE character DLE DLE sequence then the DLE character is transmitted as data A single DLE character is ignored and not transmitted On the receiving side when DLE character is received as data use case The PC2 sends data to the Wireless CPU Data contains an DLE character then the DLE character will be preceded by another DLE character when it is sent to host through the serial port 6 1 4 Syntax e if lt protocol gt 4 Action Command AT WIPFILE lt protocol gt lt index gt lt mode gt lt filename gt CONNECT OK e if lt protocol gt 5 Action Command AT WIPFILE lt protocol gt lt index gt lt mode gt lt file
18. an unsolicited event when the data arrives on the socket Multiple UARTs There can be several UARTs simultaneously active at once and different UARTs can map a different socket simultaneously However it is a forbidden to map a single socket on several UARTs simultaneously WaVvecomccontidentia Page 16 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom a Make it wireless Principles Sockets Identification 3 1 Sockets Identification Sockets are identified by a pair of numbers the first one identifies the protocol the second one identifies a given socket of this protocol 3 1 1 Possible Protocols The possible protocols are 1 UDP 2 TCP in connect mode Client e e e 3 TCP in listen mode Server e 4 FTP e 5 HTTP e 6 SMTP e 7 POP3 Two pairs with a different protocol number but the same index identify two distinct sockets Example Both 1 7 and 2 7 are valid identifiers simultaneously the former identifies a UDP socket and the later a TCP connected socket 3 1 2 Number of Sockets The number of sockets per protocol is limited e UDP 8 sockets e TCP Clients 8 sockets TCP Servers 4 sockets 3 1 3 Notes The creation of basic sockets TCP UDP is not commercial but other features are locked by a commercial feature named internet plug in The W
19. and exclusive property of WWAVECOM Not to be distributed or divulged without prior written agreement WML_DEV_OAT_UGD_076 September 11 2008 wavecom Make it wireless WIPSoft Library API Required Header File 8 1 Required Header File The header file for the WIP AT command interface is wip_atcmd h Wave COMM confidential Page 89 126 This document is the sole and exclusive property of WWAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless WIPSoft Library API The wip_ATCmdSubscribe Function 8 2 The wip_ATCmdSubscribe Function The wip_ATCmdSubscribe function subsribes to WIPCFG WIPBR WIPPING WIPCREATE WIPDATA WIPFILE WIPOPT AT commands provided by WIPSoft 8 2 1 Prototype s32 wip _ATCmdSubscribe void 8 2 2 Parameters None 8 2 3 Returned Values The function returns e Oon success e negative error code on failure as described below Error Code Description subscription for WIP AT commands fails 2 WIP AT commands already subscribed Wave COM ccontidential Page 90 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WML_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless WIPSoft Library API The wip_ATCmdUnsubscribe Function 8 3 The
20. be distributed or divulged without prior written agreement WML_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless O Examples of Application Creating 8 UDP sockets 8 TCP clients and 4 TCP servers WIPREADY 2 6 unsolicited the TCP client socket is connected to the peer AT WIPCREATE 2 7 192 168 0 1 80 create a TCP client towards peer IP device 1 192 168 0 1 port 80 OK Hall parameters and IP stack behavior are OK WIPREADY 2 7 unsolicited the TCP client socket is connected to the peer AT WIPCREATE 2 i 8 192 168 0 1 80 create a TCP client towards peer IP device 192 168 0 1 port 80 OK Yall parameters and IP stack behavior are OK WIPREADY 2 8 unsolicited the TCP client socket is connected to the peer AT WIPCREATE 2 8 192 168 0 1 80 create a TCP client towards peer IP device 1192 168 0 1 port 80 Index 8 is already CME ERROR 840 used and corresponds to an active socket AT WIPCREATE 2 9 192 168 0 1 80 create a TCP client towards a peer IP device 1 192 168 0 1 port 80 Index 9 is forbidden CME ERROR 830 WaVeCOMCccontidentia Page 113 126 This document is the sole and exclusive property of WWAVECOM Not to be distributed or divulged without prior written agreement WML_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless Examples of Application Changing the
21. be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom n Make it wireless IP Protocol Services Service Creation WIPCREATE It is not possible to create a client socket with AT WIPCREATE 2 x y z when x is already reserved by a server with AT WIPCREATE 3 lt server idx gt lt local port gt a b where asx lt b Similarly it is not possible to reserve a range with AT WIPCREATE 3 lt server idx gt lt local port gt a b if one of the TCP client socket indexes between a and b is already reserved be it by a client or a server range The lt from idx gt and lt to idx gt are reserved for the server socket till the server socket and the spawned sockets are closed explicitly So when trying to create a new TCP server socket the lt from idx gt and lt to idx gt should be different from what was used earlier A parameter used as lt from_idx gt can t be used as lt to_idx gt anymore for other TCP server socket creation until spawned sockets with specified lt from_idx gt and lt to_idx gt are closed along with the TCP server socket explicitly and vice versa When no more communication index is available in the TCP server s range or no more resources to accept new incoming connections any peer trying to connect to the server will receive an accept immediately followed by a shutdown peer close It is possible to have a TCP client and TCP serv
22. be used for PPP over GSM establishment Same behaviour as described for PPP server The lt caller identity gt is an optional ASCII string type ASCII If not specified then target will accept all DATA calls independently of caller identification If specified then target will only accept calls from lt caller identity gt which is the GSM data call number of the GSM client Opening bearer only consists in associating the IP protocol stack with the specified bearer The corresponding bearer setup has to be done through the adequate already existing AT commands please refer to VWMFM commands for UART1 and UART2 CMUX command for CMUX virtual ports and GSM GPRS AT commands Several bearer can be opened at the same time but only one bearer can be started at a time If both DNS1 and DNS2 are displayed as 0 0 0 0 in the unsolicited message when bearer is opened in server mode it means that connecting to a remote IP host through an URL will fail The options WIP_BOPT_DIAL_REDIALCOUNT and WIP_BOPT_DIAL_REDIALDELAY will not be implemented through AT commands Nevertheless for future compatibility reason Opt num 3 and 4 are kept as reserved For GSM bearer the options WIP_BOPT_IP_ADDR and WIP_BOPT_IP_DST_ADDR will display valid addresses only when the bearer is started and connected else it will display an address 0 0 0 0 WaVeCOMCccontidentia Page 38 126 This document is the sole and exclusive property of WWAV
23. closed AT WIPCLOSE 3 1 close TCP server socket index 1 OK AT WIPCREATE 3 2 81 2 3 create the server on port 81 idx 2 and from_idx 2 and to_idx 3 CME FRROR 845 TCP client socket with idx 2 was reserved by the previous server socket and it was not closed explicitly Hence error is returned Wave COMM confidential Page 108 126 This document is the sole and exclusive property of WWAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless Examples of Application Create a TCP Client and try to create a TCP Server with indexs range containing TCP Client will fail 9 10 Create a TCP Client and try to create a TCP Server with indexs range containing TCP Client will fail AT WIPCFG 1 start IP stack OK AT WIPBR 1 6 open GPRS bearer OK AT WIPBR 2 P 6 11 APN name set APN name of GPRS bearer OK AT WIPBR 2 6 0 user name set user name OK AT WIPBR 2 6 1 passwd set password OK AT WIPBR 4 6 0 start GPRS bearer OK AT WIPCREATE 2 P 1 P 198 168 0 1 80 create a TCP client towards peer IP device 1 198 168 0 1 port 80 OK all parameters and IP stack behavior are OK WIPREADY 2 A 1 unsolicited the TCP client socket is connected to the peer AT WIPCREATE 3 P 2 80 1 P 2 create the server on port 80 idx 2 Range requested contains the already used inde
24. composed of 1 50 192 168 0 4 58 50 Mbytes d AT WIPDATA 1 1 1 CONNECT abcedghijklmnopqrstuvwxyzabced Where 25 bytes the ETX character marking the g b d of the dat h b d ghijklmnoparstuvwxyz ETX bound of the datagram have been rea Wave COMM confidential Page 97 126 This document is the sole and exclusive property of WWAVECOM Not to be distributed or divulged without prior written agreement WML_DEV_OAT_UGD_076 September 11 2008 waevecom Make it wireless Examples of Application PING 9 3 PING AT WIPCFG 1 start IP stack OK AT WIPBR 1 6 open GPRS bearer OK AT WIPBR 2 P 6 P 11 APN name set APN name of GPRS bearer OK AT WIPBR 2 6 0 user name set user name OK AT WIPBR 2 6 1 passwd set password OK AT WIPBR 4 6 0 start GPRS bearer OK AT WIPPING 192 168 0 1 start PING session OK W NG 0 0 224 WaVeCOMCccontidentia Page 98 126 This document is the sole and exclusive property of WWAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless Examples of Application FTP 9 4 FTP AT WIPCFG 1 start IP stack OK AT WIPBR 1 6 open GPRS bearer OK AT WIPBR 2 P 6 m 11 F APN name set APN name of GPRS bearer OK AT WIPBR 2 6 0 user name set user name OK AT WIPBR 2 6 1 passwd set password OK AT WIP
25. confidential Page 31 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless General Configuration Bearers Handling WIPBR UART2 N A N A GSM GPRS 2 3 4 5 6 1 1 14 CMUX port over UART1 21 24 CMUX port over UART2 lt opt num gt O bearer option identifier WIP_BOPT_LOGIN username string max 64 characters WIP_BOPT_PASSWORD password string max 64 characters WIP_BOPT_DIAL_PHONENB phone number string max 32 characters WIP_BOPT_DIAL_RINGCOUNT Number of rings to wait before sending the WIP_BEV_DIAL_CALL event range 0 65535 WIP_BOPT_DIAL MSNULLMODEM Enable MS Windows null modem protocol CLIENT SERVER handshake range O 1 WIP_BOPT_PPP_PAP Allow PAP authentication range O 1 WIP_BOPT_PPP_CHAP Allow CHAP authentication range O 1 WIP_BOPT_PPP_MSCHAP 1 Allow MSCHAPv1 authentication range O 1 10 WIP_BOPT_PPP_MSCHAP2 Allow MSCHAPv2 authentication range O 1 Wave COMM confidential Page 32 126 This document is the sole and exclusive property of WWAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom n Make it wireless General Configur
26. data it should be preceded by DLE character Similarly ETX DLE characters received by the TCP IP stack from the internet are sent to the host through the serial port preceded by a DLE character To close sockets switch the UART to AT command mode and use WIPCLOSE command 6 2 2 2 UDP Sockets in Continuous mode UDP is a connectionless protocol and hence there is no way to detect or cause a shutdown However an ETX character is used to mark the boundaries of datagrams 1 Maximum size of an UDP datagram has been fixed to 5840 Bytes This limit is an arbitrary one Nevertheless note that smaller the datagram is the surer it will reach the aimed destination Note that UDP is not a reliable transport layer WaVeCOMMccontidentia Page 74 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless Data Exchange for Protocol Services Socket Data exchange WIPDATA All data written on an UDP socket is collected till an ETX character is encountered or the maximum size of the datagram is reached and will be sent as a single datagram Similarly when reading data all data will be read till an ETX character is encountered which indicates the end of the datagram In case an ETX DLE character needs to be transmitted it should be preceded by DLE character similar to TCP so
27. default O 51 u32 WIP_COPT_SND_ set the size of the TCP socket RW BUFSIZE send buffer default O 52 O 1 us WIP_COPT_HTTP define the HTTP version to be RW _VERSION used by the session default 1 O HTTP 1 0 1 HTTP 1 1 53 u32 WIP_COPT_HTTP set the maximum number of W _MAXREDIRECT allowed redirects a zero value disables automatic redirects default 8 54 lt ascii WIP_COPT_HTTP return the HTTP message R list gt _HEADER header field or a list of message header fields from the last WIPFILE call default depends on the HTTP server Caution Option 54 WIP_COPT_HTTP_HEADER is not implemented and hence attempt to read this option will result in CME ERROR 834 WaVe COMM econridentia This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 Page 59 126 September 11 2008 weaevecom Make it wireless IP Protocol Services Service Option Handling WIPOPT 5 3 7 4 Options that can be applied to SMTP Session opt Value Value Option type Description Type num format type 60 digit str u32 a WIP_COPT_SMTP_ get last protocol error code R ing scii STATUS_CODE and associated error string default NULL string 61 string ascii WIP_COPT_SMTP_ set the sender address RW SENDER default NULL string 62 string ascii WIP_COPT_SMTP_ set the sender name RW
28. index 5 Wave COMM ecconfidential Page 93 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless Examples of Application TCP Socket 9 1 2 TCP Client Socket 9 1 2 1 Using GPRS Bearer AT WIPCFG 1 start IP stack OK AT WIPBR 1 6 open GPRS bearer OK AT WIPBR 2 P 6 11 F APN name set APN name of GPRS bearer OK AT WIPBR 2 6 0 user name set user name OK AT WIPBR 2 6 1 passwd set password OK AT WIPBR 4 6 0 start GPRS bearer OK AT WIPCREATE 2 1 ip addr 80 create a TCP client towards peer IP device ip addr port 80 OK all parameters and iP stack behavior are OK WIPREADY 2 1 unsolicited the TCP client socket is connected to the peer AT WIPDATA 2 1 1 exchange data on socket idx 1 CONNECT read write switch to AT mode OK AT WIPCLOSE 2 1 close the TCP client socket index 1 OK WaVvecomccontidentia Page 94 126 This document is the sole and exclusive property of WWAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless Examples of Application TCP Socket 9 1 2 2 Using GSM Bearer AT WIPCFG 1 start IP stack OK AT WIPBR 1 5 open GSM bearer OK AT WIPBR 2 P
29. lt mode gt 5 Action Command AT WIPCREATE lt mode gt lt index gt lt server gt lt peer port gt lt username gt lt password gt lt header list gt OK e if lt mode gt 6 or 7 Action Command AT WIPCREATE lt mode gt lt index gt lt server gt lt peer port gt lt username gt lt password gt OK Read Command AT WIPCREATE NONE Test Command AT WIPCREATE OK WaVeCOMMccontidentia Page 41 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom oe Make it wireless IP Protocol Services Service Creation WIPCREATE e if lt mode gt 1 or 2 Unsolicited response WIPREADY lt mode gt lt communication index gt e if lt mode gt 3 Unsolicited response WIPACCEPT lt server index gt lt communication idx gt e if lt mode gt 5 6 or 7 Unsolicited response WIPREADY lt mode gt lt index gt 5 1 3 Parameters and Defined Values lt mode gt specifies type of socket 1 UDP 2 TCP Client 3 TCP server 4 FTP 5 HTTP Client 6 SMTP Client 7 POPS Client lt index gt TCP UDP FTP HTTP SMTP POP3 session identifier lt local port gt local TCP UDP port lt peer IP gt peer IP address a string between quotes indicating an ad
30. name OK AT WIPBR 2 6 0 user name OK AT WIPBR 2 6 1 passwd OK AT WIPBR 4 6 0 OK AT WIPCREATE 3 1 80 5 6 OK tWIPACCEPT 1 5 tWIPACCEPT 6 AT WIPCLOSE 2 5 OK start IP stack Hopen GPRS bearer set APN name of GPRS bearer set user name set password start GPRS bearer create the server on port 80 idx 1 The server is listening for connection request on port 80 Spawned sockets will be given the index 5 or 6 It will accept connection request until it has no more socket left unsolicited the server accepted a connection resulting TCP client on idx 5 unsolicited the server accepted a connection resulting TCP client on idx 6 close the spawned TCP client socket index 5 now if the peer device try to connect to the server it shall receive an accept immediately Mftollowed by an shutdown connection reset by peer Wave COMM ecconfidential Page 106 126 This document is the sole and exclusive property of WWAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom a Make it wireless Examples of Application Creating a Server and try to create a TCP Client Server on a reserved index reserved by the Server will fail 9 9 Creating a Server and try to create a TCP Client Server on a reserved index reserved by the Server will fail AT WIPCFG 1 start IP s
31. pass WIPREADY 5 1 Note Authentication connection on default proxy server port 80 AT WIPCREATE 6 1 smtp mail yaho OK o fr 587 user 7 pass WIPREADY 6 1 Note Connect to SMTP server port 587 with given username and password AT WIPCREATE 7 1 192 168 1 4 OK 110 P user n pass WIPREADY 7 1 Note Connect to POP3 server port 110 with given username and password AT WIPCREATE 7 1 OK pop mail server com WIPREADY 7 1 Note Connect to the default port 110 of POP3 server No authentication required 5 1 7 Notes The maximum number of sockets can be set to 23 so that WIP soft can handle in the same time either one FTP session in passive mode HTTP SMTP POP3 8 UDP sockets 8 TCP client sockets and 4 TCP servers Starting a TCP server requires to specify the maximum number of communication sockets that can be spawned This can be done using lt from idx gt and lt to idx gt parameters Note that the value set for lt to idx gt should be equal or more than lt from idx gt The maximum communication socket that can be created using WIP Soft is 8 Hence the range for lt communication index gt and lt from idx gt lt to idx gt is 1 8 Note that the spawned communication socket and the TCP client socket share the same communication index Wave COMM ecconfidential Page 47 126 This document is the sole and exclusive property of WAVECOM Not to
32. peer is informed that Wireless CPU will not send any more data on that socket Usually peer will shutdown the other way downlink and this will result in a peer close event on the socket On receiving side when ETX are not escaped use case Wireless CPU sends data towards Desktop PC1 Data contain a non escaped ETX no DLE ETX sequence then ETX means that a special IP event occurred on Wireless CPU regarding the concerned socket UDP socket a non escaped ETX signals the boundary of the current received datagram TCP socket a non escaped ETX signals that the peer TCP connected TCP unit shutdown the downlink way Desktop PC1 should then close the uplink socket to totally terminate the TCP session Protocol Mapped UART IP Network active socket UDP Data containing DLE ETX Data containing ETX sequence UDP ETX alone Mark the boundary of the UDP Datagram received to be transmitted TCP Data containing DLE ETX Data containing ETX sequence TCP ETX alone Causes signals a shutdown operation on TCP socket Note that the behaviour is symmetrical apply both on transmitting receiving side of mapped UART WaVvecomccontidentia Page 76 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless
33. picture indicates that an AT command is supported even if the PIN 2 CHV 2 code is not entered WaVeCOMCccontidentia Page 12 126 This document is the sole and exclusive property of WWAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless Introduction AT Commands Presentation Rules 1 4 AT Commands Presentation Rules The AT commands to be presented in the document are as follows e A Description section as Heading 3 provides general information on the AT command or response behavior e A Syntax section as Heading 3 describes the command and response syntaxes and all parameters description e A Parameters and Defined Values section as Heading 3 describes all parameters and values e A Parameter Storage as Heading 3 presents the command used to store the parameter value and or the command used to restore the parameter default value e An Examples section as Heading 3 presents the real use of the described command e A Note section as Heading 3 can also be included indicating some remarks about the command use Figures are provided where necessary WaVeCOMCccontidentia Page 13 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 waevecom Make it wireless AT Command Sy
34. returned might not be reliable WaVeCOMMccontidentia Page 79 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless Data Exchange for Protocol Services Socket Data exchange WIPDATA 6 2 7 Parameters and Defined Values lt protocol gt socket type UDP 2 TCP client lt idx gt socket identifier lt mode gt mode of operation O unmap switch the UART mapped to continuous mode to AT mode continuous switch the UART to data mode 2 continuous transparent switch the UART to data mode In this mode DLE ETX characters are considered as normal data and not special characters This mode is not supported by UDP protocol 6 2 8 Parameter Storage None 6 2 9 Possible Errors CMEE AT error code Description 831 bad state 837 bad protocol 843 connection reset by peer 6 2 10 Examples Responses AT WIPDATA 2 5 1 CONNECT lt read write data gt OK Note TCP Client with index 5 can send read data Note sequence causes the UART to switch to in continuous mode AT mode W VeECO M oconfidentiai Page 80 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008
35. to data mode and prints the content of the file on UART The end of the file is marked by ETX character and UART switches back to AT mode This mode is used for downloading file from the FTP server if lt protocol gt 4 This mode is used for downloading data of the specified URL using HTTP GET method if lt protocol gt 5 This mode is used for retrieving mail without deleting it from the POPS server if lt protocol gt 7 This mode is not supported by SMTP protocol 2 This command switches the UART to data mode and accepts a stream of data terminated by ETX character This mode is used for uploading file to the FTP server if lt protocol gt 4 This mode is used for uploading data to the specified URL using HTTP PUT method if lt protocol gt 5 This mode is used for sending mail to the SMTP server if lt protocol gt 6 This mode is not supported by POP3 protocol 3 This mode is used for deleting the specified URL using HTTP DELETE method if lt protocol gt 5 This mode is used for retrieving mail and deletion after retrieval from the POPS server if lt protocol gt 7 This mode is not supported by FTP and SMTP protocol WaVecomMccontidentia Page 68 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless Data Exchange for Protocol Servi
36. to the peer no real connection is UDP Wave COMM confidential Page 117 126 This document is the sole and exclusive property of WWAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless Examples of Application Creating 8 UDP sockets 8 TCP Clients 4 TCP Servers and either one FTP HTTP SMTP POP3 AT WIPCREATE 1 9 63 192 168 0 1 83 P 48 UDP sockets have been created and hence CME ERROR 830 S F attempt fails AT WIPCREATE 3 1 83 1 1 create one server on port 83 idx 1 One TCP client socket is reserved on index 1 OK AT WIPCREATE 3 2 84 2 2 create one server on port 84 idx 2 One TCP client socket is reserved on index 2 OK AT WIPCREATE 3 3 85 3 3 create one server on port 85 idx 3 One TCP client socket is reserved on index 3 OK AT WIPCREATE 3 4 86 4 4 create one server on port 86 idx 4 One TCP client socket is reserved on index 4 OK AT WIPCREATE 3 5 84 E 5 5 1 4 TCP servers have been created and hence creation of 5 TCP server socket fails CME ERROR 830 AT WIPCREATE 2 1 7 192 168 0 1 y 83 W 4 TCP server have been created and each of them reserved 1 TCP client socket and hence CME FRROR 845 1 8 attempt of creating TCP server fails W4 reserved TCP client sockets have been spawned by their TCP server WIPACCEPT 1 1 unsolicited the server index
37. using this option range 4 42 default value 32 8 WIP_NET_OPT_IP_MULTI_MAX Total number of multicast group Multicast is the delivery of information to a group of destinations simultaneously using the most efficient strategy to deliver the messages over each link of the network only once IP Multicast is a technique for many to many communication over an IP infrastructure An IP Multicast group address is used by sources and the receivers to send and receive content Sources use the group address as the IP destination address in their data packets Receivers use this group address to inform the network that they are interested in receiving packets sent to that group For example if some content is associated with group 239 1 1 1 the source will send data packets destined to 239 1 1 1 Receivers for that content will inform the network that they are interested in receiving data packets sent to the group 239 1 1 1 This option is used to set the total number of multicast group 9 WIP_NET_OPT IP ROUTE MAX Size of IP routing table The Routing tables refer to a database on a router which is used to store that routers information on the topology of the network This option is used to specify the size of the routing table range O 2730 default value O 10 WIP_NET_OPT_RSLV_QUERY MAX Maximum number of DNS resolver queries This option specifies the maximum number of DNS queries that will be sent to the DNS server T
38. wip_ATCmdUnsubscribe Function The wip_ATCmdUnsubscribe function unsubscribes to WIPCFG WIPBR WIPPING WIPCREATE WIPDATA WIPFILE WIPOPT AT commands provided by WIPSoft 8 3 1 Prototype s32 wip _ATCmdUnsubscribe void 8 3 2 Parameters None 8 3 3 Returned Values The function returns e Oon success e negative error code on failure as described below Error Code Description 3 WIP AT commands already unsubscribed 4 un subscription for WIP AT commandes fails Wave COM ccontidential Page 91 126 This document is the sole and exclusive property of WWAVECOM Not to be distributed or divulged without prior written agreement WML_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless Examples of Application TCP Socket 9 Examples of Application 9 1 TCP Socket 9 1 1 TCP Server Socket 9 1 1 1 Using GPRS bearer AT WIPCFG 1 OK AT WIPBR 1 6 OK AT WIPBR 2 6 11 APN name OK AT WIPBR 2 6 0 user name OK AT WIPBR 2 6 1 passwd OK AT WIPBR 4 6 0 OK AT WIPCREATE 3 1 80 5 8 OK WIPACCEPT 1 5 AT WIPDATA 2 5 1 start IP stack open GPRS bearer set APN name of GPRS bearer set user name lt login gt set password lt password gt start GPRS bearer create the server on port 80 idx 1 The server is listening for connection request on port 1 80 Spawned sockets will be given the index 5 1
39. 1 accepted a connection resulting TCP client on idx 1 WIPACCEPT 2 2 unsolicited the server index 2 accepted a connection resulting TCP client on idx 2 tWIPACCEPT 3 3 unsolicited the server index 3 accepted a connection resulting TCP client on idx 3 WIPACCEPT 4 4 unsolicited the server index 4 accepted a eonnection resulting TCP client on idx 4 AT WIPCREATE 2 F 5 192 168 0 2 7 80 create a TCP client towards peer IP device 192 168 0 2 port 80 OK Mall parameters and IP stack behavior are OK WIPREADY 2 5 unsolicited the TCP client socket is connected to the peer AT WIPCREATE 2 P 6 192 168 0 2 80 create a TCP client towards peer IP device 192 168 0 2 port 80 Wave COMM confidential Page 118 126 This document is the sole and exclusive property of WWAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom oe Make it wireless Examples of Application Creating 8 UDP sockets 8 TCP Clients 4 TCP Servers and either one FTP HTTP SMTP POP3 OK Jall parameters and IP stack behavior are OK WIPREADY 2 6 unsolicited the TCP client socket is connected to the peer AT WIPCREATE 2 7 192 168 0 2 80 create a TCP client towards peer IP device 1 192 168 0 2 port 80 OK all parameters and IP stack behavior are OK WIPREADY 2 7 unsolicited the TCP client
40. 100 126 This document is the sole and exclusive property of WWAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 waevecom Make it wireless Examples of Application HTTP AT WIPFILE 5 1 1 urlForGet use HTTP GET method rname password Accept text html1 Transfer codings compress CONNECT lt user starts getting the mail with the UART in data mode and ends with an ETX gt OK 1 e n EN LE 5 1 1 255 Found unsolicited string on the HTTP status code Jand reason Wave COMM confidential Page 101 126 This document is the sole and exclusive property of WWAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless 9 6 SMTP AT WIPCFG 1 OK AT WIPBR 1 6 OK AT WIPBR 2 6 11 APN name OK AT WIPBR 2 6 0 user name OK AT WIPBR 2 6 1 passwd OK AT WIPBR 4 6 0 OK AT WIPCREATE 6 1 192 168 1 2 25 user password OK WIPREADY 6 1 AT WIPOPT 6 1 2 61 sender mail c om ww OK AT WIPOPT 6 1 2 62 sender name OK AT WIPOPT 6 1 2 63 rec01l Qmail com rec0O2Qmail com OK AT WIPOPT 6 1 2 64 ccrec0O1 mail com ccrec0O2 mail com OK Examples of Application SMTP start IP stack open GPRS beare
41. 6 7 and 8 It will accept connection request until it has no more socket left unsolicited the server accepted a connection resulting TCP client on idx 5 exchange data on socket index 5 CONNECT read write ie fe switch to AT mode OK Wave COM ocontidentiai Page 92 126 This document is the sole and exclusive property of WWAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless Examples of Application TCP Socket AT WIPCLOSE 2 5 OK 9 1 1 2 Using GSM bearer AT WIPCFG 1 OK AT WIPBR 1 5 OK AT WIPBR 2 5 2 Phone number OK AT WIPBR 2 5 0 user name OK AT WIPBR 2 5 1 passwd OK AT WIPBR 4 5 0 OK AT WIPCREATE 3 1 80 5 8 OK WIPACCEPT 1 5 AT WIPDATA 2 5 1 CONNECT OK AT WIPCLOSE 2 5 OK close the TCP client socket index 5 start IP stack open GSM bearer set phone number for GSM bearer set user name set password start GSM bearer create the server on port 80 idx 1 The server is listening for connection request on port 1 80 Spawned sockets will be given the index 5 6 7 and 8 It will accept connection request until it has no more socket left unsolicited the server accepted a connection Wresulting TCP client on idx 5 exchange data on socket idx 5 read write switch to AT mode close the TCP client socket
42. 76 September 11 2008 weaevecom Make it wireless Data Exchange for Protocol Services Socket Data exchange WIPDATA Internet Desktop PC2 GPRS WCPU GSM 2 Data received on the i mapped UART on PC2 abcd ET xX SHUTDOWN MAPPED ART Data received on the AT window of PC2 VVIPPEERCLOSE Desktop lt proto gt lt idx gt PC 1 Data sent from PC1 abcd ET X In the above schematic a TCP socket is connected On the transmitting side data and ETX is sent use case Desktop PC1 is a Wireless CPU which sends data to PC2 which is either a PC or a Wireless CPU the data is received on PC2 and ETX character shutdowns the socket on the transmitting side and displays a message CR LFISHUTDOWN CR LF on the mapped UART of PC2 When PC2 is switched back to AT mode WIPPEERCLOSE lt protocol gt lt idx gt indication is received indicating that no more data can be sent by PC1 but can read data sent from PC2 There are different indications received for shutdown and reset for a TCP socket When a TCP socket is reset ETX character is sent on the mapped UART to indicate the end of communication The mapped UART switches to AT mode and CME ERROR 843 is displayed on the UART The reset and shutdown can therefore be distinguished by the indications received on the UART WaVeCOMMccontidentia Page 82 126 This document is the sole and exclusive property of WAVECOM Not to be
43. 76 September 11 2008 weaevecom Make it wireless Data Exchange for Protocol Services File Exchange W IPFILE Command Responses AT WIPFILE 5 1 3 urlForDelete Note Send a HTTP DELETE request to URL CONNECT lt data received terminated by ETX character gt OK WIPFILE 5 1 3 lt http status code gt lt http status reason gt AT WIPFILE 5 1 4 urlForPost Note Send a HTTP POST request to URL CONNECT lt data received terminated by ETX character gt OK WIPFILE 5 1 4 lt http status code gt lt http status reason gt AT WIPFILE 6 1 2 Note Send data mail content CONNECT lt data sent terminated by ETX character gt OK AT WIPFILE 7 1 1 15 Note Retrieve data from the given ID CONNECT lt data received terminated by ETX character gt OK Note Retrieve mail ID 15 Mail is not deleted after retrieval Wave COMM ecconfidential Page 72 126 This document is the sole and exclusive property of WWAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless Data Exchange for Protocol Services File Exchange W IPFILE Command Responses AT WIPFILE 7 1 3 71 CONNECT lt data received terminated by ETX character gt OK Note Retrieve data from the given ID Note Retrieve mail ID 1 and delete it after
44. 8 no more free socket 839 error during channel creation 840 UDP TCP socket or FTP HTTP SMTP POP3 session is already active 841 peer closed 842 destination host unreachable whether host unreachable Network unreachable response timeout 843 connection reset by peer 844 stack already started 845 attempt is made to reserve create a client socket which is already reserved opened by TCP server client 846 internal error FCM subscription failure 847 849 reserved for future use 850 unknown reason 851 859 reserved for future use 860 protocol undefined or internal error 861 username rejected by server 862 password rejected by server 863 delete error 864 list error Wave cOMcconrdential Page 125 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless Error Codes Creating TCP client and server sockets in the same Wireless CPU at the same time mapping or unmapping the UART to exchange the data between the sockets 4 CMEE AT error code Description 865 authentication error 866 server not ready error 867 POP3 email retrieving error 868 POP3 email size error 869 879 reserved for future use 880 SMTP sender email address rejected by server 881 SMITP recipient email address rejected by server 882 SMTP CC recipient email addre
45. AT WIPBR 1 lt bid gt will open bearer lt bid gt with default parameters of the bearer when existing WaVvecomccontidentia This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 Page 34 126 September 11 2008 weaevecom Make it wireless 4 2 5 Possible Errors General Configuration Bearers Handling WIPBR The possible error message is displayed only if AT CMEE 1 is activated else ERROR is displayed CMEE AT error code Description 800 invalid option 801 invalid option value 802 not enough memory left 803 already open 804 not available on this platform 807 bearer connection failure line busy 808 bearer connection failure no answer 815 bearer connection failure PPP authentication failed 816 bearer connection failure PPP IPCP negotiation failed 820 error writing configuration in FLASH memory 821 error freeing configuration in FLASH memory 4 2 6 Examples Responses AT WIPBR 1 0 6 1 OK Note Bearer UART7 is open but not started bearer GPRS is open and started AT WIPBR OK Note No bearer has been opened yet AT WIPBR 1 6 Note Open GPRS bearer OK AT WIPBR 2 6 11 APN name OK Note Set APN of GPRS bearer Wave COMM cconfidential Page 35 126 This document is the sole and
46. BR 4 6 0 start GPRS bearer OK AT WIPCREATE 4 i 1 7 FTP create FTP session server 21 username passwd OK AT WIPFILE 4 1 2 filename txt upload file filename txt CONNECT lt data gt ETX OK AT WIPFILE 4 1 1 filename txt ownload file filename txt CONNECT lt data gt ETX OK W VeECO MN Oconfidentiai Page 99 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless Examples of Application HTTP 9 5 HTTP AT WIPCFG 1 start IP stack OK AT WIPBR 1 6 open GPRS bearer OK AT WIPBR 2 P 6 m 11 F APN name set APN name of GPRS bearer OK AT WIPBR 2 6 0 user name set user name OK AT WIPBR 2 6 1 passwd set password OK AT WIPBR 4 6 0 start GPRS bearer OK AT WIPCREATE 5 1 www siteaddress connect to remote HTTP proxy server port 81 r i in Gi oe with authentication and some header fields com 81 username password h eader name header value OK WIPREADY 5 1 1 connection and authentication are successful AT WIPOPT 5 1 1 51 get size of the TCP send buffer size WIPOPT 5 51 lt sender buffer size gt OK get option successful AT WIPOPT 5 1 2 53 6 set maximum number of redirects OK WaVvecomccontidentia Page
47. DATA ccccccce cece ence enee enna eneeeaes 74 7 PING SERVICES aiesecswaccaanceccdtacumecn cee y deieedws EEEE AENEA E EEEE 85 7 1 PING command WIPPING ccc cece eee c eee e nce ene sense ease eneeenseeneeeaes 85 8 WIPSOFT LIBRARY AP1 0 0ccccccee ence ee eeeeeeaeeeenceeesaeeesaeeeesaneeeaees 88 8 1 Required Header File cccccceeecee cece eee ee eee ee ee ee Ea 89 8 2 The wip_ATCmdSubscribe Function cccceceeeee eset ee ee eee ee ee 90 8 3 The wip_ATCmdUnsubscribe Function cceeeeeee eee eee ee es 91 9 EXAMPLES OF APPLICATION cccccceeeceeeecceeenceeesateesaeeeesaeeesanes 92 9 1 IGP OOCK orriren a cenne eed ioe eed Ae ee CENEL ARER 92 9 2 UDP SOCK x scccdsiescdediexiseededesesedsexinesdede roaster meesiederoeeteexieesseee NDEAN 96 9 3 PING cto 22 tet TATATA cage aie can cate seca A AATA T 98 9 4 PP orpona ore a ameseinne ane ait nec eda amaie tees a ameter avast nent IE shes 99 9 5 HTTP eironig nrinn vee ebtinacachadindaeitiuacaebediadyiSincaciedinduedtinacacbedes 100 9 6 SMTP EE EE E E EE E EE E ETE 102 9 7 POP Bice te ede eee else feta eee ets eee ee teds oh peut at eee eee eee 104 9 Creating a TCP Server spawning the maximum TCP Socket for the configured Serv r 20 ccc ccc ccc cece cence cence ence teense ee EREDE ENEE EEREN 106 9 9 Creating a Server and try to create a TCP Client Server on a reserved index reserved by the Server will fail cc
48. D_076 September 11 2008 weaevecom Make it wireless General Configuration Bearers Handling WIPBR AT WIPBR 4 5 0 Note Start the GSM bearer as a client AT WIPBR 3 5 15 Note Read the local IP for GSM bearer AT WIPBR 3 5 16 Og Pata cal Note Read the destination IP for GSM bearer AT WIPBR 5 5 Note Stop the GSM bearer AT WIPBR 0 5 Note Close the GSM bearer 4 2 7 Notes 4 2 7 1 For Starting a Bearer The mandatory parameters to start a bearer in e server mode lt cmdtype gt lt bid gt lt mode gt lt login gt and lt password gt e client mode lt cmdtype gt lt bid gt and lt mode gt Depending on the mode and the bearer type additional parameters are required or forbidden Bid Mode Other Params 1 3 11 14 21 24 OY a 24 ooo Starting bearer as a server requires additional parameters as mentioned in the above table e For PPP server only parameters lt login gt and lt password gt are required They will be compared with remote PPP client login and password W VEeECO M ocontidentiai Page 37 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless General Configuration Bearers Handling WIPBR e For GSM server lt login gt and lt password gt will
49. ECOM Not to be distributed or divulged without prior written agreement WML_DEV_OAT_UGD_076 September 11 2008 wavecom Make it wireless IP Protocol Services Service Creation WIPCREATE 5 IP Protocol Services 5 1 Service Creation WIPCREATE 5 1 1 Description The WIPCREATE command is used to create UDP TCP client and TCP server sockets associated with the specified index and FTP HTTP SMTP POP3 service Only one FTP HTTP SMTP POP3 session at a time is available If a local port is specified while creating a socket the created socket will be assigned to this port if not a port will be assigned dynamically by WIP application If peer IP and peer port is specified the created socket will be connected to the specified IP and port TCP server cannot be used to transfer data To transfer data it creates a local TCP client socket This process of creating local socket is referred as spawning When a server socket is created using socket passively listens on a specified port for incoming connections The below mentioned diagram shows different states managed for TCP server Server Socket Close Server Create Socket channel On reception of a connection request from a remote client socket a server socket does the following e spawns a new socket client to connect to the remote socket e data transfer is done between the spawned socket and the remote socket Wave COM ccontidentia Pa
50. IP Soft commands used for socket session creation will return a CME ERROR 839 error code if the feature is not enabled To enable the features you can refer to Open AT Firmware AT user guide especially the AT WCFM command and we recommend you to contact your Wavecom distributor or sales point for further details WaVvecomccontidentia Page 17 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 wevecom Make it wireless General Configuration IP Stack Handling WIPCFG 4 General Configuration 4 1 IP Stack Handling WIPCFG O fee 4 1 1 Description The WIPCFG command is used for performing the following operations start TCP IP stack stop TCP IP stack configuring TCP IP stack displaying version information 4 1 2 Syntax e if lt mode gt 0O 1 Action Command AT WIPCFG lt mode gt OK e if lt mode gt 2 Action Command AT WIPCFG lt mode gt lt opt num gt lt value gt OK e if lt mode gt 3 Action Command AT WIPCFG lt mode gt WIP soft vXX YY Z2Z on Open AT OS vVA B MMM DDD YYYY HH MM SS lt WIPlib version number gt lt WIPSoft version number gt OK WaVe COMM ccontidentia Page 18 126 This document is the sole and exclusive property of WWAVECOM Not to be distributed or divulged without prior writte
51. L packets default 64 9 0 255 WIP_COPT_T Type of service RW RW RW OS default O 2 The option WIP_COPT_BOUND is used to check whether an UDP socket is bound to any other UDP socket or not When the UDP socket is created without specifying the IP address of the peer then the option WIP_COPT_BOUND will be read as FALSE This is because there is no destination IP address to communicate with If the UDP socket is created by specifying the peer IP address the option WIP_COPT_BOUND will be read as TRUE This is because the peer IP address will be resolved by the DNS and the socket is said to be bounded to the peer socket Hence this option will be read as TRUE Wave COMM ecconridential This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 Page 58 126 weaevecom Make it wireless IP Protocol Services Service Option Handling WIPOPT 5 3 7 2 Options that can be applied to FTP Session opt num Value format Value type Description 40 O 1 boolean data representation type O ASCII 1 binary default O 41 O 1 boolean FTP mode O active 1 passive default 1 5 3 7 3 Options that can be applied to HTTP Session opt Value Value Option type Description Type num format type 50 u32 WIP_COPT_RCV_ set the size of the TCP socket RW BUFSIZE receive buffer
52. OK Note Get total mail size WaVe COMM ccontidentia Page 55 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless IP Protocol Services Service Option Handling WIPOPT AT WIPOPT 7 1 1 73 I 7 73 1 1024 7 73 2 5237 7 13737 1228 7 73 4 36400 7 73 5 356 Note Get mail listing AT WIPOPT 7 1 2 74 10 I 7 74 10 Note Delete mail ID 10 5 3 7 Notes It is possible to change and retrieve option value using WIPOPT command only when the socket session given by lt idx gt is active else it returns error 5 3 7 1 Options that can be applied to UDP TCP Client TCP Server Sockets opt Value Option Type Description UDP TCP TCP num format client server 0 0 65535 WIP_COPT_P_ Port of the socket R R R ORT 1 0 65535 WIP_COPT_P Port of the peer R R EER PORT socket 2 string WIP_COPT_P Address of the R R EER_STRADD peer socket R 3 O 1 WIP_COPT_B_ Specifies whether R OUND the socket is bounded to a peer socket or not default 1 WaVeCOMMccontidentia Page 56 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom Mak
53. OMCccontidentia Page 4 126 This document is the sole and exclusive property of WWAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 wavecom Make it wireless AT COMMANDS USER GUIDE FOR WAVECOM IP V5 01 Overview The aim of this document is to provide Wavecom customers with a full description of the Wavecom AT commands associated with the Wavecom IP feature Wave COMM confidential Page 5 126 This document is the sole and exclusive property of WWAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 waevecom Make it wireless AT COMMANDS USER GUIDE FOR WAVECOM IP V5 01 Document History Level Date History of the evolution Writer 001 March 03 2008 Creation Wavecom 002 September 11 2008 Update for WIP Soft V5 01 Wavecom Wave COM ccontidential Page 6 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless Introduction Related Documents Contents 1 INTRODUCTION wciic ceca tesea ine ode nadieds teed ncceu ws cide ociwte baivee engin os om ode ete merpoeds metas 9 1 1 Related DOCUMENHS ive ciic civic sesecdin than eecacd aus sast sede ved vi asdi edie es vecdveev vend 9 1 2 Abbreviations
54. T_UGD_076 September 11 2008 wavecom Make it wireless Introduction Related Documents 1 Introduction 1 1 Related Documents None Wave COMM confidential Page 9 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless Introduction Abbreviations and Definitions 1 2 Abbreviations and Definitions 1 2 1 Abbreviations APN Access Point Name ASCII American Standard Code for Information Interchange AT ATtention BCC Blind Carbon Copy CC Carbon Copy CHAP Challenge Handshake Authentication Protocol CHV Card Holder Verification CID Context IDentifier CMUX Converter Multiplexer CPU Central Processing Unit DNS Domain Name System GGSN Gateway GPRS Support Node GPRS General Packet Radio Service GSM Global System for Mobile communicatioOO6E HTTP Hyper Text Transfer Protocol IP Internet Protocol IPCP Internet Protocol Control Protocol M Mandatory MS Mobile Station N A Not Applicable MSCHAP MicroSoft Challenge Handshake Authentication MSS Maximum Segment Size NU Not Used O Optional OS Operating System PAP Password Authentication Protocol PDP Packet Data Protocol PIN Personal Identity Number POP3 Post Office Protocol PPP Point to Point Protocol SIM Subscr
55. UGD_076 September 11 2008 wavecom Make it wireless Examples of Application Creating 8 UDP sockets 8 TCP Clients 4 TCP Servers and either one FTP HTTP SMTP POP3 unsolicited the POP3 session is created successtully Wave COMM confidential Page 120 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless Examples of Application Subscribe Unsubscribe WIPSoft AT commands using WIPSoft Library API 9 14 Subscribe Unsubscribe WIPSoft AT commands using WIPSoft Library API include adl_global h Global includes include wip_atcmd h WIP AT command services if _OAT_API VERSION gt 400 const ul6 wm_apmCustomStackSize 4096 else u32 wm_apmCustomStack 1024 const ul6 wm_apmCustomStackSize sizeof wm_apmCustomStack endif void adl_main adl_InitType_e InitType TRACE 1 Embedded Application Main subscribe to the WIP AT commands set service if wip _ATCmdSubsrcibe 0 The customer can write here its own application based on other plug ins or its specific application target wip _ATCmdUnsubscribe else Error while subscribing to WIP Soft library WaVvecomccontidentia Page 121 126 This document is the sole and exclusive property of WWAVECOM Not to be
56. ake it wireless Data Exchange for Protocol Services File Exchange W IPFILE Command Responses AT WIPFILE 5 1 1 urlForGet user CONNECT name password Accept text ht ml lt data received terminated by ETX character gt OK WIPFILE 5 1 1 lt http status gt lt http status reason gt Note Send a HTTP GET request to URL Note HTTP GET of specified url 1 header message Header field name is Accept Header field value is text html AT WIPFILE 5 1 1 urlForGet user CONNECT name password Accept text ht ml Tansfer Codings compress lt data received terminated by ETX character gt OK WIPFILE 5 1 1 lt http status gt lt http status reason gt Note Send a HTTP GET request to URL Note HTTP GET of specified url 2 header messages Header field name is Accept Header field value is text html Header field name is Transfer Codings Header field value is compress AT WIPFILE 5 1 2 urlForPut CONNECT lt data terminated by ETX character gt OK WIPFILE 5 1 2 lt http status code gt lt http status reason gt Note Send a HTTP PUT request to URL WaVvecomMcconridentia Page 71 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_0
57. and Definitions ccc cece cece eee ee eee naeeeenaeeenaees 10 1 3 POG OS ropero na neacith E a aa a a a cia aaeh caen Saeed iehdatadewanedea 12 1 4 AT Commands Presentation Rules cccc cece eeee eee eaeeeenaeeeeaaes 13 2 AT COMMAND SYNTAX ccccccee cee eeceeeeeeeeeeaeeeeseeeesaneeeaneeesaneeeanes 14 2 1 Command LING sisser aa ui a a E R aii 14 2 2 Information Responses and Result Codes cccceeee ence eens eens 15 3 PRINCIPLES wave cccccssesiassesaasiecesimaassir ese A ented weeaa ad vtha KEENE EEEE NEA 16 3 1 Sockets ldentification cece ccc cece cece e eee e ee ee nase eenaeeeeesteeeaaeees 17 4 GENERAL CONFIGURATION ccccccceceeeeeeeeeeeeeeeeeeeeaneeeueeeeeaneneanes 18 4 1 IP Stack Handling WIPCEG ccc cece cece cece ence eneeenseenseeneeenes 18 4 2 Bearers Handling WIPBR ccccee cence eee eee tena ee ee eeee eens 30 5 IP PROTOCOL SERVICEG cccccceeccceesece neces eesaseesaeeeeeteesanetsganees 39 5 1 Service Creation WIPCREATE cccccccccce cence eeneeeeenseeeesaeees 39 5 2 Closing a Service WIPCLOSE cc ccc cece eee eee e eee eeeeeneeeeeeaes 49 5 3 Service Option Handling WIPOPT ccceece cece eens eens eneeeaes 52 6 DATA EXCHANGE FOR PROTOCOL SERVICES cccceeceeeeseeeeaees 63 6 1 File Exchange WIPFILE cccccccce eee e cess eeeeeeeeeeeeeeseeeeeeeneeaes 64 6 2 Socket Data exchange WIP
58. arer OK AT WIPBR 2 6 0 user name set user name OK AT WIPBR 2 6 1 passwd set password OK AT WIPBR 4 6 0 start GPRS bearer OK AT WIPCREATE 1 1 55 192 168 0 1 create a UDP client towards peer IP device 75 ee 1192 168 0 1 port 75 1 OK Jall parameters and IP stack behavior are OK WIPREADY 1 1 unsolicited the UDP client socket is pseudo Z connected to the peer no real connection is UDP AT WIPCREATE 1 2 F 56 192 168 0 1 create a UDP client towards peer IP device 76 192 168 0 1 port 76 F OK all parameters and IP stack behavior are OK WIPREADY 1 2 unsolicited the UDP client socket is pseudo Z connected to the peer no real connection is UDP AT WIPCREATE 1 3 57 192 168 0 1 create a UDP client towards peer IP device 77 1 192 168 0 1 port 77 E OK all parameters and IP stack behavior are OK W VEeECO M Oconfidentiai Page 116 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless WIPREADY 1 3 AT WIPCREATE 1 4 58 192 168 0 1 78 OK WIPREADY 1 4 AT WIPCREATE 1 5 59 192 168 0 1 79 OK WIPREADY 1 5 AT WIPCREATE 1 6 60 192 168 0 1 80 OK WIPREADY 1 6 AT WIPCREATE 1 7 61
59. articular SMTP session creation For example After the SMTP session is created successfully an attempt to retrieve the error code and the associated error string using the option WIP_COPT_SMTP_STATUS CODE will result in an error code O and the error string corresponding to the successful case Create a SMTP session for the second time which will result in the CME ERROR 840 error code because the session is already active Now an attempt to retrieve the error code along with the associated error string using the option WIP_COPT_SMTP_STATUS CODE will result in error code O and the associated error string because the first SMTP session was successful 5 3 7 5 Options that can be applied to POP3 Session opt Value Value Option type Description Type num format type 70 digit str u32 a WIP_COPT_POP3_ get last protocol error code R ing scii STATUS CODE and associated error string 71 u32 WIP_COPT_POP3_ get total number of mails R NB_MAILS default depends on the mails available in the mail box 72 u32 WIP_COPT_POP3_ get total mail size R MAILSIZE default depends on the mails available in the mail box 73 digit str ascii not a POP3 wip get mail listing R ing option The return value is a list of strings containing mail ID and mail size information default depends on the mails available in the mail box 74 u32 not a POP3 wip delete the mail ID W option The mail ID corresponds to the mail
60. ation Bearers Handling WIPBR 11 WIP_BOPT_GPRS_APN Address of GGSN string max 96 characters 12 WIP_BOPT_GPRS_CID Cid of the PDP context range 1 4 13 WIP_BOPT_GPRS_HEADERCOMP Enable PDP header compression range O 1 14 WIP_BOPT_GPRS_DATACOMP Enable PDP data compression range O 1 15 WIP_BOPT_IP_ADDR Local IP address IP string 16 WIP_BOPT_IP_DST_ADDR Destination IP address IP string 17 WIP_BOPT_IP_DNS1 Address of primary DNS server IP string 18 WIP_BOPT_IP_DNS2 Address of secondary DNS server IP string 19 WIP_BOPT_IP_SETDNS Configure DNS resolver when connection is established range O 1 20 WIP_BOPT_IP_SETGW Set interface as default gateway when connection is established range O 1 lt value gt range of value for different bearer options lt mode gt mode of operation O client 1 server lt state gt current state of the bearer O stopped started lt status gt result of the connection process 0 successful W VeECO N ocontidontiai Page 33 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless General Configuration Bearers Handling WIPBR any to be matched to error code value e g 814 means PPP other authentication failure value lt local IP gt l
61. cceeeeee eee 107 9 10 Create a TCP Client and try to create a TCP Server with indexs range containing TCP Client will fail c ccc eee eee cece eee eeeeeeeeeaees 109 9 11 Creating 8 UDP sockets 8 TCP clients and 4 TCP servers 110 WaVecCOMccontidentia Page 7 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 waevecom Make it wireless Introduction Related Documents 9 12 Changing the MAX_SOCK_NUM option value and try to create 8 UDP sockets 8 TCP Client sockets and 4 TCP Server sockets 114 9 13 Creating 8 UDP sockets 8 TCP Clients 4 TCP Servers and either one PIP HT FP SMTP POPS i cctcccscces devs ccees seestvesdeia ceageesauwvaitiaivscentacnats 116 9 14 Subscribe Unsubscribe WIPSoft AT commands using WIPSoft Library AP lesscstesstsinsccsvathracs teex thee vie ieee ied tiaieidhe yeast see tiaw TEE ETDE EENE reds 121 9 15 Creating TCP client and server sockets in the same Wireless CPU at the same time mapping or unmapping the UART to exchange the data between the socketS ccc cce ccc en cece cence cence eeeneeeneeeeeueeeeeneneneneenanees 122 10 ERROR CODES n aao ELE LALLE LE EE AE Enana Enaren 124 Wave COMM confidential Page 8 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OA
62. ce 1 192 168 0 1 port 77 Yall parameters and IP stack behavior are OK WaVecomMccontidentia Page 110 126 This document is the sole and exclusive property of WWAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless Examples of Application Creating 8 UDP sockets 8 TCP clients and 4 TCP servers WIPREADY 1 3 AT WIPCREATE 1 4 58 192 168 0 1 78 OK WIPREADY 1 4 AT WIPCREATE 1 5 59 192 168 0 1 79 OK WIPREADY 1 5 AT WIPCREATE 1 6 60 192 168 0 1 80 OK WIPREADY 1 6 AT WIPCREATE 1 7 61 192 168 0 1 81 OK WIPREADY 1 7 AT WIPCREATE 1 8 62 192 168 0 1 82 OK unsolicited the UDP client socket is pseudo Z connected to the peer no real connection is UDP create a UDP client towards peer IP device 1 192 168 0 1 port 78 Yall parameters and IP stack behavior are OK unsolicited the UDP client socket is pseudo Z connected to the peer no real connection is UDP create a UDP client towards peer IP device 1 192 168 0 1 port 79 Yall parameters and IP stack behavior are OK unsolicited the UDP client socket is pseudo Z connected to the peer no real connection is UDP create a UDP client towards peer IP device 1 192 168 0 1 port 80 Yall parame
63. ces File Exchange W IPFILE 4 This command switches the UART in data mode and accepts a stream of data terminated by ETX character This mode is used for uploading data to the HTTP server using HTTP POST method if lt protocol gt 5 This mode is not supported by FTP SMTP and POP3 protocol lt filename gt file name if lt protocol gt 4 specify the name of the file to upload or download The maximum file length is limited to 128 characters The actual filename including path name has to be used if lt protocol gt 5 URL of the HTTP request if lt protocol gt 7 mail id in string format lt user name gt user name in string format lt password gt Password in string format lt header list gt HTTP header message name value pair The first string in the message header field is the name of the header and the second string is the value of the header lt gt additional HTTP message header fields more pairs name value of HTTP message header field can be added lt http status code gt HTTP 3 digit status code of the response lt http status HTTP status reason of the response in string format reason gt 6 1 6 Parameter Storage None 6 1 7 Possible Errors CMEE AT error code Description 800 invalid option 803 operation not allowed in the current WIP stack state WaVeECOMCccontidentiat Page 69 126 This document is the sole and exclusive
64. cket When the UART leaves DATA mode either because of escape sequence or because of an AT WIPDATA 1 index O on another UART the currently unsent data are sent as a single datagram 6 2 2 3 ETX Escaping Mechanism GPRS SM Data received from PC1 abc ETX efgh Data sent from PC2 abc ETX efgh MAPPED ART Desktop PCl Data sent to PC2 abc DLE ETX efgh Data received from PC2 abc DLE ETX efgh The above schematic explains how ETX characters which have a special meaning in WIP soft are handled on Wavecom Wireless CPU On transmitting side when ETX are not escaped use case Desktop PC1 sends data towards Wireless CPU Data contain a non escaped ETX no DLE ETX sequence then ETX is not transmitted but an action is done on Wireless CPU regarding the concerned socket WaVecomMcconridentia Page 75 126 This document is the sole and exclusive property of WWAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom n Make it wireless Data Exchange for Protocol Services Socket Data exchange WIPDATA UDP socket a non escaped ETX marks the boundary of the current datagram to be sent Datagram is immediately sent and the ETX is not sent towards the desktop PC2 TCP socket a non escaped ETX causes a TCP shutdown operation on the transmitting direction
65. ckets sent on the IP network may be smaller than TCP_MIN_MSS value Setting e g a 10 value for this option will make the application to wait at least 1 second or twice the TCP_MIN_MSS value to be reached before sending data on IP network In this case TCP packets size sent on the IP network should be equal to at least TCP_MIN_MSS Default value 536 bytes range O 100 default value O lt action gt requested operation on TCP IP stack parameter management O configuration storage when existing is freed stores the configuration parameters lt value gt value range for different configuration options lt XX YY ZZ gt WIP soft release version lt A B gt Open AT OS release version lt MM DD date of built of WIP Soft application YYYY gt lt HH MM SS gt time of built of WIP Soft application WaVeCOMMccontidentia Page 24 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 waevecom Make it wireless General Configuration IP Stack Handling WIPCFG lt WIPlib WIP Lib version version number gt lt WIPSoft internally identifying WIP Soft version version number gt Caution The option WIP_NET_OPT_IP_MULTILMAX is read only parameter WaVeCOMCccontidentia Page 25 126 This document is the sole and exclusive property o
66. d hence VF attempt fails create one server on port 80 idx 1 One TCP client socket is reserved on index 7 create one server on port 81 idx 2 One TCP client socket is reserved on index 2 create one server on port 82 idx 3 One TCP client socket is reserved on index 3 create one server on port 83 idx 4 One TCP client socket is reserved on index 4 4 TCP servers have been created and hence creation of 5 TCP server socket fails create a TCP client socket towards peer IP device 192 168 0 1 port 80 Index 7 is reserved by server index and hence error is returned 4 reserved TCP client sockets have been spawned by their TCP server unsolicited the server index 1 accepted a connection resulting TCP client on idx 1 unsolicited the server index 2 accepted a connection resulting TCP client on idx 2 unsolicited the server index 3 accepted a connection resulting TCP client on idx 3 unsolicited the server index 4 accepted a connection resulting TCP client on idx 4 create a TCP client towards peer IP device 1 192 168 0 1 port 80 Hall parameters and IP stack behavior are OK unsolicited the TCP client socket is connected to the peer create a TCP client towards peer IP device 1 192 168 0 1 port 80 Yall parameters and IP stack behavior are OK Wave COMM confidential Page 112 126 This document is the sole and exclusive property of WAVECOM Not to
67. d to close a socket or FTP HTTP SMTP POP3 session When one serial port UART or CMUX DLCl is used to map a socket for read write operations ETX character can also be used to close the socket An unsolicited event is generated when socket or FTP HTTP SMTP POP3 session is closed 5 2 2 Syntax Action command AT WIPCLOSE lt protocol gt lt idx gt OK Read Command AT WIPCLOSE NONE Test Command AT WIPCLOSE OK Unsolicited response WIPPEERCLOSE lt protocol gt lt idx gt 5 2 3 Parameters and Defined Values lt protocol gt protocol type 1 UDP 2 TCP client Wave cOMMeccontidential Page 49 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless IP Protocol Services Closing a Service WIPCLOSE TCP server FTP HTTP SMTP POP3 lt idx gt socket identifier or FTP HTTP SMTP POP3 session identifier This parameter is the index of the socket or FTP HTTP SMTP POP3 session created with WIPCREATE command N of A w 5 2 4 Parameter Storage None 5 2 5 Possible Errors CMEE AT error code Description 802 not enough memory 803 operation not allowed in the current WIP stack state 830 bad index 831 bad state 834 not implemented 837 bad
68. distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless Data Exchange for Protocol Services Socket Data exchange WIPDATA 6 2 11 2 Mapping Unmapping of a Mapped UDP and TCP Socket When a TCP socket is unmapped and still active it is possible to map it again in another mode which is different from the previous one without closing the TCP socket The UART switches back to AT mode due to with 1 second guard time before and after the sequence or by sending an AT WIPDATA lt proto gt lt index gt 0 on another UART in AT mode This applies to both UDP and TCP protocols When is issued Wireless CPU switches from DATA mode to AT mode If ATO command is used to switch the Wireless CPU back to DATA mode e CME ERROR 3 will be received when GPRS bearer is used e no response is received when GSM bearer is used To switch the Wireless CPU back to DATA mode AT WIPDATA x x x should be used instead of ATO After executing AT WIPDATA x x x command CONNECT will be received to indicate that the Wireless CPU is switched back to DATA mode 6 2 11 3 Time out Mechanism to know the state of the Peer TCP Socket In a TCP server client connection between two remote devices if the peer socket is closed down abruptly e g powered off the peer TCP socket does not get any indication message This is a normal behavior The TCP protocol uses a timeo
69. distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom a Make it wireless Examples of Application Creating TCP client and server sockets in the same Wireless CPU at the same time mapping or unmapping the UART to exchange the data between the sockets 9 15 Creating TCP client and server sockets in the same Wireless CPU at the same time mapping or unmapping the UART to exchange the data between the sockets AT WIPCFG 1 start IP stack OK AT WIPBR 1 6 open GPRS bearer OK AT WIPBR 2 6 11 APN name set APN name of GPRS bearer OK AT WIPBR 2 6 0 user name set user name OK AT WIPBR 2 6 1 passwd set password OK AT WIPBR 4 6 0 start GPRS bearer OK AT WIPCREATE 3 2 80 1 2 create the server on port 80 idx 2 The server is listening for connection request on port 80 OK Spawned sockets will be given the index 7 or 2 It will accept connection request until has nor more socket left AT WIPCREATE 2 i 3 198 168 0 1 80 create a TCP client towards peer IP device 1 198 168 0 1 port 80 Jall parameters and IP stack behavior are OK IPREADY 2 3 unsolicited the TCP client socket is connected to the peer IPACCEPT 2 1 unsolicited the server index accepted a connection resulting TCP client on idx 1 AT WIPDATA 2 3 1 exchange data on socket index 3 CONNECT WaVeCOMMccontidentia Page 122 126 Thi
70. dress either in numeric form e g 85 12 133 10 or as a DNS entry e g Www wavecom com WaVvecomccontidentia Page 42 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom a Make it wireless IP Protocol Services Service Creation WIPCREATE lt peer port gt peer port or the server port For TCP UDP this parameter is the port of the peer socket For FTP HTTP SMTP and POPS this parameter is the server port range 1 65535 default value for FTP 21 default value for HTTP 80 default value for SMTP 25 default value for POP3 110 lt from idx gt minimum index for spawned TCP sockets range 1 8 lt server index gt TCP server socket identifier range 1 4 lt to idx gt maximum index for spawned TCP sockets range 1 8 lt communication index gt indexes reserved for spawned sockets It cannot be used by other sockets even if the spawned sockets are not created yet range 1 8 lt server gt server address or proxy address This parameter is the server address for FTP SMTP and POPS3 protocol and for HTTP it is proxy server address It can either be a 32 bit number in dotted decimal notation xxx xxx xxx xxx or an alpha numeric string format for hostname lt user name gt username for the authentication in string format
71. e Get TTL for TCP client AT WIPOPT 3 1 2 9 10 Note Set TOS for TCP server AT WIPOPT 3 1 1 9 Note Get TOS for TCP server AT WIPOPT 1 1 1 1 Note Get peer port for UDP AT WIPOPT 4 1 2 40 1 Note Set data representation type for FTP AT WIPOPT 4 1 1 40 Note Get data representation type for FTP AT WIPOPT 5 1 2 52 0 Note Set HTTP version to 1 0 WaVe COMM ccontidentia Page 54 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless IP Protocol Services Service Option Handling WIPOPT Command Responses AT WIPOPT 5 1 2 53 6 OK Note Set maxredirect to 6 AT WIPOPT 5 1 1 52 WIPOPT 5 52 0 OK Note Get HTTP version AT WIPOPT 6 1 2 61 senderaddres OK s mail com Note Set the sender address AT WIPOPT 6 1 2 67 0 OK Note The application will format the mail header and send it during the data sending phase AT WIPOPT 6 1 1 61 WIPOPT 6 61 senderadress mail com OK Note Get the sender address AT WIPOPT 6 1 1 60 WIPOPT 6 60 220 220 innosoft com SMTP service ready OK Note Get last protocol error status AT WIPOPT 6 1 1 66 WIPOPT 6 66 My mail subject OK Note Get the set mail subject AT WIPOPT 7 1 1 72 WIPOPT 7 72 243000
72. e it wireless IP Protocol Services Service Option Handling WIPOPT opt Value Option Type Description UDP TCP TCP num format client server 4 1 5839 WIP_COPT_S Minimum amount RW RW ND_LOWAT of available space that must be available in the emission buffer before triggering a WIP_CEV_WRITE event default 1024 5 1 5839 WIP_COPT_R Minimum amount RW RW CV_LOWAT of available space that must be available in the emission buffer before triggering a WIP_CEV_READ event default 1 6 0 65535 WIP_COPT_N Number of bytes R R READ that can currently be read on that socket default O WaVeCOMCccontidentia Page 57 126 This document is the sole and exclusive property of WWAVECOM Not to be distributed or divulged without prior written agreement WML_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless IP Protocol Services Service Option Handling WIPOPT opt Value Option Type Description UDP TCP TCP num format client server 7 O 1 WIP_COPT_N When set to TRUE RW RW ODELAY TCP packets are sent immediately even if the buffer is not full enough When set to FALSE the packets will be sent either a by combining several small packets into a bigger packet b when the data is ready to send and the stack is idle default O 8 0 255 WIP_COPT_T Time to leave for RW RW RW T
73. en the session is active else CME ERROR 831 error code is returned Wave COMM ecconfidential Page 51 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless IP Protocol Services Service Option Handling WIPOPT 5 3 Service Option Handling WIPOPT 2 a0 EE 5 3 1 Description The WIPOPT command is used to read and or to configure different parameters on sockets and FTP HTTP SMTP POP3 service 5 3 2 Syntax e if lt action gt 1 Action Command AT WIPOPT lt protocol gt lt idx gt lt action gt lt optnum gt OK e if lt action gt 2 Action Command AT WIPOPT lt protocol gt lt idx gt lt action gt lt optnum gt lt optval gt OK Read Command AT WIPOPT NONE Test Command AT WIPOPT OK e if lt action gt 1 Unsolicited response WIPOPT lt protocol gt lt optnum gt lt optval gt WaVeCOMccontidentia Page 52 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom n Make it wireless IP Protocol Services Service Option Handling WIPOPT e if lt action gt 1 and lt protocol gt 5 and lt optnum gt 54 Unsolicited response
74. er sockets running at the same time in the same Wireless CPU In this scenario when the connection is established between the TCP server and TCP client sockets it is necessary to unmap the mapped socket on one index in order to send receive data on socket which is created on another index It is possible to use CMUX logical ports and can have an interface connection like UART connection for each socket for e g TCP client socket on one logical port and TCP server socket on another In this case it is not necessary to map or unmap the UART connections to send or receive the data from the socket The WIPCREATE command causes the connection and authentication to the FTP server If several file uploads and retrievals are required to from the same server a single connection with WIPCREATE is needed Then each file operation will be done one WIPFILE command per operation and the FTP connection will be released with WIPCLOSE SIM card is required only if FTP session is established through GSM or GPRS An FTP session upon an UART will work without a SIM card WaVvecomccontidentia Page 48 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 wevecom Make it wireless IP Protocol Services Closing a Service WIPCLOSE 5 2 Closing a Service WIPCLOSE 5 2 1 Description The WIPCLOSE command is use
75. exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless Note Get APN of GPRS bearer General Configuration Bearers Handling WIPBR Command Responses AT WIPBR 3 6 11 PBR 6 11 APN name AT WIPBR 4 6 0 Note Start GPRS bearer AT WIPBR 5 6 Note Stop GPRS bearer AT WIPBR 0 6 Note Close GPRS bearer AT WIPBR 1 5 Note Open GSM bearer AT WIPBR 2 5 0 login Note Set the login for GSM bearer AT WIPBR 2 5 1 password Note Set the password for GSM bearer AT WIPBR 2 5 2 phonenumber OK Note Set the phonenumber for GSM bearer AT WIPBR 2 5 15 1 1 1 1 OK Note Set the local IP address for GSM bearer AT WIPBR 2 5 16 2 2 2 2 OK Note Set the destination IP address for GSM bearer AT WIPBR 3 5 15 WIPBR 5 15 0 0 0 0 OK Note Read the local IP address for GSM bearer Note Local IP address is not set as GSM bearer is still not connected AT WIPBR 3 5 16 WIPBR 5 16 0 0 0 0 OK Note Read the destination IP address for GSM Note Destination IP address is not set as GSM bearer bearer is still not connected Wave COM ocontidentiai Page 36 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UG
76. f WWAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom oe Make it wireless General Configuration IP Stack Handling WIPCFG 4 1 4 Parameter Storage Only one IP stack configuration set can be saved into the FLASH memory e AT WIPCFG 4 1 is used to store the TCP IP stack configuration parameters into the FLASH memory e AT WIPCFG 4 0 is used to free the TCP IP stack configuration storage Executing AT WIPCFG 1 will apply default parameters when existing Still it is possible to change option values at run time using AT WIPCFG 2 lt optnum gt lt optvalue gt 4 1 5 Possible Errors The possible error message is displayed only if AT CMEE 1 is activated else ERROR is displayed CMEE AT error code Description 800 invalid option 801 invalid option value 802 not enough memory left 820 error writing configuration in FLASH memory 821 error freeing configuration in FLASH memory 844 stack already started 850 initialization failed WAVE COMM econtidentiat Page 26 126 This document is the sole and exclusive property of WWAVECOM Not to be distributed or divulged without prior written agreement WML_DEV_OAT_UGD_076 September 11 2008 weaevecom a Make it wireless General Configuration IP Stack Handling WIPCFG 4 1 6 Examples Command Responses AT WIPCFG
77. ge 39 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 waevecom Make it wireless IP Protocol Services Service Creation WIPCREATE e server socket remains in the listening mode and is ready to accept the request from other clients Below mentioned diagram shows connection establishment procedure Connect request Spawn a new Connected Transfer data 5 1 2 Syntax e if lt mode gt 1 Action Command AT WIPCREATE lt mode gt lt communication index gt lt local port gt lt peer IP gt lt peer port gt OK e if lt mode gt 2 Action Command AT WIPCREATE lt mode gt lt communication index gt lt peer IP gt lt peer port gt OK WaVeCOMMccontidentia Page 40 126 This document is the sole and exclusive property of WWAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom a Make it wireless IP Protocol Services Service Creation WIPCREATE e if lt mode gt 3 Action Command AT WIPCREATE lt mode gt lt server index gt lt local port gt lt from idx gt lt to idx gt OK e if lt mode gt 4 Action Command AT WIPCREATE lt mode gt lt index gt lt server gt lt peer_port gt lt username gt lt password gt lt account gt OK e if
78. he peer no real connection is UDP AT WIPDATA 1 7 1 F 1 exchange data on socket idx 1 CONNECT read write switch to AT mode OK AT WIPCLOSE 1 1 close the UDP socket index 1 OK AT WIPCREATE 1 1 1234 start a UDP server and listen for datagram on port 11234 WaVeCOMccontidentia Page 96 126 This document is the sole and exclusive property of WWAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless Examples of Application UDP Socket OK Yall parameters and IP stack behavior are OK WIPREADY 1 1 unsolicited the UDP client socket is pseudo connected to the peer no real connection is UDP WIPDATA Jone datagram is ready to be read it was sent 4 fi 1 192 168 0 2 t 2397 and i d 1 25 192 168 0 2 2397 H Jey es ee Peston Cay AT WIPDATA 1 1 1 CONNECT abcedghijklmnopgrstuvwxyz ETX Where 25 bytes the ETX character marking the bound of the datagram have been read or AT WIPDATA 1 1 0 type on this UART escape sequence or un map the UART on other control port USB UART OK Where UART is back to AT command mode If some other remote IP devices sent some one or more datagrams while reading for the first one then a new datagram indication is received WIPDATA Jone datagram is ready to be read it was sent 3 from 192 168 0 4 on port 58 and is
79. his option is used if the IP address is specified as alphanumeric string range 1 511 default value 4 11 WIP_NET_OPT_RSLV_CACHE MAX Size of DNS resolver cache It allows to set the maximum size of the DNS resolver cache The size of the cache is maintained by the WIP library range 1 292 default value 4 WaVe COMM ccontidentia Page 23 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless General Configuration IP Stack Handling WIPCFG 12 AT_WIP_NET_OPT_PREF_TIMEOUT VALUE Used for TCP sockets to configure the packet segmentation on IP network side This option is used to specify the maximum time to wait between two successive data chunks received from the mapped UART serial port please see WIPDATA AT command It allows the application to buffer a certain amount of data before writing on IP network side Each unit in the range represents 100 msec For example value 10 for this option will give a wait time of 1sec 10 100mesc Default value for AT WIP_NET_OPT_PREF_TIMEOUT VALUE option is O This value means that no specific process is done to avoid TCP packets segmentation data are written onto IP network without any delay after the reception of data from the mapped UART serial port please see WIPDATA AT command In this case some TCP pa
80. iber Information Module SMTP Simple Mail Transfer Protocol TCP Transmission Control Protocol TOS Type Of Service W VeECO M oconfidentiai Page 10 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 waevecom Make it wireless Introduction Abbreviations and Definitions TTL Time To Live UART Universal Asynchronous Receiver Transmitter UDP User Data Protocol URL Uniform Resource Locator WIP Wavecom Internet Protocol Wave COM ccontidential Page 11 126 This document is the sole and exclusive property of WWAVECOM Not to be distributed or divulged without prior written agreement WML_DEV_OAT_UGD_076 September 11 2008 waevecom Make it wireless Introduction Logos 1 3 Logos This picture indicates the WIND indication from which the AT command is allowed X values can be 1 3 4 16 This picture indicates that a SIM card must be inserted to support the AT command This picture indicates that an AT command is supported even if the SIM card is absent This picture indicates that the PIN 1 CHV 1 code must be entered to support the AT command This picture indicates that an AT command is supported even if the PIN 1 CHV 1 code is not entered This picture indicates that the PIN 2 CHV 2 code must be entered to support the AT command This
81. ilure no carrier 810 bearer connection failure no sim card present 811 bearer connection failure sim not ready no pin code entered 812 bearer connection failure GPRS network failure 813 bearer connection failure PPP LCP negotiation failed 814 bearer connection failure PPP authentication failed 815 bearer connection failure PPP IPCP negotiation failed 816 bearer connection failure PPP peer terminates session 817 bearer connection failure PPP peer does not answer to echo request 818 incoming call refused 819 error on Ping channel 820 error writing configuration in FLASH memory 821 error reading configuration in FLASH memory 822 829 reserved for future use WaVe COMM ccontidentia Page 124 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless Error Codes Creating TCP client and server sockets in the same Wireless CPU at the same time mapping or unmapping the UART to exchange the data between the sockets 4 CMEE AT error code Description 830 bad index 831 bad state 832 bad port number 833 bad port state 834 not implemented 835 option not supported 836 memory allocation error 837 bad protocol 83
82. lready active 842 destination host unreachable whether host unreachable Network unreachable response timeout 845 attempt is made to reserve create a client socket which is already reserved opened by TCP server client 860 protocol undefined or internal error WaVe COMM ccontidentia Page 44 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless IP Protocol Services Service Creation WIPCREATE CMEE AT error code Description 861 user name rejected by server 862 password rejected by server 865 authentication error 866 server not ready error 5 1 6 Examples Command Responses AT WIPCREATE 1 1 80 OK Note Create the UDP socket on local port 80 with Note An unsolicited event WIPREADY 1 7 will be received once the UDP socket is ready r i communication index 1 Wireless CPU acts as for usage an UDP server awaiting for incoming datagram on local port 80 AT WIPCREATE 1 1 www wavecom co OK m 80 Note Create the UDP socket on arbitrary free local Note An unsolicited event WIPREADY 1 1 port with peer IP and peer port 80 with will be received once the UDP socket is ready 8 r P communication index 1 Wireless CPU acts as for usage a UDP client that can send datagram towards the remote enti
83. lusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom n Make it wireless Data Exchange for Protocol Services Socket Data exchange WIPDATA 6 2 5 Resetting TCP Sockets A TCP socket is reset when the connection is aborted due to an error on the socket When the socket is reset an ETX character is sent on the mapped UART to indicate the end of communication The mapped UART switches to AT mode and CME ERROR 843 is displayed on the UART 6 2 6 Syntax Action Command AT WIPDATA lt protocol gt lt idx gt lt mode gt CONNECT Read Command AT WIPDATA NONE Test Command AT WIPDATA OK e if lt protocol gt 1 Unsolicited response WIPDATA lt protocol gt lt idx gt lt datagram size gt lt peer IP gt lt peer port gt Caution Using WIP AT commands when receiving several UDP datagrams on an IP bearer WIPDATA indication is sent once for the first received datagram Next indication for next remaining UDP datagram to read is sent once the first datagram have been read using WIPDATA commana e if lt protocol gt 2 Unsolicited response WIPDATA lt protocol gt lt idx gt lt number of readable bytes gt Caution The value returned by lt number of readable bytes gt indicates that there is some TCP data ready to be read but number of bytes
84. n Command AT WIPBR lt cmdtype gt lt bid gt lt opt num gt lt value gt OK e if lt cmdtype gt 3 Action Command AT WIPBR lt cmdtype gt lt bid gt lt opt num gt WIPBR lt bid gt lt opt num gt lt value gt OK e if lt cmdtype gt 4 Action Command AT WIPBR lt cmdtype gt lt bid gt lt mode gt lt login gt lt password gt lt caller identity gt OK WaVecCoMccontidentia Page 30 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless General Configuration Bearers Handling WIPBR e if lt cmdtype gt 6 Action Command AT WIPBR lt cmdtype gt lt bid gt lt mode gt OK Read Command AT WIPBR lt bid gt lt state gt lt bid gt lt state gt OK Test Command AT WIPBR OK e if lt mode gt 1 Unsolicited response WIPBR lt bid gt lt status gt lt local IP gt lt remote IP gt lt DNS1 gt lt DNS2 gt 4 2 3 Parameters and Defined Values lt cmd type gt type of command 0 close bearer 1 open bearer 2 set value of different bearer options 3 get value of different bearer options 4 start bearer 5 stop bearer 6 bearer configuration management lt bid gt bearer Identifier 1 UART1 W VeECOMN
85. n agreement WM_DEV_OAT_UGD_076 September 11 2008 wavecom Make it wireless General Configuration IP Stack Handling WIPCFG e if lt mode gt 4 Action Command AT WIPCFG lt mode gt lt action gt OK Read Command AT WIPCFG WIPCFG lt optnum gt lt value gt WIPCFG lt optnum gt lt value gt OK Test Command AT WIPCFG OK WaVeCOMCccontidentia Page 19 126 This document is the sole and exclusive property of WWAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom a Make it wireless General Configuration IP Stack Handling WIPCFG 4 1 3 Parameters and Defined Values lt mode gt requested operation O stop TCP IP stack 1 start TCP IP stack 2 configure TCP IP stack 3 display TCP IP application version 4 TCP IP stack configuration management lt opt num gt configuration option identifier O WIP_NET_OPT_IP_TTL Default TTL of outgoing data grams This option is a limit on the period of time or number of iterations or transmissions that a unit of data can experience before it should be discarded The time to live TTL is an 8 bit field in the Internet Protocol IP header It is the 9th octet of 20 The default value of this parameter is 64 Its value can be considered as an upper bound on the time that an IP datagram can exist in an internet sys
86. name gt lt username gt lt password gt lt headers list gt CONNECT OK WaVvecomccontidentia Page 66 126 This document is the sole and exclusive property of WWAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless Data Exchange for Protocol Services File Exchange W IPFILE e if lt protocol gt 6 Action Command AT WIPFILE lt protocol gt lt index gt lt mode gt CONNECT OK e if lt protocol gt 7 Action Command AT WIPFILE lt protocol gt lt index gt lt mode gt lt filename gt CONNECT OK e if lt protocol gt 5 Unsolicited response WIPFILE 5 lt index gt lt mode gt lt http status code gt lt http status reason gt Read command AT WIPFILE OK Test Command AT WIPFILE OK Wave COMM ecconfidential Page 67 126 This document is the sole and exclusive property of WWAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom n Make it wireless Data Exchange for Protocol Services File Exchange WIPFILE 6 1 5 Parameters and Defined Values lt protocol gt protocol type FTP HTTP SMTP Noo oO A POP3 lt idx gt channel identifier lt mode gt file transfer mode 1 This command switches the UART
87. note the importance or priority of the datagram The second field is TOS which denotes how the network should maintain the tradeoffs between throughput delay reliability and cost The last field is MBZ Must Be Zero is currently unused and is set to O The TOS field can have the following values 1000 minimize delay 0100 maximize throughput 0010 maximize reliability 0001 minimize monetary cost 0000 normal service For more information on this field please refer to RFC1349 range O 255 default value O Wave COMM ecconfidential Page 21 126 This document is the sole and exclusive property of WWAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom n Make it wireless General Configuration IP Stack Handling WIPCFG 2 WIP_NET_OPT_IP_FRAG_TIMEO Time to live in seconds of incomplete fragments When a datagram s size is larger than the MTU Maximum Transmission Unit of the network then the datagram is divided into smaller fragments These divided fragments are sent separately The WIP_NET_OPT_IP_FRAG_TIMEO option specifies the Time to live for these fragments range 1 65535 default value 60 3 WIP_NET_OPT_TCP_MAXINITWIN Number of segments of initial TCP window This option is used to specify the number of segments in the initial TCP window A TCP window specifies the amount of ou
88. ntax Command Line 2 AT Command Syntax This section describes the AT command format and the default value for their parameters 2 1 Command Line Commands always start by the standard prefix AT WIP and end with the lt CR gt character Optional parameters are shown in brackets Example AT WIPcmd lt Param1 gt lt Param2 gt lt Param2 gt is optional When the AT W1IPcmd is executed without lt Param2 gt the default value of lt param2 gt is used WaVeCOMCccontidentia Page 14 126 This document is the sole and exclusive property of WWAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom a Make it wireless AT Command Syntax Information Responses and Result Codes 2 2 Information Responses and Result Codes Responses start and end with lt CR gt lt LF gt except for the ATVO DCE response format and the ATQ1 result code suppression commands e If command syntax is incorrect the ERROR string is returned e If command syntax is correct but transmitted with wrong parameters the CME ERROR lt Err gt or CMS ERROR lt SmsErr gt strings is returned with adequate error codes if CMEE was previously set to 1 By default CMEE is set to O and the error message is only ERROR e If the command line has been executed successfully an OK string is returned In some cases such as AT CPIN or unsolicited incoming eve
89. nts the product does not return the OK string as a response In the following examples lt CR gt and lt CR gt lt LF gt are intentionally omitted WaVeCOMCccontidentia Page 15 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 wevecom a Make it wireless Principles Information Responses and Result Codes 3 Principles The wipSoft is an Open AT application that implements the TCP IP protocols using custom AT commands This Open AT application operates in co operative mode and must be downloaded to the Wavecom Wireless CPU The commands are sent from an external application and the corresponding responses are sent back from the Wavecom Wireless CPU to the external application The wipSoft uses the APIs provided by wipLib and provides custom AT command interface to the external application AT WIP commands involve e a host computer which issues AT WIP commands e wavecom s wireless CPU e the rest of the Internet Intranet gt Host CPU Wavecom WCPU INTERNET AT Commands Multiplexing Several sockets can be operating at once The WIPDATA command allows to temporarily identify the UART in data mode with a given socket The data written on UART is transferred through the socket The data which arrives on the socket can be read from the UART In AT mode the host receives
90. ocal IP address lt remote IP gt remote IP address first node in internet lt DNS1 IP gt Domain Name Server address lt DNS2 IP gt Domain Name Server address lt login gt PPP login lt passwd gt PPP password lt caller identity gt optional ASCII string type ascii If not specified then target will accept all DATA calls independently of caller identification If specified target will only accept calls from lt caller identity gt which is the GSM data call number of the GSM client IP are displayed in alpha numeric dot format e g 192 168 0 1 When no IP address is known 0 0 0 0 is displayed Caution The options WIP_BOPT_IP_ADDR WIP_BOPT_IP_DST_ADDR WIP_BOPT_IP_DNS1 and WIP_BOPT_IP_DNS2 can be read after the bearer connection is established successfully If an attempt is made to read the options value before the bearer connection is established successfully incorrect IP address will be received 4 2 4 Parameter Storage Several bearer configuration set can be saved Calling twice AT WIPBR 6 lt bid gt 1 with the same lt bid gt will store the last configuration set e AT WIPBR 6 lt bid gt 1 is used to store the bearer configuration parameters set associated with the bearer lt bid gt into the FLASH memory e AT WIPBR 6 lt bid gt 0 is used to free the bearer configuration parameters set associated with the bearer lt bid gt Executing
91. property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless Data Exchange for Protocol Services File Exchange W IPFILE CMEE AT error code Description 830 bad index 831 bad state 834 not implemented 836 memory allocation error 837 bad protocol 839 error during channel creation 846 internal error FCM subscription failure 860 protocol undefined or internal error 867 POP3 email retrieving error 868 POP3 email size error 880 SMTP sender email address rejected by server 881 SMITP recipient email address rejected by server 882 SMTP CC recipient email address rejected by server 883 SMTP BCC recipient email address rejected by server 884 SMTP email body send request rejected by server 6 1 8 Examples Command Responses AT WIPFILE 4 1 1 data bin CONNECT lt data received terminated by ETX character gt Note Retrieve the data for the given filename with OK index 7 AT WIPFILE 4 1 2 report 1log CONNECT lt data terminated by ETX character gt Note Send data to the given filename OK WaVeCOMMccontidentia Page 70 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom M
92. protocol 5 2 6 Examples Command Responses AT WIPCLOSE 1 1 OK Note Close UDP socket with communication index 7 AT WIPCLOSE 2 1 OK Note Close TCP client with communication index 7 WaVecCOMcconridentia Page 50 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless IP Protocol Services Closing a Service WIPCLOSE AT WIPCLOSE 3 1 OK Note Close TCP server with communication index 1 AT WIPCLOSE 4 1 OK Note Close FTP session with index 1 Note An unsolicited event WIPPEERCLOSE 4 7 is received once the FTP session is closed AT WIPCLOSE 5 1 OK Note Close HTTP session with index 1 AT WIPCLOSE 6 1 OK Note Close SMTP session with index 1 AT WIPCLOSE 7 1 OK Note Close POP3 session with index 1 5 2 7 Notes After issuing WIPCLOSE command no more data can be sent and received over the socket session In case of FTP protocol the closure of FTP session is indicated by WIPEERCLOSE unsolicited response when WIPCLOSE command is used for closing the session In case of TCP and UDP sockets response OK is returned when the WIPCLOSE command is executed irrespective of whether the socket is active or not But in case of FITP HTTP SMTP POP3 session OK response is returned if WIPCLOSE command is executed wh
93. r set APN name of GPRS bearer set user name set password start GPRS bearer connect to remote SMTP server connection and authentication are successful set sender mail address set sender name set receiver mail address set CC receiver mail address WaVecComMcconridentia Page 102 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 waevecom Make it wireless Examples of Application SMTP AT WIPOPT 6 1 2 65 bcecrecOl mail Set BCC mail address com bccrec0O2 mail com OK AT WIPOPT 6 1 2 66 mail subject Set mail subject OK AT WIPFILE 6 1 2 send mail CONNECT lt user starts sending mail with the UART in data mode and ends with an ETX character gt OK WaVeCOMCccontidentia Page 103 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless 9 7 POPS AT WIPCFG 1 OK AT WIPBR 1 6 OK AT WIPBR 2 6 11 APN name OK AT WIPBR 2 6 0 user name OK AT WIPBR 2 6 1 passwd OK AT WIPBR 4 6 0 OK AT WIPCREATE 7 1 192 168 1 2 11 0 user password OK WIPREADY 7 1 AT WIPOPT 7 1 1 71 7 11710 WIPOPT OK AT WIPOPT 7 1 1 72 WIPOPT
94. retransmission of the data to the peer TCP socket within the timeout period is managed by the Open AT Plug in WIP Lib 6 2 11 4 Packet Segmentation in TCP Socket The data sent to a mapped TCP socket through UART will be buffered before sending it to the peer This buffered data will be sent to the peer when e total amount of buffered data is twice or more than the preferred segmentation size The preferred segmentation size is configurable through the AT WIPCFG 2 4 lt size gt WIP_NET_OPT_TCP_MIN_MSS command e internal timer expires The timeout period is configurable through the AT WIPCFG 2 12 lt time gt AT_WIP_NET_OPT_PREF_TIMEOUT VALUE command e socket is unmapped shut down or closed In some scenarios there might be a segmentation of data packets because of timer expiration network problems etc Thus a single packet of data may be received in more than one packet at the peer WaVeCOMCccontidentia Page 84 126 This document is the sole and exclusive property of WWAVECOM Not to be distributed or divulged without prior written agreement WML_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless Ping Services PING command WIPPING 7 Ping Services 7 1 PING command WIPPING i a go EE 7 1 1 Description The WIPPING command is used to configure different PING parameters and to send PING requests An unsolicited response is displayed each time a PING echo e
95. s document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 waevecom Make it wireless Examples of Application Creating TCP client and server sockets in the same Wireless CPU at the same time mapping or unmapping the UART to exchange the data between the sockets abc data sent to socket index 1 and switched to AT mode by giving OK AT WIPDATA 2 1 1 exchange data on socket index 1 CONNECT abc data received from socket index 3 OK W VeECO M oconfidentiai Page 123 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless Error Codes Creating TCP client and server sockets in the same Wireless CPU at the same time mapping or unmapping the UART to exchange the data 10 Error Codes between the sockets 4 CMEE AT error code Description 800 invalid option 801 invalid option value 802 not enough memory 803 operation not allowed in the current WIP stack state 804 device already open 805 network interface not available 806 operation not allowed on the considered bearer 807 bearer connection failure line busy 808 bearer connection failure no answer 809 bearer connection fa
96. sequence lt response time gt PING response time in millisecond 7 1 4 Parameter Storage None 7 1 5 Possible Errors CMEE AT error code Description 800 invalid option 801 invalid option value 819 error on ping channel WaVe COMM ccontidentia Page 86 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless Ping Services PING command WIPPING 7 1 6 Examples Command Responses AT WIPPING www wavecom com OK WIPPING 1 0 0 Note Ping www wavecom com Note Ping www wavecom com failed timeout expired OK AT WIPPING 192 168 0 1 PP W NG 0 0 224 Note Ping 192 168 0 1 succeeded Ping response received in 224 ms Note Ping 192 168 0 1 AT WIPPING 192 168 0 1 2 2000 1000 OK WIPPING 0 0 880 WIPPING 1 1 xxxx Note Send 2 successive ping requests to 192 168 0 1 Each Ping is every 2000 ms timeout is set to 2000 ms if ping responses time is more than 1000 ms then timeout Note Ping 192 168 0 1 succeeded First Ping response received in 880 ms Second one was not received before specified expires timeout 1000 ms timeout expired WaVeCOMCccontidentia Page 87 126 This document is the sole and excl
97. socket is connected to the peer AT WIPCREATE 2 P 8 192 168 0 2 i 80 create a TCP client towards peer IP device 192 168 0 2 port 80 OK all parameters and IP stack behavior are OK WIPREADY 2 8 unsolicited the TCP client socket is connected to the peer AT WIPCREATE 2 8 192 168 0 2 80 create a TCP client towards peer IP device 1 192 168 0 2 port 80 Index 8 is already CME ERROR 840 used and corresponds to an active socket AT WIPCREATE 2 9 192 168 0 2 80 create a TCP client towards a peer IP device 1 192 168 0 2 port 80 Index 9 is forbidden CME ERROR 830 AT WIPCREATE 4 1 ftp create FTP session using default port 27 server user name password OK FTP session is created successfully AT WIPCREATE 7 1 POP3 server user name mail id M attempt of creating a OP3 session returns an CME ERROR 840 error as already 1 FTP session is active AT WIPCLOSE 4 1 close FTP session OK ie unsolicited FTP session is closed WIPPEERCLOSE 4 1 successfully AT WIPCREATE 7 r 1 fas POP3 create POP3 session using default port 110 server user name mail id OK all parameters and IP stack behaviors are OK WaVeCOMecconridentia Page 119 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_
98. ss CPU Data contains a no escaped DLE the data sent from the Wireless CPU to Desktop PC1 will contain an escaped DLE preceding the DLE character Desktop PC1 receives DLE DLE character from Wireless CPU The scenario is same for both TCP and UDP sockets Protocol Mapped UART IP Network active socket UDP Data containing DLE DLE Data containing DLE sequence UDP DLE alone A single DLE is ignored TCP Data containing DLE DLE Data containing DLE sequence TCP DLE alone A single DLE is ignored 6 2 3 Continuous Transparent Mode 6 2 3 1 TCP Sockets in Continuous Transparent Mode In this mode there is no special meaning associated for DLE ETX characters They are considered as normal data and all the data will be transmitted on the mapped UART UDP sockets do not support this mode Attempting to map an UART in this mode will result in a CME ERROR 837 6 2 4 Leaving Continuous Continuous Transparent Mode The UART can be switched back to AT mode e by sending with 1 second guard time before and after the sequence e by sending an AT WIPDATA lt proto lt index gt O0 on another UART in AT mode When the UART leaves data mode either because of escape sequence or because of an unmapping done on another UART the currently unsent data are sent as a single datagram WaVvecomccontidentia Page 78 126 This document is the sole and exc
99. ss rejected by server 883 SMTP BCC recipient email address rejected by server 884 SMTP email body send request rejected by server Wave COM ccontidential Page 126 126 This document is the sole and exclusive property of WWAVECOM Not to be distributed or divulged without prior written agreement WML_DEV_OAT_UGD_076 September 11 2008 wovecom Make it wireless WAVECOM S A 3 esplanade du Foncet 92442 Issy les Moulineaux Cedex France Tel 33 0 1 46 29 08 00 Fax 33 0 1 46 29 08 08 Wavecon Inc 4810 Eastgate Mall Second Floor San Diego CA 92121 USA Tel 1 858 362 0101 Fax 1 858 558 5485 WAVECOM Asia Pacific Ltd 4 F Shui On Centre 6 8 Harbour Road Hong Kong Tel 852 2824 0254 Fax 852 2824 025 Wwww wavecom com
100. tack OK AT WIPBR 1 6 open GPRS bearer OK AT WIPBR 2 P 6 11 APN name set APN name of GPRS bearer OK AT WIPBR 2 6 0 user name set user name OK AT WIPBR 2 6 1 passwd set password OK AT WIPBR 4 6 0 start GPRS bearer OK AT WIPCREATE 3 2 80 1 2 create the server on port 80 idx 2 The server is listening for connection request on port 80 OK Spawned sockets will be given the index 7 or 2 It will accept connection request until has nor more socket left AT WIPCREATE 2 i 3 198 168 0 1 r 80 create a TCP client towards peer IP device 1 198 168 0 1 port 80 Yall parameters and IP stack behavior are OK IPREADY 2 3 unsolicited the TCP client socket is connected to the peer TPACCEPT 2 1 unsolicited the server index accepted a connection resulting TCP client on idx 1 AT WIPDATA 2 4 3 F 1 exchange data on socket index 3 CONNECT AT WIPDATA 2 1 1 exchange data on socket index 1 CONNECT WaVecCoMccontidentia Page 107 126 This document is the sole and exclusive property of WWAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 waevecom Make it wireless Examples of Application Creating a Server and try to create a TCP Client Server on a reserved index reserved by the Server will fail ETX send unescaped ETX character PPEERCLOSE 2 3 unsolicited peer socket is
101. tem The TTL field is set by the sender of the datagram and reduced by every host on the route to its destination If the TTL field reaches zero before the datagram arrives at its destination then the datagram is discarded This is used to avoid a situation in which an undelivered datagram keeps circulating in the network range 0 255 default value 64 W VeECO M oconfidentiai Page 20 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless General Configuration IP Stack Handling WIPCFG 1 WIP_NET_OPT_IP_TOS Default TOS of outgoing parameters The IP protocol provides a facility for the Internet layer to know about the various tradeoffs that should be made for a particular packet This is required because paths through the Internet vary widely in terms of the quality of service provided This facility is defined as the Type of Service facility abbreviated as the TOS facility The TOS facility is one of the features of the Type of Service octet in the IP datagram header The Type of Service octet consists of following three fields 0 1 2 3 4 5 6 7 PRECEDENCE TOS MBZ The first field is PRECEDENCE It is intended to de
102. ters and IP stack behavior are OK unsolicited the UDP client socket is pseudo Z connected to the peer no real connection is UDP create a UDP client towards peer IP device 1 192 168 0 1 port 87 Yall parameters and IP stack behavior are OK unsolicited the UDP client socket is pseudo Z connected to the peer no real connection is UDP create a UDP client towards peer IP device 1 192 168 0 1 port 82 Hall parameters and IP stack behavior are OK unsolicited the UDP client socket is pseudo connected to the peer no real connection is UDP Wave COMM confidential Page 111 126 This document is the sole and exclusive property of WWAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless Examples of Application Creating 8 UDP sockets 8 TCP clients and 4 TCP servers AT WIPCREATE 1 9 63 192 168 0 1 83 CME ERROR 830 AT WIPCREATE 3 1 80 1 1 OK AT WIPCREATE 3 2 81 2 2 OK AT WIPCREATE 3 3 82 3 3 OK AT WIPCREATE 3 4 83 4 4 OK AT WIPCREATE 3 5 84 5 5 CME ERROR 830 AT WIPCREATE 2 1 192 168 0 1 80 CME ERROR 845 tWIPACCEPT 1 1 tWIPACCEPT 2 2 tWIPACCEPT 3 3 tWIPACCEPT 4 4 AT WIPCREATE 2 5 192 168 0 1 80 OK WIPREADY 2 5 AT WIPCREATE 2 6 192 168 0 1 80 OK 4 8 UDP sockets have been created an
103. tstanding unacknowledged by the recipient data a sender can send on a particular connection before it gets an acknowledgment back from the receiver The primary reason for the window is congestion control range O 65535 default value O 4 WIP_NET_OPT_TCP_MIN_MSS Default MSS of off link connections This option is used by the Open AT Plug in WIP Lib internally This parameter specifies the maximum size of TCP segment which would be sent By default the value of this parameter is set to 536 Hence Open AT Plug in WIP Lib would not send any TCP segment having a length greater than 536 bytes without header range 536 1460 default value 536 5 WIP_NET_OPT_DEBUG PORT This option is used to specify the port on which the debug traces are to be sent range O 3 default value O 6 WIP_NET_OPT_SOCK_MAX Total number of sockets TCP and UDP This option specifies the maximum number of TCP and UDP sockets that can be created at one particular time range 1 23 default value 20 WaVecCoMccontidentia Page 22 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless General Configuration IP Stack Handling WIPCFG 7 WIP_NET_OPT_BUF_MAX Total number of network buffers The total number of network buffers which will be used that can be specified
104. ty AT WIPCREATE 1 1 80 www wavecom OK com 80 Note Create the UDP socket on local port 80 with Note An unsolicited event WIPREADY 1 1 peer IP and peer port 80 with communication index will be received once the UDP socket is ready 1 Wireless CPU acts as a UDP client and an for usage UDP server it can send datagram towards the remote entity and receiving datagram on the specitied local port AT WIPCREATE 3 1 80 5 8 OK Note Create the TCP server on port 80 with server Note An unsolicited event WIPACCEPT 1 5 index 1 Wireless cPu acts as a TCP server it va be received once the TCP server is ready will from now on spawn TCP client socket from Of Usage communication index 5 to 8 AT WIPCREATE 2 1 IP ADDR 80 OK WaVeCOMMccontidentia Page 45 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless IP Protocol Services Service Creation WIPCREATE Command Responses Note Create the TCP client on port 80 with Note An unsolicited event WIPREADY 2 7 index 1 Wireless cPu acts as a TCP client it will be received once the TCP client is ready for R usage can from now on communicate with the remote g specified entity through communication index 1 AT WIPCREATE 4 1 ftp wavecom co m admin 123456
105. ulged without prior written agreement WML_DEV_OAT_UGD_076 September 11 2008 waevecom Make it wireless Data Exchange for Protocol Services Service Option Handling WIPOPT 6 Data Exchange for Protocol Services The section deals with the data exchange for the services over TCP IP All the commands required for the data exchange through different services are mentioned in succeeding sections WaVeCOMCccontidentia Page 63 126 This document is the sole and exclusive property of WWAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 wevecom Make it wireless Data Exchange for Protocol Services File Exchange W IPFILE 6 1 File Exchange WIPFILE E a ao RE 6 1 1 Description The WIPFILE command define the file system services that allow sending a block of data through standard TCP IP protocols This command is for file transfer reception 6 1 2 ETX Escaping Mechanism In case an ETX character needs to be transmitted as data it should be preceded by DLE character A single ETX character marks the end of transmission Similarly ETX characters received from the internet are sent to the host through the serial port preceded by a DLE character GSM GPRS Data received from PC1 ab ETX c Data sent to PC1 ab ETX c MAPPED UART Desktop PC1 Data sent to PC2 ab DLE ETX c ETX
106. ult settings of the stack is changed using WIPCFG command Following option values set by WIPCFG command are taken into consideration at the run time The below option values except for AT_WIP_NET_OPT_PREF_TIMEOUT VALUE will be taken into consideration at next start up only if these are saved in the flash before stoping the stack e WIP_NET_OPT_IP_TTL WIP_NET_OPT_IP_TOS WIP_NET_OPT_IP_FRAG_TIMEO WIP_NET_OPT_TCP_MAXINITWIN WIP_NET_OPT_TCP_MIN_MSS WIP_NET_OPT_DEBUG PORT AT_WIP_NET_OPT_PREF_TIMEOUT_ VALUE Following option values set by WIPCFG command are taken into consideration in the next start up only if these are saved in the flash before stoping the stack e WIP_NET_ OPT SOCK MAX WIP_NET_OPT_BUF_ MAX WIP_NET_OPT_IP_ROUTE MAX WIP_NET_OPT_RSLV_QUERY_ MAX WIP_NET_OPT_RSLV_CACHE MAX WaVvecomccontidentia Page 29 126 This document is the sole and exclusive property of WWAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 wevecom Make it wireless General Configuration Bearers Handling WIPBR 4 2 Bearers Handling WIPBR EJE 4 2 1 Description The WIPBR command can be used to e select the bearer e start close the bearer e configure different bearer options such as access point name lt 4 2 2 Syntax e if lt cmdtype gt 0O 1 or 5 Action Command AT WIPBR lt cmdtype gt lt bid gt OK e if lt cmdtype gt 2 Actio
107. usive property of WWAVECOM Not to be distributed or divulged without prior written agreement WML_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless WIPSoft Library API PING command WIPPING 8 WIPSoft Library API The WIPSoft Application provides a comprehensive and flexible environment to use the IP feature using AT commands The WIPSoft Application is an Open AT Application and it uses the Open AT Plug in WIP Lib as the TCP IP protocol stack Hence when the WIPSoft application executed no other Open AT Application can be executed in the Wireless CPU WIPSoft API allow customer application to subscribe for AT WIP commands Customer application can subscribe to AT WIP commands using WIP Soft library API This feature allows customer application to use ADL services with WIPSoft services Note that concurrent access to IP stack from WIPSoft library and WIP library results in unpredictable events and behavior Hence it is recommended to us either WIPSoft library API or WIP library at a time but not both at the same time The FCM flow through which the WIP AT commands are executed is subscribed by the WIPSoft library to transfer data between the Wireless CPU and the external device Hence if the WIPSoft library is subscribed from the Open AT Application same FCM flow should not be subscribed from the same Open AT Application WaVeCOMCccontidentia Page 88 126 This document is the sole
108. ut mechanism to check the state of the TCP sockets in a TCP socket connection According to this mechanism to know the state of the peer TCP socket the data needs to be sent and wait for the acknowledgement within a specified time period If the acknowledgement is not received within the specified time out period then the data is retransmitted But if the time out occurs before receiving acknowledgement then it implies that the peer TCP socket is closed TCP Timeout Period function R N Where R Round trip time This is the time for a TCP packet to go to the remote TCP socket and the time to receive the acknowledgement by the transmitter TCP socket The typical round trip time is 1 seconds for GPRS N Number of retransmission allowed before the time out happens Hence the typical timeout period is 10 minutes depending on the network and also the peer TCP socket localization WaVvecomMcconridentia Page 83 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless Data Exchange for Protocol Services Socket Data exchange WIPDATA In WIP Soft to know the state of the peer socket data needs to be sent If acknowledgement is not received within the timeout period then CME ERROR 842 is returned This indicates that the peer socket is closed Please note that the
109. vent is received or a timeout expires 7 1 2 Syntax Action Command AT WIPPING lt host gt lt repeat gt lt interval gt lt timeout gt lt nwrite gt lt tt 1 gt 1 OK Read Command AT WIPPING OK Test Command AT WIPPING OK Unsolicited response WIPPING lt timeout_expired gt lt packet_idx gt lt response_time gt WaVvecomccontidentia Page 85 126 This document is the sole and exclusive property of WWAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless Ping Services PING command WIPPING 7 1 3 Parameters and Defined Values lt host gt host name or IP address string lt repeat gt number of packets to send range 1 65535 default value 1 lt interval gt number of milliseconds between packets range 1 65535 default value 2000 lt timeout gt number of milliseconds before a packet is considered lost range 1 65535 default value 2000 lt ttl gt IP packet Time To Live Default value is set by WIP_NET_OPT_IP_TTL WIPCFG option range 0 255 lt nwrite gt size of packets range 1 1500 default value 64 lt timeout_expired gt PING result O PING response received before lt timeout gt 1 lt timeout gt expired before the response was received lt packet_idx gt packet index in the
110. x CME ERROR 845 1 and hence error is returned WaVvecomccontidentia Page 109 126 This document is the sole and exclusive property of WAVECOM Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 September 11 2008 weaevecom Make it wireless Examples of Application Creating 8 UDP sockets 8 TCP clients and 4 TCP servers 9 11 Creating 8 UDP sockets 8 TCP clients and 4 TCP servers AT WIPCFG 1 OK AT WIPBR 1 6 OK AT WIPBR 2 6 11 APN name OK AT WIPBR 2 6 0 user name OK AT WIPBR 2 6 1 passwd OK AT WIPBR 4 6 0 OK AT WIPCREATE 1 1 55 192 168 0 1 75 OK WIPREADY 1 1 AT WIPCREATE 1 2 56 192 168 0 1 716 OK WIPREADY 1 2 AT WIPCREATE 1 3 57 192 168 0 1 77 OK start IP stack open GPRS bearer set APN name of GPRS bearer set user name set password start GPRS bearer create a UDP client towards peer IP device V 192 168 0 1 port 75 Yall parameters and IP stack behavior are OK unsolicited the UDP client socket is pseudo connected to the peer no real connection is UDP create a UDP client towards peer IP device 1 192 168 0 1 port 76 Yall parameters and IP stack behavior are OK unsolicited the UDP client socket is pseudo connected to the peer no real connection is UDP create a UDP client towards peer IP devi

AT COMMANDS USER GUIDE FOR WAVECOM IP V5.01

Contents

Download Pdf Manuals

Related Search

Related Contents