Jhon Plantikow / I2C_EEPROM

I2C_EEPROM

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

Committer:
jhon309
Date:
Thu Aug 13 00:23:16 2015 +0000
Revision:
0:ac8863619623
I2C

Who changed what in which revision?

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