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.
LowPowerTicker Class Reference
[Drivers]
#include <LowPowerTicker.h>
Inherits mbed::Ticker, and NonCopyable< LowPowerTicker >.
Inherited by LowPowerTimeout.
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 Member Functions | |
| void | insert (timestamp_t timestamp) |
| Set relative timestamp of the internal event. | |
| void | insert_absolute (us_timestamp_t timestamp) |
| Set absolute timestamp of the internal event. | |
| void | remove () |
| Remove timestamp. | |
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
Low Power Ticker.
- Note:
- Synchronization level: Interrupt safe
Definition at line 35 of file LowPowerTicker.h.
Member Function Documentation
| void attach | ( | Callback< void()> | func, |
| float | t | ||
| ) | [inherited] |
| void insert | ( | timestamp_t | timestamp ) | [protected, inherited] |
Set relative timestamp of the internal event.
- Parameters:
-
timestamp event's us timestamp
- Warning:
- Do not insert more than one timestamp. The same event object is used for every insert/insert_absolute call.
- Ticker's present timestamp is used for reference. For timestamps from the past the event is scheduled after ticker's overflow. For reference
- See also:
- convert_timestamp
Definition at line 43 of file TimerEvent.cpp.
| void insert_absolute | ( | us_timestamp_t | timestamp ) | [protected, inherited] |
Set absolute timestamp of the internal event.
- Parameters:
-
timestamp event's us timestamp
- Warning:
- Do not insert more than one timestamp. The same event object is used for every insert/insert_absolute call.
Definition at line 47 of file TimerEvent.cpp.
| 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)." | |||
| ) | [inherited] |
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
| void remove | ( | ) | [protected, inherited] |
Remove timestamp.
Definition at line 51 of file TimerEvent.cpp.
Field Documentation
us_timestamp_t _delay [protected, inherited] |
Callback<void()> _function [protected, inherited] |
bool _lock_deepsleep [protected, inherited] |
Generated on Tue Jul 12 2022 12:22:54 by
1.7.2