Ctreber: /* ESP8266 AT Command Reference */

2018-06-24T16:55:02Z

ESP8266 AT Command Reference

← Older revision		Revision as of 16:55, 24 June 2018
Line 1:		Line 1:
	=ESP8266 AT Command Reference=		=ESP8266 AT Command Reference=

			Communication with the ESP is via serial connection. The designers of the ESP adopted a scheme known as "AT commands" that stems from the age when computers connected to a network via modem (I am even older than that).

			The commands that the ESP understands depend on the firmware version. There are a number of those; here are the ones I found a manual for:

			* 0.20
			* 0.22
			* 0.23
			* 0.24
			* 0.25
			* 0.30
			* 1.3 At the beginning of 2017 this was the newest version when ordering from Banggood
			* 1.4
			* 1.5
			* 1.5.4
			* 2.0.0
			* 2.1.0

			REM: A change in FW version does not imply a change in supported AT commands.

			Communication with the ESP comes in four flavors:

			* test command: To query values parameters can assume, use AT+<cmd>=?
			* query command: To query the current value of parameters, use AT+<cmd&gt?
			* setup command: To set parameters, use AT+<cmd>=<x>
			* execute command: To execute a function, use AT+<cmd>

			This scheme does not always apply but gives you an idea.

			Generally:

			* Strings need to be quoted
			* Parameter are separated with a comma
			* Each command must be followed with CRLF
			* 115200Baud is the default speed

			I wrote a Java program that communicates with an ESP8266 to try out things before I put them into my AC_ESP8266 library. Testing out of Eclipse is just way faster and more convenient then uploading a new version to the Arduino each time. And, logging on the desktop offers way more possibilities.

	==Basic==		==Basic==

Ctreber: Created page with "=ESP8266 AT Command Reference= ==Basic==

Group AT Command Description Parameters Response MQTT-Rel..."
2018-06-24T11:47:28Z

Created page with "=ESP8266 AT Command Reference= ==Basic== <table class="wikitable"> <tr> <th>Group</th><th>AT Command</th><th>Description</th><th>Parameters</th><th>Response</th><th>MQTT-Rel..."

New page
=ESP8266 AT Command Reference=

==Basic==

<table class="wikitable">
<tr>
<th>Group</th><th>AT Command</th><th>Description</th><th>Parameters</th><th>Response</th><th>MQTT-Relevant?</th>
</tr>
<tr>
<td>Basic</td>
<td>AT</td>
<td>Test AT startup</td>
<td>-</td>
<td>OK</td>
<td></td>
</tr>

<tr>
<td>Basic</td>
<td>AT+RST</td>
<td>Restart module</td>
<td>-</td>
<td>OK</td>
<td>x, for error handling</td>
</tr>

<tr>
<td>Basic</td>
<td>AT+GMR</td>
<td>View version info</td>
<td>-</td>
<td>
<AT version info> 
<SDK version info> 
<compile time> 
 
OK</td>
<td>x, for issuing the correct commands</td>
</tr>

<tr>
<td>Basic</td>
<td>AT+GSLP</td>
<td>Enter deep-sleep mode</td>
<td><time in millis></td>
<td><time> 
OK
<td>-</td>
</tr>

<tr>
<td>Basic</td>
<td>ATE</td>
<td>AT</td>
<td>commands echo or not</td>
<td>ATE0, ATE1 
OK</td>
<td>-</td>
</tr>

<tr>
<td>Basic</td><td>AT+RESTORE</td>
<td>Factory reset</td>
<td>-</td>
<td>OK</td>
<td>-
</tr>
<tr>
<td>Basic</td><td>AT+UART</td>
<td>UART configuration, [@deprecated]</td>
<td>
</td>
<td>
</td>
<td>-
</tr>

<tr>
<td>Basic</td><td>AT+UART_CUR</td>
<td>UART current configuration</td>
<td>
<baudrate 110-115200>, <databits 5-8>, <stopbits 1: 1, 2: 1.5, 3: 2>, <parity 0: none, 1: odd, 2: even>, <flow control 0: disable, 1: RTS, 2: CTS, 3: RTS + CTS>
</td>
<td>OK</td>
<td>-
</tr>

