WE310F5-X IP2WiFi Legacy AT Command Reference Guide Contents APPLICABILITY TABLE CONTENTS INTRODUCTION Scope Audience Contact Information, Support Symbol Convention Related Documents OVERVIEW AT Commands 2.1.1. AT Command Definitions 2.1.2. AT Command Syntax GETTING STARTED System Overview Legacy Command Mode ARCHITECTURE...
Page 4
WE310F5-X IP2WiFi Legacy AT Command Reference Guide GENERAL OPERATIONS Version System Settings 6.2.1. Get Current Command Mode Status 6.2.2. Switch Between Legacy and New AT Command 6.2.3. Boot Reason Time Setting 6.3.1. Set System Time 6.3.1.1. Manual Setting 6.3.2. Get System Time Profile Setting 6.4.1.
Page 5
WE310F5-X IP2WiFi Legacy AT Command Reference Guide 7.2.1. Scan Time Settings 7.2.1.1. Set Scan Time 7.2.1.2. Get Scan Time 7.2.2. Security Configuration 7.2.2.1. Security Setting 7.2.2.2. WPA-PSK and WPA2-PSK Passphrase 7.2.2.3. WPA-PSK and WPA2-PSK Key Calculation 7.2.2.4. WPA-PSK and WPA2-PSK Key 7.2.3.
Page 6
WE310F5-X IP2WiFi Legacy AT Command Reference Guide APPENDIX A - RESPONSE CODES Synchronous Message Asynchronous & Enhanced Asynchronous Messages PRODUCT AND SAFETY INFORMATION Copyrights and Other Notices 12.1.1. Copyrights 12.1.2. Computer Software Copyrights Usage and Disclosure Restrictions 12.2.1. License Agreements 12.2.2.
1. INTRODUCTION Scope This document is aimed in providing a detailed specification on and a comprehensive listing as a reference for the whole set of AT command supported by the WE310F5-X module in legacy command mode. Audience This document is intended for Telit customers, who are integrators, about to implement their applications using our WE310F5-X modules.
WE310F5-X IP2WiFi Legacy AT Command Reference Guide Note/Tip: Provides advice and suggestions that may be useful when integrating the module. Electro-static Discharge: Notifies the user to take proper grounding precautions before handling the product. All dates are in ISO 8601 format, that is. YYYY-MM-DD.
WE310F5-X IP2WiFi Legacy AT Command Reference Guide 2. OVERVIEW AT Commands The Telit wireless module family can be controlled via the serial interface using the standard AT commands. 2.1.1. AT Command Definitions This document uses the following syntactical definitions: 1. Special text fonts represent particular commands, keywords, variables, or window sessions 2.
WE310F5-X IP2WiFi Legacy AT Command Reference Guide Convention Type Description LINE Indicates user input of any string, including spaces. No other parameters may End-to-line input token be entered after input for this token. string of words WORD Indicates user input of any contiguous string (excluding spaces).
WE310F5-X IP2WiFi Legacy AT Command Reference Guide 3. GETTING STARTED 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.
WE310F5-X IP2WiFi Legacy AT Command Reference Guide 4. ARCHITECTURE Working Principle Following representation shows the communication between WE310F5-X Module and the Host: Figure 1: Communication between the Module and the Host. System Initialization During the initialization process, the module SW tries to fetch the configuration file (also called as profile) from the file system.
WE310F5-X IP2WiFi Legacy AT Command Reference Guide Figure 2: Operating Modes in Serial-to-Wireless Application. Note/Tip: The default UART baud rate is 115200 instead of 921600, using 8 bit characters with no parity bits and one stop bit. Data Handling In Data Processing Mode, data transfers are managed using various escape sequences.
Page 14
WE310F5-X IP2WiFi Legacy AT Command Reference Guide Figure 3: Data Processing Flow. Table 5: Data Handling Responses at Completion. Operation Escape Sequence Description Send and Return to <ESC>C This sequence causes transmission of the data received on Command Mode the serial interface on a TCP server/client or UDP client Sequence connection.
UART hardware FIFO overflow on S2W Application due to high speed data transmission from/to the S2W Application. If hardware flow control is enabled, an RTS/CTS handshake will occur between the serial host and the WE310F5-X node. This is a hardware feature and available only for UART interface.
5. The connection manager in order to output status indications 6. The wireless connection manager in order to output status indications When configured in Auto Connection Mode, the WE310F5-X node enters directly into Data Processing Mode after the completing the connection without sending any status information to the Host.
Page 17
WE310F5-X IP2WiFi Legacy AT Command Reference Guide Note: SP = space. 2. The SSID or Passphrase parameter may be captured within or without double quotation marks (“SSID”). 3. The quotation mark (“) may not be used as the first character of the SSID or Passphrase.
Responses Remarks Success ERROR:INVALID INPUT If parameter is not valid. (other than 0 or 1) Note/Tip: Software Flow Control is not supported in WE310F5-X module. 5.1.2. Interface Verification Command Description The command AT can be issued to verify that the interface is operating correctly or not.
Page 19
WE310F5-X IP2WiFi Legacy AT Command Reference Guide Synchronous Response Table 10: Interface Verification Synchronous Response. Responses Remarks Success No response Failure Interface not operating correctly. 80664ST11079A Rev. 3 Page 19 of 79 2021-10-25 Not Subject to NDA...
WE310F5-X IP2WiFi Legacy AT Command Reference Guide 6. GENERAL OPERATIONS Version Command Description This command is used to return version information. Command Syntax AT+VER=? Response Serial-to-WiFi version – Telit Embedded Platform Software version – WLAN firmware version – Example 1 AT+VER=? S2W APP VERSION=7.0.0...
Page 21
WE310F5-X IP2WiFi Legacy AT Command Reference Guide Module flash ID with storage capacity – Example 2 AT+VER=?? S2W APP VERSION=7.0.0 S2W GEPS VERSION=7.0.0 S2W WLAN VERSION=7.0.0 S2W BIN TYPE=DEFAULT S2W RELEASE TYPE=BETA BUILD TIME=14:59:27 BUILD DATE=Sep 18 2019 WLAN EXT VERSION=2.0.1.9999...
WE310F5-X IP2WiFi Legacy AT Command Reference Guide System Settings 6.2.1. Get Current Command Mode Status Command Description This command is used to get the status of the current command mode in which the module is operating. Command Syntax AT+YLC? Synchronous Response Table 11: Get Current Command Mode Status.
WE310F5-X IP2WiFi Legacy AT Command Reference Guide Parameter Description Table 12: Enable Legacy Command Mode Parameters. Parameter Optional/Mandatory Value Description It specifies the mode in which Mandatory 0, 1 the current AT commands are executed, where: 0-Enables New AT command, 1-Enables Legacy command.
WE310F5-X IP2WiFi Legacy AT Command Reference Guide Example AT+YBR +YBR:Hardware Reset Time Setting 6.3.1. Set System Time 6.3.1.1. Manual Setting Command Description This command is used to set the Telit node’s system time to the time specified as in the parameters and then returns the standard command response.
WE310F5-X IP2WiFi Legacy AT Command Reference Guide Example 1 AT+SETTIME=02/06/2016,15:00:00 Example 2 AT+SETTIME=,1493788674000 AT+GETTIME=? 3/5/2017,5:17:58,1493788678792 6.3.2. Get System Time Command Description This command is used to receive the current system time in milliseconds since epoch (1970) followed by the standard command response to the serial interface.
WE310F5-X IP2WiFi Legacy AT Command Reference Guide valid till: Fri, 13 Dec 1901 17:31:43 GMT Profile Setting Telit node supports different operating modes with various settings pre-configured to work with the system. A pre-defined set of variables can be stored in a profile. Telit node currently supports storing two different profiles (profile0 and profile1).
WE310F5-X IP2WiFi Legacy AT Command Reference Guide Synchronous Response Table 21: Save Profile Synchronous Response. Responses Remarks Success ERROR:INVALID INPUT If parameters are not valid. (Other than 0 and 1) Note/Tip: Telit node supports two profiles. 6.4.3. Load Profile Command Description This command is used to load a profile.
WE310F5-X IP2WiFi Legacy AT Command Reference Guide Parameter Values Reference Protocol TCP, UDP DHCP Client, 67 Server Port Number Any valid port Server IP Address Any valid IP address Host Name Valid Domain name Wireless Interface Security Configuration WPA-PSK and WPA2-PSK Key Calculation,...
WE310F5-X IP2WiFi Legacy AT Command Reference Guide Note/Tip: The following sequence of AT Commands is used for complete Factory restore: AT&Y0 AT&F AT&W0 AT&Y1 AT&F AT&W1 AT+RESET=1. 6.4.7. Identification Information Command Description This command is used to return various identification information of Telit node.
WE310F5-X IP2WiFi Legacy AT Command Reference Guide AT+NDHCP=1 SubNet Gateway 192.168.17.4:255:255:255.0:192.168.17.1 AT+NSTCP=8000 CONNECT 0 AT+ASYNCMSGFMT=1 OK 11eCONNECT0 1 192.168.17.250090 Reset Command Description This command is used to reset the Telit node. When this command is used without parameter (AT+RESET), it forcefully resets the module core and comes out with a fresh boot message “APP Reset-APP SW Reset”.
WE310F5-X IP2WiFi Legacy AT Command Reference Guide All new WE310F5-X modules will have “00:21:7E:xx:xx:xx” as MAC address with Telit Organizational Unique Identifier (OUI). 6.7.1. Get MAC Address Command Description This command is used to output the current MAC address of the wireless interface to the serial port.
WE310F5-X IP2WiFi Legacy AT Command Reference Guide Example 2 To get the current MAC address for the Telit node in AP mode, execute the following sequence of commands: AT+WM=2 AT+NMAC=? 00:1d:c9:d0:70:cc Package Version Command Description This command reads all the available version details of the package.
Page 36
WE310F5-X IP2WiFi Legacy AT Command Reference Guide Example 1 AT#SWPKGV 39.00.000-B005-P0G.000000 M0G.000003 P0G.000000 A0G.000002 R0G.060203 B0G.000002 80664ST11079A Rev. 3 Page 36 of 79 2021-10-25 Not Subject to NDA...
WE310F5-X IP2WiFi Legacy AT Command Reference Guide 7. WIRELESS Wireless Generic 7.1.1. Regulatory Domain 7.1.1.1. Set Regulatory Domain Command Description This command is used to configure the Telit node’s parameters to the requested regulatory domain. Command Syntax AT+WREGDOMAIN=<Regulatory Domain> Parameter Description Table 36: Set Regulatory Domain Parameters.
WE310F5-X IP2WiFi Legacy AT Command Reference Guide AT+WREGDOMAIN=? Synchronous Response Table 38: Get Regulatory Domain Synchronous Response. Responses Remarks REG_DOMAIN=FCC Success Example 1 AT+WREGDOMAIN=? REG_DOMAIN=FCC Where possible values of REG_DOMAIN are FCC, ETSI, TELEC 7.1.2. Operation Mode Command Description This command is used to set the wireless mode and related parameters.
Page 39
WE310F5-X IP2WiFi Legacy AT Command Reference Guide Parameter Optional/Mandatory Value Description 100 to 1000 Time between two successive beacon beacon interval in LAP Unit: milliseconds frames transmitted by the Limited AP Optional mode Default value: 100ms mode. Beacon frames will contain SSID information.
WE310F5-X IP2WiFi Legacy AT Command Reference Guide Success <CR><LF>OK<CR><LF> <CR><LF>OK<CR><LF> All parameters are valid Failure <CR><LF>ERROR:<SP>INVALID<SP>INPUT <CR><LF>2<CR><LF> Parameters are invalid <CR><LF> or in incorrect format. Example 1 Configure device in STA mode AT+WM=0 Configure device in Limited-AP mode (default configuration)
WE310F5-X IP2WiFi Legacy AT Command Reference Guide Table 42: Set PHY Mode Synchronous Response. Responses Remarks Success ERROR:NOT SUPPORTED If parameters are not valid. 7.1.3.2. Get PHY Mode Command Description This command is used to get PHY mode. Command Syntax...
WE310F5-X IP2WiFi Legacy AT Command Reference Guide Command Syntax AT+WST=<Minimum scan time><Reserved><Max scan time><CR> Parameter Description Table 44: Set Scan Time Parameters. Parameter Optional/Mandatory Value Description 5-1200 Minimum amount of time, Minimum scan time Mandatory Default time = 200 Unit-...
WE310F5-X IP2WiFi Legacy AT Command Reference Guide 7.2.2. Security Configuration 7.2.2.1. Security Setting Command Description This command is used to configure the Telit node with different security configuration. Command Syntax AT+WSEC=n Parameter Description Table 47: Security Setting Parameters. Parameter Optional/Mandatory...
WE310F5-X IP2WiFi Legacy AT Command Reference Guide Example Telit node is configured with WEP shared security AT+WSEC=2 AT+WA=TelitDemo,,11 IP SubNet Gateway 192.168.1.99:255.255.255.0:192.168.1.1 7.2.2.2. WPA-PSK and WPA2-PSK Passphrase Command Description This command is used to set the WPA-PSK and WPA2-PSK passphrase. Upon receiving the command, the PSK passphrase is reset to the value provided.
To avoid recalculating this quantity every time the WE310F5-X node associates, the WE310F5-X node provides the capability to compute the PSK once and store the resulting value. The key value is stored in the SRAM copy of the current profile;...
OK response (0 in non-verbose). The current profile parameters PSK Valid, PSK-SSID, and WPA Passphrase are updated and can be queried with AT&V. The next time the WE310F5-X node Computing PSK from SSID and Passphrase associates to the given SSID, the PSK value is used without being recalculated.
WE310F5-X IP2WiFi Legacy AT Command Reference Guide Command Syntax AT+WPSK=<PSK> Parameter Description Table 53: WPA-PSK and WPA2-PSK Key Parameters. Parameter Optional/Mandatory Value Description Mandatory 32-byte key PSK is a 32-byte key, formatted as an ASCII hexadecimal number, and other length or format is considered invalid.
Page 48
WE310F5-X IP2WiFi Legacy AT Command Reference Guide Command Syntax AT+WS[=<SSID>[,<BSSID>][,<Channel>][,<Scan Time]] Parameter Description Table 55: Scanning Parameters. Parameter Optional/Mandatory Value Description SSID Optional A string containing ASCII characters between 1 and 32 (see SSID and Passphrase, page 24). When SSID is specified, the Telit node only scans the configured SSID.
WE310F5-X IP2WiFi Legacy AT Command Reference Guide 7.2.4. Association Command Description This command is used to create or join an infrastructure network (limited access point mode), and to create or join to an ad-hoc network. Command Syntax AT+WA=<SSID>[,[<BSSID>][,<Channel>],[RSSI Flag],[WPS Registrar],[Unscheduled automatic power save delivery...
Page 50
WE310F5-X IP2WiFi Legacy AT Command Reference Guide Note/Tip: Do not issue AT+WA command when Telit node is in Wireless direct (P2P) mode. To issue AT+WA command, switch the Telit node to either Station mode or Limited-AP mode using AT+WM command.
WE310F5-X IP2WiFi Legacy AT Command Reference Guide Synchronous Response Table 58: Association Synchronous Response. Responses Remarks IP SubNet Gateway IPaddress: Success SubNetaddress: Gateway address ERROR:INVALID INPUT If parameters are not valid. ERROR Reissue the AT+LOGLVL command to get more details about the kind of error.
WE310F5-X IP2WiFi Legacy AT Command Reference Guide 7.2.6. WLAN Keep Alive Interval Command Description This command is used to set the keep-alive interval for n seconds. This keep-alive timer will fire for every n seconds once the node is associated. This timer will try to keep the node in associated state even if there is no activity between AP and the node by sending a NULL frame.
WE310F5-X IP2WiFi Legacy AT Command Reference Guide 8. DATA TRANSFER Auto Mode 8.1.1. Enable Auto Connection Command Description This command is used to store configuration settings in non-volatile memory and modify according to the parameter value in the command; the resulting change (if any) takes effect on the next reboot.
Page 54
WE310F5-X IP2WiFi Legacy AT Command Reference Guide Parameter Description Table 65: Enable Multicast Reception Parameters. Parameter Optional/Mandatory Value Description Disable 802.11 MAC layer multicast + broadcast reception is disabled. Reception of all higher layer (IP and above) Mandatory multicast and broadcast packets are disabled by AT+MCSTSET=0 option.
Page 55
WE310F5-X IP2WiFi Legacy AT Command Reference Guide Example 2 Configuring Telit node as a UDP Client and Transmitting/ Receiving Multicast Packets Where - Destination address (Multicast): 224.0.0.0 Destination port: 3610 AT+WA=TelitDemo,,11 SubNet Gateway 192.168.1.99:255.255.255.0:192.168.1.1 AT+NDHCP=1 SubNet Gateway 192.168.23.101:255.255.255.0:192.168.23.1 AT+MCSTSET=1 AT+NCUDP=224.0.0.0,3610 CONNECT 0...
WE310F5-X IP2WiFi Legacy AT Command Reference Guide 9. POWER MANAGEMENT – RADIO AND SYSTEM Radio Receive Settings 9.1.1. Active Radio Receive Command Description This command is used to enable/disable the 802.11 radio receiver. This minimizes latency and ensures that packets are received at the cost of increased power consumption.
WE310F5-X IP2WiFi Legacy AT Command Reference Guide Example 2 Radio receiver is always on, Power Save mode is enabled but will not save power since the receiver is left on. AT+WRXACTIVE=1 AT+WRXPS=1 Example 3 The receiver is switched off. The node will not receive any packets at this time.
Page 58
WE310F5-X IP2WiFi Legacy AT Command Reference Guide Note/Tip: 1).NCM with PS-Poll is does not support web provisioning (web page related) features. Parameter Description Table 70: IEEE PSPoll Listen Interval Parameters. Parameter Optional/Mandatory Value Description Enable Mandatory Disable IEEE PS Enable IEEE PS (wakeupType tells...
Page 59
WE310F5-X IP2WiFi Legacy AT Command Reference Guide Example 3 AT+WIEEEPSPOLL This command can be used for three purposes: – To configure the Power Save behavior – To Enable the Power Save – To Disable the Power Save Configuration of Power Save To configure the Power Save behavior on the STA, the first parameter of the command should be 2.
WE310F5-X IP2WiFi Legacy AT Command Reference Guide Example 4 Whenever the STA is needed to wake up at some configured interval, the Custom Wake up option should be used. While configuring the custom wake up parameters, the listen interval should not be entered; the default listen interval will be used in the association request.
WE310F5-X IP2WiFi Legacy AT Command Reference Guide Parameter Description Table 71: Custom Power Save Radio Receive Parameters. Parameter Optional/Mandatory Value Description Mandatory Power Save mode is disabled 1 (default) Power Save mode is enabled Synchronous Response Table 72: Customer Power Save Radio Receive Synchronous Response.
Page 62
WE310F5-X IP2WiFi Legacy AT Command Reference Guide Usage When this command is issued, the TELIT node will enter the ultra-low-power Standby state (after the optional delay time if present), remaining there until x milliseconds have passed since the command was issued, or an enabled alarm input is received. Any current CIDs are lost on transition to Standby.
WE310F5-X IP2WiFi Legacy AT Command Reference Guide Parameter Description Table 73: Standby Parameters. Parameter Optional/Mandatory Value Description Mandatory =Standby time This is the Standby time in in milliseconds milliseconds. If a delay time is provided, the Standby count begins after the delay time has expired.
Page 64
WE310F5-X IP2WiFi Legacy AT Command Reference Guide Note/Tip: 1.) Other components external to the TELIT node may continue to dissipate power during this time, unless measures are taken to ensure that they are also off or disabled. 2.) Only Station Mode supports DeepSleep and Standby (AT+PSDSLEEP and AT+PSSTBY).
Page 65
WE310F5-X IP2WiFi Legacy AT Command Reference Guide Synchronous Response Table 76: Deep Sleep Synchronous Response. Responses Remarks Success ERROR:INVALID INPUT If parameters values are not valid. (Other than 0 and 1) 80664ST11079A Rev. 3 Page 65 of 79 2021-10-25 Not Subject to NDA...
WE310F5-X IP2WiFi Legacy AT Command Reference Guide 10. PRODUCTION AND DEBUG Debug 10.1.1. LogLevel Command Description This command is used to configure the debug level so that the response of a command will include more information (error reason) in case of an error.
WE310F5-X IP2WiFi Legacy AT Command Reference Guide Synchronous Response Table 78: Loglevel Synchronous Response. Responses Remarks Success ERROR Failure Example 1 AT+LOGLVL=1 AT+WA=TELITDEMO SSID NOT FOUND ERROR 10.1.2. Echo Command Description Note/Tip: This command is applicable for all the AT Commands, but not to their Responses.
WE310F5-X IP2WiFi Legacy AT Command Reference Guide Synchronous Response Table 80: Echo Synchronous Response. Responses Remarks Success ERROR: INVALID INPUT If parameters are not valid. 10.1.3. Verbose Command Description This command is used to enable or disable verbose mode for synchronous and asynchronous responses.
WE310F5-X IP2WiFi Legacy AT Command Reference Guide Synchronous Response Table 83: RSSI Synchronous Response. Responses Remarks RSSI Success Example AT+WRSSI=? 10.1.5. WLAN Status Command Description This command is used to retrieve information about the current wireless status. Command Syntax AT+WSTATUS Synchronous Response Table 84: WLAN Status Synchronous Response.
Page 70
WE310F5-X IP2WiFi Legacy AT Command Reference Guide MODE:0CHANNEL:11 SSID:”TelitDemo” BSSID:98:fc:11:4a:b8:56SECURITY:NONE 80664ST11079A Rev. 3 Page 70 of 79 2021-10-25 Not Subject to NDA...
Page 72
WE310F5-X IP2WiFi Legacy AT Command Reference Guide Out of Standby- \r\n\n\rOut of StandBy- <ESC>A514Out ofStandBy- \r\n12\r\n <ESC>A5015\r\n Alarm Alarm\r\n\r\n Alarm\r\n Out of Deep Sleep \r\n\r\nOut of Deep <ESC>A611Out of \r\n13\r\n <ESC>A6016\r\n Sleep\r\n\r\n DeepSleep\r\n Serial2WiFi APP \r\nSerial2WiFi APP\r\n <ESC>A90fSerial2WiFiAPP\ \r\n16\r\n <ESC>A9019\r\n...
WE310F5-X IP2WiFi Legacy AT Command Reference Guide 12. PRODUCT AND SAFETY INFORMATION Copyrights and Other Notices SPECIFICATIONS ARE SUBJECT TO CHANGE WITHOUT NOTICE Although reasonable efforts have been made to ensure the accuracy of this document, Telit assumes no liability resulting from any inaccuracies or omissions in this document, or from the use of the information contained herein.
WE310F5-X IP2WiFi Legacy AT Command Reference Guide Telit’s products described in this instruction manual shall not be copied (reverse engineered) or reproduced in any manner without the express written permission of the copyright owner, being Telit or the 3rd Party software supplier. Furthermore, the...
WE310F5-X IP2WiFi Legacy AT Command Reference Guide 12.2.5. Third Party Rights The software may include 3rd Party’s software Rights. In this case the user agrees to comply with all terms and conditions imposed in respect of such separate software rights. In addition to 3rd Party Terms, the disclaimer of warranty and limitation of liability provisions in this License, shall apply to the 3rd Party Rights software as well.
Page 76
WE310F5-X IP2WiFi Legacy AT Command Reference Guide • it can interfere with other electronic devices, particularly in environments such as hospitals, airports, aircrafts, etc. • there is a risk of explosion such as gasoline stations, oil refineries, etc. It is the responsibility of the user to enforce the country regulation and the specific environment regulation.
WE310F5-X IP2WiFi Legacy AT Command Reference Guide 13. GLOSSARY Table 87: Acronym List Acronym Definition Analog – Digital Converter Clock Complementary Metal – Oxide Semiconductor CMOS Chip Select Digital – Analog Converter Data Terminal Equipment Equivalent Series Resistance General Purpose Input Output...
Need help?
Do you have a question about the WE310F5-X and is the answer not in the manual?
Questions and answers