Merge branch 'docs/update_at_docs' into 'master'

docs: Updated a serial of at docs Closes DOC-7127 See merge request application/esp-at!1526
espressif · Mar 20, 2024 · 4a6ee01 · 4a6ee01
2 parents 993bf6d + 0c1b36b
commit 4a6ee01
Show file tree

Hide file tree

Showing 17 changed files with 385 additions and 307 deletions.
diff --git a/docs/en/AT_Binary_Lists/esp_at_binaries.rst b/docs/en/AT_Binary_Lists/esp_at_binaries.rst
@@ -3,7 +3,7 @@ Released Firmware
 
 :link_to_translation:`zh_CN:[中文]`
 
-It is recommended to use the lastest version of firmware. Currently, Espressif only releases AT firmware for the following {IDF_TARGET_NAME} series of modules. 
+It is recommended to use the lastest version of firmware. Currently, Espressif releases AT firmware for the following {IDF_TARGET_NAME} series of modules.
 
 .. note::
 

diff --git a/docs/en/AT_Binary_Lists/index.rst b/docs/en/AT_Binary_Lists/index.rst
@@ -26,78 +26,22 @@ This document covers the following sections:
 Brief Introduction to AT Firmware
 ----------------------------------
 
-ESP-AT firmware contains several binaries, and each of them is dedicated to a specific function:
-
-- ``factory/factory_xxx.bin`` is the combination of all binaries. So, you can either download the ``factory/factory_xxx.bin`` to address 0, or several binaries to different addresses according to ``download.config``.
--   ``at_customize.bin`` provides a user partition table, which lists the starting address and partition size for the ``mfg_nvs`` and possible ``fatfs``. You can read and write the contents of the partition listed in this file with the command :ref:`AT+FS <cmd-FS>` and :ref:`AT+SYSFLASH <cmd-SYSFLASH>`.
--   ``mfg_nvs.bin`` indicates the hardware configurations for different {IDF_TARGET_NAME} modules (see the table below). Please make sure the correct bin is used for your module. For more information on this parameter file, please refer to :ref:`firmware-modify-paras-not-source-code`.
-
-  .. only:: esp32
-
-    .. list-table:: Hardware Configuration of {IDF_TARGET_NAME} Modules
-       :header-rows: 1
-
-       * - Modules
-         - UART Pins (TX, RX, CTS, RTS)
-       * - ESP32-WROOM-32 Series (ESP32 Default Module)
-         - - GPIO17
-           - GPIO16
-           - GPIO15
-           - GPIO14
-       * - ESP32-WROVER Series (Supports Classic Bluetooth)
-         - - GPIO22
-           - GPIO19
-           - GPIO15
-           - GPIO14
-       * - ESP32-PICO Series
-         - - GPIO22
-           - GPIO19
-           - GPIO15
-           - GPIO14
-       * - ESP32-SOLO Series
-         - - GPIO17
-           - GPIO16
-           - GPIO15
-           - GPIO14
-
-  .. only:: esp32c2
-
-    .. list-table:: Hardware Configuration of {IDF_TARGET_NAME} Modules
-       :header-rows: 1
-
-       * - Modules
-         - UART Pins (TX, RX, CTS, RTS)
-       * - ESP32C2-4MB Series
-         - - GPIO7
-           - GPIO6
-           - GPIO5
-           - GPIO4
-
-  .. only:: esp32c3
-
-    .. list-table:: Hardware Configuration of {IDF_TARGET_NAME} Modules
-       :header-rows: 1
-
-       * - Modules
-         - UART Pins (TX, RX, CTS, RTS)
-       * - ESP32-C3-MINI-1 Series
-         - - GPIO7
-           - GPIO6
-           - GPIO5
-           - GPIO4
-
-  .. only:: esp32c6
-
-    .. list-table:: Hardware Configuration of {IDF_TARGET_NAME} Modules
-       :header-rows: 1
-
-       * - Modules
-         - UART Pins (TX, RX, CTS, RTS)
-       * - ESP32C6-4MB Series
-         - - GPIO7
-           - GPIO6
-           - GPIO5
-           - GPIO4
+The ESP-AT firmware package contains several binary files for specific functionalities:
+
+.. code-block:: none
+
+  build
+  ├── at_customize.bin        // Secondary partition table (user partition table, listing the start address and size of the mfg_nvs partition and fatfs partition)
+  ├── bootloader
+  │   └── bootloader.bin      // Bootloader
+  ├── customized_partitions
+  │   └── mfg_nvs.bin         // Factory configuration parameters, parameter values are listed in the mfg_nvs.csv file in the same directory
+  ├── esp-at.bin              // AT application firmware
+  ├── factory
+  │   └── factory_xxx.bin     // Collection of binary files for specific functionalities. You can burn only this file to the flash space with a starting address of 0, or burn several binary files to the flash space corresponding to the starting address according to the information in the download.config file.
+  ├── partition_table
+  │   └── partition-table.bin // Primary partition table (system partition table)
+  └── ota_data_initial.bin    // OTA data initialization file
 
 .. _firmware-selection:
 

