kushagra brahmbhatt / IoT_Security

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.

Dependents:   IoTBurglar_and_Fire_AlarmSystem

Embed: (wiki syntax)

« Back to documentation index

Ticker Class Reference
Public Member Functions | Static Public Member Functions

Ticker Class Reference

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

#include <Ticker.h>

Inherits mbed::TimerEvent.

Inherited by Timeout.

Public Member Functions

void attach (void(*fptr)(void), float t)
 Attach a function to be called by the Ticker, specifiying the interval in seconds.
template<typename T >
void attach (T *tptr, void(T::*mptr)(void), float t)
 Attach a member function to be called by the Ticker, specifiying the interval in seconds.
void attach_us (void(*fptr)(void), unsigned int t)
 Attach a function to be called by the Ticker, specifiying the interval in micro-seconds.
template<typename T >
void attach_us (T *tptr, void(T::*mptr)(void), unsigned int t)
 Attach a member function to be called by the Ticker, specifiying the interval in micro-seconds.
void detach ()
 Detach the function.

Static Public Member Functions

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

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.

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 57 of file Ticker.h.

Member Function Documentation

void attach ( void(*)(void)  fptr,
float  t 
)

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

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

Definition at line 66 of file Ticker.h.

void attach ( T *  tptr,
void(T::*)(void)  mptr,
float  t 
)

Attach a member function to be called by the Ticker, specifiying the interval in 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 seconds

Definition at line 77 of file Ticker.h.

void attach_us ( T *  tptr,
void(T::*)(void)  mptr,
unsigned int  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

Definition at line 98 of file Ticker.h.

void attach_us ( void(*)(void)  fptr,
unsigned int  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 86 of file Ticker.h.

void detach (  )

Detach the function.

static void irq ( uint32_t  id ) [static, inherited]

The handler registered with the underlying timer interrupt.

Generated on Tue Jul 12 2022 19:25:17 by  doxygen 1.7.2