Telit Wireless Solutions WE310F5-X Reference Manual Download Page 18

Page: 18 / 79

                  WE310F5-X IP2WiFi Legacy AT Command Reference Guide

80664ST11079A Rev. 3

Page 18 of 79

2021-10-25

Not Subject to NDA

HOST INTERACTION

Interface

The embedded host uses one of the interfaces (UART/SPI/SDIO) to connect to the Serial-
to-WiFi Application.

5.1.1.

Hardware Flow Control

Command Description

This command is used to enable/disable hardware flow control for the UART interface.

Command Syntax

AT&Rn

Parameter Description

Table 8: Hardware Flow Control Parameters.

Parameter

Optional/Mandatory

Value

Description

Mandatory

0 (default)

Hardware flow control is
disabled.

Hardware flow control is
enabled.

Synchronous Response

Table 9: Hardware Flow Control Synchronous Response.

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.

Command Syntax

Summary of Contents for WE310F5-X

Page 1: ...1VV0301698 2021 01 Rev 0 Telit Technical Documentation WE310F5 X IP2WiFi Legacy Command Reference Guide 80664ST11079A Rev 3 2021 10 25...

Page 2: ...WE310F5 X IP2WiFi Legacy AT Command Reference Guide 80664ST11079A Rev 3 Page 2 of 79 2021 10 25 Not Subject to NDA APPLICABILITY TABLE PRODUCTS WE310F5 I WE310F5 P...

Page 3: ...s 9 2 1 1 AT Command Definitions 9 2 1 2 AT Command Syntax 10 3 GETTING STARTED 11 System Overview 11 Legacy Command Mode 11 4 ARCHITECTURE 12 Working Principle 12 System Initialization 12 Data Handli...

Page 4: ...Get System Time 25 Profile Setting 26 6 4 1 Get Profile 26 6 4 2 Save Profile 27 6 4 3 Load Profile 28 6 4 4 Select Default Profile 28 6 4 5 Define Profile 29 6 4 6 Restore Profile 30 6 4 7 Identifica...

Page 5: ...4 Association 49 7 2 5 Disassociation 51 7 2 6 WLAN Keep Alive Interval 52 8 DATA TRANSFER 53 Auto Mode 53 8 1 1 Enable Auto Connection 53 Enable Multicast Reception 53 9 POWER MANAGEMENT RADIO AND S...

Page 6: ...ages 71 12 PRODUCT AND SAFETY INFORMATION 73 Copyrights and Other Notices 73 12 1 1 Copyrights 73 12 1 2 Computer Software Copyrights 73 Usage and Disclosure Restrictions 74 12 2 1 License Agreements...

Page 7: ...eans of AT Commands Contact Information Support For general contact technical support services technical questions and report documentation errors contact Telit Technical Support at TS SRD telit com A...

Page 8: ...g 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 Related Documents Table 2 R...

Page 9: ...scription Square brackets Enclose optional parameters Choose none or select one or more an unlimited number of times each Do not enter brackets as part of any command parm1 parm2 parm3 Question mark U...

Page 10: ...followed by Telit implementation used in this document for software procedures that are explained using the AT command line interface Table 4 Command Syntax Convention Type Description command syntax...

Page 11: ...al 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 netw...

Page 12: ...s the module SW tries to fetch the configuration file also called as profile from the file system If the profile file is not found it sets the default values factory default values to profile and crea...

Page 13: ...are described in the following pages This encoding is used for both transmitted and received data The process of sending a data packet is depicted in the below figure The sequence ESC S or ESC U is se...

Page 14: ...d mode Any buffered data is sent before the connection is closed This can be issued from the serial host once the data transmissions start on a socket using ESC S CID sequence Success Indication ESC O...

Page 15: ...ing two additional CTS and RTS connections This feature prevents the UART hardware FIFO overflow on S2W Application due to high speed data transmission from to the S2W Application If hardware flow con...

Page 16: ...nd or channel for a specified scan time Scanning can be performed to find networks with a specific SSID networks operating on a specific radio channel or a combination of these constraints 4 5 2 Assoc...

Page 17: ...he first character of the SSID or Passphrase 4 If comma is a part of the SSID then SSID parameter needs to be framed with double quotation marks SS ID as shown below Table 7 SSID Parameter Expected SS...

Page 18: ...AT Rn Parameter Description Table 8 Hardware Flow Control Parameters Parameter Optional Mandatory Value Description n Mandatory 0 default Hardware flow control is disabled 1 Hardware flow control is...

Page 19: ...Reference Guide 80664ST11079A Rev 3 Page 19 of 79 2021 10 25 Not Subject to NDA Synchronous Response Table 10 Interface Verification Synchronous Response Responses Remarks OK Success No response Failu...

Page 20: ...ERSION 7 0 0 S2W WLAN VERSION 7 0 0 OK The command to get more details of the S2W version AT VER This command returns more information along with the above response of the S2W binary followed by the s...

Page 21: ...D 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...

Page 22: ...Current Command Mode Status Responses Remarks YLC mode OK It specifies the current command mode Success ERROR INVALID INPUT If parameters are not valid Other than 0 and 1 Example AT YLC YLC 0 OK 6 2 2...

Page 23: ...Command Mode Synchronous Response Responses Remarks OK Success ERROR INVALID INPUT If parameters are not valid Other than 0 and 1 6 2 3 Boot Reason Command Description This command identifies the reas...

Page 24: ...TIME dd mm yyyy HH MM SS System time in milliseconds since epoch 1970 Note Tip This command does not take care of the day light savings The reference will be with respect to UTC GMT Parameter Descript...

Page 25: ...response to the serial interface Command Syntax AT GETIME Note Tip By default the command mode is set to New AT command mode Synchronous Response Table 18 Get System Time Synchronous Response Respons...

Page 26: ...factory Reset 6 4 1 Get Profile Command Description This command is used to get the information of current profiles Profile 0 and Profile 1 and their saved parameter values in ASCII format The details...

Page 27: ...ETRY 5 WP 0 WRXPS 1 WRXACTIVE 0 NAUTO 0 1 192 168 1 1 8 WAUTH 0 WWPA Serial2Wifi PSK valid 0 SSID WWEP1 1234567890 WWEP2 WWEP3 WWEP4 S0 01000 S1 00500 S2 00500 S3 00003 S4 00010 S5 00150 S6 00050 S7 0...

Page 28: ...ritten by those stored in non volatile memory under the specified profile Command Syntax ATZn Parameter Description Table 22 Load Profile Parameters Parameter Optional Mandatory Value Description n Ma...

Page 29: ...r values that define the behavior of the Telit node are grouped into Profiles These profiles are stored in non volatile memory when not in use The default configuration supports single Profile The con...

Page 30: ...t Gateway Address Valid IP address DNS1 Valid DNS1 IP address DNS Address 72 DNS2 Valid DNS2 IP address UART Configuration Echo Mode Enabled Disabled Echo 67 Verbose Mode Enabled Disabled Verbose 68 H...

Page 31: ...scription Table 28 Identification Information Parameters Parameter Optional Mandatory Value Description n Mandatory 0 OEM identification 1 Hardware version 2 Software version n is the information ID t...

Page 32: ...ESSAGE ESC Escape TYPE Type of message and the length is one byte For asynchronous message it is 0x41 ASCII value A SUBTYPE Message subtype and the length of this field is One byte when the value of t...

Page 33: ...and 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 Command Syntax AT RESET Note Tip This command without paramet...

Page 34: ...mode andtheotherwhenitisinAPmode The MAC address printed on the Telit node is for STA mode STA MAC address 1 is the MAC address for AP mode 2 To get the current MAC address for the Telit node in STA m...

Page 35: ...ponse Parameter Description Table 34 Package Version Response Parameters Parameter Range Type Description Module Version 20 25 String It specifies the current Wi Fi software version of the module Mode...

Page 36: ...IP2WiFi Legacy AT Command Reference Guide 80664ST11079A Rev 3 Page 36 of 79 2021 10 25 Not Subject to NDA Example 1 AT SWPKGV 39 00 000 B005 P0G 000000 M0G 000003 P0G 000000 A0G 000002 R0G 060203 B0G...

Page 37: ...gulatory Domain Supported Channels Desired Power Level Regulatory Domain Mandatory Internal PA 0 as default Internal PA 2 as default 0 default FCC 1 to 11 0 7 2 15 1 ETSI 1 to 13 0 7 4 15 2 TELEC 1 to...

Page 38: ...LAP mode inactivity timeout in LAP mode reserved rate adaptation device type rate adaptation minimum application throughput CR Note Tip Do not issue AT WA command when Telit node is in WiFi direct P2...

Page 39: ...to configure this value as small as possible inactivity time out in LAP mode Optional Minimum value 60 Maximum value 65000 Default value 60 Unit seconds This value specifies the inactivity time out pe...

