AceTimeClock  1.3.0
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
Public Member Functions | List of all members
ace_time::hw::StmRtc Class Reference

A class that reads and writes HardwareDateTime from an STM32 RTC chip using the STM32RTC library. More...

#include <StmRtc.h>

Public Member Functions

 StmRtc ()=default
 Constructor.
 
void readDateTime (HardwareDateTime *dateTime) const
 Read the time into the HardwareDateTime object.
 
void setDateTime (const HardwareDateTime &dateTime) const
 Set the STM with the HardwareDateTime values.
 
bool isTimeSet () const
 Return true if the RTC is available and the time is set.
 

Detailed Description

A class that reads and writes HardwareDateTime from an STM32 RTC chip using the STM32RTC library.

This class is designed to access just enough features of the RTC chip to implement the ace_time::StmRtcClock class. It is not meant to provide access to all the features of the RTC chip.

The STM32RTC library provides a singleton instance through the STM32RTC::getInstance() method. Configuration of the STM32RTC can be performed through this instance in the global setup() function.

Definition at line 27 of file StmRtc.h.


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