Jhon Plantikow / DHT11

DHT11

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

Committer:
jhon309
Date:
Thu Aug 13 00:21:57 2015 +0000
Revision:
0:c52df770855b
DHT11

Who changed what in which revision?

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