Espressif systems Esp8266 at Setup guide

Version 2.1.0

ESP8266 AT Instruction Set

About This Guide

This document provides AT commands list based on ESP8266_NONOS_SDK.

The document is structured as follows:

Release Notes

Chapter

Title

Content

Chapter 1

Overview

Provides instructions on user-deﬁned AT commands

and downloading of AT ﬁrmware.

Chapter 2

Command Description

Gives a basic description of AT commands.

Chapter 3

Basic AT Commands

Lists AT commands of basic functions.

Chapter 4

Wi-Fi AT Commands

Lists Wi-Fi-related AT commands.

Chapter 5

TCP/IP-Related AT Commands

Lists TCP/IP-related AT commands.

Chapter 6

Appendix

Lists the AT commands of which the conﬁguration is

saved in the ﬂash.

Chapter 7

Q & A

Provides information on where and how to consult

questions about ESP8266 AT commands.

Date

Version

Release notes

2016.04

V1.5.3

First Release.

2016.05

V1.5.4

Updated Section 5.2.16 and Section 5.2.19

2016.07

V2.0.0

Added Section 3.2.11, updated Section 1.2

2017.05

V2.1.0

Updated Section 3.2, Section 4.1 and Section 5.2.

󰋴录

1. Overview 1................................................................................................................................................

1.1. User-Deﬁned AT Commands!1"......................................................................................................................

1.2. Downloading AT Firmware into the Flash!2"...................................................................................................

1.2.1. 4 Mbit Flash!2"...................................................................................................................................

1.2.2. 8 Mbit Flash!2"...................................................................................................................................

1.2.3. 16 Mbit Flash, Map: 512 KB + 512 KB!3"..........................................................................................

1.2.4. 16 Mbit Flash, Map: 1024 KB + 1024 KB!3"......................................................................................

1.2.5. 32 Mbit Flash, Map: 512 KB + 512 KB!4"..........................................................................................

1.2.6. 32 Mbit Flash, Map: 1024 KB + 1024 KB!4"......................................................................................

2. Command Description 6..........................................................................................................................

3. Basic AT Commands 7.............................................................................................................................

3.1. Overview!7".....................................................................................................................................................

3.2. Commands!8".................................................................................................................................................

3.2.1. AT—Tests AT Startup!8".....................................................................................................................

3.2.2. AT+RST—Restarts the Module!8".....................................................................................................

3.2.3. AT+GMR—Checks Version Information!8"........................................................................................

3.2.4. AT+GSLP—Enters Deep-sleep Mode!8"...........................................................................................

3.2.5. ATE—AT Commands Echoing!9".......................................................................................................

3.2.6. AT+RESTORE—Restores the Factory Default Settings!9"................................................................

3.2.7. AT+UART—UART Conﬁguration!9"...................................................................................................

3.2.8. AT+UART_CUR—Current UART Conﬁguration; Not Saved in the Flash!11"....................................

3.2.9. AT+UART_DEF—Default UART Conﬁguration; Saved in the Flash!12".............................................

3.2.10. AT+SLEEP—Conﬁgures the Sleep Modes!13"..................................................................................

3.2.11. AT+WAKEUPGPIO—Conﬁgures a GPIO to Wake ESP8266 up from Light-sleep Mode!13"............

3.2.12. AT+RFPOWER—Sets the Maximum Value of RF TX Power!14".......................................................

3.2.13. AT+RFVDD—Sets RF TX Power According to VDD33!14"................................................................

3.2.14. AT+RFAUTOTRACE—Sets RF Frequency Oﬀset Trace!15"..............................................................

3.2.15. AT+SYSRAM—Checks the Remaining Space of RAM!15"...............................................................

3.2.16. AT+SYSADC—Checks the Value of ADC!15"....................................................................................

3.2.17. AT+SYSIOSETCFG—Conﬁgures IO Working Mode!16"....................................................................

3.2.18. AT+SYSIOGETCFG—Checks the Working Modes of IO Pins!16".....................................................

