ju Lei / mbed

The official mbed C/C SDK provides the software platform and libraries to build your applications.

Fork of mbed by mbed official

Ticker.h@43:e2ed12d17f06, 2012-10-26 (annotated)

Committer:
emilmont
Date:
Fri Oct 26 17:40:46 2012 +0100
Revision:
43:e2ed12d17f06
Parent:
27:7110ebee3484
Child:
44:24d45a770a51
Update documentation

Who changed what in which revision?

UserRevisionLine numberNew contents of line
simon.ford@mbed.co.uk 9:cf0d45ce28a6 1 /* mbed Microcontroller Library - Ticker
rolf.meyer@arm.com 11:1c1ebd0324fa 2 * Copyright (c) 2007-2009 ARM Limited. All rights reserved.
rolf.meyer@arm.com 11:1c1ebd0324fa 3 */
rolf.meyer@arm.com 11:1c1ebd0324fa 4
simon.ford@mbed.co.uk 9:cf0d45ce28a6 5 #ifndef MBED_TICKER_H
simon.ford@mbed.co.uk 9:cf0d45ce28a6 6 #define MBED_TICKER_H
simon.ford@mbed.co.uk 9:cf0d45ce28a6 7
simon.ford@mbed.co.uk 9:cf0d45ce28a6 8 #include "TimerEvent.h"
rolf.meyer@arm.com 11:1c1ebd0324fa 9 #include "FunctionPointer.h"
simon.ford@mbed.co.uk 9:cf0d45ce28a6 10
simon.ford@mbed.co.uk 9:cf0d45ce28a6 11 namespace mbed {
simon.ford@mbed.co.uk 9:cf0d45ce28a6 12
emilmont 43:e2ed12d17f06 13 /** A Ticker is used to call a function at a recurring interval
simon.ford@mbed.co.uk 9:cf0d45ce28a6 14 *
emilmont 43:e2ed12d17f06 15 * You can use as many seperate Ticker objects as you require.
rolf.meyer@arm.com 11:1c1ebd0324fa 16 *
rolf.meyer@arm.com 11:1c1ebd0324fa 17 * Example:
emilmont 43:e2ed12d17f06 18 * @code
emilmont 43:e2ed12d17f06 19 * // Toggle the blinking led after 5 seconds
rolf.meyer@arm.com 11:1c1ebd0324fa 20 *
emilmont 43:e2ed12d17f06 21 * #include "mbed.h"
emilmont 43:e2ed12d17f06 22 *
emilmont 43:e2ed12d17f06 23 * Ticker timer;
emilmont 43:e2ed12d17f06 24 * DigitalOut led1(LED1);
emilmont 43:e2ed12d17f06 25 * DigitalOut led2(LED2);
emilmont 43:e2ed12d17f06 26 *
emilmont 43:e2ed12d17f06 27 * int flip = 0;
emilmont 43:e2ed12d17f06 28 *
emilmont 43:e2ed12d17f06 29 * void attime() {
emilmont 43:e2ed12d17f06 30 * flip = !flip;
emilmont 43:e2ed12d17f06 31 * }
emilmont 43:e2ed12d17f06 32 *
emilmont 43:e2ed12d17f06 33 * int main() {
emilmont 43:e2ed12d17f06 34 * timer.attach(&attime, 5);
emilmont 43:e2ed12d17f06 35 * while(1) {
emilmont 43:e2ed12d17f06 36 * if(flip == 0) {
emilmont 43:e2ed12d17f06 37 * led1 = !led1;
emilmont 43:e2ed12d17f06 38 * } else {
emilmont 43:e2ed12d17f06 39 * led2 = !led2;
emilmont 43:e2ed12d17f06 40 * }
emilmont 43:e2ed12d17f06 41 * wait(0.2);
emilmont 43:e2ed12d17f06 42 * }
emilmont 43:e2ed12d17f06 43 * }
emilmont 43:e2ed12d17f06 44 * @endcode
simon.ford@mbed.co.uk 9:cf0d45ce28a6 45 */
simon.ford@mbed.co.uk 9:cf0d45ce28a6 46 class Ticker : public TimerEvent {
simon.ford@mbed.co.uk 9:cf0d45ce28a6 47
simon.ford@mbed.co.uk 9:cf0d45ce28a6 48 public:
simon.ford@mbed.co.uk 9:cf0d45ce28a6 49
emilmont 43:e2ed12d17f06 50 /** Attach a function to be called by the Ticker, specifiying the interval in seconds
simon.ford@mbed.co.uk 9:cf0d45ce28a6 51 *
emilmont 43:e2ed12d17f06 52 * @param fptr pointer to the function to be called
emilmont 43:e2ed12d17f06 53 * @param t the time between calls in seconds
simon.ford@mbed.co.uk 9:cf0d45ce28a6 54 */
simon.ford@mbed.co.uk 9:cf0d45ce28a6 55 void attach(void (*fptr)(void), float t) {
simon.ford@mbed.co.uk 9:cf0d45ce28a6 56 attach_us(fptr, t * 1000000.0f);
simon.ford@mbed.co.uk 9:cf0d45ce28a6 57 }
simon.ford@mbed.co.uk 9:cf0d45ce28a6 58
emilmont 43:e2ed12d17f06 59 /** Attach a member function to be called by the Ticker, specifiying the interval in seconds
simon.ford@mbed.co.uk 9:cf0d45ce28a6 60 *
emilmont 43:e2ed12d17f06 61 * @param tptr pointer to the object to call the member function on
emilmont 43:e2ed12d17f06 62 * @param mptr pointer to the member function to be called
emilmont 43:e2ed12d17f06 63 * @param t the time between calls in seconds
simon.ford@mbed.co.uk 9:cf0d45ce28a6 64 */
simon.ford@mbed.co.uk 9:cf0d45ce28a6 65 template<typename T>
simon.ford@mbed.co.uk 9:cf0d45ce28a6 66 void attach(T* tptr, void (T::*mptr)(void), float t) {
simon.ford@mbed.co.uk 9:cf0d45ce28a6 67 attach_us(tptr, mptr, t * 1000000.0f);
simon.ford@mbed.co.uk 9:cf0d45ce28a6 68 }
simon.ford@mbed.co.uk 9:cf0d45ce28a6 69
emilmont 43:e2ed12d17f06 70 /** Attach a function to be called by the Ticker, specifiying the interval in micro-seconds
simon.ford@mbed.co.uk 9:cf0d45ce28a6 71 *
emilmont 43:e2ed12d17f06 72 * @param fptr pointer to the function to be called
emilmont 43:e2ed12d17f06 73 * @param t the time between calls in micro-seconds
simon.ford@mbed.co.uk 9:cf0d45ce28a6 74 */
simon.ford@mbed.co.uk 9:cf0d45ce28a6 75 void attach_us(void (*fptr)(void), unsigned int t) {
simon.ford@mbed.co.uk 9:cf0d45ce28a6 76 _function.attach(fptr);
simon.ford@mbed.co.uk 9:cf0d45ce28a6 77 setup(t);
simon.ford@mbed.co.uk 9:cf0d45ce28a6 78 }
simon.ford@mbed.co.uk 9:cf0d45ce28a6 79
emilmont 43:e2ed12d17f06 80 /** Attach a member function to be called by the Ticker, specifiying the interval in micro-seconds
simon.ford@mbed.co.uk 9:cf0d45ce28a6 81 *
emilmont 43:e2ed12d17f06 82 * @param tptr pointer to the object to call the member function on
emilmont 43:e2ed12d17f06 83 * @param mptr pointer to the member function to be called
emilmont 43:e2ed12d17f06 84 * @param t the time between calls in micro-seconds
simon.ford@mbed.co.uk 9:cf0d45ce28a6 85 */
simon.ford@mbed.co.uk 9:cf0d45ce28a6 86 template<typename T>
simon.ford@mbed.co.uk 9:cf0d45ce28a6 87 void attach_us(T* tptr, void (T::*mptr)(void), unsigned int t) {
simon.ford@mbed.co.uk 9:cf0d45ce28a6 88 _function.attach(tptr, mptr);
simon.ford@mbed.co.uk 9:cf0d45ce28a6 89 setup(t);
simon.ford@mbed.co.uk 9:cf0d45ce28a6 90 }
simon.ford@mbed.co.uk 9:cf0d45ce28a6 91
emilmont 43:e2ed12d17f06 92 /** Detach the function
simon.ford@mbed.co.uk 9:cf0d45ce28a6 93 */
simon.ford@mbed.co.uk 9:cf0d45ce28a6 94 void detach();
rolf.meyer@arm.com 11:1c1ebd0324fa 95
simon.ford@mbed.co.uk 9:cf0d45ce28a6 96 protected:
simon.ford@mbed.co.uk 9:cf0d45ce28a6 97
simon.ford@mbed.co.uk 9:cf0d45ce28a6 98 void setup(unsigned int t);
simon.ford@mbed.co.uk 9:cf0d45ce28a6 99 virtual void handler();
rolf.meyer@arm.com 11:1c1ebd0324fa 100
rolf.meyer@arm.com 11:1c1ebd0324fa 101 unsigned int _delay;
rolf.meyer@arm.com 11:1c1ebd0324fa 102 FunctionPointer _function;
simon.ford@mbed.co.uk 9:cf0d45ce28a6 103
rolf.meyer@arm.com 11:1c1ebd0324fa 104 };
simon.ford@mbed.co.uk 9:cf0d45ce28a6 105
rolf.meyer@arm.com 11:1c1ebd0324fa 106 } // namespace mbed
simon.ford@mbed.co.uk 9:cf0d45ce28a6 107
simon.ford@mbed.co.uk 9:cf0d45ce28a6 108 #endif