Function esp_idf_svc::hal::sys::esp_wifi_ftm_get_report

source ยท
pub unsafe extern "C" fn esp_wifi_ftm_get_report(
    report: *mut wifi_ftm_report_entry_t,
    num_entries: u8,
) -> i32
Expand description

@brief Get FTM measurements report copied into a user provided buffer.

@attention 1. To get the FTM report, user first needs to allocate a buffer of size (sizeof(wifi_ftm_report_entry_t) * num_entries) where the API will fill up to num_entries valid FTM measurements in the buffer. Total number of entries can be found in the event WIFI_EVENT_FTM_REPORT as ftm_report_num_entries @attention 2. The internal FTM report is freed upon use of this API which means the API can only be used once afer every FTM session initiated @attention 3. Passing the buffer as NULL merely frees the FTM report

@param report Pointer to the buffer for receiving the FTM report @param num_entries Number of FTM report entries to be filled in the report

@return

  • ESP_OK: succeed
  • others: failed