Skip to content

Commit 530471b

Browse files
ustccwustccw
committed
feat: update at docs
- Added http new errno - Added single/multiple connection notes for related commands - Added AT+CIPDINFO query command doc - Added blufi support notes for ESP32 - Added one note for ESP32-WROVER - Updated AT+CIPRECVMODE notes about link closed - Updated ESP32-C3 released time - Fixed wrong response of AT+CWDHCP query command - Closes espressif#576
1 parent cdc06db commit 530471b

File tree

13 files changed

+174
-26
lines changed

13 files changed

+174
-26
lines changed

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ The AT command firmware allows for rapid integration by providing:
3030
- The [esp-at forum](https://www.esp32.com/viewforum.php?f=42) is a place to ask questions and find community resources.
3131

3232
# Project Roadmap
33-
1. The next version of ESP-AT firmware (v2.3.0.0) is planned to be released in October 2021. At present, only ESP32-C3 series firmware is planned to be released, and ESP32-C3 firmware would support Bluetooth LE.
33+
1. The next version of ESP-AT firmware (v2.4.0.0) is planned to be released in March 2022. At present, only ESP32-C3 series firmware is planned to be released, and ESP32-C3 firmware would support Bluetooth LE 5.0.
3434

3535
2. ESP-AT Support Policy for ESP Chip Series
3636

@@ -82,7 +82,7 @@ esp-at 是 MIT 许可证下的免费软件。
8282
- [esp-at 社区](https://www.esp32.com/viewforum.php?f=34) 可以用来询问问题或寻找一些社区资源。
8383

8484
# 项目路线图
85-
1. 下一版本 ESP-AT 固件 (v2.3.0.0)，计划在 2021 年 10 月发布。当前仅计划发布 ESP32-C3 系列固件，ESP32-C3 固件将支持低功耗蓝牙。
85+
1. 下一版本 ESP-AT 固件 (v2.4.0.0)，计划在 2022 年 3 月发布。当前仅计划发布 ESP32-C3 系列固件，ESP32-C3 固件将支持低功耗蓝牙 5.0。
8686

8787
2. ESP-AT 对不同芯片系列支持策略
8888

‎docs/en/AT_Binary_Lists/ESP32_AT_binaries.rst‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,8 @@ ESP32-MINI-1 Series
3030
ESP32-WROVER-32 Series
3131
^^^^^^^^^^^^^^^^^^^^^^
3232

33+
It is not recommended to use the ESP32-WROVER-B module due to hardware limit. Please use other WROVER series modules.
34+
3335
- v2.2.0.0 `ESP32-WROVER_AT_Bin_V2.2.0.0.zip <https://download.espressif.com/esp_at/firmware/ESP32/ESP32_WROVER/ESP32-WROVER_AT_Bin_V2.2.0.0.zip>`__ (Recommended)
3436
- v2.1.0.0 `ESP32-WROVER_AT_Bin_V2.1.0.0.zip <https://download.espressif.com/esp_at/firmware/ESP32/ESP32_WROVER/ESP32-WROVER_AT_Bin_V2.1.0.0.zip>`__
3537
- v2.0.0.0 `ESP32-WROVER_AT_Bin_V2.0.0.0.zip <https://download.espressif.com/esp_at/firmware/ESP32/ESP32_WROVER/ESP32-WROVER_AT_Bin_V2.0.zip>`__

‎docs/en/AT_Command_Set/BLE_AT_Commands.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Bluetooth® Low Energy AT Commands
55

66
:link_to_translation:`zh_CN:[中文]`
77

8-
Currently, both ESP32 and ESP32-C3 support Bluetooth LE commands. AT firmware for ESP32 series supports `Bluetooth® Core Specification Version 4.2 <https://www.bluetooth.com/specifications/specs/core-specification-4-2/>`_, and AT firmware for ESP32-C3 supports `Bluetooth® Core Specification Version 5.0 <https://www.bluetooth.com/specifications/specs/core-specification-5/>`_.
8+
Currently, both ESP32 and ESP32-C3 support Bluetooth LE commands. AT firmware for ESP32 series and ESP32-C3 series supports `Bluetooth® Core Specification Version 4.2 <https://www.bluetooth.com/specifications/specs/core-specification-4-2/>`_. Next AT firmware for ESP32-C3 will support `Bluetooth® Core Specification Version 5.0 <https://www.bluetooth.com/specifications/specs/core-specification-5/>`_.
99

1010
- :ref:`AT+BLEINIT <cmd-BINIT>`: Bluetooth LE initialization.
1111
- :ref:`AT+BLEADDR <cmd-BADDR>`: Query/Set Bluetooth LE device address.

‎docs/en/AT_Command_Set/HTTP_AT_Commands.rst‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -270,6 +270,8 @@ Parameters
270270

271271
* - HTTP Client Error Code
272272
- Description
273+
* - 0x7000
274+
- Failed to Establish Connection
273275
* - 0x7190
274276
- Bad Request
275277
* - 0x7191

‎docs/en/AT_Command_Set/TCP-IP_AT_Commands.rst‎

Lines changed: 72 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -267,12 +267,22 @@ Set Command
267267

268268
**Response:**
269269

270+
For single connection, it returns:
271+
270272
::
271273

272274
CONNECT
273275

274276
OK
275277

278+
For multiple connections, it returns:
279+
280+
::
281+
282+
<link ID>,CONNECT
283+
284+
OK
285+
276286
Parameters
277287
"""""""""""
278288

@@ -326,12 +336,22 @@ Set Command
326336

327337
**Response:**
328338

339+
For single connection, it returns:
340+
329341
::
330342

331343
CONNECT
332344

333345
OK
334346

347+
For multiple connections, it returns:
348+
349+
::
350+
351+
<link ID>,CONNECT
352+
353+
OK
354+
335355
Parameters
336356
"""""""""""
337357

@@ -381,12 +401,28 @@ Set Command
381401

382402
::
383403

384-
AT+CIPSTART=[<link ID>,]<"type">,<"remote host">,<remote port>[,<keep alive>,<"local IP">]
404+
// Single connection (AT+CIPMUX=0):
405+
AT+CIPSTART=<"type">,<"remote host">,<remote port>[,<keep alive>,<"local IP">]
406+
407+
// Multiple connections (AT+CIPMUX=1):
408+
AT+CIPSTART=<link ID>,<"type">,<"remote host">,<remote port>[,<keep alive>,<"local IP">]
385409

386410
**Response:**
387411

412+
For single connection, it returns:
413+
414+
::
415+
416+
CONNECT
417+
418+
OK
419+
420+
For multiple connections, it returns:
421+
388422
::
389423

424+
<link ID>,CONNECT
425+
390426
OK
391427

392428
Parameters
@@ -757,6 +793,14 @@ Close TCP/UDP/SSL connection in the multiple connections mode.
757793

758794
AT+CIPCLOSE=<link ID>
759795

796+
**Response:**
797+
798+
::
799+
800+
<link ID>,CLOSED
801+
802+
OK
803+
760804
Execute Command
761805
^^^^^^^^^^^^^^^^^
762806

@@ -772,7 +816,9 @@ Close TCP/UDP/SSL connection in the single connection mode.
772816

773817
::
774818

775-
OK
819+
CLOSED
820+
821+
OK
776822

777823
Parameter
778824
^^^^^^^^^^
@@ -1620,6 +1666,29 @@ Example
16201666
:ref:`AT+CIPDINFO <TCPIP-AT>`: Set "+IPD" Message Mode
16211667
------------------------------------------------------
16221668

1669+
Query Command
1670+
^^^^^^^^^^^^^
1671+
1672+
**Command:**
1673+
1674+
::
1675+
1676+
AT+CIPDINFO?
1677+
1678+
**Response:**
1679+
1680+
::
1681+
1682+
+CIPDINFO:true
1683+
OK
1684+
1685+
or
1686+
1687+
::
1688+
1689+
+CIPDINFO:false
1690+
OK
1691+
16231692
Set Command
16241693
^^^^^^^^^^^
16251694

@@ -2061,7 +2130,7 @@ Notes
20612130

20622131
- ``<len>`` is the total length of socket data in the buffer.
20632132
- You should read data by running :ref:`AT+CIPRECVDATA <cmd-CIPRECVDATA>` once there is a ``+IPD`` reported. Otherwise, the next ``+IPD`` will not be reported to the host MCU until the previous ``+IPD`` has been read.
2064-
- In case of disconnection, the buffered socket data will still be there and can be read by the MCU until you send :ref:`AT+CIPCLOSE <cmd-CLOSE>`. In other words, if ``+IPD`` has been reported, the message ``CLOSED`` of this connection will never come until you send :ref:`AT+CIPCLOSE <cmd-CLOSE>` or read all data by command :ref:`AT+CIPRECVDATA <cmd-CIPRECVDATA>`.
2133+
- In case of disconnection, the buffered socket data will still be there and can be read by the MCU until you send :ref:`AT+CIPCLOSE <cmd-CLOSE>` (AT as client) or :ref:`AT+CIPSERVER=0,1 <cmd-SERVER>` (AT as server). In other words, if ``+IPD`` has been reported, the message ``CLOSED`` of this connection will never come until you send :ref:`AT+CIPCLOSE <cmd-CLOSE>` or :ref:`AT+CIPSERVER=0,1 <cmd-SERVER>` or read all data by command :ref:`AT+CIPRECVDATA <cmd-CIPRECVDATA>`.
20652134

20662135
Example
20672136
^^^^^^^^

‎docs/en/AT_Command_Set/Wi-Fi_AT_Commands.rst‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -747,7 +747,8 @@ Query Command
747747

748748
::
749749

750-
<state>
750+
+CWDHCP:<state>
751+
OK
751752

752753
Set Command
753754
^^^^^^^^^^^

‎docs/en/Compile_and_Develop/esp-at_firmware_differences.rst‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -133,13 +133,13 @@ The table lists which command set is supported by default in the official AT fir
133133
- |icon-green-check|
134134
- |icon-green-check|
135135
* - blufi
136-
- |icon-orange-check|
137-
- |icon-orange-check|
138-
- |icon-orange-check|
139-
- |icon-orange-check|
140-
- |icon-orange-check|
141-
- |icon-orange-check|
142-
- |icon-orange-check|
136+
- |icon-green-check|
137+
- |icon-green-check|
138+
- |icon-green-check|
139+
- |icon-green-check|
140+
- |icon-green-check|
141+
- |icon-green-check|
142+
- |icon-green-check|
143143
* - bt spp
144144
- |icon-orange-check|
145145
- |icon-green-check|

‎docs/zh_CN/AT_Binary_Lists/ESP32_AT_binaries.rst‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,8 @@ ESP32-MINI-1 系列
3030
ESP32-WROVER-32 系列
3131
^^^^^^^^^^^^^^^^^^^^^^
3232

33+
由于硬件限制，不推荐使用 ESP32-WROVER-B 模组，请使用其他 WROVER 系列模组。
34+
3335
- v2.2.0.0 `ESP32-WROVER_AT_Bin_V2.2.0.0.zip <https://download.espressif.com/esp_at/firmware/ESP32/ESP32_WROVER/ESP32-WROVER_AT_Bin_V2.2.0.0.zip>`__ （推荐）
3436
- v2.1.0.0 `ESP32-WROVER_AT_Bin_V2.1.0.0.zip <https://download.espressif.com/esp_at/firmware/ESP32/ESP32_WROVER/ESP32-WROVER_AT_Bin_V2.1.0.0.zip>`__
3537
- v2.0.0.0 `ESP32-WROVER_AT_Bin_V2.0.0.0.zip <https://download.espressif.com/esp_at/firmware/ESP32/ESP32_WROVER/ESP32-WROVER_AT_Bin_V2.0.zip>`__

‎docs/zh_CN/AT_Command_Set/BLE_AT_Commands.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Bluetooth® Low Energy AT 命令集
55

66
:link_to_translation:`en:[English]`
77

8-
当前，ESP32 和 ESP32-C3 都支持 Bluetooth LE 命令。ESP32 系列 AT 固件支持 `蓝牙核心规范 4.2 版本 <https://www.bluetooth.com/specifications/specs/core-specification-4-2/>`_，ESP32-C3 系列 AT 固件支持 `蓝牙核心规范 5.0 版本 <https://www.bluetooth.com/specifications/specs/core-specification-5/>`_。
8+
当前，ESP32 和 ESP32-C3 都支持 Bluetooth LE 命令。ESP32 系列和 ESP32-C3 系列 AT 固件支持 `蓝牙核心规范 4.2 版本 <https://www.bluetooth.com/specifications/specs/core-specification-4-2/>`_。下一版本 ESP32-C3 AT 固件将支持 `蓝牙核心规范 5.0 版本 <https://www.bluetooth.com/specifications/specs/core-specification-5/>`_。
99

1010
- :ref:`AT+BLEINIT <cmd-BINIT>`：Bluetooth LE 初始化
1111
- :ref:`AT+BLEADDR <cmd-BADDR>`：设置 Bluetooth LE 设备地址

‎docs/zh_CN/AT_Command_Set/HTTP_AT_Commands.rst‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -270,6 +270,8 @@ HTTP AT 命令集
270270

271271
* - HTTP 客户端错误码
272272
- 说明
273+
* - 0x7000
274+
- 建立连接失败
273275
* - 0x7190
274276
- Bad Request
275277
* - 0x7191

0 commit comments

Comments
 (0)