px-fwlib 0.10.0
Cross-platform embedded library and documentation for 8/16/32-bit microcontrollers generated with Doxygen 1.9.2
px_async_tmr.h : Asynchronous TMR connected to 32 kHz crystal

Description

This component provides basic time, calender and alarm functionality.

File(s):

Asynchronous 8-bit TMRx operation is selected to use an external 32768 Hz crystal. TMRx is configured to generate an interrupt and call a handler function.

Macros

#define ASYNC_TMR_CFG_PERIOD_MS   1000
 Define timeout period. More...
 
#define ASYNC_TMR_CFG_ON_TICK()   px_rtc_on_tick()
 Define handler function to call when timeout interrupt occurs. More...
 

Functions

void px_async_tmr_init (void)
 Initalises TMRx to use an external 32768 Hz crystal. More...
 
void px_async_tmr_int_enable (void)
 Enable TMRx interrupt. More...
 
bool px_async_tmr_int_disable (void)
 Disable TMRx interrupt. More...
 

Macro Definition Documentation

◆ ASYNC_TMR_CFG_PERIOD_MS

#define ASYNC_TMR_CFG_PERIOD_MS   1000

Define timeout period.

Definition at line 36 of file px_async_tmr_cfg_template.h.

◆ ASYNC_TMR_CFG_ON_TICK

#define ASYNC_TMR_CFG_ON_TICK ( )    px_rtc_on_tick()

Define handler function to call when timeout interrupt occurs.

Definition at line 39 of file px_async_tmr_cfg_template.h.

Function Documentation

◆ px_async_tmr_init()

void px_async_tmr_init ( void  )

Initalises TMRx to use an external 32768 Hz crystal.

TMRx is configured to generate an interrupt once a second, during which the date and time is updated and checked if an alarm has occurred.

Definition at line 60 of file px_async_tmr.c.

◆ px_async_tmr_int_enable()

void px_async_tmr_int_enable ( void  )

Enable TMRx interrupt.

Definition at line 99 of file px_async_tmr.c.

◆ px_async_tmr_int_disable()

bool px_async_tmr_int_disable ( void  )

Disable TMRx interrupt.

Definition at line 104 of file px_async_tmr.c.