timers.h File Reference

#include "FreeRTOS.h"
#include "utilities/ooc_class.h"

Go to the source code of this file.

Data Structures
class	StaticTimer_t

Typedefs
typedef StaticTimer_t *	TimerHandle_t
typedef void(*	TimerCallbackFunction_t) (TimerHandle_t xTimer)

Functions
TimerHandle_t	xTimerCreate (const char *const pcTimerName, const TickType_t xTimerPeriodInTicks, const UBaseType_t uxAutoReload, void *const pvTimerID, TimerCallbackFunction_t pxCallbackFunction)
TimerHandle_t	xTimerCreateStatic (const char *const pcTimerName, const TickType_t xTimerPeriodInTicks, const UBaseType_t uxAutoReload, void *const pvTimerID, TimerCallbackFunction_t pxCallbackFunction, StaticTimer_t *pxTimerBuffer)
BaseType_t	xTimerStart (TimerHandle_t xTimer, TickType_t xTicksToWait)
BaseType_t	xTimerStartFromISR (TimerHandle_t xTimer, BaseType_t *pxHigherPriorityTaskWoken)
BaseType_t	xTimerStop (TimerHandle_t xTimer, TickType_t xTicksToWait)
BaseType_t	xTimerStopFromISR (TimerHandle_t xTimer, BaseType_t *pxHigherPriorityTaskWoken)
BaseType_t	xTimerReset (TimerHandle_t xTimer, TickType_t xTicksToWait)
BaseType_t	xTimerResetFromISR (TimerHandle_t xTimer, BaseType_t *pxHigherPriorityTaskWoken)
BaseType_t	xTimerChangePeriod (TimerHandle_t xTimer, TickType_t xNewPeriod, TickType_t xTicksToWait)
BaseType_t	xTimerChangePeriodFromISR (TimerHandle_t xTimer, TickType_t xNewPeriod, BaseType_t *pxHigherPriorityTaskWoken)
BaseType_t	xTimerDelete (TimerHandle_t xTimer, TickType_t xTicksToWait)
BaseType_t	xTimerIsTimerActive (TimerHandle_t xTimer)
TickType_t	xTimerGetPeriod (TimerHandle_t xTimer)
void *	pvTimerGetTimerID (const TimerHandle_t xTimer)
void	vTimerSetTimerID (TimerHandle_t xTimer, void *pvNewID)
const char *	pcTimerGetName (TimerHandle_t xTimer)

Typedef Documentation

TimerHandle_t

typedef StaticTimer_t* TimerHandle_t

TimerCallbackFunction_t

typedef void(* TimerCallbackFunction_t) (TimerHandle_t xTimer)

Function Documentation

xTimerCreate()

TimerHandle_t xTimerCreate ( const char *const  pcTimerName, const TickType_t  xTimerPeriodInTicks, const UBaseType_t  uxAutoReload, void *const  pvTimerID, TimerCallbackFunction_t  pxCallbackFunction  )

extern

xTimerCreateStatic()

TimerHandle_t xTimerCreateStatic ( const char *const  pcTimerName, const TickType_t  xTimerPeriodInTicks, const UBaseType_t  uxAutoReload, void *const  pvTimerID, TimerCallbackFunction_t  pxCallbackFunction, StaticTimer_t *  pxTimerBuffer  )

extern

xTimerStart()

BaseType_t xTimerStart ( TimerHandle_t  xTimer, TickType_t  xTicksToWait  )

extern

xTimerStartFromISR()

BaseType_t xTimerStartFromISR ( TimerHandle_t  xTimer, BaseType_t *  pxHigherPriorityTaskWoken  )

extern

xTimerStop()

BaseType_t xTimerStop ( TimerHandle_t  xTimer, TickType_t  xTicksToWait  )

extern

xTimerStopFromISR()

BaseType_t xTimerStopFromISR ( TimerHandle_t  xTimer, BaseType_t *  pxHigherPriorityTaskWoken  )

extern

xTimerReset()

BaseType_t xTimerReset ( TimerHandle_t  xTimer, TickType_t  xTicksToWait  )

extern

xTimerResetFromISR()

BaseType_t xTimerResetFromISR ( TimerHandle_t  xTimer, BaseType_t *  pxHigherPriorityTaskWoken  )

extern

xTimerChangePeriod()

BaseType_t xTimerChangePeriod ( TimerHandle_t  xTimer, TickType_t  xNewPeriod, TickType_t  xTicksToWait  )

extern

xTimerChangePeriodFromISR()

BaseType_t xTimerChangePeriodFromISR ( TimerHandle_t  xTimer, TickType_t  xNewPeriod, BaseType_t *  pxHigherPriorityTaskWoken  )

extern

xTimerDelete()

BaseType_t xTimerDelete ( TimerHandle_t  xTimer, TickType_t  xTicksToWait  )

extern

xTimerIsTimerActive()

BaseType_t xTimerIsTimerActive ( TimerHandle_t  xTimer )

extern

xTimerGetPeriod()

TickType_t xTimerGetPeriod ( TimerHandle_t  xTimer )

extern

pvTimerGetTimerID()

void * pvTimerGetTimerID ( const TimerHandle_t  xTimer )

extern

vTimerSetTimerID()

void vTimerSetTimerID ( TimerHandle_t  xTimer, void *  pvNewID  )

extern

pcTimerGetName()

const char * pcTimerGetName ( TimerHandle_t  xTimer )

extern