3.2.19. AT+SYSGPIODIR—Conﬁgures the Direction of a GPIO!16".............................................................

3.2.20. AT+SYSGPIOWRITE—Conﬁgures the Output Level of a GPIO!17"..................................................

3.2.21. AT+SYSGPIOREAD—Reads the GPIO Input Level!17".....................................................................

4. Wi-Fi AT Commands 19...........................................................................................................................

4.1. Overview!19"...................................................................................................................................................

4.2. Commands!21"...............................................................................................................................................

4.2.1. AT+CWMODE—Sets the Wi-Fi Mode (Station/SoftAP/Station+SoftAP)!21".....................................

4.2.2. AT+CWMODE_CUR—Sets the Current Wi-Fi mode; Conﬁguration Not Saved in the Flash!21"......

4.2.3. AT+CWMODE_DEF—Sets the Default Wi-Fi mode; Conﬁguration Saved in the Flash!21"..............

4.2.4. AT+CWJAP—Connects to an AP!22"................................................................................................

4.2.5. AT+CWJAP_CUR—Connects to an AP; Conﬁguration Not Saved in the Flash!23"..........................

4.2.6. AT+CWJAP_DEF—Connects to an AP; Conﬁguration Saved in the Flash!23".................................

4.2.7. AT+CWLAPOPT—Sets the Conﬁguration for the Command AT+CWLAP!25"..................................

4.2.8. AT+CWLAP—Lists Available APs!26"................................................................................................

4.2.9. AT+CWQAP—Disconnects from the AP!26".....................................................................................

4.2.10. AT+CWSAP—Conﬁgures the ESP8266 SoftAP!27"..........................................................................

4.2.11. AT+CWSAP_CUR—Conﬁgures the ESP8266 SoftAP; Conﬁguration Not Saved in the Flash!27"....

4.2.12. AT+CWSAP_DEF—Conﬁgures the ESP8266 SoftAP; Conﬁguration Saved in the Flash!28"...........

4.2.13. AT+CWLIF—IP of Stations to Which the ESP8266 SoftAP is Connected!29"...................................

4.2.14. AT+CWDHCP—Enables/Disables DHCP!29"....................................................................................

4.2.15. AT+CWDHCP_CUR—Enables/Disables DHCP; Conﬁguration Not Saved in the Flash!29".............

4.2.16. AT+CWDHCP_DEF—Enables/Disables DHCP; Conﬁguration Saved in the Flash!30".....................

4.2.17. AT+CWDHCPS_CUR—Sets the IP Address Allocated by ESP8266 SoftAP DHCP;

Conﬁguration Not Saved in Flash!31"...............................................................................................................

4.2.18. AT+CWDHCPS_DEF—Sets the IP Address Allocated by ESP8266 SoftAP DHCP; Conﬁguration

Saved in Flash!31".............................................................................................................................................

4.2.19. AT+CWAUTOCONN—Auto-Connects to the AP or Not!32".............................................................

4.2.20. AT+CIPSTAMAC—Sets the MAC Address of the ESP8266 Station!32"...........................................

4.2.21. AT+CIPSTAMAC_CUR—Sets the MAC Address of the ESP8266 Station; Conﬁguration Not

Saved in the Flash!32".......................................................................................................................................

4.2.22. AT+CIPSTAMAC_DEF—Sets the MAC Address of the ESP8266 Station; Conﬁguration Saved in

the Flash!33"......................................................................................................................................................

4.2.23. AT+CIPAPMAC—Sets the MAC Address of the ESP8266 SoftAP!33"..............................................

4.2.24. AT+CIPAPMAC_CUR—Sets the MAC Address of the ESP8266 SoftAP; Conﬁguration Not

Saved in the Flash!34".......................................................................................................................................

4.2.25. AT+CIPAPMAC_DEF—Sets the MAC Address of the ESP8266 SoftAP; Conﬁguration Saved in

Flash!34"............................................................................................................................................................

4.2.26. AT+CIPSTA—Sets the IP Address of the ESP8266 Station!35"........................................................

