Espressif Systems ESP8266 SDK Setup guide

!
!
ESP8266 AT Instruction Set
Version 2.0.0
Espressif Systems IoT Team
Copyright © 2016

!
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 © 2016 Espressif Systems. All rights reserved.!

!
About This Guide
This document provides AT commands list based on ESP8266_NONOS_SDK.!
The document is structured as follows.!
Release Notes
Chapter
Title
Subject
Chapter 1
Preambles
Instructions on user-define AT command and downloading.
Chapter 2
Command Description
Basic description of AT commands.
Chapter 3
Basic AT Commands
List basic function AT commands.
Chapter 4
Wi-Fi Related AT Commands
Lists Wi-Fi related AT commands.
Chapter 5
TCP/IP AT Commands
Lists TCP/IP related AT commands.
Chapter 6
Appendix
List the AT commands which will save configuration into flash.
Chapter 7
Q & A
Provides information about AT technical support.
Date
Version
Release notes
2016.04
V1.5.3
First Release
2016.05
V1.5.4
Updated Chapter 5.2.16 and Chapter 5.2.19
2016.07
V2.0.0
Added Chapter 3.2.11, updated Chapter 1.2

" " ! "
Espressif Systems
ESP8266 AT Instruction Set
1. Preambles 5...................................................................................................
1.1. User-defined AT commands"5!....................................................................
1.2. Downloading AT firmware into Flash"6!.......................................................
1. 4Mbit Flash!6...............................................................................................
2. 8Mbit Flash!6...............................................................................................
3. 16Mbit Flash, map: 512KB + 512KB!7........................................................
4. 16Mbit Flash, map: 1024KB + 1024KB!7....................................................
5. 32Mbit Flash, map: 512KB + 512KB!8........................................................
6. 32Mbit Flash, map: 1024KB + 1024KB!8....................................................
2. Command Description 10.............................................................................
3. Basic AT Commands 11................................................................................
3.1. Overview"11!................................................................................................
3.2. Commands"12!............................................................................................
1. AT – Test AT startup !12...............................................................................
2. AT+RST – Restart module!12......................................................................
3. AT+GMR – View version info!12...................................................................
4. AT+GSLP – Enter deep-sleep mode!13.......................................................
5. ATE – AT commands echo!13......................................................................
6. AT+RESTORE – Factory reset!13.................................................................
7. AT+UART – UART configuration!14.............................................................
8. AT+UART_CUR – current UART configuration!15........................................
9. AT+UART_DEF – default UART configuration!16..........................................
10. AT+SLEEP – sleep mode!17........................................................................
11. AT+WAKEUPGPIO – set a GPIO to wake ESP8266 up from light-sleep mode!18...
12. AT+RFPOWER – set maximum value of RF TX Power!19.............................
13. AT+RFVDD – set RF TX Power according to VDD33!19...............................
4. Wi-Fi AT Commands 21.................................................................................
4.1. Commands"23!............................................................................................
Espressif Systems /Friday, July 15, 20161 73
Table of Contents

" " ! "
Espressif Systems
ESP8266 AT Instruction Set
1. AT+CWMODE – WiFi mode!23....................................................................
2. AT+CWMODE_CUR – current WiFi mode !24..............................................
3. AT+CWMODE_DEF – default WiFi mode!25................................................
4. AT+CWJAP – Connect to AP!26..................................................................
5. AT+CWJAP_CUR – Connect to AP, for current!27.......................................
6. AT+CWJAP_DEF – Connect to AP, save as default!28.................................
7. AT+CWLAPOPT – Set configuration for command AT+CWLAP !29.............
8. AT+CWLAP – List available APs !30.............................................................
9. AT+CWQAP – Disconnect from AP!31.........................................................
10. AT+CWSAP – Configuration of softAP mode!31..........................................
11. AT+CWSAP_CUR – Current config of softAP mode!32................................
12. AT+CWSAP_DEF – Default config of softAP mode!33..................................
13. AT+CWLIF – IP of stations !34.....................................................................
14. AT+CWDHCP – Enable/Disable DHCP !35..................................................
15. AT+CWDHCP_CUR – Enable/Disable DHCP!36..........................................
16. AT+CWDHCP_DEF – Enable/Disable DHCP and save to flash !37...............
17. AT+CWDHCPS_CUR – Set the IP address allocated by ESP8266 soft-AP DHCP, does
not save to flash!38.....................................................................................
18. AT+CWDHCPS_DEF – Set the IP address allocated by ESP8266 soft-AP DHCP, save
to flash!39....................................................................................................
19. AT+CWAUTOCONN – Auto connect to AP or not!39...................................
20. AT+CIPSTAMAC – Set MAC address of station !40......................................
21. AT+CIPSTAMAC_CUR – Set MAC address of station !41............................
22. AT+CIPSTAMAC_DEF – Set MAC address of station, save as default !41....
23. AT+CIPAPMAC – Set MAC address of softAP !42........................................
24. AT+CIPAPMAC_CUR – Set MAC address of softAP !42..............................
25. AT+CIPAPMAC_DEF – Set MAC address of softAP and save as default!43.
26. AT+CIPSTA – Set IP address of station!44...................................................
27. AT+CIPSTA_CUR – Set IP address of station !45.........................................
28. AT+CIPSTA_DEF – Set IP address of station and save as default !46...........
29. AT+ CIPAP – Set IP address of softAP !47...................................................
30. AT+CIPAP_CUR – Set IP address of softAP !48...........................................
31. AT+CIPAP_DEF – Set IP address of softAP, save as default !49...................
32. AT+CWSTARTSMART – Start SmartConfig !50............................................
Espressif Systems /Friday, July 15, 20162 73

