Library Functions. More...

Functions
uint32_t	TM_RTC_Init (TM_RTC_ClockSource_t source)
	Initializes RTC and starts counting. More...

uint32_t	TM_RTC_GetUnixTimeStamp (TM_RTC_t *data)
	Get number of seconds from date and time since 01.01.1970 00:00:00. More...

void	TM_RTC_GetDateTimeFromUnix (TM_RTC_t *data, uint32_t unix)
	Get formatted time from seconds till 01.01.1970 00:00:00 It fills struct with valid data. More...

void	TM_RTC_Interrupts (TM_RTC_Int_t int_value)
	Select RTC wakeup interrupts interval. More...

TM_RTC_Result_t	TM_RTC_SetDateTime (TM_RTC_t *data, TM_RTC_Format_t format)
	Set date and time to internal RTC registers. More...

TM_RTC_Result_t	TM_RTC_SetDateTimeString (char *str)
	Set date and time using string formatted date time. More...

void	TM_RTC_GetDateTime (TM_RTC_t *data, TM_RTC_Format_t format)
	Get date and time from internal RTC registers. More...

uint8_t	TM_RTC_GetDaysInMonth (uint8_t month, uint8_t year)
	Get number of days in month. More...

uint16_t	TM_RTC_GetDaysInYear (uint8_t year)
	Get number of days in specific year. More...

void	TM_RTC_WriteBackupRegister (uint8_t location, uint32_t value)
	Write RTC backup register value. This method allows you to write 32bit value from backup register 0 - 18. More...

uint32_t	TM_RTC_ReadBackupRegister (uint8_t location)
	Read RTC backup register value. This method allows you to read 32bit value from backup register 0 - 18. More...

void	TM_RTC_SetAlarm (TM_RTC_Alarm_t Alarm, TM_RTC_AlarmTime_t *AlarmTime, TM_RTC_Format_t format)
	Enables alarm A or alarm B. More...

void	TM_RTC_DisableAlarm (TM_RTC_Alarm_t Alarm)
	Disables specific alarm. More...

void	TM_RTC_RequestHandler (void)
	RTC Wakeup handler function. Called when wakeup interrupt is triggered. More...

void	TM_RTC_AlarmAHandler (void)
	RTC Alarm A handler function. Called when interrupt is triggered for alarm A. More...

void	TM_RTC_AlarmBHandler (void)
	RTC Alarm B handler function. Called when interrupt is triggered for alarm B. More...

Detailed Description

Library Functions.

Function Documentation

void TM_RTC_AlarmAHandler ( void )

RTC Alarm A handler function. Called when interrupt is triggered for alarm A.

Note: Called from my RTC library

Parameters

None

Return values

None

Note: With __weak parameter to prevent link errors if not defined by user

void TM_RTC_AlarmBHandler ( void )

RTC Alarm B handler function. Called when interrupt is triggered for alarm B.

Note: Called from my RTC library

Parameters

None

Return values

None

Note: With __weak parameter to prevent link errors if not defined by user

void TM_RTC_DisableAlarm ( TM_RTC_Alarm_t Alarm )

Disables specific alarm.

Parameters

Alarm Select which alarm you want to disable. This parameter can be a value of TM_RTC_Alarm_t enumeration

Return values

None

void TM_RTC_GetDateTime	(	TM_RTC_t *	data,
		TM_RTC_Format_t	format
	)

Get date and time from internal RTC registers.

Parameters

*data	Pointer to TM_RTC_t structure to save data to
format	Format of your structure. This parameter can be a value of TM_RTC_Format_t enumeration

Return values

None

void TM_RTC_GetDateTimeFromUnix	(	TM_RTC_t *	data,
		uint32_t	unix
	)

Get formatted time from seconds till 01.01.1970 00:00:00 It fills struct with valid data.

Note: Valid if year is greater or equal (>=) than 2000

Parameters

*data	Pointer to TM_RTC_Time_t struct to store formatted data in
unix	Seconds from 01.01.1970 00:00:00 to calculate user friendly time

Return values

None

uint8_t TM_RTC_GetDaysInMonth	(	uint8_t	month,
		uint8_t	year
	)

Get number of days in month.

Note: This function also detects if it is leap year and returns different number for February

Parameters

month	Month number in year, valid numbers are 1 - 12
year	Year number where you want to get days in month, last 2 digits

Return values

