openthread_sys

Function otThreadWakeup

Source 
pub unsafe extern "C" fn otThreadWakeup(
    aInstance: *mut otInstance,
    aWedAddress: *const otExtAddress,
    aWakeupIntervalUs: u16,
    aWakeupDurationMs: u16,
    aCallback: otWakeupCallback,
    aCallbackContext: *mut c_void,
) -> otError
Expand description

Attempts to wake a Wake-up End Device.

Requires OPENTHREAD_CONFIG_WAKEUP_COORDINATOR_ENABLE to be enabled.

The wake-up starts with transmitting a wake-up frame sequence to the Wake-up End Device. During the wake-up sequence, and for a short time after the last wake-up frame is sent, the Wake-up Coordinator keeps its receiver on to be able to receive an initial mesh link establishment message from the WED.

@warning The functionality implemented by this function is still in the design phase. Consequently, the prototype and semantics of this function are subject to change.

@param[in] aInstance A pointer to an OpenThread instance. @param[in] aWedAddress The extended address of the Wake-up End Device. @param[in] aWakeupIntervalUs An interval between consecutive wake-up frames (in microseconds). @param[in] aWakeupDurationMs Duration of the wake-up sequence (in milliseconds). @param[in] aCallback A pointer to function that is called when the wake-up succeeds or fails. @param[in] aCallbackContext A pointer to callback application-specific context.

@retval OT_ERROR_NONE Successfully started the wake-up. @retval OT_ERROR_INVALID_STATE Another attachment request is still in progress. @retval OT_ERROR_INVALID_ARGS The wake-up interval or duration are invalid.