mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

drivers/Ticker.h@134:ad3be0349dc5, 2017-01-16 (annotated)

Committer:
<>
Date:
Mon Jan 16 12:05:23 2017 +0000
Revision:
134:ad3be0349dc5
Parent:
128:9bcdf88f62b0
Child:
138:093f2bd7b9eb
Release 134 of the mbed library



Ports for Upcoming Targets





Fixes and Changes



3488: Dev stm i2c v2 unitary functions https://github.com/ARMmbed/mbed-os/pull/3488

3492: Fix #3463 CAN read() return value https://github.com/ARMmbed/mbed-os/pull/3492

3503: [LPC15xx] Ensure that PWM=1 is resolved correctly https://github.com/ARMmbed/mbed-os/pull/3503

3504: [LPC15xx] CAN implementation improvements https://github.com/ARMmbed/mbed-os/pull/3504

3539: NUCLEO_F412ZG - Add support of TRNG peripheral https://github.com/ARMmbed/mbed-os/pull/3539

3540: STM: SPI: Initialize Rx in spi_master_write https://github.com/ARMmbed/mbed-os/pull/3540

3438: K64F: Add support for SERIAL ASYNCH API https://github.com/ARMmbed/mbed-os/pull/3438

3519: MCUXpresso: Fix ENET driver to enable interrupts after interrupt handler is set https://github.com/ARMmbed/mbed-os/pull/3519

3544: STM32L4 deepsleep improvement https://github.com/ARMmbed/mbed-os/pull/3544

3546: NUCLEO-F412ZG - Add CAN peripheral https://github.com/ARMmbed/mbed-os/pull/3546

3551: Fix I2C driver for RZ/A1H https://github.com/ARMmbed/mbed-os/pull/3551

3558: K64F UART Asynch API: Fix synchronization issue https://github.com/ARMmbed/mbed-os/pull/3558

3563: LPC4088 - Fix vector checksum https://github.com/ARMmbed/mbed-os/pull/3563

3567: Dev stm32 F0 v1.7.0 https://github.com/ARMmbed/mbed-os/pull/3567

3577: Fixes linking errors when building with debug profile https://github.com/ARMmbed/mbed-os/pull/3577

Who changed what in which revision?

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