background image

GS2101M IP2WiFi Adapter Command Reference Guide

1VV0301499

 Rev. 2.0

 4

  2019-08-05

APPLICABILITY TABLE

PRODUCT

GS2101M

Software Release

5.8.0

Summary of Contents for GS2101M Series

Page 1: ...GS2101M IP2WiFi Adapter Command Reference Guide 1VV0301499 Rev 2 0 2019 08 05...

Page 2: ...ights 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 Teli...

Page 3: ...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 softw...

Page 4: ...GS2101M IP2WiFi Adapter Command Reference Guide 1VV0301499 Rev 2 0 4 2019 08 05 APPLICABILITY TABLE PRODUCT GS2101M Software Release 5 8 0...

Page 5: ...ion 31 3 1 Startup Handling 32 3 1 1 Single Interface Startup Handling 32 3 1 2 Dual Interface Startup Handling 33 3 2 Interface 33 3 2 1 UART 33 3 2 1 1 UART Parameters 33 3 2 1 2 Software Flow Contr...

Page 6: ...raceful Shutdown of WLAN 88 5 1 8 SSID Hide 89 5 2 Beacon Mode Unassociated Mode 90 5 2 1 Unassociated Unsolicited Tx 90 5 2 2 Unassociated Unsolicited Rx 96 5 2 2 1 Examples for Unassociated Unsolici...

Page 7: ...146 6 2 4 Battery Check Stop 147 6 2 5 Battery Value Get 147 6 3 System Power Save 148 6 3 1 Hibernate 148 6 3 2 Standby 149 6 3 2 1 Putting the System in Standby 149 6 3 2 2 Enabling Standby Mode Bet...

Page 8: ...Calibration 179 8 2 4 For Complete Sequence of Live Calibration 181 8 3 Debug 181 8 3 1 Log Level 181 8 3 2 Echo 182 8 3 3 Verbose 183 8 3 4 RSSI 184 8 3 5 WLAN Status 184 8 3 6 WLAN Statistics 185 A...

Page 9: ...ences page 14 Contact Information Support page 15 Returning Products to Telit page 16 Accessing the Telit Wi Fi Portal page 16 Revision History This revision history of the GainSpan IP to WiFi Adapter...

Page 10: ...tion 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...

Page 11: ...n Separates the variable from explanatory text 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 a...

Page 12: ...standing a feature or references to material not available in the manual Alert Alerts you of potential damage to a program device or system or the loss of data or service Caution Cautions you about a...

Page 13: ...Hardware User Guide Provides instructions on how to setup and use the GS2000 based module evaluation board along with component description jumper settings board specifications and pinouts 1VV0301395...

Page 14: ...applicable Software release version if applicable References The references listed in Table 5 page 14 are available on the Telit Wi Fi Portal Refer to Accessing the Telit Wi Fi Portal page 16 for det...

Page 15: ...t among other things wherever applicable Alternatively for more Technical Support information or assistance perform the following steps 1 Visit https www telit com go to Products Wi Fi and Blue tooth...

Page 16: ...urn of the components 5 Pack the component for shipment Guidelines for Packing Components for Shipment To pack and ship individual components When you return components make sure they are adequately p...

Page 17: ...ious features within the Telit Wi Fi Portal 5 Click the Agreements tab to download and upload the SLA for ADK and SDK respectively 6 Click on the Documents tab to search download and print product doc...

Page 18: ...on and WLAN firmware For Application firmware it contains information about MAC address regularity information module related information and so on For WLAN firmware it contains information about cali...

Page 19: ...eral power save and security related commands as required Start connection to an Access Point or do provisioning as required Obtain IP Address and Start Data Transfer Select advanced services if any 4...

Page 20: ...P to WiFi Hosted under the SDK Builder Configuration screen displays the module information that includes the module selected firmware version application SRAM APP WLAN RTC and Flash Internal External...

Page 21: ...tting Once you have completed selecting the options and features for building the IP to WiFi Hosted firmware click the Next button or select the Summary tab The Build Configuration Summary screen disp...

Page 22: ...rk Management page 29 2 1 Overview Figure 1 page 22 shows the overall architecture of the IP to WiFi IP2WiFi interface Transmit Tx and Receive Rx Data Handlers pass messages to and from the WiFi inter...

Page 23: ...he User can establish a data connection here and send data In data processing mode data can be sent to or received from the host For each mode configuration parameters are stored in non volatile memor...

Page 24: ...SPI SPI Mode 0 CPL 0 CPH 0 Any changes to this configuration that were made in a previous session using the ATB command see 3 2 1 1 UART Parameters page 33 will be lost when power is lost To make cha...

Page 25: ...d with a carriage return CR or line feed LF Each response is started with a carriage return CR and line feed LF with the exception of the responses to the following commands The response to the follow...

Page 26: ...owing pages This encoding is used for both transmitted and received data ESC R Length Ethernet package Where the Ethernet Packet is DstAddr SrcAddr EtherType Payload The contents of are byte or byte s...

Page 27: ...s a possibility for the receiving wireless buffers to be full on the GS node side and the GS node might drop the data If software flow control is enabled then the interface sends an XOFF character to...

Page 28: ...n data mode The auto connection mode processor for data transfer in auto connection mode Then Data is transferred on the serial port from The command processor in order to output responses to commands...

