joey shelton / LED_Demo

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.

Dependencies:   MAX44000 PWM_Tone_Library nexpaq_mdk

Fork of LED_Demo by Maxim nexpaq

Embed: (wiki syntax)

« Back to documentation index

Ticker Class Reference
Public Member Functions | Static Public Member Functions | Protected Attributes

Ticker Class Reference

A Ticker is used to call a function at a recurring interval. More...

#include <Ticker.h>

Inherits mbed::TimerEvent.

Inherited by LowPowerTicker, and Timeout.

Public Member Functions

void attach (Callback< void()> func, float t)
 Attach a function to be called by the Ticker, specifiying 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, specifiying the interval in seconds.
void attach_us (Callback< void()> func, timestamp_t t)
 Attach a function to be called by the Ticker, specifiying the interval in micro-seconds.
template<typename T , typename M >
 MBED_DEPRECATED_SINCE ("mbed-os-5.1","The attach_us function does not support cv-qualifiers. Replaced by ""attach_us(callback(obj, method), t).") void attach_us(T *obj
 Attach a member function to be called by the Ticker, specifiying the interval in micro-seconds.

Static Public Member Functions

static void irq (uint32_t id)
 The handler registered with the underlying timer interrupt.

Protected Attributes

timestamp_t _delay
 Time delay (in microseconds) for re-setting the multi-shot callback.
Callback< void()> _function
 Callback.

Detailed Description

A Ticker is used to call a function at a recurring interval.

You can use as many seperate Ticker objects as you require.

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 23 of file features/FEATURE_CLIENT/mbed-client/test/mbedclient/utest/common/Ticker.h.

Member Function Documentation

void attach ( Callback< void()>  func,
float  t 
)

Attach a function to be called by the Ticker, specifiying the interval in seconds.

Parameters:
funcpointer to the function to be called
tthe time between calls in seconds

Definition at line 75 of file hal/api/Ticker.h.

void attach_us ( Callback< void()>  func,
timestamp_t  t 
)

Attach a function to be called by the Ticker, specifiying the interval in micro-seconds.

Parameters:
fptrpointer to the function to be called
tthe time between calls in micro-seconds

Definition at line 101 of file hal/api/Ticker.h.

void irq ( uint32_t  id ) [static, inherited]

The handler registered with the underlying timer interrupt.

Definition at line 33 of file TimerEvent.cpp.

MBED_DEPRECATED_SINCE ( "mbed-os-5.1"  ,
"The attach_us function does not support cv-qualifiers. Replaced by ""attach_us(callback(obj, method), t)."   
)

Attach a member function to be called by the Ticker, specifiying the interval in micro-seconds.

Parameters:
tptrpointer to the object to call the member function on
mptrpointer to the member function to be called
tthe time between calls in micro-seconds
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, specifiying the interval in seconds.

Parameters:
objpointer to the object to call the member function on
methodpointer to the member function to be called
tthe time between calls in seconds

Field Documentation

timestamp_t _delay [protected]

Time delay (in microseconds) for re-setting the multi-shot callback.

Definition at line 136 of file hal/api/Ticker.h.

Callback<void()> _function [protected]

Callback.

Definition at line 137 of file hal/api/Ticker.h.

Generated on Tue Jul 12 2022 12:29:12 by  doxygen 1.7.2