vTimerSetTimerID() function

The timer being updated.

The ID to assign to the timer.

Start or restart a timer.

const char * const pcTimerGetName( TimerHandle_t xTimer ); Returns the name that was assigned to a timer when the timer was created.

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.

UBaseType_t uxTimerGetReloadMode( TimerHandle_t xTimer ); Queries a timer to determine if it is 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.

TickType_t xTimerGetPeriod( TimerHandle_t xTimer ); Returns the period of a timer.

TickType_t xTimerGetExpiryTime( TimerHandle_t xTimer ); Returns the time in ticks at which the timer will expire. If this is less than the current tick count then the expiry time has overflowed from the current time.

void *pvTimerGetTimerID( TimerHandle_t xTimer ); Returns the ID assigned to the timer. IDs are assigned to timers using the pvTimerID parameter of the call to xTimerCreated() that was used to create the timer, and by calling the vTimerSetTimerID() API function. If the same callback function is assigned to multiple timers then the timer ID can be used as time specific (timer local) storage. Example usage: See the xTimerCreate() API function example usage scenario.

BaseType_t xTimerIsTimerActive( TimerHandle_t xTimer ); Queries a timer to see if it is active or dormant. A timer will be dormant if: 1) It has been created but not started, or 2) It is an expired one-shot timer that has not been restarted. Timers are created in the dormant state. The xTimerStart(), xTimerReset(), xTimerStartFromISR(), xTimerResetFromISR(), xTimerChangePeriod() and xTimerChangePeriodFromISR() API functions can all be used to transition a timer into the active state. Example usage: @verbatim // This function assumes xTimer has already been created. void vAFunction( TimerHandle_t xTimer ) { if( xTimerIsTimerActive( xTimer ) != pdFALSE ) // or more simply and equivalently "if( xTimerIsTimerActive( xTimer ) )" { // xTimer is active, do something. } else { // xTimer is not active, do something else. } } @endverbatim

Stop a timer.

Delete a timer.