Merge branch 'docs/update_at_docs' into 'master'

docs: Updated a series of AT docs See merge request application/esp-at!1575
espressif · Jun 26, 2024 · 8b01b67 · 8b01b67
2 parents 98fcb46 + 6434f6d
commit 8b01b67
Show file tree

Hide file tree

Showing 31 changed files with 104 additions and 62 deletions.
diff --git a/README.md b/README.md
@@ -30,7 +30,7 @@ The following table shows ESP-AT support status of Espressif SoCs.
 |ESP32-S2 | | |  [![alt text][released]](https://github.com/espressif/esp-at/releases/tag/v3.4.0.0) | | [![alt text][supported]](https://github.com/espressif/esp-at/tree/master) |
 
 - ![alt text][released]: Released versions, you can click ![alt text][released] to go to the corresponding release page and download the AT firmware.
-- ![alt text][supported]: Rupported versions, you can click ![alt text][supported] to go to the corresponding branch and develop your own AT firmware.
+- ![alt text][supported]: Supported versions, you can click ![alt text][supported] to go to the corresponding branch and develop your own AT firmware.
 - ![alt text][pre-release]: Pre-release versions, expected to release AT firmware for the corresponding chip soon.
 
 Please choose one of the following options based on your needs:

diff --git a/docs/en/AT_Binary_Lists/esp_at_binaries.rst b/docs/en/AT_Binary_Lists/esp_at_binaries.rst
@@ -7,9 +7,16 @@ It is recommended to use the lastest version of firmware. Currently, Espressif r
 
 .. note::
 
+  .. only:: esp32c2
+
+    - The released AT firmware only supports chip versions with a crystal oscillator frequency of 26 MHz. If your module uses a crystal oscillator frequency of 40 MHz, 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:
+
+      - ``Component config`` -> ``Hardware Settings`` -> ``Main XTAL Config`` -> ``Main XTAL frequency`` -> ``40 MHz``
+
   .. only:: esp32c3
 
-    - The current {IDF_TARGET_NAME} AT firmware supports ECO0 (Rev v0.0) to ECO4 (Rev v0.4) chip versions (including ECO0 and ECO4), but does not support {IDF_TARGET_NAME} ECO6 (Rev v1.0), ECO7 (Rev v1.1), and subsequent versions.
+    - The AT firmware versions v2.2.0.0 to v3.2.0.0 support the {IDF_TARGET_NAME} ECO0 (Rev v0.0) to ECO4 (Rev v0.4) series chips (including ECO0 and ECO4).
+    - The AT firmware version v3.3.0.0 supports the {IDF_TARGET_NAME} ECO0 (Rev v0.0) to ECO4 (Rev v0.4), ECO6 (Rev v1.0), and ECO7 (Rev v1.1) series chips.
 
   - If there is no released firmware for your module, you can either use the firmware for the module that has the same hardware configuration as yours (see :doc:`../Compile_and_Develop/esp-at_firmware_differences` for which module has the same configuration), or if you need to modify the following configurations, you can generate a new firmware for your module by modifying the released firmware using the :doc:`../Compile_and_Develop/tools_at_py`.
 

diff --git a/docs/en/AT_Command_Examples/Web_server_AT_Examples.rst b/docs/en/AT_Command_Examples/Web_server_AT_Examples.rst
@@ -262,6 +262,9 @@ Introduction
 
 The WeChat applet can automatically connect to the WiFi AP of the {IDF_TARGET_NAME}, and then send the ssid and password required by the {IDF_TARGET_NAME} to connect to the network.
 
+.. important::
+  The ESP-AT WeChat applet will be discontinued on December 31, 2024. During this period, please make arrangements for the transition of its functionalities. If you still have related needs after this date, please contact `Espressif's business <https://www.espressif.com/en/contact-us/sales-questions>`_ team. We will be dedicated to providing you with support and solutions. Thank you for your understanding and support.
+
 Introduction to Operation Steps
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 

diff --git a/docs/en/AT_Command_Examples/mqtt-at-examples-for-cloud.rst b/docs/en/AT_Command_Examples/mqtt-at-examples-for-cloud.rst
@@ -33,7 +33,7 @@ Obtain certificates and endpoints from AWS IoT
   The endpoint value has the format of `xxx-ats.iot.us-east-2.amazonaws.com`.
 
 .. note::
-  It is strongly recommended to familiarize yourself with the `AWS IoT Developer Guide <https://docs.aws.amazon.com/iot/latest/developerguide/configure-iot.html>`_. Below are some key points from this Guide that are worth noting.
+  It is strongly recommended to familiarize yourself with the `AWS IoT Developer Guide <https://docs.aws.amazon.com/iot/latest/developerguide/what-is-aws-iot.html>`_. Below are some key points from this Guide that are worth noting.
 
   - All devices must have a device certificate, private key, and root CA certificate installed in order to communicate with AWS IoT.
   - Information on how to activate certificates.

diff --git a/docs/en/AT_Command_Set/BLE_AT_Commands.rst b/docs/en/AT_Command_Set/BLE_AT_Commands.rst
@@ -74,7 +74,7 @@ Introduction
 
  .. only:: esp32c2 or esp32c3 or esp32c6
 
-  Currently, AT firmware for {IDF_TARGET_NAME} supports `Bluetooth® Core Specification Version 5.0 <https://www.bluetooth.com/specifications/specs/core-specification-5/>`_.
+  Currently, AT firmware for {IDF_TARGET_NAME} supports `Bluetooth® Core Specification Version 5.0 <https://www.bluetooth.com/specifications/specs/core-specification-5-0/>`_.
 
 .. only:: esp32 or esp32c3 or esp32c6
 
@@ -162,7 +162,7 @@ Introduction
     Notes
     ^^^^^
 
-    -  When using Bluetooth LE function, if you do not need to use SoftAP mode, it is recommended to set Wi-Fi mode to NULL or station mode by using :ref:`AT+CWMODE <cmd-MODE>`.
+    -  To achieve better performance, it is recommended to disable SoftAP by sending the :ref:`AT+CWMODE=0/1 <cmd-MODE>` command before using Bluetooth LE function. For more details, please refer to the `RF Coexistence <https://docs.espressif.com/projects/esp-idf/en/latest/{IDF_TARGET_PATH_NAME}/api-guides/coexist.html>`_ documentation.
     -  Before using other Bluetooth LE AT commands, you should run this command first to trigger the initialization process.
     -  After the initialization, the Bluetooth LE role cannot be changed unless you run :ref:`AT+RST <cmd-RST>` to restart the system first and then re-initialize the Bluetooth LE role.
     -  Before you deinitialize the Bluetooth stack, it is recommended to stop broadcasting, stop scanning, and disconnect all existing connections.
@@ -2977,12 +2977,12 @@ Parameter
    -  6: WPA3_PSK
    -  7: WPA2_WPA3_PSK
 
-.. only:: esp32 or esp3c3
+Note
+^^^^
 
-    Note
-    ^^^^
-
-    - You can only start or stop BluFi when Bluetooth LE is not initialized (:ref:`AT+BLEINIT=0 <cmd-BINIT>`).
+- You can only start or stop BluFi when Bluetooth LE is not initialized (:ref:`AT+BLEINIT=0 <cmd-BINIT>`).
+- To achieve better performance, it is recommended to disable SoftAP by sending the :ref:`AT+CWMODE=0/1 <cmd-MODE>` command before using BluFi function. For more details, please refer to the `RF Coexistence <https://docs.espressif.com/projects/esp-idf/en/latest/{IDF_TARGET_PATH_NAME}/api-guides/coexist.html>`_ documentation.
+- After BluFi network configuration is completed, please send the :ref:`AT+BLUFI=0 <cmd-BLUFI>` command to disable BluFi and release resources.
 
 Example
 ^^^^^^^^

diff --git a/docs/en/AT_Command_Set/BT_AT_Commands.rst b/docs/en/AT_Command_Set/BT_AT_Commands.rst
@@ -34,7 +34,7 @@
 Introduction
 ------------
 
-{IDF_TARGET_NAME} AT firmware supports `Bluetooth® Core Specification Version 4.2 <https://www.bluetooth.com/specifications/archived-specifications/>`_.
+{IDF_TARGET_NAME} AT firmware supports `Bluetooth® Core Specification Version 4.2 <https://www.bluetooth.com/specifications/specs/>`_.
 
 .. important::
   The default AT firmware does not support the AT commands listed on this page. If you need {IDF_TARGET_NAME} to support Classic Bluetooth 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 (Each item below is independent. Choose it according to your needs):
@@ -108,6 +108,7 @@ Parameter
 Notes
 ^^^^^
 
+- To achieve better performance, it is recommended to disable SoftAP by sending the :ref:`AT+CWMODE=0/1 <cmd-MODE>` command before using Classic Bluetooth function. For more details, please refer to the `RF Coexistence <https://docs.espressif.com/projects/esp-idf/en/latest/{IDF_TARGET_PATH_NAME}/api-guides/coexist.html>`_ documentation.
 - If Classic Bluetooth is initialized, :ref:`AT+CIPMODE <cmd-IPMODE>` cannot be set to 1.
 
 Example
@@ -272,7 +273,7 @@ Parameters
    -  0x9: health.
    -  0x1F: uncategorized device.
 
--  **<minor_dev_class>**: please refer to `Minor Device Class field <https://www.bluetooth.com/specifications/assigned-numbers/baseband>`_.
+-  **<minor_dev_class>**: please refer to `Minor Device Class field <https://www.bluetooth.com/specifications/assigned-numbers/>`_.
 
 -  **<major_srv_class>**:
 
@@ -1197,9 +1198,9 @@ Set the Classic Bluetooth class of devices.
 Parameters
 ^^^^^^^^^^
 
--  **<major>**: `major class <https://btprodspecificationrefs.blob.core.windows.net/assigned-numbers/Assigned%20Number%20Types/Baseband.pdf>`_.
--  **<minor>**: `minor class <https://btprodspecificationrefs.blob.core.windows.net/assigned-numbers/Assigned%20Number%20Types/Baseband.pdf>`_.
--  **<service>**: `service class <https://btprodspecificationrefs.blob.core.windows.net/assigned-numbers/Assigned%20Number%20Types/Baseband.pdf>`_.
+-  **<major>**: `major class <https://btprodspecificationrefs.blob.core.windows.net/assigned-numbers/Assigned%20Number%20Types/Assigned_Numbers.pdf>`_.
+-  **<minor>**: `minor class <https://btprodspecificationrefs.blob.core.windows.net/assigned-numbers/Assigned%20Number%20Types/Assigned_Numbers.pdf>`_.
+-  **<service>**: `service class <https://btprodspecificationrefs.blob.core.windows.net/assigned-numbers/Assigned%20Number%20Types/Assigned_Numbers.pdf>`_.
 
 Example
 ^^^^^^^^

diff --git a/docs/en/AT_Command_Set/Driver_AT_Commands.rst b/docs/en/AT_Command_Set/Driver_AT_Commands.rst
@@ -125,7 +125,7 @@ Notes
 
 -  ESP-AT only supports ADC1.
 -  {IDF_TARGET_NAME} support 12-bit width.
--  For details on how to convert the channel value into voltage, please refer to `ADC Conversion <https://docs.espressif.com/projects/esp-idf/en/latest/{IDF_TARGET_PATH_NAME}/api-reference/peripherals/adc.html#adc-conversion>`__.
+-  For details on how to convert the channel value into voltage, please refer to `ADC Conversion <https://docs.espressif.com/projects/esp-idf/en/latest/{IDF_TARGET_PATH_NAME}/api-reference/peripherals/adc_continuous.html#adc-continuous-read-conversion-result>`__.
 
 Example
 ^^^^^^^^

diff --git a/docs/en/AT_Command_Set/HTTP_AT_Commands.rst b/docs/en/AT_Command_Set/HTTP_AT_Commands.rst
@@ -486,5 +486,5 @@ Example
 
 -  HTTP AT:
 
-   - The error code of command ``AT+HTTPCLIENT`` will be ``0x7000+Standard HTTP Error Code`` (For more details about Standard HTTP/1.1 Error Code, see `RFC 2616 <https://tools.ietf.org/html/rfc2616>`_).
+   - The error code of command ``AT+HTTPCLIENT`` will be ``0x7000+Standard HTTP Error Code`` (For more details about Standard HTTP/1.1 Error Code, see `RFC 2616 <https://datatracker.ietf.org/doc/html/rfc2616>`_).
    - For example, if AT gets the HTTP error 404 when calling command ``AT+HTTPCLIENT``, it will respond with error code of ``0x7194`` (``hex(0x7000+404)=0x7194``).
diff --git a/docs/en/AT_Command_Set/Wi-Fi_AT_Commands.rst b/docs/en/AT_Command_Set/Wi-Fi_AT_Commands.rst
@@ -177,7 +177,22 @@ Parameters
 Note
 ^^^^^
 
--  The configuration changes will be saved in the NVS area if :ref:`AT+SYSSTORE=1 <cmd-SYSSTORE>`.
+- The configuration changes will be saved in the NVS area if :ref:`AT+SYSSTORE=1 <cmd-SYSSTORE>`.
+
+.. only:: esp32 or esp32c2 or esp32c3 or esp32c6
+
+  - If you have previously used the Bluetooth function, it is recommended to send the following commands to deinitialize the initialized functions before using the SoftAP or SoftAP+Station functions:
+
+    .. only:: esp32
+
+        - :ref:`AT+BTINIT=0 <cmd-BTINIT>` (Deinitialize Classic Bluetooth)
+
+    .. only:: esp32 or esp32c2 or esp32c3 or esp32c6
+
+        - :ref:`AT+BLEINIT=0 <cmd-BINIT>` (Deinitialize Bluetooth LE)
+        - :ref:`AT+BLUFI=0 <cmd-BLUFI>` (Disable BluFi)
+
+    For more details, please refer to the `RF Coexistence <https://docs.espressif.com/projects/esp-idf/en/latest/{IDF_TARGET_PATH_NAME}/api-guides/coexist.html>`_ documentation.
 
 Example
 ^^^^^^^^
@@ -322,7 +337,7 @@ Parameters
 
 -  **<ssid>**: the SSID of the target AP.
 
-   -  Escape character syntax is needed if SSID or password contains special characters, such ``,``, ``"``, or ``\\``.
+   -  Escape character syntax is needed if SSID or password contains special characters, such as ``,``, ``"``, or ``\``.
    -  Chinese SSID is supported. Chinese SSID of some routers or hotspots is not encoded in UTF-8 encoding format. You can scan SSID first, and then connect using the scanned SSID.
 
 -  **<pwd>**: password, MAX: 63-byte ASCII.

diff --git a/docs/en/AT_Command_Set/index.rst b/docs/en/AT_Command_Set/index.rst
@@ -78,7 +78,7 @@ Generic AT command has four types:
 
       AT+CWSAP="ESP756290","21030826",1,4
 
--  Escape character syntax is needed if a string contains special characters, such as ``,``, ``"``, or ``\``:
+-  Escape character syntax is needed if a string contains special characters. The characters that need to be escaped are ``,``, ``"``, and ``\``:
 
    -  ``\\``: escape the backslash itself
    -  ``\,``: escape comma which is not used to separate each parameter

diff --git a/docs/en/Compile_and_Develop/How_to_build_project_with_web_page.rst b/docs/en/Compile_and_Develop/How_to_build_project_with_web_page.rst
@@ -89,7 +89,7 @@ GitHub Actions is now enabled.
 Step 4. Configure the secrets required to compile the ESP-AT project
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-If you have an account and an OTA token of `the Espressif OTA server <http://iot.espressif.cn/#/>`_, and you need to upgrade the AT firmware by using the :ref:`AT+CIUPDATE <cmd-UPDATE>` command, you need to complete this step. Otherwise, it is recommended to disable CONFIG_AT_OTA_SUPPORT (see :ref:`at-wc-commit-changes` for details) or skip this step.
+If you have an account and an OTA token of `the Espressif OTA server <http://iot.espressif.cn>`_, and you need to upgrade the AT firmware by using the :ref:`AT+CIUPDATE <cmd-UPDATE>` command, you need to complete this step. Otherwise, it is recommended to disable CONFIG_AT_OTA_SUPPORT (see :ref:`at-wc-commit-changes` for details) or skip this step.
 
 Under the repository, click ``Setting`` to enter the settings page.
 

diff --git a/docs/en/Compile_and_Develop/How_to_optimize_throughput.rst b/docs/en/Compile_and_Develop/How_to_optimize_throughput.rst
@@ -163,6 +163,7 @@ Users could choose one of the following methods to improve throughput performanc
     AT+CWJAP="ssid","password"
     AT+UART_CUR=3000000,8,1,0,3
     AT+CIPSTART="TCP","192.168.105.13",3344
+    AT+CIPMODE=1
     AT+CIPSEND
     // data transmission
 
@@ -267,6 +268,7 @@ The data stream of throughput is similar to water flow. In order to improve thro
     AT+CWJAP="ssid","password"
     AT+UART_CUR=3000000,8,1,0,3
     AT+CIPSTART="TCP","192.168.105.13",3344
+    AT+CIPMODE=1
     AT+CIPSEND
     // data transmission
 

diff --git a/docs/en/Compile_and_Develop/How_to_set_AT_port_pin.rst b/docs/en/Compile_and_Develop/How_to_set_AT_port_pin.rst
@@ -5,7 +5,7 @@ How to Set AT Port Pins
 
 This document introduces how to modify :term:`AT port` pins in the firmware for {IDF_TARGET_NAME} series of products. By default, ESP-AT uses two UART interfaces as AT ports: one is to output logs (named as log port below) and the other to send AT commands and receive responses (named as command port below). 
 
-To modify the AT port pins of your {IDF_TARGET_NAME}, you should:
+If you already have the {IDF_TARGET_NAME} AT firmware and only need to modify the command port pins, you can directly modify the firmware using the :doc:`tools_at_py` to generate a new firmware for your module. Otherwise, if you need to modify the AT port pins of your {IDF_TARGET_NAME} device, you need to complete the following steps:
 
 - :doc:`clone the ESP-AT project <How_to_clone_project_and_compile_it>`;
 - modify the pins either in the menuconfig utility or the factory_param_data.csv table;

diff --git a/docs/en/Compile_and_Develop/esp-at_firmware_differences.rst b/docs/en/Compile_and_Develop/esp-at_firmware_differences.rst
@@ -25,7 +25,7 @@ This section describes the differences among AT firmwares of {IDF_TARGET_NAME} s
 
   - ESP32C2-2MB-AT-Vx.x.x.x.zip (referred to as **ESP32C2-2MB Bin** in this section);
   - ESP32C2-4MB-AT-Vx.x.x.x.zip (referred to as **ESP32C2-4MB Bin** in this section);
-  - ESP32C2-BLE-2MB Bin (firmware is not released, but you can download the ``esp32c2-ble-2mb-at`` firmware from :doc:`GitHub Actions <How_to_download_the_latest_temporary_version_of_AT_from_github>`, or `Compile ESP-AT Project Locally <How_to_clone_project_and_compile_it>` by yourself);
+  - ESP32C2-BLE-2MB Bin (firmware is not released, but you can download the ``esp32c2-ble-2mb-at`` firmware from :doc:`GitHub Actions <How_to_download_the_latest_temporary_version_of_AT_from_github>`, or :doc:`Compile ESP-AT Project Locally <How_to_clone_project_and_compile_it>` by yourself);
 
 .. only:: esp32c3
 

diff --git a/docs/en/Get_Started/Hardware_connection.rst b/docs/en/Get_Started/Hardware_connection.rst
@@ -239,7 +239,7 @@ Note:
 
     ESP32-PICO Series Hardware Connection
 
-  If you want to connect your device directly with ESP32-PICO-D4 rather than the {IDF_TARGET_NAME} board that integrates it, please refer to `ESP32-PICO-D4 Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32-pico-d4_datasheet_en.pdf>`_ for more details.
+  If you want to connect your device directly with ESP32-PICO-D4 rather than the {IDF_TARGET_NAME} board that integrates it, please refer to `ESP32-PICO-D4 Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32-pico_series_datasheet_en.pdf>`_ for more details.
 
   ESP32-SOLO Series
   ^^^^^^^^^^^^^^^^^^

diff --git a/docs/en/faq.rst b/docs/en/faq.rst
@@ -111,13 +111,6 @@ Do AT commands support ESP-WIFI-MESH?
 
   Currently, AT commands do not support ESP-WIFI-MESH.
 
-Does AT support websocket commands?
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-  - Not supported in the default firmware.
-  - It can be implemented by custom commands. See `websocket <https://github.com/espressif/esp-idf/tree/master/examples/protocols/websocket>`_ and :doc:`Compile_and_Develop/How_to_add_user-defined_AT_commands` for more information.
-
-
 .. Are there any examples of using AT commands to connect to aliyun or Tencent Cloud?
 .. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 ..

diff --git a/docs/en/index.rst b/docs/en/index.rst
@@ -3,7 +3,7 @@ ESP-AT User Guide
 
 :link_to_translation:`zh_CN:[中文]`
 
-This is the documentation for `ESP-AT <https://github.com/espressif/esp-at>`_ Development Framework. ESP-AT project was started and powered by `Espressif Systems <https://www.espressif.com>`_ as an official project, for the `ESP32, ESP32-C2, ESP32-C3, ESP32-C6, and ESP32-S2 Series SoCs <https://www.espressif.com/en/products/hardware/socs>`_ provided for Windows, Linux, and macOS.
+This is the documentation for `ESP-AT <https://github.com/espressif/esp-at>`_ Development Framework. ESP-AT project was started and powered by `Espressif Systems <https://www.espressif.com>`_ as an official project, for the `ESP32, ESP32-C2, ESP32-C3, ESP32-C6, and ESP32-S2 Series SoCs <https://www.espressif.com/en/products/socs>`_ provided for Windows, Linux, and macOS.
 
 .. only:: html
 

diff --git a/docs/en/versions.rst b/docs/en/versions.rst
@@ -113,11 +113,11 @@ Each ESP-IDF major and minor release version has an associated support period. A
 
 - Service Period of Support Period
 
-    Usually, it starts from the release of the AT firmware for the chip and lasts until the planned release of the next AT version for that chip. The release time of the next AT version is usually a few months before the end of the corresponding `ESP-IDF support period <https://github.com/espressif/esp-idf/blob/master/README.md#esp-idf-version-support-period>`_ (the AT release notes provide information about the ESP-IDF version corresponding to the chip).
+    Usually, it starts from the release of the AT firmware for the chip and lasts until the planned release of the next AT version for that chip. The release time of the next AT version is usually a few months before the end of the corresponding `ESP-IDF support period <https://github.com/espressif/esp-idf/blob/master/README.md#esp-idf-release-support-schedule>`_ (the AT release notes provide information about the ESP-IDF version corresponding to the chip).
 
 - Maintenance Period of Support Period
 
-    Usually, it starts after the service period ends and lasts until the end of the corresponding `ESP-IDF support period <https://github.com/espressif/esp-idf/blob/master/README.md#esp-idf-version-support-period>`_ for the chip (the AT release notes provide information about the ESP-IDF version corresponding to the chip). For example, if the support period of ESP-IDF v5.0 is until May 29, 2025, then the maintenance period for ESP-AT v3.0 ~ v3.3 will also be until May 29, 2025.
+    Usually, it starts after the service period ends and lasts until the end of the corresponding `ESP-IDF support period <https://github.com/espressif/esp-idf/blob/master/README.md#esp-idf-release-support-schedule>`_ for the chip (the AT release notes provide information about the ESP-IDF version corresponding to the chip). For example, if the support period of ESP-IDF v5.0 is until May 29, 2025, then the maintenance period for ESP-AT v3.0 ~ v3.3 will also be until May 29, 2025.
 
 In general: