Mihail Stoyanov / mbed

Fork of the official mbed C/C++ SDK provides the software platform and libraries to build your applications. The fork has the documentation converted to Doxygen format

Dependents:   NervousPuppySprintOne NervousPuppySprint2602 Robot WarehouseBot1 ... more

Fork of mbed by mbed official

Ticker.h@27:7110ebee3484, 2011-11-29 (annotated)

Committer:
emilmont
Date:
Tue Nov 29 14:59:27 2011 +0000
Revision:
27:7110ebee3484
Parent:
11:1c1ebd0324fa
Child:
43:aff670d0d510
New Libraries 11.11

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
simon.ford@mbed.co.uk 9:cf0d45ce28a6 13 /* Class: Ticker
simon.ford@mbed.co.uk 9:cf0d45ce28a6 14 * A Ticker is used to call a function at a recurring interval
simon.ford@mbed.co.uk 9:cf0d45ce28a6 15 *
simon.ford@mbed.co.uk 9:cf0d45ce28a6 16 * You can use as many seperate Ticker objects as you require.
rolf.meyer@arm.com 11:1c1ebd0324fa 17 *
rolf.meyer@arm.com 11:1c1ebd0324fa 18 * Example:
rolf.meyer@arm.com 11:1c1ebd0324fa 19 * > // Toggle the blinking led after 5 seconds
rolf.meyer@arm.com 11:1c1ebd0324fa 20 * >
rolf.meyer@arm.com 11:1c1ebd0324fa 21 * > #include "mbed.h"
rolf.meyer@arm.com 11:1c1ebd0324fa 22 * >
rolf.meyer@arm.com 11:1c1ebd0324fa 23 * > Ticker timer;
rolf.meyer@arm.com 11:1c1ebd0324fa 24 * > DigitalOut led1(LED1);
rolf.meyer@arm.com 11:1c1ebd0324fa 25 * > DigitalOut led2(LED2);
rolf.meyer@arm.com 11:1c1ebd0324fa 26 * >
rolf.meyer@arm.com 11:1c1ebd0324fa 27 * > int flip = 0;
rolf.meyer@arm.com 11:1c1ebd0324fa 28 * >
rolf.meyer@arm.com 11:1c1ebd0324fa 29 * > void attime() {
rolf.meyer@arm.com 11:1c1ebd0324fa 30 * > flip = !flip;
rolf.meyer@arm.com 11:1c1ebd0324fa 31 * > }
rolf.meyer@arm.com 11:1c1ebd0324fa 32 * >
rolf.meyer@arm.com 11:1c1ebd0324fa 33 * > int main() {
rolf.meyer@arm.com 11:1c1ebd0324fa 34 * > timer.attach(&attime, 5);
rolf.meyer@arm.com 11:1c1ebd0324fa 35 * > while(1) {
rolf.meyer@arm.com 11:1c1ebd0324fa 36 * > if(flip == 0) {
rolf.meyer@arm.com 11:1c1ebd0324fa 37 * > led1 = !led1;
rolf.meyer@arm.com 11:1c1ebd0324fa 38 * > } else {
rolf.meyer@arm.com 11:1c1ebd0324fa 39 * > led2 = !led2;
rolf.meyer@arm.com 11:1c1ebd0324fa 40 * > }
rolf.meyer@arm.com 11:1c1ebd0324fa 41 * > wait(0.2);
rolf.meyer@arm.com 11:1c1ebd0324fa 42 * > }
rolf.meyer@arm.com 11:1c1ebd0324fa 43 * > }
rolf.meyer@arm.com 11:1c1ebd0324fa 44 *
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
simon.ford@mbed.co.uk 9:cf0d45ce28a6 50 /* Function: attach
simon.ford@mbed.co.uk 9:cf0d45ce28a6 51 * Attach a function to be called by the Ticker, specifiying the interval in seconds
simon.ford@mbed.co.uk 9:cf0d45ce28a6 52 *
simon.ford@mbed.co.uk 9:cf0d45ce28a6 53 * Variables:
simon.ford@mbed.co.uk 9:cf0d45ce28a6 54 * fptr - pointer to the function to be called
simon.ford@mbed.co.uk 9:cf0d45ce28a6 55 * t - the time between calls in seconds
simon.ford@mbed.co.uk 9:cf0d45ce28a6 56 */
simon.ford@mbed.co.uk 9:cf0d45ce28a6 57 void attach(void (*fptr)(void), float t) {
simon.ford@mbed.co.uk 9:cf0d45ce28a6 58 attach_us(fptr, t * 1000000.0f);
simon.ford@mbed.co.uk 9:cf0d45ce28a6 59 }
simon.ford@mbed.co.uk 9:cf0d45ce28a6 60
simon.ford@mbed.co.uk 9:cf0d45ce28a6 61 /* Function: attach
simon.ford@mbed.co.uk 9:cf0d45ce28a6 62 * Attach a member function to be called by the Ticker, specifiying the interval in seconds
simon.ford@mbed.co.uk 9:cf0d45ce28a6 63 *
simon.ford@mbed.co.uk 9:cf0d45ce28a6 64 * Variables:
simon.ford@mbed.co.uk 9:cf0d45ce28a6 65 * tptr - pointer to the object to call the member function on
simon.ford@mbed.co.uk 9:cf0d45ce28a6 66 * mptr - pointer to the member function to be called
simon.ford@mbed.co.uk 9:cf0d45ce28a6 67 * t - the time between calls in seconds
simon.ford@mbed.co.uk 9:cf0d45ce28a6 68 */
simon.ford@mbed.co.uk 9:cf0d45ce28a6 69 template<typename T>
simon.ford@mbed.co.uk 9:cf0d45ce28a6 70 void attach(T* tptr, void (T::*mptr)(void), float t) {
simon.ford@mbed.co.uk 9:cf0d45ce28a6 71 attach_us(tptr, mptr, t * 1000000.0f);
simon.ford@mbed.co.uk 9:cf0d45ce28a6 72 }
simon.ford@mbed.co.uk 9:cf0d45ce28a6 73
simon.ford@mbed.co.uk 9:cf0d45ce28a6 74 /* Function: attach_us
simon.ford@mbed.co.uk 9:cf0d45ce28a6 75 * Attach a function to be called by the Ticker, specifiying the interval in micro-seconds
simon.ford@mbed.co.uk 9:cf0d45ce28a6 76 *
simon.ford@mbed.co.uk 9:cf0d45ce28a6 77 * Variables:
simon.ford@mbed.co.uk 9:cf0d45ce28a6 78 * fptr - pointer to the function to be called
simon.ford@mbed.co.uk 9:cf0d45ce28a6 79 * t - the time between calls in micro-seconds
simon.ford@mbed.co.uk 9:cf0d45ce28a6 80 */
simon.ford@mbed.co.uk 9:cf0d45ce28a6 81 void attach_us(void (*fptr)(void), unsigned int t) {
simon.ford@mbed.co.uk 9:cf0d45ce28a6 82 _function.attach(fptr);
simon.ford@mbed.co.uk 9:cf0d45ce28a6 83 setup(t);
simon.ford@mbed.co.uk 9:cf0d45ce28a6 84 }
simon.ford@mbed.co.uk 9:cf0d45ce28a6 85
simon.ford@mbed.co.uk 9:cf0d45ce28a6 86 /* Function: attach_us
simon.ford@mbed.co.uk 9:cf0d45ce28a6 87 * Attach a member function to be called by the Ticker, specifiying the interval in micro-seconds
simon.ford@mbed.co.uk 9:cf0d45ce28a6 88 *
simon.ford@mbed.co.uk 9:cf0d45ce28a6 89 * Variables:
simon.ford@mbed.co.uk 9:cf0d45ce28a6 90 * tptr - pointer to the object to call the member function on
simon.ford@mbed.co.uk 9:cf0d45ce28a6 91 * mptr - pointer to the member function to be called
simon.ford@mbed.co.uk 9:cf0d45ce28a6 92 * t - the time between calls in micro-seconds
simon.ford@mbed.co.uk 9:cf0d45ce28a6 93 */
simon.ford@mbed.co.uk 9:cf0d45ce28a6 94 template<typename T>
simon.ford@mbed.co.uk 9:cf0d45ce28a6 95 void attach_us(T* tptr, void (T::*mptr)(void), unsigned int t) {
simon.ford@mbed.co.uk 9:cf0d45ce28a6 96 _function.attach(tptr, mptr);
simon.ford@mbed.co.uk 9:cf0d45ce28a6 97 setup(t);
simon.ford@mbed.co.uk 9:cf0d45ce28a6 98 }
simon.ford@mbed.co.uk 9:cf0d45ce28a6 99
simon.ford@mbed.co.uk 9:cf0d45ce28a6 100 /* Function: detach
simon.ford@mbed.co.uk 9:cf0d45ce28a6 101 * Detach the function
simon.ford@mbed.co.uk 9:cf0d45ce28a6 102 */
simon.ford@mbed.co.uk 9:cf0d45ce28a6 103 void detach();
rolf.meyer@arm.com 11:1c1ebd0324fa 104
simon.ford@mbed.co.uk 9:cf0d45ce28a6 105 protected:
simon.ford@mbed.co.uk 9:cf0d45ce28a6 106
simon.ford@mbed.co.uk 9:cf0d45ce28a6 107 void setup(unsigned int t);
simon.ford@mbed.co.uk 9:cf0d45ce28a6 108 virtual void handler();
rolf.meyer@arm.com 11:1c1ebd0324fa 109
rolf.meyer@arm.com 11:1c1ebd0324fa 110 unsigned int _delay;
rolf.meyer@arm.com 11:1c1ebd0324fa 111 FunctionPointer _function;
simon.ford@mbed.co.uk 9:cf0d45ce28a6 112
rolf.meyer@arm.com 11:1c1ebd0324fa 113 };
simon.ford@mbed.co.uk 9:cf0d45ce28a6 114
rolf.meyer@arm.com 11:1c1ebd0324fa 115 } // namespace mbed
simon.ford@mbed.co.uk 9:cf0d45ce28a6 116
simon.ford@mbed.co.uk 9:cf0d45ce28a6 117 #endif