" " ! "
Espressif Systems
ESP8266 AT Instruction Set
33. AT+CWSTOPSMART – stop SmartConfig !50..............................................
34. AT+CWSTARTDISCOVER – Start the mode that ESP8266 can be found by WeChat !...
51
35. AT+CWSTOPDISCOVER – Stop the mode that ESP8266 can be found by WeChat !.....
51
36. AT+WPS – Set WPS function !52.................................................................
37. AT+MDNS – Set MDNS function !52............................................................
5. TCP/IP Related AT Commands 53...............................................................
5.1. Overview "53!...............................................................................................
5.2. TCP/IP"54!...................................................................................................
1. AT+CIPSTATUS – Check network connection status!54..............................
2. AT+CIPDOMAIN – DNS function!54.............................................................
3. AT+CIPSTART – Establish TCP connection, UDP transmission or SSL connection!........
55
4. AT+CIPSSLSIZE – Set the size of SSL buffer !57.........................................
5. AT+CIPSEND – Send data !58.....................................................................
6. AT+CIPSENDEX – Send data !60.................................................................
7. AT+CIPSENDBUF – Write data into TCP-send-buffer!61..............................
8. AT+CIPBUFSTATUS – Check status of TCP-send-buffer!62........................
9. AT+CIPCHECKSEQ – Check if a specific segment was sent successfully!63
10. AT+CIPBUFRESET – Reset segment ID count!63........................................
11. AT+CIPCLOSE – Close TCP, UDP or SSL connection!64.............................
12. AT+CIFSR – Get local IP address !64...........................................................
13. AT+CIPMUX – Enable multiple connections!65............................................
14. AT+CIPSERVER – Configure as TCP server !66...........................................
15. AT+CIPMODE – Set transfer mode !67........................................................
16. AT+SAVETRANSLINK – Save transparent transmission link to flash !68.......
17. AT+CIPSTO – Set TCP server timeout !69...................................................
18. AT+PING – Function Ping!69.......................................................................
19. AT+CIUPDATE – Update through network!70..............................................
20. AT+CIPDINFO – Show remote IP and port with "+IPD" !70..........................
21. +IPD – Receive network data !71.................................................................
6. Appendix 72....................................................................................................
Espressif Systems /Friday, July 15, 20163 73

" " ! "
Espressif Systems
ESP8266 AT Instruction Set
7. Q&A 73............................................................................................................
Espressif Systems /Friday, July 15, 20164 73

" " ! "
Espressif Systems
ESP8266 AT Instruction Set
1. Preambles
AT command set is divided into: Basic AT commands, Wi-Fi AT commands, TCP/IP AT commands.!
1.1. User-defined AT commands
Please use only letters when naming user-defined AT commands. The AT command name must NOT
contain characters or numbers.
AT firmware is based on the ESP8266_NONOS_SDK. Espressif Systems AT commands are provided
in libat.a. In the example of \ESP8266_NONOS_SDK\examples\at\user\user_main.c, ways are
delivered on how to implement a custom, user-defined AT Command, " AT+TEST".
The structure, at_funcationType, is used to define four types of a command, e.g. "AT+TEST". !
All the files in folder "at" should be copied to theto folder "app" in ESP8266_NONOS_SDK if users need to
compile the AT firmware. !
Definition
Type
Description
at_testCmd
Test
AT Command
AT+TEST=?
Registered Callback In Example
at_testCmdTest
Function Design
Return the value"range of parameters
If at_testCmd is registered as NULL, there will be no testing command.
at_queryCmd
Query
AT Command
AT+TEST?
Registered Callback In Example
at_queryCmdTest
Function Design
Return the current value
If at_queryCmd is registered as NULL, there will be no query command.
at_setupCmd
Set
AT Command
AT+TEST=parameter1, parameter2, …
Registered Callback In Example
at_setupCmdTest
Function Design
Set configuration
If at_setupCmd is registered as NULL, there will be no setup command.
at_exeCmd
Execute
AT Command
AT+TEST
Registered Callback In Example
at_exeCmdTest
Function Design
Execute an action
If at_exeCmd is registered as NULL, there will be no execution
command.
Espressif Systems /Friday, July 15, 20165 73

