RTC_Exported_Functions_Group2

Functions
HAL_StatusTypeDef	HAL_RTC_SetTime (RTC_HandleTypeDef *hrtc, RTC_TimeTypeDef *sTime, uint32_t Format)
	Sets RTC current time. More...
HAL_StatusTypeDef	HAL_RTC_GetTime (RTC_HandleTypeDef *hrtc, RTC_TimeTypeDef *sTime, uint32_t Format)
	Gets RTC current time. More...
HAL_StatusTypeDef	HAL_RTC_SetDate (RTC_HandleTypeDef *hrtc, RTC_DateTypeDef *sDate, uint32_t Format)
	Sets RTC current date. More...
HAL_StatusTypeDef	HAL_RTC_GetDate (RTC_HandleTypeDef *hrtc, RTC_DateTypeDef *sDate, uint32_t Format)
	Gets RTC current date. More...
HAL_StatusTypeDef	HAL_RTC_IncOneSecond (RTC_HandleTypeDef *hrtc, int32_t increase)
	Increase/Decrease RTC by 1 second.. More...

Detailed Description

Function Documentation

HAL_RTC_GetDate()

HAL_StatusTypeDef HAL_RTC_GetDate	(	RTC_HandleTypeDef *	hrtc,
		RTC_DateTypeDef *	sDate,
		uint32_t	Format
	)

Gets RTC current date.

Parameters

hrtc	pointer to a RTC_HandleTypeDef structure that contains the configuration information for RTC.
sDate	Pointer to Date structure
Format	Specifies the format of the entered parameters. This parameter can be one of the following values: RTC_FORMAT_BIN: Binary data format RTC_FORMAT_BCD: BCD data format

Note

You must call HAL_RTC_GetDate() after HAL_RTC_GetTime() to unlock the values in the higher-order calendar shadow registers to ensure consistency between the time and date values. Reading RTC current time locks the values in calendar shadow registers until Current date is read.

Return values

HAL

status

HAL_RTC_GetTime()

HAL_StatusTypeDef HAL_RTC_GetTime	(	RTC_HandleTypeDef *	hrtc,
		RTC_TimeTypeDef *	sTime,
		uint32_t	Format
	)

Gets RTC current time.

Parameters

hrtc	pointer to a RTC_HandleTypeDef structure that contains the configuration information for RTC.
sTime	Pointer to Time structure
Format	Specifies the format of the entered parameters. This parameter can be one of the following values: RTC_FORMAT_BIN: Binary data format RTC_FORMAT_BCD: BCD data format

Note

You can use SubSeconds and SecondFraction (sTime structure fields returned) to convert SubSeconds value in second fraction ratio with time unit following generic formula: Second fraction ratio * time_unit= [(SecondFraction-SubSeconds)/(SecondFraction+1)] * time_unit This conversion can be performed only if no shift operation is pending (ie. SHFP=0) when PREDIV_S >= SS

You must call HAL_RTC_GetDate() after HAL_RTC_GetTime() to unlock the values in the higher-order calendar shadow registers to ensure consistency between the time and date values. Reading RTC current time locks the values in calendar shadow registers until current date is read.

Return values

HAL

status

HAL_RTC_IncOneSecond()

HAL_StatusTypeDef HAL_RTC_IncOneSecond	(	RTC_HandleTypeDef *	hrtc,
		int32_t	increase
	)

Increase/Decrease RTC by 1 second..

Parameters

hrtc	pointer to a RTC_HandleTypeDef structure that contains the configuration information for RTC.
increase	>0: increase, <0:decrease, 0 no change

Return values

HAL

status

HAL_RTC_SetDate()

HAL_StatusTypeDef HAL_RTC_SetDate	(	RTC_HandleTypeDef *	hrtc,
		RTC_DateTypeDef *	sDate,
		uint32_t	Format
	)

Sets RTC current date.

Parameters

hrtc	pointer to a RTC_HandleTypeDef structure that contains the configuration information for RTC.
sDate	Pointer to date structure
Format	specifies the format of the entered parameters. This parameter can be one of the following values: RTC_FORMAT_BIN: Binary data format RTC_FORMAT_BCD: BCD data format

Return values

HAL

status

HAL_RTC_SetTime()

HAL_StatusTypeDef HAL_RTC_SetTime	(	RTC_HandleTypeDef *	hrtc,
		RTC_TimeTypeDef *	sTime,
		uint32_t	Format
	)

Sets RTC current time.

Parameters

hrtc	pointer to a RTC_HandleTypeDef structure that contains the configuration information for RTC.
sTime	Pointer to Time structure
Format	Specifies the format of the entered parameters. This parameter can be one of the following values: RTC_FORMAT_BIN: Binary data format RTC_FORMAT_BCD: BCD data format

Return values

HAL

status