Espressif Systems ESP8266 SDK Setup guide

ESP8266 AT Instruction Set
Version 0.24
Espressif Systems IOT Team
Copyright (c) 2015

! ! " !
Espressif Systems
ESP8266 AT Instruction Set
Disclaimer and Copyright Notice
Information in this document, including URL references, is subject to change without notice.
THIS DOCUMENT IS PROVIDED AS IS WITH NO WARRANTIES WHATSOEVER, INCLUDING ANY
WARRANTY OF MERCHANTABILITY, NON-INFRINGEMENT, FITNESS FOR ANY PARTICULAR
PURPOSE, OR ANY WARRANTY OTHERWISE ARISING OUT OF ANY PROPOSAL, SPECIFICATION
OR SAMPLE. All liability, including liability for infringement of any proprietary rights, relating to use
of information in this document is disclaimed. No licenses express or implied, by estoppel or
otherwise, to any intellectual property rights are granted herein.
The WiFi Alliance Member Logo is a trademark of the WiFi Alliance.
All trade names, trademarks and registered trademarks mentioned in this document are property of
their respective owners, and are hereby acknowledged.
Copyright © 2015 Espressif Systems Inc. All rights reserved.
Espressif Systems Confidential /Friday, May 22, 20152 54

! ! " !
Espressif Systems
ESP8266 AT Instruction Set
1. Preambles 6...................................................................................................
2. Command Description 7...............................................................................
3. Basic AT Command Set 8.............................................................................
3.1. Overview!8"..................................................................................................
3.2. Commands!8"..............................................................................................
1. AT – Test AT startup !8................................................................................
2. AT+RST – Restart module!9........................................................................
3. AT+GMR – View version info!9....................................................................
4. AT+GSLP – Enter deep-sleep mode!9........................................................
5. ATE – AT commands echo!10.....................................................................
6. AT+RESTORE – Factory reset!10................................................................
7. AT+UART – UART configuration!10.............................................................
8. AT+UART_CUR – current UART configuration!11.......................................
9. AT+UART_DEF – default UART configuration!12.........................................
10. AT+SLEEP – sleep mode!13.......................................................................
11. AT+RFPOWER – set RF TX Power!13.........................................................
12. AT+RFVDD – set RF TX Power according to VDD33!14..............................
4. WiFi Functions Overview 15.........................................................................
4.1. Commands!17"............................................................................................
1. AT+CWMODE – WiFi mode!17....................................................................
2. AT+CWMODE_CUR – current WiFi mode !18..............................................
3. AT+CWMODE_DEF – default WiFi mode!19................................................
4. AT+CWJAP – Connect to AP!20..................................................................
5. AT+CWJAP_CUR – Connect to AP，for current!21.....................................
6. AT+CWJAP_DEF – Connect to AP，save as default!22...............................
7. AT+CWLAP – List available APs !23.............................................................
8. AT+CWQAP – Disconnect from AP!23.........................................................
9. AT+CWSAP – Configuration of softAP mode!24..........................................
10. AT+CWSAP_CUR – Current config of softAP mode!25................................
Espressif Systems Confidential /Friday, May 22, 20153 54
Table of Contents