" " ! "
Espressif Systems
ESP8266 AT Instruction Set
Please refer to ESP8266_Getting_Started_Guide for instructions on compiling applications.
1.2. Downloading AT firmware into Flash
Refer to ESP8266_NONOS_SDK\bin\at\readme.txt for instructions on how to download AT firmware
into Flash. Please use Espressif official Flash download tool and select corresponding Flash size to
download the firmware. !
Espressif official Flash download tool: http://bbs.espressif.com/viewtopic.php?f=5&t=433!
1. 4Mbit Flash
With the release of ESP8266_NONOS_SDK_V2.0.0, AT_V1.3, AT firmware can use 4Mbit Flash without
FOTA (upgrade AT firmware through Wi-Fi) function.!
2. 8Mbit Flash
If the Flash size is 8Mbit or larger, users can use boot mode which supports AT firmware upgrade
feature through Wi-Fi by command "AT+CIUPDATE". Use Espressif Flash download tool and select
Flash size: 8Mbit.!
bin
Address
Description
blank.bin
0x78000
Initialize RF_CAL parameter area
esp_init_data_default.bin
0x7C000
Stores default RF parameter values, has to be downloaded into
flash at least once.
If the RF_CAL parameter area is initialized, this bin has to be
downloaded too.
blank.bin
0x7A000
Initialize Flash user parameter area, more details in Appendix.
blank.bin
0x7E000
Initialize Flash system parameter area, more details in
Appendix.
eagle.flash.bin
0x00000
In \bin\at\noboot
eagle.irom0text.bin
0x10000
In \bin\at\noboot
Espressif Systems /Friday, July 15, 20166 73

" " ! "
Espressif Systems
ESP8266 AT Instruction Set
3. 16Mbit Flash, map: 512KB + 512KB
Use Espressif Flash download tool and select Flash size : 16Mbit.!
4. 16Mbit Flash, map: 1024KB + 1024KB
Use Espressif Flash download tool and select Flash size : 16Mbit-C1.!
bin
Address
Description
blank.bin
0xFB000
Initialize RF_CAL parameter area
esp_init_data_default.bin
0xFC000
Stores default RF parameter values, has to be downloaded into
flash at least once.
If the RF_CAL parameter area is initialized, this bin has to be
downloaded too.
blank.bin
0x7E000
Initialize Flash user parameter area, more details in Appendix.
blank.bin
0xFE000
Initialize Flash system parameter area, more details in
Appendix.
boot.bin
0x00000
In \bin\at
user1.1024.new.2.bin
0x01000
In \bin\at\512+512
bin
Address
Description
blank.bin
0x1FB000
Initialize RF_CAL parameter area
esp_init_data_default.bin
0x1FC000
Stores default RF parameter values, has to be downloaded into
flash at least once.
If the RF_CAL parameter area is initialized, this bin has to be
downloaded too.
blank.bin
0x7E000
Initialize Flash user parameter area, more details in Appendix.
blank.bin
0x1FE000
Initialize Flash system parameter area, more details in
Appendix.
boot.bin
0x00000
In \bin\at
user1.1024.new.2.bin
0x01000
In \bin\at\512+512
bin
Address
Description
blank.bin
0x1FB000
Initialize RF_CAL parameter area
bin
Espressif Systems /Friday, July 15, 20167 73

" " ! "
Espressif Systems
ESP8266 AT Instruction Set
5. 32Mbit Flash, map: 512KB + 512KB
Use Espressif Flash download tool and select Flash size : 32Mbit.!
6. 32Mbit Flash, map: 1024KB + 1024KB
Use Espressif Flash download tool and select Flash size : 32Mbit-C1.!
esp_init_data_default.bin
0x1FC000
Stores default RF parameter values, has to be downloaded into
flash at least once.
If the RF_CAL parameter area is initialized, this bin has to be
downloaded too.
blank.bin
0xFE000
Initialize Flash user parameter area, more details in Appendix.
blank.bin
0x1FE000
Initialize Flash system parameter area, more details in
Appendix.
boot.bin
0x00000
In \bin\at
user1.2048.new.5.bin
0x01000
In \bin\at\1024+1024
Address
Description
bin
bin
Address
Description
blank.bin
0x3FB000
Initialize RF_CAL parameter area
esp_init_data_default.bin
0x3FC000
Stores default RF parameter values, has to be downloaded into
flash at least once.
If the RF_CAL parameter area is initialized, this bin has to be
downloaded too.
blank.bin
0x7E000
Initialize Flash user parameter area, more details in Appendix.
blank.bin
0x3FE000
Initialize Flash system parameter area, more details in
Appendix.
boot.bin
0x00000
In \bin\at
user1.1024.new.2.bin
0x01000
In \bin\at\512+512
bin
Address
Description
blank.bin
0x3FB000
Initialize RF_CAL parameter area
bin
Espressif Systems /Friday, July 15, 20168 73

