Egor Rumjantsev / 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@99:7f6c6de930c0, 2015-05-03 (annotated)

Committer:
Mikchel
Date:
Sun May 03 16:04:42 2015 +0000
Revision:
99:7f6c6de930c0
Parent:
98:8ab26030e058 
12

Who changed what in which revision?

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