Merge branch 'docs/update_bt_common_homepage' into 'master'

docs: Add intro and brief descriptions to Bluetooth Common API home page

Closes DOC-11910

See merge request espressif/esp-idf!42582
This commit is contained in:
Lu Wei Ke
2025-11-21 00:20:14 +08:00
2 changed files with 64 additions and 4 deletions

View File

@@ -1,9 +1,35 @@
Bluetooth® Common
=================
Bluetooth\ :sup:`®` Common
===============================
:link_to_translation:`zh_CN:[中文]`
**Bluetooth Common** provides shared definitions and APIs used by both Bluetooth Classic and Bluetooth Low Energy (Bluetooth LE). It serves as a foundation for shared functionality across Bluetooth components, offering unified interfaces for Bluetooth initialization, configuration, and device management.
The Bluetooth Common API is organized into the following parts:
.. toctree::
:caption: Bluetooth Common Defines and APIs
:maxdepth: 1
Bluetooth Define <esp_bt_defs>
Provides shared definitions and data structures used by both Bluetooth Classic and Bluetooth LE.
.. toctree::
:maxdepth: 1
Bluetooth Main <esp_bt_main>
Provides core APIs for initializing, enabling/disabling, and managing the Bluetooth stack.
.. toctree::
:maxdepth: 1
Bluetooth Device <esp_bt_device>
Provides APIs for managing device-level properties such as address, name, visibility, and coexistence settings.
Each part typically includes the following sections:
- **Overview**: Summary of purpose, key functionality, and main interfaces
- **Application Examples**: Example projects demonstrating typical usage
- **API Reference**: Detailed API documentation, including header files, functions, structures, macros, type definitions, and enumerations

View File

@@ -1 +1,35 @@
.. include:: ../../../en/api-reference/bluetooth/bt_common.rst
蓝牙\ :sup:`®` 通用 API
=========================
:link_to_translation:`en:[English]`
**蓝牙通用 API** 提供经典蓝牙和低功耗蓝牙共用的定义和 API。它为各蓝牙组件提供基础功能提供统一的接口用于蓝牙初始化、配置和设备管理。
蓝牙通用 API 包含以下部分:
.. toctree::
:maxdepth: 1
Bluetooth Define <esp_bt_defs>
提供经典蓝牙和低功耗蓝牙共用的定义和数据结构。
.. toctree::
:maxdepth: 1
Bluetooth Main <esp_bt_main>
提供核心 API用于初始化、启用/禁用和管理蓝牙主机栈。
.. toctree::
:maxdepth: 1
Bluetooth Device <esp_bt_device>
提供设备级 API用于管理设备属性例如地址、名称、可见性和共存设置。
每个部分通常包含以下内容:
- **概述** 主要用途、核心功能和关键接口
- **应用示例**:展示典型使用场景的示例
- **API 参考**:详细 API 文档,包括头文件、函数、结构体、宏、类型定义和枚举