From a12ecaae6cf42c52fe3f605b127ad47dfbe0f068 Mon Sep 17 00:00:00 2001 From: Sun Lu Xin Date: Fri, 22 Mar 2024 15:29:42 +0800 Subject: [PATCH] docs: Updated the description of hardware connection docs --- docs/en/AT_Command_Set/BLE_AT_Commands.rst | 4 ++-- docs/en/Get_Started/Downloading_guide.rst | 2 +- docs/en/Get_Started/Hardware_connection.rst | 2 +- docs/zh_CN/AT_Command_Set/BLE_AT_Commands.rst | 4 ++-- docs/zh_CN/Get_Started/Downloading_guide.rst | 2 +- docs/zh_CN/Get_Started/Hardware_connection.rst | 2 +- 6 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/en/AT_Command_Set/BLE_AT_Commands.rst b/docs/en/AT_Command_Set/BLE_AT_Commands.rst index 5e8d71804..ff767ee3b 100644 --- a/docs/en/AT_Command_Set/BLE_AT_Commands.rst +++ b/docs/en/AT_Command_Set/BLE_AT_Commands.rst @@ -22,7 +22,7 @@ Bluetooth® Low Energy AT Commands :esp32 or esp32c3 or esp32c6 or esp32c2: - :ref:`AT+BLECONN `: Establish Bluetooth LE connection. :esp32 or esp32c3 or esp32c6 or esp32c2: - :ref:`AT+BLECONNPARAM `: Query/Update parameters of Bluetooth LE connection. :esp32 or esp32c3 or esp32c6 or esp32c2: - :ref:`AT+BLEDISCONN `: End Bluetooth LE connection. - :esp32 or esp32c3 or esp32c6: - :ref:`AT+BLEDATALEN `: Set Bluetooth LE data packet length. + :esp32 or esp32c3 : - :ref:`AT+BLEDATALEN `: Set Bluetooth LE data packet length. :esp32 or esp32c3 or esp32c6 or esp32c2: - :ref:`AT+BLECFGMTU `: Set Bluetooth LE MTU length. :esp32 or esp32c3 : - :ref:`AT+BLEGATTSSRVCRE `: Generic Attributes Server (GATTS) creates services. :esp32 or esp32c3 : - :ref:`AT+BLEGATTSSRVSTART `: GATTS starts services. @@ -1165,7 +1165,7 @@ Introduction AT+BLECONN=0,"24:0a:c4:09:34:23" AT+BLEDISCONN=0 -.. only:: esp32 or esp32c3 or esp32c6 +.. only:: esp32 or esp32c3 .. _cmd-BDLEN: diff --git a/docs/en/Get_Started/Downloading_guide.rst b/docs/en/Get_Started/Downloading_guide.rst index c9597443e..358f05079 100644 --- a/docs/en/Get_Started/Downloading_guide.rst +++ b/docs/en/Get_Started/Downloading_guide.rst @@ -138,7 +138,7 @@ Before starting to flash, you need to download `Flash Download Tools for Windows - Flash AT firmware into your device. You can select either of the two ways below. - - To download one combined factory bin to address 0, select "DoNotChgBin" to use the default configuration of the factory bin. + - To download one combined factory bin (namely, ``factory_XXX.bin`` in the ``build/factory`` directory) to address 0, select "DoNotChgBin" to use the default configuration of the factory bin. .. figure:: ../../_static/download_one_bin_{IDF_TARGET_PATH_NAME}.png :align: center diff --git a/docs/en/Get_Started/Hardware_connection.rst b/docs/en/Get_Started/Hardware_connection.rst index 5f5bd5c17..274a3148f 100644 --- a/docs/en/Get_Started/Hardware_connection.rst +++ b/docs/en/Get_Started/Hardware_connection.rst @@ -334,7 +334,7 @@ Note: {IDF_TARGET_CFG_PREFIX}-2MB series refers to the module or board that has a built-in {IDF_TARGET_NAME}/ESP8684 chip with a 2 MB flash. - {IDF_TARGET_CFG_PREFIX}-2MB AT uses two UART ports: UART0 is used to download firmware and log output; UART1 is used to send AT commands and receive AT responses. Both UART0 and UART1 use ``115200`` baud rate for communication by default. + {IDF_TARGET_CFG_PREFIX}-2MB AT uses two UART ports: UART0 is used to download firmware and log output; UART1 is used to send AT commands and receive AT responses. Both UART0 (GPIO8, used to output log) and UART1 use ``115200`` baud rate for communication by default. The log is outputted at ``74880`` baud rate at the ROM stage, so if you need to view the ROM log, please open UART0 (TX: GPIO20) at ``74880`` baud rate. .. list-table:: {IDF_TARGET_CFG_PREFIX}-2MB Series Hardware Connection Pinout :header-rows: 1 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 ccac7efe9..cc0827923 100644 --- a/docs/zh_CN/AT_Command_Set/BLE_AT_Commands.rst +++ b/docs/zh_CN/AT_Command_Set/BLE_AT_Commands.rst @@ -22,7 +22,7 @@ Bluetooth® Low Energy AT 命令集 :esp32 or esp32c3 or esp32c6 or esp32c2: - :ref:`AT+BLECONN `：建立 Bluetooth LE 连接 :esp32 or esp32c3 or esp32c6 or esp32c2: - :ref:`AT+BLECONNPARAM `：查询/更新 Bluetooth LE 连接参数 :esp32 or esp32c3 or esp32c6 or esp32c2: - :ref:`AT+BLEDISCONN `：断开 Bluetooth LE 连接 - :esp32 or esp32c3 or esp32c6: - :ref:`AT+BLEDATALEN `：设置 Bluetooth LE 数据包长度 + :esp32 or esp32c3 : - :ref:`AT+BLEDATALEN `：设置 Bluetooth LE 数据包长度 :esp32 or esp32c3 or esp32c6 or esp32c2: - :ref:`AT+BLECFGMTU `：设置 Bluetooth LE MTU 长度 :esp32 or esp32c3 : - :ref:`AT+BLEGATTSSRVCRE `：GATTS 创建服务 :esp32 or esp32c3 : - :ref:`AT+BLEGATTSSRVSTART `：GATTS 开启服务 @@ -1165,7 +1165,7 @@ Bluetooth® Low Energy AT 命令集 AT+BLECONN=0,"24:0a:c4:09:34:23" AT+BLEDISCONN=0 -.. only:: esp32 or esp32c3 or esp32c6 +.. only:: esp32 or esp32c3 .. _cmd-BDLEN: diff --git a/docs/zh_CN/Get_Started/Downloading_guide.rst b/docs/zh_CN/Get_Started/Downloading_guide.rst index 0a0676f4b..7d6fa458b 100644 --- a/docs/zh_CN/Get_Started/Downloading_guide.rst +++ b/docs/zh_CN/Get_Started/Downloading_guide.rst @@ -138,7 +138,7 @@ Windows - 将 AT 固件烧录至设备，以下两种方式任选其一： - - 直接下载打包好的量产固件至 ``0x0`` 地址：勾选 "DoNotChgBin"，使用量产固件的默认配置； + - 直接下载打包好的量产固件（即 ``build/factory`` 目录下的 ``factory_XXX.bin``）至 ``0x0`` 地址：勾选 "DoNotChgBin"，使用量产固件的默认配置； .. figure:: ../../_static/download_one_bin_{IDF_TARGET_PATH_NAME}.png :align: center diff --git a/docs/zh_CN/Get_Started/Hardware_connection.rst b/docs/zh_CN/Get_Started/Hardware_connection.rst index 67afec544..83e83b24e 100644 --- a/docs/zh_CN/Get_Started/Hardware_connection.rst +++ b/docs/zh_CN/Get_Started/Hardware_connection.rst @@ -334,7 +334,7 @@ {IDF_TARGET_CFG_PREFIX}-2MB 系列指的是内置 {IDF_TARGET_NAME}/ESP8684 芯片，同时有 2 MB flash 的模组/开发板。 - {IDF_TARGET_CFG_PREFIX}-2MB AT 采用两个 UART 接口：UART0 用于下载固件和输出日志，UART1 用于发送 AT 命令和接收 AT 响应。默认情况下，UART0 和 UART1 均使用 ``115200`` 波特率进行通信。 + {IDF_TARGET_CFG_PREFIX}-2MB AT 采用两个 UART 接口：UART0 用于下载固件和输出日志，UART1 用于发送 AT 命令和接收 AT 响应。默认情况下，用于输出日志的 UART0 (GPIO8) 和 UART1 使用 ``115200`` 波特率进行通信。因为在 ROM 阶段，日志是以 ``74880`` 波特率输出，所以如果需要查看 ROM 的日志，请用 ``74880`` 波特率打开 UART0（TX：GPIO20）。 .. list-table:: {IDF_TARGET_CFG_PREFIX}-2MB 系列硬件连接管脚分配 :header-rows: 1