Skip to content

Commit

Permalink
Merge branch 'docs/fix_at_docs' into 'master'
Browse files Browse the repository at this point in the history
docs: Updated the description of hardware connection docs

See merge request application/esp-at!1541
  • Loading branch information
xcguang committed May 14, 2024
2 parents d894ef7 + a12ecaa commit d83db65
Show file tree
Hide file tree
Showing 6 changed files with 8 additions and 8 deletions.
4 changes: 2 additions & 2 deletions docs/en/AT_Command_Set/BLE_AT_Commands.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Bluetooth® Low Energy AT Commands
:esp32 or esp32c3 or esp32c6 or esp32c2: - :ref:`AT+BLECONN <cmd-BCONN>`: Establish Bluetooth LE connection.
:esp32 or esp32c3 or esp32c6 or esp32c2: - :ref:`AT+BLECONNPARAM <cmd-BCONNP>`: Query/Update parameters of Bluetooth LE connection.
:esp32 or esp32c3 or esp32c6 or esp32c2: - :ref:`AT+BLEDISCONN <cmd-BDISC>`: End Bluetooth LE connection.
:esp32 or esp32c3 or esp32c6: - :ref:`AT+BLEDATALEN <cmd-BDLEN>`: Set Bluetooth LE data packet length.
:esp32 or esp32c3 : - :ref:`AT+BLEDATALEN <cmd-BDLEN>`: Set Bluetooth LE data packet length.
:esp32 or esp32c3 or esp32c6 or esp32c2: - :ref:`AT+BLECFGMTU <cmd-BMTU>`: Set Bluetooth LE MTU length.
:esp32 or esp32c3 : - :ref:`AT+BLEGATTSSRVCRE <cmd-GSSRVCRE>`: Generic Attributes Server (GATTS) creates services.
:esp32 or esp32c3 : - :ref:`AT+BLEGATTSSRVSTART <cmd-GSSRVSTART>`: GATTS starts services.
Expand Down Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion docs/en/Get_Started/Downloading_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/en/Get_Started/Hardware_connection.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/zh_CN/AT_Command_Set/BLE_AT_Commands.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Bluetooth® Low Energy AT 命令集
:esp32 or esp32c3 or esp32c6 or esp32c2: - :ref:`AT+BLECONN <cmd-BCONN>`:建立 Bluetooth LE 连接
:esp32 or esp32c3 or esp32c6 or esp32c2: - :ref:`AT+BLECONNPARAM <cmd-BCONNP>`:查询/更新 Bluetooth LE 连接参数
:esp32 or esp32c3 or esp32c6 or esp32c2: - :ref:`AT+BLEDISCONN <cmd-BDISC>`:断开 Bluetooth LE 连接
:esp32 or esp32c3 or esp32c6: - :ref:`AT+BLEDATALEN <cmd-BDLEN>`:设置 Bluetooth LE 数据包长度
:esp32 or esp32c3 : - :ref:`AT+BLEDATALEN <cmd-BDLEN>`:设置 Bluetooth LE 数据包长度
:esp32 or esp32c3 or esp32c6 or esp32c2: - :ref:`AT+BLECFGMTU <cmd-BMTU>`:设置 Bluetooth LE MTU 长度
:esp32 or esp32c3 : - :ref:`AT+BLEGATTSSRVCRE <cmd-GSSRVCRE>`:GATTS 创建服务
:esp32 or esp32c3 : - :ref:`AT+BLEGATTSSRVSTART <cmd-GSSRVSTART>`:GATTS 开启服务
Expand Down Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion docs/zh_CN/Get_Started/Downloading_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/zh_CN/Get_Started/Hardware_connection.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit d83db65

Please sign in to comment.