sleepTimer.h File Reference

The header file describes the 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

The header file describes the sleepTimer interface.

Author:
Atmel Corporation: http://www.atmel.com
Support email: avr@atmel.com
Copyright (c) 2008 , Atmel Corporation. All rights reserved. Licensed under Atmel's Limited License Agreement (BitCloudTM).

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 29 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] sleepTimer - pointer to sleep timer structure.
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.


Generated on Mon Feb 16 17:53:40 2009 for BitCloud Stack Documentation by  doxygen 1.5.1-p1