Jhon Plantikow / mbed

.

Dependents:   RTC

Ticker.h@0:88e313c910d0, 2015-08-13 (annotated)

Committer:
jhon309
Date:
Thu Aug 13 00:20:09 2015 +0000
Revision:
0:88e313c910d0
RTC Example

Who changed what in which revision?

UserRevisionLine numberNew contents of line
jhon309 0:88e313c910d0 1 /* mbed Microcontroller Library
jhon309 0:88e313c910d0 2 * Copyright (c) 2006-2013 ARM Limited
jhon309 0:88e313c910d0 3 *
jhon309 0:88e313c910d0 4 * Licensed under the Apache License, Version 2.0 (the "License");
jhon309 0:88e313c910d0 5 * you may not use this file except in compliance with the License.
jhon309 0:88e313c910d0 6 * You may obtain a copy of the License at
jhon309 0:88e313c910d0 7 *
jhon309 0:88e313c910d0 8 * http://www.apache.org/licenses/LICENSE-2.0
jhon309 0:88e313c910d0 9 *
jhon309 0:88e313c910d0 10 * Unless required by applicable law or agreed to in writing, software
jhon309 0:88e313c910d0 11 * distributed under the License is distributed on an "AS IS" BASIS,
jhon309 0:88e313c910d0 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
jhon309 0:88e313c910d0 13 * See the License for the specific language governing permissions and
jhon309 0:88e313c910d0 14 * limitations under the License.
jhon309 0:88e313c910d0 15 */
jhon309 0:88e313c910d0 16 #ifndef MBED_TICKER_H
jhon309 0:88e313c910d0 17 #define MBED_TICKER_H
jhon309 0:88e313c910d0 18
jhon309 0:88e313c910d0 19 #include "TimerEvent.h"
jhon309 0:88e313c910d0 20 #include "FunctionPointer.h"
jhon309 0:88e313c910d0 21
jhon309 0:88e313c910d0 22 namespace mbed {
jhon309 0:88e313c910d0 23
jhon309 0:88e313c910d0 24 /** A Ticker is used to call a function at a recurring interval
jhon309 0:88e313c910d0 25 *
jhon309 0:88e313c910d0 26 * You can use as many seperate Ticker objects as you require.
jhon309 0:88e313c910d0 27 *
jhon309 0:88e313c910d0 28 * Example:
jhon309 0:88e313c910d0 29 * @code
jhon309 0:88e313c910d0 30 * // Toggle the blinking led after 5 seconds
jhon309 0:88e313c910d0 31 *
jhon309 0:88e313c910d0 32 * #include "mbed.h"
jhon309 0:88e313c910d0 33 *
jhon309 0:88e313c910d0 34 * Ticker timer;
jhon309 0:88e313c910d0 35 * DigitalOut led1(LED1);
jhon309 0:88e313c910d0 36 * DigitalOut led2(LED2);
jhon309 0:88e313c910d0 37 *
jhon309 0:88e313c910d0 38 * int flip = 0;
jhon309 0:88e313c910d0 39 *
jhon309 0:88e313c910d0 40 * void attime() {
jhon309 0:88e313c910d0 41 * flip = !flip;
jhon309 0:88e313c910d0 42 * }
jhon309 0:88e313c910d0 43 *
jhon309 0:88e313c910d0 44 * int main() {
jhon309 0:88e313c910d0 45 * timer.attach(&attime, 5);
jhon309 0:88e313c910d0 46 * while(1) {
jhon309 0:88e313c910d0 47 * if(flip == 0) {
jhon309 0:88e313c910d0 48 * led1 = !led1;
jhon309 0:88e313c910d0 49 * } else {
jhon309 0:88e313c910d0 50 * led2 = !led2;
jhon309 0:88e313c910d0 51 * }
jhon309 0:88e313c910d0 52 * wait(0.2);
jhon309 0:88e313c910d0 53 * }
jhon309 0:88e313c910d0 54 * }
jhon309 0:88e313c910d0 55 * @endcode
jhon309 0:88e313c910d0 56 */
jhon309 0:88e313c910d0 57 class Ticker : public TimerEvent {
jhon309 0:88e313c910d0 58
jhon309 0:88e313c910d0 59 public:
jhon309 0:88e313c910d0 60 Ticker() : TimerEvent() {
jhon309 0:88e313c910d0 61 }
jhon309 0:88e313c910d0 62
jhon309 0:88e313c910d0 63 Ticker(const ticker_data_t *data) : TimerEvent(data) {
jhon309 0:88e313c910d0 64 }
jhon309 0:88e313c910d0 65
jhon309 0:88e313c910d0 66 /** Attach a function to be called by the Ticker, specifiying the interval in seconds
jhon309 0:88e313c910d0 67 *
jhon309 0:88e313c910d0 68 * @param fptr pointer to the function to be called
jhon309 0:88e313c910d0 69 * @param t the time between calls in seconds
jhon309 0:88e313c910d0 70 */
jhon309 0:88e313c910d0 71 void attach(void (*fptr)(void), float t) {
jhon309 0:88e313c910d0 72 attach_us(fptr, t * 1000000.0f);
jhon309 0:88e313c910d0 73 }
jhon309 0:88e313c910d0 74
jhon309 0:88e313c910d0 75 /** Attach a member function to be called by the Ticker, specifiying the interval in seconds
jhon309 0:88e313c910d0 76 *
jhon309 0:88e313c910d0 77 * @param tptr pointer to the object to call the member function on
jhon309 0:88e313c910d0 78 * @param mptr pointer to the member function to be called
jhon309 0:88e313c910d0 79 * @param t the time between calls in seconds
jhon309 0:88e313c910d0 80 */
jhon309 0:88e313c910d0 81 template<typename T>
jhon309 0:88e313c910d0 82 void attach(T* tptr, void (T::*mptr)(void), float t) {
jhon309 0:88e313c910d0 83 attach_us(tptr, mptr, t * 1000000.0f);
jhon309 0:88e313c910d0 84 }
jhon309 0:88e313c910d0 85
jhon309 0:88e313c910d0 86 /** Attach a function to be called by the Ticker, specifiying the interval in micro-seconds
jhon309 0:88e313c910d0 87 *
jhon309 0:88e313c910d0 88 * @param fptr pointer to the function to be called
jhon309 0:88e313c910d0 89 * @param t the time between calls in micro-seconds
jhon309 0:88e313c910d0 90 */
jhon309 0:88e313c910d0 91 void attach_us(void (*fptr)(void), timestamp_t t) {
jhon309 0:88e313c910d0 92 _function.attach(fptr);
jhon309 0:88e313c910d0 93 setup(t);
jhon309 0:88e313c910d0 94 }
jhon309 0:88e313c910d0 95
jhon309 0:88e313c910d0 96 /** Attach a member function to be called by the Ticker, specifiying the interval in micro-seconds
jhon309 0:88e313c910d0 97 *
jhon309 0:88e313c910d0 98 * @param tptr pointer to the object to call the member function on
jhon309 0:88e313c910d0 99 * @param mptr pointer to the member function to be called
jhon309 0:88e313c910d0 100 * @param t the time between calls in micro-seconds
jhon309 0:88e313c910d0 101 */
jhon309 0:88e313c910d0 102 template<typename T>
jhon309 0:88e313c910d0 103 void attach_us(T* tptr, void (T::*mptr)(void), timestamp_t t) {
jhon309 0:88e313c910d0 104 _function.attach(tptr, mptr);
jhon309 0:88e313c910d0 105 setup(t);
jhon309 0:88e313c910d0 106 }
jhon309 0:88e313c910d0 107
jhon309 0:88e313c910d0 108 virtual ~Ticker() {
jhon309 0:88e313c910d0 109 detach();
jhon309 0:88e313c910d0 110 }
jhon309 0:88e313c910d0 111
jhon309 0:88e313c910d0 112 /** Detach the function
jhon309 0:88e313c910d0 113 */
jhon309 0:88e313c910d0 114 void detach();
jhon309 0:88e313c910d0 115
jhon309 0:88e313c910d0 116 protected:
jhon309 0:88e313c910d0 117 void setup(timestamp_t t);
jhon309 0:88e313c910d0 118 virtual void handler();
jhon309 0:88e313c910d0 119
jhon309 0:88e313c910d0 120 protected:
jhon309 0:88e313c910d0 121 timestamp_t _delay; /**< Time delay (in microseconds) for re-setting the multi-shot callback. */
jhon309 0:88e313c910d0 122 FunctionPointer _function; /**< Callback. */
jhon309 0:88e313c910d0 123 };
jhon309 0:88e313c910d0 124
jhon309 0:88e313c910d0 125 } // namespace mbed
jhon309 0:88e313c910d0 126
jhon309 0:88e313c910d0 127 #endif