diff --git a/docs/en/AT_Command_Set/BLE_AT_Commands.rst b/docs/en/AT_Command_Set/BLE_AT_Commands.rst
@@ -88,33 +88,12 @@ Introduction
 .. only:: esp32c2
 
   .. important::
-    The default {IDF_TARGET_CFG_PREFIX}-4MB AT firmware supports BluFi functionality, while the {IDF_TARGET_CFG_PREFIX}-2MB AT firmware does not. If you need BluFi functionality for {IDF_TARGET_CFG_PREFIX}-2MB, please refer to the :doc:`Compile ESP-AT Project Locally <../Compile_and_Develop/How_to_clone_project_and_compile_it>` documentation and follow the steps below in the project configuration (Step 5):
-
-    - Enable ``Component config`` -> ``Bluetooth``
-    - Enable ``Component config`` -> ``Bluetooth`` -> ``Bluetooth`` -> ``Host`` -> ``NimBLE`` - ``BLE only``
-    - Enable ``Component config`` -> ``Bluetooth`` -> ``NimBLE Options`` -> ``Enable blufi functionality``
-    - Enable ``Component config`` -> ``Bluetooth`` -> ``NimBLE Options`` -> ``Enable BLE 5 feature`` -> ``Enable extended advertising``
-    - Set ``Component config`` -> ``Bluetooth`` -> ``NimBLE Options`` -> ``Maximum number of concurrent connections`` -> 1
-    - Set ``Component config`` -> ``Bluetooth`` -> ``NimBLE Options`` -> ``Memory Settings`` -> ``MSYS_1_Block Count`` -> 10
-    - Set ``Component config`` -> ``Bluetooth`` -> ``NimBLE Options`` -> ``Memory Settings`` -> ``MSYS_1_Block Size`` -> 100
-    - Set ``Component config`` -> ``Bluetooth`` -> ``NimBLE Options`` -> ``Memory Settings`` -> ``MSYS_2_Block Count`` -> 4
-    - Set ``Component config`` -> ``Bluetooth`` -> ``NimBLE Options`` -> ``Memory Settings`` -> ``ACL Buffer Count`` -> 5
-    - Set ``Component config`` -> ``Bluetooth`` -> ``NimBLE Options`` -> ``Memory Settings`` -> ``High Priority HCI Event Buffer count`` -> 5
-    - Set ``Component config`` -> ``Bluetooth`` -> ``NimBLE Options`` -> ``Memory Settings`` -> ``Low Priority HCI Event Buffer count`` -> 3
-    - Set ``Component config`` -> ``Bluetooth`` -> ``NimBLE Options`` -> ``BLE white list size`` -> 1
-    - Set ``Component config`` -> ``Bluetooth`` -> ``Controller Options`` -> ``BLE LL Resolving list size`` -> 1
-    - Set ``Component config`` -> ``Bluetooth`` -> ``Controller Options`` -> ``BLE duplicate scan list count`` -> 1
+    The default {IDF_TARGET_CFG_PREFIX}-4MB AT firmware supports BluFi functionality, while the {IDF_TARGET_CFG_PREFIX}-2MB AT firmware does not. The lack of BluFi support in the {IDF_TARGET_CFG_PREFIX}-2MB AT firmware is due to the insufficient 2 MB flash size to support Wi-Fi, BluFi, and OTA functionality simultaneously.
 
   .. important::
