Home

WIPsoft AT Commands User Guide 5.41

1. WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 24 WIPsoft 5 41 General Configuration 4 2 Bearers Handling WIPBR 4 2 1 Description ay 4 The WIPBR command can be used to e select the bearer e _ start close the bearer e configure different bearer options such as access point name 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 WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 25 WIPsoft 5 41 General Configuration e if lt cmdtype gt 6 Action Command AT WIPBR lt cmdtype gt lt bid gt lt mode gt OK Read Command AT WIPBR lt bid gt lt state gt lt bid gt lt state gt OK Test Command AT WIPBR OK e if lt mode gt 1 Unsolicited response WIPBR lt bid gt lt status gt lt local IP gt lt remote IP Q gt lt DNS1 gt lt DNS2 gt 4 2 3 Parameters and Defined Values
2. lt cmd type gt type of command 0 close bearer 1 open bearer 2 set value of different bearer options 3 get value of different bearer options 4 start bearer 5 stop bearer 6 bearer configuration management lt bid gt bearer Identifier 1 UART1 2 UART2 WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 26 WIPsoft 5 41 General Configuration 3 N A 4 ETHER 5 GSM 6 GPRS 11 14 CMUX port over UART1 21 24 CMUX port over UART2 lt opt num gt bearer option identifier 0 WIP_BOPT_LOGIN username string max 64 characters 1 WIP_BOPT_PASSWORD password string max 64 characters 2 WIP_BOPT_DIAL_PHONENB phone number string max 32 characters 5 WIP_BOPT_DIAL_RINGCOUNT Number of rings to wait before sending the WIP_BEV_DIAL_CALL event range 0 65535 6 WIP_BOPT_DIAL_MSNULLMODEM Enable MS Windows null modem protocol CLIENT SERVER handshake range 0 1 7 WIP_BOPT_PPP_PAP Allow PAP authentication range 0 1 8 WIP_BOPT_PPP_CHAP Allow CHAP authentication for the connection between the PC and the Wireless CPU UART bearer range 0 1 9 WIP_BOPT_PPP_MSCHAP1 Allow MSCHAPv1 authentication range 0 1 10 WIP_BOPT_PPP_MSCHAP2 Allow MSCHAPv2 authentication range 0 1 11 WIP_BOPT_GPRS_APN Address of GGSN string max 96 characters 12 WIP_BOPT_GPRS_CID Cid of the PDP context range 1 4 13 WIP_BOPT_GP
3. 4 2 7 Notes 4 2 7 1 For Starting a Bearer The mandatory parameters to start a bearer in e server mode lt cmdtype gt lt bid gt lt mode gt lt login gt and lt password gt e client mode lt cmdtype gt lt bid gt and lt mode gt Depending on the mode and the bearer type additional parameters are required or forbidden Bid Mode Other Parameters 1 3 11 14 21 24 0 None 1 3 11 14 21 24 1 lt PPP login gt lt PPP password gt 5 0 None 5 1 lt login gt lt password gt lt caller identity gt 6 0 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 behavior as described for PPP server The lt caller identity gt is an optional ASCII string type ASCII If not specified then target will accept all DATA calls independently of caller identification If specified then target will only accept calls from lt caller identity gt which is the GSM data call number of the GSM client Opening bearer only consists in associating the IP protocol stack with the specified bearer The corresponding bearer setup has to be done through the adequate already existing AT commands please refer to WMFM commands for UART
4. port 80 all 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 1 February 18 2011 91 WIPsoft 5 41 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 WM_DEV_OAT_UGD_076 Rev 009 Examples of Application start IP stack open GSM bearer set phone number for GSM bearer set user name set password start GSM bearer create a TCP client towards peer IP device ip addr port 80 all 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 1 February 18 2011 92 WIPsoft 5 41 9 2 UDP Socket 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 80 www sierr awireless com 80 OK WIPREADY 1 1 AT WIPDATA 1 1 1 CONNECT OK AT WIPCLOSE 1 1 OK AT WIPCREAT
5. start GPRS bearer connect to remote POP3 server connection and authentication are successful get total number of mails get total mail size retrieve mail id 5 February 18 2011 101 WIPsoft 5 41 AT WIPFILE 7 1 3 71 CONNECT lt user starts with the UART ends with an OK WM_DEV_OAT_UGD_076 getting ETX in data gt Rev 009 Examples of Application retrieve mail id 1 and delete it from the server after retrieving the mail mode and February 18 2011 102 WIPsoft 5 41 Examples of Application 9 9 MMS Example of sending an MMS with multiple recipients and multiple files with the same extensions Please note that files are not buffered but sent directly to the MMS Server Detailed information about the files is needed for the headers before and must be set for each file using WIPOPT before sending the file via WIPFILE start IP stack N WIPBR 1 6 open GPRS bearer N WIPBR 2 6 11 orange fr set APN name of GPRS bearer N FH WIPBR 2 6 0 user name set user name N A O A O AT O A O A T WIPBR 2 6 1 passwd set password OK AT WIPBR 4 6 0 start GPRS bearer OK AT WIPCREATE 8 1 create the connection to the MMS server 192 168 10 200 8080 http mms orange fr OK AT WIPOPT 8 7 1 7 2 82 Mr 7 Smith fadd email address to the TO field lt smith example com gt OK WM_DEV_OAT_UGD_076 Rev
6. OK WIPFILE 5 1 4 lt http status code gt lt http status reason gt CONNECT lt data sent terminated by ETX character gt OK CONNECT lt data received terminated by ETX character gt OK Note Retrieve mail ID 15 Mail is not deleted after retrieval CONNECT lt data received terminated by ETX character gt OK 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 For MMS when sending file data through AT WIPFILE command if data size is greater than the one specified via WIP_MMS_ADD_FILE or WIP_MMS_ADD_FILE_ANY options the data will be truncated to said option s size and module will leave the data mode When going back to AT mode WIPFILE proto index size will be received with the size equal to the size of the data that will be included in the MMS file WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 67 WIPsoft 5 41 Data Exchange for Protocol Services 6 2 Socket Data exchange WIPDATA mn TT 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 furthe
7. PING 95 POPS 101 SMTP 99 TCP Socket 89 UDP Socket 93 wip_ATCmdSubscribe 87 wip _ATCmdUnsubscribe 88 WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 124 hy SIERRA WIRELESS
8. WIP AT Commands User Guide WIPsoft 5 41 SR WM_DEV_OAT_UGD_076 SIERRA oos February 18 2011 WIRELESS WIPsoft 5 41 Introduction Important Notice Due to the nature of wireless communications transmission and reception of data can never be guaranteed Data may be delayed corrupted i e have errors or be totally lost Although significant delays or losses of data are rare when wireless devices such as the Sierra Wireless modem are used in a normal manner with a well constructed network the Sierra Wireless modem should not be used in situations where failure to transmit or receive data could result in damage of any kind to the user or any other party including but not limited to personal injury death or loss of property Sierra Wireless accepts no responsibility for damages of any kind resulting from delays or errors in data transmitted or received using the Sierra Wireless moden or for failure of the Sierra Wireless modem to transmit or receive such data Safety and Hazards Do not operate the Sierra Wireless modem in areas where blasting is in progress where explosive atmospheres may be present near medical equipment near life support equipment or any equipment which may be susceptible to any form of radio interference In such areas the Sierra Wireless modem MUST BE POWERED OFF The Sierra Wireless modem can transmit signals that could interfere with this equipment Do not operate the Sierra Wireless modem in any aircraft
9. lt A B gt Open Ar OS release version lt MM DD YYYY gt date of built of WIPsoft application lt HH MM SS gt time of built of WIPsoft application lt WIPlib version WIPlib version numbers lt WIPsoft version internally identifying WIPsoft version numbers 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 Note For lt opt num gt numbers 6 through 11 the AT WIPS command must be issued For complete details regarding AT WIPS please refer the Firmware AT Commands Interface Manual WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 20 WIPsoft 5 41 General Configuration 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 WIPCF G 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 err
10. 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 POPS 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 POP3 server if lt protocol gt 7 This mode is not supported by FTP and SMTP protocol 4 This command switches the UART in data mode and accepts a stream of data terminated by ETX character This mode is used for uploading data to the HTTP server using HTTP POST method if lt protocol gt 5 This mode is not supported by FTP SMTP and POP3 protocol 5 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 using FTP APPEND method server if lt protocol gt 4 This mode is not supported by other protocols WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 63 WIPsoft 5 41 Data Exchange for Protocol Services This mode is used to upload DATA in Data Offline mode by using WIPDATARW command This mode is used for uploading files to the FTP server if lt protocol gt
11. 56 WIPsoft 5 41 IP Protocol Services 5 3 7 6 3 Values of lt optval gt WIP_MMS_ADDFILE These are the file types that correspond to the values predefined in the MMS header specification For other types of file the MIME type has to be explicitly set as a string optval Option Type Description 0 UTF8 A text file of type UTF8 1 UTF16 A text file of type UTF16 2 UCS2 A text file of type USC2 3 US_ASCIl A text file of type US ASCII 4 JPEG An image file of type JPEG 5 GIF An image file of type GIF 6 TIFF An image file of type TIFF 7 PNG An image file of type PNG 8 WBMP An image file of type WBMP 9 SMIL A multimedia presentation of type SMIL 5 3 7 6 4 Phone Mail Option Notes 5 3 7 6 4 1 Recipients The total number of recipient To Cc Bcc must be less than or equal to 12 and for each recipient list To or Cc or Bcc the string length must be less than 250 characters including TYPE PLMN in case of phone recipient type 5 3 7 6 4 2 Command and Response When getting WIP_MMS_TO_PHONE WIP_MMS_TO_MAIL or WIP_MMS_CC_PHONE WIP_MMS_CC_MAIL or WIP_MMS_BCC_PHONE WIP_MMS_BCC_MAIL string is received in WIPOPT the response will include the complete TO or CC or BCC recipient list preceded by TYPE PLMN for phone recipient type For example If you enter AT WIPOPT 8 1 2 81 0683517984 set WIP_MMS_TO_PHONE option then AT WIPOPT 8 1 2 82 ovc sierrawireless com set WIP_MMS_TO_MAIL option After entering AT
12. TCP Data containing DLE ETX sequence Data containing ETX TCP ETX alone Causes signals a shutdown operation on TCP socket Note The behavior is symmetrical apply both on transmitting receiving side of mapped UART WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 70 WIPsoft 5 41 Data Exchange for Protocol Services 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 NT Data received from PC 1 abc DLE efgh Data sent from PC2 abc DLE efgh MAPPED ART Desktop PC1 Data sent to PC2 abc DLE DLE efgh Data received from PC2 abc DLE DLE Jefgh The above schematic explains how DLE characters which have a special meaning in WIPsoft are handled on Sierra Wireless embedded module On transmitting side when DLE is not escaped use case Desktop PC1 sends data towards embedded module 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 embedded module 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 embedded module Data contains a no escaped DLE the data sen
13. download file fiename txt CONNECT lt data gt ETX OK WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 96 WIPsoft 5 41 9 5 FIP DATA Offline 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 4 1 FTP server 21 username passwd OK AT WIPFILE 4 1 6 filename txt WIPDATARW 1 1 OK AT WIPDATARW 1 1 30313233343536373839 1 10 WIPDATARW 0 1 OK AT WIPFILE 4 1 7 filename txt tWIPDATARW 2 1 2 1 3132333435 tWIPDATARW 2 1 2 2 3132333435 tWIPDATARW 0 1 OK WIPDATARW 3 WM_DEV_OAT_UGD_076 Rev 009 Examples of Application start IP stack open GPRS bearer set APN name of GPRS bearer set user name set password start GPRS bearer create FTP session upload file filename txt upload data file 10 data bytes sent 1 WIPDATARW session closes on channel idx 7 Ydownload and dump filename txt file February 18 2011 97 WIPsoft 5 41 9 6 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
14. e if lt protocol gt 2 Unsolicited response WIPDATA lt protocol gt lt idx gt lt number of readable bytes gt Caution The value returned by lt number of readable bytes gt indicates that there is some TCP data ready to be read but number of bytes returned might not be reliable Moreover using WIPAT commands when receiving several TCP packets on an IP bearer WIPDATA indication is sent once for the first received packet The next indication for the next remaining TCP packet to read is sent after the first packet have been read using WIPDATA commana WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 73 WIPsoft 5 41 Data Exchange for Protocol Services 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 0 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 3 Data Offline Activate Data Data Offline mode on the specified socket 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 suppor
15. immediately MWtollowed by an shutdown connection reset by peer February 18 2011 106 WM_DEV_OAT_UGD_076 WIPsoft 5 41 Examples of Application 9 11 Creating a Server and 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 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 AT WIPCLOSE 3 1 OK Rev 009 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 1t 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 close TCP s
16. 009 February 18 2011 85 WM_DEV_OAT_UGD_076 WIPsoft 5 41 Ping Services 7 1 6 Examples Command Responses OK AT WIPPING www sierrawireless com WIPPING 1 0 0 Note Ping www sierrawireless com AT WIPPING 192 168 0 1 Note Ping 192 168 0 1 AT WIPPING 192 168 0 1 2 2000 1000 Note Send 2 successive ping requests to 192 168 0 1 Each Ping is every 2000 ms timeout is set to 1000 ms if ping responses time is more than 1000 ms then timeout expires Rev 009 Note Ping www sierrawireless com failed timeout expired OK WIPPING 0 0 224 Note Ping 192 168 0 7 succeeded Ping response received in 224 ms OK WIPPING 0 0 880 WIPPING 1 1 xxxx Note Ping 192 168 0 1 succeeded First Ping response received in 880 ms Second one was not received before specified timeout 1000 ms timeout expired February 18 2011 86 8 WIPsoft Library API The WIPsoft Application provides a comprehensive and flexible environment to use the IP feature using AT commands The WIPsoft Application is an application and it uses the WIPlib Plug In as the TCP IP protocol stack Hence when the WIPsoft application executed no other application can be executed in the embedded module WIPsoft API allow customer application to subscribe for AT WIP commands Customer application can subscribe to AT WIP commands using WIPsoft library API This feature allow
17. 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 data sent to socket index 1 and switched to AT mode by giving exchange data on socket index 1 data received from socket index 3 February 18 2011 120 10 Error Codes 10 1 General CME Error Codes WM_DEV_OAT_UGD Der rae 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 Ping channel 820 error writing
18. 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 78 WM_DEV_OAT_UGD_076 Rev 009 start IP stack open GPRS bearer set APN name of GPRS bearer set user name set password start GPRS bearer create a UDP client towards peer IP device 1 192 168 0 1 port 75 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 1 192 168 0 1 port 76 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 1192 168 0 1 port 77 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 1 192 168 0 1 port 78 February 18 2011 110 WIPsoft 5 41 OK WIPREADY 1 4 AT WIPCREATE 1 5 59 192 79 OK WIPREADY 1 5 AT WIPCREATE 1 6 60 192 80 OK W
19. 7 1 2 SYNTA kasarasan raige aiaia eiaa aiaiai a daaa aa deaa aaaea aa a Aaaa ddadda aaan 84 7 1 3 Parameters and Defined Values cccceceeeeenceceeeeeseeenaeeeeeeeeeeenanaeeeeeeeeeeeenanaees 85 7 1 4 Parameter Storage istic occu sted ainera eaeoe iaeia a eyes aKa a 85 7 1 5 Possible Errors ccccecececceeceeeeeeeeceeaeeeceeeeeeeceaaaeeeceeeeeseceaeaeeeeeeeedseeaeaeeeeeeeeneeesanaeees 85 7 1 6 DCE Pee ere ee neers ei errs Peter ery errs rere nr pee enc E res erence ETS 86 6 WIPSOFT LIBRARY API nasnnninnednnsnnnannnannennennenenees 87 8 1 Required Header File ceccccceceeseneeeeeneeceeeeeeeeeeeaneeeeesaeeeseeseeeseeseeeeeeeneeeeeeeneeaeesenenaes 87 8 2 The Wip ATGMdSubscribe FUNCTION wesisssscecevscecietesssccves see esessiocuedddedeiennecees deci neetees 87 8 2 1 PROLOTY PO e N E E E A A A N E A E E ET 87 8 2 2 eee E E E aceeveatensansedsauereus 87 8 2 3 Returned VAIUSS sirarni inaianei aaa iaaa aaa aaa ANAE A aAA EDNER RAN 87 8 3 The wip_ATCmadUnsubscribe FUunction cccccccsceceeceeceeeeeeeaeeeeeaeeeeeeeceaeeesaeseeaeesennees 88 8 3 1 PrOD E anona E E cv alned eat rede vaitedeg andi inde sees adeeatterdecuanean 88 8 3 2 PAVAMECHELS ccceecce cece ceeee eee ceeeeeeeceaaaeeeceeeeeceqeaaaeeeceeeeecaqaaeaeaeeeeeeeeeeeaeaeeeseeeeeeeecanaeees 88 8 3 3 Returned Values 0 cecececceececeeeeeeeeeaeee cece ee eeeeaaaeeeeeeeeesqaaeaeseceeeeesecaaeaeeeeeeeeeeeesanaeees 88 9 EXAMPLES OF APP
20. AT WIPPING lt host gt lt repeat gt lt interval gt lt timeout gt lt nwrite gt lt tt 1 gt 1 OK Read Command AT WIPPING OK Test Command AT WIPPING OK Unsolicited response WIPPING lt timeout_expired gt lt packet_ idx gt lt response time gt WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 84 WIPsoft 5 41 Ping Services 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 0 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 WM_DEV_OAT_UGD_076 Rev
21. HTTP it is proxy server address It can either be a 32 bit number in dotted decimal notation XXX XXX XXX XXxX 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 format 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 url gt URL of the MMS server This is an alphanumeric string format for hostname starting with http lt gt additional HTTP message header fields more pairs name value of HTTP message header field can be added WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 39 WIPsoft 5 41 IP Protocol Services 5 1 4 Parameter Storage None 5 1 5 Possible Errors CMEE AT error code Description 3 operation not allowed 800 invalid option 803 operation not allowed in the current WIP stack state 830 bad index 832 bad port number 834 not implemented 836 memory allocation error 8
22. If acknowledgement is not received within the timeout period then tCME ERROR 842 is returned This indicates that the peer socket is closed Please note that the retransmission of the data to the peer TCP socket within the timeout period is managed by the WIPlib Plug In 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 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 tCME 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
23. NOLES sides ecacevecgysdemuccetexn ac tacsemcnuavecvecuns ncaa sesh acanecunapenveas sarscauuenancesk iegasedmenaaaeaaceinees 76 6 2 11 1 Continuous Mode Non Transparent for a TCP Mapped Socket cceeseeeeeeees 76 6 2 11 2 Mapping Unmapping of a Mapped UDP and TCP Socket eecceeeeeeeeeeeeeeeeeeeetees 77 6 2 11 3 Time out Mechanism to know the state of the Peer TCP Socket ceseeeseeeeeeees 78 6 2 11 4 Packet Segmentation in TCP SOCKet cccceeceeeeeeeeeeeeeeeeeeeeeeeeseeeeeneeeseeeeeneeeeeeeeeaaes 78 6 2 11 5 Packet Segmentation in UDP Socket eceecceeseceseeeeeseeeeeeeeesaeeseaeeeseeeseaeeesaeeneaeeeaaee 79 6 3 DATA Offline session WIPDATARW ccccccccccseeeeeeceeeeeeeceeaeeeeeeeaeeeeeeaeeeesenaeeeeesaaes 80 6 3 1 REStNCUON Sasani aa an aE ENN E E aE Ea E NEEE ENA 80 6 3 2 SVANA E E EE E E a a ean ete 80 6 3 3 Parameters and Defined Values cccccceeeceeceeceeeeeeeeeeeaeeeeeeeeeseeeneaeeeeeeeeeseesnnaees 81 6 3 4 Parameter Storages sorina ensinan ioana a aana aaea NNa a aarun aN aaea N 81 6 3 5 POSSIDIG EONS sisaacessacevcdsseunoversnaeicvnagdceneusaessiahstnecevssadevia asneds aE i A 82 6 3 6 eue e E E E E E E T 82 7e PING SERVICE S aeaaaee aa A ea aaa aaa aA a a aAa aiaa aiaiai aan 84 Tels PING command WIPPING wi cassstdisiasscsevaanrdidasnstidvaanetdedaabsceataassidddaasace danssdddaasscaataansethe 84 7 1 1 DESCIIDUON E E E E lieee a E vitveesstlaeeennvivids 84
24. 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 WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 43 WIPsoft 5 41 IP Protocol Services 5 2 Closing a Service WIPCLOSE 5 2 1 Description The WIPCLOSE command is used to close a socket or FTP HTTP SMTP POP3 MMS session When one serial port UART or CMUX DLCl is used to map a socket for read write operations ETX character can also be used to close the socket An unsolicited event is generated when socket or FTP HTTP SMTP POP3 MMS session is closed 5 2 2 Syntax Action command AT WIPCLOSE lt protocol gt lt idx gt OK Read Command AT WIPCLOSE NONE Test Command AT WIPCLOSE OK Unsolicited response WIPPEERCLOSE lt protocol gt lt idx gt 5 2 3 Parameters and Defined Values lt protocol gt protocol type 1 UDP 2 TCP client 3 TCP server 4 FTP WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 44 WIPsoft 5 41 IP Protocol Services HTTP SMTP POP3 j N DO Oo MMS lt idx gt socke
25. destination IP address for GSM bearer AT WIPBR 4 5 0 Note Start the GSM bearer as a client AT WIPBR 3 5 15 Note Read the local IP for GSM bearer AT WIPBR 3 5 16 Note Read the destination IP for GSM bearer AT WIPBR 5 5 Note Stop the GSM bearer AT WIPBR 0 5 Note Close the GSM bearer AT WIPBR 1 4 Note Opens the Ethernet bearer AT WIPBR 4 4 0 Note Starts the Ethernet bearer in client mode AT WIPBR 5 4 Note Stops the Ethernet bearer AT WIPBR 0 4 Note Closes the Ethernet bearer AT WIPBR 2 4 23 1 Note Sets the DHCP to TRUE Default TRUE AT WIPBR 3 4 24 Note Read s the MAC address AT WIPBR 2 4 25 lt getway IP gt Note Sets the Default gateway address AT WIPBR 2 4 26 lt netmask IP Q gt Note Sets the Network mask address Rev 009 Note Local IP address is not set as GSM bearer is still not connected WIPBR 5 16 0 0 0 0 OK Note Destination IP address is not set as GSM bearer is still not connected WIPBR 5 1 WLPBR 3 160 725 252527 OK WIPBR 4 24 1 1 1 OK OK February 18 2011 32 WIPsoft 5 41 General Configuration Command Responses AT WIPBR 3 4 23 WIPBR 4 23 1 Note Reads the DHCP value OK AT WIPBR 3 4 25 WIPBR 4 25 10 66 67 193 Note Reads the Default gateway address OK AT WIPBR 3 4 26 WIPBR 4 26 255 255 255 192 Note Reads the Network mask address OK
26. lt proto lt index gt 0 on another UART in AT mode When the UART leaves data mode either because of escape sequence or because of an unmapping done on another UART the currently unsent data are sent as a single datagram WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 72 WIPsoft 5 41 Data Exchange for Protocol Services 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 Note Once the WIPDATA indication has been received on peer closed WPPEERCLOSE indication won t be received unless AT WIPDATA has been sent 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 command
27. lt wait time gt set to 2 AT WIPDATA 2 5 1 20 10 WM_DEV_OAT_UGD_076 Rev 009 Command Responses CONNECT lt j gt AT WIPDATA 2 5 1 peda Witte data OK Note sequence causes the UART to switch to AT mode CONNECT lt read write data gt OK Note sequence causes the UART to switch to AT mode CONNECT lt read write data gt OK Note sequence causes the UART to switch to AT mode CONNECT lt read write data gt lt ETX gt OK Note ETX character indicates end of data CONNECT lt read write data gt OK Note sequence causes the UART to switch to AT mode CONNECT lt read write data gt OK Note sequence causes the UART to switch to AT mode CONNECT lt read write data gt OK February 18 2011 WIPsoft 5 41 Command 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 AT WIPDATA 2 5 2 10 5 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 AT WIPDATA 2 5 2 Note TCP with index 5 can send read data in continuous transparent mode 6 2 11 Notes 6 2 11 1 Socket Data Exchange for Protocol Services Responses Note sequence causes the UART to switch to AT mode CONNECT lt read write data gt OK Note sequence causes t
28. 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 Creation Close Server 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 WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 35 WIPsoft 5 41 IP Protocol Services Connect request 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 WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 36 WIP
29. previously specified by WIPOPT 4 send the XYZ file previously specified by WIPOPT 4 send WIP_MMS_DONE to signal that the users has sent the last file This is to avoid deadlock errors where the user missed to send a file unsolicited the server accepted a connection and the MMS was sent successfully Close the connection to the server February 18 2011 105 WIPsoft 5 41 Examples of Application 9 10 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 tWIPACCEPT 1 5 tWIPACCEPT 1 6 AT WIPCLOSE 2 5 OK WM_DEV_OAT_UGD_076 Rev 009 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
30. problems etc Thus a single packet of data may be received in more than one packet at the peer WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 78 WIPsoft 5 41 Data Exchange for Protocol Services 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 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 WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 79 WIPsoft 5 41 Data Exchange for Protocol Services 6 3 DATA Offline session WIPDATARW This command is used to upload or download data on UART without switching to DATA mode CONNECT OK Onlin
31. received once the TCP client is ready for usage OK OK WIPREADY 5 1 Note HTTP session with proxy and 1 message header field Use default 80 proxy port number 1 message header field Message header field name is User Agent Message header field value is WIP HTTTP Client 1 0 OK WIPREADY 5 1 February 18 2011 41 WIPsoft 5 41 Command AT WIPCREATE 5 1 proxyaddress j user T pass AT WIPCREATE 6 1 smtp mail yaho o fr 587 user pass AT WIPCREATE 7 1 192 168 1 4 110 r user A pass AT WIPCREATE 7 1 pop mail server com IP Protocol Services Responses Note HTTP session with proxy and 3 message header fields Use default 80 proxy port number 3 message header fields Message header field name is User Agent and header field value is WIP HTTTP Client 1 0 Message header field name is Accept Encoding and header field value is gzip Message header field name is Accept Language and header field value is en US OK WIPREADY 5 1 Note Authentication connection on default proxy server port 80 OK WIPREADY 6 1 Note Connect to SMTP server port 587 with given username and password OK WIPREADY 7 1 Note Connect to POP3 server port 110 with given username and password OK WIPREADY 7 1 Note Connect to the default port 110 of POP3 server with no authentication required
32. 009 February 18 2011 103 WIPsoft 5 41 AT WIPOPT 8 1 2 83 33623456789 OK AT WIPOPT 8 1 2 83 0654321987 OK AT WIPOPT 8 1 2 86 X lt x y com gt OK AT WIPOPT 8 1 2 92 1 application smil lt 001 gt OK AT WIPOPT 8 1 2 93 9 100 1 smil lt 001 gt OK AT WIPOPT 8 1 2 93 2 222 2 txt OK AT WIPOPT 8 1 2 93 3 304 lt 003 gt OK AT WIPOPT 8 1 2 93 4 1024 4 jpeg lt 004 gt OK AT WIPOPT 8 1 2 93 5 2048 5 gif lt 005 gt OK AT WIPOPT 8 1 2 94 audio xyz 128 6 xyz lt XYZ gt OK AT WIPFILE 8 1 2 1 smil lt 001 gt CONNECT lt user starts sending the file with the UART in data mode and ends with an ETX character gt OK WM_DEV_OAT_UGD_076 Rev 009 Examples of Application add telephone number to the CC field add telephone number to the CC field add email address to the BCC field set the multipart type to Related and specify that the first file that should be read is a type SMIL with the content id lt 001 gt add a SMIL multimedia presentation file of size 100 Bytes with filename 1 smil and content id lt 001 gt add a text file of type USC2 of size 222 bytes with the filename 2 txt but no content id add a text file of type ASCII of size 304 Bytes with no filename but content id lt 003 gt 4 add a JPEG picture of size 1024 Bytes with the filename 4 jpeg and content id lt 00
33. 011 59 WIPsoft 5 41 Data Exchange for Protocol Services eee GSM GPRS g Data received from PC1 abc DLE d Data sent to PC1 abc DLE d MAPPED UART Desktop PC1 Data sent to PC2 ab DLE c DLE DLE d Data received from PC2 abc DLE DLE a The above schematic explains how DLE characters which have a special meaning in WIPsoft are handled on Sierra Wireless embedded module On the transmitting side when DLE characters are escaped by another DLE character use case Desktop PC1 sends data to the embedded module 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 embedded module 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 2 FTP HTTP SMTP Session in Continuous Mode In continuous mode an ETX character is considered as an end of data 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 character The mapped UART can be s
34. 1 and UART2 CMUX command for CMUX virtual ports and GSM GPRS AT commands Several bearers 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 WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 33 WIPsoft 5 41 General Configuration 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 The Ethernet bearer can be started only in client mode WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 34 5 IP Protocol Services 5 1 Service Creation WIPCREATE F y j 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 POPS service Only one FTP HTTP SMTP POP3 MMS 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
35. 2 5 2 Phone number OK AT WIPBR 2 5 0 user name OK AT WIPBR 2 5 1 passwd OK AT WIPBR 4 5 0 OK AT WIPCREATE 3 1 80 5 8 OK WIPACCEPT 1 5 AT WIPDATA 2 5 1 CONNECT OK AT WIPCLOSE 2 5 OK WM_DEV_OAT_UGD_076 Rev 009 Examples of Application start IP stack open GSM bearer set phone number for GSM bearer set user name set password start GSM bearer create the server on port 80 idx 1 The server is listening for connection request on port 1 80 Spawned sockets will be given the index 5 6 7 and 8 It will accept connection request until it has no more socket left unsolicited the server accepted a connection resulting TCP client on idx 5 exchange data on socket idx 5 read write switch to AT mode close the TCP client socket index 5 February 18 2011 90 WIPsoft 5 41 9 1 2 TCP Client Socket 9 1 2 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 2 1 ip addr 80 OK WIPREADY 2 1 AT WIPDATA 2 1 1 CONNECT OK AT WIPCLOSE 2 1 OK WM_DEV_OAT_UGD_076 Rev 009 Examples of Application start IP stack open GPRS bearer set APN name of GPRS bearer set user name set password start GPRS bearer create a TCP client towards peer IP device ip addr
36. 28 WIPOPT 7 73 4 36400 WLPOPT 75 137 5 396 OK AT WIPOPT 7 1 1 73 Note Get mail listing WIPOPT 7 74 10 OK AT WIPOPT 7 1 2 74 10 WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 50 WIPsoft 5 41 IP Protocol Services Command Responses Note Delete mail ID 10 5 WIPOPT 8y Toy Mr Smith AT WIPOPT 8 L 2 82 Mr Smith lt mr smith example com lt mr smith example com OK Note Add an email address to the To field of an MMS 5 3 7 Notes It is possible to change and retrieve option value using WIPOPT command only when the socket session given by lt idx gt is active else it returns error 5 3 7 1 Options that can be applied to UDP TCP Client TCP Server Sockets opt Value TCP TCP Option Type Description UDP num format client server 0 0 65535 WIP_COPT_ PORT Port of the socket R R R 1 0 65535 WIP_COPT_PEER_PORT Port of the peer socket R R 2 string WIP_COPT_PEER_STRADDR amp ress of the peer R R socket Specifies whether the socket is bounded2 to 3 0 1 WIP_COPT_BOUND a peer socket or not R default 1 Minimum amount of available space that must be available in the emission buffer before 4 1 5839 WIP_COPT_SND_LOWAT triggering a RW RW WIP_CEV_WRITE event default 1024 Number of bytes that can currently be read 6 0 65535 WIP_COPT_NREAD emithat socket R R default 0 WM_DEV_OAT_UGD_076 Rev 009 Febru
37. 37 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 unreachable response timeout attempt is made to reserve create a client socket which is already 349 reserved opened by TCP server client 851 incorrect number of parameters submitted 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 communication index 1 a mbeoded moaule will be received once the UDP socket is ready acts as an UDP server awaiting for incoming for sage datagram on local port 8O g AT WIPCREATE 1 1 www sierrawire OK less com 80 WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 40 WM_DEV_OAT_UGD_076 WIPsoft 5 41 Command Note Create the UDP socket on arbitrary free local port with peer IP and peer port 80 with communication index 1 embedded module acts as a UDP client that can send datagram towards the remote entity AT WIPCREATE 1 1 80 www sierraw ireless com 80 Note Create the UDP socket on local port 8O with peer IP and peer port 80 with communication index 1 embedded module acts as a UDP clien
38. 4 This mode is used for sending mail to the SMTP server if lt protocol gt 6 This mode is not supported by other protocols This mode is used to download and display DATA in Data Offline mode by using WIPDATARW command This mode is used for downloading a file from the FTP server if lt protocol gt 4 This mode is used for downloading data of the specified URL using HTTP GET method if lt protocol gt 5 This mode is used for retrieving mail without deleting it from the POPS server if lt protocol gt 7 This mode is not supported by other protocols This mode is used for retrieving mail and deleting after retrieval from the POP3 server if lt protocol gt 7 in Data Offline mode by using WIPDATARW command This mode is not supported by other protocols This mode is used for uploading a file using FTP APPEND method server if lt protocol gt 4 in Data Offline mode by using WIPDATARW command This mode is not supported by other protocols 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 if lt protocol gt 8 the identifier matching the identifier specified in WIPOPT Please note that the order of the files sent using WIPFILE must match the o
39. 4 gt 4 add a GIF picture of size 2048 Bytes with the filename 5 gif and content id lt 005 gt add a file of a content type specified in the string of size 128 Bytes with the filename 6 xyz and content id lt XYZ gt 1 NOW SEND THE CONTENT OF THE FILES IN THE SAME ORDER 1 send the SMIL file previously specified by WIPOPT February 18 2011 104 WIPsoft 5 41 AT WIPFILE 8 1 2 2 txt CONNECT lt user starts sending the file the UART in data mode and with an ETX character gt OK AT WIPFILE 8 1 2 lt 003 gt CONNECT lt user starts sending the file the UART in data mode and with an ETX character gt OK AT WIPFILE 8 1 2 4 jpeg lt 004 gt CONNECT lt user starts sending the file with the UART in data mode and ends with an ETX character gt OK AT WIPFILE 8 1 2 5 gif lt 005 gt CONNECT lt user starts sending the file with the UART in data mode and ends with an ETX character gt OK AT WIPFILE 8 1 2 6 xyz lt XYZ gt CONNECT lt user starts sending the file with the UART in data mode and ends with an ETX character gt OK AT WIPOPT 8 1 2 96 OK WIPACCEPT 1 5 AT WIPCLOSE 8 1 OK WM_DEV_OAT_UGD_076 Rev 009 Examples of Application 4 send the WIPOPT TXT file previously specified by 47 send the TXT file previously specified by WIPOPT 4 send the JPEG previously specified by WIPOPT 4 send the GIF
40. 5 3 7 3 Options that can be applied to HTTP Session opt Value Value Option type Description Type num format type set the size of the TCP socket 50 u32 WIP_COPT_RCV_BUFSIZE receive buffer RW default 0 WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 52 WIPsoft 5 41 IP Protocol Services opt Value Value Option type Description Type num format type set the size of the TCP socket send 51 u32 WIP_COPT_SND_BUFSIZE buffer RW default 0 WIP_COPT_HTTP_VERSION define the HTTP version to be used by the session pe ae ue 0 HTTP 1 0 ate on default 1 1 HTTP 1 1 set the maximum number of allowed redirects 53 u32 WIP_COPT_HTTP_MAXREDIRECT a zero value disables automatic Ww redirects default 8 return the HTTP message header lt ascii field or a list of message header 2 iste WIPZCOPI HTI P HEADER fields from the last WIPFILE call R 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 get last protocol error code 60 digit string u32 ascii WIP_COPT_SMTP_STATUS_CODE and associated error string R default NULL string set the sender address 6 string ascii WIP_COPT_SMTP_SENDER detauft
41. AT WIPCREATE 8 1 192 168 10 200 8080 http mm s orange fr OK WIPREADY 8 1 WM_DEV_OAT_UGD_076 5 1 7 Notes Note Connect to the MMS server with no authentication required The maximum number of sockets can be set to 23 so that WIPsoft can handle in the same time either one FTP session in passive mode HTTP SMTP POP3 8 UDP sockets 8 TCP client sockets and 4 TCP servers Starting a TCP server requires to specify the maximum number of communication sockets that can be spawned This can be done using lt from idx gt and lt to idx gt parameters Note that the value set for lt to idx gt should be equal or more than lt from idx gt The maximum communication socket that can be created using WIPsoft 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 Rev 009 February 18 2011 42 WIPsoft 5 41 IP Protocol Services It is not possible to create a client socket with AT WIPCREATE 2 x y z when x is already reserved by a server with AT WIPCREATE 3 lt server idx gt lt local port gt a b where asxsb Similarly it is not possible to reserve a range with AT WIPCREATE 3 lt server idx gt lt local port gt a b if one of the TCP client socket indexes between a and b is already reserved be it by a client or a server range The lt from idx gt an
42. Action Command AT WIPCFG lt mode gt OK e if lt mode gt 2 Action Command AT WIPCFG lt mode gt lt opt num gt lt value gt OK e if lt mode gt 3 Action Command AT WIPCFG lt mode gt WIPsoft vxXX YY ZZ on Open AT OS vA B MMM DDD YYYY HH MM SS lt WIPlib version number gt lt WIPsoft version number gt OK WM_DEV_OAT _UGD_076 Rev 009 February 18 2011 16 WIPsoft 5 41 General Configuration 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 WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 17 WIPsoft 5 41 4 1 3 General Configuration Parameters and Defined Values lt mode gt requested operation stop TCP IP stack start TCP IP stack Note If the Ethernet bearer support is defined the Ethernet driver is subscribed on executing WIPCFG 1 configure TCP IP stack display TCP IP application version TCP IP stack configuration management lt opt num gt configuration option identifier 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 fi
43. Configuration Command Responses WIPsoft v202 on Open AT OS v312 AT WIPCFG 3 Mar 26 2007 11 45 46 WIPlib v2a07 WIPsoft vlal2 Note Display software version OK AT WIPCFG 0 OK Note Stop the TCP IP Stack AT WIPCFG 4 1 Note Store IP configuration parameters OK into FLASH AT WIPCFG 4 0 OK Note Free IP configuration parameters stored in FLASH WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 23 WIPsoft 5 41 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 memory which causes the WIPsoft 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 e WIP_NET_OPT_IP_TTL e WIP_NET_OPT_IP_TOS e WIP_NET_OPT_IP_FRAG_TIMEO e WIP_NET_OPT_TCP_MAXINITWIN e WIP_NET_OPT_TCP_MIN_MSS e WIP_NET_OPT_DEBUG_PORT e AT_WIP_NET_OPT_PREF_TIMEOUT_VALUE e AT_WIP_NET_OPT_ESC_ SEQ NOT_SENT e AT_WIP_NET_OPT_AUTO_SWITCH
44. E ETX sequence then ETX is not transmitted but an action is done on embedded module 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 TCP socket a non escaped ETX causes a TCP shutdown operation on the transmitting direction peer is informed that embedded module 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 embedded module sends data towards Desktop PC1 Data contain a non escaped ETX no DLE ETX sequence then ETX means that a special IP event occurred on embedded module regarding the concerned socket e UDP socket a non escaped ETX signals the boundary of the current received datagram WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 69 WIPsoft 5 41 Data Exchange for Protocol Services e TCP socket a non escaped ETX signal 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 sequence Data containing ETX UDP ETX alone Mark the boundary of the UDP Datagram received to be transmitted
45. E 1 1 1234 OK WIPREADY 1 1 WIPDATA Lp 257 1L9221698 0 2 239 7 AT WIPDATA 1 1 1 WM_DEV_OAT_UGD_076 Rev 009 Examples of Application 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 WY www sierrawireless com port 80 Hall parameters and IP stack behavior are OK unsolicited the UDP client socket is pseudo connected to the peer no real connection is UDP exchange data on socket idx 1 Wread write switch to AT mode close the UDP socket index 1 start a UDP server and listen for datagram on port M1234 all parameters and IP stack behavior are OK unsolicited the UDP client socket is pseudo connected to the peer no real connection is UDP Hone datagram is ready to be read it was sent from 192 168 0 2 on port 2397 and is composed of 25 bytes February 18 2011 93 WIPsoft 5 41 CONNECT abcedghijklmnopqrstuvwxyz ETX or AT WIPDATA 1 1 0 OK WIPDATA 1 1 50 192 168 0 4 58 AT WIPDATA 1 1 1 CONNECT abcedghijklmnopgqrstuvwxyzabced ghijklmnopgrstuvwxyz ETX WM_DEV_OAT_UGD_076 Rev 009 Examples of Application Where 25 bytes the ETX character marking the bound of the datagram have been read type on this UART escape sequence or un map the UART on other control po
46. II AT BCC CC CHAP CHV CID CMUX CPU DNS GGSN GPRS GSM HTTP IP IPCP M MS N A MSCHAP MSS NU O OS PAP PDP PIN POP3 PPP SIM SMTP TCP TOS TTL WM_DEV_OAT_UGD_076 Definition Access Point Name American Standard Code for Information Interchange ATtention Blind Carbon Copy Carbon Copy Challenge Handshake Authentication Protocol Card Holder Verification Context IDentifier Converter Multiplexer Central Processing Unit Domain Name System Gateway GPRS Support Node General Packet Radio Service Global System for Mobile communication Hyper Text Transfer Protocol Internet Protocol Internet Protocol Control Protocol Mandatory Mobile Station Not Applicable MicroSoft Challenge Handshake Authentication Maximum Segment Size Not Used Optional Operating System Password Authentication Protocol Packet Data Protocol Personal Identity Number Post Office Protocol Point to Point Protocol Subscriber Information Module Simple Mail Transfer Protocol Transmission Control Protocol Type Of Service Time To Live Rev 009 February 18 2011 10 WIPsoft 5 41 Introduction Abbreviation UART UDP URL WIP Definition Universal Asynchronous Receiver Transmitter User Data Protocol Uniform Resource Locator Wavecom Internet Protocol 1 2 Logos Definition This picture indicates the WIND indication from which the AT command is allowed X v
47. IPREADY 1 6 AT WIPCREATE 1 7 61 192 81 OK WIPREADY 1 7 AT WIPCREATE 1 8 62 192 82 OK WIPREADY 1 8 AT WIPCREATE 1 9 63 192 83 CME ERROR 830 AT WIPCREATE 3 1 80 1 1 OK AT WIPCREATE 3 2 81 2 2 OK AT WIPCREATE 3 3 82 3 3 OK AT WIPCREATE 3 4 83 4 4 OK AT WIPCREATE 3 5 84 5 5 CME ERROR 830 WM_DEV_OAT_UGD_076 Rev 009 Examples of Application 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 1 192 168 0 1 port 79 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 80 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 81 Jall parameters and IP stack behavior are OK unsolicited the UDP client socket is pseudo connected to the peer no real connection is UDP create a UDP client towards peer IP device 1 192 168 0 1 port 82 Jall parameters and IP stack behavior are OK unsolicited the UDP client socket is pseudo connected to the peer no real c
48. K Note Download file in continuous transparent mode AT WIPFILE 4 1 2 report log 1 Note Upload file in continuous transparent mode AT WIPFILE 4 1 1 data bin 0 Note Download file in continuous mode AT WIPFILE 4 1 2 report log 0 Note Upload file in continuous mode AT WIPFILE 5 1 2 urlForPut Rev 009 Note sequence causes the UART to switch to AT mode CONNECT lt data gt OK Note sequence causes the UART to switch to AT mode CONNECT lt data received terminated by ETX character gt OK CONNECT lt data terminated by character gt OK CONNECT lt data terminated by character gt OK WIPFILE 5 1 2 lt http status code gt lt http status reason gt ETX ETX February 18 2011 66 WIPsoft 5 41 Data Exchange for Protocol Services Command Note Send a HTTP PUT request to URL AT WIPFILE 5 1 3 urlForDelete Note Send a HTTP DELETE request to URL AT WIPFILE 5 1 4 urlForPost Note Send a HTTP POST request to URL AT WIPFILE 6 1 2 Note Send data mail content AT WIPFILE 7 1 1 715 Note Retrieve data from the given ID AT WIPFILE 7 1 3 71 Note Retrieve data from the given ID Responses CONNECT lt data received terminated by ETX character gt OK WIPFILE 5 1 3 lt http status code gt lt http status reason gt CONNECT lt data received terminated by ETX character gt
49. LICATION vsvsssssscicczecsccxctacacscatassicxetatinccelatiedeatatincesiatenceaiatins 89 9 1 TOP SOCK GE inrer aa o E ee aa AA a Eaa TE Ea ENEE EAE 89 9 1 1 TCP Server Socket cccccccccecseseececeeeeeeceeeaeeeceeeeeeeseeeaeeeceeeaeeeseeeaeeeseeaeeeesenaeeseneaaes 89 9i Using GPRS bearers sa sieceedece ese cd artes dove betes eave lenaveneds aa e aiea aaie 89 9 1 1 2 Using GSM beater P cadet dia duwsaeesserndiethuclaseeesidiacies 90 9 1 2 TOP Ghent SOCK Cb vcs isss ceri aicae cievancesvawacastcdasuawsdsvauce cauvssesvacacgeddlvcasincazedancdadeasnneadecsedans 91 gizi Using GPRS Bearers siaina piei ainiaan 91 9722 JUSING GSM Beales neapero aa e R Ee e E e Aa ETES 92 9 2 UDP Eole e saitancatesinctansststdanstadssensehiascareneatesssasndenduenstersdacssideesnscnsiniediaseeataatciadsebsensberses 93 9 3 a E T E E E E A E A E T E E 95 9 4 PIP a e a a 96 9 5 FEP DATA OHIM Erein a EEEN aSa ENNE ESEA AREON ERRA ENEE ETE 97 9 6 FAT E E PE E A E 98 WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 8 WIPsoft 5 41 Introduction 9 7 SMP eeaeee ee A teenies E EE E a A a aa aaa 99 9 8 POPS ien a E EE E EE E E E N 101 9 9 MMS oeae E E e E e E 103 9 10 Creating a TCP Server spawning the maximum TCP Socket for the configured Server 106 9 11 Creating a Server and try to create a TCP Client Server on a reserved index reserved by The Server wilifailrs ssrin anien eia o a a E aAa E EraLan 107 9 12 Create a TCP Client and try to creat
50. NULL string RW s set the sender name 62 string ascii WIP_COPT_SMTP_SENDERNAME default NULL string RW P set the recipients list WIP PT_SMTP_RE 63 string ascii COPT_S REC default NULL string RW n set the CC recipients list 4 WIP PT_SMTP RE 6 string ascii COPT_S CC C default NULL string RW P set the BCC recipients list 65 string ascii WIP_COPT_SMTP_BCC_REC default NULL string RW A set the mail subject WIP PT_SMTP B 66 string ascii COPT_S SUBJ default NULL string RW decide if the SMTP library will format the mail header or if the application is in charge of formatting it 67 digit u32 WIP_COPT_SMTP_FORMAT_HEADER 0 Application formats mail RW header 1 SMTP lib formats mail header default 1 WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 53 WIPsoft 5 41 IP Protocol Services Caution Caution When option WIP_COPT_SMTP_FORMAT_HEADER is set to 0 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 cod
51. 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 AT WIPFILE 5 1 1 urlForGet use rname password Accept text html Transfer codings compress CONNECT lt user starts the with the UART ends with an ETX gt OK WIPFILE getting Sy l i 255 Found WM_DEV_OAT_UGD_076 Rev 009 mail in data mode and Examples of Application 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 87 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 MHTTP GET method unsolicited string on the HTTP status code Jand reason February 18 2011 98 WIPsoft 5 41 Examples of Application 9 7 SMTP AT WIPCFG 1 start IP stack OK AT WIPBR 1 6 open GPRS bearer OK AT WIPBR 2 F 6 i 11 7 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 6 1 F 192 168 1 2 25 connect to remote SMTP server user password OK connection and authentication are successful WIPREADY 6 1 WM_DE
52. RS_HEADERCOMP Enable PDP header compression range 0 1 14 WIP_BOPT_GPRS_DATACOMP Enable PDP data compression range 0 1 15 WIP_BOPT_IP_ADDR Local IP address IP string WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 27 WIPsoft 5 41 General Configuration 16 WIP_BOPT_IP_DST_ADDR Destination IP address IP string 17 WIP_BOPT_IP_DNS1 Address of primary DNS server IP string 18 WIP_BOPT_IP_DNS2 Address of secondary DNS server IP string 19 WIP_BOPT_IP_SETDNS Configure DNS resolver when connection is established range 0 1 20 WIP_BOPT_IP_SETGW Set interface as default gateway when connection is established range 0 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 22 WIP_BOPT_DEBUG_PKT Enable the debug traces of NET level 10 range 0 1 23 WIP_BOPT_IP_DHCP Enables auto configuration of IP address and Netmask with DHCP range 0 1 24 WIP_BOPT_IP_MAC Reads the MAC address functioning as a read only option 25 WIP_BOPT_IP_NETMASK Sets the Network mask 26 WIP_BOPT_IP_GW Sets address of default gateway 27 WIP_BOPT_RESTART Automatically restart server after connection is terminated 28 WIP_BOPT_GPRS_ERROR_REPORTING report lt GPRS CME errors g
53. Rev 009 February 18 2011 29 WIPsoft 5 41 4 2 5 General Configuration Possible Errors 4 2 5 1 General CME Errors The possible error message is displayed only if AT CMEE 1 is activated else ERROR is displayed CMEE AT a 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 failure 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 4 2 5 2 GPRS CME Errors GPRS CME errors are listed in the table below Error Meaning Resulting from the following code commands 103 Incorrect MS identity 3 CGATT 132 service option not supported 32 CGACT CGDATA ATD 99 133 requested service option not subscribed 33 CGACT CGDATA ATD 99 134 service option temporarily out of order 26 34 CGACT CGDATA ATD 99 38 148 unspecified GPRS error All GPRS commands 149 PDP aut
54. S are registered trademarks of Apple Inc registered in the U S and other countries QUALCOMM is a registered trademark of QUALCOMM Incorporated Used under license Other trademarks are the property of the respective owners Contact Information 1 604 232 1488 8 00 AM to 5 00 PM Pacific Time sales sierrawireless com Sales Desk Sierra Wireless 13811 Wireless Way Richmond BC Canada V6V 3A4 Fax 1 604 231 1109 Web www sierrawireless com Post Consult our website for up to date product descriptions documentation application notes firmware upgrades troubleshooting tips and press releases www sierrawireless com WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 3 WIPsoft 5 41 Introduction Document History Version 001 002 003 004 005 006 007 008 Date March 14 2008 May 30 2008 December 15 2008 March 9 2009 July 28 2009 February 22 2010 March 24 2010 July 20 2010 WM_DEV_OAT_UGD_076 Updates Creation Update for WIPsoft v5 01 Update for WIPsoft v5 11 Update for WIPsoft v5 12 Updated definition of Error 850 and 852 definitions updated Added Note If the Ethernet bearer support is defined the Ethernet driver is subscribed on executing WIPCFG 1 AT WIP NET OPT AUTO SWITCH definition updated lt bid gt parameter identifier updated to ETHER Seven new rows added to Parameters table starting with Parameter number 23
55. TY TO USE ANY SIERRA WIRELESS PRODUCT EVEN IF SIERRA WIRELESS AND OR ITS AFFILIATES HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES OR THEY ARE FORESEEABLE OR FOR CLAIMS BY ANY THIRD PARTY Notwithstanding the foregoing in no event shall Sierra Wireless and or its affiliates aggregate liability arising under or in connection with the Sierra Wireless product regardless of the number of events occurrences or claims giving rise to liability be in excess of the price paid by the purchaser for the Sierra Wireless product WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 WIPsoft 5 41 Introduction Patents This product may contain technology developed by or for Sierra Wireless Inc This product includes technology licensed from QUALCOMM 3G This product is manufactured or sold by Sierra Wireless Inc or its affiliates under one or more patents licensed from InterDigital Group Copyright 2011 Sierra Wireless All rights reserved Trademarks AirCard and Watcher are registered trademarks of Sierra Wireless Sierra Wireless AirPrime AirLink AirVantage and the Sierra Wireless logo are trademarks of Sierra Wireless wavecom D insim WAVECON WISMO Wireless Microprocessor Wireless CPU Open AT are filed or registered trademarks of Sierra Wireless S A in France and or in other countries Windows and Windows Vista are registered trademarks of Microsoft Corporation Macintosh and Mac O
56. UDP create a UDP client towards peer IP device 1 192 168 0 1 port 77 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 1 192 168 0 1 port 78 February 18 2011 115 WIPsoft 5 41 OK WIPREADY 1 4 AT WIPCREATE 1 5 59 192 79 OK WIPREADY 1 5 AT WIPCREATE 1 6 60 192 80 OK WIPREADY 1 6 AT WIPCREATE 1 7 61 192 81 OK WIPREADY 1 7 AT WIPCREATE 1 8 62 192 82 OK WIPREADY 1 8 AT WIPCREATE 1 9 63 192 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 AT WIPCREATE 3 4 86 4 4 OK AT WIPCREATE 3 5 84 5 5 CME ERROR 830 WM_DEV_OAT_UGD_076 Rev 009 Examples of Application Yall parameters and IP stack behavior are OK unsolicited the UDP client socket is pseudo connected to the peer no real connection is UDP create a UDP client towards peer IP device 1 192 168 0 1 port 79 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 80 Jall parameters and IP stack behavior are OK unsolicited the UDP client socket is pseudo con
57. V_OAT_UGD_076 Rev 009 February 18 2011 99 WIPsoft 5 41 Examples of Application AT WIPOPT 6 1 2 61 sender mail c Set sender mail address om OK AT WIPOPT 6 1 F 2 62 j sender name set sender name OK AT WIPOPT 6 1 2 63 set receiver mail address recO1l mail com rec02 mail com OK AT WIPOPT 6 1 2 64 ccrecO1 mail Set CC receiver mail address com ccrec0O2 mail com OK AT WIPOPT 6 1 2 65 bccrec01 mail Set BCC mail address com bccrec02 mail com OK AT WIPOPT 6 1 2 66 mail subject Set mail subject OK AT WIPFILE 6 1 2 send mail CONNECT lt user starts sending mail with the UART in data mode and ends with an ETX character gt OK WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 100 WM_DEV_OAT_UGD_076 WIPsoft 5 41 9 8 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 7 1 192 168 1 2 11 0 user password OK WIPREADY 7 1 AT WIPOPT 7 1 1 71 Ty Fl 10 WIPOPT OK AT WIPOPT 7 1 1 72 WIPOPT 7 72 124000 OK AT WIPFILE 7 1 1 5 CONNECT lt user starts the with the UART ends with an ETX gt OK getting Rev 009 mail in data mode and Examples of Application start IP stack open GPRS bearer set APN name of GPRS bearer set user name set password
58. WIPOPT 8 1 1 81 get WIP_MMS_TO_ PHONE option or AT WIPOPT 8 1 1 82 get WIP_MMS_TO_MAIL option the response will be WIPOPT 8 82 0683517984 TYPE PLMN ovc sierrawireless com WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 57 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 6 1 File Exchange WIPFILE 6 1 1 Description The WIPFILE command defines the file system services that send a block of data through standard TCP IP protocols This command is used for file transfer reception The data can be transferred using two modes continuous mode and continuous transparent mode The FTP HTTP SMTP MMS protocols support continuous mode of operation But continuous transparent mode is supported only by FTP protocol By default all these protocols transfer data using continuous mode However data transfer using FTP protocol can be configured using lt dle_mode gt parameter Note There is no lt dle_mode gt parameter specified in the WIPFILE command to configure mode of operation for HTTP SMTP protocol 6 1 1 1 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 int
59. aeeeeeeeeeseeanaeeeeeeeeeseenanaees 44 5 2 4 Parameter Stor gE risorsa an eiaeia Eaa N a Naaa 45 9 2 5 Possible ERFOVS sg 2scaeiic sadvoiye sien ien sau tenndecdach idi a adaa ai aiea ia iaaa danaa 45 5 2 6 FX ICS Arahat E E EIE sistas A T E A E EE E 45 5 2 7 NOTES 6 senses aens iore n da ana SE Aa n aE aa aaa a 46 5 3 Service Option Handling WIPOPT sssiiesisiaisinnirietaieaninaianinainiadaian iaei iaai iain 47 5 3 1 BE oie a EE E E 47 5 3 2 DVIMAX EET T 47 5 3 3 Parameters and Defined Values ccccccceeeecccceceeeeeeeeeeeaeeeeeeeeeseeaaeaeeeeeeeeeeeesanaees 48 5 3 4 Parameter Storage sissors aa aeiaai a ar enaa Nda 48 5 3 5 Possible ERrOMs 3 ienien aaie aie dana aadd a aieiaiei aaa iaai 49 5 3 6 DEEE T E EE E ade E E E E E 49 5 3 7 NOLE Saniat a aaa oaaae eaea Aaa on in cenuuh aaaaion ineeudad sanded ince ARAE TEESE 51 5 3 7 1 Options that can be applied to UDP TCP Client TCP Server Sockets 8 51 5 3 7 2 Options that can be applied to FTP Session eecceeeceeseeeeeeceeeeeeeeeeeeeneeeeeeeetneeeeeeeenaees 52 5 3 7 3 Options that can be applied to HTTP Session 0 ce eecceceeeeeeeeeneeeeeeeeeneeeeeeeeeneeeneneeeaees 52 5 3 7 4 Options that can be applied to SMTP Session cccceeccceeeeeeeeeeneeeeeeeeeeeeseeeesenseeeess 53 5 3 7 5 Options that can be applied to POP3 Session cccececceeeeeeeeeeeneeeeeeeaeeeeeeeeeesenseeeess 54 5 3 7 6 Options that can be applied to MMS session
60. alues can be 1 3 4 or 16 This picture indicates that a SIM card must be inserted to support the AT command This picture indicates that an AT command is supported even if the SIM card is absent This picture indicates that the PIN 1 CHV 1 code must be entered to support the AT command This picture indicates that an AT command is supported even if the PIN 1 CHV 1 code is not entered This picture indicates that the PIN 2 CHV 2 code must be entered to support the AT command This picture indicates that an AT command is supported even if the PIN 2 CHV 2 code is not entered WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 11 WIPsoft 5 41 Introduction 1 3 AT Commands Presentation Rules The AT commands to be presented in the document are as follows e A Description section as Heading 3 provides general information on the AT command or response behavior e A Syntax section as Heading 3 describes the command and response syntaxes and all parameters description e A Parameters and Defined Values section as Heading 3 describes all parameters and values e A Parameter Storage as Heading 3 presents the command used to store the parameter value and or the command used to restore the parameter default value e An Examples section as Heading 3 presents the real use of the described command e A Note section as Heading 3 can also be included indicating some remarks about the command use Figures are provid
61. and gt 1 to write it and send the TX buffer Only 200 data bytes can be read or written at a time DATA received are displayed by 200 byte block if received data buffer to display is bigger than 200 bytes 6 3 4 Parameter Storage None WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 81 WIPsoft 5 41 6 3 5 Possible Errors 6 3 6 Examples Command Data Exchange for Protocol Services CMEE AT error code Description 800 Invalid option 801 Invalid option value 830 Bad index 831 Bad state 836 Memory allocation error 853 Data offline buffer full Responses AT WIPDATA 1 1 3 UDP socket have b created n previously WIPDATARW 1 1 OK Note exchange data on socket index 1 with AT Command Note WIPDATARW session ready on channel idx 1 AT WIPDATARW 1 1 30313233343 536373839 WIPDATARW 3 1 10 OK Note send 10 data byte on channel idx 1 Note 10 data bytes had been sent WIPDATA 1 1 10 192 168 1 2 1357 WIPDATARW 2 1 1 1 313233343536 3738 OK Note Data dump received on channel idx 1 AT WIPDATARW 2 1 30 39 OK Note Write 200 Data bytes in TX Buffer Note 200 data bytes are stored in TX Buffer AT WIPDATARW 2 1 30 39 OK Note Write 200 Data bytes in TX Buffer Note 200 data bytes are stored in TX Buffer AT WIPDATARW 1 1 3039 WIPDATARW 3 1 402 OK Note Write 2 Data by
62. ary 18 2011 51 WIPsoft 5 41 IP Protocol Services opt Value TCP TCP Option Type Description UDP num format client server 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 7 0 1 WIP_COPT_NODELAY either RW RW a by combining several small packets into a bigger packet b when the data is ready to send and the stack is idle default 0 Time to leave for 8 0 255 WIP_COPT_TTL packets RW RW RW default 64 Type of service default 0 ne Pa RN 9 0 255 WIP_COPT_TOS 2 The option WIP_COPT_BOUND is used to check whether an UDP socket is bound to any other UDP socket or not When the UDP socket is created without specifying the IP address of the peer then the option WIP_COPT_BOUND will be read as FALSE This is because there is no destination IP address to communicate with If the UDP socket is created by specifying the peer IP address the option WIP_COPT_BOUND will be read as TRUE This is because the peer IP address will be resolved by the DNS and the socket is said to be bounded to the peer socket Hence this option will be read as TRUE 5 3 7 2 Options that can be applied to FTP Session opt num Value format Value type Description data representation type 0 ASCII 1 binary default 0 FTP mode 0 active 1 passive default 1 40 0 1 boolean 41 0 1 boolean
63. assword 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 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 SMTP email body send request rejected by server 890 Service denied 891 Message format corrupt 892 Address unresolved 893 Message not found 894 Network problem 895 Content not accepted 896 Unsupported message 897 Unspecified error WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 122 WIPsoft 5 41 Error Codes 10 2 GPRS CME Error Codes lt error gt Meaning Resulting from the following commands 103 Incorrect MS identity 3 CGATT 132 Service option not supported 32 CGACT CGDATA ATD 99 133 Requested service option not CGACT CGDATA ATD 99 subscribed 33 134 Service option temporarily out of order CGACT CGDATA ATD 99 26 34 38 148 Unspecified GPRS error All GPRS commands 149 PDP authentication failure 29 CGACT CGDATA ATD 99 150 Invalid mobile class CGCLASS CGATT WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 123 Index WIPBR 25 WIPCFG 16 WIPCLOSE 44 WIPCREATE 35 WIPDATA 68 WIPFILE 58 WIPOPT 47 WIPPING 84 FTP 96 HTTP 98
64. aution When option WIP_COPT_POP3_STATUS_CODE is used to retrieve the error code and the associated error string for the POP3 session creation it will not return any error code and error string if no error occurred during that particular POP3 session creation For example after the SMTP session is created successfully an attempt to retrieve the error code and the associated error string using the option WIP_COPT_POP3_STATUS_CODE will result in an error code 0 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 0 and the associated error string because the first POP3 session was successful WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 54 WIPsoft 5 41 IP Protocol Services 5 3 7 6 Options that can be applied to MMS sessions opt Value Value Option type Description Type num format type 80 u32 u32 WIP_MMS_DATE Set the value of the date and time of RW the MMS in the following format Month Day Year Hour Min Sec 81 string ascii WIP_MMS_TO_PHONE Adds a telephone number to the TO RW field in the MMS 82 string ascii WIP_MMS_TO_EMAIL Adds an email address to the TO RW field in the MMS 83 string asci
65. cdectdedeesaved iraa a a oiiaii 30 4 2 5 2 GPRS CME Errors ccc cc cccccccccsseccseccsecccesceecesnsceececnseeeceensenececesceecucnscnesusetenecececesecececcnecees 30 4 2 6 EXGIM PICS E E E E decade xh E E E E 31 4 2 7 Nole Sorone o E ENE E O EE a a a TAUN NENNE 33 42 74 For Starting a Beane he cic cesicp ncdsseec ceceinies eben eeekedheheettee dined auntenesOnwaeeedeiealenedinancs 33 5 IP PROTOCOL SERVICES wrctecececacasdcucadicccacacicceamascescucenacdcnnsaendeseeseusususteasesieaecs 35 5 1 Service Creation WIPCREATE 0 ccccccccccccecccccccecece cease ceceeeeeseaueeseseeseseaueaeaseeeesesaeanees 35 5 1 1 Beale a I se care Sa eect A E en aa E E A aeateg tage ates 35 5 1 2 VMAX AE sae tes te A E E E E E E E 36 5 1 3 Parameters and Defined Values 0 cc ccc cccccececceeeecessseeecessseuueeeeeeeeseueeeeuaueeeeeeaaees 38 5 1 4 Parameter Storage sriccctes onsena niedda aana a aee Eea EKEKA 40 5 1 5 POSSIDIE EnO S crre A A E a aaan 40 5 1 6 Example Tarena ee ek i eee dete ae TT 40 5 17 INTC S E EE E crete gece ce AEE EEA EE O EEEE E E EE E EA ETT 42 WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 WIPsoft 5 41 Introduction 5 2 Closing a Service 4WIPCLOSE vsi ccciecsectestdetdes hice cceedenscideacid cnt aiandi aai aaia dakai Aak 44 5 2 1 DGSCII DOM aE e a Mies si achat ieee at Weees EAE AE 44 5 2 2 SVAK r E suet cesadeavsceeaecu E E E E 44 5 23 Parameters and Defined Values cccccceeeeencceceeeeeeeeee
66. command with lt send size gt and lt wait time gt specified results in ERROR WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 77 WIPsoft 5 41 Data Exchange for Protocol Services 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 the specified time out period then the data is retransmitted But if the time out occurs before receiving acknowledgement then it implies that the peer TCP socket is closed TCP Timeout Period function R N Where R Round trip time This is the time for a TCP packet to go to the remote TCP socket and the time to receive the acknowledgement by the transmitter TCP socket The typical round trip time is 1 seconds for GPRS N Number of retransmission allowed before the time out happens Hence the typical timeout period is 10 minutes depending on the network and also the peer TCP socket localization In WIPsoft to know the state of the peer socket data needs to be sent
67. 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 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 TGP socket or FTP HTTP SMTP POPS session is already active 841 peer closed or error in the FTP connection 842 TD host unreachable whether host unreachable Network unreachable response 076 Rev 009 February 18 2011 121 WIPsoft 5 41 Error Codes eae Description 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 bearer connection failure 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 850 invalid channel option or parameter value for example HTTP user name too long 851 specified parameters to the command is more or less than the maximum number of mandatory parameters 852 IP stack not initialized 853 Data offline buffer filled 854 859 reserved for future use 860 protocol undefined or internal error 861 username rejected by server 862 p
68. d connection resulting TCP client on idx 2 unsolicited the server index 3 accepted connection resulting TCP client on idx 3 unsolicited the server index 4 accepted connection resulting TCP client on idx 4 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 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 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 1 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 1 192 168 0 1 port 80 Index 8 is already used and corresponds to an active socket create a TCP client towards a peer IP device 1 192 168 0 1 port 80 Index 9 is forbidden February 18 2011 112 WIPsoft 5 41 Examples of Application 9 14 Changing the MAX_SOCK_NUM option value and try to create 8 UDP sockets 8 TCP Client sockets and 4 TCP Server sockets AT WIPCFG 1 start IP stack OK AT WIPCFG 2 6 3 ZMAX SOCK NUM
69. d 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 soawned 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 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
70. d the server index 2 accepted connection resulting TCP client on idx 2 LWIPACCEPT unsolicited the server index 3 accepted connection resulting TCP client on idx 3 LWIPACCEPT unsolicited the server index 4 accepted connection resulting TCP client on idx 4 AT WIPCREATE 2 5 192 168 0 2 80 create a TCP client towards peer IP device a g 1 192 168 0 2 port 80 OK Jall parameters and IP stack behavior are OK WIPREFADY 2 5 unsolicited the TCP client socket is connected to the peer AT WIPCREATE 2 6 192 168 0 2 80 create a TCP client towards peer IP device T 1 192 168 0 2 port 80 OK Jall parameters and IP stack behavior are OK WIPREADY 2 6 unsolicited the TCP client socket is connected to the peer AT WIPCREATE 2 7 192 168 0 2 80 create a TCP client towards peer IP device a 1192 168 0 2 port 80 OK all parameters and IP stack behavior are OK WIPREFADY 2 7 unsolicited the TCP client socket is connected to the peer AT WIPCREATE 2 8 192 168 0 2 80 create a TCP client towards peer IP device D 1 192 168 0 2 port 80 OK Jall parameters and IP stack behavior are OK WIPREADY 2 8 unsolicited the TCP client socket is connected to the peer AT WIPCREATE 2 8 192 168 0 2 80 create a TCP client towards peer IP device ts 192 168 0 2 port 80 Index 8 is already CME ERROR 840 used and corresp
71. e a TCP Server with indexes range containing TCP Ghent WAN fall enaa aa E AEAEE SETETE S NENE EE 109 9 13 Creating 8 UDP sockets 8 TCP clients and 4 TCP servers c ccccccesseeeeetteeeseeeeees 110 9 14 Changing the MAX_SOCK_NUM option value and try to create 8 UDP sockets 8 TCP Client sockets and 4 TCP Server sockets 0 c cccccseceecessneeeceeeneeeeeeeeeeeeeaeeeeesaeeeeeeeeeeeesseeeeneas 113 9 15 Creating 8 UDP sockets 8 TCP Clients 4 TCP Servers and either one PIP ATUP SMIP P OP 8s wtsccessss cxeess saxdewessacvesstesernb sh ayvevsd veeutds ssoevevand coves ssavtesalavevasessoeees NEEE REE 115 9 16 Subscribe Unsubscribe WIPsoft AT commands using WIPsoft Library API 119 9 17 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 ee 120 10 ERROR CODES wissisncispsecinspiznwacechceeeneakenencneirannetpetiawexaehaseenwebipmasneseaseeeebieeeceesensenese 121 10 1 General CME Error Codes sicssics csccdscacitesssdevsitendensecice seed aA ONTEER ANENA EAREN SE EAEEREN 121 10 2 GPRS GME Error CodeS sesiis annann EEE naaa NRA SEARA KREASE RASANA 123 WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 9 1 Introduction The aim of this document is to provide Sierra Wireless customers with a full description of the AT commands associated with the WIP feature 1 1 Abbreviations Abbreviation APN ASC
72. e and the associated error string using the option WIP_COPT_SMTP_STATUS_CODE will result in an error code 0 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 0 and the associated error string because the first SMTP session was successful 5 3 7 5 Options that can be applied to POP3 Session 71 72 74 opt Value Value num format type 70 digit string u32 ascii WIP_COPT_POP3_STATUS_CODE 73 digit string ascii not a POP3 wip option Option type Description Type get last protocol error code and associated error string get total number of mails u32 WIP_COPT_POP3_NB_MAILS default depends on the mails R available in the mail box get total mail size u32 WIP_COPT_POP3_MAILSIZE default depends on the mails R available in the mail box get mail listing 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 delete the mail ID The mail ID corresponds to the mail ID returned by the mail listing option default depends on the mails available in the mail box u32 not a POP3 wip option C
73. e gt WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 80 WIPsoft 5 41 Data Exchange for Protocol Services Unsolicited message lt state gt 2 WIPDATARW lt state gt lt idx gt lt nb block gt lt num block gt lt DATA DUMP gt WIPDATARW lt state gt lt idx gt lt nb block gt lt num block gt lt DATA DUMP gt Read Command AT WIPDATARW OK Test Command AT WI PDATARW OK 6 3 3 Parameters and Defined Values lt command gt 0 Close WIPDATARW session 1 WRITE and Send Add DATA in TX buffer then send all data stored in the buffer 2 WRITE EXT Add DATA in TX buffer but buffer is not sent 3 WRITE Send and close Add DATA in TX buffer send all data stored in the buffer then close the current DATA offline session This command is only supported for WIPDATA session lt idx gt channel identifier lt state gt 0 WIPDATARW session Closed for the channel lt idx gt specified 1 WIPDATARW session Opened for the channel lt idx gt specified Ready to send or received data 2 Data reading 3 Data sent lt DATA DUMP gt DATA in hexadecimal format To send more than 200 bytes data use WIPDATARW with lt command gt 2 to add data to buffer and use for the last block Data must be written in TX buffer with lt command gt 2 by 200 byte block and the last block must be written with lt comm
74. e mode for WIPDATA and WIPFILE commands DATA offline session starts when AT WIPDATA command is used with mode 3 or when AT WIPFILE command is used with mode 6 7 8 or 9 Otherwise WIPDATARW command can t be use and returns CME ERROR 831 error message In this mode DLE ETX characters are considered as normal data and not special characters Data read or written are in hexadecimal dump format 6 3 1 Restrictions e DATA offline feature is not recommended to send or received quickly high data volume In this case the nominal online mode shall be used e Toimprove AT command exchange and behavior the use of USB com port is recommended Otherwise UART com port buffer threshold shall be decrease with WHCNF command see General AT Command User Guide e Be careful for TCP socket WIPDATA a maximum of 5840 bytes can be send Over this size data are lost but no error is returned e WIDATARW command should not be used to fill TX sender buffer with more than 5840 bytes 4 1460 for TCP socket 6 3 2 Syntax Action abort lt command gt O AT WIPDATARW lt command gt lt idx gt WIPDATARW lt state gt lt idx gt OK Action write lt command gt 1 2 or 3 AT WIPDATARW lt command gt lt idx gt lt DATA DUMP gt OK Unsolicited message lt state gt Oor 1 WIPDATARW lt state gt lt idx gt Unsolicited message lt state gt 3 WIPDATARW lt state gt lt idx gt lt siz
75. ed where necessary WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 2 AT Command Syntax This section describes the AT command format and the default value for their parameters 2 1 Command Line Commands always start by the standard prefix AT WIP and end with the lt CR gt character Optional parameters are shown in brackets Example AT WIPcmd lt Param1 gt lt Param2 gt lt Param2 gt is optional When the AT WIPcmd is executed without lt Param2 gt the default value of lt param2 gt is used 2 2 Information Responses and Result Codes Responses start and end with lt CR gt lt LF gt except for the ATVO DCE response format and the ATQ1 result code suppression commands e If command syntax is incorrect the ERROR string is returned e f 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 0 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 WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 3 Principles WIPsoft is an application that imp
76. eld 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 WIP_NET_OPT_IP_TOS Default TOS of outgoing parameters The IP protocol provides a facility for the Internet layer to know about the various tradeoffs that should be made for a particular packet This is required because paths through the Internet vary widely in terms of the quality of service provided This facility is defined as the Type of Service facility abbreviated as the TOS facility The TOS facility is one of the features of the Type of Service octet in the IP datagram header The Type of Service octet consists of following three fields O 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 i
77. ernet are sent to the host through the serial port preceded by a DLE character WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 58 WIPsoft 5 41 Data Exchange for Protocol Services Desktop PC2 GSM GPRS p Data received from PC1 ab ETX c Data sent to PC1 ab ETX c MAPPED UART Desktop PC1 Data sent to PC2 ab DLE ETX c ETX Data received from PC2 abc DLE ETX c The above schematic explains how ETX characters which have a special meaning in WIPsoft are handled on Sierra Wireless embedded module On transmitting side when ETX characters are escaped by a DLE use case Desktop PC1 sends data to the embedded module 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 embedded module 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 1 2 DLE Escaping Mechanism In case a DLE character needs to be transmitted as data it should be preceded by another DLE character A single DLE character not preceded by a DLE character will not be transmitted Similarly DLE characters received are sent to the host through the serial port preceded by a DLE character WM_DEV_OAT_UGD_076 Rev 009 February 18 2
78. erver socket index 7 February 18 2011 107 WIPsoft 5 41 AT WIPCREATE 3 2 81 2 3 CME ERROR 845 Examples of Application create the 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 WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 108 WIPsoft 5 41 Examples of Application 9 12 Create a TCP Client and try to create a TCP Server with indexes 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 a 1 198 168 0 1 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 WIPCREATE 3 i 2 P 80 1 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 WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 109 WIPsoft 5 41 Examples of Application 9 13 Creating 8 UDP sockets 8 TCP clients and 4 TCP servers AT WIPCFG 1 OK AT WIPBR 1 6 OK AT WIPBR
79. f the following commands e Service Creation WIPCREATE e Closing a Service WIPCLOSE e Service Option Handling WIPOPT including additional options that can be applied to MMS sessions e File Exchange WIPFILE e MMS Example e MMS Errors 890 through 897 e Note regarding the WIP_MMS DONE option Added new TCP Options function as lt opt num gt 16 and 17 in the IP Stack Handling WIPCFG section Rev 009 February 18 2011 5 Contents 1 INTRODUCTION aac aenacuvaconauatdcenndiiacunncabiecnniavancnnaebnannsalagnedvaiieanaeeueennesieenmeabiuans 10 1 1 ADDF OVIALIO MS seat cnc dete condvcceanicditat cqcuded sagehePasaneata sgactudeacaccdadanactindaceatuada aaaeaii e anai 10 1 2 LOJO Sneen ari E E E 11 1 3 AT Commands Presentation Rules aoeeeeseseeeenenesssssesnrnnrsnnssrrnrsnrinensnennrnnrnesnnnnnrnennn 12 2 AT COMMAND SYNTAX cccccecceeecceeecneseneeeceeeeeeeeaeeeeeseesseneeenaeeceseeesenaeeenesens 13 2 1 Command LINE oe tits seseseten sy Sacdacesvedcccnseaevacaeacdecuai tes a ENAERE a EN SAR 13 2 2 Information Responses and Result Codes c ccccccceseeceeceeeeeeeeeeaeeeeseeseeeeeseaeeesneeeeeeees 13 3 PRINCIPLES c ccccccseccseesceescceeeceeeeeeseeseeueeeeeseeeeeneeeeesseeueeceeeeeseussenaeenaeseuesens 14 3 1 Sockets Identification 2 cceccececceccsceeeee ee ceceseeeauaueeseceeseuseaueeseseeeeeeaueasaseeeeeeeaeanees 15 3 1 1 Possible Protocols issam Ra E E NENO 15 3 1 2 Nu
80. 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 U start IP stack OK AT WIPBR 1 6 open GPRS bearer OK AT WIPBR 2 6 11 A RPN 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 create a UDP client towards peer IP device 15 ps W192 168 0 1 port 75 d OK all parameters and IP stack behavior are OK WIPREADY 1 1 unsolicited the UDP client socket is pseudo d connected to the peer no real connection is UDP AT WIPCREATE 1 2 56 192 168 0 1 create a UDP client towards peer IP device 76 A W192 168 0 1 port 76 F WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 113 WM_DEV_OAT_UGD_076 WIPsoft 5 41 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 78 CME ERROR 838 Rev 009 Examples of Application 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 1 192 168 0 1 port 77 all parameters and IP stack behavior are OK unsolicited the UDP client socket is pseudo connected to
81. he UART to switch to AT mode 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 If the ETX character is sent from the peer it is considered as an end of data transfer After sending an ETX character the socket will be shutdown and the peer will be informed of this shutdown by a CR LFJSHUTDOWN CR LF indication on its mapped UART and the UART does not switch to AT mode This indicates that no more data can be sent from the host socket but it can receive data The below schematic shows the shutdown procedure for a TCP socket WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 WIPsoft 5 41 Data Exchange for Protocol Services Internet AN CPU Data received on the mapped UART on PC2 abcd ETX SHUTDOYYN Data received on the AT window of PC2 VVIPPEERCLOSE Desktop lt proto gt lt idx gt PC1 Data sent from PC1 abcd ET xX In the above schematic a TCP socket is connected On the transmitting side data and ETX is sent use case Desktop PC1 is a embedded module which sends data to PC2 which is either a PC ora embedded module the data is received on PC2 and ETX character shutdowns the socket on the transmitting side and displays a message CR LF JSHUTDOWN CR LF on the mapped UART of PC2 When PC2 is switched back to AT mode WIPPEERCLOSE lt protocol gt lt idx gt indicati
82. hentication failure 29 CGACT CGDATA ATD 99 150 invalid mobile class CGCLASS CGATT WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 WIPsoft 5 41 General Configuration 4 2 6 Examples Command Responses 1 0 6 1 AT WIPBR OK Note Bearer UART7 is open but not started bearer GPRS is open and started OK AT WIPBR Note No bearer has been opened yet AT WIPBR 1 6 OK Note Open GPRS bearer AT WIPBR 2 6 11 APN name aR Note Set APN of GPRS bearer AT WIPBR 3 6 11 WIPBR 6 11 APN name Note Get APN of GPRS bearer OK AT WIPBR 2 6 21 600 Note set GPRS connection timeout value to OK 60s AT WIPBR 4 6 0 OK Note Start GPRS bearer AT WIPBR 5 6 OK Note Stop GPRS bearer AT WIPBR 0 6 OK Note Close GPRS bearer AT WIPBR 1 5 OK Note Open GSM bearer AT WIPBR 2 5 0 login R Note Set the login for GSM bearer AT WIPBR 2 5 1 password aa Note Set the password for GSM bearer AT WIPBR 2 5 2 phonenumber ay Note Set the phone number for GSM bearer AT WIPBR 2 5 15 1 1 1 1 m Note Set the local IP address for GSM bearer AT WIPBR 2 5 16 2 2 2 2 Note Set the destination IP address for GSM OK bearer WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 31 WM_DEV_OAT_UGD_076 WIPsoft 5 41 General Configuration Command Responses AT WIPBR 3 5 15 WIPBR 5 15 0 0 0 0 OK Note Read the local IP address for GSM bearer AT WIPBR 3 5 16 Note Read the
83. i WIP_MMS_CC_PHONE Adds a telephone number to the CC RW field in the MMS 84 string ascii WIP_MMS_CC_EMAIL Adds an email address to the CC RW field in the MMS 85 string ascii WIP_MMS_BCC_PHONE Adds a telephone number to the RW BCC field in the MMS 86 string ascii WIP_MMS_BCC_EMAIL Adds an email address to the BCC RW field in the MMS 87 string ascii WIP_MMS_SUBJECT Set the value of the Subject field in RW the MMS 88 See u32 WIP_MMS_CLASS Set the class of the MMS RW Table 89 See u32 WIP_MMS_PRIORITY Set the priority of the MMS RW Table 90 u32 u32 WIP_MMS_SENDER_VISIBILITY Set the sender visibility of the MMS RW show 0 default hide 1 91 string ascii WIP_MMS_ FROM Set the sender of the MMS RW 92 u32 u32 WIP_MMS_MULTIPART_TYPE Set the value of the MMS Multipart RW Type via lt optval gt as u32 Mixed 0 default Related 1 In the case of Related the presentation file type is sent in lt optval2 gt as a string and the start file identification is sent in lt optval3 gt as a string 93 See u32 WIP_MMS_ADD FILE About to attach a file of type WwW Table specified in lt optval gt as u32 please see Table 5 3 7 6 1 for possible values The size in Bytes as u32 is sent in lt optval2 gt The file name is sent as a string in lt optval3 gt Content id is sent in lt optval4 gt At least one of either file name or content id must be set WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 55 WIPsoft 5 41 IP Protocol Services o
84. ifies a given socket of this protocol 3 1 1 Possible Protocols The possible protocols are e 1 UDP e 2 TCP in connect mode Client e 3 TCP in listen mode Server e 4 FTP e 5 HTTP e 6 SMIP e 7 POP3 e 8 MMS Two pairs with a different protocol number but the same index identify two distinct sockets Example Both 1 7 and 2 7 are valid identifiers simultaneously the former identifies a UDP socket and the later a TCP connected socket 3 1 2 Number of Sockets The number of sockets per protocol is limited e UDP 8 sockets e TCP Clients 8 sockets e 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 WIPsoft 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 the Firmware AT Commands Interface Manual especially the AT WCFM command and we recommend you to contact your Sierra Wireless distributor or sales point for further details WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 15 4 General Configuration 4 1 IP Stack Handling WIPCFG 4 1 1 Description The WIPCFG command is used for performing the following operations e start TCP IP stack e stop TCP IP stack e configuring TCP IP stack e displaying version information 4 1 2 Syntax e if lt mode gt 0 1
85. in 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 WIPsoft library WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 119 WM_DEV_OAT_UGD_076 WIPsoft 5 41 Examples of Application 9 17 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 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 abc OK AT WIPDATA 2 1 1 CONNECT abc OK Rev 009 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 1198
86. lements the TCP IP protocols using custom AT commands This application operates in co operative mode and must be downloaded to the Sierra Wireless embedded module The commands are sent from an external application and the corresponding responses are sent back from the module to the external application The WIPsoft uses the APIs provided by WIPlib and provides custom AT command interface to the external application AT WIP commands involve e ahost computer which issues AT WIP commands e Sierra Wireless intelligent embedded module e the rest of the Internet Intranet a Sierra Wireless embedded module AT Commands INTERNET Host CPU 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 WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 WIPsoft 5 41 Principles 3 1 Sockets Identification Sockets are identified by a pair of numbers the first one identifies the protocol the second one ident
87. lt mode gt specifies type of socket UDP TCP Client TCP server FTP HTTP Client SMTP Client POP3 Client N off A j N MMS Client lt index gt TCP UDP FTP HTTP SMTP POP3 MMS 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 sierrawireless com WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 38 WIPsoft 5 41 IP Protocol Services lt peer port gt peer port or the server port For TCP UDP this parameter is the port of the peer socket For FTP HTTP SMTP POP3 and MMS 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 default value for MMS 8080 lt from idx gt minimum index for spawned TCP sockets range 1 8 lt server index gt TCP server socket identifier range 1 4 lt to idx gt maximum index for spawned TCP sockets range 1 8 lt communication index gt indexes reserved for spawned sockets It cannot be used by other sockets even if the spawned sockets are not created yet range 1 8 lt server gt server address or proxy address This parameter is the server address for FTP SMTP and POP3 protocol and for
88. mber of Sockets cccccecccccccccc cece eececeseeeaeeeeeseceeesuseaueesesseeeeeuaueaeeseeeeseuaeaaeaseeseeesees 15 3 1 3 INQUSS EEE E AE E E E AE E EAE E A E A A 15 4 GENERAL CONFIGURAT ION nassnaasnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnna 16 4 1 IP Stack Handling WIPCFG ccccceccceeeeeeeeneeceeeeecaeeeeaaeeeeeeeseaeeesaaeeseaeeseeeesiaeessaaeeeenees 16 4 1 1 EV SCION ses ice farses Ba aye cn eons phen aga ice ty ne aa bene ed stage da aac ice E 16 4 1 2 VMAX A E E E E E T A E E sat tetiaisereraeeseees 16 4 1 3 Parameters and Defined Values 0 c cece cess cecccceceeceseseeeceesueeuceeeeeueeueueeseesauaeeeeanees 18 4 1 4 Parameter Storage siceraria aae i deed eden Adina 21 4 1 5 POSSIDIC EmO Sorsa rA EN a A a Ea Ea a Ea r aANT 21 4 1 6 eaa e E E E E 22 4 1 7 INOS S seas crt cet E Seaveute A A E EE E E EE ESEO 24 4 2 Bearers Handling WIPBR cccesccccessseceeeeeeeceeeeeeeceeeseneceeesneceeesneaeeesnneeeeseneeaeeeennnees 25 4 2 1 EV GSCI EA Siena lca ttt E E cauctn usb ey hige da cute de O E 25 4 2 2 SV MAN cs cte ec ate a a ove death a a a A S 25 4 2 3 Parameters and Defined Values 0 cc cece cc ceceecesceeessseeeceseuuuuceeeueeeeueuaeeeeuauaeeeesaaees 26 4 2 4 Parameter Storage ines ten aeseaetacel ioro aoan sacatiivsscvevts andi tbvaendesWeaeutii vaste 29 4 2 5 POSSIDIG Eio S iccschiesececente cece eed ac ceviesd A A E eeauken 30 4 25 General CME EMtorSessczcceces
89. nd WIP_BOPT_IP_DNS2 can be read after the bearer connection is established successfully If an attempt is made to read the options value before the bearer connection is established successtully incorrect IP address will be received Caution The options WIP_BOPT_IP_NETMASK and WIP_BOPT_IP_GW can be read after the bearer connection is established successfully If an attempt is made to read the options value before the bearer connection is established successfully incorrect IP address will be received Also the option WIP_BOPT_IP_MAC can be read after the bearer connection is open successfully If an attempt is made to read the options value before the bearer connection is open incorrect IP address will be received If the Ethernet bearer supported is defined the MAC address is read from the Ethernet driver on opening the bearer i e WIPBR 4 1 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 WM_DEV_OAT_UGD_076
90. nected to the peer no real connection is UDP create a UDP client towards peer IP device 1 192 168 0 1 port 81 Jall parameters and IP stack behavior are OK unsolicited the UDP client socket is pseudo connected to the peer no real connection is UDP create a UDP client towards peer IP device 1 192 168 0 1 port 82 Jall parameters and IP stack behavior are OK unsolicited the UDP client socket is pseudo connected to the peer no real connection is UDP 1 8 UDP sockets have been created and hence VF attempt fails create one server on port 83 idx 1 One TCP client socket is reserved on index 1 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 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 February 18 2011 116 WIPsoft 5 41 Examples of Application AT WIPCREATE 2 1 192 168 0 1 83 4 TCP server have been created and each of them reserved 1 TCP client socket and hence CME ERROR 845 1 5 attempt of creating TCP server fails 1 4 reserved TCP client sockets have been spawned by their TCP server WIPACCEPT unsolicited the server index 1 accepted connection resulting TCP client on idx 1 WIPACCEPT unsolicite
91. on 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 6 2 11 2 Mapping Unmapping of a Mapped UDP and TCP Socket When a TCP socket is unmapped and still active it is possible to map it again in another mode which is different from the previous one without closing the TCP socket The UART switches back to AT mode due to with 1 second guard time before and after the sequence or by sending an AT WIPDATA lt proto gt lt index gt 0 on another UART in AT mode This applies to both UDP and TCP protocols When is issued embedded module switches from DATA mode to AT mode If ATO command is used to switch the embedded module 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 embedded module 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 embedded module is switched back to DATA mode Note that un mapping socket using WIPDATA
92. onds to an active socket AT WIPCREATE 2 9 192 168 0 2 80 create a TCP client towards a peer IP device 1192 168 0 2 port 80 Index 9 is forbidden CME ERROR 830 AT WIPCREATE 4 1 ftp create FTP session using default port 27 server user name password OK J FTP session is created successfully AT WIPCREATE 7 1 POP3 server user name mail id p 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 WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 117 WIPsoft 5 41 OK WIPPEERCLOSE 4 1 AT WIPCREATE 7 1 POP3 server user name mail id OK WIPREADY 7 1 WM_DEV_OAT_UGD_076 Rev 009 Examples of Application unsolicited FTP session is closed successtully create POP3 session using default port 110 Jall parameters and IP stack behaviors are OK unsolicited the POP3 session is created successtully February 18 2011 118 WIPsoft 5 41 Examples of Application 9 16 Subscribe Unsubscribe WIPsoft AT commands using WIPsoft Library API include adl_global h Global includes include wip _atcmd h WIP AT command services if _ OAT API VERSION gt 400 const ul6 wm_apmCustomStackSize 4096 else u32 wm_apmCustomStack 1024 const ul6 wm_apmCustomStackSize sizeof wm_apmCustomStack endif void adl ma
93. onnection is UDP 1 8 UDP sockets have been created and hence VF attempt fails create one server on port 80 idx 1 One TCP client socket is reserved on index 1 create one server on port 81 idx 2 One TCP client socket is reserved on index 2 create one server on port 82 idx 3 One TCP client socket is reserved on index 3 create one server on port 83 idx 4 One TCP client socket is reserved on index 4 4 TCP servers have been created and hence creation of 5 TCP server socket fails February 18 2011 111 WIPsoft 5 41 AT WIPCREATE 2 1 192 168 0 1 80 CME ERROR 845 tWIPACCEPT tWIPACCEPT tWIPACCEPT tWIPACCEPT AT WIPCREATE 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 AT WIPCREATE 2 9 192 168 0 1 80 CME ERROR 830 WM_DEV_OAT_UGD_076 Rev 009 Examples of Application 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 accepte
94. or 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 2 8 20 Note Get TTL for TCP client OK AT WIPOPT 3 1 2 9 10 OK Note Set TOS for TCP server AT WIPOPT 3 1 1 9 WIPOPT 3 9 10 Note Get TOS for TCP server OK AT WIPOPT 1 1 1 1 WIPOPT 1 1 80 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 4 1 1 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 WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 49 WIPsoft 5 41 IP Protocol Services Command Responses WIPOPT 5 52 0 AT WIPOPT 5 1 1 52 OK Note Get HTTP version AT WIPOPT 6 1 2 61 senderaddres OK s mail com Note Set the sender address AT WIPOPT 6 1 2 67 0 OK Note The application will format the mail header and send it during the data sending phase WIPOPT AT WIPOPT 6 1 1 61 6 61 senderadress mail com OK Note Get the sender address WIPOPT 6 60 220 220 innosoft com SMTP service AT WIPOPT 6 1 1 60 ready OK Note Get last protocol error status WIPOPT 6 66 My mail AT WIPOPT 6 1 1 66 subject OK Note Get the set mail subject WIPOPT 7 72 243000 OK AT WIPOPT 7 1 1 72 Note Get total mail size WIPOPT 7 73 1 1024 WIPOPT 7 73 2 5237 WIPOPT 7 73 7 3 1
95. or writing configuration in FLASH memory 821 error freeing configuration in FLASH memory 844 stack already started 850 initialization failed 852 IP stack not initialized WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 21 General Configuration WIPsoft 5 41 Examples 4 1 6 O O sw sw WO oO OTN O a OTN lt T ie py N TF HOON ie cr N TFT HOON O ODM GOL O0 m ODO no N ww wy we NK HoOoOWMvonomen oo S S NNR ws we we we we we Re ROO TNO THO OO LP Ss ew we we wm wm we we ROO TN OT WD OO LP COT NM THM Ol CO OO i doe CO ANM TY Of CO OO i doo g o wW O DO O w O wn O 8 OOO w o O W 0O D O w O a w T oO ky E G By Bb amp e amp amp amp amp wy wy e amp o wy B ky GG G GB we Bf B amp amp amp amp wy amp HY amp wy wy y S OUOOUDDOD DODO DODD UVUDOUDD OVUVUVDOVVUOVUOVUOVOVUVUVUDOVUDOOUO DU pee GoawaaaaaAaA AAA A A A AY AY GUOMHamaiadtmdAamaaAaAaAaAA A AA AY HOW OW OW OWA OWA OWA Was WA OW WA OW Was Was aOR as A HH HH WH t HH HH it H H H HOH e AH H o NS SSS S88 SEB S8B S82 E252 52 8282 SGESESSEN SM SSS SSB E2 82 582352 SSSSSSSSEBNM as O H rP r E tot 4 4 gt 4 444 440 O Pe H e e E e E o 4 444 0 x Q S WY O Q H os T H 8 N A Io o ig o D g 0 oO S F 3 T 3 XxX fla s Ay ay SIH amp H H H EJZ elt oO JH Oo BH H o 5 O fd lt cH gq Z oH 22 February 18 2011 Rev 009 WM_DEV_OAT_UGD_076 WIPsoft 5 41 General
96. pt num 94 95 96 Value format string u32 Value type ascii u32 Option type WIP_MMS_ADD_FILE_ANY WIP_MMS_HTTP_DATA_ENCOD WIP_MMS_DONE Description About to attach a file of type specified in lt optval gt as a string using the format of mime type Example image xyz The size in Bytes is sent in lt optval2 gt The file name is sent as a string in lt optval3 gt Content id is sent in lt optval4 gt At least one of either file name or content id must be set Set the HTTP data transfer encoding no encoding 0 chunked data transfer encoding 1 default Sent as the last command to signal that the MMS sending is considered done This is to catch deadlocks when for instance a user misses to send a last file NOTE Once the MMS is sent the W PPEERCLOSE 8 is received to indicate that MMS session is closed Therefore there is no need to issue the AT WIPCLOSE command to close it Type See the Phone Mail Option Notes subsections for additional information about this option type 5 3 7 6 1 Values of lt optval gt WIP_MMS_CLASS These are the different types of message class optval Option Type 0 PERSONAL default 1 INFORMATIONAL 2 ADVERTISEMENT 3 AUTO 5 3 7 6 2 Values of lt optval gt WIP_MMS_PRIORITY These are the different types of priority OO OW WM_DEV_OAT_UGD_076 Rev 009 February 18 2011
97. qual to at least TCP_MIN_MSS Default value 536 bytes range 0 100 default value 0 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 0 which means that the sequence is sent to the peer as data If set to 1 sequence is not sent as data to the peer range 0 1 default value 0 WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 WIPsoft 5 41 General Configuration 14 AT_WIP_NET_OPT_AUTO_ SWITCH Used for TCP socket to switch back automatically to AT command mode when the TCP connection is closed by peer entity 0 Does not switch automatically to AT mode 1 Switches automatically to AT mode range 0 1 default value 0 15 Set DATA offline WIPDATARW RX and TX buffer size in bytes range 1 32000 default value 2048 16 WIP_NET_OPT_TCP_REXMT_MAX Maximum timeout of TCP packets the maximum time between TCP retransmissions range 1 64 default value 64 seconds 17 WIP_NET_OPT_TCP_REXMT_MAXCNT Max number of TCP packet retransmissions range 1 12 default value 12 lt action gt requested operation on TCP IP stack parameter management 0 configuration storage when existing is freed 1 stores the configuration parameters lt value gt value range for different configuration options lt XX YY ZZ gt WIPsoft release version
98. r 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 Note When using the UDP protocol consider that you cannot send more than the WIP_COPT_RCV_BUFSIZE data receiving buffer size Based on this be sure that no data will be lost as it depends on the bearer speed 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 LF JSHUTDOWN 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 character To close sockets switch the UART to AT command mode and use WIPCLOSE command 6 2 2 2 UDP Sockets in Continuous mode UDP is aconnectionless 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 da
99. rder of the files specified using WIPOPT lt dle_mode gt Mode to configure continuous continuous transparent mode This option specifies whether the file should be uploaded downloaded using continuous or continuous transparent mode using FTP protocol By default the mode will be set to 0 i e continuous mode If this value is set to 1 data will be transferred using continuous transparent mode Range 0 1 default value 0 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 lt content id gt MMS Content id header WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 64 WIPsoft 5 41 Data Exchange for Protocol Services lt lastindicator gt Indicates that the file is the last of the files to send 1 See the DATA Offline session WIPDATARW section for more information 6 1 6 Parameter Storage None 6 1 7 Possible Errors WM_DEV_OAT_UGD_076 CMEE AT error code De
100. rototype s32 wip_ATCmdUnsubscribe void 8 3 2 Parameters None 8 3 3 Returned Values The function returns e 0on success e negative error code on failure as described below WIP AT commands already unsubscribed un subscription for WIP AT commands fails WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 88 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 is listening for connection request on port 1 80 Spawned sockets will be given the index 5 1 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 mode WM_DEV_OAT_UGD_076 AT WIPCLOSE 2 5 OK Rev 009 close the TCP client socket index 5 February 18 2011 89 WIPsoft 5 41 9 1 1 2 Using GSM bearer AT WIPCFG 1 OK AT WIPBR 1 5 OK AT WIPBR
101. rt USB UART 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 Hone datagram is ready to be read it was sent from 192 168 0 4 on port 58 and is composed of 50 bytes Where 25 bytes the ETX character marking the bound of the datagram have been read February 18 2011 94 WIPsoft 5 41 Examples of Application 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 WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 95 WIPsoft 5 41 Examples of Application 9 4 FIP 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 P 1 j 1 7 i filename txt
102. s eecceeeeeeeteeeneeeeeeeeeneeeeeeeeeneeeeeneesaees 55 6 DATA EXCHANGE FOR PROTOCOL SERVICEG seseeeeeeeeeeeeeees 58 6 1 ile Exchange W IPRILE cninionnaninnae E E ie phage cause neaeieus 58 6 1 1 DOSCIIDUOM aeie thee tia ie Ne ee Gee ee 58 Ota ETX Escaping Mechanism aerpeessneetevverenabesecera pean 58 6 11 2 DLE Escaping Mechan SMi cc sccseccesdecasccececegs sacnedsccts deep iusesedeecheceetcenntedeecdeceesecesecteecdie 59 6 1 2 FTP HTTP SMTP Session in Continuous Mode cccccecseeeeeeeeteeeeesneeeeeeseeeeseaaes 60 6 1 3 FTP Session in Continuous Transparent Mode ccccceceeeeeeeeeceeeeeeeeeeseaeeeeeeeees 61 6 1 4 OV IMLAK a ates cance eas Seaisniealg ese veh E cas E E nade E 61 6 1 5 Parameters and Defined Values ccccceceseeenceceeeeeteeeenaeeeeeeeeeseeanaeeeeeeeeeeeenanaeees 63 6 1 6 Parameter Storage eeseseseseseesseessesssrsrsrssersssnsssnnstnnotanotunsnnosunennoounsonnsonnsennsenneens 65 6 1 7 Possible Errors ecidae dena aeaienss ands aaaea aie daa a aa aaa aia E aaae E dapancataaecones td 65 6 1 8 eE e A EE E E E E E E E E T 66 6 1 9 NOIE Sireec adan EE E AE EEEE A T 67 6 2 Socket Data exchange WIPDATAS sic cec cccssccsettecosece ceeedeneancesccdeceetendendeaseacecetansendeesanevens 68 6 2 1 DGESCIIDUON aidara aara aenten ities beinite sniends anne diene a Weel ieee ees 68 6 2 2 Continuous MOE siiiceescccssececidsreabecsuess deavatsscdvues
103. s 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 embedded module and the external device Hence if the WIPsoft library is subscribed from the application same FCM flow should not be subscribed from the same application 8 1 Required Header File The header file for the WIP AT command interface is wip_atcmd h 8 2 The wip ATCmdSubscribe Function The wip_ATCmdSubscribe function subscribes 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 0 on success e negative error code on failure as described below subscription for WIP AT commands fails WIP AT commands already subscribed WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 87 WIPsoft 5 41 WIPsoft Library API 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 P
104. s set to 0 The TOS field can have the following values 1000 minimize delay 0100 maximize throughput WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 18 WIPsoft 5 41 General Configuration 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 0 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 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 0 65535 default value 0 WIP_NET_OPT_TCP_MIN_MSS Default MSS of off link connections This option is used by the WIPlib Plug In internally This parameter specifies the maximum size of TCP segment which would be sent By default the value of
105. s 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 WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 46 WIPsoft 5 41 IP Protocol Services 5 3 Service Option Handling WIPOPT E a ao EE 5 3 1 Description The WIPOPT command is used to read and or to configure different parameters on sockets and FTP HTTP SMTP POP3 MMS 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 and lt protocol gt does not equal 8 Action Command AT WIPOPT lt protocol gt lt idx gt lt action gt lt optnum gt lt optval gt OK e if lt action gt 2 and lt protocol gt 8 Action Command AT WIPOPT lt protocol gt lt idx gt lt action gt lt optnum gt lt optval gt lt optval2 gt lt optval3 gt lt optval4 gt OK Read Command AT WIPOPT NONE Test Command AT WIPOPT OK WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 47 WIPsoft 5 41 e if lt action gt 1 IP Protocol Services Unsolicited response WIPOPT lt protocol gt l
106. scription 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 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 890 Service denied 891 Message format corrupt 892 Address unresolved 893 Message not found 894 Network problem 895 Content not accepted 896 Unsupported message 897 Unspecified error Rev 009 February 18 2011 WM_DEV_OAT_UGD_076 WIPsoft 5 41 Data Exchange for Protocol Services 6 1 8 Examples Command Responses CONNECT AT WIPFILE 4 1 1 data bin lt data received terminated by ETX character gt Note Download file in continuous mode OK CONNECT AT WIPFILE 4 1 2 report log lt data terminated by ETX character gt Note Upload file in continuous mode OK CONNECT AT WIPFILE 4 1 5 report log lt data terminated by ETX character gt Note Upload file in continuous mode data will be OK added at the end of file CONNECT AT WIPFILE 4 1 1 data bin 1 lt data gt O
107. sedcaventeddadecsediadecasveatessncady ents cdaenseteae 68 6 2 2 1 TCP Sockets in Continuous mode cccceeeceeeeseeeeeeeeaeeeecseeeeseeaueeeeecaeeeseneeeesenseetens 68 6 2 2 2 UDP Sockets in COntinuOUs MOE serrr aea en coins a n oa E EiS 68 6 2 2 3 ETX Escaping MechaniS Mis issiiciisi oriniai ireren aana aaa aaa E aa aay 69 6 2 2 4 DLE Escaping Mechan SMi ecseisii iieiea enia ao o osaa eias 71 6 2 3 Continuous Transparent Mode c ccceecceeceeeeeseeceeeeeseeeeeceaeeeeaeeseeeeeseaeeeenaeeeeeeeeees 72 6 2 3 1 TCP Sockets in Continuous Transparent Mode c cccccceeeceeeeeeeeeeeeeeeeeeeeeeeneeeeeeeeenees 72 6 2 3 2 UDP Sockets in Continuous Transparent MOde cccceeceeeneeeeeeeseneeeeeeeseneeeeeeeteneeeaaes 72 6 2 4 Leaving Continuous Continuous Transparent Mode cccceeeceeeeeeeeteeeeneeeeeeees 72 6 2 5 Resetting IGP Soket riian anin iaido siia o ana iaaiiai 73 6 2 6 e A AE E E AE A A E ET 73 6 2 7 Parameters and Defined Values ccccceeceececceeceeeeeeeeeeaeeeeeeeeesecneaeeeeeeeeeseesnnaees 74 6 2 8 Parameter Storage cccccesesceceeeeeceeeeesaeceeeeeceaeeeeaaeseeaeeccaeeeseaesgeaaeseaeeescaeeeeaeseeneeee 74 WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 7 WIPsoft 5 41 Introduction 6 2 9 POSSIDIE ELrOrSii2sconccectdives issu ceiad anartan aii aaan ai aa ia aaa DaT Aaaa TAT aaia ATANAN EEN 74 62 10 IEXAMpPIOS iaa aAA tate nee Gaede ge endian ed cea 75 Gl
108. soft 5 41 IP Protocol Services 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 lt mode gt 6 or 7 Action Command AT WIPCREATE lt mode gt lt index gt lt server gt lt peer port gt lt username gt lt password gt OK e if lt mode gt 8 Action Command AT WIPCREATE lt mode gt lt index gt lt server gt lt peer port gt lt url gt OK Read Command AT WIPCREATE NONE WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 37 WIPsoft 5 41 IP Protocol Services 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 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
109. t instead of WIPsoft generic error range 0 1 default 0 for WIPsoft generic error lt mac IP gt MAC address of Ethernet driver lt getway IP gt default gateway address lt netmask IP gt network mask address lt value gt range of value for different bearer options lt mode gt mode of operation client 0 server 1 lt state gt current state of the bearer stopped 0 pp i started WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 28 WIPsoft 5 41 General Configuration lt status gt result of the connection process successful 0 any other to be matched to error code value e g 814 means PPP authentication failure value 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 Caution The options WIP_BOPT_IP_ADDR WIP_BOPT_IP_DST_ADDR WIP_BOPT_IP_DNS1 a
110. t 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 index 1 embedded module acts as a TCP server it will from now on spawn TCP client socket from communication index 5 to 8 AT WIPCREATE 2 1 IP ADDR 80 Note Create the TCP client on port 80 with index 1 embedded module 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 AT WIPCREATE 5 1 proxyaddress user name password User Agent WIP HTTP Client 1 0 Accept Encoding gzip Accept Language en US Rev 009 IP Protocol Services Responses Note An unsolicited event WIPREADY 1 1 will be received once the UDP socket is ready for usage OK 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 OK Note An unsolicited event WIPREADY 2 1 will be
111. t from the embedded module to Desktop PC1 will contain an escaped DLE preceding the DLE character Desktop PC1 receives DLE DLE character from embedded module The scenario is same for both TCP and UDP sockets Mapped UART IP Network active socket Data containing DLE DLE sequence Data containing DLE WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 71 WIPsoft 5 41 Data Exchange for Protocol Services Protocol Mapped UART IP Network active socket UDP DLE alone A single DLE is ignored TCP Data containing DLE DLE sequence Data containing DLE 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
112. t 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 5 2 4 Parameter Storage None 5 2 5 Possible Errors CMEE AT error code Description 802 not enough memory 803 operation not allowed in the current WIP stack state 830 bad index 831 bad state 834 not implemented 837 bad protocol 5 2 6 Examples Command Responses AT WIPCLOSE 1 1 OK Note Close UDP socket with communication index 7 AT WIPCLOSE 2 1 OK Note Close TCP client with communication index 7 AT WIPCLOSE 3 1 OK Note Close TCP server with communication index 7 AT WIPCLOSE 4 1 OK Note Close FTP session with index 1 received once the FTP session is closed AT WIPCLOSE 5 1 OK Note Close HTTP session with index 1 WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 Note An unsolicited event WIPPEERCLOSE 4 7 is WIPsoft 5 41 IP Protocol Services Command Responses AT WIPCLOSE 6 1 OK Note Close SMTP session with index 7 AT WIPCLOSE 7 1 OK Note Close POP3 session with index 1 AT WIPCLOSE 8 1 OK Note Close MMS session with index 1 5 2 7 Notes After issuing WIPCLOSE command no more data can be sent and received over the socket session In case of FTP protocol the closure of FTP session is indicated by WIPEERCLOSE unsolicited response when WIPCLOSE command i
113. t optnum gt lt optval gt if lt action gt 1 and lt protocol gt 5 and lt optnum gt 54 Unsolicited response value gt WIPOPT 5 54 lt message header field name gt lt message header field 5 3 3 Parameters and Defined Values lt protocol gt protocol type 1 UDP TCP client TCP server FTP HTTP SMTP POP3 CO N off A j N MMS lt idx gt socket or FTP HTTP SMTP POP3 MMS 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 lt optval2 gt value of an extra option optional lt optval3 gt value of an extra option optional lt optval4 gt value of an extra option optional 5 3 4 Parameter Storage None WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 48 WIPsoft 5 41 IP Protocol Services 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 invalid channel option or parameter value for example HTTP user name too long 860 protocol undefined or internal error 863 protocol delete error 864 protocol list err
114. tagram Similarly when reading data 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 WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 68 WIPsoft 5 41 Data Exchange for Protocol Services 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 When the UART leaves DATA mode either because of escape sequence or because of an AT WIPDATA 1 index 0 on another UART the currently unsent data are sent as a single datagram 6 2 2 3 ETX Escaping Mechanism Desktop GPRS Pad Data received from PC1 abc ETX efgh Data sent from PC2 abc ETX efgh MAPPED ART Desktop PCl Data sent to PC2 abc DLE ETX efgh Data received from PC2 abc DLE ETX efgh The above schematic explains how ETX characters which have a special meaning in WIPsoft are handled on Sierra Wireless embedded module On transmitting side when ETX are not escaped use case Desktop PC1 sends data towards embedded module Data contain a non escaped ETX lt no DL
115. ted 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 irrespective of size of the data packet This parameter is supported only for UDP continuous transparent mode range 1 100 default value 2 1 See the DATA Offline session WIPDATARW section for more information 6 2 8 Parameter Storage None 6 2 9 Possible Errors CMEE AT error code Description 831 bad state 836 memory allocation error 837 bad protocol 843 connection reset by peer WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 74 WIPsoft 5 41 6 2 10 Examples Data Exchange for Protocol Services Note TCP Client with index 5 can send read data in continuous mode AT WIPDATA 2 5 1 10 5 Note TCP Client with index 5 can send read data in continuous mode AT WIPDATA 1 5 1 Note UDP with index 5 can send read data in continuous mode AT WIPDATA 1 5 1 Note UDP with index 5 can send read data in continuous mode AT WIPDATA 1 5 2 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 AT WIPDATA 1 5 2 20 2 Note UDP with index 5 can send read data in continuous transparent mode with lt send size gt set to 20 and
116. tes in TX Buffer and send buffer Note 402 data bytes have been sent AT WIPDATARW 0 1 WIPDATARW 0 1 OK WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 WM_DEV_OAT_UGD_076 WIPsoft 5 41 Data Exchange for Protocol Services Note Close WIPDATARW session on channel idx 1 AT WIPDATARW 1 1 30313233343 536373839 CME ERROR 831 Note try to send 10 bytes on channel index 1 Note WIPDATARW session is not open in channel idx 7 AT WIPFILE 4 2 6 filename txt WIPDATARW 1 2 OK Note Start data offline session for uploading file filename txt AT WIPDATARW 1 2 30313233343 536373839 WIPDATARW 4 2 10 WIPDATARW 0 2 OK Note Upload data Note 10 bytes uploaded WIPDATARW session closed on channel idx 2 AT WIPFILE 4 2 7 filename txt WIPDATARW 3 2 2 1 31 WIPDATARW 3 2 2 2 31 WIPDATARW 0 2 OK Note file Download and display filename txt Note More than 200 data downloaded WIPDATARW session closed on channel idx 2 Rev 009 February 18 2011 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
117. the peer no real connection is UDP create a UDP client towards peer IP device 1192 168 0 1 port 78 maximum 3 sockets can be created as the ZMAX SOCK NUM value has been changed to 173 Hence an attempt to create a fourth socket returns error February 18 2011 114 WIPsoft 5 41 Examples of Application 9 15 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 3 AT WIPCREATE 1 4 58 192 168 0 1 78 WM_DEV_OAT_UGD_076 Rev 009 start IP stack open GPRS bearer set APN name of GPRS bearer set user name set password start GPRS bearer create a UDP client towards peer IP device 1 192 168 0 1 port 75 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 1 192 168 0 1 port 76 all parameters and IP stack behavior are OK unsolicited the UDP client socket is pseudo connected to the peer no real connection is
118. this parameter is set to 536 Hence WIPlib Plug In would not send any TCP segment having a length greater than 536 bytes without header range 536 1460 default value 536 WIP_NET_OPT_DEBUG_PORT This option is used to specify the port on which the debug traces are to be sent range 0 3 default value 0 12 AT_WIP_NET_OPT_PREF_TIMEOUT_VALUE Used for TCP sockets to configure the packet segmentation on IP network side This option is used to specify the maximum time to wait between two successive data chunks received from the mapped UART serial port please see WIPDATA AT command It allows the application to buffer a certain amount of data before writing on IP network side Each unit in the range represents 100 msec For example value 10 for this option will give a wait time of 1sec 10 100msec Default value for AT_WIP_NET_OPT_PREF_TIMEOUT_VALUE option is 0 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 e
119. through lt netmask IP gt Caution regarding WIP_BOPT IP NETMASK and WIP BOPT IP GW added Example updated starting at AT WIPBR 1 4 through the end of the table Note that The Ethernet bearer can be started only in client mode added Definition updated and note added to discuss that data can be transferred using two modes Mode 5 added and AT WIPFILE 4 1 5 report log example enhanced to reflect new mode New WIPDATA error added Added opt num parameters WIP_BOPT DEBUG PKT and WIP BOPT RESTART to the WIPBR command Updated version number Clarified the definition of the WIP_BOPT PPP CHAP option for the WIPBR command Rev 009 February 18 2011 4 WIPsoft 5 41 Introduction 009 February 18 2011 WM_DEV_OAT_UGD_076 Corrected erroneous syntax for mode 1 in the Service Creation WIPCREATE section Added a new lt opt num gt 28 and its corresponding GPRS CME Errors to the Bearers Handling WIPBR section Added new DATA Offline function including e New DATA Offline session WIPDATARW section e New lt opt num gt 15 in the IP Stack Handling WIPCFG section e New lt mode gt 6 7 8 and 9 in the File Exchange WIPFILE section e New lt mode gt 3 and lt error gt 836 in the Socket Data exchange WIPDATA section e New lt error gt 853 e New FTP DATA Offline example Added new MMS function including e Added new MMS lt mode gt 8 and details to the subsections o
120. whether the aircraft is on the ground or in flight In aircraft the Sierra Wireless modem MUST BE POWERED OFF When operating the Sierra Wireless modem can transmit signals that could interfere with various onboard systems Note Some airlines may permit the use of cellular phones while the aircraft is on the ground and the door is open Sierra Wireless modems may be used at this time The driver or operator of any vehicle should not operate the Sierra Wireless modem while in control of a vehicle Doing so will detract from the driver or operator s control and operation of that vehicle In some states and provinces operating such communications devices while in control of a vehicle is an offence Limitations of Liability This manual is provided as is Sierra Wireless 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 manual shall endorse all risks arising from its use The information in this manual is subject to change without notice and does not represent a commitment on the part of Sierra Wireless SIERRA WIRELESS AND ITS AFFILIATES SPECIFICALLY DISCLAIM LIABILITY FOR ANY AND ALL DIRECT INDIRECT SPECIAL GENERAL INCIDENTAL CONSEQUENTIAL PUNITIVE OR EXEMPLARY DAMAGES INCLUDING BUT NOT LIMITED TO LOSS OF PROFITS OR REVENUE OR ANTICIPATED PROFITS OR REVENUE ARISING OUT OF THE USE OR INABILI
121. witched back to AT mode either by 1 sending ETX character 2 sending sequence with 1 second guard time before and after the sequence 3 controlling the DTR signal using AT amp D command When the UART leaves data mode the currently unsent data are transferred WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 60 WIPsoft 5 41 Data Exchange for Protocol Services 6 1 3 FTP Session in Continuous Transparent Mode In this mode DLE ETX characters are considered as normal data and not as special characters In case ETX DLE character is received it will not be preceded by a DLE character before sending it to the mapped UART The mapped UART can be switched back to AT mode either by 1 sending sequence with 1 second guard time before and after the sequence 2 controlling the DTR signal using AT amp D command When the UART leaves data mode the currently unsent data are transferred 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 lt dle_mode gt CONNECT OK 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 e if lt protocol gt 6 Action Command AT WIPFILE lt protocol gt lt index gt lt mode gt CONNECT OK WM_DEV_OAT_UGD_076 Rev 009 Februar
122. y 18 2011 61 WIPsoft 5 41 Data Exchange for Protocol Services 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 8 Action Command AT WIPFILE lt protocol gt lt index gt lt mode gt lt filename gt lt content id gt lt lastindicator 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 WM_DEV_OAT_UGD_076 Rev 009 February 18 2011 62 WIPsoft 5 41 Data Exchange for Protocol Services 6 1 5 Parameters and Defined Values lt protocol gt protocol type 4 FTP 5 HTTP 6 SMTP 7 POP3 8 MMS 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 from the FTP server if lt protocol gt 4 This mode is used for downloading data of the specified URL using HTTP GET method if lt protocol gt 5 This mode is used for retrieving mail without deleting it from the POPS server if lt protocol gt 7 This mode is not supported by SMTP protocol

WIPsoft AT Commands User Guide 5.41

Contents

Download Pdf Manuals

Related Search

Related Contents