Telit WE310F5-X Reference Guide
WE310F5-X AT Command
Reference Guide
80664ST11034A Rev. 4 – 2020-08-25
WE310F5-X AT Command Reference Guide
80664ST11034A Rev. 4 Page 2 of 174 2020-08-25
SPECIFICATIONS ARE SUBJECT TO CHANGE WITHOUT NOTICE
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.
WE310F5-X AT Command Reference Guide
80664ST11034A Rev. 4 Page 3 of 174 2020-08-25
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.
WE310F5-X AT Command Reference Guide
80664ST11034A Rev. 4 Page 4 of 174 2020-08-25
APPLICABILITY TABLE
PRODUCTS
SW Versions
Modules
WE310F5-X SERIES
39.00.000
WE310F5-X AT Command Reference Guide
80664ST11034A Rev. 4 Page 5 of 174 2020-08-25
CONTENTS
NOTICES LIST ............................................................................................................... 2
COPYRIGHTS ................................................................................................................ 2
COMPUTER SOFTWARE COPYRIGHTS ..................................................................... 2
USAGE AND DISCLOSURE RESTRICTIONS.............................................................. 3
APPLICABILITY TABLE................................................................................................ 4
CONTENTS 5
FIGURES LIST ............................................................................................................. 11
TABLES LIST ............................................................................................................... 12
1. INTRODUCTION ...................................................................................... 14
Scope ....................................................................................................... 14
Audience .................................................................................................. 14
Contact Information, Support ................................................................... 14
Text Conventions ..................................................................................... 15
Related Documents .................................................................................. 15
2. OVERVIEW .............................................................................................. 16
AT Commands ......................................................................................... 16
Command definition ................................................................................. 16
AT Command Syntax ............................................................................... 17
Command Lines ....................................................................................... 17
Information Response and Result Codes ................................................ 18
3. ARCHITECTURE ..................................................................................... 20
System Overview ..................................................................................... 20
Working Principle ..................................................................................... 21
System Initialization ................................................................................. 21
3.3.1. Auto Connection ....................................................................................... 22
4. HOST INTERACTION .............................................................................. 23
Interface ................................................................................................... 23
4.1.1. UART ........................................................................................................ 23
4.1.1.1. Baud Rate - B ........................................................................................... 23
4.1.1.2. Hardware Flow Control - &Kn .................................................................. 24
5. GENERAL OPERATIONS ....................................................................... 26
System Settings ....................................................................................... 26
5.1.1. Echo Mode - En ....................................................................................... 26
5.1.2. Verbose Mode - Vn .................................................................................. 26
WE310F5-X AT Command Reference Guide
80664ST11034A Rev. 4 Page 6 of 174 2020-08-25
5.1.3. File System ............................................................................................... 27
5.1.3.1. File Open - +YFOP ................................................................................... 27
5.1.3.2. File Close - +YFCL ................................................................................... 28
5.1.3.3. File Read - +YFRD ................................................................................... 29
5.1.3.4. File Write - +YFWR .................................................................................. 30
5.1.3.5. File Length - +YFLN ................................................................................. 31
5.1.3.6. File List - +YFLS ....................................................................................... 32
5.1.3.7. File Delete - +YFRM ................................................................................. 32
Profile Settings ......................................................................................... 33
5.2.1. Profile Read - Zn ...................................................................................... 33
5.2.2. Profile Set - &Yn ....................................................................................... 34
5.2.3. Profile Save - &Wn ................................................................................... 35
5.2.4. Profile Clear/Factory Reset - &F .............................................................. 35
Real Time Clock (RTC) Settings .............................................................. 36
5.3.1. Time Settings - +YTIME ........................................................................... 36
Heap Information - +YHD ......................................................................... 37
Reset - +YSR ........................................................................................... 37
Manufacturer's Name - +CGMI ................................................................ 38
Module Name - +CGMM .......................................................................... 38
Modem Version - +CGMR ........................................................................ 39
Package Version - #SWPKGV ................................................................. 39
Version - +YVER ...................................................................................... 40
6. NETWORK CONNECTION MANAGER .................................................. 42
Wireless Network Connection Manager (WNCM) .................................... 42
6.1.1. NCM Initialize - +WNI ............................................................................... 42
6.1.2. NCM De-initialize - +WNDI ...................................................................... 43
6.1.3. Configure Station Mode - +WNSTAC ...................................................... 44
6.1.4. Configure AP Mode - +WNAPC ............................................................... 45
6.1.5. Configure IP Address in AP Mode - +WNAPIPC ..................................... 47
6.1.6. NCM Create - +WNCR ............................................................................. 48
6.1.7. NCM Connect - +WNCN .......................................................................... 49
6.1.8. Get Associated Station Information - +WNASTINFO .............................. 52
6.1.9. Interface Configuration Information - +WNIFCFG ................................... 52
6.1.10. NCM Disconnect - +WNDC ...................................................................... 54
7. WIRELESS DRIVER ................................................................................ 56
Wireless Local Area Network (WLAN) ..................................................... 56
7.1.1. Get MAC Address - +WMACG ................................................................. 56
7.1.2. Scan - +WS .............................................................................................. 57
7.1.3. Scan Time - +WST ................................................................................... 58
WE310F5-X AT Command Reference Guide
80664ST11034A Rev. 4 Page 7 of 174 2020-08-25
7.1.4. Set Country Code - +WCCS .................................................................... 59
7.1.5. Get Physical Mode - +WPHYMODEG ..................................................... 59
7.1.6. Set Physical Mode - +WPHYMODES ...................................................... 60
7.1.7. Get RSSI - +WRSSIG .............................................................................. 61
7.1.8. Send Raw Packets - +WRAWPKTS ........................................................ 61
7.1.9. Set Promiscuous Filter - +WPROMISCSETFILTER ............................... 63
7.1.10. Start Promiscuous Mode - +WPROMISCCMD ........................................ 64
7.1.11. Application Information Element - +WAPPIE ........................................... 65
Bluetooth Low Energy (BLE) .................................................................... 66
7.2.1. BLE Initialize/De-initialize - +BI ................................................................ 66
7.2.2. BLE Own Device Address - +BOAD ........................................................ 67
7.2.3. BLE Connect - +BCONNECT .................................................................. 67
7.2.4. BLE Disconnect - +BDISCONNECT ........................................................ 69
7.2.5. BLE Scan - +BSCAN ................................................................................ 69
7.2.6. BLE Scan Response Data - +BSCANRSPDATA .................................... 70
7.2.7. BLE Device Name - +BNAME .................................................................. 71
7.2.8. BLE Input/Output Capabilities - +BIOCAP ............................................... 73
7.2.9. BLE Bond List - +BBNDLIST ................................................................... 74
7.2.10. BLE Bond Delete - +BBNDDEL ............................................................... 75
7.2.11. BLE Secure Simple Pairing PIN (SSP-PIN) - +BSSPPIN ........................ 76
7.2.12. BLE Secure Simple Pairing Confirmation (SSP-CONF) - +BSSPCONF . 76
7.2.13. BLE Product ID - +BPNPPID ................................................................... 77
7.2.14. BLE Product Version ID - +BPNPPVER .................................................. 78
7.2.15. BLE Vendor ID - +BPNPVID .................................................................... 79
7.2.16. BLE Source Vendor ID - +BPNPVSRC .................................................... 80
7.2.17. BLE Advertise Data - +BADVDATA ......................................................... 81
7.2.18. BLE Advertise Enable - +BADVE ............................................................. 82
7.2.19. BLE Maximum Advertising Interval - +BADVINTMAX ............................. 83
7.2.20. BLE Minimum Advertising Interval - +BADVINTMIN ............................... 84
7.2.21. BLE Maximum Connection Interval - +BCONINTMAX ............................ 85
7.2.22. BLE Minimum Connection Interval - +BCONINTMIN .............................. 86
7.2.23. BLE Slave Latency - +BSLAVELAT ......................................................... 87
7.2.24. BLE Read - +BREAD ............................................................................... 88
7.2.25. BLE Write - +BWRITE .............................................................................. 89
7.2.26. BLE Client Character Configuration Discriptor ......................................... 90
7.2.27. BLE Server Data Exchange - +BSRVDATAEX ....................................... 90
7.2.28. BLE Service Discovery - +BSCAN ........................................................... 91
7.2.29. BLE Attributes for Code Generation - +BATTRIB .................................... 92
8. NETWORK PROTOCOL ......................................................................... 94
Caller Identification (CID) ......................................................................... 94
WE310F5-X AT Command Reference Guide
80664ST11034A Rev. 4 Page 8 of 174 2020-08-25
8.1.1. Get CID Information - +NCIDI .................................................................. 94
Ping - +NPING ......................................................................................... 95
Ping Status - +NPINGSTATS .................................................................. 96
Socket ...................................................................................................... 97
8.4.1. Socket Create - +SC ................................................................................ 98
8.4.2. Socket Bind - +SB .................................................................................... 99
8.4.3. Socket Connect - +SCO ......................................................................... 100
8.4.4. Socket Listen - +SL ................................................................................ 101
8.4.5. Set Socket Option - +SSOPT ................................................................. 102
8.4.6. Get Socket Option - +SGOPT ................................................................ 104
8.4.7. Socket Accept - +SA .............................................................................. 106
8.4.8. Socket Send - +SN ................................................................................. 107
8.4.9. Socket Receive Ready - +SRR .............................................................. 108
8.4.10. Socket Receive - +SR ............................................................................ 109
8.4.11. Socket Close - +SCL .............................................................................. 111
Secure Socket Layer (SSL)/ Transport Layer Security (TLS) ................ 111
8.5.1. SSL Initialize - +NSSLINIT ..................................................................... 114
8.5.2. SSL Configure - +NSSLCFG ................................................................. 115
8.5.3. SSL Connect - +NSSLCO ...................................................................... 118
8.5.4. SSL Bind - +NSSLB ............................................................................... 119
8.5.5. SSL Listen - +NSSLL ............................................................................. 120
8.5.6. SSL Accept - +NSSLA ........................................................................... 120
8.5.7. SSL Receive Ready - +NSSLRR ........................................................... 121
8.5.8. SSL Receive - +NSSLRD ...................................................................... 122
8.5.9. SSL Write - +NSSLWR .......................................................................... 123
8.5.10. SSL Close - +NSSLCL ........................................................................... 124
8.5.11. SSL Certificate List - +NSSLCERTLIST ................................................ 125
8.5.12. SSL Certificate Store - +NSSLCERTSTORE ........................................ 126
8.5.13. SSL Certificate Deletion - +NSSLCERTDELETE .................................. 127
Simple Network Time Protocol (SNTP) Settings .................................... 127
8.6.1. SNTP Configure - +NSNTPCFG ............................................................ 127
8.6.2. SNTP Start - +NSNTPSTART ................................................................ 128
8.6.3. SNTP Stop - +NSNTPSTOP .................................................................. 129
Domain Name System (DNS) ................................................................ 130
8.7.1. DNS Client .............................................................................................. 130
8.7.1.1. DNS Resolve URL - +NDNSCRURL ..................................................... 130
8.7.1.2. DNS Set Server IP Address - +NDNSCSRVIP ...................................... 131
8.7.2. DNS Server ............................................................................................ 132
8.7.2.1. DNS Host Addition - +NDNSSADDHOST.............................................. 132
8.7.2.2. DNS Server Start - +NDNSSSTART ...................................................... 132
WE310F5-X AT Command Reference Guide
80664ST11034A Rev. 4 Page 9 of 174 2020-08-25
8.7.2.3. DNS Server Stop - +NDNSSSTOP ........................................................ 133
8.7.3. DNS Service Discovery - +NDNSSD ..................................................... 133
8.7.4. DNS Service Get Target Info - +NDNSSDGETTARGETINFO .............. 135
Multicast Domain Name System (mDNS) .............................................. 136
8.8.1. mDNS Start - +NMDNSSTART .............................................................. 136
8.8.2. mDNS Host Name Registration - +NMDNSHNREG .............................. 137
8.8.3. mDNS Service Registration - +NMDNSSRVREG ................................. 138
8.8.4. mDNS Service De-Registration - +NMDNSSRVDEREG ....................... 139
8.8.5. mDNS Text Update - +NMDNSUPDATETXT ........................................ 139
8.8.6. mDNS Stop - +NMDNSSTOP ................................................................ 140
HTTP Server (HTTPD) ........................................................................... 140
8.9.1. HTTP Server Configure - +NHTTPDCFG .............................................. 140
8.9.2. HTTP Server Start - +NHTTPDSTART .................................................. 142
8.9.3. HTTP Server Configure URI - +NHTTPDCFGURI ................................ 142
8.9.4. HTTP Server Read - +NHTTPDRD ....................................................... 144
8.9.5. HTTP Server Send Data - +NHTTPDSENDDATA ................................ 145
8.9.6. HTTP Server - Send Header Response - +NHTTPDSENDHDR .......... 145
8.9.7. HTTP Server Receive Ready - +NHTTPDURIRR ................................. 146
8.9.8. HTTP Server Stop - +NHTTPDSTOP .................................................... 147
Message Queuing Telemetry Transport (MQTT) ................................... 147
8.10.1. MQTT Initialize - +NMQTTINIT .............................................................. 148
8.10.2. MQTT Client Connect - +NMQTTCONNECT ........................................ 149
8.10.3. MQTT Client Publish - +NMQTTPUBLISH ............................................ 151
8.10.4. MQTT Client Receive Request - +NMQTTRR ....................................... 152
8.10.5. MQTT Client Subscribe - +NMQTTSUBSCRIBE ................................... 153
8.10.6. MQTT Client Receive - +NMQTTR ........................................................ 153
8.10.7. MQTT Client Disconnect - +NMQTTDISCONNECT .............................. 154
9. ADVANCED SERVICES ........................................................................ 156
Provisioning ............................................................................................ 156
9.1.1. Web Provisioning - +WNWEBPROV ..................................................... 156
Firmware Upgrade ................................................................................. 157
9.2.1. HTTPC Firmware Upgrade - +FUHTTPC .............................................. 158
9.2.2. HTTPD Firmware Upgrade - +FUHTTPD .............................................. 159
9.2.3. XFP Start - +YXFPSTART ..................................................................... 159
9.2.4. Validate Firmware Upgrade - +FUVALIDATE ........................................ 159
10. APPENDIX A - AT COMMANDS SUMMARY ....................................... 161
11. APPENDIX B ......................................................................................... 170
12. GLOSSARY AND ACRONYMS ............................................................ 172
WE310F5-X AT Command Reference Guide
80664ST11034A Rev. 4 Page 10 of 174 2020-08-25
13. DOCUMENT HISTORY ......................................................................... 173
WE310F5-X AT Command Reference Guide
80664ST11034A Rev. 4 Page 11 of 174 2020-08-25
FIGURES LIST
Figure 1: Communication between the Host and the Module ..................................................................... 21
Figure 2: Serial to Wireless Application ....................................................................................................... 21
WE310F5-X AT Command Reference Guide
80664ST11034A Rev. 4 Page 12 of 174 2020-08-25
TABLES LIST
Table 1: Document Text Convention ........................................................................................................... 16
Table 2: AT Command Syntax .................................................................................................................... 17
Table 3: Example Response ....................................................................................................................... 18
Table 4: Error Response.............................................................................................................................. 19
WE310F5-X AT Command Reference Guide
80664ST11034A Rev. 4 Page 13 of 174 2020-08-25
WE310F5-X AT Command Reference Guide
80664ST11034A Rev. 4 Page 14 of 174 2020-08-25
1. INTRODUCTION
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.
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.
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:
http://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.
WE310F5-X AT Command Reference Guide
80664ST11034A Rev. 4 Page 15 of 174 2020-08-25
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.
Related Documents
Please refer to https://www.telit.com/m2m-iot-products/wifi-bluetooth-modules/ for current documentation
and downloads.
WE310F5-X AT Command Reference Guide
80664ST11034A Rev. 4 Page 16 of 174 2020-08-25
2. OVERVIEW
This chapter provides guidelines for using AT command line interface to design, configure and provision
WE310F5-X module in a wireless network using serial commands.
AT Commands
Telit wireless module family can be controlled via the serial interface using the standard AT commands.
Command definition
This document uses the following syntactical definitions:
• Special text fonts represent particular-commands, keywords, variables, or window sessions
• Color text indicates cross-reference, hyperlinks to supplemental information
• Command notation indicates commands, subcommands, 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
Encloses optional parameters. Choose none or select one or more unlimited
number of times. Do not enter brackets as part of any command.
[parm1|parm2|parm3]
?
Question mark
Used with the square brackets to limit the immediately following token to one
occurrence.
<CR>
Carriage return
Each command is terminated by a carriage return.
<LF>
Line Feed
Each command is terminated by a line feed.
<CR><LF>
Carriage return Line feed
Each command is terminated by <CR><LF>.
< >
Angle brackets
Enclose a numeric range, endpoints inclusive. Do not enter angle brackets as
part of any command.
<SSID>
=
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
WE310F5-X AT Command Reference Guide
80664ST11034A Rev. 4 Page 17 of 174 2020-08-25
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 limitation of the parameter as mandatory or optional.
Table 2: AT Command Syntax
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+YLC<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+YLC?<CR> This is a Read command for checking current sub parameter values.
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.
WE310F5-X AT Command Reference Guide
80664ST11034A Rev. 4 Page 18 of 174 2020-08-25
Information Response and Result Codes
When a command is executed the response can be either in synchronous or in asynchronous format that
may occur at any point. 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<CR>
2
<CR><LF>+WNCN:CONNECTED,192.168.3.45,255.
255.255.0,192.168.3.1<CR><LF>
+WNCN:CONNECTED,192.168.3.45,255.255.25
5.0,192.168.3.1<CR><LF>
3
<CR><LF>OK<CR><LF>
0<CR>
……
……
4
<CR><LF>+WNCN:CONNECTED,192.168.3.46,255.
255.255.0,192.168.3.1<CR><LF>
+WNCN:CONNECTED,192.168.3.46,255.255.25
5.0,192.168.3.1<CR><LF>
Table 3: Example Response
The first line is the command executed to connect to a network.
The second line shows the synchronous response of the command. The response is always prefixed with
the command name. In few cases, the synchronous response doesn’t come with the prefix.
The third line shows the status of the command whether the command processing is successful, or it
failed.
If there is any change in the connection status, then an asynchronous response is given which is seen in
line four.
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>
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.
WE310F5-X AT Command Reference Guide
80664ST11034A Rev. 4 Page 19 of 174 2020-08-25
The result codes of an Error response 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.
PARMETER OUT OF 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 RECEIVED
6
Parsing of parameter of type data failed, because the
data entered is excess compared to the length
mentioned in the command.
Table 4: Error Response
WE310F5-X AT Command Reference Guide
80664ST11034A Rev. 4 Page 20 of 174 2020-08-25
3. ARCHITECTURE
This chapter provides a brief overview of the system and the architecture of Serial-to-Wireless application.
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.
Following are the basic application development sequence for a Serial-to-Wireless user:
1. Evaluate the hardware and firmware
• Download the software, program, and execute.
• To download the software, go to DownloadZone (https://www.telit.com/support-
training/download-zone/), and download all the latest packages including the binary.
• Flash the binary using WE310F5-X Module Programming Reference Guide on the custom
hardware or on the evaluation board and execute in RUN mode.
2. Develop host firmware
• Interface host application using AT commands, refer WE310F5-X AT Command Reference
Guide.
• Configure the serial interface (UART) for mode and polarity. For software interface, choose
Command & Response, Byte stuffing/de-stuffing as “None” for UART options.
• Issue general, power save, and security related commands as required.
• Start connection to an access point or do provisioning as required.
• Obtain the IP address and start data transferring.
• Select advanced services if any.
3. Debug the host and the module
• Debug using the AT commands and other options if required, refer WE310F5-X AT Command
Reference Guide.
• Analyze using Wire shark over wireless. For more details, refer information about AirPcap Nx
in http://www.riverbed.com.
4. Production Process
• Perform generic recommendations in production line.
• Perform RF tests.
For detailed use cases and example , refer “WE310F5-X Use Case Reference Guide”.
WE310F5-X AT Command Reference Guide
80664ST11034A Rev. 4 Page 21 of 174 2020-08-25
Working Principle
Following representation shows the communication between the Host and the WE310F5-X module:
Figure 1: Communication between the Host and the Module
System Initialization
Upon startup the serial to wireless interface performs the following actions:
- During the initialization process, the module software tries to fetch the configuration file (also
called as profile) from the file system. If the profile is not found, it sets the factory default values to
profile and creates the file in the file system.
For a default profile, the interface starts in the AP mode, initializing the provisioning software.
User can either configure the module through the provisioning mechanism or can issue
commands to start in Station mode and join the intended AP.
- In the profile, configuration related to wireless network- UDP/TCP/DNS/MDNS/HTTP/MQTT are
kept. If the auto connection mode is set, then the module will attempt to join the wireless network
and tries to open connection based on the UDP/TCP/HTTP/MQTT configuration. It configures the
services and fetches based on the MDNS configuration.
- Serial to wireless application is initialized based on the profile settings.
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 2: Serial to Wireless Application
Serial to Wireless application takes command input from three different IOs. The software configurations
can be by either UART and SPI or UART or SDIO combinations. The driver interface gives a transparent
WE310F5-X AT Command Reference Guide
80664ST11034A Rev. 4 Page 22 of 174 2020-08-25
interface to the AT command parser. AT command parser does the parsing and calls the command
processor API to process the command.
Note: Current release does not support SPI and SDIO interface.
3.3.1. Auto Connection
Start
Auto mode
enable
Configure the
module based on
the saved profile
and indicate to user
about the result of
the configuration
Wait for user
command
Wait for user
command
YES
NO
- Configures L2 and L3
connection indicate the result
- Configure UDP/TCP and
indicates to user
- Configures mDNS and
indicates to user
WE310F5-X AT Command Reference Guide
80664ST11034A Rev. 4 Page 23 of 174 2020-08-25
4. HOST INTERACTION
Interface
An embedded host uses one of the serial IO interfaces to connect to the module.
By default, UART0 interface is enabled. When the module boots up, it initializes the UART0 interface to
receive command. Host can enable the second interface by issuing AT command (e.g. AT+YSIF = 1). The
second interface supported can be either SPI or SDIO. Both SPI and SDIO supports Slave mode.
By default, the second interface is disabled. User can enable and save it in profile for the next boot where
the module automatically starts the second interface. Upon factory reset, the second interface is disabled.
4.1.1. UART
The UART0 is enabled by default. User can configure the UART port with the below shown configuration.
Both UART0 and UART1 takes AT command but UART1 displays debug logs along with the AT command
response.
By default, HW flow control is disabled. User can enable HW flow control by issuing AT&K command for
UART0.
The hardware flow control on UART1 is not supported.
4.1.1.1. Baud Rate - B
Description
This command is used to configure UART and set the UART parameters.
Pre-requisites
None.
Syntax
ATB=<Port>,<Baud rate>,[<Bits per character>,<Parity mode>,<Stop bits>]
Parameters Description
Paramete
r
Value
Forma
t
Descriptio
n
Port
Range: 0,1
Integer
It specifies
port of the
UART to be
WE310F5-X AT Command Reference Guide
80664ST11034A Rev. 4 Page 24 of 174 2020-08-25
configured,
where:
0 - High
Speed
UART,
1 - Debug
UART.
Baud rate
Range:
300,600,1200,2400,4800,9600,14400,19200,38400,57600,11520
0
Integer
It specifies
rate at
which the
data
transmits
over a
channel,
port 0
supports
300 to
921600
baud rate
and port 1
supports
only
115200
baud rate.
Bits per
character
Range: 5-8
Default: 8
Integer
It specifies
the bits per
character.
Parity
mode
Range: 0-2
Default: 0
Integer
It specifies
the parity
mode being
used,
where:- 0 is
No Parity, 1
is odd
Parity and 2
is Even
Parity.
Stop bits
Range: 1,3
Default: 1
Integer
It specifies
the number
of stop bits,
where:- 1
for 1 bit and
3 for 2 bits.
Status
For all possible status responses refer Table 4: Status Responses
Example
ATB=0,115200,3,0,1
OK
4.1.1.2. Hardware Flow Control - &Kn
Description
WE310F5-X AT Command Reference Guide
80664ST11034A Rev. 4 Page 25 of 174 2020-08-25
This command is used to enable or disable the hardware flow control for UART interface.
Pre-requisites
None.
Syntax
AT&Kn
Parameters Description
Parameter
Value
Format
Description
n
Range: 0,3
Integer
It specifies state of the hardware flow control for
UART interface, where:
3-Enables hardware flow control,
0-Disables hardware flow control.
Status
For all possible status responses refer Table 4: Status Responses
Example
AT&K0
OK
Following command is used to get the status of the hardware flow control in UART interface:
Syntax
AT&K?
Response
&K:<mode>
Response Parameters Description
Parameter
Range
Type
Description
mode
0,3
Integer
It returns 0 or 3, if the
HW flow control is
disabled or enabled
respectively.
Status
For all possible status responses refer Table 4: Status Responses
Example
AT&K?
&K:0
OK
WE310F5-X AT Command Reference Guide
80664ST11034A Rev. 4 Page 26 of 174 2020-08-25
5. GENERAL OPERATIONS
System Settings
For basic module setting and to get system information, the following AT commands are used:
• ATEn - To enable/disable echo mode
• ATVn – To enable/disable verbose mode
• AT+YSR – To perform a software reset on the board
• AT+YHD – To get heap information
• AT+YTIME – To set and get time
To store information in the internal Flash of the module, file system commands are used. User can
open/create, read/write and close the file after the completion of specific operation and then delete the file
if not required or not in use.
For a file to be saved in secure mode, a password can be provided during file open procedure. If a
secured file is opened with a wrong password or without a password, then file read operation will give junk
data. User must track and maintain the password of the files saved in secured mode.
User can list the files present in the internal flash and get information on the size of each file.
5.1.1. Echo Mode - En
Description
This command enables or disables Echo mode. In UART interface, echo mode is enabled by
default and in SPI and SDIO interface, echo mode is disabled.
Pre-requisites
None.
Syntax
ATEn
Parameters Description
Parameter
Value
Format
Description
n
Range: 0-1
Integer
It specifies the state of echo mode, where:
1-Enables Echo mode,
0-Disables Echo mode.
Status
For all possible status responses refer Table 4: Status Responses
Example
ATE0
OK
5.1.2. Verbose Mode - Vn
Description
This command enables or disables Verbose mode.
Pre-requisites
None.
WE310F5-X AT Command Reference Guide
80664ST11034A Rev. 4 Page 27 of 174 2020-08-25
Syntax
ATVn
Parameters Description
Parameter
Value
Format
Description
n
Range: 0-1
Integer
It specifies the state of Verbose mode, where:
1-Enables Verbose mode
0-Disables Verbose mode.
Status
For all possible status responses refer Table 4: Status Responses
Example
ATV1
OK
5.1.3. File System
5.1.3.1. File Open - +YFOP
Description
This command opens a specified file with the given option.
Pre-requisites
None.
Syntax
AT+YFOP=<Name>,<Option>,[<Password>]
Parameters Description
Parameter
Value
Format
Description
Name
Range: 1-64
String
It specifies the file name along with the path.
Ex:/sys/abc.txt
Option
Range: 0x00x2, 0x41,
0x42, 0xC1,
0xC2, 0x241,
0x242, 0x441,
0x442, 0x4C1,
0x4C2
Hexadecimal
It specifies the options for Open flag, following are
the options:
0x0 to Open in read only mode.
0x1 to Open in write only mode.
0x2 to Open in read and write mode.
In addition to the above flags, any of the following
flags can be bitwise "OR"ed:
0x400 APPEND: - Data written will be appended to
the end of the file. The file operations will always
adjust the position pointer to the end of the file.
0x40 CREAT: - Create the file if it does not exist.
0x80 EXCL: - Used with CREAT. If the file already
exists, then fail, and return error.
WE310F5-X AT Command Reference Guide
80664ST11034A Rev. 4 Page 28 of 174 2020-08-25
0x200 TRUNC: - If the file already exists then
discard its previous contents, reducing it to an
empty file.
Password
Range: 16
Default:
String
It specifies the password for a secured file,
supported each time to open a file. If the password
is not necessary to open a file, then it is a unsecure
file.
Response
+YFOP:<File Descriptor>
Response Parameters Description
Parameter
Range
Type
Description
File Descriptor
0X0-0XFFFFFFFF
Hexadecimal
It specifies the file
descriptor in use for
other file operations.
Status
For all possible status responses refer Table 4: Status Responses
Example
AT+YFOP="/abc.txt",42,"TelitIndiaPvtLtd"
+YFOP:1006E6A0
OK
5.1.3.2. File Close - +YFCL
Description
This command closes a specified file.
Pre-requisites
A file must be open before issuing this command.
Syntax
AT+YFCL=<File Descriptor>
Parameters Description
Parameter
Value
Format
Description
File Descriptor
Range: 0X00XFFFFFFFF
Hexadecimal
It specifies the return value while opening the file.
Status
For all possible status responses refer Table 4: Status Responses
Example
AT+YFCL=0
OK
WE310F5-X AT Command Reference Guide
80664ST11034A Rev. 4 Page 29 of 174 2020-08-25
5.1.3.3. File Read - +YFRD
Description
This command reads the specified number of bytes of a file from a given offset and the start of the
file.
Pre-requisites
A file must be open before issuing this command.
Syntax
AT+YFRD=<File Descriptor>,[<Offset>],<Length>
Parameters Description
Parameter
Value
Format
Description
File Descriptor
Range: 0X00XFFFFFFFF
Hexadecimal
It specifies the return value while opening a file.
Offset
Range: -116384
Default: -1
Integer
It specifies the offset of the file to start.
If the change in offset value is not required then the
offset value is -1, else it is 0-4096 for any valid
offset value.
If the offset value is not given then by default -1 in
taken as the offset.
Length
Range: 116384
Integer
It specifies the data to be sent with a gap of
~10msec before sending the data.
Response
+YFRD:<File Descriptor>,<Requested Length>,Available Length>,<Data>
Response Parameters Description
Parameter
Range
Type
Description
File Descriptor
0X0-0XFFFFFFFF
Hexadecimal
It specifies the File
Descriptor.
Requested length
1-4294967295
Integer
It specifies the length
requested by user
Available length
1-4294967295
Integer
It specifies the length of
data following
Data
1-4294967295
Binary Data
It specifies the data to
be sent.
Status
For all possible status responses refer Table 4: Status Responses
Example
WE310F5-X AT Command Reference Guide
80664ST11034A Rev. 4 Page 30 of 174 2020-08-25
Example1:
AT+YFRD=0,0,5
+YFRD=0,5,5,abcde
OK
Example2:
If the file size is 4224 and the user request a read command for 4500 bytes, then
AT+YFRD=0,4500
+YFRD:0,4500,1024,<data of 1024 bytes>
+YFRD:0,4500,1024,<data of 1024 bytes>
+YFRD:0,4500,1024,<data of 1024 bytes>
+YFRD:0,4500,1024,<data of 1024 bytes>
+YFRD:0,4500,128,<data of 128 bytes>
OK
5.1.3.4. File Write - +YFWR
Description
This command writes in a specified file from a given offset.
Pre-requisites
A file is required to be open before issuing this command.
Syntax
AT+YFWR=<File Descriptor>,[<Offset>],<Data length>,<Data>
Parameters Description
Parameter
Value
Format
Description
File Descriptor
Range: 0X00XFFFFFFFF
Hexadecimal
It specifies the return value while opening a file.
Offset
Range: -116384
Default: -1
Integer
It specifies the offset of the file to start.
If the change in offset value is not required then the
offset value is -1, else it is 0-4096 for any valid
offset value.
If the offset value is not given then by default -1 in
taken as the offset.
Data length
Range: 14294967295
Integer
It specifies the data to be sent with a gap of
~10msec before sending the data.
Data
Range: 14294967295
Binary Data
It specifies the data to be sent.
Status
For all possible status responses refer Table 4: Status Responses
Loading...