alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Merge branch 'doc/ble_deinit_v4.4' into 'release/v4.4'

Browse Source 
doc(bt): Add description for de-initialize bt controller(backport release/v4.4)

See merge request espressif/esp-idf!18928
This commit is contained in:
Jiang Jiang Jian 2022-07-10 15:37:50 +08:00
commit 3ab8c3fff4
3 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -354,6 +354,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

@ -336,6 +336,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.