! ! " !
Espressif Systems
ESP8266 AT Instruction Set
11. AT+CWSAP_DEF – Default config of softAP mode!26..................................
12. AT+CWLIF – IP of stations !26.....................................................................
13. AT+CWDHCP – Enable/Disable DHCP !27..................................................
14. AT+CWDHCP_CUR – Enable/Disable DHCP!28..........................................
15. AT+CWDHCP_DEF – Enable/Disable DHCP and save to Flash !29..............
16. AT+CWAUTOCONN – Auto connect to AP or not!29...................................
17. AT+CIPSTAMAC – Set mac address of station !30.......................................
18. AT+CIPSTAMAC_CUR – Set mac address of station !30.............................
19. AT+CIPSTAMAC_DEF – Set mac address of station, save as default !31.....
20. AT+CIPAPMAC – Set mac address of softAP !31.........................................
21. AT+CIPAPMAC_CUR – Set mac address of softAP !32...............................
22. AT+CIPAPMAC_DEF – Set mac address of softAP and save as default!32..
23. AT+CIPSTA – Set IP address of station!33...................................................
24. AT+CIPSTA_CUR – Set IP address of station !34.........................................
25. AT+CIPSTA_DEF – Set IP address of station and save as default !35...........
26. AT+ CIPAP – Set IP address of softAP !36...................................................
27. AT+CIPAP_CUR – Set IP address of softAP !37...........................................
28. AT+CIPAP_DEF – Set IP address of softAP, save as default !38...................
29. AT+CWSTARTSMART – Start SmartConfig !39............................................
30. AT+CWSTOPSMART – stop SmartConfig !39..............................................
5. TCP/IP Related AT Commands 40...............................................................
5.1. Overview !40"...............................................................................................
5.2. TCP/IP!41"...................................................................................................
1. AT+CIPSTATUS – Information about connection!41.....................................
2. AT+CIPSTART – Start connection!42...........................................................
3. AT+CIPSEND – Send data !43.....................................................................
4. AT+CIPSENDEX – Send data !44.................................................................
5. AT+CIPSENDBUF – Write data into TCP-send-buffer!45..............................
6. AT+CIPBUFRESET – Reset segment ID count!45........................................
7. AT+CIPBUFSTATUS – Check status of TCP-send-buffer!46........................
8. AT+CIPCHECKSEG – Check if specific segment sent successfully or not!47
9. AT+CIPCLOSE – Close TCP or UDP connection!47.....................................
10. AT+CIFSR – Get local IP address !48...........................................................
Espressif Systems Confidential /Friday, May 22, 20154 54

! ! " !
Espressif Systems
ESP8266 AT Instruction Set
11. AT+CIPMUX – Enable multiple connections!49............................................
12. AT+CIPSERVER – Configure as TCP server !49...........................................
13. AT+CIPMODE – Set transfer mode !50........................................................
14. AT+SAVETRANSLINK – Save transparent transmission link to Flash !50......
15. AT+CIPSTO – Set TCP server timeout !51...................................................
16. AT+CIUPDATE – Update through network!51..............................................
17. AT+PING – Function Ping!52.......................................................................
18. +IPD – Receive network data !52.................................................................
6. Appendix 53....................................................................................................
7. Q&A 54............................................................................................................
Espressif Systems Confidential /Friday, May 22, 20155 54

! ! " !
Espressif Systems
ESP8266 AT Instruction Set
1. Preambles
This is the documentation for Espressif AT command Command set and usage.
Command set is divided into: Basic AT commands, WiFi related AT commands, TCP / IP AT
commands.
Copy all files in folder "at" to folder "app" in esp_iot_sdk if users need to compile AT.
Download:
boot.bin, downloads to flash 0x00000
user1.bin, downloads to flash 0x01000
blank.bin, factory initialize,
AT_v0.22 or version before that，corresponding to 512KB flash size，blank.bin downloads to flash
both 0x3E000 and 0x7E000
AT_v0.23 or version later than that, corresponding to 1024KB flash size，blank.bin downloads to
flash both 0x7E000 and 0xFE000
Please use Espressif official flash download tool http://bbs.espressif.com/viewtopic.php?f=5&t=433
select corresponding flash size while downloading.
Notes:
• Please make sure that correct BIN (/esp_iot_sdk/bin/at) is already in the chip (ESP8266) before
the AT commands listed in this documentation can be used.
• AT has already taken priority 0 and 1 of system_os_task , so only one task of priority 2 is allowed
to set up by user.
• AT returns messages below to show status of Wi-Fi connection of ESP8266 station
‣WIFI CONNECTED - Wi-Fi connected
‣WIFI GOT IP - ESP8266 station got IP from AP
‣WIFI DISCONNECT - Wi-Fi disconnected"
Espressif Systems Confidential /Friday, May 22, 20156 54

! ! " !
Espressif Systems
ESP8266 AT Instruction Set
2. Command Description
Each Command set contains four types of AT commands.
Notes:
1. Not all AT Command has four commands.
2. [] = default value, not required or may not appear
3. String values require double quotation marks, for example:
AT+CWSAP="ESP756290","21030826",1,4
4. Baudrate = 115200
5. AT Commands has to be capitalized, and end with "/r/n"
Type
Command Format
DescrIPtion
Test
AT+<x>=?
Query the Set command or internal parameters and its range
values.
Query
AT+<x>?
Returns the current value of the parameter.
Set
AT+<x>=<…>
Set the value of user-defined parameters in commands and run.
Execute
AT+<x>
Runs commands with no user-defined parameters.
Espressif Systems Confidential /Friday, May 22, 20157 54