<tr>
<td>Basic</td><td>AT+UART_DEF</td>
<td>UART default configuration, save to flash</td>
<td>
</td>
<td>
</td>
<td>once
</tr>

<tr>
<td>Basic</td><td>AT+SLEEP</td>
<td>Sleep mode (station mode only)</td>
<td><sleep mode 0: disable, 1: light, 2: modem></td>
<td>
Query:
+SLEEP:<sleep mode>
Set:
OK
</td>
<td>-</td>
</tr>

<tr>
<td>Basic</td><td>AT+WAKEUPGPIO</td>
<td>Set a GPIO to wake ESP8266 up from light-sleep mode</td>
<td>
</td>
<td>
</td>
<td>-
</tr>

<tr>
<td>Basic</td><td>AT+RFPOWER</td>
<td>Set maximum value of RF TX Power</td>
<td><power 0-82> in 0.25dBm</td>
<td>OK</td>
<td>-
</tr>

<tr>
<td>Basic</td><td>AT+RFVDD</td>
<td>Set RF TX Power according to VDD33</td>
<td>
</td>
<td>
</td>
<td>-
</tr>
</table>

==WLAN==

<table class="wikitable">
<tr>
<th>Group</th><th>AT Command</th><th>Description</th><th>Parameters</th><th>Response</th><th>MQTT-Relevant?</th>
</tr>
<tr>
<td>WLAN</td><td>AT+CWMODE</td>
<td>Wi-Fi mode(sta/AP/sta+AP), [@deprecated]</td>
<td>
</td>
<td>
</td>
<td>-
</tr>

<tr>
<td>WLAN</td><td>AT+CWMODE_CUR</td>
<td>Wi-Fi mode (station/ AP/ station+AP). Settings not updated in flash.</td>
<td><mode 1: station, 2: softAP, 3: softAP + station></td>
<td>
</td>
<td>-
</tr>

<tr>
<td>WLAN</td><td>AT+CWMODE_DEF</td>
<td>Wi-Fi default mode(station/ AP/ station+AP). Save to flash.</td>
<td>
</td>
<td>
</td>
<td>x - what does saving to flash provide?
</tr>

<tr>
<td>WLAN</td><td>AT+CWJAP</td>
<td>Connect to AP, [@deprecated]</td>
<td>

</td>
<td>
</td>
<td>-
</tr>

<tr>
<td>WLAN</td><td>AT+CWJAP_CUR</td>
<td>Connect to AP, won’t save to flash (station mode only)</td>
<td><ssid>,<pwd>[, <bssid>]</td>
<td>
Query:
+CWJAP_CUR:<ssid>, <bssid>, <channel>, <rssi>
OK
Set:
OK 
or
+CWJAP:<error code 1: connection timeout, 2: wrong password, 3: cannot find target AP, 4: connection failed>
</td>
<td>-</td>
</tr>

<tr>
<td>WLAN</td><td>AT+CWJAP_DEF</td>
<td>Connect to AP, save to flash (station mode only)</td>
<td>
</td>
<td>
</td>
<td>x - what does saving to flash provide?
</tr>

<tr>
<td>WLAN</td><td>AT+CWLAPOPT</td>
<td>Set the configuration of command AT+CWLAP</td>
<td><sort enable 0: no sort, 1: sort by rssi>,<mask b0: ECN, b1: SSID, b2: RSSI, b3: MAC, b4: chn, b5: freq offset, b6: freq calibration></td>
<td>
</td>
<td>
</tr>

<tr>
<td>WLAN</td><td>AT+CWLAP</td>
<td>Lists available APs</td>
<td><ssid>[, <mac>, <ch>]</td>
<td>
+CWLAP:<ecn 0: open, 1: WEP, 2: WPA_PSK, 3: WPA2_PSK, 4: WPA_WPA2_PSK, 5: WPA2_Enterprise>, <ssid>, <rssi>, <mac>, <ch>, <freq offset>, <freq calibration>
OK
depending on options set with CWLAPOPT
</td>
<td>maybe, for selecting a WLAN</td>
</tr>

