Luis Ruiz
/
RangignMaster
A base program for ranging, open to improvement
Timers/Timers.h@0:1ca9a50646e6, 2018-04-23 (annotated)
- Committer:
- LuisRuiz
- Date:
- Mon Apr 23 18:42:08 2018 +0000
- Revision:
- 0:1ca9a50646e6
Ranging Master Role for SX1280
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
LuisRuiz | 0:1ca9a50646e6 | 1 | /* |
LuisRuiz | 0:1ca9a50646e6 | 2 | ______ _ |
LuisRuiz | 0:1ca9a50646e6 | 3 | / _____) _ | | |
LuisRuiz | 0:1ca9a50646e6 | 4 | ( (____ _____ ____ _| |_ _____ ____| |__ |
LuisRuiz | 0:1ca9a50646e6 | 5 | \____ \| ___ | (_ _) ___ |/ ___) _ \ |
LuisRuiz | 0:1ca9a50646e6 | 6 | _____) ) ____| | | || |_| ____( (___| | | | |
LuisRuiz | 0:1ca9a50646e6 | 7 | (______/|_____)_|_|_| \__)_____)\____)_| |_| |
LuisRuiz | 0:1ca9a50646e6 | 8 | (C)2016 Semtech |
LuisRuiz | 0:1ca9a50646e6 | 9 | |
LuisRuiz | 0:1ca9a50646e6 | 10 | Description: Timers header |
LuisRuiz | 0:1ca9a50646e6 | 11 | |
LuisRuiz | 0:1ca9a50646e6 | 12 | Maintainer: Gregory Cristian & Gilbert Menth |
LuisRuiz | 0:1ca9a50646e6 | 13 | */ |
LuisRuiz | 0:1ca9a50646e6 | 14 | |
LuisRuiz | 0:1ca9a50646e6 | 15 | #ifndef TIMERS_H |
LuisRuiz | 0:1ca9a50646e6 | 16 | #define TIMERS_H |
LuisRuiz | 0:1ca9a50646e6 | 17 | |
LuisRuiz | 0:1ca9a50646e6 | 18 | |
LuisRuiz | 0:1ca9a50646e6 | 19 | #define TIM_MSEC ( uint32_t )1 |
LuisRuiz | 0:1ca9a50646e6 | 20 | #define TIM_SEC ( uint32_t )1000 |
LuisRuiz | 0:1ca9a50646e6 | 21 | #define TIM_MIN ( uint32_t )60000 |
LuisRuiz | 0:1ca9a50646e6 | 22 | #define TIM_HOUR ( uint32_t )3600000 |
LuisRuiz | 0:1ca9a50646e6 | 23 | #define MAX_TIMER_VALUE ( TIM_MIN * 150 ) // maximum time for timer |
LuisRuiz | 0:1ca9a50646e6 | 24 | |
LuisRuiz | 0:1ca9a50646e6 | 25 | |
LuisRuiz | 0:1ca9a50646e6 | 26 | /*! |
LuisRuiz | 0:1ca9a50646e6 | 27 | * \brief Initialses the hardware and variables associated with the timers. |
LuisRuiz | 0:1ca9a50646e6 | 28 | */ |
LuisRuiz | 0:1ca9a50646e6 | 29 | void TimersInit( void ); |
LuisRuiz | 0:1ca9a50646e6 | 30 | |
LuisRuiz | 0:1ca9a50646e6 | 31 | /*! |
LuisRuiz | 0:1ca9a50646e6 | 32 | * \brief Sets a timer to a specific value |
LuisRuiz | 0:1ca9a50646e6 | 33 | * |
LuisRuiz | 0:1ca9a50646e6 | 34 | * \param [in] *STimer Pointer to the timer value to be set. |
LuisRuiz | 0:1ca9a50646e6 | 35 | * \param [in] TimeLength Value to set the timer to in milliseconds. |
LuisRuiz | 0:1ca9a50646e6 | 36 | */ |
LuisRuiz | 0:1ca9a50646e6 | 37 | void TimersSetTimer( uint32_t *sTimer, uint32_t timeLength ); |
LuisRuiz | 0:1ca9a50646e6 | 38 | |
LuisRuiz | 0:1ca9a50646e6 | 39 | /*! |
LuisRuiz | 0:1ca9a50646e6 | 40 | * \brief Checks if a timer has expired. |
LuisRuiz | 0:1ca9a50646e6 | 41 | * |
LuisRuiz | 0:1ca9a50646e6 | 42 | * \param [in] *STimer Pointer to the timer value to be read. |
LuisRuiz | 0:1ca9a50646e6 | 43 | * |
LuisRuiz | 0:1ca9a50646e6 | 44 | * \retval Status Non zero if the timer has not expired and is still |
LuisRuiz | 0:1ca9a50646e6 | 45 | * running. |
LuisRuiz | 0:1ca9a50646e6 | 46 | */ |
LuisRuiz | 0:1ca9a50646e6 | 47 | uint32_t TimersTimerHasExpired ( const uint32_t * sTimer ); |
LuisRuiz | 0:1ca9a50646e6 | 48 | |
LuisRuiz | 0:1ca9a50646e6 | 49 | /*! |
LuisRuiz | 0:1ca9a50646e6 | 50 | * \brief Returns the value of the current time in milliseconds |
LuisRuiz | 0:1ca9a50646e6 | 51 | * |
LuisRuiz | 0:1ca9a50646e6 | 52 | * \param [in] refresh Flag indicates refresh display required (touch) |
LuisRuiz | 0:1ca9a50646e6 | 53 | * |
LuisRuiz | 0:1ca9a50646e6 | 54 | * \retval Value value of current time in milliseconds |
LuisRuiz | 0:1ca9a50646e6 | 55 | */ |
LuisRuiz | 0:1ca9a50646e6 | 56 | uint32_t TimersTimerValue ( void ); |
LuisRuiz | 0:1ca9a50646e6 | 57 | |
LuisRuiz | 0:1ca9a50646e6 | 58 | #endif //TIMERS_H |