API Functions

Overview

Function definitions for PCF8523 driver.

Note

This is the public API for the PCF8523 RTC device.

Functions
rtc_status_t	PCF8523_getCSR (rtc_instance_t *rtc)
	Get control/status register from PCF8523 RTC.
rtc_status_t	PCF8523_getTime (rtc_instance_t *rtc)
	Get time from PCF8523 RTC.
rtc_status_t	PCF8523_setTime (rtc_instance_t *rtc)
	Set time on PCF8523 RTC.
rtc_status_t	PCF8523_setTimeSystem (rtc_instance_t *rtc, u8 use_12hour_mode)
	Set time system (12-hour or 24-hour) on PCF8523 RTC.

Function Documentation

PCF8523_getCSR()

rtc_status_t PCF8523_getCSR

(

rtc_instance_t *

rtc

)

#include <PCF8523.h>

Get control/status register from PCF8523 RTC.

Parameters

rtc	Pointer to RTC instance.

Returns

Status code of the operation.

Definition at line 176 of file PCF8523.c.

PCF8523_getTime()

rtc_status_t PCF8523_getTime

(

rtc_instance_t *

rtc

)

#include <PCF8523.h>

Get time from PCF8523 RTC.

Parameters

rtc	Pointer to RTC instance.

Returns

Status code of the operation.

Definition at line 63 of file PCF8523.c.

PCF8523_setTime()

rtc_status_t PCF8523_setTime

(

rtc_instance_t *

rtc

)

#include <PCF8523.h>

Set time on PCF8523 RTC.

Parameters

rtc	Pointer to RTC instance.

Returns

Status code of the operation.

Definition at line 97 of file PCF8523.c.

PCF8523_setTimeSystem()

rtc_status_t PCF8523_setTimeSystem	(	rtc_instance_t *	rtc,
		u8	use_12hour_mode )

#include <PCF8523.h>

Set time system (12-hour or 24-hour) on PCF8523 RTC.

Parameters

rtc	Pointer to RTC instance.
use_12hour_mode	Flag indicating whether to use 12-hour mode (1) or 24-hour mode (0).

Returns

Status code of the operation.

Definition at line 128 of file PCF8523.c.