Page 40: ...with following configuration AT WM 2 16 1 1 5 Number of stations allowed to associate in Limited AP mode 16 DTIM period in LAP mode 1 Device type Line powered Minimum application throughput 5mbps Con...

Page 41: ...de Synchronous Response Responses Remarks Mode Value OK Success Note where mode is 0 1 6 Example 1 AT WPHYMODE 2 OK Station AP Mode 7 2 1 Scan Time Settings 7 2 1 1 Set Scan Time Command Description T...

Page 42: ...ronous Response Table 45 Set Scan Time Synchronous Response Events Verbose Mode Non Verbose Mode Remarks Success CR LF OK CR LF CR LF 0 CR LF Parameters are valid Failure CR LF ERROR SP INVAL ID SP IN...

Page 43: ...ise Not Supported 32 WPA2 Enterprise Not Supported 64 WPA2 AES TKIP security Not Supported Note 1 In AP mode only Open and WPA AES as security mechanism is supported 2 Enterprise security is supported...

Page 44: ...PAPSK command instead of the following command See WPA PSK and WPA2 PSK Key Calculation Command Syntax AT WWPA passphrase Parameter Description Table 49 WPA PSK and WPA2 PSK Passphrase Parameters Para...

Page 45: ...me 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 the pr...

Page 46: ...that the profile containing the new PSK is the default profile should be issued The PSK will then be available when the WE310F5 X node awakens from Standby mode See Select Default Profile page 39 for...

Page 47: ...lt profile should be issued The PSK will then be available when the Telit node awakens from Standby ERROR INVALID INPUT Invalid PSK if PSK is not 32 bytes Example AT WPSK 00010203040506070809000102030...

Page 48: ...50 default It specifies the default scan time that the node uses The default scan time can be overridden by issuing AT WST command see Set Scan Time page 53 Configuring scan time using this parameter...

Page 49: ...age The following is the behavior of the command in different modes 1 In STA mode i e AT WM 0 see Operation Mode page 46 The node will attempt to associate with the requested network If the requested...

Page 50: ...same as the modules MAC address In Ad hoc mode it is the BSSID of the network element to which the module will join or it is the BSSIC of the network creator Channel Optional Depends on the value of A...

Page 51: ...RROR IP CONFIG FAIL If DHCP fails in infrastructure mode Example AT WA TelitDemo 11 IPSubNetGateway 192 168 1 99 255 255 255 0 192 168 1 1 OK 7 2 5 Disassociation Command Description This command is u...

Page 52: ...vity between AP and the node by sending a NULL frame Command Syntax AT WKEEPALIVE Interval Type Parameter Description Table 61 WLAN Keep Alive Interval Parameters Parameter Optional Mandatory Value De...

Page 53: ...boot Command Syntax ATCn Parameter Description Table 63 Enable Auto Connection Parameters Parameter Optional Mandatory Value Description n Mandatory 0 1 0 Disable 1 Enable n is 0 to disable auto conne...

Page 54: ...e Synchronous Response Table 66 Enable Multicast Reception Synchronous Response Responses Remarks OK Success ERROR INVALID INPUT If parameters are not valid If n value is other than 0 or 1 Example 1 T...

Page 55: ...11 IP SubNet Gateway 192 168 1 99 255 255 255 0 192 168 1 1 OK AT NDHCP 1 IP SubNet Gateway 192 168 23 101 255 255 255 0 192 168 23 1 OK AT MCSTSET 1 OK AT NCUDP 224 0 0 0 3610 CONNECT 0 OK Example 3...

Page 56: ...7 can be enabled but will not save power since the receiver is left on Command Syntax AT WRXACTIVE n Parameter Description Table 68 Active Radio Receive Parameters Parameter Optional Mandatory Value D...

Page 57: ...d is issued once to configure the mode DTIM based wakeup Listen interval based wake up or Custom wake up and then to enable the configuration in commands issued when configured for listen interval bas...

Page 58: ...N A Reserved for future use DataRxType Not Supported N A Reserved for future use ActiveToOffTimeout Not Supported N A Time to be in active radio state if DataRxType is switched to active mode Time is...

Page 59: ...A will wake up for every 10 beacons Wake up for DTIM To configure the STA to wake up for every DTIM interval the command is AT WIEEEPSPOLL 2 0 Here we did not specify the listen interval as that will...