! ! " !
Espressif Systems
ESP8266 AT Instruction Set
3. Basic AT Command Set
3.1. Overview
The ESP8266 wireless WiFi modules can be driven via the serial interface using the standard AT
commands. Here is a list of some basic AT commands that can be used.
3.2. Commands
1. AT – Test AT startup
The type of this command is "executed". It's used to test the setup function of your wireless WiFi
module.
Basic
Command
Description
AT
Test AT startup
AT+RST
Restart module
AT+GMR
View version info
AT+GSLP
Enter deep-sleep mode
ATE
AT commands echo or not
AT+RESTORE
Factory Reset
AT+UART
UART configuration, [@deprecated]
AT+UART_CUR
UART current configuration
AT+UART_DEF
UART default configuration, save to flash
AT+SLEEP
Sleep mode
AT+RFPOWER
Set RF TX Power
AT+RFVDD
Set RF TX Power according to VDD33
AT – Test AT startup
Response
OK
Parameters
null
Espressif Systems Confidential /Friday, May 22, 20158 54

! ! " !
Espressif Systems
ESP8266 AT Instruction Set
2. AT+RST – Restart module
The type of this command is "executed". It’s used to restart the module.
3. AT+GMR – View version info
This AT command is used to check the version of AT commands and SDK that you are using, the type
of which is "executed".
4. AT+GSLP – Enter deep-sleep mode
This command is used to invoke the deep-sleep mode of the module, the type of which is "set". A
minor adjustment has to be made before the module enter this deep sleep mode, i.e., connect
XPD_DCDC with EXT_RSTB via 0R.
AT+RST – Restart module
Response
OK
Parameters
null
AT+GMR – View version info
Response
< AT version info >
< SDK version info >
< compile time >
OK
Parameters
< AT version info > information about AT version
< SDK version info > information about SDK version
< compile time > time of the bin was compiled
AT+GSLP=<time>
Response
<time>
OK
Parameters
The time unit of < time > is ms. ESP8266 will wake up after X ms and then
enter the deep sleep mode.
Espressif Systems Confidential /Friday, May 22, 20159 54

! ! " !
Espressif Systems
ESP8266 AT Instruction Set
5. ATE – AT commands echo
This command ATE is an AT trigger command echo. It means that entered commands can be echoed
back to the sender when ATE command is used. Two parameters are possible. The command returns
"OK" in normal cases and "ERROR" when a parameter other than 0 or 1 was specified.
6. AT+RESTORE – Factory reset
This command is used to reset all parameters saved in flash (according to appendix), restore the
factory default settings of the module. The chip will be restarted when this command is executed.
7. AT+UART – UART configuration
This command sets the UART configuration and writes the new configuration to the flash. It is stored
as the default parameter and will also be used as the default baudrate henceforth. [THIS API IS
DEPRECATED.]
ATE – AT commands echo
Response
OK
Parameters
ATE0: Switch echo off
ATE1: Switch echo on
AT+RESTORE – Factory reset
Response
OK
Notes
Restore factory default settings.
The chip will restart.
AT+UART=<baudrate>,<databits>,<stopbits>,<parity>,<flow control>
This API is deprecated, please use AT+UART_CUR or AT+UART_DEF instead.
Example
AT+UART=115200,8,1,0,3
Response
OK
Parameters
<baudrate>
Baudrate range: 110 to 115200*40 (4.608 Mega)
<databits>!
5: 5 bits data!
6: 6 bits data!
7: 7 bits data!
8: 8 bits data
<stopbits>
1: 1 bit stop bit!
2: 1.5 bit stop bit!
3: 2 bit stop bit
AT+UART=<baudrate>,<databits>,<stopbits>,<parity>,<flow control>
This API is deprecated, please use AT+UART_CUR or AT+UART_DEF instead.
Espressif Systems Confidential /Friday, May 22, 201510 54