<tr>
<td>WLAN</td><td>AT+CWQAP</td>
<td>Disconnect from AP</td>
<td>-</td>
<td>OK</td>
<td>maybe, for error handling
</tr>

<tr>
<td>WLAN</td><td>AT+CWSAP</td>
<td>Set configuration of ESP8266 soft-AP, [@deprecated]</td>
<td>
</td>
<td>
</td>
<td>-
</tr>

<tr>
<td>WLAN</td><td>AT+CWSAP_CUR</td>
<td>Set current configuration of ESP8266 soft-AP. Settings not updated in flash.</td>
<td>
<ssid>, <pwd>, <chl>, <ecn 0, 2, 3, 4>[, <max conn 1-4>][, <ssid hidden 0: broadcast, 1: don't broadcast>]
</td>
<td>
Query:
+CWSAP_CUR:<ssid>, <pwd>, <chl>, <ecn>, <max conn>, <ssid hidden>
Set:
OK
or
ERROR
</td>
<td>-</td>
</tr>

<tr>
<td>WLAN</td><td>AT+CWSAP_DEF</td>
<td>Set configuration of ESP8266 soft-AP. Save changes to flash.</td>
<td>
</td>
<td>
</td>
<td>-
</tr>

<tr>
<td>WLAN</td><td>AT+CWLIF</td>
<td>Get station IP which is connected to ESP8266 soft-AP</td>
<td>-</td>
<td>
<IP addr>, <mac>
 
OK
</td>
<td>-
</tr>

<tr>
<td>WLAN</td><td>AT+CWDHCP</td>
<td>Enable/Disable DHCP, [@deprecated]</td>
<td>
</td>
<td>
</td>
<td>-
</tr>

<tr>
<td>WLAN</td><td>AT+CWDHCP_CUR</td>
<td>Enable/Disable DHCP, changes not save to flash</td>
<td>
</td>
<td>
</td>
<td>-
</tr>

<tr>
<td>WLAN</td><td>AT+CWDHCP_DEF</td>
<td>Enable/Disable DHCP, save changes to flash</td>
<td>
</td>
<td>
</td>
<td>-
</tr>

<tr>
<td>WLAN</td><td>AT+CWDHCPS_CUR</td>
<td>Set IP range of DHCP server, changes not save to flash</td>
<td>
</td>
<td>
</td>
<td>-
</tr>

<tr>
<td>WLAN</td><td>AT+CWDHCPS_DEF</td>
<td>Set IP range of DHCP server, save changes to flash</td>
<td>
</td>
<td>
</td>
<td>-
</tr>

<tr>
<td>WLAN</td><td>AT+CWAUTOCONN</td>
<td>Connect to AP automatically on power-up</td>
<td><enable 0: disable, 1: enable auto-connect on startup></td>
<td>
</td>
<td>x - quite possibly!
</tr>

<tr>
<td>WLAN</td><td>AT+CIPSTAMAC</td>
<td>Set MAC address of ESP8266 station [@deprecated]</td>
<td>
</td>
<td>
</td>
<td>-
</tr>

<tr>
<td>WLAN</td><td>AT+CIPSTAMAC_CUR</td>
<td>Set MAC address of ESP8266 station. Changes not save to flash.</td>
<td>
</td>
<td>
</td>
<td>-
</tr>

<tr>
<td>WLAN</td><td>AT+CIPSTAMAC_DEF</td>
<td>Set MAC address of ESP8266 station. Save changes to flash.</td>
<td>
</td>
<td>
</td>
<td>-
</tr>

<tr>
<td>WLAN</td><td>AT+CIPAPMAC</td>
<td>Set MAC address of ESP8266 soft-AP [@deprecated]</td>
<td>
</td>
<td>
</td>
<td>-
</tr>

<tr>
<td>WLAN</td><td>AT+CIPAPMAC_CUR</td>
<td>Set MAC address of ESP8266 soft-AP. Changes not save to flash.</td>
<td>
</td>
<td>
</td>
<td>-
</tr>

<tr>
<td>WLAN</td><td>AT+CIPAPMAC_DEF</td>
<td>Set MAC address of ESP8266 soft-AP. Save changes to flash.</td>
<td>
</td>
<td>
</td>
<td>-
</tr>

<tr>
<td>WLAN</td><td>AT+CIPSTA</td>
<td>Set IP address of ESP8266 station, [@deprecated]</td>
<td>
</td>
<td>
</td>
<td>-
</tr>

<tr>
<td>WLAN</td><td>AT+CIPSTA_CUR</td>
<td>Set IP address of ESP8266 station. Changes not save to flash.</td>
<td>
</td>
<td>
</td>
<td>x - to query
</tr>

<tr>
<td>WLAN</td><td>AT+CIPSTA_DEF</td>
<td>Set IP address of ESP8266 station. Save changes to flash.</td>
<td>
</td>
<td>
</td>
<td>-
</tr>

<tr>
<td>WLAN</td><td>AT+CIPAP</td>
<td>Set IP address of ESP8266 soft-AP, [@deprecated]</td>
<td>
</td>
<td>
</td>
<td>-
</tr>

<tr>
<td>WLAN</td><td>AT+CIPAP_CUR</td>
<td>Set IP address of ESP8266 soft-AP. Changes not save to flash.</td>
<td>
</td>
<td>
</td>
<td>-
</tr>

<tr>
<td>WLAN</td><td>AT+CIPAP_DEF</td>
<td>Set IP address of ESP8266 soft-AP. Save changes to flash.</td>
<td>
</td>
<td>
</td>
<td>-
</tr>

<tr>
<td>WLAN</td><td>AT+CWSTARTSMART</td>
<td>Start SmartConfig (for AirKiss or ESP-TOUCH)</td>
<td>
</td>
<td>
</td>
<td>-
</tr>

<tr>
<td>WLAN</td><td>AT+CWSTOPSMART</td>
<td>Stop SmartConfig</td>
<td>
</td>
<td>
</td>
<td>-
</tr>

<tr>
<td>WLAN</td><td>AT+CWSTARTDISCOVER</td>
<td>Start the mode that ESP8266 can be found by WeChat</td>
<td>
</td>
<td>
</td>
<td>-
</tr>

<tr>
<td>WLAN</td><td>AT+CWSTOPDISCOVER</td>
<td>Stop the mode that ESP8266 can be found by WeChat</td>
<td>
</td>
<td>
</td>
<td>-
</tr>

<tr>
<td>WLAN</td><td>AT+WPS</td>
<td>Set WPS function</td>
<td>
</td>
<td>
</td>
<td>-
</tr>

<tr>
<td>WLAN</td><td>AT+MDNS</td>
<td>Set MDNS function</td>
<td>
</td>
<td>
</td>
<td>-
</tr>
</table>

==TCP==

<table class="wikitable">
<tr>
<th>Group</th><th>AT Command</th><th>Description</th><th>Parameters</th><th>Response</th><th>MQTT-Relevant?</th>
</tr>
<tr>
<td>TCP</td><td>AT+CIPSTATUS</td>
<td>Get connection status</td>
<td>
</td>
<td>
STATUS:<stat: 2: connected to AP, obtained IP, 3: TCP or UDP connection created, 4: TCP or UDP disconnected, 5: not connected to AP> 
 
+CIPSTATUS:<link ID 0-4>, <type TCP or UDP>, <remote_IP>, <remote_port>, <local_port>, <tetype 0: client, 1: server>
</td>
<td>x
</tr>

<tr>
<td>TCP</td><td>AT+CIPDOMAIN</td>
<td>DNS function</td>
<td>
</td>
<td>
</td>
<td>-
</tr>

<tr>
<td>TCP</td><td>AT+CIPSTART</td>
<td>Establish TCP connection, UDP transmission or SSL connection (only one at the same time, high memory consumption)</td>
<td><link ID 0-4>,<type TCP, UDP, SSL>, <remote IP>, <remote port>[, <TCP keep alive>]</td>
<td>
</td>
<td>x
</tr>

<tr>
<td>TCP</td><td>AT+CIPSSLSIZE</td>
<td>Set the size of SSL buffer</td>
<td>
</td>
<td>
</td>
<td>maybe, SSL would be great
</tr>

<tr>
<td>TCP</td><td>AT+CIPSEND</td>
<td>Send data</td>
<td>AT+CIPSEND=<link ID>, <length>
then receives serial data until length is reached, then
ERROR
or
SEND OK</td>
<td>x</td>
</tr>

<tr>
<td>TCP</td><td>AT+CIPSENDEX</td>
<td>Send data, if <length> or "\0" is met, data will be sent</td>
<td>
</td>
<td>
</td>
<td>
</tr>

<tr>
<td>TCP</td><td>AT+CIPSENDBUF</td>
<td>Write data into TCP-send-buffer</td>
<td>
</td>
<td>
</td>
<td>
</tr>

<tr>
<td>TCP</td><td>AT+CIPBUFRESET</td>
<td>Reset segment ID count</td>
<td>
</td>
<td>
</td>
<td>
</tr>

<tr>
<td>TCP</td><td>AT+CIPBUFSTATUS</td>
<td>Check status of TCP-send-buffer (not for SSL connections)</td>
<td>
</td>
<td>
</td>
<td>
</tr>

<tr>
<td>TCP</td><td>AT+CIPCHECKSEQ</td>
<td>Check if a specific segment is sent or not</td>
<td>
</td>
<td>
</td>
<td>
</tr>

<tr>
<td>TCP</td><td>AT+CIPCLOSE</td>
<td>Close TCP/UDP/SSL connection </td>
<td>
</td>
<td>
</td>
<td>x
</tr>

<tr>
<td>TCP</td><td>AT+CIFSR</td>
<td>Get local IP address </td>
<td>
</td>
<td>
+ CIFSR:<IP address> 
 
OK
</td>
<td>x
</tr>

<tr>
<td>TCP</td><td>AT+CIPMUX</td>
<td>Set multiple connections mode</td>
<td>
</td>
<td>
</td>
<td>x - to select single mode, but do we need single mode?
</tr>

<tr>
<td>TCP</td><td>AT+CIPSERVER</td>
<td>Configure as server</td>
<td>
</td>
<td>
</td>
<td>-
</tr>

<tr>
<td>TCP</td><td>AT+CIPMODE</td>
<td>Set transmission mode</td>
<td>
</td>
<td>
</td>
<td>- not used so far
</tr>

<tr>
<td>TCP</td><td>AT+SAVETRANSLINK</td>
<td>Save transparent transmission link to flash</td>
<td>
</td>
<td>
</td>
<td>- I get the impression this creates a TCP connection and after that, serial talks transparently to that connection
</tr>

<tr>
<td>TCP</td><td>AT+CIPSTO</td>
<td>Set timeout when ESP8266 runs as TCP server</td>
<td>
</td>
<td>
</td>
<td>-
</tr>

<tr>
<td>TCP</td><td>AT+CIUPDATE</td>
<td>Upgrade firmware through network</td>
<td>
</td>
<td>
</td>
<td>-
</tr>

<tr>
<td>TCP</td><td>AT+PING</td>
<td>Function PING </td>
<td><IP></td>
<td>
+<time> 
 
OK
Or
ERROR
</td>
<td>maybe, for error handling
</tr>
<tr>
<td>TCP</td><td>AT+CIPDINFO</td>
<td>Show remote IP and remote port with "+IPD" </td>
<td>
</td>
<td>
</td>
<td>-
</td>
</tr>
</table>

NOTOC

ESP8266 AT Command Reference - Revision history

Ctreber: /* ESP8266 AT Command Reference */