-    The default {IDF_TARGET_CFG_PREFIX}-4MB AT firmware and {IDF_TARGET_CFG_PREFIX}-2MB AT firmware do not support Bluetooth LE functionality. If you need to enable Bluetooth LE functionality, please refer to the :doc:`Compile ESP-AT Project Locally <../Compile_and_Develop/How_to_clone_project_and_compile_it>` documentation and follow the steps of above BluFi functionality in the project configuration (Step 5), and then follow the steps below:
+    The default {IDF_TARGET_CFG_PREFIX}-4MB AT firmware and {IDF_TARGET_CFG_PREFIX}-2MB AT firmware do not support Bluetooth LE functionality. If you need to support Bluetooth LE functionality, please refer to the :doc:`Compile ESP-AT Project Locally <../Compile_and_Develop/How_to_clone_project_and_compile_it>` documentation and choose ``ESP32C2-BLE-2MB`` during the environment installation in step 3.
 
-    - Enable Bluetooth LE commands: ``Component config`` -> ``AT`` -> ``AT ble command support``
-    - Set ``Component config`` -> ``Bluetooth`` -> ``NimBLE Options`` -> ``Maximum length of BLE device name in octets`` -> 32
-    - Set ``Component config`` -> ``Bluetooth`` -> ``NimBLE Options`` -> ``Preferred MTU size in octets`` -> 203
-
-    If you encounter an error similar to ``Part 'ota_0' 0/16 @ 0xd0000 size 0x130000 (overflow 0x59a0)``, you need to disable unnecessary features in ``Component config`` -> ``AT`` according to your application requirements to reduce the firmware size.
-
-    Due to limited memory, it is recommended to disable the Wi-Fi protocol stack by sending the command :ref:`AT+CWINIT=0 <cmd-INIT>` before using Bluetooth LE functionality. This will free up memory for Bluetooth operations.
+    Due to the limited memory of {IDF_TARGET_NAME}, Wi-Fi and Bluetooth LE functionalities cannot be supported simultaneously in a single firmware.
 
 .. only:: esp32 or esp32c3 or esp32c6 or esp32c2
 

diff --git a/docs/en/AT_Command_Set/Wi-Fi_AT_Commands.rst b/docs/en/AT_Command_Set/Wi-Fi_AT_Commands.rst
@@ -369,6 +369,7 @@ Notes
 -  The parameter ``<reconn_interval>`` of this command is the same as ``<interval_second>`` of the command :ref:`AT+CWRECONNCFG <cmd-RECONNCFG>`. Therefore, if you omit ``<reconn_interval>`` when running this command, the interval between Wi-Fi reconnections will use the default value 1.
 -  If the ``<ssid>`` and ``<password>`` parameter are omitted, AT will use the last configuration.
 -  Execute command has the same maximum timeout to setup command. The default value is 15 seconds, but you can change it by setting the parameter ``<jap_timeout>``.
+-  The authentication method via `WAPI <https://en.wikipedia.org/wiki/WLAN_Authentication_and_Privacy_Infrastructure>`_ is not supported for connecting to the router.
 -  To get an IPv6 address, you need to set :ref:`AT+CIPV6=1 <cmd-IPV6>`.
 -  Response ``OK`` means that the IPv4 network is ready, but not the IPv6 network. At present, ESP-AT is mainly based on IPv4 network, supplemented by IPv6 network.
 -  ``WIFI GOT IPv6 LL`` represents that the linklocal IPv6 address has been obtained. This address is calculated locally through EUI-64 and does not require the participation of the AP. Because of the parallel timing, this print may be before or after ``OK``.