Skip to content

Commit b333aa7

Browse files
committed
Merge branch 'docs/update_at_docs' into 'release/v2.2.0.0_esp8266'
docs: Backported some AT command docs to esp8266 See merge request application/esp-at!1646
2 parents 42c8e3f + b3bd9fd commit b333aa7

9 files changed

+734
-174
lines changed

docs/en/AT_Command_Set/Basic_AT_Commands.rst

-84
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@ Basic AT Commands
1717
- :ref:`AT+SLEEP <cmd-SLEEP>`: Set the sleep mode.
1818
- :ref:`AT+SYSRAM <cmd-SYSRAM>`: Query current remaining heap size and minimum heap size.
1919
- :ref:`AT+SYSMSG <cmd-SYSMSG>`: Query/Set System Prompt Information.
20-
- :ref:`AT+USERRAM <cmd-USERRAM>`: Operate user's free RAM.
2120
- :ref:`AT+SYSFLASH <cmd-SYSFLASH>`: Query/Set User Partitions in Flash.
2221
- [ESP32 Only] :ref:`AT+FS <cmd-FS>`: Filesystem Operations.
2322
- :ref:`AT+RFPOWER <cmd-RFPOWER>`: Query/Set RF TX Power.
@@ -625,89 +624,6 @@ Example
625624
// print no prompt info when the connection status is changed
626625
AT+SYSMSG=2
627626

628-
.. _cmd-USERRAM:
629-
630-
:ref:`AT+USERRAM <Basic-AT>`: Operate user's free RAM
631-
------------------------------------------------------
632-
633-
Query Command
634-
^^^^^^^^^^^^^
635-
636-
**Function:**
637-
638-
Query the current available user's RAM size.
639-
640-
**Command:**
641-
642-
::
643-
644-
AT+USERRAM?
645-
646-
**Response:**
647-
648-
::
649-
650-
+USERRAM:<size>
651-
OK
652-
653-
Set Command
654-
^^^^^^^^^^^
655-
656-
**Function:**
657-
658-
Operate user's free RAM
659-
660-
**Command:**
661-
662-
::
663-
664-
AT+USERRAM=<operation>,<size>[,<offset>]
665-
666-
**Response:**
667-
668-
::
669-
+USERRAM:<length>,<data> // esp-at returns this response only when the operator is ``read``
670-
671-
OK
672-
673-
Parameters
674-
^^^^^^^^^^
675-
676-
- **<operation>**:
677-
678-
- 0: release user's RAM
679-
- 1: malloc user's RAM
680-
- 2: write user's RAM
681-
- 3: read user's RAM
682-
- 4: clear user's RAM
683-
684-
- **<size>**: the size to malloc/read/write
685-
- **<offset>**: the offset to read/write. Default: 0
686-
687-
Notes
688-
^^^^^
689-
690-
- Please malloc the RAM size before you perform any other operations.
691-
- If the operator is ``write``, wrap return ``>`` after the write command, then you can send the data that you want to write. The length should be parameter ``<length>``.
692-
- If the operator is ``read`` and the length is bigger than 1024, ESP-AT will reply multiple times in the same format, each reply can carry up to 1024 bytes of data, and eventually end up with ``\r\nOK\r\n``.
693-
694-
Example
695-
^^^^^^^^
696-
697-
::
698-
699-
// malloc 1 KB user's RAM
700-
AT+USERRAM=1,1024
701-
702-
// write 500 bytes to RAM (offset: 0)
703-
AT+USERRAM=2,500
704-
705-
// read 64 bytes from RAM offset 100
706-
AT+USERRAM=3,64,100
707-
708-
// free the user's RAM
709-
AT+USERRAM=0
710-
711627
.. _cmd-SYSFLASH:
712628

713629
:ref:`AT+SYSFLASH <Basic-AT>`: Query/Set User Partitions in Flash

docs/en/AT_Command_Set/TCP-IP_AT_Commands.rst

+47-3
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ TCP/IP AT Commands
66
:link_to_translation:`zh_CN:[中文]`
77

