openthread_sys

Function otLinkEnergyScan

Source
pub unsafe extern "C" fn otLinkEnergyScan(
    aInstance: *mut otInstance,
    aScanChannels: u32,
    aScanDuration: u16,
    aCallback: otHandleEnergyScanResult,
    aCallbackContext: *mut c_void,
) -> otError
Expand description

Starts an IEEE 802.15.4 Energy Scan

@param[in] aInstance A pointer to an OpenThread instance. @param[in] aScanChannels A bit vector indicating on which channels to perform energy scan. @param[in] aScanDuration The time in milliseconds to spend scanning each channel. @param[in] aCallback A pointer to a function called to pass on scan result on indicate scan completion. @param[in] aCallbackContext A pointer to application-specific context.

@retval OT_ERROR_NONE Accepted the Energy Scan request. @retval OT_ERROR_BUSY Could not start the energy scan.