eS-WiFi Module AT Command Set
Contents
1. a a 19 4 6 CONFIGURE NETWORK SETTINGS 19 46 1 CO NelWorkuu g a uu Dama asa cna ba eeu ve pf ua epa euge aene ONERE Sh ass 19 46 2 CI Set Network 5510 2 19 4 6 2 C2 Set Network Passphrase cii ie u eo eer S uD ER Fe qu QE FERNER FER Ve Ve CR 20 4 6 3 C3 Set Network Security Type uu LI Uu 20 Preliminary Subject to change eS WiFi Module AT Command Set Version v1 4 Gs Inventek Systems See eee DOC UM 20035 1 4 User Manual eS WiFi Module 4 6 4 CA Set Network DHCP u ui tree iea irse isses entree serrer ss sisse sr een 4 6 5 C5 Set Network IP Version 4 6 6 C6 Set Network IP Address 4 6 7 C7 Set Network IP Maska ka pice enero arae YR Rock een eeu nee tke n cna Re E RP VR E REDE 4 6 8 C8 Set Network Gateway 5 ertet ett SL ER kusakanakunaka sa 4 6 9 C9 Set Network Primary DNS 4 6 10 CA Set Network Secondary DNS enne nn nnns sre n teda dass ss ense 4 6 11 CB Set Network Join Retry Counmt u nana sess estesa asas essen rna2. connu dea Dae Fennec sese e cec apakuy 51 5 6 3 2 Read and Write UDP Data in Server Mode U na 52 5 6 4 UDP Client Setup and Data Transport WW 53 5 6 4 1 UDP Client Set Up mN 53 5 6 4 2 Read and Write UDP Data in Client Mode 53 6 APPENDIXCA wmE M g 55 7 DOCUMENT REVISION HISTORY eese eese e ee eee eese eee o sooo sooo ooo quao e eee e e eee e e eee 57 Preliminary Subject to change eS WiFi Module AT Command Set Version v1 4 Gs Inventek Systems DOC UM 20035 1 4 User Manual eS WiFi Module 1 Introduction 1 1 Scope The scope of this document is to introduce users to Inventek System s AT Command Set for the eS WiFi Module product and to explain how to take advantage of the AT Command Set for WiFi Communications 1 2 AT Command Usage in the User Manual is shown as Usage lt AT Command gt lt optional gt lt data if is used gt lt Carriage Return CR gt or lt AT Command gt lt CR gt And default values are show as Default lt A
3. 9 SP SaN 12 3 1 AT COMMAND SET LIST OF SUPPORTED FUNCTIONS 12 4 AT COMMAND DETAIL DESCRIPTION 16 4 1 PRINT HELP MESSAGE 16 4 2 SSS ENTER COMMAND MODE 16 4 3 EXIT COMMAND MODE 16 4 4 ACCESS POINT 16 4 4 1 AO Activate 16 4 4 2 A1 SET ACCESS POINT SECURITY MODE 17 4 4 3 A2WSet Seclllrity Key 17 44 Wc SCTAGEESS Point Channel anenarerarerarerarerarararararararerarararararararerarerarerarerarerararererarerorererererersrerersrarerere 17 4 4 5 AD Activate Access Point Direct Connect Mode nennen 17 4 4 6 AE Exit Access Point Direct Connect sees nenne rennen renun 18 4 4 7 AL Set Access Point DHCP Lease Time eese nnne rne rn rere seri serena nnn 18 4 4 8 ASt Access Point SSID irc siet EYES 4 4 9 A Show Access Point Settings 4 5 SELECT COMMUNICATION INTERFACE 4 5 1 B Show Communication Interface Settings
4. Embedding Connectivity Everywhere Gs Inventek Systems eS WiFi Module AT Command Set User Manual Inventek Systems 2 Republic Road Billerica MA 01862 Phone 978 667 1962 www Inventeksys com eS WiFi Module User Manua Gs Inventek Systems Embedding elisa DOC UM 20035 1 4 User Manual eS WiFi Module eS WiFi Module embedded Serial to WiFi AT Command Set User Manual Inventek Systems Inc Preliminary Subject to change eS WiFi Module AT Command Set Version v1 4 Gs Inventek Systems Embedding Connectivity Everywhere DOC UM 20035 1 4 User Manual eS WiFi Module Inventek System Inc AT Command Set Copyright and Company Information Contact Information Telephone 978 667 1962 Fax 978 667 1949 Location Mailing Address Inventek Systems 2 Republic Road Billerica MA 01862 Hours of Operation Monday Friday U S EST 08 00 a m 05 00 p m Send E mail inquiries to Sales Support Sales inventeksys com N N Nep Inventek Systems Embedding Connectivity Everywhere Copyright c 2011 Inventek Systems is a USA based full service wireless solutions provider focused on 802 11 b g n WiFi embedded solutions GPS embedded modules and antennas We provide a wide range of standard and custom embedded options ranging from low cost system in a package SiP products to modular based custom solutions We provide complete services from consulting to custom design to c
5. Lease Time gt lt CR gt 30 mins Default Value 0 30 mins 4 4 8 AS Set Access Point SSID Sets the Access Point SSID It can be up to 32 characters in total length including MAC if enabled Usage AS MAC Mode lt SSID gt lt CR gt MAC Value Mode Default Value MAC Mode 1 SSID eS WiFi AP 4 4 9 A Show Access Point Settings Returns Access Point Settings Usage A lt CR gt Field 1 2 3 4 5 6 7 Function SSID IP Channel Security Security AP Lease Address Type Key DHCP Time Preliminary Subject to change eS WiFi Module AT Command Set Version v1 4 18 Gs Inventek Systems Embedding lig a at DOC UM 20035 1 4 User Manual eS WiFi Module Field 8 Function Status Default Value None 4 5 Select Communication Interface Used to select SPI UART or USB interface for communication with the eS WiFi module 4 5 1 B Show Communication Interface Settings Return current Communication Interface settings Usage B CR Field 1 2 3 4 5 6 7 Function Host Interface Default Value None 4 6 Configure Network Settings Used to set up the network parameters needed to access a WiFi network 4 6 1 C0 Join a Network Using the user defined parameters of SSID Passphrase Security Type etc attempt to join a WiFi network for access A successful Join returns SSID and IP Address otherwise an error message is return A network cannot be re joined once the eS WiFi module has joined a network
6. 4 6 12 CC Network Auto Corihect uiuis eo entere eene renes dpa nee cox nx aer Nil cx neenon renes 4 6 13 CD Disconnect from Network enne enne eene ennt nennen nins WA 4 6 14 CE Set Authorization Type 4 6 15 CF Set Clear Packet Filter Packet Bypass Mode nn nana 4 6 16 CJ Join Leave IGMP Group ccccccesscesscecssecesseecssscesseecssscesseecssscesssecaasusseecsasesentecsaseceseecaseceaeserseeceaeeceas 4 6 17 CM Add Remove MAC Address To From Multicast Allow List 4 6 18 CN Set Country Code 4 6 19 CR Get RSSI of Associated Access Point 4 6 20 CS Connection Status s eee eee Y 4 6 21 Show Network Settings W WMSN 4 7 USB COMMANDS 4 7 1 E2 HID Keep alive WA W 4 8 SCAN FOR NETWORK ACCESS POINTS 4 8 1 FO Scan for Network Access Points 4 8 2 F1 Set Scan Repeat Count 4 8 3 F2 Set Scan Delay 4 8 4 F Sh
7. LC PM vc WS MF ST SA SN RS SC SL SG SK 5 SB SO ZA ES LK SR SZ SE CH SY TW TJ TZ TH TG TO Tr TN TR TM TC TV eS WiFi Module AT Command Set Version v1 4 Inventek Systems Embedding Connectivity Everywhere DOC UM 20035 1 4 User Manual eS WiFi Module Country Code Country Code Country Code DENMARK DK MAURITIUS MU UGANDA UG DJIBOUTI DJ MAYOTTE YT UKRAINE UA DOMINICA DM MEXICO MX UNITED ARAB EMIRATES AE DOMINICAN REPUBLIC DO MICRONESIA FEDERATED STATES OF FM UNITED KINGDOM GB ECUADOR EC MOLDOVA REPUBLIC OF MD UNITED STATES US EGYPT EG MONACO UNITED_STATES_REV4 US EL_SALVADOR SV MONGOLIA MN UNITED STATES NO DFS Q2 EQUATORIAL GUINEA GQ MONTENEGRO ME UNITED_STATES_MINOR_OUTLYING_ISLANDS UM ERITREA ER MONTSERRAT MS URUGUAY UY ESTONIA EE MOROCCO MA UZBEKISTAN UZ ETHIOPIA ET MOZAMBIQUE MZ VANUATU VU FALKLAND ISLANDS MALVINAS FK MYANMAR MM VENEZUELA VE FAROE ISLANDS FO NAMIBIA NA VIET NAM VN FIJI FJ NAURU NR VIRGIN_ISLANDS_BRITISH VG FINLAND FI NEPAL NP VIRGIN ISLANDS US VI FRANCE FR NETHERLANDS NL WALLIS AND FUTUNA WF FRENCH GUINA GF NETHERLANDS ANTILLES AN WEST BANK oc FRENCH_POLYNESIA PF NEW_CALEDONIA NC WESTERN_SAHARA EH FRENCH_SOUTHERN_TERRITORIES TF NEW_ZEALAND NZ YEMEN YE GABON GA NICARAGUA NI ZAMBIA ZM GAMBIA GM NIGER NE ZIMBABWE ZW GEORGIA GE NIGERIA NG GERMANY DE NORFOLK_ISLAND NF GHANA GH NORTHERN_MARIANA_ISLANDS GIBRALTAR GI NORWAY NO Preliminary Subject to change eS WiFi Module AT C
8. Transport Protocol UDP Client IP ADDR 0 0 0 0 Local Port 5024 Remote Host IP ADDR 192 168 1 110 Remote Host Port 5025 TCP Server Enabled NO UDP Server Enabled No OK gt 5 6 2 2 Read and Write TCP Data in Client Mode The eS WiFi Module can read and write data over the network using Transmission Control Protocol To aid in moving data over the network the eS WiFi Module s AT Command Set has commands for setting the Packet Size and for setting the Timeouts for data movement For TCP communications multiple reads may be needed to read all available data received If no data is available the read will timeout Set 1200 byte packet size for Read gt R1 1200 OK gt Set five second timeout for Read in milliseconds gt R2 5000 Preliminary Subject to change eS WiFi Module AT Command Set Version v1 4 50 Gs Inventek Systems eee u sss DOC UM 20035 1 4 User Manual eS WiFi Module Check Read Configuration gt R Number of TCP UPD bytes to receive per read 1200 TCP UPD receive timeout 5000 ms OK gt Perform Read of Remote Client gt RO testing 1234567890 OK gt Write data to Remote Client gt 50 0123456789 timeout detected bytes sent 10 OK gt The timeout was detected because the packet size was set to 1200 bytes but only 10 bytes were written to the remote client After a 5000 millisecond delay and no further data the 10 bytes were sent 5 6 3 UDP Server Set Up an
9. lt CR gt Default Value Inventek Systems eS WiFi 4 16 15 ZP Power Management Enable Disable Power Management features Usage ZP lt Feature gt Value CR p WiFI On All Power Save Off Power Save Off Power Save On Beacon Interval sec Default Value Feature 0 WiFi On All Power Save Off 4 16 16 ZR Reset Module Software reset of the module The equivalent of using the RTSN pin Usage ZR lt CR gt Default Value None 4 16 17 ZU Firmware Upgrade M3G Only uses STM32F205 boot loader Starts the STM32F205 built in boot loader to upgrade the firmware Usage ZU lt CR gt Default Value None Preliminary Subject to change eS WiFi Module AT Command Set Version v1 4 41 Gs Inventek Systems Embedding Connectivity Everywhere DOC UM 20035 1 4 User Manual eS WiFi Module 4 16 18 Z Show System Settings Returns current system settings Usage Z lt CR gt Field 1 Function Config ration Field 8 Function Current Beacon Default Value None WPS Pin 9 Previous Beacon Preliminary Subject to change 3 4 VID PID MAC 10 Product Name 42 5 6 7 AP IP PS Radio Address Mode Mode eS WiFi Module AT Command Set Version v1 4 Gs Inventek Systems ns DOC UM 20035 1 4 User Manual eS WiFi Module 5 Example eS WiFi Module AT Command Usage This section of the eS_WiFi Module User Manual covers example usage of the AT Command Set Areas covered include Changing the
10. 6 1 1 TCP Server Set Up Set protocol to TCP gt P1 0 OK Set local TCP Port Number to 5024 gt P2 5024 OK gt Enable TCP Server mode the eS WiFi Module will wait for a connection from a remote Client gt P5 1 TCP Task set up OK gt Waiting on TCP connection gt Accepted TCP connection from 192 168 1 107 on port 5024 gt Check TCP Server Mode Configuration gt P Transport Protocol TCP Client IP ADDR 192 168 1 107 Local Port 5024 Remote Host IP ADDR 0 0 0 0 Remote Host Port 5025 TCP Server Enabled Yes UDP Server Enabled No OK gt Preliminary Subject to change eS WiFi Module AT Command Set Version v1 4 48 C5 Inventek Systems eee DOC UM 20035 1 4 User Manual eS WiFi Module 5 6 1 2 Read and Write TCP Data in Server Mode The eS WiFi Module can read and write data over the network using Transmission Control Protocol To aid in moving data over the network the eS WiFi Module s AT Command Set has commands for setting the Packet Size and for setting the Timeouts for data movement For TCP communications multiple reads may be needed to read all available data received If no data is available the read will timeout Set 1200 byte packet size for Read range 1 to 1200 gt R1 1200 OK gt Set five second timeout for Read in milliseconds range 0 to 5000 gt R2 5000 Check Read Configuration gt R Number of TCP UPD bytes to receive per read 1200 TCP UPD rec
11. Baud Rate Scanning for Access Points Joining Networks and transferring data via Transmission Control Protocol using TCP and UDP 5 1 Entering Human Readable Command Mode The eS WiFi Module supports a Human Readable Command Mode for console interaction with the AT Command set For the AT Command usage examples that follow the Human Readable Command Mode will be used Sending the AT Command at the console prompt will put the eS WiFi Module into human readable mode Sending the AT Command will take the eS WiFi Module out of Human Readable mode and back into Machine Readable Mode which is the default console mode for the eS WiFI Module Entering Human Readable Mode example gt Entering CMD mode OK gt 5 2 Changing the Baud Rate One of the first things that may be useful when using the eS WiFi Module is to up the data rate of the eS WiFi Module serial interface for faster interaction with the console and data transfer Check Current Baud Rate gt U Communication Port UART Baud Rate 115200 Data width 8 bit Parity NONE Stop Bits 1 Mode ASCII RX Timeout 0 ms TX Timeout 0 ms OK gt Set New Baud gt U2 921600 OK gt Activate Baud Change gt U0 At this point the eS WiFi Module will expect a faster or slower baud rate depending on the baud rate used for U2 The next step is to change the baud rate of the system to continue communicating with the eS WiFI Module After changing th
12. Byte gt lt CR gt o No Filtering Note The filters remove the packets that are not directed to or are not part a Multicast group that has been enabled to the eS WiFi module Default Value 00 No Filtering 4 6 16 CJ Join Leave IGMP Group Join or leave a IGMP group Usage CJ lt Action gt lt Group IP Address gt lt CR gt Default Value None 4 6 17 CM Add Remove MAC Address To From Multicast Allow List Packet Bypass Mode Adds or removes a MAC address to or from the multicast allow list while in PBM Usage CM lt MAC Address gt lt CR gt Default Value None Preliminary Subject to change eS WiFi Module AT Command Set Version v1 4 24 Gs Inventek Systems ii dedii ela DOC UM 20035 1 4 User Manual eS WiFi Module 4 6 18 CN Set Country Code Set the country code for the eS WiFi module The country code is a two letter code representing a country which selects which channels are valid to use Usage CN lt Code gt lt CR gt Please see Appendix A for the list of Country Code supported Default Value US 4 6 19 CR Get RSSI of Associated Access Point Get the RSSI on the currently associated Access Point Usage CR lt CR gt Response Description No Associated AP All other values Default Value None 4 6 20 CS Connection Status Gets the current network connection status Usage CS lt CR gt Connected Not Connected Default Value None Preliminary Subject
13. Default Value None 4 12 Receive Transport Data Once the Transport Protocol has been defined and either the server or client mode has been enabled data can be received from a connected server or client using the AT Command RO with AT Command R1 setting the size of data to read from the transport protocol stack For TCP data multiple reads may have been needed to return all of the available data however for UDP data received greater than the number of bytes defined by the AT Command R1 will be lost 4 12 1 RO Read Transport Data Available receive data is read using the AT Command RO RO reads the transport buffer for AT Command R1 size bytes Multiple reads may been needed to read all of the available TCP data UDP data received greater than the bytes size defined by R1 will be lost Usage RO0 lt CR gt Default Value None Preliminary Subject to change eS WiFi Module AT Command Set Version v1 4 33 Gs Inventek Systems ial cr coii Sig DOC UM 20035 1 4 User Manual eS WiFi Module 4 12 2 R1 Set Read Transport Packet Size bytes The AT Command R1 is a user defined value for the packet size of data to return a data read The AT Command R1 should be set before performing AT Command RO The input range for AT Command R1 is 0 to 1200 bytes Usage R1 lt Data Packet Size CR Default Value R121200 4 12 3 R2 Set Read Transport Timeout ms The AT Command
14. Gs Inventek Systems Sd cisci e i DOC UM 20035 1 4 User Manual eS WiFi Module 4 6 12 CC Network Auto Connect Network Auto Connect allows the user to define weather or not the eS WiFi module will attempt a Join a wireless network after the system is powered up and operational or after a reset The Network Auto Connect modes are listed in Table 4 5 Auto Connect Auto Connect Mode Disable Network Auto Join MEN Network Auto Join Table 4 5 Network Auto Connect Modes Usage CC lt Auto Connect Modes gt lt CR gt Default Value 0 4 6 13 CD Disconnect from Network To disconnect the eS WiFi module from a wireless network the AT Command CD is used CD will shut down the network communications and clear the network IP Address Net Mask and Gateway Address assigned to the eS WiFi Module Usage CD lt CR gt Default Value None 4 6 14 CE Set Authorization Type Set the authorization type for WEP security IP Version Type Mode Usage CE Type CR Default Value 0 Open Preliminary Subject to change eS WiFi Module AT Command Set Version v1 4 23 Gs Inventek Systems lls DOC UM 20035 1 4 User Manual eS WiFi Module 4 6 15 Set Clear Packet Filter Packet Bypass Mode Set Clear the packet filters when operating in the PBM Packet Bypass Mode The PBM sends the received Ethernet packet directly to host interface bypassing the module s TCP IP Stack Usage CF lt Mode
15. KH LAO_PEOPLES_DEMOCRATIC_REPUBIC CAMEROON CM LATVIA CANADA CA LEBANON CAPE_VERDE LESOTHO CAYMAN_ISLANDS KY LIBERIA CENTRAL_AFRICAN_REPUBLIC LIBYAN_ARAB_JAMAHIRIYA CHAD TD LIECHTENSTEIN CHILE CL LITHUANIA CHINA CN LUXEMBOURG CHRISTMAS_ISLAND CX MACAO COLOMBIA co MACEDONIA_FORMER_YUGOSLAV_REPUBLIC_OF COMOROS KM MADAGASCAR CONGO MALAWI CONGO_THE_DEMOCRATIC_REPUBLIC_OF_THE cD MALAYSIA COSTA_RICA CR MALDIVES COTE_DIVOIRE cl MALI CROATIA HR MALTA CUBA MAN_ISLE_OF CYPRUS MARTINIQUE CZECH_REPUBLIC CZ MAURITANIA Preliminary Subject to change 55 Code KI KR 0A KW KG LA LV LB 15 LR LY LI LT LU MO MK MG MW MY MV ML MT IM MQ MR Country OMAN PAKISTAN PALAU PANAMA PAPUA NEW GUINEA PARAGUAY PERU PHILIPPINES POLAND PORTUGAL PUETO RICO QATAR REUNION ROMANIA RUSSIAN FEDERATION RWANDA SAINT KITTS AND NEVIS SAINT LUCIA SAINT PIERRE AND MIQUELON SAINT VINCENT AND THE GRENADINES SAMOA SANIT MARTIN SINT MARTEEN SAO TOME AND PRINCIPE SAUDI ARABIA SENEGAL SERBIA SEYCHELLES SIERRA LEONE SINGAPORE SLOVAKIA SLOVENIA SOLOMON ISLANDS SOMALIA SOUTH AFRICA SPAIN SRI LANKA SURINAME SWAZILAND SWEDEN SWITZERLAND SYRIAN ARAB REPUBLIC TAIWAN PROVINCE OF CHINA TAJIKISTAN TANZANIA UNITED REPUBLIC OF THAILAND TOGO TONGA TRINIDAD AND TOBAGO TUNISIA TURKEY TURKMENISTAN TURKS AND CAICOS ISLANDS TUVALU Code OM PK PW PA PG PY PE PH PL PT PR QA RE RO RU RW KN
16. R2 is a user defined value for the amount of time in milliseconds to wait on the Read Transport Data AT Command R2 to finish The input range for R2 is 0 to 30000 milliseconds Usage R2 lt Read Transport Timeout gt lt CR gt Default Value R1 5000 4 12 4 R3 Set Receive Mode The AT Command R3 sets the receive mode In receive mode 1 the CRLF Carriage Return Line Feed delineation are removed from the Read response Usage R32 Value CR Receive Mode Normal No Delineation Default Value None 4 12 5 R Show Read Transport Settings Return current Receive Transport Data Settings Usage R lt CR gt Field 1 2 3 Function Number of Timeout Receive Bytes Mode Default Value None Preliminary Subject to change eS WiFi Module AT Command Set Version v1 4 34 Gs Inventek Systems s a DOC UM 20035 1 4 User Manual eS WiFi Module 4 13 Write Transport Data Once the Transport Protocol has been define and either the server or client mode has been enabled data can be written to a connected Transport Server or Client using the AT Command S0 with AT Command S1 defining the size of data to write 4 13 1 SO Write Transport Data The AT Command SO is used to write data to a Transport Server or Client The size of the data to write is defined via the AT Command S1 After the AT Command SO is entered any data writing to the eS WiFi module s selected communicating interface wil
17. Show Write Transport Settings 35 4 14 PING IP TARGET ADDRESS 36 4 14 1 TO Ping IP Target Address IE e WW 36 4 14 2 TT Set Ping Target Address S WA W x 36 4 14 3 T2 Set Ping Repeat Count 36 4 14 4 T3 Set Ping Delay ms 4 14 5 T Show Ping Settings 4 15 CONFIGURE UART 4 15 1 U0 Activate UART Settings 4 15 2 U2 Set UART Baud Rate 4 15 3 UP Show UART Setting 4 16 SYSTEM INFORMATION 4 16 1 20 Reset To Factory Defaults 4 16 2 Z1 Save Current Settings 4 16 3 Z2 Clear Saved Settings 4 16 4 Z3 Set Factory User Space 4 16 5 Z4 Set MAC Address 4 16 6 Z5 Get MAC Address 4 16 7 Z6 Set Access Point IP Address 4 16 8 Z7 Set WPS Pin Wax NO 4 16 9 Z8 Get WPS 4 16 10 Z9 Set USB 4 16 11 ZC Clear Factory Lock
18. Switch 4 16 12 ZD Flash 4 16 13 ZF Set Factory Lock Switch 4 16 14 ZN Set Product 4 16 15 ZP Power Management 4 16 16 ZR Reset Module 4 16 17 ZU Firmware Upgrade M3G Only uses STM32F205 boot loader 4 16 18 Z Show System Settings 5 EXAMPLE ES WIFI MODULE AT COMMAND USAGE 5 1 ENTERING HUMAN READABLE COMMAND MODE 5 2 CHANGING THE BAUD RATE 5 3 FIND ACCESS POINTS 5 4 JOIN NETWORK ACCESS POINT 5 5 PING A SYSTEM ON A NETWORK Preliminary Subject to change 43 43 44 45 47 eS WiFi Module AT Command Set Version v1 4 Gs Inventek Systems sess DOC UM 20035 1 4 User Manual eS WiFi Module 5 6 TRANSMISSION CONTROL PROTOCOL 48 5 6 1 TCP Server Set up and Data Transport 5 6 1 1 TCP Server Set eee cte parco Uo pieces tc LED EV e e ra de ee ga Eco Pe pee de cuc a acp Me PE s erc Ea REPE rae a aiai 5 6 1 2 Read and Write TCP Data in Server Mode l u iii iaaa enne nennen 49 5 6 2 TCP Client Setup and Data Tra sporkt siine unsi ushiku aia Eaa eiaa aaia 5 6 2 1 TCP Client Set Up 5 6 2 2 Read and Write TCP Data in Client Mode 5 6 3 UDP Server Set Up and Data ussiisa 5 6 3 1LUDP Server SetlUpu uuu u ree
19. gt lt CR gt Type Value Type 4 Digital Output Default Value None 4 9 3 G4 GPIO Setup Sets the type of the specified GPIO pin Usage G2 lt Pin Number gt lt Value gt lt CR gt Default Value None Preliminary Subject to change eS WiFi Module AT Command Set Version v1 4 28 Gs Inventek Systems DOC UM 20035 1 4 User Manual eS WiFi Module 4 9 4 G Show GPIO Settings The AT Command G will return the GPIO pin type Usage I CR Field 1 2 3 4 5 6 7 Function GPIO1 GPIO2 GPIO3 GPIO4 CFGO CFG1 Default Value None 4 10 Software Information Information about the AT Command application that includes Firmware Version WICED Version IP Stack Name and Version RTOS Name and Version can be access using the following AT Commands 4 10 1 I Show Applications Information The AT Command I will return Application Firmware Platform IP Stack and FreeRTOS information Usage I CR Field 1 2 3 4 5 6 7 Function Product FW API Stack RTOS CPU Product ID Revision Revision Revision Revision Clock Name Default Value None 4 11 Transport Communication Transmission Control Protocol TCP and User Datagram Protocol UDP are used for point to point or port to port communications on a network TCP is a guarantee port to port communication protocol that is used to insure data is transferred error free between a server and client UDP is consider to be faster than TCP for the
20. per read TCP UPD receive timeout OK gt Perform Read of Remote Client gt RO testing 1234567890 OK gt Write data to Remote Client gt 50 0123456789 timeout detected bytes sent 10 OK gt 1200 5000 ms The timeout was detected because the packet size was set to 1200 bytes but only 10 bytes were written to the remote client After a 5000 millisecond delay and no further data the 10 bytes were sent Preliminary Subject to change 54 eS WiFi Module AT Command Set Version v1 4 5 Inventek Systems Embedding Connectivity Everywhere DOC UM 20035 1 4 User Manual eS WiFi Module 6 Appendix A Country Code Country AFGHANISTAN AF GREECE ALBANIA AL GRENADA ALGERIA DZ GUADELOUPE AMERICAN_SAMOA AS GUAM ANGOLA AO GUATEMALA ANGUILLA Al GUERNSEY ANTIGUA_AND_BARBUDA AG GUINEA ARGENTINA AR GUINEA_BISSAU ARMENIA AM GUYANA ARUBA AW HAITI AUSTRALIA AU HOLY_SEE_VATICAN_CITY_STATE AUSTRIA AT HONDURAS AZERBAIJAN AZ HONG_KONG BAHAMAS BS HUNGARY BAHRAIN BH ICELAND BAKER_ISLAND 0B INDIA BANGLADESH BD INDONESIA BARBADOS BB IRAN_ISLAMIC_REPUBLIC_OF BELARUS BY IRAQ BELGIUM BE IRELAND BELIZE BZ ISRAEL BENIN BJ ITALY BERMUDA BM JAMAICA BHUTAN BT JAPAN BOLIVIA BO JERSEY BOSNIA_AND_HERZEGOVINA BA JORDAN BOTSWANA BW KAZAKHSTAN BRAZIL BR KENYA BRITISH_INDIAN_OCEAN_TERRITORY 10 BRUNEI_DARUSSALAM BN KOREA_REPUBLIC_OF BULGARIA BG KOSOVO BURKINA_FASO BF KUWAIT BURUNDI BI KYRGYZSTAN CAMBODIA
21. system PC Smartphone Tablet etc must use the Security Key to associate with the eS WiFi Access Point to communicate with the eS WiFi Module Usage A2 lt Key gt lt CR gt Default Value None 4 4 4 AC Set Access Point Channel Set the channel the Access Point will broadcast on The channels are from 1 to 18 based upon the Country Code setting for the eS WiFi module Usage AC2 Channel CR Default Value 1 4 4 5 AD Activate Access Point Direct Connect Mode Starts the Access Point DHCP Server and minimal CSO Connection Support Only Web Server The CSO Web Server handles the support for connecting Apple devices with iOS6 and other devices that require addition support to connect to a captive network Usage AD lt CR gt Default Value None Preliminary Subject to change eS WiFi Module AT Command Set Version v1 4 17 Gs Inventek Systems sll lial i aa DOC UM 20035 1 4 User Manual eS WiFi Module 4 4 6 AE Exit Access Point Direct Connect Mode Shuts down the Access Point DHCP Server and Web Server when the connected using the Direct Connect mode This is for both the AO and AD commands For the 0 command this is only needed when a Direct Connection has been made through the Network Access Web Page Usage AE lt CR gt Default Value None 4 4 7 AL Set Access Point DHCP Lease Time Set the lease time given by the DHCP Server when an IP address has been assigned Lease Value Time Usage AL
22. to change eS WiFi Module AT Command Set Version v1 4 25 Gs Inventek Systems s uid SS LCN DOC UM 20035 1 4 User Manual eS WiFi Module 4 6 21 C Show Network Settings Return current Configured Network Settings Usage C lt CR gt Field 1 2 3 4 5 6 7 Function SSID Password Security DHCP IP IP Mask Type Version Address Field 8 9 10 11 12 13 14 Function Gateway DNS1 DNS2 Retries Auto Authent Country Connect ication Code Field 15 Function Status Default Value None 4 7 USB Commands 4 7 1 E2 HID Keep alive Enables Disable the HID Keep alive When Enabled the eS WiFi module will send a data packet with a zero number of valid bytes The allow systems that have a blocking read function to release Usage E2 lt CR gt Default Value None 4 8 Scan for Network Access Points The eS WiFi module can scan for available networks and return detail information about networks found without having to join a network The information returned on the available networks includes SSID BSSID RSSI Data Rate Network Type Security Radio Band and Channel The information returned about Network Access Points can be used in joining one of the networks Scanning for Network Access Points is a very handy command for determining what wireless networks are in listening range of the eS WiFi module 4 8 1 FO Scan for Network Access Points Find Networks can be used to scan for available networks and return information about the network
23. 1 90 on the network for five times with a 500 millisecond delay between pings gt TO Pinging 192 168 Ping Reply 32ms Pinging 192 168 Ping Reply 5ms Pinging 192 168 Ping Reply 3ms Pinging 192 168 Ping Reply 4ms Pinging 192 168 Ping Reply 6ms OK 1 90 1 90 1 90 1 90 1 90 Preliminary Subject to change 47 eS WiFi Module AT Command Set Version v1 4 C Inventek Systems Embedding Connectivity Everywhere DOC UM 20035 1 4 User Manual eS WiFi Module gt 5 6 Transmission Control Protocol To move data across a network Transmission Control Protocol is often used The eS WiFi Module can be configured to be a Server or Client on a network for Transmission Control Protocol communications Also the eS WiFi Module supports TCP and UDP protocols for data transfer The examples that follow show TCP and UDP Server and TCP and UDP Client operational modes of the eS WiFi module The following examples also assume that Transmission Control Protocol software is used on the remote Server or remote Client system and that a port number has been set up for use 5 6 1 TCP Server Set up and Data Transport The first step in setting up the eS WiFi Module to be a TCP server on the Network assuming the eS WiFi has been joined to a Network is to set the protocol mode followed by enabling the TCP server mode Once the eS Wifi Module is in TCP server mode data can then be written to and read from a remote client on the network 5
24. 192 168 1 117 OK gt Check Network Join Settings after joining Access Point gt SSID PSWD SECURITY DHCP IP IP ADDR mars PASSWORD WPA2 AES Enabled IPV4 192 168 1 117 Preliminary Subject to change 46 eS WiFi Module AT Command Set Version v1 4 Gs Inventek Systems Embedding Connectivity Everywhere DOC UM 20035 1 4 User Manual eS WiFi Module MASK GW ADDR DNS1 DNS2 Join Retries Auto Connect Status OK gt 255 255 255 0 192 168 1 1 0 0 0 0 0 0 0 0 5 0 Connected 5 5 Ping a System on a Network From time to time there is a need to Ping a system on a network or Ping a system while debugging a connection on the network The eS WiFi module can be configured to Ping systems on a network To Ping a system on a network from the eS WiFi Module the IP Address of the system must be set up In addition to setting up IP Address for the system to ping the number of times to perform the Ping and the delay between Pings can be set Assuming that eS Wifi Module has already joined to a network the following steps will ping a system on the network Set Ping IP Address to 192 168 1 90 for a system on the Network gt T1 192 168 1 90 OK gt Set Ping Repeats to 5 gt T2 5 OK gt Set Ping Delay to 500 milliseconds gt T3 500 OK gt Check Ping Settings gt T Ping Target Address 192 168 1 90 Ping Repeats 5 Ping Delay 500 ms OK gt Ping 192 168
25. E 99 FF AA DD 90dBm 54 0 Mbits s Infrastructure WPA2 AES 2 4GHz 1 saturn FF 11 00 55 cc 90dBm 54 0 Mbits s Infrastructure 2 4GHz 6 uranu 33 44 199 44 11 94dBm 54 0 Mbits s Infrastructure WPA2 AES 2 4GHz 11 00 00 EE CC eS WiFi Module AT Command Set Version v1 4 Gs Inventek Systems de gia is idi DOC UM 20035 1 4 User Manual eS WiFi Module If needed the eS WiFi Module can be set up to scan a number of times for Access Points This mode can be helpful during set up or debug on a network The example below sets up the eS WiFi Module to run 5 Access Point scans gt Fl 5 OK gt gt FO waiting for scan results returned data End of scan results waiting for scan results returned data End of scan results waiting for scan results returned data End of scan results waiting for scan results returned data End of scan results Waiting for scan results returned data End of scan results OK The eS WiFi Module can also be set up using an AT Command to delay between scans The delay is set in milliseconds The time range for delay is 0 to 5000 milliseconds Delay one second between scans gt F2 1000 OK gt Check current Find settings gt F Scan Repeats 10 Scan 1 in ms 1000 OK gt 5 4 Join Network Access Point To join a Network Access Point the SSID the PASSWORD the Security Mode and the I
26. K Set remote Server IP Address gt P3 192 168 1 110 OK Set remote UDP Port Number to 5025 gt P4 5025 OK gt Enable UDP Client mode gt P6 1 Connecting to 192 168 1 110 OK gt Once the UDP Client mode AT Command returns to the console a connection has been established with a remote server or an error message will be generated on a connection failure Check UDP Client Mode Configuration gt P Transport Protocol UDP Client IP ADDR 0 0 0 0 Local Port 5024 Remote Host IP ADDR 192 168 1 110 Remote Host Port 5025 TCP Server Enabled NO UDP Server Enabled No OK gt 5 6 4 2 Read and Write UDP Data in Client Mode The eS WiFi Module can read and write data over the network using Transmission Control Protocol To aid in moving data over the network the eS WiFi Module s AT Command Set has commands for setting the Packet Size and for setting the Timeouts for data movement For UDP communications the number bytes sent to the server must match the number bytes to read any additional data sent to the server may be lost Preliminary Subject to change eS WiFi Module AT Command Set Version v1 4 53 Gs Inventek Systems Embedding Connectivity Everywhere DOC UM 20035 1 4 User Manual eS WiFi Module Set 1200 byte packet size for Read gt R1 1200 OK gt Set five second timeout for Read in milliseconds gt R2 5000 Check Read Configuration gt R Number of TCP UPD bytes to receive
27. Modes gt lt CR gt Default Value C5 0 4 6 6 C6 Set Network IP Address Set Network IP Address allows the user to define the IP Address that the eS WiFi module will use on a wireless network If DHCP is disabled the IP Address must be set to allow the eS WiFi module to work correctly on a wireless network The IP Address must be entered in dotted decimal notation which is defined aS for the network address If DHCP is enabled the IP Address will be set by the wireless network on a network join Usage C6 lt xxx xxx xxx xxx gt lt CR gt Default Value 000 000 000 000 4 6 7 C7 Set Network IP Mask Set Network IP Mask is a user defined value for the network net mask subnetting of the network used on the WiFi Network If DHCP is disabled the net mask must be set to allow the eS WiFi module to work correctly on a wireless network The net mask must be entered in dotted decimal notation which is defined as If DHCP is enabled the Net Mask will be set by the wireless network on a network join Usage 7 lt gt lt gt Default Value 000 000 000 000 Preliminary Subject to change eS WiFi Module AT Command Set Version v1 4 21 Gs Inventek Systems a Sar DOC UM 20035 1 4 User Manual eS WiFi Module 4 6 8 C8 Set Network Gateway Set Network Gateway is a user defined Gateway IP Address used by the devices on the network to a
28. P Address mode DHCP or locally assigned IP Address must be set See your network administrator for information needed to accessing Access Points on your network Using the information returned from previous network scan F0 and network information supplied by the Network Administrator the eS WiFi module can be configured to join an Access Point on the Network The following example shows how to join an Access Point using DHCP however a locally defined IP Address can also be used Refer to the sections 4 6 4 4 6 6 and 4 6 7 on setting a local IP Address for the eS WiFi module Preliminary Subject to change eS WiFi Module AT Command Set Version v1 4 45 Gs Inventek Systems Embedding Connectivity Everywhere DOC UM 20035 1 4 User Manual eS WiFi Module Set SSID for Access Point gt Cl mars ok gt Set Password for Access Point gt C2 PASSWORD OK gt Set Security Mode WPA2 AES for Access Point gt C323 OK gt Set eS WiFi Module IP Address via DHCP gt C4 1 OK gt Check Network Join settings before joining Access Point gt SSID PSWD SECURITY DHCP IP IP ADDR MASK GW ADDR DNS1 DNS2 Join Retries Auto Connect Status OK gt mars PASSWORD WPA2 AES Enabled ot Connected Join Network Access Point mars using PASSWORD WPA2 AES and DHCP gt CO Joining mars Successfully joined mars Obtaining IP address via DHCP Network ready IP
29. Request TCP sens entre 4 119 P8 Set Listen Backlogs 3 ooo visco manna aa E Ve Ra e ERI E RAE anka SNR SETA 4 11 10 PR Packet Bypass Mode PBM Read Mode a 4 11 11 PW Packet Bypass Mode PBM Write Packet enne enhn 4 11 12 P Show Transport Settings sno Eten ES nS CERES NR en PAIR 4 12 RECEIVE TRANSPORT DATA Preliminary Subject to change eS WiFi Module AT Command Set Version v1 4 Gs Inventek Systems E OMM DOC UM 20035 1 4 User Manual eS WiFi Module 4 12 1 RO Read Transport Data uu aqu u nde eene a tae G nal aaa au ka aqu 4 12 2 R1 Set Read Transport Packet Size bytes 4 12 3 R Set Read Transport Timeout ms l l n n S 4 424 R3 Set Receive MOG EI Sa Sua Sakaq ha a bapa niaaa saa ha 4 12 5 R Show Read Transport Settimgs u uuu ashaka sasa 4 13 WRITE TRANSPORT DATA 4 13 1 S0 Write TransportData u orte era aee A E E E r iia 4 13 2 S1 Set Write Transport Packet Size bytes a 35 4 13 3 S2 Set Write Transport Timeout ms 35 4 13 4 S
30. T Allow List PBM Only Set Country Code See Appendix A for Codes Get RSSS of Associated Network Access Point Get Connection Status Show Network Settings HID Keep alive Scan for Network Access Points Set Scan Repeat Count Set Scan Delay ms Show Scan Settings Read GPIO ADC GPIO Setup Show GPIO Settings Show Application Information Activate Transport Settings Set Transport Protocol Set Transport Local Port Number Set Transport Remote Host IP Address Set Transport Remote Port Number Stop Start Transport Server Stop Start Transport Client Preliminary Subject to change eS WiFi Module AT Command Set Version v1 4 13 Gs Inventek Systems Embedding Connectivity Everyanera DOC UM 20035 1 4 User Manual eS WiFi Module Preliminary Subject to change eS WiFi Module AT Command Set Version v1 4 14 Gs Inventek Systems Embedding Connectivity Sees DOC UM 20035 1 4 User Manual eS WiFi Module Show System Settings Table 3 1 AT Command Set List Preliminary Subject to change eS WiFi Module AT Command Set Version v1 4 15 Gs Inventek Systems asses DOC UM 20035 1 4 User Manual eS WiFi Module 4 AT Command Detail Description 4 1 Print Help Message Print Help menu to console Usage lt CR gt Default Value None 4 2 Enter Command Mode Command Human Readable Mode is entered via While in Command mode all AT Commands return deta
31. T Command gt lt Value gt 1 3 Supported Product Versions This document covers the following currently available eS WiFi modules ISM4319 M3 L44 C Ceramic Antenna ISM4319 M3 L44 E Printed Micro strip Antenna ISM4319 M3 L44 U U FL Connector to external antenna ISM4319 M3G L44 E Printed Micro strip Antenna ISM43362 M3G L44 E Printed Micro strip Antenna ISM43362 M3G L44 U U FL Connector to external antenna 1 4 AT Command Set In the early 1980 s Hayes Microcomputer Products Inc was one of the first modem manufactures to use an AT type Command Set to control operations of their modem products for communication over the Plain Old Telephone Service POTS Since then a number of products have been developed for communications that use the AT Command Set for device control AT is short for AT tention and is used to get the attention of a device for set up and control of it s functions Normally following the AT command would be other letters and numbers that would control the functions associated with the command For example ATDT1234567 means ATtention modem Dial with Tone the number following the command which in this case is 1234567 Common practice today is to shorten the AT command to just the function command which using the example above the shorten command to dial using tone for a number would be DT 1234567 1 4 1 Entering AT Commands As mentioned above it is common pract
32. ccess other networks or as a default gateway when no other IP Address matches any other routes in the network routing table The Gateway IP Address must be entered in dotted decimal notation which is defined as Usage C8 lt xxx xxx xxx xxx gt lt CR gt Default Value 000 000 000 000 4 6 9 C9 Set Network Primary DNS Set Network Primary Domain Name System DNS is a user defined address used for translating human readable domain names into numerical identifiers for network devices The Primary DNS must be entered in dotted decimal notation which is defined as Usage 9 lt gt lt gt Default Value 000 000 000 000 4 6 10 CA Set Network Secondary DNS Set Network Secondary DNS is used as a back up to the Primary DNS The Secondary DNS must be entered in dotted decimal notation which is defined as Usage CA2 00 XXX XXX XXX CR Default Value 000 000 000 000 4 6 11 CB Set Network Join Retry Count Set Network Join Retry Count is a user defined value that controls the number of times the eS WiFi module will attempt to join a wireless network before stopping with a failure notice if the system is unable to join the network Input range for Join Retries is O to 10 Usage CB lt Join Retries CR Default Value 5 Preliminary Subject to change eS WiFi Module AT Command Set Version v1 4 22
33. d Data Transport The first step in setting up the eS WiFi Module to be a UDP server on the Network assuming the eS WiFi has been joined to a Network is to set the protocol mode followed by enabling the UDP server mode Once the eS Wifi Module is in UDP server mode data can then be written to and read from a remote client on the network 5 6 3 1 UDP Server Set Up Set protocol to UDP gt 1 1 OK Set local UDP Port Number to 5024 gt P2 5024 OK gt Enable UDP Server mode the eS WiFi Module will wait for a connection from a remote Client gt P5 1 UDP Task set up OK gt Waiting on UDP connection gt Accepted UDP connection from 192 168 1 110 on port 5024 gt Check UDP Server Mode Configuration gt P Transport Protocol UDP Preliminary Subject to change eS WiFi Module AT Command Set Version v1 4 51 Gs Inventek Systems Embedding Connectivity Everywhere DOC UM 20035 1 4 User Manual eS WiFi Module Client IP ADDR 192 168 1 110 24 Local Port 50 Remote Host IP ADDR 0 0 0 0 Remote Host Port 5025 TCP Server Enabled No UDP Server Enabled Yes OK gt 5 6 3 2 Read and Write UDP Data in Server Mode The eS WiFi Module can read and write data over the network using Transmission Control Protocol To aid in moving data over the network the eS WiFi Module s AT Command Set has commands for setting the Packet Size and for setting the Timeouts for data movement For UDP communicati
34. e System baud sending a CR should return the console prompt gt If not reset the eS WiFi Module and retry changing the baud Preliminary Subject to change eS WiFi Module AT Command Set Version v1 4 43 Inventek Systems Embedding Connectivity Everywhere DOC UM 20035 1 4 User Manual eS WiFi Module Check Baud Rate After Change gt U Communication Port OK gt Baud Rate Data Width Parity Stop Bits Mode RX Timeout TX Timeout Finding Access Points UART 921600 8 bit NONE 1 ASCII 0 ms The first steps in joining a network is to determining available Access Points in the listening range of the eS WiFi Module The eS WiFi Module AT Command Set supports functions for finding Access Points The AT Command for finding Access Points can be used without joining a network 5 3 Find Access Points gt FO waiting for scan results 001 002 003 004 End of scan results OK gt Preliminary Subject to change SSID BSSID RSSI Max Data Rate Network Type Security Radio Band Channel SSID BSSID RSSI Max Data Rate Network Type Security Radio Band Channel SSID BSSID RSSI Max Data Rate Network Type Security Radio Band channel SSID BSSID RSSI Max Data Rate Network Type Security Radio Band Channel 1 WEP mars CC 33 CC 99 39 39dBm 54 0 Infrastructure WPA2 AES 2 4GHz 2 jupiter E
35. e listed in Table 4 2 WiFi Security WiFi Security Mode Description 2 WiFi Protected Access WiFi Protected Access 2 WPA WPA2 WiFi Protected Access and WiFi Protected Access 2 Table 4 2 Network WiFi Security Modes Usage C3 lt WiFi Security Modes CR Default Value C320 4 6 4 C4 Set Network DHCP Dynamic Host Configuration Protocol DHCP is used to query a network for an available IP Address that would be used for communications on the network The eS WiFi module can use DHCP or a user defined IP Address The eS WiFi module must have an IP Address to communicate with a wireless network The Network DHCP Modes are listed in Table 4 3 DHCP Mode Disabled User supplied IP Address Enabled Network supplied IP Address Table 4 3 Network DHCP Modes Preliminary Subject to change eS WiFi Module AT Command Set Version v1 4 20 Gs Inventek Systems Embedding Connectivity Everyanere DOC UM 20035 1 4 User Manual eS WiFi Module Usage C4 lt DHCP Modes gt lt CR gt Default Value C4 1 4 6 5 C5 Set Network IP Version Set Network IP Version is used to select between Internet Protocol Version 4 IPV4 and Internet Protocol Version 6 IPV6 The IP Version must be set for correct operation of the eS WiFi module on a wireless network The Network IP Version settings are listed in Table 4 4 IP IP Version Version Mode IPV4 IPV6 Table 4 4 Network IP Version Modes Usage C5 lt IP Version
36. eive timeout 5000 ms OK gt Perform Read of Remote Client gt RO testing 1234567890 OK gt Write data to Remote Client gt 50 0123456789 timeout detected bytes sent 10 OK gt The timeout was detected because the packet size was set to 1200 bytes but only 10 bytes were written to the remote client After a 5000 millisecond delay and no further data the 10 bytes were sent 5 6 2 TCP Client Setup and Data Transport The first step in setting up the eS WiFi Module to be a client on a Network assuming the eS WiFi has been joined to a Network is to set the protocol mode the remote port number and remote server IP Address Once the eS Wifi Module has been set up as a client for TCP data transfer data can then be written and read from a remote server on the network Preliminary Subject to change eS WiFi Module AT Command Set Version v1 4 49 Gs Inventek Systems ee eee DOC UM 20035 1 4 User Manual eS WiFi Module 5 6 2 1 TCP Client Set Up Set protocol to TCP gt P1 0 OK Set remote Server IP Address gt P3 192 168 1 110 OK Set remote TCP Port Number to 5025 gt P4 5025 OK gt Enable TCP Client mode gt P6 1 Connecting to 192 168 1 110 OK gt Once the TCP Client mode AT Command returns to the console a connection has been established with a remote server or an error message will be generated on a connection failure Check TCP Client Mode Configuration gt P
37. er and letter case letters and numbers Future support for binary data transfers to be added Preliminary Subject to change eS WiFi Module AT Command Set Version v1 4 Gs Inventek Systems DOC UM 20035 1 4 User Manual eS WiFi Module 2 Hardware Interface and Module Operation The eS WiFi module supports RS 232 Serial Communications Universal Serial Bus USB and Serial Peripheral Interface Bus SPI A Micro Controller or System Host can easily interface to the eS WiFi module using one of the support hardware interfaces The eS WiFi module has two modes of operation Human Readable Mode and Machine Readable Mode 2 1 RS 232 Serial Communication 2 1 1 Data Mode When the eS WiFi module is interfaced serially the serial interface needs to be configured for 8 bit data no parity and one stop bit 8 n 1 2 1 2 Flow Control The eS WiFi module doesn t require or support Flow Control so Flow Control should be None 2 1 3 Supported Baud Rates The eS WiFi module supports the following serial baud rates Basic Rates 1200 2400 4800 9600 19200 38400 57600 115200 230400 460800 921600 Extended Rates 1152000 1382400 1612800 1834200 2073600 M3G Only 2 1 2 Default Serial Configuration The eS WiFi module is shipped with the default serial configuration of 115200 baud 8 data bits no party and 1 stop bits 2 2 USB Universal Serial Bus TBD 2 3 SPI Serial Peripheral Interface Bus TBD 2 4 Mod
38. for network port to port communications The Transport Protocols modes are listed in Table 4 6 Transport Protocol Transport Protocol Mode TCP Enabled UDP Enabled UDP Lite Enabled Table 4 6 Transport Protocol Modes Usage P1 lt Transport Protocol Modes CR Default Value P120 4 11 3 P2 Set Transport Local Port Number Set Transport Local Port Number allows the user to define the local port that the eS WiFi module will listen on for Transport communication connections Input range for Transport Local Port Number is 0 to 65535 Usage P2 lt Transport Local Port Number CR Default Value P2 5024 Refer to documentation on TCP UDP communications for pre defined port information 4 11 4 P3 Set Transport Remote Host Port IP Address Set Transport Remote Host IP Address is a user defined address that eS WiFi module will used to contact a Transport server on the network The Transport Remote Host IP Address must be entered in dotted decimal notation which is defined as xxx xxx xxx xxx for the network address Usage lt gt lt gt Default Value 000 000 000 000 Preliminary Subject to change eS WiFi Module AT Command Set Version v1 4 30 Gs Inventek Systems Embedding eer DOC UM 20035 1 4 User Manual eS WiFi Module 4 11 5 P4 Set Transport Remote Port Number Set Transport Remote Port Number allows the user to define the port number for a Transport Server o
39. ge U2 lt Baud Rate CR Default Value U2 115200 4 15 3 U Show UART Setting Return current UART Configuration Usage U lt CR gt Field 1 2 3 4 5 6 Function Port Baud Data Parity Stop Mode Rate Width Bit s Default Value None 4 16 System Information 4 16 1 Z0 Reset To Factory Defaults Reset the current user space settings to factory default The setting are not saved until a Z1 command is issued Usage Z0 lt CR gt Default Value None 4 16 2 Z1 Save Current Settings Saves the current user setting to the space selected with the Z3 command Usage Z1 lt CR gt Default Value None Preliminary Subject to change eS WiFi Module AT Command Set Version v1 4 38 Gs Inventek Systems eda i DOC UM 20035 1 4 User Manual eS WiFi Module 4 16 3 Z2 Clear Saved Settings Clears the save settings space based upon the space selected with the Z3 command Usage Z2 lt CR gt Default Value None 4 16 4 Z3 Set Factory User Space Selects the space that will be used by the Z1 and Z2 commands Usage Z3 lt Value gt lt CR gt Default Value None 4 16 5 Z4 Set MAC Address Sets the MAC address Usage Z4 lt XX XX XX XX XX XX gt lt CR gt Default Value None 4 16 6 Z5 Get MAC Address Gets the MAC address Usage Z5 lt CR gt Default Value None 4 16 7 Z6 Set Access Point IP Address Sets the Access Point IP address Usage Z6 lt XXX XXX XXX XXX gt lt CR gt Defau
40. ice to drop the AT in front of a device control command and just use the device control function command letters and number combinations Inventek System has adopted this method for controlling the functions of the eS WiFi module In addition Inventek System has Preliminary Subject to change eS WiFi Module AT Command Set Version v1 4 Gs Inventek Systems Embedding Connectivity Everywhere DOC UM 20035 1 4 User Manual eS WiFi Module added an to the command to delimit the command from its data For example the AT Command to set the eS WiFi module s IP Address would be C6 127 0 0 1 instead of ATC6 127 0 0 1 Also a number of AT Commands for the eS WiFi module only use a single letter or a single letter plus number to execute the command For instance will return available help information on the eS WiFi module While a CO command would command the eS WiFi module to joined a network The format for entering AT Commands is shown as follows lt AT Command gt lt optional gt lt data if is used gt lt Carriage Return CR gt or lt AT Command gt lt CR gt All AT Commands must be followed by a lt CR gt to activate the command Empty string values for AT Commands are shown with NONE in the User Manual Supported character sets Currently the eS WiFi module only supports 8 bit ASCII All AT Commands must be in capital letters however data can contain both upp
41. igure UART The eS WiFi module can be configured to use its serial interface for communications with a host computer or terminal console programs Currently the only UART Configuration mode for the eS WiFi module is the serial interface which is set to 8 data bits no parity one stop bits The eS WiFi modules can support baud rates from 1200 to 2073600 baud The AT Command U2 is used to set the baud rate The eS WiFi module interface can also be set up in ASCII or Binary mode for data In addition the eS WiFi module can be configured to generate timeout messages on the serial communications 4 15 1 UO Activate UART Settings The AT Command UO is used to store the current eS WiFi module UART settings in non volatile memory for power on or after a reset for automatic configuration of the UART Usage U0 lt CR gt Default Value None 4 15 2 U2 Set UART Baud Rate The AT Command U2 is used to set the baud rate for the Comm Port selected using the AT Command U1 Table 4 10 list the available eS WiFi module baud rates Basic Baud Rates 4800 9600 38400 57600 230400 460800 921600 Table 4 10 Basic Baud Rates Preliminary Subject to change eS WiFi Module AT Command Set Version v1 4 37 Gs Inventek Systems Embedding elisa DOC UM 20035 1 4 User Manual eS WiFi Module Extended Baud Rates M3G Version Only 1152000 1382400 1612800 1843200 2073600 Table 4 11 Extended Baud Rates Usa
42. il text formatted information to the user when the command is executed Command Mode is helpful when debugging network interfaces or interaction with the eS WiFi module Usage lt CR gt Default Value None 4 3 Exit Command Mode Command Mode is exited via which places the eS WiFi module in Machine Readable mode where AT Commands generate short limited coma delimited information on the execution of a command Machine mode is intended for Micro Controller or Host System control of the eS WiFi module Usage lt CR gt Default Value 4 4 Access Point Used to setup the internal Access Point Network Access 4 4 1 A0 Activate Access Point Starts the Access Point DHCP Server DNS Server and Web Server Usage A0 lt CR gt Default Value None Preliminary Subject to change eS WiFi Module AT Command Set Version v1 4 16 Gs Inventek Systems doc ll DOC UM 20035 1 4 User Manual eS WiFi Module 4 4 2 A1 Set Access Point Security Mode Set the security mode for the Access Point Usage A1 lt Mode gt lt CR gt WiFi Security WiFi Security Mode Description No WiFi Security Reserved Not Valid m 7j WiFi Protected Access WiFi Protected Access 2 WPA WPA2 WiFi Protected Access and WiFi Protected Access 2 Default Value 0 Open 4 4 3 A2 Set Security Key Security Key can be up to 32 characters and is an unique security keyword for access to a wireless network A
43. l be sent to a connected Transport Server or Client Once the number bytes defined by AT Command S1 have been sent the eS WiFi module will return back to the AT Command mode waiting for the next AT Command If more bytes are written to the eS WiFi module than are defined by the AT Command S1 the data will be lost and error message will be returned on the excess data written to the eS WiFi module selected communication interface Usage SO CR 4 13 2 S1 Set Write Transport Packet Size bytes AT Command S1 is used to define the packet size of data to write to a connected Transport Server or Client The AT Command S1 should be set before a performing AT Command SO Usage S1 lt Data Packet Size CR Default Value S1 1200 4 13 3 S2 Set Write Transport Timeout ms The AT Command S2 is a user defined value for the amount of time in milliseconds to wait on the Write Transport Data AT Command R2 to finish The input range for S2 is 0 to 30000 milliseconds Usage S2 lt Write Transport Timeout gt lt CR gt Default Value S1 5000 4 13 4 S Show Write Transport Settings Return current Write Transport Data Settings Usage S CR Field 1 2 Function Number of Timeout Bytes Default Value None Preliminary Subject to change eS WiFi Module AT Command Set Version v1 4 35 Gs Inventek Systems eee DOC UM 20035 1 4 User Manual eS WiFi Module 4 14 Ping IP Target Address Ping is a network u
44. lt value 192 168 10 1 Preliminary Subject to change eS WiFi Module AT Command Set Version v1 4 39 Gs Inventek Systems DOC UM 20035 1 4 User Manual eS WiFi Module 4 16 8 Z7 Set WPS Pin Sets the 8 digit numeric WPS WiFi Protected Setup pin number Usage Z7 lt XXXXXXXX gt lt CR gt Default Value None 4 16 9 Z8 Get WPS Pin Gets the WPS WiFi Protected Setup pin number Usage Z8 lt CR gt Default Value 12345678 4 16 10 29 Set USB VID PID Sets the USB VID Vendor ID and the PID Product ID Valid only when firmware supports USB Usage Z9 lt XXXX XXXX gt lt CR gt Default Value None 4 16 11 ZC Clear Factory Lock Switch Clears the Factory Lock switch allowing the factory flash space to be changed Usage ZC 0 lt CR gt Default Value None 4 16 12 ZD Flash Dump Dumps the selected space from the Z3 command to the host interface Usage ZD lt CR gt Default Vale None 4 16 13 ZF Set Factory Lock Switch Sets the Factory Lock switch making the Factory space not changable Usage ZF 1 lt CR gt Default Value 0 Unlocked Preliminary Subject to change eS WiFi Module AT Command Set Version v1 4 40 Gs Inventek Systems DOC UM 20035 1 4 User Manual eS WiFi Module 4 16 14 ZN Set Product Name Sets the Product Name reported by the Access Point web pages the l and Z commands The name can be up to 32 alphanumeric characters long Usage ZN lt Product Name gt
45. movement of data over a network however UDP does not guarantee the delivery of data between a server and a client UDP lite is UDP with the partial removable of checksums which may improve network data movement performance but may be more prone to data errors The eS WiFi module supports TCP UDP and UDP lite for port to port communication The eS WiFi module can be configured as a server or client on a network for TCP UDP communication In Transport server mode the eS WiFi module will wait in the background for connection requests Once a network device request a connection to the server the server will enter a mode were data can be requested by a client and data delivered to a client The eS WiFi module can also be configured as a client for TCP UDP communications to make requests to a Transport server on the wireless network If UDP or UDP lite is used it is recommended that the user develop their own packet numbering and error checking for data transfers Preliminary Subject to change eS WiFi Module AT Command Set Version v1 4 29 Gs Inventek Systems DOC UM 20035 1 4 User Manual eS WiFi Module 4 11 1 PO Activate Transport Settings Store Transport configurations to non volatile memory for power on or after a reset default configuration Usage PO lt CR gt Default Value None 4 11 2 P1 Set Transport Protocol Set Transport Protocol allows the user to enable selection of ether TCP UDP or UDP Lite
46. n the network that the eS WiFi module will use for communications with that server Input range for Local Port is 0 to 65535 Usage P4 lt Local Port gt lt CR gt Default Value P4 5025 4 11 6 P5 Stop Start Transport Server Stop Start Transport Server is used to stop or start the eS WiFi module s Transport Server mode The AT Command P1 is used to select between TCP UDP or UDP Lite server protocols The Transport Server Transport Server Transport Server Mode modes are listed in Table 4 7 Server Disable Server Enable Figure 4 7 Transport Server Modes Usage P5 lt Transport Server Modes gt lt CR gt Default Value P5 0 4 11 7 P6 Stop Start Transport Client Stop Start Transport Client is used to stop or start the eS WiFi module s Transport Client mode The AT Command P1 is used to select between TCP UDP or UDP Lite server protocols The Transport Server modes are listed in Table 4 8 Transport Client Transport Client Mode Client Disable Client Enable Figure 4 8 Transport Server Mode Usage P6 lt Transport Client Modes gt lt CR gt Default Value P5 0 Preliminary Subject to change eS WiFi Module AT Command Set Version v1 4 31 Gs Inventek Systems Aa i lala DOC UM 20035 1 4 User Manual eS WiFi Module 4 11 8 P7 Start Stop Request TCP Loop Controls the Request TCP Loop Closing socket allows the next listen backlog to be handled Usage P7 lt Value gt lt CR gt L
47. ommand Set Version v1 4 56 Gs Inventek Systems SEE DOC UM 20035 1 4 User Manual eS WiFi Module 7 Document Revision History ome me oon mmm mmn ne arcomra sannan been ser wr r commorari saon 1 2 2012 RES Added Usage Examples He o AT Command Set r1 2 docx 3 12 2012 Changed Logo as AT Command Set r1 3 docx 11 21 12 SEP Update with new commands m AT Command Set r1 4 docx Preliminary Subject to change eS WiFi Module AT Command Set Version v1 4 57 Gs Inventek Systems DOC UM 20035 1 4 User Manual eS WiFi Module Inventek Systems Embedding Connectivity Everywhere Inventek Systems 2 Republic Road Billerica MA 01862 www inventeksys com Preliminary Subject to change eS WiFi Module AT Command Set Version v1 4 58
48. ons the number bytes sent to the server must match the number bytes to read any additional data sent to the server may be lost Set 1200 byte packet size for Read range 1 to 1200 gt R1 1200 OK gt Set five second timeout for Read in milliseconds range 0 to 5000 gt R2 5000 Check Read Configuration gt R Number of TCP UPD bytes to receive per read 1200 TCP UPD receive timeout 5000 ms OK gt Perform Read of Remote Client gt RO testing 1234567890 OK gt Write data to Remote Client gt 50 0123456789 timeout detected bytes sent 10 OK gt The timeout was detected because the packet size was set to 1200 bytes but only 10 bytes were written to the remote client After a 5000 millisecond delay and no further data the 10 bytes were sent Preliminary Subject to change eS WiFi Module AT Command Set Version v1 4 52 Gs Inventek Systems Embedding Connectivity Everywhere DOC UM 20035 1 4 User Manual eS WiFi Module 5 6 4 UDP Client Setup and Data Transport The first step in setting up the eS WiFi Module to be a client on a Network assuming the eS WiFi has been joined to a Network is to set the protocol mode the remote port number and remote server IP Address Once the eS Wifi Module has been set up as a client for UDP data transfer data can then be written and read from a remote server on the network 5 6 4 1 UDP Client Set Up Set protocol to UDP gt 1 0 O
49. oop Function Stop Start Close Socket Default Value P7 0 4 11 9 P8 Set Listen Backlogs Set the number of listen backlogs TCP connection requests that can be queued Usage P82 value CR Range 1 to 30 backlogs Default Value P8 1 4 11 10 PR Packet Bypass Mode PBM Read Mode Set the Packet Bypass Mode PBM In this mode Ethernet packets are forwarded from the WiFi interface bypass the internal TCI IP stack and are presented to the host interface Bypass Value Mode 397 Normal No Bypass Forward All Usage PR2 Value CR Forward Non ARP Copy All Copy Non ARP Note In all mode the packets forwarded or copied can be filtered with the PF command Default Value PR 0 Preliminary Subject to change eS WiFi Module AT Command Set Version v1 4 32 Gs Inventek Systems DOC UM 20035 1 4 User Manual eS WiFi Module 4 11 11 PW Packet Bypass Mode PBM Write Packet This writes Ethernet packets directly to the WiFi interface bypassing the internal TCP IP stack Usage PW lt NOB gt lt DATA gt lt CR gt NOB Number of Bytes to send Data Ethernet Packet 1516 Bytes Max Default Value None 4 11 12 P Show Transport Settings Return current Transport Communication Settings Usage P lt CR gt Field 1 2 3 4 5 6 7 Function Protocol Client Local Host Remote TCP UDP IP Port IP Port Server Server Field 8 9 10 Function TCP Accept Read Backlogs Loop Mode
50. ost effective high volume manufacturing Copyright 2011 Inventek Systems Technical support Engineering inventeksys com Preliminary Subject to change eS WiFi Module AT Command Set Version v1 4 Gs Inventek Systems sia ii DOC UM 20035 1 4 User Manual eS WiFi Module AT Command Set User Manual Table of Contents To INTRODUCTION esee 8 1 1 SCOPE 8 1 2 AT COMMAND USAGE IN THE USER MANUAL IS SHOWN AS 8 1 3 SUPPORTED PRODUCT VERSIONS 8 1 4 AT COMMAND SET 8 1 4 Entering AT le esee eri e re rue cn rane 8 2 HARDWARE INTERFACE AND MODULE OPERATION 10 2 1 RS 232 SERIAL COMMUNICATION P SNPICBUsolree REA SENE 2 1 2 FIOW O ERIS 2 1 3 Supported Baud Rates 2 1 2 Default Serial Configuration 2 2 USB UNIVERSAL SERIAL BUS 2 3 SPI SERIAL PERIPHERAL INTERFACE BUS 2 4 MODULE OPERATION MODES 2 4 1 Human Readable Mode 908 S 2 4 2 Machine Readable Mode f 11 3 AT COMMAND SET VERSION 2 0
51. ow Scan Settings 4 9 GPIO INFORMATION 4 9 1 G2 Read GPIO AD W a 4 9 2 G3 Write ME p Em 4 9 4 G Show GRIO Settiggs u 9 4 10 SOFTWARE INFORMATION 4 10 1 I Show Applications Information 4 11 TRANSPORT COMMUNICATION Activate Transport Settings 781 2 5 Trafisport Protocol sccsssscccsssssecssssnsesessoccssssssecssssnsessenceeesnseseceensssusessecensussecesensssensesaeessueass 4 11 3 P2 Set Transport Local Port Number enne enne eene enne 4 11 4 P3 Set Transport Remote Host Port IP Address 4 11 5 P4 Set Transport Remote Port Number 4 11 6 P5 Stop Start Transport Server ehem nennen nne traten nnne nennen 4 11 7 PG Stop Start Transport Client ener enne tranne sn 4 11 8 P7 Start Stop
52. s found Usage F0 lt CR gt Default Value None Preliminary Subject to change eS WiFi Module AT Command Set Version v1 4 26 Gs Inventek Systems ee ee DOC UM 20035 1 4 User Manual eS WiFi Module 4 8 2 F1 Set Scan Repeat Count Set Repeat Count is a user defined value that controls the number of times to scan for Network Access Points Input range for Set Scan Repeat Count is 0 to 255 Usage F12 Set Scan Repeat Count CR Default Value 0 4 8 3 F2 Set Scan Delay Set Scan Delay is a user defined value that sets the amount of time in milliseconds to wait between scans for Network Access Points Input range for Set Scan Delay is 0 to 5000 which represents the delay in milliseconds Usage F2 lt Set Scan Delay gt lt CR gt Default Value 1000 4 8 4 F Show Scan Settings Returns current Scan Settings Usage F lt CR gt Field 1 2 3 4 5 6 7 Function Repeat Delay 1 Repeat ms Default Value None 4 9 GPIO Information 4 9 1 G2 Read GPIO ADC Reads the current value of the specified GPIO or ACD pin Usage G2 lt Pin Number Value CR Dita np Default Value None Preliminary Subject to change eS WiFi Module AT Command Set Version v1 4 27 Gs Inventek Systems Embedding Connectivity Peres DOC UM 20035 1 4 User Manual eS WiFi Module 4 9 2 Write GPIO Writes the current value of the specified GPIO pin Usage G3 lt Pin Number gt lt Type Value gt lt Value
53. tility for testing the reachability of hosts on a network Ping will measure the round trip time to a host or return a timeout if the host is not reachable 4 14 1 TO Ping IP Target Address The AT Command TO will Ping a remote host returning the round trip time or a timeout message The host IP Address used by Ping must be set by using the AT Command T1 Usage T0 lt CR gt Default Value None 4 14 2 T1 Set Ping Target Address The AT Command T1 is used to set the IP Address of the host to Ping Usage 1 lt gt lt gt Default Value 000 000 000 000 4 14 3 T2 Set Ping Repeat Count The AT Command T2 is used to define the number of times to repeat a Ping of a host on the network Usage T2 Repeats CR Default Value 2 0 4 14 4 T3 Set Ping Delay ms The AT Command T3 is used to define the amount of time to wait between Pinging a host on the network The amount of time to wait is defined in milliseconds and is limited to the range of 0 to 5000 Usage T3 lt delay in ms CR Default Value T320 4 14 5 T Show Ping Settings Return current Ping Settings Usage T lt CR gt Field 1 2 3 Function Target IP Repeats Delay Address 1 Repeats Default Value None Preliminary Subject to change eS WiFi Module AT Command Set Version v1 4 36 Gs Inventek Systems Embedding Connectivity Everywhere DOC UM 20035 1 4 User Manual eS WiFi Module 4 15 Conf
54. ule Operation Modes The eS WiFi module has two modes of operation Human Readable Mode verbose and Machine Readable Mode that can be used to control the operation of the module At power up the eS WiFi module defaults to Machine Readable Mode An AT command is used to put the eS WiFi module into Human Readable Mode or Machine Readable Mode Preliminary Subject to change eS WiFi Module AT Command Set Version v1 4 10 Embedding Connectivity Everywhere 2 4 1 Human Readable Mode In Human Readable Mode a user can interact with the module via the module s built in console and a serial terminal program All AT commands will return detail information related to the operation of the command Gs Inventek Systems DOC UM 20035 1 4 User Manual eS WiFi Module 2 4 2 Machine Readable Mode Machine Readable Mode is intended for direct control of the eS WiFi module operation via a Micro Controller or System Host All AT commands will return short limited information about operation of the command Preliminary Subject to change eS WiFi Module AT Command Set Version v1 4 11 Gs Inventek Systems s eee DOC UM 20035 1 4 User Manual eS WiFi Module 3 AT Command Set Version 2 0 3 1 AT Command Set List of Supported Functions Preliminary Subject to change eS WiFi Module AT Command Set Version v1 4 12 Gs Inventek Systems Embedding Connectivity Everywnere DOC UM 20035 1 4 User Manual eS WiFi Module Add Remove MAC To From MCAS
55. without first closing the current network connection Usage C0 lt CR gt Default Value None 4 6 2 C1 Set Network SSID Network Service Set Identifier SSID can be up to 32 characters and is an unique identifier network name for a wireless network The eS WiFi module must use the SSID Passphrase and WiFi Security to communicate with a wireless network The SSID is normally supplied by a network administrator Usage C1 lt SSID gt lt CR gt Default Value C1 NONE Preliminary Subject to change eS WiFi Module AT Command Set Version v1 4 19 Gs Inventek Systems sicui la adi iba DOC UM 20035 1 4 User Manual eS WiFi Module 4 6 2 C2 Set Network Passphrase Network Passphrase can be up to 32 characters and is an unique security keyword for access to a wireless network The eS WiFi module must use the Passphrase associated with the network SSID and the WiFi Network Security to communicate with a wireless network The Passphrase is normally supplied by a network administrator Usage C2 Passphrase CR Default Value 2 4 6 3 C3 Set Network Security Type Select the WiFi Network Security to use for communication with a WiFi network Below is a list of WiFi Security Modes The eS WiFi module must use one the WiFi Security modes with the associated SSID and Passphrase to communicate with a wireless network The WiFi Security is normally supplied by a network administrator The Network WiFi Security Modes ar
Download Pdf Manuals
Related Search