4.2.27. AT+CIPSTA_CUR—Sets the IP Address of the ESP8266 Station; Conﬁguration Not Saved in

the Flash!35"......................................................................................................................................................

4.2.28. AT+CIPSTA_DEF—Sets the IP Address of the ESP8266 Station; Conﬁguration Saved in the

Flash!36"............................................................................................................................................................

4.2.29. AT+CIPAP—Sets the IP Address of the ESP8266 SoftAP!36"..........................................................

4.2.30. AT+CIPAP_CUR—Sets the IP Address of the ESP8266 SoftAP; Conﬁguration Not Saved in the

Flash!37"............................................................................................................................................................

4.2.31. AT+CIPAP_DEF—Sets the IP Address of the ESP8266 SoftAP; Conﬁguration Saved in the Flash

!37"....................................................................................................................................................................

4.2.32. AT+CWSTARTSMART—Starts SmartConﬁg!38"...............................................................................

4.2.33. AT+CWSTOPSMART—Stops SmartConﬁg!38"................................................................................

4.2.34. AT+CWSTARTDISCOVER—Enables the Mode that ESP8266 can be Found by WeChat!39"..........

4.2.35. AT+CWSTOPDISCOVER—Disables the Mode that ESP8266 can be Found by WeChat!39"..........

4.2.36. AT+WPS—Enables the WPS Function!39"........................................................................................

4.2.37. AT+MDNS—Conﬁgures the MDNS Function!40"..............................................................................

4.2.38. AT+CWHOSTNAME—Conﬁgures the Name of ESP8266 Station!40"..............................................

5. TCP/IP-Related AT Commands 41..........................................................................................................

5.1. Overview!41"...................................................................................................................................................

5.2. Commands!42"...............................................................................................................................................

5.2.1. AT+CIPSTATUS—Gets the Connection Status!42"...........................................................................

5.2.2. AT+CIPDOMAIN—DNS Function!42"................................................................................................

5.2.3. AT+CIPSTART—Establishes TCP Connection, UDP Transmission or SSL Connection!43".............

5.2.4. AT+CIPSSLSIZE—Sets the Size of SSL Buﬀer!45"...........................................................................

5.2.5. AT+CIPSEND—Sends Data!45".........................................................................................................

5.2.6. AT+CIPSENDEX—Sends Data!46"....................................................................................................

5.2.7. AT+CIPSENDBUF—Writes Data into the TCP-Send-Buﬀer!46"........................................................

5.2.8. AT+CIPBUFRESET—Resets the Segment ID Count!47"...................................................................

5.2.9. AT+CIPBUFSTATUS—Checks the Status of the TCP-Send-Buﬀer!48"............................................

5.2.10. AT+CIPCHECKSEQ—Checks If a Speciﬁc Segment Was Successfully Sent!48"............................

5.2.11. AT+CIPCLOSE—Closes the TCP/UDP/SSL Connection!49"............................................................

5.2.12. AT+CIFSR—Gets the Local IP Address!49"......................................................................................

5.2.13. AT+CIPMUX—Enable or Disable Multiple Connections!49"..............................................................

5.2.14. AT+CIPSERVER—Deletes/Creates TCP Server!50"..........................................................................

5.2.15. AT+CIPMODE—Sets Transmission Mode!50"...................................................................................

5.2.16. AT+SAVETRANSLINK—Saves the Transparent Transmission Link in Flash!51"...............................

5.2.17. AT+CIPSTO—Sets the TCP Server Timeout!52"...............................................................................

5.2.18. AT+PING—Ping Packets!52".............................................................................................................

5.2.19. AT+CIUPDATE—Updates the Software Through Wi-Fi!53"...............................................................

5.2.20. AT+CIPDINFO—Shows the Remote IP and Port with +IPD!53"........................................................

5.2.21. +IPD—Receives Network Data!53"...................................................................................................

5.2.22. AT+CIPSNTPCFG—Sets the Conﬁguration of SNTP!54"..................................................................

5.2.23. AT+CIPSNTPTIME—Checks the SNTP Time!54"..............................................................................

