From e4b3fe2f46822d4707fce38d99517335ad9bafcd Mon Sep 17 00:00:00 2001 From: Yuhan Wei Date: Mon, 15 Jul 2024 19:41:43 +0800 Subject: [PATCH 01/14] docs(ble): Reorganized the bluetooth API guide structure --- docs/conf_common.py | 20 ++++++++----- .../api-guides/{ => bluetooth}/bluetooth.rst | 24 +++++++-------- docs/en/api-guides/bluetooth/index.rst | 20 +++++++++++++ docs/en/api-guides/index.rst | 2 +- .../api-guides/{ => bluetooth}/bluetooth.rst | 30 +++++++++---------- docs/zh_CN/api-guides/bluetooth/index.rst | 20 +++++++++++++ docs/zh_CN/api-guides/index.rst | 2 +- 7 files changed, 81 insertions(+), 37 deletions(-) rename docs/en/api-guides/{ => bluetooth}/bluetooth.rst (88%) create mode 100644 docs/en/api-guides/bluetooth/index.rst rename docs/zh_CN/api-guides/{ => bluetooth}/bluetooth.rst (83%) create mode 100644 docs/zh_CN/api-guides/bluetooth/index.rst diff --git a/docs/conf_common.py b/docs/conf_common.py index 108b94611b..055efc1365 100644 --- a/docs/conf_common.py +++ b/docs/conf_common.py @@ -17,20 +17,24 @@ if os.environ.get('IDF_PATH') is None: raise RuntimeError('IDF_PATH should be set, run export.sh before building docs') BT_DOCS = ['api-guides/bluetooth.rst', - 'api-reference/bluetooth/bt_le.rst', + 'api-guides/bluetooth/index.rst', + 'api-guides/bluetooth/bluetooth.rst', 'api-reference/bluetooth/esp_bt_defs.rst', 'api-reference/bluetooth/esp_bt_device.rst', 'api-reference/bluetooth/esp_bt_main.rst', 'api-reference/bluetooth/bt_common.rst', 'api-reference/bluetooth/controller_vhci.rst', - 'api-reference/bluetooth/esp_gap_ble.rst', - 'api-reference/bluetooth/esp_gatt_defs.rst', - 'api-reference/bluetooth/esp_gatts.rst', - 'api-reference/bluetooth/esp_gattc.rst', - 'api-reference/bluetooth/index.rst', - 'api-reference/bluetooth/nimble/index.rst'] + 'api-reference/bluetooth/index.rst'] + +BLE_DOCS = ['api-reference/bluetooth/bt_le.rst', + 'api-guides/bluetooth/ble/ble-feature-support-status.rst', + 'api-reference/bluetooth/esp_gap_ble.rst', + 'api-reference/bluetooth/esp_gatt_defs.rst', + 'api-reference/bluetooth/esp_gatts.rst', + 'api-reference/bluetooth/esp_gattc.rst', + 'api-reference/bluetooth/nimble/index.rst', + 'migration-guides/release-5.x/5.0/bluetooth-low-energy.rst'] -BLE_DOCS = ['migration-guides/release-5.x/5.0/bluetooth-low-energy.rst'] BLE_MESH_DOCS = ['api-guides/esp-ble-mesh/ble-mesh-index.rst', 'api-guides/esp-ble-mesh/ble-mesh-feature-list.rst', diff --git a/docs/en/api-guides/bluetooth.rst b/docs/en/api-guides/bluetooth/bluetooth.rst similarity index 88% rename from docs/en/api-guides/bluetooth.rst rename to docs/en/api-guides/bluetooth/bluetooth.rst index 7617e1b432..0cab773f3d 100644 --- a/docs/en/api-guides/bluetooth.rst +++ b/docs/en/api-guides/bluetooth/bluetooth.rst @@ -1,5 +1,5 @@ -Bluetooth® Overview -=================== +Introduction +------------ :link_to_translation:`zh_CN:[中文]` @@ -21,7 +21,7 @@ The Bluetooth stack in ESP-IDF is a layered architecture that enables Bluetooth .. only:: esp32 or esp32s3 or esp32c3 or esp32c6 - .. figure:: ../../_static/bluetooth-architecture.png + .. figure:: ../../../_static/bluetooth-architecture.png :align: center :scale: 90% :alt: {IDF_TARGET_NAME} Bluetooth Stack Architecture @@ -30,7 +30,7 @@ The Bluetooth stack in ESP-IDF is a layered architecture that enables Bluetooth .. only:: esp32c2 - .. figure:: ../../_static/bluetooth-architecture-no-ble-mesh.png + .. figure:: ../../../_static/bluetooth-architecture-no-ble-mesh.png :align: center :scale: 90% :alt: {IDF_TARGET_NAME} Bluetooth Stack Architecture @@ -39,7 +39,7 @@ The Bluetooth stack in ESP-IDF is a layered architecture that enables Bluetooth .. only:: esp32h2 - .. figure:: ../../_static/bluetooth-architecture-no-blufi.png + .. figure:: ../../../_static/bluetooth-architecture-no-blufi.png :align: center :scale: 90% :alt: {IDF_TARGET_NAME} Bluetooth Stack Architecture @@ -110,7 +110,7 @@ ESP Bluetooth Controller At the bottom layer is ESP Bluetooth Controller, which encompasses various modules such as PHY, Baseband, Link Controller, Link Manager, Device Manager, and HCI. It handles hardware interface management and link management. It provides functions in the form of libraries and is accessible through APIs. This layer directly interacts with the hardware and low-level Bluetooth protocols. -- :doc:`API reference <../api-reference/bluetooth/controller_vhci>` +- :doc:`API reference <../../api-reference/bluetooth/controller_vhci>` - :example:`Application examples ` @@ -141,12 +141,12 @@ ESP-Bluedroid is a modified version of the native Android Bluetooth stack, Blued - API references - - :doc:`../api-reference/bluetooth/bt_common` - - :doc:`Bluetooth LE <../api-reference/bluetooth/bt_le>` + - :doc:`../../api-reference/bluetooth/bt_common` + - :doc:`Bluetooth LE <../../api-reference/bluetooth/bt_le>` .. only:: esp32 - - :doc:`../api-reference/bluetooth/classic_bt` + - :doc:`../../api-reference/bluetooth/classic_bt` - :example:`Application examples ` @@ -162,7 +162,7 @@ ESP-NimBLE supports Bluetooth LE only. Classic Bluetooth is not supported. - API references - `NimBLE API references `__ - - :doc:`ESP-NimBLE API references for initialization <../api-reference/bluetooth/nimble/index>` + - :doc:`ESP-NimBLE API references for initialization <../../api-reference/bluetooth/nimble/index>` - :example:`Application examples ` @@ -180,7 +180,7 @@ Above the host stacks are the profile implementations by Espressif and some comm Built on top of Zephyr Bluetooth Mesh stack, the ESP-BLE-MESH implementation supports device provisioning and node control. It also supports such node features as Proxy, Relay, Low power and Friend. - - :doc:`ESP-BLE-MESH documentation `: feature list, get started, architecture, description of application examples, frequently asked questions, etc. + - :doc:`ESP-BLE-MESH documentation <../esp-ble-mesh/ble-mesh-index>`: feature list, get started, architecture, description of application examples, frequently asked questions, etc. - :example:`Application examples ` @@ -191,7 +191,7 @@ Above the host stacks are the profile implementations by Espressif and some comm The BluFi for {IDF_TARGET_NAME} is a Wi-Fi network configuration function via Bluetooth channel. It provides a secure protocol to pass Wi-Fi configuration and credentials to {IDF_TARGET_NAME}. Using this information, {IDF_TARGET_NAME} can then connect to an AP or establish a softAP. - - :doc:`BluFi documentation ` + - :doc:`BluFi documentation <../blufi>` - :example:`Application examples ` diff --git a/docs/en/api-guides/bluetooth/index.rst b/docs/en/api-guides/bluetooth/index.rst new file mode 100644 index 0000000000..199935e3f3 --- /dev/null +++ b/docs/en/api-guides/bluetooth/index.rst @@ -0,0 +1,20 @@ +Bluetooth® +============ +:link_to_translation:`zh_CN:[中文]` + +Overview +-------- +.. toctree:: + :maxdepth: 1 + + bluetooth + +.. .. only:: SOC_BLE_SUPPORTED + + .. Bluetooth® Low Energy (Bluetooth LE) + .. ------------------------------------ + + .. .. toctree:: + .. :maxdepth: 2 + + .. ble/ble-feature-support-status diff --git a/docs/en/api-guides/index.rst b/docs/en/api-guides/index.rst index 9e11d6e4f9..bd0c0704e8 100644 --- a/docs/en/api-guides/index.rst +++ b/docs/en/api-guides/index.rst @@ -8,7 +8,7 @@ API Guides app_trace startup :SOC_BLUFI_SUPPORTED: blufi - :SOC_BT_SUPPORTED: bluetooth + :SOC_BT_SUPPORTED: bluetooth/index bootloader build-system :SOC_SUPPORT_COEXISTENCE: coexist diff --git a/docs/zh_CN/api-guides/bluetooth.rst b/docs/zh_CN/api-guides/bluetooth/bluetooth.rst similarity index 83% rename from docs/zh_CN/api-guides/bluetooth.rst rename to docs/zh_CN/api-guides/bluetooth/bluetooth.rst index 477d20238c..de511d7927 100644 --- a/docs/zh_CN/api-guides/bluetooth.rst +++ b/docs/zh_CN/api-guides/bluetooth/bluetooth.rst @@ -1,5 +1,5 @@ -蓝牙®概述 -========= +介绍 +------ :link_to_translation:`en:[English]` @@ -21,7 +21,7 @@ ESP-IDF 中的蓝牙协议栈是一个分层架构，可在 {IDF_TARGET_NAME} .. only:: esp32 or esp32s3 or esp32c3 or esp32c6 - .. figure:: ../../_static/bluetooth-architecture.png + .. figure:: ../../../_static/bluetooth-architecture.png :align: center :scale: 90% :alt: {IDF_TARGET_NAME} 蓝牙协议栈架构 @@ -30,7 +30,7 @@ ESP-IDF 中的蓝牙协议栈是一个分层架构，可在 {IDF_TARGET_NAME} .. only:: esp32c2 - .. figure:: ../../_static/bluetooth-architecture-no-ble-mesh.png + .. figure:: ../../../_static/bluetooth-architecture-no-ble-mesh.png :align: center :scale: 90% :alt: {IDF_TARGET_NAME} 蓝牙协议栈架构 @@ -39,7 +39,7 @@ ESP-IDF 中的蓝牙协议栈是一个分层架构，可在 {IDF_TARGET_NAME} .. only:: esp32h2 - .. figure:: ../../_static/bluetooth-architecture-no-blufi.png + .. figure:: ../../../_static/bluetooth-architecture-no-blufi.png :align: center :scale: 90% :alt: {IDF_TARGET_NAME} 蓝牙协议栈架构 @@ -110,7 +110,7 @@ ESP 蓝牙控制器 底层为 ESP 蓝牙控制器，包含 PHY、基带、链路控制器、链路管理器、设备管理器和 HCI 等各种模块。该层管理硬件接口和链路，以库的形式提供功能，并通过 API 访问，且直接与硬件和低级别蓝牙协议交互。 -- :doc:`API 参考 <../api-reference/bluetooth/controller_vhci>` +- :doc:`API 参考 <../../api-reference/bluetooth/controller_vhci>` - :example:`应用示例 ` @@ -141,12 +141,12 @@ ESP-Bluedroid 是原生 Android 蓝牙协议栈 Bluedroid 的修改版，由两 - API 参考 - - :doc:`../api-reference/bluetooth/bt_common` - - :doc:`低功耗蓝牙 <../api-reference/bluetooth/bt_le>` + - :doc:`../../api-reference/bluetooth/bt_common` + - :doc:`低功耗蓝牙 <../../api-reference/bluetooth/bt_le>` .. only:: esp32 - - :doc:`../api-reference/bluetooth/classic_bt` + - :doc:`../../api-reference/bluetooth/classic_bt` - :example:`应用程序示例 ` @@ -162,15 +162,15 @@ ESP-NimBLE 仅支持低功耗蓝牙，不支持经典蓝牙。 - API 参考 - `NimBLE API 参考 `__ - - :doc:`ESP-NimBLE 初始化 API 参考 initialization <../api-reference/bluetooth/nimble/index>` + - :doc:`ESP-NimBLE 初始化 API 参考 initialization <../../api-reference/bluetooth/nimble/index>` - :example:`应用程序示例 ` -配置文件 +蓝牙规范 -------- -主机协议层之上是 Espressif 的配置文件实现和一些常见的配置文件。根据具体配置，这些配置文件可以在 ESP-Bluedroid 或 ESP-NimBLE 上运行。 +主机协议层之上是 Espressif 的蓝牙规范和一些常见的蓝牙规范。根据具体配置，这些规范可以在 ESP-Bluedroid 或 ESP-NimBLE 上运行。 .. only:: SOC_BLE_MESH_SUPPORTED @@ -180,7 +180,7 @@ ESP-NimBLE 仅支持低功耗蓝牙，不支持经典蓝牙。 ESP-BLE-MESH 基于 Zephyr 蓝牙 Mesh 协议栈，其实现支持设备配网和节点控制，还支持代理、中继、低功耗和朋友等节点功能。 - - :doc:`ESP-BLE-MESH 文档 `：功能列表、快速入门、架构、应用示例描述、常见问题等。 + - :doc:`ESP-BLE-MESH 文档 <../esp-ble-mesh/ble-mesh-index>`：功能列表、快速入门、架构、应用示例描述、常见问题等。 - :example:`应用示例 ` @@ -191,11 +191,11 @@ ESP-NimBLE 仅支持低功耗蓝牙，不支持经典蓝牙。 {IDF_TARGET_NAME} 的 BluFi 是通过蓝牙信道进行的 Wi-Fi 网络配置功能。BluFi 提供了将 Wi-Fi 配置和凭据传递给 {IDF_TARGET_NAME} 的安全协议，从而使 {IDF_TARGET_NAME} 连接到 AP 或搭建软 AP。 - - :doc:`BluFi 文档 ` + - :doc:`BluFi 文档 <../blufi>` - :example:`应用示例 ` 应用 ---- -最上层是应用层。利用上述 API 和配置文件，可以在 ESP-Bluedroid 和 ESP-NimBLE 协议栈之上创建特定用例的蓝牙应用程序。 +最上层是应用层。利用上述 API 和蓝牙规范，可以在 ESP-Bluedroid 和 ESP-NimBLE 协议栈之上创建特定用例的蓝牙应用程序。 diff --git a/docs/zh_CN/api-guides/bluetooth/index.rst b/docs/zh_CN/api-guides/bluetooth/index.rst new file mode 100644 index 0000000000..426fee96f5 --- /dev/null +++ b/docs/zh_CN/api-guides/bluetooth/index.rst @@ -0,0 +1,20 @@ +蓝牙® +========= +:link_to_translation:`en:[English]` + +概述 +-------- +.. toctree:: + :maxdepth: 1 + + bluetooth + +.. .. only:: SOC_BLE_SUPPORTED + + .. 低功耗蓝牙® + .. ------------------ + + .. .. toctree:: + .. :maxdepth: 2 + + .. ble/ble-feature-support-status diff --git a/docs/zh_CN/api-guides/index.rst b/docs/zh_CN/api-guides/index.rst index c99ad1d9f3..428ba4fb5a 100644 --- a/docs/zh_CN/api-guides/index.rst +++ b/docs/zh_CN/api-guides/index.rst @@ -8,7 +8,7 @@ API 指南 app_trace startup :SOC_BLUFI_SUPPORTED: blufi - :SOC_BT_SUPPORTED: bluetooth + :SOC_BT_SUPPORTED: bluetooth/index bootloader build-system :SOC_SUPPORT_COEXISTENCE: coexist From c6f974e68937b728faca86cb513593b90f8a3a92 Mon Sep 17 00:00:00 2001 From: Yuhan Wei Date: Tue, 16 Jul 2024 14:18:41 +0800 Subject: [PATCH 02/14] docs(ble): Created an independent BLE folder --- docs/conf_common.py | 8 +++--- docs/en/api-guides/ble/index.rst | 10 ++++++++ .../bluetooth.rst => ble/overview.rst} | 25 ++++++++----------- docs/en/api-guides/bluetooth/index.rst | 20 --------------- docs/en/api-guides/index.rst | 2 +- docs/zh_CN/api-guides/ble/index.rst | 10 ++++++++ .../bluetooth.rst => ble/overview.rst} | 13 +++------- docs/zh_CN/api-guides/bluetooth/index.rst | 20 --------------- docs/zh_CN/api-guides/index.rst | 2 +- 9 files changed, 39 insertions(+), 71 deletions(-) create mode 100644 docs/en/api-guides/ble/index.rst rename docs/en/api-guides/{bluetooth/bluetooth.rst => ble/overview.rst} (86%) delete mode 100644 docs/en/api-guides/bluetooth/index.rst create mode 100644 docs/zh_CN/api-guides/ble/index.rst rename docs/zh_CN/api-guides/{bluetooth/bluetooth.rst => ble/overview.rst} (93%) delete mode 100644 docs/zh_CN/api-guides/bluetooth/index.rst diff --git a/docs/conf_common.py b/docs/conf_common.py index 055efc1365..379d4ae513 100644 --- a/docs/conf_common.py +++ b/docs/conf_common.py @@ -16,10 +16,7 @@ from esp_docs.conf_docs import * # noqa: F403,F401 if os.environ.get('IDF_PATH') is None: raise RuntimeError('IDF_PATH should be set, run export.sh before building docs') -BT_DOCS = ['api-guides/bluetooth.rst', - 'api-guides/bluetooth/index.rst', - 'api-guides/bluetooth/bluetooth.rst', - 'api-reference/bluetooth/esp_bt_defs.rst', +BT_DOCS = ['api-reference/bluetooth/esp_bt_defs.rst', 'api-reference/bluetooth/esp_bt_device.rst', 'api-reference/bluetooth/esp_bt_main.rst', 'api-reference/bluetooth/bt_common.rst', @@ -27,7 +24,8 @@ BT_DOCS = ['api-guides/bluetooth.rst', 'api-reference/bluetooth/index.rst'] BLE_DOCS = ['api-reference/bluetooth/bt_le.rst', - 'api-guides/bluetooth/ble/ble-feature-support-status.rst', + 'api-guides/ble/index.rst', + 'api-guides/ble/overview.rst', 'api-reference/bluetooth/esp_gap_ble.rst', 'api-reference/bluetooth/esp_gatt_defs.rst', 'api-reference/bluetooth/esp_gatts.rst', diff --git a/docs/en/api-guides/ble/index.rst b/docs/en/api-guides/ble/index.rst new file mode 100644 index 0000000000..4896107669 --- /dev/null +++ b/docs/en/api-guides/ble/index.rst @@ -0,0 +1,10 @@ +Bluetooth® Low Energy (Bluetooth LE) +==================================== +:link_to_translation:`zh_CN:[中文]` + +Overview +-------- +.. toctree:: + :maxdepth: 1 + + overview diff --git a/docs/en/api-guides/bluetooth/bluetooth.rst b/docs/en/api-guides/ble/overview.rst similarity index 86% rename from docs/en/api-guides/bluetooth/bluetooth.rst rename to docs/en/api-guides/ble/overview.rst index 0cab773f3d..44d3f648d1 100644 --- a/docs/en/api-guides/bluetooth/bluetooth.rst +++ b/docs/en/api-guides/ble/overview.rst @@ -3,7 +3,7 @@ Introduction :link_to_translation:`zh_CN:[中文]` -This document provides an architecture overview of the Bluetooth stack in ESP-IDF and some quick links to related documents and application examples. +This document provides an architecture overview of the Bluetooth Low Energy (Bluetooth LE) stack in ESP-IDF and some quick links to related documents and application examples. .. only:: esp32 @@ -17,36 +17,36 @@ This document provides an architecture overview of the Bluetooth stack in ESP-ID {IDF_TARGET_NAME} supports Bluetooth 5.0 (LE) and is certified for Bluetooth LE 5.3. -The Bluetooth stack in ESP-IDF is a layered architecture that enables Bluetooth functionality on {IDF_TARGET_NAME} chip series. The table below shows its architecture. +The Bluetooth LE stack in ESP-IDF is a layered architecture that enables Bluetooth functionality on {IDF_TARGET_NAME} chip series. The table below shows its architecture. .. only:: esp32 or esp32s3 or esp32c3 or esp32c6 .. figure:: ../../../_static/bluetooth-architecture.png :align: center :scale: 90% - :alt: {IDF_TARGET_NAME} Bluetooth Stack Architecture + :alt: {IDF_TARGET_NAME} Bluetooth LE Stack Architecture - {IDF_TARGET_NAME} Bluetooth Stack Architecture + {IDF_TARGET_NAME} Bluetooth LE Stack Architecture .. only:: esp32c2 .. figure:: ../../../_static/bluetooth-architecture-no-ble-mesh.png :align: center :scale: 90% - :alt: {IDF_TARGET_NAME} Bluetooth Stack Architecture + :alt: {IDF_TARGET_NAME} Bluetooth LE Stack Architecture - {IDF_TARGET_NAME} Bluetooth Stack Architecture + {IDF_TARGET_NAME} Bluetooth LE Stack Architecture .. only:: esp32h2 .. figure:: ../../../_static/bluetooth-architecture-no-blufi.png :align: center :scale: 90% - :alt: {IDF_TARGET_NAME} Bluetooth Stack Architecture + :alt: {IDF_TARGET_NAME} Bluetooth LE Stack Architecture - {IDF_TARGET_NAME} Bluetooth Stack Architecture + {IDF_TARGET_NAME} Bluetooth LE Stack Architecture -The table below shows whether the Bluetooth modules are supported in a specific chip series. +The table below shows whether the Bluetooth LE modules are supported in a specific chip series. .. list-table:: :width: 100% @@ -143,11 +143,6 @@ ESP-Bluedroid is a modified version of the native Android Bluetooth stack, Blued - :doc:`../../api-reference/bluetooth/bt_common` - :doc:`Bluetooth LE <../../api-reference/bluetooth/bt_le>` - - .. only:: esp32 - - - :doc:`../../api-reference/bluetooth/classic_bt` - - :example:`Application examples ` @@ -198,4 +193,4 @@ Above the host stacks are the profile implementations by Espressif and some comm Applications ------------ -At the uppermost layer are applications. You can build your own applications on top of the ESP-Bluedroid and ESP-NimBLE stacks, leveraging the provided APIs and profiles to create Bluetooth-enabled applications tailored to specific use cases. +At the uppermost layer are applications. You can build your own applications on top of the ESP-Bluedroid and ESP-NimBLE stacks, leveraging the provided APIs and profiles to create Bluetooth LE-enabled applications tailored to specific use cases. diff --git a/docs/en/api-guides/bluetooth/index.rst b/docs/en/api-guides/bluetooth/index.rst deleted file mode 100644 index 199935e3f3..0000000000 --- a/docs/en/api-guides/bluetooth/index.rst +++ /dev/null @@ -1,20 +0,0 @@ -Bluetooth® -============ -:link_to_translation:`zh_CN:[中文]` - -Overview --------- -.. toctree:: - :maxdepth: 1 - - bluetooth - -.. .. only:: SOC_BLE_SUPPORTED - - .. Bluetooth® Low Energy (Bluetooth LE) - .. ------------------------------------ - - .. .. toctree:: - .. :maxdepth: 2 - - .. ble/ble-feature-support-status diff --git a/docs/en/api-guides/index.rst b/docs/en/api-guides/index.rst index bd0c0704e8..14b527a92a 100644 --- a/docs/en/api-guides/index.rst +++ b/docs/en/api-guides/index.rst @@ -8,7 +8,7 @@ API Guides app_trace startup :SOC_BLUFI_SUPPORTED: blufi - :SOC_BT_SUPPORTED: bluetooth/index + :SOC_BLE_SUPPORTED: ble/index bootloader build-system :SOC_SUPPORT_COEXISTENCE: coexist diff --git a/docs/zh_CN/api-guides/ble/index.rst b/docs/zh_CN/api-guides/ble/index.rst new file mode 100644 index 0000000000..0d581546b1 --- /dev/null +++ b/docs/zh_CN/api-guides/ble/index.rst @@ -0,0 +1,10 @@ +蓝牙® +========= +:link_to_translation:`en:[English]` + +概述 +-------- +.. toctree:: + :maxdepth: 1 + + overview diff --git a/docs/zh_CN/api-guides/bluetooth/bluetooth.rst b/docs/zh_CN/api-guides/ble/overview.rst similarity index 93% rename from docs/zh_CN/api-guides/bluetooth/bluetooth.rst rename to docs/zh_CN/api-guides/ble/overview.rst index de511d7927..a2d7a980b8 100644 --- a/docs/zh_CN/api-guides/bluetooth/bluetooth.rst +++ b/docs/zh_CN/api-guides/ble/overview.rst @@ -3,7 +3,7 @@ :link_to_translation:`en:[English]` -此文档概述了 ESP-IDF 中蓝牙协议栈的架构，并提供了一些相关文档和应用示例的快速链接。 +此文档概述了 ESP-IDF 中低功耗蓝牙协议栈的架构，并提供了一些相关文档和应用示例的快速链接。 .. only:: esp32 @@ -17,7 +17,7 @@ {IDF_TARGET_NAME} 支持蓝牙 5.0 (LE)，并且已经获得蓝牙 LE 5.3 认证。 -ESP-IDF 中的蓝牙协议栈是一个分层架构，可在 {IDF_TARGET_NAME} 系列芯片上实现蓝牙功能，详见下。 +ESP-IDF 中的低功耗蓝牙协议栈是一个分层架构，可在 {IDF_TARGET_NAME} 系列芯片上实现低功耗蓝牙功能，详见下。 .. only:: esp32 or esp32s3 or esp32c3 or esp32c6 @@ -46,7 +46,7 @@ ESP-IDF 中的蓝牙协议栈是一个分层架构，可在 {IDF_TARGET_NAME} {IDF_TARGET_NAME} 蓝牙协议栈架构 -参考下表可知特定芯片是否支持蓝牙模块。 +参考下表可知特定芯片是否支持低功耗蓝牙模块。 .. list-table:: :width: 100% @@ -143,11 +143,6 @@ ESP-Bluedroid 是原生 Android 蓝牙协议栈 Bluedroid 的修改版，由两 - :doc:`../../api-reference/bluetooth/bt_common` - :doc:`低功耗蓝牙 <../../api-reference/bluetooth/bt_le>` - - .. only:: esp32 - - - :doc:`../../api-reference/bluetooth/classic_bt` - - :example:`应用程序示例 ` @@ -198,4 +193,4 @@ ESP-NimBLE 仅支持低功耗蓝牙，不支持经典蓝牙。 应用 ---- -最上层是应用层。利用上述 API 和蓝牙规范，可以在 ESP-Bluedroid 和 ESP-NimBLE 协议栈之上创建特定用例的蓝牙应用程序。 +最上层是应用层。利用上述 API 和蓝牙规范，可以在 ESP-Bluedroid 和 ESP-NimBLE 协议栈之上创建特定用例的低功耗蓝牙应用程序。 diff --git a/docs/zh_CN/api-guides/bluetooth/index.rst b/docs/zh_CN/api-guides/bluetooth/index.rst deleted file mode 100644 index 426fee96f5..0000000000 --- a/docs/zh_CN/api-guides/bluetooth/index.rst +++ /dev/null @@ -1,20 +0,0 @@ -蓝牙® -========= -:link_to_translation:`en:[English]` - -概述 --------- -.. toctree:: - :maxdepth: 1 - - bluetooth - -.. .. only:: SOC_BLE_SUPPORTED - - .. 低功耗蓝牙® - .. ------------------ - - .. .. toctree:: - .. :maxdepth: 2 - - .. ble/ble-feature-support-status diff --git a/docs/zh_CN/api-guides/index.rst b/docs/zh_CN/api-guides/index.rst index 428ba4fb5a..953a4f42ff 100644 --- a/docs/zh_CN/api-guides/index.rst +++ b/docs/zh_CN/api-guides/index.rst @@ -8,7 +8,7 @@ API 指南 app_trace startup :SOC_BLUFI_SUPPORTED: blufi - :SOC_BT_SUPPORTED: bluetooth/index + :SOC_BLE_SUPPORTED: ble/index bootloader build-system :SOC_SUPPORT_COEXISTENCE: coexist From 48bf83416a0160380c14038d4cecf811a5ce857b Mon Sep 17 00:00:00 2001 From: Yuhan Wei Date: Sun, 21 Jul 2024 17:18:37 +0800 Subject: [PATCH 03/14] docs(ble): Moved ble-mesh and blufi to ble section --- docs/conf_common.py | 12 ++--- docs/en/api-guides/{ => ble}/blufi.rst | 17 +++---- .../esp-ble-mesh/ble-mesh-architecture.rst | 8 +-- .../{ => ble}/esp-ble-mesh/ble-mesh-faq.rst | 6 +-- .../esp-ble-mesh/ble-mesh-feature-list.rst | 4 +- .../{ => ble}/esp-ble-mesh/ble-mesh-index.rst | 49 +++++++++---------- .../esp-ble-mesh/ble-mesh-terminology.rst | 4 +- docs/en/api-guides/ble/index.rst | 44 +++++++++++++++-- docs/en/api-guides/ble/overview.rst | 6 +-- docs/en/api-guides/index.rst | 2 - .../api-reference/bluetooth/esp-ble-mesh.rst | 3 +- 11 files changed, 93 insertions(+), 62 deletions(-) rename docs/en/api-guides/{ => ble}/blufi.rst (99%) rename docs/en/api-guides/{ => ble}/esp-ble-mesh/ble-mesh-architecture.rst (99%) rename docs/en/api-guides/{ => ble}/esp-ble-mesh/ble-mesh-faq.rst (99%) rename docs/en/api-guides/{ => ble}/esp-ble-mesh/ble-mesh-feature-list.rst (98%) rename docs/en/api-guides/{ => ble}/esp-ble-mesh/ble-mesh-index.rst (93%) rename docs/en/api-guides/{ => ble}/esp-ble-mesh/ble-mesh-terminology.rst (99%) diff --git a/docs/conf_common.py b/docs/conf_common.py index 379d4ae513..b8f7249a53 100644 --- a/docs/conf_common.py +++ b/docs/conf_common.py @@ -34,11 +34,11 @@ BLE_DOCS = ['api-reference/bluetooth/bt_le.rst', 'migration-guides/release-5.x/5.0/bluetooth-low-energy.rst'] -BLE_MESH_DOCS = ['api-guides/esp-ble-mesh/ble-mesh-index.rst', - 'api-guides/esp-ble-mesh/ble-mesh-feature-list.rst', - 'api-guides/esp-ble-mesh/ble-mesh-terminology.rst', - 'api-guides/esp-ble-mesh/ble-mesh-architecture.rst', - 'api-guides/esp-ble-mesh/ble-mesh-faq.rst', +BLE_MESH_DOCS = ['api-guides/ble/esp-ble-mesh/ble-mesh-index.rst', + 'api-guides/ble/esp-ble-mesh/ble-mesh-feature-list.rst', + 'api-guides/ble/esp-ble-mesh/ble-mesh-terminology.rst', + 'api-guides/ble/esp-ble-mesh/ble-mesh-architecture.rst', + 'api-guides/ble/esp-ble-mesh/ble-mesh-faq.rst', 'api-reference/bluetooth/esp-ble-mesh.rst'] CLASSIC_BT_DOCS = ['api-reference/bluetooth/classic_bt.rst', @@ -55,7 +55,7 @@ CLASSIC_BT_DOCS = ['api-reference/bluetooth/classic_bt.rst', 'api-reference/bluetooth/esp_gap_bt.rst', 'migration-guides/release-5.x/5.0/bluetooth-classic.rst'] -BLUFI_DOCS = ['api-guides/blufi.rst', +BLUFI_DOCS = ['api-guides/ble/blufi.rst', 'api-reference/bluetooth/esp_blufi.rst'] WIFI_DOCS = ['api-guides/low-power-mode/low-power-mode-wifi.rst', diff --git a/docs/en/api-guides/blufi.rst b/docs/en/api-guides/ble/blufi.rst similarity index 99% rename from docs/en/api-guides/blufi.rst rename to docs/en/api-guides/ble/blufi.rst index 5e69ccf2a9..460799826f 100644 --- a/docs/en/api-guides/blufi.rst +++ b/docs/en/api-guides/ble/blufi.rst @@ -1,11 +1,8 @@ -BluFi -^^^^^ +Introduction +============== :link_to_translation:`zh_CN:[中文]` -Overview --------- - The BluFi for {IDF_TARGET_NAME} is a Wi-Fi network configuration function via Bluetooth channel. It provides a secure protocol to pass Wi-Fi configuration and credentials to {IDF_TARGET_NAME}. Using this information, {IDF_TARGET_NAME} can then connect to an AP or establish a SoftAP. Fragmenting, data encryption, and checksum verification in the BluFi layer are the key elements of this process. @@ -13,7 +10,7 @@ Fragmenting, data encryption, and checksum verification in the BluFi layer are t You can customize symmetric encryption, asymmetric encryption, and checksum support customization. Here we use the DH algorithm for key negotiation, 128-AES algorithm for data encryption, and CRC16 algorithm for checksum verification. The BluFi Flow ---------------- +=============== The BluFi networking flow includes the configuration of the SoftAP and Station. @@ -46,7 +43,7 @@ The following uses Station as an example to illustrate the core parts of the pro 2. The data lengths before and after symmetric encryption/decryption must stay the same. It also supports in-place encryption and decryption. The Flow Chart of BluFi --------------------------- +======================== .. seqdiag:: :caption: BluFi Flow Chart @@ -75,7 +72,7 @@ The Flow Chart of BluFi .. _frame_formats: The Frame Formats Defined in BluFi ------------------------------------ +=================================== The frame formats for the communication between the mobile phone App and {IDF_TARGET_NAME} are defined as follows: @@ -431,7 +428,7 @@ The format of ACK Frame: The **CheckSum** field takes two bytes, which is used to check "sequence + data length + clear text data". The Security Implementation of {IDF_TARGET_NAME} ------------------------------------------------- +================================================= 1. Securing Data @@ -482,7 +479,7 @@ The data to be encrypted and decrypted must be in the same length. The IV8 is an This function is used to compute CheckSum and return a value of CheckSum. BluFi uses the returned value to compare the CheckSum of the frame. GATT Related Instructions -------------------------- +========================== UUID >>>>> diff --git a/docs/en/api-guides/esp-ble-mesh/ble-mesh-architecture.rst b/docs/en/api-guides/ble/esp-ble-mesh/ble-mesh-architecture.rst similarity index 99% rename from docs/en/api-guides/esp-ble-mesh/ble-mesh-architecture.rst rename to docs/en/api-guides/ble/esp-ble-mesh/ble-mesh-architecture.rst index f096c8a797..7d196c604a 100644 --- a/docs/en/api-guides/esp-ble-mesh/ble-mesh-architecture.rst +++ b/docs/en/api-guides/ble/esp-ble-mesh/ble-mesh-architecture.rst @@ -1,5 +1,5 @@ -ESP-BLE-MESH Architecture -========================= +Architecture +============= :link_to_translation:`zh_CN:[中文]` @@ -22,7 +22,7 @@ This document introduces ESP-BLE-MESH architecture overview, ESP-BLE-MESH archit Currently ESP-BLE-MESH has implemented most functions of Mesh Profile and all the Client Models defined in Mesh Model specification. Those missing functions/models are under development and will be provided soon. ESP-BLE-MESH architecture has been granted the official Bluetooth `certification `__. -.. figure:: ../../../_static/esp-ble-mesh-architecture.png +.. figure:: ../../../../_static/esp-ble-mesh-architecture.png :align: center Figure 1.1 ESP-BLE-MESH Architecture Diagram @@ -217,7 +217,7 @@ The design and implementation of ESP-BLE-MESH architecture is based on layers an - **Module-based Approach**: Every file implements an independent function that can be called by other programs. -.. figure:: ../../../_static/esp-ble-mesh-interface.png +.. figure:: ../../../../_static/esp-ble-mesh-interface.png :align: center Figure 2.1 ESP-BLE-MESH Architecture Implementation Diagram diff --git a/docs/en/api-guides/esp-ble-mesh/ble-mesh-faq.rst b/docs/en/api-guides/ble/esp-ble-mesh/ble-mesh-faq.rst similarity index 99% rename from docs/en/api-guides/esp-ble-mesh/ble-mesh-faq.rst rename to docs/en/api-guides/ble/esp-ble-mesh/ble-mesh-faq.rst index e6ed548923..3223670b72 100644 --- a/docs/en/api-guides/esp-ble-mesh/ble-mesh-faq.rst +++ b/docs/en/api-guides/ble/esp-ble-mesh/ble-mesh-faq.rst @@ -1,5 +1,5 @@ -ESP-BLE-MESH FAQ -================ +FAQ +===== :link_to_translation:`zh_CN:[中文]` @@ -532,7 +532,7 @@ Generally, a Provisioner is used to provision unprovisioned devices and form a m .. only:: esp32 - The :doc:`ESP32-DevKitC <../../hw-reference/esp32/get-started-devkitc>` board without PSRAM can run properly but the throughput of it is low since it has no PSRAM. When Bluetooth and Wi-Fi coexist, the throughput of ESP32-DevKitC with PSRAM can be stabilized to more than 1 Mbps. + The :doc:`ESP32-DevKitC <../../../hw-reference/esp32/get-started-devkitc>` board without PSRAM can run properly but the throughput of it is low since it has no PSRAM. When Bluetooth and Wi-Fi coexist, the throughput of ESP32-DevKitC with PSRAM can be stabilized to more than 1 Mbps. Some configurations in menuconfig shall be enabled to support PSRAM. diff --git a/docs/en/api-guides/esp-ble-mesh/ble-mesh-feature-list.rst b/docs/en/api-guides/ble/esp-ble-mesh/ble-mesh-feature-list.rst similarity index 98% rename from docs/en/api-guides/esp-ble-mesh/ble-mesh-feature-list.rst rename to docs/en/api-guides/ble/esp-ble-mesh/ble-mesh-feature-list.rst index f2efc745f9..5955646296 100644 --- a/docs/en/api-guides/esp-ble-mesh/ble-mesh-feature-list.rst +++ b/docs/en/api-guides/ble/esp-ble-mesh/ble-mesh-feature-list.rst @@ -1,5 +1,5 @@ -ESP-BLE-MESH Feature List -========================= +Feature List +============= :link_to_translation:`zh_CN:[中文]` diff --git a/docs/en/api-guides/esp-ble-mesh/ble-mesh-index.rst b/docs/en/api-guides/ble/esp-ble-mesh/ble-mesh-index.rst similarity index 93% rename from docs/en/api-guides/esp-ble-mesh/ble-mesh-index.rst rename to docs/en/api-guides/ble/esp-ble-mesh/ble-mesh-index.rst index b6874b932f..591e00d1b0 100644 --- a/docs/en/api-guides/esp-ble-mesh/ble-mesh-index.rst +++ b/docs/en/api-guides/ble/esp-ble-mesh/ble-mesh-index.rst @@ -1,6 +1,5 @@ -************ -ESP-BLE-MESH -************ +Introduction +============== :link_to_translation:`zh_CN:[中文]` @@ -12,7 +11,7 @@ Bluetooth mesh is not a wireless communications technology, but a networking tec Built on top of Zephyr Bluetooth Mesh stack, the ESP-BLE-MESH implementation supports device provisioning and node control. It also supports such node features as Proxy, Relay, Low power and Friend. -Please see the :doc:`ble-mesh-architecture` for information about the implementation of ESP-BLE-MESH architecture and :doc:`ESP-BLE-MESH API Reference <../../api-reference/bluetooth/esp-ble-mesh>` for information about respective API. +Please see the :doc:`ble-mesh-architecture` for information about the implementation of ESP-BLE-MESH architecture and :doc:`ESP-BLE-MESH API Reference <../../../api-reference/bluetooth/esp-ble-mesh>` for information about respective API. ESP-BLE-MESH is implemented and certified based on the latest Mesh Profile v1.0.1, users can refer `here `_ for the certification details of ESP-BLE-MESH. @@ -20,19 +19,19 @@ ESP-BLE-MESH is implemented and certified based on the latest Mesh Profile v1.0. .. note:: - If you are looking for Wi-Fi based implementation of mesh for {IDF_TARGET_NAME}, please check another product by Espressif called ESP-WIFI-MESH. For more information and documentation see :doc:`ESP-WIFI-MESH <../../api-reference/network/esp-wifi-mesh>`. + If you are looking for Wi-Fi based implementation of mesh for {IDF_TARGET_NAME}, please check another product by Espressif called ESP-WIFI-MESH. For more information and documentation see :doc:`ESP-WIFI-MESH <../../../api-reference/network/esp-wifi-mesh>`. .. _getting-started-with-ble-mesh: -Getting Started with ESP-BLE-MESH -================================= +Getting Started +================= This section is intended to help you get started with ESP-BLE-MESH for the hardware based on the {IDF_TARGET_NAME} chip by Espressif. We are going to demonstrate process of setting and operation of a small ESP-BLE-MESH network of three nodes. This process will cover device provisioning and node configuration, and then sending on/off commands to Generic OnOff Server Models on specific nodes. -If you are new to ESP-IDF, please first set up development environment, compile , flash and run example application following top level ESP-IDF :doc:`../../get-started/index` documentation. +If you are new to ESP-IDF, please first set up development environment, compile , flash and run example application following top level ESP-IDF :doc:`../../../get-started/index` documentation. What You Need @@ -83,7 +82,7 @@ After the :example:`bluetooth/esp_ble_mesh/onoff_models/onoff_server` example is Once boards are powered on, the RGB LED on each board should turn **GREEN**. -.. figure:: ../../../_static/ble-mesh-device-power-on.png +.. figure:: ../../../../_static/ble-mesh-device-power-on.png :align: center ESP-BLE-MESH Devices Power On @@ -98,7 +97,7 @@ In this section, we will use the **nRF Mesh Android** App to demonstrate how to The Scanner is App's functionality to search for unprovisioned devices in range. Open the App, press **Scanner** at the bottom and the search will start. After a short while we should see three unprovisioned devices displayed. -.. figure:: ../../../_static/ble-mesh-scanner.png +.. figure:: ../../../../_static/ble-mesh-scanner.png :align: center :height: 370 @@ -114,7 +113,7 @@ Users can select any unprovisioned device, then the App will try to set up a con After the **IDENTIFY** interface button is pressed, users can see the **PROVISION** interface button. -.. figure:: ../../../_static/ble-mesh-identify-provision.png +.. figure:: ../../../../_static/ble-mesh-identify-provision.png :align: center :height: 370 @@ -132,7 +131,7 @@ Then, the App will try to provision the unprovisioned device. When the device is When all the procedures are finished, the node is configured properly. And after pressing **OK**, users can see that unicast address is assigned, and Composition Data of the node is decoded successfully. -.. figure:: ../../../_static/ble-mesh-config-complete.png +.. figure:: ../../../../_static/ble-mesh-config-complete.png :align: center :height: 370 @@ -140,7 +139,7 @@ When all the procedures are finished, the node is configured properly. And after Sometimes in procedure 2, the App may fail to reconnect with the node. In this case, after pressing **OK**, users can see that only unicast address of the node has been assigned, but no Composition Data has been got. Then users need to press **CONNECT** on the top right, and the previously provisioned node will be displayed on the screen, and users need to choose it and try to connect with the node. -.. figure:: ../../../_static/ble-mesh-initial-config-fail.png +.. figure:: ../../../../_static/ble-mesh-initial-config-fail.png :align: center :height: 370 @@ -148,7 +147,7 @@ Sometimes in procedure 2, the App may fail to reconnect with the node. In this c After connecting successfully, the App will show the interface buttons which can be used to get Composition Data and add AppKey. -.. figure:: ../../../_static/ble-mesh-reconnect-initial-config.png +.. figure:: ../../../../_static/ble-mesh-reconnect-initial-config.png :align: center :height: 370 @@ -161,7 +160,7 @@ Here an example of three devices listed. * The left picture shows that the third device is provisioned successfully, but the App failed to connect with it. When it tries to reconnect with the third node, three nodes are displayed on the App. * The right picture shows that after connecting with any node successfully, the App displays the information of the three nodes. Users can see that the App has got the Composition Data of the first and the second nodes, but for the third one, only the unicast address has been assigned to it while the Composition Data is unknown. -.. figure:: ../../../_static/ble-mesh-reconnect-three.png +.. figure:: ../../../../_static/ble-mesh-reconnect-three.png :align: center :height: 370 @@ -174,7 +173,7 @@ When provisioning and initial configuration are finished, users can start to con Example below shows how to bind AppKey with Generic OnOff Server Model within the Primary Element. -.. figure:: ../../../_static/ble-mesh-model-bind-appkey.png +.. figure:: ../../../../_static/ble-mesh-model-bind-appkey.png :align: center :height: 370 @@ -191,7 +190,7 @@ After all the Generic OnOff Server Models within the three elements are bound wi In the :example:`bluetooth/esp_ble_mesh/onoff_models/onoff_server` example, the first Generic OnOff Server Model is used to control the **RED** color, the second one is used to control the **GREEN** color and the third one is used to control the **BLUE** color. -.. figure:: ../../../_static/ble-mesh-generic-onoff.png +.. figure:: ../../../../_static/ble-mesh-generic-onoff.png :align: center :height: 370 @@ -199,7 +198,7 @@ In the :example:`bluetooth/esp_ble_mesh/onoff_models/onoff_server` example, the The following screenshot shows different board with different color on. -.. figure:: ../../../_static/ble-mesh-three-nodes-on.png +.. figure:: ../../../../_static/ble-mesh-three-nodes-on.png :align: center Three ESP-BLE-MESH Nodes On @@ -210,8 +209,8 @@ The following screenshot shows different board with different color on. .. _esp-ble-mesh-examples: -ESP-BLE-MESH Examples -===================== +Examples +========= * :example_file:`OnOff Server ` - shows the use of ESP-BLE-MESH as a node having a Configuration Server model and a Generic OnOff Server model. A ESP-BLE-MESH Provisioner can then provision the unprovisioned device and control a RGB LED representing on/off state, see :example:`example code `. @@ -230,15 +229,15 @@ ESP-BLE-MESH Examples .. _esp-ble-mesh-demo-videos: -ESP-BLE-MESH Demo Videos -======================== +Demo Videos +============ * `Espressif Fast Provisioning using ESP-BLE-MESH App `_ * `Espressif ESP-BLE-MESH and Wi-Fi Coexistence `_ -ESP-BLE-MESH FAQ -================ +FAQ +==== * :ref:`ble-mesh-faq-provisioner-development` * :ref:`ble-mesh-faq-node-development` @@ -253,7 +252,7 @@ Related Documents ================= .. toctree:: - :maxdepth: 1 + :maxdepth: 2 ble-mesh-feature-list ble-mesh-architecture diff --git a/docs/en/api-guides/esp-ble-mesh/ble-mesh-terminology.rst b/docs/en/api-guides/ble/esp-ble-mesh/ble-mesh-terminology.rst similarity index 99% rename from docs/en/api-guides/esp-ble-mesh/ble-mesh-terminology.rst rename to docs/en/api-guides/ble/esp-ble-mesh/ble-mesh-terminology.rst index d6ab0031e3..fdf4dbdf5a 100644 --- a/docs/en/api-guides/esp-ble-mesh/ble-mesh-terminology.rst +++ b/docs/en/api-guides/ble/esp-ble-mesh/ble-mesh-terminology.rst @@ -1,5 +1,5 @@ -ESP-BLE-MESH Terminology -======================== +Terminology +============ :link_to_translation:`zh_CN:[中文]` diff --git a/docs/en/api-guides/ble/index.rst b/docs/en/api-guides/ble/index.rst index 4896107669..f39237ac3d 100644 --- a/docs/en/api-guides/ble/index.rst +++ b/docs/en/api-guides/ble/index.rst @@ -1,10 +1,48 @@ -Bluetooth® Low Energy (Bluetooth LE) -==================================== +####################### +Bluetooth® Low Energy +####################### + :link_to_translation:`zh_CN:[中文]` +********* Overview --------- +********* .. toctree:: :maxdepth: 1 overview + +********** +Profile +********** + +.. only:: SOC_BLE_MESH_SUPPORTED + + ESP-BLE-MESH + ^^^^^^^^^^^^^ + + - See the :ref:`ESP-BLE-MESH ` section. + +.. only:: SOC_BLUFI_SUPPORTED + + BluFi + ^^^^^ + + .. toctree:: + :maxdepth: 1 + + blufi + + +.. only:: SOC_BLE_MESH_SUPPORTED + + .. _mesh: + + ************* + ESP-BLE-MESH + ************* + + .. toctree:: + :maxdepth: 2 + + esp-ble-mesh/ble-mesh-index diff --git a/docs/en/api-guides/ble/overview.rst b/docs/en/api-guides/ble/overview.rst index 44d3f648d1..94572fdb41 100644 --- a/docs/en/api-guides/ble/overview.rst +++ b/docs/en/api-guides/ble/overview.rst @@ -1,5 +1,5 @@ Introduction ------------- +============= :link_to_translation:`zh_CN:[中文]` @@ -175,7 +175,7 @@ Above the host stacks are the profile implementations by Espressif and some comm Built on top of Zephyr Bluetooth Mesh stack, the ESP-BLE-MESH implementation supports device provisioning and node control. It also supports such node features as Proxy, Relay, Low power and Friend. - - :doc:`ESP-BLE-MESH documentation <../esp-ble-mesh/ble-mesh-index>`: feature list, get started, architecture, description of application examples, frequently asked questions, etc. + - :doc:`ESP-BLE-MESH documentation `: feature list, get started, architecture, description of application examples, frequently asked questions, etc. - :example:`Application examples ` @@ -186,7 +186,7 @@ Above the host stacks are the profile implementations by Espressif and some comm The BluFi for {IDF_TARGET_NAME} is a Wi-Fi network configuration function via Bluetooth channel. It provides a secure protocol to pass Wi-Fi configuration and credentials to {IDF_TARGET_NAME}. Using this information, {IDF_TARGET_NAME} can then connect to an AP or establish a softAP. - - :doc:`BluFi documentation <../blufi>` + - :doc:`BluFi documentation ` - :example:`Application examples ` diff --git a/docs/en/api-guides/index.rst b/docs/en/api-guides/index.rst index 14b527a92a..011537284c 100644 --- a/docs/en/api-guides/index.rst +++ b/docs/en/api-guides/index.rst @@ -7,7 +7,6 @@ API Guides app_trace startup - :SOC_BLUFI_SUPPORTED: blufi :SOC_BLE_SUPPORTED: ble/index bootloader build-system @@ -20,7 +19,6 @@ API Guides :SOC_RTC_MEM_SUPPORTED: deep-sleep-stub :SOC_USB_OTG_SUPPORTED and not esp32p4: dfu error-handling - :SOC_BLE_MESH_SUPPORTED: esp-ble-mesh/ble-mesh-index :SOC_WIFI_MESH_SUPPORT: esp-wifi-mesh :SOC_SPIRAM_SUPPORTED: external-ram fatal-errors diff --git a/docs/en/api-reference/bluetooth/esp-ble-mesh.rst b/docs/en/api-reference/bluetooth/esp-ble-mesh.rst index 74cc7cdb89..138c4d88fa 100644 --- a/docs/en/api-reference/bluetooth/esp-ble-mesh.rst +++ b/docs/en/api-reference/bluetooth/esp-ble-mesh.rst @@ -11,7 +11,7 @@ For an ESP32 to join and work on a ESP-BLE-MESH network, it must be provisioned Apart from ESP-BLE-MESH nodes, inside ESP-BLE-MESH network, there is also ESP32 that works as ESP-BLE-MESH provisioner, which could provision unprovisioned devices into ESP-BLE-MESH nodes and configure the nodes with various features. -For information how to start using ESP32 and ESP-BLE-MESH, please see the Section :ref:`getting-started-with-ble-mesh`. If you are interested in information on ESP-BLE-MESH architecture, including some details of software implementation, please see Section :doc:`../../api-guides/esp-ble-mesh/ble-mesh-architecture`. +For information how to start using ESP32 and ESP-BLE-MESH, please see the Section :ref:`getting-started-with-ble-mesh`. If you are interested in information on ESP-BLE-MESH architecture, including some details of software implementation, please see Section :doc:`../../api-guides/ble/esp-ble-mesh/ble-mesh-architecture`. Application Examples and Demos @@ -225,4 +225,3 @@ Composition and Metadata ^^^^^^^^^^^^^^^^^^^^^^^^ .. include-build-file:: inc/esp_ble_mesh_cm_data_api.inc - From 8379a45f4d1323185ea7a3063d064c7908bff571 Mon Sep 17 00:00:00 2001 From: Yuhan Wei Date: Tue, 23 Jul 2024 17:19:32 +0800 Subject: [PATCH 04/14] docs(ble): Moved blufi to ble folder --- docs/conf_common.py | 10 +++--- docs/en/api-guides/ble/index.rst | 16 +-------- docs/en/api-guides/ble/overview.rst | 2 +- .../esp-ble-mesh/ble-mesh-architecture.rst | 4 +-- .../{ble => }/esp-ble-mesh/ble-mesh-faq.rst | 0 .../esp-ble-mesh/ble-mesh-feature-list.rst | 0 .../{ble => }/esp-ble-mesh/ble-mesh-index.rst | 33 +++++++++--------- .../esp-ble-mesh/ble-mesh-terminology.rst | 0 docs/en/api-guides/index.rst | 1 + .../api-reference/bluetooth/esp-ble-mesh.rst | 2 +- docs/zh_CN/api-guides/{ => ble}/blufi.rst | 0 docs/zh_CN/api-guides/ble/index.rst | 34 ++++++++++++++++--- docs/zh_CN/api-guides/ble/overview.rst | 2 +- docs/zh_CN/api-guides/index.rst | 3 +- 14 files changed, 59 insertions(+), 48 deletions(-) rename docs/en/api-guides/{ble => }/esp-ble-mesh/ble-mesh-architecture.rst (99%) rename docs/en/api-guides/{ble => }/esp-ble-mesh/ble-mesh-faq.rst (100%) rename docs/en/api-guides/{ble => }/esp-ble-mesh/ble-mesh-feature-list.rst (100%) rename docs/en/api-guides/{ble => }/esp-ble-mesh/ble-mesh-index.rst (94%) rename docs/en/api-guides/{ble => }/esp-ble-mesh/ble-mesh-terminology.rst (100%) rename docs/zh_CN/api-guides/{ => ble}/blufi.rst (100%) diff --git a/docs/conf_common.py b/docs/conf_common.py index b8f7249a53..abfd1b9e61 100644 --- a/docs/conf_common.py +++ b/docs/conf_common.py @@ -34,11 +34,11 @@ BLE_DOCS = ['api-reference/bluetooth/bt_le.rst', 'migration-guides/release-5.x/5.0/bluetooth-low-energy.rst'] -BLE_MESH_DOCS = ['api-guides/ble/esp-ble-mesh/ble-mesh-index.rst', - 'api-guides/ble/esp-ble-mesh/ble-mesh-feature-list.rst', - 'api-guides/ble/esp-ble-mesh/ble-mesh-terminology.rst', - 'api-guides/ble/esp-ble-mesh/ble-mesh-architecture.rst', - 'api-guides/ble/esp-ble-mesh/ble-mesh-faq.rst', +BLE_MESH_DOCS = ['api-guides/esp-ble-mesh/ble-mesh-index.rst', + 'api-guides/esp-ble-mesh/ble-mesh-feature-list.rst', + 'api-guides/esp-ble-mesh/ble-mesh-terminology.rst', + 'api-guides/esp-ble-mesh/ble-mesh-architecture.rst', + 'api-guides/esp-ble-mesh/ble-mesh-faq.rst', 'api-reference/bluetooth/esp-ble-mesh.rst'] CLASSIC_BT_DOCS = ['api-reference/bluetooth/classic_bt.rst', diff --git a/docs/en/api-guides/ble/index.rst b/docs/en/api-guides/ble/index.rst index f39237ac3d..85f20303cd 100644 --- a/docs/en/api-guides/ble/index.rst +++ b/docs/en/api-guides/ble/index.rst @@ -21,7 +21,7 @@ Profile ESP-BLE-MESH ^^^^^^^^^^^^^ - - See the :ref:`ESP-BLE-MESH ` section. + - See the :doc:`ESP-BLE-MESH documentation <../esp-ble-mesh/ble-mesh-index>`. .. only:: SOC_BLUFI_SUPPORTED @@ -32,17 +32,3 @@ Profile :maxdepth: 1 blufi - - -.. only:: SOC_BLE_MESH_SUPPORTED - - .. _mesh: - - ************* - ESP-BLE-MESH - ************* - - .. toctree:: - :maxdepth: 2 - - esp-ble-mesh/ble-mesh-index diff --git a/docs/en/api-guides/ble/overview.rst b/docs/en/api-guides/ble/overview.rst index 94572fdb41..37e04f5f4b 100644 --- a/docs/en/api-guides/ble/overview.rst +++ b/docs/en/api-guides/ble/overview.rst @@ -175,7 +175,7 @@ Above the host stacks are the profile implementations by Espressif and some comm Built on top of Zephyr Bluetooth Mesh stack, the ESP-BLE-MESH implementation supports device provisioning and node control. It also supports such node features as Proxy, Relay, Low power and Friend. - - :doc:`ESP-BLE-MESH documentation `: feature list, get started, architecture, description of application examples, frequently asked questions, etc. + - :doc:`ESP-BLE-MESH documentation <../esp-ble-mesh/ble-mesh-index>`: feature list, get started, architecture, description of application examples, frequently asked questions, etc. - :example:`Application examples ` diff --git a/docs/en/api-guides/ble/esp-ble-mesh/ble-mesh-architecture.rst b/docs/en/api-guides/esp-ble-mesh/ble-mesh-architecture.rst similarity index 99% rename from docs/en/api-guides/ble/esp-ble-mesh/ble-mesh-architecture.rst rename to docs/en/api-guides/esp-ble-mesh/ble-mesh-architecture.rst index 7d196c604a..64f1e09636 100644 --- a/docs/en/api-guides/ble/esp-ble-mesh/ble-mesh-architecture.rst +++ b/docs/en/api-guides/esp-ble-mesh/ble-mesh-architecture.rst @@ -22,7 +22,7 @@ This document introduces ESP-BLE-MESH architecture overview, ESP-BLE-MESH archit Currently ESP-BLE-MESH has implemented most functions of Mesh Profile and all the Client Models defined in Mesh Model specification. Those missing functions/models are under development and will be provided soon. ESP-BLE-MESH architecture has been granted the official Bluetooth `certification `__. -.. figure:: ../../../../_static/esp-ble-mesh-architecture.png +.. figure:: ../../../_static/esp-ble-mesh-architecture.png :align: center Figure 1.1 ESP-BLE-MESH Architecture Diagram @@ -217,7 +217,7 @@ The design and implementation of ESP-BLE-MESH architecture is based on layers an - **Module-based Approach**: Every file implements an independent function that can be called by other programs. -.. figure:: ../../../../_static/esp-ble-mesh-interface.png +.. figure:: ../../../_static/esp-ble-mesh-interface.png :align: center Figure 2.1 ESP-BLE-MESH Architecture Implementation Diagram diff --git a/docs/en/api-guides/ble/esp-ble-mesh/ble-mesh-faq.rst b/docs/en/api-guides/esp-ble-mesh/ble-mesh-faq.rst similarity index 100% rename from docs/en/api-guides/ble/esp-ble-mesh/ble-mesh-faq.rst rename to docs/en/api-guides/esp-ble-mesh/ble-mesh-faq.rst diff --git a/docs/en/api-guides/ble/esp-ble-mesh/ble-mesh-feature-list.rst b/docs/en/api-guides/esp-ble-mesh/ble-mesh-feature-list.rst similarity index 100% rename from docs/en/api-guides/ble/esp-ble-mesh/ble-mesh-feature-list.rst rename to docs/en/api-guides/esp-ble-mesh/ble-mesh-feature-list.rst diff --git a/docs/en/api-guides/ble/esp-ble-mesh/ble-mesh-index.rst b/docs/en/api-guides/esp-ble-mesh/ble-mesh-index.rst similarity index 94% rename from docs/en/api-guides/ble/esp-ble-mesh/ble-mesh-index.rst rename to docs/en/api-guides/esp-ble-mesh/ble-mesh-index.rst index 591e00d1b0..7144342bcc 100644 --- a/docs/en/api-guides/ble/esp-ble-mesh/ble-mesh-index.rst +++ b/docs/en/api-guides/esp-ble-mesh/ble-mesh-index.rst @@ -1,5 +1,6 @@ -Introduction -============== +************ +ESP-BLE-MESH +************ :link_to_translation:`zh_CN:[中文]` @@ -11,7 +12,7 @@ Bluetooth mesh is not a wireless communications technology, but a networking tec Built on top of Zephyr Bluetooth Mesh stack, the ESP-BLE-MESH implementation supports device provisioning and node control. It also supports such node features as Proxy, Relay, Low power and Friend. -Please see the :doc:`ble-mesh-architecture` for information about the implementation of ESP-BLE-MESH architecture and :doc:`ESP-BLE-MESH API Reference <../../../api-reference/bluetooth/esp-ble-mesh>` for information about respective API. +Please see the :doc:`ble-mesh-architecture` for information about the implementation of ESP-BLE-MESH architecture and :doc:`ESP-BLE-MESH API Reference <../../api-reference/bluetooth/esp-ble-mesh>` for information about respective API. ESP-BLE-MESH is implemented and certified based on the latest Mesh Profile v1.0.1, users can refer `here `_ for the certification details of ESP-BLE-MESH. @@ -19,19 +20,19 @@ ESP-BLE-MESH is implemented and certified based on the latest Mesh Profile v1.0. .. note:: - If you are looking for Wi-Fi based implementation of mesh for {IDF_TARGET_NAME}, please check another product by Espressif called ESP-WIFI-MESH. For more information and documentation see :doc:`ESP-WIFI-MESH <../../../api-reference/network/esp-wifi-mesh>`. + If you are looking for Wi-Fi based implementation of mesh for {IDF_TARGET_NAME}, please check another product by Espressif called ESP-WIFI-MESH. For more information and documentation see :doc:`ESP-WIFI-MESH <../../api-reference/network/esp-wifi-mesh>`. .. _getting-started-with-ble-mesh: -Getting Started +Getting Started ================= This section is intended to help you get started with ESP-BLE-MESH for the hardware based on the {IDF_TARGET_NAME} chip by Espressif. We are going to demonstrate process of setting and operation of a small ESP-BLE-MESH network of three nodes. This process will cover device provisioning and node configuration, and then sending on/off commands to Generic OnOff Server Models on specific nodes. -If you are new to ESP-IDF, please first set up development environment, compile , flash and run example application following top level ESP-IDF :doc:`../../../get-started/index` documentation. +If you are new to ESP-IDF, please first set up development environment, compile , flash and run example application following top level ESP-IDF :doc:`../../get-started/index` documentation. What You Need @@ -82,7 +83,7 @@ After the :example:`bluetooth/esp_ble_mesh/onoff_models/onoff_server` example is Once boards are powered on, the RGB LED on each board should turn **GREEN**. -.. figure:: ../../../../_static/ble-mesh-device-power-on.png +.. figure:: ../../../_static/ble-mesh-device-power-on.png :align: center ESP-BLE-MESH Devices Power On @@ -97,7 +98,7 @@ In this section, we will use the **nRF Mesh Android** App to demonstrate how to The Scanner is App's functionality to search for unprovisioned devices in range. Open the App, press **Scanner** at the bottom and the search will start. After a short while we should see three unprovisioned devices displayed. -.. figure:: ../../../../_static/ble-mesh-scanner.png +.. figure:: ../../../_static/ble-mesh-scanner.png :align: center :height: 370 @@ -113,7 +114,7 @@ Users can select any unprovisioned device, then the App will try to set up a con After the **IDENTIFY** interface button is pressed, users can see the **PROVISION** interface button. -.. figure:: ../../../../_static/ble-mesh-identify-provision.png +.. figure:: ../../../_static/ble-mesh-identify-provision.png :align: center :height: 370 @@ -131,7 +132,7 @@ Then, the App will try to provision the unprovisioned device. When the device is When all the procedures are finished, the node is configured properly. And after pressing **OK**, users can see that unicast address is assigned, and Composition Data of the node is decoded successfully. -.. figure:: ../../../../_static/ble-mesh-config-complete.png +.. figure:: ../../../_static/ble-mesh-config-complete.png :align: center :height: 370 @@ -139,7 +140,7 @@ When all the procedures are finished, the node is configured properly. And after Sometimes in procedure 2, the App may fail to reconnect with the node. In this case, after pressing **OK**, users can see that only unicast address of the node has been assigned, but no Composition Data has been got. Then users need to press **CONNECT** on the top right, and the previously provisioned node will be displayed on the screen, and users need to choose it and try to connect with the node. -.. figure:: ../../../../_static/ble-mesh-initial-config-fail.png +.. figure:: ../../../_static/ble-mesh-initial-config-fail.png :align: center :height: 370 @@ -147,7 +148,7 @@ Sometimes in procedure 2, the App may fail to reconnect with the node. In this c After connecting successfully, the App will show the interface buttons which can be used to get Composition Data and add AppKey. -.. figure:: ../../../../_static/ble-mesh-reconnect-initial-config.png +.. figure:: ../../../_static/ble-mesh-reconnect-initial-config.png :align: center :height: 370 @@ -160,7 +161,7 @@ Here an example of three devices listed. * The left picture shows that the third device is provisioned successfully, but the App failed to connect with it. When it tries to reconnect with the third node, three nodes are displayed on the App. * The right picture shows that after connecting with any node successfully, the App displays the information of the three nodes. Users can see that the App has got the Composition Data of the first and the second nodes, but for the third one, only the unicast address has been assigned to it while the Composition Data is unknown. -.. figure:: ../../../../_static/ble-mesh-reconnect-three.png +.. figure:: ../../../_static/ble-mesh-reconnect-three.png :align: center :height: 370 @@ -173,7 +174,7 @@ When provisioning and initial configuration are finished, users can start to con Example below shows how to bind AppKey with Generic OnOff Server Model within the Primary Element. -.. figure:: ../../../../_static/ble-mesh-model-bind-appkey.png +.. figure:: ../../../_static/ble-mesh-model-bind-appkey.png :align: center :height: 370 @@ -190,7 +191,7 @@ After all the Generic OnOff Server Models within the three elements are bound wi In the :example:`bluetooth/esp_ble_mesh/onoff_models/onoff_server` example, the first Generic OnOff Server Model is used to control the **RED** color, the second one is used to control the **GREEN** color and the third one is used to control the **BLUE** color. -.. figure:: ../../../../_static/ble-mesh-generic-onoff.png +.. figure:: ../../../_static/ble-mesh-generic-onoff.png :align: center :height: 370 @@ -198,7 +199,7 @@ In the :example:`bluetooth/esp_ble_mesh/onoff_models/onoff_server` example, the The following screenshot shows different board with different color on. -.. figure:: ../../../../_static/ble-mesh-three-nodes-on.png +.. figure:: ../../../_static/ble-mesh-three-nodes-on.png :align: center Three ESP-BLE-MESH Nodes On diff --git a/docs/en/api-guides/ble/esp-ble-mesh/ble-mesh-terminology.rst b/docs/en/api-guides/esp-ble-mesh/ble-mesh-terminology.rst similarity index 100% rename from docs/en/api-guides/ble/esp-ble-mesh/ble-mesh-terminology.rst rename to docs/en/api-guides/esp-ble-mesh/ble-mesh-terminology.rst diff --git a/docs/en/api-guides/index.rst b/docs/en/api-guides/index.rst index 011537284c..4e7e40aa8c 100644 --- a/docs/en/api-guides/index.rst +++ b/docs/en/api-guides/index.rst @@ -8,6 +8,7 @@ API Guides app_trace startup :SOC_BLE_SUPPORTED: ble/index + :SOC_BLE_MESH_SUPPORTED: esp-ble-mesh/ble-mesh-index bootloader build-system :SOC_SUPPORT_COEXISTENCE: coexist diff --git a/docs/en/api-reference/bluetooth/esp-ble-mesh.rst b/docs/en/api-reference/bluetooth/esp-ble-mesh.rst index 138c4d88fa..bf03a8fe79 100644 --- a/docs/en/api-reference/bluetooth/esp-ble-mesh.rst +++ b/docs/en/api-reference/bluetooth/esp-ble-mesh.rst @@ -11,7 +11,7 @@ For an ESP32 to join and work on a ESP-BLE-MESH network, it must be provisioned Apart from ESP-BLE-MESH nodes, inside ESP-BLE-MESH network, there is also ESP32 that works as ESP-BLE-MESH provisioner, which could provision unprovisioned devices into ESP-BLE-MESH nodes and configure the nodes with various features. -For information how to start using ESP32 and ESP-BLE-MESH, please see the Section :ref:`getting-started-with-ble-mesh`. If you are interested in information on ESP-BLE-MESH architecture, including some details of software implementation, please see Section :doc:`../../api-guides/ble/esp-ble-mesh/ble-mesh-architecture`. +For information how to start using ESP32 and ESP-BLE-MESH, please see the Section :ref:`getting-started-with-ble-mesh`. If you are interested in information on ESP-BLE-MESH architecture, including some details of software implementation, please see Section :doc:`../../api-guides/esp-ble-mesh/ble-mesh-architecture`. Application Examples and Demos diff --git a/docs/zh_CN/api-guides/blufi.rst b/docs/zh_CN/api-guides/ble/blufi.rst similarity index 100% rename from docs/zh_CN/api-guides/blufi.rst rename to docs/zh_CN/api-guides/ble/blufi.rst diff --git a/docs/zh_CN/api-guides/ble/index.rst b/docs/zh_CN/api-guides/ble/index.rst index 0d581546b1..08301dac17 100644 --- a/docs/zh_CN/api-guides/ble/index.rst +++ b/docs/zh_CN/api-guides/ble/index.rst @@ -1,10 +1,34 @@ -蓝牙® -========= -:link_to_translation:`en:[English]` +################ +低功耗蓝牙® +################ -概述 --------- +:link_to_translation:`zh_CN:[中文]` + +***** +概览 +***** .. toctree:: :maxdepth: 1 overview + +********** +蓝牙规范 +********** + +.. only:: SOC_BLE_MESH_SUPPORTED + + ESP-BLE-MESH + ^^^^^^^^^^^^^ + + - See the :doc:`ESP-BLE-MESH documentation <../esp-ble-mesh/ble-mesh-index>`. + +.. only:: SOC_BLUFI_SUPPORTED + + BluFi + ^^^^^ + + .. toctree:: + :maxdepth: 1 + + blufi diff --git a/docs/zh_CN/api-guides/ble/overview.rst b/docs/zh_CN/api-guides/ble/overview.rst index a2d7a980b8..aacc40b68a 100644 --- a/docs/zh_CN/api-guides/ble/overview.rst +++ b/docs/zh_CN/api-guides/ble/overview.rst @@ -186,7 +186,7 @@ ESP-NimBLE 仅支持低功耗蓝牙，不支持经典蓝牙。 {IDF_TARGET_NAME} 的 BluFi 是通过蓝牙信道进行的 Wi-Fi 网络配置功能。BluFi 提供了将 Wi-Fi 配置和凭据传递给 {IDF_TARGET_NAME} 的安全协议，从而使 {IDF_TARGET_NAME} 连接到 AP 或搭建软 AP。 - - :doc:`BluFi 文档 <../blufi>` + - :doc:`BluFi 文档 ` - :example:`应用示例 ` diff --git a/docs/zh_CN/api-guides/index.rst b/docs/zh_CN/api-guides/index.rst index 953a4f42ff..3f49d592b6 100644 --- a/docs/zh_CN/api-guides/index.rst +++ b/docs/zh_CN/api-guides/index.rst @@ -7,8 +7,8 @@ API 指南 app_trace startup - :SOC_BLUFI_SUPPORTED: blufi :SOC_BLE_SUPPORTED: ble/index + :SOC_BLE_MESH_SUPPORTED: esp-ble-mesh/ble-mesh-index bootloader build-system :SOC_SUPPORT_COEXISTENCE: coexist @@ -20,7 +20,6 @@ API 指南 :SOC_RTC_MEM_SUPPORTED: deep-sleep-stub :SOC_USB_OTG_SUPPORTED and not esp32p4: dfu error-handling - :SOC_BLE_MESH_SUPPORTED: esp-ble-mesh/ble-mesh-index :SOC_WIFI_MESH_SUPPORT: esp-wifi-mesh :SOC_SPIRAM_SUPPORTED: external-ram fatal-errors From 2030b83b1a547fde20cfcd6214e981f72fc5cd84 Mon Sep 17 00:00:00 2001 From: Yuhan Wei Date: Wed, 24 Jul 2024 10:19:27 +0800 Subject: [PATCH 05/14] docs(ble): Reduced the toctree depth for Related Documents --- docs/en/api-guides/esp-ble-mesh/ble-mesh-index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/api-guides/esp-ble-mesh/ble-mesh-index.rst b/docs/en/api-guides/esp-ble-mesh/ble-mesh-index.rst index 7144342bcc..402dfb008c 100644 --- a/docs/en/api-guides/esp-ble-mesh/ble-mesh-index.rst +++ b/docs/en/api-guides/esp-ble-mesh/ble-mesh-index.rst @@ -253,7 +253,7 @@ Related Documents ================= .. toctree:: - :maxdepth: 2 + :maxdepth: 1 ble-mesh-feature-list ble-mesh-architecture From 95f9bf8e64a92bfce839f6d04763330473d389bd Mon Sep 17 00:00:00 2001 From: Yuhan Wei Date: Wed, 24 Jul 2024 11:06:09 +0800 Subject: [PATCH 06/14] docs(ble): Make the section name consistent for the zh_CN and eng versions --- docs/zh_CN/api-guides/ble/overview.rst | 4 ++-- .../api-guides/esp-ble-mesh/ble-mesh-index.rst | 16 ++++++++-------- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/zh_CN/api-guides/ble/overview.rst b/docs/zh_CN/api-guides/ble/overview.rst index aacc40b68a..80392861eb 100644 --- a/docs/zh_CN/api-guides/ble/overview.rst +++ b/docs/zh_CN/api-guides/ble/overview.rst @@ -114,8 +114,8 @@ ESP 蓝牙控制器 - :example:`应用示例 ` -主机 ----- +ESP 蓝牙主机 +------------- 有 ESP-Bluedroid 和 ESP-NimBLE 两个主机，其主要区别如下： diff --git a/docs/zh_CN/api-guides/esp-ble-mesh/ble-mesh-index.rst b/docs/zh_CN/api-guides/esp-ble-mesh/ble-mesh-index.rst index 274c0cd879..ce5218b00a 100644 --- a/docs/zh_CN/api-guides/esp-ble-mesh/ble-mesh-index.rst +++ b/docs/zh_CN/api-guides/esp-ble-mesh/ble-mesh-index.rst @@ -25,8 +25,8 @@ ESP-BLE-MESH 的实现和认证基于最新的 `Mesh Profile v1.0.1 ` - 展示了将 ESP-BLE-MESH 作为拥有 Configuration Server model 和 Generic OnOff Server model 的节点设备的用法。然后，ESP-BLE-MESH Provisioner 可以配网设备，控制表示开/关状态的 RGB 灯，示例请见 :example:`example code `。 @@ -230,15 +230,15 @@ ESP-BLE-MESH 示例 .. _esp-ble-mesh-demo-videos: -ESP-BLE-MESH 演示视频 -====================== +演示视频 +======== * `Espressif Fast Provisioning using ESP-BLE-MESH App `_ * `Espressif ESP-BLE-MESH and Wi-Fi Coexistence `_ -ESP-BLE-MESH 常见问题手册 -========================= +常见问题手册 +=========== * :ref:`ble-mesh-faq-provisioner-development` * :ref:`ble-mesh-faq-node-development` From dc6f1503c2c3287ab4a923842d0a70a3c25e97d3 Mon Sep 17 00:00:00 2001 From: Yuhan Wei Date: Wed, 24 Jul 2024 16:22:53 +0800 Subject: [PATCH 07/14] docs(ble): Modified the table of content in ble/index.rst --- docs/en/api-guides/ble/index.rst | 19 ++++------------- docs/zh_CN/api-guides/ble/blufi.rst | 12 +++++------ docs/zh_CN/api-guides/ble/index.rst | 21 +++++-------------- .../esp-ble-mesh/ble-mesh-index.rst | 2 +- 4 files changed, 16 insertions(+), 38 deletions(-) diff --git a/docs/en/api-guides/ble/index.rst b/docs/en/api-guides/ble/index.rst index 85f20303cd..88c0599b9a 100644 --- a/docs/en/api-guides/ble/index.rst +++ b/docs/en/api-guides/ble/index.rst @@ -16,19 +16,8 @@ Overview Profile ********** -.. only:: SOC_BLE_MESH_SUPPORTED +.. toctree:: + :maxdepth: 2 - ESP-BLE-MESH - ^^^^^^^^^^^^^ - - - See the :doc:`ESP-BLE-MESH documentation <../esp-ble-mesh/ble-mesh-index>`. - -.. only:: SOC_BLUFI_SUPPORTED - - BluFi - ^^^^^ - - .. toctree:: - :maxdepth: 1 - - blufi + :SOC_BLE_MESH_SUPPORTED: ../esp-ble-mesh/ble-mesh-index + :SOC_BLUFI_SUPPORTED: blufi diff --git a/docs/zh_CN/api-guides/ble/blufi.rst b/docs/zh_CN/api-guides/ble/blufi.rst index 4478385e27..33737b6298 100644 --- a/docs/zh_CN/api-guides/ble/blufi.rst +++ b/docs/zh_CN/api-guides/ble/blufi.rst @@ -1,10 +1,10 @@ BluFi -^^^^^ +^^^^^^ :link_to_translation:`en:[English]` 概览 ------ +-------- BluFi 是一项基于蓝牙通道的 Wi-Fi 网络配置功能，适用于 {IDF_TARGET_NAME}。它通过安全协议将 Wi-Fi 的 SSID、密码等配置信息传输到 {IDF_TARGET_NAME}。基于这些信息，{IDF_TARGET_NAME} 可进而连接到 AP 或建立 SoftAP。 @@ -13,7 +13,7 @@ BluFi 流程的关键部分包括数据的分片、加密以及校验和验证 用户可按需自定义用于对称加密、非对称加密以及校验的算法。此处，我们采用 DH 算法进行密钥协商，128-AES 算法用于数据加密，CRC16 算法用于校验和验证。 BluFi 流程 ----------- +----------- BluFi 配网流程包含配置 SoftAP 和配置 Station 两部分。 @@ -46,7 +46,7 @@ BluFi 配网流程包含配置 SoftAP 和配置 Station 两部分。 2. 进行对称加密和解密时，加密和解密前后的数据长度必须一致。支持原地加密和解密。 BluFi 流程图 ---------------- +------------ .. seqdiag:: :caption: BluFi Flow Chart @@ -75,7 +75,7 @@ BluFi 流程图 .. _frame_formats: BluFi 中定义的帧格式 ----------------------------- +--------------------- 手机应用程序与 {IDF_TARGET_NAME} 之间的 BluFi 通信格式定义如下： @@ -431,7 +431,7 @@ ACK 帧格式 (8 bit)： 此字段占两个字节，用来校验序列、数据长度以及明文。 {IDF_TARGET_NAME} 端的安全实现 ----------------------------------- +----------------------------- 1. 数据安全 diff --git a/docs/zh_CN/api-guides/ble/index.rst b/docs/zh_CN/api-guides/ble/index.rst index 08301dac17..fc141f0396 100644 --- a/docs/zh_CN/api-guides/ble/index.rst +++ b/docs/zh_CN/api-guides/ble/index.rst @@ -2,7 +2,7 @@ 低功耗蓝牙® ################ -:link_to_translation:`zh_CN:[中文]` +:link_to_translation:`en:[English]` ***** 概览 @@ -16,19 +16,8 @@ 蓝牙规范 ********** -.. only:: SOC_BLE_MESH_SUPPORTED +.. toctree:: + :maxdepth: 2 - ESP-BLE-MESH - ^^^^^^^^^^^^^ - - - See the :doc:`ESP-BLE-MESH documentation <../esp-ble-mesh/ble-mesh-index>`. - -.. only:: SOC_BLUFI_SUPPORTED - - BluFi - ^^^^^ - - .. toctree:: - :maxdepth: 1 - - blufi + :SOC_BLE_MESH_SUPPORTED: ../esp-ble-mesh/ble-mesh-index + :SOC_BLUFI_SUPPORTED: blufi diff --git a/docs/zh_CN/api-guides/esp-ble-mesh/ble-mesh-index.rst b/docs/zh_CN/api-guides/esp-ble-mesh/ble-mesh-index.rst index ce5218b00a..b0b7671782 100644 --- a/docs/zh_CN/api-guides/esp-ble-mesh/ble-mesh-index.rst +++ b/docs/zh_CN/api-guides/esp-ble-mesh/ble-mesh-index.rst @@ -238,7 +238,7 @@ Step 5. 运行网络 常见问题手册 -=========== +============= * :ref:`ble-mesh-faq-provisioner-development` * :ref:`ble-mesh-faq-node-development` From 28160ef5d68782c827884ceeac4fe46c3a0b9de5 Mon Sep 17 00:00:00 2001 From: Yuhan Wei Date: Wed, 24 Jul 2024 16:41:52 +0800 Subject: [PATCH 08/14] docs(ble): Adjusted the title level in en/api-guides/ble/blufi.rst --- docs/en/api-guides/ble/blufi.rst | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/docs/en/api-guides/ble/blufi.rst b/docs/en/api-guides/ble/blufi.rst index 460799826f..ce60c53f46 100644 --- a/docs/en/api-guides/ble/blufi.rst +++ b/docs/en/api-guides/ble/blufi.rst @@ -1,7 +1,10 @@ -Introduction -============== +BluFi +^^^^^^ -:link_to_translation:`zh_CN:[中文]` +:link_to_translation:`en:[English]` + +Overview +---------- The BluFi for {IDF_TARGET_NAME} is a Wi-Fi network configuration function via Bluetooth channel. It provides a secure protocol to pass Wi-Fi configuration and credentials to {IDF_TARGET_NAME}. Using this information, {IDF_TARGET_NAME} can then connect to an AP or establish a SoftAP. @@ -10,7 +13,7 @@ Fragmenting, data encryption, and checksum verification in the BluFi layer are t You can customize symmetric encryption, asymmetric encryption, and checksum support customization. Here we use the DH algorithm for key negotiation, 128-AES algorithm for data encryption, and CRC16 algorithm for checksum verification. The BluFi Flow -=============== +---------------- The BluFi networking flow includes the configuration of the SoftAP and Station. @@ -43,7 +46,7 @@ The following uses Station as an example to illustrate the core parts of the pro 2. The data lengths before and after symmetric encryption/decryption must stay the same. It also supports in-place encryption and decryption. The Flow Chart of BluFi -======================== +------------------------- .. seqdiag:: :caption: BluFi Flow Chart @@ -72,7 +75,7 @@ The Flow Chart of BluFi .. _frame_formats: The Frame Formats Defined in BluFi -=================================== +------------------------------------ The frame formats for the communication between the mobile phone App and {IDF_TARGET_NAME} are defined as follows: @@ -428,7 +431,7 @@ The format of ACK Frame: The **CheckSum** field takes two bytes, which is used to check "sequence + data length + clear text data". The Security Implementation of {IDF_TARGET_NAME} -================================================= +-------------------------------------------------- 1. Securing Data @@ -479,7 +482,7 @@ The data to be encrypted and decrypted must be in the same length. The IV8 is an This function is used to compute CheckSum and return a value of CheckSum. BluFi uses the returned value to compare the CheckSum of the frame. GATT Related Instructions -========================== +---------------------------- UUID >>>>> From 4b32ffb8a9e6237f1a675c7469a370e00b3694d8 Mon Sep 17 00:00:00 2001 From: Yuhan Wei Date: Wed, 24 Jul 2024 22:28:24 +0800 Subject: [PATCH 09/14] docs(ble): created an independent entry for classic bt --- docs/conf_common.py | 4 +- docs/en/api-guides/ble/overview.rst | 9 +- docs/en/api-guides/classic-bt/index.rst | 13 +++ docs/en/api-guides/classic-bt/overview.rst | 93 +++++++++++++++++++ docs/en/api-guides/index.rst | 1 + docs/zh_CN/api-guides/ble/overview.rst | 9 +- docs/zh_CN/api-guides/classic-bt/index.rst | 13 +++ docs/zh_CN/api-guides/classic-bt/overview.rst | 93 +++++++++++++++++++ docs/zh_CN/api-guides/index.rst | 1 + 9 files changed, 233 insertions(+), 3 deletions(-) create mode 100644 docs/en/api-guides/classic-bt/index.rst create mode 100644 docs/en/api-guides/classic-bt/overview.rst create mode 100644 docs/zh_CN/api-guides/classic-bt/index.rst create mode 100644 docs/zh_CN/api-guides/classic-bt/overview.rst diff --git a/docs/conf_common.py b/docs/conf_common.py index abfd1b9e61..792e7c3129 100644 --- a/docs/conf_common.py +++ b/docs/conf_common.py @@ -41,7 +41,9 @@ BLE_MESH_DOCS = ['api-guides/esp-ble-mesh/ble-mesh-index.rst', 'api-guides/esp-ble-mesh/ble-mesh-faq.rst', 'api-reference/bluetooth/esp-ble-mesh.rst'] -CLASSIC_BT_DOCS = ['api-reference/bluetooth/classic_bt.rst', +CLASSIC_BT_DOCS = ['api-guides/classic-bt/index.rst', + 'api-guides/classic-bt/overview.rst', + 'api-reference/bluetooth/classic_bt.rst', 'api-reference/bluetooth/esp_a2dp.rst', 'api-reference/bluetooth/esp_avrc.rst', 'api-reference/bluetooth/esp_hidd.rst', diff --git a/docs/en/api-guides/ble/overview.rst b/docs/en/api-guides/ble/overview.rst index 37e04f5f4b..2aa07f2569 100644 --- a/docs/en/api-guides/ble/overview.rst +++ b/docs/en/api-guides/ble/overview.rst @@ -143,8 +143,15 @@ ESP-Bluedroid is a modified version of the native Android Bluetooth stack, Blued - :doc:`../../api-reference/bluetooth/bt_common` - :doc:`Bluetooth LE <../../api-reference/bluetooth/bt_le>` -- :example:`Application examples ` +.. only:: esp32 + + - :example:`Bluetooth LE 4.2 Application Examples ` + +.. only:: not esp32 + + - :example:`Bluetooth LE 4.2 Application Examples ` + - :example:`Bluetooth LE 5.0 Application Examples ` ESP-NimBLE ^^^^^^^^^^ diff --git a/docs/en/api-guides/classic-bt/index.rst b/docs/en/api-guides/classic-bt/index.rst new file mode 100644 index 0000000000..873af279e4 --- /dev/null +++ b/docs/en/api-guides/classic-bt/index.rst @@ -0,0 +1,13 @@ +####################### +Classic Bluetooth® +####################### + +:link_to_translation:`zh_CN:[中文]` + +********* +Overview +********* +.. toctree:: + :maxdepth: 1 + + overview diff --git a/docs/en/api-guides/classic-bt/overview.rst b/docs/en/api-guides/classic-bt/overview.rst new file mode 100644 index 0000000000..1f82914b2a --- /dev/null +++ b/docs/en/api-guides/classic-bt/overview.rst @@ -0,0 +1,93 @@ +Introduction +============= + +:link_to_translation:`zh_CN:[中文]` + +This document provides an architecture overview of the Classic Bluetooth stack in ESP-IDF and some quick links to related documents and application examples. + +.. only:: esp32 + + {IDF_TARGET_NAME} supports Dual-Mode Bluetooth 4.2. + +The Classic Bluetooth stack in ESP-IDF is a layered architecture that enables Bluetooth functionality on {IDF_TARGET_NAME} chip series. The table below shows its architecture. + +.. only:: esp32 + + .. figure:: ../../../_static/bluetooth-architecture-no-ble-mesh.png + :align: center + :scale: 90% + :alt: {IDF_TARGET_NAME} Classic Bluetooth Stack Architecture + + {IDF_TARGET_NAME} Classic Bluetooth Stack Architecture + +The table below shows whether the Classic Bluetooth modules are supported in a specific chip series. + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Chip Series + - Controller + - ESP-Bluedroid + * - ESP32 + - Y + - Y + * - ESP32-S2 + - \– + - \– + * - ESP32-S3 + - \– + - \– + * - ESP32-C2 + - \– + - \– + * - ESP32-C3 + - \- + - \- + * - ESP32-C6 + - \- + - \- + * - ESP32-H2 + - \- + - \- + +The following sections briefly describe each layer and provide quick links to the related documents and application examples. + + +ESP Bluetooth Controller +------------------------ + +At the bottom layer is ESP Bluetooth Controller, which encompasses various modules such as PHY, Baseband, Link Controller, Link Manager, Device Manager, and HCI. It handles hardware interface management and link management. It provides functions in the form of libraries and is accessible through APIs. This layer directly interacts with the hardware and low-level Bluetooth protocols. + +- :doc:`API reference <../../api-reference/bluetooth/controller_vhci>` +- :example:`Application examples ` + + +Hosts +----- + +There are one host, ESP-Bluedroid, supporting Classic Bluetooth in IDF. + + +ESP-Bluedroid +^^^^^^^^^^^^^ + +ESP-Bluedroid is a modified version of the native Android Bluetooth stack, Bluedroid. It consists of two layers: the Bluetooth Upper Layer (BTU) and the Bluetooth Transport Controller layer (BTC). The BTU layer is responsible for processing bottom layer Bluetooth protocols such as L2CAP, GATT/ATT, SMP, GAP, and other profiles. The BTU layer provides an interface prefixed with "bta". The BTC layer is mainly responsible for providing a supported interface, prefixed with "esp", to the application layer, processing GATT-based profiles and handling miscellaneous tasks. All the APIs are located in the ESP_API layer. Developers should use the Bluetooth APIs prefixed with "esp". + +- API references + + - :doc:`../../api-reference/bluetooth/bt_common` + - :doc:`../../api-reference/bluetooth/classic_bt` +- :example:`Application examples ` + +Profiles +-------- + +Above the host stacks are the profile implementations by Espressif and some common profiles. Depending on your configuration, these profiles can run on ESP-Bluedroid. + + +Applications +------------ + +At the uppermost layer are applications. You can build your own applications on top of the ESP-Bluedroid stacks, leveraging the provided APIs and profiles to create Classic Bluetooth applications tailored to specific use cases. diff --git a/docs/en/api-guides/index.rst b/docs/en/api-guides/index.rst index 4e7e40aa8c..7c004d947d 100644 --- a/docs/en/api-guides/index.rst +++ b/docs/en/api-guides/index.rst @@ -7,6 +7,7 @@ API Guides app_trace startup + :SOC_BT_CLASSIC_SUPPORTED: classic-bt/index :SOC_BLE_SUPPORTED: ble/index :SOC_BLE_MESH_SUPPORTED: esp-ble-mesh/ble-mesh-index bootloader diff --git a/docs/zh_CN/api-guides/ble/overview.rst b/docs/zh_CN/api-guides/ble/overview.rst index 80392861eb..41463cc37f 100644 --- a/docs/zh_CN/api-guides/ble/overview.rst +++ b/docs/zh_CN/api-guides/ble/overview.rst @@ -143,8 +143,15 @@ ESP-Bluedroid 是原生 Android 蓝牙协议栈 Bluedroid 的修改版，由两 - :doc:`../../api-reference/bluetooth/bt_common` - :doc:`低功耗蓝牙 <../../api-reference/bluetooth/bt_le>` -- :example:`应用程序示例 ` +.. only:: esp32 + + - :example:`低功耗蓝牙 4.2 应用程序示例 ` + +.. only:: not esp32 + + - :example:`低功耗蓝牙 4.2 应用程序示例 ` + - :example:`低功耗蓝牙 5.0 应用程序示例 ` ESP-NimBLE ^^^^^^^^^^ diff --git a/docs/zh_CN/api-guides/classic-bt/index.rst b/docs/zh_CN/api-guides/classic-bt/index.rst new file mode 100644 index 0000000000..a1806a02ec --- /dev/null +++ b/docs/zh_CN/api-guides/classic-bt/index.rst @@ -0,0 +1,13 @@ +########### +经典蓝牙® +########### + +:link_to_translation:`en:[English]` + +***** +概览 +***** +.. toctree:: + :maxdepth: 1 + + overview diff --git a/docs/zh_CN/api-guides/classic-bt/overview.rst b/docs/zh_CN/api-guides/classic-bt/overview.rst new file mode 100644 index 0000000000..4f0b22a80c --- /dev/null +++ b/docs/zh_CN/api-guides/classic-bt/overview.rst @@ -0,0 +1,93 @@ +介绍 +------ + +:link_to_translation:`en:[English]` + +此文档概述了 ESP-IDF 中经典蓝牙协议栈的架构，并提供了一些相关文档和应用示例的快速链接。 + +.. only:: esp32 + + {IDF_TARGET_NAME} 支持双模蓝牙 4.2，并且已经获得双模蓝牙 4.2 认证。 + +ESP-IDF 中的经典蓝牙协议栈是一个分层架构，可在 {IDF_TARGET_NAME} 系列芯片上实现经典蓝牙功能，详见下。 + +.. only:: esp32 + + .. figure:: ../../../_static/bluetooth-architecture-no-ble-mesh.png + :align: center + :scale: 90% + :alt: {IDF_TARGET_NAME} 经典蓝牙协议栈架构 + + {IDF_TARGET_NAME} 经典蓝牙协议栈架构 + +参考下表可知特定芯片是否支持经典蓝牙模块。 + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - 芯片系列 + - 控制器 + - ESP-Bluedroid + * - ESP32 + - Y + - Y + * - ESP32-S2 + - \– + - \– + * - ESP32-S3 + - \– + - \– + * - ESP32-C2 + - \- + - \- + * - ESP32-C3 + - \- + - \- + * - ESP32-C6 + - \- + - \- + * - ESP32-H2 + - \- + - \- + +以下各节简要介绍了每个层，并提供了相关文档和应用示例的快速链接。 + + +ESP 蓝牙控制器 +-------------- + +底层为 ESP 蓝牙控制器，包含 PHY、基带、链路控制器、链路管理器、设备管理器和 HCI 等各种模块。该层管理硬件接口和链路，以库的形式提供功能，并通过 API 访问，且直接与硬件和低级别蓝牙协议交互。 + +- :doc:`API 参考 <../../api-reference/bluetooth/controller_vhci>` +- :example:`应用示例 ` + + +ESP 蓝牙主机 +------------- + +IDF 中的ESP-Bluedroid 主机支持经典蓝牙。 + + +ESP-Bluedroid +^^^^^^^^^^^^^ + +ESP-Bluedroid 是原生 Android 蓝牙协议栈 Bluedroid 的修改版，由两层组成：蓝牙上层 (BTU) 和蓝牙传输控制器层 (BTC)。BTU 层负责处理 L2CAP、GATT/ATT、SMP、GAP 等底层蓝牙协议以及其他配置文件，提供以 "bta" 为前缀的接口。BTC 层主要负责向应用层提供以 "esp" 为前缀的支持接口，并处理基于 GATT 的配置文件以及其他任务。所有的 API 都位于 ESP_API 层，开发者应使用以 "esp" 为前缀的蓝牙 API。 + +- API 参考 + + - :doc:`../../api-reference/bluetooth/bt_common` + - :doc:`经典蓝牙 <../../api-reference/bluetooth/classic_bt>` +- :example:`应用程序示例 ` + +蓝牙规范 +-------- + +主机协议层之上是 Espressif 的蓝牙规范和一些常见的蓝牙规范。根据具体配置，这些规范可以在 ESP-Bluedroid 上运行。 + + +应用 +---- + +最上层是应用层。利用上述 API 和蓝牙规范，可以在 ESP-Bluedroid 协议栈之上创建特定用例的经典蓝牙应用程序。 diff --git a/docs/zh_CN/api-guides/index.rst b/docs/zh_CN/api-guides/index.rst index 3f49d592b6..9ee0dadb8b 100644 --- a/docs/zh_CN/api-guides/index.rst +++ b/docs/zh_CN/api-guides/index.rst @@ -7,6 +7,7 @@ API 指南 app_trace startup + :SOC_BT_CLASSIC_SUPPORTED: classic-bt/index :SOC_BLE_SUPPORTED: ble/index :SOC_BLE_MESH_SUPPORTED: esp-ble-mesh/ble-mesh-index bootloader From b71b3366d98326107a03dd70f0ccee8df4f75f77 Mon Sep 17 00:00:00 2001 From: Yuhan Wei Date: Thu, 25 Jul 2024 09:55:29 +0800 Subject: [PATCH 10/14] docs(ble): Adjusted the title level in the chinese version of overview.rst --- docs/en/api-guides/classic-bt/index.rst | 2 +- docs/zh_CN/api-guides/ble/overview.rst | 2 +- docs/zh_CN/api-guides/classic-bt/index.rst | 2 +- docs/zh_CN/api-guides/classic-bt/overview.rst | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/en/api-guides/classic-bt/index.rst b/docs/en/api-guides/classic-bt/index.rst index 873af279e4..7c8195bca6 100644 --- a/docs/en/api-guides/classic-bt/index.rst +++ b/docs/en/api-guides/classic-bt/index.rst @@ -8,6 +8,6 @@ Classic Bluetooth® Overview ********* .. toctree:: - :maxdepth: 1 + :maxdepth: 2 overview diff --git a/docs/zh_CN/api-guides/ble/overview.rst b/docs/zh_CN/api-guides/ble/overview.rst index 41463cc37f..fb124c4f45 100644 --- a/docs/zh_CN/api-guides/ble/overview.rst +++ b/docs/zh_CN/api-guides/ble/overview.rst @@ -1,5 +1,5 @@ 介绍 ------- +======= :link_to_translation:`en:[English]` diff --git a/docs/zh_CN/api-guides/classic-bt/index.rst b/docs/zh_CN/api-guides/classic-bt/index.rst index a1806a02ec..57aba1ca5d 100644 --- a/docs/zh_CN/api-guides/classic-bt/index.rst +++ b/docs/zh_CN/api-guides/classic-bt/index.rst @@ -8,6 +8,6 @@ 概览 ***** .. toctree:: - :maxdepth: 1 + :maxdepth: 2 overview diff --git a/docs/zh_CN/api-guides/classic-bt/overview.rst b/docs/zh_CN/api-guides/classic-bt/overview.rst index 4f0b22a80c..c090d81056 100644 --- a/docs/zh_CN/api-guides/classic-bt/overview.rst +++ b/docs/zh_CN/api-guides/classic-bt/overview.rst @@ -1,5 +1,5 @@ 介绍 ------- +======= :link_to_translation:`en:[English]` From 124a23d9b16d3dc025c80489e3a8ebedc0eaa68b Mon Sep 17 00:00:00 2001 From: Yuhan Wei Date: Thu, 25 Jul 2024 14:31:01 +0800 Subject: [PATCH 11/14] docs(ble): Uploaded the classic-bluetooth-architecture.png; Applied the suggestion from Mengyang --- .../classic-bluetooth-architecture.png | Bin 0 -> 23207 bytes docs/en/api-guides/ble/overview.rst | 2 +- docs/en/api-guides/classic-bt/overview.rst | 21 ++++-------------- docs/zh_CN/api-guides/ble/overview.rst | 2 +- docs/zh_CN/api-guides/classic-bt/overview.rst | 19 +++------------- 5 files changed, 9 insertions(+), 35 deletions(-) create mode 100644 docs/_static/classic-bluetooth-architecture.png diff --git a/docs/_static/classic-bluetooth-architecture.png b/docs/_static/classic-bluetooth-architecture.png new file mode 100644 index 0000000000000000000000000000000000000000..671f04729a1bbdc6cce9059960169cf2ac26dc7a GIT binary patch literal 23207 zcmeAS@N?(olHy`uVBq!ia0y~yVCrFDU^vOa#=yX^(lS|rfq{XsILO_JVcj{ImkbP| zCrVr+N^&dGGILTHRE?b>EL9_ejQrvfRbv-bBO}+G)Z~(){5(}7BUK}V-29Zxw9M2L zh@6puk%_K>xvr6Eh=Hl9v7@nxsH{RgDaCGP6@vjSSpVle6oN4T>o0^vC8Xp{1>JAB#lFEWq zh?il0)?Hbv2#jhVtP?xuBwqi zUScj(XFy_lsxDM}CNz#pBMd$Lv;2$P%ltj6%*|2)!oob!O@o=4Tj5@mSdihHp8}4F zlnRLLhQ<~qAT34)DU}crb3;prKzb3(9;me-f#A$4sDli_4mUDLFU?FzEr#fYDlEy* z&nd|)Kov~R&&x|qh9(%O!o;GY{Bl%fY56%&-$B(BB&I`cgjxs^2*wCfkZ5>jN=XL9 zB^IVgsy$LO(=%W;8yY}mauZ>Sp#sGji7ENz5dB~wYK4juPXHAaPulm{ST3U5G$&NhK_;7Uh@brGSeALses^ z@{G)q)Zl`|WRUXmqQnAKW2cOg+#FS77m##XW=@WCeoj6pQRn67rK%b`rRO9TgW}de z)z~R5Kd%IubPP?wWdbNmm8BMyq{0#+#QuUrg#W-^#vjO_z%&3CZtki1xv3>Zm8wPt zP!n~Hp#cO<*cMQ3IU<#q!BR;EQVKDGC6Gjr>s5`6(&0vf9Ia|ZIQCSH+@O(<-}#_Y z87++%L&56Nd`zXKd+=HKPM-(2%?P|(Wh!;oR*eq zmYj?w-ik|#^0QN65v^)uoMLX7WB`g`i2byUQCJK@Bh&~K`=BU6icwQov4k9>CeWB4 zkO+kquc#5K3yQ>)qWsJhNVric-cn3cEmBN~i8l+QBx5r(I^{&Pcr!GG)-Z!Q-b^7e zgA{L|HcDo4Vo7FxUNJ8#0a)XOQbW$Tup*0|St%q8ALKP+EWTu0fn>ndzAjd%*LECav z*AQCEKnqfA8PX6|xDJ|v)EpW#$W0csm~}>~4k1#b@vCZNgsq|+eDQ06C4ND*J5q*B z%}a3vbs1ERU7)!qC9yaI-bO`gk0Khch{j233alpqZdn=`P@}PlTo^)|8OS*X*1#-E z%}FfDECV&3RgH|G_G4?0;BPR3G9|c^Xas5X2IObvmEdmj8p5oH*;JfgT9lj$)ddP% z!mU{XR+@q2K_42z!%Aaka5Ea-u*V-VP}ShpG$EDHwz-i3tYZdk zkDyc}1Z#-H(gE$09)^`eA?d+_2_@}8>MnT01gYT(Ys`$+ zYoKBjON(^C>NRiygkxL?EQc}zhg?K~Wnp7}5DBmlbi@`ca)3j&fPq1Q!PCVtq$2L^ zT-JywH-G=j&%S+apVqYu7&_wK+uu{TlC8@YGyW_}~KTX?th-PqWF|DS)Ter|n$ zfq4&)LGk?8pMuiP{hm{7_dIpa^Ulw1pFVy1b`?a3`vR%%XO*kho zKv9G!qqVj5R=KzNKesPloV;Sa;iP*_7b6r-?N4?5wA^Q=QQJ`oeWNSkCm1~%SfJ>D z7e|JldEv3lvnNlUY`@3FJ9p{q1R2XBl`WjvS>`5cIjX1x6_1 zC}pbRJf6Vm_E959qwSYmF#}XWfl-LVkn!w6^>cRN;nx#xa!*RQvZpKRhh>B^vVH}| zZs7}idX=P_XE|kTOW--FAf|qZ(G%{i29`ep9C;nLbPj49JG%SCBC&gwDh^CgB(RY) zgY~qdW(Q}8K~|FC4#W2yy;C-;!`!C8_*x~Q=9F)OHcx;-R^I7=ItibI;wQhMy1~XQ zbT|-m@x}UtD|e`H%F%K7!hYex zKOAmti*z?A%QPVZ{*Yv2gVSX@7UjL&4|ASd$RZ5gpuqTlPmdkT;tKJ~mOj?i@8vsbn(OwZfVBIoPvy60r^F?bZG3D4O1OJdjc^WA4w>PXKs zyVgE&&YU@WQjXQ6ZMpedOwX#T{Nv~E{{vLQXB8OA`@thXp@hSu{aGxq^+2L zBww{)@;#Ul_~jR`S?OKXC+DZlvh4n)xKtJDHIC^lE(URXUN+kG>S#;!X2)nq9Dcf1 z@W+x}{>8}_Rs}w99HFT;%+cY{rOj2hBTICTRrXAL^XAQ-Kh+nuxTYUH*yPgCWazQu z#!P5vE158I9pl(rn`mCib!jL9|5f6eQ?`BCWf{l88DP*Rpr8*; z`i&ee3OX!{A6(R0svKzGwqWm}dYS1Zjg zZx@n%YOeM6O_EZNXIMvaxfOeEl;>obf8bA~uwm+(fRNR9IW9k2%e7Cje%+ctGx?$? zr}{aK#geZ~m}jvgUAk|VJ=aGI`~QE%#m~=o+Ql<-qDEoRp1Pkhs-Kq~i!Y7|*c^9R z;P!Hm|4s{Uh&s5V>}`}u=A|PJB~MRH&A7HEa)p3izyb!nxIG;^i=QtletvGD(i1jb zsg_P*^+m4TVg-eT3ln&z&Rr5H#9`0!WXHx&uA3j6e9WE|^gMsR>l=&0(zy#ZCd9n4 zaqZk=>220l(PO?oev!+&DKkv6C9}*k`uN}9UliOO_2ODNi`VqEB1ykZ9GFxRDw)Ex zC02*8?~C1CCfO0TGKh6|`FlRmL;F}Czr4KsZM8x2F`g%9XNzZEUUu}= z)zu&0-L(!`9madOo!`7=({-#yqsT5CxW58yj(;#N@THnf7rIAKgD|Z`1rEU z=*8|@5VkgIRe#6s!pFx}zP`NFyWMN5*22Qa$4*R8Y_5u*eg5m~>k};slSK66WX{eu zcb}-_8j?|cYfI*-WqZQ6W`*j+?h;vcEOKKKYuedat;NsJt=xCCOEh@iNu9_|D+-^T zpWmN*d)vy7@%!s~*G6wwa%^H*5xl(bQ{TUj$K})Rc8c_*B_^p0ahNe4Z;aiT_OnK& zxV|Uo=OvAYFE)K_IC$@k=Hic^pZg!_kQBByTYvEO_4OeycAbB4u|x2)zfD~Q|Kj#< zPJ7kXZY=-pCR2L1-6wL>;`0v-PfasPKDZ-mrSZBQ^N$~y>3ya8k*Li38~p6wa-7#h z6b39!t2N1g-4K$w$Nqa+US#*(+t(gnDGYydX0E)e*Nug-)9rqIdC9zM+sgjc)6cEm z$2)tw^J6jD3)dH_-m?A@n*9IQPvP!4{|_xI)vGA^&sX&1RQoww_QgS8cb)on>F4FE ze?E)quuXT}{Nc|^b}lhp&gGn&Cn_W+U44G%W%7+p=UA)Da$FXvoDA4orfl&=s%gc= zMXa+e^;H;!KFn_j<#OZX?Vd5I?BO9+)fY?7&NM#$;nyTp?~r{9SB7oNiIlM_;h1Eu z5$6=_`$+fcdb-MP8eJL>=MOYBPupYOeF5IGg&WdCYS@-2E&qc4pq1WA|#maQVsEwp`=YUb#^#banUd^8CbeR}5cV z*lKU}U8ZHLwphZa7YA2d-k|!*EU&fXrSVFcV<$IHUmW%~O~QPU{xsbgjqm=tDI`yO zb7On5a9RHS21)Mgi@bV&P1w06%1qqwe^0C2U)jR9pIEonaprr^h(7e?X;(_v;wAWNVn2kOJdh&WNQ6Ix#yoeA>{tz2Nz|xfi;ExJ0#DHm9H0>N?gG zxTi=|D;F5jF79v@ z>@6!R)AFf%e2n)*%#z%jn^@1!vu)nId9%>eN3tS}D><(oZs$LI?_M0|!GYM?ZE~i$&q11$BRa6%-c-*M5J0KmS^++rbPm zwKAo~1VMrGvFrVOHzqtSyD@eBs+NTuM;!YmU)bg?FW>a>!_D0uGp*)U(@-@0n*4zW4vXyV4?OC;GH*Q$3RVCecK!=h4>JHy3Ucnm6lu{^wm! zPbKfX{8s4B`MHM-um3&OX0y#Z>guJP6OBrvOw;cxX0CnV%94ChsO(hotxdJ%JkpQ< zR%&aSeAN;?XnsEbM*X8UM}v2kWulTsslm0ow&!=;HebK;`%;VJ3w>?n6Mucx7FP^< zaw6lxmfQ_9J}U_+G&XQX%uU!+{$9=~_0*CuT{&05phtx=MkyUtzMr>bHU%C!rF3CQ zXSo0BC2{*|c5<<2A3A&ZF!Rcw%KFXI4c52Jh~A#J*6A>#=-!Uy!KYP4X6r_83o$!V z{Nwd?ebpODM>-bT%wp%0IWW^WeM)%9XM9n1y5-qXk@t%$6qoW!7%)s$ z_jfxrMf2m6lfumjYXTRuZOgyE?w3bJtWCF2miWRPzr_hA?LxmNIDFvPk{uMvx#^(a zI11HdPh+^K9xmZkw-r@GG=j zHIG@iM<^)o_71LRJ9Aubc3tJ&cHH{w@k^DL3;uShALD)Bz1Q0O;gzk=+rIyoGIpty zz5Bj4plM6m%|8|2znOj#*Xx^tN; z>AS0q6t|n;%ul+J=S=_n{eJ)IRwWi!iL9oNA0HoYW17|_s;yO+-j^_C!}e+7I|?7W zU0MBoKYw2Cq(`A|E-r5W6}V?Y>ZvJ>E$vHZYD=iP2imk;a*^nAm|~W8M#9-|naHCI zIk((*m)xE1Ik)pIO}O&^d$*XU!U+}?o*1=ytEsESPp{DWb$WTfmqO;l6v3YP_O(Y| z<>s{+_Q~CA|K__o@n2W2)_Q-I$6aUJ1C~@sI?u0~+WqMJ{l%+a|M_fS#rvx5>gi{i zAH{TU<=0)?kayIH=ly-xr*dN2p?s1?>7j~goRREm5>IQQKF;e(I6HOwf`i*+UMnX) zmGe_F9{s`uQf2~)m3{j4r?W3%Ww_OitL=gz(|6}*va^_|bC zIL?7dMZkh_wNOtHPwSJHo`oGPF{b?s)D|7do^Dy3Hg$G}%p|*_Cmo;8c`|m0)O%Q0 zeOaL;b&+Lp#Y2}4yZV1Jnn6npIt&G)8f8~2f1a>mL&w&Y!OI_AUhdzv)6*l0E9=P} zw~uUIHzM~;R|;GD_V#vurGTvywp93pul;1#f7YTsuq%7Z*R1FE|NefzuMxUx3fFn> ziKp-Ft=5!a{y#T?Ux*`^iTk-v*w6ae-{(4>v$^;4`lTa_)sxmIZ)bdAo-^l@!92@K zmgo6<9jB}a44u!Z%${)a&dLb}Uyt|8Pe~||u@^pjtKxY{{htqft(#RHFJGG*%Gg=o z6lhcX=wtNm#}c2!KmF60q%=KK*e&7ewZkid7a9nu`8DOT>q{tUEd9JRv~pr2=dmx6 zn^%viJ!6ai@ zr(q&LLtvRXJG*+Lfl5MXQ(())C;DE(iebCUa+zk;a-{(kA9fG(%mlGe)r<0I#!!q_2Q?^-h_TGiZqE1E%C0Xc)4rugy!AcDSi!U zYj-d3)_;HAZtV-#RWq~0bz1!8?Gmm%`sy)NZSJaVV*HO+c%I9+vuW|EL>>==xI+8( zU!h$K-%l`Hadm-ZUCn>K_G@1!nAN&j=zsoZwrL^*=L_!xt5_Z%Xk-pm?Anrlf8WYG z4r@CLye6r1{tDbvI_bFvleg3MN2OC931upYndjeI)3?xY-K4y$t3*}U17~$?GtIuH z@loAZd(%wwd^xMqS5Mqe{QdFKxl&MddQkQxYfV;zM+c`YE?e@!#rmH+-}7lPZi2l* z2b2`EKRS4wh!k%4r1*BXSJX9~g}J^aS;etC3KXSGvzD|?tMo|h@3?ZbTYUBPB@S+f zz9@C{%iHH&lRYNmw%K5#FegiA!!uVCy*xuRgV*Z=C)f+6iRnM+T|HgE){Upsq<2fu zH&Mf1>nlCxDQ$H$n5Gddr`{(M^4@#K?&$l8Z2id&{#6sbG6a|2-&ZyNM!>?X+%M8r zVlRzS0^M(Yd3%XTKiU<*VaAJoWkC-*>xi##`|I z-2YGdM~iP&U(k4}EBdkG$%T0g&X@k~-g;{i5aRt`gpN|Eb$on7)mW{it@zva?_Qp8K*j zmQ5n-ramsUk-P6cX^G~Qn|;T8wPwG+x2rEjGe~ltgYr?0`agosmBveJfBlf#@BW|p z;^N=7_d~n>*~r~J{M>)OLgK54jgMI*Z){%Pe^s)#$S>s<&rF{_;grRD8dy9Is4#LJ z`!C$H?8OhUo}i0op7}O3O)O{PY|&**KA4fEcC0Dz(D@wD;DLY;lSq$9&%s^w8WPQ| zz2Xxa@>nz^N}WBORUDYo1U5t-{PFd5_@3I|VX}*r6BB}coel^!O;cN#bzd>X_(xQ( zIG5Y%yHR>NO#&0T(mA=0`%gIW<@xpf{~x`*9j=vs@ybOD!IYVE)Ho+NSSTiJZZe$n zp?|~W1qnSHqK|h@h78O&OyCSKV3U;87hn?U*~1U*jUOoE2r#&HF7EZNATGDq!b=j+ z0i~8~CXt?pRn>>yKhcml{Qh1+8psmi2RB#y@2I%UTq_m%&(o{Osn_PN-lXr! zL3@=rjQoO?4RZHxPw<&HqiJF}E7TDY#*N0|^2%XfPOJzuT6=W5=fRA^C%^bAzQ1%o zbEkmQcGf3Op^w2w*-qSsW zC$L>9ca|E|Cl}N|eEF(wdg57gc)-GfTL!}2B0UTDUl)^ocy4n4j;}wI-`W1|Xg_Zs zRg%N!1|6kQS)kuoa`LfKkjjFpk6RLj+RWm3ZF_#b(_K3e5<3i>6B@1xE=bt2OZRCL z+<_hr@k}B;zdkL2c~OB;XoD4#NKe@Ir7;4~P?`WL<{Fv;HH7&GUU38%MBSZMuca=F!3UXntXA0f*q-xL@E7vou2>&v0w)8MKUs8O0d^L0+3Y4W@aRwMf{S_;2L^w#mh)JY} z_R21b+1FHayXWN}um8b+-p*#rqN#z5>a_)np+!1=+ExobV<8&uEebmKZ!P^`_8uhf74 zZsX~dnk&LrxPRdJpao6#3XL3&372=y%!pi*Kci*2riAhl-ADgbj_&^P^0<16Z=6Nb z`j*Skp*%(*j*f#C~yy~6`OCAb$1O*OO z{J*NYMc44cqvFL0TP%ud*=6=_7CwCOml7h^ZD&!@vEB2lru%$<)5S+8zRFHONsA9> zGO#9B+?!iqW6pJ~V2|Y-Sh{-Q)6f){zF=EYU(>~~vRSWHKuJ_cfe}=OI&RJ({oK}RG(#XIOVDRZ1hZrN* zv4q6OuF!ZCP~;3Sa66I9{o6CxpzW_*0oyjm2WMBCSA2ZKnsl_YS7ha+$J_7MZQj*d zU0L~Xe*M3|?8(O0ofbzX^<0=?o;%5*LNTGV$*}CrjUS($a*OFiH1Nq#OsxFE0!K|Es3#DJzx4l1_xU1qN!a(cS?Kzo>H2kterQDR)cM8py4Rxc@eG;w zzn;F%h*&vs{&%DF^F3;7r57ijZhN&?nZ578Lf7y&wtLxEURuT_x@Nk5jN9d`vm1_< zavPj8C%Nxtj0chTn>lufH~Q+n{!=+v9*2N5tHOEBoeJSz9mmp03xHI}6gf z>^agY{P^nX@Ljq07dSQ>6h3m zRQH3ASpWJMMs3OPdg7TKyPfykT$^^cwNi)nO|sor^RLTt^7985|GLlETQjZ7ck}e+ z4sugg2DrtluRmF;G-1`%wQZi~gnbw7D0?X-6`I#0^>wv!^*fn{>EdxV^_{i1zdyX% z9bORkvd8GD_u<_A(z~|3X|r8krd+z~%EG2le#7loDkb&imLKm?HP(=DPMw}{mAMV%xS1fvR!f~IxhD38ukNAX!vqBeG<~iH5m%M%cK%bq{`S#O|?wiZb8l=2Q zaJGN@HHtSo@y?lzYzJ?w%Z~mcdGGjz_t)3|zpyM%I>w@yar(R+&Mhn6FXKG6|Jnam zt*u(p_ojU)|H&kJVN)_UkBq6oA&z4Q^0aJSG82+N)Cz4#V=~i~m~UU-*T~F%=aR?Ca|iZ)`}ksQF>==tyUC(bH24%ii94b^guG&4#(R zOl&GXI8^Gb4qMx`)O&i==f6o2(zZQj8_&ipImdEFw8wn?J(s^+ycag6vwxAfbNRTA z*qMkGED6%>*Zy(2?R0S3vU>WOV-vOWJZ4xdyxH{e`F{I}>Y;I4-dqu4cIW$`Eb+VK zMfV=o&nv!fRa-Br6(`_(%Op_$lJ)|nXHJ~-Bsn^&2V>Lo%FfjIfd`P z)ux=B$6Cq#^ym>mVP3_Tg0*f6!Q0Mc)xMs#{&3e@J&##Bn$s-w4_+(1J!N|6o-K!# zJALKKI%Dd6{lTi=rm9PpvYNG>i}o&7N%+dLCd>dd{(Q7c)Hr8Bhm&A!l*g~b?ffTZ znQF)FuX~$5*}D8)&(7lKkM8a+_n59X_f+SZdA8Pde|{`HvTzGCJ72=}b+I$-YIi-X zdRhGUSLy2gnJJATu;4K{sA1W3tjSwiE$`2c4q0`xx|;uumv)|daQk}xs`!saM<-a< z=h^@4m}Prk?%4PI`-_V%YMq#&svPz{Dz!*-R(qh$QU`Jo63iB!tJU4&2YiX7TlS?`rc43!I!&PRwy^y&P{_-+Huo zngq*=?gti;D%d!*re|iflBm{FHLy^(*O5XJ=P@c_HXh;RPDl;}X?cvQBV)^4h4aA@`J= zFNOWLKEyhyA&!og zajwztkB8mw?0+14!@Tld%G0~XS4|FPyxKdbvN-A3q?aDEY%(XXCLdRuTk!IZs?6Rh zm$QMlrUV9WI8v$Uch|0S=Hv9FvzxZsb!D(w@ElopcK06+H^F+(Nva1|i?0tfi;pzP zzt7WryrTVuYVV4`rN=&e`Eq2Puyrkmn_z!q@50;5E(vhn-~dheC_U2(Ta$6)*xKmr zNtc)Tvhgo&nRfK?jU9!_Ya%zheXaig&sIpqW5K_@Nk_RrlL;RmA2+`tP#C$`jko0O zEzzUh;^FIq4Q`#t=bG-xWF>HcCHe2OuNS}kKeYW=ny{*G&kxQ=KP6s%UVeT;*R##) z=aO#!db>)&)h6pvq_N&2&9Gf79`35(e6%=WBh!hg`qQg&uN(+0xLtqb!@pa$*;C8| zyW-q@WEwY3eS5V!et%u?!<6N9ep)_z63+fn;5_!P@9zZTNIg}tXOksiYXLrKU0stR z;m`7h^SbbjiUj7iFEU;A|Ngmm+N^zhXNxfNZoW^75|fwv^jYd{4xK(ZPyOP;Liewm zV_mHemrkCemi%+iQ!W4EM;|)b_!n1bFiShPzg@y9v_X?8Ok09^^`vP9UteBczOZ$E z>h-6yv(C&gyvn4++ zR;xFx<#4<2s{iV9{xc^Zd2{A=J-H)mv$xlTc>d<|^ltQhC$jV6s$%Uga<{lEgP%Iz z;>ir$Rg-DIVb<2%u4!ANSAL(K6O&UBf9>^!I|thnrWE|RA(RHPwB5#QN?1{eF|oODl|JTy6Ly3>;cFcu&!2e0;oLnkD)2GT)6^Q(wj? zX75=$<8Vgr?o+0%W{kzGi$w~0ByGf2m#qnzXZP4F??uI$s6AZI<>xfZxaIaGm~7Si zziP?S_ZQ|J-cWisY|g%7DRIB~-xVdaMOX4z9&@)|_x#~s_Z4xAb_w-NI;`>Dy;tgL zJNw5+GrJ3{3s~k>mAbs=tDUm_;@!uK9twQw?3?_+=>F08gDcK%z28x{>V|vvv3V|! zW!yNs+0EQC-kZLi+^|(}L*zjX_B`*4-6ou-&(F>lKi(%BY=8Ua&6NdTpPii@xWBIU z>#UaLOS__+t_B6_-gEtE)F)-i)z{Z|%I)>FwT8vde6n}D`>bnkx~R5oX7`nu4Qdig zPb{gqTBNr2dR7Sc`+Iww&tBU4q58}HhZcn_o1UCl)b-9!){<2)T=k9jih_;xuKLe> zqJ$Y`j`}y*V-61aW<+gmB_TGVKrx*r5th;ts zK|<95q4eIxVRa^=U~ z?zkS?p8a+Ioc?z4et3CU-6!6LSM&0cL-%s4LsWM>ULyEvLSgd3jB^st43gx96dL~v zZiqUlanG64JlmJ=`m`G7$IZK4Ma(iU9dTc}g~QoWN64n* zeC_ac4t3X7t$ixJU)O}oE&4|4y1;y1bza#U=0Ed2e~x>t$%~7Ofs0+geqJJevM?uf`PNkrrm6j$ zp(NowRePz+5}DJ=NF6zdiiRZnN*d z#7Chc!S`J6`}X~-{Ptv~Rh_!q8Hu#D-p9UHJZaRQZ>Jo4?2A_f`;{i+wn*Vbb)gN8 zOlJBLxdrD-BaK)W>q%s`KnDtxSQxpEacuN`m_JFR=V89Tg|ZN&EzhCLB+|3c_1dYo zK?YGj*@|H+a}rz{nkH^{rdy8y+Eqxu_Jzd~={|=4$Yu6oJ?hF~$`0?Ye?2b9JnyOl>US!XJ^}-rh4v8{yx|{3Yl71s@(LlZ6(Yde`k14XLo3C+B-Wg!f###24 zUG!qbr+aoO{(&r<$xB@pMQDDJZxMrcyLH?ioSmNDA*5*(lb`3Xk!R{56_K^N)0!?O z-In{s>{;>a-t5;Ef4=d}tF00E#azS!w=F<K_UOP>tqx5zAI-=;GQ&H60cG$qb1 zJYok8N6>ySxfP#xmcTSJ3K_IBur9Woas$2;sDUMC1_SG2-h8|1e$aqYabS8T zumCbCg%~E`6<(0A<>A@qm*CF#I3U9$((^0;R0u%2e~dyK5}8DL%=Y|@v4TYx1Lq9T ziWC{IH_iz2&3qb~F1DG^_l9?n6&Q;-ehBp3V)gU$D<~-mvG0?y6#BH;WS<}39{C^D z2hTIs@j*vCHoQB}7#<#e&N{+h3^ukZ5d-|f>f6Hg)qfdiA7OM_yj z^sOAdsnCqz(ZJH=+|XobaixM6;l>*Rj9hL5qD=c%&Ux{?it0p`5BK#e_St2+YCjHw z4iz2v#&N_Wh{zf4enq!W zo5bczLq|1ke|Ba(zujZT%EkNIGJ9dct`H+QLE!7{cI}C~jsDjia1pNJc8ffT~86Qvn81H`|IVq2dAzj9hN_*#ldIsieZVTCC^)zu)@vY^&Qu zG=mhPwqytvH6MDtL{sAM>vIv`_tgFS)2ei6oXX#n@&tre!c5O{QiH3 z_qzLk_;^`-iRVlnPhs^7SM7RR=N#zY|NmhA#YJq{?|1H3eD2S^&GUd3>*K@i{1^9D zm%q8S_4J0-tz4pqj&uqq=I5{f?FSkjF-n6Bj=U4Ntsl8b#cz&9qieU=!r0wqAO041 zuwOXHz`B@EAd~5L{~WiaYIpyr1}^WiHPfHB=3cpVCF9#)eTSNlpXd2&yxgDnIcIag zx|GDPv+BQHTJG7{clPz7{N>L&q)fX`e%!NXkHN{Ctj)*Hefn5;b5g58{-cBxujx^H z=Pi#BesX@UsP}TqwpV<1^HF;AN`b9M>9qq4kv`0-nm2l@lUdO-R z`9D6qG=7w>-Tl$m{}!kvx7=^8LNnKkCdXzrO~YG@T)B7b*wJ#MtdWVe;Nv6LGjpxQ z=USJyy`S%F)4<23AyL}kAs@{=GX3cO<;9CjtL(f) zPj=5PmtXk%f@jCqbe@>v*#0Y;lce65t__yFX}moA*%9fTuP+p;nuz6?$o5fPe6D*#h87Z#H z{ru>omC7X>zkm8_t#Ue=Q_t9aq3hpO2gQ1xy<0Cg`C7B%{=mx{lOE@(N|ei3bj@1( z>%qH|x+i9sO+^a0N0D=EtG6*-TpMk^CG#>{`MW!g$NOYKD+8DK&zJlD{{DC7SNs3} z;|{BE=3xyt_+_rfnmplsa-4u8XNKIt=GSw16ZMC6@iN%?YdnxTd>FR z=KTpp(_d>!d|lun{jj$ol=Im6`S!|wb1b?FTe(Cx)c>zzem_+^T#J9fmebSqS6|pz zq0G)F!(nc2Zd3a!Wbd_Aq1s>G+!PL6gsU! z*VontF7Xgl^;_;cyN#V+PNDG8krh!}SG`hyzrW^ZQ0uYnxwqSl)6cCatpD?)@#13l zf_Kna(|xpOfzGsXP^Yb5CXQ-FNm?5~a?Wm)p*W_FNWU=azqb<&EuWW?IuUvl5>D z{L6ksICyDJ;guBuw;m*Z(UsWx|H#w#w~w3uPSl%s>ZbSg$DbCOo|vmUx&OO;-M=P1 z=HrL=xj2em`zAXnZgZ*pwcOkNht@8&&z@^j&_zfwj^y_a6QytS11#OJuz+g|tUR>w@e9=>PM z>*xLfiSPd{PD?o6nEd14WA-lbGtHfccPaaSJJV*k?X7jwMq@E&r=5?^=3ZYS_Nz3r z@p``fg1p^zZP$-l>ntqhyxK4Oq~Y~;`3Da+ZuXd^(fCSV&Ldb?}DQY1K9lT$;n# zGk>edU)iWdg}R>)e>eNP@W|2Mpo#XyErqT*p0iD}r+qTW0`)mQeE1MxujV^Tr2hZk z?LtxO@9!`Fi^sWUoqbojb&E3A; z{I(yy{ZbTd6HnZdbWOu#eRyc={inAYW20Ao`29z8cHz@!u@!UfFYT(YF&FIN&6;xj zL)_b|(MmO~%{}JTZx~b=YTK7gezI=Gv#d8$r(BKHuXIILT#0G@ZM}U> z`||VgEBE*d&Iq3SE8*#~y9E+9jFHC6T;KPdy|AFF^6LMGlheI8PS^QHZ-~0Nvp#FK zP`i?WYlhd0n4&QK`#Tozu-KBEEfd5*BG{QKoD9uJL9o6t`XJ>Nfc~N#P}D zcUXStqjUQwOH;S@iE@!geit9 zI{G?HLi-)}c4|m8d-eSF735g+;^`eZagj5R|H{v;2yye7wY;VA+M6!%2Itjmuk4F5 zXW44Dc}_a9d)Lo}$Bk`jAO1c1;o3%DwQfTfkAcV zF#5Jzhm7SUM}sa0zt9C*ySC>pInow&dat`i%vM#gf2L?1z8P5|4BX-*&eM6Aqs>Vd6(u4)s%!_cn+n zDomW1z3w#+kLm35cfYT??(@{3>qC@jde8Ugf6wmrnv%Kb+;_EEyZ4`u+vj%bPw2(P zvB_s7?)uN1cx9neXw;+E=KfFTUc07p=jdVW+;f+{zA!5hnz!@4<0qBQKP^j45B_*^ zC~t|+G>KD}Gs{E|i~AErC*EP6U6BKyvcjh{|<3il^AvE2KAa!tfWCQ#VpjLWMQ0kX2l!Nr{#xQIIr&i{^sW6zXwgz`5>!f@9(R1?vXG&vs1k3N;`Oq z#Z7spSqFsqqc=9y?SJ5zx+!0OQOEwx@2+q7eSve${X&NLeN|fhGoHN8{I;aSZS^J5 zgNkyNCo`uc7x`?RwDp#zwa_H9t4}n%Dx1R(kO)4mZw=eloY5OaK3#UtjS4V(`@4RU+wnqGfq!uYhw^fbB`p1F z7mmK`wdS9iv2REHRIa7c&)@UTeXwRv{v$(Qf%Dd}9uZeEd^p$JCWuxE^-b zuFbt)FS0f2`@xB4xhGiGN=Gl+tbUn-Y>oOt8Y%* z%Fp2s-ydJTA@{xDRR8MdN79_1{#n<2JaBKSevIXou-19C&kashJ-sKq`_h)*CJPGN zdgdo@df|FW;?uPJRqvJ``dK9LY{&VxCV6)%8P-34&fD~H{_*9Zub8DdUpRu6d997! zK0!Cy?5L~Df)2;EoeeTpB`bbiJb98c_x84CEePwx9W3T zWwgqjva;>o4VFEO2j7|`$cU}E)6>8Gj)3~N`F6Xy(mh>zpERtUX??CeVM_LssFTIo z;j0WbrFwP0i?#FFgR8JtJj+U;6+{Tz*Qc0o8JllFOu+|vztdSV3U~O3Pw&h!Bc_3 zqG83d_DiJe{DXNO?KRcYxTJP@t*^3Zl9`yd(7buOYn1`3VkDzzH@qy^NuL11`dOdQr!tP zRfXn3D!yx`=_@{5b+(#CL!!4oNhrTE;W3Y#{p}?QHUB>Gp1SgO#iyvxDc@)2YsdGw zRD74WJzTIh(wy6RVuK_&yU$xx@mfV?wo$6rj$OO7^5=ByjoVwbvRLxyZuOm=wZFau zIt98+6h)1MDm{&oD@&F`#a=klc0#UQJ)l|JXE8?WX+sPS`}>*wc2Emf-Pjk8x)c^RCt_*8dABd|tubQsbEKxsUlNx`&_Q#SvTaR7; zRNT(;MG3UHb%Bg^8P8Jh|N2uD7WuO*yrxnf;4)oio35+=B^MVj(~U9OXV0DUYh8VR zPi6A7geix_-QC?&-EC?nZO-sA@LJgW#3<{tX7si-Qtq>xW&Y_Zemt;hiFN6#7FKSt z6|Y?+ymrKBt#kczYNDfc*_#CkS6-X9lsQcWO<^#&X!+J|Z~6Fm)si~hC+dk7o)4zW zIC6gWn%GgXVT+Q`|E{<*kuHnRHHQ{9hdlDSH$B9%dv9Q{_^J={Z!cp#<(;M@aoY4v zll6D`#|Ny^zqaN+d$hG}v&{GPbDOibzgz6FHB7>Mhj!GJ^~+YZWN&}D{FAEc9-YK9 z;_L6NG8W{1a<1#@?C+~$EKWLm&ox@Ap<&K9$oXdtMH%{(xy>nvcG|SCt4(A`%Yvw62oSv?= zXjR`*qbRMK>u06c+iWS^d~2oBjD@zhwQdJ}5fVA5aec<-{g?c^O77MFS<+V^)cnR+lq2zz)Vbtk4 zmd4lC#dg>H+~e%q$}Jvt{JV$gmJa9p_TF(x|Ns5vU0AZyEyqK`uKwSjQ`6RT%N<+r z&uYW|rJO8bUz8T!s)NAZy8!1`~UNF{jIaR_>4uacI=pH*{N}fDeoo4j(p}R_|Z6Q9I0Gt$JWnMcuqFN=a*d z?((r6Q<~>$(8V6$vSiLk@;yhawT`MqE!`Hzuqc$b`$qmFgCocHNp{;lytnPV zhx3lOXL?M*Tv1#0xF_ncuQ>hiQPG@U4!6fl;%5(Q?A#EvH+R*{-TNPfPFvFl@57emdT9~*_LXBwp%iR@)5J*_IE z=W1MZq$$iocmnUt+l$@%uLNhh+{hH2<|rA?m7Y?oly!8mq>QwqWSf09-qD8+ebRY*A!E{Z zjpGkIOxL|{QqHyE)aG97!ud#w%f9Ei63@}@Wlx(=-CD9LdPdjrvp*6_-de4csr&Oq z_0m$WyrSHo8%lR-maDK#ZM6KI{bx@mXYlWH*{10}_j!C`g(nq0**CHJ)z8)2{}~yl z&wJy{^h{_&*1-%tmT%lvj9kYS7(W(;jj{%U7L;9?%l)`A*r4qrTR{bMierNUBbOWZ zp>4|+YDlcjG~X!(73Y}2z^eRyLW1Ce1RgQ7I2R@rhYeqyW-u_Yl!DF$0L@GYPGVq9 zZn?8TYP(t19zjX7{f#`Jw^o8r6KRfj46JpbX_-pLaUg59T{KQZT6 z$JY8ex=<(oP*bq%zGUN9?sUk;Sw~MSHRo}`7Dt0$VH5A{>To^q`DbE?Bjy8HsoVejZMtA$dt(`ym?6mn82lY)<(&Se@d}&WM(nQua z&L8XY4LRJ}mgfFG_TUvl#)0DppS$+)Mb8qKOrL1Z33V3uRDqS3i)%RCo*8{ogD!pq z&4JxkO*pmt#qq-$`X4%EZ}0WofjCFtwyHwX#givbKDl|v&ZeiSBhKyi-ar)j2lLA> zE@=<^Y~;0di_EjLNXv><67I4vY1e&woOq?cz$EvsIa|0p%%=`aP6`VGwz!>$Kd7-V zQ?S=&_C#}GghM0L8H>Np+usxzJf|jQLFqk(7*T}e2|=r%7eWzINexXC7fm!5LdZm@ zGj^)Xj@~S^BEh6D*Vra^t~pP*E6mOWYnCm-g=a*&osQ`o%+QfKTNr(duV@`S#Wb)e z@iFSA8?LB2mvc}2tho^9{OmoKZ-j@q)?%PS>{?M;5fr_dTn7r0L@Jf+?OS=NqM-VzIQ7oAn`M zHY~9>u&kNdu+cp5-`aAP2=jw0avOX;otUV+%E4{+hHvvaJTj{^VzciStm{T-_@k_F z%Pad>mG&0dvR&M6_qnG`*t&7XlzM6XY1>&4K?>Te(K9!1TF;Ar_TI;2c>VU=l4M|D OVDNPHb6Mw<&;$T)tAjfL literal 0 HcmV?d00001 diff --git a/docs/en/api-guides/ble/overview.rst b/docs/en/api-guides/ble/overview.rst index 2aa07f2569..e360d210cd 100644 --- a/docs/en/api-guides/ble/overview.rst +++ b/docs/en/api-guides/ble/overview.rst @@ -129,7 +129,7 @@ There are two hosts, ESP-Bluedroid and ESP-NimBLE. The major difference between ESP-Bluedroid ^^^^^^^^^^^^^ -ESP-Bluedroid is a modified version of the native Android Bluetooth stack, Bluedroid. It consists of two layers: the Bluetooth Upper Layer (BTU) and the Bluetooth Transport Controller layer (BTC). The BTU layer is responsible for processing bottom layer Bluetooth protocols such as L2CAP, GATT/ATT, SMP, GAP, and other profiles. The BTU layer provides an interface prefixed with "bta". The BTC layer is mainly responsible for providing a supported interface, prefixed with "esp", to the application layer, processing GATT-based profiles and handling miscellaneous tasks. All the APIs are located in the ESP_API layer. Developers should use the Bluetooth APIs prefixed with "esp". +ESP-Bluedroid is a modified version of the native Android Bluetooth stack, Bluedroid. It consists of two layers: the Bluetooth Upper Layer (BTU) and the Bluetooth Transport Controller layer (BTC). The BTU layer is responsible for processing bottom layer Bluetooth protocols such as L2CAP, GATT/ATT, SMP, GAP, and other profiles. The BTU layer provides an interface prefixed with "bta". The BTC layer is mainly responsible for providing a supported interface, prefixed with "esp", to the application layer, processing GATT-based profiles and handling miscellaneous tasks. All the APIs are located in the ESP_API layer. Developers should use the Bluetooth Low Energy APIs prefixed with "esp". .. only:: esp32 diff --git a/docs/en/api-guides/classic-bt/overview.rst b/docs/en/api-guides/classic-bt/overview.rst index 1f82914b2a..3932ad0aee 100644 --- a/docs/en/api-guides/classic-bt/overview.rst +++ b/docs/en/api-guides/classic-bt/overview.rst @@ -13,14 +13,14 @@ The Classic Bluetooth stack in ESP-IDF is a layered architecture that enables Bl .. only:: esp32 - .. figure:: ../../../_static/bluetooth-architecture-no-ble-mesh.png + .. figure:: ../../../_static/classic-bluetooth.png :align: center :scale: 90% :alt: {IDF_TARGET_NAME} Classic Bluetooth Stack Architecture {IDF_TARGET_NAME} Classic Bluetooth Stack Architecture -The table below shows whether the Classic Bluetooth modules are supported in a specific chip series. +The table below shows whether the Classic Bluetooth Controller are supported in a specific chip series. .. list-table:: :width: 100% @@ -29,28 +29,20 @@ The table below shows whether the Classic Bluetooth modules are supported in a s * - Chip Series - Controller - - ESP-Bluedroid * - ESP32 - Y - - Y * - ESP32-S2 - \– - - \– * - ESP32-S3 - \– - - \– * - ESP32-C2 - \– - - \– * - ESP32-C3 - \- - - \- * - ESP32-C6 - \- - - \- * - ESP32-H2 - \- - - \- The following sections briefly describe each layer and provide quick links to the related documents and application examples. @@ -67,13 +59,13 @@ At the bottom layer is ESP Bluetooth Controller, which encompasses various modul Hosts ----- -There are one host, ESP-Bluedroid, supporting Classic Bluetooth in IDF. +There is one host, ESP-Bluedroid, supporting Classic Bluetooth in IDF. ESP-Bluedroid ^^^^^^^^^^^^^ -ESP-Bluedroid is a modified version of the native Android Bluetooth stack, Bluedroid. It consists of two layers: the Bluetooth Upper Layer (BTU) and the Bluetooth Transport Controller layer (BTC). The BTU layer is responsible for processing bottom layer Bluetooth protocols such as L2CAP, GATT/ATT, SMP, GAP, and other profiles. The BTU layer provides an interface prefixed with "bta". The BTC layer is mainly responsible for providing a supported interface, prefixed with "esp", to the application layer, processing GATT-based profiles and handling miscellaneous tasks. All the APIs are located in the ESP_API layer. Developers should use the Bluetooth APIs prefixed with "esp". +ESP-Bluedroid is a modified version of the native Android Bluetooth stack, Bluedroid. It consists of two layers: the Bluetooth Upper Layer (BTU) and the Bluetooth Transport Controller layer (BTC). The BTU layer is responsible for processing bottom layer Bluetooth protocols such as L2CAP and other profiles. The BTU layer provides an interface prefixed with "bta". The BTC layer is mainly responsible for providing a supported interface, prefixed with "esp", to the application layer and handling miscellaneous tasks. All the APIs are located in the ESP_API layer. Developers should use the Classic Bluetooth APIs prefixed with "esp". - API references @@ -81,11 +73,6 @@ ESP-Bluedroid is a modified version of the native Android Bluetooth stack, Blued - :doc:`../../api-reference/bluetooth/classic_bt` - :example:`Application examples ` -Profiles --------- - -Above the host stacks are the profile implementations by Espressif and some common profiles. Depending on your configuration, these profiles can run on ESP-Bluedroid. - Applications ------------ diff --git a/docs/zh_CN/api-guides/ble/overview.rst b/docs/zh_CN/api-guides/ble/overview.rst index fb124c4f45..62dbc36db0 100644 --- a/docs/zh_CN/api-guides/ble/overview.rst +++ b/docs/zh_CN/api-guides/ble/overview.rst @@ -129,7 +129,7 @@ ESP 蓝牙主机 ESP-Bluedroid ^^^^^^^^^^^^^ -ESP-Bluedroid 是原生 Android 蓝牙协议栈 Bluedroid 的修改版，由两层组成：蓝牙上层 (BTU) 和蓝牙传输控制器层 (BTC)。BTU 层负责处理 L2CAP、GATT/ATT、SMP、GAP 等底层蓝牙协议以及其他配置文件，提供以 "bta" 为前缀的接口。BTC 层主要负责向应用层提供以 "esp" 为前缀的支持接口，并处理基于 GATT 的配置文件以及其他任务。所有的 API 都位于 ESP_API 层，开发者应使用以 "esp" 为前缀的蓝牙 API。 +ESP-Bluedroid 是原生 Android 蓝牙协议栈 Bluedroid 的修改版，由两层组成：蓝牙上层 (BTU) 和蓝牙传输控制器层 (BTC)。BTU 层负责处理 L2CAP、GATT/ATT、SMP、GAP 等底层蓝牙协议以及其他配置文件，提供以 "bta" 为前缀的接口。BTC 层主要负责向应用层提供以 "esp" 为前缀的支持接口，并处理基于 GATT 的配置文件以及其他任务。所有的 API 都位于 ESP_API 层，开发者应使用以 "esp" 为前缀的低功耗蓝牙 API。 .. only:: esp32 diff --git a/docs/zh_CN/api-guides/classic-bt/overview.rst b/docs/zh_CN/api-guides/classic-bt/overview.rst index c090d81056..2c4298d882 100644 --- a/docs/zh_CN/api-guides/classic-bt/overview.rst +++ b/docs/zh_CN/api-guides/classic-bt/overview.rst @@ -13,14 +13,14 @@ ESP-IDF 中的经典蓝牙协议栈是一个分层架构，可在 {IDF_TARGET_NA .. only:: esp32 - .. figure:: ../../../_static/bluetooth-architecture-no-ble-mesh.png + .. figure:: ../../../_static/classic-bluetooth.png :align: center :scale: 90% :alt: {IDF_TARGET_NAME} 经典蓝牙协议栈架构 {IDF_TARGET_NAME} 经典蓝牙协议栈架构 -参考下表可知特定芯片是否支持经典蓝牙模块。 +参考下表可知特定芯片是否支持经典蓝牙控制器。 .. list-table:: :width: 100% @@ -29,28 +29,20 @@ ESP-IDF 中的经典蓝牙协议栈是一个分层架构，可在 {IDF_TARGET_NA * - 芯片系列 - 控制器 - - ESP-Bluedroid * - ESP32 - Y - - Y * - ESP32-S2 - \– - - \– * - ESP32-S3 - \– - - \– * - ESP32-C2 - \- - - \- * - ESP32-C3 - \- - - \- * - ESP32-C6 - \- - - \- * - ESP32-H2 - \- - - \- 以下各节简要介绍了每个层，并提供了相关文档和应用示例的快速链接。 @@ -73,7 +65,7 @@ IDF 中的ESP-Bluedroid 主机支持经典蓝牙。 ESP-Bluedroid ^^^^^^^^^^^^^ -ESP-Bluedroid 是原生 Android 蓝牙协议栈 Bluedroid 的修改版，由两层组成：蓝牙上层 (BTU) 和蓝牙传输控制器层 (BTC)。BTU 层负责处理 L2CAP、GATT/ATT、SMP、GAP 等底层蓝牙协议以及其他配置文件，提供以 "bta" 为前缀的接口。BTC 层主要负责向应用层提供以 "esp" 为前缀的支持接口，并处理基于 GATT 的配置文件以及其他任务。所有的 API 都位于 ESP_API 层，开发者应使用以 "esp" 为前缀的蓝牙 API。 +ESP-Bluedroid 是原生 Android 蓝牙协议栈 Bluedroid 的修改版，由两层组成：蓝牙上层 (BTU) 和蓝牙传输控制器层 (BTC)。BTU 层负责处理 L2CAP 等底层蓝牙协议以及其他配置文件，提供以 "bta" 为前缀的接口。BTC 层主要负责向应用层提供以 "esp" 为前缀的支持接口，并处理其他任务。所有的 API 都位于 ESP_API 层，开发者应使用以 "esp" 为前缀的经典蓝牙 API。 - API 参考 @@ -81,11 +73,6 @@ ESP-Bluedroid 是原生 Android 蓝牙协议栈 Bluedroid 的修改版，由两 - :doc:`经典蓝牙 <../../api-reference/bluetooth/classic_bt>` - :example:`应用程序示例 ` -蓝牙规范 --------- - -主机协议层之上是 Espressif 的蓝牙规范和一些常见的蓝牙规范。根据具体配置，这些规范可以在 ESP-Bluedroid 上运行。 - 应用 ---- From d5c35d8b9b1e294be4d2834a01a2bdc097c1d58f Mon Sep 17 00:00:00 2001 From: Yuhan Wei Date: Thu, 25 Jul 2024 15:44:47 +0800 Subject: [PATCH 12/14] docs(ble): Fixed the image name in classic-bt/overview.rst --- docs/en/api-guides/classic-bt/overview.rst | 2 +- docs/zh_CN/api-guides/classic-bt/overview.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/en/api-guides/classic-bt/overview.rst b/docs/en/api-guides/classic-bt/overview.rst index 3932ad0aee..5707c51323 100644 --- a/docs/en/api-guides/classic-bt/overview.rst +++ b/docs/en/api-guides/classic-bt/overview.rst @@ -13,7 +13,7 @@ The Classic Bluetooth stack in ESP-IDF is a layered architecture that enables Bl .. only:: esp32 - .. figure:: ../../../_static/classic-bluetooth.png + .. figure:: ../../../_static/classic-bluetooth-architecture.png :align: center :scale: 90% :alt: {IDF_TARGET_NAME} Classic Bluetooth Stack Architecture diff --git a/docs/zh_CN/api-guides/classic-bt/overview.rst b/docs/zh_CN/api-guides/classic-bt/overview.rst index 2c4298d882..53a1e3eac3 100644 --- a/docs/zh_CN/api-guides/classic-bt/overview.rst +++ b/docs/zh_CN/api-guides/classic-bt/overview.rst @@ -13,7 +13,7 @@ ESP-IDF 中的经典蓝牙协议栈是一个分层架构，可在 {IDF_TARGET_NA .. only:: esp32 - .. figure:: ../../../_static/classic-bluetooth.png + .. figure:: ../../../_static/classic-bluetooth-architecture.png :align: center :scale: 90% :alt: {IDF_TARGET_NAME} 经典蓝牙协议栈架构 From 524549fdb25e30aa88855d1ff07354c0b48e3bf3 Mon Sep 17 00:00:00 2001 From: Wei Yu Han Date: Fri, 26 Jul 2024 17:16:48 +0800 Subject: [PATCH 13/14] docs(ble): Replaced Classic Bluetooth with Bluetooth Classic --- docs/en/api-guides/classic-bt/index.rst | 2 +- docs/en/api-guides/classic-bt/overview.rst | 12 ++++++------ 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/en/api-guides/classic-bt/index.rst b/docs/en/api-guides/classic-bt/index.rst index 7c8195bca6..e6e9141c70 100644 --- a/docs/en/api-guides/classic-bt/index.rst +++ b/docs/en/api-guides/classic-bt/index.rst @@ -1,5 +1,5 @@ ####################### -Classic Bluetooth® +Bluetooth® Classic ####################### :link_to_translation:`zh_CN:[中文]` diff --git a/docs/en/api-guides/classic-bt/overview.rst b/docs/en/api-guides/classic-bt/overview.rst index 5707c51323..4c28f800e8 100644 --- a/docs/en/api-guides/classic-bt/overview.rst +++ b/docs/en/api-guides/classic-bt/overview.rst @@ -3,24 +3,24 @@ Introduction :link_to_translation:`zh_CN:[中文]` -This document provides an architecture overview of the Classic Bluetooth stack in ESP-IDF and some quick links to related documents and application examples. +This document provides an architecture overview of the Bluetooth Classic stack in ESP-IDF and some quick links to related documents and application examples. .. only:: esp32 {IDF_TARGET_NAME} supports Dual-Mode Bluetooth 4.2. -The Classic Bluetooth stack in ESP-IDF is a layered architecture that enables Bluetooth functionality on {IDF_TARGET_NAME} chip series. The table below shows its architecture. +The Bluetooth Classic stack in ESP-IDF is a layered architecture that enables Bluetooth functionality on {IDF_TARGET_NAME} chip series. The table below shows its architecture. .. only:: esp32 .. figure:: ../../../_static/classic-bluetooth-architecture.png :align: center :scale: 90% - :alt: {IDF_TARGET_NAME} Classic Bluetooth Stack Architecture + :alt: {IDF_TARGET_NAME} Bluetooth Classic Stack Architecture - {IDF_TARGET_NAME} Classic Bluetooth Stack Architecture + {IDF_TARGET_NAME} Bluetooth Classic Stack Architecture -The table below shows whether the Classic Bluetooth Controller are supported in a specific chip series. +The table below shows whether the Bluetooth Classic Controller are supported in a specific chip series. .. list-table:: :width: 100% @@ -77,4 +77,4 @@ ESP-Bluedroid is a modified version of the native Android Bluetooth stack, Blued Applications ------------ -At the uppermost layer are applications. You can build your own applications on top of the ESP-Bluedroid stacks, leveraging the provided APIs and profiles to create Classic Bluetooth applications tailored to specific use cases. +At the uppermost layer are applications. You can build your own applications on top of the ESP-Bluedroid stacks, leveraging the provided APIs and profiles to create Bluetooth Classic applications tailored to specific use cases. From 182e2c17bafc80376cf70289dbfec1056691fe9e Mon Sep 17 00:00:00 2001 From: Wei Yu Han Date: Mon, 29 Jul 2024 09:54:19 +0800 Subject: [PATCH 14/14] docs(bluetooth): Repaced Classic Bluetooth with Bluetooth Classic in API reference section name --- docs/en/api-reference/bluetooth/classic_bt.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/en/api-reference/bluetooth/classic_bt.rst b/docs/en/api-reference/bluetooth/classic_bt.rst index a1f861bb50..0fc595fb79 100644 --- a/docs/en/api-reference/bluetooth/classic_bt.rst +++ b/docs/en/api-reference/bluetooth/classic_bt.rst @@ -1,8 +1,8 @@ -Classic Bluetooth® -================== +Bluetooth® Classic +=================== .. toctree:: - :caption: Classic Bluetooth + :caption: Bluetooth Classic Bluetooth GAP Bluetooth A2DP