Public function

Functions
void	rtc9_cfg_setup (rtc9_cfg_t *cfg)
	Config Object Initialization function.
RTC9_RETVAL	rtc9_init (rtc9_t *ctx, rtc9_cfg_t *cfg)
	Initialization function.
void	rtc9_generic_write (rtc9_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
	Generic write function.
void	rtc9_generic_read (rtc9_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
	Generic read function.
void	rtc9_wakeup (rtc9_t *ctx)
	Wake-up process.
void	rtc9_software_reset (rtc9_t *ctx)
	Software reset.
void	rtc9_hardware_reset (rtc9_t *ctx)
	Hardware reset.
void	rtc9_set_time (rtc9_t *ctx, uint8_t hour, uint8_t min, uint8_t sec)
	Set new time - 24 hour format.
void	rtc9_set_date (rtc9_t *ctx, rtc9_set_data_t *set_data)
	Set new date.
void	rtc9_get_time (rtc9_t *ctx, rtc9_get_time_t *get_time)
	Get new time - 24 hour format.
void	rtc9_get_date (rtc9_t *ctx, rtc9_get_date_t *get_data)
	Get new date.
char *	rtc9_current_month (uint8_t month)
	Month in the String format.
char *	rtc9_current_day_of_week (uint8_t day_of_week)
	Day of Week in the String format.
void	rtc9_set_alarm_time (rtc9_t *ctx, uint8_t hour, uint8_t min, uint8_t sec)
	Set new ALARM 1 time - 24 hour format.
void	rtc9_set_alarm_date (rtc9_t *ctx, uint8_t day, uint8_t month, uint8_t year)
	Set new ALARM 1 date.
void	rtc9_read_flag_status (rtc9_t *ctx, uint8_t *read_data)
	Reads FLAGS regiter.

Detailed Description

Function Documentation

rtc9_cfg_setup()

void rtc9_cfg_setup

(

rtc9_cfg_t *

cfg

)

Config Object Initialization function.

Parameters

cfg	Click configuration structure.

@description This function initializes click configuration structure to init state.

Note

All used pins will be set to unconnected state.

rtc9_current_day_of_week()

char * rtc9_current_day_of_week

(

uint8_t

day_of_week

)

Day of Week in the String format.

Parameters

day_of_week

Current dey of week

Returns

pointer to string... ( 1 = Sunday... )

rtc9_current_month()

char * rtc9_current_month

(

uint8_t

month

)

Month in the String format.

Parameters

month

Current month

Returns

pointer to string... ( 1 = January... )

rtc9_generic_read()

void rtc9_generic_read	(	rtc9_t *	ctx,
		uint8_t	reg,
		uint8_t *	data_buf,
		uint8_t	len )

Generic read function.

Parameters

ctx	Click object.
reg	Register address.
data_buf	Output data buf
len	Number of the bytes to be read

@description This function reads data from the desired register.

rtc9_generic_write()

void rtc9_generic_write	(	rtc9_t *	ctx,
		uint8_t	reg,
		uint8_t *	data_buf,
		uint8_t	len )

Generic write function.

Parameters

ctx	Click object.
reg	Register address.
data_buf	Data buf to be written.
len	Number of the bytes in data buf.

@description This function writes data to the desired register.

rtc9_get_date()

void rtc9_get_date	(	rtc9_t *	ctx,
		rtc9_get_date_t *	get_data )

Get new date.

Parameters

rtc9	Click object.
get_data	Struct object.

rtc9_get_time()

void rtc9_get_time	(	rtc9_t *	ctx,
		rtc9_get_time_t *	get_time )

Get new time - 24 hour format.

Parameters

rtc9	Click object.
get_time	Struct object.

rtc9_hardware_reset()

void rtc9_hardware_reset

(

rtc9_t *

ctx

)

Hardware reset.

Parameters

rtc9	Click object.

rtc9_init()

RTC9_RETVAL rtc9_init	(	rtc9_t *	ctx,
		rtc9_cfg_t *	cfg )

Initialization function.

Parameters

ctx	Click object.
cfg	Click configuration structure.

@description This function initializes all necessary pins and peripherals used for this click.

rtc9_read_flag_status()

void rtc9_read_flag_status	(	rtc9_t *	ctx,
		uint8_t *	read_data )

Reads FLAGS regiter.

Parameters

rtc9	Click object.
read_data	Data to be read.

rtc9_set_alarm_date()

void rtc9_set_alarm_date	(	rtc9_t *	ctx,
		uint8_t	day,
		uint8_t	month,
		uint8_t	year )

Set new ALARM 1 date.

Parameters

rtc9	Click object.
day	New Day (1 - 31/30/28/29)
month	New month (1 - 12)
year	New year (0 - 99) 2000 year ... 2099 year

rtc9_set_alarm_time()

void rtc9_set_alarm_time	(	rtc9_t *	ctx,
		uint8_t	hour,
		uint8_t	min,
		uint8_t	sec )

Set new ALARM 1 time - 24 hour format.

Parameters

rtc9	Click object.
hour	New Hours (0 - 23)
min	New minutes (0 - 59)
sec	New secconds (0 - 59)

rtc9_set_date()

void rtc9_set_date	(	rtc9_t *	ctx,
		rtc9_set_data_t *	set_data )

Set new date.

Parameters

rtc9	Click object.
set_data	Struct object.

rtc9_set_time()

void rtc9_set_time	(	rtc9_t *	ctx,
		uint8_t	hour,
		uint8_t	min,
		uint8_t	sec )

Set new time - 24 hour format.

Parameters

rtc9	Click object.
hour	New Hours (0 - 23)
min	New minutes (0 - 59)
sec	New secconds (0 - 59)

rtc9_software_reset()

void rtc9_software_reset

(

rtc9_t *

ctx

)

Software reset.

Parameters

rtc9	Click object.

rtc9_wakeup()

void rtc9_wakeup

(

rtc9_t *

ctx

)

Wake-up process.

Parameters

rtc9	Click object.

Note

This function must be called at the start of the program