AceTimeClock  1.2.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::clock::StmRtcClock Class Reference

An implementation of Clock that uses an STM32 RTC chip using the STM32RTC library. More...

#include <StmRtcClock.h>

Inheritance diagram for ace_time::clock::StmRtcClock:
Inheritance graph
[legend]
Collaboration diagram for ace_time::clock::StmRtcClock:
Collaboration graph
[legend]

Public Member Functions

 StmRtcClock ()=default
 Constructor.
 
void setup ()
 Setup does nothing. More...
 
acetime_t getNow () const override
 Return the number of seconds since the AceTime epoch (2000-01-01T00:00:00Z). More...
 
void setNow (acetime_t epochSeconds) override
 Set the time to the indicated seconds. More...
 
bool isTimeSet () const
 Return true if the RTC is available and the time is set.
 
- Public Member Functions inherited from ace_time::clock::Clock
 Clock ()=default
 Default constructor.
 
 ~Clock ()=default
 We deliberately avoid using a virtual destructor. More...
 
virtual void sendRequest () const
 Send a time request asynchronously.
 
virtual bool isResponseReady () const
 Return true if a response is ready.
 
virtual acetime_t readResponse () const
 Returns number of seconds since AceTime epoch (2000-01-01). More...
 

Additional Inherited Members

- Static Public Attributes inherited from ace_time::clock::Clock
static const acetime_t kInvalidSeconds = LocalTime::kInvalidSeconds
 Error value returned by getNow() and other methods when this object is not yet initialized.
 

Detailed Description

An implementation of Clock that uses an STM32 RTC chip using the STM32RTC library.

The STM32RTC singleton object should be configured using STM32RTC::getInstance() in the global setup() function.

Definition at line 28 of file StmRtcClock.h.

Member Function Documentation

◆ getNow()

acetime_t ace_time::clock::StmRtcClock::getNow ( ) const
inlineoverridevirtual

Return the number of seconds since the AceTime epoch (2000-01-01T00:00:00Z).

Returns kInvalidSeconds if an error has occured.

This is a blocking call. Some clocks (e.g. NTP client) this may take many seconds. On those clocks, use the asynchronous methods (sendRequest(), isResponseReady(), and readResponse()) instead.

Implements ace_time::clock::Clock.

Definition at line 36 of file StmRtcClock.h.

◆ setNow()

void ace_time::clock::StmRtcClock::setNow ( acetime_t  )
inlineoverridevirtual

Set the time to the indicated seconds.

Calling with a value of kInvalidSeconds indicates an error condition, so the method should do nothing. Some clocks do not support this feature, for example, NTP or GPS clocks and this method will be a no-op.

Reimplemented from ace_time::clock::Clock.

Definition at line 42 of file StmRtcClock.h.

◆ setup()

void ace_time::clock::StmRtcClock::setup ( )
inline

Setup does nothing.

Defined for API consistency with other Clocks.

Definition at line 34 of file StmRtcClock.h.


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