appTimer.h File Reference

The header file describes the appTimer interface. More...

#include <types.h>
#include <mnHalTimer.h>
#include <halAppClock.h>

Go to the source code of this file.

Typedefs
typedef Timer_t	HAL_AppTimer_t
	fields of structure: uint32_t interval - timer firing interval. Interval must be more than 10 ms (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 timer callback function (set by user).
Functions
int	HAL_StartAppTimer (HAL_AppTimer_t *appTimer)
	Starts to count an interval (starts user timer).
int	HAL_StopAppTimer (HAL_AppTimer_t *appTimer)
	Stops the user timer.
INLINE uint32_t	HAL_GetSystemTime (void)
	Gets system time.

---

Detailed Description

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

---

Typedef Documentation

typedef Timer_t HAL_AppTimer_t

fields of structure:
uint32_t interval - timer firing interval. Interval must be more than 10 ms (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 timer callback function (set by user).

Definition at line 38 of file appTimer.h.

---

Function Documentation

int HAL_StartAppTimer

(

HAL_AppTimer_t *

appTimer

)

Starts to count an interval (starts user timer).

Parameters:

[in]

appTimer

- pointer to the timer structure (HAL_AppTimer_t is typedef Timer_t)

Returns:

-1 - pointer is NULL 0 - success

int HAL_StopAppTimer

(

HAL_AppTimer_t *

appTimer

)

Stops the user timer.

Parameters:

[in]

appTimer

- pointer to the timer structure.

Returns:

-1 - there is no appTimer started or pointer is NULL 0 - success

INLINE uint32_t HAL_GetSystemTime

(

void

)

Gets system time.

Returns:

time since power up in milliseconds.

Definition at line 82 of file appTimer.h.

---