openthread_sys

Function otCommissionerEnergyScan

Source
pub unsafe extern "C" fn otCommissionerEnergyScan(
    aInstance: *mut otInstance,
    aChannelMask: u32,
    aCount: u8,
    aPeriod: u16,
    aScanDuration: u16,
    aAddress: *const otIp6Address,
    aCallback: otCommissionerEnergyReportCallback,
    aContext: *mut c_void,
) -> otError
Expand description

Sends an Energy Scan Query message.

@param[in] aInstance A pointer to an OpenThread instance. @param[in] aChannelMask The channel mask value. @param[in] aCount The number of energy measurements per channel. @param[in] aPeriod The time between energy measurements (milliseconds). @param[in] aScanDuration The scan duration for each energy measurement (milliseconds). @param[in] aAddress A pointer to the IPv6 destination. @param[in] aCallback A pointer to a function called on receiving an Energy Report message. @param[in] aContext A pointer to application-specific context.

@retval OT_ERROR_NONE Successfully enqueued the Energy Scan Query message. @retval OT_ERROR_NO_BUFS Insufficient buffers to generate an Energy Scan Query message. @retval OT_ERROR_INVALID_STATE The commissioner is not active.

@note Only use this after successfully starting the Commissioner role with otCommissionerStart().