Vipin Ranka / MGAS_GR_Peach

This is the final version of Mini Gateway for Automation and Security desgined for Renesas GR Peach Design Contest

Dependencies:   GR-PEACH_video GraphicsFramework HTTPServer R_BSP mbed-rpc mbed-rtos Socket lwip-eth lwip-sys lwip FATFileSystem

Fork of mbed-os-example-mbed5-blinky by mbed-os-examples

mbed-dev/drivers/Ticker.h@12:9a20164dcc47, 2017-01-11 (annotated)

Committer:
vipinranka
Date:
Wed Jan 11 11:41:30 2017 +0000
Revision:
12:9a20164dcc47
This is the final version MGAS Project for Renesas GR Peach Design Contest

Who changed what in which revision?

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