Home

AT Command Set User`s Manual

Contents

1. 37 MS REPCAIACOUNL sccssssscesnsssssscssccssssssesessssssensccssssscssnssssaseneccssssecaeasssscsnaccnsssasacensesesnecesssessnes 38 CENA de 38 LE ue uses b 38 4 9 5 MES Et ScamBSSID uuu u nu trei epe e dr eR eR ERR Eo EN AE FREE EXE FARE abyss XR o ERES eR Rua ha dias 38 49 6 FS SEMRSCAMl D DUE 38 4 9 7 F Show Scan Settings eer Co Ra Veo Rev Et eee ere 39 4 10 GPIO ADC INFORMATION 39 4 10 71 62 C pEcu ojZ bs 39 ZI ACE E ERa 40 4 103 GA GPIO tenses 40 4 10 4 G SHOW GPIO SEINES eironi rare NRTK m 41 4 11 SOFTWARE INFORMATION 41 4 11 1 12 Show Applications Information 41 Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 Gop nen Systems TE EE DOC UM 20035 4 1 User Manual eS WiFi Module 4 12 MISCELLANEOUS COMMAND 41 4 12 1 MF Test External Serial Flas Pesen u u theres ea thee exec hee haere EE a exe et la ere 41 4 12 2 MR MESSAGE READ SPI ONLY 42 4 12 3 MS Suppress Async Message DHCP csssseccececssssssseesececsesensneesececeesesscess
2. 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 CR to activate the command Empty string values for AT Commands are shown with NONE in the User Manual The Supported character sets Currently the eS WiFi module only supports 8 bit ASCII AT Commands must be in capital letters however data can contain both upper and letter case letters and numbers Future support for binary data transfers to be added 1 4 2 eS WiFi Command Formats All AT commands sent to the module must be formatted as follows 2 Character Command _ v 2 Character Command Note 1 v Carriage Return For example gt P120 gt PK 1 3000 r gt qm Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 10 Gs Inventek Systems Embedding Connectivity Everywhere DOC UM 20035 4 1 User Manual eS WiFi Module All AT command responses from the module will follow this format Response Formats Delimeter Payload Delimeter Return X Delimeter Prompt Data sp ErorType WA Usage sp Notes 1 v Carriage Return nzNew Line 3 sp gt space For example WnDATAWnOKWn sp WnERRORWRn
3. Gop nen Systems DO la DOC UM 20035 4 1 User Manual eS WiFi Module 4 7 DNS Commands 4 7 1 DO DNS Lookup This command performs a DNS lookup of a Domain Name to get its IPv4 address The Domain Name is limited to 64 characters Usage D0 Domain Name gt lt CR gt Default Value None Example gt DO www yahoo com 98 139 183 24 OK gt 4 7 2 D1 Set mDNS State and Name This command Enables Disables the use of mDNS and sets the Device name This is supported in C2 4 0 or greater Usage D1 lt 0 1 gt lt Device Name gt lt CR gt Default None Example gt D1 1 es WiFi43362 1 OK gt 4 7 3 D2 Set mDNS Services This command sets up the 2 available services The status will be displayed as part of the Join message 2 This is supported in C2 4 0 or greater Usage D2 lt Service 0 1 gt lt Instance 32chars gt lt Service 32Chars gt lt Port gt lt TTL gt Default None Example gt D2 0 0 OK 1 gt CO JOIN SSID 192 168 2 18 0 0 OK gt Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 36 Gop nen Systems BaN DOC UM 20035 4 1 User Manual eS WiFi Module Example 2 gt Dl 1 test 1234 OK gt D220 1 web service web service tcp local 80 60 OK gt CO JOIN istest 001 10 0 0 3 1 0 OK gt mDNS Listener Listening for multicast messages on 224 0 0 251
4. Inventek Systems Embedding Connectivity Everywhere eS WiFi Module AT Command Set IWIN User Manual Inventek Systems 2 Republic Road Billerica MA 01862 Phone 978 667 1962 www Inventeksys com eS WiFi Module User Manual Gop nen Systems iilis ai d DOC UM 20035 4 1 User Manual eS WiFi Module eS WiFi Module embedded Serial to WiFi AT Command Set IWIN User Manual Inventek Systems Inc Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 Gop nen Systems ee DOC UM 20035 4 1 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 NA A NM A J M N I b hZ Inventek Systems Embedding Connectivity Everywhere Copyright c 2011 TH C3 W _ 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
5. MACEDONIA FORMER YUGOSLAV REPUBLIC OF MADAGASCAR MALAWI MALAYSIA MALDIVES MALI MALTA MAN SLE OF MARTINIQUE MAURITANIA 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 LG 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 v4 1 77 Inventek Systems Embedding Connectivity Everywhere DOC UM 20035 4 1 User Manual eS WiFi Module Country DENMARK DJIBOUTI DOMINICA DOMINICAN_REPUBLIC ECUADOR EGYPT EL_SALVADOR EQUATORIAL_GUINEA ERITREA ESTONIA ETHIOPIA FALKLAND ISLANDS MALVIN
6. Set Product Name Sets the Product Name reported by the Access Point web pages the and Z commands The name can be up to 32 alphanumeric characters long Usage ZN lt Product Name gt lt CR gt Default Value Inventek Systems eS WiFi Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 61 Qe nen Systems eee ee DOC UM 20035 4 1 User Manual eS WiFi Module 4 19 15 ZO OTA Firmware Update Get the URL for the update firmware downloads to external serial flash and then updates the micro processors on board flash and re boots Usage Z0 lt 1 128 gt lt CR gt lt URL Bytes http domain port bin_file_path gt Default Value None 4 19 16 ZP Power Management Enable Disable Power Management features Usage ZP lt Feature gt lt Value gt lt CR gt Fo WHO Al Power Save Of Power Save Off Power Save On Beacon Interval sec L3 p owe s Default Value Feature 0 WiFi On All Power Save Off 4 19 17 ZR Reset Module Software reset of the module The equivalent of using the RTSN pin Usage ZR lt CR gt Default Value None Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 62 Qe nen Systems Embedding Connectivity Everywhere DOC UM 20035 4 1 User Manual eS WiFi Module 4 19 18 ZU Firmware Upgrade M3G Only uses STM32F205 boot loader Starts the STM32F205 built in boot loader to upgrad
7. ccscccsssceessecseceessecsscecstecsssceeseecstesesssessececseecsasceseecsaseccatecsaseecseecsaeeecaseceas 33 4 6 17 CM Add Remove MAC Address To From Multicast Allow List Packet Bypass Mode 34 4 6 18 CN Set Country Esso 34 4 6 19 CR Get RSSI of Associated Access Point ccsceccccesseeceeeecececenneecseuececsecaececeeneeceeaueeeceeaaeseseueeeeseneeeeseaas 34 4 6 20 CS Connection Status _ 34 4 6 21 CW Connect using WPS Pin or PBC nn 35 4 6 22 Show Network 5 Saa _ 35 4 7 DNS COMMANDS 36 4 7 1 DO DNS 9 enne rente nennen sanete TS 36 4 7 2 DT Set mDN State MD ssssccccssssesssssccsssssccssssnsccseneceesssceacsensssecseeceesssseecesnnssessssasseseeees 36 4 8 USB COMMANDS 37 4 8 1 E2 E E A 37 4 9 SCAN FOR NETWORK ACCESS POINTS 37 4 9 1 FO Sean folglietwork ABGESS Points
8. 1 User Manual eS WiFi Module Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 16 Qe nen Systems al aka DOC UM 20035 4 1 User Manual eS WiFi Module Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 17 Qe nen Systems PECTORE DOC UM 20035 1 User Manual eS WiFi Module Reset Module Firmware Upgrade M3G Only use STM32F205 boot loader ZN Set OTA Method 2 Show System Settings Table 3 1 AT Command Set List Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 18 Qe nen Systems Embedding Connectivity Everywhere DOC UM 20035 4 1 User Manual eS WiFi Module 4 AT Command Detail Description 4 1 Print Help Message Print Help menu to console Usage CR Default Value None 4 2 Enter Command Mode Command Human Readable Mode is entered via While in Command mode all AT Commands return detail 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 Response from eS WiFi gt Entering CMD Mode OK gt 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
9. IP Version Modes Usage C5 lt IP Version Modes CR 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 xxx xxx xxx xxx 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 v4 1 30 Qe nen Systems Embedding Connectivity Everywhere 4 6 8 C8 Set Network Gateway DOC UM 20035 4 1 User Manual eS WiFi Module Set Network Gateway is a user defined Gatew
10. Interface Settings Return current Communication Interface settings Host Value Interface UART Usage B CR Field 1 2 3 4 5 6 7 Function Host N A N A N A N A N A N A Interface Default Value None Response from eS WiFi in UART Mode gt 0 gt 4 5 2 B2 Set SPI Mode Set the SPI mode for phase and polarity Usage B2 value CR CPOL 0 CPHA 0 CPOL 0 CPHA 1 POL 1 CPHA 0 POL 1 CPHA 1 Default 0 Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 25 Gop nen Systems hae aba DOC UM 20035 4 1 User Manual eS WiFi Module 4 5 3 B3 Set SPI Ready Pin Sets whether the WKUP pin is has the SDRDY signal for design that didn t implement the SDRDY pin SDRDY ADCO Only Usage B3 value CR 1 SDRDY ADCO and WKUP Default 0 Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 26 Gop nen Systems Embedding Connectivity Everywhere DOC UM 20035 4 1 User Manual eS WiFi Module 4 6 Configure Network Settings Used to set up the network parameters needed to access a Wi Fi network The eS WiFi can connect to a network using three techniques depending upon your application 1 Your microcontroller can issue a series of AT commands starting with C1 as outlined in this section 2 You can setup a Direct Connection a private network as detailed in section above 3 You can start the Access Point and a web s
11. Multi Accept Server Close Socket Multi Accept Server Enable Figure 4 7 Transport Server Modes Usage P5 lt Transport Server Modes CR Default Value P5 0 4 13 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 Transport Client Client Mode Client Disable Figure 4 8 Transport Server Mode Usage P6 lt Transport Client Modes CR Default Value P5 0 Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 46 Gop nen Systems ee ee DOC UM 20035 4 1 User Manual eS WiFi Module 4 13 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 Loop Function Stop Start Close Socket Get Next Connection Default Value P7 0 4 13 9 P8 Set Listen Backlogs Set the number of listen backlogs TCP connection requests that can be queued Usage P8 value CR Range 1 to 6 backlogs Default Value P8 1 4 13 10 PA Set Custom Certificate Authority Set a custom certificate authority name for simple verification of the SSL certificate Usage PA lt index 0 1 gt lt Custom CA 63 characters max gt lt CR gt Default Value None Prelimina
12. 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 Seitings gt T Ping Target Address 192 168 1 90 Ping Repeats 5 Ping Delay 500 ms OK gt Ping 192 168 1 90 on the network for five times with a 500 millisecond delay between pings gt TO Pinging 192 168 1 90 Ping Reply 32ms Pinging 192 168 1 90 Ping Reply 5ms Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 68 Gop nen Systems Embedding Sonngcivity Everyiinere DOC UM 20035 4 1 User Manual eS WiFi Module Pinging 192 168 1 90 Ping Reply 3ms Pinging 192 168 1 90 Ping Reply 4ms Pinging 192 168 1 90 Ping Reply 6ms OK 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 TC
13. Press CTRL C to quit Port 80 is open on 10 0 0 3 4 8 USB Commands 4 8 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 9 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 9 1 FO Scan for Network Access Points Find Networks can be used to scan for available networks and return information about the networks found Usage F0 lt CR gt Default Value None Responses 001 SSID1 08 86 3B 2B 7E 2E 51 54 0 Infrastructure WPA2 AES 2 4GHz 1 002 SSID2 C0 C1 C0 88 9F 6A 53 54 0 Infrastructure WPA2 AES 2 4GHz 6 1 003 SSID3 00 24 B2 B1 E9 FD 61 54 0 Infrastructure Open 2 4GHz 11 OK gt Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 37 Gop nen Systems Embeddi
14. 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 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 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 and 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 Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 72 Gop nen Systems Embedding Connectivity Everywhere 5 6 3 1 UDP Server Set Up DOC UM 20035 4 1 User Manual eS WiFi Module Set protocol to UDP gt Pl 1 OK Set local UDP Port Number to 5024 gt 2 5024 OK gt Enable UDP Server mode the
15. command Machine mode is intended for Micro Controller or Host System control of the eS WiFi module This document is focused on users connecting the eS WiFi to a microcontroller so the responses document will not be in Command Mode Usage lt CR gt Default Value Response from eS WiFi gt Exiting CMD Mode OK gt 4 4 Access Point Used to setup the internal Access Point Network Access The eS WiFi runs a Soft Access Point that allows a user to setup a connection to a local network as a STA Client on that network or serve up a HTML page to a user Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 19 Gop nen Systems Embedding Connectivity Everywhere DOC UM 20035 4 1 User Manual eS WiFi Module 4 4 1 A Show Access Point Settings Returns Access Point Settings Usage A CR Response from eS WiFi gt Es WiFi 192 168 10 1 1 0 1 24 0 OK gt Field 1 2 3 4 5 6 7 Function SSID IP Channel Security Security AP Lease Address Type Key DHCP Time Field 8 Function Status Default Value None The following commands are used to setup the Access Point A typical application will senda sequence of commands to setup the Access point and then have your settings saved in flash memory by using the Z1 command Here is an example of setting up the Access Point information that needs to be saved into Flash upon completion AS 0 ABC Mac address OFF SSID 26 192 168 10 1 IP Add
16. design to cost effective high volume manufacturing Copyright 2011 Inventek Systems Technical support Engineering inventeksys com Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 Gop nen Systems pai DOC UM 20035 4 1 User Manual eS WiFi Module AT Command Set User Manual Table of Contents inteso me 9 1 1 ScoPE 9 1 2 AT COMMAND USAGE IN THE USER MANUAL IS SHOWN AS 9 1 3 SUPPORTED PRODUCT VERSIONS 9 1 4 AT COMMAND SET 9 1 4 Entering AT Commands cerent I 10 1 4 2 eS WiFi Command Formats creuse esee eren agis enn lp eee enne nennen anne 10 All AT commands sent to the module must be formatted as follows 10 All AT command responses from the module will follow this format 11 2 HARDWARE INTERFACE AND MODULE OPERATION 12 2 1 RS 232 SERIAL COMMUNICATION 12 2 1 1 Data a a re phe en p Re bene mere NB eee dee eee 12 2 1 2 Flow BED eene 12 2 1 3 Supported Baud Rates eene nnne 12 2 1 2 Default Ser
17. forwarded from the WiFi interface bypass the internal TCI IP stack and are presented to the host interface Usage PR lt Value gt lt CR gt Bypass Value Mode Normal No Bypass Forward All 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 4 13 17 PS Raw Ethernet PBM USB HID Packet Statistics Send the raw ether packet statistics to the host Usage PS lt CR gt Default Value None Returns Receive Packets Write Packets Command Packets Current Packet CP Last Packet LP 4 13 18 PT USB HID RX Sequencing When enabled add a sequence number of CP current packet of PT Packets Total as the second and third bytes of the USB HID packet Usage PT lt 0 1 gt lt CR gt Default Value None Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 49 Gop nen Systems Embedding Connectivity Everywhere DOC UM 20035 4 1 User Manual eS WiFi Module 4 13 19 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 13 20 PY Set TCP API Message Timeout Set the TCP API message timeout to the stack Usage PY lt Timeout in ms gt lt CR gt Range Restore D
18. lt Value gt lt CR gt Default Value None 4 19 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 19 6 25 Get MAC Address Gets the MAC address Usage Z5 lt CR gt Default Value None Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 59 Gop nen Systems Empedding connectivity DOC UM 20035 4 1 User Manual eS WiFi Module 4 19 7 Z6 Set Access Point IP Address Sets the Access Point IP address Usage Z6 lt XXX XXX XXX XXX gt lt CR gt Default value 192 168 10 1 4 19 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 19 9 Z8 Get WPS Pin Gets the WPS WiFi Protected Setup pin number Usage Z8 lt CR gt Default Value 12345678 4 19 10 Z9 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 19 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 Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 60 Gop nen Systems ee ee DOC UM 20035 4 1 User Manual eS WiFi Module 4 19 12 ZD Flash Dump Dumps the selected space from the Z3 command to the host interface Usage ZD lt
19. 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 17 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 Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 54 Gop nen Systems sl ciui elim DOC UM 20035 4 1 User Manual eS WiFi Module 4 17 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 230400 460800 921600 1152000 1382400 1612800 1843200 2073600 2304000 2764800 3686400 3916800 Table 4 10 Basic Baud Rates Usage U2 lt Baud Rate gt lt CR gt Default Value U2 115200 Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 55 Qe nen Systems ee ee DOC UM 20035 4 1 User Manual eS WiFi Module 4 17 3 U Show UART Setting Return curr
20. 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 DT1234567 Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 Gop nen Systems eye Everyiinere DOC UM 20035 4 1 User Manual eS WiFi Module 1 4 1 Entering AT Commands As mentioned above it is common practice 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 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
21. to 65535 Usage P2 lt Transport Local Port Number gt lt CR gt Default Value P2 5024 Refer to documentation on TCP UDP communications for pre defined port information 4 13 4 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 v4 1 45 Gop nen Systems Embedding Connectivity Everywhere DOC UM 20035 4 1 User Manual eS WiFi Module 4 13 5 P4 Set Transport Remote Port Number Set Transport Remote Port Number allows the user to define the port number for a Transport Server on the network that the eS WiFi module will use for communications with that server Input range for Local Port is 0 to 65535 Usage 4 lt Port CR Default Value P4 5025 4 13 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 modes are listed in Table 4 7 Transport Server Transport Server Mode Server Disable
22. to change eS WiFi Module AT Command Set Version v4 1 31 Gop nen Systems Embedding Connectivity Everywhere DOC UM 20035 4 1 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 You must save the CC AT command with the Z1 command to save the setting Auto Connect Auto Connect Mode Disable Network Auto Join Enable 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 lt Type gt lt CR gt Default Value 0 Open Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 32 Gop nen Systems Embedding Connectivity Everywhere DOC UM 20035 4 1 User Manual eS WiFi Module 4 6 15 CF Set Clear Packet Filter Packet Bypass Mode Set Clear the packet filters
23. 200 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 The eS WiFi module supports USB Contact Inventek for firmware 2 3 SPI Serial Peripheral Interface Bus The eS WiFi module supports SPI Contact Inventek for firmware Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 12 Gop nen Systems DUREE DOC UM 20035 4 1 User Manual eS WiFi Module 2 4 Module 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 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 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 informa
24. 4 4 7 AD Activate Access Point Direct Connect Mode 4 4 8 AE Exit Access Point Direct Connect Mode enne enne ener enn 4 4 9 AL Set Access Point DHCP Lease Time nnne nnns nnns seen tentes nnns 4 4 10 AR Get Client RSSI SoftAP Only Direct Connect Mode AS Set Access Point SSID eti erret e terae ee a EE da eva ee ene nn Dese eerie n n e EE dans 4 4 12 AT Set Maximum Number of AP Clients enne inns 4 5 SELECT COMMUNICATION INTERFACE Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 Gop nen Systems DOC UM 20035 4 1 User Manual eS WiFi Module 4 5 1 B Show Communication Interface Settings 25 4 5 2 B2 Set SPUMO E direnir eere a aae e eere SERRE ONERE 25 4 5 3 B3 Set SPLReady Pi a Cr EE EE Up n a 26 4 6 CONFIGURE NETWORK SETTINGS 27 4 6 1 CO JOIN aNetWOTK peser enne SE MEN iD NER NE AV 27 4 6 2 C1 Network SSID TE uu nasa ER 27 4 6 4 C3 Set Network Security Type enne essen satana
25. 789 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 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 Communication Socket gt P020 OK Set protocol to UDP gt P1 0 OK Set remote Server IP Address gt P3 192 168 1 110 OK Set remote UDP Port Number to 5025 gt P4 5025 OK gt Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 74 Embedding Connectivity Everywhere Gop nen Systems DOC UM 20035 4 1 User Manual eS WiFi Module Enable UDP Client mode gt P6 1 Connecting to 192 168 1 110 OK gt Once the 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 Re
26. ART Setting 4 18 WLAN 57 4 18 1 WL Set GPIOs for Link Status and Activity a 57 4 19 SYSTEM INFORMATION FLASH 4 19 1 20 Reset To Factory Defaults 4 19 2 Z1 Save Current Settings ie 4 19 3 72 Clear Saved Settings eerte et re 4 19 4 73 Set Factory User Space 2 4 19 5 74 Set MAC Address da luu 4 19 6 Z5 Get MAC Address eese sees een eee netten hane o W WN 4 19 7 Z6 Set Access Point IP Address my SW 4 19 8 27 Set WPS PIM 4 19 9 28 Get WPS Pin 4 19 10 Z9 Set USB VID PID 4 19 11 ZC Clear Factory Lock Switch h WB 4 19 12 ZD Flash Dump Mnene ene e e a aee eene er
27. AS FAROE ISLANDS FIJI FINLAND FRANCE FRENCH_GUINA FRENCH_POLYNESIA FRENCH_SOUTHERN_TERRITORIES GABON GAMBIA GEORGIA GERMANY GHANA GIBRALTAR Preliminary Subject to change Code DK DJ DM DO EC EG SV GQ ER EE ET FK FO FJ FI FR GF PF TF GA GM GE DE GH GI Country MAURITIUS MAYOTTE MEXICO MICRONESIA FEDERATED STATES OF MOLDOVA REPUBLIC OF MONACO MONGOLIA MONTENEGRO MONTSERRAT MOROCCO MOZAMBIQUE MYANMAR NAMIBIA NAURU NEPAL NETHERLANDS NETHERLANDS ANTILLES NEW CALEDONIA NEW ZEALAND NICARAGUA NIGER NIGERIA NORFOLK ISLAND NORTHERN MARIANA ISLANDS NORWAY 78 Code MU MX FM MD MC MN ME MS MA 2 MM NA NR NP NL AN NC NZ NI NE NG NF MP NO Country UGANDA UKRAINE UNITED ARAB EMIRATES UNITED KINGDOM UNITED STATES UNITED STATES REV4 UNITED STATES NO DFS UNITED STATES MINOR OUTLYING ISLANDS URUGUAY UZBEKISTAN VANUATU VENEZUELA VIET NAM VIRGIN ISLANDS BRITISH VIRGIN ISLANDS US WALLIS AND FUTUNA WEST BANK WESTERN SAHARA YEMEN ZAMBIA ZIMBABWE Code UG UA AE GB US US Q2 UM UY UZ VU VE VN VG WF oc EH YE ZM ZW eS WiFi Module AT Command Set Version v4 1 Gop nen Systems ee dodi DOC UM 20035 4 1 User Manual eS WiFi Module 7 Document Revision History Description Revisi on 12 08 11 Initial Creation AT Command Set docx 12 15 11 Initial Release AT Command Set r1 0 docx 12 15 11 Minor AT Command Set corrections formatting r1 1
28. CP 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 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 4 13 1 Set Display Communication Socket Set Display the communication socket for TCP UDP or UDP Lite communications All the commands for communications are duplicated for each socket The Rx and Sx are tied to the communication socket selected by PO Usage Se
29. CR gt Default Vale None Responses FLASH Dump 0000 7F 00 00 04 73 73 69 64 FF FF FF FF FF FF FF FF Cl ssid 0010 FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF 0020 FF FF FF FF 08 70 61 73 73 77 6F 72 64 FF FF FF password 0030 FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF EF 0040 FF FF FF FF FF FF 00 05 00 00 01 C2 00 FF FF FF e 0050 FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF 0060 FF 00 00 00 00 00 00 00 00 00 00 13 88 0070 13 88 01 05 B4 05 B4 CO A8 01 00 O1 00 OO 00 n 1 0080 00 00 00 00 00 FF FF FF FF FF 18 49 6E 76 65 Inve 0090 6E 74 65 6B 20 53 79 73 74 65 6D 73 20 65 53 2D ntek Systems eS 00A0 57 69 46 69 FF FF FF FF FF FF FF FF FF OA 65 53 WiFi es 2D 57 69 46 69 5F 41 50 FF FF FF FF FF FF FF FF WiFi AP OOCO FF FF FF FF FF FF FF FF FF FF FF FF FF FF 01 01 00 0 55 53 18 00 00 FF FF FF FF FF FF FF FF FF FF FF US 00 0 FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF OOFO FF FF FF FF FF FF FF FF FF FF FF FF F9 AB OF 00 gt 4 19 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 4 19 14 ZN
30. Embedding Connectivity Everywhere 4 10 4 G Show GPIO Settings DOC UM 20035 4 1 User Manual eS WiFi Module The AT Command G will return the GPIO pin type To confirm your settings and the sequence of returned states from this request will be grouped by type not by pin number Usage I CR Field 1 2 3 4 5 6 7 Function GPIOO GPIO1 GPIO2 GPIO3 GPIO4 CFGO CFG1 Default Value None 4 11 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 11 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 12 Miscellaneous Command 4 12 1 MF Test External Serial Flash Does an erase write read and verify test on the external serial flash used for Factory Reset or Over The Air OTA firmware updates Usage MF lt CR gt Default Value None Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 41 Embedding Connectivity Everywhere Gop nen Systems DOC UM 20035 4 1 User Manual eS WiFi Module 4 12 2 MR Message Read SPI Only This command reads any asynchronous message that occ
31. P Server Enabled Yes Server Enabled OK gt 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 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 bytes sent 10 OK 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 v4 1 70 Gop nen Systems Embedding Connectivity Everywhere DOC UM 20035 4 1 User Manual eS WiFi Module 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 ass
32. P 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 6 1 1 TCP Server Set Up Set Communication Socket gt P020 OK 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 Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 69 Gop nen Systems Embedding Connectivity Everywhere DOC UM 20035 4 1 User Manual eS WiFi Module 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 TC
33. USAGEWn sp v v ASCII gt ODOADATAODOAOKODOASE20 gt ODOADATAODOAUSAGEODOASE20 AT command to send Data can follow either of these formats Command Delimiter payload v Binary data 1 1460 bytes Note 1 v Carriage Return Command PayloadSize 1 Delimiter Payload SSP Number of Bytes to be sent Binary data pem 1 1460 bytes Note 1 v Carriage Return For example gt SODATA r gt 3 77 rDATA77byteslong Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 11 Gop nen Systems Embedding Connectivity Everywhere DOC UM 20035 4 1 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 1
34. Version v4 1 23 Gop nens Systems a dul apiid in DOC UM 20035 4 1 User Manual eS WiFi Module 4 4 10 AR Get Client RSSI SoftAP Only Direct Connect Mode Gets the Client RSSI values for all clients connected to the SoftAP in direct connect mode i e AO then select Direct Connect from the Configuration page or AD Usage AR lt CR gt Default Value None Please note that it may take more than one issuance of the command to return a non zero value Responses gt AR 0 AC 72 89 55 CE 36 0 OK 1 gt AR 0 AC 72 89 55 CE 36 40 OK gt 4 4 11 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 lt MAC Mode lt SSID gt lt CR gt MAC Value Mode Default Value MAC Mode 1 SSID eS WiFi_AP 4 4 12 AT Set Maximum Number of AP Clients Sets the maximum number of AP client that will given an IP address Please note the AP it s self is considered one of the clients so the total of client equals 5 Usage AT lt Number of Clients gt lt CR gt MAC Mode Number of Clients Default Value 4 Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 24 Gop nen Systems a DOC UM 20035 4 1 User Manual eS WiFi Module 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
35. a 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 gt The eS WiFi Module can also be set up using 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 F2 1000 OK gt Check current Find settings gt Scan Repeats 10 Scan Delay 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 IP 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 FO 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 Set SSID for Access Point Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 66 Gop nen Systems Embedding Connectivity Everywhere DOC UM 20035 4 1 User Manu
36. al eS WiFi Module gt C1 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 mars PSWD PASSWORD SECURITY WPA2 AES DHCP Enabled IP IPV4 IP ADDR 0 0 0 0 MASK 0 0 0 0 GW ADDR 0 0 0 0 DNS1 0 0 0 0 DNS2 0 0 0 0 Join Retries 5 Auto Connect 0 Status Not Connected OK gt Join Network Access Point mars using PASSWORD WPA2 AES and DHCP gt CO Joining mars accession joined mars Obtaining IP address via DHCP Network ready IP 192 168 1 117 OK gt Check Network Join Settings after joining Access Point gt SSID mars PSWD PASSWORD SECURITY WPA2 AES DHCP Enabled IP IPV4 IP ADDR 192 168 1 117 MASK 255 255 255 0 Preliminary Subject to change 67 eS WiFi Module AT Command Set Version v4 1 Gop nen Systems ere Everyanere DOC UM 20035 4 1 User Manual eS WiFi Module GW ADDR 192 168 1 1 DNS1 0 0 0 0 DNS2 0 0 0 0 Join Retries 5 Auto Connect 0 Status Connected OK gt Turn on auto connect Save settings in Flash above 71 5 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
37. ay IP Address used by the devices on the network to access 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 XXX XXX XXX XXX Usage 8 lt gt lt gt Default Value 255 255 255 255 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 C92 00CXXX 09X XXX CR Default Value 255 255 255 255 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 lt gt lt gt Default Value 255 255 255 255 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
38. d 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 lt Passphrase gt lt CR gt Default Value C2ZNONE 4 6 4 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 are listed in Table 4 2 WiFi Security WiFi Security Mode Description No WiFi Security Wired Equivalent Privacy wA WiFi Protected Access TKIP WPA WPA2 WPA2 TKIP WiFi Protected Access and WiFi Protected Access 2 WiFi Protected Access 2 TKIP Table 4 2 Network WiFi Security Modes K WiFi Protected Access 2 AES Usage C3 WiFi Security Modes CR Default Value C320 Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 28 Gop nen Systems Embedding Connectivity Everywhere 4 6 4 C4 Set Network DHCP DOC UM 20035 4 1 User Manual eS WiFi Module 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 ha
39. docx 1 2 2012 Added Usage Examples AT Command Set r1 2 docx 3 12 2012 MFT Changed Logo AT Command Set r1 3 docx 11 21 2012 Update with new AT Command Set commands r1 4 docx 2 5 2013 MFT Update AT Command List AT Command Set 2 0 docx 5 9 2013 Update AT Command List AT Command Set 2 1 docx 6 16 2014 Updated for C2 4 0 X AT Command Set _ release DOC UM 20035 2 2 docx 3 10 2015 Updated for C2 5 0 X AT Command Set _ release DOC UM 20035 4 1 docx Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 79 Qe nen Systems DANCER DOC UM 20035 4 1 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 v4 1 80
40. e architected the flash memory to have two banks of flash partitioned as 1 Factory Default Space 2 Customer User Space We recommend that customers save there default settings in User Space and if you have trouble with flash in the field or a flash error you can switch to Factory space and do a reset this will erase the flash in the User Space this starting the module in a known state 4 19 1 20 Reset To Factory Defaults Reset the current user space settings to factory default The setting are not saved until a Z1 command is issued You cannot be connected to a Network when trying to reset eS WiFi to defaults Usage Z0 lt CR gt Default Value None 4 19 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 v4 1 58 Gop nen Systems Embedding Connectivity Everywhere 4 19 3 Z2 Clear Saved Settings DOC UM 20035 4 1 User Manual eS WiFi Module Clears the save settings space based upon the space selected with the Z3 command Usage Z2 lt CR gt Default Value None Responses EEPROM Erasing EEPROM Complete 1 OK gt EEPROM Erasing user sections 2 EEPROM Complete OK gt 4 19 4 Z3 Set Factory User Space Selects the space that will be used by the Z1 and Z2 commands Usage Z3
41. e the firmware Usage ZU lt CR gt Default Value None 4 19 19 ZV Set OTA Method Selects the method for the OTA download Usage ZV lt Value gt lt CR gt Internet Server Default Value None 4 19 20 Z Show System Settings Returns current system settings Usage Z lt CR gt Field 1 2 3 4 5 6 7 Function Config WPS VID PID MAC AP IP PS Radio ration Pin Address Mode Mode Field 8 9 10 Function Current Previous Product Beacon Beacon Name Default Value None Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 63 Gop nen Systems ee ee DOC UM 20035 4 1 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 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 W
42. eS WiFi Module will wait for a connection from a remote Client gt P5 1 UDP Task set up OK Waiting on UDP connection Accepted UDP connection from 192 168 1 110 on port 5024 gt Check UDP Server Mode Configuration gt P Transport Protocol UDP Client IP ADDR 192 168 1 110 Local Port 5024 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 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 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 Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 73 Gop nen Systems ee DOC UM 20035 4 1 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 Perform Read of Remote Client gt RO testing 1234567890 OK gt Write data to Remote Client S0 0123456
43. eceeessesanasseceeessesseauaeseeeseesas 42 4 124 MT Set Message au etn eid auo u anu Env ER EN ERES amun hua aquya n ERA E ERR 43 4 13 TRANSPORT COMMUNICATION 44 4 13 1 PO Set Display Communication Socket nnns 44 4 13 2 PT Set Transport PKOtOCOl a aar va ae ERR e SR RP EPA RR E 45 4 13 3 P2 Set Transport Local Port Number 45 4 13 4 P3 Set Transport Remote Host Port IP Address 45 4 13 5 P4 Set Transport Remote Port Number I n n 46 4 13 6 P5 Stop Start Transport Server ccscccsssccsssceessecssecesssecsasceeseecssececseecseseeneeensssucssecsaseccsseenaeaecseecesseccaeeceas 46 4 13 7 PG Stop Start Transport Client 46 4 13 8 P7 Start Stop Request TCP Loop ccccccssscesssecssscesseecssecesssecsasceseecsaeceenevessedenssesnstaccssecascecstecseeeecseeceas 4 13 9 P8 Set Listen Backlogs 4 13 10 PA Set Custom Certificate Authority 4 13 12 PB Set Root CA Verification Results 4 13 13 PC Write Security Certificates e
44. efault 0 65535 Info Default Value 10000 4 13 21 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 Default Value None Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 50 Gop nen Systems Embedding Connectivity Everywhere DOC UM 20035 4 1 User Manual eS WiFi Module 4 14 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 14 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 RO CR Default Value None 4 14 2 R1 Set Read Transport Packet Size bytes The AT Command R1 is a user defined va
45. eliminary Subject to change eS WiFi Module AT Command Set Version v4 1 52 Gop nen Systems Embedding Connectivity Everywhere 4 15 4 S3 Write Transport Data DOC UM 20035 4 1 User Manual eS WiFi Module The AT Command S3 is used to write data to a Transport Server or Client The size of the data to write is defined by the first parameter After the AT Command S3 is entered i e the CR is received by the eS WiFi any data writing to the eS WiFi module s selected communicating interface will be sent to a connected Transport Server or Client Once the number bytes defined by the first parameter 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 first parameter 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 S3 lt Data Packet Size CR Data 4 15 5 S Show Write Transport Settings Return current Write Transport Data Settings Usage S CR Field 1 2 ar Function Number Timeout of Bytes Default Value None 4 16 Ping IP Target Address Ping is a network utility 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 16 1 T0 Ping IP Target Address The AT Command TO will Pin
46. en 4 19 13 ZF Set Factory Lock Switch ccena eene nennen enne tenente inna 4 19 14 ZN Set Product ED Rma Oe 4 19 15 ZO OTA Firmware Update 9 W 4 19 16 ZP Power Management B 4 19 17 ZR Reset Module Besse nennen nnne enn nnne n nhan enne nan nne 4 19 18 ZU Firmware Upgrade M3G Only uses STM32F205 boot loader 4 19 19 ZV Set OTA Method WN 9 4 19 20 Z Show System Settings 5 EXAMPLE ES WIFI MODULE AT COMMAND USAGFE U sese s U uuu uu 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 5 6 TRANSMISSION CONTROL PROTOCOL Data Transport WIS ad dM 5 6 1 2 Read and Write TCP Data in Server Mode 5 6 2 TCP Client Setup and Data Transport J J nennen nen nn nnns sn en
47. ent 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 Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 56 Qe nen Systems Embedding Connectivity Everywhere 4 18 WLAN DOC UM 20035 4 1 User Manual eS WiFi Module 4 18 1 WL Set GPIOs for Link Status and Activity Sets the GPIO pins for WLAN link status and activity The link status can also be used as an IRQ to the host processor to indicate if the module is connected to a wireless network Usage WL lt Arg1 gt lt Activity GPIO 0 9 gt lt Polarity O Active Low 1 Active High CR Arg e toclear reset GPIO pin to original settings to show current values e Link GPIO 0 9 Examples gt WL OK V E ll Ds Ww Es VO b v O Note GPIOs 0 4 are GPIO0 4 and GPIOs 5 9 are ADC0 4 Default Value Link 255 Activity 255 Link Link Activity Status Off Connection lost Flashing Off WPS In progress Flashing Connected with link activity Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 57 Gop nen Systems E E ES DOC UM 20035 4 1 User Manual eS WiFi Module 4 19 System Information Flash The AT commands can be saved into flash to initialize the systems such as customer Mac address out the auto connect to join a network once the SSID and password have been saved into User Space W
48. ere enne nennen nnne 4 13 14 PD Write Security Key 4 13 15 PK TCP Keep Alive W 4 13 16 PR Packet Bypass Mode PBM Read Mode Q 49 4 13 17 PS Raw Ethernet PBM USB HID Packet Statistics eene enne nnn nnne 49 4 13 18 PT USB HID RX 5 W 4 13 19 PW Packet Bypass Mode PBM Write Packet 4 13 20 PY Set Message 4 13 21 P Show Transport SettIR8s W 4 14 RECEIVE TRANSPORT DATA 4 14 1 RO Read Transport Data 4 14 2 R1 Set Read Transport Packet Size bytes 4 14 3 R Set Read Transport Timeout ms enne ener nennen enne nennen nnne enne nnns 51 4 14 4 R3 SelsbeceiveliyIode WWW nnne U U nnne eror nennen nnne u u 51 4 14 5 R Show Read Transport Settings 52 4 15 WRITE TRANSPORT DATA 52 WRES
49. erver running on eS WiFi and the user will be able to connect to the Web Site and enter the password and 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 without first closing the current network connection Usage C0 lt CR gt Default Value None Responses JOIN SSID DHCP 192 168 2 18 C1 3 x gt Responses JOIN SSID 192 168 2 18 0 0 2 4 0 OK gt 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 v4 1 27 Gop nen Systems lisse arie do ed DOC UM 20035 4 1 User Manual eS WiFi Module 4 6 3 C2 Set Network Passphrase Network Passphrase can be up to 32 63 64 for WPA2 C2 4 0 or greater characters and is a unique security keyword for access to a wireless network The eS WiFi module must use the Passphrase associate
50. g a remote host returning the round trip time or a timeout message The host IP Address used by Ping must be set up by using the AT Command T1 Usage T0 lt CR gt Default Value None 4 16 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 Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 53 Qe nen Systems Embedding Connectivity Everywhere DOC UM 20035 4 1 User Manual eS WiFi Module 4 16 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 Range 0 65534 65535 Continuous Default Value T220 4 16 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 16 5 T Show Ping Settings Return current Ping Settings Usage T lt CR gt Field 1 2 3 Function Target Repeats Delay IP 1 Repeats Address __ Default Value None 4 17 Configure 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
51. he currently associated Access Point No Associated AP Usage CR CR All other values RSSI dB 4 6 20 CS Connection Status Default Value None Gets the current wireless network connection status Usage CS lt CR gt Response Connected Default Value None Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 34 Gop nen Systems Embedding Connectivity Everywhere DOC UM 20035 4 1 User Manual eS WiFi Module 4 6 21 CW Connect using WPS Pin or PBC Connects to an access point using WPS WiFi Protected Setup Pin or PBC Push Button Configuration methods Once connected the SSID Password Security Key Security Type settings will be populated and then can be saved using the Z1 command for use later Please note when using the Pin method the pin must be set using the Z7 command Usage CW lt value gt lt CR gt Default Value None Responses WPS Searching WPS Associated 1 WPS SSID DHCP 192 168 2 18 OK gt 4 6 22 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 Preliminary Subject to change 35 eS WiFi Module AT Command Set Version v4 1
52. i Module 4 4 4 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 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 5 AA Get AP DHCP Cached Address es Gets the MAC and IP addresses in the AP DHCP cache Usage AA lt Channel gt lt CR gt Default Value None 4 4 6 AC Set Access Point Channel Set the channel the Access Point will broadcast on The channels are from 1 to 13 based upon the Country Code setting for the eS WiFi module A setting of 0 selects the auto channel algorithm Usage AC lt Channel gt lt CR gt Default Value C1 3 x 1 C2 4 0 0 4 4 7 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 This mode is used to establish a IPV4 Direct Connection to a PC Smartphone or IOT appliance Once your PC smart phone or IOT device joins the eS WiFi the eS WiFi will issue an IP Address and create a wireless network connection between the eS Wi Fi and the Smartphone or IOT appliance The Direct C
53. iFI 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 the 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 v4 1 64 Gop nen Systems Embedding Connectivity Everywhere DOC UM 20035 4 1 User Manual eS WiFi Module Check Baud Rate After Change gt U Communication Port UART Baud Rate 921600 Data width 8 bit Parity NONE Stop Bits 1 Mode ASCII RX Timeout 0 ms TX Timeout 0 ms OK Finding Access Points The first steps in joining a network is to determining available Access Points in the listening range of the eS WiFi Modu
54. ial Configuration ERR eee 12 2 2 USB UNIVERSAL SERIAL BUS 12 2 3 SPI SERIAL PERIPHERAL INTERFACE BUS 12 2 4 MODULE OPERATION MODES 2 4 1 Human Readable Mode Wa 2 4 2 Machine Readable Mode 3 AT COMMAND SET VERSION 2 0 SP S SS 14 3 1 AT COMMAND SET LIST OF SUPPORTED FUNCTIONS 14 4 AT COMMAND DETAILZSESCRIBIBION S 19 4 1 PRINT HELP MESSAGE 19 4 2 SSS ENTER COMMAND MODE 19 4 3 EXIT COMMAND MODE 4 4 ACCESS POINT Ado SHOMBANCCESSHBOIN Settings LL 2 AOWDCLVOWRACCESSIPDINE 4 4 3 A1 Set Access Point Security Mode eene een nennen AAA Set Security Key uuu u rto e UTERE Nu Res FEY Te CEP Rura Rn 4 4 5 AA Get AP DHCP Cached Address s cc cccccssssccesssssecesssececssseceeseeeecesssececsesseceesaesecsesaececesseceeaeseceeaas 4 4 6 AC Set Access Point Channel
55. ith AT Command S1 defining the size of data to write 4 15 1 S0 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 will 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 Data 4 15 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 Data Packet Size CR Default Value 8121200 4 15 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 Pr
56. le 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 SSID mars BSSID CC 33 CC 99 39 00 RSSI 39dBm Max Data Rate 54 0 Mbits Network Type Infrastructure Security WPA2 AES Radio Band 2 4GHz Channel 2 002 SSID jupiter BSSID EE 99 FF AA DD 00 RSSI 90dBm Max Data Rate 54 0 Mbits s Network Type Infrastructure Security WPA2 AES Radio Band 2 4GHz Channel 1 003 SSID saturn BSSID FF 11 00 55 CC EE RSSI 90dBm Max Data Rate 54 0 Mbits s Network Type Infrastructure Security WEP Radio Band 2 4GHz Channel 6 004 SSID uranu BSSID 33 44 299 44 11 RSSI 94dBm Max Data Rate 54 0 Mbits s Network Type Infrastructure Security WPA2 AES Radio Band 2 4GHz Channel 11 End of scan results OK gt Preliminary Subject to change 65 eS WiFi Module AT Command Set Version v4 1 Gop nen Systems hb Erbe idus DOC UM 20035 4 1 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 dat
57. lransSpalilaData 52 4 15 2 ST Set Write Transport Packet Size bytes enne enne 52 4 15 3 S2 Set Write Transport Timeout ms enne nnne nnne nnne nennen nennen nnne ens 52 4 15 4 S3 Write Transport 4 15 5 S Show Write Transport Settings 4 16 PING IP TARGET ADDRESS 4 16 1 STO Ping IP Target Address iore terrm rite eno ae aa Ve FPE Tuae 4 16 2 TT Set Ping Target Address cccccsesscccccceesesssaesecececseeeeseeececseseaaeseeeeecsesesaeseeeesceeseaaeseeeesceeseaaeaeeeeeceeeea 4 16 3 T2 Set Ping Repeat a e 4 164 T3 Set Ping Delay Ims t Rete 54 4 16 5 T SHOW Ping SettillBS oerte eee sa tes rb ee ree 54 4 17 CoNFIGURE UART 54 4 17 1 UO Activate UART ssh kashas suyaway essa na 54 Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 Gop nen Systems DOC UM 20035 4 1 User Manual eS WiFi Module 4 17 2 U2 Set UART Baud Rate 4 17 3 U Show U
58. lue 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 R1 1200 4 14 3 R2 Set Read Transport Timeout ms The AT Command 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 14 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 R3 lt Value gt lt CR gt Receive Mode Normal No Delineation Default Value None Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 51 Gop nen Systems Embedding Connectivity Everywhere DOC UM 20035 4 1 User Manual eS WiFi Module 4 14 5 R Show Read Transport Settings Return current Receive Transport Data Settings Usage R lt CR gt Field 1 2 3 Function Number Timeout Receive of Mode Bytes Default Value None 4 15 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 SO w
59. mote 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 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 per read 1200 TCP UPD receive timeout 5000 ms OK gt Perform Read of Remote Client gt RO testing 1234567890 OK gt Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 75 Gop nen Systems Embedding Connectivity Everywhere DOC UM 20035 4 1 User Manual eS WiFi Module Write data to Remote Client gt 50 0123456789 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 76 eS WiFi Module AT Command Set Version v4 1 Embedding Connectivity Everywhe
60. mware for either UART SPI or USB onto the module When you order your production parts you need to specify your firmware build that you have qualified details are found in the product specifications The AT Command set is very simple to use and the default firmware is set for UART 115K baud and you can download a free demo software program from the Inventek web site to exercise the module 1 2 AT Command Usage in the User Manual is shown as Usage lt AT Command gt optional gt data if is used gt Carriage Return CR gt or lt AT Command gt lt CR gt And default values are show as Default lt AT 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
61. n setup the GPIO to Control an LED Read a Button Digital Input or Digital Output The output is a 3 3V CMOS GPIO2 is the only output available as an ADC An couple of examples 1 Issue and AT command to see if you are connected to the network Once you know you are connected you can light an LED 2 Setup GPIO2 as an A D connect a temperature sensor and reads the value A user can setup and read the state of GPIO s 1 7 with the AT command Some Firmware revision may use some of the GPIO s for special functions so please contact Inventek for details For example the SPI firmware uses the GPIO2 ADC for the SPI ready function 4 10 1 G2 Read GPIO ADC Reads the current value of the specified GPIO or ACD pin Usage G2 lt Pin Number Value CR Digital ng Default Value None Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 39 Gop nen Systems DOC UM 20035 4 1 User Manual eS WiFi Module 4 10 2 G3 Write GPIO Writes the current value of the specified GPIO pin Usage G3 lt Pin Number gt lt Type Value gt lt Value gt lt CR gt Type Value Type 4 Digital Output Default Value None 4 10 3 G4 GPIO Setup Sets the type of the specified GPIO pin Usage G2 lt Pin Number gt lt Value gt lt CR gt Digital Input Digital Output Default Value None Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 40 Qe nen Systems
62. ng Connectivity Everywhere DOC UM 20035 4 1 User Manual eS WiFi Module 4 9 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 9 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 CR Default Value 1000 4 9 4 F3 Set Scan Channel Set Scan Channel to scan for Input range O None 1 to 14 Usage F3 Channel CR Default Value 1 4 9 5 F4 Set Scan BSSID Set Scan Channel to scan for Usage F4 lt XX XX XX XX XX XX gt lt CR gt Default Value None 4 9 6 F5 Set Scan SSID Set Scan Channel to scan for Input range Clear 32 character SSID gt Usage 5 lt 32 character SSID gt lt CR gt Default Value None Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 38 Gop nen Systems dre DOC UM 20035 4 1 User Manual eS WiFi Module 4 9 7 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 10 GPIO ADC Information You ca
63. onnection is an Infrastructure connection that has advantages over Adhoc for example Android does not support Adhoc natively Once you have established this infrastructure connection you can setup a Peer to Peer connection using UDP UDP Lite or TCP Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 22 Embedding Connectivity Everywhere Gop nen Systems DOC UM 20035 4 1 User Manual eS WiFi Module Responses AP SSID eS WiFi AP 0022FA0BBCOF IP 192 168 10 1 WEB SVR CSO Server started 1 OK gt AP DHCP Assigned AC 72 89 55 CE 36 has 192 168 10 100 2 gt 4 4 8 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 used for both the A0 and AD commands For the A0 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 It is important to create and tear down networks properly You should shut down the UDP UDP Lite or TCP prior to issuing the AE command 4 4 9 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 30 mins Usage AL lt Lease Time gt lt CR gt 1 254 1 254 hrs 255 136 hrs Default Value 0 30 mins Preliminary Subject to change eS WiFi Module AT Command Set
64. re w Systems DOC UM 2003544 1 User Manual eS WiFi Module 6 Appendix A Country AFGHANISTAN ALBANIA ALGERIA AMERICAN SAMOA ANGOLA ANGUILLA ANTIGUA AND BARBUDA ARGENTINA ARMENIA ARUBA AUSTRALIA AUSTRIA AZERBAIJAN BAHAMAS BAHRAIN BAKER ISLAND BANGLADESH BARBADOS BELARUS BELGIUM BELIZE BENIN BERMUDA BHUTAN BOLIVIA BOSNIA AND HERZEGOVINA BOTSWANA BRAZIL BRITISH INDIAN OCEAN TERRITORY BRUNEI_DARUSSALAM BULGARIA BURKINA_FASO BURUNDI CAMBODIA CAMEROON CANADA CAPE_VERDE CAYMAN_ISLANDS CENTRAL_AFRICAN_REPUBLIC CHAD CHILE CHINA CHRISTMAS ISLAND COLOMBIA COMOROS CONGO CONGO THE DEMOCRATIC REPUBLIC OF THE COSTA RICA COTE DIVOIRE CROATIA CUBA CYPRUS CZECH REPUBLIC Preliminary Subject to change Code AF AL DZ AS AO Al AG AR AM AW AU AT AZ BS BH OB BD BB BY BE BZ BJ BM BT BO BA BW BR BN BG BF KY CF TD CL CN CX co KM CD CR cl HR CU cy Cz Country GREECE GRENADA GUADELOUPE GUAM GUATEMALA GUERNSEY GUINEA GUINEA BISSAU GUYANA HAITI HOLY SEE VATICAN CITY STATE HONDURAS HONG KONG HUNGARY ICELAND INDIA INDONESIA IRAN ISLAMIC REPUBLIC OF IRAQ IRELAND ISRAEL ITALY JAMAICA JAPAN JERSEY JORDAN KAZAKHSTAN KENYA KIRIBATI KOREA REPUBLIC OF KOSOVO KUWAIT KYRGYZSTAN LAO PEOPLES DEMOCRATIC REPUBIC LATVIA LEBANON LESOTHO LIBERIA LIBYAN ARAB JAMAHIRIYA LIECHTENSTEIN LITHUANIA LUXEMBOURG MACAO
65. ress AC 1 Channel 1 13 Japan 14 select country code 1 2 WPA A2 Password Security Key AL 24 Lease Time Note AP DHCP is default to ON Z1 Saves setting to flash If you reset the eS WiFi module you can type A You will see that all the settings above have been saved ABC 192 168 10 1 2 Password 1 24 0 If you want to reset the device to the factory defaults you can issue the following 3 AT commands Z3 0 Set Factory User Space Z2 Erases Flash ZR Reset Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 20 Gop nen Systems Embedding connectivity ee DOC UM 20035 4 1 User Manual eS WiFi Module 4 4 2 A0 Activate Access Point Starts the Access Point DHCP Server DNS Server and Web Server Usage A0 lt CR gt Default Value None Responses AP SSID eS WiFi AP 0022F40BBCOF IP 192 168 10 1 1 WEB SVR Server started AP DHCP Assigned AC 72 89 55 CE 36 has 192 168 10 100 gt 2 JOIN SSID 3 DHCP 192 168 2 18 OK gt AP Shutdown OK 4 gt 4 4 3 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 WPA WPA2 WiFi Protected Access and WiFi Protected Access 2 Default Value 0 Open Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 21 Gop nen Systems agn Mead d DOC UM 20035 4 1 User Manual eS WiF
66. ry Subject to change eS WiFi Module AT Command Set Version v4 1 47 Gop nen Systems eee DOC UM 20035 4 1 User Manual eS WiFi Module 4 13 12 PB Set Root CA Verification Results Set the TCP API message timeout to the stack TCP Keep Alive Terminate SSL Connection Error Message Usage PB value CR Error Message Don t terminate SSL Connection Default Value 0 4 13 13 PC Write Security Certificates Writes a security certificates to flash Usage PC lt Certificate 0 1 gt lt Number of Bytes v Byte of certificate CR Default Value None 4 13 14 PD Write Security Key Writes a security keys to flash Usage PD lt Key 0 1 gt lt Number of Bytes Byte of keys CR Default Value None 4 13 15 PK TCP Keep Alive Enables Disables and sets the TCP Keep Alive Time to Idle This is useful in detecting broken TCP connections If enabled and a TCP connection is broken the 50 53 commands will respond with 1 once the broken connection is detected Usage PK value1 value2 CR Value1 TCP Keep Alive Enable Po n _ Lo Value2 Range 250ms to 7200000ms default is 7200000ms Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 48 Qe nen Systems Embedding Connectivity Everywhere DOC UM 20035 4 1 User Manual eS WiFi Module 4 13 16 PR Packet Bypass Mode PBM Read Mode Set the Packet Bypass Mode PBM In this mode Ethernet packets are
67. s assa 28 4 6 4 Set Network DHCP itte pte heh or si RI FEES NER Gea RE eds in a 29 4 6 5 C5 Set Network IP Version u u u eoe coe ons enin repere sek orent daa ls cx eese eene e ia 30 4 6 6 C6 Set Network IP Address u WA 30 4 6 7 C7 Set Network IP Mask eene enne eren nnne noeh aeneo o seas eo s WN 30 4 6 8 C8 Set Network Gateway SW 31 4 6 9 C9 Set Network Primary DNS ge een ene WA 31 4 6 10 CA Set Network Secondary DNS W 31 4 6 11 CB Set Network Join Retry 31 4 6 12 CC Network Auto Connect e ee WB 32 4 6 13 CD Disconnect from Network gt 32 4 6 14 CE Set Authorization pee 32 4 6 15 CF Set Clear Packet Filter Packet Bypass Mode n nn nanan 33 4 6 16 CJ Join Leave IGMP Group
68. t PO Communication Socket 0 to 3 gt lt CR gt Usage Display PO CR Responses gt P0 1 1 gt gt 1 2 gt P0 1 CR Set Socket 1 P1 0 lt CR gt P3 192 168 2 2 lt CR gt P4 8002 lt CR gt P6 1 lt CR gt 3 4 lt CR gt 1234 RO CR P0 2 CR P1 0 lt CR gt P3 192 168 2 3 lt CR gt P4 8002 lt CR gt P6 1 lt CR gt S3 4 CR 4321 RO CR P0 1 CR Preliminary Subject to change Remote Host Remote Port Start Client connection Send Data Receive Data Set Socket 2 Remote Host Remote Port Start Client connection Send Data Receive Data Set Socket 1 eS WiFi Module AT Command Set Version v4 1 44 Gop nen Systems Embedding Connectivity Everywhere 4 13 2 P1 Set Transport Protocol DOC UM 20035 4 1 User Manual eS WiFi Module Set Transport Protocol allows the user to enable selection of ether TCP UDP or UDP Lite for network port to port communications The Transport Protocols modes are listed in Table 4 6 Transport Protocol Transport Protocol Mode Table 4 6 Transport Protocol Modes Usage P1 lt Transport Protocol Modes gt lt CR gt Default Value P1 0 4 13 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
69. tion about operation of the command Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 13 Qe nen Systems ee eee DOC UM 20035 4 1 User Manual eS WiFi Module 3 AT Command Set Version 2 0 3 1 AT Command Set List of Supported Functions Activate Access Point Direct Connect Mode Exit Access Point Direct Connect Mode Set Access Point Lease Time Get Client RSSI SoftAP Only Set Access Point SSID Set Maximum Number of AP Clients Show Access Point Settings Set SPI Mode Show Communication Interface Settings Join a Network Set Network SSID Set Network Passphrase Set Network Security Type Set Network DHCP Mode Set Network IP Version Set Network IP Address Set SPI Ready Pin Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 14 Qe nen Systems a aka DOC UM 20035 4 1 User Manual eS WiFi Module Add Remove MAC To From MCAST Allow List PBM Only Set Country Code See Appendix A for Codes Get RSSS of Associated Network Access Point Get Connection Status Connect using WPS Pin or PBC Show Network Settings DNS Lookup Enable mDNS HID Keep alive Scan for Network Access Points Set Scan Repeat Count Set Scan Delay ms Set Scan Channel Set Scan BBSID Show Scan Settings Enable mDNS Service Read GPIO ADC Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 15 Qe nen systems Embedding DOC UM 20035 4
70. tre 5 6 2 1 NIIT S 5 6 2 2 Read and Write TCP Data in Client Mode 5 6 3 UDP Server Set Up and Data Transport 5 6 3 1 UDP Server Set Up CE 5 6 3 2 Read and Write UDP Data in Server Mode n nentes rennen 73 5 6 4 UDP Client Setup and Data Transport nn 74 56 4 NIB IB ael T LU o L P 74 5 6 4 2 Read and Write UDP Data in Client Mode enne enne ener enhn ener entren en nennen 75 6 APPENDIX ge 77 Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 Gop nen Systems DOC UM 20035 4 1 User Manual eS WiFi Module 7 DOCUMENT REVISION HISTORY sssssscccssssssssccsssssssecesssssssseccssssssseccesssnsssscessssnssescesssnussecesssnnsseseessnueteseesssnssecess 79 Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 Gop nen Systems ER DOC UM 20035 4 1 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 called IWIN for the eS WiFi Module product and to explain how to take advantage of the AT Command Set for Wi Fi Communications When you purchase the Inventek module we have programmed our latest fir
71. uming 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 5 6 2 1 TCP Client Set Up Set Communication Socket gt P020 OK 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 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 Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 71 Qe nen Systems DOC UM 20035 4 1 User Manual eS WiFi Module 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
72. ur based on asynchronous event such as a device connecting the Soft AP Access Point and AD commands TCP connection message from the P5 command The message will have a Start Of Message Asynchronous SOMA and End Of Message Asynchronous EOMA delimiters Responses SOMA AP DHCP Assigned AC 72 89 55 CE 36 has 192 168 10 100 EOMA 1 OK gt SOMA TCP SVR Accepted 192 168 2 2 5024 EOMA OK 2 gt 4 12 3 MS Suppress Async Message DHCP Suppresses the DHCP assigned messages from being sent to the host Usage MS lt Disable Supress gt lt CR gt Default Value 0 Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 42 Gop nen Systems DOC UM 20035 4 1 User Manual eS WiFi Module 4 12 4 MT Set Message Type Set the message type Normal full messages including usage on error or Simple No usage on error Usage MS Disable Simple CR Default Value 0 Example 1 gt MT ERROR Unknown Error Usage MT lt 0 Normal 1 Simple gt gt MT 1 OK gt MT ERROR gt Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 43 Embedding Connectivity Everywhere Gop nen Systems DOC UM 2003544 1 User Manual eS WiFi Module 4 13 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 T
73. ve an IP Address to communicate with a wireless network The Network DHCP Modes are listed in Table 4 3 Disabled User supplied IP Address Enabled Network supplied IP Address Table 4 3 Network DHCP Modes Usage C4 lt DHCP Modes gt lt CR gt Default Value C4 1 The following commands are used to configure the eS WiFi to join a wireless network Here is an example of the AT commands C1 Inventek SSID C2 Password Router Passphrase C3 2 WPA C4 1 DHCP Co eS WiFi joins the network CC 1 Auto Connect On Automatically connects on power up 21 Saves setting to flash In the above scenario as soon as power is applied to the eS WiFi the module will automatically connect to the Inventek router with the password and settings you entered If you want to change to another network you simple make the changes to the AT command and save your new settings into flash using the Z1 command Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 29 Gop nen Systems Embedding Connectivity Everywhere DOC UM 20035 4 1 User Manual eS WiFi Module 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 Table 4 4 Network
74. 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 Byte CR 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 The packets sent are RAW 802 3 Ethernet packets with the Wi Fi headers stripped off We insert our AT command format at the end of each packet as detailed in section 1 4 2 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 Preliminary Subject to change eS WiFi Module AT Command Set Version v4 1 33 Gop nen Systems DOC UM 20035 4 1 User Manual eS WiFi Module 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 MAC Address gt lt CR gt Default Value None 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 t

Download Pdf Manuals

Related Search

Related Contents

Fujitsu CELSIUS H710    User manual  FA1600C v2 Installation Manual  U USE ER MA ANU UAL L  Quantum GoVault User's Guide    FALL3D-6.2  User Manual IP Scanner: im2020, im2520, im2520f, im3520 - 2003-07  RIDGID RS33 Instructions / Assembly  

Copyright © All rights reserved. Failed to retrieve file