Bob Seque / mbed-dev

mbed library sources. Supersedes mbed-src.

Fork of mbed-dev by mbed official

api/Ticker.h@0:9b334a45a8ff, 2015-10-01 (annotated)

Committer:
bogdanm
Date:
Thu Oct 01 15:25:22 2015 +0300
Revision:
0:9b334a45a8ff
Initial commit on mbed-dev



Replaces mbed-src (now inactive)

Who changed what in which revision?

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