Function openthread_sys::otPlatRadioEnergyScan

source · 
pub unsafe extern "C" fn otPlatRadioEnergyScan(
    aInstance: *mut otInstance,
    aScanChannel: u8,
    aScanDuration: u16,
) -> otError
Expand description

Begin the energy scan sequence on the radio.

Is used when radio provides OT_RADIO_CAPS_ENERGY_SCAN capability.

@param[in] aInstance The OpenThread instance structure. @param[in] aScanChannel The channel to perform the energy scan on. @param[in] aScanDuration The duration, in milliseconds, for the channel to be scanned.

@retval OT_ERROR_NONE Successfully started scanning the channel. @retval OT_ERROR_BUSY The radio is performing energy scanning. @retval OT_ERROR_NOT_IMPLEMENTED The radio doesn’t support energy scanning.