Page 60: ...e buffered frames in case the PS Poll request from the STA does not reach the AP Enable Power Save To enable the power save on the STA the command is AT WIEEEPSPOLL 1 Whenever AT WIEEEPSPOLL is given...

Page 61: ...Access Point that it will go to sleep and the Access Point will buffer any packets addresses to that node The node will awaken to listen to periodic beacons from the Access Point that contains a Traf...

Page 62: ...eeded from the interface until the requested time has passed or provide an alarm input to awaken the module when needed The alarm should trigger about 10 msec prior to issuance of any serial commands...

Page 63: ...and waken the TELIT node from Standby A value of 0 specifies a high to low transition as active a value of 1 specifies low to high ALARM2 POL Not Supported 1 low to high This is the polarity of the tr...

Page 64: ...code to the serial interface The S2W application sends the message Out of Deep Sleep along with the standard response once it comes out from deep sleep A similar command can be used to enable the dee...

Page 65: ...rence Guide 80664ST11079A Rev 3 Page 65 of 79 2021 10 25 Not Subject to NDA Synchronous Response Table 76 Deep Sleep Synchronous Response Responses Remarks OK Success ERROR INVALID INPUT If parameters...

Page 66: ...Syntax AT LOGLVL level Command Note This command can also be used for domain check as well Parameter Description Table 77 Loglevel Parameters Parameter Optional Mandatory Value Description level Mand...

Page 67: ...s command is used to enable or disable the echo back to host MCU Command Syntax ATEn Parameter Description Table 79 Echo Parameters Parameter Optional Mandatory Value Description level NA 0 Disabled 1...

Page 68: ...er Optional Mandatory Value Description n NA 0 Verbose response is disabled the status response is in the form of numerical codes For more information about the numerical codes when Verbose is disable...

Page 69: ...tatus Command Syntax AT WSTATUS Synchronous Response Table 84 WLAN Status Synchronous Response Responses Remarks MODE mode CHANNEL channel SSID ssid BSSID bssid SECURITY security OK Success The Telit...

Page 70: ...WE310F5 X IP2WiFi Legacy AT Command Reference Guide 80664ST11079A Rev 3 Page 70 of 79 2021 10 25 Not Subject to NDA MODE 0CHANNEL 11 SSID TelitDemo BSSID 98 fc 11 4a b8 56SECURITY NONE OK...

Page 71: ...fully S2W_LINK_LOST r nDISASSOCIATED r n r n9 r n Telit node is not associated to a wireless network MCU sends NSTCP UDP or AT NCTCP UDP Asynchronous Enhanced Asynchronous Messages Asynchronous messag...

Page 72: ...ESC A5015 r n Out of Deep Sleep r n r nOut of Deep Sleep r n r n ESC A611Outof DeepSleep r n r n13 r n ESC A6016 r n Serial2WiFi APP r nSerial2WiFi APP r n ESC A90fSerial2WiFiAPP r n r n16 r n ESC A9...

Page 73: ...services in your country 12 1 1 Copyrights This instruction manual and the Telit products described herein may include or describe Telit s copyrighted material such as computer programs stored in semi...

Page 74: ...agreement 12 2 2 Copyrighted Materials The Software and the documentation are copyrighted materials Making unauthorized copies is prohibited by the law The software or the documentation shall not be...

Page 75: ...OUT LIMITATION LOST OF 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 CODES OR THE EXERCISE OF ANY RIG...

Page 76: ...ing mode The system integrator is responsible for the functioning of the final product Therefore the external components of the module as well as any project or installation issue have to be handled w...

Page 77: ...peed HSDPA High Speed Downlink Packet Access HSIC High Speed Inter Chip HSUPA High Speed Uplink Packet Access I O Input Output MISO Master Input Slave Output MOSI Master Output Slave Input MRDY Master...

Page 78: ...ENTINFO AT WRETRY AT WAUTO Addition of AT SWPKGV AT PSSTBY ATCn AT ASYNCMSGFMT AT YBR AT PSDPSLEEP AT NMAC AT MCSTSET Updated Get Current Command Mode Status Switch Between Legacy and New AT Command U...

Page 79: ...1VV0301698 2021 01 Rev 0 Telit Technical Documentation...

Search results

Summary of Contents for WE310F5-X

Reviews:

Related manuals for WE310F5-X

Brands by name

Popular brands

Telit Wireless Solutions WE310F5-X, Reference Manual

Search results

Summary of Contents for WE310F5-X

Reviews:

Related manuals for WE310F5-X

Brands by name

Popular brands