88
- :ref:`AT+CIPV6 <cmd-IPV6>`: Enable/disable the network of Internet Protocol Version 6 (IPv6).
9-
- :ref:`AT+CIPSTATUS <cmd-STATUS>`: Obtain the TCP/UDP/SSL connection status and information.
9+
- :ref:`AT+CIPSTATE <cmd-IPSTATE>`: Obtain the TCP/UDP/SSL connection information.
10+
- :ref:`AT+CIPSTATUS (deprecated) <cmd-STATUS>`: Obtain the TCP/UDP/SSL connection status and information.
1011
- :ref:`AT+CIPDOMAIN <cmd-DOMAIN>`: Resolve a Domain Name.
1112
- :ref:`AT+CIPSTART <cmd-START>`: Establish TCP connection, UDP transmission, or SSL connection.
1213
- :ref:`AT+CIPSTARTEX <cmd-STARTEX>`: Establish TCP connection, UDP transmission, or SSL connection with an automatically assigned ID.
@@ -96,11 +97,54 @@ Notes
9697

9798
- You should enable IPv6 network before using IPv6 related upper layer AT commands (TCP/UDP/SSL/PING/DNS based on IPv6 network, also known as TCP6/UDP6/SSL6/PING6/DNS6 or TCPv6/UDPv6/SSLv6/PINGv6/DNSv6).
9899

99-
.. _cmd-STATUS:
100+
.. _cmd-IPSTATE:
100101

101-
:ref:`AT+CIPSTATUS <TCPIP-AT>`: Obtain the TCP/UDP/SSL Connection Status and Information
102+
:ref:`AT+CIPSTATE <TCPIP-AT>`: Obtain the TCP/UDP/SSL Connection Information
102103
----------------------------------------------------------------------------------------
103104

105+
Query Command
106+
^^^^^^^^^^^^^^^
107+
108+
**Command:**
109+
110+
::
111+
112+
AT+CIPSTATE?
113+
114+
**Response:**
115+
116+
When there is a connection, AT returns:
117+
118+
::
119+
120+
+CIPSTATE:<link ID>,<"type">,<"remote IP">,<remote port>,<local port>,<tetype>
121+
122+
OK
123+
124+
When there is no connection, AT returns:
125+
126+
::
127+
128+
OK
129+
130+
Parameters
131+
^^^^^^^^^^
132+
133+
- **<link ID>**: ID of the connection (0~4), used for multiple connections.
134+
- **<"type">**: string parameter showing the type of transmission: "TCP", "TCPv6", "UDP", "UDPv6", "SSL", or "SSLv6".
135+
- **<"remote IP">**: string parameter showing the remote IPv4 address or IPv6 address.
136+
- **<remote port>**: the remote port number.
137+
- **<local port>**: the local port number.
138+
- **<tetype>**:
139+
140+
- 0: ESP runs as a client.
141+
- 1: ESP runs as a server.
142+
143+
.. _cmd-STATUS:
144+
145+
:ref:`AT+CIPSTATUS (deprecated) <TCPIP-AT>`: Obtain the TCP/UDP/SSL Connection Status and Information
146+
-----------------------------------------------------------------------------------------------------
147+
104148
Execute Command
105149
^^^^^^^^^^^^^^^
106150

docs/en/AT_Command_Set/index.rst

+1
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ Here is a list of AT commands. Some of them can only work on the ESP32 series, s
2020
[ESP8266 Only] Signaling Test AT Commands <Signaling_Test_AT_Commands>
2121
Web server AT Commands <Web_server_AT_Commands>
2222
[ESP32 & ESP32S2 & ESP32-C3] Driver AT Commands <Driver_AT_Commands>
23+
User AT Commands <user_at_commands>
2324
AT Command Set Comparison <AT_Command_Set_Comparison>
2425

2526
It is strongly recommended to read the following sections for some common information on AT commands before you dive into the details of each command.

0 commit comments

Comments
 (0)