Dataflow Runtime API  3.0.3.0
Classes | Static Public Member Functions | List of all members
imt::base::hal::stm32h730::peripherals::RTC Class Reference

Real time Clock module Reference: ST_CortexM7_STM32H730_TRM_Rev2.pdf Chapter 51. More...

#include <Imt.Base.HAL.STM32H730/Peripherals/RTC.h>

Classes

struct  AMPM
 Enumeration for AM/PM selection. More...
 
struct  ClockSource
 Enumeration for RTC ClockSource Selection. More...
 
struct  DateStruct
 RTC time structure definitions. More...
 
struct  DayLightSaving
 Enumeration for RTC DayLight Saving Definition. More...
 
struct  HourFormat
 Enumeration for hour format. More...
 
struct  InitStruct
 RTC config structure definition. More...
 
struct  Month
 Enumeration for month day units. More...
 
struct  OutPutPolarity
 Enumeration for RTC Output Polarity Definition - not used in current implementation. More...
 
struct  OutputSelection
 Enumeration for Output selection - not used in current implementation. More...
 
struct  TampPreChargeDuration
 Enumeration for RTC_TAMP precharge duration - not used in current implementation. More...
 
struct  TimeStruct
 RTC time structure definitions. More...
 
struct  WakeupClockSelection
 Enumeration for Wakeup Clock selection - not used in current implementation. More...
 
struct  Weekday
 Enumeration for weekday units. More...
 

Static Public Member Functions

static bool init (const InitStruct &initStruct)
 Initializes the RTC peripheral according to the specified parameters in the InitStruct. More...
 
static void configureRtcTimeStamp (const TimeStruct &timeStamp, const DateStruct &date)
 Configuration of thte RTC Timestamp. More...
 
static void getTimeStamp (TimeStruct &timeStamp, DateStruct &date)
 Read the current timestamp from the date and time registers. More...
 
static bool isTimeStampConfigured ()
 Check if the ISR.INITS register is set, which means that the time was previously configured. More...
 
static bool isRtcRunning ()
 

Detailed Description

Real time Clock module Reference: ST_CortexM7_STM32H730_TRM_Rev2.pdf Chapter 51.

Member Function Documentation

◆ configureRtcTimeStamp()

static void imt::base::hal::stm32h730::peripherals::RTC::configureRtcTimeStamp ( const TimeStruct timeStamp,
const DateStruct date 
)
static

Configuration of thte RTC Timestamp.

Parameters
timeStampStructure accordingly to the TimeStruct which includes all necessary time units
dateStructure accordingly to the DateStruct which includes all necessary date units

◆ getTimeStamp()

static void imt::base::hal::stm32h730::peripherals::RTC::getTimeStamp ( TimeStruct timeStamp,
DateStruct date 
)
static

Read the current timestamp from the date and time registers.

Parameters
timeStampStructure accordingly to the TimeStruct which includes all necessary time units
dateStructure accordingly to the DateStruct which includes all necessary date units

◆ init()

static bool imt::base::hal::stm32h730::peripherals::RTC::init ( const InitStruct initStruct)
static

Initializes the RTC peripheral according to the specified parameters in the InitStruct.

Parameters
initStructpointer to a InitStruct structure that contains the configuration information for the RTC peripheral.

◆ isRtcRunning()

static bool imt::base::hal::stm32h730::peripherals::RTC::isRtcRunning ( )
static

◆ isTimeStampConfigured()

static bool imt::base::hal::stm32h730::peripherals::RTC::isTimeStampConfigured ( )
static

Check if the ISR.INITS register is set, which means that the time was previously configured.

Return values
boolean: true if configured, false if not

The documentation for this class was generated from the following file: