You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Added show_all_ip parameter in AT+CIPDOMAIN command
- Changed Wi-Fi passthrough to Network passthrough
- Updated the passthrough mode introduction
- Moved "ESP-AT Firmware Differences" from Compile_and_Develop/esp-at_firmware_differences.rst to AT_Binary_Lists/esp_at_binaries.rst
- Added ESP32-C2-2MB-G2/ESP32-C2-4MB-G2 to AT firmware difference section
- Updated some notes of AT+SYSROLLBACK, AT+SYSRAM command
- Updated some notes of github ci firmware
- Updated some notes of AT released firmware
- Added the mqtt version note
@@ -1340,7 +1340,7 @@ UART Wi-Fi passthrough transmission when the {IDF_TARGET_NAME} works as a TCP cl
1340
1340
1341
1341
OK
1342
1342
1343
-
#. Enable the UART Wi-Fi:term:`Passthrough Receiving Mode`.
1343
+
#. Enable the Network:term:`Passthrough Receiving Mode`.
1344
1344
1345
1345
Command:
1346
1346
@@ -1354,7 +1354,7 @@ UART Wi-Fi passthrough transmission when the {IDF_TARGET_NAME} works as a TCP cl
1354
1354
1355
1355
OK
1356
1356
1357
-
#. Enter the UART Wi-Fi:term:`Passthrough Mode` and send data.
1357
+
#. Enter the Network:term:`Passthrough Mode` and send data.
1358
1358
1359
1359
Command:
1360
1360
@@ -1372,13 +1372,13 @@ UART Wi-Fi passthrough transmission when the {IDF_TARGET_NAME} works as a TCP cl
1372
1372
1373
1373
#. Stop sending data.
1374
1374
1375
-
When receiving a packet that contains only ``+++``, the UART Wi-Fi passthrough transmission process will be stopped. Then please wait at least 1 second before sending the next AT command. Please note that if you input ``+++`` directly by typing, the ``+++`` may not be recognized as three consecutive ``+`` because of the prolonged typing duration. For more details, please refer to :ref:`[Passthrough Mode Only] +++ <cmd-PLUS>`.
1375
+
When receiving a packet that contains only ``+++``, the Network passthrough transmission process will be stopped. Then please wait at least 1 second before sending the next AT command. Please note that if you input ``+++`` directly by typing, the ``+++`` may not be recognized as three consecutive ``+`` because of the prolonged typing duration. For more details, please refer to :ref:`[Passthrough Mode Only] +++ <cmd-PLUS>`.
1376
1376
1377
1377
.. Important::
1378
1378
1379
1379
The aim of ending the packet with ``+++`` is to exit :term:`Passthrough Mode` and to accept normal AT commands, while TCP still remains connected. However, you can also use command ``AT+CIPSEND`` to go back into :term:`Passthrough Mode`.
1380
1380
1381
-
#. Exit the UART Wi-Fi:term:`Passthrough Receiving Mode`.
1381
+
#. Exit the Network:term:`Passthrough Receiving Mode`.
1382
1382
1383
1383
Command:
1384
1384
@@ -1408,7 +1408,7 @@ UART Wi-Fi passthrough transmission when the {IDF_TARGET_NAME} works as a TCP cl
1408
1408
1409
1409
OK
1410
1410
1411
-
UART Wi-Fi passthrough transmission when the {IDF_TARGET_NAME} works as a TCP server
1411
+
Network passthrough transmission when the {IDF_TARGET_NAME} works as a TCP server
@@ -1534,7 +1534,7 @@ UART Wi-Fi passthrough transmission when the {IDF_TARGET_NAME} works as a TCP se
1534
1534
1535
1535
0,CONNECT
1536
1536
1537
-
#. Enable the UART Wi-Fi:term:`Passthrough Receiving Mode`.
1537
+
#. Enable the Network:term:`Passthrough Receiving Mode`.
1538
1538
1539
1539
Command:
1540
1540
@@ -1548,7 +1548,7 @@ UART Wi-Fi passthrough transmission when the {IDF_TARGET_NAME} works as a TCP se
1548
1548
1549
1549
OK
1550
1550
1551
-
#. Enter the UART Wi-Fi:term:`Passthrough Mode` and send data.
1551
+
#. Enter the Network:term:`Passthrough Mode` and send data.
1552
1552
1553
1553
Command:
1554
1554
@@ -1566,13 +1566,13 @@ UART Wi-Fi passthrough transmission when the {IDF_TARGET_NAME} works as a TCP se
1566
1566
1567
1567
#. Stop sending data.
1568
1568
1569
-
When receiving a packet that contains only ``+++``, the UART Wi-Fi passthrough transmission process will be stopped. Then please wait at least 1 second before sending the next AT command. Please note that if you input ``+++`` directly by typing, the ``+++`` may not be recognized as three consecutive ``+`` because of the prolonged typing duration. For more details, please refer to :ref:`[Passthrough Mode Only] +++ <cmd-PLUS>`.
1569
+
When receiving a packet that contains only ``+++``, the Network passthrough transmission process will be stopped. Then please wait at least 1 second before sending the next AT command. Please note that if you input ``+++`` directly by typing, the ``+++`` may not be recognized as three consecutive ``+`` because of the prolonged typing duration. For more details, please refer to :ref:`[Passthrough Mode Only] +++ <cmd-PLUS>`.
1570
1570
1571
1571
.. Important::
1572
1572
1573
1573
The aim of ending the packet with ``+++`` is to exit :term:`Passthrough Mode` and to accept normal AT commands, while TCP still remains connected. However, you can also use command ``AT+CIPSEND`` to go back into :term:`Passthrough Mode`.
1574
1574
1575
-
#. Exit the UART Wi-Fi:term:`Passthrough Receiving Mode`.
1575
+
#. Exit the Network:term:`Passthrough Receiving Mode`.
1576
1576
1577
1577
Command:
1578
1578
@@ -1602,7 +1602,7 @@ UART Wi-Fi passthrough transmission when the {IDF_TARGET_NAME} works as a TCP se
1602
1602
1603
1603
OK
1604
1604
1605
-
UART Wi-Fi passthrough transmission when the {IDF_TARGET_NAME} works as a softAP in UDP transparent transmission
1605
+
Network passthrough transmission when the {IDF_TARGET_NAME} works as a softAP in UDP transparent transmission
@@ -1660,7 +1660,7 @@ UART Wi-Fi passthrough transmission when the {IDF_TARGET_NAME} works as a softAP
1660
1660
1661
1661
OK
1662
1662
1663
-
#. Enter the UART Wi-Fi:term:`Passthrough Receiving Mode`.
1663
+
#. Enter the Network:term:`Passthrough Receiving Mode`.
1664
1664
1665
1665
Command:
1666
1666
@@ -1674,7 +1674,7 @@ UART Wi-Fi passthrough transmission when the {IDF_TARGET_NAME} works as a softAP
1674
1674
1675
1675
OK
1676
1676
1677
-
#. Enter the UART Wi-Fi:term:`Passthrough Mode` and send data.
1677
+
#. Enter the Network:term:`Passthrough Mode` and send data.
1678
1678
1679
1679
Command:
1680
1680
@@ -1692,13 +1692,13 @@ UART Wi-Fi passthrough transmission when the {IDF_TARGET_NAME} works as a softAP
1692
1692
1693
1693
#. Stop sending data.
1694
1694
1695
-
When receiving a packet that contains only ``+++``, the UART Wi-Fi passthrough transmission process will be stopped. Then please wait at least 1 second before sending the next AT command. Please note that if you input ``+++`` directly by typing, the ``+++`` may not be recognized as three consecutive ``+`` because of the prolonged typing duration. For more details, please refer to :ref:`[Passthrough Mode Only] +++ <cmd-PLUS>`.
1695
+
When receiving a packet that contains only ``+++``, the Network passthrough transmission process will be stopped. Then please wait at least 1 second before sending the next AT command. Please note that if you input ``+++`` directly by typing, the ``+++`` may not be recognized as three consecutive ``+`` because of the prolonged typing duration. For more details, please refer to :ref:`[Passthrough Mode Only] +++ <cmd-PLUS>`.
1696
1696
1697
1697
.. Important::
1698
1698
1699
1699
The aim of ending the packet with ``+++`` is to exit :term:`Passthrough Mode` and to accept normal AT commands, while TCP still remains connected. However, you can also use command ``AT+CIPSEND`` to go back into :term:`Passthrough Mode`.
1700
1700
1701
-
#. Exit the UART Wi-Fi:term:`Passthrough Receiving Mode`.
1701
+
#. Exit the Network:term:`Passthrough Receiving Mode`.
Copy file name to clipboardExpand all lines: docs/en/AT_Command_Set/Basic_AT_Commands.rst
+28-12Lines changed: 28 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -427,6 +427,9 @@ Example
427
427
// Set to enter TCP server passthrough mode on power-up, listening on port 1002
428
428
AT+SAVETRANSLINK=3,1002,"TCP",2
429
429
430
+
// Restart the module
431
+
AT+RST
432
+
430
433
// PC connects to esp-ap-001 and uses a TCP client tool to connect to {IDF_TARGET_NAME}'s port 1002
431
434
nc 192.168.4.1 1002
432
435
@@ -876,8 +879,16 @@ Query Command
876
879
Parameters
877
880
^^^^^^^^^^
878
881
879
-
- **<remaining RAM size>**: current remaining heap size. Unit: byte.
880
-
- **<minimum heap size>**: minimum available heap size in the runtime. Unit: byte. When the parameter's value is less than or close to 10 KB, the Wi-Fi and BLE functions of {IDF_TARGET_NAME} may be affected.
882
+
- **<remaining RAM size>**: Current available heap size. Unit: byte. When there is a memory leak, this value will gradually decrease.
883
+
- **<minimum heap size>**: Minimum available heap size recorded since the {IDF_TARGET_NAME} was powered on. Unit: byte. When this value is less than or close to 10 KB, the Wi-Fi and BLE functions of {IDF_TARGET_NAME} may be affected. This value only updates when a new, lower minimum is detected; it never increases.
884
+
885
+
Note
886
+
^^^^
887
+
888
+
- When ``<minimum heap size>`` is less than or close to 10 KB, or you see logs like ``alloc failed, size:<requested_size>, caps:<requested_caps>`` on the :term:`AT log port`, consider optimizing memory:
889
+
890
+
- Disable unnecessary AT features under ``python build.py menuconfig`` > ``Component config`` > ``AT``.
891
+
- Refer to the `Minimizing RAM Usage <https://docs.espressif.com/projects/esp-idf/en/latest/{IDF_TARGET_PATH_NAME}/api-guides/performance/ram-usage.html>`_ documentation for relevant methods.
881
892
882
893
Example
883
894
^^^^^^^^
@@ -971,17 +982,17 @@ Parameter
971
982
972
983
- **<state>**:
973
984
974
-
- Bit0: Prompt information when quitting Wi-Fi:term:`Passthrough Mode`, Bluetooth LE SPP and Bluetooth SPP.
985
+
- Bit0: Prompt information when quitting Network:term:`Passthrough Mode`, Bluetooth LE SPP and Bluetooth SPP.
975
986
976
-
- 0: Print no prompt information when quitting Wi-Fi:term:`Passthrough Mode`, Bluetooth LE SPP and Bluetooth SPP.
977
-
- 1: Print ``+QUITT`` when quitting Wi-Fi:term:`Passthrough Mode`, Bluetooth LE SPP and Bluetooth SPP.
987
+
- 0: Print no prompt information when quitting Network:term:`Passthrough Mode`, Bluetooth LE SPP and Bluetooth SPP.
988
+
- 1: Print ``+QUITT`` when quitting Network:term:`Passthrough Mode`, Bluetooth LE SPP and Bluetooth SPP.
978
989
979
990
- Bit1: Connection prompt information type.
980
991
981
992
- 0: Use simple prompt information, such as ``XX,CONNECT``.
982
993
- 1: Use detailed prompt information, such as ``+LINK_CONN:status_type,link_id,ip_type,terminal_type,remote_ip,remote_port,local_port``.
983
994
984
-
- Bit2: Connection status prompt information for Wi-Fi:term:`Passthrough Mode`, Bluetooth LE SPP and Bluetooth SPP.
995
+
- Bit2: Connection status prompt information for Network:term:`Passthrough Mode`, Bluetooth LE SPP and Bluetooth SPP.
985
996
986
997
- 0: Print no prompt information.
987
998
- 1: Print one of the following prompt information when Wi-Fi, socket, Bluetooth LE or Bluetooth status is changed:
@@ -1010,15 +1021,15 @@ Notes
1010
1021
^^^^^
1011
1022
1012
1023
- The configuration changes will be saved in the NVS partition if ``AT+SYSSTORE=1``.
1013
-
- If you set Bit0 to 1, it will prompt "+QUITT" when you quit Wi-Fi :term:`Passthrough Mode`.
1024
+
- If you set Bit0 to 1, it will prompt "+QUITT" when you quit :term:`Passthrough Mode`.
1014
1025
- If you set Bit1 to 1, it will impact the information of command :ref:`AT+CIPSTART <cmd-START>` and :ref:`AT+CIPSERVER <cmd-SERVER>`. It will supply "+LINK_CONN:status_type,link_id,ip_type,terminal_type,remote_ip,remote_port,local_port" instead of "XX,CONNECT".
1015
1026
1016
1027
Example
1017
1028
^^^^^^^^
1018
1029
1019
1030
::
1020
1031
1021
-
// print no prompt info when quitting Wi-Fi passthrough mode
1032
+
// print no prompt info when quitting passthrough mode
1022
1033
// print detailed connection prompt info
1023
1034
// print no prompt info when the connection status is changed
1024
1035
AT+SYSMSG=2
@@ -1850,6 +1861,10 @@ Query the address and version of the current running firmware and the rollback f
1850
1861
Execute Command
1851
1862
^^^^^^^^^^^^^^^
1852
1863
1864
+
**Function:**
1865
+
1866
+
Roll back to the previous firmware.
1867
+
1853
1868
**Command:**
1854
1869
1855
1870
::
@@ -1873,11 +1888,12 @@ Parameters
1873
1888
Note
1874
1889
^^^^^
1875
1890
1876
-
.. only:: esp32c2
1877
-
1878
-
- **{IDF_TARGET_CFG_PREFIX}-4MB AT firmware supports this command, but {IDF_TARGET_CFG_PREFIX}-2MB AT firmware does not due to the compressed OTA firmware**.
1891
+
.. list::
1879
1892
1880
-
- This command will not upgrade via OTA. It only rolls back to the firmware which is in the other OTA partition.
1893
+
- When performing a firmware rollback, {IDF_TARGET_NAME} first verifies the integrity of the target firmware. The rollback proceeds only if verification succeeds; otherwise, an error is returned.
1894
+
:esp32c2: - For {IDF_TARGET_NAME}-2MB AT firmware, the compressed OTA partition stores a firmware image that, after decompression, is identical to the currently running firmware. Therefore, a true firmware switch cannot be performed.
1895
+
:esp32c5 or esp32c61: - For {IDF_TARGET_NAME}-4MB AT firmware, the compressed OTA partition stores a firmware image that, after decompression, is identical to the currently running firmware. Therefore, a true firmware switch cannot be performed.
1896
+
:esp32c2 or esp32c3 or esp32c6 or esp32 or esp32s2: - The rollback function operates independently of the OTA upgrade process and can directly switch execution to the firmware version stored in the other OTA partition.
Copy file name to clipboardExpand all lines: docs/en/AT_Command_Set/MQTT_AT_Commands.rst
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,6 +28,7 @@ Introduction
28
28
------------
29
29
30
30
.. important::
31
+
- Currently, AT firmware for {IDF_TARGET_NAME} series supports `MQTT Version 3.1.1 <https://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html>`_.
31
32
- The default AT firmware supports all the AT commands mentioned on this page. If you don't need {IDF_TARGET_NAME} to support MQTT commands, you can compile the ESP-AT project by following the steps in :doc:`Compile ESP-AT Project Locally <../Compile_and_Develop/How_to_clone_project_and_compile_it>` documentation. In the project configuration during the fifth step, make the following selections:
0 commit comments