LowPowerTicker Class Reference

Low Power Ticker. More...

#include <LowPowerTicker.h>

Inheritance diagram for LowPowerTicker:

Public Member Functions
template<typename F >
MBED_FORCEINLINE void	attach (F &&func, float t)
	Attach a function to be called by the Ticker, specifying the interval in seconds. More...
void	attach (Callback< void()> func, std::chrono::microseconds t)
	Attach a function to be called by the Ticker, specifying the interval in microseconds. More...
void	attach_us (Callback< void()> func, us_timestamp_t t)
	Attach a function to be called by the Ticker, specifying the interval in microseconds. More...
void	detach ()
	Detach the function. More...

Detailed Description

Low Power Ticker.

Note

Synchronization level: Interrupt safe

Definition at line 42 of file LowPowerTicker.h.

Member Function Documentation

attach() [1/2]

MBED_FORCEINLINE void attach ( F &&  func, float  t  )

inherited

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

The method forwards its arguments to attach_us() rather than copying them which may not be trivial depending on the callback copied. The function is forcibly inlined to not use floating-point operations. This is possible given attach_us() expects an integer value for the callback interval.

Parameters

func	pointer to the function to be called
t	the time between calls in seconds

Deprecated:

Pass a chrono duration, not a float second count. For example use 10ms rather than 0.01f.

Definition at line 92 of file Ticker.h.

attach() [2/2]

void attach ( Callback< void()>  func, std::chrono::microseconds  t  )

inherited

Attach a function to be called by the Ticker, specifying the interval in microseconds.

Parameters

func	pointer to the function to be called
t	the time between calls in micro-seconds

Note

setting t to a value shorter than it takes to process the ticker callback causes the system to hang. Ticker callback is called constantly with no time for threads scheduling.

attach_us()

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

inherited

Attach a function to be called by the Ticker, specifying the interval in microseconds.

Parameters

func	pointer to the function to be called
t	the time between calls in micro-seconds

Note

setting t to a value shorter than it takes to process the ticker callback causes the system to hang. Ticker callback is called constantly with no time for threads scheduling.

Deprecated:

Pass a chrono duration, not an integer microsecond count. For example use 10ms rather than 10000.

detach()

void detach ( )

inherited

Detach the function.