Eric Lewiston / STM32L4xx_HAL_Driver

Hal Drivers for L4

Dependents:   BSP OneHopeOnePrayer FINAL_AUDIO_RECORD AudioDemo

Fork of STM32L4xx_HAL_Driver by Senior Design: Sound Monitor

Embed: (wiki syntax)

« Back to documentation index

RTC Time and Date functions
Functions

RTC Time and Date functions
[RTC Exported Functions]

RTC Time and Date functions. More...

Functions

HAL_StatusTypeDef HAL_RTC_SetTime (RTC_HandleTypeDef *hrtc, RTC_TimeTypeDef *sTime, uint32_t Format)
 Set RTC current time.
HAL_StatusTypeDef HAL_RTC_GetTime (RTC_HandleTypeDef *hrtc, RTC_TimeTypeDef *sTime, uint32_t Format)
 Get RTC current time.
HAL_StatusTypeDef HAL_RTC_SetDate (RTC_HandleTypeDef *hrtc, RTC_DateTypeDef *sDate, uint32_t Format)
 Set RTC current date.
HAL_StatusTypeDef HAL_RTC_GetDate (RTC_HandleTypeDef *hrtc, RTC_DateTypeDef *sDate, uint32_t Format)
 Get RTC current date.

Detailed Description

RTC Time and Date functions. 

 ===============================================================================
                 ##### RTC Time and Date functions #####
 ===============================================================================
 
 [..] This section provides functions allowing to configure Time and Date features

Function Documentation

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

Get RTC current date.

Parameters:
hrtc,:RTC handle
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:
HALstatus

Definition at line 703 of file stm32l4xx_hal_rtc.c.

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

Get RTC current time.

Parameters:
hrtc,:RTC handle
sTime,:Pointer to Time structure with Hours, Minutes and Seconds fields returned with input format (BIN or BCD), also SubSeconds field returning the RTC_SSR register content and SecondFraction field the Synchronous pre-scaler factor to be used for second fraction ratio computation.
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 to ensure consistency between the time and date values.
Return values:
HALstatus

Definition at line 548 of file stm32l4xx_hal_rtc.c.

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

Set RTC current date.

Parameters:
hrtc,:RTC handle
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:
HALstatus

Definition at line 592 of file stm32l4xx_hal_rtc.c.

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

Set RTC current time.

Parameters:
hrtc,:RTC handle
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:
HALstatus

Definition at line 413 of file stm32l4xx_hal_rtc.c.

Generated on Tue Jul 12 2022 11:35:30 by  doxygen 1.7.2