Page 29: ...e configured authentication mode AT WAUTH see 5 3 8 Advanced Commands page 118 for more information Associate to the AP AT WA see 5 3 5 Association page 113 Perform security negotiation if required Ch...

Page 30: ...d and Input SSID Expected SSID Input SSID Remarks TEST TEST Valid satisfies rule 2 TEST TEST Valid satisfies rule 2 TE ST TE ST Valid satisfies rule 3 TE ST TE ST Invalid breaks rule 3 TE ST TE ST Val...

Page 31: ...erface It supports to use a combination of two interfaces to communicate with Host One interface Command interface is used for AT command response and the other interface Data interface is used for da...

Page 32: ...r transmission at the GS node s SPI interface In case of SPI Byte Stuffing Host MCU repeatedly transmit s idle characters F5 over the SPI line and reads the characters transmitted by GS node r nIP2WiF...

Page 33: ...nIP2Wifi r n message through Command UART interface to the host after power cycle and sends DataInterfaceReady r n message on Data interface 3 Command UART interface does not accept any AT commands un...

Page 34: ...o prevent data loss and data corruption 3 Software flow control needs to be used for ASCII data transfer up to 115200 baud rate 4 Hardware flow control needs to be used for ASCII data transfer beyond...

Page 35: ...are Flow Control parameters Synchronous Response Table 13 page 35 describes the synchronous responses and remarks for the Software Flow Control command Table 12 Software Flow Control Parameters Parame...

Page 36: ...are Flow Control parameters Synchronous Response Table 15 page 36 describes the synchronous responses and remarks for the Hardware Flow Control command Table 14 Hardware Flow Control Parameters Parame...

Page 37: ...ameters take effect after node reset restart However they are stored in RAM and will be lost when power is lost unless they are saved to a profile using AT W see 4 3 2 Save Profile page 65 The profile...

Page 38: ...is incorporated SPI transmit data handling procedure The SPI data transfer layer makes use of an octet or byte stuffing procedure The Control Escape octet is defined as binary 11111011 hexadecimal 0xF...

Page 39: ...rk then XOFF character will be sent out informing the host to stop transmitting actual data After receiving XOFF character host must stop transmitting actual data and can send IDLE bytes until the XON...

Page 40: ...sing Interrupt based methodology Transferring Data from MCU to GS Node 1 MCU sends first four bytes of WRITE_REQUEST to GS node It waits for minimum of 3 2 microseconds and rearms the interrupt handle...

Page 41: ...done by tasks who have a higher priority than the application receive task which makes the GPIO37 high when there is data to be sent to MCU While the interrupts are disabled a thread switch can only h...

Page 42: ...receive the WRITE_RESPONSE 7 MCU parses the WRITE_RESPONSE if it is WRITE_RESPONSE_OK it learns the amount of data that can be received by GS node and provides eight bytes of Data header to GS node 8...

Page 43: ...re put in PING Tx buffer Figure 4 page 43 shows the timing diagram from step 4 to step 8 Figure 4 Transferring data from MCU to GS node Contd The following section provides steps involved while transf...

Page 44: ...e operation after issuing a READ_REQUEST or WRITE_REQUEST The data length value in the DATA_HEADER should always be identical to the data length value in the respective READ_RESPONSE or WRITE_RESPONSE...

Page 45: ...en GS node receives the WRITE_REQUEST it pulls GPIO37 LOW to avoid the race condition when GPIO37 is high and HOST MCU wants to write some data to GS node and then processes WRITE_REQUEST It creates W...

Page 46: ...from GS2000 and a If GPIO is LOW will stop the clock b If GPIO is HIGH will start the procedure for READ once it is ready to receive The following section provides steps involved while transferring d...

Page 47: ...bytes of Data header and actual data If it is READ_RESPONSE_NOK then there is no actual data to be sent to MCU 7 GS node pulls down the GPIO37 to LOW after sending READ_RESPONSE and DATA_HEADER This...

Page 48: ...TE When the size of data is less than 1024 bytes the time GPIO37 takes to become low after step 6 is 16 clock cycles READ RESPONSE Data Header When the size of data is more than 1024 bytes the wait cy...

Page 49: ...11 12 13 14 15 16 WRITE_REQUEST from HOST DATA HOST CLOCK CMD PHASE RESPONSE PHASE DATA PHASE WRITE_RESPONSE DATA_HEADER GPIO goes LOW after 16 X bytes when MCU sending more than 1024bytes to GS Wher...

Page 50: ...nt problems when waiting for the start element However no provisions are made to ensure that the subsequent data stream does not contain a byte with value 0xA5 so it is possible for the driver to mist...

Page 51: ...the HI Frame Response from GS node Figure 10 HI Frame Response from GS Node Table 21 page 52 shows the HI Frame Response from GS node Table 20 HI Parameters Service Class Identifiers Identifiers Desc...

Page 52: ...U side 0x14 READ_RESPONSE_NOK to MCU side 0x15 DATA to MCU side Reserved 0x00 Additional Info 0x00 0x00 0x00 0x01 Pending Data for transfer from GS2000 to MCU Length 0 No Data CheckSum A single checks...

Page 53: ...imum clock supported is 33Mhz 4 Support for Direct read write IO52 and Extended read write IO53 operations 5 IO Signals SDIO_CLK Clock SDIO_CMD Command line SDIO_DAT0 is used for data transfer and bus...

Page 54: ...step 2 occurs perform the following Refer function io_sd_mount Set the clock frequency low speed 400KHz for card identification Wait for card wake up 100 msec 500msec 1sec Send CMD52 to do a card res...

Page 55: ...ues of SDIO CCR registers before and after initialization for reference Table 23 DIO CCR registers before and after initialization S No Address Name Value Before Value After 1 0x00 CCCR SDIO Version 0...

Page 56: ...ion 1 address 0x04 using CMD52 Re Check Interrupt Pending register to make sure interrupt has been cleared Read Interrupt Pending register function 0 address 0x05 If value is 0x00 it means there is no...

Page 57: ...restoring the SDIO connection between Host MCU and GS node 3 2 3 3 7 SDIO_Busy Signal Handling When SDIO buffer on GS node is full it cannot receive more data from Host MCU In such cases SDIO Slave o...

Page 58: ...r 3 Host reads the data length registers 4 Host reads number of bytes specified by the data length registers 5 After this point DATA_1 goes high 6 Host enables the interrupt again 7 If GS node has mor...

Page 59: ...SPI0_CLK IN SDIO Clock SPI0 Clock GPIO_34 SDIO_CMD SPI0_DIN IN SD4 bit mode command line SD1 bit mode command line SPI mode Data input GPIO_37 SDIO_DAT1_INT IN OUT SD4 bit mode Data line 1 Interrupt...

Page 60: ...P to WiFi version GainSpan Embedded Platform Software version WLAN firmware version Example 1 AT VER IP2WiFi APP VERSION 5 1 4 IP2WiFi GEPS VERSION 5 1 4 IP2WiFi WLAN VERSION 5 1 4 OK The command to g...

Page 61: ...firmware extension version Module flash ID with storage capacity Example 2 AT VER IP2WiFi APP VERSION 5 1 4 IP2WiFi GEPS VERSION 5 1 4 IP2WiFi WLAN VERSION 5 1 4 IP2WiFi BIN TYPE 5_1_4_Unsolicited_Tx...

Page 62: ...ameters Synchronous Response Table 27 page 62 describes the synchronous responses and remarks for the Set System Time command Example 1 AT SETTIME 02 06 2016 15 00 00 OK Example 2 AT SETTIME 149378867...

Page 63: ...onses and remarks for the Get System Time command Example 1 AT GETTIME 2 6 2016 15 0 7 1464879607040 OK Example 2 Serial2WiFi APP AT TCERTADD SSL_comodo 0 1500 1 OK OK AT CERTINFOGET SSL_comodo ERROR...

Page 64: ...ing a profile AT V To view the current profile AT W To write to profile settings ATZn To load a profile AT Y To reboot with particular profile AT F To factory Reset 4 3 1 Get Profile This command is u...

Page 65: ...e issued using the same profile number selected here Command Syntax AT Wn Parameter Description Table 30 page 65 describes the Save Profile parameters Synchronous Response Table 31 page 65 describes t...

Page 66: ...n Parameter Description Table 32 page 66 describes the Load Profile parameters Synchronous Response Table 33 page 66 describes the synchronous responses and remarks for the Load Profile command Table...

Page 67: ...le 34 page 67 describes the Select Default Profile parameters Synchronous Response Table 35 page 67 describes the synchronous responses and remarks for the Select Default Profile command Example AT Y0...

Page 68: ...file command 4 3 6 Define Profile The configuration parameter values that define the behavior of the GS node are grouped into Profiles These profiles are stored in non volatile memory when not in use...

Page 69: ...ion 5 3 8 Advanced Commands page 118 WPA Pass Phrase 5 3 3 4 WPA PSK and WPA2 PSK Passphrase page 107 UART Configuration Echo Mode Enabled Disabled 8 3 2 Echo page 182 Verbose Mode Enabled Disabled 8...

Page 70: ...Table 38 Identification Information Parameters Parameter Optional Mandatory Value Description n Mandatory 0 OEM identification 1 Hardware version 2 Software version n is the information ID to obtain...

Page 71: ...ous message transfer IP2WiFi Application makes the GPIO9 high Node Start Up Handling Format The asynchronous message format is as shown ESC TYPE SUBTYPE LENGTH MESSAGE ESC Escape TYPE Type of message...

Page 72: ...T RESET Command Syntax AT RESET n Parameter Description Table 42 page 72 describes the Reset parameters NOTE This command without parameter AT RESET is obsolete and it is retained for backward compati...

Page 73: ...Set MAC Address parameters Synchronous Response NOTE This command is obsolete as GS node uses the MAC address from OTP It is retained for backward compatibility NOTE 1 The GS node is stored with two...

Page 74: ...WM 0 OK AT NMAC 00 1d c9 d0 70 cc OK AT NMAC 00 1d c9 d0 70 cc OK Example 2 To set the MAC address for the GS node in AP mode execute the following sequence of commands AT WM 2 OK AT NMAC 00 1d c9 d0...

Page 75: ...70 cc OK Example 2 To get the current MAC address for the GS node in AP mode execute the following sequence of commands AT WM 2 OK AT NMAC 00 1d c9 d0 70 cc OK NOTE 1 The GS node is stored with two MA...

Page 76: ...gulatory Domain 5 1 1 1 Set Regulatory Domain This command is used to configure the GS node s parameters to the requested regulatory domain Command Syntax AT WREGDOMAIN Regulartory Domain Parameter De...

Page 77: ...and remarks for the Get Regulatory Domain command Example AT WREGDOMAIN REG_DOMAIN FCC OK Table 46 Set Regulatory Domain Parameters Parameter Optional Mandatory Value Regulatory Domain Supported Chan...

Page 78: ...terval in LAP mode broadcast ssid in LAP mode no of stations allowed in LAP mode DTIM period in LAP mode inactivity timeout in LAP mode reserved rate adaptation device type rate adaptation minimum app...

Page 79: ...dcast SSID in LAP mode Optional 0 1 0 Enable 1 Disable Default value 0 0 Beacon frames will contain SSID information 1 Beacon frames will not contain SSID information stealth mode It specifies whether...

Page 80: ...fine tuning the chosen rate adaptation The rate adaptation algorithm depends on the following application profiles Ultra low power profile This profile concentrates on saving power as it uses battery...

Page 81: ...used to set the current retry count set to the supplied value Command Syntax AT WRETRY n Parameter Description Table 51 page 81 describes the Set Retry Count parameters Table 50 Mode Synchronous Respo...

Page 82: ...nous Response Table 52 page 82 describes the synchronous responses and remarks for the Set Retry Count command Example AT WRETRY 5 OK Table 52 Set Retry Count Synchronous Responses Responses Remarks O...

Page 83: ...Interval command Asynchronous Response Table 55 page 84 describes the asynchronous responses and remarks for the Sync Loss Interval command Table 53 Sync Loss Interval Parameters Parameter Optional Ma...

Page 84: ...le 55 Sync Loss Interval Asynchronous Responses Responses Remarks 314Disassociation Event Where Subtype 3 Length 14 ASCII equivalent decimal is 20 characters i e length of the actual message Actual me...

Page 85: ...u want to set the transmission rate to 11Mbps then you will need to give the value as 22 Example AT WRATE 22 Parameter Description Table 58 page 86 describes the Set Transmit Rate parameters Table 57...

Page 86: ...maining parameters Transmit rate of management frame and Transmit rate of control frame 4 2 MBPS 11 5 5 MBPS 13 6 5 MBPS 12 6 MBPS 18 9 MBPS 22 11 MBPS 24 12 MBPS 36 18 MBPS 39 19 5 MBPS 48 24 MBPS 52...

Page 87: ...onse Table 60 page 87 describes the synchronous responses and remarks for the Get Transmit Rate command Example AT WRATE 0 OK Table 59 Set Transmit Rate Synchronous Responses Responses Remarks OK Succ...

Page 88: ...osing calibration data and other WLAN related data stored in RAM or RTC memory It also needs to be used before hibernate mode or system reset Command Syntax AT PWRDOWN Synchronous Response Table 61 pa...

Page 89: ...ks for SSID Hide command Example N A Table 62 SSID Hide Parameters Parameter Optional Mandatory Value Description n Mandatory 0 to 2 Default value N A This parameter specifies the status of the hidden...

Page 90: ...e issued before sending unsolicited data through the GS node The format of an unsolicited data frame is ESC D d Payload The Payload contents are byte or byte stream Command Syntax AT UNSOLICITEDTX Fra...

Page 91: ...ad The maximum size of the frame is limited to 1400 bytes Reception wait time Mandatory 0 4294967295 Unit milliseconds 0 The receiver does not wait for any frames 4294967295 The receiver is switched o...

Page 92: ...Non directed control frames 1073741824 Enable duplicate frame reception 2147483648 Pass data to application with MAC headers It specifies the type of the frame to be received Enable Disable IE filter...

Page 93: ...Tx command Example 1 Table 67 page 94provides the examples for Unassociated unsolicited Tx Table 65 Transmission Rate and input value range for Power Transmission Rate Input Value Range for Power 1 1...

Page 94: ...1 1 5 0 00 1d c9 aa bb dd 00 0100 Probe request AT UNSOLICITEDTX 64 0 1 2 1 1 5 0 00 1d c9 aa bb dd 00 0101 Probe response AT UNSOLICITEDTX 80 0 1 2 1 1 5 0 00 1d c9 aa bb dd 00 1000 Beacon AT UNSOLIC...

Page 95: ...Example 4 For sending Data frame where sequence number is 973 and fragment number is 0 in Sequence Control field The hex value for the Sequence Control field 0x3cd0 The decimal value for the Sequence...

Page 96: ...cited Rx Parameters Parameter Optional Mandatory Value Description Frame type Mandatory Types of frames 1 Beacon frame 2 Probe request frame 4 Probe response frame 8 Multi cast data frame 16 Unicast d...

Page 97: ...frames Mandatory 1 or 0 1 Enable IE based filtering 0 Disable IE based filtering It is used to enable or disable IE filter for reception frames based on the frame IDs configured in Reception IE ID pa...

Page 98: ...types Data with MAC header Data which is received as it is at the MAC layer without changing its format Data with Ethernet header MAC header is removed from the received data and Ethernet header is a...

Page 99: ...ed to enable or disable encryption in unassociated unsolicited mode Command Syntax AT UAMENC Enable Disable Encryption Type Encryption Key IE ID Parameter Description Table 69 page 99 describes the Un...

