diff --git a/docs/en/AT_Command_Set/Web_server_AT_Commands.rst b/docs/en/AT_Command_Set/Web_server_AT_Commands.rst index 58812b19..7ff2ca76 100644 --- a/docs/en/AT_Command_Set/Web_server_AT_Commands.rst +++ b/docs/en/AT_Command_Set/Web_server_AT_Commands.rst @@ -52,7 +52,8 @@ Parameters Notes ^^^^^ -- There are two ways to provide the HTML files needed by the Web server. One is to use FAT file system, and you need to enable AT FS command at this time. The other one is to use embedded files to store HTML files (default setting). +- There are two ways to provide the HTML files needed by the Web server. One is to use FAT file system, and you need to enable AT FS command at this time. The other is to use the embedded file to store HTML files (default setting). +- The default HTML file is :component_file:`index.html `. If you need to customize the display format or text of the HTML file, you can directly modify this file. If you need to customize other content of the HTML file (e.g., add a field), you need to modify the corresponding source code file :component_file:`at_web_server_cmd.c `. - Please make sure that the maximum number of open sockets is not less than 12, you may change the number by ``./build.py menuconfig`` > ``Component config`` > ``LWIP`` > ``Max bumber of open sockets`` and compile the project (see :doc:`../Compile_and_Develop/How_to_clone_project_and_compile_it`). - The default firmware does not support Web server AT commands (see :doc:`../Compile_and_Develop/esp-at_firmware_differences`), but you can enable it by ``./build.py menuconfig`` > ``Component config`` > ``AT`` > ``AT WEB Server command support`` and compile the project (see :doc:`../Compile_and_Develop/How_to_clone_project_and_compile_it`). - ESP-AT supports captive portals in {IDF_TARGET_NAME} series of devices. See :ref:`example `. 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 6afd3196..aa80e250 100644 --- a/docs/en/AT_Command_Set/Wi-Fi_AT_Commands.rst +++ b/docs/en/AT_Command_Set/Wi-Fi_AT_Commands.rst @@ -523,6 +523,10 @@ Parameters - bit 8: determine whether AP with ``WAPI_PSK`` authmode will be shown. - bit 9: determine whether AP with ``OWE`` authmode will be shown. + .. only:: esp32c6 + + - bit 10: determine whether AP with ``WPA3_ENT_SUITE_B_192_BIT`` authmode will be shown. + Example ^^^^^^^^ @@ -591,6 +595,10 @@ Parameters - 8: WAPI_PSK - 9: OWE + .. only:: esp32c6 + + - 10: WPA3_ENT_SUITE_B_192_BIT + - ****: string parameter showing SSID of the AP. - ****: signal strength. - ****: string parameter showing MAC address of the AP. diff --git a/docs/en/AT_Command_Set/websocket_at_commands.rst b/docs/en/AT_Command_Set/websocket_at_commands.rst index a84a51c5..d1e7a9b0 100644 --- a/docs/en/AT_Command_Set/websocket_at_commands.rst +++ b/docs/en/AT_Command_Set/websocket_at_commands.rst @@ -260,7 +260,7 @@ Parameters ^^^^^^^^^^ - ****: ID of the WebSocket connection. Range: [0,2]. -- ****: Length of data to send. Unit: byte. +- ****: Length of data to send. Unit: byte. The maximum length that can be sent is determined by subtracting the value of ```` in `AT+WSCFG ` by 10 and the size of the heap space that the system can allocate (taking the smaller value of the two). - ****: The opcode in the WebSocket frame sent. Range: [0,0xF]. Default: 1, which means text frame. For details about opcode, please refer to `RFC6455 5.2 section `_. - 0x0: continuation frame 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 b60a5cbf..11dfa3d8 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 @@ -51,9 +51,9 @@ By default, the {IDF_TARGET_NAME} AT firmware provided by Espressif uses the fol When compiling your ESP-AT project, you can modify them to other pins with the menuconfig utitlity: -* ``./build.py menuconfig`` --> ``Component config`` --> ``Common ESP-related`` --> ``UART for console output`` -* ``./build.py menuconfig`` --> ``Component config`` --> ``Common ESP-related`` --> ``UART TX on GPIO#`` -* ``./build.py menuconfig`` --> ``Component config`` --> ``Common ESP-related`` --> ``UART RX on GPIO#`` +* ``./build.py menuconfig`` --> ``Component config`` --> ``ESP System Settings`` --> ``Channel for console output`` --> ``Custom UART`` +* ``./build.py menuconfig`` --> ``Component config`` --> ``ESP System Settings`` --> ``UART TX on GPIO#`` +* ``./build.py menuconfig`` --> ``Component config`` --> ``ESP System Settings`` --> ``UART RX on GPIO#`` Modify Command Port Pins ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/en/faq.rst b/docs/en/faq.rst index 6ff0e993..4c9e29c0 100755 --- a/docs/en/faq.rst +++ b/docs/en/faq.rst @@ -93,6 +93,19 @@ Why is Wi-Fi disconnected (``WIFI DISCONNECT`` printed)? You can check the Wi-Fi disconnection reason code on the :term:`AT log port`, which usually prints ``wifi disconnected, rc:``. The ```` here refers to `Wi-Fi Reason Code `_. +What are the common Wi-Fi compatibility issues? +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + - AMPDU compatibility issue. + + - If the router does not support AMPDU, {IDF_TARGET_NAME} will automatically disable the AMPDU function when interacting with the router. + - If the router supports AMPDU but there is a compatibility issue with AMPDU transmission between the router and {IDF_TARGET_NAME}, it is recommended to disable the function on the router or {IDF_TARGET_NAME}. For information on how to disable it on {IDF_TARGET_NAME}, please refer to :doc:`Compile_and_Develop/How_to_clone_project_and_compile_it` and select the following options in the fifth step of configuring the project: + + - Disable ``Component config`` -> ``Wi-Fi`` -> ``WiFi AMPDU TX`` + - Disable ``Component config`` -> ``Wi-Fi`` -> ``WiFi AMPDU RX`` + + - Phy mode compatibility issue. If there is a compatibility issue with the phy mode between the router and {IDF_TARGET_NAME}, it is recommended to switch it on the router or {IDF_TARGET_NAME}. For how to switch it on {IDF_TARGET_NAME}, please refer to the :ref:`AT+CWSTAPROTO ` command. + Do AT commands support ESP-WIFI-MESH? ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -185,17 +198,6 @@ How big is the chip flash required for ESP-AT firmware on different modules? - For {IDF_TARGET_NAME} series modules, please refer to :doc:`ESP-AT Firmware Differences `. -.. only:: esp32 - - How does the {IDF_TARGET_NAME} AT communicate through the UART0 port? - ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - - The default AT firmware communicates through the UART1 port. If you want to communicate through UART0, please download and compile the ESP-AT project. - - - Refer to :doc:`Compile_and_Develop/How_to_clone_project_and_compile_it` to set up the compiling environment; - - Modify the module's UART pins in your :component_file:`factory_param_data.csv `, i.e. change uart_tx_pin to GPIO1, and uart_tx_pin to GPIO3; - - Configure your esp-at project: ``./build.py menuconfig`` > ``Component config`` > ``Common ESP-related`` > ``UART for console output(Custom)`` > ``Uart peripheral to use for console output(0-1)(UART1)`` > ``(1)UART TX on GPIO# (NEW)`` > ``(3)UART TX on GPIO# (NEW)``. - How to view the error log of AT firmware? ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/zh_CN/AT_Command_Set/Web_server_AT_Commands.rst b/docs/zh_CN/AT_Command_Set/Web_server_AT_Commands.rst index e3f1c8cd..2bfd4bf9 100644 --- a/docs/zh_CN/AT_Command_Set/Web_server_AT_Commands.rst +++ b/docs/zh_CN/AT_Command_Set/Web_server_AT_Commands.rst @@ -53,6 +53,7 @@ Web 服务器 AT 命令 ^^^^^ - 有两种方法可以提供 Web 服务器所需的 HTML 文件。一种是使用 FAT 文件系统，此时需要启用 AT FS 命令。另一种是使用嵌入文件来存储 HTML 文件（默认设置）。 +- 默认的 HTML 文件为 :component_file:`index.html `。如果需要自定义 HTML 文件的显示格式或显示文字，则您直接修改该文件即可；如果需要自定义 HTML 文件的其它内容（例如：增加一个字段），则您需要对应修改源码文件 :component_file:`at_web_server_cmd.c `。 - 请确保开放的 socket 的最大数目不能小于 12，您可以在 menuconfig 中设置此项 ``./build.py menuconfig`` > ``Component config`` > ``LWIP`` > ``Max number of open sockets``，然后重新编译工程（参考文档 :doc:`../Compile_and_Develop/How_to_clone_project_and_compile_it`）。 - AT 固件默认不支持 Web 服务器 AT 命令（参考文档 see :doc:`../Compile_and_Develop/esp-at_firmware_differences`），但您可以在 menuconfig 中设置支持 Web 服务器 AT 命令 ``./build.py menuconfig`` > ``Component config`` > ``AT`` > ``AT WEB Server command support``，然后重新编译工程（参考文档 :doc:`../Compile_and_Develop/How_to_clone_project_and_compile_it`）。 - ESP-AT 在 {IDF_TARGET_NAME} 系列设备中支持强制门户 (captive portal)，可参考 :ref:`示例 `。 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 dd1155ce..ec0f232a 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 @@ -523,6 +523,10 @@ Wi-Fi AT 命令集 - bit 8: 是否显示 ``WAPI_PSK`` 认证方式的 AP - bit 9: 是否显示 ``OWE`` 认证方式的 AP + .. only:: esp32c6 + + - bit 10: 是否显示 ``WPA3_ENT_SUITE_B_192_BIT`` 认证方式的 AP + 示例 ^^^^ @@ -591,6 +595,10 @@ Wi-Fi AT 命令集 - 8: WAPI_PSK - 9: OWE + .. only:: esp32c6 + + - 10: WPA3_ENT_SUITE_B_192_BIT + - ****：字符串参数，AP 的 SSID - ****：信号强度 - ****：字符串参数，AP 的 MAC 地址 diff --git a/docs/zh_CN/AT_Command_Set/websocket_at_commands.rst b/docs/zh_CN/AT_Command_Set/websocket_at_commands.rst index 3201ca9c..38f9a48f 100644 --- a/docs/zh_CN/AT_Command_Set/websocket_at_commands.rst +++ b/docs/zh_CN/AT_Command_Set/websocket_at_commands.rst @@ -260,7 +260,7 @@ WebSocket AT 命令集 ^^^^ - ****：WebSocket 连接 ID。范围：[0,2]。 -- ****：发送的数据长度。单位：字节。 +- ****：发送的数据长度。单位：字节。可发送的最大长度由 :ref:`AT+WSCFG ` 中的 ```` 值减去 10 和系统可分配的堆空间大小共同决定（取两个中的小值）。 - ****：发送的 WebSocket 帧中的 opcode。范围：[0,0xF]。默认值：1，即 text 帧。请参考 `RFC6455 5.2 章节 `_ 了解更多的 opcode。 - 0x0：continuation 帧 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 c03453d1..e891787d 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 @@ -51,9 +51,9 @@ 在编译 ESP-AT 工程时，可使用 menuconfig 配置工具将其修改为其它管脚： -* ``./build.py menuconfig`` --> ``Component config`` --> ``Common ESP-related`` --> ``UART for console output`` -* ``./build.py menuconfig`` --> ``Component config`` --> ``Common ESP-related`` --> ``UART TX on GPIO#`` -* ``./build.py menuconfig`` --> ``Component config`` --> ``Common ESP-related`` --> ``UART RX on GPIO#`` +* ``./build.py menuconfig`` --> ``Component config`` --> ``ESP System Settings`` --> ``Channel for console output`` --> ``Custom UART`` +* ``./build.py menuconfig`` --> ``Component config`` --> ``ESP System Settings`` --> ``UART TX on GPIO#`` +* ``./build.py menuconfig`` --> ``Component config`` --> ``ESP System Settings`` --> ``UART RX on GPIO#`` 修改命令端口管脚 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/zh_CN/faq.rst b/docs/zh_CN/faq.rst index 23fc5227..b27875c1 100755 --- a/docs/zh_CN/faq.rst +++ b/docs/zh_CN/faq.rst @@ -93,6 +93,19 @@ Wi-Fi 断开（打印 WIFI DISCONNECT） 是为什么？ 您可以在 :term:`AT 日志端口` 查看到 Wi-Fi 断开的原因，通常会打印 "wifi disconnected, rc:"。此处的 请参考： `Wi-Fi 原因代码 `_。 +Wi-Fi 常见的兼容性问题有哪些？ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + - AMPDU 兼容性问题。 + + - 如果路由器不支持 AMPDU，那么 {IDF_TARGET_NAME} 会在和路由器交互时，自动关闭 AMPDU 功能。 + - 如果路由器支持 AMPDU，但是路由器和 {IDF_TARGET_NAME} 之间的 AMPDU 传输存在兼容性问题，那么建议关闭路由器的 AMPDU 功能或者 {IDF_TARGET_NAME} 的 AMPDU 功能。如果您要禁用 {IDF_TARGET_NAME} 的 AMPDU 功能，请自行 :doc:`编译 ESP-AT 工程 <../Compile_and_Develop/How_to_clone_project_and_compile_it>`，在第五步配置工程里选择： + + - 禁用 ``Component config`` -> ``Wi-Fi`` -> ``WiFi AMPDU TX`` + - 禁用 ``Component config`` -> ``Wi-Fi`` -> ``WiFi AMPDU RX`` + + - phy mode 兼容性问题。如果路由器和 {IDF_TARGET_NAME} 之间的 phy mode 存在兼容性问题，那么建议切换路由器的 phy mode 或者 {IDF_TARGET_NAME} 的 phy mode。如果您要切换 {IDF_TARGET_NAME} 的 phy mode，请参考 :ref:`AT+CWSTAPROTO ` 命令。 + ESP-AT 命令是否支持 ESP-WIFI-MESH？ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -185,17 +198,6 @@ AT 命令中串口波特率是否可以修改？（默认：115200） - 对于 {IDF_TARGET_NAME} 系列模组，您可以参考 :doc:`ESP-AT 固件差异 `。 -.. only:: esp32 - - {IDF_TARGET_NAME} AT 如何从 UART0 口通信？ - ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - - 默认 AT 固件是通过 UART1 口通信的，如果要从 UART0 通信，需要下载并编译 ESP-AT。 - - - 参考 :doc:`Compile_and_Develop/How_to_clone_project_and_compile_it` 搭建好编译环境； - - 修改 :component_file:`factory_param_data.csv ` 表中对应模组的 UART 管脚，将 uart_tx_pin 修改为 GPIO1，uart_tx_pin 修改为 GPIO3； - - 调整配置：``./build.py menuconfig`` > ``Component config`` > ``Common ESP-related`` > ``UART for console output(Custom)`` > ``Uart peripheral to use for console output(0-1)(UART1)`` > ``(1)UART TX on GPIO# (NEW)`` > ``(3)UART TX on GPIO# (NEW)``。 - AT 固件如何查看 error log？ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^