Number of days in specific month and year

uint16_t TM_RTC_GetDaysInYear ( uint8_t year )

Get number of days in specific year.

Note: This function also detects if it is leap year

Parameters

year	Year number where you want to get days in month, last 2 digits

Return values

Number of days in year

uint32_t TM_RTC_GetUnixTimeStamp ( TM_RTC_t * data )

Get number of seconds from date and time since 01.01.1970 00:00:00.

Parameters

*data Pointer to TM_RTC_t data structure

Return values

Calculated seconds from date and time since 01.01.1970 00:00:00

uint32_t TM_RTC_Init ( TM_RTC_ClockSource_t source )

Initializes RTC and starts counting.

Parameters

source. RTC Clock source TM_RTC_ClockSource_t to be used for RTC

Note: Internal clock source is not so accurate; If you reset your MCU and RTC still has power, it will count independent of MCU status

Return values

Returns

RTC status.

1: RTC has already been initialized and time is set
0: RTC was now initialized first time. Now you can set your first clock

void TM_RTC_Interrupts ( TM_RTC_Int_t int_value )

Select RTC wakeup interrupts interval.

Note: This function can also be used to disable interrupt

Parameters

int_value Look for TM_RTC_Int_t for valid inputs

Return values

None

uint32_t TM_RTC_ReadBackupRegister ( uint8_t location )

Read RTC backup register value. This method allows you to read 32bit value from backup register 0 - 18.

Note: RTC has 20 backup registers where you can store data which will be available all the time RTC is running and has power.; My library uses register 19 to store info about RTC settings and is not available for USER to store data there.; RTC HAS to be initialized first before you can use this method.

Parameters

location RTC backup register location. 0 to 18 are valid

Return values

Value at specific RTC backup register location

void TM_RTC_RequestHandler ( void )

RTC Wakeup handler function. Called when wakeup interrupt is triggered.

Note: Called from my RTC library

Parameters

None

Return values

None

Note: With __weak parameter to prevent link errors if not defined by user

void TM_RTC_SetAlarm	(	TM_RTC_Alarm_t	Alarm,
		TM_RTC_AlarmTime_t *	AlarmTime,
		TM_RTC_Format_t	format
	)

Enables alarm A or alarm B.

Parameters

Alarm	Specify which alarm to set. This parameter can be a value of TM_RTC_Alarm_t enumeration
*AlarmTime	Pointer to TM_RTC_AlarmTime_t structure to get data from.
format	RTC date and time format. This parameter can be a value of TM_RTC_Format_t enumeration.

Return values

None

TM_RTC_Result_t TM_RTC_SetDateTime	(	TM_RTC_t *	data,
		TM_RTC_Format_t	format
	)

Set date and time to internal RTC registers.

Parameters

*data	Pointer to filled TM_RTC_t structure with date and time
format	Format of your structure. This parameter can be a value of TM_RTC_Format_t enumeration

Return values

RTC	datetime status TM_RTC_Result_t: TM_RTC_Result_Ok: Date and Time set OK TM_RTC_Result_Error: Date and time is wrong

TM_RTC_Result_t TM_RTC_SetDateTimeString ( char * str )

Set date and time using string formatted date time.

Note

Valid string format is: dd.mm.YY.x;HH:ii:ss

dd: date, 2 digits, decimal
mm: month, 2 digits, decimal
YY: year, last 2 digits, decimal
x: day in a week: 1 digit, 1 = Monday, 7 = Sunday
HH: hours, 24-hour mode, 2 digits, decimal
ii: minutes, 2 digits, decimal
ss: seconds, 2 digits, decimal

Parameters

*str	Pointer to string with datetime format

Return values

RTC	datetime status TM_RTC_Result_t: TM_RTC_Result_Ok: Date and Time set OK TM_RTC_Result_Error: Date and time is wrong

void TM_RTC_WriteBackupRegister	(	uint8_t	location,
		uint32_t	value
	)

Write RTC backup register value. This method allows you to write 32bit value from backup register 0 - 18.

Note: RTC has 20 backup registers where you can store data which will be available all the time RTC is running and has power.; My library uses register 19 to store info about RTC settings and is not available for USER to store data there.; RTC HAS to be initialized first before you can use this method.

Parameters

location	RTC backup register location. 0 to 18 are valid
value	32-bit long value to be stored in RTC backup register

Return values

Value at specific RTC backup register location