From 6434f6d0d5bdc32db100b572627c7bb3a5b641c3 Mon Sep 17 00:00:00 2001 From: Chen Wu Date: Wed, 26 Jun 2024 15:16:59 +0800 Subject: [PATCH] docs: Updated a series of AT docs - Added new v3.3.0.0 support status for different ESP32-C3 ECOs - Fixed some incorrect links - Fixed that AT+CIPMODE=1 command was missed in How_to_optimize_throughput.rst - Added one note about AT+BLUFI command - Updated some descriptions about escape character - Added a description about crystal oscillator frequency for ESP32-C2 firmware - Added the coexistence notes between softap and bluetooth - Added a description to How_to_set_AT_port_pin.rst - Fixed a typo in home readme.md - Added support periods for esp-at wechat applet --- README.md | 2 +- docs/en/AT_Binary_Lists/esp_at_binaries.rst | 9 ++++++++- .../Web_server_AT_Examples.rst | 3 +++ .../mqtt-at-examples-for-cloud.rst | 2 +- docs/en/AT_Command_Set/BLE_AT_Commands.rst | 14 +++++++------- docs/en/AT_Command_Set/BT_AT_Commands.rst | 11 ++++++----- docs/en/AT_Command_Set/Driver_AT_Commands.rst | 2 +- docs/en/AT_Command_Set/HTTP_AT_Commands.rst | 2 +- docs/en/AT_Command_Set/Wi-Fi_AT_Commands.rst | 19 +++++++++++++++++-- docs/en/AT_Command_Set/index.rst | 2 +- .../How_to_build_project_with_web_page.rst | 2 +- .../How_to_optimize_throughput.rst | 2 ++ .../How_to_set_AT_port_pin.rst | 2 +- .../esp-at_firmware_differences.rst | 2 +- docs/en/Get_Started/Hardware_connection.rst | 2 +- docs/en/faq.rst | 7 ------- docs/en/index.rst | 2 +- docs/en/versions.rst | 4 ++-- .../zh_CN/AT_Binary_Lists/esp_at_binaries.rst | 9 ++++++++- .../Web_server_AT_Examples.rst | 3 +++ .../mqtt-at-examples-for-cloud.rst | 2 +- docs/zh_CN/AT_Command_Set/BLE_AT_Commands.rst | 14 +++++++------- docs/zh_CN/AT_Command_Set/BT_AT_Commands.rst | 11 ++++++----- .../AT_Command_Set/Driver_AT_Commands.rst | 2 +- .../zh_CN/AT_Command_Set/HTTP_AT_Commands.rst | 2 +- .../AT_Command_Set/Wi-Fi_AT_Commands.rst | 19 +++++++++++++++++-- docs/zh_CN/AT_Command_Set/index.rst | 2 +- .../How_to_build_project_with_web_page.rst | 2 +- .../How_to_optimize_throughput.rst | 2 ++ .../How_to_set_AT_port_pin.rst | 2 +- docs/zh_CN/faq.rst | 7 ------- 31 files changed, 104 insertions(+), 62 deletions(-) diff --git a/README.md b/README.md index af05edb0..08b7c023 100644 --- 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 index e86be2f4..15d485b0 100644 --- 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 index 85b07fe3..9422d500 100644 --- 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 `_ 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 index fefe446b..3ff29128 100644 --- 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 `_. 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 `_. 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 index ff767ee3..bd4e9279 100644 --- 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 `_. + Currently, AT firmware for {IDF_TARGET_NAME} supports `Bluetooth® Core Specification Version 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 `. + - To achieve better performance, it is recommended to disable SoftAP by sending the :ref:`AT+CWMODE=0/1 ` command before using Bluetooth LE function. For more details, please refer to the `RF Coexistence `_ 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 ` 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 `). +- You can only start or stop BluFi when Bluetooth LE is not initialized (:ref:`AT+BLEINIT=0 `). +- To achieve better performance, it is recommended to disable SoftAP by sending the :ref:`AT+CWMODE=0/1 ` command before using BluFi function. For more details, please refer to the `RF Coexistence `_ documentation. +- After BluFi network configuration is completed, please send the :ref:`AT+BLUFI=0 ` 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 index 4d1d8a58..572763f1 100644 --- 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 `_. +{IDF_TARGET_NAME} AT firmware supports `Bluetooth® Core Specification Version 4.2 `_. .. 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 ` command before using Classic Bluetooth function. For more details, please refer to the `RF Coexistence `_ documentation. - If Classic Bluetooth is initialized, :ref:`AT+CIPMODE ` cannot be set to 1. Example @@ -272,7 +273,7 @@ Parameters - 0x9: health. - 0x1F: uncategorized device. -- ****: please refer to `Minor Device Class field `_. +- ****: please refer to `Minor Device Class field `_. - ****: @@ -1197,9 +1198,9 @@ Set the Classic Bluetooth class of devices. Parameters ^^^^^^^^^^ -- ****: `major class `_. -- ****: `minor class `_. -- ****: `service class `_. +- ****: `major class `_. +- ****: `minor class `_. +- ****: `service class `_. Example ^^^^^^^^ diff --git a/docs/en/AT_Command_Set/Driver_AT_Commands.rst b/docs/en/AT_Command_Set/Driver_AT_Commands.rst index fc945848..3b4030d6 100644 --- 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 `__. +- For details on how to convert the channel value into voltage, please refer to `ADC Conversion `__. Example ^^^^^^^^ diff --git a/docs/en/AT_Command_Set/HTTP_AT_Commands.rst b/docs/en/AT_Command_Set/HTTP_AT_Commands.rst index 40c04a4d..9a610007 100644 --- 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 `_). + - 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 `_). - 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 index 4911ce62..a0e7461e 100644 --- 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 `. +- The configuration changes will be saved in the NVS area if :ref:`AT+SYSSTORE=1 `. + +.. 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 ` (Deinitialize Classic Bluetooth) + + .. only:: esp32 or esp32c2 or esp32c3 or esp32c6 + + - :ref:`AT+BLEINIT=0 ` (Deinitialize Bluetooth LE) + - :ref:`AT+BLUFI=0 ` (Disable BluFi) + + For more details, please refer to the `RF Coexistence `_ documentation. Example ^^^^^^^^ @@ -322,7 +337,7 @@ Parameters - ****: 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. - ****: password, MAX: 63-byte ASCII. diff --git a/docs/en/AT_Command_Set/index.rst b/docs/en/AT_Command_Set/index.rst index 62d4b3be..f3c91337 100644 --- 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 index f14f768f..09de9241 100644 --- 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 `_, and you need to upgrade the AT firmware by using the :ref:`AT+CIUPDATE ` 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 `_, and you need to upgrade the AT firmware by using the :ref:`AT+CIUPDATE ` 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 index f9dcd99d..3647ed85 100644 --- 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 index 216e2c94..4ac60035 100644 --- 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 `; - 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 index 4c5bb786..eaa640bf 100644 --- 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 `, or `Compile ESP-AT Project Locally ` by yourself); + - ESP32C2-BLE-2MB Bin (firmware is not released, but you can download the ``esp32c2-ble-2mb-at`` firmware from :doc:`GitHub Actions `, or :doc:`Compile ESP-AT Project Locally ` by yourself); .. only:: esp32c3 diff --git a/docs/en/Get_Started/Hardware_connection.rst b/docs/en/Get_Started/Hardware_connection.rst index fb554299..0adefefc 100644 --- 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 `_ 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 `_ for more details. ESP32-SOLO Series ^^^^^^^^^^^^^^^^^^ diff --git a/docs/en/faq.rst b/docs/en/faq.rst index 4c9e29c0..75a2451b 100644 --- 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 `_ 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 index 55e524d2..d2c83920 100644 --- 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 `_ Development Framework. ESP-AT project was started and powered by `Espressif Systems `_ as an official project, for the `ESP32, ESP32-C2, ESP32-C3, ESP32-C6, and ESP32-S2 Series SoCs `_ provided for Windows, Linux, and macOS. +This is the documentation for `ESP-AT `_ Development Framework. ESP-AT project was started and powered by `Espressif Systems `_ as an official project, for the `ESP32, ESP32-C2, ESP32-C3, ESP32-C6, and ESP32-S2 Series SoCs `_ provided for Windows, Linux, and macOS. .. only:: html diff --git a/docs/en/versions.rst b/docs/en/versions.rst index 0fda7a6f..8c6468ec 100644 --- 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 `_ (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 `_ (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 `_ 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 `_ 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: diff --git a/docs/zh_CN/AT_Binary_Lists/esp_at_binaries.rst b/docs/zh_CN/AT_Binary_Lists/esp_at_binaries.rst index 4a209f61..7240f4fe 100644 --- a/docs/zh_CN/AT_Binary_Lists/esp_at_binaries.rst +++ b/docs/zh_CN/AT_Binary_Lists/esp_at_binaries.rst @@ -7,9 +7,16 @@ .. note:: + .. only:: esp32c2 + + - 发布的 AT 固件仅支持 26 MHz 晶振频率的芯片版本。如果您的模组使用的是 40 MHz 的晶振频率，请自行 :doc:`编译 ESP-AT 工程 <../Compile_and_Develop/How_to_clone_project_and_compile_it>`，在第五步配置工程里选择： + + - ``Component config`` -> ``Hardware Settings`` -> ``Main XTAL Config`` -> ``Main XTAL frequency`` -> ``40 MHz`` + .. only:: esp32c3 - - 当前的 {IDF_TARGET_NAME} AT 固件支持 {IDF_TARGET_NAME} ECO0 (Rev v0.0) ~ ECO4 (Rev v0.4) 系列芯片（包括 ECO0 和 ECO4），暂不支持 {IDF_TARGET_NAME} 的 ECO6 (Rev v1.0)、ECO7 (Rev v1.1) 以及之后的芯片。 + - v2.2.0.0 ~ v3.2.0.0 版本的 AT 固件均支持 {IDF_TARGET_NAME} ECO0 (Rev v0.0) ~ ECO4 (Rev v0.4) 系列芯片（包括 ECO0 和 ECO4）。 + - v3.3.0.0 版本的 AT 固件支持 {IDF_TARGET_NAME} ECO0 (Rev v0.0) ~ ECO4 (Rev v0.4)、ECO6 (Rev v1.0)、ECO7 (Rev v1.1) 系列芯片。 - 如果您的模组没有发布的固件，可以使用相同硬件配置的模组的固件（点击 :doc:`../Compile_and_Develop/esp-at_firmware_differences` 查看与您的模组硬件配置相同的固件），或者如果您需要修改下面的配置，则可以通过 :doc:`../Compile_and_Develop/tools_at_py` 修改发布的固件，为您的模组生成新的固件。 diff --git a/docs/zh_CN/AT_Command_Examples/Web_server_AT_Examples.rst b/docs/zh_CN/AT_Command_Examples/Web_server_AT_Examples.rst index 7f4d15ec..2f389b7f 100644 --- a/docs/zh_CN/AT_Command_Examples/Web_server_AT_Examples.rst +++ b/docs/zh_CN/AT_Command_Examples/Web_server_AT_Examples.rst @@ -262,6 +262,9 @@ Web Server AT 示例 微信小程序配网是通过微信小程序连接 {IDF_TARGET_NAME} 设备创建的 AP，并通过微信小程序将需要连接的 AP 信息传输给 {IDF_TARGET_NAME} 设备，{IDF_TARGET_NAME} 设备通过这些信息连接到对应的 AP，并通知微信小程序配网结果的解决方案。 +.. important:: + ESP-AT 微信小程序将于 2024 年 12 月 31 日下架。在此期间，请做好产品功能的过渡。如您此后仍有相关需求，敬请联系 `乐鑫商务 `_，我们将竭诚为您提供支持和解决方案，感谢您的理解和支持。 + 流程 ^^^^ diff --git a/docs/zh_CN/AT_Command_Examples/mqtt-at-examples-for-cloud.rst b/docs/zh_CN/AT_Command_Examples/mqtt-at-examples-for-cloud.rst index e7dff945..9636f6be 100644 --- a/docs/zh_CN/AT_Command_Examples/mqtt-at-examples-for-cloud.rst +++ b/docs/zh_CN/AT_Command_Examples/mqtt-at-examples-for-cloud.rst @@ -33,7 +33,7 @@ MQTT AT 连接云示例 端点的格式为 “xxx-ats.iot.us-east-2.amazonaws.com”。 .. note:: - 强烈建议您熟悉 `AWS IoT 开发人员指南 `_ 以下是本指南中值得注意的一些要点。 + 强烈建议您熟悉 `AWS IoT 开发人员指南 `_ 以下是本指南中值得注意的一些要点。 - AWS IoT 需要所有设备必须有事物证书、事物私钥、和根证书。 - 有关如何激活证书。 diff --git a/docs/zh_CN/AT_Command_Set/BLE_AT_Commands.rst b/docs/zh_CN/AT_Command_Set/BLE_AT_Commands.rst index d2621d12..6c0da17a 100644 --- a/docs/zh_CN/AT_Command_Set/BLE_AT_Commands.rst +++ b/docs/zh_CN/AT_Command_Set/BLE_AT_Commands.rst @@ -74,7 +74,7 @@ Bluetooth® Low Energy AT 命令集 .. only:: esp32c2 or esp32c3 or esp32c6 - 当前， {IDF_TARGET_NAME} AT 固件支持 `蓝牙核心规范 5.0 版本 `_。 + 当前， {IDF_TARGET_NAME} AT 固件支持 `蓝牙核心规范 5.0 版本 `_。 .. only:: esp32 or esp32c3 or esp32c6 @@ -162,7 +162,7 @@ Bluetooth® Low Energy AT 命令集 说明 ^^^^ - - 使用 Bluetooth LE 功能时，如果您无需使用 SoftAP 模式，则建议您可以通过 :ref:`AT+CWMODE ` 设置 Wi-Fi 模式为 Null 或 Station 模式。 + - 为获得更好的性能，建议在使用 Bluetooth LE 功能前，先发送 :ref:`AT+CWMODE=0/1 ` 命令禁用 SoftAP。如您想了解更多细节，请阅读 `RF 共存 `_ 文档。 - 使用其它 Bluetooth LE 命令之前，请先调用本命令，初始化 Bluetooth LE 角色。 - Bluetooth LE 角色初始化后，不能直接切换。如需切换角色，需要先调用 :ref:`AT+RST ` 命令重启系统，再重新初始化 Bluetooth LE 角色。 - 建议在注销 Bluetooth LE 之前，停止正在进行的广播、扫描并断开所有的连接。 @@ -2977,12 +2977,12 @@ Bluetooth® Low Energy AT 命令集 - 6: WPA3_PSK； - 7: WPA2_WPA3_PSK。 -.. only:: esp32 or esp3c3 - - 说明 - ^^^^ +说明 +^^^^ - - 您只能在 Bluetooth LE 未初始化情况下开启或关闭 BluFi (:ref:`AT+BLEINIT=0 `)。 +- 您只能在 Bluetooth LE 未初始化情况下开启或关闭 BluFi (:ref:`AT+BLEINIT=0 `)。 +- 为获得更好的性能，建议在使用 BluFi 功能前，先发送 :ref:`AT+CWMODE=0/1 ` 命令禁用 SoftAP。如您想了解更多细节，请阅读 `RF 共存 `_ 文档。 +- BluFi 配网后请发送 :ref:`AT+BLUFI=0 ` 命令关闭 BluFi，以释放资源。 示例 ^^^^ diff --git a/docs/zh_CN/AT_Command_Set/BT_AT_Commands.rst b/docs/zh_CN/AT_Command_Set/BT_AT_Commands.rst index 5fc93697..435ba4e4 100644 --- a/docs/zh_CN/AT_Command_Set/BT_AT_Commands.rst +++ b/docs/zh_CN/AT_Command_Set/BT_AT_Commands.rst @@ -34,7 +34,7 @@ 介绍 ------ -{IDF_TARGET_NAME} AT 固件支持 `蓝牙核心规范 4.2 版本 `_。 +{IDF_TARGET_NAME} AT 固件支持 `蓝牙核心规范 4.2 版本 `_。 .. important:: 默认的 AT 固件不支持此页面下的 AT 命令。如果您需要 {IDF_TARGET_NAME} 支持经典蓝牙命令，请自行 :doc:`编译 ESP-AT 工程 <../Compile_and_Develop/How_to_clone_project_and_compile_it>`，在第五步配置工程里选择（下面每项是独立的，根据您的需要选择）： @@ -108,6 +108,7 @@ 说明 ^^^^ +- 为获得更好的性能，建议在使用 Classic Bluetooth 功能前，先发送 :ref:`AT+CWMODE=0/1 ` 命令禁用 SoftAP。如您想了解更多细节，请阅读 `RF 共存 `_ 文档。 - 如果 Classic Bluetooth 已初始化，则 :ref:`AT+CIPMODE ` 无法设置为 1。 示例 @@ -272,7 +273,7 @@ - 0x9: 健康； - 0x1F: 未分类。 -- ****：请参考 `次要设备类型 (Minor Device Class field) `_。 +- ****：请参考 `次要设备类型 (Minor Device Class field) `_。 - ****：主要服务类型： @@ -1197,9 +1198,9 @@ 参数 ^^^^ -- ****：`主要设备类型 (major class) `_； -- ****：`次要设备类型 (minor class) `_； -- ****：`服务类型 (service class) `_。 +- ****：`主要设备类型 (major class) `_； +- ****：`次要设备类型 (minor class) `_； +- ****：`服务类型 (service class) `_。 示例 ^^^^ diff --git a/docs/zh_CN/AT_Command_Set/Driver_AT_Commands.rst b/docs/zh_CN/AT_Command_Set/Driver_AT_Commands.rst index 0bc4450b..17ed25c0 100644 --- a/docs/zh_CN/AT_Command_Set/Driver_AT_Commands.rst +++ b/docs/zh_CN/AT_Command_Set/Driver_AT_Commands.rst @@ -125,7 +125,7 @@ - ESP-AT 只支持 ADC1。 - {IDF_TARGET_NAME} 支持 12 位宽度。 -- 对于如何将通道值转换为电压，可以参考 `ADC 转换 `__。 +- 对于如何将通道值转换为电压，可以参考 `ADC 转换 `__。 示例 ^^^^ diff --git a/docs/zh_CN/AT_Command_Set/HTTP_AT_Commands.rst b/docs/zh_CN/AT_Command_Set/HTTP_AT_Commands.rst index 365ed4be..ed19d42e 100644 --- a/docs/zh_CN/AT_Command_Set/HTTP_AT_Commands.rst +++ b/docs/zh_CN/AT_Command_Set/HTTP_AT_Commands.rst @@ -486,5 +486,5 @@ HTTP AT 命令集 - HTTP AT： - - ``AT+HTTPCLIENT`` 命令的错误码为 ``0x7000+Standard HTTP Error Code`` （更多有关 Standard HTTP/1.1 Error Code 的信息，请参考 `RFC 2616 `_）。 + - ``AT+HTTPCLIENT`` 命令的错误码为 ``0x7000+Standard HTTP Error Code`` （更多有关 Standard HTTP/1.1 Error Code 的信息，请参考 `RFC 2616 `_）。 - 例如，若 AT 在调用 ``AT+HTTPCLIENT`` 命令时收到 HTTP error 404，则会返回 ``0x7194`` 错误码 (``hex(0x7000+404)=0x7194``)。 diff --git a/docs/zh_CN/AT_Command_Set/Wi-Fi_AT_Commands.rst b/docs/zh_CN/AT_Command_Set/Wi-Fi_AT_Commands.rst index 4f801ac6..489979e2 100644 --- a/docs/zh_CN/AT_Command_Set/Wi-Fi_AT_Commands.rst +++ b/docs/zh_CN/AT_Command_Set/Wi-Fi_AT_Commands.rst @@ -177,7 +177,22 @@ Wi-Fi AT 命令集 说明 ^^^^ -- 若 :ref:`AT+SYSSTORE=1 `，本设置将保存在 NVS 分区 +- 若 :ref:`AT+SYSSTORE=1 `，本设置将保存在 NVS 分区 + +.. only:: esp32 or esp32c2 or esp32c3 or esp32c6 + + - 如您之前使用过蓝牙功能，为获得更好的性能，建议在使用 SoftAP 或 SoftAP+Station 功能前，先发送以下命令注销已初始化过的功能： + + .. only:: esp32 + + - :ref:`AT+BTINIT=0 ` （注销 Classic Bluetooth） + + .. only:: esp32 or esp32c2 or esp32c3 or esp32c6 + + - :ref:`AT+BLEINIT=0 ` （注销 Bluetooth LE） + - :ref:`AT+BLUFI=0 ` （关闭 BluFi） + + 如您想了解更多细节，请阅读 `RF 共存 `_ 文档。 示例 ^^^^ @@ -322,7 +337,7 @@ Wi-Fi AT 命令集 - ****：目标 AP 的 SSID - - 如果 SSID 和密码中有 ``,``、``"``、``\\`` 等特殊字符，需转义 + - 如果 SSID 和密码中有 ``,``、``"``、``\`` 等特殊字符，需转义 - AT 支持连接 SSID 为中文的 AP，但是某些路由器或者热点的中文 SSID 不是 UTF-8 编码格式。您可以先扫描 SSID，然后使用扫描到的 SSID 进行连接。 - ****：密码最长 63 字节 ASCII diff --git a/docs/zh_CN/AT_Command_Set/index.rst b/docs/zh_CN/AT_Command_Set/index.rst index 6b2ed518..6f25a685 100644 --- a/docs/zh_CN/AT_Command_Set/index.rst +++ b/docs/zh_CN/AT_Command_Set/index.rst @@ -78,7 +78,7 @@ AT 命令分类 AT+CWSAP="ESP756290","21030826",1,4 -- 特殊字符需作转义处理，如 ``,``、``"``、``\`` 等。 +- 特殊字符需作转义处理，当前需要转义的字符有 ``,``、``"``、``\``。 - ``\\``：转义反斜杠。 - ``\,``：转义逗号，分隔参数的逗号无需转义。 diff --git a/docs/zh_CN/Compile_and_Develop/How_to_build_project_with_web_page.rst b/docs/zh_CN/Compile_and_Develop/How_to_build_project_with_web_page.rst index f0638a31..db69e52a 100644 --- a/docs/zh_CN/Compile_and_Develop/How_to_build_project_with_web_page.rst +++ b/docs/zh_CN/Compile_and_Develop/How_to_build_project_with_web_page.rst @@ -89,7 +89,7 @@ 第四步：配置编译 ESP-AT 工程所需的密钥 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -如果您有 `Espressif OTA server `_ 的账户和 OTA token，并且需要使用 :ref:`AT+CIUPDATE ` 命令升级 AT 固件，那么需要完成此步骤。否则，建议您禁用 CONFIG_AT_OTA_SUPPORT（有关更多详细信息，请参阅 :ref:`at-wc-commit-changes`）或者跳过此步骤。 +如果您有 `Espressif OTA server `_ 的账户和 OTA token，并且需要使用 :ref:`AT+CIUPDATE ` 命令升级 AT 固件，那么需要完成此步骤。否则，建议您禁用 CONFIG_AT_OTA_SUPPORT（有关更多详细信息，请参阅 :ref:`at-wc-commit-changes`）或者跳过此步骤。 点击仓库下的 ``Settings`` 进入设置页面。 diff --git a/docs/zh_CN/Compile_and_Develop/How_to_optimize_throughput.rst b/docs/zh_CN/Compile_and_Develop/How_to_optimize_throughput.rst index e07000bd..c3913482 100644 --- a/docs/zh_CN/Compile_and_Develop/How_to_optimize_throughput.rst +++ b/docs/zh_CN/Compile_and_Develop/How_to_optimize_throughput.rst @@ -163,6 +163,7 @@ 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 // 传输数据 @@ -267,6 +268,7 @@ 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 // 传输数据 diff --git a/docs/zh_CN/Compile_and_Develop/How_to_set_AT_port_pin.rst b/docs/zh_CN/Compile_and_Develop/How_to_set_AT_port_pin.rst index f6c27319..17a5ce7e 100644 --- a/docs/zh_CN/Compile_and_Develop/How_to_set_AT_port_pin.rst +++ b/docs/zh_CN/Compile_and_Develop/How_to_set_AT_port_pin.rst @@ -5,7 +5,7 @@ 本文档介绍了如何修改 {IDF_TARGET_NAME} 系列固件中的 :term:`AT port` 管脚。默认情况下，ESP-AT 使用两个 UART 接口作为 AT 端口：一个用于输出日志（以下称为日志端口），另一个用于发送 AT 命令和接收响应（以下称为命令端口）。 -要修改 {IDF_TARGET_NAME} 设备的 AT 端口管脚，应该： +如果您已经有 {IDF_TARGET_NAME} AT 固件，并且只需要修改命令端口管脚，请直接通过 :doc:`tools_at_py` 修改固件，为您的模组生成新的固件。否则您要修改 {IDF_TARGET_NAME} 设备的 AT 端口管脚，需要完成下面步骤： - :doc:`克隆 ESP-AT 工程 `。 - 在 menuconfig 配置工具或 factory_param_data.csv 表格中修改对应管脚。 diff --git a/docs/zh_CN/faq.rst b/docs/zh_CN/faq.rst index 7835d2bd..13efa753 100644 --- a/docs/zh_CN/faq.rst +++ b/docs/zh_CN/faq.rst @@ -111,13 +111,6 @@ ESP-AT 命令是否支持 ESP-WIFI-MESH？ ESP-AT 当前不支持 ESP-WIFI-MESH。 -AT 是否支持 websocket 命令？ -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - - - 默认命令不支持 websocket 命令。 - - 可通过自定义命令实现，代码参考 `websocket `_，以及 :doc:`Compile_and_Develop/How_to_add_user-defined_AT_commands`。 - - 是否有 AT 命令连接阿里云以及腾讯云示例？ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^