! ! " !
Espressif Systems
ESP8266 AT Instruction Set
8. AT+UART_CUR – current UART configuration
This command sets the current UART configuration; it does not write to the flash device. Hence there
is no change in the default baudrate.
<parity>
0: None!
1: Odd!
2: EVEN
<flow control>
0: disable flow control!
1: enable RTS!
2: enable CTS!
3: enable both RTS and CTS
Notes
•This configuration will also store the baud rate as the default rate in the
user parameter area in the Flash for boot up.
•Flow control needs hardware support: MTCK is UART0 CTS and MTDO is UART0
RTS.
AT+UART=<baudrate>,<databits>,<stopbits>,<parity>,<flow control>
This API is deprecated, please use AT+UART_CUR or AT+UART_DEF instead.
AT+UART=<baudrate>,<databits>,<stopbits>,<parity>,<flow control>
This API is deprecated, please use AT+UART_CUR or AT+UART_DEF instead.
AT+UART_CUR=<baudrate>,<databits>,<stopbits>,<parity>,<flow control>
Example
AT+UART_CUR=115200,8,1,0,3
Response
OK
Parameters
<baudrate>
Baudrate range: 110 to 115200*40 (4.608 Mega)
<databits>!
5: 5 bits data!
6: 6 bits data!
7: 7 bits data!
8: 8 bits data
<stopbits>
1: 1 bit stop bit!
2: 1.5 bit stop bit!
3: 2 bit stop bit
<parity>
0: None!
1: Odd!
2: EVEN
<flow control>
0: disable flow control!
1: enable RTS!
2: enable CTS!
3: enable both RTS and CTS
Notes
•This configuration will NOT be stored in the flash; unlike the AT+UART
command.
•Flow control needs hardware support: MTCK is UART0 CTS and MTDO is UART0
RTS.
Espressif Systems Confidential /Friday, May 22, 201511 54

! ! " !
Espressif Systems
ESP8266 AT Instruction Set
9. AT+UART_DEF – default UART configuration
This command sets the UART configuration and save it to flash. It is stored as the default parameter
and will also be used as the default baudrate henceforth.
AT+UART_DEF=<baudrate>,<databits>,<stopbits>,<parity>,<flow control>
Example
AT+UART_DEF=115200,8,1,0,3
Response
OK
Parameters
<baudrate>
Baudrate range: 110 to 115200*40 (4.608 Mega)
<databits>!
5: 5 bits data!
6: 6 bits data!
7: 7 bits data!
8: 8 bits data
<stopbits>
1: 1 bit stop bit!
2: 1.5 bit stop bit!
3: 2 bit stop bit
<parity>
0: None!
1: Odd!
2: EVEN
<flow control>
0: disable flow control!
1: enable RTS!
2: enable CTS!
3: enable both RTS and CTS
Notes
•This configuration will be stored in the flash user parameter area.
•Flow control needs hardware support: MTCK is UART0 CTS and MTDO is UART0
RTS.
Espressif Systems Confidential /Friday, May 22, 201512 54

! ! " !
Espressif Systems
ESP8266 AT Instruction Set
10. AT+SLEEP – sleep mode
This command sets ESP8266 sleep mode. It can only be used in station mode，default to be modem-
sleep mode .
11. AT+RFPOWER – set RF TX Power
This command sets ESP8266 RF TX power, it is not precise, it is setting the maximum value of RF TX
power.
AT+SLEEP – sleep mode
Command
AT+SLEEP?
Response
+SLEEP:<sleep mode>
OK
Parameters
<sleep mode> 0 means disable sleep mode
<sleep mode> 1 means light-sleep mode
<sleep mode> 2 means modem-sleep mode
Command
AT+SLEEP=<sleep mode>
Response
OK
Parameters
The same as above.
AT+RFPOWER – set RF TX Power
Example
AT+RFPOWER=50
Command
AT+RFPOWER=<TX power>
Response
OK
Parameters
<TX power> maximum value of RF TX power, range 0 ~ 82
Espressif Systems Confidential /Friday, May 22, 201513 54

