John Karatka / mbed

mbed

Fork of mbed-dev by mbed official

drivers/Ticker.h@175:b96e65c34a4d, 2017-10-02 (annotated)

Committer:
AnnaBridge
Date:
Mon Oct 02 15:33:19 2017 +0100
Revision:
175:b96e65c34a4d
Parent:
168:9672193075cf
Child:
176:af195413fb11
This updates the lib to the mbed lib v 152

Who changed what in which revision?

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