Page 100: ...rks for the Set Scan Time command Example AT WST 150 150 OK Table 70 Set Scan Time Parameters Parameter Optional Mandatory Value milliseconds Description Minimum scan time Mandatory 5 1200 150 default...

Page 101: ...e Table 72 page 101 describes the synchronous responses and remarks for the Get Scan Time command Example AT WST MinScanTime 150 MaxScanTime 150 Table 72 Get Scan Time Synchronous Responses Responses...

Page 102: ...for the WiFi Security Configuration Authentication Mode command Example AT WAUTH 0 OK Table 73 WiFi Security Configuration Authentication Mode Parameter Optional Mandatory Value Mode Description n Man...

Page 103: ...trict security compliance is not applicable for WPS feature 1 Open security 2 WEP security 4 WPA PSK security TKIP only 8 WPA2 PSK security AES only 16 WPA Enterprise 32 WPA2 Enterprise 64 WPA2 AES TK...

Page 104: ...d Command Syntax AT WWEPn key Parameter Description Table 77 page 104 describes the WEP Keys parameters Table 76 Security Configuration Synchronous Responses Responses Remarks OK Success ERROR INVALID...

Page 105: ...ed AT WRXACTIVE 1 OK AT WM 2 OK AT WAUTH 2 OK AT WSEC 2 OK AT WWEP1 1234567890 OK AT WA GainSpanAP 6 OK 5 3 3 3 WEP Key Type Configuration This command is used to configure ASCII or HEX values as inpu...

Page 106: ...eter Optional Mandatory Value Description enable ASCII Mandatory 1 This parameter value enables ASCII mode where the WEP key entered through the AT WWEPn key command are characters whose ASCII value g...

Page 107: ...AT WWPA test12345 OK AT WA GainSpanDemo 11 OK NOTE It is recommended to use AT WPAPSK command instead of the following command See 5 3 3 5 WPA PSK and WPA2 PSK Key Calculation page 108 Table 80 WPA P...

Page 108: ...ers Parameter Optional Mandatory Value Description SSID Mandatory 1 32 The SSID is a string of between 1 and 32 ASCII characters See 2 7 3 SSID and Passphrase page 29 PASSPHRASE Mandatory 8 63 The pas...

Page 109: ...ly sets the pre shared key as provided The argument is a 32 byte key formatted as an ASCII hexadecimal number any other length or format is considered invalid Command Syntax AT WPSK PSK Parameter Desc...

Page 110: ...T PSSTBY 1000 Out of StandBy Timer AT WA GainSpanDemo 11 OK Table 85 WPA PSK and WPA2 PSK Key Synchronous Responses Responses Remarks OK Success After the PSK has been entered the commands AT W to sav...

Page 111: ...bes the synchronous responses and remarks for the Scanning command Table 86 Scanning Parameters Parameter Optional Mandatory Value Description SSID Optional N A A string containing ASCII characters be...

Page 112: ...39 NONE No Of AP Found 1 OK 2 AT WS GainSpanAdHoc BSSID SSID Channel Type RSSI Security 62 67 20 01 f1 07 GainSpanAdHoc 11 ADHOC 30 NONE No Of AP Found 1 OK Table 87 Scanning Synchronous Responses Res...

Page 113: ...mmand in different modes 1 In STA mode i e AT WM 0 see 5 1 2 Operation Mode page 78 The node will attempt to associate with the requested network If the requested network is not available an error mes...

Page 114: ...SSID and BSSID matches Where as if BSSID is not provided module will try matching the SSID In Limited AP mode this shall be the same as the modules MAC address I Channel Optional Depends on the value...

Page 115: ...he behavior of the GS node as provided in Table 89 page 115 WPS Registrar Optional 1 Initialize WPS registrar This will not trigger WPS procedure Note WPS registrar with hidden ssid is not supported U...

Page 116: ...nce 5 3 7 1 Keep Alive Timer This command is used to keep alive the timing intervals associated with the GS node This keep alive timer will fire for every n seconds once the GS node is associated This...

Page 117: ...conds once the node is associated This timer will try to keep the GS node in associated state even if there is no activity between AP and GS node by sending a NULL frame Command Syntax AT WKEEPALIVE I...

Page 118: ...255 seconds This parameter specifies the time GS node keeps sending NULL frame to AP to maintain the association The value 0 disables this feature 45 seconds default Type Optional Value range 0 1 It...

Page 119: ...ronous Responses Responses Remarks No Of Stations Connected NoOfClients MacAddr IP no OK Success Limited AP mode MAC address and the IP of each of the client associated to the Limited AP The IP addres...

Page 120: ...erating class Mandatory 81 1 to 13 channel 82 14 channel Preferred operating band i e the frequency band at which the P2P device is in the listen state or the frequency band at which the p2p device is...

Page 121: ...ds Push Button Country Japan 5 4 2 Set WPS This command helps in configuring the WPS related attributes of P2P device WPS configuration method is configured through AT P2PSETDEV command Command Syntax...

Page 122: ...it character default value GAINSPAN P2P Unique name to identify the device P2P Device manufacturers should attempt to create unique Device Names and user interfaces that maximize the probability of se...

Page 123: ...be in find phase forever or until stopped explicitly using the AT P2PSTOPFIND command The value is a 32 bit variable Channels to scan in search state Mandatory 1 default Social channels 1 6 11 Note On...

Page 124: ...nd complete CR LF same as verbose asynchronous mode same as verbose asynchronous mode same as verbose asynchronous mode After the completion of P2P find phase the device is moved back to P2P LISTEN st...

Page 125: ...ble 105 page 125 describes the asynchronous responses and remarks for the P2P Stop Find command Table 104 Stop Find Synchronous Responses Events Verbose mode Non Verbose mode Remarks Success CR LF OK...

Page 126: ...nd remarks for the Set P2P Configuration Example Start the registrar in PushButton or DISPLAY method AT P2PPROVOK Start the registrar in KEYPAD method AT P2PPROVOK 89170960 Table 106 Provoke Parameter...

Page 127: ...d use in connect join command Once the provisioning discovery response comes back the following response is sent to host p2p prov disc respenter pin Upon receiving this response the host should issue...

Page 128: ...vision Discovery Response with Keypad Method CR LF p2p prov disc resp SP enter pin CR LF OK CR L F Provision Discovery Response with Push Button Method CR LF p2p prov disc resp SP pbc CR LF 0 CR LF Pr...

Page 129: ...hannel Mandatory N A it specifies the peer p2p device to which group information needs to be carried out and is extracted during P2PFIND phase WPS config method Mandatory 0 Use push button for provisi...

Page 130: ...erating channel device MAC address WPA2 personal passphrase or WPA2 personal PSK CR LF Network Parameter Response Format CR LF OK CR LF CR LF p2p go negotiation complete SP GO SSID operating channel d...

Page 131: ...a GO p2p go neg complete GO DIRECT aR 11 02 1d c9 90 6a bb E4JWHKo3 p2p go neg fail reason Example 1 Group formation using PBC Method AT P2PGRPFORM 02 1d c9 01 02 03 6 0 1 1 0 OK Example 2 Group form...

Page 132: ...en out p2p group started GO DIRECT gs 6 02 1d c9 01 02 04 GSDemo123 p2p group started client DIRECT gs 6 02 1d c9 01 02 03 GSDemo123 5 4 7 1 Provision Discovery Request Handling Upon receiving provisi...

Page 133: ...ethods device capability group capability The user action should be to show the PIN on a display and issue following AT P2PGRPFORM or AT P2PPROVOK Response Keypad Method p2p prov disc req enter pin pe...

Page 134: ...nd remarks for the Client Join command Table 112 Client Join Parameters Parameter Optional mandatory Value Description GO MAC address Mandatory N A The device MAC address of the group owner xx xx xx x...

Page 135: ...ode Non Verbose mode Remarks Connected successfully to GO CR LF p2p join success client SP SSID channel MAC address for GO WPA2 personal PSK CR LF OK CR LF CR LF p2p join success client SP SSID channe...

Page 136: ...he Invitation Procedure command Asynchronous Response Table 116 page 137 describes the asynchronous responses and remarks for the Invitation Procedure command NOTE This does not support sending invita...

Page 137: ...t stops GO operation and switches to P2P device mode Table 116 Invitation Procedure Asynchronous Responses Events Verbose mode Non Verbose mode Remarks Asynchronous Enhanced Asynchronous Asynchronous...

Page 138: ...3 3 Deep Sleep page 155 even if it is enabled AT PSDSLEEP The Power Save mode see 6 1 3 Custom Power Save Radio Receive page 143 can be enabled but will not save power since the receiver is left on C...

Page 139: ...Case 1 Radio receiver is always on Power Save mode is enabled but will not save power since the receiver is left on AT WRXACTIVE 1 OK AT WRXPS 1 OK Example Use Case 2 The receiver is switched off The...

Page 140: ...119 page 140 describes the IEEE PS Poll Listen Interval parameters NOTE 1 It is recommended that the users building a binary that supports PS Poll feature using SDK Builder do not enable Concurrent mo...

Page 141: ...Wake up for Listen Interval WakeupType Optional valid if wakeup type is listen interval and custom 0 3 0 DTIM based wakeup 1 Listen interval based wakeup 2 Custom wakeup 3 DTIM aligned custom wakeup w...

Page 142: ...Either of these options can be used to wake the STA However the use case is as follows Example Use Case Whenever the STA is needed to wake up at some configured interval the Custom Wake up option sho...

Page 143: ...iver is on In this case the node will inform the 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 be...

Page 144: ...tem is provided with sufficient voltage for normal operation Low supply voltages can result in data corruption when profile data is written to flash memory Command Syntax AT BCHKSTRT Frequency Paramet...

Page 145: ...y Warning Standby Level Set command Table 124 Battery Warning Standby Level Set Parameters Parameter Optional Mandatory Value Description Warning Level Mandatory N A The battery voltage in millivolts...

Page 146: ...same command can be used to get the current configured battery check period the usage as follows AT BCHK Parameter Description Table 126 page 146 describes the Battery Check Set parameters Synchronou...

Page 147: ...or ERROR if the operation fails 6 2 5 Battery Value Get This command is used to retrieve the results of battery check operations Command Syntax AT BATTVALGET Response This command should return a mes...

Page 148: ...d Table 128 Hibernate Mode Parameters Parameter Optional Mandatory Value Description ALARM1 POL Mandatory 0 high to low default This is the polarity of the transition at pin RTC_IO_1 of the module tha...

Page 149: ...actions are needed 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 ser...

