alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2025-08-07 20:00:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(bt): fixed some doc error and add ocf parameters description

Browse Source
This commit is contained in:
zhiweijian
2025-03-24 15:38:14 +08:00
committed by Shen Weilong
parent 3a71bec278
commit a24fdf2892
10 changed files with 570 additions and 56 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
docs/en/api-reference/bluetooth/bt_vhci.rst
View File

@@ -1,6 +1,6 @@
:orphan:
HCI Vendor-specific (VS) Command
HCI Vendor-specific (VS) Commands
==========================================
:link_to_translation:`zh_CN:[中文]`
@@ -8,10 +8,7 @@ HCI Vendor-specific (VS) Command
HCI VS Commands for Espressif's Bluetooth Host
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The following HCI VS commands are exclusively for Espressif's Bluetooth Host (ESP-Bluedroid Host or ESP-NimBLE Host).
If you are using a non-ESP host or HCI UART, these commands will remain disabled unless the initialization function is explicitly called from the application.
Note, these init functions as well as these additional HCI VS commands are intended for Espressif's Bluetooth Host use only.
Application developers **should not** call the init functions in their applications.
The following HCI VS commands are exclusively for Espressif's Bluetooth Host (ESP-Bluedroid Host or ESP-NimBLE Host). If you are using a non-ESP host or HCI UART, these commands will remain disabled unless the initialization function is explicitly called from the application. Note, these init functions as well as these additional HCI VS commands are intended for Espressif's Bluetooth Host use only. Application developers **should not** call the init functions in their applications.
.. only:: esp32
@@ -63,10 +60,7 @@ Application developers **should not** call the init functions in their applicati
HCI VS Events for Espressif's Bluetooth Host
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The following HCI VS events are exclusively for Espressif's Bluetooth Host (ESP-Bluedroid Host or ESP-NimBLE Host).
If you are using a non-ESP host or HCI UART, these events will remain disabled unless the initialization function is explicitly called from the application.
Note, these init functions as well as these additional HCI VS events are intended for Espressif's Bluetooth Host use only.
Application developers **should not** call the init functions in their applications.
The following HCI VS events are exclusively for Espressif's Bluetooth Host (ESP-Bluedroid Host or ESP-NimBLE Host). If you are using a non-ESP host or HCI UART, these events will remain disabled unless the initialization function is explicitly called from the application. Note, these init functions as well as these additional HCI VS events are intended for Espressif's Bluetooth Host use only. Application developers **should not** call the init functions in their applications.
.. only:: esp32
@@ -96,13 +90,10 @@ Application developers **should not** call the init functions in their applicati
.. doxygendefine:: ESP_BT_VS_LE_ADV_LOST_EVT_SUBCODE
HCI VS Commands for Espressif's Internal-Use Debugging
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The following HCI VS debugging commands are implemented in Bluetooth Low Energy controller pre-compiled libraries.
These commands are not linked into the application binary, unless the function `esp_ble_internalTestFeaturesEnable(true)` is called from the application.
They are intended for Espressif's internal use only. Application developers **should not** call `esp_ble_internalTestFeaturesEnable(true)` in their applications.
The following HCI VS debugging commands are implemented in Bluetooth Low Energy controller pre-compiled libraries. These commands are not linked into the application binary, unless the function `esp_ble_internalTestFeaturesEnable(true)` is called from the application. They are intended for Espressif's internal use only. Application developers **should not** call `esp_ble_internalTestFeaturesEnable(true)` in their applications.
.. only:: esp32
@@ -125,9 +116,7 @@ They are intended for Espressif's internal use only. Application developers **sh
.. doxygendefine:: ESP_BT_VS_CFG_TEST_GET_CTRL_COMPILE_VER_SUBCMD
.. doxygendefine:: ESP_BT_VS_CFG_TEST_RELATED_SUBCMD_MAX
The following HCI VS debugging commands are implemented in Bluetooth Classic controller pre-compiled libraries.
These commands are not linked into the application binary, unless the corresponding initialization function is explicitly called from the application.
They are intended for Espressif's internal use only. Application developers **should not** call in their applications.
The following HCI VS debugging commands are implemented in Bluetooth Classic controller pre-compiled libraries. These commands are not linked into the application binary, unless the corresponding initialization function is explicitly called from the application. They are intended for Espressif's internal use only. Application developers **should not** call in their applications.
.. doxygendefine:: ESP_BT_VS_WR_DM1_ENABLE_OCF
.. doxygendefine:: ESP_BT_VS_CLK_UPDATE_OCF
@@ -279,9 +268,7 @@ They are intended for Espressif's internal use only. Application developers **sh
HCI VS Events for Espressif's Internal-Use Debugging
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The following HCI VS debugging events are implemented in Bluetooth controller pre-compiled libraries.
These events are not linked into the application binary and are intended for Espressif's internal use only.
Application developers **should not** call the corresponding initialization function in their applications.
The following HCI VS debugging events are implemented in Bluetooth controller pre-compiled libraries. These events are not linked into the application binary and are intended for Espressif's internal use only. Application developers **should not** call the corresponding initialization function in their applications.
.. only:: esp32

4
docs/en/api-reference/bluetooth/controller_vhci.rst
View File

@@ -1,4 +1,4 @@
Controller && HCI
Controller & HCI
==================================================
:link_to_translation:`zh_CN:[中文]`
@@ -29,5 +29,5 @@ API Reference
HCI Vendor-specific (VS) Commands
--------------------------------------
Espressif's HCI VS commands are exclusively designed for use with Espressif's Bluetooth Host stack or internal debugging purposes. Application developers **should not** initialize or invoke these VS commands in their applications. Please refer :doc:`Espressif-specific HCI Command <bt_vhci>` for detailed information.
Espressif's HCI VS commands are exclusively designed for use with Espressif's Bluetooth Host stack or internal debugging purposes. Application developers **should not** initialize or invoke these VS commands in their applications. Please refer to :doc:`bt_vhci` for detailed information.