sleepTimer.h File Reference

Declarations of sleepTimer interface. More...

Go to the source code of this file.

Typedefs
typedef Timer_t	HAL_SleepTimer_t
	fields of structure uint32_t interval - timer firing interval (set by user) TimerMode_t mode - timer work mode (set by user). Must be chosen from: TIMER_REPEAT_MODE TIMER_ONE_SHOT_MODE void (*callback)() - pointer to the timer callback function (set by user)
Functions
uint32_t	HAL_ConvertToSleepInterval (uint32_t interval)
	Converts an interval from milliseconds to sleep timer ticks.
int	HAL_StartSleepTimer (HAL_SleepTimer_t *sleepTimer)
	Starts sleep timer.
int	HAL_StopSleepTimer (HAL_SleepTimer_t *sleepTimer)
	Removes timer.

---

Detailed Description

Declarations of sleepTimer interface.

Definition in file sleepTimer.h.

---

Typedef Documentation

typedef Timer_t HAL_SleepTimer_t

fields of structure
uint32_t interval - timer firing interval (set by user)
TimerMode_t mode - timer work mode (set by user). Must be chosen from:
TIMER_REPEAT_MODE
TIMER_ONE_SHOT_MODE
void (*callback)() - pointer to the timer callback function (set by user)

Definition at line 24 of file sleepTimer.h.

---

Function Documentation

uint32_t HAL_ConvertToSleepInterval

(

uint32_t

interval

)

Converts an interval from milliseconds to sleep timer ticks.

Parameters:

[in]

interval

- interval in milliseconds.

Returns:

interval in sleep timer ticks.

int HAL_StartSleepTimer

(

HAL_SleepTimer_t *

sleepTimer

)

Starts sleep timer.

Parameters:

[in]

interval

- interval in ms.

Returns:

-1 - bad interval.
0 - otherwise.

int HAL_StopSleepTimer

(

HAL_SleepTimer_t *

sleepTimer

)

Removes timer.

Parameters:

[in]

sleepTimer

- address of the timer to be removed from the list

Returns:

-1 - there is no such timer in the list.
0 - otherwise.

---