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

doc(bt): Add description for de-initialize bt controller

Browse Source
This commit is contained in:
xiewenxiang
2022-03-10 10:40:12 +08:00
parent 228cbc4dae
commit ac3fbccbe1
3 changed files with 6 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
components/bt/include/esp32/include/esp_bt.h
View File

@@ -326,6 +326,8 @@ esp_err_t esp_bt_controller_init(esp_bt_controller_config_t *cfg);
/** /**
* @brief De-initialize BT controller to free resource and delete task. * @brief De-initialize BT controller to free resource and delete task.
* You should stop advertising and scanning, as well as
* disconnect all existing connections before de-initializing BT controller.
* *
* This function should be called only once, after any other BT functions are called. * This function should be called only once, after any other BT functions are called.
* @return ESP_OK - success, other - failed * @return ESP_OK - success, other - failed

2
components/bt/include/esp32c3/include/esp_bt.h
View File

@@ -337,6 +337,8 @@ esp_err_t esp_bt_controller_init(esp_bt_controller_config_t *cfg);
/** /**
* @brief De-initialize BT controller to free resource and delete task. * @brief De-initialize BT controller to free resource and delete task.
* You should stop advertising and scanning, as well as
* disconnect all existing connections before de-initializing BT controller.
* *
* This function should be called only once, after any other BT functions are called. * This function should be called only once, after any other BT functions are called.
* This function is not whole completed, esp_bt_controller_init cannot called after this function. * This function is not whole completed, esp_bt_controller_init cannot called after this function.

2
components/bt/include/esp32s3/include/esp_bt.h
View File

@@ -260,6 +260,8 @@ esp_err_t esp_bt_controller_init(esp_bt_controller_config_t *cfg);
/** /**
* @brief De-initialize BT controller to free resource and delete task. * @brief De-initialize BT controller to free resource and delete task.
* You should stop advertising and scanning, as well as
* disconnect all existing connections before de-initializing BT controller.
* *
* This function should be called only once, after any other BT functions are called. * This function should be called only once, after any other BT functions are called.
* This function is not whole completed, esp_bt_controller_init cannot called after this function. * This function is not whole completed, esp_bt_controller_init cannot called after this function.