docs(ble): Created an independent BLE folder

This commit is contained in:
Yuhan Wei
2024-07-16 14:18:41 +08:00
committed by Wei Yu Han
parent e4b3fe2f46
commit c6f974e689
9 changed files with 39 additions and 71 deletions

View File

@@ -16,10 +16,7 @@ from esp_docs.conf_docs import * # noqa: F403,F401
if os.environ.get('IDF_PATH') is None: if os.environ.get('IDF_PATH') is None:
raise RuntimeError('IDF_PATH should be set, run export.sh before building docs') raise RuntimeError('IDF_PATH should be set, run export.sh before building docs')
BT_DOCS = ['api-guides/bluetooth.rst', BT_DOCS = ['api-reference/bluetooth/esp_bt_defs.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_device.rst',
'api-reference/bluetooth/esp_bt_main.rst', 'api-reference/bluetooth/esp_bt_main.rst',
'api-reference/bluetooth/bt_common.rst', 'api-reference/bluetooth/bt_common.rst',
@@ -27,7 +24,8 @@ BT_DOCS = ['api-guides/bluetooth.rst',
'api-reference/bluetooth/index.rst'] 'api-reference/bluetooth/index.rst']
BLE_DOCS = ['api-reference/bluetooth/bt_le.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_gap_ble.rst',
'api-reference/bluetooth/esp_gatt_defs.rst', 'api-reference/bluetooth/esp_gatt_defs.rst',
'api-reference/bluetooth/esp_gatts.rst', 'api-reference/bluetooth/esp_gatts.rst',

View File

@@ -0,0 +1,10 @@
Bluetooth® Low Energy (Bluetooth LE)
====================================
:link_to_translation:`zh_CN:[中文]`
Overview
--------
.. toctree::
:maxdepth: 1
overview

View File

@@ -3,7 +3,7 @@ Introduction
:link_to_translation:`zh_CN:[中文]` :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 .. 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. {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 .. only:: esp32 or esp32s3 or esp32c3 or esp32c6
.. figure:: ../../../_static/bluetooth-architecture.png .. figure:: ../../../_static/bluetooth-architecture.png
:align: center :align: center
:scale: 90% :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 .. only:: esp32c2
.. figure:: ../../../_static/bluetooth-architecture-no-ble-mesh.png .. figure:: ../../../_static/bluetooth-architecture-no-ble-mesh.png
:align: center :align: center
:scale: 90% :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 .. only:: esp32h2
.. figure:: ../../../_static/bluetooth-architecture-no-blufi.png .. figure:: ../../../_static/bluetooth-architecture-no-blufi.png
:align: center :align: center
:scale: 90% :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:: .. list-table::
:width: 100% :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:`../../api-reference/bluetooth/bt_common`
- :doc:`Bluetooth LE <../../api-reference/bluetooth/bt_le>` - :doc:`Bluetooth LE <../../api-reference/bluetooth/bt_le>`
.. only:: esp32
- :doc:`../../api-reference/bluetooth/classic_bt`
- :example:`Application examples <bluetooth/bluedroid>` - :example:`Application examples <bluetooth/bluedroid>`
@@ -198,4 +193,4 @@ Above the host stacks are the profile implementations by Espressif and some comm
Applications 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.

View File

@@ -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

View File

@@ -8,7 +8,7 @@ API Guides
app_trace app_trace
startup startup
:SOC_BLUFI_SUPPORTED: blufi :SOC_BLUFI_SUPPORTED: blufi
:SOC_BT_SUPPORTED: bluetooth/index :SOC_BLE_SUPPORTED: ble/index
bootloader bootloader
build-system build-system
:SOC_SUPPORT_COEXISTENCE: coexist :SOC_SUPPORT_COEXISTENCE: coexist

View File

@@ -0,0 +1,10 @@
蓝牙®
=========
:link_to_translation:`en:[English]`
概述
--------
.. toctree::
:maxdepth: 1
overview

View File

@@ -3,7 +3,7 @@
:link_to_translation:`en:[English]` :link_to_translation:`en:[English]`
此文档概述了 ESP-IDF 中蓝牙协议栈的架构,并提供了一些相关文档和应用示例的快速链接。 此文档概述了 ESP-IDF 中低功耗蓝牙协议栈的架构,并提供了一些相关文档和应用示例的快速链接。
.. only:: esp32 .. only:: esp32
@@ -17,7 +17,7 @@
{IDF_TARGET_NAME} 支持蓝牙 5.0 (LE),并且已经获得蓝牙 LE 5.3 认证。 {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 .. only:: esp32 or esp32s3 or esp32c3 or esp32c6
@@ -46,7 +46,7 @@ ESP-IDF 中的蓝牙协议栈是一个分层架构,可在 {IDF_TARGET_NAME}
{IDF_TARGET_NAME} 蓝牙协议栈架构 {IDF_TARGET_NAME} 蓝牙协议栈架构
参考下表可知特定芯片是否支持蓝牙模块。 参考下表可知特定芯片是否支持低功耗蓝牙模块。
.. list-table:: .. list-table::
:width: 100% :width: 100%
@@ -143,11 +143,6 @@ ESP-Bluedroid 是原生 Android 蓝牙协议栈 Bluedroid 的修改版,由两
- :doc:`../../api-reference/bluetooth/bt_common` - :doc:`../../api-reference/bluetooth/bt_common`
- :doc:`低功耗蓝牙 <../../api-reference/bluetooth/bt_le>` - :doc:`低功耗蓝牙 <../../api-reference/bluetooth/bt_le>`
.. only:: esp32
- :doc:`../../api-reference/bluetooth/classic_bt`
- :example:`应用程序示例 <bluetooth/bluedroid>` - :example:`应用程序示例 <bluetooth/bluedroid>`
@@ -198,4 +193,4 @@ ESP-NimBLE 仅支持低功耗蓝牙,不支持经典蓝牙。
应用 应用
---- ----
最上层是应用层。利用上述 API 和蓝牙规范,可以在 ESP-Bluedroid 和 ESP-NimBLE 协议栈之上创建特定用例的蓝牙应用程序。 最上层是应用层。利用上述 API 和蓝牙规范,可以在 ESP-Bluedroid 和 ESP-NimBLE 协议栈之上创建特定用例的低功耗蓝牙应用程序。

View File

@@ -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

View File

@@ -8,7 +8,7 @@ API 指南
app_trace app_trace
startup startup
:SOC_BLUFI_SUPPORTED: blufi :SOC_BLUFI_SUPPORTED: blufi
:SOC_BT_SUPPORTED: bluetooth/index :SOC_BLE_SUPPORTED: ble/index
bootloader bootloader
build-system build-system
:SOC_SUPPORT_COEXISTENCE: coexist :SOC_SUPPORT_COEXISTENCE: coexist