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

docs(ble): clarify meaning of 0 value for esp_ble_gap_start_ext_scan() parameters

Browse Source 
(cherry picked from commit ebb76933d0)

Co-authored-by: zhanghaipeng <zhanghaipeng@espressif.com>
This commit is contained in:
Zhang Hai Peng
2025-05-13 16:14:07 +08:00
parent 4f050ed635
commit 901fc0c9ac
1 changed files with 7 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
components/bt/host/bluedroid/api/include/api/esp_gap_ble_api.h
View File

@ -2730,15 +2730,17 @@ esp_err_t esp_ble_gap_periodic_adv_stop(uint8_t instance);
esp_err_t esp_ble_gap_set_ext_scan_params(const esp_ble_ext_scan_params_t *params);
/**
* @brief This function is used to enable scanning.
* @brief Enables extended scanning.
*
* @param[in] duration Scan duration time, where Time = N * 10 ms. Range: 0x0001 to 0xFFFF.
* @param[in] period Time interval from when the Controller started its last Scan Duration until it begins the subsequent Scan Duration.
* Time = N * 1.28 sec. Range: 0x0001 to 0xFFFF.
* @param[in] duration Scan duration in units of 10 ms.
* - Range: 0x0001 to 0xFFFF (Time = N * 10 ms).
* - 0x0000: Scan continuously until explicitly disabled.
*
* @param[in] period Time interval between the start of consecutive scan durations, in units of 1.28 seconds.
* - Range: 0x0001 to 0xFFFF (Time = N * 1.28 sec).
* - 0x0000: Scan continuously.
* @return - ESP_OK : success
* - other : failed
*
*/
esp_err_t esp_ble_gap_start_ext_scan(uint32_t duration, uint16_t period);