Application Timer#

SAppTimer#

typedef struct SAppTimer SAppTimer

AppTimer object.

AppTimerInit#

void AppTimerInit (uint8_t iTaskNotificationBitNumber, void * ReceiverTask)

Initialize AppTimer.

AppTimerSetReceiverTask#

void AppTimerSetReceiverTask (void * ReceiverTask)

Configures the Receiver task of callbacks.

Provided as the AppTimer may be needed for registering SwTimers before the receiver task is created, meaning AppTimerInit is called prior to the Receiver task handle being available. Though not the intention, the receiver task can be changed at run time.

AppTimerRegister#

bool AppTimerRegister (SSwTimer * pTimer, bool bAutoReload, void(*)(SSwTimer *pTimer) pCallback)

Register a SwTimer to a TimerLiaison.

Initial SwTimer configuration is also performed.

Method creates a static FreeRTOS timer from the SwTimer object passed as argument, and registers it as requiring callbacks in the Receiver task. If calling method AppTimerRegister on the same SwTimer object multiple times, all but the first call will be ignored.

AppTimerDeepSleepPersistentRegister#

bool AppTimerDeepSleepPersistentRegister (SSwTimer * pTimer, bool bAutoReload, void(*)(SSwTimer *pTimer) pCallback)

Wrapper for AppTimerRegister to register timers that should be re-loaded after deep sleep hibernate.

In addition to having AppTimerRegister() register the timer with a TimerLiaison this function also marks the timer to survive deep sleep hibernate.

For parameter descriptions See Also

• AppTimerRegister.

AppTimerDeepSleepPersistentStart#

ESwTimerStatus AppTimerDeepSleepPersistentStart (SSwTimer * pTimer, uint32_t iTimeout)

Wrapper for TimerStart() that ensures the timer value is saved so it can be re-loaded after deep sleep hibernate.

For parameter descriptions See Also

• TimerStart.

AppTimerDeepSleepPersistentRestart#

ESwTimerStatus AppTimerDeepSleepPersistentRestart (SSwTimer * pTimer)

Wrapper for TimerRestart() that ensures the timer status is saved so it can be re-loaded after deep sleep hibernate.

For parameter descriptions See Also

• TimerRestart.

AppTimerDeepSleepPersistentStop#

ESwTimerStatus AppTimerDeepSleepPersistentStop (SSwTimer * pTimer)

Wrapper for TimerStop() that ensures the timer status is saved so it does not get re-started after deep sleep hibernate.

For parameter descriptions See Also

• TimerStop.

AppTimerNotificationHandler#

void AppTimerNotificationHandler (void )

Must be called from application task when the task notification bit assigned to AppTimer is set.

Method will perform pending callbacks. There is no side effects from calling method when assigned task notification bit was not set.

AppTimerDeepSleepPersistentResetStorage#

void AppTimerDeepSleepPersistentResetStorage (void )

Clear storage used for persisting application timers during deep sleep hibernate.

AppTimerDeepSleepPersistentSaveAll#

void AppTimerDeepSleepPersistentSaveAll (void )

Save SSwTimers that should survive deep sleep Hibernate.

The number of remaining milliseconds until timeout are saved to the RTCC retention registers for all application timers registered to be persisted during Deep Sleep.

AppTimerDeepSleepPersistentLoadAll#

void AppTimerDeepSleepPersistentLoadAll (zpal_reset_reason_t resetReason)

Load SSwTimers after deep sleep hibernate wakeup.

Activates callback registered for the timer causing the wakeup

Must be called AFTER AppTimerInit() and AppTimerDeepSleepPersistentRegister()

AppTimerDeepSleepGetFirstRetentionRegister#

uint32_t AppTimerDeepSleepGetFirstRetentionRegister (void )

Get index of first retention register used for saving Deep Sleep persistent app timers.

The retention registers are manipulated with the zpal_retention_register_xx() API.

AppTimerDeepSleepGetLastRetentionRegister#

uint32_t AppTimerDeepSleepGetLastRetentionRegister (void )

Get index of last retention register used for saving Deep Sleep persistent app timers.

NB: The number of retention registers used depends on how many times AppTimerDeepSleepPersistentRegister() have been called since system startup. It is not safe to use the returned value to locate "free" retention registers unless it is guarantees that all calls to AppTimerDeepSleepPersistentRegister() has been performed.

The retention registers are manipulated with the zpal_retention_register_xx() API.

AppTimerStopAll#

void AppTimerStopAll (void )

Stops all the running applications timers.