AceTimeClock/html/StmRtc_8h_source.html

 /*

  * MIT License

  * Copyright (c) 2020 Brian T. Park, Anatoli Arkhipenko

  */


 #ifndef ACE_TIME_HW_STM_RTC_H

 #define ACE_TIME_HW_STM_RTC_H


 #if defined(ARDUINO_ARCH_STM32) || defined(EPOXY_DUINO)


 namespace ace_time {

 namespace hw {


 class HardwareDateTime;


 class StmRtc {

   public:

     explicit StmRtc() = default;


     void readDateTime(HardwareDateTime* dateTime) const;


     void setDateTime(const HardwareDateTime& dateTime) const;


     bool isTimeSet() const;

 };


 } // hw

 } // ace_time


 #endif //  #if defined(ARDUINO_ARCH_STM32) || defined(EPOXY_DUINO)

 #endif //  #ifndef ACE_TIME_HW_STM_RTC_H

ace_time::hw::HardwareDateTime
The date (year, month, day) and time (hour, minute, second) fields supported by the DS3231 RTC chip.
Definition: HardwareDateTime.h:19

ace_time::hw::StmRtc
A class that reads and writes HardwareDateTime from an STM32 RTC chip using the STM32RTC library.
Definition: StmRtc.h:27

ace_time::hw::StmRtc::setDateTime
void setDateTime(const HardwareDateTime &dateTime) const
Set the STM with the HardwareDateTime values.
Definition: StmRtc.cpp:59

ace_time::hw::StmRtc::isTimeSet
bool isTimeSet() const
Return true if the RTC is available and the time is set.
Definition: StmRtc.cpp:69

ace_time::hw::StmRtc::StmRtc
StmRtc()=default
Constructor.

ace_time::hw::StmRtc::readDateTime
void readDateTime(HardwareDateTime *dateTime) const
Read the time into the HardwareDateTime object.
Definition: StmRtc.cpp:18