Page 150: ...ds from the time the command is issued to the time when the module goes to Standby ALARM1 POL Optional 0 high to low This is the polarity of the transition at pin RTC_IO_1 of the module which will tri...

Page 151: ...ous Response Table 133 page 151 describes the synchronous responses and remarks for Request Standby Mode command Table 132 Enable Standby Mode Between Beacons Parameters Parameter Optional Mandatory V...

Page 152: ...t 0 Disable Alarm 1 wakeup 1 Enable Alarm 1 wakeup Mandatory 1 Alarm 1 polarity Value range 0 1 Format Decimal Default value 0 This combination of Conf ID and Value specifies the polarity of the trans...

Page 153: ...S2101M IP2WiFi Adapter Command Reference Guide 1VV0301499 Rev 2 0 153 2019 08 05 Synchronous Response Table 135 page 155 describes the synchronous responses and remarks for Request Standby Mode comman...

Page 154: ...GS2101M IP2WiFi Adapter Command Reference Guide 1VV0301499 Rev 2 0 154 2019 08 05...

Page 155: ...scardable characters or commands should be sent until an indication is received from the application Response These commands do not return any response code to the serial interface The IP2WiFi applica...

Page 156: ...ion Timeout Optional Integer by 32bit value Node goes to deep sleep state for the configured time in milliseconds and upon time out exits the node from deep sleep state Max time out value is 32 bit AL...

Page 157: ...s parameter decides the state of radio on off in conjunction with Power Save Control parameter Reserved parameter Mandatory 0 Always issue zero 0 for this parameter Receiver on time after Transmission...

Page 158: ...based on Power Save Control and Power Save Configuration Power Save Control Power Save Configuration 0 1 0 Exit power save immediately Radio will be switched on immediately Note Exits power save only...

Page 159: ...e user wants to save power or does not want to use this feature then they are allowed to switch off the hardware crypto block The SW internally keeps a count of ON and OFF requests and when the count...

Page 160: ...GPIO GPIO NO pin level to high or low as per the SET RESET parameter Command Syntax AT DGPIO GPIO NO SET RESET 0 1 Parameter Description Table 142 page 160 describes the GPIO Out HIGH LOW parameters...

Page 161: ...ctions Use the lowest data rate of each standard 802 11b 802 11g and 802 11n as the transmit power is highest at these rates The RF commands already include the Gain Control Table limits If the data r...

Page 162: ...meL en TxRate TxPower DestAddr Bssid HtEnable GuardInterval GreenField PreambleType QosEnable AckPolicy Scrambler AifsnVal Antenna ccaBypass Parameter Description Table 144 page 162 describes the Asyn...

Page 163: ...egacy rate TxPower Mandatory 0 to 27 The value of this parameter can range from 0 to 27 Where 27 is the index corresponding to the maximum TxPower GS node will support DestAddr Mandatory N A The MAC a...

Page 164: ...ommand Syntax AT WRXTEST Channel BandWidth RxFrameTypeFilter RxAddrFilter Antenna Parameter Description Table 146 page 165 describes the Asynchronous Frame Reception Start parameters Table 145 Asynchr...

Page 165: ...d at 9M 0 No of packets received at 12M 0 No of packets received at 18M 0 No of packets received at 24M 0 No of packets received at 36M 0 Table 146 Asynchronous Frame Reception Start Parameters Parame...

Page 166: ...n Rx command Use the following command AT WFRAMETXTEST 6 0 10000 1000 24 16 00 11 22 33 44 55 00 33 44 55 66 77 0 0 0 0 0 4 0 2 0 1 AT WRXTEST 1 0 0 00 11 22 33 44 55 0 AT WRXTEST 1 0 536870912 00 11...

Page 167: ...le 0 No of packets received at 5M and Long Preamble 0 No of packets received at 11M and Long Preamble 0 No of packets received at 2M and Short Preamble 0 No of packets received at 5M and Short Preambl...

Page 168: ...Table 147 Asynchronous Frame Transmission Parameters Parameter Optional Mandatory Value Description Channel Mandatory 1 to 14 The channel on which the data is to be sent 1 14 BandWidth Mandatory 0 Th...

Page 169: ...achine in PHY It allows to enable normal mode or remove the control of ACG module on the receiver state machine in PHY ContpreambleMode Mandatory 0 1 0 Disable Continuous Preamble Mode 1 Enable Contin...

Page 170: ...be used PhyTestTxRate Mandatory 0 to 7 It specifies the PHY test transmission rates The rates differ depending on the ModeSelect parameter ModeSelect Mandatory 0 1 2 0 11g mode 1 11b mode 2 11n mode...

Page 171: ...nfigure the ModeSelect parameter to 2 TxRate parameter to 5 and PhyTestTxRate to 5 AT WTX99TEST 1 0 25000 1000 0 20 00 11 22 33 44 55 00 50 c2 5e 10 99 0 0 0 0 1 0 1 1 1 0 1 3 1 Table 149 page 171 tab...

Page 172: ...TX99TEST 1 0 99 1000 0 19 00 11 22 33 44 55 00 50 c2 5e 10 99 0 0 0 0 0 0 0 0 0 0 3 4 0 MCS0 AT WTX99TEST 1 0 99 1000 0 27 00 11 22 33 44 55 00 50 c2 5e 10 99 0 0 0 0 0 0 0 0 0 0 3 0 2 MCS1 AT WTX99TE...