! ! " !
Espressif Systems
ESP8266 AT Instruction Set
12. AT+RFVDD – set RF TX Power according to VDD33
This command sets ESP8266 RF TX power according to VDD33. To get the power voltage of
ESP8266 VDD3P3, TOUT pin has to be suspended.
AT+RFVDD – set RF TX power according to VDD33
Command
AT+RFVDD?
Response
+RFVDD:<VDD33>
OK
Parameters
<VDD33> power voltage of ESP8266 VDD33, unit: 1/1024 V
TOUT pin has to be suspended to measure VDD33.
Command
AT+RFVDD=<VDD33>
Response
OK
Parameters
<VDD33> power voltage of ESP8266 VDD33, range [1900, 3300]
Command
AT+RFVDD
Response
OK
Note
“AT+RFVDD” will automatically set RF TX power according to VDD33.
TOUT pin has to be suspended.
Espressif Systems Confidential /Friday, May 22, 201514 54

! ! " !
Espressif Systems
ESP8266 AT Instruction Set
4. WiFi Functions Overview
WiFi Connectivity Functions Invoked by AT commands
Command
Description
AT+CWMODE
WIFI mode（sta/AP/sta+AP）, [@deprecated]
AT+CWMODE_CUR
WIFI mode（sta/AP/sta+AP）
Won’t save to Flash
AT+CWMODE_DEF
WIFI default mode（sta/AP/sta+AP）
Save to Flash
AT+CWJAP
Connect to AP, [@deprecated]
AT+CWJAP_CUR
Connect to AP, won’t save to Flash
AT+CWJAP_DEF
Connect to AP, save to Flash
AT+CWLAP
Lists available APs
AT+CWQAP
Disconnect from AP
AT+CWSAP
Set configuration of ESP8266 softAP
[@deprecated]
AT+CWSAP_CUR
Set configuration of ESP8266 softAP
Won’t save to Flash.
AT+CWSAP_DEF
Set configuration of ESP8266 softAP
Save to Flash.
AT+CWLIF
Get station’s IP which is connected to ESP8266 softAP
AT+CWDHCP
Enable/Disable DHCP, [@deprecated]
AT+CWDHCP_CUR
Enable/Disable DHCP, won’t save to Flash
AT+CWDHCP_DEF
Enable/Disable DHCP, save to Flash
AT+CWAUTOCONN
Connect to AP automatically when power on
AT+CIPSTAMAC
Set mac address of ESP8266 station
[@deprecated]
AT+CIPSTAMAC_CUR
Set mac address of ESP8266 station
Won’t save to Flash.
Espressif Systems Confidential /Friday, May 22, 201515 54

! ! " !
Espressif Systems
ESP8266 AT Instruction Set
AT+CIPSTAMAC_DEF
Set mac address of ESP8266 station
Save to Flash.
AT+CIPAPMAC
Set mac address of ESP8266 softAP
[@deprecated]
AT+CIPAPMAC_CUR
Set mac address of ESP8266 softAP
Won’t save to Flash.
AT+CIPAPMAC_DEF
Set mac address of ESP8266 softAP
Save to Flash.
AT+CIPSTA
Set IP address of ESP8266 station, [@deprecated]
AT+CIPSTA_CUR
Set IP address of ESP8266 station
Won’t save to Flash.
AT+CIPSTA_DEF
Set IP address of ESP8266 station
Save to Flash.
AT+CIPAP
Set IP address of ESP8266 softAP, [@deprecated]
AT+CIPAP_CUR
Set IP address of ESP8266 softAP
Won’t save to Flash.
AT+CIPAP_DEF
Set IP address of ESP8266 softAP
Save to Flash.
Espressif Systems Confidential /Friday, May 22, 201516 54

! ! " !
Espressif Systems
ESP8266 AT Instruction Set
4.1. Commands
1. AT+CWMODE – WiFi mode
The function of this AT command is to get the value scope of WiFi mode, including station mode,
softAP mode, and station+softAP mode, enquiry about the information of WiFi mode, or set the WiFi
mode.
AT+CWMODE – WiFi mode
[@deprecated]. Please use AT+CWMODE_CUR or AT+CWMODE_DEF instead.
Command
AT+CWMODE=?
Response
+CWMODE:( value scope of <mode>)
OK
Parameters
Please refer to AT command settings.
Command
AT+CWMODE?
Response
+CWMODE:<mode>
OK
Parameters
Please refer to AT command settings.
Command
AT+CWMODE=<mode>
Response
OK
Parameters
<mode>1 means Station mode
<mode>2 means softAP mode
<mode>3 means AP + Station mode
Notes
This setting will be stored in the flash system parameter area. It won’t
be erased even when the power is off and restarted.
Espressif Systems Confidential /Friday, May 22, 201517 54

