Function esp_idf_hal::sys::vTimerSetReloadMode

source ·
pub unsafe extern "C" fn vTimerSetReloadMode(
    xTimer: *mut tmrTimerControl,
    uxAutoReload: u32,
)
Expand description

void vTimerSetReloadMode( TimerHandle_t xTimer, const UBaseType_t uxAutoReload );

Updates a timer to be either an auto-reload timer, in which case the timer automatically resets itself each time it expires, or a one-shot timer, in which case the timer will only expire once unless it is manually restarted.

@param xTimer The handle of the timer being updated.

@param uxAutoReload If uxAutoReload is set to pdTRUE then the timer will expire repeatedly with a frequency set by the timer’s period (see the xTimerPeriodInTicks parameter of the xTimerCreate() API function). If uxAutoReload is set to pdFALSE then the timer will be a one-shot timer and enter the dormant state after it expires.