Christopher Haster / mbed-hal

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   target-freescale

Fork of mbed-hal by Morpheus

api/Ticker.h@0:9c59db1fbc9e, 2016-03-23 (annotated)

Committer:
screamer
Date:
Wed Mar 23 21:36:09 2016 +0000
Revision:
0:9c59db1fbc9e
Child:
7:4fdb3a44f646
Initial revision

Who changed what in which revision?

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