! ! " !
Espressif Systems
ESP8266 AT Instruction Set
2. AT+CWMODE_CUR – current WiFi mode
There are three WiFi working modes: Station mode, softAP mode, and the co-existence of Station
mode and softAP mode. This command is used to acquire the existing WiFi mode, or to set a
customised WiFi mode.
AT+CWMODE_CUR – Set WIFI mode（sta/AP/sta+AP）, won’t save to Flash
Example
AT+CWMODE_CUR=3
Command
AT+CWMODE_CUR=?
Response
+CWMODE_CUR:( value scope of <mode>)
OK
Parameters
<mode>1 means Station mode
<mode>2 means softAP mode
<mode>3 means AP + Station mode
Command
AT+CWMODE_CUR?
Response
+CWMODE_CUR:<mode>
OK
Parameters
<mode>1 means Station mode
<mode>2 means softAP mode
<mode>3 means AP + Station mode
Command
AT+CWMODE_CUR=<mode>
Response
OK
Parameters
<mode>1 means Station mode
<mode>2 means softAP mode
<mode>3 means AP + Station mode
Notes
This configuration will not store in Flash.
Espressif Systems Confidential /Friday, May 22, 201518 54

! ! " !
Espressif Systems
ESP8266 AT Instruction Set
3. AT+CWMODE_DEF – default WiFi mode
AT+CWMODE_DEF - WIFI mode (sta/AP/sta+AP), save to Flash
Example
AT+CWMODE_DEF=3
Command
AT+CWMODE_DEF=?
Response
+CWMODE_DEF:( value scope of <mode>)
OK
Parameters
<mode>1 means Station mode
<mode>2 means softAP mode
<mode>3 means AP + Station mode
Command
AT+CWMODE_DEF?
Response
+CWMODE_DEF:<mode>
OK
Parameters
<mode>1 means Station mode
<mode>2 means softAP mode
<mode>3 means AP + Station mode
Command
AT+CWMODE_DEF=<mode>
Response
OK
Parameters
<mode>1 means Station mode
<mode>2 means softAP mode
<mode>3 means AP + Station mode
Notes
This configuration will store in Flash system parameter area.
Espressif Systems Confidential /Friday, May 22, 201519 54

! ! " !
Espressif Systems
ESP8266 AT Instruction Set
4. AT+CWJAP – Connect to AP
AT+CWJAP – Connect to AP
[@deprecated]. Please use AT+CWJAP_CUR or AT+CWJAP_DEF instead.
Example
AT+CWJAP ="abc"，"0123456789"
If SSID is "ab/,c" and password is "0123456789"/"
AT+CWJAP =“ab///,c"，"0123456789/"//"
If several APs have the same SSID as “abc”,target AP can be found
by bssid：
AT+CWJAP =“abc”,“0123456789”,”ca:d7:19:d8:a6:44”
Command
AT+CWJAP?
Response
+CWJAP:<ssid>,<bssid>,<channel>,<rssi>
OK
Parameters
<ssid> string, AP’s SSID
Command
AT+CWJAP=<ssid>,<pwd>[,<bssid>]
Response
OK
or
+CWJAP:<error code>
FAIL
Parameters
<ssid> string, AP’s SSID
<pwd> string, MAX: 64 bytes ASCII
[<bssid>] string, AP’s bssid(MAC address), for several APs may
have the same SSID
<error code> only for reference,it’s not reliable
<error code> 1 connecting timeout
<error code> 2 wrong password
<error code> 3 can not found target AP
<error code> 4 connect fail
This command needs station mode enable.
Escape character syntax is needed if "SSID" or "password" contains
any special characters
(’,’、’"’and’/’)
Notes
This configuration will store in Flash system parameter area.
Espressif Systems Confidential /Friday, May 22, 201520 54