PCF8523_ex.h File Reference

PCF8523 Driver extensions. More...

#include "sarmfsw.h"
#include "PCF8523.h"

Include dependency graph for PCF8523_ex.h:

This graph shows which files directly or indirectly include this file:

Data Structures
union	uPCF8523_REG_MAP
	Union of PCF8523 registry map. More...

Functions
FctERR	PCF8523_Reset (void)
FctERR	PCF8523_Disable_Alarm (void)
FctERR	PCF8523_Disable_Minute_Alarm (void)
FctERR	PCF8523_Disable_Hour_Alarm (void)
FctERR	PCF8523_Disable_Day_Alarm (void)
FctERR	PCF8523_Disable_Weekday_Alarm (void)
FctERR	PCF8523_Enable_Minute_Alarm (const uint8_t minute)
FctERR	PCF8523_Enable_Hour_Alarm (const uint8_t hour)
FctERR	PCF8523_Enable_Day_Alarm (const uint8_t day)
FctERR	PCF8523_Enable_Weekday_Alarm (const uint8_t weekday)
FctERR	PCF8523_Set_12_24 (const bool twelve)
FctERR	PCF8523_Set_Date_Raw (const uint8_t date[4])
FctERR	PCF8523_Set_Time_Raw (const uint8_t time[3])
FctERR	PCF8523_Get_Countdown (uint8_t *ctdw, const uint16_t period, const uint8_t timer)
	Countdown calculation for PCF8523 peripheral.
FctERR	PCF8523_Get_Date_Raw (uint8_t *const date)
FctERR	PCF8523_Get_Time_Raw (uint8_t *const time)
FctERR	PCF8523_Check_Clock_Integrity (bool *const integrity)
void	PCF8523_INT1_GPIO_Init (GPIO_TypeDef *const GPIOx, const uint16_t GPIO_Pin, const GPIO_PinState GPIO_Active)
	Interrupt 1 GPIO pin init for PCF8523.
bool	PCF8523_INT1_GPIO_Get (void)
	Interrupt 1 GPIO pin getter for PCF8523.
void	PCF8523_INT2_GPIO_Init (GPIO_TypeDef *const GPIOx, const uint16_t GPIO_Pin, const GPIO_PinState GPIO_Active)
	Interrupt 2 GPIO pin init for PCF8523.
bool	PCF8523_INT2_GPIO_Get (void)
	Interrupt 2 GPIO pin getter for PCF8523.

Detailed Description

PCF8523 Driver extensions.

Author

SMFSW

Copyright

MIT (c) 2017-2026, SMFSW

PCF8523: Real-Time Clock (RTC) and calendar

Function Documentation

PCF8523_Check_Clock_Integrity()

FctERR PCF8523_Check_Clock_Integrity

(

bool *const

integrity

)

Here is the call graph for this function:

PCF8523_Disable_Alarm()

FctERR PCF8523_Disable_Alarm ( void )

inline

Here is the call graph for this function:

PCF8523_Disable_Day_Alarm()

FctERR PCF8523_Disable_Day_Alarm ( void )

inline

Here is the call graph for this function:

PCF8523_Disable_Hour_Alarm()

FctERR PCF8523_Disable_Hour_Alarm ( void )

inline

Here is the call graph for this function:

PCF8523_Disable_Minute_Alarm()

FctERR PCF8523_Disable_Minute_Alarm ( void )

inline

Here is the call graph for this function:

PCF8523_Disable_Weekday_Alarm()

FctERR PCF8523_Disable_Weekday_Alarm ( void )

inline

Here is the call graph for this function:

PCF8523_Enable_Day_Alarm()

FctERR PCF8523_Enable_Day_Alarm

(

const uint8_t

day

)

Here is the call graph for this function:

PCF8523_Enable_Hour_Alarm()

FctERR PCF8523_Enable_Hour_Alarm

(

const uint8_t

hour

)

Here is the call graph for this function:

PCF8523_Enable_Minute_Alarm()

FctERR PCF8523_Enable_Minute_Alarm

(

const uint8_t

minute

)

Here is the call graph for this function:

PCF8523_Enable_Weekday_Alarm()

FctERR PCF8523_Enable_Weekday_Alarm

(

const uint8_t

weekday

)

Here is the call graph for this function:

PCF8523_Get_Countdown()

FctERR PCF8523_Get_Countdown	(	uint8_t *	ctdw,
		const uint16_t	period,
		const uint8_t	timer )

Countdown calculation for PCF8523 peripheral.

Returns

Error code

PCF8523_Get_Date_Raw()

FctERR PCF8523_Get_Date_Raw ( uint8_t *const date )

inline

Here is the call graph for this function:

Here is the caller graph for this function:

PCF8523_Get_Time_Raw()

FctERR PCF8523_Get_Time_Raw ( uint8_t *const time )

inline

Here is the call graph for this function:

Here is the caller graph for this function:

PCF8523_INT1_GPIO_Get()

bool PCF8523_INT1_GPIO_Get

(

void

)

Interrupt 1 GPIO pin getter for PCF8523.

Weak Functions

PCF8523 Interrupt 1 GPIO pin getter may be user implemented if needed

Returns

INT1 pin state value (0: inactive, 1: active)

Here is the call graph for this function:

Here is the caller graph for this function:

PCF8523_INT1_GPIO_Init()

void PCF8523_INT1_GPIO_Init	(	GPIO_TypeDef *const	GPIOx,
		const uint16_t	GPIO_Pin,
		const GPIO_PinState	GPIO_Active )

Interrupt 1 GPIO pin init for PCF8523.

Weak Functions

PCF8523 Interrupt 1 GPIO pin init may be user implemented if needed

Parameters

[in]	GPIOx	- INT1 port
[in]	GPIO_Pin	- INT1 pin
[in]	GPIO_Active	INT1 pin active state

Here is the call graph for this function:

PCF8523_INT2_GPIO_Get()

bool PCF8523_INT2_GPIO_Get

(

void

)

Interrupt 2 GPIO pin getter for PCF8523.

Weak Functions

PCF8523 Interrupt 2 GPIO pin getter may be user implemented if needed

Returns

INT2 pin state value (0: inactive, 1: active)

Here is the call graph for this function:

Here is the caller graph for this function:

PCF8523_INT2_GPIO_Init()

void PCF8523_INT2_GPIO_Init	(	GPIO_TypeDef *const	GPIOx,
		const uint16_t	GPIO_Pin,
		const GPIO_PinState	GPIO_Active )

Interrupt 2 GPIO pin init for PCF8523.

Weak Functions

PCF8523 Interrupt 2 GPIO pin init may be user implemented if needed

Parameters

[in]	GPIOx	- INT2 port
[in]	GPIO_Pin	- INT2 pin
[in]	GPIO_Active	INT2 pin active state

Here is the call graph for this function:

PCF8523_Reset()

FctERR PCF8523_Reset ( void )

inline

Here is the call graph for this function:

PCF8523_Set_12_24()

FctERR PCF8523_Set_12_24

(

const bool

twelve

)

Here is the call graph for this function:

PCF8523_Set_Date_Raw()

FctERR PCF8523_Set_Date_Raw ( const uint8_t date[4] )

inline

Here is the call graph for this function:

Here is the caller graph for this function:

PCF8523_Set_Time_Raw()

FctERR PCF8523_Set_Time_Raw ( const uint8_t time[3] )

inline

Here is the call graph for this function:

Here is the caller graph for this function: