Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Ticker Class Reference
[Drivers]
A Ticker is used to call a function at a recurring interval. More...
#include <Ticker.h>
Inherits mbed::TimerEvent, and NonCopyable< Ticker >.
Inherited by LowPowerTicker, and Timeout.
Public Member Functions | |
| void | attach (Callback< void()> func, float t) |
| Attach a function to be called by the Ticker, specifying the interval in seconds. | |
| template<typename T , typename M > | |
| MBED_DEPRECATED_SINCE ("mbed-os-5.1","The attach function does not support cv-qualifiers. Replaced by ""attach(callback(obj, method), t).") void attach(T *obj | |
| Attach a member function to be called by the Ticker, specifying the interval in seconds. | |
Static Public Member Functions | |
| static void | irq (uint32_t id) |
| The handler registered with the underlying timer interrupt. | |
Protected Attributes | |
| us_timestamp_t | _delay |
| Time delay (in microseconds) for re-setting the multi-shot callback. | |
| Callback< void()> | _function |
| Callback. | |
| bool | _lock_deepsleep |
| Flag which indicates if deep-sleep should be disabled. | |
Private Member Functions | |
| MBED_DEPRECATED ("Invalid copy construction of a NonCopyable resource.") NonCopyable(const NonCopyable &) | |
| NonCopyable copy constructor. | |
| MBED_DEPRECATED ("Invalid copy assignment of a NonCopyable resource.") NonCopyable &operator | |
| NonCopyable copy assignment operator. | |
Detailed Description
A Ticker is used to call a function at a recurring interval.
You can use as many separate Ticker objects as you require.
- Note:
- Synchronization level: Interrupt safe
Example:
// Toggle the blinking led after 5 seconds #include "mbed.h" Ticker timer; DigitalOut led1(LED1); DigitalOut led2(LED2); int flip = 0; void attime() { flip = !flip; } int main() { timer.attach(&attime, 5); while(1) { if(flip == 0) { led1 = !led1; } else { led2 = !led2; } wait(0.2); } }
Definition at line 66 of file Ticker.h.
Member Function Documentation
| void attach | ( | Callback< void()> | func, |
| float | t | ||
| ) |
| void irq | ( | uint32_t | id ) | [static, inherited] |
The handler registered with the underlying timer interrupt.
- Parameters:
-
id Timer Event ID
Definition at line 33 of file TimerEvent.cpp.
| MBED_DEPRECATED_SINCE | ( | "mbed-os-5.1" | , |
| "The attach function does not support cv-qualifiers. Replaced by ""attach(callback(obj, method), t)." | |||
| ) |
Attach a member function to be called by the Ticker, specifying the interval in seconds.
- Parameters:
-
obj pointer to the object to call the member function on method pointer to the member function to be called t the time between calls in seconds
Field Documentation
us_timestamp_t _delay [protected] |
bool _lock_deepsleep [protected] |
Generated on Thu Jul 14 2022 14:36:32 by
1.7.2