Telit WL865E4-P Reference Guide

WL865E4-P AT Command
Reference Guide
80613ST10987A Rev. 1.4.27 – 2021-01-17
WL865E4-P AT Command Reference Guide
80613ST10987A Rev. 1.4.27 Page 2 of 299 2021-01-17
NOTICES LIST
While reasonable efforts have been made to assure the accuracy of this document, Telit assumes no liability resulting from any inaccuracies or omissions in this document, or from use of the information obtained herein. The information in this document has been carefully checked and is believed to be reliable. However, no responsibility is assumed for inaccuracies or omissions. Telit reserves the right to make changes to any products described herein and reserves the right to revise this document and to make changes from time to time in content hereof with no obligation to notify any person of revisions or changes. Telit does not assume any liability arising out of the application or use of any product, software, or circuit described herein; neither does it convey license under its patent rights or the rights of others.
It is possible that this publication may contain references to, or information about Telit products (machines and programs), programming, or services that are not announced in your country. Such references or information must not be construed to mean that Telit intends to announce such Telit products, programming, or services in your country.
COPYRIGHTS
This instruction manual and the Telit products described in this instruction manual may be, include or describe copyrighted Telit material, such as computer programs stored in semiconductor memories or other media. Laws in the Italy and other countries preserve for Telit and its licensors certain exclusive rights for copyrighted material, including the exclusive right to copy, reproduce in any form, distribute and make derivative works of the copyrighted material. Accordingly, any copyrighted material of Telit and its licensors contained herein or in the Telit products described in this instruction manual may not be copied, reproduced, distributed, merged or modified in any manner without the express written permission of Telit. Furthermore, the purchase of Telit products shall not be deemed to grant either directly or by implication, estoppel, or otherwise, any license under the copyrights, patents or patent applications of Telit, as arises by operation of law in the sale of a product.
COMPUTER SOFTWARE COPYRIGHTS
The Telit and 3rd Party supplied Software (SW) products described in this instruction manual may include copyrighted Telit and other 3rd Party supplied computer programs stored in semiconductor memories or other media. Laws in the Italy and other countries preserve for Telit and other 3rd Party supplied SW certain exclusive rights for copyrighted computer programs, including the exclusive right to copy or reproduce in any form the copyrighted computer program. Accordingly, any copyrighted Telit or other 3rd Party supplied SW computer programs contained in the Telit products described in this instruction manual may not be copied (reverse engineered) or reproduced in any manner without the express written permission of Telit or the 3rd Party SW supplier. Furthermore, the purchase of Telit products shall not be deemed to grant either directly or by implication, estoppel, or otherwise, any license under the copyrights, patents or patent applications of Telit or other 3rd Party supplied SW, except for the normal non-exclusive, royalty free license to use that arises by operation of law in the sale of a product.
WL865E4-P AT Command Reference Guide
80613ST10987A Rev. 1.4.27 Page 3 of 299 2021-01-17
USAGE AND DISCLOSURE RESTRICTIONS
I. License Agreements
The software described in this document is the property of Telit and its licensors. It is furnished by express license agreement only and may be used only in accordance with the terms of such an agreement.
II. Copyrighted Materials
Software and documentation are copyrighted materials. Making unauthorized copies is prohibited by law. No part of the software or documentation may be reproduced, transmitted, transcribed, stored in a retrieval system, or translated into any language or computer language, in any form or by any means, without prior written permission of Telit
III. High Risk Materials
Components, units, or third-party products used in the product described herein are NOT fault-tolerant and are NOT designed, manufactured, or intended for use as on-line control equipment in the following hazardous environments requiring fail-safe controls: the operation of Nuclear Facilities, Aircraft Navigation or Aircraft Communication Systems, Air Traffic Control, Life Support, or Weapons Systems (High Risk Activities"). Telit and its supplier(s) specifically disclaim any expressed or implied warranty of fitness for such High Risk Activities.
IV. Trademarks
TELIT and the Stylized T Logo are registered in Trademark Office. All other product or service names are the property of their respective owners.
V. Third Party Rights
The software may include Third Party Right software. In this case you agree to comply with all terms and conditions imposed on you in respect of such separate software. In addition to Third Party Terms, the disclaimer of warranty and limitation of liability provisions in this License shall apply to the Third Party Right software.
TELIT HEREBY DISCLAIMS ANY AND ALL WARRANTIES EXPRESS OR IMPLIED FROM ANY THIRD PARTIES REGARDING ANY SEPARATE FILES, ANY THIRD PARTY MATERIALS INCLUDED IN THE SOFTWARE, ANY THIRD PARTY MATERIALS FROM WHICH THE SOFTWARE IS DERIVED
(COLLECTIVELY “OTHER CODE”), AND THE USE OF ANY OR ALL THE OTHER CODE IN
CONNECTION WITH THE SOFTWARE, INCLUDING (WITHOUT LIMITATION) ANY WARRANTIES OF SATISFACTORY QUALITY OR FITNESS FOR A PARTICULAR PURPOSE.
NO THIRD PARTY LICENSORS OF OTHER CODE SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND WHETHER MADE UNDER CONTRACT, TORT OR OTHER LEGAL THEORY, ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE OTHER CODE OR THE EXERCISE OF ANY RIGHTS GRANTED UNDER EITHER OR BOTH THIS LICENSE AND THE LEGAL TERMS APPLICABLE TO ANY SEPARATE FILES, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
WL865E4-P AT Command Reference Guide
80613ST10987A Rev. 1.4.27 Page 4 of 299 2021-01-17
WL865E4-P AT Command Reference Guide
80613ST10987A Rev. 1.4.27 Page 5 of 299 2021-01-17
APPLICABILITY TABLE
PRODUCTS
SW Versions
WL865E4-P
36.07.000
WL865E4-P
36.07.001
WL865E4-P AT Command Reference Guide
80613ST10987A Rev. 1.4.27 Page 6 of 299 2021-01-17
WL865E4-P AT Command Reference Guide
80613ST10987A Rev. 1.4.27 Page 7 of 299 2021-01-17
CONTENTS
NOTICES LIST ............................................................................................................... 2
COPYRIGHTS ................................................................................................................ 2
COMPUTER SOFTWARE COPYRIGHTS ..................................................................... 2
USAGE AND DISCLOSURE RESTRICTIONS.............................................................. 3
APPLICABILITY TABLE................................................................................................ 5
CONTENTS 7
FIGURES LIST ............................................................................................................. 15
TABLES LIST ............................................................................................................... 16
1. INTRODUCTION ...................................................................................... 19
1.1. Scope ....................................................................................................... 19
1.2. Audience .................................................................................................. 19
1.3. Contact Information, Support ................................................................... 19
1.4. Text Conventions ..................................................................................... 20
1.5. Related Documents .................................................................................. 20
2. OVERVIEW .............................................................................................. 23
2.1. AT Commands ......................................................................................... 23
2.2. Command Definition ................................................................................. 23
2.3. AT Command Syntax ............................................................................... 24
2.4. Command Lines ....................................................................................... 24
2.5. Information Response and Result Codes ................................................ 26
2.6. Parameter Types ...................................................................................... 27
3. ARCHITECTURE ..................................................................................... 30
3.1. System Overview ..................................................................................... 30
3.2. Working Principle ..................................................................................... 30
3.3. System Initialization ................................................................................. 31
4. HOST INTERACTION .............................................................................. 33
4.1. Interface ................................................................................................... 33
4.1.1. UART ........................................................................................................ 33
4.1.1.1. Baud Rate - B ........................................................................................... 33
4.1.1.2. Hardware Flow Control - &Kn .................................................................. 35
4.1.2. SPI/SDIO .................................................................................................. 36
4.1.2.1. SPI/SDIO Interface - +YSIF ..................................................................... 38
4.1.2.2. SPI/SDIO Interface Demonstration - +YIDEMO ...................................... 39
5. GENERAL OPERATIONS ....................................................................... 43
WL865E4-P AT Command Reference Guide
80613ST10987A Rev. 1.4.27 Page 8 of 299 2021-01-17
5.1. System Settings ....................................................................................... 43
5.1.1. Switch Between Legacy and AT Command - +YLC ................................ 43
5.1.2. Echo Mode - En ....................................................................................... 44
5.1.3. Backspace Handling - BKPn .................................................................... 44
5.1.4. Verbose Mode - Vn .................................................................................. 45
5.1.5. Boot Reason - +YBR ................................................................................ 45
5.1.6. Exception Boot Reason - +YBER ............................................................ 46
5.1.7. Auto Mode - Cn ........................................................................................ 48
5.1.8. Data Mode - An ........................................................................................ 49
5.1.9. Debug Log Level - +YLOGSL .................................................................. 49
5.1.10. File System ............................................................................................... 50
5.1.10.1. File Open - +YFOP ................................................................................... 50
5.1.10.2. File Close - +YFCL ................................................................................... 51
5.1.10.3. File Read - +YFRD ................................................................................... 51
5.1.10.4. File Write - +YFWR .................................................................................. 53
5.1.10.5. File Length - +YFLN ................................................................................. 54
5.1.10.6. File List - +YFLS ....................................................................................... 54
5.1.10.7. File Delete - +YFRM ................................................................................. 55
5.1.11. Flash Read - +YFR .................................................................................. 56
5.2. Profile Settings ......................................................................................... 57
5.2.1. Profile Read - Zn ...................................................................................... 57
5.2.2. Profile Set - &Yn ....................................................................................... 58
5.2.3. Profile Save - &Wn ................................................................................... 59
5.2.4. Save TCP Profile - +YPTCP .................................................................... 59
5.2.5. Save UDP Profile - +YPUDP ................................................................... 60
5.2.6. Profile Clear/Factory Reset - &F .............................................................. 61
5.3. Default Profile ........................................................................................... 62
5.3.1. AP DHCP server configuration - +DPNADSC.......................................... 62
5.3.2. AP Static IP configuration - +DPNAIPC ................................................... 64
5.3.3. AP WLAN configuration - +DPNAWC ...................................................... 66
5.3.4. Station Static IP configuration - +DPNSIPC ............................................ 69
5.3.5. Station Retry configuration - +DPSRC ..................................................... 71
5.3.6. Station WLAN configuration - +DPNSWC ................................................ 73
5.3.7. Update TCP Profile - +DPTC ................................................................... 75
5.3.8. Update UDP Profile - +DPUC .................................................................. 78
5.4. Real Time Clock (RTC) Settings .............................................................. 81
5.4.1. Time Settings - +YTIME ........................................................................... 81
5.5. Power Save .............................................................................................. 82
5.5.1. Standby - +YPS ........................................................................................ 82
5.6. Heap Information - +YHD ......................................................................... 83
WL865E4-P AT Command Reference Guide
80613ST10987A Rev. 1.4.27 Page 9 of 299 2021-01-17
5.7. Heap Information List - +YHLD ................................................................ 83
5.8. Reset - +YSR ........................................................................................... 84
5.9. Manufacturer's Name - +CGMI ................................................................ 84
5.10. Module Name - +CGMM .......................................................................... 85
5.11. Modem Version - +CGMR ........................................................................ 85
5.12. Package Version - #SWPKGV ................................................................. 86
5.13. Version - +YVER ...................................................................................... 87
5.14. Shut Down - +NSHUTDOWN .................................................................. 88
6. NETWORK CONNECTION MANAGER .................................................. 89
6.1. Wireless Network Connection Manager (WNCM) .................................... 89
6.1.1. NCM Initialize - +WNI ............................................................................... 89
6.1.2. NCM De-initialize - +WNDI ...................................................................... 90
6.1.3. Configure Station Mode - +WNSTAC ...................................................... 91
6.1.4. Configure AP Mode - +WNAPC ............................................................... 92
6.1.5. Configure IP Address - +WNIPC .............................................................. 94
6.1.6. Configure IP Address in AP Mode - +WNAPIPC ..................................... 95
6.1.7. NCM Create - +WNCR ............................................................................. 96
6.1.8. NCM Retry Count - +WNRETRYC ........................................................... 98
6.1.9. NCM Connect - +WNCN .......................................................................... 99
6.1.10. Interface Statistics in AP Mode - +WNAPST ........................................ 101
6.1.11. Get Associated Station Information - +WNASTINFO ............................ 104
6.1.12. Interface Configuration Information - +WNIFCFG ................................. 105
6.1.13. Interface Statistics in Station Mode - +WNSTAST ................................. 106
6.1.14. NCM Disconnect - +WNDC .................................................................... 110
6.1.15. EAP Configuration - +WNEAP ............................................................... 110
7. WIRELESS DRIVER .............................................................................. 112
7.1. Wireless Local Area Network (WLAN) ................................................... 112
7.1.1. Interface Initialization - +WI .................................................................... 112
7.1.2. Get MAC Address - +WMACG ............................................................... 113
7.1.3. Scan - +WS ............................................................................................ 114
7.1.4. Scan Time - +WST ................................................................................. 115
7.1.5. Get Country Code - +WCCG ................................................................. 116
7.1.6. Set Country Code - +WCCS .................................................................. 117
7.1.7. Get Regulatory Domain - +WREGDG .................................................... 117
7.1.8. Set Regulatory Domain - +WREGDS .................................................... 118
7.1.9. Get Physical Mode - +WPHYMODEG ................................................... 118
7.1.10. Set Physical Mode - +WPHYMODES .................................................... 119
7.1.11. Power Save - +WPOWERSAVE ............................................................ 120
7.1.12. Set Transmission Power - +WTXPOWERS ........................................... 121
WL865E4-P AT Command Reference Guide
80613ST10987A Rev. 1.4.27 Page 10 of 299 2021-01-17
7.1.13. Get Transmission Rate - +WTXRATEG ................................................. 121
7.1.14. Set Transmission Rate - +WTXRATES ................................................. 122
7.1.15. Get RSSI - +WRSSIG ............................................................................ 123
7.1.16. Send Raw Packets - +WRAWPKTS ...................................................... 124
7.1.17. Set Promiscuous Filter - +WPROMISCSETFILTER ............................. 126
7.1.18. Start Promiscuous Mode - +WPROMISCCMD ...................................... 127
7.1.19. Application Information Element - +WAPPIE ......................................... 127
7.1.20. Set Beacon Miss Interval - +WBMISSINTS ........................................... 128
7.2. Bluetooth Low Energy (BLE) .................................................................. 129
7.2.1. BLE Initialize/De-initialize - +BI .............................................................. 129
7.2.2. BLE Own Device Address - +BOAD ...................................................... 130
7.2.3. BLE Connect - +BCONNECT ................................................................ 130
7.2.4. BLE Disconnect - +BDISCONNECT ...................................................... 132
7.2.5. BLE Scan - +BSCAN .............................................................................. 132
7.2.6. BLE Scan Response Data - +BSCANRSPDATA .................................. 133
7.2.7. BLE Device Name - +BNAME ................................................................ 134
7.2.8. BLE Input/Output Capabilities - +BIOCAP ............................................. 136
7.2.9. Bond List - +BBNDLIST ......................................................................... 137
7.2.10. Bond Delete - +BBNDDEL ..................................................................... 138
7.2.11. BLE Secure Simple Pairing PIN (SSP-PIN) - +BSSPPIN ...................... 138
7.2.12. BLE FixPin - +BFIXPIN .......................................................................... 139
7.2.13. BLE Secure Simple Pairing Confirmation (SSP-CONF) - +BSSPCONF140
7.2.14. BLE Product ID - +BPNPPID ................................................................. 141
7.2.15. BLE Product Version ID - +BPNPPVER ................................................ 142
7.2.16. BLE Vendor ID - +BPNPVID .................................................................. 143
7.2.17. BLE Source Vendor ID - +BPNPVSRC .................................................. 144
7.2.18. BLE Terminal Input/Output - +BTIO ....................................................... 145
7.2.19. BLE Terminal Input/Ouput Data Mode - +BTIODATAMODE ................ 146
7.2.20. BLE Advertise Data - +BADDATA ......................................................... 146
7.2.21. BLE Advertise Enable - +BADVE ........................................................... 147
7.2.22. BLE Maximum Advertising Interval - +BADVINTMAX ........................... 148
7.2.23. BLE Minimum Advertising Interval - +BADVINTMIN ............................. 149
7.2.24. BLE Maximum Connection Interval - +BCONINTMAX .......................... 150
7.2.25. BLE Minimum Connection Interval - +BCONINTMIN ............................ 151
7.2.26. BLE Slave Latency - +BSLAVELAT ....................................................... 152
7.2.27. BLE Service Discovery - +BSRVD ......................................................... 153
7.2.28. BLE Read - +BREAD ............................................................................. 154
7.2.29. BLE Write - +BWRITE ............................................................................ 155
7.2.30. BLE Client Character Configuration - +BCCCD ..................................... 156
7.2.31. BLE Attribute Server - +BATTRIB .......................................................... 157
WL865E4-P AT Command Reference Guide
80613ST10987A Rev. 1.4.27 Page 11 of 299 2021-01-17
7.2.32. BLE Server Data Exchange - +BSRVDATAEX ..................................... 159
7.2.33. BLE Transmission Test - +BBPWRTXT ................................................. 160
7.2.34. BLE Reception Test - +BBPWRRXTEST .............................................. 161
7.2.35. BLE Set Transmission Power - +BTXPOWERSET ............................... 161
7.2.36. BLE Get Transmission Power - +BTXPOWERGET .............................. 162
7.2.37. BLE Power Measurement during Scan - +BTXPWMSCAN................... 163
7.2.38. BLE Power Measurement during Write - +BTXPWMWRITE ................. 163
8. NETWORK PROTOCOL ....................................................................... 165
8.1. Caller Identification (CID) ....................................................................... 165
8.1.1. Get CID Information - +NCIDI ................................................................ 165
8.1.2. CID Status Information - +NCIDS .......................................................... 166
8.2. Ping - +NPING ....................................................................................... 167
8.3. Ping Status - +NPINGSTATS ................................................................ 168
8.4. Socket .................................................................................................... 169
8.4.1. Socket Create - +SC .............................................................................. 170
8.4.2. Socket Bind - +SB .................................................................................. 172
8.4.3. Socket Connect - +SCO ......................................................................... 172
8.4.4. Socket Listen - +SL ................................................................................ 173
8.4.5. Set Socket Option - +SSOPT ................................................................. 174
8.4.6. Get Socket Option - +SGOPT ................................................................ 175
8.4.7. Socket Accept - +SA .............................................................................. 176
8.4.8. Socket Send - +SN ................................................................................. 177
8.4.9. Socket Receive Ready - +SRR .............................................................. 178
8.4.10. Socket Receive - +SR ............................................................................ 180
8.4.11. Get Socket Error - +SGERR .................................................................. 181
8.4.12. Socket Throughput Test - +STPTEST ................................................... 183
8.4.13. Socket Throughput Test Statistics - +STPTESTSTAT .......................... 185
8.4.14. Socket Close - +SCL .............................................................................. 186
8.5. Secure Socket Layer (SSL)/ Transport Layer Security (TLS) ................ 187
8.5.1. SSL Initialize - +NSSLINIT ..................................................................... 189
8.5.2. SSL Configure - +NSSLCFG ................................................................. 190
8.5.3. SSL Connect - +NSSLCO ...................................................................... 194
8.5.4. SSL Bind - +NSSLB ............................................................................... 195
8.5.5. SSL Listen - +NSSLL ............................................................................. 196
8.5.6. SSL Accept - +NSSLA ........................................................................... 196
8.5.7. SSL Receive Ready - +NSSLRR ........................................................... 197
8.5.8. SSL Receive - +NSSLRD ...................................................................... 198
8.5.9. SSL Write - +NSSLWR .......................................................................... 199
8.5.10. SSL Close - +NSSLCL ........................................................................... 200
8.5.11. SSL Certificate List - +NSSLCERTLIST ................................................ 201
WL865E4-P AT Command Reference Guide
80613ST10987A Rev. 1.4.27 Page 12 of 299 2021-01-17
8.5.12. SSL Certificate Store - +NSSLCERTSTORE ........................................ 202
8.5.13. SSL Certificate Deletion - +NSSLCERTDELETE .................................. 203
8.6. Simple Network Time Protocol (SNTP) Settings .................................... 203
8.6.1. SNTP Configure - +NSNTPCFG ............................................................ 203
8.6.2. SNTP Start - +NSNTPSTART ................................................................ 204
8.6.3. SNTP Stop - +NSNTPSTOP .................................................................. 205
8.7. Domain Name System (DNS) ................................................................ 206
8.7.1. DNS Client .............................................................................................. 206
8.7.1.1. DNS Resolve URL - +NDNSCRURL ..................................................... 206
8.7.1.2. DNS Set Server IP Address - +NDNSCSRVIP ...................................... 207
8.7.2. DNS Server ............................................................................................ 208
8.7.2.1. DNS Host Addition - +NDNSSADDHOST.............................................. 208
8.7.2.2. DNS Server Start - +NDNSSSTART ...................................................... 208
8.7.2.3. DNS Server Stop - +NDNSSSTOP ........................................................ 209
8.7.3. DNS Service Discovery - +NDNSSD ..................................................... 209
8.8. Multicast Domain Name System (mDNS) .............................................. 211
8.8.1. mDNS Start - +NMDNSSTART .............................................................. 211
8.8.2. mDNS Host Name Registration - +NMDNSHNREG .............................. 212
8.8.3. mDNS Service Registration - +NMDNSSRVREG ................................. 213
8.8.4. mDNS Service De-Registration - +NMDNSSRVDEREG ....................... 213
8.8.5. mDNS Text Update - +NMDNSUPDATETXT ........................................ 214
8.8.6. mDNS Stop - +NMDNSSTOP ................................................................ 214
8.9. HTTP Client (HTTPC) ............................................................................ 215
8.9.1. HTTP Client Initialize - +NHTTPCINIT ................................................... 216
8.9.2. HTTP Client Configure - +NHTTPCCFG ............................................... 217
8.9.3. HTTP Client Connect - +NHTTPCCO .................................................... 218
8.9.4. HTTP Client Request - +NHTTPCREQ ................................................. 219
8.9.5. HTTP Client Receive - +NHTTPCRDRSP ............................................. 220
8.9.6. HTTP Client Close - +NHTTPCCL ......................................................... 221
8.10. HTTP Server (HTTPD) ........................................................................... 222
8.10.1. HTTP Server Configure - +NHTTPDCFG .............................................. 222
8.10.2. HTTP Server Start - +NHTTPDSTART .................................................. 224
8.10.3. HTTP Server Configure URI - +NHTTPDCFGURI ................................ 224
8.10.4. HTTP Server Read - +NHTTPDRD ....................................................... 225
8.10.5. HTTP Server Send Data - +NHTTPDSENDDATA ................................ 226
8.10.6. HTTP Server - Send Header Response - +NHTTPDSENDHDR .......... 227
8.10.7. HTTP Server Receive Ready - +NHTTPDURIRR ................................. 228
8.10.8. HTTP Server Stop - +NHTTPDSTOP .................................................... 228
8.11. Message Queuing Telemetry Transport (MQTT) ................................... 229
8.11.1. MQTT Initialize - +NMQTTINIT .............................................................. 231
WL865E4-P AT Command Reference Guide
80613ST10987A Rev. 1.4.27 Page 13 of 299 2021-01-17
8.11.2. MQTT Client Connect - +NMQTTCONNECT ........................................ 231
8.11.3. MQTT Client Publish - +NMQTTPUBLISH ............................................ 233
8.11.4. MQTT Client Receive Request - +NMQTTRR ....................................... 234
8.11.5. MQTT Client Subscribe - +NMQTTSUBSCRIBE ................................... 235
8.11.6. MQTT Client Receive - +NMQTTR ........................................................ 236
8.11.7. MQTT Client UnSubscribe - +NMQTTUNSUBSCRIBE ......................... 237
8.11.8. MQTT Client Disconnect - +NMQTTCL ................................................. 238
8.12. WebSocket ............................................................................................. 239
8.12.1. WebSocket Create - +WEBSOCKNEW ................................................. 239
8.12.2. WebSocket Configure - +WEBSOCKCONF .......................................... 241
8.12.3. WebSocket Connect - +WEBSOCKCONN ............................................ 242
8.12.4. WebSocket Send Data - +WEBSOCKSEND ......................................... 242
8.12.5. WebSocket Ping - +WEBSOCKPING .................................................... 243
8.12.6. WebSocket Pong - +WEBSOCKPONG ................................................. 244
8.12.7. Send Data to WebSocket - +WEBSOCKSEND ..................................... 245
8.12.8. WebSocket Receive Ready Data - +WEBSOCKRECVREADY ............ 246
8.12.9. WebSocket Receive Data - +WEBSOCKRECV .................................... 247
8.12.10. WebSocket Close - +WEBSOCKCLOSE............................................... 249
9. ADVANCED SERVICES ........................................................................ 250
9.1. Provisioning ............................................................................................ 250
9.1.1. Web Provisioning - +WNWEBPROV ..................................................... 250
9.2. Firmware Upgrade ................................................................................. 251
9.2.1. HTTPC Initialize Firmware Upgrade - +FUHTTPCINIT ......................... 252
9.2.2. HTTPC Firmware Upgrade - +FUHTTPC .............................................. 253
9.2.3. HTTPD Firmware Upgrade - +FUHTTPD .............................................. 254
9.2.4. 254
9.2.4.1. XFP Start - +YXFPSTART ..................................................................... 256
9.2.5. Validate Firmware Upgrade - +FUVALIDATE ........................................ 257
9.3. M2M Smart Device Communication (TR50) .......................................... 258
9.3.1. deviceWISE Configure - +DWCFG ........................................................ 259
9.3.2. deviceWISE Connect/Disconnect - +DWCONN .................................... 260
9.3.3. deviceWISE Connection Status - +DWSTATUS ................................... 261
9.3.4. deviceWISE Send Data - +DWSEND .................................................... 262
9.3.5. deviceWISE Send Raw Data - +DWSENDR ......................................... 263
9.3.6. deviceWISE Receive Data - +DWRCV .................................................. 263
9.3.7. deviceWISE Receive Raw Data - +DWRCVR ....................................... 264
9.3.8. deviceWISE Read Unresolved Data - +DWLRCV ................................. 265
9.4. Amazon Web Service (AWS) ................................................................. 266
9.4.1. AWS Initialize - +CAWSINIT .................................................................. 273
9.4.2. AWS Configure - +CAWSCFG ............................................................... 274
WL865E4-P AT Command Reference Guide
80613ST10987A Rev. 1.4.27 Page 14 of 299 2021-01-17
9.4.3. AWS Command - +CAWSCMD ............................................................. 275
10. APPENDIX A - AT COMMANDS SUMMARY ....................................... 277
11. APPENDIX B ......................................................................................... 291
12. GLOSSARY AND ACRONYMS ............................................................ 293
13. DOCUMENT HISTORY ......................................................................... 294
WL865E4-P AT Command Reference Guide
80613ST10987A Rev. 1.4.27 Page 15 of 299 2021-01-17
FIGURES LIST
Figure 1: Communication between the Interfaces ....................................................................................... 30
Figure 2: Command processing in Serial to Wireless Application ............................................................... 31
Figure 3: Operating Modes of Serial to Wireless Application ...................................................................... 32
WL865E4-P AT Command Reference Guide
80613ST10987A Rev. 1.4.27 Page 16 of 299 2021-01-17
TABLES LIST
Table 1: Document Text Convention ........................................................................................................... 23
Table 2: AT Command Syntax .................................................................................................................... 24
Table 3: Example Response ....................................................................................................................... 26
Table 4: Status Responses ......................................................................................................................... 27
WL865E4-P AT Command Reference Guide
80613ST10987A Rev. 1.4.27 Page 17 of 299 2021-01-17
WL865E4-P AT Command Reference Guide
80613ST10987A Rev. 1.4.27 Page 18 of 299 2021-01-17
WL865E4-P AT Command Reference Guide
80613ST10987A Rev. 1.4.27 Page 19 of 299 2021-01-17
1. INTRODUCTION
1.1. Scope
This document covers the more significant standard and proprietary AT commands provided by Telit's modules. Several module features are described and for each one of them the related AT commands are explained through examples. This document is not an exhaustive description of the AT commands implemented on the Telit's modules series; its target is only to give you an entry point to the AT commands world.
1.2. Audience
This manual is designed for software engineers who want to evaluate, design, and implement the modules within their environment. To use this manual, you will need a basic understanding of wireless networks, network principles, and network protocols.
1.3. Contact Information, Support
For general contact, technical support services, technical questions and report documentation errors contact Telit Technical Support at:
TS-SRD@telit.com
For detailed information about where you can buy Telit modules or for recommendations on accessories and components visit:
https://www.telit.com
Our aim is to make this guide as helpful as possible. Keep us informed of your comments and suggestions for improvements. Telit appreciates feedback from the users of our information.
WL865E4-P AT Command Reference Guide
80613ST10987A Rev. 1.4.27 Page 20 of 299 2021-01-17
1.4. Text Conventions
Danger – This information MUST be followed, or catastrophic equipment failure or bodily injury may occur.
Caution or Warning – Alerts the user to important points about integrating the module, if these points are not followed, the module and end user equipment may fail or malfunction.
Tip or Information – Provides advice and suggestions that may be useful when integrating the module.
All dates are in ISO 8601 format, i.e. YYYY-MM-DD.
1.5. Related Documents
Please refer to https://www.telit.com/ for current documentation and downloads. For EVK: ­WL865E4-P Evaluation Board Quick Start Guide
WL865E4-P AT Command Reference Guide
80613ST10987A Rev. 1.4.27 Page 21 of 299 2021-01-17
WL865E4-P Use Case Reference Guide WL865E4-P Legacy Command Reference Guide
WL865E4-P AT Command Reference Guide
80613ST10987A Rev. 1.4.27 Page 22 of 299 2021-01-17
WL865E4-P AT Command Reference Guide
80613ST10987A Rev. 1.4.27 Page 23 of 299 2021-01-17
2. OVERVIEW
This chapter provides guidelines for using AT command line interface to design, configure and provision WL865E4-P module in a wireless network using serial commands.
2.1. AT Commands
Telit wireless module family can be controlled via the serial interface using the standard AT commands.
2.2. Command Definition
This document uses the following syntactical definitions:
Color text indicates cross-reference, hyperlinks to supplemental information
Command notation indicates commands, sub commands, or command elements
Following table describes the text conventions used in this manual for software procedures that are explained using the AT command line interface.
Convention Type
Description
[ ] Square brackets
Name enclosed in square brackets are optional parameters. Square brackets themselves do not appear in the command line.
<CR> Carriage return
It is the command line and result code terminator character. The ASCII equivalent decimal value of <CR> is 13.
<LF> Line Feed
It is the character recognized as line feed character. The ASCII equivalent decimal value of <LF> is 10. The line feed character is output after carriage return character if verbose result codes are used (ATV1 option used) otherwise, if numeric format result codes are used (ATV0 option used) it will not appear in the result codes.
<CR><LF> Carriage return Line feed
Each command is terminated by <CR><LF>.
< > Angle brackets
Name enclosed in angle brackets are optional parameters. Angle brackets themselves do not appear in the command line.
= Equal sign
Separates the variable from explanatory text and is entered as part of the command.
PROCESSID = <CID>
. Dot (period)
Allows the repetition of the element that immediately follows it multiple times. Do not enter as part of the command.
. AA:NN can be expanded to 1:01 1:02 1:03.
A.B.C.D IP address
IPv4-style address.
10.0.11.123
LINE End-to-line input token
Indicates user input of any string, including spaces. No other parameters may be entered after input for this token.
string of words
WORD Single token
Indicates user input of any contiguous string (excluding spaces). singlewordnospaces
Table 1: Document Text Convention
WL865E4-P AT Command Reference Guide
80613ST10987A Rev. 1.4.27 Page 24 of 299 2021-01-17
2.3. AT Command Syntax
Following table describes the syntax rules followed by Telit implementation used in this manual for software procedures that are explained using the AT command line interface.
Convention Type
Description
command syntax monospaced font
This monospaced font represents command strings entered on a command line and sample source code.
AT XXXX
Proportional font description
Gives specific details about a parameter. <Data> DATA.
UPPERCASE Variable parameter
Indicates user input. Enter a value according to the descriptions that follow. Each uppercased token expands into one or more other token.
lowercase Line Feed
Indicates keywords. Enter values exactly as shown in the command description.
M/O
Gives the condition of the parameter as mandatory or optional.
Table 2: AT Command Syntax
2.4. Command Lines
A command line is made up of three elements: the prefix, the body and the termination character. The command line prefix consists of the characters “AT” or “at”, followed by “+” or “#” or without “+/#”. Most commands are prefixed with “AT+”.
To repeat the execution of the previous command line, the characters “A/” or “a/” or AT#/ or at#/ is used.
The termination character may be selected by a user option, the default being <CR>. The basic structures of the command line are:
AT+CMD<CR> where AT+ is the command line prefix, YLC is the body of a basic command. <CR> is the command line terminator character AT+YLC=0<CR> where 0 is a sub parameter
AT+CMD? <CR> This is a Read command for checking current sub parameter values.
WL865E4-P AT Command Reference Guide
80613ST10987A Rev. 1.4.27 Page 25 of 299 2021-01-17
The set of proprietary AT commands differentiates from the standard one because
the name of each of them begins with either “@”, “#”, “$” or “*”. Proprietary AT
commands follow the same syntax rules as extended commands.
Following are the AT commands the does not have prefixes in Responses: AT+CGMI, AT#SWPKGV, AT+CGMR, AT+CGMM, ATIn and ATI. Following are the AT commands the does not have prefixes “AT+” in Command: ATCn, ATEn, ATVn, AT&Wn, AT&Yn, ATZn, AT&F, AT&Kn, AT#SWPKGV, ATIn and ATI.
WL865E4-P AT Command Reference Guide
80613ST10987A Rev. 1.4.27 Page 26 of 299 2021-01-17
2.5. Information Response and Result Codes
Following is an example of a command executed with response in verbose and non-verbose mode:
Sl No
Verbose mode
Non-verbose mode
1
AT+WNCN=1,"Telit_Guest","Welcome",6<CR>
AT+WNCN=1,"Telit_Guest","Welcome",6<C R>
2
<CR><LF>+WNCN:CONNECTED,192.168.3.4 5,255.255.255.0,192.168.3.1<CR><LF>
+WNCN:CONNECTED,192.168.3.45,255.25
5.255.0,192.168.3.1<CR><LF>
3
<CR><LF>OK<CR><LF>
0<CR>
……
……
4
<CR><LF>+WNCN:CONNECTED,192.168.3.4 6,255.255.255.0,192.168.3.1<CR><LF>
+WNCN:CONNECTED,192.168.3.46,255.25
5.255.0,192.168.3.1<CR><LF>
Table 3: Example Response
Synchronous Response:
Synchronous messaging is a two-way communication i.e. the information sent as a response of the command after the complete execution from the host. It is followed by the status of the command after execution.
In the above example, the node sends connection request to AP, AP sends response, node gets connected by acquiring IP address, net mask and Gateway.
Asynchronous Response:
Asynchronous Response is a one-way communication i.e. the information is sent as an indication of an event that occurred. This event may be due to the command issued previously.
For example, in disassociation event, when the AP gets reset a message is seen on the module. In few cases, there will be multiple responses. Following are the responses to the command scan:
AT+WS=1<CR> <CR><LF>+WS:C0:C1:C0:A6:7F:3A,"ssid153126173420",1,INFRA,-80,NONE<CR><LF> <CR><LF>+WS:2C:30:33:DC:83:FE,"dd-wrt",1,INFRA,-82,NONE<CR><LF> <CR><LF>+WS:C8:B3:73:4A:33:48,"wifiVirus",1,INFRA,-90,WPA2 PSK<CR><LF> <CR><LF>+WS:98:FC:11:F8:C7:15,"FWUP",3,INFRA,-94,WPA2 PSK<CR><LF> <CR><LF>+WS:68:7F:74:52:6F:D4,"homekit",6,INFRA,-90,NONE<CR><LF> <CR><LF>+WS:00:03:7F:50:00:01,"QSoftAP",6,INFRA,-93,WPA2 PSK<CR><LF> <CR><LF>+WS:00:8E:F2:56:24:04,"GainSpan4",6,INFRA,-79,WPA2 PSK<CR><LF> <CR><LF>OK<CR><LF>
WL865E4-P AT Command Reference Guide
80613ST10987A Rev. 1.4.27 Page 27 of 299 2021-01-17
The result or status codes for all possible responses are as follows:
Verbose mode
Non-verbose mode
Description
OK 0 Parsing and processing of command done
successfully.
ERROR
1
Parsing done but processing failed.
INVALID PARAM
2
Parsing of parameter failed, because one of the parameters entered is wrong-it may be because of data type mismatch.
INVALID COMMAND
3
Parsing of command failed as the command entered is not a valid command.
PARMETEROUTOF RANGE
4
Parsing of parameter failed as the parameter value entered is not within the range.
NO MEMORY
5
Parsing or processing of command failed, since the memory allocation failed.
EXCESS DATA RECIEVED
6
Parsing of parameter of type data failed, because the data entered is excess compared to the length mentioned in the command.
Table 4: Status Responses
Verbose Mode:
Verbose Mode displays the status of a command executed, is enabled by default. It is in the ASCII (human readable) format.
Example:
ATV1 OK
Non-Verbose Mode:
Non-Verbose Mode displays the output in numerical digits, each digit indicates specific status. Example:
ATV0 0
2.6. Parameter Types
Following are different types of parameter: Integer: The value must be entered in decimal format and that is stored in 4bytes value. The range
specified is the range of its value.
HEX: Hexadecimal value up to 4 bytes e.g. FF FF FF FF is the range specified is the range of its value. Long integer: A decimal value that cannot be stored in 4bytes value and can be stored in 8bytes value.
The range specified is the range of its value. String: It must be entered in double quote. All the special character can be used within the string. To have
double quote, escape character (‘\’) must be appended, e.g. “Te\”lit”. The range specified is the length of the string.
IP Address: It can be IPv4 address or IPv6 address notation. IPv4 Address: It must be IPv4 notation.
WL865E4-P AT Command Reference Guide
80613ST10987A Rev. 1.4.27 Page 28 of 299 2021-01-17
IPv6 Address: It must be IPv6 notation. MAC Address: It must be in the format (EUI48) i.e. XX:XX:XX:XX:XX:XX. Fixed String: It is a predefined string and doesn’t come in double quote. Hex Stream: It is a stream of hex bytes. The range specifies the length of the byte stream, e.g.
1234aabbcc is 5 bytes long. Binary Data: Binary data is not processed by parser and it is given as is to command processor. It is
always preceded by integer parameter that gives the length of the binary data. The binary data is not echoed by the parser.
As the parameter Data and Data length are mutually inclusive, if either of this parameter is present (optional or mandatory) then the other parameter must also be present in the command.
Example:
AT+NHTTPDSENDDATA=0,0[,0,]
WL865E4-P AT Command Reference Guide
80613ST10987A Rev. 1.4.27 Page 29 of 299 2021-01-17
WL865E4-P AT Command Reference Guide
80613ST10987A Rev. 1.4.27 Page 30 of 299 2021-01-17
3. ARCHITECTURE
This chapter provides a brief overview of the system and the architecture of Serial-to-Wireless application.
3.1. System Overview
The Serial to Wireless stack is used to provide wireless capability to any device having a serial interface. This approach offloads WLAN, TCP/IP stack and network management overhead to the wireless chip, allowing a small embedded host (for example an MCU) to communicate with other hosts on the network using a wireless link. The host processor can use serial commands to configure the serial to wireless application and create wireless or network connections.
The user will receive a pre-loaded firmware to Run the application. To customize the application user is required to perform the following steps.
3.2. Working Principle
The architecture of the Serial to Wireless interface communicates to and from TCP/IP network commands. These are network management commands of serial to wireless interface. The network connections intercepts using Command Processor. Following diagram represents the sequence of communication between the interfaces:
SPI
Driver
SDIO
Driver
UART
Driver
AT Command Parser
Command Processor
SPI
Drv Ctx
UART
Drv Ctx
SDIO
Drv Ctx
Driver Interface
Figure 1: Communication between the Interfaces
Serial to Wireless application takes command input from three different IOs. The software configurations can be UART and either SPI or SDIO combinations. The driver interface gives a transparent interface to the AT command parser. AT command parser does the parsing and calls the command processor API to process the command.
Loading...
+ 269 hidden pages