Merge branch 'docs/add_application_examples_bluetooth' into 'master'

docs: update application examples for bluedroid and blufi

See merge request espressif/esp-idf!32185
This commit is contained in:
Zhang Xiao Yan
2024-09-03 18:07:05 +08:00
16 changed files with 75 additions and 107 deletions
@@ -6,20 +6,11 @@ GAP API
应用示例
-------------------
以下示例及其教程存放在 ESP-IDF 项目示例的 :example:`bluetooth/bluedroid/ble` 目录下
- :example:`bluetooth/bluedroid/ble/gatt_security_client` 演示使用 ESP BLE security API{IDF_TARGET_NAME} 作为 GATT 客户端时如何建立安全连接并加密与对等设备的通信
* 以下为 SMP(安全管理协议)安全客户端示例及教程。该示例程序会初始化其安全参数,并充当 GATT 客户端,可向对端设备发送安全请求,完成加密过程
- :example:`bluetooth/bluedroid/ble/gatt_security_client`
- :example_file:`GATT 安全客户端示例演示 <bluetooth/bluedroid/ble/gatt_security_client/tutorial/Gatt_Security_Client_Example_Walkthrough.md>`
* 以下为 SMP 安全服务器示例及其教程。该示例程序会初始化其安全参数,并充当 GATT 客户端,可向对端设备发送配对请求,完成加密过程。
- :example:`bluetooth/bluedroid/ble/gatt_security_server`
- :example_file:`GATT 安全服务器示例演示 <bluetooth/bluedroid/ble/gatt_security_server/tutorial/Gatt_Security_Server_Example_Walkthrough.md>`
- :example:`bluetooth/bluedroid/ble/gatt_security_server` 演示使用 ESP BLE security API{IDF_TARGET_NAME} 作为 GATT 服务器时如何建立安全连接并加密与对等设备的通信
API 参考
-------------
.. include-build-file:: inc/esp_gap_ble_api.inc
@@ -6,24 +6,11 @@ GATT 服务器 API
应用示例
-------------------
以下示例及其教程存放在 ESP-IDF 示例的 :example:`bluetooth/bluedroid/ble` 目录下:
- :example:`bluetooth/bluedroid/ble/gatt_server_service_table` 演示如何使用属性表创建 GATT Service,从而无需逐个添加属性。
* 以下为 GATT 服务器示例及其教程,该示例创建了一个带有属性表的 GATT 服务器,无需逐个添加属性。建议通过以下方式添加属性(官方推荐)
- :example:`bluetooth/bluedroid/ble/gatt_server_service_table`
- :example_file:`GATT 服务器服务表示例 <bluetooth/bluedroid/ble/gatt_server_service_table/tutorial/Gatt_Server_Service_Table_Example_Walkthrough.md>`
* 以下为 GATT 服务器示例及其教程,该示例逐个添加 Bluedroid 定义的属性,创建 GATT 服务。建议通过以下方式添加属性。
- :example:`bluetooth/bluedroid/ble/gatt_server`
- :example_file:`GATT 服务器示例 <bluetooth/bluedroid/ble/gatt_server/tutorial/Gatt_Server_Example_Walkthrough.md>`
* 以下示例与低功耗蓝牙 (Bluetooth® LE) SPP 类似。在该示例中,GATT 服务器可以接收来自 UART 的数据,并将数据自动发送到对端设备。
- :example:`bluetooth/bluedroid/ble/ble_spp_server`
- :example:`bluetooth/bluedroid/ble/gatt_server` 演示如何逐个添加属性来创建 GATT Service,并开始广播,以便 GATT Client 进行连接并交换数据
API 参考
-------------
.. include-build-file:: inc/esp_gatts_api.inc