5.2.24. AT+CIPDNS_CUR—Sets User-deﬁned DNS Servers; Conﬁguration Not Saved in the Flash!54"....

5.2.25. AT+CIPDNS_DEF—Sets User-deﬁned DNS Servers; Conﬁguration Saved in the Flash!55"............

6. Appendix 56.............................................................................................................................................

7. Q&A 57......................................................................................................................................................

1. Overview

This document provides AT commands based on ESP8266_NONOS_SDK and explain how to use

them. AT command set is divided into: Basic AT commands, Wi-Fi AT commands, and TCP/IP AT

commands.

1.1. User-Deﬁned AT Commands

Please use only English letters when naming user-deﬁned AT commands. The AT command name

must NOT contain characters or numbers.

AT ﬁrmware is based on ESP8266_NONOS_SDK. Espressif Systems’ AT commands are provided in

libat.a, which is included in the AT BIN ﬁrmware. Examples of customized, user-deﬁned AT

commands are provided in ESP8266_NONOS_SDK/example/at.

Examples of implementing user-deﬁned AT commands are provided in /ESP8266_NONOS_SDK/

examples/at/user/user_main.c. The structure, at_funcationType, is used to deﬁne four types of a

command, for details of which please refer to the following table.

Deﬁnition

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 conﬁguration

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

!/!1 58

2017.05

1. Overview

All the ﬁles in folder at should be copied to the folder app in ESP8266_NONOS_SDK if users need to

compile the AT ﬁrmware.

For details please refer to ESP8266 Getting Started Guide.

1.2. Downloading AT Firmware into the Flash

Please refer to ESP8266_NONOS_SDK/bin/at/readme.txt for instructions on how to download AT

ﬁrmware into ﬂash. Please use Espressif’s ofﬁcial Flash Download Tools to download the ﬁrmware.

Make sure you select the corresponding ﬂash size.

Espressif’s ofﬁcial Flash Download Tools:"

http://espressif.com/en/support/download/other-tools?keys=&ﬁeld_type_tid%5B%5D=14.

1.2.1. 4 Mbit Flash

With the release of ESP8266_NONOS_SDK_V2.0.0, AT_V1.3, AT ﬁrmware can use 4-Mbit ﬂash but

does not supports FOTA (upgrade AT ﬁrmware through Wi-Fi) function.

1.2.2. 8 Mbit Flash

If the ﬂash size is 8 Mbit or larger, users can use boot mode which supports AT ﬁrmware upgrade

feature through Wi-Fi by command AT+CIUPDATE. Use Espressif Flash download tool and select ﬂash

size: 8 Mbit.

BIN

Address

Description

blank.bin

0x78000

Initializes the RF_CAL parameter area.

esp_init_data_default.bin

0x7C000

Stores the default RF parameter values; the BIN has to be

downloaded into ﬂash at least once.

If the RF_CAL parameter area is initialized, this BIN has to be

downloaded too.

blank.bin

0x7A000

Initializes the ﬂash user parameter area; for more details please

see Appendix.

blank.bin

0x7E000

Initializes Flash system parameter area; for more details please

see Appendix.

eagle.ﬂash.bin

0x00000

In /bin/at/noboot.

eagle.irom0text.bin

0x10000

In /bin/at/noboot.

Espressif

!/!2 58

2017.05

1. Overview

1.2.3. 16 Mbit Flash, Map: 512 KB + 512 KB

Use Espressif Flash download tool and select ﬂash size: 16 Mbit.

1.2.4. 16 Mbit Flash, Map: 1024 KB + 1024 KB

Use Espressif Flash download tool and select ﬂash size: 16 Mbit-C1.

BIN

Address

Description

blank.bin

0xFB000

Initializes the RF_CAL parameter area.

esp_init_data_default.bin

0xFC000

Initializes the RF_CAL parameter area.

blank.bin

0x7E000

Stores the default RF parameter values; the BIN has to be

downloaded into ﬂash at least once.

If the RF_CAL parameter area is initialized, this BIN has to be

downloaded too.

blank.bin

0xFE000

Initializes the ﬂash user parameter area; for more details please

see Appendix.

boot.bin

0x00000

In /bin/at

user1.1024.new.2.bin

0x01000

In /bin/at/512+512

BIN

Address

Description

blank.bin

0x1FB000

Initializes RF_CAL parameter area.

esp_init_data_default.bin

0x1FC000

Stores default RF parameter values, has to be downloaded into

ﬂash at least once.

If the RF_CAL parameter area is initialized, this bin has to be

downloaded too.

blank.bin

0x7E000

Initializes Flash user parameter area, more details in Appendix.

blank.bin

0x1FE000

Initializes 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

Initializes RF_CAL parameter area.

esp_init_data_default.bin

0x1FC000

Stores default RF parameter values, has to be downloaded into

ﬂash at least once.

If the RF_CAL parameter area is initialized, this bin has to be

downloaded too.

blank.bin

0xFE000

Initializes Flash user parameter area, more details in Appendix.

BIN

Espressif

!/!3 58

2017.05

1. Overview

1.2.5. 32 Mbit Flash, Map: 512 KB + 512 KB

Use Espressif Flash download tool and select ﬂash size: 32 Mbit.

1.2.6. 32 Mbit Flash, Map: 1024 KB + 1024 KB

Use Espressif Flash download tool and select ﬂash size: 32 Mbit-C1.

blank.bin

0x1FE000

Initializes 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

Address

Description

blank.bin

0x3FB000

Initializes RF_CAL parameter area.

esp_init_data_default.bin

0x3FC000

Stores default RF parameter values, has to be downloaded into

ﬂash at least once.

If the RF_CAL parameter area is initialized, this bin has to be

downloaded too.

blank.bin

0x7E000

Initializes Flash user parameter area, more details in Appendix.

blank.bin

0x3FE000

Initializes 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

Initializes RF_CAL parameter area

esp_init_data_default.bin

0x3FC000

Stores default RF parameter values, has to be downloaded into

ﬂash at least once.

If the RF_CAL parameter area is initialized, this bin has to be

downloaded too.

blank.bin

0xFE000

Initializes Flash user parameter area, more details in Appendix.

blank.bin

0x3FE000

Initializes 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.

Espressif

!/!4 58

2017.05

Table of contents

Other Espressif Systems Motherboard manuals

Espressif Systems

Espressif Systems ESP32-LyraTD-SYNA User manual

Espressif Systems

Espressif Systems ESP-EYE User manual

Espressif Systems

Espressif Systems ESP8266 Series Instruction Manual

Espressif Systems

Espressif Systems ESP32-DevKitC User manual

Espressif Systems

Espressif Systems ESP8266-DevKitS User manual

Espressif Systems

Espressif Systems ESP32-LyraTD-DSPG User manual

Espressif Systems

Espressif Systems ESP Installation guide

Popular Motherboard manuals by other brands

Gigabyte

Gigabyte MNJ190I-FH user manual

Biostar

Biostar HI-FI-Z87X-3D Setup manual

Atmel

Atmel SAM9753PIA-DK user guide

Coapt

Coapt GEN2 Handbook

Supero

Supero SUPER P4DL6 user manual

Cypress

Cypress CY3210-PSoCEVAL1 quick start guide

ASROCK

ASROCK B660M-HDV manual

Fujitsu

Fujitsu D2831 Short description

Industrial Computers

Industrial Computers ADE-6050 user manual

Asus

Asus TUF Z270 MARK 2 manual

DFI

DFI NB71-BC user manual

ASROCK

ASROCK H61 Pro BTC user manual

Norco

Norco POS-7893 user manual

Intel

Intel DG965MS specification

Asus

Asus B85M-VIEW PAKER user manual

Asus

Asus P5G41T-M LX V2 user manual

Gigabyte

Gigabyte GA-K8VT800-RH user manual

Gigabyte

Gigabyte Z790M AORUS ELITE user manual

Espressif Systems ESP8266 AT Setup guide

Popular Motherboard manuals by other brands