Function openthread_sys::otLinkSetCslPeriod

source · 
pub unsafe extern "C" fn otLinkSetCslPeriod(
    aInstance: *mut otInstance,
    aPeriod: u32
) -> otError
Expand description

Sets the CSL period in microseconds. Disable CSL by setting this parameter to 0.

The CSL period MUST be a multiple of OT_LINK_CSL_PERIOD_TEN_SYMBOLS_UNIT_IN_USEC, otherwise OT_ERROR_INVALID_ARGS is returned.

@param[in] aInstance A pointer to an OpenThread instance. @param[in] aPeriod The CSL period in microseconds.

@retval OT_ERROR_NONE Successfully set the CSL period. @retval OT_ERROR_INVALID_ARGS Invalid CSL period