Page 173: ...The values of 0 is 20MHz Note Currently the GS node supports only 20MHz operation TxPower Mandatory 0 27 The value of this parameter can range from 0 to 27 Where 27 is the index corresponding to Maxi...

Page 174: ...depending on the ModeSelect see Table 151 page 174 ModeSelect Mandatory 0 to 2 0 11g mode 1 11b mode 2 11n mode Table 150 Asynchronous Frame Transmission TX100 mode Continued Parameter Optional Mandat...

Page 175: ...s Example AT WCARWAVTEST 11 0 27 0 2 Table 152 Carrier Wave Transmission Parameters Parameter Optional Mandatory Value Description Channel Mandatory 1 14 The channel on which the data is sent BandWidt...

Page 176: ...alue remains the same unless manually changed When live calibration is disabled It aborts any live calibration that is in progress Partial data is not written and not erased from flash Factory calibra...

Page 177: ...urns value 1 when live calibration is enabled or return 0 when live calibration is disabled Table 154 Live Calibration Synchronous Responses Responses Remarks OK Success ERROR INVALID INPUT If paramet...

Page 178: ...ation Erase command Example AT WLCALERASE OK NOTE Live calibration is scheduled to start in the next boot based on the following triggers During scan In associated state Unsolicited Tx and unsolicited...

Page 179: ...open air environment this operation is expected to be completed in under 2 seconds However in crowded environment it may take up to 3 seconds If placed in a shielded box this operation is expected to...

Page 180: ...Info status FAIL Length 133 Data 80000020 0 1 12 1 a 5 0 1 12 2 9 5 1 41 12 b 9 7 1 41 11 a 9 7 1 41 11 a 9 7 1 41 10 9 9 7 1 41 f 9 9 7 1 41 e 9 9 7 1 41 d 8 8 7 ff ff ff ff ff ff ff ff ff ff ff ff f...

Page 181: ...d can also be used for domain check as well Parameter Description Table 158 page 181 describes the Error Code parameters Synchronous Response Table 159 page 182 describes the synchronous responses and...

Page 182: ...uccess ERROR Failure NOTE This command is applicable for all the AT Commands but not to their Responses Table 160 Echo Parameters Parameter Value Description n 0 Disabled 1 default Enabled If echo is...

Page 183: ...es the synchronous responses and remarks for the Verbose command Table 161 Echo Synchronous Responses Synchronous Responses Remarks OK Success ERROR INVALID INPUT If parameters are not valid Table 162...

Page 184: ...WLAN Status This command is used to retrieve information about the current wireless status Command Syntax AT WSTATUS Synchronous Response Table 165 page 184 describes the synchronous responses and rem...

Page 185: ...ou enable the Ping and Trace Route option under the Networking Services tab while building the firmware in the SDK Builder Usage When the statistics are sent to the host the clears them so that a new...

Page 186: ...ticase data uc_data Unicast data qos_uc_data Unicast QoS data qos_mc_data Multicast QoS data amsdu_uc_data Unicast AMSDU data amsdu_mc_data Multicast AMSDU data ampdu_uc_data Unicast AMPDU data ampdu_...

Page 187: ...ncrypted tkip TKIP encrypted ccmp CCMP encrypted unencryp Not encrypted ukencryp Unknown encryption leg Legacy ht20l HT LongGl 20MHZ ht20s HT ShrtGl 20MHz ht40l HT LongGl 40MHz ht40s HT ShrtGl 40MHz m...

Page 188: ...oS data qos_oth_data Other QoS data amsdu_uc_data Multicast AMSDU data amsdu_mc_data Unicast AMSDU data amsdu_oth_data Other AMSDU data oth_mgmt Other Management frame oth_ctrl Other Control frame oth...

Page 189: ...terface A 2 Asynchronous Enhanced Asynchronous Messages Table 169 page 190 lists the response codes of asynchronous and enhanced asynchronous messages in verbose and non verbose mode Asynchronous mess...

Page 190: ...Timer r n n rOut of StandBy Timer r n r n ESC A414Out of StandBy Timer r n r n11 r n ESC A4014 r n Out of Standby Alarm r n n rOut of StandBy Alarm r n r n ESC A514Out of StandBy Alarm r n r n12 r n...

Page 191: ...ration Success for mDNS service name r n ESC fc23 Registration Success for RR 555 r n r n33 r n ESC fc021b r n Registration Failed for mDNS service name SP Registration Failed for mDNS service name r...

Page 192: ...ff0815Out of StandBy Pspoll CR L F r n50 r n ESC A ff0802 26 CR LF Table 169 Response codes for Asynchronous and Enhanced Asynchronous Messages Events Verbose mode Non Verbose Mode Asynchronous messag...

Page 193: ...ue to WLAN processor software reset 2 n rAPP Reset APP SW Reset r n Adapter reset due to app processor software reset This can also be triggered when AT RESET command is issued and in this case it is...

Page 194: ...MESSAGES HOST MCU should parse the received data in such a way that it should separate all 3 types of data mentioned above and process accordingly as the HOST can receive the data which contains DATA...

Page 195: ...en there is a chance of receiving network DATA or ASYNCHRONOUS MESSAGE before COMMAND RESPONSE This is because S2W application is designed in such a way that it reads only one character at a time from...

Page 196: ......

Reviews: