Home

AT Commands User Guide for Wavecom IP v5.11

1. escape sequence or because of an unmapping done on another UART the currently unsent data are sent as a single datagram wavecom 6 Confidential Page 74 122 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 003 December 15 2008 waovecom Smart wireless Smart business 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 lt send size gt lt wait time 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 Unso
2. filename txt cownload file filename txt CONNECT lt data gt ETX OK wavecom 6 Confidential Page 96 122 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 003 December 15 2008 waovecom Smart wireless Smart business 9 5 HTTP 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 5 1 www siteaddress com 81 username password h eader name header value OK WIPREADY 5 1 AT WIPOPT 5 1 1 51 WIPOPT 5 51 lt sender buffer size gt OK AT WIPOPT 5 1 2 53 6 OK Examples of Application HTTP start IP stack open GPRS bearer set APN name of GPRS bearer set user name set password start GPRS bearer connect to remote HTTP proxy server port 81 with authentication and some header fields connection and authentication are successful get size of the TCP send buffer size get option successful set maximum number of redirects Page 97 122 wavecom 6 Confidential 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 003 December 15 2008 wovecom Smart wireless Smart business Examples of Applica
3. wavecom 6 Confidential Page 94 122 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 003 December 15 2008 waovecom Smart wireless Smart business 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 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 WIPPING 192 168 0 1 start PING session OK WIPPING 0 0 224 wavecom 6 confidential Page 95 122 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 003 December 15 2008 waovecom Smart wireless Smart business Examples of Application 9 4 FTP 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 4 1 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
4. set value of different bearer options get value of different bearer options start bearer stop bearer al A W N gt bearer configuration management lt bid gt bearer Identifier UART1 UART2 N A N A GSM 6 GPRS 11 14 CM UX port over UART1 21 24 CMUX port over UART2 oy A l N gt lt opt num gt bearer option identifier wavecom 6 Confidential Page 28 122 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 003 December 15 2008 woaovecom Smart wireless Smart business General Configuration Bearers Handling WIPBR 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 O0 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 11 WIP_BOPT_GPRS APN Address of
5. wavecom 6 Confidential start IP stack open 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 followed by an shutdown connection reset by peer Page 103 122 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 003 December 15 2008 woaovecom Smart wireless Smart business Examples of Application Creating a Server and try to create a TCP Client Server on a reserved index 9 9 Creating a Server and reserved by the Server will fail try to create a TCP Client Server on a reserved index reserved by the Server will fail 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 2 80 1 2 OK AT WIPCREATE
6. User Manual WIP AT Commands User Guide WIPSoft v5 11 Reference WM DEV OAT UGD 076 Revision 003 Date December 15 2008 Cellular Modem AT Firmware Embedded Applications C Lua RRR integrated Development Environment gt Real Time Multitasking OS i Embedded Plugins wovecomnm Smart wireless Smart business Wireless CPUs Operating Systems Integrated Development Environments Plug Ins Services waovecom Smart wireless Smart business AT Commands User Guide for Wavecom IP v5 11 Reference WM_DEV OAT_UGD 076 Revision 003 Date December 15 2008 wavecoms confidential Page 1 122 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 003 December 15 2008 wavecom Smart wireless Smart business AT COMMANDS USER GUIDE FOR WAVECOM IP v5 11 Trademarks 3 wavecom inSIM YOU MAKE IT WE MAKE IT WIRELESS WAVECOM Wireless Microprocessor Wireless CPU Open AT and certain other trademarks and logos appearing on this document are filed or registered trademarks of Wavecom S A in France and or in other countries All other company and or product names mentioned may be filed or registered trademarks of their respective owners Copyright This manual is copyrighted by WAVECOM with all rights reserved No part of this manual may be reproduced modified o
7. text html W VecCcon o Confidential Page 66 122 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 003 December 15 2008 woaovecom ees Smart wireless Smart business Data Exchange for Protocol Services File Exchange WIPFILE Command Responses AT WIPFILE 5 1 1 urlForGet user CONNECT name password Accept text ht f lt data received terminated b ml Tansfer Codings compress 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 AT WIPFILE 5 1 3 urlForDelete CONNECT lt data received terminated by ETX character gt OK WIPFILE 5 1 3 lt http status code gt lt http status reason gt Note Send a HTTP DELETE request to URL AT WIPFILE 5 1 4 urlForPost CONNECT lt data received terminated by ETX character gt OK WIPFILE 5 1 4 lt h
8. Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD 076 003 December 15 2008 woaovecom Smart wireless Smart business 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 76 OK WIPREADY 1 2 AT WIPCREATE 1 3 57 192 168 0 1 17 OK WIPREADY 1 3 AT WIPCREATE 1 4 58 192 168 0 1 18 OK wavecom 6 Confidential 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 192 168 0 1 port 75 Hall parameters and IP stack behavior are OK unsolicited the UDP client socket is pseudo 1 connected to the peer no real connection is UDP create a UDP client towards peer IP device 1192 168 0 1 port 76 Hall parameters and IP stack behavior are OK unsolicited the UDP client socket is pseudo 1 connected to the peer no real connection is UDP create a UDP client towards peer IP device 1 192 168 0 1 port 77 Jall parameters and IP stack beha
9. Wwavecom s confidential Page 83 122 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 003 December 15 2008 wevecom i Smart wireless Smart business 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 AT WIPPING 192 168 0 1 OK WIPPING 0 0 224 Note Ping 192 168 0 1 Note Ping 192 168 0 1 succeeded Ping response received in 224 ms 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 Note Ping 192 168 0 1 succeeded First Each Ping is every 2000 ms timeout is set to 1000 ms if Ping response received in 880 ms Second ping responses time is more than 1000 ms then timeout one was not received before specified expires timeout 1000 ms timeout expired wavecom 6 Confidential Page 84 122 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 003 December 15 2008 wevecom an Smart wireless Smart business WIPSoft Library API PING command WIPPING 8 WIPSoft Library API The WIPSoft Application provides
10. 076 003 December 15 2008 WAVECOM S A 3 esplanade du Foncet 92442 Issy les Moulineaux France Tel 33 1 46 29 08 00 Fax 33 1 46 29 08 08 Wavecom Inc 430 Davis Drive Suite 300 Research Triangle Park North Carolina USA Tel 1 919 237 4000 Fax 1 919 237 4140 WAVECOM Asia Pacific Unit 201 207 2nd Floor Bio Informatics Centre No 2 Science Park West Avenue Hong Kong Science Park Shatin New Territories Hong Kong PRC Tel 852 2824 0254 Fax 852 2824 0255 Online contact details GPS and maps waoveconm Smart wireless Smart business
11. 1 Note Set the local IP address for GSM bearer wavecom 6 confidential Page 32 122 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 003 December 15 2008 waovecom a Smart wireless Smart business General Configuration Bearers Handling WIPBR Command Responses AT WIPBR 2 5 16 2 2 2 2 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 AT WIPBR 4 5 0 OK Note Start the GSM bearer as a client AT WIPBR 3 5 15 WLEBR S amp 1l5 Note Read the local IP for GSM bearer OK AT WIPBR 3 5 16 WIPBR 5 16 2 2 2 2 Note Read the destination IP for GSM bearer OK AT WIPBR 5 5 OK Note Stop the GSM bearer AT WIPBR 0 5 OK 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 mo
12. 15 2008 woaovecom Smart wireless Smart business Examples of Application Creating 8 UDP sockets 8 TCP Clients 4 TCP Servers and either one FTP HTTP SMTP POP3 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 f tp create FTP session using default port 21 server user name password OK FTP session is created successfully AT WIPCREATE 7 1 POP3 server user name mail id E 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 WIPPEERCLOSE 4 1 unsolicited FTP session is closed successfully AT WIPCREATE 7 1 POP3 create POP session using default port 110 server user name mail id OK Mall parameters and IP stack behaviors are OK WIPREADY 7 1 unsolicited the POP3 session is created successfully wavecom 6 Confidential Page 116 122 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 003 December 15 2008 woaovecom Smart wireless Smart business Examples of Application Subscribe Unsubscribe WIPSoft AT commands using WIPSoft Library API 9 14 Subscribe Unsubscribe WIPSoft AT commands using WIPSoft Library API include a
13. 2 3 198 168 0 1 80 OK WIPREADY 2 3 WIPACCEPT 2 1 AT WIPDATA 2 3 1 CONNECT AT WIPDATA 2 1 1 CONNECT ETX WIPPEERCLOSE 2 3 wavecom 6 Confidential start IP stack open GPRS bearer set APN name of GPRS bearer set user name set password start GPRS bearer create the server on port 80 idx 2 The server is listening for connection request on port 80 Spawned sockets will be given the index 7 or 2 lt will accept connection request until has nor more socket left create a TCP client towards peer IP device 1 198 168 0 1 port 80 all parameters and IP stack behavior are OK unsolicited the TCP client socket is connected to the peer unsolicited the server index accepted a connection resulting TCP client on idx 1 exchange data on socket index 3 exchange data on socket index 1 send unescaped ETX character unsolicited peer socket is closed Page 104 122 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 003 December 15 2008 woaovecom Smart wireless Smart business AT WIPCLOSE 3 1 OK AT WIPCREATE 3 2 81 2 3 CME ERROR 845 wavecom 6 confidential Examples of Application Creating a Server and try to create a TCP Client Server on a reserved index reserved by the Server will fail close TCP server socket index 7 create the
14. 3 AT WIPCREATE 1 4 58 192 168 0 1 78 wavecom 6 Confidential 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 1192 168 0 1 port 75 Jall parameters and IP stack behavior are OK unsolicited the UDP client socket is pseudo 1 connected to the peer no real connection is UDP create a UDP client towards peer IP device 192 168 0 1 port 76 Jall parameters and IP stack behavior are OK unsolicited the UDP client socket is pseudo 1 connected to the peer no real connection is UDP create a UDP client towards peer IP device 192 168 0 1 port 77 Jall parameters and IP stack behavior are OK unsolicited the UDP client socket is pseudo 1 connected to the peer no real connection is UDP create a UDP client towards peer IP device 1192 168 0 1 port 78 Page 113 122 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 003 December 15 2008 woaovecom Smart wireless Smart business Examples of Application Creating 8 UDP sockets 8 TCP Clients 4 TCP Servers and either one 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
15. 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 WIPREADY 1 8 AT WIPCREATE 1 9 63 192 168 0 1 83 CME ERROR 830 AT WIPCREATE 3 1 83 1 1 OK AT WIPCREATE 3 2 84 2 2 OK AT WIPCREATE 3 3 85 3 3 OK wavecom 6 Confidential FTP HTTP SMTP POP3 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 79 Hall 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 192 168 0 1 port 80 fall parameters and IP stack behavior are OK unsolicited the UDP client socket is pseudo 1 connected to the peer no real connection is 4 UDP create a UDP client towards peer IP device 14 192 168 0 1 port 81 all 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 1192 168 0 1 port 82 all parameters and IP stack behavior are OK unsolicited the UDP client socket is pseudo 1 connected to the peer no real connection is UDP 48 UDP sockets have been created and hence 9 attempt fails crea
16. 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 vA B MMM DDD YYYY HH MM SS lt WIPlib version number gt lt WIPSoft version number gt OK wavecom 6 Confidential Page 15 122 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 003 December 15 2008 woaovecom Smart wireless Smart business 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 wavecom 6 confidential Page 16 122 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 003 December 15 2008 waovecom Smart wireless Smart business General Configuration IP Stack Handling WIPCFG 4 1 3 Parameters and Defined Values lt mode gt requested operation stop TCP IP stack 1 start TCP IP stack 2 configure TCP IP stack 3 display TCP IP application version 4 TCP IP stack configurat
17. 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 Subscriber Information Module SMTP Simple Mail Transfer Protocol TCP Transmission Control Protocol TOS Type Of Service TTL Time To Live UART Universal Asynchronous Receiver Transmitter UDP User Data Protocol URL Uniform Resource Locator WIP Wavecom Internet Protocol Wa Vecono confidential Page 8 122 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 003 December 15 2008 waoavecom Smart wireless Smart business Introduction Logos This picture indicates the WIND indication from which the AT command is allowed X values can be 1 3 4 16 This pic
18. WIPCFG 4 1 6 Examples Command Responses AT WIPCFG 1 Note Start IP Stack AT WIPCFG AT WIPCFG 2 0 10 Note Configure TTL of IP Stack wavecom 6 Confidential Page 23 122 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 003 December 15 2008 waovecom Smart wireless Smart business General Configuration IP Stack Handling WIPCFG Command Responses AT WIPCFG 14 0 OK AT WIPCFG 3 Note Display software version WIP soft v202 on Open AT OS v312 Mar 26 2007 11 45 46 WIPlib v2a07 WIPSoft vlal2 OK AT WIPCFG 0 Note Stop the TCP IP Stack OK AT WIPCFG 4 1 Note Store IP configuration parameters into FLASH OK AT WIPCFG 4 0 Note Free IP configuration parameters stored in FLASH wavecom 6 Confidential Page 24 122 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 003 December 15 2008 waovecom Smart wireless Smart business General Configuration 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 m
19. 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 wavecom 6 Confidential Page 85 122 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 003 December 15 2008 wovecom Smart wireless Smart business WIPSoft Library API Required Header File 8 1 Required Header File The header file for
20. are successful set sender mail address set sender name set receiver mail address set CC receiver mail address set BCC mail address Page 99 122 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 003 December 15 2008 wovecom Smart wireless Smart business Examples of Application SMTP 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 wavecom 6 confidential Page 100 122 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 003 December 15 2008 waovecom Smart wireless Smart business Examples of Application POP3 9 7 POP3 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 7 1 7 192 168 1 2 j 11 connect to remote POP3 server 0 user password OK WIPREADY 7 1 connection and authentication are successful AT WIPOPT 7 1 1 71 get total number of mails WIPOPT 7 71 10 O
21. not configured using WIPDATA command then the values already set for option WIP_NET_OPT_TCP_MIN_ MSS and AT_WIP_NET_OPT_PREF_TIMEOUT VALUE will be used Note that if an attempt is made to set data packet size more than twice the value of WIP_NET_OPT_TCP_MIN_MSS_ using WIPDATA command results in CME ERROR 847 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 or WIPDATA 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 or WIPDATA 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 6 2 11 5 Packet Segmentation in UDP Socket This feature for UDP is supported only in case of continuous transparent mode If the WIPDATA command is executed in continuous mode to use this feature ERROR will be returned The parameters used for packet segmentation can be configured using WIPDATA command In case if it is not configured using
22. 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 Desktop GPRS NT Data received from PC1 abc ETX efgh Data sent from PC2 abc ETXJefgh MAPPED ART Desktop PCI 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 e 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 e TCP socket a non escaped ETX causes a TCP shutdown operation on the transmitting direction 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
23. 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 UDP TCP client 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 Wl N gt 5 2 4 Parameter Storage wavecoms Confidential Page 46 122 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 003 December 15 2008 waovecom Smart wireless Smart business IP Protocol Services Closing a Service WIPCLOSE 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 protocol 5 2 6 Examples Command Responses AT WIPCLOSE 1 1 Note Close UDP sock
24. server lt state gt current state of the bearer stopped started lt status gt O result of the connection process successful any other value to be matched to error code value e g 814 means PPP authentication failure lt local IP gt local 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 then 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 wavecom 6 Confidential Page 30 122 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 003 December 15 2008 waovecom e Smart wireless Smart business General Configuration Bearers Handling WIPBR 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 est
25. server on port 81 idx 2 and from_idx 2 and to_idx 3 TCP client socket with idx 2 was reserved by the previous server socket and it was not closed explicitly Hence error is returned Page 105 122 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 003 December 15 2008 woaovecom Smart wireless Smart business 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 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 1 198 168 0 1 80 create a TCP client towards peer IP device 1198 168 0 1 port 80 OK Jall parameters and IP stack behavior are OK WIPREADY 2 1 unsolicited the TCP client socket is connected to the peer AT WIPCREATE 3 2 r 80 I 2 create the server on port 80 idx 2 Range requested contains the already used index CME ERROR 845 1 and hence error is returned wavecom 6 Confidential Page 106 122 This document is the sole and exclusive property of Wavecom
26. 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 Note that un mapping socket using WIPDATA command with lt send size gt and lt wait time gt specified results in ERROR 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 timeout 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 th
27. the WIP AT command interface is wip_atcmd h wavecom 6 confidential Page 86 122 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 003 December 15 2008 waovecom Smart wireless Smart business 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 O ON success e negative error code on failure as described below Error Code Description a subscription for WIP AT commands fails 2 WIP AT commands already subscribed wavecom 6 Confidential Page 87 122 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 003 December 15 2008 waovecom Smart wireless Smart business WIPSoft Library API The wip_ATCmdUnsubscribe Function 8 3 The 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
28. to AT mode AT WIPDATA 2 5 2 Note TCP with index 5 can send read data in continuous transparent mode 6 2 11 Notes 62117 CONNECT lt read write data gt OK Note sequence causes the UART to switch to AT mode 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 ransfer Baia and the peer will be After sending an ETX character informed of this shutdown by a the socket will be TCR LFISHUTDOWN CR LF indication on its mapped UART and the 6 oes 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 6cBefrtatic shows the shutdown procedure for a TCP socket 6 2 11 6 2 11 6 2 11 6 2 11 6 2 11 6 2 11 6 2 11 6 2 11 6 2 11 o WaVveage M o Confidential Page 78 122 This document is the sole and exclusive property of Wavecom Not to be distributed or divulged witho gig yritten agreement WM_DEV_OAT_UGD_076 003 6 2 11 6 2 11 December 15 2008 waovecom Smart wireless Smart business Data Exchange for Protocol Services Socket Data exchange WIPDATA Internet AN CPU Data received on the mapped UART on PC2 abcq ETX SHUTDOWN Data received on the AT window of PC2 VVIPPEERCLOSE Desktop lt proto gt lt idx gt PC1 Data sent from PC1 abcd ETX In the above schematic a TC
29. 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 The first field is PRECEDENCE It is intended to denote 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 0 255 default value O 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 wavecom 6 Confidential Page 18 122 This document is the sole and exclusive property of Wavecom Not to be distributed or d
30. 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 wavecom 6 Confidential Page 43 122 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 003 December 15 2008 woaovecom ae Smart wireless Smart business IP Protocol Services Service Creation WIPCREATE 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 It is not possible to create a client socket with AT WIPCREATE z2 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 A
31. 8 3 2 Parameters None 8 3 3 Returned Values The function returns e O ON 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 commands fails wavecom 6 Confidential Page 88 122 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 003 December 15 2008 waovecom Smart wireless Smart business 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 CONNECT OK 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 Mis listening for connection request on port 180 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 resulting TCP client on idx 5 exchange data on socket index 5 read write switch to AT m
32. A AT command It allows the application to buffer a certain amount of data before writing on IP network side weavecom s confidential Page 19 122 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 003 December 15 2008 woaovecom Smart wireless Smart business General Configuration IP Stack Handling WIPCFG 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 packets 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 13 AT_WIP_NET_OPT_ESC SEQ NOT SENT Used to configure whether a escape sequence should be sent as data to the peer By default this option is set to O which means tha
33. 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 Comman ds 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 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 wavecom 6 Confidential Page 13 122 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 003 December 15 2008 wevecom ae Smart wireless Smart business 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 TCP in listen mode Server FTP HTTP SMTP 7 POP3 Two pairs with a different pro
34. AT WIPOPT 3 1 1 9 WIPOPT Note Get TOS for TCP server OK AT WIPOPT 1 1 1 1 WIPOPT Note Get peer port for UDP OK AT WIPOPT 4 1 2 40 1 OK Note Set data representation type for FTP AT WIPOPT 4 1 1 40 WIPOPT Note Get data representation type for FTP OK AT WIPOPT 5 1 2 52 0 OK Note Set HTTP version to 1 0 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 wavecom 6 Confidential Page 51 122 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 003 December 15 2008 waovecom a Smart wireless Smart business IP Protocol Services Service Option Handling WIPOPT Command Responses 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 subject OK Note Get the set mail subject AT WIPOPT 7 1 1 72 WIPOPT 7 72 243000 OK Note Get total mail size AT WIPOPT 7 1 1 73 Pie Ly Sy dey L
35. ETX character indicates end of data AT WIPDATA 1 5 2 CONNECT lt read write data gt OK Note UDP with index 5 can send read data in continuous transparent mode with default value set for lt send size gt and lt wait time gt Note sequence causes the UART to switch to AT mode AT WIPDATA 1 5 2 20 2 CONNECT lt read write data gt OK Note UDP with index 5 can send read data in continuous transparent mode with lt send size gt set to 20 and lt wait time gt set to 2 Note sequence causes the UART to switch to AT mode AT WIPDATA 2 5 1 20 10 CONNECT lt read write data gt OK wavecom 6 Confidential Page 77 122 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 003 December 15 2008 waovecom Smart wireless Smart business Data Exchange for Protocol Services Socket Data exchange WIPDATA Command Responses Note TCP with index 5 can send read data in continuous mode with lt send size gt set to 20 and lt wait time gt set to 10 Note sequence causes the UART to switch to AT mode AT WIPDATA 2 5 2 10 5 CONNECT lt read write data gt OK Note TCP with index 5 can send read data in continuous transparent mode with lt send size gt set to 10 and lt wait time gt set to 5 Note sequence causes the UART to switch
36. G OK Unsolicited response WIPPING lt timeout_expired gt lt packet idx gt lt response time gt wavecom 6 Confidential Page 82 122 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 003 December 15 2008 waovecom Smart wireless Smart business 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 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
37. 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 wavecom 6 confidential Page 29 122 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 003 December 15 2008 woaovecom Smart wireless Smart business General Configuration Bearers Handling WIPBR 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 21 WIP_BOPT_GPRS_TIMEOUT Define a time limit to connect GPRS bearer For example value 300 for this option sets a wait time of 30s 300 100ms Note If timer expires before GPRS bearer connects error 847 is returned range 300 1200 default 1200 lt value gt range of value for different bearer options lt mode gt O mode of operation client 1
38. IP event occurred on Wireless CPU regarding the concerned socket wavecom 6 Confidential Page 71 122 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 003 December 15 2008 wevecom ae Smart wireless Smart business Data Exchange for Protocol Services Socket Data exchange WIPDATA e UDP socket a non escaped ETX signals the boundary of the current received datagram e 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 wavecom s confidential Page 72 122 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 003 December 15 2008 waovecom Smart wireless Smart business Data Exchange for Protocol S
39. K AT WIPOPT 7 1 1 72 get total mail size WIPOPT 7 72 124000 OK 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 wavecom 6 Confidential Page 101 122 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 003 December 15 2008 wovecom Smart wireless Smart business Examples of Application POP3 AT WIPFILE 7 1 3 71 retrieve mail id 1 and delete it from the server we after retrieving CONNECT lt user starts getting the mail with the UART in data mode and ends with an ETX gt OK wavecom 6 confidential Page 102 122 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 003 December 15 2008 woaovecom Smart wireless Smart business 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 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 WIPACCEPT 1 5 WIPACCEPT 1 6 AT WIPCLOSE 2 5 OK
40. M bearer set user name set password start GSM bearer create a TCP client towards peer IP device ip addr port 80 Hall parameters and iP stack behavior are OK unsolicited the TCP client socket is connected to the peer exchange data on socket idx 1 read write switch to AT mode close the TCP client socket index 7 Page 92 122 wavecom 6 Confidential 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 003 December 15 2008 waovecom Smart wireless Smart business 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 6 y 11 BPN name set APN name of GPRS bearer OK AT WIPBR 2 F 6 F 0 7 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 80 WWW wavec create a UDP client towards peer IP device FF WY www wavecom com port 80 om com 80 OK all 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 AT WIPDATA 1 1 i 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
41. OZ dg log 24 9231 bp Lar Spl 28 7 73 74 36400 Tp Tp IpI Note Get mail listing AT WIPOPT 7 1 2 74 10 WIPOPT 7 74 10 OK 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 wavecom s confidential Page 52 122 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 003 December 15 2008 woaovecom Smart wireless Smart business 5 3 7 1 Options that can be applied to UDP TCP Client TCP Server Sockets IP Protocol Services Service Option Handling WIPOPT opt num Value format Option Type Description UDP TCP client TCP server 0 0 65535 WIP_COPT P ORT Port of the socket R 0 65535 WIP_COPT P EER PORT Port of the peer socket R string WIP_COPT_P EER STRADD R Address of peer socket the WIP_COPT_B OUND Specifies whether the socket is bounded to a peer socket or not default 1 1 5839 WIP_COPT_S ND_LOWAT Minimum amount of available space that must be available in the emission buffer before triggering a WIP_CEV_WRITE event default 1024 RW RW 0 65535 WIP_ COPT N READ Number of bytes that can currently be read on that socket
42. P 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 LFJSHUTDOWN 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 wavecom 6 Confidential Page 79 122 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 003 December 15 2008 waovecom a Smart wireless Smart business 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
43. T 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 server 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
44. TE 2 5 192 168 0 1 80 OK WIPREADY 2 5 AT WIPCREATE 2 6 192 168 0 1 80 OK WIPREADY 2 6 AT WIPCREATE 2 7 192 168 0 1 80 OK WIPREADY 2 7 AT WIPCREATE 2 8 192 168 0 1 80 OK WIPREADY 2 8 AT WIPCREATE 2 8 192 168 0 1 80 CME ERROR 840 wavecom 6 Confidential 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 4 192 168 0 1 port 80 all 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 192 168 0 1 port 80 Jall parameters and IP stack behavior are OK unsolicited the TCP client socket is connected to the peer create a TCP client towards peer IP
45. WIPCREATE 3 2 80 1 2 OK AT WIPCREATE 2 3 198 168 0 1 80 OK WIPREADY 2 3 WIPACCEPT 2 1 AT WIPDATA 2 3 1 CONNECT abcttt OK AT WIPDATA 2 1 1 CONNECT wavecom 6 Confidential start IP stack open GPRS bearer set APN name of GPRS bearer set user name set password start GPRS bearer create the server on port 80 idx 2 The server Mis listening for connection request on port 80 Spawned sockets will be given the index 1 or 2 lt will accept connection request until has nor more socket left create a TCP client towards peer IP device 1198 168 0 1 port 80 Jall parameters and IP stack behavior are OK unsolicited the TCP client socket is connected to the peer unsolicited the server index accepted a connection resulting TCP client on idx 1 exchange data on socket index 3 data sent to socket index 1 and switched to AT mode by giving exchange data on socket index 1 Page 118 122 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 003 December 15 2008 wovecom Smart wireless Smart business 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 received from socket index 3 OK wavecom 6 confidential P
46. WIPDATA command default value of these parameters will be used The data sent to a mapped UDP socket through UART will be buffered before sending it to the peer This buffered data will be sent to the peer when e the buffered data size is equal to segmentation size Note that if the buffered data is greater than segmentation size then the data will be written to the channel in chunks of segmentation size e the timer expires e socket is unmapped 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 wavecom 6 Confidential Page 81 122 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 003 December 15 2008 woaovecom Smart wireless Smart business Ping Services PING command WIPPING 7 Ping Services 7 1 PING command WIPPING 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 event 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 OK Read Command AT WIPPING OK Test Command AT WIPPIN
47. a UDP server and listen for datagram on port 11234 OK Jall 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 Hone datagram is ready to be read it was sent from 192 168 0 2 on port 2397 and is composed 1 1 25 192 168 0 2 2397 of 25 ibytes Wwavecom s confidential Page 93 122 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 003 December 15 2008 woaovecom Smart wireless Smart business Examples of Application UDP Socket AT WIPDATA 1 1 1 CONNECT abcedghij klmnopqrstuvwxyz 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 from 192 168 0 4 on port 58 and is composed of 1 1 50 192 168 0 4 58 50 bytes 4 a AT WIPDATA 1 1 1 CONNECT abcedghij klmnopqrstuvwxyzabced here 25 bytes the ETX character marking the ghijklmnopqrstuvwxyz ETX bound of the datagram have been read
48. ablished 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 AT WIPBR 1 lt bid gt will open bearer lt bid gt with default parameters of the bearer when existing 4 2 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 803 operation not allowed in the current WIP stack state 804 device already open 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 847 bearer connection fai
49. acter 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 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 Note that in this mode packet segmentation feature is not supported In case an ETX DLE character needs to be transmitted it should be preceded by DLE character similar to TCP socket 1 Maximum size of an UDP datagram has been fixed to 5904 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 WaeVvecoM o Confidential Page 70 122 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 003 December 15 2008 woaovecom Smart wireless Smart business Data Exchange for Protocol Services Socket Data exchange WIPDATA When the UART leaves DATA mode either because of escape sequence or because
50. ading 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 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 reason gt HTTP status reason of the response in string format 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 830 bad index 831 bad state 834 not implemented 836 memory allocation error Wwavecom s confidential Page 65 122 This document is the sole and exclusive property of Wavecom Not to be distributed or divulged without p
51. age 119 122 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 003 December 15 2008 woaovecom Smart wireless Smart business 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 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 failure 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 Pi
52. ameter 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 wavecom s confidential Page 39 122 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 003 December 15 2008 waovecom eee Smart wireless Smart business IP Protocol Services Service Creation WIPCREATE 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 POPS 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 Authentication is disabled when this parameter is not specified for HTTP SMTP and POPS lt password gt password for the authentication in string for
53. art business 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 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 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 F 1 j 1 exchange data on socket idx 1 CONNECT read write switch to AT mode OK AT WIPCLOSE 2 j 1 close the TCP client socket index 1 OK wavecom 6 Confidential Page 91 122 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 003 December 15 2008 waovecom Smart wireless Smart business 9 1 2 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 2 1 ip addr 80 OK WIPREADY 2 1 AT WIPDATA 2 1 1 CONNECT OK AT WIPCLOSE 2 1 OK Examples of Application TCP Socket start IP stack Hopen GSM bearer set phone number for GS
54. de and the bearer type additional parameters are required or forbidden Bid Mode Other Params maiaa o None 1 3 11 14 21 24 1 lt PPP login gt lt PPP password gt 5 C E 5 lt login gt lt password gt lt caller identity gt wavecom 6 Confidential Page 33 122 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 003 December 15 2008 wevecom i Smart wireless Smart business General Configuration Bearers Handling WIPBR 6 O None 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 e For GSM server lt login gt and lt password gt will 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
55. default O WIP_ COPT N ODELAY When set to TRUE 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 RW RW wavecom 6 Confidential Page 53 122 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 003 December 15 2008 waovecom Smart wireless Smart business IP Protocol Services Service Option Handling WIPOPT opt Value Option Type Description UDP TCP TCP num format client server 8 0 255 WIP_COPT_T Time to leave for RW RW RW TL 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 pe
56. dential Page 48 122 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 003 December 15 2008 woaovecom Smart wireless Smart business IP Protocol Services Service Option Handling WIPOPT 5 3 Service Option Handling WIPOPT 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 wavecom 6 Confidential Page 49 122 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 003 December 15 2008 waovecom ieee Smart wireless Smart business 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 WIPOPT 5 54 lt message header field
57. device 192 168 0 1 port 80 Jall 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 Jall 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 1192 168 0 1 port 80 Index 8 is already used and corresponds to an active socket Page 109 122 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 003 December 15 2008 wovecom Smart wireless Smart business Examples of Application Creating 8 UDP sockets 8 TCP clients and 4 TCP servers AT WIPCREATE 2 9 192 168 0 1 80 create a TCP client towards a peer IP device a 1192 168 0 1 port 80 Index 9 is forbidden CME ERROR 830 wavecom 6 confidential Page 110 122 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 003 December 15 2008 woaovecom Smart wireless Smart business 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 9 12 Changing the MAX_SOCK_NUM option value and try to create 8 UDP sockets 8 TCP Client socket
58. distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 003 December 15 2008 waovecom Smart wireless Smart business IP Protocol Services Service Creation WIPCREATE Connect Spawn a new socket Transfer data Socket Closed 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 wavecom 6 Confidential Page 37 122 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 003 December 15 2008 weaevecom i Smart wireless Smart business 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 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 l
59. dl_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 wavecom 6 Confidential Page 117 122 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 003 December 15 2008 woaovecom Smart wireless Smart business 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 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
60. e 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 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 wavecom 6 Confidential Page 80 122 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 003 December 15 2008 woaovecom ae Smart wireless Smart business Data Exchange for Protocol Services Socket Data exchange WIPDATA Please note that the 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 parameters used for packet segmentation can be configured using WIPDATA or WIPCFG command In case if it is
61. eader 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 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 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 Wa vecom o confidential Page 55 122 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 003 December 15 2008 waovecom m Smart wireless Smart business IP Protocol Services Service Option Handling WIPOPT opt Value Value Option type Description Type num format type 67 dig
62. ecember 15 2008 wovecom Smart wireless Smart business Introduction Related Documents 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 2 0 0 cee ec cece cece eens ee eeeeeeeeeeneneeeneneenaeeenenenenaes 118 10 ERROR CODES ieiiaiiscsecscacscdacsesscopsseaadesavaseernsaceesgeetimaaedissaacanteted 120 wavecom 6 confidential Page 6 122 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 003 December 15 2008 wovecom Smart wireless Smart business Introduction Related Documents 1 Introduction 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 1 1 Related Documents None wavecom 6 confidential Page 7 122 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 003 December 15 2008 waovecom Smart wireless Smart business Introduction Abbreviations and Definitions 1 2 Abbreviations and Definitions 1 2 1 Abbreviations APN Access Point Name ASCII American Standard Code for
63. ecom Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 003 December 15 2008 woaovecom Smart wireless Smart business Data Exchange for Protocol Services File Exchange WIPFILE 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 wavecom 6 Confidential Page 63 122 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 003 December 15 2008 wevecom i Smart wireless Smart business Data Exchange for Protocol Services File Exchange WIPFILE 6 1 5 Parameters and Defined Values lt protocol gt protocol type FTP HTTP SMTP POP3 N O oO A lt idx gt channel identifier lt mode gt file transfer mode 1 This command switches the UART 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 fro
64. ection 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 wavecom 6 Confidential Page 10 122 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 003 December 15 2008 waovecom Smart wireless Smart business AT Command Syntax 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 W1IPcmd 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 wavecom 6 confidential Page 11 122 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 003 December 15 2008 waovecom Smart wireless Smart business 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 comma
65. ed 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 4192 168 0 2 port 80 Jall 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 192 168 0 2 port 80 Jall 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 2 port 80 Jall 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 192 168 0 2 port 80 Jall 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 2 port 80 Index 8 is already used and corresponds to an active socket Page 115 122 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 003 December
66. eeeeeeeeeeeseeeeenbaeeeneeseeenenes 15 4 1 IP Stack Handling WIPCEG 2 00 ccc cece n betes eeeeee es 15 4 2 Bearers Handling WIPBR ccceecee ee eee hunne teen eee eeeeeeeeeees 26 5 IP PROTOCOL SERVICES srsresssnrsassannrersanrssnnrs Moc cs Metis tneenasvenees 35 5 1 Service Creation WIPCREATE o Qa 35 5 2 Closing a Service WIPCLOSE ssdnnsssssnatessssrrnrrnrenrnnrrrererrrnrnne 45 5 3 Service Option Handling WIPOPT ccccee cece ee eee eee eee eee 49 6 DATA EXCHANGE FOR PROTOCOL SERVICES cccceeeeeeeeeeneaes 58 6 1 File Exchange WIPFILE c cccceetece cece eee eee ee ee eeeeeeeeeees 59 6 2 Socket Data exchange WIPDATA 0 0ccccee ee eee teen e ee eeee eee 69 7 PING SERVICES ii isccscisesdecdiccc cd aaa Mees aeontel ess A AREKEA NEEE AEE EEKE 82 7 1 PING command WIPPING cc cece cece cece cee eneeeeeneeeeeeteeeaeeees 82 8 WIPSOFT LIBRARY API Sige cee cneccceccnenccceceeenesnennnaneneseseneesenens 85 8 1 Required Header File cc cece cece cece eee eee teens ee eee eee eeeeeeneee es 86 8 2 The wip_ATCmdSubscribe Function cece eee eee eee 87 8 3 The wip_ATCmdUnsubscribe Function ccceeeeee eee eee teeta eee 88 9 EXAMPLES OF APPLICATION ccccsceeeeeeeeeeeeeeeeenaeeeeaeeenaeeneaeenaees 89 9 1 TCP Socko Wii Senco iia nas asd bins geek ee wanda eee ae ee 89 9 2 UDP SOGRCt OF ig iin s
67. emory which causes the WIP Soft to crash Hence care must be taken when the default 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 and AT_WIP_NET_OPT_ESC_SEQ_ NOT_SENT will be taken into consideration at next start up only if these are saved in the flash before stopping the stack 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 AT_WIP_NET_OPT_ESC SEQ NOT SENT AT_WIP_NET_OPT_AUTO SWITCH wavecom 6 Confidential Page 25 122 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 003 December 15 2008 wovecom Smart wireless Smart business General Configuration Bearers Handling WIPBR 4 2 Bearers Handling WIPBR wavecom 6 confidential Page 26 122 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 003 December 15 2008 woaovecom Smart wireless Smart business General Configuration Bearers Handling WIPBR 4 2 1 Description The WIPBR command can be used to e select the bearer e start close the bearer e config
68. er socket Hence this option will be read as TRUE 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 default O wavecoms confidential Page 54 122 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 003 December 15 2008 waovecom Smart wireless Smart business IP Protocol Services Service Option Handling WIPOPT opt Value Value Option type Description Type num format type 51 u32 WIP_COPT_SND_ set the size of the TCP socket RW BUFSIZE send buffer default O 52 O 1 u8 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 h
69. ervices 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 GPRS SM 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 On the receiving side use case when Desktop PC2 sends data towards Wireless 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 wavecom 6 Confidential Page 73 122 This document is the sole and exclusive property of Wavecom Not to be distributed or divulged without pri
70. ess Er En E E E EOR ED EOR vias ED EVR EPRE EON EDR EDA EREE DRE 93 9 3 ANEP Y A 95 9 4 BiN a E EA AAA A A A T 96 9 5 fal TWA E E E E E E 97 9 6 e UEa E T ne ere ne een errr ere 99 9 7 ee er a te Ae eset ete Rata aoe eee aie ete aerate a Dk E EEE 101 9 Creating a TCP Server spawning the maximum TCP Socket for the configured Server cccccceccce cece cece eee eee e eee eee e este de sess eegstegetenetenanegas 103 9 9 Creating a Server and try to create a TCP Client Server on a reserved index reserved by the Server will fail ccceeeeeeee es 104 9 10 Create a TCP Client and try to create a TCP Server with indexs range containing TCP Client will fail cece cece eect ee eee eee eeee es 106 9 11 Creating 8 UDP sockets 8 TCP clients and 4 TCP servers 107 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 111 9 13 Creating 8 UDP sockets 8 TCP Clients 4 TCP Servers and either one FTP HTTP SMTP POPS cccc cece cece cece ete e ene e eee ee ee eenateeeeeeeeneeeenae 113 9 14 Subscribe Unsubscribe WIPSoft AT commands using WIPSoft bibranyAR leivontsidacbneeiacuteew end peed A E Ea E Ded ade Piet eae peak aa nae pea dawnt 117 Wwavecom s confidential Page 5 122 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 003 D
71. et with communication index 7 AT WIPCLOSE 2 1 Note Close TCP client with communication index 7 AT WIPCLOSE 3 1 Note Close TCP server with communication index 7 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 Note Close POP3 session with index 1 5 2 7 Notes wavecom 6 Confidential Page 47 122 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 003 December 15 2008 woaovecom Smart wireless Smart business IP Protocol Services Closing a Service WIPCLOSE 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 FTP HTTP SMTP POP3 session OK response is returned if WIPCLOSE command is executed when the session is active else CME ERROR 831 error code is returned wavecom 6 Confi
72. field value is WIP HTTTP Client 1 0 AT WIPCREATE 5 1 proxyaddress OK user name password User 4WIPREADY 5 1 a A Agent WIP HTTP Client 1 0 Accept Encoding gzip Accept Language en US wavecom 6 Confidential Page 42 122 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 003 December 15 2008 waovecom a Smart wireless Smart business IP Protocol Services Service Creation WIPCREATE Note HTTP session with proxy and 3 message header fields Use default 80 proxy port number 3 message header fields a 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 AT WIPCREATE 5 1 proxyaddress OK ose y 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 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 g user F pass WIPREADY 7 1 Note Connect to POP3 server port 110 with given username and password AT WIPCREATE 7
73. ication index 1 Wireless CPU acts as a UDP client and an UDP server it can send datagram towards the remote entity and receiving datagram on the specified local port AT WIPCREATE 3 1 80 5 8 Note Create the TCP server on port 80 with server 2 P index 1 Wireless CPU acts as a TCP server it will from now on spawn TCP client socket from communication index 5 to 8 Note An unsolicited event WIPREADY 1 1 will be received once the UDP socket is ready for usage OK Note An unsolicited event WIPACCEPT 1 5 will be received once the TCP server is ready for usage AT WIPCREATE 2 1 IP ADDR 80 Note Create the TCP client on port 80 with 7 5 index 1 Wireless CPU acts as a TCP client it can from now on communicate with the remote specified entity through communication index 1 AT WIPCREATE 4 1 ftp wavecom co m admin 123456 Note Create a FTP session towards the remote specified FTP server Communication index to be used then is 1 AT WIPCREATE 5 1 proxyaddress user name password User Agent WIP HTTP Client 1 0 OK Note An unsolicited event WIPREADY 2 1 will be received once the TCP client is ready for usage OK WIPREADY 5 1 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
74. ion 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 system 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 wavecom s confidential Page 17 122 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 003 December 15 2008 woaovecom Smart wireless Smart business 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
75. is the sole and exclusive property of Wavecom Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD_076 003 December 15 2008 wevecom i Smart wireless Smart business 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 wavecom 6 Confidential Page 22 122 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 003 December 15 2008 wevecom i Smart wireless Smart business General Configuration IP Stack Handling
76. it 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 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 particular 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 Option
77. ivulged without prior written agreement WM_DEV_OAT_UGD_076 003 December 15 2008 woaovecom Smart wireless Smart business General Configuration IP Stack Handling WIPCFG 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 outstanding 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 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 WIPDAT
78. le 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 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 1 will be received once the UDP socket is ready for usage communication index 1 Wireless CPU acts as 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 y communication index 1 Wireless CPU acts as for usage a UDP client that can send datagram towards the remote entity AT WIPCREATE 1 1 80 www wavecom com 80 wavecom 6 Confidential Page 41 122 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 003 December 15 2008 waovecom Smart wireless Smart business IP Protocol Services Service Creation WIPCREATE Note Create the UDP socket on local port 80 with peer IP and peer port 80 with commun
79. licited 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 returned might not be reliable wavecom 6 Confidential Page 75 122 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 003 December 15 2008 waovecom Smart wireless Smart business Data Exchange for Protocol Services Socket Data exchange WIPDATA 6 2 7 Parameters and Defined Values lt protocol gt socket type 1 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 1 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 lt send size gt data packet size This parameter specifies the size of the data packet that needs to be sent to the peer This parameter is supported only for UDP continuous transparent mode range 8 1460 default value 1020 lt wait time gt timeout for configuring the packet segmentation on IP network side This parameter specifies the timeout after which the buffered data will be sent to the peer i
80. lure WIP_BOPT_GPRS_TIMEOUT time limit expired before GPRS bearer connected 848 impossible to connect to the bearer 849 connection to the bearer has succeeded but a problem has occurred during the data flow establishment wavecoms Confidential Page 31 122 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 003 December 15 2008 woaovecom Smart wireless Smart business 4 2 6 Examples General Configuration Bearers Handling WIPBR Command 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 Note Set APN of GPRS bearer OK AT WIPBR 3 6 11 Note Get APN of GPRS bearer WIPBR 6 11 APN name OK AT WIPBR 2 6 21 600 Note set GPRS connection timeout value to 60s OK 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 Note Set the phonenumber for GSM bearer AT WIPBR 2 5 15 1 1 1
81. m 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 POP3 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 wavecom 6 Confidential Page 64 122 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 003 December 15 2008 woaovecom Smart wireless Smart business Data Exchange for Protocol Services File Exchange WIPFILE This command switches the UART in data mode and accepts a stream of data terminated by ETX character This mode is used for uplo
82. mat Authentication is disabled when this parameter is not specified for HTTP SMTP and POPS 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 wavecom s confidential Page 40 122 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 003 December 15 2008 waovecom Smart wireless Smart business IP Protocol Services Service Creation WIPCREATE CMEE AT error code Description 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 already active 842 destination host unreachable whether host unreachable Network unreachab
83. meaning in WIP soft are handled on Wavecom Wireless CPU 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 wavecom 6 Confidential Page 61 122 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 003 December 15 2008 wovecom Smart wireless Smart business Data Exchange for Protocol Services File Exchange WIPFILE e if lt protocol gt 5 Action Command AT WIPFILE lt protocol gt lt index gt lt mode gt lt filename gt lt username gt lt password gt lt headers list gt CONNECT OK wavecom 6 confidential Page 62 122 This document is the sole and exclusive property of Wav
84. n 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 wavecom 6 Confidential Page 57 122 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 003 December 15 2008 waovecom Smart wireless Smart business 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 wavecom 6 confidential Page 58 122 This document is the sole and exclusive property of Wavecom Not to be distributed or divulged with
85. name gt lt message header field value gt 5 3 3 Parameters and Defined Values lt protocol gt protocol type 1 UDP 2 TCP client 3 TCP server 4 FTP 5 HTTP 6 SMTP 7 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 834 not implemented 835 option not supported 837 bad protocol 850 unknown reason wavecom s confidential Page 50 122 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 003 December 15 2008 waovecom e Smart wireless Smart business IP Protocol Services Service Option Handling WIPOPT CMEE AT error code Description 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 OK Note Set TTL for TCP client AT WIPOPT 2 1 1 8 WIPOPT Note Get TTL for TCP client OK AT WIPOPT 3 1 2 9 10 OK Note Set TOS for TCP server
86. nds 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 events 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 wavecom 6 Confidential Page 12 122 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 003 December 15 2008 wevecom i Smart wireless Smart business 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
87. ng channel 820 error writing configuration in FLASH memory 821 error reading configuration in FLASH memory 822 829 reserved for future use 830 bad index 831 bad state 832 bad port number 833 bad port state wavecom 6 Confidential This document is the sole and exclusive without prior written agreement WM_DEV_OAT_UGD_076 003 Page 120 122 property of Wavecom Not to be distributed or divulged December 15 2008 woaovecom Smart wireless Smart business 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 CMEE AT error code Description 834 not implemented 835 option not supported 836 memory allocation error 837 bad protocol 838 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 or error in the FTP connection 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 WIP_BOPT_GPRS_TIMEOUT time limit expired before GPRS bearer connected 848 imp
88. ode AT WIPCLOSE 2 5 OK 9 1 1 2 Using GSM bearer wavecom 6 Confidential close the TCP client socket index 5 Page 89 122 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 003 December 15 2008 woaovecom Smart wireless Smart business Examples of Application TCP Socket AT WIPCFG 1 U start IP stack OK AT WIPBR 1 5 open GSM bearer OK AT WIPBR 2 5 2 Phone number set phone number for GSM bearer OK AT WIPBR 2 7 5 j 0 j 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 3 i 1 7 80 i 5 i 8 create the server on port 80 idx 1 The server Mis listening for connection request on port OK 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 WIPACCEPT 1 5 unsolicited the server accepted a connection resulting TCP client on idx 5 AT WIPDATA 2 5 1 exchange data on socket idx 5 CONNECT read write switch to AT mode OK AT WIPCLOSE 2 5 close the TCP client socket index 5 OK wavecom Confidential Page 90 122 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 003 December 15 2008 waovecom Smart wireless Sm
89. or written agreement WM_DEV_OAT_UGD 076 003 December 15 2008 woaovecom eee Smart wireless Smart business Data Exchange for Protocol Services Socket Data exchange WIPDATA 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 6 2 3 2 UDP 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 In case ETX DLE character is received it will not be preceded by a DLE character before sending it to the mapped UART 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 0 on another UART in AT mode When the UART leaves data mode either because of
90. ossible to connect to the bearer 849 connection to the bearer has succeeded but a problem has occurred during the data flow establishment 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 865 authentication error 866 server not ready error 867 POP3 email retrieving error 868 POP3 email size error wavecom 6 Confidential This document is the sole and exclusive without prior written agreement WM_DEV_OAT_UGD_076 003 Page 121 122 property of Wavecom Not to be distributed or divulged December 15 2008 woaovecom Smart wireless Smart business 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 CMEE AT error code Description 869 879 reserved for future use 880 SMTP sender email address rejected by server 881 SMTP 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 SMITP email body send request rejected by server wavecom 6 Confidential Page 122 122 This document is the sole and exclusive property of Wavecom Not to be distributed or divulged without prior written agreement WM_DEV_OAT_UGD
91. out prior written agreement WM_DEV_OAT_UGD_076 003 December 15 2008 wovecom Smart wireless Smart business Data Exchange for Protocol Services File Exchange WIPFILE 6 1 File Exchange WIPFILE wavecom 6 confidential Page 59 122 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 003 December 15 2008 woaovecom Smart wireless Smart business Data Exchange for Protocol Services File Exchange W IPFILE 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 Desktop PC2 GSM GPRS J Data received from PC1 ab ETX c Data sent to PC1 MAPPED UART ab ETX c Desktop PC1 Data sent to PC2 ab DLE ETX c ETX 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 On transmitting side when ETX cha
92. peer no real connection is UDP AT WIPCREATE 1 7 3 57 F 192 168 0 1 create a UDP client towards peer IP device 77 192 168 0 1 port 77 F OK Jall parameters and IP stack behavior are OK WIPREADY 1 3 unsolicited the UDP client socket is pseudo connected to the peer no real connection is UDP AT WIPCREATE 1 5 4 7 58 F 192 168 0 1 create a UDP client towards peer IP device 78 1192 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 13 Hence an attempt to create a fourth socket returns error W VecConn o Confidential Page 112 122 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 003 December 15 2008 woaovecom Smart wireless Smart business 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 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 76 OK WIPREADY 1 2 AT WIPCREATE 1 3 57 192 168 0 1 17 OK WIPREADY 1
93. please refer to WMFM 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 wavecom 6 Confidential Page 34 122 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 003 December 15 2008 wovecom Smart wireless Smart business IP Protocol Services Service Creation WIPCREATE 5 IP Protocol Services 5 1 Service Creation WIPCREATE Eag Ee wavecom 6 Confidential Page 35 122 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 003 December 15 2008 wevecom i Smart wireless Smart business IP Protocol Services Ser
94. 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 wavecom 6 Confidential Page 44 122 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 003 December 15 2008 wovecom Smart wireless Smart business IP Protocol Services Closing a Service WIPCLOSE 5 2 Closing a Service WIPCLOSE wavecom 6 confidential Page 45 122 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 003 December 15 2008 woaovecom a Smart wireless Smart business IP Protocol Services Closing a Service WIPCLOSE 5 2 1 Description The WIPCLOSE command is used 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
95. r disclosed to third parties in any form without the prior written permission of WAVECOM No Warranty No Liability This document is provided as is Wavecom makes no warranties of any kind either expressed or implied including any implied warranties of merchantability fitness for a particular purpose or noninfringement The recipient of the documentation shall endorse all risks arising from its use In no event shall Wavecom be liable for any incidental direct indirect consequential or punitive damages arising from the use or inadequacy of the documentation even if Wavecom has been advised of the possibility of such damages and to the extent permitted by law wavecoms Confidential Page 2 122 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 003 December 15 2008 wovecom Smart wireless Smart business AT COMMANDS USER GUIDE FOR WAVECOM IP V5 11 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 wavecom 6 confidential Page 3 122 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 003 December 15 2008 wovecom Smart wireless Smart business AT COMMANDS USER GUIDE FOR WAVECOM IP V5 11 Document Hi
96. racters 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 wavecom 6 Confidential Page 60 122 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 003 December 15 2008 woaovecom Smart wireless Smart business Data Exchange for Protocol Services File Exchange W IPFILE 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 Desktop PC2 GSM GPRS J Data received from PC1 abc DLE d Data sent to PC1 MAPPED UART abc DLE d 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
97. rior written agreement WM_DEV_OAT_UGD_076 003 December 15 2008 waovecom e Smart wireless Smart business Data Exchange for Protocol Services File Exchange WIPFILE CMEE AT error code Description 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 SMTP 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 log CONNECT lt data terminated by ETX character gt Note Send data to the given filename OK AT WIPFILE 5 1 1 urlForGet user CONNECT namie Password Accept text ht lt data received terminated by ml Ww 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
98. rrespective of size of the data packet This parameter is Supported only for UDP continuous transparent mode range 1 100 default value 2 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 Command Responses wavecom 6 Confidential Page 76 122 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 003 December 15 2008 waovecom Smart wireless Smart business Data Exchange for Protocol Services Socket Data exchange WIPDATA Command Responses AT WIPDATA 2 5 1 Note TCP Client 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 2 5 1 10 5 CONNECT lt read write data gt OK Note TCP Client with index 5 can send read data in continuous mode 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 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
99. s and 4 TCP Server sockets AT WIPCFG 1 start IP stack OK AT WIPCFG 2 6 3 ZMAX SOCK NUM has been changed to 3 OK AT WIPCFG 4 1 save the changed configuration to flash OK AT WIPCFG 0 close the IP stack OK AT WIPCFG 1 start IP stack OK AT WIPBR 1 6 Hopen 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 1 1 55 192 168 0 1 reate a UDP client towards peer IP device 75 1 192 168 0 1 port 75 f OK Jall 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 AT WIPCREATE 1 2 7 56 192 168 0 1 create a UDP client towards peer IP device 76 192 168 0 1 port 76 1 OK all parameters and IP stack behavior are OK wavecom 6 Confidential Page 111 122 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 003 December 15 2008 woaovecom Smart wireless Smart business 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 WIPREADY 1 2 unsolicited the UDP client socket is pseudo 1 connected to the
100. s 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 wavecom s confidential Page 56 122 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 003 December 15 2008 waovecom a Smart wireless Smart business IP Protocol Services Service Option Handling WIPOPT opt Value Value Option type Description Type num format type 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 ID returned by the mail listing option default depends on the mails available in the mail box 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 retur
101. story Level Date History of the evolution Writer 001 March 14 2008 Creation Wavecom 002 May 30 2008 Update for WIPSoft v5 01 Wavecom 003 December 15 2008 Update for WIPSoft v5 11 Wavecom wavecoms confidential Page 4 122 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 003 December 15 2008 waovecom eee Smart wireless Smart business Introduction Related Documents Table of Contents 1 INTRODUCTION wiecccidcseceiies ded cewas eo ediewne todd ENEE ands dccaw asec yadda A nave 7 1 1 Related DOCUMENTS 0 cc cece cece nce e eee e ene e eee e eee eeeeeeeeeeenesaeeeeeeees 7 1 2 Abbreviations and Definitions ccccc cece ccc ee eee eee aces ee eeneaaenees 8 1 3 LOGOS rear sare era ic ee Cac dae ae eee eet oe ae a aria eae Cae eee 9 1 4 AT Commands Presentation Rules cccccc cece cece eee ceeneaeeeees 10 2 AT COMMAND SYNTAX oiiiccccocsends ened ince etieiee cocedevescwdeveecenes tees Mewes 11 2 1 Command Lins aiecnc ss estes arts aiaa na hetinee ee Wate Mee 11 2 2 Information Responses and Result Codes c eeeeeeeeeee eee 12 3 PRINCIPLEG cccccceseceeeeeenecee eee eneeeeee neces neces eB 13 3 1 Sockets Identification ccc cece cece cece eee eee saae nese eeeesaeeeeeneees 14 4 GENERAL CONFIGURATION ccccccccceee
102. t the sequence is sent to the peer as data If set to 1 4 sequence is not sent as data to the peer range O 1 default value O 14 AT_WIP_NET_OPT_AUTO_ SWITCH O Does not switch automatically to AT mode 1 Switches automatically to AT mode range O 1 default value O lt action gt requested operation on TCP IP stack parameter management 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 YYYY gt date of built of WIP Soft application lt HH MM SS gt time of built of WIP Soft application lt WIPlib WIP Lib version version number gt wavecom s confidential Page 20 122 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 003 December 15 2008 wovecom Smart wireless Smart business General Configuration IP Stack Handling WIPCFG lt WIPSoft internally identifying WIP Soft version version number gt Note WIP_NET_OPT_SOCK MAX 1 sockets are reserved when UDP sockets are created and not for TCP sockets one socket buffer is added to support afford DNS accesses wavecom 6 confidential Page 21 122 This document
103. t 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 e if lt mode gt 1 or 2 Unsolicited response WIPREADY lt mode gt lt communication index gt e if lt mode gt 3 wavecom 6 Confidential Page 38 122 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 003 December 15 2008 woaovecom Smart wireless Smart business IP Protocol Services Service Creation WIPCREATE 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 TCP Client TCP server FTP HTTP Client SMTP Client NO of A O N POP3 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 address either in numeric form e g 85 12 133 10 or as a DNS entry e g WWW vwavecom com lt peer port gt peer port or the server port For TCP UDP this par
104. ta exchange WIPDATA wavecom 6 confidential Page 69 122 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 003 December 15 2008 woaovecom a Smart wireless Smart business Data Exchange for Protocol Services Socket Data exchange WIPDATA 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 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 LFISHUTDOWN CR LF on the mapped UART In case an ETX DLE character needs to be transmitted as 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 char
105. te one server on port 83 idx 1 One TCP client socket is reserved on index 7 create one server on port 84 idx 2 One TCP client socket is reserved on index 2 create one server on port 85 idx 3 One TCP client socket is reserved on index 3 Page 114 122 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 003 December 15 2008 woaovecom Smart wireless Smart business Examples of Application Creating 8 UDP sockets 8 TCP Clients 4 TCP Servers and either one AT WIPCREATE 3 4 86 4 4 OK AT WIPCREATE 3 5 84 5 5 CME ERROR 830 AT WIPCREATE 2 1 192 168 0 1 83 CME ERROR 845 WIPACCEPT WIPACCEPT WIPACCEPT WIPACCEPT AT WIPCREATE 2 5 192 168 0 2 80 OK WIPREADY 2 5 AT WIPCREATE 2 6 192 168 0 2 80 OK WIPREADY 2 6 AT WIPCREATE 2 7 192 168 0 2 80 OK WIPREADY 2 7 AT WIPCREATE 2 8 192 168 0 2 80 OK WIPREADY 2 8 AT WIPCREATE 2 8 192 168 0 2 80 CME ERROR 840 wavecom 6 Confidential FTP HTTP SMTP POP3 create one server on port 86 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 4 4 TCP server have been created and each of them reserved 1 TCP client socket and hence 1 5 attempt of creating TCP server fails 4 reserv
106. ters and IP stack behavior are OK unsolicited the UDP client socket is pseudo 1 connected to the peer no real connection is UDP create a UDP client towards peer IP device 1192 168 0 1 port 81 Mall 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 fall parameters and IP stack behavior are OK unsolicited the UDP client socket is pseudo 1 connected to the peer no real connection is UDP 48 UDP sockets have been created and hence 9 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 Page 108 122 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 003 December 15 2008 woaovecom Smart wireless Smart business Examples of Application Creating 8 UDP sockets 8 TCP clients and 4 TCP servers 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 WIPACCEPT WIPACCEPT WIPACCEPT WIPACCEPT AT WIPCREA
107. tion HTTP AT WIPFILE 5 1 1 urlForGet use H77P GET method rname password Accept text html Transfer codings compress CONNECT lt user starts getting the mail with the UART in data mode and ends with an ETX gt OK WIPFILE 5 1 1 255 Found unsolicited string on the HTTP status code and reason wavecom 6 confidential Page 98 122 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 003 December 15 2008 waovecom Smart wireless Smart business 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 OK AT WIPOPT 6 1 2 62 sender name OK AT WIPOPT 6 1 2 63 rec0O1 mail com rec02 mail com OK AT WIPOPT 6 1 2 64 ccrec01 mail com ccrec02 mail com OK AT WIPOPT 6 1 2 65 bccrec01 mail com bccrec0O2 mail com OK wavecom 6 Confidential Examples of Application SMTP start IP stack open GPRS bearer set APN name of GPRS bearer set user name set password start GPRS bearer eonnect to remote SMTP server connection and authentication
108. tocol 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 e o o o o o o ooh W 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 WIP 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 wavecom 6 Confidential Page 14 122 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 003 December 15 2008 woaovecom Smart wireless Smart business General Configuration IP Stack Handling WIPCFG 4 General Configuration 4 1 IP Stack Handling WIPCFG 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 O 1 Action Command
109. ttp status code gt lt http status reason gt wavecom 6 Confidential Page 67 122 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 003 December 15 2008 woaovecom Smart wireless Smart business Data Exchange for Protocol Services File Exchange WIPFILE Command Responses Note Send a HTTP POST request to URL AT WIPFILE 6 1 2 CONNECT lt data sent terminated by ETX character gt OK Note Send data mail content AT WIPFILE 7 1 1 15 CONNECT lt data received terminated by ETX character gt OK Note Retrieve data from the given ID Note Retrieve mail ID 15 Mail is not deleted after retrieval AT WIPFILE 7 1 3 1 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 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 wavecom 6 Confidential Page 68 122 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 003 December 15 2008 wovecom Smart wireless Smart business Data Exchange for Protocol Services Socket Data exchange WIPDATA 6 2 Socket Da
110. ture 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 picture indicates that an AT command is supported even if the PIN 2 CHV 2 code is not entered wavecom 6 Confidential Page 9 122 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 003 December 15 2008 waovecom Smart wireless Smart business 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 s
111. ure different bearer options such as access point name 4 2 2 Syntax e if lt cmdtype gt 0 1 or 5 Action Command AT WIPBR lt cmdtype gt lt bid gt OK e if lt cmdtype gt 2 Action 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 e if lt cmdtype gt 6 Action Command AT WIPBR lt cmdtype gt lt bid gt lt mode gt OK wavecom 6 Confidential Page 27 122 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 003 December 15 2008 woaovecom Smart wireless Smart business General Configuration Bearers Handling WIPBR 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 6 gt lt DNS1 gt lt DNS2 gt 4 2 3 Parameters and Defined Values lt cmd type gt type of command O close bearer open bearer
112. vice 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 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 wavecom 6 confidential Page 36 122 This document is the sole and exclusive property of Wavecom Not to be
113. vior are OK unsolicited the UDP client socket is pseudo 1 connected to the peer no real connection is UDP create a UDP client towards peer IP device 1192 168 0 1 port 78 Jall parameters and IP stack behavior are OK Page 107 122 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 003 December 15 2008 woaovecom Smart wireless Smart business Examples of Application Creating 8 UDP sockets 8 TCP clients and 4 TCP servers 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 WIPREADY 1 8 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 wavecom 6 Confidential unsolicited the UDP client socket is pseudo 1 connected to the peer no real connection is UDP create a UDP client towards peer IP device 192 168 0 1 port 79 fall 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 1192 168 0 1 port 80 fall parame

AT Commands User Guide for Wavecom IP v5.11

Contents

Download Pdf Manuals

Related Search

Related Contents