From 0ff36f760e097ae1ae931cce551ef93cbf34582b Mon Sep 17 00:00:00 2001 From: Sun Lu Xin Date: Mon, 22 Jul 2024 14:22:23 +0800 Subject: [PATCH] docs: fix some issues with the AT documents --- docs/en/AT_Command_Set/MQTT_AT_Commands.rst | 2 +- docs/en/AT_Command_Set/Wi-Fi_AT_Commands.rst | 2 +- docs/en/Compile_and_Develop/tools_at_py.rst | 4 ++-- docs/en/faq.rst | 19 ++++++++++++++++--- .../zh_CN/AT_Command_Set/MQTT_AT_Commands.rst | 2 +- .../AT_Command_Set/Wi-Fi_AT_Commands.rst | 2 +- .../zh_CN/Compile_and_Develop/tools_at_py.rst | 4 ++-- docs/zh_CN/faq.rst | 17 +++++++++++++++-- 8 files changed, 39 insertions(+), 13 deletions(-) diff --git a/docs/en/AT_Command_Set/MQTT_AT_Commands.rst b/docs/en/AT_Command_Set/MQTT_AT_Commands.rst index 79a3f7837..38e73eaf5 100644 --- a/docs/en/AT_Command_Set/MQTT_AT_Commands.rst +++ b/docs/en/AT_Command_Set/MQTT_AT_Commands.rst @@ -577,7 +577,7 @@ Set Command **Function:** -Subscribe to defined MQTT topics with defined QoS. It supports subscribing to multiple topics. +Subscribe to defined MQTT topics with defined QoS. Multiple topics are available for subscription (up to 10 topics can be subscribed). **Command:** 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 df4a0041f..42fdc4ae5 100644 --- a/docs/en/AT_Command_Set/Wi-Fi_AT_Commands.rst +++ b/docs/en/AT_Command_Set/Wi-Fi_AT_Commands.rst @@ -590,7 +590,7 @@ List all available APs. :: - +CWLAP:,,,,,,,,,, + +CWLAP:(,,,,,,,,,,) OK Parameters diff --git a/docs/en/Compile_and_Develop/tools_at_py.rst b/docs/en/Compile_and_Develop/tools_at_py.rst index dd0b90bfb..c4370e875 100644 --- a/docs/en/Compile_and_Develop/tools_at_py.rst +++ b/docs/en/Compile_and_Develop/tools_at_py.rst @@ -5,7 +5,7 @@ at.py Tool :link_to_translation:`zh_CN:[中文]` -The ``at.py`` tool is used to modify various parameter configurations in the official release firmware, GitHub temporary firmware, and 2MB/4MB firmware of ESP-AT. These configurations include Wi-Fi configurations, certificate and key configurations, UART configurations, GATTS configurations, and more. When the default firmware does not meet your requirements, you can use the ``at.py`` tool to modify these parameter configurations in the firmware. +The ``at.py`` tool is used to modify various parameter configurations in the packaged 2 MB/4 MB AT production firmware (namely, ``factory_XXX.bin`` in the ``build/factory`` directory). These configurations include Wi-Fi configurations, certificate and key configurations, UART configurations, GATTS configurations, and more. When the default firmware does not meet your requirements, you can use the ``at.py`` tool to modify these parameter configurations in the firmware. .. _esp-at-py-steps: @@ -188,7 +188,7 @@ The modifiable UART configuration includes only the UART configuration for the : - Description * - \--uart_num - UART number for the AT command port - - Only needs to be modified if the AT command port is also used as the AT log port. Ensure that the ``tx_pin`` and ``rx_pin`` below have the same pins as the :term:`AT log port`. + - Only needs to be modified if the AT command port is also used as the AT log port. Ensure that the ``tx_pin`` and ``rx_pin`` below have the same pins as the :term:`AT log port`. If the :term:`AT log port` is only configured with the ``rx pin``, you need to configure the following ``tx_pin`` to be consistent with the ``tx pin`` of the UART of the Download Firmware Port (please refer to :doc:`Hardware Connection <../Get_Started/Hardware_connection>`). * - \--baud - Baud rate of the AT command port - Original value: 115200 diff --git a/docs/en/faq.rst b/docs/en/faq.rst index 4412c0049..820c3204e 100644 --- a/docs/en/faq.rst +++ b/docs/en/faq.rst @@ -173,12 +173,12 @@ How to enable the notify and indicate functions on Bluetooth LE clients? AT+BLEGATTCWR=0,3,6,1,2 > - // Write 0x01 + // Write low byte 0x01 high byte 0x00 (if you want to use hex format, it is: 0100) OK // Server: +WRITE:0,1,6,1,2,<0x01>,<0x00> AT+BLEGATTCWR=0,3,7,1,2 > - // Write 0x02 + // Write low byte 0x02 high byte 0x00 (if you want to use hex format, it is: 0200) OK // Server: +WRITE:0,1,6,1,2,<0x02>,<0x00> // Writing ccc is a prerequisite for the server to be able to send notify and indicate @@ -230,10 +230,23 @@ How to test and optimize the throughput of {IDF_TARGET_NAME} AT? .. only:: esp32 What is the maximum rate of {IDF_TARGET_NAME} AT default firmware Bluetooth LE UART transparent transmission? - ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ In an open office environment, when the serial port baud rate is 2000000, the average transmission rate of ESP-AT Bluetooth is 0.56 Mbps, and the average transmission rate of ESP-AT Bluetooth LE is 0.101 Mbps. +How to modify the default maximum number of TCP segment retransmissions for {IDF_TARGET_NAME} AT? +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + By default, the maximum number of TCP segment retransmissions for AT is 6. You can reconfigure the maximum number of TCP segment retransmissions (range: [3-12]) as follows: + + - Please refer to the :doc:`compile ESP-AT project locally <../Compile_and_Develop/How_to_clone_project_and_compile_it>` document to compile the AT firmware. In step five, configure ``Maximum number of retransmissions of data segments``: + + :: + + python build.py menuconfig > Component config > LWIP > TCP > Maximum number of retransmissions of data segments + + - Please refer to the :doc:`compile ESP-AT project on the webpage <../Compile_and_Develop/How_to_build_project_with_web_page>` document to compile the AT firmware. In step 5.3, modify the value of `CONFIG_LWIP_TCP_MAXRTX `_. + Other ----- diff --git a/docs/zh_CN/AT_Command_Set/MQTT_AT_Commands.rst b/docs/zh_CN/AT_Command_Set/MQTT_AT_Commands.rst index b2f32c6a2..b47b0359a 100644 --- a/docs/zh_CN/AT_Command_Set/MQTT_AT_Commands.rst +++ b/docs/zh_CN/AT_Command_Set/MQTT_AT_Commands.rst @@ -577,7 +577,7 @@ MQTT AT 命令集 **功能：** -订阅指定 MQTT topic 的指定 QoS，支持订阅多个 topic +订阅指定 MQTT topic 的指定 QoS，支持订阅多个 topic（最多支持订阅 10 个 topic）。 **命令：** 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 965742268..7920209af 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 @@ -590,7 +590,7 @@ Wi-Fi AT 命令集 :: - +CWLAP:,,,,,,,,,, + +CWLAP:(,,,,,,,,,,) OK 参数 diff --git a/docs/zh_CN/Compile_and_Develop/tools_at_py.rst b/docs/zh_CN/Compile_and_Develop/tools_at_py.rst index e58152160..48560ed23 100644 --- a/docs/zh_CN/Compile_and_Develop/tools_at_py.rst +++ b/docs/zh_CN/Compile_and_Develop/tools_at_py.rst @@ -5,7 +5,7 @@ at.py 工具 :link_to_translation:`en:[English]` -``at.py`` 工具用于修改 ESP-AT 官方发布版固件、GitHub 临时固件和 2MB/4MB 固件中的多种参数配置。这些配置包括 Wi-Fi 配置、证书和密钥配置、UART 配置、GATTS 配置等。当默认的固件无法满足您的需求时，您可以使用 ``at.py`` 工具修改固件中的这些参数配置。 +``at.py`` 工具用于修改打包好的 2 MB/4 MB AT 量产固件（即 ``build/factory`` 目录下的 ``factory_XXX.bin``）中的多种参数配置。这些配置包括 Wi-Fi 配置、证书和密钥配置、UART 配置、GATTS 配置等。当默认的固件无法满足您的需求时，您可以使用 ``at.py`` 工具修改固件中的这些参数配置。 .. _esp-at-py-steps: @@ -188,7 +188,7 @@ at.py 工具 - 说明 * - \--uart_num - AT 命令口的 UART 号 - - 仅在 AT 日志口同时用作 AT 命令口时，需要修改此参数。同时保证下面的 ``tx_pin`` 和 ``rx_pin`` 和 :term:`AT 日志端口` 的管脚一样。 + - 仅在 AT 日志口同时用作 AT 命令口时，需要修改此参数。同时需保证下面的 ``tx_pin`` 和 ``rx_pin`` 要配置与 :term:`AT 日志端口` 的 tx 和 rx 管脚一致，如果 :term:`AT 日志端口` 只配置了 rx，则下面 ``tx_pin`` 需要配置与下载固件口（可查看 :doc:`硬件连接 <../Get_Started/Hardware_connection>`）的 UART 的 tx 管脚一致。 * - \--baud - AT 命令口的波特率 - 原始值：115200 diff --git a/docs/zh_CN/faq.rst b/docs/zh_CN/faq.rst index 3f50662b9..e80688af3 100644 --- a/docs/zh_CN/faq.rst +++ b/docs/zh_CN/faq.rst @@ -173,12 +173,12 @@ AT 命令中串口波特率是否可以修改？（默认：115200） AT+BLEGATTCWR=0,3,6,1,2 > - // 写 0x01 + // 写低位 0x01 高位 0x00（如果要使用 hex 格式写的话就是：0100） OK // server: +WRITE:0,1,6,1,2,<0x01>,<0x00> AT+BLEGATTCWR=0,3,7,1,2 > - // 写 0x02 + // 写低位 0x02 高位 0x00（如果要使用 hex 格式写的话就是：0200） OK // server: +WRITE:0,1,6,1,2,<0x02>,<0x00> // 写 ccc 是 server 可以发送 notify 和 indicate 的前提条件 @@ -234,6 +234,19 @@ ESP-AT 固件中 TCP 发送窗口大小是否可以修改？ 办公室开放环境下，串口波特率为 2000000 时，ESP-AT Bluetooth 平均传输速率为 0.56 Mbps，ESP-AT Bluetooth LE 平均传输速率为 0.101 Mbps。 +如何修改 {IDF_TARGET_NAME} AT 默认 TCP 数据段最大重传次数？ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + 默认情况下，AT 的 TCP 数据段重传最大次数为 6 次。您可以通过以下方式重新配置 TCP 数据段重传最大次数（取值范围为：[3-12]）： + + - 请参考 :doc:`本地编译 ESP-AT 工程 <../Compile_and_Develop/How_to_clone_project_and_compile_it>` 文档自行编译 AT 固件，在第五步中，请配置 ``Maximum number of retransmissions of data segments``： + + :: + + python build.py menuconfig > Component config > LWIP > TCP > Maximum number of retransmissions of data segments + + - 请参考 :doc:`网页编译 ESP-AT 工程 <../Compile_and_Develop/How_to_build_project_with_web_page>` 文档自行编译 AT 固件，在第五步的第三小点中，请修改 `CONFIG_LWIP_TCP_MAXRTX `_ 的值。 + 其他 ----