AceTimeClock
1.2.0
Clock classes for Arduino that can synchronize from an NTP server or an RTC chip
|
An implementation of Clock that uses an STM32 RTC chip using the STM32RTC library. More...
#include <StmRtcClock.h>
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. | |
![]() | |
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 const acetime_t | kInvalidSeconds = LocalTime::kInvalidSeconds |
Error value returned by getNow() and other methods when this object is not yet initialized. | |
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.
|
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.
|
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.
|
inline |
Setup does nothing.
Defined for API consistency with other Clocks.
Definition at line 34 of file StmRtcClock.h.