" " ! "
Espressif Systems
ESP8266 AT Instruction Set
Notes: !
•Please make sure that correct BIN (/ESP8266_NONOS_SDK/bin/at) is already in the chip (ESP8266)
before the AT commands listed in this documentation can be used.!
•AT firmware uses priority levels 0 and 1 of system_os_task, so only one task of priority 2 is allowed
to be set up by the 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&
esp_init_data_default.bin
0x3FC000
Stores default RF parameter values, has to be downloaded into
flash at least once.
If the RF_CAL parameter area is initialized, this bin has to be
downloaded too.
blank.bin
0xFE000
Initialize Flash user parameter area, more details in Appendix.
blank.bin
0x3FE000
Initialize Flash system parameter area, more details in
Appendix.
boot.bin
0x00000
In \bin\at
user1.2048.new.5.bin
0x01000
In \bin\at\1024+1024
Address
Description
bin
Espressif Systems /Friday, July 15, 20169 73

" " ! "
Espressif Systems
ESP8266 AT Instruction Set
2. Command Description
Each Command set contains four types of AT commands.!
Notes: !
1."Not all AT commands support all the above mentioned four variations.!
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."Default Baudrate = 115200!
5. AT commands have to be capitalized, and must terminate with "/r/n". Terminal programs must
be set up accordingly (refer to screenshot below).
!
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 /Friday, July 15, 201610 73

" " ! "
Espressif Systems
ESP8266 AT Instruction Set
3. Basic AT Commands
3.1. Overview
The ESP8266 wireless Wi-Fi 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.!
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+WAKEUPGPIO
Set a GPIO to wake ESP8266 up from light-sleep mode
AT+RFPOWER
Set maximum value of RF TX Power
AT+RFVDD
Set RF TX Power according to VDD33
Espressif Systems /Friday, July 15, 201611 73

" " ! "
Espressif Systems
ESP8266 AT Instruction Set
3.2. Commands
1. AT – Test AT startup
The type of this command is "executed". It is used to test the setup function of your wireless Wi-Fi
module.!
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 firmware installed and the SDK that it
uses, the type of which is "executed".!
AT – Test AT startup
Response
OK
Parameters
null
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
Espressif Systems /Friday, July 15, 201612 73

" " ! "
Espressif Systems
ESP8266 AT Instruction Set
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 0 ohm resistor. !
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. !
AT+GSLP=<time>
Response
<time>
OK
Parameters
The time unit of <time> is ms.
ESP8266 will wake up after deep sleep <time> ms.
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.
Espressif Systems /Friday, July 15, 201613 73

" " ! "
Espressif Systems
ESP8266 AT Instruction Set
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.]
AT+UART=<baudrate>, <databits>, <stopbits>, <parity>, <flow control>
This command 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
<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 baudrate 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.
Espressif Systems /Friday, July 15, 201614 73

" " ! "
Espressif Systems
ESP8266 AT Instruction Set
8. AT+UART_CUR – current UART configuration
This command sets the current UART configuration, it does not write changes to the flash. Hence
there is no change in the default baud rate.!
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 store in the flash.
•Flow control needs hardware support: MTCK is UART0 CTS and MTDO is
UART0 RTS.
Espressif Systems /Friday, July 15, 201615 73

" " ! "
Espressif Systems
ESP8266 AT Instruction Set
9. AT+UART_DEF – default UART configuration
This command sets the UART configuration and saves it to flash. It is stored as the default parameter
and will also be used as the default baud rate 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 flash user parameter area for boot up.
•Flow control needs hardware support: MTCK is UART0 CTS and MTDO is
UART0 RTS.
Espressif Systems /Friday, July 15, 201616 73

" " ! "
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. Modem sleep is the
default sleep mode.!
AT+SLEEP – sleep mode
Command
AT+SLEEP?
Response
+SLEEP : <sleep mode>
OK
Parameters
<sleep mode>
0 : disable sleep mode
1 : light-sleep mode
2 : modem-sleep mode
Command
AT+SLEEP=<sleep mode>
Response
OK
Parameters
The same as above.
Espressif Systems /Friday, July 15, 201617 73